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 */
55 /* HCI device quirks */
57 HCI_QUIRK_RESET_ON_INIT,
59 HCI_QUIRK_FIXUP_BUFFER_SIZE
62 /* HCI device flags */
79 /* HCI ioctl defines */
80 #define HCIDEVUP _IOW('H', 201, int)
81 #define HCIDEVDOWN _IOW('H', 202, int)
82 #define HCIDEVRESET _IOW('H', 203, int)
83 #define HCIDEVRESTAT _IOW('H', 204, int)
85 #define HCIGETDEVLIST _IOR('H', 210, int)
86 #define HCIGETDEVINFO _IOR('H', 211, int)
87 #define HCIGETCONNLIST _IOR('H', 212, int)
88 #define HCIGETCONNINFO _IOR('H', 213, int)
90 #define HCISETRAW _IOW('H', 220, int)
91 #define HCISETSCAN _IOW('H', 221, int)
92 #define HCISETAUTH _IOW('H', 222, int)
93 #define HCISETENCRYPT _IOW('H', 223, int)
94 #define HCISETPTYPE _IOW('H', 224, int)
95 #define HCISETLINKPOL _IOW('H', 225, int)
96 #define HCISETLINKMODE _IOW('H', 226, int)
97 #define HCISETACLMTU _IOW('H', 227, int)
98 #define HCISETSCOMTU _IOW('H', 228, int)
100 #define HCISETSECMGR _IOW('H', 230, int)
102 #define HCIINQUIRY _IOR('H', 240, int)
105 #define HCI_CONNECT_TIMEOUT (40000) /* 40 seconds */
106 #define HCI_DISCONN_TIMEOUT (2000) /* 2 seconds */
107 #define HCI_IDLE_TIMEOUT (6000) /* 6 seconds */
108 #define HCI_INIT_TIMEOUT (10000) /* 10 seconds */
111 #define HCI_COMMAND_PKT 0x01
112 #define HCI_ACLDATA_PKT 0x02
113 #define HCI_SCODATA_PKT 0x03
114 #define HCI_EVENT_PKT 0x04
115 #define HCI_VENDOR_PKT 0xff
117 /* HCI packet types */
118 #define HCI_DM1 0x0008
119 #define HCI_DM3 0x0400
120 #define HCI_DM5 0x4000
121 #define HCI_DH1 0x0010
122 #define HCI_DH3 0x0800
123 #define HCI_DH5 0x8000
125 #define HCI_HV1 0x0020
126 #define HCI_HV2 0x0040
127 #define HCI_HV3 0x0080
129 #define SCO_PTYPE_MASK (HCI_HV1 | HCI_HV2 | HCI_HV3)
130 #define ACL_PTYPE_MASK (~SCO_PTYPE_MASK)
132 /* eSCO packet types */
133 #define ESCO_HV1 0x0001
134 #define ESCO_HV2 0x0002
135 #define ESCO_HV3 0x0004
136 #define ESCO_EV3 0x0008
137 #define ESCO_EV4 0x0010
138 #define ESCO_EV5 0x0020
140 #define SCO_ESCO_MASK (ESCO_HV1 | ESCO_HV2 | ESCO_HV3)
143 #define ACL_CONT 0x01
144 #define ACL_START 0x02
145 #define ACL_ACTIVE_BCAST 0x04
146 #define ACL_PICO_BCAST 0x08
149 #define SCO_LINK 0x00
150 #define ACL_LINK 0x01
151 #define ESCO_LINK 0x02
154 #define LMP_3SLOT 0x01
155 #define LMP_5SLOT 0x02
156 #define LMP_ENCRYPT 0x04
157 #define LMP_SOFFSET 0x08
158 #define LMP_TACCURACY 0x10
159 #define LMP_RSWITCH 0x20
160 #define LMP_HOLD 0x40
161 #define LMP_SNIFF 0x80
163 #define LMP_PARK 0x01
164 #define LMP_RSSI 0x02
165 #define LMP_QUALITY 0x04
169 #define LMP_ULAW 0x40
170 #define LMP_ALAW 0x80
172 #define LMP_CVSD 0x01
173 #define LMP_PSCHEME 0x02
174 #define LMP_PCONTROL 0x04
176 #define LMP_ESCO 0x80
181 #define LMP_SNIFF_SUBR 0x02
183 /* Connection modes */
184 #define HCI_CM_ACTIVE 0x0000
185 #define HCI_CM_HOLD 0x0001
186 #define HCI_CM_SNIFF 0x0002
187 #define HCI_CM_PARK 0x0003
190 #define HCI_LP_RSWITCH 0x0001
191 #define HCI_LP_HOLD 0x0002
192 #define HCI_LP_SNIFF 0x0004
193 #define HCI_LP_PARK 0x0008
196 #define HCI_LM_ACCEPT 0x8000
197 #define HCI_LM_MASTER 0x0001
198 #define HCI_LM_AUTH 0x0002
199 #define HCI_LM_ENCRYPT 0x0004
200 #define HCI_LM_TRUSTED 0x0008
201 #define HCI_LM_RELIABLE 0x0010
202 #define HCI_LM_SECURE 0x0020
204 /* ----- HCI Commands ---- */
205 #define HCI_OP_INQUIRY 0x0401
206 struct hci_cp_inquiry {
210 } __attribute__ ((packed));
212 #define HCI_OP_INQUIRY_CANCEL 0x0402
214 #define HCI_OP_EXIT_PERIODIC_INQ 0x0404
216 #define HCI_OP_CREATE_CONN 0x0405
217 struct hci_cp_create_conn {
224 } __attribute__ ((packed));
226 #define HCI_OP_DISCONNECT 0x0406
227 struct hci_cp_disconnect {
230 } __attribute__ ((packed));
232 #define HCI_OP_ADD_SCO 0x0407
233 struct hci_cp_add_sco {
236 } __attribute__ ((packed));
238 #define HCI_OP_CREATE_CONN_CANCEL 0x0408
239 struct hci_cp_create_conn_cancel {
241 } __attribute__ ((packed));
243 #define HCI_OP_ACCEPT_CONN_REQ 0x0409
244 struct hci_cp_accept_conn_req {
247 } __attribute__ ((packed));
249 #define HCI_OP_REJECT_CONN_REQ 0x040a
250 struct hci_cp_reject_conn_req {
253 } __attribute__ ((packed));
255 #define HCI_OP_LINK_KEY_REPLY 0x040b
256 struct hci_cp_link_key_reply {
259 } __attribute__ ((packed));
261 #define HCI_OP_LINK_KEY_NEG_REPLY 0x040c
262 struct hci_cp_link_key_neg_reply {
264 } __attribute__ ((packed));
266 #define HCI_OP_PIN_CODE_REPLY 0x040d
267 struct hci_cp_pin_code_reply {
271 } __attribute__ ((packed));
273 #define HCI_OP_PIN_CODE_NEG_REPLY 0x040e
274 struct hci_cp_pin_code_neg_reply {
276 } __attribute__ ((packed));
278 #define HCI_OP_CHANGE_CONN_PTYPE 0x040f
279 struct hci_cp_change_conn_ptype {
282 } __attribute__ ((packed));
284 #define HCI_OP_AUTH_REQUESTED 0x0411
285 struct hci_cp_auth_requested {
287 } __attribute__ ((packed));
289 #define HCI_OP_SET_CONN_ENCRYPT 0x0413
290 struct hci_cp_set_conn_encrypt {
293 } __attribute__ ((packed));
295 #define HCI_OP_CHANGE_CONN_LINK_KEY 0x0415
296 struct hci_cp_change_conn_link_key {
298 } __attribute__ ((packed));
300 #define HCI_OP_REMOTE_NAME_REQ 0x0419
301 struct hci_cp_remote_name_req {
306 } __attribute__ ((packed));
308 #define HCI_OP_REMOTE_NAME_REQ_CANCEL 0x041a
309 struct hci_cp_remote_name_req_cancel {
311 } __attribute__ ((packed));
313 #define HCI_OP_READ_REMOTE_FEATURES 0x041b
314 struct hci_cp_read_remote_features {
316 } __attribute__ ((packed));
318 #define HCI_OP_READ_REMOTE_EXT_FEATURES 0x041c
319 struct hci_cp_read_remote_ext_features {
322 } __attribute__ ((packed));
324 #define HCI_OP_READ_REMOTE_VERSION 0x041d
325 struct hci_cp_read_remote_version {
327 } __attribute__ ((packed));
329 #define HCI_OP_SETUP_SYNC_CONN 0x0428
330 struct hci_cp_setup_sync_conn {
335 __le16 voice_setting;
338 } __attribute__ ((packed));
340 #define HCI_OP_ACCEPT_SYNC_CONN_REQ 0x0429
341 struct hci_cp_accept_sync_conn_req {
346 __le16 content_format;
349 } __attribute__ ((packed));
351 #define HCI_OP_REJECT_SYNC_CONN_REQ 0x042a
352 struct hci_cp_reject_sync_conn_req {
355 } __attribute__ ((packed));
357 #define HCI_OP_SNIFF_MODE 0x0803
358 struct hci_cp_sniff_mode {
364 } __attribute__ ((packed));
366 #define HCI_OP_EXIT_SNIFF_MODE 0x0804
367 struct hci_cp_exit_sniff_mode {
369 } __attribute__ ((packed));
371 #define HCI_OP_ROLE_DISCOVERY 0x0809
372 struct hci_cp_role_discovery {
374 } __attribute__ ((packed));
375 struct hci_rp_role_discovery {
379 } __attribute__ ((packed));
381 #define HCI_OP_SWITCH_ROLE 0x080b
382 struct hci_cp_switch_role {
385 } __attribute__ ((packed));
387 #define HCI_OP_READ_LINK_POLICY 0x080c
388 struct hci_cp_read_link_policy {
390 } __attribute__ ((packed));
391 struct hci_rp_read_link_policy {
395 } __attribute__ ((packed));
397 #define HCI_OP_WRITE_LINK_POLICY 0x080d
398 struct hci_cp_write_link_policy {
401 } __attribute__ ((packed));
402 struct hci_rp_write_link_policy {
405 } __attribute__ ((packed));
407 #define HCI_OP_SNIFF_SUBRATE 0x0811
408 struct hci_cp_sniff_subrate {
411 __le16 min_remote_timeout;
412 __le16 min_local_timeout;
413 } __attribute__ ((packed));
415 #define HCI_OP_SET_EVENT_MASK 0x0c01
416 struct hci_cp_set_event_mask {
418 } __attribute__ ((packed));
420 #define HCI_OP_RESET 0x0c03
422 #define HCI_OP_SET_EVENT_FLT 0x0c05
423 struct hci_cp_set_event_flt {
427 } __attribute__ ((packed));
430 #define HCI_FLT_CLEAR_ALL 0x00
431 #define HCI_FLT_INQ_RESULT 0x01
432 #define HCI_FLT_CONN_SETUP 0x02
434 /* CONN_SETUP Condition types */
435 #define HCI_CONN_SETUP_ALLOW_ALL 0x00
436 #define HCI_CONN_SETUP_ALLOW_CLASS 0x01
437 #define HCI_CONN_SETUP_ALLOW_BDADDR 0x02
439 /* CONN_SETUP Conditions */
440 #define HCI_CONN_SETUP_AUTO_OFF 0x01
441 #define HCI_CONN_SETUP_AUTO_ON 0x02
443 #define HCI_OP_WRITE_LOCAL_NAME 0x0c13
444 struct hci_cp_write_local_name {
446 } __attribute__ ((packed));
448 #define HCI_OP_READ_LOCAL_NAME 0x0c14
449 struct hci_rp_read_local_name {
452 } __attribute__ ((packed));
454 #define HCI_OP_WRITE_CA_TIMEOUT 0x0c16
456 #define HCI_OP_WRITE_PG_TIMEOUT 0x0c18
458 #define HCI_OP_WRITE_SCAN_ENABLE 0x0c1a
459 #define SCAN_DISABLED 0x00
460 #define SCAN_INQUIRY 0x01
461 #define SCAN_PAGE 0x02
463 #define HCI_OP_READ_AUTH_ENABLE 0x0c1f
465 #define HCI_OP_WRITE_AUTH_ENABLE 0x0c20
466 #define AUTH_DISABLED 0x00
467 #define AUTH_ENABLED 0x01
469 #define HCI_OP_READ_ENCRYPT_MODE 0x0c21
471 #define HCI_OP_WRITE_ENCRYPT_MODE 0x0c22
472 #define ENCRYPT_DISABLED 0x00
473 #define ENCRYPT_P2P 0x01
474 #define ENCRYPT_BOTH 0x02
476 #define HCI_OP_READ_CLASS_OF_DEV 0x0c23
477 struct hci_rp_read_class_of_dev {
480 } __attribute__ ((packed));
482 #define HCI_OP_WRITE_CLASS_OF_DEV 0x0c24
483 struct hci_cp_write_class_of_dev {
485 } __attribute__ ((packed));
487 #define HCI_OP_READ_VOICE_SETTING 0x0c25
488 struct hci_rp_read_voice_setting {
490 __le16 voice_setting;
491 } __attribute__ ((packed));
493 #define HCI_OP_WRITE_VOICE_SETTING 0x0c26
494 struct hci_cp_write_voice_setting {
495 __le16 voice_setting;
496 } __attribute__ ((packed));
498 #define HCI_OP_HOST_BUFFER_SIZE 0x0c33
499 struct hci_cp_host_buffer_size {
504 } __attribute__ ((packed));
506 #define HCI_OP_READ_LOCAL_VERSION 0x1001
507 struct hci_rp_read_local_version {
514 } __attribute__ ((packed));
516 #define HCI_OP_READ_LOCAL_COMMANDS 0x1002
517 struct hci_rp_read_local_commands {
520 } __attribute__ ((packed));
522 #define HCI_OP_READ_LOCAL_FEATURES 0x1003
523 struct hci_rp_read_local_features {
526 } __attribute__ ((packed));
528 #define HCI_OP_READ_LOCAL_EXT_FEATURES 0x1004
529 struct hci_rp_read_local_ext_features {
534 } __attribute__ ((packed));
536 #define HCI_OP_READ_BUFFER_SIZE 0x1005
537 struct hci_rp_read_buffer_size {
543 } __attribute__ ((packed));
545 #define HCI_OP_READ_BD_ADDR 0x1009
546 struct hci_rp_read_bd_addr {
549 } __attribute__ ((packed));
551 /* ---- HCI Events ---- */
552 #define HCI_EV_INQUIRY_COMPLETE 0x01
554 #define HCI_EV_INQUIRY_RESULT 0x02
555 struct inquiry_info {
558 __u8 pscan_period_mode;
562 } __attribute__ ((packed));
564 #define HCI_EV_CONN_COMPLETE 0x03
565 struct hci_ev_conn_complete {
571 } __attribute__ ((packed));
573 #define HCI_EV_CONN_REQUEST 0x04
574 struct hci_ev_conn_request {
578 } __attribute__ ((packed));
580 #define HCI_EV_DISCONN_COMPLETE 0x05
581 struct hci_ev_disconn_complete {
585 } __attribute__ ((packed));
587 #define HCI_EV_AUTH_COMPLETE 0x06
588 struct hci_ev_auth_complete {
591 } __attribute__ ((packed));
593 #define HCI_EV_REMOTE_NAME 0x07
594 struct hci_ev_remote_name {
598 } __attribute__ ((packed));
600 #define HCI_EV_ENCRYPT_CHANGE 0x08
601 struct hci_ev_encrypt_change {
605 } __attribute__ ((packed));
607 #define HCI_EV_CHANGE_LINK_KEY_COMPLETE 0x09
608 struct hci_ev_change_link_key_complete {
611 } __attribute__ ((packed));
613 #define HCI_EV_REMOTE_FEATURES 0x0b
614 struct hci_ev_remote_features {
618 } __attribute__ ((packed));
620 #define HCI_EV_REMOTE_VERSION 0x0c
621 struct hci_ev_remote_version {
627 } __attribute__ ((packed));
629 #define HCI_EV_QOS_SETUP_COMPLETE 0x0d
633 __u32 peak_bandwidth;
635 __u32 delay_variation;
636 } __attribute__ ((packed));
637 struct hci_ev_qos_setup_complete {
641 } __attribute__ ((packed));
643 #define HCI_EV_CMD_COMPLETE 0x0e
644 struct hci_ev_cmd_complete {
647 } __attribute__ ((packed));
649 #define HCI_EV_CMD_STATUS 0x0f
650 struct hci_ev_cmd_status {
654 } __attribute__ ((packed));
656 #define HCI_EV_ROLE_CHANGE 0x12
657 struct hci_ev_role_change {
661 } __attribute__ ((packed));
663 #define HCI_EV_NUM_COMP_PKTS 0x13
664 struct hci_ev_num_comp_pkts {
666 /* variable length part */
667 } __attribute__ ((packed));
669 #define HCI_EV_MODE_CHANGE 0x14
670 struct hci_ev_mode_change {
675 } __attribute__ ((packed));
677 #define HCI_EV_PIN_CODE_REQ 0x16
678 struct hci_ev_pin_code_req {
680 } __attribute__ ((packed));
682 #define HCI_EV_LINK_KEY_REQ 0x17
683 struct hci_ev_link_key_req {
685 } __attribute__ ((packed));
687 #define HCI_EV_LINK_KEY_NOTIFY 0x18
688 struct hci_ev_link_key_notify {
692 } __attribute__ ((packed));
694 #define HCI_EV_CLOCK_OFFSET 0x1c
695 struct hci_ev_clock_offset {
699 } __attribute__ ((packed));
701 #define HCI_EV_PKT_TYPE_CHANGE 0x1d
702 struct hci_ev_pkt_type_change {
706 } __attribute__ ((packed));
708 #define HCI_EV_PSCAN_REP_MODE 0x20
709 struct hci_ev_pscan_rep_mode {
712 } __attribute__ ((packed));
714 #define HCI_EV_INQUIRY_RESULT_WITH_RSSI 0x22
715 struct inquiry_info_with_rssi {
718 __u8 pscan_period_mode;
722 } __attribute__ ((packed));
723 struct inquiry_info_with_rssi_and_pscan_mode {
726 __u8 pscan_period_mode;
731 } __attribute__ ((packed));
733 #define HCI_EV_REMOTE_EXT_FEATURES 0x23
734 struct hci_ev_remote_ext_features {
740 } __attribute__ ((packed));
742 #define HCI_EV_SYNC_CONN_COMPLETE 0x2c
743 struct hci_ev_sync_conn_complete {
753 } __attribute__ ((packed));
755 #define HCI_EV_SYNC_CONN_CHANGED 0x2d
756 struct hci_ev_sync_conn_changed {
763 } __attribute__ ((packed));
765 #define HCI_EV_SNIFF_SUBRATE 0x2e
766 struct hci_ev_sniff_subrate {
769 __le16 max_tx_latency;
770 __le16 max_rx_latency;
771 __le16 max_remote_timeout;
772 __le16 max_local_timeout;
773 } __attribute__ ((packed));
775 #define HCI_EV_EXTENDED_INQUIRY_RESULT 0x2f
776 struct extended_inquiry_info {
779 __u8 pscan_period_mode;
784 } __attribute__ ((packed));
786 /* Internal events generated by Bluetooth stack */
787 #define HCI_EV_STACK_INTERNAL 0xfd
788 struct hci_ev_stack_internal {
791 } __attribute__ ((packed));
793 #define HCI_EV_SI_DEVICE 0x01
794 struct hci_ev_si_device {
797 } __attribute__ ((packed));
799 #define HCI_EV_SI_SECURITY 0x02
800 struct hci_ev_si_security {
805 } __attribute__ ((packed));
807 /* ---- HCI Packet structures ---- */
808 #define HCI_COMMAND_HDR_SIZE 3
809 #define HCI_EVENT_HDR_SIZE 2
810 #define HCI_ACL_HDR_SIZE 4
811 #define HCI_SCO_HDR_SIZE 3
813 struct hci_command_hdr {
814 __le16 opcode; /* OCF & OGF */
816 } __attribute__ ((packed));
818 struct hci_event_hdr {
821 } __attribute__ ((packed));
824 __le16 handle; /* Handle & Flags(PB, BC) */
826 } __attribute__ ((packed));
831 } __attribute__ ((packed));
834 #include <linux/skbuff.h>
835 static inline struct hci_event_hdr *hci_event_hdr(const struct sk_buff *skb)
837 return (struct hci_event_hdr *) skb->data;
840 static inline struct hci_acl_hdr *hci_acl_hdr(const struct sk_buff *skb)
842 return (struct hci_acl_hdr *) skb->data;
845 static inline struct hci_sco_hdr *hci_sco_hdr(const struct sk_buff *skb)
847 return (struct hci_sco_hdr *) skb->data;
851 /* Command opcode pack/unpack */
852 #define hci_opcode_pack(ogf, ocf) (__u16) ((ocf & 0x03ff)|(ogf << 10))
853 #define hci_opcode_ogf(op) (op >> 10)
854 #define hci_opcode_ocf(op) (op & 0x03ff)
856 /* ACL handle and flags pack/unpack */
857 #define hci_handle_pack(h, f) (__u16) ((h & 0x0fff)|(f << 12))
858 #define hci_handle(h) (h & 0x0fff)
859 #define hci_flags(h) (h >> 12)
861 /* ---- HCI Sockets ---- */
864 #define HCI_DATA_DIR 1
866 #define HCI_TIME_STAMP 3
869 #define HCI_CMSG_DIR 0x0001
870 #define HCI_CMSG_TSTAMP 0x0002
872 struct sockaddr_hci {
873 sa_family_t hci_family;
874 unsigned short hci_dev;
876 #define HCI_DEV_NONE 0xffff
879 unsigned long type_mask;
880 unsigned long event_mask[2];
890 #define HCI_FLT_TYPE_BITS 31
891 #define HCI_FLT_EVENT_BITS 63
892 #define HCI_FLT_OGF_BITS 63
893 #define HCI_FLT_OCF_BITS 127
895 /* ---- HCI Ioctl requests structures ---- */
896 struct hci_dev_stats {
909 struct hci_dev_info {
929 struct hci_dev_stats stat;
932 struct hci_conn_info {
946 struct hci_dev_list_req {
948 struct hci_dev_req dev_req[0]; /* hci_dev_req structures */
951 struct hci_conn_list_req {
954 struct hci_conn_info conn_info[0];
957 struct hci_conn_info_req {
960 struct hci_conn_info conn_info[0];
963 struct hci_inquiry_req {
970 #define IREQ_CACHE_FLUSH 0x0001