Fix copy-and-paste documentation mistake
[framework/connectivity/connman.git] / include / device.h
1 /*
2  *
3  *  Connection Manager
4  *
5  *  Copyright (C) 2007-2008  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 #ifdef __cplusplus
26 extern "C" {
27 #endif
28
29 #include <connman/element.h>
30
31 /**
32  * SECTION:device
33  * @title: Device driver premitives
34  * @short_description: Functions for registering device drivers
35  */
36
37 enum connman_device_type {
38         CONNMAN_DEVICE_TYPE_UNKNOWN   = CONNMAN_ELEMENT_SUBTYPE_UNKNOWN,
39         CONNMAN_DEVICE_TYPE_FAKE      = CONNMAN_ELEMENT_SUBTYPE_FAKE,
40         CONNMAN_DEVICE_TYPE_ETHERNET  = CONNMAN_ELEMENT_SUBTYPE_ETHERNET,
41         CONNMAN_DEVICE_TYPE_WIFI      = CONNMAN_ELEMENT_SUBTYPE_WIFI,
42         CONNMAN_DEVICE_TYPE_WIMAX     = CONNMAN_ELEMENT_SUBTYPE_WIMAX,
43         CONNMAN_DEVICE_TYPE_MODEM     = CONNMAN_ELEMENT_SUBTYPE_MODEM,
44         CONNMAN_DEVICE_TYPE_BLUETOOTH = CONNMAN_ELEMENT_SUBTYPE_BLUETOOTH,
45 };
46
47 enum connman_device_capabilities {
48         CONNMAN_DEVICE_CAPABILITY_SCANNING = (1 << 0),
49 };
50
51 enum connman_device_state {
52         CONNMAN_DEVICE_STATE_UNKNOWN = 0,
53         CONNMAN_DEVICE_STATE_OFF     = 1,
54 };
55
56 struct connman_device_driver;
57
58 struct connman_device {
59         struct connman_element *element;
60         unsigned long capabilities;
61         enum connman_device_state state;
62
63         struct connman_device_driver *driver;
64         void *driver_data;
65
66         GSList *networks;
67 };
68
69 extern int connman_device_set_enabled(struct connman_device *device,
70                                                         gboolean enabled);
71
72 struct connman_device_driver {
73         const char *name;
74         enum connman_device_type type;
75         int priority;
76         int (*probe) (struct connman_device *device);
77         void (*remove) (struct connman_device *device);
78         int (*scan) (struct connman_device *device);
79 };
80
81 extern int connman_device_driver_register(struct connman_device_driver *driver);
82 extern void connman_device_driver_unregister(struct connman_device_driver *driver);
83
84 #ifdef __cplusplus
85 }
86 #endif
87
88 #endif /* __CONNMAN_DEVICE_H */