54beb65d167ad2a6ff59270a9dc4bd98399fce37
[framework/connectivity/connman.git] / include / device.h
1 /*
2  *
3  *  Connection Manager
4  *
5  *  Copyright (C) 2007-2010  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_GADGET    = 7,
47         CONNMAN_DEVICE_TYPE_VENDOR    = 10000,
48 };
49
50 #define CONNMAN_DEVICE_PRIORITY_LOW      -100
51 #define CONNMAN_DEVICE_PRIORITY_DEFAULT     0
52 #define CONNMAN_DEVICE_PRIORITY_HIGH      100
53
54 struct connman_device;
55
56 struct connman_device *connman_device_create(const char *node,
57                                                 enum connman_device_type type);
58
59 #define connman_device_ref(device) \
60         connman_device_ref_debug(device, __FILE__, __LINE__, __func__)
61
62 #define connman_device_unref(device) \
63         connman_device_unref_debug(device, __FILE__, __LINE__, __func__)
64
65 struct connman_device *
66 connman_device_ref_debug(struct connman_device *device,
67                         const char *file, int line, const char *caller);
68 void connman_device_unref_debug(struct connman_device *device,
69                         const char *file, int line, const char *caller);
70
71 enum connman_device_type connman_device_get_type(struct connman_device *device);
72 void connman_device_set_index(struct connman_device *device, int index);
73 int connman_device_get_index(struct connman_device *device);
74 void connman_device_set_interface(struct connman_device *device,
75                                                 const char *interface);
76
77 void connman_device_set_ident(struct connman_device *device,
78                                                 const char *ident);
79 const char *connman_device_get_ident(struct connman_device *device);
80
81 int connman_device_set_powered(struct connman_device *device,
82                                                 connman_bool_t powered);
83 int connman_device_set_scanning(struct connman_device *device,
84                                                 connman_bool_t scanning);
85 void connman_device_reset_scanning(struct connman_device *device);
86
87 int connman_device_set_disconnected(struct connman_device *device,
88                                                 connman_bool_t disconnected);
89 connman_bool_t connman_device_get_disconnected(struct connman_device *device);
90
91 int connman_device_set_string(struct connman_device *device,
92                                         const char *key, const char *value);
93 const char *connman_device_get_string(struct connman_device *device,
94                                                         const char *key);
95
96 int connman_device_add_network(struct connman_device *device,
97                                         struct connman_network *network);
98 struct connman_network *connman_device_get_network(struct connman_device *device,
99                                                         const char *identifier);
100 int connman_device_remove_network(struct connman_device *device,
101                                         struct connman_network *network);
102 void connman_device_remove_all_networks(struct connman_device *device);
103
104 void connman_device_schedule_scan(struct connman_device *device);
105
106 int connman_device_register(struct connman_device *device);
107 void connman_device_unregister(struct connman_device *device);
108
109 void *connman_device_get_data(struct connman_device *device);
110 void connman_device_set_data(struct connman_device *device, void *data);
111
112 struct connman_device_driver {
113         const char *name;
114         enum connman_device_type type;
115         int priority;
116         int (*probe) (struct connman_device *device);
117         void (*remove) (struct connman_device *device);
118         int (*enable) (struct connman_device *device);
119         int (*disable) (struct connman_device *device);
120         int (*scan) (struct connman_device *device);
121         int (*scan_fast) (struct connman_device *device);
122         int (*scan_hidden)(struct connman_device *device,
123                         const char *ssid, unsigned int ssid_len,
124                         const char *identity, const char* passphrase);
125 };
126
127 int connman_device_driver_register(struct connman_device_driver *driver);
128 void connman_device_driver_unregister(struct connman_device_driver *driver);
129
130 #ifdef __cplusplus
131 }
132 #endif
133
134 #endif /* __CONNMAN_DEVICE_H */