Add skeleton for service interface includes
[connman] / include / device.h
1 /*
2  *
3  *  Connection Manager
4  *
5  *  Copyright (C) 2007-2009  Intel Corporation. All rights reserved.
6  *
7  *  This program is free software; you can redistribute it and/or modify
8  *  it under the terms of the GNU General Public License version 2 as
9  *  published by the Free Software Foundation.
10  *
11  *  This program is distributed in the hope that it will be useful,
12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  *  GNU General Public License for more details.
15  *
16  *  You should have received a copy of the GNU General Public License
17  *  along with this program; if not, write to the Free Software
18  *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
19  *
20  */
21
22 #ifndef __CONNMAN_DEVICE_H
23 #define __CONNMAN_DEVICE_H
24
25 #include <connman/types.h>
26 #include <connman/network.h>
27
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31
32 /**
33  * SECTION:device
34  * @title: Device premitives
35  * @short_description: Functions for handling devices
36  */
37
38 enum connman_device_type {
39         CONNMAN_DEVICE_TYPE_UNKNOWN   = 0,
40         CONNMAN_DEVICE_TYPE_ETHERNET  = 1,
41         CONNMAN_DEVICE_TYPE_WIFI      = 2,
42         CONNMAN_DEVICE_TYPE_WIMAX     = 3,
43         CONNMAN_DEVICE_TYPE_BLUETOOTH = 4,
44         CONNMAN_DEVICE_TYPE_GPS       = 5,
45         CONNMAN_DEVICE_TYPE_HSO       = 15,
46         CONNMAN_DEVICE_TYPE_NOZOMI    = 16,
47         CONNMAN_DEVICE_TYPE_HUAWEI    = 17,
48         CONNMAN_DEVICE_TYPE_NOVATEL   = 18,
49         CONNMAN_DEVICE_TYPE_VENDOR    = 10000,
50 };
51
52 enum connman_device_mode {
53         CONNMAN_DEVICE_MODE_UNKNOWN          = 0,
54         CONNMAN_DEVICE_MODE_NETWORK_SINGLE   = 1,
55         CONNMAN_DEVICE_MODE_NETWORK_MULTIPLE = 2,
56         CONNMAN_DEVICE_MODE_TRANSPORT_IP     = 3,
57 };
58
59 enum connman_device_policy {
60         CONNMAN_DEVICE_POLICY_UNKNOWN = 0,
61         CONNMAN_DEVICE_POLICY_IGNORE  = 1,
62         CONNMAN_DEVICE_POLICY_OFF     = 2,
63         CONNMAN_DEVICE_POLICY_AUTO    = 3,
64         CONNMAN_DEVICE_POLICY_MANUAL  = 4,
65 };
66
67 struct connman_device;
68
69 extern struct connman_device *connman_device_create(const char *node,
70                                                 enum connman_device_type type);
71 extern struct connman_device *connman_device_ref(struct connman_device *device);
72 extern void connman_device_unref(struct connman_device *device);
73
74 extern enum connman_device_type connman_device_get_type(struct connman_device *device);
75 extern const char *connman_device_get_name(struct connman_device *device);
76 extern const char *connman_device_get_path(struct connman_device *device);
77 extern void connman_device_set_index(struct connman_device *device,
78                                                                 int index);
79 extern int connman_device_get_index(struct connman_device *device);
80 extern void connman_device_set_interface(struct connman_device *device,
81                                                         const char *interface);
82 extern const char *connman_device_get_interface(struct connman_device *device);
83
84 extern void connman_device_set_policy(struct connman_device *device,
85                                         enum connman_device_policy policy);
86 extern void connman_device_set_mode(struct connman_device *device,
87                                                 enum connman_device_mode mode);
88 extern enum connman_device_mode connman_device_get_mode(struct connman_device *device);
89
90 extern int connman_device_set_powered(struct connman_device *device,
91                                                 connman_bool_t powered);
92 extern int connman_device_set_carrier(struct connman_device *device,
93                                                 connman_bool_t carrier);
94 extern int connman_device_set_scanning(struct connman_device *device,
95                                                 connman_bool_t scanning);
96 extern int connman_device_set_disconnected(struct connman_device *device,
97                                                 connman_bool_t disconnected);
98
99 extern int connman_device_set_string(struct connman_device *device,
100                                         const char *key, const char *value);
101 extern const char *connman_device_get_string(struct connman_device *device,
102                                                         const char *key);
103
104 extern int connman_device_add_network(struct connman_device *device,
105                                         struct connman_network *network);
106 extern struct connman_network *connman_device_get_network(struct connman_device *device,
107                                                         const char *identifier);
108 extern int connman_device_remove_network(struct connman_device *device,
109                                                         const char *identifier);
110
111 extern int connman_device_register(struct connman_device *device);
112 extern void connman_device_unregister(struct connman_device *device);
113
114 extern void *connman_device_get_data(struct connman_device *device);
115 extern void connman_device_set_data(struct connman_device *device, void *data);
116
117 struct connman_device_driver {
118         const char *name;
119         enum connman_device_type type;
120         int priority;
121         int (*probe) (struct connman_device *device);
122         void (*remove) (struct connman_device *device);
123         int (*enable) (struct connman_device *device);
124         int (*disable) (struct connman_device *device);
125         int (*scan) (struct connman_device *device);
126         int (*join) (struct connman_device *device,
127                                         struct connman_network *network);
128 };
129
130 extern int connman_device_driver_register(struct connman_device_driver *driver);
131 extern void connman_device_driver_unregister(struct connman_device_driver *driver);
132
133 #ifdef __cplusplus
134 }
135 #endif
136
137 #endif /* __CONNMAN_DEVICE_H */