device: add connman_device_get_ident()
[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_VENDOR    = 10000,
47 };
48
49 enum connman_device_mode {
50         CONNMAN_DEVICE_MODE_UNKNOWN          = 0,
51         CONNMAN_DEVICE_MODE_NETWORK_SINGLE   = 1,
52         CONNMAN_DEVICE_MODE_NETWORK_MULTIPLE = 2,
53 };
54
55 struct connman_device;
56
57 struct connman_device *connman_device_create(const char *node,
58                                                 enum connman_device_type type);
59 struct connman_device *connman_device_ref(struct connman_device *device);
60 void connman_device_unref(struct connman_device *device);
61
62 enum connman_device_type connman_device_get_type(struct connman_device *device);
63 const char *connman_device_get_name(struct connman_device *device);
64 const char *connman_device_get_path(struct connman_device *device);
65 void connman_device_set_index(struct connman_device *device, int index);
66 int connman_device_get_index(struct connman_device *device);
67 void connman_device_set_interface(struct connman_device *device,
68                                 const char *interface, const char *control);
69 const char *connman_device_get_control(struct connman_device *device);
70
71 void connman_device_set_ident(struct connman_device *device,
72                                                 const char *ident);
73 const char *connman_device_get_ident(struct connman_device *device);
74
75 void connman_device_set_mode(struct connman_device *device,
76                                         enum connman_device_mode mode);
77 enum connman_device_mode connman_device_get_mode(struct connman_device *device);
78
79 int connman_device_set_powered(struct connman_device *device,
80                                                 connman_bool_t powered);
81 int connman_device_set_scanning(struct connman_device *device,
82                                                 connman_bool_t scanning);
83
84 int connman_device_set_disconnected(struct connman_device *device,
85                                                 connman_bool_t disconnected);
86 connman_bool_t connman_device_get_disconnected(struct connman_device *device);
87 int connman_device_set_connected(struct connman_device *device,
88                                                 connman_bool_t connected);
89
90 int connman_device_set_string(struct connman_device *device,
91                                         const char *key, const char *value);
92 const char *connman_device_get_string(struct connman_device *device,
93                                                         const char *key);
94
95 int connman_device_add_network(struct connman_device *device,
96                                         struct connman_network *network);
97 struct connman_network *connman_device_get_network(struct connman_device *device,
98                                                         const char *identifier);
99 int connman_device_remove_network(struct connman_device *device,
100                                                         const char *identifier);
101 void connman_device_remove_all_networks(struct connman_device *device);
102
103 void connman_device_schedule_scan(struct connman_device *device);
104
105 int connman_device_register(struct connman_device *device);
106 void connman_device_unregister(struct connman_device *device);
107
108 void *connman_device_get_data(struct connman_device *device);
109 void connman_device_set_data(struct connman_device *device, void *data);
110
111 struct connman_device_driver {
112         const char *name;
113         enum connman_device_type type;
114         int priority;
115         int (*probe) (struct connman_device *device);
116         void (*remove) (struct connman_device *device);
117         int (*enable) (struct connman_device *device);
118         int (*disable) (struct connman_device *device);
119         int (*scan) (struct connman_device *device);
120 };
121
122 int connman_device_driver_register(struct connman_device_driver *driver);
123 void connman_device_driver_unregister(struct connman_device_driver *driver);
124
125 #ifdef __cplusplus
126 }
127 #endif
128
129 #endif /* __CONNMAN_DEVICE_H */