495668c77fb656e4339b5ad6c0f728beb4b66986
[linux-2.6.git] / include / net / bluetooth / mgmt.h
1 /*
2    BlueZ - Bluetooth protocol stack for Linux
3
4    Copyright (C) 2010  Nokia Corporation
5    Copyright (C) 2011-2012  Intel Corporation
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    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
12    OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
13    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS.
14    IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) AND AUTHOR(S) BE LIABLE FOR ANY
15    CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES
16    WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
17    ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
18    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
19
20    ALL LIABILITY, INCLUDING LIABILITY FOR INFRINGEMENT OF ANY PATENTS,
21    COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS, RELATING TO USE OF THIS
22    SOFTWARE IS DISCLAIMED.
23 */
24
25 #define MGMT_INDEX_NONE                 0xFFFF
26
27 #define MGMT_STATUS_SUCCESS             0x00
28 #define MGMT_STATUS_UNKNOWN_COMMAND     0x01
29 #define MGMT_STATUS_NOT_CONNECTED       0x02
30 #define MGMT_STATUS_FAILED              0x03
31 #define MGMT_STATUS_CONNECT_FAILED      0x04
32 #define MGMT_STATUS_AUTH_FAILED         0x05
33 #define MGMT_STATUS_NOT_PAIRED          0x06
34 #define MGMT_STATUS_NO_RESOURCES        0x07
35 #define MGMT_STATUS_TIMEOUT             0x08
36 #define MGMT_STATUS_ALREADY_CONNECTED   0x09
37 #define MGMT_STATUS_BUSY                0x0a
38 #define MGMT_STATUS_REJECTED            0x0b
39 #define MGMT_STATUS_NOT_SUPPORTED       0x0c
40 #define MGMT_STATUS_INVALID_PARAMS      0x0d
41 #define MGMT_STATUS_DISCONNECTED        0x0e
42 #define MGMT_STATUS_NOT_POWERED         0x0f
43 #define MGMT_STATUS_CANCELLED           0x10
44
45 struct mgmt_hdr {
46         __le16 opcode;
47         __le16 index;
48         __le16 len;
49 } __packed;
50
51 struct mgmt_addr_info {
52         bdaddr_t bdaddr;
53         __u8 type;
54 } __packed;
55
56 #define MGMT_OP_READ_VERSION            0x0001
57 struct mgmt_rp_read_version {
58         __u8 version;
59         __le16 revision;
60 } __packed;
61
62 #define MGMT_OP_READ_COMMANDS           0x0002
63 struct mgmt_rp_read_commands {
64         __le16 num_commands;
65         __le16 num_events;
66         __le16 opcodes[0];
67 } __packed;
68
69 #define MGMT_OP_READ_INDEX_LIST         0x0003
70 struct mgmt_rp_read_index_list {
71         __le16 num_controllers;
72         __le16 index[0];
73 } __packed;
74
75 /* Reserve one extra byte for names in management messages so that they
76  * are always guaranteed to be nul-terminated */
77 #define MGMT_MAX_NAME_LENGTH            (HCI_MAX_NAME_LENGTH + 1)
78 #define MGMT_MAX_SHORT_NAME_LENGTH      (HCI_MAX_SHORT_NAME_LENGTH + 1)
79
80 #define MGMT_SETTING_POWERED            0x00000001
81 #define MGMT_SETTING_CONNECTABLE        0x00000002
82 #define MGMT_SETTING_FAST_CONNECTABLE   0x00000004
83 #define MGMT_SETTING_DISCOVERABLE       0x00000008
84 #define MGMT_SETTING_PAIRABLE           0x00000010
85 #define MGMT_SETTING_LINK_SECURITY      0x00000020
86 #define MGMT_SETTING_SSP                0x00000040
87 #define MGMT_SETTING_BREDR              0x00000080
88 #define MGMT_SETTING_HS                 0x00000100
89 #define MGMT_SETTING_LE                 0x00000200
90
91 #define MGMT_OP_READ_INFO               0x0004
92 struct mgmt_rp_read_info {
93         bdaddr_t bdaddr;
94         __u8 version;
95         __le16 manufacturer;
96         __le32 supported_settings;
97         __le32 current_settings;
98         __u8 dev_class[3];
99         __u8 name[MGMT_MAX_NAME_LENGTH];
100         __u8 short_name[MGMT_MAX_SHORT_NAME_LENGTH];
101 } __packed;
102
103 struct mgmt_mode {
104         __u8 val;
105 } __packed;
106
107 #define MGMT_OP_SET_POWERED             0x0005
108
109 #define MGMT_OP_SET_DISCOVERABLE        0x0006
110 struct mgmt_cp_set_discoverable {
111         __u8 val;
112         __u16 timeout;
113 } __packed;
114
115 #define MGMT_OP_SET_CONNECTABLE         0x0007
116
117 #define MGMT_OP_SET_FAST_CONNECTABLE    0x0008
118
119 #define MGMT_OP_SET_PAIRABLE            0x0009
120
121 #define MGMT_OP_SET_LINK_SECURITY       0x000A
122
123 #define MGMT_OP_SET_SSP                 0x000B
124
125 #define MGMT_OP_SET_HS                  0x000C
126
127 #define MGMT_OP_SET_LE                  0x000D
128
129 #define MGMT_OP_SET_DEV_CLASS           0x000E
130 struct mgmt_cp_set_dev_class {
131         __u8 major;
132         __u8 minor;
133 } __packed;
134
135 #define MGMT_OP_SET_LOCAL_NAME          0x000F
136 struct mgmt_cp_set_local_name {
137         __u8 name[MGMT_MAX_NAME_LENGTH];
138         __u8 short_name[MGMT_MAX_SHORT_NAME_LENGTH];
139 } __packed;
140
141 #define MGMT_OP_ADD_UUID                0x0010
142 struct mgmt_cp_add_uuid {
143         __u8 uuid[16];
144         __u8 svc_hint;
145 } __packed;
146
147 #define MGMT_OP_REMOVE_UUID             0x0011
148 struct mgmt_cp_remove_uuid {
149         __u8 uuid[16];
150 } __packed;
151
152 struct mgmt_link_key_info {
153         struct mgmt_addr_info addr;
154         u8 type;
155         u8 val[16];
156         u8 pin_len;
157 } __packed;
158
159 #define MGMT_OP_LOAD_LINK_KEYS          0x0012
160 struct mgmt_cp_load_link_keys {
161         __u8 debug_keys;
162         __le16 key_count;
163         struct mgmt_link_key_info keys[0];
164 } __packed;
165
166 struct mgmt_ltk_info {
167         struct mgmt_addr_info addr;
168         __u8 authenticated;
169         __u8 master;
170         __u8 enc_size;
171         __le16 ediv;
172         __u8 rand[8];
173         __u8 val[16];
174 } __packed;
175
176 #define MGMT_OP_LOAD_LONG_TERM_KEYS     0x0013
177 struct mgmt_cp_load_long_term_keys {
178         __le16 key_count;
179         struct mgmt_ltk_info keys[0];
180 } __packed;
181
182 #define MGMT_OP_DISCONNECT              0x0014
183 struct mgmt_cp_disconnect {
184         struct mgmt_addr_info addr;
185 } __packed;
186 struct mgmt_rp_disconnect {
187         struct mgmt_addr_info addr;
188 } __packed;
189
190 #define MGMT_OP_GET_CONNECTIONS         0x0015
191 struct mgmt_rp_get_connections {
192         __le16 conn_count;
193         struct mgmt_addr_info addr[0];
194 } __packed;
195
196 #define MGMT_OP_PIN_CODE_REPLY          0x0016
197 struct mgmt_cp_pin_code_reply {
198         struct mgmt_addr_info addr;
199         __u8 pin_len;
200         __u8 pin_code[16];
201 } __packed;
202 struct mgmt_rp_pin_code_reply {
203         struct mgmt_addr_info addr;
204 } __packed;
205
206 #define MGMT_OP_PIN_CODE_NEG_REPLY      0x0017
207 struct mgmt_cp_pin_code_neg_reply {
208         struct mgmt_addr_info addr;
209 } __packed;
210
211 #define MGMT_OP_SET_IO_CAPABILITY       0x0018
212 struct mgmt_cp_set_io_capability {
213         __u8 io_capability;
214 } __packed;
215
216 #define MGMT_OP_PAIR_DEVICE             0x0019
217 struct mgmt_cp_pair_device {
218         struct mgmt_addr_info addr;
219         __u8 io_cap;
220 } __packed;
221 struct mgmt_rp_pair_device {
222         struct mgmt_addr_info addr;
223 } __packed;
224
225 #define MGMT_OP_CANCEL_PAIR_DEVICE      0x001A
226
227 #define MGMT_OP_UNPAIR_DEVICE           0x001B
228 struct mgmt_cp_unpair_device {
229         struct mgmt_addr_info addr;
230         __u8 disconnect;
231 } __packed;
232 struct mgmt_rp_unpair_device {
233         struct mgmt_addr_info addr;
234 };
235
236 #define MGMT_OP_USER_CONFIRM_REPLY      0x001C
237 struct mgmt_cp_user_confirm_reply {
238         struct mgmt_addr_info addr;
239 } __packed;
240 struct mgmt_rp_user_confirm_reply {
241         struct mgmt_addr_info addr;
242 } __packed;
243
244 #define MGMT_OP_USER_CONFIRM_NEG_REPLY  0x001D
245 struct mgmt_cp_user_confirm_neg_reply {
246         struct mgmt_addr_info addr;
247 } __packed;
248
249 #define MGMT_OP_USER_PASSKEY_REPLY      0x001E
250 struct mgmt_cp_user_passkey_reply {
251         struct mgmt_addr_info addr;
252         __le32 passkey;
253 } __packed;
254 struct mgmt_rp_user_passkey_reply {
255         struct mgmt_addr_info addr;
256 } __packed;
257
258 #define MGMT_OP_USER_PASSKEY_NEG_REPLY  0x001F
259 struct mgmt_cp_user_passkey_neg_reply {
260         struct mgmt_addr_info addr;
261 } __packed;
262
263 #define MGMT_OP_READ_LOCAL_OOB_DATA     0x0020
264 struct mgmt_rp_read_local_oob_data {
265         __u8 hash[16];
266         __u8 randomizer[16];
267 } __packed;
268
269 #define MGMT_OP_ADD_REMOTE_OOB_DATA     0x0021
270 struct mgmt_cp_add_remote_oob_data {
271         struct mgmt_addr_info addr;
272         __u8 hash[16];
273         __u8 randomizer[16];
274 } __packed;
275
276 #define MGMT_OP_REMOVE_REMOTE_OOB_DATA  0x0022
277 struct mgmt_cp_remove_remote_oob_data {
278         struct mgmt_addr_info addr;
279 } __packed;
280
281 #define MGMT_OP_START_DISCOVERY         0x0023
282 struct mgmt_cp_start_discovery {
283         __u8 type;
284 } __packed;
285
286 #define MGMT_OP_STOP_DISCOVERY          0x0024
287 struct mgmt_cp_stop_discovery {
288         __u8 type;
289 } __packed;
290
291 #define MGMT_OP_CONFIRM_NAME            0x0025
292 struct mgmt_cp_confirm_name {
293         struct mgmt_addr_info addr;
294         __u8 name_known;
295 } __packed;
296 struct mgmt_rp_confirm_name {
297         struct mgmt_addr_info addr;
298 } __packed;
299
300 #define MGMT_OP_BLOCK_DEVICE            0x0026
301 struct mgmt_cp_block_device {
302         struct mgmt_addr_info addr;
303 } __packed;
304
305 #define MGMT_OP_UNBLOCK_DEVICE          0x0027
306 struct mgmt_cp_unblock_device {
307         struct mgmt_addr_info addr;
308 } __packed;
309
310 #define MGMT_EV_CMD_COMPLETE            0x0001
311 struct mgmt_ev_cmd_complete {
312         __le16 opcode;
313         __u8 status;
314         __u8 data[0];
315 } __packed;
316
317 #define MGMT_EV_CMD_STATUS              0x0002
318 struct mgmt_ev_cmd_status {
319         __le16 opcode;
320         __u8 status;
321 } __packed;
322
323 #define MGMT_EV_CONTROLLER_ERROR        0x0003
324 struct mgmt_ev_controller_error {
325         __u8 error_code;
326 } __packed;
327
328 #define MGMT_EV_INDEX_ADDED             0x0004
329
330 #define MGMT_EV_INDEX_REMOVED           0x0005
331
332 #define MGMT_EV_NEW_SETTINGS            0x0006
333
334 #define MGMT_EV_CLASS_OF_DEV_CHANGED    0x0007
335 struct mgmt_ev_class_of_dev_changed {
336         __u8 dev_class[3];
337 };
338
339 #define MGMT_EV_LOCAL_NAME_CHANGED      0x0008
340 struct mgmt_ev_local_name_changed {
341         __u8 name[MGMT_MAX_NAME_LENGTH];
342         __u8 short_name[MGMT_MAX_SHORT_NAME_LENGTH];
343 } __packed;
344
345 #define MGMT_EV_NEW_LINK_KEY            0x0009
346 struct mgmt_ev_new_link_key {
347         __u8 store_hint;
348         struct mgmt_link_key_info key;
349 } __packed;
350
351 #define MGMT_EV_NEW_LONG_TERM_KEY       0x000A
352 struct mgmt_ev_new_long_term_key {
353         __u8 store_hint;
354         struct mgmt_ltk_info key;
355 } __packed;
356
357 #define MGMT_EV_DEVICE_CONNECTED        0x000B
358 struct mgmt_ev_device_connected {
359         struct mgmt_addr_info addr;
360         __le16 eir_len;
361         __u8 eir[0];
362 } __packed;
363
364 #define MGMT_EV_DEVICE_DISCONNECTED     0x000C
365
366 #define MGMT_EV_CONNECT_FAILED          0x000D
367 struct mgmt_ev_connect_failed {
368         struct mgmt_addr_info addr;
369         __u8 status;
370 } __packed;
371
372 #define MGMT_EV_PIN_CODE_REQUEST        0x000E
373 struct mgmt_ev_pin_code_request {
374         struct mgmt_addr_info addr;
375         __u8 secure;
376 } __packed;
377
378 #define MGMT_EV_USER_CONFIRM_REQUEST    0x000F
379 struct mgmt_ev_user_confirm_request {
380         struct mgmt_addr_info addr;
381         __u8 confirm_hint;
382         __le32 value;
383 } __packed;
384
385 #define MGMT_EV_USER_PASSKEY_REQUEST    0x0010
386 struct mgmt_ev_user_passkey_request {
387         struct mgmt_addr_info addr;
388 } __packed;
389
390 #define MGMT_EV_AUTH_FAILED             0x0011
391 struct mgmt_ev_auth_failed {
392         struct mgmt_addr_info addr;
393         __u8 status;
394 } __packed;
395
396 #define MGMT_EV_DEVICE_FOUND            0x0012
397 struct mgmt_ev_device_found {
398         struct mgmt_addr_info addr;
399         __s8 rssi;
400         __u8 confirm_name;
401         __le16 eir_len;
402         __u8 eir[0];
403 } __packed;
404
405 #define MGMT_EV_DISCOVERING             0x0013
406 struct mgmt_ev_discovering {
407         __u8 type;
408         __u8 discovering;
409 } __packed;
410
411 #define MGMT_EV_DEVICE_BLOCKED          0x0014
412 struct mgmt_ev_device_blocked {
413         struct mgmt_addr_info addr;
414 } __packed;
415
416 #define MGMT_EV_DEVICE_UNBLOCKED        0x0015
417 struct mgmt_ev_device_unblocked {
418         struct mgmt_addr_info addr;
419 } __packed;
420
421 #define MGMT_EV_DEVICE_UNPAIRED         0x0016
422 struct mgmt_ev_device_unpaired {
423         struct mgmt_addr_info addr;
424 } __packed;