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
141 #define ACL_CONT 0x01
142 #define ACL_START 0x02
143 #define ACL_ACTIVE_BCAST 0x04
144 #define ACL_PICO_BCAST 0x08
147 #define SCO_LINK 0x00
148 #define ACL_LINK 0x01
149 #define ESCO_LINK 0x02
152 #define LMP_3SLOT 0x01
153 #define LMP_5SLOT 0x02
154 #define LMP_ENCRYPT 0x04
155 #define LMP_SOFFSET 0x08
156 #define LMP_TACCURACY 0x10
157 #define LMP_RSWITCH 0x20
158 #define LMP_HOLD 0x40
159 #define LMP_SNIFF 0x80
161 #define LMP_PARK 0x01
162 #define LMP_RSSI 0x02
163 #define LMP_QUALITY 0x04
167 #define LMP_ULAW 0x40
168 #define LMP_ALAW 0x80
170 #define LMP_CVSD 0x01
171 #define LMP_PSCHEME 0x02
172 #define LMP_PCONTROL 0x04
174 #define LMP_ESCO 0x80
179 #define LMP_SNIFF_SUBR 0x02
181 /* Connection modes */
182 #define HCI_CM_ACTIVE 0x0000
183 #define HCI_CM_HOLD 0x0001
184 #define HCI_CM_SNIFF 0x0002
185 #define HCI_CM_PARK 0x0003
188 #define HCI_LP_RSWITCH 0x0001
189 #define HCI_LP_HOLD 0x0002
190 #define HCI_LP_SNIFF 0x0004
191 #define HCI_LP_PARK 0x0008
194 #define HCI_LM_ACCEPT 0x8000
195 #define HCI_LM_MASTER 0x0001
196 #define HCI_LM_AUTH 0x0002
197 #define HCI_LM_ENCRYPT 0x0004
198 #define HCI_LM_TRUSTED 0x0008
199 #define HCI_LM_RELIABLE 0x0010
200 #define HCI_LM_SECURE 0x0020
202 /* ----- HCI Commands ---- */
203 #define HCI_OP_INQUIRY 0x0401
204 struct hci_cp_inquiry {
208 } __attribute__ ((packed));
210 #define HCI_OP_INQUIRY_CANCEL 0x0402
212 #define HCI_OP_EXIT_PERIODIC_INQ 0x0404
214 #define HCI_OP_CREATE_CONN 0x0405
215 struct hci_cp_create_conn {
222 } __attribute__ ((packed));
224 #define HCI_OP_DISCONNECT 0x0406
225 struct hci_cp_disconnect {
228 } __attribute__ ((packed));
230 #define HCI_OP_ADD_SCO 0x0407
231 struct hci_cp_add_sco {
234 } __attribute__ ((packed));
236 #define HCI_OP_CREATE_CONN_CANCEL 0x0408
237 struct hci_cp_create_conn_cancel {
239 } __attribute__ ((packed));
241 #define HCI_OP_ACCEPT_CONN_REQ 0x0409
242 struct hci_cp_accept_conn_req {
245 } __attribute__ ((packed));
247 #define HCI_OP_REJECT_CONN_REQ 0x040a
248 struct hci_cp_reject_conn_req {
251 } __attribute__ ((packed));
253 #define HCI_OP_LINK_KEY_REPLY 0x040b
254 struct hci_cp_link_key_reply {
257 } __attribute__ ((packed));
259 #define HCI_OP_LINK_KEY_NEG_REPLY 0x040c
260 struct hci_cp_link_key_neg_reply {
262 } __attribute__ ((packed));
264 #define HCI_OP_PIN_CODE_REPLY 0x040d
265 struct hci_cp_pin_code_reply {
269 } __attribute__ ((packed));
271 #define HCI_OP_PIN_CODE_NEG_REPLY 0x040e
272 struct hci_cp_pin_code_neg_reply {
274 } __attribute__ ((packed));
276 #define HCI_OP_CHANGE_CONN_PTYPE 0x040f
277 struct hci_cp_change_conn_ptype {
280 } __attribute__ ((packed));
282 #define HCI_OP_AUTH_REQUESTED 0x0411
283 struct hci_cp_auth_requested {
285 } __attribute__ ((packed));
287 #define HCI_OP_SET_CONN_ENCRYPT 0x0413
288 struct hci_cp_set_conn_encrypt {
291 } __attribute__ ((packed));
293 #define HCI_OP_CHANGE_CONN_LINK_KEY 0x0415
294 struct hci_cp_change_conn_link_key {
296 } __attribute__ ((packed));
298 #define HCI_OP_REMOTE_NAME_REQ 0x0419
299 struct hci_cp_remote_name_req {
304 } __attribute__ ((packed));
306 #define HCI_OP_REMOTE_NAME_REQ_CANCEL 0x041a
307 struct hci_cp_remote_name_req_cancel {
309 } __attribute__ ((packed));
311 #define HCI_OP_READ_REMOTE_FEATURES 0x041b
312 struct hci_cp_read_remote_features {
314 } __attribute__ ((packed));
316 #define HCI_OP_READ_REMOTE_EXT_FEATURES 0x041c
317 struct hci_cp_read_remote_ext_features {
320 } __attribute__ ((packed));
322 #define HCI_OP_READ_REMOTE_VERSION 0x041d
323 struct hci_cp_read_remote_version {
325 } __attribute__ ((packed));
327 #define HCI_OP_SETUP_SYNC_CONN 0x0428
328 struct hci_cp_setup_sync_conn {
333 __le16 voice_setting;
336 } __attribute__ ((packed));
338 #define HCI_OP_ACCEPT_SYNC_CONN_REQ 0x0429
339 struct hci_cp_accept_sync_conn_req {
344 __le16 content_format;
347 } __attribute__ ((packed));
349 #define HCI_OP_REJECT_SYNC_CONN_REQ 0x042a
350 struct hci_cp_reject_sync_conn_req {
353 } __attribute__ ((packed));
355 #define HCI_OP_SNIFF_MODE 0x0803
356 struct hci_cp_sniff_mode {
362 } __attribute__ ((packed));
364 #define HCI_OP_EXIT_SNIFF_MODE 0x0804
365 struct hci_cp_exit_sniff_mode {
367 } __attribute__ ((packed));
369 #define HCI_OP_ROLE_DISCOVERY 0x0809
370 struct hci_cp_role_discovery {
372 } __attribute__ ((packed));
373 struct hci_rp_role_discovery {
377 } __attribute__ ((packed));
379 #define HCI_OP_SWITCH_ROLE 0x080b
380 struct hci_cp_switch_role {
383 } __attribute__ ((packed));
385 #define HCI_OP_READ_LINK_POLICY 0x080c
386 struct hci_cp_read_link_policy {
388 } __attribute__ ((packed));
389 struct hci_rp_read_link_policy {
393 } __attribute__ ((packed));
395 #define HCI_OP_WRITE_LINK_POLICY 0x080d
396 struct hci_cp_write_link_policy {
399 } __attribute__ ((packed));
400 struct hci_rp_write_link_policy {
403 } __attribute__ ((packed));
405 #define HCI_OP_SNIFF_SUBRATE 0x0811
406 struct hci_cp_sniff_subrate {
409 __le16 min_remote_timeout;
410 __le16 min_local_timeout;
411 } __attribute__ ((packed));
413 #define HCI_OP_SET_EVENT_MASK 0x0c01
414 struct hci_cp_set_event_mask {
416 } __attribute__ ((packed));
418 #define HCI_OP_RESET 0x0c03
420 #define HCI_OP_SET_EVENT_FLT 0x0c05
421 struct hci_cp_set_event_flt {
425 } __attribute__ ((packed));
428 #define HCI_FLT_CLEAR_ALL 0x00
429 #define HCI_FLT_INQ_RESULT 0x01
430 #define HCI_FLT_CONN_SETUP 0x02
432 /* CONN_SETUP Condition types */
433 #define HCI_CONN_SETUP_ALLOW_ALL 0x00
434 #define HCI_CONN_SETUP_ALLOW_CLASS 0x01
435 #define HCI_CONN_SETUP_ALLOW_BDADDR 0x02
437 /* CONN_SETUP Conditions */
438 #define HCI_CONN_SETUP_AUTO_OFF 0x01
439 #define HCI_CONN_SETUP_AUTO_ON 0x02
441 #define HCI_OP_WRITE_LOCAL_NAME 0x0c13
442 struct hci_cp_write_local_name {
444 } __attribute__ ((packed));
446 #define HCI_OP_READ_LOCAL_NAME 0x0c14
447 struct hci_rp_read_local_name {
450 } __attribute__ ((packed));
452 #define HCI_OP_WRITE_CA_TIMEOUT 0x0c16
454 #define HCI_OP_WRITE_PG_TIMEOUT 0x0c18
456 #define HCI_OP_WRITE_SCAN_ENABLE 0x0c1a
457 #define SCAN_DISABLED 0x00
458 #define SCAN_INQUIRY 0x01
459 #define SCAN_PAGE 0x02
461 #define HCI_OP_READ_AUTH_ENABLE 0x0c1f
463 #define HCI_OP_WRITE_AUTH_ENABLE 0x0c20
464 #define AUTH_DISABLED 0x00
465 #define AUTH_ENABLED 0x01
467 #define HCI_OP_READ_ENCRYPT_MODE 0x0c21
469 #define HCI_OP_WRITE_ENCRYPT_MODE 0x0c22
470 #define ENCRYPT_DISABLED 0x00
471 #define ENCRYPT_P2P 0x01
472 #define ENCRYPT_BOTH 0x02
474 #define HCI_OP_READ_CLASS_OF_DEV 0x0c23
475 struct hci_rp_read_class_of_dev {
478 } __attribute__ ((packed));
480 #define HCI_OP_WRITE_CLASS_OF_DEV 0x0c24
481 struct hci_cp_write_class_of_dev {
483 } __attribute__ ((packed));
485 #define HCI_OP_READ_VOICE_SETTING 0x0c25
486 struct hci_rp_read_voice_setting {
488 __le16 voice_setting;
489 } __attribute__ ((packed));
491 #define HCI_OP_WRITE_VOICE_SETTING 0x0c26
492 struct hci_cp_write_voice_setting {
493 __le16 voice_setting;
494 } __attribute__ ((packed));
496 #define HCI_OP_HOST_BUFFER_SIZE 0x0c33
497 struct hci_cp_host_buffer_size {
502 } __attribute__ ((packed));
504 #define HCI_OP_READ_LOCAL_VERSION 0x1001
505 struct hci_rp_read_local_version {
512 } __attribute__ ((packed));
514 #define HCI_OP_READ_LOCAL_COMMANDS 0x1002
515 struct hci_rp_read_local_commands {
518 } __attribute__ ((packed));
520 #define HCI_OP_READ_LOCAL_FEATURES 0x1003
521 struct hci_rp_read_local_features {
524 } __attribute__ ((packed));
526 #define HCI_OP_READ_LOCAL_EXT_FEATURES 0x1004
527 struct hci_rp_read_local_ext_features {
532 } __attribute__ ((packed));
534 #define HCI_OP_READ_BUFFER_SIZE 0x1005
535 struct hci_rp_read_buffer_size {
541 } __attribute__ ((packed));
543 #define HCI_OP_READ_BD_ADDR 0x1009
544 struct hci_rp_read_bd_addr {
547 } __attribute__ ((packed));
549 /* ---- HCI Events ---- */
550 #define HCI_EV_INQUIRY_COMPLETE 0x01
552 #define HCI_EV_INQUIRY_RESULT 0x02
553 struct inquiry_info {
556 __u8 pscan_period_mode;
560 } __attribute__ ((packed));
562 #define HCI_EV_CONN_COMPLETE 0x03
563 struct hci_ev_conn_complete {
569 } __attribute__ ((packed));
571 #define HCI_EV_CONN_REQUEST 0x04
572 struct hci_ev_conn_request {
576 } __attribute__ ((packed));
578 #define HCI_EV_DISCONN_COMPLETE 0x05
579 struct hci_ev_disconn_complete {
583 } __attribute__ ((packed));
585 #define HCI_EV_AUTH_COMPLETE 0x06
586 struct hci_ev_auth_complete {
589 } __attribute__ ((packed));
591 #define HCI_EV_REMOTE_NAME 0x07
592 struct hci_ev_remote_name {
596 } __attribute__ ((packed));
598 #define HCI_EV_ENCRYPT_CHANGE 0x08
599 struct hci_ev_encrypt_change {
603 } __attribute__ ((packed));
605 #define HCI_EV_CHANGE_LINK_KEY_COMPLETE 0x09
606 struct hci_ev_change_link_key_complete {
609 } __attribute__ ((packed));
611 #define HCI_EV_REMOTE_FEATURES 0x0b
612 struct hci_ev_remote_features {
616 } __attribute__ ((packed));
618 #define HCI_EV_REMOTE_VERSION 0x0c
619 struct hci_ev_remote_version {
625 } __attribute__ ((packed));
627 #define HCI_EV_QOS_SETUP_COMPLETE 0x0d
631 __u32 peak_bandwidth;
633 __u32 delay_variation;
634 } __attribute__ ((packed));
635 struct hci_ev_qos_setup_complete {
639 } __attribute__ ((packed));
641 #define HCI_EV_CMD_COMPLETE 0x0e
642 struct hci_ev_cmd_complete {
645 } __attribute__ ((packed));
647 #define HCI_EV_CMD_STATUS 0x0f
648 struct hci_ev_cmd_status {
652 } __attribute__ ((packed));
654 #define HCI_EV_ROLE_CHANGE 0x12
655 struct hci_ev_role_change {
659 } __attribute__ ((packed));
661 #define HCI_EV_NUM_COMP_PKTS 0x13
662 struct hci_ev_num_comp_pkts {
664 /* variable length part */
665 } __attribute__ ((packed));
667 #define HCI_EV_MODE_CHANGE 0x14
668 struct hci_ev_mode_change {
673 } __attribute__ ((packed));
675 #define HCI_EV_PIN_CODE_REQ 0x16
676 struct hci_ev_pin_code_req {
678 } __attribute__ ((packed));
680 #define HCI_EV_LINK_KEY_REQ 0x17
681 struct hci_ev_link_key_req {
683 } __attribute__ ((packed));
685 #define HCI_EV_LINK_KEY_NOTIFY 0x18
686 struct hci_ev_link_key_notify {
690 } __attribute__ ((packed));
692 #define HCI_EV_CLOCK_OFFSET 0x1c
693 struct hci_ev_clock_offset {
697 } __attribute__ ((packed));
699 #define HCI_EV_PSCAN_REP_MODE 0x20
700 struct hci_ev_pscan_rep_mode {
703 } __attribute__ ((packed));
705 #define HCI_EV_INQUIRY_RESULT_WITH_RSSI 0x22
706 struct inquiry_info_with_rssi {
709 __u8 pscan_period_mode;
713 } __attribute__ ((packed));
714 struct inquiry_info_with_rssi_and_pscan_mode {
717 __u8 pscan_period_mode;
722 } __attribute__ ((packed));
724 #define HCI_EV_REMOTE_EXT_FEATURES 0x23
725 struct hci_ev_remote_ext_features {
731 } __attribute__ ((packed));
733 #define HCI_EV_SYNC_CONN_COMPLETE 0x2c
734 struct hci_ev_sync_conn_complete {
744 } __attribute__ ((packed));
746 #define HCI_EV_SYNC_CONN_CHANGED 0x2d
747 struct hci_ev_sync_conn_changed {
754 } __attribute__ ((packed));
756 #define HCI_EV_SNIFF_SUBRATE 0x2e
757 struct hci_ev_sniff_subrate {
760 __le16 max_tx_latency;
761 __le16 max_rx_latency;
762 __le16 max_remote_timeout;
763 __le16 max_local_timeout;
764 } __attribute__ ((packed));
766 #define HCI_EV_EXTENDED_INQUIRY_RESULT 0x2f
767 struct extended_inquiry_info {
770 __u8 pscan_period_mode;
775 } __attribute__ ((packed));
777 /* Internal events generated by Bluetooth stack */
778 #define HCI_EV_STACK_INTERNAL 0xfd
779 struct hci_ev_stack_internal {
782 } __attribute__ ((packed));
784 #define HCI_EV_SI_DEVICE 0x01
785 struct hci_ev_si_device {
788 } __attribute__ ((packed));
790 #define HCI_EV_SI_SECURITY 0x02
791 struct hci_ev_si_security {
796 } __attribute__ ((packed));
798 /* ---- HCI Packet structures ---- */
799 #define HCI_COMMAND_HDR_SIZE 3
800 #define HCI_EVENT_HDR_SIZE 2
801 #define HCI_ACL_HDR_SIZE 4
802 #define HCI_SCO_HDR_SIZE 3
804 struct hci_command_hdr {
805 __le16 opcode; /* OCF & OGF */
807 } __attribute__ ((packed));
809 struct hci_event_hdr {
812 } __attribute__ ((packed));
815 __le16 handle; /* Handle & Flags(PB, BC) */
817 } __attribute__ ((packed));
822 } __attribute__ ((packed));
825 #include <linux/skbuff.h>
826 static inline struct hci_event_hdr *hci_event_hdr(const struct sk_buff *skb)
828 return (struct hci_event_hdr *) skb->data;
831 static inline struct hci_acl_hdr *hci_acl_hdr(const struct sk_buff *skb)
833 return (struct hci_acl_hdr *) skb->data;
836 static inline struct hci_sco_hdr *hci_sco_hdr(const struct sk_buff *skb)
838 return (struct hci_sco_hdr *) skb->data;
842 /* Command opcode pack/unpack */
843 #define hci_opcode_pack(ogf, ocf) (__u16) ((ocf & 0x03ff)|(ogf << 10))
844 #define hci_opcode_ogf(op) (op >> 10)
845 #define hci_opcode_ocf(op) (op & 0x03ff)
847 /* ACL handle and flags pack/unpack */
848 #define hci_handle_pack(h, f) (__u16) ((h & 0x0fff)|(f << 12))
849 #define hci_handle(h) (h & 0x0fff)
850 #define hci_flags(h) (h >> 12)
852 /* ---- HCI Sockets ---- */
855 #define HCI_DATA_DIR 1
857 #define HCI_TIME_STAMP 3
860 #define HCI_CMSG_DIR 0x0001
861 #define HCI_CMSG_TSTAMP 0x0002
863 struct sockaddr_hci {
864 sa_family_t hci_family;
865 unsigned short hci_dev;
867 #define HCI_DEV_NONE 0xffff
870 unsigned long type_mask;
871 unsigned long event_mask[2];
881 #define HCI_FLT_TYPE_BITS 31
882 #define HCI_FLT_EVENT_BITS 63
883 #define HCI_FLT_OGF_BITS 63
884 #define HCI_FLT_OCF_BITS 127
886 /* ---- HCI Ioctl requests structures ---- */
887 struct hci_dev_stats {
900 struct hci_dev_info {
920 struct hci_dev_stats stat;
923 struct hci_conn_info {
937 struct hci_dev_list_req {
939 struct hci_dev_req dev_req[0]; /* hci_dev_req structures */
942 struct hci_conn_list_req {
945 struct hci_conn_info conn_info[0];
948 struct hci_conn_info_req {
951 struct hci_conn_info conn_info[0];
954 struct hci_inquiry_req {
961 #define IREQ_CACHE_FLUSH 0x0001