xref: /linux/include/net/bluetooth/mgmt.h (revision 9e8ba5f3ec35cba4fd8a8bebda548c4db2651e40)
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 
43 struct mgmt_hdr {
44 	__le16 opcode;
45 	__le16 index;
46 	__le16 len;
47 } __packed;
48 
49 #define MGMT_OP_READ_VERSION		0x0001
50 struct mgmt_rp_read_version {
51 	__u8 version;
52 	__le16 revision;
53 } __packed;
54 
55 #define MGMT_OP_READ_INDEX_LIST		0x0003
56 struct mgmt_rp_read_index_list {
57 	__le16 num_controllers;
58 	__le16 index[0];
59 } __packed;
60 
61 /* Reserve one extra byte for names in management messages so that they
62  * are always guaranteed to be nul-terminated */
63 #define MGMT_MAX_NAME_LENGTH		(HCI_MAX_NAME_LENGTH + 1)
64 
65 #define MGMT_OP_READ_INFO		0x0004
66 struct mgmt_rp_read_info {
67 	__u8 type;
68 	__u8 powered;
69 	__u8 connectable;
70 	__u8 discoverable;
71 	__u8 pairable;
72 	__u8 sec_mode;
73 	bdaddr_t bdaddr;
74 	__u8 dev_class[3];
75 	__u8 features[8];
76 	__u16 manufacturer;
77 	__u8 hci_ver;
78 	__u16 hci_rev;
79 	__u8 name[MGMT_MAX_NAME_LENGTH];
80 } __packed;
81 
82 struct mgmt_mode {
83 	__u8 val;
84 } __packed;
85 
86 #define MGMT_OP_SET_POWERED		0x0005
87 
88 #define MGMT_OP_SET_DISCOVERABLE	0x0006
89 struct mgmt_cp_set_discoverable {
90 	__u8 val;
91 	__u16 timeout;
92 } __packed;
93 
94 #define MGMT_OP_SET_CONNECTABLE		0x0007
95 
96 #define MGMT_OP_SET_PAIRABLE		0x0008
97 
98 #define MGMT_OP_ADD_UUID		0x0009
99 struct mgmt_cp_add_uuid {
100 	__u8 uuid[16];
101 	__u8 svc_hint;
102 } __packed;
103 
104 #define MGMT_OP_REMOVE_UUID		0x000A
105 struct mgmt_cp_remove_uuid {
106 	__u8 uuid[16];
107 } __packed;
108 
109 #define MGMT_OP_SET_DEV_CLASS		0x000B
110 struct mgmt_cp_set_dev_class {
111 	__u8 major;
112 	__u8 minor;
113 } __packed;
114 
115 #define MGMT_OP_SET_SERVICE_CACHE	0x000C
116 struct mgmt_cp_set_service_cache {
117 	__u8 enable;
118 } __packed;
119 
120 struct mgmt_link_key_info {
121 	bdaddr_t bdaddr;
122 	u8 type;
123 	u8 val[16];
124 	u8 pin_len;
125 } __packed;
126 
127 #define MGMT_OP_LOAD_LINK_KEYS		0x000D
128 struct mgmt_cp_load_link_keys {
129 	__u8 debug_keys;
130 	__le16 key_count;
131 	struct mgmt_link_key_info keys[0];
132 } __packed;
133 
134 #define MGMT_OP_REMOVE_KEYS		0x000E
135 struct mgmt_cp_remove_keys {
136 	bdaddr_t bdaddr;
137 	__u8 disconnect;
138 } __packed;
139 struct mgmt_rp_remove_keys {
140 	bdaddr_t bdaddr;
141 	__u8 status;
142 };
143 
144 #define MGMT_OP_DISCONNECT		0x000F
145 struct mgmt_cp_disconnect {
146 	bdaddr_t bdaddr;
147 } __packed;
148 struct mgmt_rp_disconnect {
149 	bdaddr_t bdaddr;
150 	__u8 status;
151 } __packed;
152 
153 #define MGMT_ADDR_BREDR			0x00
154 #define MGMT_ADDR_LE_PUBLIC		0x01
155 #define MGMT_ADDR_LE_RANDOM		0x02
156 #define MGMT_ADDR_INVALID		0xff
157 
158 struct mgmt_addr_info {
159 	bdaddr_t bdaddr;
160 	__u8 type;
161 } __packed;
162 
163 #define MGMT_OP_GET_CONNECTIONS		0x0010
164 struct mgmt_rp_get_connections {
165 	__le16 conn_count;
166 	struct mgmt_addr_info addr[0];
167 } __packed;
168 
169 #define MGMT_OP_PIN_CODE_REPLY		0x0011
170 struct mgmt_cp_pin_code_reply {
171 	bdaddr_t bdaddr;
172 	__u8 pin_len;
173 	__u8 pin_code[16];
174 } __packed;
175 struct mgmt_rp_pin_code_reply {
176 	bdaddr_t bdaddr;
177 	uint8_t status;
178 } __packed;
179 
180 #define MGMT_OP_PIN_CODE_NEG_REPLY	0x0012
181 struct mgmt_cp_pin_code_neg_reply {
182 	bdaddr_t bdaddr;
183 } __packed;
184 
185 #define MGMT_OP_SET_IO_CAPABILITY	0x0013
186 struct mgmt_cp_set_io_capability {
187 	__u8 io_capability;
188 } __packed;
189 
190 #define MGMT_OP_PAIR_DEVICE		0x0014
191 struct mgmt_cp_pair_device {
192 	struct mgmt_addr_info addr;
193 	__u8 io_cap;
194 } __packed;
195 struct mgmt_rp_pair_device {
196 	struct mgmt_addr_info addr;
197 	__u8 status;
198 } __packed;
199 
200 #define MGMT_OP_USER_CONFIRM_REPLY	0x0015
201 struct mgmt_cp_user_confirm_reply {
202 	bdaddr_t bdaddr;
203 } __packed;
204 struct mgmt_rp_user_confirm_reply {
205 	bdaddr_t bdaddr;
206 	__u8 status;
207 } __packed;
208 
209 #define MGMT_OP_USER_CONFIRM_NEG_REPLY	0x0016
210 
211 #define MGMT_OP_SET_LOCAL_NAME		0x0017
212 struct mgmt_cp_set_local_name {
213 	__u8 name[MGMT_MAX_NAME_LENGTH];
214 } __packed;
215 
216 #define MGMT_OP_READ_LOCAL_OOB_DATA	0x0018
217 struct mgmt_rp_read_local_oob_data {
218 	__u8 hash[16];
219 	__u8 randomizer[16];
220 } __packed;
221 
222 #define MGMT_OP_ADD_REMOTE_OOB_DATA	0x0019
223 struct mgmt_cp_add_remote_oob_data {
224 	bdaddr_t bdaddr;
225 	__u8 hash[16];
226 	__u8 randomizer[16];
227 } __packed;
228 
229 #define MGMT_OP_REMOVE_REMOTE_OOB_DATA	0x001A
230 struct mgmt_cp_remove_remote_oob_data {
231 	bdaddr_t bdaddr;
232 } __packed;
233 
234 #define MGMT_OP_START_DISCOVERY		0x001B
235 struct mgmt_cp_start_discovery {
236 	__u8 type;
237 } __packed;
238 
239 #define MGMT_OP_STOP_DISCOVERY		0x001C
240 
241 #define MGMT_OP_BLOCK_DEVICE		0x001D
242 struct mgmt_cp_block_device {
243 	bdaddr_t bdaddr;
244 } __packed;
245 
246 #define MGMT_OP_UNBLOCK_DEVICE		0x001E
247 struct mgmt_cp_unblock_device {
248 	bdaddr_t bdaddr;
249 } __packed;
250 
251 #define MGMT_OP_SET_FAST_CONNECTABLE	0x001F
252 struct mgmt_cp_set_fast_connectable {
253 	__u8 enable;
254 } __packed;
255 
256 #define MGMT_OP_USER_PASSKEY_REPLY	0x0020
257 struct mgmt_cp_user_passkey_reply {
258 	bdaddr_t bdaddr;
259 	__le32 passkey;
260 } __packed;
261 
262 #define MGMT_OP_USER_PASSKEY_NEG_REPLY	0x0021
263 struct mgmt_cp_user_passkey_neg_reply {
264 	bdaddr_t bdaddr;
265 } __packed;
266 
267 #define MGMT_EV_CMD_COMPLETE		0x0001
268 struct mgmt_ev_cmd_complete {
269 	__le16 opcode;
270 	__u8 data[0];
271 } __packed;
272 
273 #define MGMT_EV_CMD_STATUS		0x0002
274 struct mgmt_ev_cmd_status {
275 	__u8 status;
276 	__le16 opcode;
277 } __packed;
278 
279 #define MGMT_EV_CONTROLLER_ERROR	0x0003
280 struct mgmt_ev_controller_error {
281 	__u8 error_code;
282 } __packed;
283 
284 #define MGMT_EV_INDEX_ADDED		0x0004
285 
286 #define MGMT_EV_INDEX_REMOVED		0x0005
287 
288 #define MGMT_EV_POWERED			0x0006
289 
290 #define MGMT_EV_DISCOVERABLE		0x0007
291 
292 #define MGMT_EV_CONNECTABLE		0x0008
293 
294 #define MGMT_EV_PAIRABLE		0x0009
295 
296 #define MGMT_EV_NEW_LINK_KEY		0x000A
297 struct mgmt_ev_new_link_key {
298 	__u8 store_hint;
299 	struct mgmt_link_key_info key;
300 } __packed;
301 
302 #define MGMT_EV_CONNECTED		0x000B
303 
304 #define MGMT_EV_DISCONNECTED		0x000C
305 
306 #define MGMT_EV_CONNECT_FAILED		0x000D
307 struct mgmt_ev_connect_failed {
308 	struct mgmt_addr_info addr;
309 	__u8 status;
310 } __packed;
311 
312 #define MGMT_EV_PIN_CODE_REQUEST	0x000E
313 struct mgmt_ev_pin_code_request {
314 	bdaddr_t bdaddr;
315 	__u8 secure;
316 } __packed;
317 
318 #define MGMT_EV_USER_CONFIRM_REQUEST	0x000F
319 struct mgmt_ev_user_confirm_request {
320 	bdaddr_t bdaddr;
321 	__u8 confirm_hint;
322 	__le32 value;
323 } __packed;
324 
325 #define MGMT_EV_AUTH_FAILED		0x0010
326 struct mgmt_ev_auth_failed {
327 	bdaddr_t bdaddr;
328 	__u8 status;
329 } __packed;
330 
331 #define MGMT_EV_LOCAL_NAME_CHANGED	0x0011
332 struct mgmt_ev_local_name_changed {
333 	__u8 name[MGMT_MAX_NAME_LENGTH];
334 } __packed;
335 
336 #define MGMT_EV_DEVICE_FOUND		0x0012
337 struct mgmt_ev_device_found {
338 	struct mgmt_addr_info addr;
339 	__u8 dev_class[3];
340 	__s8 rssi;
341 	__u8 eir[HCI_MAX_EIR_LENGTH];
342 } __packed;
343 
344 #define MGMT_EV_REMOTE_NAME		0x0013
345 struct mgmt_ev_remote_name {
346 	bdaddr_t bdaddr;
347 	__u8 name[MGMT_MAX_NAME_LENGTH];
348 } __packed;
349 
350 #define MGMT_EV_DISCOVERING		0x0014
351 
352 #define MGMT_EV_DEVICE_BLOCKED		0x0015
353 struct mgmt_ev_device_blocked {
354 	bdaddr_t bdaddr;
355 } __packed;
356 
357 #define MGMT_EV_DEVICE_UNBLOCKED	0x0016
358 struct mgmt_ev_device_unblocked {
359 	bdaddr_t bdaddr;
360 } __packed;
361 
362 #define MGMT_EV_USER_PASSKEY_REQUEST	0x0017
363 struct mgmt_ev_user_passkey_request {
364 	bdaddr_t bdaddr;
365 } __packed;
366