xref: /openbmc/linux/include/net/bluetooth/hci.h (revision 220b881a)
1 /*
2    BlueZ - Bluetooth protocol stack for Linux
3    Copyright (C) 2000-2001 Qualcomm Incorporated
4 
5    Written 2000,2001 by Maxim Krasnyansky <maxk@qualcomm.com>
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 #ifndef __HCI_H
26 #define __HCI_H
27 
28 #define HCI_MAX_ACL_SIZE	1024
29 #define HCI_MAX_SCO_SIZE	255
30 #define HCI_MAX_EVENT_SIZE	260
31 #define HCI_MAX_FRAME_SIZE	(HCI_MAX_ACL_SIZE + 4)
32 
33 /* HCI dev events */
34 #define HCI_DEV_REG			1
35 #define HCI_DEV_UNREG			2
36 #define HCI_DEV_UP			3
37 #define HCI_DEV_DOWN			4
38 #define HCI_DEV_SUSPEND			5
39 #define HCI_DEV_RESUME			6
40 
41 /* HCI notify events */
42 #define HCI_NOTIFY_CONN_ADD		1
43 #define HCI_NOTIFY_CONN_DEL		2
44 #define HCI_NOTIFY_VOICE_SETTING	3
45 
46 /* HCI bus types */
47 #define HCI_VIRTUAL	0
48 #define HCI_USB		1
49 #define HCI_PCCARD	2
50 #define HCI_UART	3
51 #define HCI_RS232	4
52 #define HCI_PCI		5
53 #define HCI_SDIO	6
54 
55 /* HCI controller types */
56 #define HCI_BREDR	0x00
57 #define HCI_AMP		0x01
58 
59 /* HCI device quirks */
60 enum {
61 	HCI_QUIRK_NO_RESET,
62 	HCI_QUIRK_RAW_DEVICE,
63 	HCI_QUIRK_FIXUP_BUFFER_SIZE
64 };
65 
66 /* HCI device flags */
67 enum {
68 	HCI_UP,
69 	HCI_INIT,
70 	HCI_RUNNING,
71 
72 	HCI_PSCAN,
73 	HCI_ISCAN,
74 	HCI_AUTH,
75 	HCI_ENCRYPT,
76 	HCI_INQUIRY,
77 
78 	HCI_RAW,
79 
80 	HCI_SETUP,
81 	HCI_AUTO_OFF,
82 	HCI_MGMT,
83 	HCI_PAIRABLE,
84 	HCI_SERVICE_CACHE,
85 	HCI_LINK_KEYS,
86 	HCI_DEBUG_KEYS,
87 
88 	HCI_RESET,
89 };
90 
91 /* HCI ioctl defines */
92 #define HCIDEVUP	_IOW('H', 201, int)
93 #define HCIDEVDOWN	_IOW('H', 202, int)
94 #define HCIDEVRESET	_IOW('H', 203, int)
95 #define HCIDEVRESTAT	_IOW('H', 204, int)
96 
97 #define HCIGETDEVLIST	_IOR('H', 210, int)
98 #define HCIGETDEVINFO	_IOR('H', 211, int)
99 #define HCIGETCONNLIST	_IOR('H', 212, int)
100 #define HCIGETCONNINFO	_IOR('H', 213, int)
101 #define HCIGETAUTHINFO	_IOR('H', 215, int)
102 
103 #define HCISETRAW	_IOW('H', 220, int)
104 #define HCISETSCAN	_IOW('H', 221, int)
105 #define HCISETAUTH	_IOW('H', 222, int)
106 #define HCISETENCRYPT	_IOW('H', 223, int)
107 #define HCISETPTYPE	_IOW('H', 224, int)
108 #define HCISETLINKPOL	_IOW('H', 225, int)
109 #define HCISETLINKMODE	_IOW('H', 226, int)
110 #define HCISETACLMTU	_IOW('H', 227, int)
111 #define HCISETSCOMTU	_IOW('H', 228, int)
112 
113 #define HCIBLOCKADDR	_IOW('H', 230, int)
114 #define HCIUNBLOCKADDR	_IOW('H', 231, int)
115 
116 #define HCIINQUIRY	_IOR('H', 240, int)
117 
118 /* HCI timeouts */
119 #define HCI_CONNECT_TIMEOUT	(40000)	/* 40 seconds */
120 #define HCI_DISCONN_TIMEOUT	(2000)	/* 2 seconds */
121 #define HCI_PAIRING_TIMEOUT	(60000)	/* 60 seconds */
122 #define HCI_IDLE_TIMEOUT	(6000)	/* 6 seconds */
123 #define HCI_INIT_TIMEOUT	(10000)	/* 10 seconds */
124 #define HCI_CMD_TIMEOUT		(1000)	/* 1 seconds */
125 
126 /* HCI data types */
127 #define HCI_COMMAND_PKT		0x01
128 #define HCI_ACLDATA_PKT		0x02
129 #define HCI_SCODATA_PKT		0x03
130 #define HCI_EVENT_PKT		0x04
131 #define HCI_VENDOR_PKT		0xff
132 
133 /* HCI packet types */
134 #define HCI_DM1		0x0008
135 #define HCI_DM3		0x0400
136 #define HCI_DM5		0x4000
137 #define HCI_DH1		0x0010
138 #define HCI_DH3		0x0800
139 #define HCI_DH5		0x8000
140 
141 #define HCI_HV1		0x0020
142 #define HCI_HV2		0x0040
143 #define HCI_HV3		0x0080
144 
145 #define SCO_PTYPE_MASK	(HCI_HV1 | HCI_HV2 | HCI_HV3)
146 #define ACL_PTYPE_MASK	(~SCO_PTYPE_MASK)
147 
148 /* eSCO packet types */
149 #define ESCO_HV1	0x0001
150 #define ESCO_HV2	0x0002
151 #define ESCO_HV3	0x0004
152 #define ESCO_EV3	0x0008
153 #define ESCO_EV4	0x0010
154 #define ESCO_EV5	0x0020
155 #define ESCO_2EV3	0x0040
156 #define ESCO_3EV3	0x0080
157 #define ESCO_2EV5	0x0100
158 #define ESCO_3EV5	0x0200
159 
160 #define SCO_ESCO_MASK  (ESCO_HV1 | ESCO_HV2 | ESCO_HV3)
161 #define EDR_ESCO_MASK  (ESCO_2EV3 | ESCO_3EV3 | ESCO_2EV5 | ESCO_3EV5)
162 
163 /* ACL flags */
164 #define ACL_START_NO_FLUSH	0x00
165 #define ACL_CONT		0x01
166 #define ACL_START		0x02
167 #define ACL_ACTIVE_BCAST	0x04
168 #define ACL_PICO_BCAST		0x08
169 
170 /* Baseband links */
171 #define SCO_LINK	0x00
172 #define ACL_LINK	0x01
173 #define ESCO_LINK	0x02
174 /* Low Energy links do not have defined link type. Use invented one */
175 #define LE_LINK		0x80
176 
177 /* LMP features */
178 #define LMP_3SLOT	0x01
179 #define LMP_5SLOT	0x02
180 #define LMP_ENCRYPT	0x04
181 #define LMP_SOFFSET	0x08
182 #define LMP_TACCURACY	0x10
183 #define LMP_RSWITCH	0x20
184 #define LMP_HOLD	0x40
185 #define LMP_SNIFF	0x80
186 
187 #define LMP_PARK	0x01
188 #define LMP_RSSI	0x02
189 #define LMP_QUALITY	0x04
190 #define LMP_SCO		0x08
191 #define LMP_HV2		0x10
192 #define LMP_HV3		0x20
193 #define LMP_ULAW	0x40
194 #define LMP_ALAW	0x80
195 
196 #define LMP_CVSD	0x01
197 #define LMP_PSCHEME	0x02
198 #define LMP_PCONTROL	0x04
199 
200 #define LMP_RSSI_INQ	0x40
201 #define LMP_ESCO	0x80
202 
203 #define LMP_EV4		0x01
204 #define LMP_EV5		0x02
205 #define LMP_LE		0x40
206 
207 #define LMP_SNIFF_SUBR	0x02
208 #define LMP_PAUSE_ENC	0x04
209 #define LMP_EDR_ESCO_2M	0x20
210 #define LMP_EDR_ESCO_3M	0x40
211 #define LMP_EDR_3S_ESCO	0x80
212 
213 #define LMP_EXT_INQ	0x01
214 #define LMP_SIMPLE_PAIR	0x08
215 #define LMP_NO_FLUSH	0x40
216 
217 #define LMP_LSTO	0x01
218 #define LMP_INQ_TX_PWR	0x02
219 
220 /* Connection modes */
221 #define HCI_CM_ACTIVE	0x0000
222 #define HCI_CM_HOLD	0x0001
223 #define HCI_CM_SNIFF	0x0002
224 #define HCI_CM_PARK	0x0003
225 
226 /* Link policies */
227 #define HCI_LP_RSWITCH	0x0001
228 #define HCI_LP_HOLD	0x0002
229 #define HCI_LP_SNIFF	0x0004
230 #define HCI_LP_PARK	0x0008
231 
232 /* Link modes */
233 #define HCI_LM_ACCEPT	0x8000
234 #define HCI_LM_MASTER	0x0001
235 #define HCI_LM_AUTH	0x0002
236 #define HCI_LM_ENCRYPT	0x0004
237 #define HCI_LM_TRUSTED	0x0008
238 #define HCI_LM_RELIABLE	0x0010
239 #define HCI_LM_SECURE	0x0020
240 
241 /* Authentication types */
242 #define HCI_AT_NO_BONDING		0x00
243 #define HCI_AT_NO_BONDING_MITM		0x01
244 #define HCI_AT_DEDICATED_BONDING	0x02
245 #define HCI_AT_DEDICATED_BONDING_MITM	0x03
246 #define HCI_AT_GENERAL_BONDING		0x04
247 #define HCI_AT_GENERAL_BONDING_MITM	0x05
248 
249 /* -----  HCI Commands ---- */
250 #define HCI_OP_NOP			0x0000
251 
252 #define HCI_OP_INQUIRY			0x0401
253 struct hci_cp_inquiry {
254 	__u8     lap[3];
255 	__u8     length;
256 	__u8     num_rsp;
257 } __packed;
258 
259 #define HCI_OP_INQUIRY_CANCEL		0x0402
260 
261 #define HCI_OP_EXIT_PERIODIC_INQ	0x0404
262 
263 #define HCI_OP_CREATE_CONN		0x0405
264 struct hci_cp_create_conn {
265 	bdaddr_t bdaddr;
266 	__le16   pkt_type;
267 	__u8     pscan_rep_mode;
268 	__u8     pscan_mode;
269 	__le16   clock_offset;
270 	__u8     role_switch;
271 } __packed;
272 
273 #define HCI_OP_DISCONNECT		0x0406
274 struct hci_cp_disconnect {
275 	__le16   handle;
276 	__u8     reason;
277 } __packed;
278 
279 #define HCI_OP_ADD_SCO			0x0407
280 struct hci_cp_add_sco {
281 	__le16   handle;
282 	__le16   pkt_type;
283 } __packed;
284 
285 #define HCI_OP_CREATE_CONN_CANCEL	0x0408
286 struct hci_cp_create_conn_cancel {
287 	bdaddr_t bdaddr;
288 } __packed;
289 
290 #define HCI_OP_ACCEPT_CONN_REQ		0x0409
291 struct hci_cp_accept_conn_req {
292 	bdaddr_t bdaddr;
293 	__u8     role;
294 } __packed;
295 
296 #define HCI_OP_REJECT_CONN_REQ		0x040a
297 struct hci_cp_reject_conn_req {
298 	bdaddr_t bdaddr;
299 	__u8     reason;
300 } __packed;
301 
302 #define HCI_OP_LINK_KEY_REPLY		0x040b
303 struct hci_cp_link_key_reply {
304 	bdaddr_t bdaddr;
305 	__u8     link_key[16];
306 } __packed;
307 
308 #define HCI_OP_LINK_KEY_NEG_REPLY	0x040c
309 struct hci_cp_link_key_neg_reply {
310 	bdaddr_t bdaddr;
311 } __packed;
312 
313 #define HCI_OP_PIN_CODE_REPLY		0x040d
314 struct hci_cp_pin_code_reply {
315 	bdaddr_t bdaddr;
316 	__u8     pin_len;
317 	__u8     pin_code[16];
318 } __packed;
319 struct hci_rp_pin_code_reply {
320 	__u8     status;
321 	bdaddr_t bdaddr;
322 } __packed;
323 
324 #define HCI_OP_PIN_CODE_NEG_REPLY	0x040e
325 struct hci_cp_pin_code_neg_reply {
326 	bdaddr_t bdaddr;
327 } __packed;
328 struct hci_rp_pin_code_neg_reply {
329 	__u8     status;
330 	bdaddr_t bdaddr;
331 } __packed;
332 
333 #define HCI_OP_CHANGE_CONN_PTYPE	0x040f
334 struct hci_cp_change_conn_ptype {
335 	__le16   handle;
336 	__le16   pkt_type;
337 } __packed;
338 
339 #define HCI_OP_AUTH_REQUESTED		0x0411
340 struct hci_cp_auth_requested {
341 	__le16   handle;
342 } __packed;
343 
344 #define HCI_OP_SET_CONN_ENCRYPT		0x0413
345 struct hci_cp_set_conn_encrypt {
346 	__le16   handle;
347 	__u8     encrypt;
348 } __packed;
349 
350 #define HCI_OP_CHANGE_CONN_LINK_KEY	0x0415
351 struct hci_cp_change_conn_link_key {
352 	__le16   handle;
353 } __packed;
354 
355 #define HCI_OP_REMOTE_NAME_REQ		0x0419
356 struct hci_cp_remote_name_req {
357 	bdaddr_t bdaddr;
358 	__u8     pscan_rep_mode;
359 	__u8     pscan_mode;
360 	__le16   clock_offset;
361 } __packed;
362 
363 #define HCI_OP_REMOTE_NAME_REQ_CANCEL	0x041a
364 struct hci_cp_remote_name_req_cancel {
365 	bdaddr_t bdaddr;
366 } __packed;
367 
368 #define HCI_OP_READ_REMOTE_FEATURES	0x041b
369 struct hci_cp_read_remote_features {
370 	__le16   handle;
371 } __packed;
372 
373 #define HCI_OP_READ_REMOTE_EXT_FEATURES	0x041c
374 struct hci_cp_read_remote_ext_features {
375 	__le16   handle;
376 	__u8     page;
377 } __packed;
378 
379 #define HCI_OP_READ_REMOTE_VERSION	0x041d
380 struct hci_cp_read_remote_version {
381 	__le16   handle;
382 } __packed;
383 
384 #define HCI_OP_SETUP_SYNC_CONN		0x0428
385 struct hci_cp_setup_sync_conn {
386 	__le16   handle;
387 	__le32   tx_bandwidth;
388 	__le32   rx_bandwidth;
389 	__le16   max_latency;
390 	__le16   voice_setting;
391 	__u8     retrans_effort;
392 	__le16   pkt_type;
393 } __packed;
394 
395 #define HCI_OP_ACCEPT_SYNC_CONN_REQ	0x0429
396 struct hci_cp_accept_sync_conn_req {
397 	bdaddr_t bdaddr;
398 	__le32   tx_bandwidth;
399 	__le32   rx_bandwidth;
400 	__le16   max_latency;
401 	__le16   content_format;
402 	__u8     retrans_effort;
403 	__le16   pkt_type;
404 } __packed;
405 
406 #define HCI_OP_REJECT_SYNC_CONN_REQ	0x042a
407 struct hci_cp_reject_sync_conn_req {
408 	bdaddr_t bdaddr;
409 	__u8     reason;
410 } __packed;
411 
412 #define HCI_OP_IO_CAPABILITY_REPLY	0x042b
413 struct hci_cp_io_capability_reply {
414 	bdaddr_t bdaddr;
415 	__u8     capability;
416 	__u8     oob_data;
417 	__u8     authentication;
418 } __packed;
419 
420 #define HCI_OP_USER_CONFIRM_REPLY		0x042c
421 struct hci_cp_user_confirm_reply {
422 	bdaddr_t bdaddr;
423 } __packed;
424 struct hci_rp_user_confirm_reply {
425 	__u8     status;
426 	bdaddr_t bdaddr;
427 } __packed;
428 
429 #define HCI_OP_USER_CONFIRM_NEG_REPLY	0x042d
430 
431 #define HCI_OP_REMOTE_OOB_DATA_REPLY	0x0430
432 struct hci_cp_remote_oob_data_reply {
433 	bdaddr_t bdaddr;
434 	__u8     hash[16];
435 	__u8     randomizer[16];
436 } __packed;
437 
438 #define HCI_OP_REMOTE_OOB_DATA_NEG_REPLY	0x0433
439 struct hci_cp_remote_oob_data_neg_reply {
440 	bdaddr_t bdaddr;
441 } __packed;
442 
443 #define HCI_OP_IO_CAPABILITY_NEG_REPLY	0x0434
444 struct hci_cp_io_capability_neg_reply {
445 	bdaddr_t bdaddr;
446 	__u8     reason;
447 } __packed;
448 
449 #define HCI_OP_SNIFF_MODE		0x0803
450 struct hci_cp_sniff_mode {
451 	__le16   handle;
452 	__le16   max_interval;
453 	__le16   min_interval;
454 	__le16   attempt;
455 	__le16   timeout;
456 } __packed;
457 
458 #define HCI_OP_EXIT_SNIFF_MODE		0x0804
459 struct hci_cp_exit_sniff_mode {
460 	__le16   handle;
461 } __packed;
462 
463 #define HCI_OP_ROLE_DISCOVERY		0x0809
464 struct hci_cp_role_discovery {
465 	__le16   handle;
466 } __packed;
467 struct hci_rp_role_discovery {
468 	__u8     status;
469 	__le16   handle;
470 	__u8     role;
471 } __packed;
472 
473 #define HCI_OP_SWITCH_ROLE		0x080b
474 struct hci_cp_switch_role {
475 	bdaddr_t bdaddr;
476 	__u8     role;
477 } __packed;
478 
479 #define HCI_OP_READ_LINK_POLICY		0x080c
480 struct hci_cp_read_link_policy {
481 	__le16   handle;
482 } __packed;
483 struct hci_rp_read_link_policy {
484 	__u8     status;
485 	__le16   handle;
486 	__le16   policy;
487 } __packed;
488 
489 #define HCI_OP_WRITE_LINK_POLICY	0x080d
490 struct hci_cp_write_link_policy {
491 	__le16   handle;
492 	__le16   policy;
493 } __packed;
494 struct hci_rp_write_link_policy {
495 	__u8     status;
496 	__le16   handle;
497 } __packed;
498 
499 #define HCI_OP_READ_DEF_LINK_POLICY	0x080e
500 struct hci_rp_read_def_link_policy {
501 	__u8     status;
502 	__le16   policy;
503 } __packed;
504 
505 #define HCI_OP_WRITE_DEF_LINK_POLICY	0x080f
506 struct hci_cp_write_def_link_policy {
507 	__le16   policy;
508 } __packed;
509 
510 #define HCI_OP_SNIFF_SUBRATE		0x0811
511 struct hci_cp_sniff_subrate {
512 	__le16   handle;
513 	__le16   max_latency;
514 	__le16   min_remote_timeout;
515 	__le16   min_local_timeout;
516 } __packed;
517 
518 #define HCI_OP_SET_EVENT_MASK		0x0c01
519 struct hci_cp_set_event_mask {
520 	__u8     mask[8];
521 } __packed;
522 
523 #define HCI_OP_RESET			0x0c03
524 
525 #define HCI_OP_SET_EVENT_FLT		0x0c05
526 struct hci_cp_set_event_flt {
527 	__u8     flt_type;
528 	__u8     cond_type;
529 	__u8     condition[0];
530 } __packed;
531 
532 /* Filter types */
533 #define HCI_FLT_CLEAR_ALL	0x00
534 #define HCI_FLT_INQ_RESULT	0x01
535 #define HCI_FLT_CONN_SETUP	0x02
536 
537 /* CONN_SETUP Condition types */
538 #define HCI_CONN_SETUP_ALLOW_ALL	0x00
539 #define HCI_CONN_SETUP_ALLOW_CLASS	0x01
540 #define HCI_CONN_SETUP_ALLOW_BDADDR	0x02
541 
542 /* CONN_SETUP Conditions */
543 #define HCI_CONN_SETUP_AUTO_OFF	0x01
544 #define HCI_CONN_SETUP_AUTO_ON	0x02
545 
546 #define HCI_OP_DELETE_STORED_LINK_KEY	0x0c12
547 struct hci_cp_delete_stored_link_key {
548 	bdaddr_t bdaddr;
549 	__u8     delete_all;
550 } __packed;
551 
552 #define HCI_MAX_NAME_LENGTH		248
553 
554 #define HCI_OP_WRITE_LOCAL_NAME		0x0c13
555 struct hci_cp_write_local_name {
556 	__u8     name[HCI_MAX_NAME_LENGTH];
557 } __packed;
558 
559 #define HCI_OP_READ_LOCAL_NAME		0x0c14
560 struct hci_rp_read_local_name {
561 	__u8     status;
562 	__u8     name[HCI_MAX_NAME_LENGTH];
563 } __packed;
564 
565 #define HCI_OP_WRITE_CA_TIMEOUT		0x0c16
566 
567 #define HCI_OP_WRITE_PG_TIMEOUT		0x0c18
568 
569 #define HCI_OP_WRITE_SCAN_ENABLE	0x0c1a
570 	#define SCAN_DISABLED		0x00
571 	#define SCAN_INQUIRY		0x01
572 	#define SCAN_PAGE		0x02
573 
574 #define HCI_OP_READ_AUTH_ENABLE		0x0c1f
575 
576 #define HCI_OP_WRITE_AUTH_ENABLE	0x0c20
577 	#define AUTH_DISABLED		0x00
578 	#define AUTH_ENABLED		0x01
579 
580 #define HCI_OP_READ_ENCRYPT_MODE	0x0c21
581 
582 #define HCI_OP_WRITE_ENCRYPT_MODE	0x0c22
583 	#define ENCRYPT_DISABLED	0x00
584 	#define ENCRYPT_P2P		0x01
585 	#define ENCRYPT_BOTH		0x02
586 
587 #define HCI_OP_READ_CLASS_OF_DEV	0x0c23
588 struct hci_rp_read_class_of_dev {
589 	__u8     status;
590 	__u8     dev_class[3];
591 } __packed;
592 
593 #define HCI_OP_WRITE_CLASS_OF_DEV	0x0c24
594 struct hci_cp_write_class_of_dev {
595 	__u8     dev_class[3];
596 } __packed;
597 
598 #define HCI_OP_READ_VOICE_SETTING	0x0c25
599 struct hci_rp_read_voice_setting {
600 	__u8     status;
601 	__le16   voice_setting;
602 } __packed;
603 
604 #define HCI_OP_WRITE_VOICE_SETTING	0x0c26
605 struct hci_cp_write_voice_setting {
606 	__le16   voice_setting;
607 } __packed;
608 
609 #define HCI_OP_HOST_BUFFER_SIZE		0x0c33
610 struct hci_cp_host_buffer_size {
611 	__le16   acl_mtu;
612 	__u8     sco_mtu;
613 	__le16   acl_max_pkt;
614 	__le16   sco_max_pkt;
615 } __packed;
616 
617 #define HCI_OP_WRITE_INQUIRY_MODE	0x0c45
618 
619 #define HCI_MAX_EIR_LENGTH		240
620 
621 #define HCI_OP_WRITE_EIR		0x0c52
622 struct hci_cp_write_eir {
623 	uint8_t		fec;
624 	uint8_t		data[HCI_MAX_EIR_LENGTH];
625 } __packed;
626 
627 #define HCI_OP_READ_SSP_MODE		0x0c55
628 struct hci_rp_read_ssp_mode {
629 	__u8     status;
630 	__u8     mode;
631 } __packed;
632 
633 #define HCI_OP_WRITE_SSP_MODE		0x0c56
634 struct hci_cp_write_ssp_mode {
635 	__u8     mode;
636 } __packed;
637 
638 #define HCI_OP_READ_LOCAL_OOB_DATA		0x0c57
639 struct hci_rp_read_local_oob_data {
640 	__u8     status;
641 	__u8     hash[16];
642 	__u8     randomizer[16];
643 } __packed;
644 
645 #define HCI_OP_READ_INQ_RSP_TX_POWER	0x0c58
646 
647 #define HCI_OP_READ_LOCAL_VERSION	0x1001
648 struct hci_rp_read_local_version {
649 	__u8     status;
650 	__u8     hci_ver;
651 	__le16   hci_rev;
652 	__u8     lmp_ver;
653 	__le16   manufacturer;
654 	__le16   lmp_subver;
655 } __packed;
656 
657 #define HCI_OP_READ_LOCAL_COMMANDS	0x1002
658 struct hci_rp_read_local_commands {
659 	__u8     status;
660 	__u8     commands[64];
661 } __packed;
662 
663 #define HCI_OP_READ_LOCAL_FEATURES	0x1003
664 struct hci_rp_read_local_features {
665 	__u8     status;
666 	__u8     features[8];
667 } __packed;
668 
669 #define HCI_OP_READ_LOCAL_EXT_FEATURES	0x1004
670 struct hci_rp_read_local_ext_features {
671 	__u8     status;
672 	__u8     page;
673 	__u8     max_page;
674 	__u8     features[8];
675 } __packed;
676 
677 #define HCI_OP_READ_BUFFER_SIZE		0x1005
678 struct hci_rp_read_buffer_size {
679 	__u8     status;
680 	__le16   acl_mtu;
681 	__u8     sco_mtu;
682 	__le16   acl_max_pkt;
683 	__le16   sco_max_pkt;
684 } __packed;
685 
686 #define HCI_OP_READ_BD_ADDR		0x1009
687 struct hci_rp_read_bd_addr {
688 	__u8     status;
689 	bdaddr_t bdaddr;
690 } __packed;
691 
692 #define HCI_OP_LE_SET_EVENT_MASK	0x2001
693 struct hci_cp_le_set_event_mask {
694 	__u8     mask[8];
695 } __packed;
696 
697 #define HCI_OP_LE_READ_BUFFER_SIZE	0x2002
698 struct hci_rp_le_read_buffer_size {
699 	__u8     status;
700 	__le16   le_mtu;
701 	__u8     le_max_pkt;
702 } __packed;
703 
704 #define HCI_OP_LE_CREATE_CONN		0x200d
705 struct hci_cp_le_create_conn {
706 	__le16   scan_interval;
707 	__le16   scan_window;
708 	__u8     filter_policy;
709 	__u8     peer_addr_type;
710 	bdaddr_t peer_addr;
711 	__u8     own_address_type;
712 	__le16   conn_interval_min;
713 	__le16   conn_interval_max;
714 	__le16   conn_latency;
715 	__le16   supervision_timeout;
716 	__le16   min_ce_len;
717 	__le16   max_ce_len;
718 } __packed;
719 
720 #define HCI_OP_LE_CREATE_CONN_CANCEL	0x200e
721 
722 #define HCI_OP_LE_CONN_UPDATE		0x2013
723 struct hci_cp_le_conn_update {
724 	__le16   handle;
725 	__le16   conn_interval_min;
726 	__le16   conn_interval_max;
727 	__le16   conn_latency;
728 	__le16   supervision_timeout;
729 	__le16   min_ce_len;
730 	__le16   max_ce_len;
731 } __packed;
732 
733 /* ---- HCI Events ---- */
734 #define HCI_EV_INQUIRY_COMPLETE		0x01
735 
736 #define HCI_EV_INQUIRY_RESULT		0x02
737 struct inquiry_info {
738 	bdaddr_t bdaddr;
739 	__u8     pscan_rep_mode;
740 	__u8     pscan_period_mode;
741 	__u8     pscan_mode;
742 	__u8     dev_class[3];
743 	__le16   clock_offset;
744 } __packed;
745 
746 #define HCI_EV_CONN_COMPLETE		0x03
747 struct hci_ev_conn_complete {
748 	__u8     status;
749 	__le16   handle;
750 	bdaddr_t bdaddr;
751 	__u8     link_type;
752 	__u8     encr_mode;
753 } __packed;
754 
755 #define HCI_EV_CONN_REQUEST		0x04
756 struct hci_ev_conn_request {
757 	bdaddr_t bdaddr;
758 	__u8     dev_class[3];
759 	__u8     link_type;
760 } __packed;
761 
762 #define HCI_EV_DISCONN_COMPLETE		0x05
763 struct hci_ev_disconn_complete {
764 	__u8     status;
765 	__le16   handle;
766 	__u8     reason;
767 } __packed;
768 
769 #define HCI_EV_AUTH_COMPLETE		0x06
770 struct hci_ev_auth_complete {
771 	__u8     status;
772 	__le16   handle;
773 } __packed;
774 
775 #define HCI_EV_REMOTE_NAME		0x07
776 struct hci_ev_remote_name {
777 	__u8     status;
778 	bdaddr_t bdaddr;
779 	__u8     name[HCI_MAX_NAME_LENGTH];
780 } __packed;
781 
782 #define HCI_EV_ENCRYPT_CHANGE		0x08
783 struct hci_ev_encrypt_change {
784 	__u8     status;
785 	__le16   handle;
786 	__u8     encrypt;
787 } __packed;
788 
789 #define HCI_EV_CHANGE_LINK_KEY_COMPLETE	0x09
790 struct hci_ev_change_link_key_complete {
791 	__u8     status;
792 	__le16   handle;
793 } __packed;
794 
795 #define HCI_EV_REMOTE_FEATURES		0x0b
796 struct hci_ev_remote_features {
797 	__u8     status;
798 	__le16   handle;
799 	__u8     features[8];
800 } __packed;
801 
802 #define HCI_EV_REMOTE_VERSION		0x0c
803 struct hci_ev_remote_version {
804 	__u8     status;
805 	__le16   handle;
806 	__u8     lmp_ver;
807 	__le16   manufacturer;
808 	__le16   lmp_subver;
809 } __packed;
810 
811 #define HCI_EV_QOS_SETUP_COMPLETE	0x0d
812 struct hci_qos {
813 	__u8     service_type;
814 	__u32    token_rate;
815 	__u32    peak_bandwidth;
816 	__u32    latency;
817 	__u32    delay_variation;
818 } __packed;
819 struct hci_ev_qos_setup_complete {
820 	__u8     status;
821 	__le16   handle;
822 	struct   hci_qos qos;
823 } __packed;
824 
825 #define HCI_EV_CMD_COMPLETE		0x0e
826 struct hci_ev_cmd_complete {
827 	__u8     ncmd;
828 	__le16   opcode;
829 } __packed;
830 
831 #define HCI_EV_CMD_STATUS		0x0f
832 struct hci_ev_cmd_status {
833 	__u8     status;
834 	__u8     ncmd;
835 	__le16   opcode;
836 } __packed;
837 
838 #define HCI_EV_ROLE_CHANGE		0x12
839 struct hci_ev_role_change {
840 	__u8     status;
841 	bdaddr_t bdaddr;
842 	__u8     role;
843 } __packed;
844 
845 #define HCI_EV_NUM_COMP_PKTS		0x13
846 struct hci_ev_num_comp_pkts {
847 	__u8     num_hndl;
848 	/* variable length part */
849 } __packed;
850 
851 #define HCI_EV_MODE_CHANGE		0x14
852 struct hci_ev_mode_change {
853 	__u8     status;
854 	__le16   handle;
855 	__u8     mode;
856 	__le16   interval;
857 } __packed;
858 
859 #define HCI_EV_PIN_CODE_REQ		0x16
860 struct hci_ev_pin_code_req {
861 	bdaddr_t bdaddr;
862 } __packed;
863 
864 #define HCI_EV_LINK_KEY_REQ		0x17
865 struct hci_ev_link_key_req {
866 	bdaddr_t bdaddr;
867 } __packed;
868 
869 #define HCI_EV_LINK_KEY_NOTIFY		0x18
870 struct hci_ev_link_key_notify {
871 	bdaddr_t bdaddr;
872 	__u8     link_key[16];
873 	__u8     key_type;
874 } __packed;
875 
876 #define HCI_EV_CLOCK_OFFSET		0x1c
877 struct hci_ev_clock_offset {
878 	__u8     status;
879 	__le16   handle;
880 	__le16   clock_offset;
881 } __packed;
882 
883 #define HCI_EV_PKT_TYPE_CHANGE		0x1d
884 struct hci_ev_pkt_type_change {
885 	__u8     status;
886 	__le16   handle;
887 	__le16   pkt_type;
888 } __packed;
889 
890 #define HCI_EV_PSCAN_REP_MODE		0x20
891 struct hci_ev_pscan_rep_mode {
892 	bdaddr_t bdaddr;
893 	__u8     pscan_rep_mode;
894 } __packed;
895 
896 #define HCI_EV_INQUIRY_RESULT_WITH_RSSI	0x22
897 struct inquiry_info_with_rssi {
898 	bdaddr_t bdaddr;
899 	__u8     pscan_rep_mode;
900 	__u8     pscan_period_mode;
901 	__u8     dev_class[3];
902 	__le16   clock_offset;
903 	__s8     rssi;
904 } __packed;
905 struct inquiry_info_with_rssi_and_pscan_mode {
906 	bdaddr_t bdaddr;
907 	__u8     pscan_rep_mode;
908 	__u8     pscan_period_mode;
909 	__u8     pscan_mode;
910 	__u8     dev_class[3];
911 	__le16   clock_offset;
912 	__s8     rssi;
913 } __packed;
914 
915 #define HCI_EV_REMOTE_EXT_FEATURES	0x23
916 struct hci_ev_remote_ext_features {
917 	__u8     status;
918 	__le16   handle;
919 	__u8     page;
920 	__u8     max_page;
921 	__u8     features[8];
922 } __packed;
923 
924 #define HCI_EV_SYNC_CONN_COMPLETE	0x2c
925 struct hci_ev_sync_conn_complete {
926 	__u8     status;
927 	__le16   handle;
928 	bdaddr_t bdaddr;
929 	__u8     link_type;
930 	__u8     tx_interval;
931 	__u8     retrans_window;
932 	__le16   rx_pkt_len;
933 	__le16   tx_pkt_len;
934 	__u8     air_mode;
935 } __packed;
936 
937 #define HCI_EV_SYNC_CONN_CHANGED	0x2d
938 struct hci_ev_sync_conn_changed {
939 	__u8     status;
940 	__le16   handle;
941 	__u8     tx_interval;
942 	__u8     retrans_window;
943 	__le16   rx_pkt_len;
944 	__le16   tx_pkt_len;
945 } __packed;
946 
947 #define HCI_EV_SNIFF_SUBRATE		0x2e
948 struct hci_ev_sniff_subrate {
949 	__u8     status;
950 	__le16   handle;
951 	__le16   max_tx_latency;
952 	__le16   max_rx_latency;
953 	__le16   max_remote_timeout;
954 	__le16   max_local_timeout;
955 } __packed;
956 
957 #define HCI_EV_EXTENDED_INQUIRY_RESULT	0x2f
958 struct extended_inquiry_info {
959 	bdaddr_t bdaddr;
960 	__u8     pscan_rep_mode;
961 	__u8     pscan_period_mode;
962 	__u8     dev_class[3];
963 	__le16   clock_offset;
964 	__s8     rssi;
965 	__u8     data[240];
966 } __packed;
967 
968 #define HCI_EV_IO_CAPA_REQUEST		0x31
969 struct hci_ev_io_capa_request {
970 	bdaddr_t bdaddr;
971 } __packed;
972 
973 #define HCI_EV_IO_CAPA_REPLY		0x32
974 struct hci_ev_io_capa_reply {
975 	bdaddr_t bdaddr;
976 	__u8     capability;
977 	__u8     oob_data;
978 	__u8     authentication;
979 } __packed;
980 
981 #define HCI_EV_USER_CONFIRM_REQUEST	0x33
982 struct hci_ev_user_confirm_req {
983 	bdaddr_t	bdaddr;
984 	__le32		passkey;
985 } __packed;
986 
987 #define HCI_EV_REMOTE_OOB_DATA_REQUEST	0x35
988 struct hci_ev_remote_oob_data_request {
989 	bdaddr_t bdaddr;
990 } __packed;
991 
992 #define HCI_EV_SIMPLE_PAIR_COMPLETE	0x36
993 struct hci_ev_simple_pair_complete {
994 	__u8     status;
995 	bdaddr_t bdaddr;
996 } __packed;
997 
998 #define HCI_EV_REMOTE_HOST_FEATURES	0x3d
999 struct hci_ev_remote_host_features {
1000 	bdaddr_t bdaddr;
1001 	__u8     features[8];
1002 } __packed;
1003 
1004 #define HCI_EV_LE_META			0x3e
1005 struct hci_ev_le_meta {
1006 	__u8     subevent;
1007 } __packed;
1008 
1009 /* Low energy meta events */
1010 #define HCI_EV_LE_CONN_COMPLETE		0x01
1011 struct hci_ev_le_conn_complete {
1012 	__u8     status;
1013 	__le16   handle;
1014 	__u8     role;
1015 	__u8     bdaddr_type;
1016 	bdaddr_t bdaddr;
1017 	__le16   interval;
1018 	__le16   latency;
1019 	__le16   supervision_timeout;
1020 	__u8     clk_accurancy;
1021 } __packed;
1022 
1023 /* Internal events generated by Bluetooth stack */
1024 #define HCI_EV_STACK_INTERNAL	0xfd
1025 struct hci_ev_stack_internal {
1026 	__u16    type;
1027 	__u8     data[0];
1028 } __packed;
1029 
1030 #define HCI_EV_SI_DEVICE	0x01
1031 struct hci_ev_si_device {
1032 	__u16    event;
1033 	__u16    dev_id;
1034 } __packed;
1035 
1036 #define HCI_EV_SI_SECURITY	0x02
1037 struct hci_ev_si_security {
1038 	__u16    event;
1039 	__u16    proto;
1040 	__u16    subproto;
1041 	__u8     incoming;
1042 } __packed;
1043 
1044 /* ---- HCI Packet structures ---- */
1045 #define HCI_COMMAND_HDR_SIZE 3
1046 #define HCI_EVENT_HDR_SIZE   2
1047 #define HCI_ACL_HDR_SIZE     4
1048 #define HCI_SCO_HDR_SIZE     3
1049 
1050 struct hci_command_hdr {
1051 	__le16	opcode;		/* OCF & OGF */
1052 	__u8	plen;
1053 } __packed;
1054 
1055 struct hci_event_hdr {
1056 	__u8	evt;
1057 	__u8	plen;
1058 } __packed;
1059 
1060 struct hci_acl_hdr {
1061 	__le16	handle;		/* Handle & Flags(PB, BC) */
1062 	__le16	dlen;
1063 } __packed;
1064 
1065 struct hci_sco_hdr {
1066 	__le16	handle;
1067 	__u8	dlen;
1068 } __packed;
1069 
1070 #ifdef __KERNEL__
1071 #include <linux/skbuff.h>
1072 static inline struct hci_event_hdr *hci_event_hdr(const struct sk_buff *skb)
1073 {
1074 	return (struct hci_event_hdr *) skb->data;
1075 }
1076 
1077 static inline struct hci_acl_hdr *hci_acl_hdr(const struct sk_buff *skb)
1078 {
1079 	return (struct hci_acl_hdr *) skb->data;
1080 }
1081 
1082 static inline struct hci_sco_hdr *hci_sco_hdr(const struct sk_buff *skb)
1083 {
1084 	return (struct hci_sco_hdr *) skb->data;
1085 }
1086 #endif
1087 
1088 /* Command opcode pack/unpack */
1089 #define hci_opcode_pack(ogf, ocf)	(__u16) ((ocf & 0x03ff)|(ogf << 10))
1090 #define hci_opcode_ogf(op)		(op >> 10)
1091 #define hci_opcode_ocf(op)		(op & 0x03ff)
1092 
1093 /* ACL handle and flags pack/unpack */
1094 #define hci_handle_pack(h, f)	(__u16) ((h & 0x0fff)|(f << 12))
1095 #define hci_handle(h)		(h & 0x0fff)
1096 #define hci_flags(h)		(h >> 12)
1097 
1098 /* ---- HCI Sockets ---- */
1099 
1100 /* Socket options */
1101 #define HCI_DATA_DIR	1
1102 #define HCI_FILTER	2
1103 #define HCI_TIME_STAMP	3
1104 
1105 /* CMSG flags */
1106 #define HCI_CMSG_DIR	0x0001
1107 #define HCI_CMSG_TSTAMP	0x0002
1108 
1109 struct sockaddr_hci {
1110 	sa_family_t    hci_family;
1111 	unsigned short hci_dev;
1112 	unsigned short hci_channel;
1113 };
1114 #define HCI_DEV_NONE	0xffff
1115 
1116 #define HCI_CHANNEL_RAW		0
1117 #define HCI_CHANNEL_CONTROL	1
1118 
1119 struct hci_filter {
1120 	unsigned long type_mask;
1121 	unsigned long event_mask[2];
1122 	__le16 opcode;
1123 };
1124 
1125 struct hci_ufilter {
1126 	__u32  type_mask;
1127 	__u32  event_mask[2];
1128 	__le16 opcode;
1129 };
1130 
1131 #define HCI_FLT_TYPE_BITS	31
1132 #define HCI_FLT_EVENT_BITS	63
1133 #define HCI_FLT_OGF_BITS	63
1134 #define HCI_FLT_OCF_BITS	127
1135 
1136 /* ---- HCI Ioctl requests structures ---- */
1137 struct hci_dev_stats {
1138 	__u32 err_rx;
1139 	__u32 err_tx;
1140 	__u32 cmd_tx;
1141 	__u32 evt_rx;
1142 	__u32 acl_tx;
1143 	__u32 acl_rx;
1144 	__u32 sco_tx;
1145 	__u32 sco_rx;
1146 	__u32 byte_rx;
1147 	__u32 byte_tx;
1148 };
1149 
1150 struct hci_dev_info {
1151 	__u16 dev_id;
1152 	char  name[8];
1153 
1154 	bdaddr_t bdaddr;
1155 
1156 	__u32 flags;
1157 	__u8  type;
1158 
1159 	__u8  features[8];
1160 
1161 	__u32 pkt_type;
1162 	__u32 link_policy;
1163 	__u32 link_mode;
1164 
1165 	__u16 acl_mtu;
1166 	__u16 acl_pkts;
1167 	__u16 sco_mtu;
1168 	__u16 sco_pkts;
1169 
1170 	struct hci_dev_stats stat;
1171 };
1172 
1173 struct hci_conn_info {
1174 	__u16    handle;
1175 	bdaddr_t bdaddr;
1176 	__u8     type;
1177 	__u8     out;
1178 	__u16    state;
1179 	__u32    link_mode;
1180 };
1181 
1182 struct hci_dev_req {
1183 	__u16  dev_id;
1184 	__u32  dev_opt;
1185 };
1186 
1187 struct hci_dev_list_req {
1188 	__u16  dev_num;
1189 	struct hci_dev_req dev_req[0];	/* hci_dev_req structures */
1190 };
1191 
1192 struct hci_conn_list_req {
1193 	__u16  dev_id;
1194 	__u16  conn_num;
1195 	struct hci_conn_info conn_info[0];
1196 };
1197 
1198 struct hci_conn_info_req {
1199 	bdaddr_t bdaddr;
1200 	__u8     type;
1201 	struct   hci_conn_info conn_info[0];
1202 };
1203 
1204 struct hci_auth_info_req {
1205 	bdaddr_t bdaddr;
1206 	__u8     type;
1207 };
1208 
1209 struct hci_inquiry_req {
1210 	__u16 dev_id;
1211 	__u16 flags;
1212 	__u8  lap[3];
1213 	__u8  length;
1214 	__u8  num_rsp;
1215 };
1216 #define IREQ_CACHE_FLUSH 0x0001
1217 
1218 #endif /* __HCI_H */
1219