xref: /openbmc/linux/include/net/bluetooth/mgmt.h (revision 28424707)
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_INDEX_LIST		0x0003
67 struct mgmt_rp_read_index_list {
68 	__le16 num_controllers;
69 	__le16 index[0];
70 } __packed;
71 
72 /* Reserve one extra byte for names in management messages so that they
73  * are always guaranteed to be nul-terminated */
74 #define MGMT_MAX_NAME_LENGTH		(HCI_MAX_NAME_LENGTH + 1)
75 #define MGMT_MAX_SHORT_NAME_LENGTH	(10 + 1)
76 
77 #define MGMT_SETTING_POWERED		0x00000001
78 #define MGMT_SETTING_CONNECTABLE	0x00000002
79 #define MGMT_SETTING_FAST_CONNECTABLE	0x00000004
80 #define MGMT_SETTING_DISCOVERABLE	0x00000008
81 #define MGMT_SETTING_PAIRABLE		0x00000010
82 #define MGMT_SETTING_LINK_SECURITY	0x00000020
83 #define MGMT_SETTING_SSP		0x00000040
84 #define MGMT_SETTING_BREDR		0x00000080
85 #define MGMT_SETTING_HS			0x00000100
86 #define MGMT_SETTING_LE			0x00000200
87 
88 #define MGMT_OP_READ_INFO		0x0004
89 struct mgmt_rp_read_info {
90 	bdaddr_t bdaddr;
91 	__u8 version;
92 	__le16 manufacturer;
93 	__le32 supported_settings;
94 	__le32 current_settings;
95 	__u8 dev_class[3];
96 	__u8 name[MGMT_MAX_NAME_LENGTH];
97 	__u8 short_name[MGMT_MAX_SHORT_NAME_LENGTH];
98 } __packed;
99 
100 struct mgmt_mode {
101 	__u8 val;
102 } __packed;
103 
104 #define MGMT_OP_SET_POWERED		0x0005
105 
106 #define MGMT_OP_SET_DISCOVERABLE	0x0006
107 struct mgmt_cp_set_discoverable {
108 	__u8 val;
109 	__u16 timeout;
110 } __packed;
111 
112 #define MGMT_OP_SET_CONNECTABLE		0x0007
113 
114 #define MGMT_OP_SET_FAST_CONNECTABLE	0x0008
115 
116 #define MGMT_OP_SET_PAIRABLE		0x0009
117 
118 #define MGMT_OP_SET_LINK_SECURITY	0x000A
119 
120 #define MGMT_OP_SET_SSP			0x000B
121 
122 #define MGMT_OP_SET_HS			0x000C
123 
124 #define MGMT_OP_SET_LE			0x000D
125 
126 #define MGMT_OP_SET_DEV_CLASS		0x000E
127 struct mgmt_cp_set_dev_class {
128 	__u8 major;
129 	__u8 minor;
130 } __packed;
131 
132 #define MGMT_OP_SET_LOCAL_NAME		0x000F
133 struct mgmt_cp_set_local_name {
134 	__u8 name[MGMT_MAX_NAME_LENGTH];
135 } __packed;
136 
137 #define MGMT_OP_ADD_UUID		0x0010
138 struct mgmt_cp_add_uuid {
139 	__u8 uuid[16];
140 	__u8 svc_hint;
141 } __packed;
142 
143 #define MGMT_OP_REMOVE_UUID		0x0011
144 struct mgmt_cp_remove_uuid {
145 	__u8 uuid[16];
146 } __packed;
147 
148 struct mgmt_link_key_info {
149 	bdaddr_t bdaddr;
150 	u8 type;
151 	u8 val[16];
152 	u8 pin_len;
153 } __packed;
154 
155 #define MGMT_OP_LOAD_LINK_KEYS		0x0012
156 struct mgmt_cp_load_link_keys {
157 	__u8 debug_keys;
158 	__le16 key_count;
159 	struct mgmt_link_key_info keys[0];
160 } __packed;
161 
162 struct mgmt_ltk_info {
163 	struct mgmt_addr_info addr;
164 	__u8 authenticated;
165 	__u8 master;
166 	__u8 enc_size;
167 	__le16 ediv;
168 	__u8 rand[8];
169 	__u8 val[16];
170 } __packed;
171 
172 #define MGMT_OP_LOAD_LONG_TERM_KEYS	0x0013
173 struct mgmt_cp_load_long_term_keys {
174 	__le16 key_count;
175 	struct mgmt_ltk_info keys[0];
176 } __packed;
177 
178 #define MGMT_OP_REMOVE_KEYS		0x0014
179 struct mgmt_cp_remove_keys {
180 	bdaddr_t bdaddr;
181 	__u8 disconnect;
182 } __packed;
183 struct mgmt_rp_remove_keys {
184 	bdaddr_t bdaddr;
185 	__u8 status;
186 };
187 
188 #define MGMT_OP_DISCONNECT		0x0015
189 struct mgmt_cp_disconnect {
190 	bdaddr_t bdaddr;
191 } __packed;
192 struct mgmt_rp_disconnect {
193 	bdaddr_t bdaddr;
194 	__u8 status;
195 } __packed;
196 
197 #define MGMT_OP_GET_CONNECTIONS		0x0016
198 struct mgmt_rp_get_connections {
199 	__le16 conn_count;
200 	struct mgmt_addr_info addr[0];
201 } __packed;
202 
203 #define MGMT_OP_PIN_CODE_REPLY		0x0017
204 struct mgmt_cp_pin_code_reply {
205 	bdaddr_t bdaddr;
206 	__u8 pin_len;
207 	__u8 pin_code[16];
208 } __packed;
209 struct mgmt_rp_pin_code_reply {
210 	bdaddr_t bdaddr;
211 	uint8_t status;
212 } __packed;
213 
214 #define MGMT_OP_PIN_CODE_NEG_REPLY	0x0018
215 struct mgmt_cp_pin_code_neg_reply {
216 	bdaddr_t bdaddr;
217 } __packed;
218 
219 #define MGMT_OP_SET_IO_CAPABILITY	0x0019
220 struct mgmt_cp_set_io_capability {
221 	__u8 io_capability;
222 } __packed;
223 
224 #define MGMT_OP_PAIR_DEVICE		0x001A
225 struct mgmt_cp_pair_device {
226 	struct mgmt_addr_info addr;
227 	__u8 io_cap;
228 } __packed;
229 struct mgmt_rp_pair_device {
230 	struct mgmt_addr_info addr;
231 	__u8 status;
232 } __packed;
233 
234 #define MGMT_OP_CANCEL_PAIR_DEVICE	0x001B
235 
236 #define MGMT_OP_USER_CONFIRM_REPLY	0x001C
237 struct mgmt_cp_user_confirm_reply {
238 	bdaddr_t bdaddr;
239 } __packed;
240 struct mgmt_rp_user_confirm_reply {
241 	bdaddr_t bdaddr;
242 	__u8 status;
243 } __packed;
244 
245 #define MGMT_OP_USER_CONFIRM_NEG_REPLY	0x001D
246 struct mgmt_cp_user_confirm_neg_reply {
247 	bdaddr_t bdaddr;
248 } __packed;
249 
250 #define MGMT_OP_USER_PASSKEY_REPLY	0x001E
251 struct mgmt_cp_user_passkey_reply {
252 	bdaddr_t bdaddr;
253 	__le32 passkey;
254 } __packed;
255 struct mgmt_rp_user_passkey_reply {
256 	bdaddr_t bdaddr;
257 	__u8 status;
258 } __packed;
259 
260 #define MGMT_OP_USER_PASSKEY_NEG_REPLY	0x001F
261 struct mgmt_cp_user_passkey_neg_reply {
262 	bdaddr_t bdaddr;
263 } __packed;
264 
265 #define MGMT_OP_READ_LOCAL_OOB_DATA	0x0020
266 struct mgmt_rp_read_local_oob_data {
267 	__u8 hash[16];
268 	__u8 randomizer[16];
269 } __packed;
270 
271 #define MGMT_OP_ADD_REMOTE_OOB_DATA	0x0021
272 struct mgmt_cp_add_remote_oob_data {
273 	bdaddr_t bdaddr;
274 	__u8 hash[16];
275 	__u8 randomizer[16];
276 } __packed;
277 
278 #define MGMT_OP_REMOVE_REMOTE_OOB_DATA	0x0022
279 struct mgmt_cp_remove_remote_oob_data {
280 	bdaddr_t bdaddr;
281 } __packed;
282 
283 #define MGMT_OP_START_DISCOVERY		0x0023
284 struct mgmt_cp_start_discovery {
285 	__u8 type;
286 } __packed;
287 
288 #define MGMT_OP_STOP_DISCOVERY		0x0024
289 
290 #define MGMT_OP_CONFIRM_NAME		0x0025
291 struct mgmt_cp_confirm_name {
292 	bdaddr_t bdaddr;
293 	__u8 name_known;
294 } __packed;
295 struct mgmt_rp_confirm_name {
296 	bdaddr_t bdaddr;
297 	__u8 status;
298 } __packed;
299 
300 #define MGMT_OP_BLOCK_DEVICE		0x0026
301 struct mgmt_cp_block_device {
302 	bdaddr_t bdaddr;
303 } __packed;
304 
305 #define MGMT_OP_UNBLOCK_DEVICE		0x0027
306 struct mgmt_cp_unblock_device {
307 	bdaddr_t bdaddr;
308 } __packed;
309 
310 #define MGMT_EV_CMD_COMPLETE		0x0001
311 struct mgmt_ev_cmd_complete {
312 	__le16 opcode;
313 	__u8 data[0];
314 } __packed;
315 
316 #define MGMT_EV_CMD_STATUS		0x0002
317 struct mgmt_ev_cmd_status {
318 	__u8 status;
319 	__le16 opcode;
320 } __packed;
321 
322 #define MGMT_EV_CONTROLLER_ERROR	0x0003
323 struct mgmt_ev_controller_error {
324 	__u8 error_code;
325 } __packed;
326 
327 #define MGMT_EV_INDEX_ADDED		0x0004
328 
329 #define MGMT_EV_INDEX_REMOVED		0x0005
330 
331 #define MGMT_EV_NEW_SETTINGS		0x0006
332 
333 #define MGMT_EV_CLASS_OF_DEV_CHANGED	0x0007
334 struct mgmt_ev_class_of_dev_changed {
335 	__u8 dev_class[3];
336 };
337 
338 #define MGMT_EV_LOCAL_NAME_CHANGED	0x0008
339 struct mgmt_ev_local_name_changed {
340 	__u8 name[MGMT_MAX_NAME_LENGTH];
341 	__u8 short_name[MGMT_MAX_SHORT_NAME_LENGTH];
342 } __packed;
343 
344 #define MGMT_EV_NEW_LINK_KEY		0x0009
345 struct mgmt_ev_new_link_key {
346 	__u8 store_hint;
347 	struct mgmt_link_key_info key;
348 } __packed;
349 
350 #define MGMT_EV_NEW_LONG_TERM_KEY	0x000A
351 struct mgmt_ev_new_long_term_key {
352 	__u8 store_hint;
353 	struct mgmt_ltk_info key;
354 } __packed;
355 
356 #define MGMT_EV_DEVICE_CONNECTED	0x000B
357 struct mgmt_ev_device_connected {
358 	struct mgmt_addr_info addr;
359 	__le16 eir_len;
360 	__u8 eir[0];
361 } __packed;
362 
363 #define MGMT_EV_DEVICE_DISCONNECTED	0x000C
364 
365 #define MGMT_EV_CONNECT_FAILED		0x000D
366 struct mgmt_ev_connect_failed {
367 	struct mgmt_addr_info addr;
368 	__u8 status;
369 } __packed;
370 
371 #define MGMT_EV_PIN_CODE_REQUEST	0x000E
372 struct mgmt_ev_pin_code_request {
373 	bdaddr_t bdaddr;
374 	__u8 secure;
375 } __packed;
376 
377 #define MGMT_EV_USER_CONFIRM_REQUEST	0x000F
378 struct mgmt_ev_user_confirm_request {
379 	bdaddr_t bdaddr;
380 	__u8 confirm_hint;
381 	__le32 value;
382 } __packed;
383 
384 #define MGMT_EV_USER_PASSKEY_REQUEST	0x0010
385 struct mgmt_ev_user_passkey_request {
386 	bdaddr_t bdaddr;
387 } __packed;
388 
389 #define MGMT_EV_AUTH_FAILED		0x0011
390 struct mgmt_ev_auth_failed {
391 	bdaddr_t bdaddr;
392 	__u8 status;
393 } __packed;
394 
395 #define MGMT_EV_DEVICE_FOUND		0x0012
396 struct mgmt_ev_device_found {
397 	struct mgmt_addr_info addr;
398 	__s8 rssi;
399 	__u8 confirm_name;
400 	__le16 eir_len;
401 	__u8 eir[0];
402 } __packed;
403 
404 #define MGMT_EV_DISCOVERING		0x0013
405 
406 #define MGMT_EV_DEVICE_BLOCKED		0x0014
407 struct mgmt_ev_device_blocked {
408 	bdaddr_t bdaddr;
409 } __packed;
410 
411 #define MGMT_EV_DEVICE_UNBLOCKED	0x0015
412 struct mgmt_ev_device_unblocked {
413 	bdaddr_t bdaddr;
414 } __packed;
415