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
55 /* HCI controller types */
56 #define HCI_BREDR 0x00
59 /* HCI device quirks */
63 HCI_QUIRK_FIXUP_BUFFER_SIZE
66 /* HCI device flags */
85 /* HCI ioctl defines */
86 #define HCIDEVUP _IOW('H', 201, int)
87 #define HCIDEVDOWN _IOW('H', 202, int)
88 #define HCIDEVRESET _IOW('H', 203, int)
89 #define HCIDEVRESTAT _IOW('H', 204, int)
91 #define HCIGETDEVLIST _IOR('H', 210, int)
92 #define HCIGETDEVINFO _IOR('H', 211, int)
93 #define HCIGETCONNLIST _IOR('H', 212, int)
94 #define HCIGETCONNINFO _IOR('H', 213, int)
95 #define HCIGETAUTHINFO _IOR('H', 215, int)
97 #define HCISETRAW _IOW('H', 220, int)
98 #define HCISETSCAN _IOW('H', 221, int)
99 #define HCISETAUTH _IOW('H', 222, int)
100 #define HCISETENCRYPT _IOW('H', 223, int)
101 #define HCISETPTYPE _IOW('H', 224, int)
102 #define HCISETLINKPOL _IOW('H', 225, int)
103 #define HCISETLINKMODE _IOW('H', 226, int)
104 #define HCISETACLMTU _IOW('H', 227, int)
105 #define HCISETSCOMTU _IOW('H', 228, int)
107 #define HCIBLOCKADDR _IOW('H', 230, int)
108 #define HCIUNBLOCKADDR _IOW('H', 231, int)
110 #define HCIINQUIRY _IOR('H', 240, int)
113 #define HCI_CONNECT_TIMEOUT (40000) /* 40 seconds */
114 #define HCI_DISCONN_TIMEOUT (2000) /* 2 seconds */
115 #define HCI_PAIRING_TIMEOUT (60000) /* 60 seconds */
116 #define HCI_IDLE_TIMEOUT (6000) /* 6 seconds */
117 #define HCI_INIT_TIMEOUT (10000) /* 10 seconds */
120 #define HCI_COMMAND_PKT 0x01
121 #define HCI_ACLDATA_PKT 0x02
122 #define HCI_SCODATA_PKT 0x03
123 #define HCI_EVENT_PKT 0x04
124 #define HCI_VENDOR_PKT 0xff
126 /* HCI packet types */
127 #define HCI_DM1 0x0008
128 #define HCI_DM3 0x0400
129 #define HCI_DM5 0x4000
130 #define HCI_DH1 0x0010
131 #define HCI_DH3 0x0800
132 #define HCI_DH5 0x8000
134 #define HCI_HV1 0x0020
135 #define HCI_HV2 0x0040
136 #define HCI_HV3 0x0080
138 #define SCO_PTYPE_MASK (HCI_HV1 | HCI_HV2 | HCI_HV3)
139 #define ACL_PTYPE_MASK (~SCO_PTYPE_MASK)
141 /* eSCO packet types */
142 #define ESCO_HV1 0x0001
143 #define ESCO_HV2 0x0002
144 #define ESCO_HV3 0x0004
145 #define ESCO_EV3 0x0008
146 #define ESCO_EV4 0x0010
147 #define ESCO_EV5 0x0020
148 #define ESCO_2EV3 0x0040
149 #define ESCO_3EV3 0x0080
150 #define ESCO_2EV5 0x0100
151 #define ESCO_3EV5 0x0200
153 #define SCO_ESCO_MASK (ESCO_HV1 | ESCO_HV2 | ESCO_HV3)
154 #define EDR_ESCO_MASK (ESCO_2EV3 | ESCO_3EV3 | ESCO_2EV5 | ESCO_3EV5)
157 #define ACL_START_NO_FLUSH 0x00
158 #define ACL_CONT 0x01
159 #define ACL_START 0x02
160 #define ACL_ACTIVE_BCAST 0x04
161 #define ACL_PICO_BCAST 0x08
164 #define SCO_LINK 0x00
165 #define ACL_LINK 0x01
166 #define ESCO_LINK 0x02
169 #define LMP_3SLOT 0x01
170 #define LMP_5SLOT 0x02
171 #define LMP_ENCRYPT 0x04
172 #define LMP_SOFFSET 0x08
173 #define LMP_TACCURACY 0x10
174 #define LMP_RSWITCH 0x20
175 #define LMP_HOLD 0x40
176 #define LMP_SNIFF 0x80
178 #define LMP_PARK 0x01
179 #define LMP_RSSI 0x02
180 #define LMP_QUALITY 0x04
184 #define LMP_ULAW 0x40
185 #define LMP_ALAW 0x80
187 #define LMP_CVSD 0x01
188 #define LMP_PSCHEME 0x02
189 #define LMP_PCONTROL 0x04
191 #define LMP_ESCO 0x80
196 #define LMP_SNIFF_SUBR 0x02
197 #define LMP_EDR_ESCO_2M 0x20
198 #define LMP_EDR_ESCO_3M 0x40
199 #define LMP_EDR_3S_ESCO 0x80
201 #define LMP_SIMPLE_PAIR 0x08
202 #define LMP_NO_FLUSH 0x40
204 /* Connection modes */
205 #define HCI_CM_ACTIVE 0x0000
206 #define HCI_CM_HOLD 0x0001
207 #define HCI_CM_SNIFF 0x0002
208 #define HCI_CM_PARK 0x0003
211 #define HCI_LP_RSWITCH 0x0001
212 #define HCI_LP_HOLD 0x0002
213 #define HCI_LP_SNIFF 0x0004
214 #define HCI_LP_PARK 0x0008
217 #define HCI_LM_ACCEPT 0x8000
218 #define HCI_LM_MASTER 0x0001
219 #define HCI_LM_AUTH 0x0002
220 #define HCI_LM_ENCRYPT 0x0004
221 #define HCI_LM_TRUSTED 0x0008
222 #define HCI_LM_RELIABLE 0x0010
223 #define HCI_LM_SECURE 0x0020
225 /* Authentication types */
226 #define HCI_AT_NO_BONDING 0x00
227 #define HCI_AT_NO_BONDING_MITM 0x01
228 #define HCI_AT_DEDICATED_BONDING 0x02
229 #define HCI_AT_DEDICATED_BONDING_MITM 0x03
230 #define HCI_AT_GENERAL_BONDING 0x04
231 #define HCI_AT_GENERAL_BONDING_MITM 0x05
233 /* ----- HCI Commands ---- */
234 #define HCI_OP_INQUIRY 0x0401
235 struct hci_cp_inquiry
{
241 #define HCI_OP_INQUIRY_CANCEL 0x0402
243 #define HCI_OP_EXIT_PERIODIC_INQ 0x0404
245 #define HCI_OP_CREATE_CONN 0x0405
246 struct hci_cp_create_conn
{
255 #define HCI_OP_DISCONNECT 0x0406
256 struct hci_cp_disconnect
{
261 #define HCI_OP_ADD_SCO 0x0407
262 struct hci_cp_add_sco
{
267 #define HCI_OP_CREATE_CONN_CANCEL 0x0408
268 struct hci_cp_create_conn_cancel
{
272 #define HCI_OP_ACCEPT_CONN_REQ 0x0409
273 struct hci_cp_accept_conn_req
{
278 #define HCI_OP_REJECT_CONN_REQ 0x040a
279 struct hci_cp_reject_conn_req
{
284 #define HCI_OP_LINK_KEY_REPLY 0x040b
285 struct hci_cp_link_key_reply
{
290 #define HCI_OP_LINK_KEY_NEG_REPLY 0x040c
291 struct hci_cp_link_key_neg_reply
{
295 #define HCI_OP_PIN_CODE_REPLY 0x040d
296 struct hci_cp_pin_code_reply
{
302 #define HCI_OP_PIN_CODE_NEG_REPLY 0x040e
303 struct hci_cp_pin_code_neg_reply
{
307 #define HCI_OP_CHANGE_CONN_PTYPE 0x040f
308 struct hci_cp_change_conn_ptype
{
313 #define HCI_OP_AUTH_REQUESTED 0x0411
314 struct hci_cp_auth_requested
{
318 #define HCI_OP_SET_CONN_ENCRYPT 0x0413
319 struct hci_cp_set_conn_encrypt
{
324 #define HCI_OP_CHANGE_CONN_LINK_KEY 0x0415
325 struct hci_cp_change_conn_link_key
{
329 #define HCI_OP_REMOTE_NAME_REQ 0x0419
330 struct hci_cp_remote_name_req
{
337 #define HCI_OP_REMOTE_NAME_REQ_CANCEL 0x041a
338 struct hci_cp_remote_name_req_cancel
{
342 #define HCI_OP_READ_REMOTE_FEATURES 0x041b
343 struct hci_cp_read_remote_features
{
347 #define HCI_OP_READ_REMOTE_EXT_FEATURES 0x041c
348 struct hci_cp_read_remote_ext_features
{
353 #define HCI_OP_READ_REMOTE_VERSION 0x041d
354 struct hci_cp_read_remote_version
{
358 #define HCI_OP_SETUP_SYNC_CONN 0x0428
359 struct hci_cp_setup_sync_conn
{
364 __le16 voice_setting
;
369 #define HCI_OP_ACCEPT_SYNC_CONN_REQ 0x0429
370 struct hci_cp_accept_sync_conn_req
{
375 __le16 content_format
;
380 #define HCI_OP_REJECT_SYNC_CONN_REQ 0x042a
381 struct hci_cp_reject_sync_conn_req
{
386 #define HCI_OP_SNIFF_MODE 0x0803
387 struct hci_cp_sniff_mode
{
395 #define HCI_OP_EXIT_SNIFF_MODE 0x0804
396 struct hci_cp_exit_sniff_mode
{
400 #define HCI_OP_ROLE_DISCOVERY 0x0809
401 struct hci_cp_role_discovery
{
404 struct hci_rp_role_discovery
{
410 #define HCI_OP_SWITCH_ROLE 0x080b
411 struct hci_cp_switch_role
{
416 #define HCI_OP_READ_LINK_POLICY 0x080c
417 struct hci_cp_read_link_policy
{
420 struct hci_rp_read_link_policy
{
426 #define HCI_OP_WRITE_LINK_POLICY 0x080d
427 struct hci_cp_write_link_policy
{
431 struct hci_rp_write_link_policy
{
436 #define HCI_OP_READ_DEF_LINK_POLICY 0x080e
437 struct hci_rp_read_def_link_policy
{
442 #define HCI_OP_WRITE_DEF_LINK_POLICY 0x080f
443 struct hci_cp_write_def_link_policy
{
447 #define HCI_OP_SNIFF_SUBRATE 0x0811
448 struct hci_cp_sniff_subrate
{
451 __le16 min_remote_timeout
;
452 __le16 min_local_timeout
;
455 #define HCI_OP_SET_EVENT_MASK 0x0c01
456 struct hci_cp_set_event_mask
{
460 #define HCI_OP_RESET 0x0c03
462 #define HCI_OP_SET_EVENT_FLT 0x0c05
463 struct hci_cp_set_event_flt
{
470 #define HCI_FLT_CLEAR_ALL 0x00
471 #define HCI_FLT_INQ_RESULT 0x01
472 #define HCI_FLT_CONN_SETUP 0x02
474 /* CONN_SETUP Condition types */
475 #define HCI_CONN_SETUP_ALLOW_ALL 0x00
476 #define HCI_CONN_SETUP_ALLOW_CLASS 0x01
477 #define HCI_CONN_SETUP_ALLOW_BDADDR 0x02
479 /* CONN_SETUP Conditions */
480 #define HCI_CONN_SETUP_AUTO_OFF 0x01
481 #define HCI_CONN_SETUP_AUTO_ON 0x02
483 #define HCI_OP_WRITE_LOCAL_NAME 0x0c13
484 struct hci_cp_write_local_name
{
488 #define HCI_OP_READ_LOCAL_NAME 0x0c14
489 struct hci_rp_read_local_name
{
494 #define HCI_OP_WRITE_CA_TIMEOUT 0x0c16
496 #define HCI_OP_WRITE_PG_TIMEOUT 0x0c18
498 #define HCI_OP_WRITE_SCAN_ENABLE 0x0c1a
499 #define SCAN_DISABLED 0x00
500 #define SCAN_INQUIRY 0x01
501 #define SCAN_PAGE 0x02
503 #define HCI_OP_READ_AUTH_ENABLE 0x0c1f
505 #define HCI_OP_WRITE_AUTH_ENABLE 0x0c20
506 #define AUTH_DISABLED 0x00
507 #define AUTH_ENABLED 0x01
509 #define HCI_OP_READ_ENCRYPT_MODE 0x0c21
511 #define HCI_OP_WRITE_ENCRYPT_MODE 0x0c22
512 #define ENCRYPT_DISABLED 0x00
513 #define ENCRYPT_P2P 0x01
514 #define ENCRYPT_BOTH 0x02
516 #define HCI_OP_READ_CLASS_OF_DEV 0x0c23
517 struct hci_rp_read_class_of_dev
{
522 #define HCI_OP_WRITE_CLASS_OF_DEV 0x0c24
523 struct hci_cp_write_class_of_dev
{
527 #define HCI_OP_READ_VOICE_SETTING 0x0c25
528 struct hci_rp_read_voice_setting
{
530 __le16 voice_setting
;
533 #define HCI_OP_WRITE_VOICE_SETTING 0x0c26
534 struct hci_cp_write_voice_setting
{
535 __le16 voice_setting
;
538 #define HCI_OP_HOST_BUFFER_SIZE 0x0c33
539 struct hci_cp_host_buffer_size
{
546 #define HCI_OP_READ_SSP_MODE 0x0c55
547 struct hci_rp_read_ssp_mode
{
552 #define HCI_OP_WRITE_SSP_MODE 0x0c56
553 struct hci_cp_write_ssp_mode
{
557 #define HCI_OP_READ_LOCAL_VERSION 0x1001
558 struct hci_rp_read_local_version
{
567 #define HCI_OP_READ_LOCAL_COMMANDS 0x1002
568 struct hci_rp_read_local_commands
{
573 #define HCI_OP_READ_LOCAL_FEATURES 0x1003
574 struct hci_rp_read_local_features
{
579 #define HCI_OP_READ_LOCAL_EXT_FEATURES 0x1004
580 struct hci_rp_read_local_ext_features
{
587 #define HCI_OP_READ_BUFFER_SIZE 0x1005
588 struct hci_rp_read_buffer_size
{
596 #define HCI_OP_READ_BD_ADDR 0x1009
597 struct hci_rp_read_bd_addr
{
602 /* ---- HCI Events ---- */
603 #define HCI_EV_INQUIRY_COMPLETE 0x01
605 #define HCI_EV_INQUIRY_RESULT 0x02
606 struct inquiry_info
{
609 __u8 pscan_period_mode
;
615 #define HCI_EV_CONN_COMPLETE 0x03
616 struct hci_ev_conn_complete
{
624 #define HCI_EV_CONN_REQUEST 0x04
625 struct hci_ev_conn_request
{
631 #define HCI_EV_DISCONN_COMPLETE 0x05
632 struct hci_ev_disconn_complete
{
638 #define HCI_EV_AUTH_COMPLETE 0x06
639 struct hci_ev_auth_complete
{
644 #define HCI_EV_REMOTE_NAME 0x07
645 struct hci_ev_remote_name
{
651 #define HCI_EV_ENCRYPT_CHANGE 0x08
652 struct hci_ev_encrypt_change
{
658 #define HCI_EV_CHANGE_LINK_KEY_COMPLETE 0x09
659 struct hci_ev_change_link_key_complete
{
664 #define HCI_EV_REMOTE_FEATURES 0x0b
665 struct hci_ev_remote_features
{
671 #define HCI_EV_REMOTE_VERSION 0x0c
672 struct hci_ev_remote_version
{
680 #define HCI_EV_QOS_SETUP_COMPLETE 0x0d
684 __u32 peak_bandwidth
;
686 __u32 delay_variation
;
688 struct hci_ev_qos_setup_complete
{
694 #define HCI_EV_CMD_COMPLETE 0x0e
695 struct hci_ev_cmd_complete
{
700 #define HCI_EV_CMD_STATUS 0x0f
701 struct hci_ev_cmd_status
{
707 #define HCI_EV_ROLE_CHANGE 0x12
708 struct hci_ev_role_change
{
714 #define HCI_EV_NUM_COMP_PKTS 0x13
715 struct hci_ev_num_comp_pkts
{
717 /* variable length part */
720 #define HCI_EV_MODE_CHANGE 0x14
721 struct hci_ev_mode_change
{
728 #define HCI_EV_PIN_CODE_REQ 0x16
729 struct hci_ev_pin_code_req
{
733 #define HCI_EV_LINK_KEY_REQ 0x17
734 struct hci_ev_link_key_req
{
738 #define HCI_EV_LINK_KEY_NOTIFY 0x18
739 struct hci_ev_link_key_notify
{
745 #define HCI_EV_CLOCK_OFFSET 0x1c
746 struct hci_ev_clock_offset
{
752 #define HCI_EV_PKT_TYPE_CHANGE 0x1d
753 struct hci_ev_pkt_type_change
{
759 #define HCI_EV_PSCAN_REP_MODE 0x20
760 struct hci_ev_pscan_rep_mode
{
765 #define HCI_EV_INQUIRY_RESULT_WITH_RSSI 0x22
766 struct inquiry_info_with_rssi
{
769 __u8 pscan_period_mode
;
774 struct inquiry_info_with_rssi_and_pscan_mode
{
777 __u8 pscan_period_mode
;
784 #define HCI_EV_REMOTE_EXT_FEATURES 0x23
785 struct hci_ev_remote_ext_features
{
793 #define HCI_EV_SYNC_CONN_COMPLETE 0x2c
794 struct hci_ev_sync_conn_complete
{
806 #define HCI_EV_SYNC_CONN_CHANGED 0x2d
807 struct hci_ev_sync_conn_changed
{
816 #define HCI_EV_SNIFF_SUBRATE 0x2e
817 struct hci_ev_sniff_subrate
{
820 __le16 max_tx_latency
;
821 __le16 max_rx_latency
;
822 __le16 max_remote_timeout
;
823 __le16 max_local_timeout
;
826 #define HCI_EV_EXTENDED_INQUIRY_RESULT 0x2f
827 struct extended_inquiry_info
{
830 __u8 pscan_period_mode
;
837 #define HCI_EV_IO_CAPA_REQUEST 0x31
838 struct hci_ev_io_capa_request
{
842 #define HCI_EV_SIMPLE_PAIR_COMPLETE 0x36
843 struct hci_ev_simple_pair_complete
{
848 #define HCI_EV_REMOTE_HOST_FEATURES 0x3d
849 struct hci_ev_remote_host_features
{
854 /* Internal events generated by Bluetooth stack */
855 #define HCI_EV_STACK_INTERNAL 0xfd
856 struct hci_ev_stack_internal
{
861 #define HCI_EV_SI_DEVICE 0x01
862 struct hci_ev_si_device
{
867 #define HCI_EV_SI_SECURITY 0x02
868 struct hci_ev_si_security
{
875 /* ---- HCI Packet structures ---- */
876 #define HCI_COMMAND_HDR_SIZE 3
877 #define HCI_EVENT_HDR_SIZE 2
878 #define HCI_ACL_HDR_SIZE 4
879 #define HCI_SCO_HDR_SIZE 3
881 struct hci_command_hdr
{
882 __le16 opcode
; /* OCF & OGF */
886 struct hci_event_hdr
{
892 __le16 handle
; /* Handle & Flags(PB, BC) */
902 #include <linux/skbuff.h>
903 static inline struct hci_event_hdr
*hci_event_hdr(const struct sk_buff
*skb
)
905 return (struct hci_event_hdr
*) skb
->data
;
908 static inline struct hci_acl_hdr
*hci_acl_hdr(const struct sk_buff
*skb
)
910 return (struct hci_acl_hdr
*) skb
->data
;
913 static inline struct hci_sco_hdr
*hci_sco_hdr(const struct sk_buff
*skb
)
915 return (struct hci_sco_hdr
*) skb
->data
;
919 /* Command opcode pack/unpack */
920 #define hci_opcode_pack(ogf, ocf) (__u16) ((ocf & 0x03ff)|(ogf << 10))
921 #define hci_opcode_ogf(op) (op >> 10)
922 #define hci_opcode_ocf(op) (op & 0x03ff)
924 /* ACL handle and flags pack/unpack */
925 #define hci_handle_pack(h, f) (__u16) ((h & 0x0fff)|(f << 12))
926 #define hci_handle(h) (h & 0x0fff)
927 #define hci_flags(h) (h >> 12)
929 /* ---- HCI Sockets ---- */
932 #define HCI_DATA_DIR 1
934 #define HCI_TIME_STAMP 3
937 #define HCI_CMSG_DIR 0x0001
938 #define HCI_CMSG_TSTAMP 0x0002
940 struct sockaddr_hci
{
941 sa_family_t hci_family
;
942 unsigned short hci_dev
;
943 unsigned short hci_channel
;
945 #define HCI_DEV_NONE 0xffff
947 #define HCI_CHANNEL_RAW 0
948 #define HCI_CHANNEL_CONTROL 1
951 unsigned long type_mask
;
952 unsigned long event_mask
[2];
962 #define HCI_FLT_TYPE_BITS 31
963 #define HCI_FLT_EVENT_BITS 63
964 #define HCI_FLT_OGF_BITS 63
965 #define HCI_FLT_OCF_BITS 127
967 /* ---- HCI Ioctl requests structures ---- */
968 struct hci_dev_stats
{
981 struct hci_dev_info
{
1001 struct hci_dev_stats stat
;
1004 struct hci_conn_info
{
1013 struct hci_dev_req
{
1018 struct hci_dev_list_req
{
1020 struct hci_dev_req dev_req
[0]; /* hci_dev_req structures */
1023 struct hci_conn_list_req
{
1026 struct hci_conn_info conn_info
[0];
1029 struct hci_conn_info_req
{
1032 struct hci_conn_info conn_info
[0];
1035 struct hci_auth_info_req
{
1040 struct hci_inquiry_req
{
1047 #define IREQ_CACHE_FLUSH 0x0001
1049 #endif /* __HCI_H */