xref: /openbmc/linux/include/net/bluetooth/hci_core.h (revision 7583028d)
1 /*
2    BlueZ - Bluetooth protocol stack for Linux
3    Copyright (c) 2000-2001, 2010, Code Aurora Forum. All rights reserved.
4    Copyright 2023 NXP
5 
6    Written 2000,2001 by Maxim Krasnyansky <maxk@qualcomm.com>
7 
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;
11 
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.
20 
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.
24 */
25 
26 #ifndef __HCI_CORE_H
27 #define __HCI_CORE_H
28 
29 #include <linux/idr.h>
30 #include <linux/leds.h>
31 #include <linux/rculist.h>
32 
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>
37 
38 /* HCI priority */
39 #define HCI_PRIO_MAX	7
40 
41 /* HCI maximum id value */
42 #define HCI_MAX_ID 10000
43 
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;
54 };
55 
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;
67 };
68 
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_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		scan_start;
95 	unsigned long		scan_duration;
96 	unsigned long		name_resolve_timeout;
97 };
98 
99 #define SUSPEND_NOTIFIER_TIMEOUT	msecs_to_jiffies(2000) /* 2 seconds */
100 
101 enum suspend_tasks {
102 	SUSPEND_PAUSE_DISCOVERY,
103 	SUSPEND_UNPAUSE_DISCOVERY,
104 
105 	SUSPEND_PAUSE_ADVERTISING,
106 	SUSPEND_UNPAUSE_ADVERTISING,
107 
108 	SUSPEND_SCAN_DISABLE,
109 	SUSPEND_SCAN_ENABLE,
110 	SUSPEND_DISCONNECTING,
111 
112 	SUSPEND_POWERING_DOWN,
113 
114 	SUSPEND_PREPARE_NOTIFIER,
115 
116 	SUSPEND_SET_ADV_FILTER,
117 	__SUSPEND_NUM_TASKS
118 };
119 
120 enum suspended_state {
121 	BT_RUNNING = 0,
122 	BT_SUSPEND_DISCONNECT,
123 	BT_SUSPEND_CONFIGURE_WAKE,
124 };
125 
126 struct hci_conn_hash {
127 	struct list_head list;
128 	unsigned int     acl_num;
129 	unsigned int     amp_num;
130 	unsigned int     sco_num;
131 	unsigned int     iso_num;
132 	unsigned int     le_num;
133 	unsigned int     le_num_peripheral;
134 };
135 
136 struct bdaddr_list {
137 	struct list_head list;
138 	bdaddr_t bdaddr;
139 	u8 bdaddr_type;
140 };
141 
142 struct codec_list {
143 	struct list_head list;
144 	u8	id;
145 	__u16	cid;
146 	__u16	vid;
147 	u8	transport;
148 	u8	num_caps;
149 	u32	len;
150 	struct hci_codec_caps caps[];
151 };
152 
153 struct bdaddr_list_with_irk {
154 	struct list_head list;
155 	bdaddr_t bdaddr;
156 	u8 bdaddr_type;
157 	u8 peer_irk[16];
158 	u8 local_irk[16];
159 };
160 
161 /* Bitmask of connection flags */
162 enum hci_conn_flags {
163 	HCI_CONN_FLAG_REMOTE_WAKEUP = 1,
164 	HCI_CONN_FLAG_DEVICE_PRIVACY = 2,
165 };
166 typedef u8 hci_conn_flags_t;
167 
168 struct bdaddr_list_with_flags {
169 	struct list_head list;
170 	bdaddr_t bdaddr;
171 	u8 bdaddr_type;
172 	hci_conn_flags_t flags;
173 };
174 
175 struct bt_uuid {
176 	struct list_head list;
177 	u8 uuid[16];
178 	u8 size;
179 	u8 svc_hint;
180 };
181 
182 struct blocked_key {
183 	struct list_head list;
184 	struct rcu_head rcu;
185 	u8 type;
186 	u8 val[16];
187 };
188 
189 struct smp_csrk {
190 	bdaddr_t bdaddr;
191 	u8 bdaddr_type;
192 	u8 type;
193 	u8 val[16];
194 };
195 
196 struct smp_ltk {
197 	struct list_head list;
198 	struct rcu_head rcu;
199 	bdaddr_t bdaddr;
200 	u8 bdaddr_type;
201 	u8 authenticated;
202 	u8 type;
203 	u8 enc_size;
204 	__le16 ediv;
205 	__le64 rand;
206 	u8 val[16];
207 };
208 
209 struct smp_irk {
210 	struct list_head list;
211 	struct rcu_head rcu;
212 	bdaddr_t rpa;
213 	bdaddr_t bdaddr;
214 	u8 addr_type;
215 	u8 val[16];
216 };
217 
218 struct link_key {
219 	struct list_head list;
220 	struct rcu_head rcu;
221 	bdaddr_t bdaddr;
222 	u8 type;
223 	u8 val[HCI_LINK_KEY_SIZE];
224 	u8 pin_len;
225 };
226 
227 struct oob_data {
228 	struct list_head list;
229 	bdaddr_t bdaddr;
230 	u8 bdaddr_type;
231 	u8 present;
232 	u8 hash192[16];
233 	u8 rand192[16];
234 	u8 hash256[16];
235 	u8 rand256[16];
236 };
237 
238 struct adv_info {
239 	struct list_head list;
240 	bool	enabled;
241 	bool	pending;
242 	bool	periodic;
243 	__u8	mesh;
244 	__u8	instance;
245 	__u32	flags;
246 	__u16	timeout;
247 	__u16	remaining_time;
248 	__u16	duration;
249 	__u16	adv_data_len;
250 	__u8	adv_data[HCI_MAX_EXT_AD_LENGTH];
251 	bool	adv_data_changed;
252 	__u16	scan_rsp_len;
253 	__u8	scan_rsp_data[HCI_MAX_EXT_AD_LENGTH];
254 	bool	scan_rsp_changed;
255 	__u16	per_adv_data_len;
256 	__u8	per_adv_data[HCI_MAX_PER_AD_LENGTH];
257 	__s8	tx_power;
258 	__u32   min_interval;
259 	__u32   max_interval;
260 	bdaddr_t	random_addr;
261 	bool 		rpa_expired;
262 	struct delayed_work	rpa_expired_cb;
263 };
264 
265 #define HCI_MAX_ADV_INSTANCES		5
266 #define HCI_DEFAULT_ADV_DURATION	2
267 
268 #define HCI_ADV_TX_POWER_NO_PREFERENCE 0x7F
269 
270 #define DATA_CMP(_d1, _l1, _d2, _l2) \
271 	(_l1 == _l2 ? memcmp(_d1, _d2, _l1) : _l1 - _l2)
272 
273 #define ADV_DATA_CMP(_adv, _data, _len) \
274 	DATA_CMP((_adv)->adv_data, (_adv)->adv_data_len, _data, _len)
275 
276 #define SCAN_RSP_CMP(_adv, _data, _len) \
277 	DATA_CMP((_adv)->scan_rsp_data, (_adv)->scan_rsp_len, _data, _len)
278 
279 struct monitored_device {
280 	struct list_head list;
281 
282 	bdaddr_t bdaddr;
283 	__u8     addr_type;
284 	__u16    handle;
285 	bool     notified;
286 };
287 
288 struct adv_pattern {
289 	struct list_head list;
290 	__u8 ad_type;
291 	__u8 offset;
292 	__u8 length;
293 	__u8 value[HCI_MAX_AD_LENGTH];
294 };
295 
296 struct adv_rssi_thresholds {
297 	__s8 low_threshold;
298 	__s8 high_threshold;
299 	__u16 low_threshold_timeout;
300 	__u16 high_threshold_timeout;
301 	__u8 sampling_period;
302 };
303 
304 struct adv_monitor {
305 	struct list_head patterns;
306 	struct adv_rssi_thresholds rssi;
307 	__u16		handle;
308 
309 	enum {
310 		ADV_MONITOR_STATE_NOT_REGISTERED,
311 		ADV_MONITOR_STATE_REGISTERED,
312 		ADV_MONITOR_STATE_OFFLOADED
313 	} state;
314 };
315 
316 #define HCI_MIN_ADV_MONITOR_HANDLE		1
317 #define HCI_MAX_ADV_MONITOR_NUM_HANDLES		32
318 #define HCI_MAX_ADV_MONITOR_NUM_PATTERNS	16
319 #define HCI_ADV_MONITOR_EXT_NONE		1
320 #define HCI_ADV_MONITOR_EXT_MSFT		2
321 
322 #define HCI_MAX_SHORT_NAME_LENGTH	10
323 
324 #define HCI_CONN_HANDLE_UNSET		0xffff
325 #define HCI_CONN_HANDLE_MAX		0x0eff
326 
327 /* Min encryption key size to match with SMP */
328 #define HCI_MIN_ENC_KEY_SIZE		7
329 
330 /* Default LE RPA expiry time, 15 minutes */
331 #define HCI_DEFAULT_RPA_TIMEOUT		(15 * 60)
332 
333 /* Default min/max age of connection information (1s/3s) */
334 #define DEFAULT_CONN_INFO_MIN_AGE	1000
335 #define DEFAULT_CONN_INFO_MAX_AGE	3000
336 /* Default authenticated payload timeout 30s */
337 #define DEFAULT_AUTH_PAYLOAD_TIMEOUT   0x0bb8
338 
339 struct amp_assoc {
340 	__u16	len;
341 	__u16	offset;
342 	__u16	rem_len;
343 	__u16	len_so_far;
344 	__u8	data[HCI_MAX_AMP_ASSOC_SIZE];
345 };
346 
347 #define HCI_MAX_PAGES	3
348 
349 struct hci_dev {
350 	struct list_head list;
351 	struct mutex	lock;
352 
353 	char		name[8];
354 	unsigned long	flags;
355 	__u16		id;
356 	__u8		bus;
357 	__u8		dev_type;
358 	bdaddr_t	bdaddr;
359 	bdaddr_t	setup_addr;
360 	bdaddr_t	public_addr;
361 	bdaddr_t	random_addr;
362 	bdaddr_t	static_addr;
363 	__u8		adv_addr_type;
364 	__u8		dev_name[HCI_MAX_NAME_LENGTH];
365 	__u8		short_name[HCI_MAX_SHORT_NAME_LENGTH];
366 	__u8		eir[HCI_MAX_EIR_LENGTH];
367 	__u16		appearance;
368 	__u8		dev_class[3];
369 	__u8		major_class;
370 	__u8		minor_class;
371 	__u8		max_page;
372 	__u8		features[HCI_MAX_PAGES][8];
373 	__u8		le_features[8];
374 	__u8		le_accept_list_size;
375 	__u8		le_resolv_list_size;
376 	__u8		le_num_of_adv_sets;
377 	__u8		le_states[8];
378 	__u8		mesh_ad_types[16];
379 	__u8		mesh_send_ref;
380 	__u8		commands[64];
381 	__u8		hci_ver;
382 	__u16		hci_rev;
383 	__u8		lmp_ver;
384 	__u16		manufacturer;
385 	__u16		lmp_subver;
386 	__u16		voice_setting;
387 	__u8		num_iac;
388 	__u16		stored_max_keys;
389 	__u16		stored_num_keys;
390 	__u8		io_capability;
391 	__s8		inq_tx_power;
392 	__u8		err_data_reporting;
393 	__u16		page_scan_interval;
394 	__u16		page_scan_window;
395 	__u8		page_scan_type;
396 	__u8		le_adv_channel_map;
397 	__u16		le_adv_min_interval;
398 	__u16		le_adv_max_interval;
399 	__u8		le_scan_type;
400 	__u16		le_scan_interval;
401 	__u16		le_scan_window;
402 	__u16		le_scan_int_suspend;
403 	__u16		le_scan_window_suspend;
404 	__u16		le_scan_int_discovery;
405 	__u16		le_scan_window_discovery;
406 	__u16		le_scan_int_adv_monitor;
407 	__u16		le_scan_window_adv_monitor;
408 	__u16		le_scan_int_connect;
409 	__u16		le_scan_window_connect;
410 	__u16		le_conn_min_interval;
411 	__u16		le_conn_max_interval;
412 	__u16		le_conn_latency;
413 	__u16		le_supv_timeout;
414 	__u16		le_def_tx_len;
415 	__u16		le_def_tx_time;
416 	__u16		le_max_tx_len;
417 	__u16		le_max_tx_time;
418 	__u16		le_max_rx_len;
419 	__u16		le_max_rx_time;
420 	__u8		le_max_key_size;
421 	__u8		le_min_key_size;
422 	__u16		discov_interleaved_timeout;
423 	__u16		conn_info_min_age;
424 	__u16		conn_info_max_age;
425 	__u16		auth_payload_timeout;
426 	__u8		min_enc_key_size;
427 	__u8		max_enc_key_size;
428 	__u8		pairing_opts;
429 	__u8		ssp_debug_mode;
430 	__u8		hw_error_code;
431 	__u32		clock;
432 	__u16		advmon_allowlist_duration;
433 	__u16		advmon_no_filter_duration;
434 	__u8		enable_advmon_interleave_scan;
435 
436 	__u16		devid_source;
437 	__u16		devid_vendor;
438 	__u16		devid_product;
439 	__u16		devid_version;
440 
441 	__u8		def_page_scan_type;
442 	__u16		def_page_scan_int;
443 	__u16		def_page_scan_window;
444 	__u8		def_inq_scan_type;
445 	__u16		def_inq_scan_int;
446 	__u16		def_inq_scan_window;
447 	__u16		def_br_lsto;
448 	__u16		def_page_timeout;
449 	__u16		def_multi_adv_rotation_duration;
450 	__u16		def_le_autoconnect_timeout;
451 	__s8		min_le_tx_power;
452 	__s8		max_le_tx_power;
453 
454 	__u16		pkt_type;
455 	__u16		esco_type;
456 	__u16		link_policy;
457 	__u16		link_mode;
458 
459 	__u32		idle_timeout;
460 	__u16		sniff_min_interval;
461 	__u16		sniff_max_interval;
462 
463 	__u8		amp_status;
464 	__u32		amp_total_bw;
465 	__u32		amp_max_bw;
466 	__u32		amp_min_latency;
467 	__u32		amp_max_pdu;
468 	__u8		amp_type;
469 	__u16		amp_pal_cap;
470 	__u16		amp_assoc_size;
471 	__u32		amp_max_flush_to;
472 	__u32		amp_be_flush_to;
473 
474 	struct amp_assoc	loc_assoc;
475 
476 	__u8		flow_ctl_mode;
477 
478 	unsigned int	auto_accept_delay;
479 
480 	unsigned long	quirks;
481 
482 	atomic_t	cmd_cnt;
483 	unsigned int	acl_cnt;
484 	unsigned int	sco_cnt;
485 	unsigned int	le_cnt;
486 	unsigned int	iso_cnt;
487 
488 	unsigned int	acl_mtu;
489 	unsigned int	sco_mtu;
490 	unsigned int	le_mtu;
491 	unsigned int	iso_mtu;
492 	unsigned int	acl_pkts;
493 	unsigned int	sco_pkts;
494 	unsigned int	le_pkts;
495 	unsigned int	iso_pkts;
496 
497 	__u16		block_len;
498 	__u16		block_mtu;
499 	__u16		num_blocks;
500 	__u16		block_cnt;
501 
502 	unsigned long	acl_last_tx;
503 	unsigned long	sco_last_tx;
504 	unsigned long	le_last_tx;
505 
506 	__u8		le_tx_def_phys;
507 	__u8		le_rx_def_phys;
508 
509 	struct workqueue_struct	*workqueue;
510 	struct workqueue_struct	*req_workqueue;
511 
512 	struct work_struct	power_on;
513 	struct delayed_work	power_off;
514 	struct work_struct	error_reset;
515 	struct work_struct	cmd_sync_work;
516 	struct list_head	cmd_sync_work_list;
517 	struct mutex		cmd_sync_work_lock;
518 	struct mutex		unregister_lock;
519 	struct work_struct	cmd_sync_cancel_work;
520 	struct work_struct	reenable_adv_work;
521 
522 	__u16			discov_timeout;
523 	struct delayed_work	discov_off;
524 
525 	struct delayed_work	service_cache;
526 
527 	struct delayed_work	cmd_timer;
528 	struct delayed_work	ncmd_timer;
529 
530 	struct work_struct	rx_work;
531 	struct work_struct	cmd_work;
532 	struct work_struct	tx_work;
533 
534 	struct delayed_work	le_scan_disable;
535 	struct delayed_work	le_scan_restart;
536 
537 	struct sk_buff_head	rx_q;
538 	struct sk_buff_head	raw_q;
539 	struct sk_buff_head	cmd_q;
540 
541 	struct sk_buff		*sent_cmd;
542 	struct sk_buff		*recv_event;
543 
544 	struct mutex		req_lock;
545 	wait_queue_head_t	req_wait_q;
546 	__u32			req_status;
547 	__u32			req_result;
548 	struct sk_buff		*req_skb;
549 
550 	void			*smp_data;
551 	void			*smp_bredr_data;
552 
553 	struct discovery_state	discovery;
554 
555 	int			discovery_old_state;
556 	bool			discovery_paused;
557 	int			advertising_old_state;
558 	bool			advertising_paused;
559 
560 	struct notifier_block	suspend_notifier;
561 	enum suspended_state	suspend_state_next;
562 	enum suspended_state	suspend_state;
563 	bool			scanning_paused;
564 	bool			suspended;
565 	u8			wake_reason;
566 	bdaddr_t		wake_addr;
567 	u8			wake_addr_type;
568 
569 	struct hci_conn_hash	conn_hash;
570 
571 	struct list_head	mesh_pending;
572 	struct list_head	mgmt_pending;
573 	struct list_head	reject_list;
574 	struct list_head	accept_list;
575 	struct list_head	uuids;
576 	struct list_head	link_keys;
577 	struct list_head	long_term_keys;
578 	struct list_head	identity_resolving_keys;
579 	struct list_head	remote_oob_data;
580 	struct list_head	le_accept_list;
581 	struct list_head	le_resolv_list;
582 	struct list_head	le_conn_params;
583 	struct list_head	pend_le_conns;
584 	struct list_head	pend_le_reports;
585 	struct list_head	blocked_keys;
586 	struct list_head	local_codecs;
587 
588 	struct hci_dev_stats	stat;
589 
590 	atomic_t		promisc;
591 
592 	const char		*hw_info;
593 	const char		*fw_info;
594 	struct dentry		*debugfs;
595 
596 #ifdef CONFIG_DEV_COREDUMP
597 	struct hci_devcoredump	dump;
598 #endif
599 
600 	struct device		dev;
601 
602 	struct rfkill		*rfkill;
603 
604 	DECLARE_BITMAP(dev_flags, __HCI_NUM_FLAGS);
605 	hci_conn_flags_t	conn_flags;
606 
607 	__s8			adv_tx_power;
608 	__u8			adv_data[HCI_MAX_EXT_AD_LENGTH];
609 	__u8			adv_data_len;
610 	__u8			scan_rsp_data[HCI_MAX_EXT_AD_LENGTH];
611 	__u8			scan_rsp_data_len;
612 	__u8			per_adv_data[HCI_MAX_PER_AD_LENGTH];
613 	__u8			per_adv_data_len;
614 
615 	struct list_head	adv_instances;
616 	unsigned int		adv_instance_cnt;
617 	__u8			cur_adv_instance;
618 	__u16			adv_instance_timeout;
619 	struct delayed_work	adv_instance_expire;
620 
621 	struct idr		adv_monitors_idr;
622 	unsigned int		adv_monitors_cnt;
623 
624 	__u8			irk[16];
625 	__u32			rpa_timeout;
626 	struct delayed_work	rpa_expired;
627 	bdaddr_t		rpa;
628 
629 	struct delayed_work	mesh_send_done;
630 
631 	enum {
632 		INTERLEAVE_SCAN_NONE,
633 		INTERLEAVE_SCAN_NO_FILTER,
634 		INTERLEAVE_SCAN_ALLOWLIST
635 	} interleave_scan_state;
636 
637 	struct delayed_work	interleave_scan;
638 
639 	struct list_head	monitored_devices;
640 	bool			advmon_pend_notify;
641 
642 #if IS_ENABLED(CONFIG_BT_LEDS)
643 	struct led_trigger	*power_led;
644 #endif
645 
646 #if IS_ENABLED(CONFIG_BT_MSFTEXT)
647 	__u16			msft_opcode;
648 	void			*msft_data;
649 	bool			msft_curve_validity;
650 #endif
651 
652 #if IS_ENABLED(CONFIG_BT_AOSPEXT)
653 	bool			aosp_capable;
654 	bool			aosp_quality_report;
655 #endif
656 
657 	int (*open)(struct hci_dev *hdev);
658 	int (*close)(struct hci_dev *hdev);
659 	int (*flush)(struct hci_dev *hdev);
660 	int (*setup)(struct hci_dev *hdev);
661 	int (*shutdown)(struct hci_dev *hdev);
662 	int (*send)(struct hci_dev *hdev, struct sk_buff *skb);
663 	void (*notify)(struct hci_dev *hdev, unsigned int evt);
664 	void (*hw_error)(struct hci_dev *hdev, u8 code);
665 	int (*post_init)(struct hci_dev *hdev);
666 	int (*set_diag)(struct hci_dev *hdev, bool enable);
667 	int (*set_bdaddr)(struct hci_dev *hdev, const bdaddr_t *bdaddr);
668 	void (*cmd_timeout)(struct hci_dev *hdev);
669 	void (*reset)(struct hci_dev *hdev);
670 	bool (*wakeup)(struct hci_dev *hdev);
671 	int (*set_quality_report)(struct hci_dev *hdev, bool enable);
672 	int (*get_data_path_id)(struct hci_dev *hdev, __u8 *data_path);
673 	int (*get_codec_config_data)(struct hci_dev *hdev, __u8 type,
674 				     struct bt_codec *codec, __u8 *vnd_len,
675 				     __u8 **vnd_data);
676 };
677 
678 #define HCI_PHY_HANDLE(handle)	(handle & 0xff)
679 
680 enum conn_reasons {
681 	CONN_REASON_PAIR_DEVICE,
682 	CONN_REASON_L2CAP_CHAN,
683 	CONN_REASON_SCO_CONNECT,
684 	CONN_REASON_ISO_CONNECT,
685 };
686 
687 struct hci_conn {
688 	struct list_head list;
689 
690 	atomic_t	refcnt;
691 
692 	bdaddr_t	dst;
693 	__u8		dst_type;
694 	bdaddr_t	src;
695 	__u8		src_type;
696 	bdaddr_t	init_addr;
697 	__u8		init_addr_type;
698 	bdaddr_t	resp_addr;
699 	__u8		resp_addr_type;
700 	__u8		adv_instance;
701 	__u16		handle;
702 	__u16		sync_handle;
703 	__u16		state;
704 	__u8		mode;
705 	__u8		type;
706 	__u8		role;
707 	bool		out;
708 	__u8		attempt;
709 	__u8		dev_class[3];
710 	__u8		features[HCI_MAX_PAGES][8];
711 	__u16		pkt_type;
712 	__u16		link_policy;
713 	__u8		key_type;
714 	__u8		auth_type;
715 	__u8		sec_level;
716 	__u8		pending_sec_level;
717 	__u8		pin_length;
718 	__u8		enc_key_size;
719 	__u8		io_capability;
720 	__u32		passkey_notify;
721 	__u8		passkey_entered;
722 	__u16		disc_timeout;
723 	__u16		conn_timeout;
724 	__u16		setting;
725 	__u16		auth_payload_timeout;
726 	__u16		le_conn_min_interval;
727 	__u16		le_conn_max_interval;
728 	__u16		le_conn_interval;
729 	__u16		le_conn_latency;
730 	__u16		le_supv_timeout;
731 	__u8		le_adv_data[HCI_MAX_AD_LENGTH];
732 	__u8		le_adv_data_len;
733 	__u8		le_per_adv_data[HCI_MAX_PER_AD_LENGTH];
734 	__u8		le_per_adv_data_len;
735 	__u8		le_tx_phy;
736 	__u8		le_rx_phy;
737 	__s8		rssi;
738 	__s8		tx_power;
739 	__s8		max_tx_power;
740 	struct bt_iso_qos iso_qos;
741 	unsigned long	flags;
742 
743 	enum conn_reasons conn_reason;
744 
745 	__u32		clock;
746 	__u16		clock_accuracy;
747 
748 	unsigned long	conn_info_timestamp;
749 
750 	__u8		remote_cap;
751 	__u8		remote_auth;
752 	__u8		remote_id;
753 
754 	unsigned int	sent;
755 
756 	struct sk_buff_head data_q;
757 	struct list_head chan_list;
758 
759 	struct delayed_work disc_work;
760 	struct delayed_work auto_accept_work;
761 	struct delayed_work idle_work;
762 	struct delayed_work le_conn_timeout;
763 	struct work_struct  le_scan_cleanup;
764 
765 	struct device	dev;
766 	struct dentry	*debugfs;
767 
768 	struct hci_dev	*hdev;
769 	void		*l2cap_data;
770 	void		*sco_data;
771 	void		*iso_data;
772 	struct amp_mgr	*amp_mgr;
773 
774 	struct list_head link_list;
775 	struct hci_conn	*parent;
776 	struct hci_link *link;
777 
778 	struct bt_codec codec;
779 
780 	void (*connect_cfm_cb)	(struct hci_conn *conn, u8 status);
781 	void (*security_cfm_cb)	(struct hci_conn *conn, u8 status);
782 	void (*disconn_cfm_cb)	(struct hci_conn *conn, u8 reason);
783 
784 	void (*cleanup)(struct hci_conn *conn);
785 };
786 
787 struct hci_link {
788 	struct list_head list;
789 	struct hci_conn *conn;
790 };
791 
792 struct hci_chan {
793 	struct list_head list;
794 	__u16 handle;
795 	struct hci_conn *conn;
796 	struct sk_buff_head data_q;
797 	unsigned int	sent;
798 	__u8		state;
799 	bool		amp;
800 };
801 
802 struct hci_conn_params {
803 	struct list_head list;
804 	struct list_head action;
805 
806 	bdaddr_t addr;
807 	u8 addr_type;
808 
809 	u16 conn_min_interval;
810 	u16 conn_max_interval;
811 	u16 conn_latency;
812 	u16 supervision_timeout;
813 
814 	enum {
815 		HCI_AUTO_CONN_DISABLED,
816 		HCI_AUTO_CONN_REPORT,
817 		HCI_AUTO_CONN_DIRECT,
818 		HCI_AUTO_CONN_ALWAYS,
819 		HCI_AUTO_CONN_LINK_LOSS,
820 		HCI_AUTO_CONN_EXPLICIT,
821 	} auto_connect;
822 
823 	struct hci_conn *conn;
824 	bool explicit_connect;
825 	hci_conn_flags_t flags;
826 	u8  privacy_mode;
827 };
828 
829 extern struct list_head hci_dev_list;
830 extern struct list_head hci_cb_list;
831 extern rwlock_t hci_dev_list_lock;
832 extern struct mutex hci_cb_list_lock;
833 
834 #define hci_dev_set_flag(hdev, nr)             set_bit((nr), (hdev)->dev_flags)
835 #define hci_dev_clear_flag(hdev, nr)           clear_bit((nr), (hdev)->dev_flags)
836 #define hci_dev_change_flag(hdev, nr)          change_bit((nr), (hdev)->dev_flags)
837 #define hci_dev_test_flag(hdev, nr)            test_bit((nr), (hdev)->dev_flags)
838 #define hci_dev_test_and_set_flag(hdev, nr)    test_and_set_bit((nr), (hdev)->dev_flags)
839 #define hci_dev_test_and_clear_flag(hdev, nr)  test_and_clear_bit((nr), (hdev)->dev_flags)
840 #define hci_dev_test_and_change_flag(hdev, nr) test_and_change_bit((nr), (hdev)->dev_flags)
841 
842 #define hci_dev_clear_volatile_flags(hdev)			\
843 	do {							\
844 		hci_dev_clear_flag(hdev, HCI_LE_SCAN);		\
845 		hci_dev_clear_flag(hdev, HCI_LE_ADV);		\
846 		hci_dev_clear_flag(hdev, HCI_LL_RPA_RESOLUTION);\
847 		hci_dev_clear_flag(hdev, HCI_PERIODIC_INQ);	\
848 		hci_dev_clear_flag(hdev, HCI_QUALITY_REPORT);	\
849 	} while (0)
850 
851 #define hci_dev_le_state_simultaneous(hdev) \
852 	(test_bit(HCI_QUIRK_VALID_LE_STATES, &hdev->quirks) && \
853 	 (hdev->le_states[4] & 0x08) &&	/* Central */ \
854 	 (hdev->le_states[4] & 0x40) &&	/* Peripheral */ \
855 	 (hdev->le_states[3] & 0x10))	/* Simultaneous */
856 
857 /* ----- HCI interface to upper protocols ----- */
858 int l2cap_connect_ind(struct hci_dev *hdev, bdaddr_t *bdaddr);
859 int l2cap_disconn_ind(struct hci_conn *hcon);
860 void l2cap_recv_acldata(struct hci_conn *hcon, struct sk_buff *skb, u16 flags);
861 
862 #if IS_ENABLED(CONFIG_BT_BREDR)
863 int sco_connect_ind(struct hci_dev *hdev, bdaddr_t *bdaddr, __u8 *flags);
864 void sco_recv_scodata(struct hci_conn *hcon, struct sk_buff *skb);
865 #else
866 static inline int sco_connect_ind(struct hci_dev *hdev, bdaddr_t *bdaddr,
867 				  __u8 *flags)
868 {
869 	return 0;
870 }
871 
872 static inline void sco_recv_scodata(struct hci_conn *hcon, struct sk_buff *skb)
873 {
874 }
875 #endif
876 
877 #if IS_ENABLED(CONFIG_BT_LE)
878 int iso_connect_ind(struct hci_dev *hdev, bdaddr_t *bdaddr, __u8 *flags);
879 void iso_recv(struct hci_conn *hcon, struct sk_buff *skb, u16 flags);
880 #else
881 static inline int iso_connect_ind(struct hci_dev *hdev, bdaddr_t *bdaddr,
882 				  __u8 *flags)
883 {
884 	return 0;
885 }
886 static inline void iso_recv(struct hci_conn *hcon, struct sk_buff *skb,
887 			    u16 flags)
888 {
889 }
890 #endif
891 
892 /* ----- Inquiry cache ----- */
893 #define INQUIRY_CACHE_AGE_MAX   (HZ*30)   /* 30 seconds */
894 #define INQUIRY_ENTRY_AGE_MAX   (HZ*60)   /* 60 seconds */
895 
896 static inline void discovery_init(struct hci_dev *hdev)
897 {
898 	hdev->discovery.state = DISCOVERY_STOPPED;
899 	INIT_LIST_HEAD(&hdev->discovery.all);
900 	INIT_LIST_HEAD(&hdev->discovery.unknown);
901 	INIT_LIST_HEAD(&hdev->discovery.resolve);
902 	hdev->discovery.report_invalid_rssi = true;
903 	hdev->discovery.rssi = HCI_RSSI_INVALID;
904 }
905 
906 static inline void hci_discovery_filter_clear(struct hci_dev *hdev)
907 {
908 	hdev->discovery.result_filtering = false;
909 	hdev->discovery.report_invalid_rssi = true;
910 	hdev->discovery.rssi = HCI_RSSI_INVALID;
911 	hdev->discovery.uuid_count = 0;
912 	kfree(hdev->discovery.uuids);
913 	hdev->discovery.uuids = NULL;
914 	hdev->discovery.scan_start = 0;
915 	hdev->discovery.scan_duration = 0;
916 }
917 
918 bool hci_discovery_active(struct hci_dev *hdev);
919 
920 void hci_discovery_set_state(struct hci_dev *hdev, int state);
921 
922 static inline int inquiry_cache_empty(struct hci_dev *hdev)
923 {
924 	return list_empty(&hdev->discovery.all);
925 }
926 
927 static inline long inquiry_cache_age(struct hci_dev *hdev)
928 {
929 	struct discovery_state *c = &hdev->discovery;
930 	return jiffies - c->timestamp;
931 }
932 
933 static inline long inquiry_entry_age(struct inquiry_entry *e)
934 {
935 	return jiffies - e->timestamp;
936 }
937 
938 struct inquiry_entry *hci_inquiry_cache_lookup(struct hci_dev *hdev,
939 					       bdaddr_t *bdaddr);
940 struct inquiry_entry *hci_inquiry_cache_lookup_unknown(struct hci_dev *hdev,
941 						       bdaddr_t *bdaddr);
942 struct inquiry_entry *hci_inquiry_cache_lookup_resolve(struct hci_dev *hdev,
943 						       bdaddr_t *bdaddr,
944 						       int state);
945 void hci_inquiry_cache_update_resolve(struct hci_dev *hdev,
946 				      struct inquiry_entry *ie);
947 u32 hci_inquiry_cache_update(struct hci_dev *hdev, struct inquiry_data *data,
948 			     bool name_known);
949 void hci_inquiry_cache_flush(struct hci_dev *hdev);
950 
951 /* ----- HCI Connections ----- */
952 enum {
953 	HCI_CONN_AUTH_PEND,
954 	HCI_CONN_REAUTH_PEND,
955 	HCI_CONN_ENCRYPT_PEND,
956 	HCI_CONN_RSWITCH_PEND,
957 	HCI_CONN_MODE_CHANGE_PEND,
958 	HCI_CONN_SCO_SETUP_PEND,
959 	HCI_CONN_MGMT_CONNECTED,
960 	HCI_CONN_SSP_ENABLED,
961 	HCI_CONN_SC_ENABLED,
962 	HCI_CONN_AES_CCM,
963 	HCI_CONN_POWER_SAVE,
964 	HCI_CONN_FLUSH_KEY,
965 	HCI_CONN_ENCRYPT,
966 	HCI_CONN_AUTH,
967 	HCI_CONN_SECURE,
968 	HCI_CONN_FIPS,
969 	HCI_CONN_STK_ENCRYPT,
970 	HCI_CONN_AUTH_INITIATOR,
971 	HCI_CONN_DROP,
972 	HCI_CONN_CANCEL,
973 	HCI_CONN_PARAM_REMOVAL_PEND,
974 	HCI_CONN_NEW_LINK_KEY,
975 	HCI_CONN_SCANNING,
976 	HCI_CONN_AUTH_FAILURE,
977 	HCI_CONN_PER_ADV,
978 };
979 
980 static inline bool hci_conn_ssp_enabled(struct hci_conn *conn)
981 {
982 	struct hci_dev *hdev = conn->hdev;
983 	return hci_dev_test_flag(hdev, HCI_SSP_ENABLED) &&
984 	       test_bit(HCI_CONN_SSP_ENABLED, &conn->flags);
985 }
986 
987 static inline bool hci_conn_sc_enabled(struct hci_conn *conn)
988 {
989 	struct hci_dev *hdev = conn->hdev;
990 	return hci_dev_test_flag(hdev, HCI_SC_ENABLED) &&
991 	       test_bit(HCI_CONN_SC_ENABLED, &conn->flags);
992 }
993 
994 static inline void hci_conn_hash_add(struct hci_dev *hdev, struct hci_conn *c)
995 {
996 	struct hci_conn_hash *h = &hdev->conn_hash;
997 	list_add_tail_rcu(&c->list, &h->list);
998 	switch (c->type) {
999 	case ACL_LINK:
1000 		h->acl_num++;
1001 		break;
1002 	case AMP_LINK:
1003 		h->amp_num++;
1004 		break;
1005 	case LE_LINK:
1006 		h->le_num++;
1007 		if (c->role == HCI_ROLE_SLAVE)
1008 			h->le_num_peripheral++;
1009 		break;
1010 	case SCO_LINK:
1011 	case ESCO_LINK:
1012 		h->sco_num++;
1013 		break;
1014 	case ISO_LINK:
1015 		h->iso_num++;
1016 		break;
1017 	}
1018 }
1019 
1020 static inline void hci_conn_hash_del(struct hci_dev *hdev, struct hci_conn *c)
1021 {
1022 	struct hci_conn_hash *h = &hdev->conn_hash;
1023 
1024 	list_del_rcu(&c->list);
1025 	synchronize_rcu();
1026 
1027 	switch (c->type) {
1028 	case ACL_LINK:
1029 		h->acl_num--;
1030 		break;
1031 	case AMP_LINK:
1032 		h->amp_num--;
1033 		break;
1034 	case LE_LINK:
1035 		h->le_num--;
1036 		if (c->role == HCI_ROLE_SLAVE)
1037 			h->le_num_peripheral--;
1038 		break;
1039 	case SCO_LINK:
1040 	case ESCO_LINK:
1041 		h->sco_num--;
1042 		break;
1043 	case ISO_LINK:
1044 		h->iso_num--;
1045 		break;
1046 	}
1047 }
1048 
1049 static inline unsigned int hci_conn_num(struct hci_dev *hdev, __u8 type)
1050 {
1051 	struct hci_conn_hash *h = &hdev->conn_hash;
1052 	switch (type) {
1053 	case ACL_LINK:
1054 		return h->acl_num;
1055 	case AMP_LINK:
1056 		return h->amp_num;
1057 	case LE_LINK:
1058 		return h->le_num;
1059 	case SCO_LINK:
1060 	case ESCO_LINK:
1061 		return h->sco_num;
1062 	case ISO_LINK:
1063 		return h->iso_num;
1064 	default:
1065 		return 0;
1066 	}
1067 }
1068 
1069 static inline unsigned int hci_conn_count(struct hci_dev *hdev)
1070 {
1071 	struct hci_conn_hash *c = &hdev->conn_hash;
1072 
1073 	return c->acl_num + c->amp_num + c->sco_num + c->le_num + c->iso_num;
1074 }
1075 
1076 static inline __u8 hci_conn_lookup_type(struct hci_dev *hdev, __u16 handle)
1077 {
1078 	struct hci_conn_hash *h = &hdev->conn_hash;
1079 	struct hci_conn *c;
1080 	__u8 type = INVALID_LINK;
1081 
1082 	rcu_read_lock();
1083 
1084 	list_for_each_entry_rcu(c, &h->list, list) {
1085 		if (c->handle == handle) {
1086 			type = c->type;
1087 			break;
1088 		}
1089 	}
1090 
1091 	rcu_read_unlock();
1092 
1093 	return type;
1094 }
1095 
1096 static inline struct hci_conn *hci_conn_hash_lookup_bis(struct hci_dev *hdev,
1097 							bdaddr_t *ba,
1098 							__u8 big, __u8 bis)
1099 {
1100 	struct hci_conn_hash *h = &hdev->conn_hash;
1101 	struct hci_conn  *c;
1102 
1103 	rcu_read_lock();
1104 
1105 	list_for_each_entry_rcu(c, &h->list, list) {
1106 		if (bacmp(&c->dst, ba) || c->type != ISO_LINK)
1107 			continue;
1108 
1109 		if (c->iso_qos.bcast.big == big && c->iso_qos.bcast.bis == bis) {
1110 			rcu_read_unlock();
1111 			return c;
1112 		}
1113 	}
1114 	rcu_read_unlock();
1115 
1116 	return NULL;
1117 }
1118 
1119 static inline struct hci_conn *hci_conn_hash_lookup_handle(struct hci_dev *hdev,
1120 								__u16 handle)
1121 {
1122 	struct hci_conn_hash *h = &hdev->conn_hash;
1123 	struct hci_conn  *c;
1124 
1125 	rcu_read_lock();
1126 
1127 	list_for_each_entry_rcu(c, &h->list, list) {
1128 		if (c->handle == handle) {
1129 			rcu_read_unlock();
1130 			return c;
1131 		}
1132 	}
1133 	rcu_read_unlock();
1134 
1135 	return NULL;
1136 }
1137 
1138 static inline struct hci_conn *hci_conn_hash_lookup_ba(struct hci_dev *hdev,
1139 							__u8 type, bdaddr_t *ba)
1140 {
1141 	struct hci_conn_hash *h = &hdev->conn_hash;
1142 	struct hci_conn  *c;
1143 
1144 	rcu_read_lock();
1145 
1146 	list_for_each_entry_rcu(c, &h->list, list) {
1147 		if (c->type == type && !bacmp(&c->dst, ba)) {
1148 			rcu_read_unlock();
1149 			return c;
1150 		}
1151 	}
1152 
1153 	rcu_read_unlock();
1154 
1155 	return NULL;
1156 }
1157 
1158 static inline struct hci_conn *hci_conn_hash_lookup_le(struct hci_dev *hdev,
1159 						       bdaddr_t *ba,
1160 						       __u8 ba_type)
1161 {
1162 	struct hci_conn_hash *h = &hdev->conn_hash;
1163 	struct hci_conn  *c;
1164 
1165 	rcu_read_lock();
1166 
1167 	list_for_each_entry_rcu(c, &h->list, list) {
1168 		if (c->type != LE_LINK)
1169 		       continue;
1170 
1171 		if (ba_type == c->dst_type && !bacmp(&c->dst, ba)) {
1172 			rcu_read_unlock();
1173 			return c;
1174 		}
1175 	}
1176 
1177 	rcu_read_unlock();
1178 
1179 	return NULL;
1180 }
1181 
1182 static inline struct hci_conn *hci_conn_hash_lookup_cis(struct hci_dev *hdev,
1183 							bdaddr_t *ba,
1184 							__u8 ba_type,
1185 							__u8 cig,
1186 							__u8 id)
1187 {
1188 	struct hci_conn_hash *h = &hdev->conn_hash;
1189 	struct hci_conn  *c;
1190 
1191 	rcu_read_lock();
1192 
1193 	list_for_each_entry_rcu(c, &h->list, list) {
1194 		if (c->type != ISO_LINK)
1195 			continue;
1196 
1197 		/* Match CIG ID if set */
1198 		if (cig != BT_ISO_QOS_CIG_UNSET && cig != c->iso_qos.ucast.cig)
1199 			continue;
1200 
1201 		/* Match CIS ID if set */
1202 		if (id != BT_ISO_QOS_CIS_UNSET && id != c->iso_qos.ucast.cis)
1203 			continue;
1204 
1205 		/* Match destination address if set */
1206 		if (!ba || (ba_type == c->dst_type && !bacmp(&c->dst, ba))) {
1207 			rcu_read_unlock();
1208 			return c;
1209 		}
1210 	}
1211 
1212 	rcu_read_unlock();
1213 
1214 	return NULL;
1215 }
1216 
1217 static inline struct hci_conn *hci_conn_hash_lookup_cig(struct hci_dev *hdev,
1218 							__u8 handle)
1219 {
1220 	struct hci_conn_hash *h = &hdev->conn_hash;
1221 	struct hci_conn  *c;
1222 
1223 	rcu_read_lock();
1224 
1225 	list_for_each_entry_rcu(c, &h->list, list) {
1226 		if (c->type != ISO_LINK)
1227 			continue;
1228 
1229 		if (handle == c->iso_qos.ucast.cig) {
1230 			rcu_read_unlock();
1231 			return c;
1232 		}
1233 	}
1234 
1235 	rcu_read_unlock();
1236 
1237 	return NULL;
1238 }
1239 
1240 static inline struct hci_conn *hci_conn_hash_lookup_big(struct hci_dev *hdev,
1241 							__u8 handle)
1242 {
1243 	struct hci_conn_hash *h = &hdev->conn_hash;
1244 	struct hci_conn  *c;
1245 
1246 	rcu_read_lock();
1247 
1248 	list_for_each_entry_rcu(c, &h->list, list) {
1249 		if (bacmp(&c->dst, BDADDR_ANY) || c->type != ISO_LINK)
1250 			continue;
1251 
1252 		if (handle == c->iso_qos.bcast.big) {
1253 			rcu_read_unlock();
1254 			return c;
1255 		}
1256 	}
1257 
1258 	rcu_read_unlock();
1259 
1260 	return NULL;
1261 }
1262 
1263 static inline struct hci_conn *hci_conn_hash_lookup_state(struct hci_dev *hdev,
1264 							__u8 type, __u16 state)
1265 {
1266 	struct hci_conn_hash *h = &hdev->conn_hash;
1267 	struct hci_conn  *c;
1268 
1269 	rcu_read_lock();
1270 
1271 	list_for_each_entry_rcu(c, &h->list, list) {
1272 		if (c->type == type && c->state == state) {
1273 			rcu_read_unlock();
1274 			return c;
1275 		}
1276 	}
1277 
1278 	rcu_read_unlock();
1279 
1280 	return NULL;
1281 }
1282 
1283 typedef void (*hci_conn_func_t)(struct hci_conn *conn, void *data);
1284 static inline void hci_conn_hash_list_state(struct hci_dev *hdev,
1285 					    hci_conn_func_t func, __u8 type,
1286 					    __u16 state, void *data)
1287 {
1288 	struct hci_conn_hash *h = &hdev->conn_hash;
1289 	struct hci_conn  *c;
1290 
1291 	if (!func)
1292 		return;
1293 
1294 	rcu_read_lock();
1295 
1296 	list_for_each_entry_rcu(c, &h->list, list) {
1297 		if (c->type == type && c->state == state)
1298 			func(c, data);
1299 	}
1300 
1301 	rcu_read_unlock();
1302 }
1303 
1304 static inline struct hci_conn *hci_lookup_le_connect(struct hci_dev *hdev)
1305 {
1306 	struct hci_conn_hash *h = &hdev->conn_hash;
1307 	struct hci_conn  *c;
1308 
1309 	rcu_read_lock();
1310 
1311 	list_for_each_entry_rcu(c, &h->list, list) {
1312 		if (c->type == LE_LINK && c->state == BT_CONNECT &&
1313 		    !test_bit(HCI_CONN_SCANNING, &c->flags)) {
1314 			rcu_read_unlock();
1315 			return c;
1316 		}
1317 	}
1318 
1319 	rcu_read_unlock();
1320 
1321 	return NULL;
1322 }
1323 
1324 int hci_disconnect(struct hci_conn *conn, __u8 reason);
1325 bool hci_setup_sync(struct hci_conn *conn, __u16 handle);
1326 void hci_sco_setup(struct hci_conn *conn, __u8 status);
1327 bool hci_iso_setup_path(struct hci_conn *conn);
1328 int hci_le_create_cis(struct hci_conn *conn);
1329 
1330 struct hci_conn *hci_conn_add(struct hci_dev *hdev, int type, bdaddr_t *dst,
1331 			      u8 role);
1332 void hci_conn_del(struct hci_conn *conn);
1333 void hci_conn_hash_flush(struct hci_dev *hdev);
1334 void hci_conn_check_pending(struct hci_dev *hdev);
1335 
1336 struct hci_chan *hci_chan_create(struct hci_conn *conn);
1337 void hci_chan_del(struct hci_chan *chan);
1338 void hci_chan_list_flush(struct hci_conn *conn);
1339 struct hci_chan *hci_chan_lookup_handle(struct hci_dev *hdev, __u16 handle);
1340 
1341 struct hci_conn *hci_connect_le_scan(struct hci_dev *hdev, bdaddr_t *dst,
1342 				     u8 dst_type, u8 sec_level,
1343 				     u16 conn_timeout,
1344 				     enum conn_reasons conn_reason);
1345 struct hci_conn *hci_connect_le(struct hci_dev *hdev, bdaddr_t *dst,
1346 				u8 dst_type, bool dst_resolved, u8 sec_level,
1347 				u16 conn_timeout, u8 role);
1348 struct hci_conn *hci_connect_acl(struct hci_dev *hdev, bdaddr_t *dst,
1349 				 u8 sec_level, u8 auth_type,
1350 				 enum conn_reasons conn_reason);
1351 struct hci_conn *hci_connect_sco(struct hci_dev *hdev, int type, bdaddr_t *dst,
1352 				 __u16 setting, struct bt_codec *codec);
1353 struct hci_conn *hci_bind_cis(struct hci_dev *hdev, bdaddr_t *dst,
1354 			      __u8 dst_type, struct bt_iso_qos *qos);
1355 struct hci_conn *hci_connect_cis(struct hci_dev *hdev, bdaddr_t *dst,
1356 				 __u8 dst_type, struct bt_iso_qos *qos);
1357 struct hci_conn *hci_connect_bis(struct hci_dev *hdev, bdaddr_t *dst,
1358 				 __u8 dst_type, struct bt_iso_qos *qos,
1359 				 __u8 data_len, __u8 *data);
1360 int hci_pa_create_sync(struct hci_dev *hdev, bdaddr_t *dst, __u8 dst_type,
1361 		       __u8 sid, struct bt_iso_qos *qos);
1362 int hci_le_big_create_sync(struct hci_dev *hdev, struct bt_iso_qos *qos,
1363 			   __u16 sync_handle, __u8 num_bis, __u8 bis[]);
1364 int hci_conn_check_link_mode(struct hci_conn *conn);
1365 int hci_conn_check_secure(struct hci_conn *conn, __u8 sec_level);
1366 int hci_conn_security(struct hci_conn *conn, __u8 sec_level, __u8 auth_type,
1367 		      bool initiator);
1368 int hci_conn_switch_role(struct hci_conn *conn, __u8 role);
1369 
1370 void hci_conn_enter_active_mode(struct hci_conn *conn, __u8 force_active);
1371 
1372 void hci_conn_failed(struct hci_conn *conn, u8 status);
1373 
1374 /*
1375  * hci_conn_get() and hci_conn_put() are used to control the life-time of an
1376  * "hci_conn" object. They do not guarantee that the hci_conn object is running,
1377  * working or anything else. They just guarantee that the object is available
1378  * and can be dereferenced. So you can use its locks, local variables and any
1379  * other constant data.
1380  * Before accessing runtime data, you _must_ lock the object and then check that
1381  * it is still running. As soon as you release the locks, the connection might
1382  * get dropped, though.
1383  *
1384  * On the other hand, hci_conn_hold() and hci_conn_drop() are used to control
1385  * how long the underlying connection is held. So every channel that runs on the
1386  * hci_conn object calls this to prevent the connection from disappearing. As
1387  * long as you hold a device, you must also guarantee that you have a valid
1388  * reference to the device via hci_conn_get() (or the initial reference from
1389  * hci_conn_add()).
1390  * The hold()/drop() ref-count is known to drop below 0 sometimes, which doesn't
1391  * break because nobody cares for that. But this means, we cannot use
1392  * _get()/_drop() in it, but require the caller to have a valid ref (FIXME).
1393  */
1394 
1395 static inline struct hci_conn *hci_conn_get(struct hci_conn *conn)
1396 {
1397 	get_device(&conn->dev);
1398 	return conn;
1399 }
1400 
1401 static inline void hci_conn_put(struct hci_conn *conn)
1402 {
1403 	put_device(&conn->dev);
1404 }
1405 
1406 static inline struct hci_conn *hci_conn_hold(struct hci_conn *conn)
1407 {
1408 	BT_DBG("hcon %p orig refcnt %d", conn, atomic_read(&conn->refcnt));
1409 
1410 	atomic_inc(&conn->refcnt);
1411 	cancel_delayed_work(&conn->disc_work);
1412 
1413 	return conn;
1414 }
1415 
1416 static inline void hci_conn_drop(struct hci_conn *conn)
1417 {
1418 	BT_DBG("hcon %p orig refcnt %d", conn, atomic_read(&conn->refcnt));
1419 
1420 	if (atomic_dec_and_test(&conn->refcnt)) {
1421 		unsigned long timeo;
1422 
1423 		switch (conn->type) {
1424 		case ACL_LINK:
1425 		case LE_LINK:
1426 			cancel_delayed_work(&conn->idle_work);
1427 			if (conn->state == BT_CONNECTED) {
1428 				timeo = conn->disc_timeout;
1429 				if (!conn->out)
1430 					timeo *= 2;
1431 			} else {
1432 				timeo = 0;
1433 			}
1434 			break;
1435 
1436 		case AMP_LINK:
1437 			timeo = conn->disc_timeout;
1438 			break;
1439 
1440 		default:
1441 			timeo = 0;
1442 			break;
1443 		}
1444 
1445 		cancel_delayed_work(&conn->disc_work);
1446 		queue_delayed_work(conn->hdev->workqueue,
1447 				   &conn->disc_work, timeo);
1448 	}
1449 }
1450 
1451 /* ----- HCI Devices ----- */
1452 static inline void hci_dev_put(struct hci_dev *d)
1453 {
1454 	BT_DBG("%s orig refcnt %d", d->name,
1455 	       kref_read(&d->dev.kobj.kref));
1456 
1457 	put_device(&d->dev);
1458 }
1459 
1460 static inline struct hci_dev *hci_dev_hold(struct hci_dev *d)
1461 {
1462 	BT_DBG("%s orig refcnt %d", d->name,
1463 	       kref_read(&d->dev.kobj.kref));
1464 
1465 	get_device(&d->dev);
1466 	return d;
1467 }
1468 
1469 #define hci_dev_lock(d)		mutex_lock(&d->lock)
1470 #define hci_dev_unlock(d)	mutex_unlock(&d->lock)
1471 
1472 #define to_hci_dev(d) container_of(d, struct hci_dev, dev)
1473 #define to_hci_conn(c) container_of(c, struct hci_conn, dev)
1474 
1475 static inline void *hci_get_drvdata(struct hci_dev *hdev)
1476 {
1477 	return dev_get_drvdata(&hdev->dev);
1478 }
1479 
1480 static inline void hci_set_drvdata(struct hci_dev *hdev, void *data)
1481 {
1482 	dev_set_drvdata(&hdev->dev, data);
1483 }
1484 
1485 static inline void *hci_get_priv(struct hci_dev *hdev)
1486 {
1487 	return (char *)hdev + sizeof(*hdev);
1488 }
1489 
1490 struct hci_dev *hci_dev_get(int index);
1491 struct hci_dev *hci_get_route(bdaddr_t *dst, bdaddr_t *src, u8 src_type);
1492 
1493 struct hci_dev *hci_alloc_dev_priv(int sizeof_priv);
1494 
1495 static inline struct hci_dev *hci_alloc_dev(void)
1496 {
1497 	return hci_alloc_dev_priv(0);
1498 }
1499 
1500 void hci_free_dev(struct hci_dev *hdev);
1501 int hci_register_dev(struct hci_dev *hdev);
1502 void hci_unregister_dev(struct hci_dev *hdev);
1503 void hci_release_dev(struct hci_dev *hdev);
1504 int hci_register_suspend_notifier(struct hci_dev *hdev);
1505 int hci_unregister_suspend_notifier(struct hci_dev *hdev);
1506 int hci_suspend_dev(struct hci_dev *hdev);
1507 int hci_resume_dev(struct hci_dev *hdev);
1508 int hci_reset_dev(struct hci_dev *hdev);
1509 int hci_recv_frame(struct hci_dev *hdev, struct sk_buff *skb);
1510 int hci_recv_diag(struct hci_dev *hdev, struct sk_buff *skb);
1511 __printf(2, 3) void hci_set_hw_info(struct hci_dev *hdev, const char *fmt, ...);
1512 __printf(2, 3) void hci_set_fw_info(struct hci_dev *hdev, const char *fmt, ...);
1513 
1514 static inline void hci_set_msft_opcode(struct hci_dev *hdev, __u16 opcode)
1515 {
1516 #if IS_ENABLED(CONFIG_BT_MSFTEXT)
1517 	hdev->msft_opcode = opcode;
1518 #endif
1519 }
1520 
1521 static inline void hci_set_aosp_capable(struct hci_dev *hdev)
1522 {
1523 #if IS_ENABLED(CONFIG_BT_AOSPEXT)
1524 	hdev->aosp_capable = true;
1525 #endif
1526 }
1527 
1528 static inline void hci_devcd_setup(struct hci_dev *hdev)
1529 {
1530 #ifdef CONFIG_DEV_COREDUMP
1531 	INIT_WORK(&hdev->dump.dump_rx, hci_devcd_rx);
1532 	INIT_DELAYED_WORK(&hdev->dump.dump_timeout, hci_devcd_timeout);
1533 	skb_queue_head_init(&hdev->dump.dump_q);
1534 #endif
1535 }
1536 
1537 int hci_dev_open(__u16 dev);
1538 int hci_dev_close(__u16 dev);
1539 int hci_dev_do_close(struct hci_dev *hdev);
1540 int hci_dev_reset(__u16 dev);
1541 int hci_dev_reset_stat(__u16 dev);
1542 int hci_dev_cmd(unsigned int cmd, void __user *arg);
1543 int hci_get_dev_list(void __user *arg);
1544 int hci_get_dev_info(void __user *arg);
1545 int hci_get_conn_list(void __user *arg);
1546 int hci_get_conn_info(struct hci_dev *hdev, void __user *arg);
1547 int hci_get_auth_info(struct hci_dev *hdev, void __user *arg);
1548 int hci_inquiry(void __user *arg);
1549 
1550 struct bdaddr_list *hci_bdaddr_list_lookup(struct list_head *list,
1551 					   bdaddr_t *bdaddr, u8 type);
1552 struct bdaddr_list_with_irk *hci_bdaddr_list_lookup_with_irk(
1553 				    struct list_head *list, bdaddr_t *bdaddr,
1554 				    u8 type);
1555 struct bdaddr_list_with_flags *
1556 hci_bdaddr_list_lookup_with_flags(struct list_head *list, bdaddr_t *bdaddr,
1557 				  u8 type);
1558 int hci_bdaddr_list_add(struct list_head *list, bdaddr_t *bdaddr, u8 type);
1559 int hci_bdaddr_list_add_with_irk(struct list_head *list, bdaddr_t *bdaddr,
1560 				 u8 type, u8 *peer_irk, u8 *local_irk);
1561 int hci_bdaddr_list_add_with_flags(struct list_head *list, bdaddr_t *bdaddr,
1562 				   u8 type, u32 flags);
1563 int hci_bdaddr_list_del(struct list_head *list, bdaddr_t *bdaddr, u8 type);
1564 int hci_bdaddr_list_del_with_irk(struct list_head *list, bdaddr_t *bdaddr,
1565 				 u8 type);
1566 int hci_bdaddr_list_del_with_flags(struct list_head *list, bdaddr_t *bdaddr,
1567 				   u8 type);
1568 void hci_bdaddr_list_clear(struct list_head *list);
1569 
1570 struct hci_conn_params *hci_conn_params_lookup(struct hci_dev *hdev,
1571 					       bdaddr_t *addr, u8 addr_type);
1572 struct hci_conn_params *hci_conn_params_add(struct hci_dev *hdev,
1573 					    bdaddr_t *addr, u8 addr_type);
1574 void hci_conn_params_del(struct hci_dev *hdev, bdaddr_t *addr, u8 addr_type);
1575 void hci_conn_params_clear_disabled(struct hci_dev *hdev);
1576 
1577 struct hci_conn_params *hci_pend_le_action_lookup(struct list_head *list,
1578 						  bdaddr_t *addr,
1579 						  u8 addr_type);
1580 
1581 void hci_uuids_clear(struct hci_dev *hdev);
1582 
1583 void hci_link_keys_clear(struct hci_dev *hdev);
1584 struct link_key *hci_find_link_key(struct hci_dev *hdev, bdaddr_t *bdaddr);
1585 struct link_key *hci_add_link_key(struct hci_dev *hdev, struct hci_conn *conn,
1586 				  bdaddr_t *bdaddr, u8 *val, u8 type,
1587 				  u8 pin_len, bool *persistent);
1588 struct smp_ltk *hci_add_ltk(struct hci_dev *hdev, bdaddr_t *bdaddr,
1589 			    u8 addr_type, u8 type, u8 authenticated,
1590 			    u8 tk[16], u8 enc_size, __le16 ediv, __le64 rand);
1591 struct smp_ltk *hci_find_ltk(struct hci_dev *hdev, bdaddr_t *bdaddr,
1592 			     u8 addr_type, u8 role);
1593 int hci_remove_ltk(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 bdaddr_type);
1594 void hci_smp_ltks_clear(struct hci_dev *hdev);
1595 int hci_remove_link_key(struct hci_dev *hdev, bdaddr_t *bdaddr);
1596 
1597 struct smp_irk *hci_find_irk_by_rpa(struct hci_dev *hdev, bdaddr_t *rpa);
1598 struct smp_irk *hci_find_irk_by_addr(struct hci_dev *hdev, bdaddr_t *bdaddr,
1599 				     u8 addr_type);
1600 struct smp_irk *hci_add_irk(struct hci_dev *hdev, bdaddr_t *bdaddr,
1601 			    u8 addr_type, u8 val[16], bdaddr_t *rpa);
1602 void hci_remove_irk(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 addr_type);
1603 bool hci_is_blocked_key(struct hci_dev *hdev, u8 type, u8 val[16]);
1604 void hci_blocked_keys_clear(struct hci_dev *hdev);
1605 void hci_smp_irks_clear(struct hci_dev *hdev);
1606 
1607 bool hci_bdaddr_is_paired(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 type);
1608 
1609 void hci_remote_oob_data_clear(struct hci_dev *hdev);
1610 struct oob_data *hci_find_remote_oob_data(struct hci_dev *hdev,
1611 					  bdaddr_t *bdaddr, u8 bdaddr_type);
1612 int hci_add_remote_oob_data(struct hci_dev *hdev, bdaddr_t *bdaddr,
1613 			    u8 bdaddr_type, u8 *hash192, u8 *rand192,
1614 			    u8 *hash256, u8 *rand256);
1615 int hci_remove_remote_oob_data(struct hci_dev *hdev, bdaddr_t *bdaddr,
1616 			       u8 bdaddr_type);
1617 
1618 void hci_adv_instances_clear(struct hci_dev *hdev);
1619 struct adv_info *hci_find_adv_instance(struct hci_dev *hdev, u8 instance);
1620 struct adv_info *hci_get_next_instance(struct hci_dev *hdev, u8 instance);
1621 struct adv_info *hci_add_adv_instance(struct hci_dev *hdev, u8 instance,
1622 				      u32 flags, u16 adv_data_len, u8 *adv_data,
1623 				      u16 scan_rsp_len, u8 *scan_rsp_data,
1624 				      u16 timeout, u16 duration, s8 tx_power,
1625 				      u32 min_interval, u32 max_interval,
1626 				      u8 mesh_handle);
1627 struct adv_info *hci_add_per_instance(struct hci_dev *hdev, u8 instance,
1628 				      u32 flags, u8 data_len, u8 *data,
1629 				      u32 min_interval, u32 max_interval);
1630 int hci_set_adv_instance_data(struct hci_dev *hdev, u8 instance,
1631 			 u16 adv_data_len, u8 *adv_data,
1632 			 u16 scan_rsp_len, u8 *scan_rsp_data);
1633 int hci_remove_adv_instance(struct hci_dev *hdev, u8 instance);
1634 void hci_adv_instances_set_rpa_expired(struct hci_dev *hdev, bool rpa_expired);
1635 u32 hci_adv_instance_flags(struct hci_dev *hdev, u8 instance);
1636 bool hci_adv_instance_is_scannable(struct hci_dev *hdev, u8 instance);
1637 
1638 void hci_adv_monitors_clear(struct hci_dev *hdev);
1639 void hci_free_adv_monitor(struct hci_dev *hdev, struct adv_monitor *monitor);
1640 int hci_add_adv_monitor(struct hci_dev *hdev, struct adv_monitor *monitor);
1641 int hci_remove_single_adv_monitor(struct hci_dev *hdev, u16 handle);
1642 int hci_remove_all_adv_monitor(struct hci_dev *hdev);
1643 bool hci_is_adv_monitoring(struct hci_dev *hdev);
1644 int hci_get_adv_monitor_offload_ext(struct hci_dev *hdev);
1645 
1646 void hci_event_packet(struct hci_dev *hdev, struct sk_buff *skb);
1647 
1648 void hci_init_sysfs(struct hci_dev *hdev);
1649 void hci_conn_init_sysfs(struct hci_conn *conn);
1650 void hci_conn_add_sysfs(struct hci_conn *conn);
1651 void hci_conn_del_sysfs(struct hci_conn *conn);
1652 
1653 #define SET_HCIDEV_DEV(hdev, pdev) ((hdev)->dev.parent = (pdev))
1654 #define GET_HCIDEV_DEV(hdev) ((hdev)->dev.parent)
1655 
1656 /* ----- LMP capabilities ----- */
1657 #define lmp_encrypt_capable(dev)   ((dev)->features[0][0] & LMP_ENCRYPT)
1658 #define lmp_rswitch_capable(dev)   ((dev)->features[0][0] & LMP_RSWITCH)
1659 #define lmp_hold_capable(dev)      ((dev)->features[0][0] & LMP_HOLD)
1660 #define lmp_sniff_capable(dev)     ((dev)->features[0][0] & LMP_SNIFF)
1661 #define lmp_park_capable(dev)      ((dev)->features[0][1] & LMP_PARK)
1662 #define lmp_inq_rssi_capable(dev)  ((dev)->features[0][3] & LMP_RSSI_INQ)
1663 #define lmp_esco_capable(dev)      ((dev)->features[0][3] & LMP_ESCO)
1664 #define lmp_bredr_capable(dev)     (!((dev)->features[0][4] & LMP_NO_BREDR))
1665 #define lmp_le_capable(dev)        ((dev)->features[0][4] & LMP_LE)
1666 #define lmp_sniffsubr_capable(dev) ((dev)->features[0][5] & LMP_SNIFF_SUBR)
1667 #define lmp_pause_enc_capable(dev) ((dev)->features[0][5] & LMP_PAUSE_ENC)
1668 #define lmp_esco_2m_capable(dev)   ((dev)->features[0][5] & LMP_EDR_ESCO_2M)
1669 #define lmp_ext_inq_capable(dev)   ((dev)->features[0][6] & LMP_EXT_INQ)
1670 #define lmp_le_br_capable(dev)     (!!((dev)->features[0][6] & LMP_SIMUL_LE_BR))
1671 #define lmp_ssp_capable(dev)       ((dev)->features[0][6] & LMP_SIMPLE_PAIR)
1672 #define lmp_no_flush_capable(dev)  ((dev)->features[0][6] & LMP_NO_FLUSH)
1673 #define lmp_lsto_capable(dev)      ((dev)->features[0][7] & LMP_LSTO)
1674 #define lmp_inq_tx_pwr_capable(dev) ((dev)->features[0][7] & LMP_INQ_TX_PWR)
1675 #define lmp_ext_feat_capable(dev)  ((dev)->features[0][7] & LMP_EXTFEATURES)
1676 #define lmp_transp_capable(dev)    ((dev)->features[0][2] & LMP_TRANSPARENT)
1677 #define lmp_edr_2m_capable(dev)    ((dev)->features[0][3] & LMP_EDR_2M)
1678 #define lmp_edr_3m_capable(dev)    ((dev)->features[0][3] & LMP_EDR_3M)
1679 #define lmp_edr_3slot_capable(dev) ((dev)->features[0][4] & LMP_EDR_3SLOT)
1680 #define lmp_edr_5slot_capable(dev) ((dev)->features[0][5] & LMP_EDR_5SLOT)
1681 
1682 /* ----- Extended LMP capabilities ----- */
1683 #define lmp_cpb_central_capable(dev) ((dev)->features[2][0] & LMP_CPB_CENTRAL)
1684 #define lmp_cpb_peripheral_capable(dev) ((dev)->features[2][0] & LMP_CPB_PERIPHERAL)
1685 #define lmp_sync_train_capable(dev) ((dev)->features[2][0] & LMP_SYNC_TRAIN)
1686 #define lmp_sync_scan_capable(dev)  ((dev)->features[2][0] & LMP_SYNC_SCAN)
1687 #define lmp_sc_capable(dev)         ((dev)->features[2][1] & LMP_SC)
1688 #define lmp_ping_capable(dev)       ((dev)->features[2][1] & LMP_PING)
1689 
1690 /* ----- Host capabilities ----- */
1691 #define lmp_host_ssp_capable(dev)  ((dev)->features[1][0] & LMP_HOST_SSP)
1692 #define lmp_host_sc_capable(dev)   ((dev)->features[1][0] & LMP_HOST_SC)
1693 #define lmp_host_le_capable(dev)   (!!((dev)->features[1][0] & LMP_HOST_LE))
1694 #define lmp_host_le_br_capable(dev) (!!((dev)->features[1][0] & LMP_HOST_LE_BREDR))
1695 
1696 #define hdev_is_powered(dev)   (test_bit(HCI_UP, &(dev)->flags) && \
1697 				!hci_dev_test_flag(dev, HCI_AUTO_OFF))
1698 #define bredr_sc_enabled(dev)  (lmp_sc_capable(dev) && \
1699 				hci_dev_test_flag(dev, HCI_SC_ENABLED))
1700 #define rpa_valid(dev)         (bacmp(&dev->rpa, BDADDR_ANY) && \
1701 				!hci_dev_test_flag(dev, HCI_RPA_EXPIRED))
1702 #define adv_rpa_valid(adv)     (bacmp(&adv->random_addr, BDADDR_ANY) && \
1703 				!adv->rpa_expired)
1704 
1705 #define scan_1m(dev) (((dev)->le_tx_def_phys & HCI_LE_SET_PHY_1M) || \
1706 		      ((dev)->le_rx_def_phys & HCI_LE_SET_PHY_1M))
1707 
1708 #define le_2m_capable(dev) (((dev)->le_features[1] & HCI_LE_PHY_2M))
1709 
1710 #define scan_2m(dev) (((dev)->le_tx_def_phys & HCI_LE_SET_PHY_2M) || \
1711 		      ((dev)->le_rx_def_phys & HCI_LE_SET_PHY_2M))
1712 
1713 #define le_coded_capable(dev) (((dev)->le_features[1] & HCI_LE_PHY_CODED))
1714 
1715 #define scan_coded(dev) (((dev)->le_tx_def_phys & HCI_LE_SET_PHY_CODED) || \
1716 			 ((dev)->le_rx_def_phys & HCI_LE_SET_PHY_CODED))
1717 
1718 #define ll_privacy_capable(dev) ((dev)->le_features[0] & HCI_LE_LL_PRIVACY)
1719 
1720 /* Use LL Privacy based address resolution if supported */
1721 #define use_ll_privacy(dev) (ll_privacy_capable(dev) && \
1722 			     hci_dev_test_flag(dev, HCI_ENABLE_LL_PRIVACY))
1723 
1724 #define privacy_mode_capable(dev) (use_ll_privacy(dev) && \
1725 				   (hdev->commands[39] & 0x04))
1726 
1727 /* Use enhanced synchronous connection if command is supported and its quirk
1728  * has not been set.
1729  */
1730 #define enhanced_sync_conn_capable(dev) \
1731 	(((dev)->commands[29] & 0x08) && \
1732 	 !test_bit(HCI_QUIRK_BROKEN_ENHANCED_SETUP_SYNC_CONN, &(dev)->quirks))
1733 
1734 /* Use ext scanning if set ext scan param and ext scan enable is supported */
1735 #define use_ext_scan(dev) (((dev)->commands[37] & 0x20) && \
1736 			   ((dev)->commands[37] & 0x40) && \
1737 			   !test_bit(HCI_QUIRK_BROKEN_EXT_SCAN, &(dev)->quirks))
1738 
1739 /* Use ext create connection if command is supported */
1740 #define use_ext_conn(dev) ((dev)->commands[37] & 0x80)
1741 
1742 /* Extended advertising support */
1743 #define ext_adv_capable(dev) (((dev)->le_features[1] & HCI_LE_EXT_ADV))
1744 
1745 /* BLUETOOTH CORE SPECIFICATION Version 5.3 | Vol 4, Part E page 1789:
1746  *
1747  * C24: Mandatory if the LE Controller supports Connection State and either
1748  * LE Feature (LL Privacy) or LE Feature (Extended Advertising) is supported
1749  */
1750 #define use_enhanced_conn_complete(dev) (ll_privacy_capable(dev) || \
1751 					 ext_adv_capable(dev))
1752 
1753 /* Periodic advertising support */
1754 #define per_adv_capable(dev) (((dev)->le_features[1] & HCI_LE_PERIODIC_ADV))
1755 
1756 /* CIS Master/Slave and BIS support */
1757 #define iso_capable(dev) (cis_capable(dev) || bis_capable(dev))
1758 #define cis_capable(dev) \
1759 	(cis_central_capable(dev) || cis_peripheral_capable(dev))
1760 #define cis_central_capable(dev) \
1761 	((dev)->le_features[3] & HCI_LE_CIS_CENTRAL)
1762 #define cis_peripheral_capable(dev) \
1763 	((dev)->le_features[3] & HCI_LE_CIS_PERIPHERAL)
1764 #define bis_capable(dev) ((dev)->le_features[3] & HCI_LE_ISO_BROADCASTER)
1765 
1766 #define mws_transport_config_capable(dev) (((dev)->commands[30] & 0x08) && \
1767 	(!test_bit(HCI_QUIRK_BROKEN_MWS_TRANSPORT_CONFIG, &(dev)->quirks)))
1768 
1769 /* ----- HCI protocols ----- */
1770 #define HCI_PROTO_DEFER             0x01
1771 
1772 static inline int hci_proto_connect_ind(struct hci_dev *hdev, bdaddr_t *bdaddr,
1773 					__u8 type, __u8 *flags)
1774 {
1775 	switch (type) {
1776 	case ACL_LINK:
1777 		return l2cap_connect_ind(hdev, bdaddr);
1778 
1779 	case SCO_LINK:
1780 	case ESCO_LINK:
1781 		return sco_connect_ind(hdev, bdaddr, flags);
1782 
1783 	case ISO_LINK:
1784 		return iso_connect_ind(hdev, bdaddr, flags);
1785 
1786 	default:
1787 		BT_ERR("unknown link type %d", type);
1788 		return -EINVAL;
1789 	}
1790 }
1791 
1792 static inline int hci_proto_disconn_ind(struct hci_conn *conn)
1793 {
1794 	if (conn->type != ACL_LINK && conn->type != LE_LINK)
1795 		return HCI_ERROR_REMOTE_USER_TERM;
1796 
1797 	return l2cap_disconn_ind(conn);
1798 }
1799 
1800 /* ----- HCI callbacks ----- */
1801 struct hci_cb {
1802 	struct list_head list;
1803 
1804 	char *name;
1805 
1806 	void (*connect_cfm)	(struct hci_conn *conn, __u8 status);
1807 	void (*disconn_cfm)	(struct hci_conn *conn, __u8 status);
1808 	void (*security_cfm)	(struct hci_conn *conn, __u8 status,
1809 								__u8 encrypt);
1810 	void (*key_change_cfm)	(struct hci_conn *conn, __u8 status);
1811 	void (*role_switch_cfm)	(struct hci_conn *conn, __u8 status, __u8 role);
1812 };
1813 
1814 static inline void hci_connect_cfm(struct hci_conn *conn, __u8 status)
1815 {
1816 	struct hci_cb *cb;
1817 
1818 	mutex_lock(&hci_cb_list_lock);
1819 	list_for_each_entry(cb, &hci_cb_list, list) {
1820 		if (cb->connect_cfm)
1821 			cb->connect_cfm(conn, status);
1822 	}
1823 	mutex_unlock(&hci_cb_list_lock);
1824 
1825 	if (conn->connect_cfm_cb)
1826 		conn->connect_cfm_cb(conn, status);
1827 }
1828 
1829 static inline void hci_disconn_cfm(struct hci_conn *conn, __u8 reason)
1830 {
1831 	struct hci_cb *cb;
1832 
1833 	mutex_lock(&hci_cb_list_lock);
1834 	list_for_each_entry(cb, &hci_cb_list, list) {
1835 		if (cb->disconn_cfm)
1836 			cb->disconn_cfm(conn, reason);
1837 	}
1838 	mutex_unlock(&hci_cb_list_lock);
1839 
1840 	if (conn->disconn_cfm_cb)
1841 		conn->disconn_cfm_cb(conn, reason);
1842 }
1843 
1844 static inline void hci_auth_cfm(struct hci_conn *conn, __u8 status)
1845 {
1846 	struct hci_cb *cb;
1847 	__u8 encrypt;
1848 
1849 	if (test_bit(HCI_CONN_ENCRYPT_PEND, &conn->flags))
1850 		return;
1851 
1852 	encrypt = test_bit(HCI_CONN_ENCRYPT, &conn->flags) ? 0x01 : 0x00;
1853 
1854 	mutex_lock(&hci_cb_list_lock);
1855 	list_for_each_entry(cb, &hci_cb_list, list) {
1856 		if (cb->security_cfm)
1857 			cb->security_cfm(conn, status, encrypt);
1858 	}
1859 	mutex_unlock(&hci_cb_list_lock);
1860 
1861 	if (conn->security_cfm_cb)
1862 		conn->security_cfm_cb(conn, status);
1863 }
1864 
1865 static inline void hci_encrypt_cfm(struct hci_conn *conn, __u8 status)
1866 {
1867 	struct hci_cb *cb;
1868 	__u8 encrypt;
1869 
1870 	if (conn->state == BT_CONFIG) {
1871 		if (!status)
1872 			conn->state = BT_CONNECTED;
1873 
1874 		hci_connect_cfm(conn, status);
1875 		hci_conn_drop(conn);
1876 		return;
1877 	}
1878 
1879 	if (!test_bit(HCI_CONN_ENCRYPT, &conn->flags))
1880 		encrypt = 0x00;
1881 	else if (test_bit(HCI_CONN_AES_CCM, &conn->flags))
1882 		encrypt = 0x02;
1883 	else
1884 		encrypt = 0x01;
1885 
1886 	if (!status) {
1887 		if (conn->sec_level == BT_SECURITY_SDP)
1888 			conn->sec_level = BT_SECURITY_LOW;
1889 
1890 		if (conn->pending_sec_level > conn->sec_level)
1891 			conn->sec_level = conn->pending_sec_level;
1892 	}
1893 
1894 	mutex_lock(&hci_cb_list_lock);
1895 	list_for_each_entry(cb, &hci_cb_list, list) {
1896 		if (cb->security_cfm)
1897 			cb->security_cfm(conn, status, encrypt);
1898 	}
1899 	mutex_unlock(&hci_cb_list_lock);
1900 
1901 	if (conn->security_cfm_cb)
1902 		conn->security_cfm_cb(conn, status);
1903 }
1904 
1905 static inline void hci_key_change_cfm(struct hci_conn *conn, __u8 status)
1906 {
1907 	struct hci_cb *cb;
1908 
1909 	mutex_lock(&hci_cb_list_lock);
1910 	list_for_each_entry(cb, &hci_cb_list, list) {
1911 		if (cb->key_change_cfm)
1912 			cb->key_change_cfm(conn, status);
1913 	}
1914 	mutex_unlock(&hci_cb_list_lock);
1915 }
1916 
1917 static inline void hci_role_switch_cfm(struct hci_conn *conn, __u8 status,
1918 								__u8 role)
1919 {
1920 	struct hci_cb *cb;
1921 
1922 	mutex_lock(&hci_cb_list_lock);
1923 	list_for_each_entry(cb, &hci_cb_list, list) {
1924 		if (cb->role_switch_cfm)
1925 			cb->role_switch_cfm(conn, status, role);
1926 	}
1927 	mutex_unlock(&hci_cb_list_lock);
1928 }
1929 
1930 static inline bool hci_bdaddr_is_rpa(bdaddr_t *bdaddr, u8 addr_type)
1931 {
1932 	if (addr_type != ADDR_LE_DEV_RANDOM)
1933 		return false;
1934 
1935 	if ((bdaddr->b[5] & 0xc0) == 0x40)
1936 	       return true;
1937 
1938 	return false;
1939 }
1940 
1941 static inline bool hci_is_identity_address(bdaddr_t *addr, u8 addr_type)
1942 {
1943 	if (addr_type == ADDR_LE_DEV_PUBLIC)
1944 		return true;
1945 
1946 	/* Check for Random Static address type */
1947 	if ((addr->b[5] & 0xc0) == 0xc0)
1948 		return true;
1949 
1950 	return false;
1951 }
1952 
1953 static inline struct smp_irk *hci_get_irk(struct hci_dev *hdev,
1954 					  bdaddr_t *bdaddr, u8 addr_type)
1955 {
1956 	if (!hci_bdaddr_is_rpa(bdaddr, addr_type))
1957 		return NULL;
1958 
1959 	return hci_find_irk_by_rpa(hdev, bdaddr);
1960 }
1961 
1962 static inline int hci_check_conn_params(u16 min, u16 max, u16 latency,
1963 					u16 to_multiplier)
1964 {
1965 	u16 max_latency;
1966 
1967 	if (min > max || min < 6 || max > 3200)
1968 		return -EINVAL;
1969 
1970 	if (to_multiplier < 10 || to_multiplier > 3200)
1971 		return -EINVAL;
1972 
1973 	if (max >= to_multiplier * 8)
1974 		return -EINVAL;
1975 
1976 	max_latency = (to_multiplier * 4 / max) - 1;
1977 	if (latency > 499 || latency > max_latency)
1978 		return -EINVAL;
1979 
1980 	return 0;
1981 }
1982 
1983 int hci_register_cb(struct hci_cb *hcb);
1984 int hci_unregister_cb(struct hci_cb *hcb);
1985 
1986 int __hci_cmd_send(struct hci_dev *hdev, u16 opcode, u32 plen,
1987 		   const void *param);
1988 
1989 int hci_send_cmd(struct hci_dev *hdev, __u16 opcode, __u32 plen,
1990 		 const void *param);
1991 void hci_send_acl(struct hci_chan *chan, struct sk_buff *skb, __u16 flags);
1992 void hci_send_sco(struct hci_conn *conn, struct sk_buff *skb);
1993 void hci_send_iso(struct hci_conn *conn, struct sk_buff *skb);
1994 
1995 void *hci_sent_cmd_data(struct hci_dev *hdev, __u16 opcode);
1996 void *hci_recv_event_data(struct hci_dev *hdev, __u8 event);
1997 
1998 u32 hci_conn_get_phy(struct hci_conn *conn);
1999 
2000 /* ----- HCI Sockets ----- */
2001 void hci_send_to_sock(struct hci_dev *hdev, struct sk_buff *skb);
2002 void hci_send_to_channel(unsigned short channel, struct sk_buff *skb,
2003 			 int flag, struct sock *skip_sk);
2004 void hci_send_to_monitor(struct hci_dev *hdev, struct sk_buff *skb);
2005 void hci_send_monitor_ctrl_event(struct hci_dev *hdev, u16 event,
2006 				 void *data, u16 data_len, ktime_t tstamp,
2007 				 int flag, struct sock *skip_sk);
2008 
2009 void hci_sock_dev_event(struct hci_dev *hdev, int event);
2010 
2011 #define HCI_MGMT_VAR_LEN	BIT(0)
2012 #define HCI_MGMT_NO_HDEV	BIT(1)
2013 #define HCI_MGMT_UNTRUSTED	BIT(2)
2014 #define HCI_MGMT_UNCONFIGURED	BIT(3)
2015 #define HCI_MGMT_HDEV_OPTIONAL	BIT(4)
2016 
2017 struct hci_mgmt_handler {
2018 	int (*func) (struct sock *sk, struct hci_dev *hdev, void *data,
2019 		     u16 data_len);
2020 	size_t data_len;
2021 	unsigned long flags;
2022 };
2023 
2024 struct hci_mgmt_chan {
2025 	struct list_head list;
2026 	unsigned short channel;
2027 	size_t handler_count;
2028 	const struct hci_mgmt_handler *handlers;
2029 	void (*hdev_init) (struct sock *sk, struct hci_dev *hdev);
2030 };
2031 
2032 int hci_mgmt_chan_register(struct hci_mgmt_chan *c);
2033 void hci_mgmt_chan_unregister(struct hci_mgmt_chan *c);
2034 
2035 /* Management interface */
2036 #define DISCOV_TYPE_BREDR		(BIT(BDADDR_BREDR))
2037 #define DISCOV_TYPE_LE			(BIT(BDADDR_LE_PUBLIC) | \
2038 					 BIT(BDADDR_LE_RANDOM))
2039 #define DISCOV_TYPE_INTERLEAVED		(BIT(BDADDR_BREDR) | \
2040 					 BIT(BDADDR_LE_PUBLIC) | \
2041 					 BIT(BDADDR_LE_RANDOM))
2042 
2043 /* These LE scan and inquiry parameters were chosen according to LE General
2044  * Discovery Procedure specification.
2045  */
2046 #define DISCOV_LE_SCAN_WIN		0x12
2047 #define DISCOV_LE_SCAN_INT		0x12
2048 #define DISCOV_LE_TIMEOUT		10240	/* msec */
2049 #define DISCOV_INTERLEAVED_TIMEOUT	5120	/* msec */
2050 #define DISCOV_INTERLEAVED_INQUIRY_LEN	0x04
2051 #define DISCOV_BREDR_INQUIRY_LEN	0x08
2052 #define DISCOV_LE_RESTART_DELAY		msecs_to_jiffies(200)	/* msec */
2053 #define DISCOV_LE_FAST_ADV_INT_MIN	0x00A0	/* 100 msec */
2054 #define DISCOV_LE_FAST_ADV_INT_MAX	0x00F0	/* 150 msec */
2055 #define DISCOV_LE_PER_ADV_INT_MIN	0x00A0	/* 200 msec */
2056 #define DISCOV_LE_PER_ADV_INT_MAX	0x00A0	/* 200 msec */
2057 #define DISCOV_LE_ADV_MESH_MIN		0x00A0  /* 100 msec */
2058 #define DISCOV_LE_ADV_MESH_MAX		0x00A0  /* 100 msec */
2059 #define INTERVAL_TO_MS(x)		(((x) * 10) / 0x10)
2060 
2061 #define NAME_RESOLVE_DURATION		msecs_to_jiffies(10240)	/* 10.24 sec */
2062 
2063 void mgmt_fill_version_info(void *ver);
2064 int mgmt_new_settings(struct hci_dev *hdev);
2065 void mgmt_index_added(struct hci_dev *hdev);
2066 void mgmt_index_removed(struct hci_dev *hdev);
2067 void mgmt_set_powered_failed(struct hci_dev *hdev, int err);
2068 void mgmt_power_on(struct hci_dev *hdev, int err);
2069 void __mgmt_power_off(struct hci_dev *hdev);
2070 void mgmt_new_link_key(struct hci_dev *hdev, struct link_key *key,
2071 		       bool persistent);
2072 void mgmt_device_connected(struct hci_dev *hdev, struct hci_conn *conn,
2073 			   u8 *name, u8 name_len);
2074 void mgmt_device_disconnected(struct hci_dev *hdev, bdaddr_t *bdaddr,
2075 			      u8 link_type, u8 addr_type, u8 reason,
2076 			      bool mgmt_connected);
2077 void mgmt_disconnect_failed(struct hci_dev *hdev, bdaddr_t *bdaddr,
2078 			    u8 link_type, u8 addr_type, u8 status);
2079 void mgmt_connect_failed(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 link_type,
2080 			 u8 addr_type, u8 status);
2081 void mgmt_pin_code_request(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 secure);
2082 void mgmt_pin_code_reply_complete(struct hci_dev *hdev, bdaddr_t *bdaddr,
2083 				  u8 status);
2084 void mgmt_pin_code_neg_reply_complete(struct hci_dev *hdev, bdaddr_t *bdaddr,
2085 				      u8 status);
2086 int mgmt_user_confirm_request(struct hci_dev *hdev, bdaddr_t *bdaddr,
2087 			      u8 link_type, u8 addr_type, u32 value,
2088 			      u8 confirm_hint);
2089 int mgmt_user_confirm_reply_complete(struct hci_dev *hdev, bdaddr_t *bdaddr,
2090 				     u8 link_type, u8 addr_type, u8 status);
2091 int mgmt_user_confirm_neg_reply_complete(struct hci_dev *hdev, bdaddr_t *bdaddr,
2092 					 u8 link_type, u8 addr_type, u8 status);
2093 int mgmt_user_passkey_request(struct hci_dev *hdev, bdaddr_t *bdaddr,
2094 			      u8 link_type, u8 addr_type);
2095 int mgmt_user_passkey_reply_complete(struct hci_dev *hdev, bdaddr_t *bdaddr,
2096 				     u8 link_type, u8 addr_type, u8 status);
2097 int mgmt_user_passkey_neg_reply_complete(struct hci_dev *hdev, bdaddr_t *bdaddr,
2098 					 u8 link_type, u8 addr_type, u8 status);
2099 int mgmt_user_passkey_notify(struct hci_dev *hdev, bdaddr_t *bdaddr,
2100 			     u8 link_type, u8 addr_type, u32 passkey,
2101 			     u8 entered);
2102 void mgmt_auth_failed(struct hci_conn *conn, u8 status);
2103 void mgmt_auth_enable_complete(struct hci_dev *hdev, u8 status);
2104 void mgmt_set_class_of_dev_complete(struct hci_dev *hdev, u8 *dev_class,
2105 				    u8 status);
2106 void mgmt_set_local_name_complete(struct hci_dev *hdev, u8 *name, u8 status);
2107 void mgmt_start_discovery_complete(struct hci_dev *hdev, u8 status);
2108 void mgmt_stop_discovery_complete(struct hci_dev *hdev, u8 status);
2109 void mgmt_device_found(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 link_type,
2110 		       u8 addr_type, u8 *dev_class, s8 rssi, u32 flags,
2111 		       u8 *eir, u16 eir_len, u8 *scan_rsp, u8 scan_rsp_len,
2112 		       u64 instant);
2113 void mgmt_remote_name(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 link_type,
2114 		      u8 addr_type, s8 rssi, u8 *name, u8 name_len);
2115 void mgmt_discovering(struct hci_dev *hdev, u8 discovering);
2116 void mgmt_suspending(struct hci_dev *hdev, u8 state);
2117 void mgmt_resuming(struct hci_dev *hdev, u8 reason, bdaddr_t *bdaddr,
2118 		   u8 addr_type);
2119 bool mgmt_powering_down(struct hci_dev *hdev);
2120 void mgmt_new_ltk(struct hci_dev *hdev, struct smp_ltk *key, bool persistent);
2121 void mgmt_new_irk(struct hci_dev *hdev, struct smp_irk *irk, bool persistent);
2122 void mgmt_new_csrk(struct hci_dev *hdev, struct smp_csrk *csrk,
2123 		   bool persistent);
2124 void mgmt_new_conn_param(struct hci_dev *hdev, bdaddr_t *bdaddr,
2125 			 u8 bdaddr_type, u8 store_hint, u16 min_interval,
2126 			 u16 max_interval, u16 latency, u16 timeout);
2127 void mgmt_smp_complete(struct hci_conn *conn, bool complete);
2128 bool mgmt_get_connectable(struct hci_dev *hdev);
2129 u8 mgmt_get_adv_discov_flags(struct hci_dev *hdev);
2130 void mgmt_advertising_added(struct sock *sk, struct hci_dev *hdev,
2131 			    u8 instance);
2132 void mgmt_advertising_removed(struct sock *sk, struct hci_dev *hdev,
2133 			      u8 instance);
2134 void mgmt_adv_monitor_removed(struct hci_dev *hdev, u16 handle);
2135 int mgmt_phy_configuration_changed(struct hci_dev *hdev, struct sock *skip);
2136 void mgmt_adv_monitor_device_lost(struct hci_dev *hdev, u16 handle,
2137 				  bdaddr_t *bdaddr, u8 addr_type);
2138 
2139 int hci_abort_conn(struct hci_conn *conn, u8 reason);
2140 u8 hci_le_conn_update(struct hci_conn *conn, u16 min, u16 max, u16 latency,
2141 		      u16 to_multiplier);
2142 void hci_le_start_enc(struct hci_conn *conn, __le16 ediv, __le64 rand,
2143 		      __u8 ltk[16], __u8 key_size);
2144 
2145 void hci_copy_identity_address(struct hci_dev *hdev, bdaddr_t *bdaddr,
2146 			       u8 *bdaddr_type);
2147 
2148 #define SCO_AIRMODE_MASK       0x0003
2149 #define SCO_AIRMODE_CVSD       0x0000
2150 #define SCO_AIRMODE_TRANSP     0x0003
2151 
2152 #define LOCAL_CODEC_ACL_MASK	BIT(0)
2153 #define LOCAL_CODEC_SCO_MASK	BIT(1)
2154 
2155 #define TRANSPORT_TYPE_MAX	0x04
2156 
2157 #endif /* __HCI_CORE_H */
2158