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.
26 * $Id: hci.h,v 1.4 2002/04/18 22:26:15 maxk Exp $
32 #define HCI_MAX_ACL_SIZE 1024
33 #define HCI_MAX_SCO_SIZE 255
34 #define HCI_MAX_EVENT_SIZE 260
35 #define HCI_MAX_FRAME_SIZE (HCI_MAX_ACL_SIZE + 4)
39 #define HCI_DEV_UNREG 2
41 #define HCI_DEV_DOWN 4
42 #define HCI_DEV_SUSPEND 5
43 #define HCI_DEV_RESUME 6
45 /* HCI notify events */
46 #define HCI_NOTIFY_CONN_ADD 1
47 #define HCI_NOTIFY_CONN_DEL 2
48 #define HCI_NOTIFY_VOICE_SETTING 3
50 /* HCI device types */
58 /* HCI device quirks */
60 HCI_QUIRK_RESET_ON_INIT
63 /* HCI device flags */
78 /* HCI ioctl defines */
79 #define HCIDEVUP _IOW('H', 201, int)
80 #define HCIDEVDOWN _IOW('H', 202, int)
81 #define HCIDEVRESET _IOW('H', 203, int)
82 #define HCIDEVRESTAT _IOW('H', 204, int)
84 #define HCIGETDEVLIST _IOR('H', 210, int)
85 #define HCIGETDEVINFO _IOR('H', 211, int)
86 #define HCIGETCONNLIST _IOR('H', 212, int)
87 #define HCIGETCONNINFO _IOR('H', 213, int)
89 #define HCISETRAW _IOW('H', 220, int)
90 #define HCISETSCAN _IOW('H', 221, int)
91 #define HCISETAUTH _IOW('H', 222, int)
92 #define HCISETENCRYPT _IOW('H', 223, int)
93 #define HCISETPTYPE _IOW('H', 224, int)
94 #define HCISETLINKPOL _IOW('H', 225, int)
95 #define HCISETLINKMODE _IOW('H', 226, int)
96 #define HCISETACLMTU _IOW('H', 227, int)
97 #define HCISETSCOMTU _IOW('H', 228, int)
98 #define HCISETRAWVND _IOW('H', 229, 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_UNKNOWN_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
175 /* ----- HCI Commands ---- */
176 /* OGF & OCF values */
178 /* Informational Parameters */
179 #define OGF_INFO_PARAM 0x04
181 #define OCF_READ_LOCAL_VERSION 0x0001
182 struct hci_rp_read_loc_version {
189 } __attribute__ ((packed));
191 #define OCF_READ_LOCAL_FEATURES 0x0003
192 struct hci_rp_read_loc_features {
195 } __attribute__ ((packed));
197 #define OCF_READ_BUFFER_SIZE 0x0005
198 struct hci_rp_read_buffer_size {
204 } __attribute__ ((packed));
206 #define OCF_READ_BD_ADDR 0x0009
207 struct hci_rp_read_bd_addr {
210 } __attribute__ ((packed));
212 /* Host Controller and Baseband */
213 #define OGF_HOST_CTL 0x03
214 #define OCF_RESET 0x0003
215 #define OCF_READ_AUTH_ENABLE 0x001F
216 #define OCF_WRITE_AUTH_ENABLE 0x0020
217 #define AUTH_DISABLED 0x00
218 #define AUTH_ENABLED 0x01
220 #define OCF_READ_ENCRYPT_MODE 0x0021
221 #define OCF_WRITE_ENCRYPT_MODE 0x0022
222 #define ENCRYPT_DISABLED 0x00
223 #define ENCRYPT_P2P 0x01
224 #define ENCRYPT_BOTH 0x02
226 #define OCF_WRITE_CA_TIMEOUT 0x0016
227 #define OCF_WRITE_PG_TIMEOUT 0x0018
229 #define OCF_WRITE_SCAN_ENABLE 0x001A
230 #define SCAN_DISABLED 0x00
231 #define SCAN_INQUIRY 0x01
232 #define SCAN_PAGE 0x02
234 #define OCF_SET_EVENT_FLT 0x0005
235 struct hci_cp_set_event_flt {
239 } __attribute__ ((packed));
242 #define HCI_FLT_CLEAR_ALL 0x00
243 #define HCI_FLT_INQ_RESULT 0x01
244 #define HCI_FLT_CONN_SETUP 0x02
246 /* CONN_SETUP Condition types */
247 #define HCI_CONN_SETUP_ALLOW_ALL 0x00
248 #define HCI_CONN_SETUP_ALLOW_CLASS 0x01
249 #define HCI_CONN_SETUP_ALLOW_BDADDR 0x02
251 /* CONN_SETUP Conditions */
252 #define HCI_CONN_SETUP_AUTO_OFF 0x01
253 #define HCI_CONN_SETUP_AUTO_ON 0x02
255 #define OCF_READ_CLASS_OF_DEV 0x0023
256 struct hci_rp_read_dev_class {
259 } __attribute__ ((packed));
261 #define OCF_WRITE_CLASS_OF_DEV 0x0024
262 struct hci_cp_write_dev_class {
264 } __attribute__ ((packed));
266 #define OCF_READ_VOICE_SETTING 0x0025
267 struct hci_rp_read_voice_setting {
270 } __attribute__ ((packed));
272 #define OCF_WRITE_VOICE_SETTING 0x0026
273 struct hci_cp_write_voice_setting {
275 } __attribute__ ((packed));
277 #define OCF_HOST_BUFFER_SIZE 0x0033
278 struct hci_cp_host_buffer_size {
283 } __attribute__ ((packed));
286 #define OGF_LINK_CTL 0x01
287 #define OCF_CREATE_CONN 0x0005
288 struct hci_cp_create_conn {
295 } __attribute__ ((packed));
297 #define OCF_ACCEPT_CONN_REQ 0x0009
298 struct hci_cp_accept_conn_req {
301 } __attribute__ ((packed));
303 #define OCF_REJECT_CONN_REQ 0x000a
304 struct hci_cp_reject_conn_req {
307 } __attribute__ ((packed));
309 #define OCF_DISCONNECT 0x0006
310 struct hci_cp_disconnect {
313 } __attribute__ ((packed));
315 #define OCF_ADD_SCO 0x0007
316 struct hci_cp_add_sco {
319 } __attribute__ ((packed));
321 #define OCF_INQUIRY 0x0001
322 struct hci_cp_inquiry {
326 } __attribute__ ((packed));
328 #define OCF_INQUIRY_CANCEL 0x0002
330 #define OCF_LINK_KEY_REPLY 0x000B
331 #define OCF_LINK_KEY_NEG_REPLY 0x000C
332 struct hci_cp_link_key_reply {
335 } __attribute__ ((packed));
337 #define OCF_PIN_CODE_REPLY 0x000D
338 #define OCF_PIN_CODE_NEG_REPLY 0x000E
339 struct hci_cp_pin_code_reply {
343 } __attribute__ ((packed));
345 #define OCF_CHANGE_CONN_PTYPE 0x000F
346 struct hci_cp_change_conn_ptype {
349 } __attribute__ ((packed));
351 #define OCF_AUTH_REQUESTED 0x0011
352 struct hci_cp_auth_requested {
354 } __attribute__ ((packed));
356 #define OCF_SET_CONN_ENCRYPT 0x0013
357 struct hci_cp_set_conn_encrypt {
360 } __attribute__ ((packed));
362 #define OCF_READ_REMOTE_FEATURES 0x001B
363 struct hci_cp_read_rmt_features {
365 } __attribute__ ((packed));
367 #define OCF_READ_REMOTE_VERSION 0x001D
368 struct hci_cp_read_rmt_version {
370 } __attribute__ ((packed));
373 #define OGF_LINK_POLICY 0x02
374 #define OCF_ROLE_DISCOVERY 0x0009
375 struct hci_cp_role_discovery {
377 } __attribute__ ((packed));
378 struct hci_rp_role_discovery {
382 } __attribute__ ((packed));
384 #define OCF_READ_LINK_POLICY 0x000C
385 struct hci_cp_read_link_policy {
387 } __attribute__ ((packed));
388 struct hci_rp_read_link_policy {
392 } __attribute__ ((packed));
394 #define OCF_SWITCH_ROLE 0x000B
395 struct hci_cp_switch_role {
398 } __attribute__ ((packed));
400 #define OCF_WRITE_LINK_POLICY 0x000D
401 struct hci_cp_write_link_policy {
404 } __attribute__ ((packed));
405 struct hci_rp_write_link_policy {
408 } __attribute__ ((packed));
411 #define OGF_STATUS_PARAM 0x05
413 /* Testing commands */
414 #define OGF_TESTING_CMD 0x3E
416 /* Vendor specific commands */
417 #define OGF_VENDOR_CMD 0x3F
419 /* ---- HCI Events ---- */
420 #define HCI_EV_INQUIRY_COMPLETE 0x01
422 #define HCI_EV_INQUIRY_RESULT 0x02
423 struct inquiry_info {
426 __u8 pscan_period_mode;
430 } __attribute__ ((packed));
432 #define HCI_EV_INQUIRY_RESULT_WITH_RSSI 0x22
433 struct inquiry_info_with_rssi {
436 __u8 pscan_period_mode;
440 } __attribute__ ((packed));
442 #define HCI_EV_CONN_COMPLETE 0x03
443 struct hci_ev_conn_complete {
449 } __attribute__ ((packed));
451 #define HCI_EV_CONN_REQUEST 0x04
452 struct hci_ev_conn_request {
456 } __attribute__ ((packed));
458 #define HCI_EV_DISCONN_COMPLETE 0x05
459 struct hci_ev_disconn_complete {
463 } __attribute__ ((packed));
465 #define HCI_EV_AUTH_COMPLETE 0x06
466 struct hci_ev_auth_complete {
469 } __attribute__ ((packed));
471 #define HCI_EV_ENCRYPT_CHANGE 0x08
472 struct hci_ev_encrypt_change {
476 } __attribute__ ((packed));
478 #define HCI_EV_QOS_SETUP_COMPLETE 0x0D
482 __u32 peak_bandwidth;
484 __u32 delay_variation;
485 } __attribute__ ((packed));
486 struct hci_ev_qos_setup_complete {
490 } __attribute__ ((packed));
492 #define HCI_EV_CMD_COMPLETE 0x0E
493 struct hci_ev_cmd_complete {
496 } __attribute__ ((packed));
498 #define HCI_EV_CMD_STATUS 0x0F
499 struct hci_ev_cmd_status {
503 } __attribute__ ((packed));
505 #define HCI_EV_NUM_COMP_PKTS 0x13
506 struct hci_ev_num_comp_pkts {
508 /* variable length part */
509 } __attribute__ ((packed));
511 #define HCI_EV_ROLE_CHANGE 0x12
512 struct hci_ev_role_change {
516 } __attribute__ ((packed));
518 #define HCI_EV_PIN_CODE_REQ 0x16
519 struct hci_ev_pin_code_req {
521 } __attribute__ ((packed));
523 #define HCI_EV_LINK_KEY_REQ 0x17
524 struct hci_ev_link_key_req {
526 } __attribute__ ((packed));
528 #define HCI_EV_LINK_KEY_NOTIFY 0x18
529 struct hci_ev_link_key_notify {
533 } __attribute__ ((packed));
535 #define HCI_EV_RMT_FEATURES 0x0B
536 struct hci_ev_rmt_features {
540 } __attribute__ ((packed));
542 #define HCI_EV_RMT_VERSION 0x0C
543 struct hci_ev_rmt_version {
549 } __attribute__ ((packed));
551 /* Internal events generated by Bluetooth stack */
552 #define HCI_EV_STACK_INTERNAL 0xFD
553 struct hci_ev_stack_internal {
556 } __attribute__ ((packed));
558 #define HCI_EV_SI_DEVICE 0x01
559 struct hci_ev_si_device {
562 } __attribute__ ((packed));
564 #define HCI_EV_SI_SECURITY 0x02
565 struct hci_ev_si_security {
570 } __attribute__ ((packed));
572 /* ---- HCI Packet structures ---- */
573 #define HCI_COMMAND_HDR_SIZE 3
574 #define HCI_EVENT_HDR_SIZE 2
575 #define HCI_ACL_HDR_SIZE 4
576 #define HCI_SCO_HDR_SIZE 3
578 struct hci_command_hdr {
579 __u16 opcode; /* OCF & OGF */
581 } __attribute__ ((packed));
583 struct hci_event_hdr {
586 } __attribute__ ((packed));
589 __u16 handle; /* Handle & Flags(PB, BC) */
591 } __attribute__ ((packed));
596 } __attribute__ ((packed));
598 /* Command opcode pack/unpack */
599 #define hci_opcode_pack(ogf, ocf) (__u16)((ocf & 0x03ff)|(ogf << 10))
600 #define hci_opcode_ogf(op) (op >> 10)
601 #define hci_opcode_ocf(op) (op & 0x03ff)
603 /* ACL handle and flags pack/unpack */
604 #define hci_handle_pack(h, f) (__u16)((h & 0x0fff)|(f << 12))
605 #define hci_handle(h) (h & 0x0fff)
606 #define hci_flags(h) (h >> 12)
608 /* ---- HCI Sockets ---- */
611 #define HCI_DATA_DIR 1
613 #define HCI_TIME_STAMP 3
616 #define HCI_CMSG_DIR 0x0001
617 #define HCI_CMSG_TSTAMP 0x0002
619 struct sockaddr_hci {
620 sa_family_t hci_family;
621 unsigned short hci_dev;
623 #define HCI_DEV_NONE 0xffff
626 unsigned long type_mask;
627 unsigned long event_mask[2];
637 #define HCI_FLT_TYPE_BITS 31
638 #define HCI_FLT_EVENT_BITS 63
639 #define HCI_FLT_OGF_BITS 63
640 #define HCI_FLT_OCF_BITS 127
642 /* ---- HCI Ioctl requests structures ---- */
643 struct hci_dev_stats {
656 struct hci_dev_info {
676 struct hci_dev_stats stat;
679 struct hci_conn_info {
693 struct hci_dev_list_req {
695 struct hci_dev_req dev_req[0]; /* hci_dev_req structures */
698 struct hci_conn_list_req {
701 struct hci_conn_info conn_info[0];
704 struct hci_conn_info_req {
707 struct hci_conn_info conn_info[0];
710 struct hci_inquiry_req {
717 #define IREQ_CACHE_FLUSH 0x0001