drm/nouveau: fix kernel-doc comments
[drm/drm-misc.git] / include / net / bluetooth / hci_core.h
blobea798f07c5a2d6e90c2dc2581922edeee2de4113
1 /*
2 BlueZ - Bluetooth protocol stack for Linux
3 Copyright (c) 2000-2001, 2010, Code Aurora Forum. All rights reserved.
4 Copyright 2023-2024 NXP
6 Written 2000,2001 by Maxim Krasnyansky <maxk@qualcomm.com>
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License version 2 as
10 published by the Free Software Foundation;
12 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
13 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
14 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS.
15 IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) AND AUTHOR(S) BE LIABLE FOR ANY
16 CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES
17 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
18 ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
19 OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
21 ALL LIABILITY, INCLUDING LIABILITY FOR INFRINGEMENT OF ANY PATENTS,
22 COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS, RELATING TO USE OF THIS
23 SOFTWARE IS DISCLAIMED.
26 #ifndef __HCI_CORE_H
27 #define __HCI_CORE_H
29 #include <linux/idr.h>
30 #include <linux/leds.h>
31 #include <linux/rculist.h>
33 #include <net/bluetooth/hci.h>
34 #include <net/bluetooth/hci_sync.h>
35 #include <net/bluetooth/hci_sock.h>
36 #include <net/bluetooth/coredump.h>
38 /* HCI priority */
39 #define HCI_PRIO_MAX 7
41 /* HCI maximum id value */
42 #define HCI_MAX_ID 10000
44 /* HCI Core structures */
45 struct inquiry_data {
46 bdaddr_t bdaddr;
47 __u8 pscan_rep_mode;
48 __u8 pscan_period_mode;
49 __u8 pscan_mode;
50 __u8 dev_class[3];
51 __le16 clock_offset;
52 __s8 rssi;
53 __u8 ssp_mode;
56 struct inquiry_entry {
57 struct list_head all; /* inq_cache.all */
58 struct list_head list; /* unknown or resolve */
59 enum {
60 NAME_NOT_KNOWN,
61 NAME_NEEDED,
62 NAME_PENDING,
63 NAME_KNOWN,
64 } name_state;
65 __u32 timestamp;
66 struct inquiry_data data;
69 struct discovery_state {
70 int type;
71 enum {
72 DISCOVERY_STOPPED,
73 DISCOVERY_STARTING,
74 DISCOVERY_FINDING,
75 DISCOVERY_RESOLVING,
76 DISCOVERY_STOPPING,
77 } state;
78 struct list_head all; /* All devices found during inquiry */
79 struct list_head unknown; /* Name state not known */
80 struct list_head resolve; /* Name needs to be resolved */
81 __u32 timestamp;
82 bdaddr_t last_adv_addr;
83 u8 last_adv_addr_type;
84 s8 last_adv_rssi;
85 u32 last_adv_flags;
86 u8 last_adv_data[HCI_MAX_EXT_AD_LENGTH];
87 u8 last_adv_data_len;
88 bool report_invalid_rssi;
89 bool result_filtering;
90 bool limited;
91 s8 rssi;
92 u16 uuid_count;
93 u8 (*uuids)[16];
94 unsigned long name_resolve_timeout;
97 #define SUSPEND_NOTIFIER_TIMEOUT msecs_to_jiffies(2000) /* 2 seconds */
99 enum suspend_tasks {
100 SUSPEND_PAUSE_DISCOVERY,
101 SUSPEND_UNPAUSE_DISCOVERY,
103 SUSPEND_PAUSE_ADVERTISING,
104 SUSPEND_UNPAUSE_ADVERTISING,
106 SUSPEND_SCAN_DISABLE,
107 SUSPEND_SCAN_ENABLE,
108 SUSPEND_DISCONNECTING,
110 SUSPEND_POWERING_DOWN,
112 SUSPEND_PREPARE_NOTIFIER,
114 SUSPEND_SET_ADV_FILTER,
115 __SUSPEND_NUM_TASKS
118 enum suspended_state {
119 BT_RUNNING = 0,
120 BT_SUSPEND_DISCONNECT,
121 BT_SUSPEND_CONFIGURE_WAKE,
124 struct hci_conn_hash {
125 struct list_head list;
126 unsigned int acl_num;
127 unsigned int sco_num;
128 unsigned int iso_num;
129 unsigned int le_num;
130 unsigned int le_num_peripheral;
133 struct bdaddr_list {
134 struct list_head list;
135 bdaddr_t bdaddr;
136 u8 bdaddr_type;
139 struct codec_list {
140 struct list_head list;
141 u8 id;
142 __u16 cid;
143 __u16 vid;
144 u8 transport;
145 u8 num_caps;
146 u32 len;
147 struct hci_codec_caps caps[];
150 struct bdaddr_list_with_irk {
151 struct list_head list;
152 bdaddr_t bdaddr;
153 u8 bdaddr_type;
154 u8 peer_irk[16];
155 u8 local_irk[16];
158 /* Bitmask of connection flags */
159 enum hci_conn_flags {
160 HCI_CONN_FLAG_REMOTE_WAKEUP = 1,
161 HCI_CONN_FLAG_DEVICE_PRIVACY = 2,
163 typedef u8 hci_conn_flags_t;
165 struct bdaddr_list_with_flags {
166 struct list_head list;
167 bdaddr_t bdaddr;
168 u8 bdaddr_type;
169 hci_conn_flags_t flags;
172 struct bt_uuid {
173 struct list_head list;
174 u8 uuid[16];
175 u8 size;
176 u8 svc_hint;
179 struct blocked_key {
180 struct list_head list;
181 struct rcu_head rcu;
182 u8 type;
183 u8 val[16];
186 struct smp_csrk {
187 bdaddr_t bdaddr;
188 u8 bdaddr_type;
189 u8 type;
190 u8 val[16];
193 struct smp_ltk {
194 struct list_head list;
195 struct rcu_head rcu;
196 bdaddr_t bdaddr;
197 u8 bdaddr_type;
198 u8 authenticated;
199 u8 type;
200 u8 enc_size;
201 __le16 ediv;
202 __le64 rand;
203 u8 val[16];
206 struct smp_irk {
207 struct list_head list;
208 struct rcu_head rcu;
209 bdaddr_t rpa;
210 bdaddr_t bdaddr;
211 u8 addr_type;
212 u8 val[16];
215 struct link_key {
216 struct list_head list;
217 struct rcu_head rcu;
218 bdaddr_t bdaddr;
219 u8 type;
220 u8 val[HCI_LINK_KEY_SIZE];
221 u8 pin_len;
224 struct oob_data {
225 struct list_head list;
226 bdaddr_t bdaddr;
227 u8 bdaddr_type;
228 u8 present;
229 u8 hash192[16];
230 u8 rand192[16];
231 u8 hash256[16];
232 u8 rand256[16];
235 struct adv_info {
236 struct list_head list;
237 bool enabled;
238 bool pending;
239 bool periodic;
240 __u8 mesh;
241 __u8 instance;
242 __u8 handle;
243 __u32 flags;
244 __u16 timeout;
245 __u16 remaining_time;
246 __u16 duration;
247 __u16 adv_data_len;
248 __u8 adv_data[HCI_MAX_EXT_AD_LENGTH];
249 bool adv_data_changed;
250 __u16 scan_rsp_len;
251 __u8 scan_rsp_data[HCI_MAX_EXT_AD_LENGTH];
252 bool scan_rsp_changed;
253 __u16 per_adv_data_len;
254 __u8 per_adv_data[HCI_MAX_PER_AD_LENGTH];
255 __s8 tx_power;
256 __u32 min_interval;
257 __u32 max_interval;
258 bdaddr_t random_addr;
259 bool rpa_expired;
260 struct delayed_work rpa_expired_cb;
263 #define HCI_MAX_ADV_INSTANCES 5
264 #define HCI_DEFAULT_ADV_DURATION 2
266 #define HCI_ADV_TX_POWER_NO_PREFERENCE 0x7F
268 #define DATA_CMP(_d1, _l1, _d2, _l2) \
269 (_l1 == _l2 ? memcmp(_d1, _d2, _l1) : _l1 - _l2)
271 #define ADV_DATA_CMP(_adv, _data, _len) \
272 DATA_CMP((_adv)->adv_data, (_adv)->adv_data_len, _data, _len)
274 #define SCAN_RSP_CMP(_adv, _data, _len) \
275 DATA_CMP((_adv)->scan_rsp_data, (_adv)->scan_rsp_len, _data, _len)
277 struct monitored_device {
278 struct list_head list;
280 bdaddr_t bdaddr;
281 __u8 addr_type;
282 __u16 handle;
283 bool notified;
286 struct adv_pattern {
287 struct list_head list;
288 __u8 ad_type;
289 __u8 offset;
290 __u8 length;
291 __u8 value[HCI_MAX_EXT_AD_LENGTH];
294 struct adv_rssi_thresholds {
295 __s8 low_threshold;
296 __s8 high_threshold;
297 __u16 low_threshold_timeout;
298 __u16 high_threshold_timeout;
299 __u8 sampling_period;
302 struct adv_monitor {
303 struct list_head patterns;
304 struct adv_rssi_thresholds rssi;
305 __u16 handle;
307 enum {
308 ADV_MONITOR_STATE_NOT_REGISTERED,
309 ADV_MONITOR_STATE_REGISTERED,
310 ADV_MONITOR_STATE_OFFLOADED
311 } state;
314 #define HCI_MIN_ADV_MONITOR_HANDLE 1
315 #define HCI_MAX_ADV_MONITOR_NUM_HANDLES 32
316 #define HCI_MAX_ADV_MONITOR_NUM_PATTERNS 16
317 #define HCI_ADV_MONITOR_EXT_NONE 1
318 #define HCI_ADV_MONITOR_EXT_MSFT 2
320 #define HCI_MAX_SHORT_NAME_LENGTH 10
322 #define HCI_CONN_HANDLE_MAX 0x0eff
323 #define HCI_CONN_HANDLE_UNSET(_handle) (_handle > HCI_CONN_HANDLE_MAX)
325 /* Min encryption key size to match with SMP */
326 #define HCI_MIN_ENC_KEY_SIZE 7
328 /* Default LE RPA expiry time, 15 minutes */
329 #define HCI_DEFAULT_RPA_TIMEOUT (15 * 60)
331 /* Default min/max age of connection information (1s/3s) */
332 #define DEFAULT_CONN_INFO_MIN_AGE 1000
333 #define DEFAULT_CONN_INFO_MAX_AGE 3000
334 /* Default authenticated payload timeout 30s */
335 #define DEFAULT_AUTH_PAYLOAD_TIMEOUT 0x0bb8
337 #define HCI_MAX_PAGES 3
339 struct hci_dev {
340 struct list_head list;
341 struct mutex lock;
343 struct ida unset_handle_ida;
345 const char *name;
346 unsigned long flags;
347 __u16 id;
348 __u8 bus;
349 bdaddr_t bdaddr;
350 bdaddr_t setup_addr;
351 bdaddr_t public_addr;
352 bdaddr_t random_addr;
353 bdaddr_t static_addr;
354 __u8 adv_addr_type;
355 __u8 dev_name[HCI_MAX_NAME_LENGTH];
356 __u8 short_name[HCI_MAX_SHORT_NAME_LENGTH];
357 __u8 eir[HCI_MAX_EIR_LENGTH];
358 __u16 appearance;
359 __u8 dev_class[3];
360 __u8 major_class;
361 __u8 minor_class;
362 __u8 max_page;
363 __u8 features[HCI_MAX_PAGES][8];
364 __u8 le_features[8];
365 __u8 le_accept_list_size;
366 __u8 le_resolv_list_size;
367 __u8 le_num_of_adv_sets;
368 __u8 le_states[8];
369 __u8 mesh_ad_types[16];
370 __u8 mesh_send_ref;
371 __u8 commands[64];
372 __u8 hci_ver;
373 __u16 hci_rev;
374 __u8 lmp_ver;
375 __u16 manufacturer;
376 __u16 lmp_subver;
377 __u16 voice_setting;
378 __u8 num_iac;
379 __u16 stored_max_keys;
380 __u16 stored_num_keys;
381 __u8 io_capability;
382 __s8 inq_tx_power;
383 __u8 err_data_reporting;
384 __u16 page_scan_interval;
385 __u16 page_scan_window;
386 __u8 page_scan_type;
387 __u8 le_adv_channel_map;
388 __u16 le_adv_min_interval;
389 __u16 le_adv_max_interval;
390 __u8 le_scan_type;
391 __u16 le_scan_interval;
392 __u16 le_scan_window;
393 __u16 le_scan_int_suspend;
394 __u16 le_scan_window_suspend;
395 __u16 le_scan_int_discovery;
396 __u16 le_scan_window_discovery;
397 __u16 le_scan_int_adv_monitor;
398 __u16 le_scan_window_adv_monitor;
399 __u16 le_scan_int_connect;
400 __u16 le_scan_window_connect;
401 __u16 le_conn_min_interval;
402 __u16 le_conn_max_interval;
403 __u16 le_conn_latency;
404 __u16 le_supv_timeout;
405 __u16 le_def_tx_len;
406 __u16 le_def_tx_time;
407 __u16 le_max_tx_len;
408 __u16 le_max_tx_time;
409 __u16 le_max_rx_len;
410 __u16 le_max_rx_time;
411 __u8 le_max_key_size;
412 __u8 le_min_key_size;
413 __u16 discov_interleaved_timeout;
414 __u16 conn_info_min_age;
415 __u16 conn_info_max_age;
416 __u16 auth_payload_timeout;
417 __u8 min_enc_key_size;
418 __u8 max_enc_key_size;
419 __u8 pairing_opts;
420 __u8 ssp_debug_mode;
421 __u8 hw_error_code;
422 __u32 clock;
423 __u16 advmon_allowlist_duration;
424 __u16 advmon_no_filter_duration;
425 __u8 enable_advmon_interleave_scan;
427 __u16 devid_source;
428 __u16 devid_vendor;
429 __u16 devid_product;
430 __u16 devid_version;
432 __u8 def_page_scan_type;
433 __u16 def_page_scan_int;
434 __u16 def_page_scan_window;
435 __u8 def_inq_scan_type;
436 __u16 def_inq_scan_int;
437 __u16 def_inq_scan_window;
438 __u16 def_br_lsto;
439 __u16 def_page_timeout;
440 __u16 def_multi_adv_rotation_duration;
441 __u16 def_le_autoconnect_timeout;
442 __s8 min_le_tx_power;
443 __s8 max_le_tx_power;
445 __u16 pkt_type;
446 __u16 esco_type;
447 __u16 link_policy;
448 __u16 link_mode;
450 __u32 idle_timeout;
451 __u16 sniff_min_interval;
452 __u16 sniff_max_interval;
454 unsigned int auto_accept_delay;
456 unsigned long quirks;
458 atomic_t cmd_cnt;
459 unsigned int acl_cnt;
460 unsigned int sco_cnt;
461 unsigned int le_cnt;
462 unsigned int iso_cnt;
464 unsigned int acl_mtu;
465 unsigned int sco_mtu;
466 unsigned int le_mtu;
467 unsigned int iso_mtu;
468 unsigned int acl_pkts;
469 unsigned int sco_pkts;
470 unsigned int le_pkts;
471 unsigned int iso_pkts;
473 unsigned long acl_last_tx;
474 unsigned long le_last_tx;
476 __u8 le_tx_def_phys;
477 __u8 le_rx_def_phys;
479 struct workqueue_struct *workqueue;
480 struct workqueue_struct *req_workqueue;
482 struct work_struct power_on;
483 struct delayed_work power_off;
484 struct work_struct error_reset;
485 struct work_struct cmd_sync_work;
486 struct list_head cmd_sync_work_list;
487 struct mutex cmd_sync_work_lock;
488 struct mutex unregister_lock;
489 struct work_struct cmd_sync_cancel_work;
490 struct work_struct reenable_adv_work;
492 __u16 discov_timeout;
493 struct delayed_work discov_off;
495 struct delayed_work service_cache;
497 struct delayed_work cmd_timer;
498 struct delayed_work ncmd_timer;
500 struct work_struct rx_work;
501 struct work_struct cmd_work;
502 struct work_struct tx_work;
504 struct delayed_work le_scan_disable;
506 struct sk_buff_head rx_q;
507 struct sk_buff_head raw_q;
508 struct sk_buff_head cmd_q;
510 struct sk_buff *sent_cmd;
511 struct sk_buff *recv_event;
513 struct mutex req_lock;
514 wait_queue_head_t req_wait_q;
515 __u32 req_status;
516 __u32 req_result;
517 struct sk_buff *req_skb;
518 struct sk_buff *req_rsp;
520 void *smp_data;
521 void *smp_bredr_data;
523 struct discovery_state discovery;
525 bool discovery_paused;
526 int advertising_old_state;
527 bool advertising_paused;
529 struct notifier_block suspend_notifier;
530 enum suspended_state suspend_state_next;
531 enum suspended_state suspend_state;
532 bool scanning_paused;
533 bool suspended;
534 u8 wake_reason;
535 bdaddr_t wake_addr;
536 u8 wake_addr_type;
538 struct hci_conn_hash conn_hash;
540 struct list_head mesh_pending;
541 struct list_head mgmt_pending;
542 struct list_head reject_list;
543 struct list_head accept_list;
544 struct list_head uuids;
545 struct list_head link_keys;
546 struct list_head long_term_keys;
547 struct list_head identity_resolving_keys;
548 struct list_head remote_oob_data;
549 struct list_head le_accept_list;
550 struct list_head le_resolv_list;
551 struct list_head le_conn_params;
552 struct list_head pend_le_conns;
553 struct list_head pend_le_reports;
554 struct list_head blocked_keys;
555 struct list_head local_codecs;
557 struct hci_dev_stats stat;
559 atomic_t promisc;
561 const char *hw_info;
562 const char *fw_info;
563 struct dentry *debugfs;
565 struct hci_devcoredump dump;
567 struct device dev;
569 struct rfkill *rfkill;
571 DECLARE_BITMAP(dev_flags, __HCI_NUM_FLAGS);
572 hci_conn_flags_t conn_flags;
574 __s8 adv_tx_power;
575 __u8 adv_data[HCI_MAX_EXT_AD_LENGTH];
576 __u8 adv_data_len;
577 __u8 scan_rsp_data[HCI_MAX_EXT_AD_LENGTH];
578 __u8 scan_rsp_data_len;
579 __u8 per_adv_data[HCI_MAX_PER_AD_LENGTH];
580 __u8 per_adv_data_len;
582 struct list_head adv_instances;
583 unsigned int adv_instance_cnt;
584 __u8 cur_adv_instance;
585 __u16 adv_instance_timeout;
586 struct delayed_work adv_instance_expire;
588 struct idr adv_monitors_idr;
589 unsigned int adv_monitors_cnt;
591 __u8 irk[16];
592 __u32 rpa_timeout;
593 struct delayed_work rpa_expired;
594 bdaddr_t rpa;
596 struct delayed_work mesh_send_done;
598 enum {
599 INTERLEAVE_SCAN_NONE,
600 INTERLEAVE_SCAN_NO_FILTER,
601 INTERLEAVE_SCAN_ALLOWLIST
602 } interleave_scan_state;
604 struct delayed_work interleave_scan;
606 struct list_head monitored_devices;
607 bool advmon_pend_notify;
609 #if IS_ENABLED(CONFIG_BT_LEDS)
610 struct led_trigger *power_led;
611 #endif
613 #if IS_ENABLED(CONFIG_BT_MSFTEXT)
614 __u16 msft_opcode;
615 void *msft_data;
616 bool msft_curve_validity;
617 #endif
619 #if IS_ENABLED(CONFIG_BT_AOSPEXT)
620 bool aosp_capable;
621 bool aosp_quality_report;
622 #endif
624 int (*open)(struct hci_dev *hdev);
625 int (*close)(struct hci_dev *hdev);
626 int (*flush)(struct hci_dev *hdev);
627 int (*setup)(struct hci_dev *hdev);
628 int (*shutdown)(struct hci_dev *hdev);
629 int (*send)(struct hci_dev *hdev, struct sk_buff *skb);
630 void (*notify)(struct hci_dev *hdev, unsigned int evt);
631 void (*hw_error)(struct hci_dev *hdev, u8 code);
632 int (*post_init)(struct hci_dev *hdev);
633 int (*set_diag)(struct hci_dev *hdev, bool enable);
634 int (*set_bdaddr)(struct hci_dev *hdev, const bdaddr_t *bdaddr);
635 void (*cmd_timeout)(struct hci_dev *hdev);
636 void (*reset)(struct hci_dev *hdev);
637 bool (*wakeup)(struct hci_dev *hdev);
638 int (*set_quality_report)(struct hci_dev *hdev, bool enable);
639 int (*get_data_path_id)(struct hci_dev *hdev, __u8 *data_path);
640 int (*get_codec_config_data)(struct hci_dev *hdev, __u8 type,
641 struct bt_codec *codec, __u8 *vnd_len,
642 __u8 **vnd_data);
643 u8 (*classify_pkt_type)(struct hci_dev *hdev, struct sk_buff *skb);
646 #define HCI_PHY_HANDLE(handle) (handle & 0xff)
648 enum conn_reasons {
649 CONN_REASON_PAIR_DEVICE,
650 CONN_REASON_L2CAP_CHAN,
651 CONN_REASON_SCO_CONNECT,
652 CONN_REASON_ISO_CONNECT,
655 struct hci_conn {
656 struct list_head list;
658 atomic_t refcnt;
660 bdaddr_t dst;
661 __u8 dst_type;
662 bdaddr_t src;
663 __u8 src_type;
664 bdaddr_t init_addr;
665 __u8 init_addr_type;
666 bdaddr_t resp_addr;
667 __u8 resp_addr_type;
668 __u8 adv_instance;
669 __u16 handle;
670 __u16 sync_handle;
671 __u8 sid;
672 __u16 state;
673 __u16 mtu;
674 __u8 mode;
675 __u8 type;
676 __u8 role;
677 bool out;
678 __u8 attempt;
679 __u8 dev_class[3];
680 __u8 features[HCI_MAX_PAGES][8];
681 __u16 pkt_type;
682 __u16 link_policy;
683 __u8 key_type;
684 __u8 auth_type;
685 __u8 sec_level;
686 __u8 pending_sec_level;
687 __u8 pin_length;
688 __u8 enc_key_size;
689 __u8 io_capability;
690 __u32 passkey_notify;
691 __u8 passkey_entered;
692 __u16 disc_timeout;
693 __u16 conn_timeout;
694 __u16 setting;
695 __u16 auth_payload_timeout;
696 __u16 le_conn_min_interval;
697 __u16 le_conn_max_interval;
698 __u16 le_conn_interval;
699 __u16 le_conn_latency;
700 __u16 le_supv_timeout;
701 __u8 le_adv_data[HCI_MAX_EXT_AD_LENGTH];
702 __u8 le_adv_data_len;
703 __u8 le_per_adv_data[HCI_MAX_PER_AD_TOT_LEN];
704 __u16 le_per_adv_data_len;
705 __u16 le_per_adv_data_offset;
706 __u8 le_adv_phy;
707 __u8 le_adv_sec_phy;
708 __u8 le_tx_phy;
709 __u8 le_rx_phy;
710 __s8 rssi;
711 __s8 tx_power;
712 __s8 max_tx_power;
713 struct bt_iso_qos iso_qos;
714 __u8 num_bis;
715 __u8 bis[HCI_MAX_ISO_BIS];
717 unsigned long flags;
719 enum conn_reasons conn_reason;
720 __u8 abort_reason;
722 __u32 clock;
723 __u16 clock_accuracy;
725 unsigned long conn_info_timestamp;
727 __u8 remote_cap;
728 __u8 remote_auth;
729 __u8 remote_id;
731 unsigned int sent;
733 struct sk_buff_head data_q;
734 struct list_head chan_list;
736 struct delayed_work disc_work;
737 struct delayed_work auto_accept_work;
738 struct delayed_work idle_work;
739 struct delayed_work le_conn_timeout;
741 struct device dev;
742 struct dentry *debugfs;
744 struct hci_dev *hdev;
745 void *l2cap_data;
746 void *sco_data;
747 void *iso_data;
749 struct list_head link_list;
750 struct hci_conn *parent;
751 struct hci_link *link;
753 struct bt_codec codec;
755 void (*connect_cfm_cb) (struct hci_conn *conn, u8 status);
756 void (*security_cfm_cb) (struct hci_conn *conn, u8 status);
757 void (*disconn_cfm_cb) (struct hci_conn *conn, u8 reason);
759 void (*cleanup)(struct hci_conn *conn);
762 struct hci_link {
763 struct list_head list;
764 struct hci_conn *conn;
767 struct hci_chan {
768 struct list_head list;
769 __u16 handle;
770 struct hci_conn *conn;
771 struct sk_buff_head data_q;
772 unsigned int sent;
773 __u8 state;
776 struct hci_conn_params {
777 struct list_head list;
778 struct list_head action;
780 bdaddr_t addr;
781 u8 addr_type;
783 u16 conn_min_interval;
784 u16 conn_max_interval;
785 u16 conn_latency;
786 u16 supervision_timeout;
788 enum {
789 HCI_AUTO_CONN_DISABLED,
790 HCI_AUTO_CONN_REPORT,
791 HCI_AUTO_CONN_DIRECT,
792 HCI_AUTO_CONN_ALWAYS,
793 HCI_AUTO_CONN_LINK_LOSS,
794 HCI_AUTO_CONN_EXPLICIT,
795 } auto_connect;
797 struct hci_conn *conn;
798 bool explicit_connect;
799 /* Accessed without hdev->lock: */
800 hci_conn_flags_t flags;
801 u8 privacy_mode;
804 extern struct list_head hci_dev_list;
805 extern struct list_head hci_cb_list;
806 extern rwlock_t hci_dev_list_lock;
807 extern struct mutex hci_cb_list_lock;
809 #define hci_dev_set_flag(hdev, nr) set_bit((nr), (hdev)->dev_flags)
810 #define hci_dev_clear_flag(hdev, nr) clear_bit((nr), (hdev)->dev_flags)
811 #define hci_dev_change_flag(hdev, nr) change_bit((nr), (hdev)->dev_flags)
812 #define hci_dev_test_flag(hdev, nr) test_bit((nr), (hdev)->dev_flags)
813 #define hci_dev_test_and_set_flag(hdev, nr) test_and_set_bit((nr), (hdev)->dev_flags)
814 #define hci_dev_test_and_clear_flag(hdev, nr) test_and_clear_bit((nr), (hdev)->dev_flags)
815 #define hci_dev_test_and_change_flag(hdev, nr) test_and_change_bit((nr), (hdev)->dev_flags)
817 #define hci_dev_clear_volatile_flags(hdev) \
818 do { \
819 hci_dev_clear_flag(hdev, HCI_LE_SCAN); \
820 hci_dev_clear_flag(hdev, HCI_LE_ADV); \
821 hci_dev_clear_flag(hdev, HCI_LL_RPA_RESOLUTION);\
822 hci_dev_clear_flag(hdev, HCI_PERIODIC_INQ); \
823 hci_dev_clear_flag(hdev, HCI_QUALITY_REPORT); \
824 } while (0)
826 #define hci_dev_le_state_simultaneous(hdev) \
827 (!test_bit(HCI_QUIRK_BROKEN_LE_STATES, &hdev->quirks) && \
828 (hdev->le_states[4] & 0x08) && /* Central */ \
829 (hdev->le_states[4] & 0x40) && /* Peripheral */ \
830 (hdev->le_states[3] & 0x10)) /* Simultaneous */
832 /* ----- HCI interface to upper protocols ----- */
833 int l2cap_connect_ind(struct hci_dev *hdev, bdaddr_t *bdaddr);
834 int l2cap_disconn_ind(struct hci_conn *hcon);
835 void l2cap_recv_acldata(struct hci_conn *hcon, struct sk_buff *skb, u16 flags);
837 #if IS_ENABLED(CONFIG_BT_BREDR)
838 int sco_connect_ind(struct hci_dev *hdev, bdaddr_t *bdaddr, __u8 *flags);
839 void sco_recv_scodata(struct hci_conn *hcon, struct sk_buff *skb);
840 #else
841 static inline int sco_connect_ind(struct hci_dev *hdev, bdaddr_t *bdaddr,
842 __u8 *flags)
844 return 0;
847 static inline void sco_recv_scodata(struct hci_conn *hcon, struct sk_buff *skb)
850 #endif
852 #if IS_ENABLED(CONFIG_BT_LE)
853 int iso_connect_ind(struct hci_dev *hdev, bdaddr_t *bdaddr, __u8 *flags);
854 void iso_recv(struct hci_conn *hcon, struct sk_buff *skb, u16 flags);
855 #else
856 static inline int iso_connect_ind(struct hci_dev *hdev, bdaddr_t *bdaddr,
857 __u8 *flags)
859 return 0;
861 static inline void iso_recv(struct hci_conn *hcon, struct sk_buff *skb,
862 u16 flags)
865 #endif
867 /* ----- Inquiry cache ----- */
868 #define INQUIRY_CACHE_AGE_MAX (HZ*30) /* 30 seconds */
869 #define INQUIRY_ENTRY_AGE_MAX (HZ*60) /* 60 seconds */
871 static inline void discovery_init(struct hci_dev *hdev)
873 hdev->discovery.state = DISCOVERY_STOPPED;
874 INIT_LIST_HEAD(&hdev->discovery.all);
875 INIT_LIST_HEAD(&hdev->discovery.unknown);
876 INIT_LIST_HEAD(&hdev->discovery.resolve);
877 hdev->discovery.report_invalid_rssi = true;
878 hdev->discovery.rssi = HCI_RSSI_INVALID;
881 static inline void hci_discovery_filter_clear(struct hci_dev *hdev)
883 hdev->discovery.result_filtering = false;
884 hdev->discovery.report_invalid_rssi = true;
885 hdev->discovery.rssi = HCI_RSSI_INVALID;
886 hdev->discovery.uuid_count = 0;
887 kfree(hdev->discovery.uuids);
888 hdev->discovery.uuids = NULL;
891 bool hci_discovery_active(struct hci_dev *hdev);
893 void hci_discovery_set_state(struct hci_dev *hdev, int state);
895 static inline int inquiry_cache_empty(struct hci_dev *hdev)
897 return list_empty(&hdev->discovery.all);
900 static inline long inquiry_cache_age(struct hci_dev *hdev)
902 struct discovery_state *c = &hdev->discovery;
903 return jiffies - c->timestamp;
906 static inline long inquiry_entry_age(struct inquiry_entry *e)
908 return jiffies - e->timestamp;
911 struct inquiry_entry *hci_inquiry_cache_lookup(struct hci_dev *hdev,
912 bdaddr_t *bdaddr);
913 struct inquiry_entry *hci_inquiry_cache_lookup_unknown(struct hci_dev *hdev,
914 bdaddr_t *bdaddr);
915 struct inquiry_entry *hci_inquiry_cache_lookup_resolve(struct hci_dev *hdev,
916 bdaddr_t *bdaddr,
917 int state);
918 void hci_inquiry_cache_update_resolve(struct hci_dev *hdev,
919 struct inquiry_entry *ie);
920 u32 hci_inquiry_cache_update(struct hci_dev *hdev, struct inquiry_data *data,
921 bool name_known);
922 void hci_inquiry_cache_flush(struct hci_dev *hdev);
924 /* ----- HCI Connections ----- */
925 enum {
926 HCI_CONN_AUTH_PEND,
927 HCI_CONN_ENCRYPT_PEND,
928 HCI_CONN_RSWITCH_PEND,
929 HCI_CONN_MODE_CHANGE_PEND,
930 HCI_CONN_SCO_SETUP_PEND,
931 HCI_CONN_MGMT_CONNECTED,
932 HCI_CONN_SSP_ENABLED,
933 HCI_CONN_SC_ENABLED,
934 HCI_CONN_AES_CCM,
935 HCI_CONN_POWER_SAVE,
936 HCI_CONN_FLUSH_KEY,
937 HCI_CONN_ENCRYPT,
938 HCI_CONN_AUTH,
939 HCI_CONN_SECURE,
940 HCI_CONN_FIPS,
941 HCI_CONN_STK_ENCRYPT,
942 HCI_CONN_AUTH_INITIATOR,
943 HCI_CONN_DROP,
944 HCI_CONN_CANCEL,
945 HCI_CONN_PARAM_REMOVAL_PEND,
946 HCI_CONN_NEW_LINK_KEY,
947 HCI_CONN_SCANNING,
948 HCI_CONN_AUTH_FAILURE,
949 HCI_CONN_PER_ADV,
950 HCI_CONN_BIG_CREATED,
951 HCI_CONN_CREATE_CIS,
952 HCI_CONN_CREATE_BIG_SYNC,
953 HCI_CONN_BIG_SYNC,
954 HCI_CONN_BIG_SYNC_FAILED,
955 HCI_CONN_CREATE_PA_SYNC,
956 HCI_CONN_PA_SYNC,
957 HCI_CONN_PA_SYNC_FAILED,
960 static inline bool hci_conn_ssp_enabled(struct hci_conn *conn)
962 struct hci_dev *hdev = conn->hdev;
963 return hci_dev_test_flag(hdev, HCI_SSP_ENABLED) &&
964 test_bit(HCI_CONN_SSP_ENABLED, &conn->flags);
967 static inline bool hci_conn_sc_enabled(struct hci_conn *conn)
969 struct hci_dev *hdev = conn->hdev;
970 return hci_dev_test_flag(hdev, HCI_SC_ENABLED) &&
971 test_bit(HCI_CONN_SC_ENABLED, &conn->flags);
974 static inline void hci_conn_hash_add(struct hci_dev *hdev, struct hci_conn *c)
976 struct hci_conn_hash *h = &hdev->conn_hash;
977 list_add_tail_rcu(&c->list, &h->list);
978 switch (c->type) {
979 case ACL_LINK:
980 h->acl_num++;
981 break;
982 case LE_LINK:
983 h->le_num++;
984 if (c->role == HCI_ROLE_SLAVE)
985 h->le_num_peripheral++;
986 break;
987 case SCO_LINK:
988 case ESCO_LINK:
989 h->sco_num++;
990 break;
991 case ISO_LINK:
992 h->iso_num++;
993 break;
997 static inline void hci_conn_hash_del(struct hci_dev *hdev, struct hci_conn *c)
999 struct hci_conn_hash *h = &hdev->conn_hash;
1001 list_del_rcu(&c->list);
1002 synchronize_rcu();
1004 switch (c->type) {
1005 case ACL_LINK:
1006 h->acl_num--;
1007 break;
1008 case LE_LINK:
1009 h->le_num--;
1010 if (c->role == HCI_ROLE_SLAVE)
1011 h->le_num_peripheral--;
1012 break;
1013 case SCO_LINK:
1014 case ESCO_LINK:
1015 h->sco_num--;
1016 break;
1017 case ISO_LINK:
1018 h->iso_num--;
1019 break;
1023 static inline unsigned int hci_conn_num(struct hci_dev *hdev, __u8 type)
1025 struct hci_conn_hash *h = &hdev->conn_hash;
1026 switch (type) {
1027 case ACL_LINK:
1028 return h->acl_num;
1029 case LE_LINK:
1030 return h->le_num;
1031 case SCO_LINK:
1032 case ESCO_LINK:
1033 return h->sco_num;
1034 case ISO_LINK:
1035 return h->iso_num;
1036 default:
1037 return 0;
1041 static inline unsigned int hci_conn_count(struct hci_dev *hdev)
1043 struct hci_conn_hash *c = &hdev->conn_hash;
1045 return c->acl_num + c->sco_num + c->le_num + c->iso_num;
1048 static inline bool hci_conn_valid(struct hci_dev *hdev, struct hci_conn *conn)
1050 struct hci_conn_hash *h = &hdev->conn_hash;
1051 struct hci_conn *c;
1053 rcu_read_lock();
1055 list_for_each_entry_rcu(c, &h->list, list) {
1056 if (c == conn) {
1057 rcu_read_unlock();
1058 return true;
1061 rcu_read_unlock();
1063 return false;
1066 static inline __u8 hci_conn_lookup_type(struct hci_dev *hdev, __u16 handle)
1068 struct hci_conn_hash *h = &hdev->conn_hash;
1069 struct hci_conn *c;
1070 __u8 type = INVALID_LINK;
1072 rcu_read_lock();
1074 list_for_each_entry_rcu(c, &h->list, list) {
1075 if (c->handle == handle) {
1076 type = c->type;
1077 break;
1081 rcu_read_unlock();
1083 return type;
1086 static inline struct hci_conn *hci_conn_hash_lookup_bis(struct hci_dev *hdev,
1087 bdaddr_t *ba, __u8 bis)
1089 struct hci_conn_hash *h = &hdev->conn_hash;
1090 struct hci_conn *c;
1092 rcu_read_lock();
1094 list_for_each_entry_rcu(c, &h->list, list) {
1095 if (bacmp(&c->dst, ba) || c->type != ISO_LINK)
1096 continue;
1098 if (c->iso_qos.bcast.bis == bis) {
1099 rcu_read_unlock();
1100 return c;
1103 rcu_read_unlock();
1105 return NULL;
1108 static inline struct hci_conn *hci_conn_hash_lookup_sid(struct hci_dev *hdev,
1109 __u8 sid,
1110 bdaddr_t *dst,
1111 __u8 dst_type)
1113 struct hci_conn_hash *h = &hdev->conn_hash;
1114 struct hci_conn *c;
1116 rcu_read_lock();
1118 list_for_each_entry_rcu(c, &h->list, list) {
1119 if (c->type != ISO_LINK || bacmp(&c->dst, dst) ||
1120 c->dst_type != dst_type || c->sid != sid)
1121 continue;
1123 rcu_read_unlock();
1124 return c;
1127 rcu_read_unlock();
1129 return NULL;
1132 static inline struct hci_conn *
1133 hci_conn_hash_lookup_per_adv_bis(struct hci_dev *hdev,
1134 bdaddr_t *ba,
1135 __u8 big, __u8 bis)
1137 struct hci_conn_hash *h = &hdev->conn_hash;
1138 struct hci_conn *c;
1140 rcu_read_lock();
1142 list_for_each_entry_rcu(c, &h->list, list) {
1143 if (bacmp(&c->dst, ba) || c->type != ISO_LINK ||
1144 !test_bit(HCI_CONN_PER_ADV, &c->flags))
1145 continue;
1147 if (c->iso_qos.bcast.big == big &&
1148 c->iso_qos.bcast.bis == bis) {
1149 rcu_read_unlock();
1150 return c;
1153 rcu_read_unlock();
1155 return NULL;
1158 static inline struct hci_conn *hci_conn_hash_lookup_handle(struct hci_dev *hdev,
1159 __u16 handle)
1161 struct hci_conn_hash *h = &hdev->conn_hash;
1162 struct hci_conn *c;
1164 rcu_read_lock();
1166 list_for_each_entry_rcu(c, &h->list, list) {
1167 if (c->handle == handle) {
1168 rcu_read_unlock();
1169 return c;
1172 rcu_read_unlock();
1174 return NULL;
1177 static inline struct hci_conn *hci_conn_hash_lookup_ba(struct hci_dev *hdev,
1178 __u8 type, bdaddr_t *ba)
1180 struct hci_conn_hash *h = &hdev->conn_hash;
1181 struct hci_conn *c;
1183 rcu_read_lock();
1185 list_for_each_entry_rcu(c, &h->list, list) {
1186 if (c->type == type && !bacmp(&c->dst, ba)) {
1187 rcu_read_unlock();
1188 return c;
1192 rcu_read_unlock();
1194 return NULL;
1197 static inline struct hci_conn *hci_conn_hash_lookup_le(struct hci_dev *hdev,
1198 bdaddr_t *ba,
1199 __u8 ba_type)
1201 struct hci_conn_hash *h = &hdev->conn_hash;
1202 struct hci_conn *c;
1204 rcu_read_lock();
1206 list_for_each_entry_rcu(c, &h->list, list) {
1207 if (c->type != LE_LINK)
1208 continue;
1210 if (ba_type == c->dst_type && !bacmp(&c->dst, ba)) {
1211 rcu_read_unlock();
1212 return c;
1216 rcu_read_unlock();
1218 return NULL;
1221 static inline struct hci_conn *hci_conn_hash_lookup_cis(struct hci_dev *hdev,
1222 bdaddr_t *ba,
1223 __u8 ba_type,
1224 __u8 cig,
1225 __u8 id)
1227 struct hci_conn_hash *h = &hdev->conn_hash;
1228 struct hci_conn *c;
1230 rcu_read_lock();
1232 list_for_each_entry_rcu(c, &h->list, list) {
1233 if (c->type != ISO_LINK || !bacmp(&c->dst, BDADDR_ANY))
1234 continue;
1236 /* Match CIG ID if set */
1237 if (cig != c->iso_qos.ucast.cig)
1238 continue;
1240 /* Match CIS ID if set */
1241 if (id != c->iso_qos.ucast.cis)
1242 continue;
1244 /* Match destination address if set */
1245 if (!ba || (ba_type == c->dst_type && !bacmp(&c->dst, ba))) {
1246 rcu_read_unlock();
1247 return c;
1251 rcu_read_unlock();
1253 return NULL;
1256 static inline struct hci_conn *hci_conn_hash_lookup_cig(struct hci_dev *hdev,
1257 __u8 handle)
1259 struct hci_conn_hash *h = &hdev->conn_hash;
1260 struct hci_conn *c;
1262 rcu_read_lock();
1264 list_for_each_entry_rcu(c, &h->list, list) {
1265 if (c->type != ISO_LINK || !bacmp(&c->dst, BDADDR_ANY))
1266 continue;
1268 if (handle == c->iso_qos.ucast.cig) {
1269 rcu_read_unlock();
1270 return c;
1274 rcu_read_unlock();
1276 return NULL;
1279 static inline struct hci_conn *hci_conn_hash_lookup_big(struct hci_dev *hdev,
1280 __u8 handle)
1282 struct hci_conn_hash *h = &hdev->conn_hash;
1283 struct hci_conn *c;
1285 rcu_read_lock();
1287 list_for_each_entry_rcu(c, &h->list, list) {
1288 if (c->type != ISO_LINK)
1289 continue;
1291 /* An ISO_LINK hcon with BDADDR_ANY as destination
1292 * address is a Broadcast connection. A Broadcast
1293 * slave connection is associated with a PA train,
1294 * so the sync_handle can be used to differentiate
1295 * from unicast.
1297 if (bacmp(&c->dst, BDADDR_ANY) &&
1298 c->sync_handle == HCI_SYNC_HANDLE_INVALID)
1299 continue;
1301 if (handle == c->iso_qos.bcast.big) {
1302 rcu_read_unlock();
1303 return c;
1307 rcu_read_unlock();
1309 return NULL;
1312 static inline struct hci_conn *
1313 hci_conn_hash_lookup_big_sync_pend(struct hci_dev *hdev,
1314 __u8 handle, __u8 num_bis)
1316 struct hci_conn_hash *h = &hdev->conn_hash;
1317 struct hci_conn *c;
1319 rcu_read_lock();
1321 list_for_each_entry_rcu(c, &h->list, list) {
1322 if (c->type != ISO_LINK)
1323 continue;
1325 if (handle == c->iso_qos.bcast.big && num_bis == c->num_bis) {
1326 rcu_read_unlock();
1327 return c;
1331 rcu_read_unlock();
1333 return NULL;
1336 static inline struct hci_conn *
1337 hci_conn_hash_lookup_big_state(struct hci_dev *hdev, __u8 handle, __u16 state)
1339 struct hci_conn_hash *h = &hdev->conn_hash;
1340 struct hci_conn *c;
1342 rcu_read_lock();
1344 list_for_each_entry_rcu(c, &h->list, list) {
1345 if (bacmp(&c->dst, BDADDR_ANY) || c->type != ISO_LINK ||
1346 c->state != state)
1347 continue;
1349 if (handle == c->iso_qos.bcast.big) {
1350 rcu_read_unlock();
1351 return c;
1355 rcu_read_unlock();
1357 return NULL;
1360 static inline struct hci_conn *
1361 hci_conn_hash_lookup_pa_sync_big_handle(struct hci_dev *hdev, __u8 big)
1363 struct hci_conn_hash *h = &hdev->conn_hash;
1364 struct hci_conn *c;
1366 rcu_read_lock();
1368 list_for_each_entry_rcu(c, &h->list, list) {
1369 if (c->type != ISO_LINK ||
1370 !test_bit(HCI_CONN_PA_SYNC, &c->flags))
1371 continue;
1373 if (c->iso_qos.bcast.big == big) {
1374 rcu_read_unlock();
1375 return c;
1378 rcu_read_unlock();
1380 return NULL;
1383 static inline struct hci_conn *
1384 hci_conn_hash_lookup_pa_sync_handle(struct hci_dev *hdev, __u16 sync_handle)
1386 struct hci_conn_hash *h = &hdev->conn_hash;
1387 struct hci_conn *c;
1389 rcu_read_lock();
1391 list_for_each_entry_rcu(c, &h->list, list) {
1392 if (c->type != ISO_LINK)
1393 continue;
1395 /* Ignore the listen hcon, we are looking
1396 * for the child hcon that was created as
1397 * a result of the PA sync established event.
1399 if (c->state == BT_LISTEN)
1400 continue;
1402 if (c->sync_handle == sync_handle) {
1403 rcu_read_unlock();
1404 return c;
1407 rcu_read_unlock();
1409 return NULL;
1412 static inline struct hci_conn *hci_conn_hash_lookup_state(struct hci_dev *hdev,
1413 __u8 type, __u16 state)
1415 struct hci_conn_hash *h = &hdev->conn_hash;
1416 struct hci_conn *c;
1418 rcu_read_lock();
1420 list_for_each_entry_rcu(c, &h->list, list) {
1421 if (c->type == type && c->state == state) {
1422 rcu_read_unlock();
1423 return c;
1427 rcu_read_unlock();
1429 return NULL;
1432 typedef void (*hci_conn_func_t)(struct hci_conn *conn, void *data);
1433 static inline void hci_conn_hash_list_state(struct hci_dev *hdev,
1434 hci_conn_func_t func, __u8 type,
1435 __u16 state, void *data)
1437 struct hci_conn_hash *h = &hdev->conn_hash;
1438 struct hci_conn *c;
1440 if (!func)
1441 return;
1443 rcu_read_lock();
1445 list_for_each_entry_rcu(c, &h->list, list) {
1446 if (c->type == type && c->state == state)
1447 func(c, data);
1450 rcu_read_unlock();
1453 static inline void hci_conn_hash_list_flag(struct hci_dev *hdev,
1454 hci_conn_func_t func, __u8 type,
1455 __u8 flag, void *data)
1457 struct hci_conn_hash *h = &hdev->conn_hash;
1458 struct hci_conn *c;
1460 if (!func)
1461 return;
1463 rcu_read_lock();
1465 list_for_each_entry_rcu(c, &h->list, list) {
1466 if (c->type == type && test_bit(flag, &c->flags))
1467 func(c, data);
1470 rcu_read_unlock();
1473 static inline struct hci_conn *hci_lookup_le_connect(struct hci_dev *hdev)
1475 struct hci_conn_hash *h = &hdev->conn_hash;
1476 struct hci_conn *c;
1478 rcu_read_lock();
1480 list_for_each_entry_rcu(c, &h->list, list) {
1481 if (c->type == LE_LINK && c->state == BT_CONNECT &&
1482 !test_bit(HCI_CONN_SCANNING, &c->flags)) {
1483 rcu_read_unlock();
1484 return c;
1488 rcu_read_unlock();
1490 return NULL;
1493 /* Returns true if an le connection is in the scanning state */
1494 static inline bool hci_is_le_conn_scanning(struct hci_dev *hdev)
1496 struct hci_conn_hash *h = &hdev->conn_hash;
1497 struct hci_conn *c;
1499 rcu_read_lock();
1501 list_for_each_entry_rcu(c, &h->list, list) {
1502 if (c->type == LE_LINK && c->state == BT_CONNECT &&
1503 test_bit(HCI_CONN_SCANNING, &c->flags)) {
1504 rcu_read_unlock();
1505 return true;
1509 rcu_read_unlock();
1511 return false;
1514 int hci_disconnect(struct hci_conn *conn, __u8 reason);
1515 bool hci_setup_sync(struct hci_conn *conn, __u16 handle);
1516 void hci_sco_setup(struct hci_conn *conn, __u8 status);
1517 bool hci_iso_setup_path(struct hci_conn *conn);
1518 int hci_le_create_cis_pending(struct hci_dev *hdev);
1519 int hci_pa_create_sync_pending(struct hci_dev *hdev);
1520 int hci_le_big_create_sync_pending(struct hci_dev *hdev);
1521 int hci_conn_check_create_cis(struct hci_conn *conn);
1523 struct hci_conn *hci_conn_add(struct hci_dev *hdev, int type, bdaddr_t *dst,
1524 u8 role, u16 handle);
1525 struct hci_conn *hci_conn_add_unset(struct hci_dev *hdev, int type,
1526 bdaddr_t *dst, u8 role);
1527 void hci_conn_del(struct hci_conn *conn);
1528 void hci_conn_hash_flush(struct hci_dev *hdev);
1530 struct hci_chan *hci_chan_create(struct hci_conn *conn);
1531 void hci_chan_del(struct hci_chan *chan);
1532 void hci_chan_list_flush(struct hci_conn *conn);
1533 struct hci_chan *hci_chan_lookup_handle(struct hci_dev *hdev, __u16 handle);
1535 struct hci_conn *hci_connect_le_scan(struct hci_dev *hdev, bdaddr_t *dst,
1536 u8 dst_type, u8 sec_level,
1537 u16 conn_timeout,
1538 enum conn_reasons conn_reason);
1539 struct hci_conn *hci_connect_le(struct hci_dev *hdev, bdaddr_t *dst,
1540 u8 dst_type, bool dst_resolved, u8 sec_level,
1541 u16 conn_timeout, u8 role, u8 phy, u8 sec_phy);
1542 void hci_connect_le_scan_cleanup(struct hci_conn *conn, u8 status);
1543 struct hci_conn *hci_connect_acl(struct hci_dev *hdev, bdaddr_t *dst,
1544 u8 sec_level, u8 auth_type,
1545 enum conn_reasons conn_reason, u16 timeout);
1546 struct hci_conn *hci_connect_sco(struct hci_dev *hdev, int type, bdaddr_t *dst,
1547 __u16 setting, struct bt_codec *codec,
1548 u16 timeout);
1549 struct hci_conn *hci_bind_cis(struct hci_dev *hdev, bdaddr_t *dst,
1550 __u8 dst_type, struct bt_iso_qos *qos);
1551 struct hci_conn *hci_bind_bis(struct hci_dev *hdev, bdaddr_t *dst,
1552 struct bt_iso_qos *qos,
1553 __u8 base_len, __u8 *base);
1554 struct hci_conn *hci_connect_cis(struct hci_dev *hdev, bdaddr_t *dst,
1555 __u8 dst_type, struct bt_iso_qos *qos);
1556 struct hci_conn *hci_connect_bis(struct hci_dev *hdev, bdaddr_t *dst,
1557 __u8 dst_type, struct bt_iso_qos *qos,
1558 __u8 data_len, __u8 *data);
1559 struct hci_conn *hci_pa_create_sync(struct hci_dev *hdev, bdaddr_t *dst,
1560 __u8 dst_type, __u8 sid, struct bt_iso_qos *qos);
1561 int hci_le_big_create_sync(struct hci_dev *hdev, struct hci_conn *hcon,
1562 struct bt_iso_qos *qos,
1563 __u16 sync_handle, __u8 num_bis, __u8 bis[]);
1564 int hci_conn_check_link_mode(struct hci_conn *conn);
1565 int hci_conn_check_secure(struct hci_conn *conn, __u8 sec_level);
1566 int hci_conn_security(struct hci_conn *conn, __u8 sec_level, __u8 auth_type,
1567 bool initiator);
1568 int hci_conn_switch_role(struct hci_conn *conn, __u8 role);
1570 void hci_conn_enter_active_mode(struct hci_conn *conn, __u8 force_active);
1572 void hci_conn_failed(struct hci_conn *conn, u8 status);
1573 u8 hci_conn_set_handle(struct hci_conn *conn, u16 handle);
1576 * hci_conn_get() and hci_conn_put() are used to control the life-time of an
1577 * "hci_conn" object. They do not guarantee that the hci_conn object is running,
1578 * working or anything else. They just guarantee that the object is available
1579 * and can be dereferenced. So you can use its locks, local variables and any
1580 * other constant data.
1581 * Before accessing runtime data, you _must_ lock the object and then check that
1582 * it is still running. As soon as you release the locks, the connection might
1583 * get dropped, though.
1585 * On the other hand, hci_conn_hold() and hci_conn_drop() are used to control
1586 * how long the underlying connection is held. So every channel that runs on the
1587 * hci_conn object calls this to prevent the connection from disappearing. As
1588 * long as you hold a device, you must also guarantee that you have a valid
1589 * reference to the device via hci_conn_get() (or the initial reference from
1590 * hci_conn_add()).
1591 * The hold()/drop() ref-count is known to drop below 0 sometimes, which doesn't
1592 * break because nobody cares for that. But this means, we cannot use
1593 * _get()/_drop() in it, but require the caller to have a valid ref (FIXME).
1596 static inline struct hci_conn *hci_conn_get(struct hci_conn *conn)
1598 get_device(&conn->dev);
1599 return conn;
1602 static inline void hci_conn_put(struct hci_conn *conn)
1604 put_device(&conn->dev);
1607 static inline struct hci_conn *hci_conn_hold(struct hci_conn *conn)
1609 BT_DBG("hcon %p orig refcnt %d", conn, atomic_read(&conn->refcnt));
1611 atomic_inc(&conn->refcnt);
1612 cancel_delayed_work(&conn->disc_work);
1614 return conn;
1617 static inline void hci_conn_drop(struct hci_conn *conn)
1619 BT_DBG("hcon %p orig refcnt %d", conn, atomic_read(&conn->refcnt));
1621 if (atomic_dec_and_test(&conn->refcnt)) {
1622 unsigned long timeo;
1624 switch (conn->type) {
1625 case ACL_LINK:
1626 case LE_LINK:
1627 cancel_delayed_work(&conn->idle_work);
1628 if (conn->state == BT_CONNECTED) {
1629 timeo = conn->disc_timeout;
1630 if (!conn->out)
1631 timeo *= 2;
1632 } else {
1633 timeo = 0;
1635 break;
1637 default:
1638 timeo = 0;
1639 break;
1642 cancel_delayed_work(&conn->disc_work);
1643 queue_delayed_work(conn->hdev->workqueue,
1644 &conn->disc_work, timeo);
1648 /* ----- HCI Devices ----- */
1649 static inline void hci_dev_put(struct hci_dev *d)
1651 BT_DBG("%s orig refcnt %d", d->name,
1652 kref_read(&d->dev.kobj.kref));
1654 put_device(&d->dev);
1657 static inline struct hci_dev *hci_dev_hold(struct hci_dev *d)
1659 BT_DBG("%s orig refcnt %d", d->name,
1660 kref_read(&d->dev.kobj.kref));
1662 get_device(&d->dev);
1663 return d;
1666 #define hci_dev_lock(d) mutex_lock(&d->lock)
1667 #define hci_dev_unlock(d) mutex_unlock(&d->lock)
1669 #define to_hci_dev(d) container_of(d, struct hci_dev, dev)
1670 #define to_hci_conn(c) container_of(c, struct hci_conn, dev)
1672 static inline void *hci_get_drvdata(struct hci_dev *hdev)
1674 return dev_get_drvdata(&hdev->dev);
1677 static inline void hci_set_drvdata(struct hci_dev *hdev, void *data)
1679 dev_set_drvdata(&hdev->dev, data);
1682 static inline void *hci_get_priv(struct hci_dev *hdev)
1684 return (char *)hdev + sizeof(*hdev);
1687 struct hci_dev *hci_dev_get(int index);
1688 struct hci_dev *hci_get_route(bdaddr_t *dst, bdaddr_t *src, u8 src_type);
1690 struct hci_dev *hci_alloc_dev_priv(int sizeof_priv);
1692 static inline struct hci_dev *hci_alloc_dev(void)
1694 return hci_alloc_dev_priv(0);
1697 void hci_free_dev(struct hci_dev *hdev);
1698 int hci_register_dev(struct hci_dev *hdev);
1699 void hci_unregister_dev(struct hci_dev *hdev);
1700 void hci_release_dev(struct hci_dev *hdev);
1701 int hci_register_suspend_notifier(struct hci_dev *hdev);
1702 int hci_unregister_suspend_notifier(struct hci_dev *hdev);
1703 int hci_suspend_dev(struct hci_dev *hdev);
1704 int hci_resume_dev(struct hci_dev *hdev);
1705 int hci_reset_dev(struct hci_dev *hdev);
1706 int hci_recv_frame(struct hci_dev *hdev, struct sk_buff *skb);
1707 int hci_recv_diag(struct hci_dev *hdev, struct sk_buff *skb);
1708 __printf(2, 3) void hci_set_hw_info(struct hci_dev *hdev, const char *fmt, ...);
1709 __printf(2, 3) void hci_set_fw_info(struct hci_dev *hdev, const char *fmt, ...);
1711 static inline void hci_set_msft_opcode(struct hci_dev *hdev, __u16 opcode)
1713 #if IS_ENABLED(CONFIG_BT_MSFTEXT)
1714 hdev->msft_opcode = opcode;
1715 #endif
1718 static inline void hci_set_aosp_capable(struct hci_dev *hdev)
1720 #if IS_ENABLED(CONFIG_BT_AOSPEXT)
1721 hdev->aosp_capable = true;
1722 #endif
1725 static inline void hci_devcd_setup(struct hci_dev *hdev)
1727 #ifdef CONFIG_DEV_COREDUMP
1728 INIT_WORK(&hdev->dump.dump_rx, hci_devcd_rx);
1729 INIT_DELAYED_WORK(&hdev->dump.dump_timeout, hci_devcd_timeout);
1730 skb_queue_head_init(&hdev->dump.dump_q);
1731 #endif
1734 int hci_dev_open(__u16 dev);
1735 int hci_dev_close(__u16 dev);
1736 int hci_dev_do_close(struct hci_dev *hdev);
1737 int hci_dev_reset(__u16 dev);
1738 int hci_dev_reset_stat(__u16 dev);
1739 int hci_dev_cmd(unsigned int cmd, void __user *arg);
1740 int hci_get_dev_list(void __user *arg);
1741 int hci_get_dev_info(void __user *arg);
1742 int hci_get_conn_list(void __user *arg);
1743 int hci_get_conn_info(struct hci_dev *hdev, void __user *arg);
1744 int hci_get_auth_info(struct hci_dev *hdev, void __user *arg);
1745 int hci_inquiry(void __user *arg);
1747 struct bdaddr_list *hci_bdaddr_list_lookup(struct list_head *list,
1748 bdaddr_t *bdaddr, u8 type);
1749 struct bdaddr_list_with_irk *hci_bdaddr_list_lookup_with_irk(
1750 struct list_head *list, bdaddr_t *bdaddr,
1751 u8 type);
1752 struct bdaddr_list_with_flags *
1753 hci_bdaddr_list_lookup_with_flags(struct list_head *list, bdaddr_t *bdaddr,
1754 u8 type);
1755 int hci_bdaddr_list_add(struct list_head *list, bdaddr_t *bdaddr, u8 type);
1756 int hci_bdaddr_list_add_with_irk(struct list_head *list, bdaddr_t *bdaddr,
1757 u8 type, u8 *peer_irk, u8 *local_irk);
1758 int hci_bdaddr_list_add_with_flags(struct list_head *list, bdaddr_t *bdaddr,
1759 u8 type, u32 flags);
1760 int hci_bdaddr_list_del(struct list_head *list, bdaddr_t *bdaddr, u8 type);
1761 int hci_bdaddr_list_del_with_irk(struct list_head *list, bdaddr_t *bdaddr,
1762 u8 type);
1763 int hci_bdaddr_list_del_with_flags(struct list_head *list, bdaddr_t *bdaddr,
1764 u8 type);
1765 void hci_bdaddr_list_clear(struct list_head *list);
1767 struct hci_conn_params *hci_conn_params_lookup(struct hci_dev *hdev,
1768 bdaddr_t *addr, u8 addr_type);
1769 struct hci_conn_params *hci_conn_params_add(struct hci_dev *hdev,
1770 bdaddr_t *addr, u8 addr_type);
1771 void hci_conn_params_del(struct hci_dev *hdev, bdaddr_t *addr, u8 addr_type);
1772 void hci_conn_params_clear_disabled(struct hci_dev *hdev);
1773 void hci_conn_params_free(struct hci_conn_params *param);
1775 void hci_pend_le_list_del_init(struct hci_conn_params *param);
1776 void hci_pend_le_list_add(struct hci_conn_params *param,
1777 struct list_head *list);
1778 struct hci_conn_params *hci_pend_le_action_lookup(struct list_head *list,
1779 bdaddr_t *addr,
1780 u8 addr_type);
1782 void hci_uuids_clear(struct hci_dev *hdev);
1784 void hci_link_keys_clear(struct hci_dev *hdev);
1785 struct link_key *hci_find_link_key(struct hci_dev *hdev, bdaddr_t *bdaddr);
1786 struct link_key *hci_add_link_key(struct hci_dev *hdev, struct hci_conn *conn,
1787 bdaddr_t *bdaddr, u8 *val, u8 type,
1788 u8 pin_len, bool *persistent);
1789 struct smp_ltk *hci_add_ltk(struct hci_dev *hdev, bdaddr_t *bdaddr,
1790 u8 addr_type, u8 type, u8 authenticated,
1791 u8 tk[16], u8 enc_size, __le16 ediv, __le64 rand);
1792 struct smp_ltk *hci_find_ltk(struct hci_dev *hdev, bdaddr_t *bdaddr,
1793 u8 addr_type, u8 role);
1794 int hci_remove_ltk(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 bdaddr_type);
1795 void hci_smp_ltks_clear(struct hci_dev *hdev);
1796 int hci_remove_link_key(struct hci_dev *hdev, bdaddr_t *bdaddr);
1798 struct smp_irk *hci_find_irk_by_rpa(struct hci_dev *hdev, bdaddr_t *rpa);
1799 struct smp_irk *hci_find_irk_by_addr(struct hci_dev *hdev, bdaddr_t *bdaddr,
1800 u8 addr_type);
1801 struct smp_irk *hci_add_irk(struct hci_dev *hdev, bdaddr_t *bdaddr,
1802 u8 addr_type, u8 val[16], bdaddr_t *rpa);
1803 void hci_remove_irk(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 addr_type);
1804 bool hci_is_blocked_key(struct hci_dev *hdev, u8 type, u8 val[16]);
1805 void hci_blocked_keys_clear(struct hci_dev *hdev);
1806 void hci_smp_irks_clear(struct hci_dev *hdev);
1808 bool hci_bdaddr_is_paired(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 type);
1810 void hci_remote_oob_data_clear(struct hci_dev *hdev);
1811 struct oob_data *hci_find_remote_oob_data(struct hci_dev *hdev,
1812 bdaddr_t *bdaddr, u8 bdaddr_type);
1813 int hci_add_remote_oob_data(struct hci_dev *hdev, bdaddr_t *bdaddr,
1814 u8 bdaddr_type, u8 *hash192, u8 *rand192,
1815 u8 *hash256, u8 *rand256);
1816 int hci_remove_remote_oob_data(struct hci_dev *hdev, bdaddr_t *bdaddr,
1817 u8 bdaddr_type);
1819 void hci_adv_instances_clear(struct hci_dev *hdev);
1820 struct adv_info *hci_find_adv_instance(struct hci_dev *hdev, u8 instance);
1821 struct adv_info *hci_get_next_instance(struct hci_dev *hdev, u8 instance);
1822 struct adv_info *hci_add_adv_instance(struct hci_dev *hdev, u8 instance,
1823 u32 flags, u16 adv_data_len, u8 *adv_data,
1824 u16 scan_rsp_len, u8 *scan_rsp_data,
1825 u16 timeout, u16 duration, s8 tx_power,
1826 u32 min_interval, u32 max_interval,
1827 u8 mesh_handle);
1828 struct adv_info *hci_add_per_instance(struct hci_dev *hdev, u8 instance,
1829 u32 flags, u8 data_len, u8 *data,
1830 u32 min_interval, u32 max_interval);
1831 int hci_set_adv_instance_data(struct hci_dev *hdev, u8 instance,
1832 u16 adv_data_len, u8 *adv_data,
1833 u16 scan_rsp_len, u8 *scan_rsp_data);
1834 int hci_remove_adv_instance(struct hci_dev *hdev, u8 instance);
1835 void hci_adv_instances_set_rpa_expired(struct hci_dev *hdev, bool rpa_expired);
1836 u32 hci_adv_instance_flags(struct hci_dev *hdev, u8 instance);
1837 bool hci_adv_instance_is_scannable(struct hci_dev *hdev, u8 instance);
1839 void hci_adv_monitors_clear(struct hci_dev *hdev);
1840 void hci_free_adv_monitor(struct hci_dev *hdev, struct adv_monitor *monitor);
1841 int hci_add_adv_monitor(struct hci_dev *hdev, struct adv_monitor *monitor);
1842 int hci_remove_single_adv_monitor(struct hci_dev *hdev, u16 handle);
1843 int hci_remove_all_adv_monitor(struct hci_dev *hdev);
1844 bool hci_is_adv_monitoring(struct hci_dev *hdev);
1845 int hci_get_adv_monitor_offload_ext(struct hci_dev *hdev);
1847 void hci_event_packet(struct hci_dev *hdev, struct sk_buff *skb);
1849 void hci_init_sysfs(struct hci_dev *hdev);
1850 void hci_conn_init_sysfs(struct hci_conn *conn);
1851 void hci_conn_add_sysfs(struct hci_conn *conn);
1852 void hci_conn_del_sysfs(struct hci_conn *conn);
1854 #define SET_HCIDEV_DEV(hdev, pdev) ((hdev)->dev.parent = (pdev))
1855 #define GET_HCIDEV_DEV(hdev) ((hdev)->dev.parent)
1857 /* ----- LMP capabilities ----- */
1858 #define lmp_encrypt_capable(dev) ((dev)->features[0][0] & LMP_ENCRYPT)
1859 #define lmp_rswitch_capable(dev) ((dev)->features[0][0] & LMP_RSWITCH)
1860 #define lmp_hold_capable(dev) ((dev)->features[0][0] & LMP_HOLD)
1861 #define lmp_sniff_capable(dev) ((dev)->features[0][0] & LMP_SNIFF)
1862 #define lmp_park_capable(dev) ((dev)->features[0][1] & LMP_PARK)
1863 #define lmp_inq_rssi_capable(dev) ((dev)->features[0][3] & LMP_RSSI_INQ)
1864 #define lmp_esco_capable(dev) ((dev)->features[0][3] & LMP_ESCO)
1865 #define lmp_bredr_capable(dev) (!((dev)->features[0][4] & LMP_NO_BREDR))
1866 #define lmp_le_capable(dev) ((dev)->features[0][4] & LMP_LE)
1867 #define lmp_sniffsubr_capable(dev) ((dev)->features[0][5] & LMP_SNIFF_SUBR)
1868 #define lmp_pause_enc_capable(dev) ((dev)->features[0][5] & LMP_PAUSE_ENC)
1869 #define lmp_esco_2m_capable(dev) ((dev)->features[0][5] & LMP_EDR_ESCO_2M)
1870 #define lmp_ext_inq_capable(dev) ((dev)->features[0][6] & LMP_EXT_INQ)
1871 #define lmp_le_br_capable(dev) (!!((dev)->features[0][6] & LMP_SIMUL_LE_BR))
1872 #define lmp_ssp_capable(dev) ((dev)->features[0][6] & LMP_SIMPLE_PAIR)
1873 #define lmp_no_flush_capable(dev) ((dev)->features[0][6] & LMP_NO_FLUSH)
1874 #define lmp_lsto_capable(dev) ((dev)->features[0][7] & LMP_LSTO)
1875 #define lmp_inq_tx_pwr_capable(dev) ((dev)->features[0][7] & LMP_INQ_TX_PWR)
1876 #define lmp_ext_feat_capable(dev) ((dev)->features[0][7] & LMP_EXTFEATURES)
1877 #define lmp_transp_capable(dev) ((dev)->features[0][2] & LMP_TRANSPARENT)
1878 #define lmp_edr_2m_capable(dev) ((dev)->features[0][3] & LMP_EDR_2M)
1879 #define lmp_edr_3m_capable(dev) ((dev)->features[0][3] & LMP_EDR_3M)
1880 #define lmp_edr_3slot_capable(dev) ((dev)->features[0][4] & LMP_EDR_3SLOT)
1881 #define lmp_edr_5slot_capable(dev) ((dev)->features[0][5] & LMP_EDR_5SLOT)
1883 /* ----- Extended LMP capabilities ----- */
1884 #define lmp_cpb_central_capable(dev) ((dev)->features[2][0] & LMP_CPB_CENTRAL)
1885 #define lmp_cpb_peripheral_capable(dev) ((dev)->features[2][0] & LMP_CPB_PERIPHERAL)
1886 #define lmp_sync_train_capable(dev) ((dev)->features[2][0] & LMP_SYNC_TRAIN)
1887 #define lmp_sync_scan_capable(dev) ((dev)->features[2][0] & LMP_SYNC_SCAN)
1888 #define lmp_sc_capable(dev) ((dev)->features[2][1] & LMP_SC)
1889 #define lmp_ping_capable(dev) ((dev)->features[2][1] & LMP_PING)
1891 /* ----- Host capabilities ----- */
1892 #define lmp_host_ssp_capable(dev) ((dev)->features[1][0] & LMP_HOST_SSP)
1893 #define lmp_host_sc_capable(dev) ((dev)->features[1][0] & LMP_HOST_SC)
1894 #define lmp_host_le_capable(dev) (!!((dev)->features[1][0] & LMP_HOST_LE))
1895 #define lmp_host_le_br_capable(dev) (!!((dev)->features[1][0] & LMP_HOST_LE_BREDR))
1897 #define hdev_is_powered(dev) (test_bit(HCI_UP, &(dev)->flags) && \
1898 !hci_dev_test_flag(dev, HCI_AUTO_OFF))
1899 #define bredr_sc_enabled(dev) (lmp_sc_capable(dev) && \
1900 hci_dev_test_flag(dev, HCI_SC_ENABLED))
1901 #define rpa_valid(dev) (bacmp(&dev->rpa, BDADDR_ANY) && \
1902 !hci_dev_test_flag(dev, HCI_RPA_EXPIRED))
1903 #define adv_rpa_valid(adv) (bacmp(&adv->random_addr, BDADDR_ANY) && \
1904 !adv->rpa_expired)
1906 #define scan_1m(dev) (((dev)->le_tx_def_phys & HCI_LE_SET_PHY_1M) || \
1907 ((dev)->le_rx_def_phys & HCI_LE_SET_PHY_1M))
1909 #define le_2m_capable(dev) (((dev)->le_features[1] & HCI_LE_PHY_2M))
1911 #define scan_2m(dev) (((dev)->le_tx_def_phys & HCI_LE_SET_PHY_2M) || \
1912 ((dev)->le_rx_def_phys & HCI_LE_SET_PHY_2M))
1914 #define le_coded_capable(dev) (((dev)->le_features[1] & HCI_LE_PHY_CODED) && \
1915 !test_bit(HCI_QUIRK_BROKEN_LE_CODED, \
1916 &(dev)->quirks))
1918 #define scan_coded(dev) (((dev)->le_tx_def_phys & HCI_LE_SET_PHY_CODED) || \
1919 ((dev)->le_rx_def_phys & HCI_LE_SET_PHY_CODED))
1921 #define ll_privacy_capable(dev) ((dev)->le_features[0] & HCI_LE_LL_PRIVACY)
1923 /* Use LL Privacy based address resolution if supported */
1924 #define use_ll_privacy(dev) (ll_privacy_capable(dev) && \
1925 hci_dev_test_flag(dev, HCI_ENABLE_LL_PRIVACY))
1927 #define privacy_mode_capable(dev) (use_ll_privacy(dev) && \
1928 (hdev->commands[39] & 0x04))
1930 #define read_key_size_capable(dev) \
1931 ((dev)->commands[20] & 0x10 && \
1932 !test_bit(HCI_QUIRK_BROKEN_READ_ENC_KEY_SIZE, &hdev->quirks))
1934 /* Use enhanced synchronous connection if command is supported and its quirk
1935 * has not been set.
1937 #define enhanced_sync_conn_capable(dev) \
1938 (((dev)->commands[29] & 0x08) && \
1939 !test_bit(HCI_QUIRK_BROKEN_ENHANCED_SETUP_SYNC_CONN, &(dev)->quirks))
1941 /* Use ext scanning if set ext scan param and ext scan enable is supported */
1942 #define use_ext_scan(dev) (((dev)->commands[37] & 0x20) && \
1943 ((dev)->commands[37] & 0x40) && \
1944 !test_bit(HCI_QUIRK_BROKEN_EXT_SCAN, &(dev)->quirks))
1946 /* Use ext create connection if command is supported */
1947 #define use_ext_conn(dev) (((dev)->commands[37] & 0x80) && \
1948 !test_bit(HCI_QUIRK_BROKEN_EXT_CREATE_CONN, &(dev)->quirks))
1949 /* Extended advertising support */
1950 #define ext_adv_capable(dev) (((dev)->le_features[1] & HCI_LE_EXT_ADV))
1952 /* Maximum advertising length */
1953 #define max_adv_len(dev) \
1954 (ext_adv_capable(dev) ? HCI_MAX_EXT_AD_LENGTH : HCI_MAX_AD_LENGTH)
1956 /* BLUETOOTH CORE SPECIFICATION Version 5.3 | Vol 4, Part E page 1789:
1958 * C24: Mandatory if the LE Controller supports Connection State and either
1959 * LE Feature (LL Privacy) or LE Feature (Extended Advertising) is supported
1961 #define use_enhanced_conn_complete(dev) ((ll_privacy_capable(dev) || \
1962 ext_adv_capable(dev)) && \
1963 !test_bit(HCI_QUIRK_BROKEN_EXT_CREATE_CONN, \
1964 &(dev)->quirks))
1966 /* Periodic advertising support */
1967 #define per_adv_capable(dev) (((dev)->le_features[1] & HCI_LE_PERIODIC_ADV))
1969 /* CIS Master/Slave and BIS support */
1970 #define iso_capable(dev) (cis_capable(dev) || bis_capable(dev))
1971 #define cis_capable(dev) \
1972 (cis_central_capable(dev) || cis_peripheral_capable(dev))
1973 #define cis_central_capable(dev) \
1974 ((dev)->le_features[3] & HCI_LE_CIS_CENTRAL)
1975 #define cis_peripheral_capable(dev) \
1976 ((dev)->le_features[3] & HCI_LE_CIS_PERIPHERAL)
1977 #define bis_capable(dev) ((dev)->le_features[3] & HCI_LE_ISO_BROADCASTER)
1978 #define sync_recv_capable(dev) ((dev)->le_features[3] & HCI_LE_ISO_SYNC_RECEIVER)
1980 #define mws_transport_config_capable(dev) (((dev)->commands[30] & 0x08) && \
1981 (!test_bit(HCI_QUIRK_BROKEN_MWS_TRANSPORT_CONFIG, &(dev)->quirks)))
1983 /* ----- HCI protocols ----- */
1984 #define HCI_PROTO_DEFER 0x01
1986 static inline int hci_proto_connect_ind(struct hci_dev *hdev, bdaddr_t *bdaddr,
1987 __u8 type, __u8 *flags)
1989 switch (type) {
1990 case ACL_LINK:
1991 return l2cap_connect_ind(hdev, bdaddr);
1993 case SCO_LINK:
1994 case ESCO_LINK:
1995 return sco_connect_ind(hdev, bdaddr, flags);
1997 case ISO_LINK:
1998 return iso_connect_ind(hdev, bdaddr, flags);
2000 default:
2001 BT_ERR("unknown link type %d", type);
2002 return -EINVAL;
2006 static inline int hci_proto_disconn_ind(struct hci_conn *conn)
2008 if (conn->type != ACL_LINK && conn->type != LE_LINK)
2009 return HCI_ERROR_REMOTE_USER_TERM;
2011 return l2cap_disconn_ind(conn);
2014 /* ----- HCI callbacks ----- */
2015 struct hci_cb {
2016 struct list_head list;
2018 char *name;
2020 void (*connect_cfm) (struct hci_conn *conn, __u8 status);
2021 void (*disconn_cfm) (struct hci_conn *conn, __u8 status);
2022 void (*security_cfm) (struct hci_conn *conn, __u8 status,
2023 __u8 encrypt);
2024 void (*key_change_cfm) (struct hci_conn *conn, __u8 status);
2025 void (*role_switch_cfm) (struct hci_conn *conn, __u8 status, __u8 role);
2028 static inline void hci_connect_cfm(struct hci_conn *conn, __u8 status)
2030 struct hci_cb *cb;
2032 mutex_lock(&hci_cb_list_lock);
2033 list_for_each_entry(cb, &hci_cb_list, list) {
2034 if (cb->connect_cfm)
2035 cb->connect_cfm(conn, status);
2037 mutex_unlock(&hci_cb_list_lock);
2039 if (conn->connect_cfm_cb)
2040 conn->connect_cfm_cb(conn, status);
2043 static inline void hci_disconn_cfm(struct hci_conn *conn, __u8 reason)
2045 struct hci_cb *cb;
2047 mutex_lock(&hci_cb_list_lock);
2048 list_for_each_entry(cb, &hci_cb_list, list) {
2049 if (cb->disconn_cfm)
2050 cb->disconn_cfm(conn, reason);
2052 mutex_unlock(&hci_cb_list_lock);
2054 if (conn->disconn_cfm_cb)
2055 conn->disconn_cfm_cb(conn, reason);
2058 static inline void hci_auth_cfm(struct hci_conn *conn, __u8 status)
2060 struct hci_cb *cb;
2061 __u8 encrypt;
2063 if (test_bit(HCI_CONN_ENCRYPT_PEND, &conn->flags))
2064 return;
2066 encrypt = test_bit(HCI_CONN_ENCRYPT, &conn->flags) ? 0x01 : 0x00;
2068 mutex_lock(&hci_cb_list_lock);
2069 list_for_each_entry(cb, &hci_cb_list, list) {
2070 if (cb->security_cfm)
2071 cb->security_cfm(conn, status, encrypt);
2073 mutex_unlock(&hci_cb_list_lock);
2075 if (conn->security_cfm_cb)
2076 conn->security_cfm_cb(conn, status);
2079 static inline void hci_encrypt_cfm(struct hci_conn *conn, __u8 status)
2081 struct hci_cb *cb;
2082 __u8 encrypt;
2084 if (conn->state == BT_CONFIG) {
2085 if (!status)
2086 conn->state = BT_CONNECTED;
2088 hci_connect_cfm(conn, status);
2089 hci_conn_drop(conn);
2090 return;
2093 if (!test_bit(HCI_CONN_ENCRYPT, &conn->flags))
2094 encrypt = 0x00;
2095 else if (test_bit(HCI_CONN_AES_CCM, &conn->flags))
2096 encrypt = 0x02;
2097 else
2098 encrypt = 0x01;
2100 if (!status) {
2101 if (conn->sec_level == BT_SECURITY_SDP)
2102 conn->sec_level = BT_SECURITY_LOW;
2104 if (conn->pending_sec_level > conn->sec_level)
2105 conn->sec_level = conn->pending_sec_level;
2108 mutex_lock(&hci_cb_list_lock);
2109 list_for_each_entry(cb, &hci_cb_list, list) {
2110 if (cb->security_cfm)
2111 cb->security_cfm(conn, status, encrypt);
2113 mutex_unlock(&hci_cb_list_lock);
2115 if (conn->security_cfm_cb)
2116 conn->security_cfm_cb(conn, status);
2119 static inline void hci_key_change_cfm(struct hci_conn *conn, __u8 status)
2121 struct hci_cb *cb;
2123 mutex_lock(&hci_cb_list_lock);
2124 list_for_each_entry(cb, &hci_cb_list, list) {
2125 if (cb->key_change_cfm)
2126 cb->key_change_cfm(conn, status);
2128 mutex_unlock(&hci_cb_list_lock);
2131 static inline void hci_role_switch_cfm(struct hci_conn *conn, __u8 status,
2132 __u8 role)
2134 struct hci_cb *cb;
2136 mutex_lock(&hci_cb_list_lock);
2137 list_for_each_entry(cb, &hci_cb_list, list) {
2138 if (cb->role_switch_cfm)
2139 cb->role_switch_cfm(conn, status, role);
2141 mutex_unlock(&hci_cb_list_lock);
2144 static inline bool hci_bdaddr_is_rpa(bdaddr_t *bdaddr, u8 addr_type)
2146 if (addr_type != ADDR_LE_DEV_RANDOM)
2147 return false;
2149 if ((bdaddr->b[5] & 0xc0) == 0x40)
2150 return true;
2152 return false;
2155 static inline bool hci_is_identity_address(bdaddr_t *addr, u8 addr_type)
2157 if (addr_type == ADDR_LE_DEV_PUBLIC)
2158 return true;
2160 /* Check for Random Static address type */
2161 if ((addr->b[5] & 0xc0) == 0xc0)
2162 return true;
2164 return false;
2167 static inline struct smp_irk *hci_get_irk(struct hci_dev *hdev,
2168 bdaddr_t *bdaddr, u8 addr_type)
2170 if (!hci_bdaddr_is_rpa(bdaddr, addr_type))
2171 return NULL;
2173 return hci_find_irk_by_rpa(hdev, bdaddr);
2176 static inline int hci_check_conn_params(u16 min, u16 max, u16 latency,
2177 u16 to_multiplier)
2179 u16 max_latency;
2181 if (min > max) {
2182 BT_WARN("min %d > max %d", min, max);
2183 return -EINVAL;
2186 if (min < 6) {
2187 BT_WARN("min %d < 6", min);
2188 return -EINVAL;
2191 if (max > 3200) {
2192 BT_WARN("max %d > 3200", max);
2193 return -EINVAL;
2196 if (to_multiplier < 10) {
2197 BT_WARN("to_multiplier %d < 10", to_multiplier);
2198 return -EINVAL;
2201 if (to_multiplier > 3200) {
2202 BT_WARN("to_multiplier %d > 3200", to_multiplier);
2203 return -EINVAL;
2206 if (max >= to_multiplier * 8) {
2207 BT_WARN("max %d >= to_multiplier %d * 8", max, to_multiplier);
2208 return -EINVAL;
2211 max_latency = (to_multiplier * 4 / max) - 1;
2212 if (latency > 499) {
2213 BT_WARN("latency %d > 499", latency);
2214 return -EINVAL;
2217 if (latency > max_latency) {
2218 BT_WARN("latency %d > max_latency %d", latency, max_latency);
2219 return -EINVAL;
2222 return 0;
2225 int hci_register_cb(struct hci_cb *hcb);
2226 int hci_unregister_cb(struct hci_cb *hcb);
2228 int __hci_cmd_send(struct hci_dev *hdev, u16 opcode, u32 plen,
2229 const void *param);
2231 int hci_send_cmd(struct hci_dev *hdev, __u16 opcode, __u32 plen,
2232 const void *param);
2233 void hci_send_acl(struct hci_chan *chan, struct sk_buff *skb, __u16 flags);
2234 void hci_send_sco(struct hci_conn *conn, struct sk_buff *skb);
2235 void hci_send_iso(struct hci_conn *conn, struct sk_buff *skb);
2237 void *hci_sent_cmd_data(struct hci_dev *hdev, __u16 opcode);
2238 void *hci_recv_event_data(struct hci_dev *hdev, __u8 event);
2240 u32 hci_conn_get_phy(struct hci_conn *conn);
2242 /* ----- HCI Sockets ----- */
2243 void hci_send_to_sock(struct hci_dev *hdev, struct sk_buff *skb);
2244 void hci_send_to_channel(unsigned short channel, struct sk_buff *skb,
2245 int flag, struct sock *skip_sk);
2246 void hci_send_to_monitor(struct hci_dev *hdev, struct sk_buff *skb);
2247 void hci_send_monitor_ctrl_event(struct hci_dev *hdev, u16 event,
2248 void *data, u16 data_len, ktime_t tstamp,
2249 int flag, struct sock *skip_sk);
2251 void hci_sock_dev_event(struct hci_dev *hdev, int event);
2253 #define HCI_MGMT_VAR_LEN BIT(0)
2254 #define HCI_MGMT_NO_HDEV BIT(1)
2255 #define HCI_MGMT_UNTRUSTED BIT(2)
2256 #define HCI_MGMT_UNCONFIGURED BIT(3)
2257 #define HCI_MGMT_HDEV_OPTIONAL BIT(4)
2259 struct hci_mgmt_handler {
2260 int (*func) (struct sock *sk, struct hci_dev *hdev, void *data,
2261 u16 data_len);
2262 size_t data_len;
2263 unsigned long flags;
2266 struct hci_mgmt_chan {
2267 struct list_head list;
2268 unsigned short channel;
2269 size_t handler_count;
2270 const struct hci_mgmt_handler *handlers;
2271 void (*hdev_init) (struct sock *sk, struct hci_dev *hdev);
2274 int hci_mgmt_chan_register(struct hci_mgmt_chan *c);
2275 void hci_mgmt_chan_unregister(struct hci_mgmt_chan *c);
2277 /* Management interface */
2278 #define DISCOV_TYPE_BREDR (BIT(BDADDR_BREDR))
2279 #define DISCOV_TYPE_LE (BIT(BDADDR_LE_PUBLIC) | \
2280 BIT(BDADDR_LE_RANDOM))
2281 #define DISCOV_TYPE_INTERLEAVED (BIT(BDADDR_BREDR) | \
2282 BIT(BDADDR_LE_PUBLIC) | \
2283 BIT(BDADDR_LE_RANDOM))
2285 /* These LE scan and inquiry parameters were chosen according to LE General
2286 * Discovery Procedure specification.
2288 #define DISCOV_LE_SCAN_WIN 0x0012 /* 11.25 msec */
2289 #define DISCOV_LE_SCAN_INT 0x0012 /* 11.25 msec */
2290 #define DISCOV_LE_SCAN_INT_FAST 0x0060 /* 60 msec */
2291 #define DISCOV_LE_SCAN_WIN_FAST 0x0030 /* 30 msec */
2292 #define DISCOV_LE_SCAN_INT_CONN 0x0060 /* 60 msec */
2293 #define DISCOV_LE_SCAN_WIN_CONN 0x0060 /* 60 msec */
2294 #define DISCOV_LE_SCAN_INT_SLOW1 0x0800 /* 1.28 sec */
2295 #define DISCOV_LE_SCAN_WIN_SLOW1 0x0012 /* 11.25 msec */
2296 #define DISCOV_LE_SCAN_INT_SLOW2 0x1000 /* 2.56 sec */
2297 #define DISCOV_LE_SCAN_WIN_SLOW2 0x0024 /* 22.5 msec */
2298 #define DISCOV_CODED_SCAN_INT_FAST 0x0120 /* 180 msec */
2299 #define DISCOV_CODED_SCAN_WIN_FAST 0x0090 /* 90 msec */
2300 #define DISCOV_CODED_SCAN_INT_SLOW1 0x1800 /* 3.84 sec */
2301 #define DISCOV_CODED_SCAN_WIN_SLOW1 0x0036 /* 33.75 msec */
2302 #define DISCOV_CODED_SCAN_INT_SLOW2 0x3000 /* 7.68 sec */
2303 #define DISCOV_CODED_SCAN_WIN_SLOW2 0x006c /* 67.5 msec */
2304 #define DISCOV_LE_TIMEOUT 10240 /* msec */
2305 #define DISCOV_INTERLEAVED_TIMEOUT 5120 /* msec */
2306 #define DISCOV_INTERLEAVED_INQUIRY_LEN 0x04
2307 #define DISCOV_BREDR_INQUIRY_LEN 0x08
2308 #define DISCOV_LE_RESTART_DELAY msecs_to_jiffies(200) /* msec */
2309 #define DISCOV_LE_FAST_ADV_INT_MIN 0x00A0 /* 100 msec */
2310 #define DISCOV_LE_FAST_ADV_INT_MAX 0x00F0 /* 150 msec */
2311 #define DISCOV_LE_PER_ADV_INT_MIN 0x00A0 /* 200 msec */
2312 #define DISCOV_LE_PER_ADV_INT_MAX 0x00A0 /* 200 msec */
2313 #define DISCOV_LE_ADV_MESH_MIN 0x00A0 /* 100 msec */
2314 #define DISCOV_LE_ADV_MESH_MAX 0x00A0 /* 100 msec */
2315 #define INTERVAL_TO_MS(x) (((x) * 10) / 0x10)
2317 #define NAME_RESOLVE_DURATION msecs_to_jiffies(10240) /* 10.24 sec */
2319 void mgmt_fill_version_info(void *ver);
2320 int mgmt_new_settings(struct hci_dev *hdev);
2321 void mgmt_index_added(struct hci_dev *hdev);
2322 void mgmt_index_removed(struct hci_dev *hdev);
2323 void mgmt_set_powered_failed(struct hci_dev *hdev, int err);
2324 void mgmt_power_on(struct hci_dev *hdev, int err);
2325 void __mgmt_power_off(struct hci_dev *hdev);
2326 void mgmt_new_link_key(struct hci_dev *hdev, struct link_key *key,
2327 bool persistent);
2328 void mgmt_device_connected(struct hci_dev *hdev, struct hci_conn *conn,
2329 u8 *name, u8 name_len);
2330 void mgmt_device_disconnected(struct hci_dev *hdev, bdaddr_t *bdaddr,
2331 u8 link_type, u8 addr_type, u8 reason,
2332 bool mgmt_connected);
2333 void mgmt_disconnect_failed(struct hci_dev *hdev, bdaddr_t *bdaddr,
2334 u8 link_type, u8 addr_type, u8 status);
2335 void mgmt_connect_failed(struct hci_dev *hdev, struct hci_conn *conn,
2336 u8 status);
2337 void mgmt_pin_code_request(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 secure);
2338 void mgmt_pin_code_reply_complete(struct hci_dev *hdev, bdaddr_t *bdaddr,
2339 u8 status);
2340 void mgmt_pin_code_neg_reply_complete(struct hci_dev *hdev, bdaddr_t *bdaddr,
2341 u8 status);
2342 int mgmt_user_confirm_request(struct hci_dev *hdev, bdaddr_t *bdaddr,
2343 u8 link_type, u8 addr_type, u32 value,
2344 u8 confirm_hint);
2345 int mgmt_user_confirm_reply_complete(struct hci_dev *hdev, bdaddr_t *bdaddr,
2346 u8 link_type, u8 addr_type, u8 status);
2347 int mgmt_user_confirm_neg_reply_complete(struct hci_dev *hdev, bdaddr_t *bdaddr,
2348 u8 link_type, u8 addr_type, u8 status);
2349 int mgmt_user_passkey_request(struct hci_dev *hdev, bdaddr_t *bdaddr,
2350 u8 link_type, u8 addr_type);
2351 int mgmt_user_passkey_reply_complete(struct hci_dev *hdev, bdaddr_t *bdaddr,
2352 u8 link_type, u8 addr_type, u8 status);
2353 int mgmt_user_passkey_neg_reply_complete(struct hci_dev *hdev, bdaddr_t *bdaddr,
2354 u8 link_type, u8 addr_type, u8 status);
2355 int mgmt_user_passkey_notify(struct hci_dev *hdev, bdaddr_t *bdaddr,
2356 u8 link_type, u8 addr_type, u32 passkey,
2357 u8 entered);
2358 void mgmt_auth_failed(struct hci_conn *conn, u8 status);
2359 void mgmt_auth_enable_complete(struct hci_dev *hdev, u8 status);
2360 void mgmt_set_class_of_dev_complete(struct hci_dev *hdev, u8 *dev_class,
2361 u8 status);
2362 void mgmt_set_local_name_complete(struct hci_dev *hdev, u8 *name, u8 status);
2363 void mgmt_start_discovery_complete(struct hci_dev *hdev, u8 status);
2364 void mgmt_stop_discovery_complete(struct hci_dev *hdev, u8 status);
2365 void mgmt_device_found(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 link_type,
2366 u8 addr_type, u8 *dev_class, s8 rssi, u32 flags,
2367 u8 *eir, u16 eir_len, u8 *scan_rsp, u8 scan_rsp_len,
2368 u64 instant);
2369 void mgmt_remote_name(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 link_type,
2370 u8 addr_type, s8 rssi, u8 *name, u8 name_len);
2371 void mgmt_discovering(struct hci_dev *hdev, u8 discovering);
2372 void mgmt_suspending(struct hci_dev *hdev, u8 state);
2373 void mgmt_resuming(struct hci_dev *hdev, u8 reason, bdaddr_t *bdaddr,
2374 u8 addr_type);
2375 bool mgmt_powering_down(struct hci_dev *hdev);
2376 void mgmt_new_ltk(struct hci_dev *hdev, struct smp_ltk *key, bool persistent);
2377 void mgmt_new_irk(struct hci_dev *hdev, struct smp_irk *irk, bool persistent);
2378 void mgmt_new_csrk(struct hci_dev *hdev, struct smp_csrk *csrk,
2379 bool persistent);
2380 void mgmt_new_conn_param(struct hci_dev *hdev, bdaddr_t *bdaddr,
2381 u8 bdaddr_type, u8 store_hint, u16 min_interval,
2382 u16 max_interval, u16 latency, u16 timeout);
2383 void mgmt_smp_complete(struct hci_conn *conn, bool complete);
2384 bool mgmt_get_connectable(struct hci_dev *hdev);
2385 u8 mgmt_get_adv_discov_flags(struct hci_dev *hdev);
2386 void mgmt_advertising_added(struct sock *sk, struct hci_dev *hdev,
2387 u8 instance);
2388 void mgmt_advertising_removed(struct sock *sk, struct hci_dev *hdev,
2389 u8 instance);
2390 void mgmt_adv_monitor_removed(struct hci_dev *hdev, u16 handle);
2391 int mgmt_phy_configuration_changed(struct hci_dev *hdev, struct sock *skip);
2392 void mgmt_adv_monitor_device_lost(struct hci_dev *hdev, u16 handle,
2393 bdaddr_t *bdaddr, u8 addr_type);
2395 int hci_abort_conn(struct hci_conn *conn, u8 reason);
2396 u8 hci_le_conn_update(struct hci_conn *conn, u16 min, u16 max, u16 latency,
2397 u16 to_multiplier);
2398 void hci_le_start_enc(struct hci_conn *conn, __le16 ediv, __le64 rand,
2399 __u8 ltk[16], __u8 key_size);
2401 void hci_copy_identity_address(struct hci_dev *hdev, bdaddr_t *bdaddr,
2402 u8 *bdaddr_type);
2404 #define SCO_AIRMODE_MASK 0x0003
2405 #define SCO_AIRMODE_CVSD 0x0000
2406 #define SCO_AIRMODE_TRANSP 0x0003
2408 #define LOCAL_CODEC_ACL_MASK BIT(0)
2409 #define LOCAL_CODEC_SCO_MASK BIT(1)
2411 #define TRANSPORT_TYPE_MAX 0x04
2413 #endif /* __HCI_CORE_H */