device: Introduce hidden SSID scan function
[platform/upstream/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 struct connman_device *connman_device_ref(struct connman_device *device);
59 void connman_device_unref(struct connman_device *device);
60
61 enum connman_device_type connman_device_get_type(struct connman_device *device);
62 void connman_device_set_index(struct connman_device *device, int index);
63 int connman_device_get_index(struct connman_device *device);
64 void connman_device_set_interface(struct connman_device *device,
65                                                 const char *interface);
66
67 void connman_device_set_ident(struct connman_device *device,
68                                                 const char *ident);
69 const char *connman_device_get_ident(struct connman_device *device);
70
71 int connman_device_set_powered(struct connman_device *device,
72                                                 connman_bool_t powered);
73 int connman_device_set_scanning(struct connman_device *device,
74                                                 connman_bool_t scanning);
75 void connman_device_reset_scanning(struct connman_device *device);
76
77 int connman_device_set_disconnected(struct connman_device *device,
78                                                 connman_bool_t disconnected);
79 connman_bool_t connman_device_get_disconnected(struct connman_device *device);
80
81 int connman_device_set_string(struct connman_device *device,
82                                         const char *key, const char *value);
83 const char *connman_device_get_string(struct connman_device *device,
84                                                         const char *key);
85
86 int connman_device_add_network(struct connman_device *device,
87                                         struct connman_network *network);
88 struct connman_network *connman_device_get_network(struct connman_device *device,
89                                                         const char *identifier);
90 int connman_device_remove_network(struct connman_device *device,
91                                         struct connman_network *network);
92 void connman_device_remove_all_networks(struct connman_device *device);
93
94 void connman_device_schedule_scan(struct connman_device *device);
95
96 int connman_device_register(struct connman_device *device);
97 void connman_device_unregister(struct connman_device *device);
98
99 void *connman_device_get_data(struct connman_device *device);
100 void connman_device_set_data(struct connman_device *device, void *data);
101
102 struct connman_device_driver {
103         const char *name;
104         enum connman_device_type type;
105         int priority;
106         int (*probe) (struct connman_device *device);
107         void (*remove) (struct connman_device *device);
108         int (*enable) (struct connman_device *device);
109         int (*disable) (struct connman_device *device);
110         int (*scan) (struct connman_device *device);
111         int (*scan_fast) (struct connman_device *device);
112         int (*scan_hidden)(struct connman_device *device,
113                         const char *ssid, unsigned int ssid_len,
114                         const char *identity, const char* passphrase);
115 };
116
117 int connman_device_driver_register(struct connman_device_driver *driver);
118 void connman_device_driver_unregister(struct connman_device_driver *driver);
119
120 #ifdef __cplusplus
121 }
122 #endif
123
124 #endif /* __CONNMAN_DEVICE_H */