xref: /openbmc/linux/include/net/bluetooth/mgmt.h (revision aee9b218)
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	(10 + 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 } __packed;
139 
140 #define MGMT_OP_ADD_UUID		0x0010
141 struct mgmt_cp_add_uuid {
142 	__u8 uuid[16];
143 	__u8 svc_hint;
144 } __packed;
145 
146 #define MGMT_OP_REMOVE_UUID		0x0011
147 struct mgmt_cp_remove_uuid {
148 	__u8 uuid[16];
149 } __packed;
150 
151 struct mgmt_link_key_info {
152 	struct mgmt_addr_info addr;
153 	u8 type;
154 	u8 val[16];
155 	u8 pin_len;
156 } __packed;
157 
158 #define MGMT_OP_LOAD_LINK_KEYS		0x0012
159 struct mgmt_cp_load_link_keys {
160 	__u8 debug_keys;
161 	__le16 key_count;
162 	struct mgmt_link_key_info keys[0];
163 } __packed;
164 
165 struct mgmt_ltk_info {
166 	struct mgmt_addr_info addr;
167 	__u8 authenticated;
168 	__u8 master;
169 	__u8 enc_size;
170 	__le16 ediv;
171 	__u8 rand[8];
172 	__u8 val[16];
173 } __packed;
174 
175 #define MGMT_OP_LOAD_LONG_TERM_KEYS	0x0013
176 struct mgmt_cp_load_long_term_keys {
177 	__le16 key_count;
178 	struct mgmt_ltk_info keys[0];
179 } __packed;
180 
181 #define MGMT_OP_DISCONNECT		0x0014
182 struct mgmt_cp_disconnect {
183 	struct mgmt_addr_info addr;
184 } __packed;
185 struct mgmt_rp_disconnect {
186 	struct mgmt_addr_info addr;
187 } __packed;
188 
189 #define MGMT_OP_GET_CONNECTIONS		0x0015
190 struct mgmt_rp_get_connections {
191 	__le16 conn_count;
192 	struct mgmt_addr_info addr[0];
193 } __packed;
194 
195 #define MGMT_OP_PIN_CODE_REPLY		0x0016
196 struct mgmt_cp_pin_code_reply {
197 	struct mgmt_addr_info addr;
198 	__u8 pin_len;
199 	__u8 pin_code[16];
200 } __packed;
201 struct mgmt_rp_pin_code_reply {
202 	struct mgmt_addr_info addr;
203 } __packed;
204 
205 #define MGMT_OP_PIN_CODE_NEG_REPLY	0x0017
206 struct mgmt_cp_pin_code_neg_reply {
207 	struct mgmt_addr_info addr;
208 } __packed;
209 
210 #define MGMT_OP_SET_IO_CAPABILITY	0x0018
211 struct mgmt_cp_set_io_capability {
212 	__u8 io_capability;
213 } __packed;
214 
215 #define MGMT_OP_PAIR_DEVICE		0x0019
216 struct mgmt_cp_pair_device {
217 	struct mgmt_addr_info addr;
218 	__u8 io_cap;
219 } __packed;
220 struct mgmt_rp_pair_device {
221 	struct mgmt_addr_info addr;
222 } __packed;
223 
224 #define MGMT_OP_CANCEL_PAIR_DEVICE	0x001A
225 
226 #define MGMT_OP_UNPAIR_DEVICE		0x001B
227 struct mgmt_cp_unpair_device {
228 	struct mgmt_addr_info addr;
229 	__u8 disconnect;
230 } __packed;
231 struct mgmt_rp_unpair_device {
232 	struct mgmt_addr_info addr;
233 };
234 
235 #define MGMT_OP_USER_CONFIRM_REPLY	0x001C
236 struct mgmt_cp_user_confirm_reply {
237 	struct mgmt_addr_info addr;
238 } __packed;
239 struct mgmt_rp_user_confirm_reply {
240 	struct mgmt_addr_info addr;
241 } __packed;
242 
243 #define MGMT_OP_USER_CONFIRM_NEG_REPLY	0x001D
244 struct mgmt_cp_user_confirm_neg_reply {
245 	struct mgmt_addr_info addr;
246 } __packed;
247 
248 #define MGMT_OP_USER_PASSKEY_REPLY	0x001E
249 struct mgmt_cp_user_passkey_reply {
250 	struct mgmt_addr_info addr;
251 	__le32 passkey;
252 } __packed;
253 struct mgmt_rp_user_passkey_reply {
254 	struct mgmt_addr_info addr;
255 } __packed;
256 
257 #define MGMT_OP_USER_PASSKEY_NEG_REPLY	0x001F
258 struct mgmt_cp_user_passkey_neg_reply {
259 	struct mgmt_addr_info addr;
260 } __packed;
261 
262 #define MGMT_OP_READ_LOCAL_OOB_DATA	0x0020
263 struct mgmt_rp_read_local_oob_data {
264 	__u8 hash[16];
265 	__u8 randomizer[16];
266 } __packed;
267 
268 #define MGMT_OP_ADD_REMOTE_OOB_DATA	0x0021
269 struct mgmt_cp_add_remote_oob_data {
270 	struct mgmt_addr_info addr;
271 	__u8 hash[16];
272 	__u8 randomizer[16];
273 } __packed;
274 
275 #define MGMT_OP_REMOVE_REMOTE_OOB_DATA	0x0022
276 struct mgmt_cp_remove_remote_oob_data {
277 	struct mgmt_addr_info addr;
278 } __packed;
279 
280 #define MGMT_OP_START_DISCOVERY		0x0023
281 struct mgmt_cp_start_discovery {
282 	__u8 type;
283 } __packed;
284 
285 #define MGMT_OP_STOP_DISCOVERY		0x0024
286 
287 #define MGMT_OP_CONFIRM_NAME		0x0025
288 struct mgmt_cp_confirm_name {
289 	struct mgmt_addr_info addr;
290 	__u8 name_known;
291 } __packed;
292 struct mgmt_rp_confirm_name {
293 	struct mgmt_addr_info addr;
294 } __packed;
295 
296 #define MGMT_OP_BLOCK_DEVICE		0x0026
297 struct mgmt_cp_block_device {
298 	struct mgmt_addr_info addr;
299 } __packed;
300 
301 #define MGMT_OP_UNBLOCK_DEVICE		0x0027
302 struct mgmt_cp_unblock_device {
303 	struct mgmt_addr_info addr;
304 } __packed;
305 
306 #define MGMT_EV_CMD_COMPLETE		0x0001
307 struct mgmt_ev_cmd_complete {
308 	__le16 opcode;
309 	__u8 status;
310 	__u8 data[0];
311 } __packed;
312 
313 #define MGMT_EV_CMD_STATUS		0x0002
314 struct mgmt_ev_cmd_status {
315 	__le16 opcode;
316 	__u8 status;
317 } __packed;
318 
319 #define MGMT_EV_CONTROLLER_ERROR	0x0003
320 struct mgmt_ev_controller_error {
321 	__u8 error_code;
322 } __packed;
323 
324 #define MGMT_EV_INDEX_ADDED		0x0004
325 
326 #define MGMT_EV_INDEX_REMOVED		0x0005
327 
328 #define MGMT_EV_NEW_SETTINGS		0x0006
329 
330 #define MGMT_EV_CLASS_OF_DEV_CHANGED	0x0007
331 struct mgmt_ev_class_of_dev_changed {
332 	__u8 dev_class[3];
333 };
334 
335 #define MGMT_EV_LOCAL_NAME_CHANGED	0x0008
336 struct mgmt_ev_local_name_changed {
337 	__u8 name[MGMT_MAX_NAME_LENGTH];
338 	__u8 short_name[MGMT_MAX_SHORT_NAME_LENGTH];
339 } __packed;
340 
341 #define MGMT_EV_NEW_LINK_KEY		0x0009
342 struct mgmt_ev_new_link_key {
343 	__u8 store_hint;
344 	struct mgmt_link_key_info key;
345 } __packed;
346 
347 #define MGMT_EV_NEW_LONG_TERM_KEY	0x000A
348 struct mgmt_ev_new_long_term_key {
349 	__u8 store_hint;
350 	struct mgmt_ltk_info key;
351 } __packed;
352 
353 #define MGMT_EV_DEVICE_CONNECTED	0x000B
354 struct mgmt_ev_device_connected {
355 	struct mgmt_addr_info addr;
356 	__le16 eir_len;
357 	__u8 eir[0];
358 } __packed;
359 
360 #define MGMT_EV_DEVICE_DISCONNECTED	0x000C
361 
362 #define MGMT_EV_CONNECT_FAILED		0x000D
363 struct mgmt_ev_connect_failed {
364 	struct mgmt_addr_info addr;
365 	__u8 status;
366 } __packed;
367 
368 #define MGMT_EV_PIN_CODE_REQUEST	0x000E
369 struct mgmt_ev_pin_code_request {
370 	struct mgmt_addr_info addr;
371 	__u8 secure;
372 } __packed;
373 
374 #define MGMT_EV_USER_CONFIRM_REQUEST	0x000F
375 struct mgmt_ev_user_confirm_request {
376 	struct mgmt_addr_info addr;
377 	__u8 confirm_hint;
378 	__le32 value;
379 } __packed;
380 
381 #define MGMT_EV_USER_PASSKEY_REQUEST	0x0010
382 struct mgmt_ev_user_passkey_request {
383 	struct mgmt_addr_info addr;
384 } __packed;
385 
386 #define MGMT_EV_AUTH_FAILED		0x0011
387 struct mgmt_ev_auth_failed {
388 	struct mgmt_addr_info addr;
389 	__u8 status;
390 } __packed;
391 
392 #define MGMT_EV_DEVICE_FOUND		0x0012
393 struct mgmt_ev_device_found {
394 	struct mgmt_addr_info addr;
395 	__s8 rssi;
396 	__u8 confirm_name;
397 	__le16 eir_len;
398 	__u8 eir[0];
399 } __packed;
400 
401 #define MGMT_EV_DISCOVERING		0x0013
402 
403 #define MGMT_EV_DEVICE_BLOCKED		0x0014
404 struct mgmt_ev_device_blocked {
405 	struct mgmt_addr_info addr;
406 } __packed;
407 
408 #define MGMT_EV_DEVICE_UNBLOCKED	0x0015
409 struct mgmt_ev_device_unblocked {
410 	struct mgmt_addr_info addr;
411 } __packed;
412 
413 #define MGMT_EV_DEVICE_UNPAIRED		0x0016
414 struct mgmt_ev_device_unpaired {
415 	struct mgmt_addr_info addr;
416 } __packed;
417