Add support for storing network specific path value
[connman] / 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 #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_HSO       = 11,
45         CONNMAN_DEVICE_TYPE_VENDOR    = 42,
46 };
47
48 enum connman_device_mode {
49         CONNMAN_DEVICE_MODE_NO_NETWORK        = 0,
50         CONNMAN_DEVICE_MODE_SINGLE_NETWORK    = 1,
51         CONNMAN_DEVICE_MODE_MULTIPLE_NETWORKS = 2,
52 };
53
54 enum connman_device_policy {
55         CONNMAN_DEVICE_POLICY_UNKNOWN = 0,
56         CONNMAN_DEVICE_POLICY_IGNORE  = 1,
57         CONNMAN_DEVICE_POLICY_OFF     = 2,
58         CONNMAN_DEVICE_POLICY_AUTO    = 3,
59         CONNMAN_DEVICE_POLICY_MANUAL  = 4,
60 };
61
62 struct connman_device;
63
64 extern struct connman_device *connman_device_create(const char *node,
65                                                 enum connman_device_type type);
66 extern struct connman_device *connman_device_ref(struct connman_device *device);
67 extern void connman_device_unref(struct connman_device *device);
68
69 extern void connman_device_set_path(struct connman_device *device,
70                                                         const char *path);
71 extern const char *connman_device_get_path(struct connman_device *device);
72 extern void connman_device_set_index(struct connman_device *device,
73                                                                 int index);
74 extern int connman_device_get_index(struct connman_device *device);
75 extern void connman_device_set_interface(struct connman_device *device,
76                                                         const char *interface);
77 extern const char *connman_device_get_interface(struct connman_device *device);
78
79 extern void connman_device_set_policy(struct connman_device *device,
80                                         enum connman_device_policy policy);
81 extern void connman_device_set_mode(struct connman_device *device,
82                                                 enum connman_device_mode mode);
83
84 extern int connman_device_set_powered(struct connman_device *device,
85                                                 connman_bool_t powered);
86 extern int connman_device_set_carrier(struct connman_device *device,
87                                                 connman_bool_t carrier);
88 extern int connman_device_set_scanning(struct connman_device *device,
89                                                 connman_bool_t scanning);
90
91 extern int connman_device_add_network(struct connman_device *device,
92                                         struct connman_network *network);
93 extern struct connman_network *connman_device_get_network(struct connman_device *device,
94                                                         const char *identifier);
95 extern int connman_device_remove_network(struct connman_device *device,
96                                                         const char *identifier);
97
98 extern int connman_device_register(struct connman_device *device);
99 extern void connman_device_unregister(struct connman_device *device);
100
101 extern void *connman_device_get_data(struct connman_device *device);
102 extern void connman_device_set_data(struct connman_device *device, void *data);
103
104 struct connman_device_driver {
105         const char *name;
106         enum connman_device_type type;
107         int priority;
108         int (*probe) (struct connman_device *device);
109         void (*remove) (struct connman_device *device);
110         int (*enable) (struct connman_device *device);
111         int (*disable) (struct connman_device *device);
112         int (*scan) (struct connman_device *device);
113 };
114
115 extern int connman_device_driver_register(struct connman_device_driver *driver);
116 extern void connman_device_driver_unregister(struct connman_device_driver *driver);
117
118 #ifdef __cplusplus
119 }
120 #endif
121
122 #endif /* __CONNMAN_DEVICE_H */