Add function connman_device_remove_all_networks
[framework/connectivity/connman.git] / 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_CELLULAR  = 5,
45         CONNMAN_DEVICE_TYPE_GPS       = 6,
46         CONNMAN_DEVICE_TYPE_MBM       = 14,
47         CONNMAN_DEVICE_TYPE_HSO       = 15,
48         CONNMAN_DEVICE_TYPE_NOZOMI    = 16,
49         CONNMAN_DEVICE_TYPE_HUAWEI    = 17,
50         CONNMAN_DEVICE_TYPE_NOVATEL   = 18,
51         CONNMAN_DEVICE_TYPE_VENDOR    = 10000,
52 };
53
54 enum connman_device_mode {
55         CONNMAN_DEVICE_MODE_UNKNOWN          = 0,
56         CONNMAN_DEVICE_MODE_NETWORK_SINGLE   = 1,
57         CONNMAN_DEVICE_MODE_NETWORK_MULTIPLE = 2,
58         CONNMAN_DEVICE_MODE_TRANSPORT_IP     = 3,
59 };
60
61 struct connman_device;
62
63 struct connman_device *connman_device_create(const char *node,
64                                                 enum connman_device_type type);
65 struct connman_device *connman_device_ref(struct connman_device *device);
66 void connman_device_unref(struct connman_device *device);
67
68 enum connman_device_type connman_device_get_type(struct connman_device *device);
69 const char *connman_device_get_name(struct connman_device *device);
70 const char *connman_device_get_path(struct connman_device *device);
71 void connman_device_set_index(struct connman_device *device, int index);
72 int connman_device_get_index(struct connman_device *device);
73 void connman_device_set_interface(struct connman_device *device,
74                                 const char *interface, const char *control);
75 const char *connman_device_get_control(struct connman_device *device);
76
77 void connman_device_set_ident(struct connman_device *device,
78                                                 const char *ident);
79
80 void connman_device_set_mode(struct connman_device *device,
81                                         enum connman_device_mode mode);
82 enum connman_device_mode connman_device_get_mode(struct connman_device *device);
83 void connman_device_set_secondary(struct connman_device *device,
84                                                 connman_bool_t secondary);
85 connman_bool_t connman_device_get_secondary(struct connman_device *device);
86
87 int connman_device_set_powered(struct connman_device *device,
88                                                 connman_bool_t powered);
89 int connman_device_set_carrier(struct connman_device *device,
90                                                 connman_bool_t carrier);
91 int connman_device_set_scanning(struct connman_device *device,
92                                                 connman_bool_t scanning);
93 void connman_device_cleanup_scanning(struct connman_device *device);
94
95 int connman_device_set_disconnected(struct connman_device *device,
96                                                 connman_bool_t disconnected);
97 connman_bool_t connman_device_get_disconnected(struct connman_device *device);
98 int connman_device_set_connected(struct connman_device *device,
99                                                 connman_bool_t connected);
100
101 int connman_device_set_string(struct connman_device *device,
102                                         const char *key, const char *value);
103 const char *connman_device_get_string(struct connman_device *device,
104                                                         const char *key);
105
106 int connman_device_add_network(struct connman_device *device,
107                                         struct connman_network *network);
108 struct connman_network *connman_device_get_network(struct connman_device *device,
109                                                         const char *identifier);
110 int connman_device_remove_network(struct connman_device *device,
111                                                         const char *identifier);
112 void connman_device_remove_all_networks(struct connman_device *device);
113
114 int connman_device_register(struct connman_device *device);
115 void connman_device_unregister(struct connman_device *device);
116
117 void *connman_device_get_data(struct connman_device *device);
118 void connman_device_set_data(struct connman_device *device, void *data);
119
120 struct connman_device_driver {
121         const char *name;
122         enum connman_device_type type;
123         int priority;
124         int (*probe) (struct connman_device *device);
125         void (*remove) (struct connman_device *device);
126         int (*enable) (struct connman_device *device);
127         int (*disable) (struct connman_device *device);
128         int (*connect) (struct connman_device *device);
129         int (*disconnect) (struct connman_device *device);
130         int (*scan) (struct connman_device *device);
131         int (*join) (struct connman_device *device,
132                                         struct connman_network *network);
133 };
134
135 int connman_device_driver_register(struct connman_device_driver *driver);
136 void connman_device_driver_unregister(struct connman_device_driver *driver);
137
138 #ifdef __cplusplus
139 }
140 #endif
141
142 #endif /* __CONNMAN_DEVICE_H */