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