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 */
81 /* HCI ioctl defines */
82 #define HCIDEVUP _IOW('H', 201, int)
83 #define HCIDEVDOWN _IOW('H', 202, int)
84 #define HCIDEVRESET _IOW('H', 203, int)
85 #define HCIDEVRESTAT _IOW('H', 204, int)
87 #define HCIGETDEVLIST _IOR('H', 210, int)
88 #define HCIGETDEVINFO _IOR('H', 211, int)
89 #define HCIGETCONNLIST _IOR('H', 212, int)
90 #define HCIGETCONNINFO _IOR('H', 213, int)
91 #define HCIGETAUTHINFO _IOR('H', 215, int)
93 #define HCISETRAW _IOW('H', 220, int)
94 #define HCISETSCAN _IOW('H', 221, int)
95 #define HCISETAUTH _IOW('H', 222, int)
96 #define HCISETENCRYPT _IOW('H', 223, int)
97 #define HCISETPTYPE _IOW('H', 224, int)
98 #define HCISETLINKPOL _IOW('H', 225, int)
99 #define HCISETLINKMODE _IOW('H', 226, int)
100 #define HCISETACLMTU _IOW('H', 227, int)
101 #define HCISETSCOMTU _IOW('H', 228, int)
103 #define HCIBLOCKADDR _IOW('H', 230, int)
104 #define HCIUNBLOCKADDR _IOW('H', 231, int)
106 #define HCIINQUIRY _IOR('H', 240, int)
109 #define HCI_CONNECT_TIMEOUT (40000) /* 40 seconds */
110 #define HCI_DISCONN_TIMEOUT (2000) /* 2 seconds */
111 #define HCI_PAIRING_TIMEOUT (60000) /* 60 seconds */
112 #define HCI_IDLE_TIMEOUT (6000) /* 6 seconds */
113 #define HCI_INIT_TIMEOUT (10000) /* 10 seconds */
116 #define HCI_COMMAND_PKT 0x01
117 #define HCI_ACLDATA_PKT 0x02
118 #define HCI_SCODATA_PKT 0x03
119 #define HCI_EVENT_PKT 0x04
120 #define HCI_VENDOR_PKT 0xff
122 /* HCI packet types */
123 #define HCI_DM1 0x0008
124 #define HCI_DM3 0x0400
125 #define HCI_DM5 0x4000
126 #define HCI_DH1 0x0010
127 #define HCI_DH3 0x0800
128 #define HCI_DH5 0x8000
130 #define HCI_HV1 0x0020
131 #define HCI_HV2 0x0040
132 #define HCI_HV3 0x0080
134 #define SCO_PTYPE_MASK (HCI_HV1 | HCI_HV2 | HCI_HV3)
135 #define ACL_PTYPE_MASK (~SCO_PTYPE_MASK)
137 /* eSCO packet types */
138 #define ESCO_HV1 0x0001
139 #define ESCO_HV2 0x0002
140 #define ESCO_HV3 0x0004
141 #define ESCO_EV3 0x0008
142 #define ESCO_EV4 0x0010
143 #define ESCO_EV5 0x0020
144 #define ESCO_2EV3 0x0040
145 #define ESCO_3EV3 0x0080
146 #define ESCO_2EV5 0x0100
147 #define ESCO_3EV5 0x0200
149 #define SCO_ESCO_MASK (ESCO_HV1 | ESCO_HV2 | ESCO_HV3)
150 #define EDR_ESCO_MASK (ESCO_2EV3 | ESCO_3EV3 | ESCO_2EV5 | ESCO_3EV5)
153 #define ACL_CONT 0x01
154 #define ACL_START 0x02
155 #define ACL_ACTIVE_BCAST 0x04
156 #define ACL_PICO_BCAST 0x08
159 #define SCO_LINK 0x00
160 #define ACL_LINK 0x01
161 #define ESCO_LINK 0x02
164 #define LMP_3SLOT 0x01
165 #define LMP_5SLOT 0x02
166 #define LMP_ENCRYPT 0x04
167 #define LMP_SOFFSET 0x08
168 #define LMP_TACCURACY 0x10
169 #define LMP_RSWITCH 0x20
170 #define LMP_HOLD 0x40
171 #define LMP_SNIFF 0x80
173 #define LMP_PARK 0x01
174 #define LMP_RSSI 0x02
175 #define LMP_QUALITY 0x04
179 #define LMP_ULAW 0x40
180 #define LMP_ALAW 0x80
182 #define LMP_CVSD 0x01
183 #define LMP_PSCHEME 0x02
184 #define LMP_PCONTROL 0x04
186 #define LMP_ESCO 0x80
191 #define LMP_SNIFF_SUBR 0x02
192 #define LMP_EDR_ESCO_2M 0x20
193 #define LMP_EDR_ESCO_3M 0x40
194 #define LMP_EDR_3S_ESCO 0x80
196 #define LMP_SIMPLE_PAIR 0x08
198 /* Connection modes */
199 #define HCI_CM_ACTIVE 0x0000
200 #define HCI_CM_HOLD 0x0001
201 #define HCI_CM_SNIFF 0x0002
202 #define HCI_CM_PARK 0x0003
205 #define HCI_LP_RSWITCH 0x0001
206 #define HCI_LP_HOLD 0x0002
207 #define HCI_LP_SNIFF 0x0004
208 #define HCI_LP_PARK 0x0008
211 #define HCI_LM_ACCEPT 0x8000
212 #define HCI_LM_MASTER 0x0001
213 #define HCI_LM_AUTH 0x0002
214 #define HCI_LM_ENCRYPT 0x0004
215 #define HCI_LM_TRUSTED 0x0008
216 #define HCI_LM_RELIABLE 0x0010
217 #define HCI_LM_SECURE 0x0020
219 /* Authentication types */
220 #define HCI_AT_NO_BONDING 0x00
221 #define HCI_AT_NO_BONDING_MITM 0x01
222 #define HCI_AT_DEDICATED_BONDING 0x02
223 #define HCI_AT_DEDICATED_BONDING_MITM 0x03
224 #define HCI_AT_GENERAL_BONDING 0x04
225 #define HCI_AT_GENERAL_BONDING_MITM 0x05
227 /* ----- HCI Commands ---- */
228 #define HCI_OP_INQUIRY 0x0401
229 struct hci_cp_inquiry
{
235 #define HCI_OP_INQUIRY_CANCEL 0x0402
237 #define HCI_OP_EXIT_PERIODIC_INQ 0x0404
239 #define HCI_OP_CREATE_CONN 0x0405
240 struct hci_cp_create_conn
{
249 #define HCI_OP_DISCONNECT 0x0406
250 struct hci_cp_disconnect
{
255 #define HCI_OP_ADD_SCO 0x0407
256 struct hci_cp_add_sco
{
261 #define HCI_OP_CREATE_CONN_CANCEL 0x0408
262 struct hci_cp_create_conn_cancel
{
266 #define HCI_OP_ACCEPT_CONN_REQ 0x0409
267 struct hci_cp_accept_conn_req
{
272 #define HCI_OP_REJECT_CONN_REQ 0x040a
273 struct hci_cp_reject_conn_req
{
278 #define HCI_OP_LINK_KEY_REPLY 0x040b
279 struct hci_cp_link_key_reply
{
284 #define HCI_OP_LINK_KEY_NEG_REPLY 0x040c
285 struct hci_cp_link_key_neg_reply
{
289 #define HCI_OP_PIN_CODE_REPLY 0x040d
290 struct hci_cp_pin_code_reply
{
296 #define HCI_OP_PIN_CODE_NEG_REPLY 0x040e
297 struct hci_cp_pin_code_neg_reply
{
301 #define HCI_OP_CHANGE_CONN_PTYPE 0x040f
302 struct hci_cp_change_conn_ptype
{
307 #define HCI_OP_AUTH_REQUESTED 0x0411
308 struct hci_cp_auth_requested
{
312 #define HCI_OP_SET_CONN_ENCRYPT 0x0413
313 struct hci_cp_set_conn_encrypt
{
318 #define HCI_OP_CHANGE_CONN_LINK_KEY 0x0415
319 struct hci_cp_change_conn_link_key
{
323 #define HCI_OP_REMOTE_NAME_REQ 0x0419
324 struct hci_cp_remote_name_req
{
331 #define HCI_OP_REMOTE_NAME_REQ_CANCEL 0x041a
332 struct hci_cp_remote_name_req_cancel
{
336 #define HCI_OP_READ_REMOTE_FEATURES 0x041b
337 struct hci_cp_read_remote_features
{
341 #define HCI_OP_READ_REMOTE_EXT_FEATURES 0x041c
342 struct hci_cp_read_remote_ext_features
{
347 #define HCI_OP_READ_REMOTE_VERSION 0x041d
348 struct hci_cp_read_remote_version
{
352 #define HCI_OP_SETUP_SYNC_CONN 0x0428
353 struct hci_cp_setup_sync_conn
{
358 __le16 voice_setting
;
363 #define HCI_OP_ACCEPT_SYNC_CONN_REQ 0x0429
364 struct hci_cp_accept_sync_conn_req
{
369 __le16 content_format
;
374 #define HCI_OP_REJECT_SYNC_CONN_REQ 0x042a
375 struct hci_cp_reject_sync_conn_req
{
380 #define HCI_OP_SNIFF_MODE 0x0803
381 struct hci_cp_sniff_mode
{
389 #define HCI_OP_EXIT_SNIFF_MODE 0x0804
390 struct hci_cp_exit_sniff_mode
{
394 #define HCI_OP_ROLE_DISCOVERY 0x0809
395 struct hci_cp_role_discovery
{
398 struct hci_rp_role_discovery
{
404 #define HCI_OP_SWITCH_ROLE 0x080b
405 struct hci_cp_switch_role
{
410 #define HCI_OP_READ_LINK_POLICY 0x080c
411 struct hci_cp_read_link_policy
{
414 struct hci_rp_read_link_policy
{
420 #define HCI_OP_WRITE_LINK_POLICY 0x080d
421 struct hci_cp_write_link_policy
{
425 struct hci_rp_write_link_policy
{
430 #define HCI_OP_READ_DEF_LINK_POLICY 0x080e
431 struct hci_rp_read_def_link_policy
{
436 #define HCI_OP_WRITE_DEF_LINK_POLICY 0x080f
437 struct hci_cp_write_def_link_policy
{
441 #define HCI_OP_SNIFF_SUBRATE 0x0811
442 struct hci_cp_sniff_subrate
{
445 __le16 min_remote_timeout
;
446 __le16 min_local_timeout
;
449 #define HCI_OP_SET_EVENT_MASK 0x0c01
450 struct hci_cp_set_event_mask
{
454 #define HCI_OP_RESET 0x0c03
456 #define HCI_OP_SET_EVENT_FLT 0x0c05
457 struct hci_cp_set_event_flt
{
464 #define HCI_FLT_CLEAR_ALL 0x00
465 #define HCI_FLT_INQ_RESULT 0x01
466 #define HCI_FLT_CONN_SETUP 0x02
468 /* CONN_SETUP Condition types */
469 #define HCI_CONN_SETUP_ALLOW_ALL 0x00
470 #define HCI_CONN_SETUP_ALLOW_CLASS 0x01
471 #define HCI_CONN_SETUP_ALLOW_BDADDR 0x02
473 /* CONN_SETUP Conditions */
474 #define HCI_CONN_SETUP_AUTO_OFF 0x01
475 #define HCI_CONN_SETUP_AUTO_ON 0x02
477 #define HCI_OP_WRITE_LOCAL_NAME 0x0c13
478 struct hci_cp_write_local_name
{
482 #define HCI_OP_READ_LOCAL_NAME 0x0c14
483 struct hci_rp_read_local_name
{
488 #define HCI_OP_WRITE_CA_TIMEOUT 0x0c16
490 #define HCI_OP_WRITE_PG_TIMEOUT 0x0c18
492 #define HCI_OP_WRITE_SCAN_ENABLE 0x0c1a
493 #define SCAN_DISABLED 0x00
494 #define SCAN_INQUIRY 0x01
495 #define SCAN_PAGE 0x02
497 #define HCI_OP_READ_AUTH_ENABLE 0x0c1f
499 #define HCI_OP_WRITE_AUTH_ENABLE 0x0c20
500 #define AUTH_DISABLED 0x00
501 #define AUTH_ENABLED 0x01
503 #define HCI_OP_READ_ENCRYPT_MODE 0x0c21
505 #define HCI_OP_WRITE_ENCRYPT_MODE 0x0c22
506 #define ENCRYPT_DISABLED 0x00
507 #define ENCRYPT_P2P 0x01
508 #define ENCRYPT_BOTH 0x02
510 #define HCI_OP_READ_CLASS_OF_DEV 0x0c23
511 struct hci_rp_read_class_of_dev
{
516 #define HCI_OP_WRITE_CLASS_OF_DEV 0x0c24
517 struct hci_cp_write_class_of_dev
{
521 #define HCI_OP_READ_VOICE_SETTING 0x0c25
522 struct hci_rp_read_voice_setting
{
524 __le16 voice_setting
;
527 #define HCI_OP_WRITE_VOICE_SETTING 0x0c26
528 struct hci_cp_write_voice_setting
{
529 __le16 voice_setting
;
532 #define HCI_OP_HOST_BUFFER_SIZE 0x0c33
533 struct hci_cp_host_buffer_size
{
540 #define HCI_OP_READ_SSP_MODE 0x0c55
541 struct hci_rp_read_ssp_mode
{
546 #define HCI_OP_WRITE_SSP_MODE 0x0c56
547 struct hci_cp_write_ssp_mode
{
551 #define HCI_OP_READ_LOCAL_VERSION 0x1001
552 struct hci_rp_read_local_version
{
561 #define HCI_OP_READ_LOCAL_COMMANDS 0x1002
562 struct hci_rp_read_local_commands
{
567 #define HCI_OP_READ_LOCAL_FEATURES 0x1003
568 struct hci_rp_read_local_features
{
573 #define HCI_OP_READ_LOCAL_EXT_FEATURES 0x1004
574 struct hci_rp_read_local_ext_features
{
581 #define HCI_OP_READ_BUFFER_SIZE 0x1005
582 struct hci_rp_read_buffer_size
{
590 #define HCI_OP_READ_BD_ADDR 0x1009
591 struct hci_rp_read_bd_addr
{
596 /* ---- HCI Events ---- */
597 #define HCI_EV_INQUIRY_COMPLETE 0x01
599 #define HCI_EV_INQUIRY_RESULT 0x02
600 struct inquiry_info
{
603 __u8 pscan_period_mode
;
609 #define HCI_EV_CONN_COMPLETE 0x03
610 struct hci_ev_conn_complete
{
618 #define HCI_EV_CONN_REQUEST 0x04
619 struct hci_ev_conn_request
{
625 #define HCI_EV_DISCONN_COMPLETE 0x05
626 struct hci_ev_disconn_complete
{
632 #define HCI_EV_AUTH_COMPLETE 0x06
633 struct hci_ev_auth_complete
{
638 #define HCI_EV_REMOTE_NAME 0x07
639 struct hci_ev_remote_name
{
645 #define HCI_EV_ENCRYPT_CHANGE 0x08
646 struct hci_ev_encrypt_change
{
652 #define HCI_EV_CHANGE_LINK_KEY_COMPLETE 0x09
653 struct hci_ev_change_link_key_complete
{
658 #define HCI_EV_REMOTE_FEATURES 0x0b
659 struct hci_ev_remote_features
{
665 #define HCI_EV_REMOTE_VERSION 0x0c
666 struct hci_ev_remote_version
{
674 #define HCI_EV_QOS_SETUP_COMPLETE 0x0d
678 __u32 peak_bandwidth
;
680 __u32 delay_variation
;
682 struct hci_ev_qos_setup_complete
{
688 #define HCI_EV_CMD_COMPLETE 0x0e
689 struct hci_ev_cmd_complete
{
694 #define HCI_EV_CMD_STATUS 0x0f
695 struct hci_ev_cmd_status
{
701 #define HCI_EV_ROLE_CHANGE 0x12
702 struct hci_ev_role_change
{
708 #define HCI_EV_NUM_COMP_PKTS 0x13
709 struct hci_ev_num_comp_pkts
{
711 /* variable length part */
714 #define HCI_EV_MODE_CHANGE 0x14
715 struct hci_ev_mode_change
{
722 #define HCI_EV_PIN_CODE_REQ 0x16
723 struct hci_ev_pin_code_req
{
727 #define HCI_EV_LINK_KEY_REQ 0x17
728 struct hci_ev_link_key_req
{
732 #define HCI_EV_LINK_KEY_NOTIFY 0x18
733 struct hci_ev_link_key_notify
{
739 #define HCI_EV_CLOCK_OFFSET 0x1c
740 struct hci_ev_clock_offset
{
746 #define HCI_EV_PKT_TYPE_CHANGE 0x1d
747 struct hci_ev_pkt_type_change
{
753 #define HCI_EV_PSCAN_REP_MODE 0x20
754 struct hci_ev_pscan_rep_mode
{
759 #define HCI_EV_INQUIRY_RESULT_WITH_RSSI 0x22
760 struct inquiry_info_with_rssi
{
763 __u8 pscan_period_mode
;
768 struct inquiry_info_with_rssi_and_pscan_mode
{
771 __u8 pscan_period_mode
;
778 #define HCI_EV_REMOTE_EXT_FEATURES 0x23
779 struct hci_ev_remote_ext_features
{
787 #define HCI_EV_SYNC_CONN_COMPLETE 0x2c
788 struct hci_ev_sync_conn_complete
{
800 #define HCI_EV_SYNC_CONN_CHANGED 0x2d
801 struct hci_ev_sync_conn_changed
{
810 #define HCI_EV_SNIFF_SUBRATE 0x2e
811 struct hci_ev_sniff_subrate
{
814 __le16 max_tx_latency
;
815 __le16 max_rx_latency
;
816 __le16 max_remote_timeout
;
817 __le16 max_local_timeout
;
820 #define HCI_EV_EXTENDED_INQUIRY_RESULT 0x2f
821 struct extended_inquiry_info
{
824 __u8 pscan_period_mode
;
831 #define HCI_EV_IO_CAPA_REQUEST 0x31
832 struct hci_ev_io_capa_request
{
836 #define HCI_EV_SIMPLE_PAIR_COMPLETE 0x36
837 struct hci_ev_simple_pair_complete
{
842 #define HCI_EV_REMOTE_HOST_FEATURES 0x3d
843 struct hci_ev_remote_host_features
{
848 /* Internal events generated by Bluetooth stack */
849 #define HCI_EV_STACK_INTERNAL 0xfd
850 struct hci_ev_stack_internal
{
855 #define HCI_EV_SI_DEVICE 0x01
856 struct hci_ev_si_device
{
861 #define HCI_EV_SI_SECURITY 0x02
862 struct hci_ev_si_security
{
869 /* ---- HCI Packet structures ---- */
870 #define HCI_COMMAND_HDR_SIZE 3
871 #define HCI_EVENT_HDR_SIZE 2
872 #define HCI_ACL_HDR_SIZE 4
873 #define HCI_SCO_HDR_SIZE 3
875 struct hci_command_hdr
{
876 __le16 opcode
; /* OCF & OGF */
880 struct hci_event_hdr
{
886 __le16 handle
; /* Handle & Flags(PB, BC) */
896 #include <linux/skbuff.h>
897 static inline struct hci_event_hdr
*hci_event_hdr(const struct sk_buff
*skb
)
899 return (struct hci_event_hdr
*) skb
->data
;
902 static inline struct hci_acl_hdr
*hci_acl_hdr(const struct sk_buff
*skb
)
904 return (struct hci_acl_hdr
*) skb
->data
;
907 static inline struct hci_sco_hdr
*hci_sco_hdr(const struct sk_buff
*skb
)
909 return (struct hci_sco_hdr
*) skb
->data
;
913 /* Command opcode pack/unpack */
914 #define hci_opcode_pack(ogf, ocf) (__u16) ((ocf & 0x03ff)|(ogf << 10))
915 #define hci_opcode_ogf(op) (op >> 10)
916 #define hci_opcode_ocf(op) (op & 0x03ff)
918 /* ACL handle and flags pack/unpack */
919 #define hci_handle_pack(h, f) (__u16) ((h & 0x0fff)|(f << 12))
920 #define hci_handle(h) (h & 0x0fff)
921 #define hci_flags(h) (h >> 12)
923 /* ---- HCI Sockets ---- */
926 #define HCI_DATA_DIR 1
928 #define HCI_TIME_STAMP 3
931 #define HCI_CMSG_DIR 0x0001
932 #define HCI_CMSG_TSTAMP 0x0002
934 struct sockaddr_hci
{
935 sa_family_t hci_family
;
936 unsigned short hci_dev
;
938 #define HCI_DEV_NONE 0xffff
941 unsigned long type_mask
;
942 unsigned long event_mask
[2];
952 #define HCI_FLT_TYPE_BITS 31
953 #define HCI_FLT_EVENT_BITS 63
954 #define HCI_FLT_OGF_BITS 63
955 #define HCI_FLT_OCF_BITS 127
957 /* ---- HCI Ioctl requests structures ---- */
958 struct hci_dev_stats
{
971 struct hci_dev_info
{
991 struct hci_dev_stats stat
;
994 struct hci_conn_info
{
1003 struct hci_dev_req
{
1008 struct hci_dev_list_req
{
1010 struct hci_dev_req dev_req
[0]; /* hci_dev_req structures */
1013 struct hci_conn_list_req
{
1016 struct hci_conn_info conn_info
[0];
1019 struct hci_conn_info_req
{
1022 struct hci_conn_info conn_info
[0];
1025 struct hci_auth_info_req
{
1030 struct hci_inquiry_req
{
1037 #define IREQ_CACHE_FLUSH 0x0001
1039 #endif /* __HCI_H */