xref: /openbmc/linux/include/net/bluetooth/mgmt.h (revision e98d2ce2)
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 
99 #define MGMT_OP_READ_INFO		0x0004
100 #define MGMT_READ_INFO_SIZE		0
101 struct mgmt_rp_read_info {
102 	bdaddr_t	bdaddr;
103 	__u8		version;
104 	__le16		manufacturer;
105 	__le32		supported_settings;
106 	__le32		current_settings;
107 	__u8		dev_class[3];
108 	__u8		name[MGMT_MAX_NAME_LENGTH];
109 	__u8		short_name[MGMT_MAX_SHORT_NAME_LENGTH];
110 } __packed;
111 
112 struct mgmt_mode {
113 	__u8 val;
114 } __packed;
115 
116 #define MGMT_SETTING_SIZE		1
117 
118 #define MGMT_OP_SET_POWERED		0x0005
119 
120 #define MGMT_OP_SET_DISCOVERABLE	0x0006
121 struct mgmt_cp_set_discoverable {
122 	__u8	val;
123 	__le16	timeout;
124 } __packed;
125 #define MGMT_SET_DISCOVERABLE_SIZE	3
126 
127 #define MGMT_OP_SET_CONNECTABLE		0x0007
128 
129 #define MGMT_OP_SET_FAST_CONNECTABLE	0x0008
130 
131 #define MGMT_OP_SET_PAIRABLE		0x0009
132 
133 #define MGMT_OP_SET_LINK_SECURITY	0x000A
134 
135 #define MGMT_OP_SET_SSP			0x000B
136 
137 #define MGMT_OP_SET_HS			0x000C
138 
139 #define MGMT_OP_SET_LE			0x000D
140 #define MGMT_OP_SET_DEV_CLASS		0x000E
141 struct mgmt_cp_set_dev_class {
142 	__u8	major;
143 	__u8	minor;
144 } __packed;
145 #define MGMT_SET_DEV_CLASS_SIZE		2
146 
147 #define MGMT_OP_SET_LOCAL_NAME		0x000F
148 struct mgmt_cp_set_local_name {
149 	__u8	name[MGMT_MAX_NAME_LENGTH];
150 	__u8	short_name[MGMT_MAX_SHORT_NAME_LENGTH];
151 } __packed;
152 #define MGMT_SET_LOCAL_NAME_SIZE	260
153 
154 #define MGMT_OP_ADD_UUID		0x0010
155 struct mgmt_cp_add_uuid {
156 	__u8	uuid[16];
157 	__u8	svc_hint;
158 } __packed;
159 #define MGMT_ADD_UUID_SIZE		17
160 
161 #define MGMT_OP_REMOVE_UUID		0x0011
162 struct mgmt_cp_remove_uuid {
163 	__u8	uuid[16];
164 } __packed;
165 #define MGMT_REMOVE_UUID_SIZE		16
166 
167 struct mgmt_link_key_info {
168 	struct mgmt_addr_info addr;
169 	__u8	type;
170 	__u8	val[16];
171 	__u8	pin_len;
172 } __packed;
173 
174 #define MGMT_OP_LOAD_LINK_KEYS		0x0012
175 struct mgmt_cp_load_link_keys {
176 	__u8	debug_keys;
177 	__le16	key_count;
178 	struct	mgmt_link_key_info keys[0];
179 } __packed;
180 #define MGMT_LOAD_LINK_KEYS_SIZE	3
181 
182 struct mgmt_ltk_info {
183 	struct mgmt_addr_info addr;
184 	__u8	authenticated;
185 	__u8	master;
186 	__u8	enc_size;
187 	__le16	ediv;
188 	__u8	rand[8];
189 	__u8	val[16];
190 } __packed;
191 
192 #define MGMT_OP_LOAD_LONG_TERM_KEYS	0x0013
193 struct mgmt_cp_load_long_term_keys {
194 	__le16	key_count;
195 	struct	mgmt_ltk_info keys[0];
196 } __packed;
197 #define MGMT_LOAD_LONG_TERM_KEYS_SIZE	2
198 
199 #define MGMT_OP_DISCONNECT		0x0014
200 struct mgmt_cp_disconnect {
201 	struct mgmt_addr_info addr;
202 } __packed;
203 #define MGMT_DISCONNECT_SIZE		MGMT_ADDR_INFO_SIZE
204 struct mgmt_rp_disconnect {
205 	struct mgmt_addr_info addr;
206 } __packed;
207 
208 #define MGMT_OP_GET_CONNECTIONS		0x0015
209 #define MGMT_GET_CONNECTIONS_SIZE	0
210 struct mgmt_rp_get_connections {
211 	__le16 conn_count;
212 	struct mgmt_addr_info addr[0];
213 } __packed;
214 
215 #define MGMT_OP_PIN_CODE_REPLY		0x0016
216 struct mgmt_cp_pin_code_reply {
217 	struct mgmt_addr_info addr;
218 	__u8	pin_len;
219 	__u8	pin_code[16];
220 } __packed;
221 #define MGMT_PIN_CODE_REPLY_SIZE	(MGMT_ADDR_INFO_SIZE + 17)
222 struct mgmt_rp_pin_code_reply {
223 	struct mgmt_addr_info addr;
224 } __packed;
225 
226 #define MGMT_OP_PIN_CODE_NEG_REPLY	0x0017
227 struct mgmt_cp_pin_code_neg_reply {
228 	struct mgmt_addr_info addr;
229 } __packed;
230 #define MGMT_PIN_CODE_NEG_REPLY_SIZE	MGMT_ADDR_INFO_SIZE
231 
232 #define MGMT_OP_SET_IO_CAPABILITY	0x0018
233 struct mgmt_cp_set_io_capability {
234 	__u8	io_capability;
235 } __packed;
236 #define MGMT_SET_IO_CAPABILITY_SIZE	1
237 
238 #define MGMT_OP_PAIR_DEVICE		0x0019
239 struct mgmt_cp_pair_device {
240 	struct mgmt_addr_info addr;
241 	__u8	io_cap;
242 } __packed;
243 #define MGMT_PAIR_DEVICE_SIZE		(MGMT_ADDR_INFO_SIZE + 1)
244 struct mgmt_rp_pair_device {
245 	struct mgmt_addr_info addr;
246 } __packed;
247 
248 #define MGMT_OP_CANCEL_PAIR_DEVICE	0x001A
249 #define MGMT_CANCEL_PAIR_DEVICE_SIZE	MGMT_ADDR_INFO_SIZE
250 
251 #define MGMT_OP_UNPAIR_DEVICE		0x001B
252 struct mgmt_cp_unpair_device {
253 	struct mgmt_addr_info addr;
254 	__u8 disconnect;
255 } __packed;
256 #define MGMT_UNPAIR_DEVICE_SIZE		(MGMT_ADDR_INFO_SIZE + 1)
257 struct mgmt_rp_unpair_device {
258 	struct mgmt_addr_info addr;
259 };
260 
261 #define MGMT_OP_USER_CONFIRM_REPLY	0x001C
262 struct mgmt_cp_user_confirm_reply {
263 	struct mgmt_addr_info addr;
264 } __packed;
265 #define MGMT_USER_CONFIRM_REPLY_SIZE	MGMT_ADDR_INFO_SIZE
266 struct mgmt_rp_user_confirm_reply {
267 	struct mgmt_addr_info addr;
268 } __packed;
269 
270 #define MGMT_OP_USER_CONFIRM_NEG_REPLY	0x001D
271 struct mgmt_cp_user_confirm_neg_reply {
272 	struct mgmt_addr_info addr;
273 } __packed;
274 #define MGMT_USER_CONFIRM_NEG_REPLY_SIZE MGMT_ADDR_INFO_SIZE
275 
276 #define MGMT_OP_USER_PASSKEY_REPLY	0x001E
277 struct mgmt_cp_user_passkey_reply {
278 	struct mgmt_addr_info addr;
279 	__le32	passkey;
280 } __packed;
281 #define MGMT_USER_PASSKEY_REPLY_SIZE	(MGMT_ADDR_INFO_SIZE + 4)
282 struct mgmt_rp_user_passkey_reply {
283 	struct mgmt_addr_info addr;
284 } __packed;
285 
286 #define MGMT_OP_USER_PASSKEY_NEG_REPLY	0x001F
287 struct mgmt_cp_user_passkey_neg_reply {
288 	struct mgmt_addr_info addr;
289 } __packed;
290 #define MGMT_USER_PASSKEY_NEG_REPLY_SIZE MGMT_ADDR_INFO_SIZE
291 
292 #define MGMT_OP_READ_LOCAL_OOB_DATA	0x0020
293 #define MGMT_READ_LOCAL_OOB_DATA_SIZE	0
294 struct mgmt_rp_read_local_oob_data {
295 	__u8	hash[16];
296 	__u8	randomizer[16];
297 } __packed;
298 
299 #define MGMT_OP_ADD_REMOTE_OOB_DATA	0x0021
300 struct mgmt_cp_add_remote_oob_data {
301 	struct mgmt_addr_info addr;
302 	__u8	hash[16];
303 	__u8	randomizer[16];
304 } __packed;
305 #define MGMT_ADD_REMOTE_OOB_DATA_SIZE	(MGMT_ADDR_INFO_SIZE + 32)
306 
307 #define MGMT_OP_REMOVE_REMOTE_OOB_DATA	0x0022
308 struct mgmt_cp_remove_remote_oob_data {
309 	struct mgmt_addr_info addr;
310 } __packed;
311 #define MGMT_REMOVE_REMOTE_OOB_DATA_SIZE MGMT_ADDR_INFO_SIZE
312 
313 #define MGMT_OP_START_DISCOVERY		0x0023
314 struct mgmt_cp_start_discovery {
315 	__u8 type;
316 } __packed;
317 #define MGMT_START_DISCOVERY_SIZE	1
318 
319 #define MGMT_OP_STOP_DISCOVERY		0x0024
320 struct mgmt_cp_stop_discovery {
321 	__u8 type;
322 } __packed;
323 #define MGMT_STOP_DISCOVERY_SIZE	1
324 
325 #define MGMT_OP_CONFIRM_NAME		0x0025
326 struct mgmt_cp_confirm_name {
327 	struct mgmt_addr_info addr;
328 	__u8	name_known;
329 } __packed;
330 #define MGMT_CONFIRM_NAME_SIZE		(MGMT_ADDR_INFO_SIZE + 1)
331 struct mgmt_rp_confirm_name {
332 	struct mgmt_addr_info addr;
333 } __packed;
334 
335 #define MGMT_OP_BLOCK_DEVICE		0x0026
336 struct mgmt_cp_block_device {
337 	struct mgmt_addr_info addr;
338 } __packed;
339 #define MGMT_BLOCK_DEVICE_SIZE		MGMT_ADDR_INFO_SIZE
340 
341 #define MGMT_OP_UNBLOCK_DEVICE		0x0027
342 struct mgmt_cp_unblock_device {
343 	struct mgmt_addr_info addr;
344 } __packed;
345 #define MGMT_UNBLOCK_DEVICE_SIZE	MGMT_ADDR_INFO_SIZE
346 
347 #define MGMT_OP_SET_DEVICE_ID		0x0028
348 struct mgmt_cp_set_device_id {
349 	__le16	source;
350 	__le16	vendor;
351 	__le16	product;
352 	__le16	version;
353 } __packed;
354 #define MGMT_SET_DEVICE_ID_SIZE		8
355 
356 #define MGMT_OP_SET_ADVERTISING		0x0029
357 
358 #define MGMT_OP_SET_BREDR		0x002A
359 
360 #define MGMT_OP_SET_STATIC_ADDRESS	0x002B
361 struct mgmt_cp_set_static_address {
362 	bdaddr_t bdaddr;
363 } __packed;
364 #define MGMT_SET_STATIC_ADDRESS_SIZE	6
365 
366 #define MGMT_OP_SET_SCAN_PARAMS		0x002C
367 struct mgmt_cp_set_scan_params {
368 	__le16	interval;
369 	__le16	window;
370 } __packed;
371 #define MGMT_SET_SCAN_PARAMS_SIZE	4
372 
373 #define MGMT_EV_CMD_COMPLETE		0x0001
374 struct mgmt_ev_cmd_complete {
375 	__le16	opcode;
376 	__u8	status;
377 	__u8	data[0];
378 } __packed;
379 
380 #define MGMT_EV_CMD_STATUS		0x0002
381 struct mgmt_ev_cmd_status {
382 	__le16	opcode;
383 	__u8	status;
384 } __packed;
385 
386 #define MGMT_EV_CONTROLLER_ERROR	0x0003
387 struct mgmt_ev_controller_error {
388 	__u8	error_code;
389 } __packed;
390 
391 #define MGMT_EV_INDEX_ADDED		0x0004
392 
393 #define MGMT_EV_INDEX_REMOVED		0x0005
394 
395 #define MGMT_EV_NEW_SETTINGS		0x0006
396 
397 #define MGMT_EV_CLASS_OF_DEV_CHANGED	0x0007
398 struct mgmt_ev_class_of_dev_changed {
399 	__u8	dev_class[3];
400 };
401 
402 #define MGMT_EV_LOCAL_NAME_CHANGED	0x0008
403 struct mgmt_ev_local_name_changed {
404 	__u8	name[MGMT_MAX_NAME_LENGTH];
405 	__u8	short_name[MGMT_MAX_SHORT_NAME_LENGTH];
406 } __packed;
407 
408 #define MGMT_EV_NEW_LINK_KEY		0x0009
409 struct mgmt_ev_new_link_key {
410 	__u8	store_hint;
411 	struct mgmt_link_key_info key;
412 } __packed;
413 
414 #define MGMT_EV_NEW_LONG_TERM_KEY	0x000A
415 struct mgmt_ev_new_long_term_key {
416 	__u8	store_hint;
417 	struct mgmt_ltk_info key;
418 } __packed;
419 
420 #define MGMT_EV_DEVICE_CONNECTED	0x000B
421 struct mgmt_ev_device_connected {
422 	struct mgmt_addr_info addr;
423 	__le32	flags;
424 	__le16	eir_len;
425 	__u8	eir[0];
426 } __packed;
427 
428 #define MGMT_DEV_DISCONN_UNKNOWN	0x00
429 #define MGMT_DEV_DISCONN_TIMEOUT	0x01
430 #define MGMT_DEV_DISCONN_LOCAL_HOST	0x02
431 #define MGMT_DEV_DISCONN_REMOTE		0x03
432 
433 #define MGMT_EV_DEVICE_DISCONNECTED	0x000C
434 struct mgmt_ev_device_disconnected {
435 	struct mgmt_addr_info addr;
436 	__u8	reason;
437 } __packed;
438 
439 #define MGMT_EV_CONNECT_FAILED		0x000D
440 struct mgmt_ev_connect_failed {
441 	struct mgmt_addr_info addr;
442 	__u8	status;
443 } __packed;
444 
445 #define MGMT_EV_PIN_CODE_REQUEST	0x000E
446 struct mgmt_ev_pin_code_request {
447 	struct mgmt_addr_info addr;
448 	__u8	secure;
449 } __packed;
450 
451 #define MGMT_EV_USER_CONFIRM_REQUEST	0x000F
452 struct mgmt_ev_user_confirm_request {
453 	struct mgmt_addr_info addr;
454 	__u8	confirm_hint;
455 	__le32	value;
456 } __packed;
457 
458 #define MGMT_EV_USER_PASSKEY_REQUEST	0x0010
459 struct mgmt_ev_user_passkey_request {
460 	struct mgmt_addr_info addr;
461 } __packed;
462 
463 #define MGMT_EV_AUTH_FAILED		0x0011
464 struct mgmt_ev_auth_failed {
465 	struct mgmt_addr_info addr;
466 	__u8	status;
467 } __packed;
468 
469 #define MGMT_DEV_FOUND_CONFIRM_NAME    0x01
470 #define MGMT_DEV_FOUND_LEGACY_PAIRING  0x02
471 
472 #define MGMT_EV_DEVICE_FOUND		0x0012
473 struct mgmt_ev_device_found {
474 	struct mgmt_addr_info addr;
475 	__s8	rssi;
476 	__le32	flags;
477 	__le16	eir_len;
478 	__u8	eir[0];
479 } __packed;
480 
481 #define MGMT_EV_DISCOVERING		0x0013
482 struct mgmt_ev_discovering {
483 	__u8	type;
484 	__u8	discovering;
485 } __packed;
486 
487 #define MGMT_EV_DEVICE_BLOCKED		0x0014
488 struct mgmt_ev_device_blocked {
489 	struct mgmt_addr_info addr;
490 } __packed;
491 
492 #define MGMT_EV_DEVICE_UNBLOCKED	0x0015
493 struct mgmt_ev_device_unblocked {
494 	struct mgmt_addr_info addr;
495 } __packed;
496 
497 #define MGMT_EV_DEVICE_UNPAIRED		0x0016
498 struct mgmt_ev_device_unpaired {
499 	struct mgmt_addr_info addr;
500 } __packed;
501 
502 #define MGMT_EV_PASSKEY_NOTIFY		0x0017
503 struct mgmt_ev_passkey_notify {
504 	struct mgmt_addr_info addr;
505 	__le32	passkey;
506 	__u8	entered;
507 } __packed;
508