xref: /openbmc/linux/include/net/bluetooth/mgmt.h (revision afb46f79)
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 #define MGMT_STATUS_INVALID_INDEX	0x11
45 #define MGMT_STATUS_RFKILLED		0x12
46 
47 struct mgmt_hdr {
48 	__le16	opcode;
49 	__le16	index;
50 	__le16	len;
51 } __packed;
52 
53 struct mgmt_addr_info {
54 	bdaddr_t	bdaddr;
55 	__u8		type;
56 } __packed;
57 #define MGMT_ADDR_INFO_SIZE		7
58 
59 #define MGMT_OP_READ_VERSION		0x0001
60 #define MGMT_READ_VERSION_SIZE		0
61 struct mgmt_rp_read_version {
62 	__u8	version;
63 	__le16	revision;
64 } __packed;
65 
66 #define MGMT_OP_READ_COMMANDS		0x0002
67 #define MGMT_READ_COMMANDS_SIZE		0
68 struct mgmt_rp_read_commands {
69 	__le16	num_commands;
70 	__le16	num_events;
71 	__le16	opcodes[0];
72 } __packed;
73 
74 #define MGMT_OP_READ_INDEX_LIST		0x0003
75 #define MGMT_READ_INDEX_LIST_SIZE	0
76 struct mgmt_rp_read_index_list {
77 	__le16	num_controllers;
78 	__le16	index[0];
79 } __packed;
80 
81 /* Reserve one extra byte for names in management messages so that they
82  * are always guaranteed to be nul-terminated */
83 #define MGMT_MAX_NAME_LENGTH		(HCI_MAX_NAME_LENGTH + 1)
84 #define MGMT_MAX_SHORT_NAME_LENGTH	(HCI_MAX_SHORT_NAME_LENGTH + 1)
85 
86 #define MGMT_SETTING_POWERED		0x00000001
87 #define MGMT_SETTING_CONNECTABLE	0x00000002
88 #define MGMT_SETTING_FAST_CONNECTABLE	0x00000004
89 #define MGMT_SETTING_DISCOVERABLE	0x00000008
90 #define MGMT_SETTING_PAIRABLE		0x00000010
91 #define MGMT_SETTING_LINK_SECURITY	0x00000020
92 #define MGMT_SETTING_SSP		0x00000040
93 #define MGMT_SETTING_BREDR		0x00000080
94 #define MGMT_SETTING_HS			0x00000100
95 #define MGMT_SETTING_LE			0x00000200
96 #define MGMT_SETTING_ADVERTISING	0x00000400
97 #define MGMT_SETTING_SECURE_CONN	0x00000800
98 #define MGMT_SETTING_DEBUG_KEYS		0x00001000
99 #define MGMT_SETTING_PRIVACY		0x00002000
100 
101 #define MGMT_OP_READ_INFO		0x0004
102 #define MGMT_READ_INFO_SIZE		0
103 struct mgmt_rp_read_info {
104 	bdaddr_t	bdaddr;
105 	__u8		version;
106 	__le16		manufacturer;
107 	__le32		supported_settings;
108 	__le32		current_settings;
109 	__u8		dev_class[3];
110 	__u8		name[MGMT_MAX_NAME_LENGTH];
111 	__u8		short_name[MGMT_MAX_SHORT_NAME_LENGTH];
112 } __packed;
113 
114 struct mgmt_mode {
115 	__u8 val;
116 } __packed;
117 
118 #define MGMT_SETTING_SIZE		1
119 
120 #define MGMT_OP_SET_POWERED		0x0005
121 
122 #define MGMT_OP_SET_DISCOVERABLE	0x0006
123 struct mgmt_cp_set_discoverable {
124 	__u8	val;
125 	__le16	timeout;
126 } __packed;
127 #define MGMT_SET_DISCOVERABLE_SIZE	3
128 
129 #define MGMT_OP_SET_CONNECTABLE		0x0007
130 
131 #define MGMT_OP_SET_FAST_CONNECTABLE	0x0008
132 
133 #define MGMT_OP_SET_PAIRABLE		0x0009
134 
135 #define MGMT_OP_SET_LINK_SECURITY	0x000A
136 
137 #define MGMT_OP_SET_SSP			0x000B
138 
139 #define MGMT_OP_SET_HS			0x000C
140 
141 #define MGMT_OP_SET_LE			0x000D
142 #define MGMT_OP_SET_DEV_CLASS		0x000E
143 struct mgmt_cp_set_dev_class {
144 	__u8	major;
145 	__u8	minor;
146 } __packed;
147 #define MGMT_SET_DEV_CLASS_SIZE		2
148 
149 #define MGMT_OP_SET_LOCAL_NAME		0x000F
150 struct mgmt_cp_set_local_name {
151 	__u8	name[MGMT_MAX_NAME_LENGTH];
152 	__u8	short_name[MGMT_MAX_SHORT_NAME_LENGTH];
153 } __packed;
154 #define MGMT_SET_LOCAL_NAME_SIZE	260
155 
156 #define MGMT_OP_ADD_UUID		0x0010
157 struct mgmt_cp_add_uuid {
158 	__u8	uuid[16];
159 	__u8	svc_hint;
160 } __packed;
161 #define MGMT_ADD_UUID_SIZE		17
162 
163 #define MGMT_OP_REMOVE_UUID		0x0011
164 struct mgmt_cp_remove_uuid {
165 	__u8	uuid[16];
166 } __packed;
167 #define MGMT_REMOVE_UUID_SIZE		16
168 
169 struct mgmt_link_key_info {
170 	struct mgmt_addr_info addr;
171 	__u8	type;
172 	__u8	val[16];
173 	__u8	pin_len;
174 } __packed;
175 
176 #define MGMT_OP_LOAD_LINK_KEYS		0x0012
177 struct mgmt_cp_load_link_keys {
178 	__u8	debug_keys;
179 	__le16	key_count;
180 	struct	mgmt_link_key_info keys[0];
181 } __packed;
182 #define MGMT_LOAD_LINK_KEYS_SIZE	3
183 
184 struct mgmt_ltk_info {
185 	struct mgmt_addr_info addr;
186 	__u8	type;
187 	__u8	master;
188 	__u8	enc_size;
189 	__le16	ediv;
190 	__le64	rand;
191 	__u8	val[16];
192 } __packed;
193 
194 #define MGMT_OP_LOAD_LONG_TERM_KEYS	0x0013
195 struct mgmt_cp_load_long_term_keys {
196 	__le16	key_count;
197 	struct	mgmt_ltk_info keys[0];
198 } __packed;
199 #define MGMT_LOAD_LONG_TERM_KEYS_SIZE	2
200 
201 #define MGMT_OP_DISCONNECT		0x0014
202 struct mgmt_cp_disconnect {
203 	struct mgmt_addr_info addr;
204 } __packed;
205 #define MGMT_DISCONNECT_SIZE		MGMT_ADDR_INFO_SIZE
206 struct mgmt_rp_disconnect {
207 	struct mgmt_addr_info addr;
208 } __packed;
209 
210 #define MGMT_OP_GET_CONNECTIONS		0x0015
211 #define MGMT_GET_CONNECTIONS_SIZE	0
212 struct mgmt_rp_get_connections {
213 	__le16 conn_count;
214 	struct mgmt_addr_info addr[0];
215 } __packed;
216 
217 #define MGMT_OP_PIN_CODE_REPLY		0x0016
218 struct mgmt_cp_pin_code_reply {
219 	struct mgmt_addr_info addr;
220 	__u8	pin_len;
221 	__u8	pin_code[16];
222 } __packed;
223 #define MGMT_PIN_CODE_REPLY_SIZE	(MGMT_ADDR_INFO_SIZE + 17)
224 struct mgmt_rp_pin_code_reply {
225 	struct mgmt_addr_info addr;
226 } __packed;
227 
228 #define MGMT_OP_PIN_CODE_NEG_REPLY	0x0017
229 struct mgmt_cp_pin_code_neg_reply {
230 	struct mgmt_addr_info addr;
231 } __packed;
232 #define MGMT_PIN_CODE_NEG_REPLY_SIZE	MGMT_ADDR_INFO_SIZE
233 
234 #define MGMT_OP_SET_IO_CAPABILITY	0x0018
235 struct mgmt_cp_set_io_capability {
236 	__u8	io_capability;
237 } __packed;
238 #define MGMT_SET_IO_CAPABILITY_SIZE	1
239 
240 #define MGMT_OP_PAIR_DEVICE		0x0019
241 struct mgmt_cp_pair_device {
242 	struct mgmt_addr_info addr;
243 	__u8	io_cap;
244 } __packed;
245 #define MGMT_PAIR_DEVICE_SIZE		(MGMT_ADDR_INFO_SIZE + 1)
246 struct mgmt_rp_pair_device {
247 	struct mgmt_addr_info addr;
248 } __packed;
249 
250 #define MGMT_OP_CANCEL_PAIR_DEVICE	0x001A
251 #define MGMT_CANCEL_PAIR_DEVICE_SIZE	MGMT_ADDR_INFO_SIZE
252 
253 #define MGMT_OP_UNPAIR_DEVICE		0x001B
254 struct mgmt_cp_unpair_device {
255 	struct mgmt_addr_info addr;
256 	__u8 disconnect;
257 } __packed;
258 #define MGMT_UNPAIR_DEVICE_SIZE		(MGMT_ADDR_INFO_SIZE + 1)
259 struct mgmt_rp_unpair_device {
260 	struct mgmt_addr_info addr;
261 };
262 
263 #define MGMT_OP_USER_CONFIRM_REPLY	0x001C
264 struct mgmt_cp_user_confirm_reply {
265 	struct mgmt_addr_info addr;
266 } __packed;
267 #define MGMT_USER_CONFIRM_REPLY_SIZE	MGMT_ADDR_INFO_SIZE
268 struct mgmt_rp_user_confirm_reply {
269 	struct mgmt_addr_info addr;
270 } __packed;
271 
272 #define MGMT_OP_USER_CONFIRM_NEG_REPLY	0x001D
273 struct mgmt_cp_user_confirm_neg_reply {
274 	struct mgmt_addr_info addr;
275 } __packed;
276 #define MGMT_USER_CONFIRM_NEG_REPLY_SIZE MGMT_ADDR_INFO_SIZE
277 
278 #define MGMT_OP_USER_PASSKEY_REPLY	0x001E
279 struct mgmt_cp_user_passkey_reply {
280 	struct mgmt_addr_info addr;
281 	__le32	passkey;
282 } __packed;
283 #define MGMT_USER_PASSKEY_REPLY_SIZE	(MGMT_ADDR_INFO_SIZE + 4)
284 struct mgmt_rp_user_passkey_reply {
285 	struct mgmt_addr_info addr;
286 } __packed;
287 
288 #define MGMT_OP_USER_PASSKEY_NEG_REPLY	0x001F
289 struct mgmt_cp_user_passkey_neg_reply {
290 	struct mgmt_addr_info addr;
291 } __packed;
292 #define MGMT_USER_PASSKEY_NEG_REPLY_SIZE MGMT_ADDR_INFO_SIZE
293 
294 #define MGMT_OP_READ_LOCAL_OOB_DATA	0x0020
295 #define MGMT_READ_LOCAL_OOB_DATA_SIZE	0
296 struct mgmt_rp_read_local_oob_data {
297 	__u8	hash[16];
298 	__u8	randomizer[16];
299 } __packed;
300 struct mgmt_rp_read_local_oob_ext_data {
301 	__u8	hash192[16];
302 	__u8	randomizer192[16];
303 	__u8	hash256[16];
304 	__u8	randomizer256[16];
305 } __packed;
306 
307 #define MGMT_OP_ADD_REMOTE_OOB_DATA	0x0021
308 struct mgmt_cp_add_remote_oob_data {
309 	struct mgmt_addr_info addr;
310 	__u8	hash[16];
311 	__u8	randomizer[16];
312 } __packed;
313 #define MGMT_ADD_REMOTE_OOB_DATA_SIZE	(MGMT_ADDR_INFO_SIZE + 32)
314 struct mgmt_cp_add_remote_oob_ext_data {
315 	struct mgmt_addr_info addr;
316 	__u8	hash192[16];
317 	__u8	randomizer192[16];
318 	__u8	hash256[16];
319 	__u8	randomizer256[16];
320 } __packed;
321 #define MGMT_ADD_REMOTE_OOB_EXT_DATA_SIZE (MGMT_ADDR_INFO_SIZE + 64)
322 
323 #define MGMT_OP_REMOVE_REMOTE_OOB_DATA	0x0022
324 struct mgmt_cp_remove_remote_oob_data {
325 	struct mgmt_addr_info addr;
326 } __packed;
327 #define MGMT_REMOVE_REMOTE_OOB_DATA_SIZE MGMT_ADDR_INFO_SIZE
328 
329 #define MGMT_OP_START_DISCOVERY		0x0023
330 struct mgmt_cp_start_discovery {
331 	__u8 type;
332 } __packed;
333 #define MGMT_START_DISCOVERY_SIZE	1
334 
335 #define MGMT_OP_STOP_DISCOVERY		0x0024
336 struct mgmt_cp_stop_discovery {
337 	__u8 type;
338 } __packed;
339 #define MGMT_STOP_DISCOVERY_SIZE	1
340 
341 #define MGMT_OP_CONFIRM_NAME		0x0025
342 struct mgmt_cp_confirm_name {
343 	struct mgmt_addr_info addr;
344 	__u8	name_known;
345 } __packed;
346 #define MGMT_CONFIRM_NAME_SIZE		(MGMT_ADDR_INFO_SIZE + 1)
347 struct mgmt_rp_confirm_name {
348 	struct mgmt_addr_info addr;
349 } __packed;
350 
351 #define MGMT_OP_BLOCK_DEVICE		0x0026
352 struct mgmt_cp_block_device {
353 	struct mgmt_addr_info addr;
354 } __packed;
355 #define MGMT_BLOCK_DEVICE_SIZE		MGMT_ADDR_INFO_SIZE
356 
357 #define MGMT_OP_UNBLOCK_DEVICE		0x0027
358 struct mgmt_cp_unblock_device {
359 	struct mgmt_addr_info addr;
360 } __packed;
361 #define MGMT_UNBLOCK_DEVICE_SIZE	MGMT_ADDR_INFO_SIZE
362 
363 #define MGMT_OP_SET_DEVICE_ID		0x0028
364 struct mgmt_cp_set_device_id {
365 	__le16	source;
366 	__le16	vendor;
367 	__le16	product;
368 	__le16	version;
369 } __packed;
370 #define MGMT_SET_DEVICE_ID_SIZE		8
371 
372 #define MGMT_OP_SET_ADVERTISING		0x0029
373 
374 #define MGMT_OP_SET_BREDR		0x002A
375 
376 #define MGMT_OP_SET_STATIC_ADDRESS	0x002B
377 struct mgmt_cp_set_static_address {
378 	bdaddr_t bdaddr;
379 } __packed;
380 #define MGMT_SET_STATIC_ADDRESS_SIZE	6
381 
382 #define MGMT_OP_SET_SCAN_PARAMS		0x002C
383 struct mgmt_cp_set_scan_params {
384 	__le16	interval;
385 	__le16	window;
386 } __packed;
387 #define MGMT_SET_SCAN_PARAMS_SIZE	4
388 
389 #define MGMT_OP_SET_SECURE_CONN		0x002D
390 
391 #define MGMT_OP_SET_DEBUG_KEYS		0x002E
392 
393 #define MGMT_OP_SET_PRIVACY		0x002F
394 struct mgmt_cp_set_privacy {
395 	__u8 privacy;
396 	__u8 irk[16];
397 } __packed;
398 #define MGMT_SET_PRIVACY_SIZE		17
399 
400 struct mgmt_irk_info {
401 	struct mgmt_addr_info addr;
402 	__u8 val[16];
403 } __packed;
404 
405 #define MGMT_OP_LOAD_IRKS		0x0030
406 struct mgmt_cp_load_irks {
407 	__le16 irk_count;
408 	struct mgmt_irk_info irks[0];
409 } __packed;
410 #define MGMT_LOAD_IRKS_SIZE		2
411 
412 #define MGMT_EV_CMD_COMPLETE		0x0001
413 struct mgmt_ev_cmd_complete {
414 	__le16	opcode;
415 	__u8	status;
416 	__u8	data[0];
417 } __packed;
418 
419 #define MGMT_EV_CMD_STATUS		0x0002
420 struct mgmt_ev_cmd_status {
421 	__le16	opcode;
422 	__u8	status;
423 } __packed;
424 
425 #define MGMT_EV_CONTROLLER_ERROR	0x0003
426 struct mgmt_ev_controller_error {
427 	__u8	error_code;
428 } __packed;
429 
430 #define MGMT_EV_INDEX_ADDED		0x0004
431 
432 #define MGMT_EV_INDEX_REMOVED		0x0005
433 
434 #define MGMT_EV_NEW_SETTINGS		0x0006
435 
436 #define MGMT_EV_CLASS_OF_DEV_CHANGED	0x0007
437 struct mgmt_ev_class_of_dev_changed {
438 	__u8	dev_class[3];
439 };
440 
441 #define MGMT_EV_LOCAL_NAME_CHANGED	0x0008
442 struct mgmt_ev_local_name_changed {
443 	__u8	name[MGMT_MAX_NAME_LENGTH];
444 	__u8	short_name[MGMT_MAX_SHORT_NAME_LENGTH];
445 } __packed;
446 
447 #define MGMT_EV_NEW_LINK_KEY		0x0009
448 struct mgmt_ev_new_link_key {
449 	__u8	store_hint;
450 	struct mgmt_link_key_info key;
451 } __packed;
452 
453 #define MGMT_EV_NEW_LONG_TERM_KEY	0x000A
454 struct mgmt_ev_new_long_term_key {
455 	__u8	store_hint;
456 	struct mgmt_ltk_info key;
457 } __packed;
458 
459 #define MGMT_EV_DEVICE_CONNECTED	0x000B
460 struct mgmt_ev_device_connected {
461 	struct mgmt_addr_info addr;
462 	__le32	flags;
463 	__le16	eir_len;
464 	__u8	eir[0];
465 } __packed;
466 
467 #define MGMT_DEV_DISCONN_UNKNOWN	0x00
468 #define MGMT_DEV_DISCONN_TIMEOUT	0x01
469 #define MGMT_DEV_DISCONN_LOCAL_HOST	0x02
470 #define MGMT_DEV_DISCONN_REMOTE		0x03
471 
472 #define MGMT_EV_DEVICE_DISCONNECTED	0x000C
473 struct mgmt_ev_device_disconnected {
474 	struct mgmt_addr_info addr;
475 	__u8	reason;
476 } __packed;
477 
478 #define MGMT_EV_CONNECT_FAILED		0x000D
479 struct mgmt_ev_connect_failed {
480 	struct mgmt_addr_info addr;
481 	__u8	status;
482 } __packed;
483 
484 #define MGMT_EV_PIN_CODE_REQUEST	0x000E
485 struct mgmt_ev_pin_code_request {
486 	struct mgmt_addr_info addr;
487 	__u8	secure;
488 } __packed;
489 
490 #define MGMT_EV_USER_CONFIRM_REQUEST	0x000F
491 struct mgmt_ev_user_confirm_request {
492 	struct mgmt_addr_info addr;
493 	__u8	confirm_hint;
494 	__le32	value;
495 } __packed;
496 
497 #define MGMT_EV_USER_PASSKEY_REQUEST	0x0010
498 struct mgmt_ev_user_passkey_request {
499 	struct mgmt_addr_info addr;
500 } __packed;
501 
502 #define MGMT_EV_AUTH_FAILED		0x0011
503 struct mgmt_ev_auth_failed {
504 	struct mgmt_addr_info addr;
505 	__u8	status;
506 } __packed;
507 
508 #define MGMT_DEV_FOUND_CONFIRM_NAME    0x01
509 #define MGMT_DEV_FOUND_LEGACY_PAIRING  0x02
510 
511 #define MGMT_EV_DEVICE_FOUND		0x0012
512 struct mgmt_ev_device_found {
513 	struct mgmt_addr_info addr;
514 	__s8	rssi;
515 	__le32	flags;
516 	__le16	eir_len;
517 	__u8	eir[0];
518 } __packed;
519 
520 #define MGMT_EV_DISCOVERING		0x0013
521 struct mgmt_ev_discovering {
522 	__u8	type;
523 	__u8	discovering;
524 } __packed;
525 
526 #define MGMT_EV_DEVICE_BLOCKED		0x0014
527 struct mgmt_ev_device_blocked {
528 	struct mgmt_addr_info addr;
529 } __packed;
530 
531 #define MGMT_EV_DEVICE_UNBLOCKED	0x0015
532 struct mgmt_ev_device_unblocked {
533 	struct mgmt_addr_info addr;
534 } __packed;
535 
536 #define MGMT_EV_DEVICE_UNPAIRED		0x0016
537 struct mgmt_ev_device_unpaired {
538 	struct mgmt_addr_info addr;
539 } __packed;
540 
541 #define MGMT_EV_PASSKEY_NOTIFY		0x0017
542 struct mgmt_ev_passkey_notify {
543 	struct mgmt_addr_info addr;
544 	__le32	passkey;
545 	__u8	entered;
546 } __packed;
547 
548 #define MGMT_EV_NEW_IRK			0x0018
549 struct mgmt_ev_new_irk {
550 	__u8     store_hint;
551 	bdaddr_t rpa;
552 	struct mgmt_irk_info irk;
553 } __packed;
554 
555 struct mgmt_csrk_info {
556 	struct mgmt_addr_info addr;
557 	__u8 master;
558 	__u8 val[16];
559 } __packed;
560 
561 #define MGMT_EV_NEW_CSRK		0x0019
562 struct mgmt_ev_new_csrk {
563 	__u8 store_hint;
564 	struct mgmt_csrk_info key;
565 } __packed;
566