2 BlueZ - Bluetooth protocol stack for Linux
3 Copyright (C) 2000-2001 Qualcomm Incorporated
5 Written 2000,2001 by Maxim Krasnyansky <maxk@qualcomm.com>
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;
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.
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.
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)
35 #define HCI_DEV_UNREG 2
37 #define HCI_DEV_DOWN 4
38 #define HCI_DEV_SUSPEND 5
39 #define HCI_DEV_RESUME 6
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
46 /* HCI device types */
54 /* HCI device quirks */
56 HCI_QUIRK_RESET_ON_INIT,
60 /* HCI device flags */
77 /* HCI ioctl defines */
78 #define HCIDEVUP _IOW('H', 201, int)
79 #define HCIDEVDOWN _IOW('H', 202, int)
80 #define HCIDEVRESET _IOW('H', 203, int)
81 #define HCIDEVRESTAT _IOW('H', 204, int)
83 #define HCIGETDEVLIST _IOR('H', 210, int)
84 #define HCIGETDEVINFO _IOR('H', 211, int)
85 #define HCIGETCONNLIST _IOR('H', 212, int)
86 #define HCIGETCONNINFO _IOR('H', 213, int)
88 #define HCISETRAW _IOW('H', 220, int)
89 #define HCISETSCAN _IOW('H', 221, int)
90 #define HCISETAUTH _IOW('H', 222, int)
91 #define HCISETENCRYPT _IOW('H', 223, int)
92 #define HCISETPTYPE _IOW('H', 224, int)
93 #define HCISETLINKPOL _IOW('H', 225, int)
94 #define HCISETLINKMODE _IOW('H', 226, int)
95 #define HCISETACLMTU _IOW('H', 227, int)
96 #define HCISETSCOMTU _IOW('H', 228, int)
98 #define HCISETSECMGR _IOW('H', 230, int)
100 #define HCIINQUIRY _IOR('H', 240, int)
103 #define HCI_CONN_TIMEOUT (HZ * 40)
104 #define HCI_DISCONN_TIMEOUT (HZ * 2)
105 #define HCI_CONN_IDLE_TIMEOUT (HZ * 60)
107 /* HCI Packet types */
108 #define HCI_COMMAND_PKT 0x01
109 #define HCI_ACLDATA_PKT 0x02
110 #define HCI_SCODATA_PKT 0x03
111 #define HCI_EVENT_PKT 0x04
112 #define HCI_VENDOR_PKT 0xff
114 /* HCI Packet types */
115 #define HCI_DM1 0x0008
116 #define HCI_DM3 0x0400
117 #define HCI_DM5 0x4000
118 #define HCI_DH1 0x0010
119 #define HCI_DH3 0x0800
120 #define HCI_DH5 0x8000
122 #define HCI_HV1 0x0020
123 #define HCI_HV2 0x0040
124 #define HCI_HV3 0x0080
126 #define SCO_PTYPE_MASK (HCI_HV1 | HCI_HV2 | HCI_HV3)
127 #define ACL_PTYPE_MASK (~SCO_PTYPE_MASK)
130 #define ACL_CONT 0x01
131 #define ACL_START 0x02
132 #define ACL_ACTIVE_BCAST 0x04
133 #define ACL_PICO_BCAST 0x08
136 #define SCO_LINK 0x00
137 #define ACL_LINK 0x01
140 #define LMP_3SLOT 0x01
141 #define LMP_5SLOT 0x02
142 #define LMP_ENCRYPT 0x04
143 #define LMP_SOFFSET 0x08
144 #define LMP_TACCURACY 0x10
145 #define LMP_RSWITCH 0x20
146 #define LMP_HOLD 0x40
147 #define LMP_SNIF 0x80
149 #define LMP_PARK 0x01
150 #define LMP_RSSI 0x02
151 #define LMP_QUALITY 0x04
155 #define LMP_ULAW 0x40
156 #define LMP_ALAW 0x80
158 #define LMP_CVSD 0x01
159 #define LMP_PSCHEME 0x02
160 #define LMP_PCONTROL 0x04
163 #define HCI_LP_RSWITCH 0x0001
164 #define HCI_LP_HOLD 0x0002
165 #define HCI_LP_SNIFF 0x0004
166 #define HCI_LP_PARK 0x0008
169 #define HCI_LM_ACCEPT 0x8000
170 #define HCI_LM_MASTER 0x0001
171 #define HCI_LM_AUTH 0x0002
172 #define HCI_LM_ENCRYPT 0x0004
173 #define HCI_LM_TRUSTED 0x0008
174 #define HCI_LM_RELIABLE 0x0010
175 #define HCI_LM_SECURE 0x0020
177 /* ----- HCI Commands ---- */
178 /* OGF & OCF values */
180 /* Informational Parameters */
181 #define OGF_INFO_PARAM 0x04
183 #define OCF_READ_LOCAL_VERSION 0x0001
184 struct hci_rp_read_loc_version {
191 } __attribute__ ((packed));
193 #define OCF_READ_LOCAL_FEATURES 0x0003
194 struct hci_rp_read_loc_features {
197 } __attribute__ ((packed));
199 #define OCF_READ_BUFFER_SIZE 0x0005
200 struct hci_rp_read_buffer_size {
206 } __attribute__ ((packed));
208 #define OCF_READ_BD_ADDR 0x0009
209 struct hci_rp_read_bd_addr {
212 } __attribute__ ((packed));
214 /* Host Controller and Baseband */
215 #define OGF_HOST_CTL 0x03
216 #define OCF_RESET 0x0003
217 #define OCF_READ_AUTH_ENABLE 0x001F
218 #define OCF_WRITE_AUTH_ENABLE 0x0020
219 #define AUTH_DISABLED 0x00
220 #define AUTH_ENABLED 0x01
222 #define OCF_READ_ENCRYPT_MODE 0x0021
223 #define OCF_WRITE_ENCRYPT_MODE 0x0022
224 #define ENCRYPT_DISABLED 0x00
225 #define ENCRYPT_P2P 0x01
226 #define ENCRYPT_BOTH 0x02
228 #define OCF_WRITE_CA_TIMEOUT 0x0016
229 #define OCF_WRITE_PG_TIMEOUT 0x0018
231 #define OCF_WRITE_SCAN_ENABLE 0x001A
232 #define SCAN_DISABLED 0x00
233 #define SCAN_INQUIRY 0x01
234 #define SCAN_PAGE 0x02
236 #define OCF_SET_EVENT_FLT 0x0005
237 struct hci_cp_set_event_flt {
241 } __attribute__ ((packed));
244 #define HCI_FLT_CLEAR_ALL 0x00
245 #define HCI_FLT_INQ_RESULT 0x01
246 #define HCI_FLT_CONN_SETUP 0x02
248 /* CONN_SETUP Condition types */
249 #define HCI_CONN_SETUP_ALLOW_ALL 0x00
250 #define HCI_CONN_SETUP_ALLOW_CLASS 0x01
251 #define HCI_CONN_SETUP_ALLOW_BDADDR 0x02
253 /* CONN_SETUP Conditions */
254 #define HCI_CONN_SETUP_AUTO_OFF 0x01
255 #define HCI_CONN_SETUP_AUTO_ON 0x02
257 #define OCF_READ_CLASS_OF_DEV 0x0023
258 struct hci_rp_read_dev_class {
261 } __attribute__ ((packed));
263 #define OCF_WRITE_CLASS_OF_DEV 0x0024
264 struct hci_cp_write_dev_class {
266 } __attribute__ ((packed));
268 #define OCF_READ_VOICE_SETTING 0x0025
269 struct hci_rp_read_voice_setting {
271 __le16 voice_setting;
272 } __attribute__ ((packed));
274 #define OCF_WRITE_VOICE_SETTING 0x0026
275 struct hci_cp_write_voice_setting {
276 __le16 voice_setting;
277 } __attribute__ ((packed));
279 #define OCF_HOST_BUFFER_SIZE 0x0033
280 struct hci_cp_host_buffer_size {
285 } __attribute__ ((packed));
288 #define OGF_LINK_CTL 0x01
289 #define OCF_CREATE_CONN 0x0005
290 struct hci_cp_create_conn {
297 } __attribute__ ((packed));
299 #define OCF_ACCEPT_CONN_REQ 0x0009
300 struct hci_cp_accept_conn_req {
303 } __attribute__ ((packed));
305 #define OCF_REJECT_CONN_REQ 0x000a
306 struct hci_cp_reject_conn_req {
309 } __attribute__ ((packed));
311 #define OCF_DISCONNECT 0x0006
312 struct hci_cp_disconnect {
315 } __attribute__ ((packed));
317 #define OCF_ADD_SCO 0x0007
318 struct hci_cp_add_sco {
321 } __attribute__ ((packed));
323 #define OCF_INQUIRY 0x0001
324 struct hci_cp_inquiry {
328 } __attribute__ ((packed));
330 #define OCF_INQUIRY_CANCEL 0x0002
332 #define OCF_LINK_KEY_REPLY 0x000B
333 struct hci_cp_link_key_reply {
336 } __attribute__ ((packed));
338 #define OCF_LINK_KEY_NEG_REPLY 0x000C
339 struct hci_cp_link_key_neg_reply {
341 } __attribute__ ((packed));
343 #define OCF_PIN_CODE_REPLY 0x000D
344 struct hci_cp_pin_code_reply {
348 } __attribute__ ((packed));
350 #define OCF_PIN_CODE_NEG_REPLY 0x000E
351 struct hci_cp_pin_code_neg_reply {
353 } __attribute__ ((packed));
355 #define OCF_CHANGE_CONN_PTYPE 0x000F
356 struct hci_cp_change_conn_ptype {
359 } __attribute__ ((packed));
361 #define OCF_AUTH_REQUESTED 0x0011
362 struct hci_cp_auth_requested {
364 } __attribute__ ((packed));
366 #define OCF_SET_CONN_ENCRYPT 0x0013
367 struct hci_cp_set_conn_encrypt {
370 } __attribute__ ((packed));
372 #define OCF_CHANGE_CONN_LINK_KEY 0x0015
373 struct hci_cp_change_conn_link_key {
375 } __attribute__ ((packed));
377 #define OCF_READ_REMOTE_FEATURES 0x001B
378 struct hci_cp_read_rmt_features {
380 } __attribute__ ((packed));
382 #define OCF_READ_REMOTE_VERSION 0x001D
383 struct hci_cp_read_rmt_version {
385 } __attribute__ ((packed));
388 #define OGF_LINK_POLICY 0x02
389 #define OCF_ROLE_DISCOVERY 0x0009
390 struct hci_cp_role_discovery {
392 } __attribute__ ((packed));
393 struct hci_rp_role_discovery {
397 } __attribute__ ((packed));
399 #define OCF_READ_LINK_POLICY 0x000C
400 struct hci_cp_read_link_policy {
402 } __attribute__ ((packed));
403 struct hci_rp_read_link_policy {
407 } __attribute__ ((packed));
409 #define OCF_SWITCH_ROLE 0x000B
410 struct hci_cp_switch_role {
413 } __attribute__ ((packed));
415 #define OCF_WRITE_LINK_POLICY 0x000D
416 struct hci_cp_write_link_policy {
419 } __attribute__ ((packed));
420 struct hci_rp_write_link_policy {
423 } __attribute__ ((packed));
426 #define OGF_STATUS_PARAM 0x05
428 /* Testing commands */
429 #define OGF_TESTING_CMD 0x3E
431 /* Vendor specific commands */
432 #define OGF_VENDOR_CMD 0x3F
434 /* ---- HCI Events ---- */
435 #define HCI_EV_INQUIRY_COMPLETE 0x01
437 #define HCI_EV_INQUIRY_RESULT 0x02
438 struct inquiry_info {
441 __u8 pscan_period_mode;
445 } __attribute__ ((packed));
447 #define HCI_EV_INQUIRY_RESULT_WITH_RSSI 0x22
448 struct inquiry_info_with_rssi {
451 __u8 pscan_period_mode;
455 } __attribute__ ((packed));
456 struct inquiry_info_with_rssi_and_pscan_mode {
459 __u8 pscan_period_mode;
464 } __attribute__ ((packed));
466 #define HCI_EV_EXTENDED_INQUIRY_RESULT 0x2F
467 struct extended_inquiry_info {
470 __u8 pscan_period_mode;
475 } __attribute__ ((packed));
477 #define HCI_EV_CONN_COMPLETE 0x03
478 struct hci_ev_conn_complete {
484 } __attribute__ ((packed));
486 #define HCI_EV_CONN_REQUEST 0x04
487 struct hci_ev_conn_request {
491 } __attribute__ ((packed));
493 #define HCI_EV_DISCONN_COMPLETE 0x05
494 struct hci_ev_disconn_complete {
498 } __attribute__ ((packed));
500 #define HCI_EV_AUTH_COMPLETE 0x06
501 struct hci_ev_auth_complete {
504 } __attribute__ ((packed));
506 #define HCI_EV_ENCRYPT_CHANGE 0x08
507 struct hci_ev_encrypt_change {
511 } __attribute__ ((packed));
513 #define HCI_EV_CHANGE_CONN_LINK_KEY_COMPLETE 0x09
514 struct hci_ev_change_conn_link_key_complete {
517 } __attribute__ ((packed));
519 #define HCI_EV_QOS_SETUP_COMPLETE 0x0D
523 __u32 peak_bandwidth;
525 __u32 delay_variation;
526 } __attribute__ ((packed));
527 struct hci_ev_qos_setup_complete {
531 } __attribute__ ((packed));
533 #define HCI_EV_CMD_COMPLETE 0x0E
534 struct hci_ev_cmd_complete {
537 } __attribute__ ((packed));
539 #define HCI_EV_CMD_STATUS 0x0F
540 struct hci_ev_cmd_status {
544 } __attribute__ ((packed));
546 #define HCI_EV_NUM_COMP_PKTS 0x13
547 struct hci_ev_num_comp_pkts {
549 /* variable length part */
550 } __attribute__ ((packed));
552 #define HCI_EV_ROLE_CHANGE 0x12
553 struct hci_ev_role_change {
557 } __attribute__ ((packed));
559 #define HCI_EV_MODE_CHANGE 0x14
560 struct hci_ev_mode_change {
565 } __attribute__ ((packed));
567 #define HCI_EV_PIN_CODE_REQ 0x16
568 struct hci_ev_pin_code_req {
570 } __attribute__ ((packed));
572 #define HCI_EV_LINK_KEY_REQ 0x17
573 struct hci_ev_link_key_req {
575 } __attribute__ ((packed));
577 #define HCI_EV_LINK_KEY_NOTIFY 0x18
578 struct hci_ev_link_key_notify {
582 } __attribute__ ((packed));
584 #define HCI_EV_RMT_FEATURES 0x0B
585 struct hci_ev_rmt_features {
589 } __attribute__ ((packed));
591 #define HCI_EV_RMT_VERSION 0x0C
592 struct hci_ev_rmt_version {
598 } __attribute__ ((packed));
600 #define HCI_EV_CLOCK_OFFSET 0x01C
601 struct hci_ev_clock_offset {
605 } __attribute__ ((packed));
607 #define HCI_EV_PSCAN_REP_MODE 0x20
608 struct hci_ev_pscan_rep_mode {
611 } __attribute__ ((packed));
613 /* Internal events generated by Bluetooth stack */
614 #define HCI_EV_STACK_INTERNAL 0xFD
615 struct hci_ev_stack_internal {
618 } __attribute__ ((packed));
620 #define HCI_EV_SI_DEVICE 0x01
621 struct hci_ev_si_device {
624 } __attribute__ ((packed));
626 #define HCI_EV_SI_SECURITY 0x02
627 struct hci_ev_si_security {
632 } __attribute__ ((packed));
634 /* ---- HCI Packet structures ---- */
635 #define HCI_COMMAND_HDR_SIZE 3
636 #define HCI_EVENT_HDR_SIZE 2
637 #define HCI_ACL_HDR_SIZE 4
638 #define HCI_SCO_HDR_SIZE 3
640 struct hci_command_hdr {
641 __le16 opcode; /* OCF & OGF */
643 } __attribute__ ((packed));
645 struct hci_event_hdr {
648 } __attribute__ ((packed));
651 __le16 handle; /* Handle & Flags(PB, BC) */
653 } __attribute__ ((packed));
658 } __attribute__ ((packed));
660 /* Command opcode pack/unpack */
661 #define hci_opcode_pack(ogf, ocf) (__u16) ((ocf & 0x03ff)|(ogf << 10))
662 #define hci_opcode_ogf(op) (op >> 10)
663 #define hci_opcode_ocf(op) (op & 0x03ff)
665 /* ACL handle and flags pack/unpack */
666 #define hci_handle_pack(h, f) (__u16) ((h & 0x0fff)|(f << 12))
667 #define hci_handle(h) (h & 0x0fff)
668 #define hci_flags(h) (h >> 12)
670 /* ---- HCI Sockets ---- */
673 #define HCI_DATA_DIR 1
675 #define HCI_TIME_STAMP 3
678 #define HCI_CMSG_DIR 0x0001
679 #define HCI_CMSG_TSTAMP 0x0002
681 struct sockaddr_hci {
682 sa_family_t hci_family;
683 unsigned short hci_dev;
685 #define HCI_DEV_NONE 0xffff
688 unsigned long type_mask;
689 unsigned long event_mask[2];
699 #define HCI_FLT_TYPE_BITS 31
700 #define HCI_FLT_EVENT_BITS 63
701 #define HCI_FLT_OGF_BITS 63
702 #define HCI_FLT_OCF_BITS 127
704 /* ---- HCI Ioctl requests structures ---- */
705 struct hci_dev_stats {
718 struct hci_dev_info {
738 struct hci_dev_stats stat;
741 struct hci_conn_info {
755 struct hci_dev_list_req {
757 struct hci_dev_req dev_req[0]; /* hci_dev_req structures */
760 struct hci_conn_list_req {
763 struct hci_conn_info conn_info[0];
766 struct hci_conn_info_req {
769 struct hci_conn_info conn_info[0];
772 struct hci_inquiry_req {
779 #define IREQ_CACHE_FLUSH 0x0001