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