xref: /openbmc/linux/include/net/bluetooth/hci_core.h (revision d7955ce4)
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 	struct hci_devcoredump	dump;
597 
598 	struct device		dev;
599 
600 	struct rfkill		*rfkill;
601 
602 	DECLARE_BITMAP(dev_flags, __HCI_NUM_FLAGS);
603 	hci_conn_flags_t	conn_flags;
604 
605 	__s8			adv_tx_power;
606 	__u8			adv_data[HCI_MAX_EXT_AD_LENGTH];
607 	__u8			adv_data_len;
608 	__u8			scan_rsp_data[HCI_MAX_EXT_AD_LENGTH];
609 	__u8			scan_rsp_data_len;
610 	__u8			per_adv_data[HCI_MAX_PER_AD_LENGTH];
611 	__u8			per_adv_data_len;
612 
613 	struct list_head	adv_instances;
614 	unsigned int		adv_instance_cnt;
615 	__u8			cur_adv_instance;
616 	__u16			adv_instance_timeout;
617 	struct delayed_work	adv_instance_expire;
618 
619 	struct idr		adv_monitors_idr;
620 	unsigned int		adv_monitors_cnt;
621 
622 	__u8			irk[16];
623 	__u32			rpa_timeout;
624 	struct delayed_work	rpa_expired;
625 	bdaddr_t		rpa;
626 
627 	struct delayed_work	mesh_send_done;
628 
629 	enum {
630 		INTERLEAVE_SCAN_NONE,
631 		INTERLEAVE_SCAN_NO_FILTER,
632 		INTERLEAVE_SCAN_ALLOWLIST
633 	} interleave_scan_state;
634 
635 	struct delayed_work	interleave_scan;
636 
637 	struct list_head	monitored_devices;
638 	bool			advmon_pend_notify;
639 
640 #if IS_ENABLED(CONFIG_BT_LEDS)
641 	struct led_trigger	*power_led;
642 #endif
643 
644 #if IS_ENABLED(CONFIG_BT_MSFTEXT)
645 	__u16			msft_opcode;
646 	void			*msft_data;
647 	bool			msft_curve_validity;
648 #endif
649 
650 #if IS_ENABLED(CONFIG_BT_AOSPEXT)
651 	bool			aosp_capable;
652 	bool			aosp_quality_report;
653 #endif
654 
655 	int (*open)(struct hci_dev *hdev);
656 	int (*close)(struct hci_dev *hdev);
657 	int (*flush)(struct hci_dev *hdev);
658 	int (*setup)(struct hci_dev *hdev);
659 	int (*shutdown)(struct hci_dev *hdev);
660 	int (*send)(struct hci_dev *hdev, struct sk_buff *skb);
661 	void (*notify)(struct hci_dev *hdev, unsigned int evt);
662 	void (*hw_error)(struct hci_dev *hdev, u8 code);
663 	int (*post_init)(struct hci_dev *hdev);
664 	int (*set_diag)(struct hci_dev *hdev, bool enable);
665 	int (*set_bdaddr)(struct hci_dev *hdev, const bdaddr_t *bdaddr);
666 	void (*cmd_timeout)(struct hci_dev *hdev);
667 	void (*reset)(struct hci_dev *hdev);
668 	bool (*wakeup)(struct hci_dev *hdev);
669 	int (*set_quality_report)(struct hci_dev *hdev, bool enable);
670 	int (*get_data_path_id)(struct hci_dev *hdev, __u8 *data_path);
671 	int (*get_codec_config_data)(struct hci_dev *hdev, __u8 type,
672 				     struct bt_codec *codec, __u8 *vnd_len,
673 				     __u8 **vnd_data);
674 };
675 
676 #define HCI_PHY_HANDLE(handle)	(handle & 0xff)
677 
678 enum conn_reasons {
679 	CONN_REASON_PAIR_DEVICE,
680 	CONN_REASON_L2CAP_CHAN,
681 	CONN_REASON_SCO_CONNECT,
682 	CONN_REASON_ISO_CONNECT,
683 };
684 
685 struct hci_conn {
686 	struct list_head list;
687 
688 	atomic_t	refcnt;
689 
690 	bdaddr_t	dst;
691 	__u8		dst_type;
692 	bdaddr_t	src;
693 	__u8		src_type;
694 	bdaddr_t	init_addr;
695 	__u8		init_addr_type;
696 	bdaddr_t	resp_addr;
697 	__u8		resp_addr_type;
698 	__u8		adv_instance;
699 	__u16		handle;
700 	__u16		sync_handle;
701 	__u16		state;
702 	__u8		mode;
703 	__u8		type;
704 	__u8		role;
705 	bool		out;
706 	__u8		attempt;
707 	__u8		dev_class[3];
708 	__u8		features[HCI_MAX_PAGES][8];
709 	__u16		pkt_type;
710 	__u16		link_policy;
711 	__u8		key_type;
712 	__u8		auth_type;
713 	__u8		sec_level;
714 	__u8		pending_sec_level;
715 	__u8		pin_length;
716 	__u8		enc_key_size;
717 	__u8		io_capability;
718 	__u32		passkey_notify;
719 	__u8		passkey_entered;
720 	__u16		disc_timeout;
721 	__u16		conn_timeout;
722 	__u16		setting;
723 	__u16		auth_payload_timeout;
724 	__u16		le_conn_min_interval;
725 	__u16		le_conn_max_interval;
726 	__u16		le_conn_interval;
727 	__u16		le_conn_latency;
728 	__u16		le_supv_timeout;
729 	__u8		le_adv_data[HCI_MAX_AD_LENGTH];
730 	__u8		le_adv_data_len;
731 	__u8		le_per_adv_data[HCI_MAX_PER_AD_LENGTH];
732 	__u8		le_per_adv_data_len;
733 	__u8		le_tx_phy;
734 	__u8		le_rx_phy;
735 	__s8		rssi;
736 	__s8		tx_power;
737 	__s8		max_tx_power;
738 	struct bt_iso_qos iso_qos;
739 	unsigned long	flags;
740 
741 	enum conn_reasons conn_reason;
742 
743 	__u32		clock;
744 	__u16		clock_accuracy;
745 
746 	unsigned long	conn_info_timestamp;
747 
748 	__u8		remote_cap;
749 	__u8		remote_auth;
750 	__u8		remote_id;
751 
752 	unsigned int	sent;
753 
754 	struct sk_buff_head data_q;
755 	struct list_head chan_list;
756 
757 	struct delayed_work disc_work;
758 	struct delayed_work auto_accept_work;
759 	struct delayed_work idle_work;
760 	struct delayed_work le_conn_timeout;
761 	struct work_struct  le_scan_cleanup;
762 
763 	struct device	dev;
764 	struct dentry	*debugfs;
765 
766 	struct hci_dev	*hdev;
767 	void		*l2cap_data;
768 	void		*sco_data;
769 	void		*iso_data;
770 	struct amp_mgr	*amp_mgr;
771 
772 	struct list_head link_list;
773 	struct hci_conn	*parent;
774 	struct hci_link *link;
775 
776 	struct bt_codec codec;
777 
778 	void (*connect_cfm_cb)	(struct hci_conn *conn, u8 status);
779 	void (*security_cfm_cb)	(struct hci_conn *conn, u8 status);
780 	void (*disconn_cfm_cb)	(struct hci_conn *conn, u8 reason);
781 
782 	void (*cleanup)(struct hci_conn *conn);
783 };
784 
785 struct hci_link {
786 	struct list_head list;
787 	struct hci_conn *conn;
788 };
789 
790 struct hci_chan {
791 	struct list_head list;
792 	__u16 handle;
793 	struct hci_conn *conn;
794 	struct sk_buff_head data_q;
795 	unsigned int	sent;
796 	__u8		state;
797 	bool		amp;
798 };
799 
800 struct hci_conn_params {
801 	struct list_head list;
802 	struct list_head action;
803 
804 	bdaddr_t addr;
805 	u8 addr_type;
806 
807 	u16 conn_min_interval;
808 	u16 conn_max_interval;
809 	u16 conn_latency;
810 	u16 supervision_timeout;
811 
812 	enum {
813 		HCI_AUTO_CONN_DISABLED,
814 		HCI_AUTO_CONN_REPORT,
815 		HCI_AUTO_CONN_DIRECT,
816 		HCI_AUTO_CONN_ALWAYS,
817 		HCI_AUTO_CONN_LINK_LOSS,
818 		HCI_AUTO_CONN_EXPLICIT,
819 	} auto_connect;
820 
821 	struct hci_conn *conn;
822 	bool explicit_connect;
823 	/* Accessed without hdev->lock: */
824 	hci_conn_flags_t flags;
825 	u8  privacy_mode;
826 };
827 
828 extern struct list_head hci_dev_list;
829 extern struct list_head hci_cb_list;
830 extern rwlock_t hci_dev_list_lock;
831 extern struct mutex hci_cb_list_lock;
832 
833 #define hci_dev_set_flag(hdev, nr)             set_bit((nr), (hdev)->dev_flags)
834 #define hci_dev_clear_flag(hdev, nr)           clear_bit((nr), (hdev)->dev_flags)
835 #define hci_dev_change_flag(hdev, nr)          change_bit((nr), (hdev)->dev_flags)
836 #define hci_dev_test_flag(hdev, nr)            test_bit((nr), (hdev)->dev_flags)
837 #define hci_dev_test_and_set_flag(hdev, nr)    test_and_set_bit((nr), (hdev)->dev_flags)
838 #define hci_dev_test_and_clear_flag(hdev, nr)  test_and_clear_bit((nr), (hdev)->dev_flags)
839 #define hci_dev_test_and_change_flag(hdev, nr) test_and_change_bit((nr), (hdev)->dev_flags)
840 
841 #define hci_dev_clear_volatile_flags(hdev)			\
842 	do {							\
843 		hci_dev_clear_flag(hdev, HCI_LE_SCAN);		\
844 		hci_dev_clear_flag(hdev, HCI_LE_ADV);		\
845 		hci_dev_clear_flag(hdev, HCI_LL_RPA_RESOLUTION);\
846 		hci_dev_clear_flag(hdev, HCI_PERIODIC_INQ);	\
847 		hci_dev_clear_flag(hdev, HCI_QUALITY_REPORT);	\
848 	} while (0)
849 
850 #define hci_dev_le_state_simultaneous(hdev) \
851 	(test_bit(HCI_QUIRK_VALID_LE_STATES, &hdev->quirks) && \
852 	 (hdev->le_states[4] & 0x08) &&	/* Central */ \
853 	 (hdev->le_states[4] & 0x40) &&	/* Peripheral */ \
854 	 (hdev->le_states[3] & 0x10))	/* Simultaneous */
855 
856 /* ----- HCI interface to upper protocols ----- */
857 int l2cap_connect_ind(struct hci_dev *hdev, bdaddr_t *bdaddr);
858 int l2cap_disconn_ind(struct hci_conn *hcon);
859 void l2cap_recv_acldata(struct hci_conn *hcon, struct sk_buff *skb, u16 flags);
860 
861 #if IS_ENABLED(CONFIG_BT_BREDR)
862 int sco_connect_ind(struct hci_dev *hdev, bdaddr_t *bdaddr, __u8 *flags);
863 void sco_recv_scodata(struct hci_conn *hcon, struct sk_buff *skb);
864 #else
865 static inline int sco_connect_ind(struct hci_dev *hdev, bdaddr_t *bdaddr,
866 				  __u8 *flags)
867 {
868 	return 0;
869 }
870 
871 static inline void sco_recv_scodata(struct hci_conn *hcon, struct sk_buff *skb)
872 {
873 }
874 #endif
875 
876 #if IS_ENABLED(CONFIG_BT_LE)
877 int iso_connect_ind(struct hci_dev *hdev, bdaddr_t *bdaddr, __u8 *flags);
878 void iso_recv(struct hci_conn *hcon, struct sk_buff *skb, u16 flags);
879 #else
880 static inline int iso_connect_ind(struct hci_dev *hdev, bdaddr_t *bdaddr,
881 				  __u8 *flags)
882 {
883 	return 0;
884 }
885 static inline void iso_recv(struct hci_conn *hcon, struct sk_buff *skb,
886 			    u16 flags)
887 {
888 }
889 #endif
890 
891 /* ----- Inquiry cache ----- */
892 #define INQUIRY_CACHE_AGE_MAX   (HZ*30)   /* 30 seconds */
893 #define INQUIRY_ENTRY_AGE_MAX   (HZ*60)   /* 60 seconds */
894 
895 static inline void discovery_init(struct hci_dev *hdev)
896 {
897 	hdev->discovery.state = DISCOVERY_STOPPED;
898 	INIT_LIST_HEAD(&hdev->discovery.all);
899 	INIT_LIST_HEAD(&hdev->discovery.unknown);
900 	INIT_LIST_HEAD(&hdev->discovery.resolve);
901 	hdev->discovery.report_invalid_rssi = true;
902 	hdev->discovery.rssi = HCI_RSSI_INVALID;
903 }
904 
905 static inline void hci_discovery_filter_clear(struct hci_dev *hdev)
906 {
907 	hdev->discovery.result_filtering = false;
908 	hdev->discovery.report_invalid_rssi = true;
909 	hdev->discovery.rssi = HCI_RSSI_INVALID;
910 	hdev->discovery.uuid_count = 0;
911 	kfree(hdev->discovery.uuids);
912 	hdev->discovery.uuids = NULL;
913 	hdev->discovery.scan_start = 0;
914 	hdev->discovery.scan_duration = 0;
915 }
916 
917 bool hci_discovery_active(struct hci_dev *hdev);
918 
919 void hci_discovery_set_state(struct hci_dev *hdev, int state);
920 
921 static inline int inquiry_cache_empty(struct hci_dev *hdev)
922 {
923 	return list_empty(&hdev->discovery.all);
924 }
925 
926 static inline long inquiry_cache_age(struct hci_dev *hdev)
927 {
928 	struct discovery_state *c = &hdev->discovery;
929 	return jiffies - c->timestamp;
930 }
931 
932 static inline long inquiry_entry_age(struct inquiry_entry *e)
933 {
934 	return jiffies - e->timestamp;
935 }
936 
937 struct inquiry_entry *hci_inquiry_cache_lookup(struct hci_dev *hdev,
938 					       bdaddr_t *bdaddr);
939 struct inquiry_entry *hci_inquiry_cache_lookup_unknown(struct hci_dev *hdev,
940 						       bdaddr_t *bdaddr);
941 struct inquiry_entry *hci_inquiry_cache_lookup_resolve(struct hci_dev *hdev,
942 						       bdaddr_t *bdaddr,
943 						       int state);
944 void hci_inquiry_cache_update_resolve(struct hci_dev *hdev,
945 				      struct inquiry_entry *ie);
946 u32 hci_inquiry_cache_update(struct hci_dev *hdev, struct inquiry_data *data,
947 			     bool name_known);
948 void hci_inquiry_cache_flush(struct hci_dev *hdev);
949 
950 /* ----- HCI Connections ----- */
951 enum {
952 	HCI_CONN_AUTH_PEND,
953 	HCI_CONN_REAUTH_PEND,
954 	HCI_CONN_ENCRYPT_PEND,
955 	HCI_CONN_RSWITCH_PEND,
956 	HCI_CONN_MODE_CHANGE_PEND,
957 	HCI_CONN_SCO_SETUP_PEND,
958 	HCI_CONN_MGMT_CONNECTED,
959 	HCI_CONN_SSP_ENABLED,
960 	HCI_CONN_SC_ENABLED,
961 	HCI_CONN_AES_CCM,
962 	HCI_CONN_POWER_SAVE,
963 	HCI_CONN_FLUSH_KEY,
964 	HCI_CONN_ENCRYPT,
965 	HCI_CONN_AUTH,
966 	HCI_CONN_SECURE,
967 	HCI_CONN_FIPS,
968 	HCI_CONN_STK_ENCRYPT,
969 	HCI_CONN_AUTH_INITIATOR,
970 	HCI_CONN_DROP,
971 	HCI_CONN_CANCEL,
972 	HCI_CONN_PARAM_REMOVAL_PEND,
973 	HCI_CONN_NEW_LINK_KEY,
974 	HCI_CONN_SCANNING,
975 	HCI_CONN_AUTH_FAILURE,
976 	HCI_CONN_PER_ADV,
977 };
978 
979 static inline bool hci_conn_ssp_enabled(struct hci_conn *conn)
980 {
981 	struct hci_dev *hdev = conn->hdev;
982 	return hci_dev_test_flag(hdev, HCI_SSP_ENABLED) &&
983 	       test_bit(HCI_CONN_SSP_ENABLED, &conn->flags);
984 }
985 
986 static inline bool hci_conn_sc_enabled(struct hci_conn *conn)
987 {
988 	struct hci_dev *hdev = conn->hdev;
989 	return hci_dev_test_flag(hdev, HCI_SC_ENABLED) &&
990 	       test_bit(HCI_CONN_SC_ENABLED, &conn->flags);
991 }
992 
993 static inline void hci_conn_hash_add(struct hci_dev *hdev, struct hci_conn *c)
994 {
995 	struct hci_conn_hash *h = &hdev->conn_hash;
996 	list_add_tail_rcu(&c->list, &h->list);
997 	switch (c->type) {
998 	case ACL_LINK:
999 		h->acl_num++;
1000 		break;
1001 	case AMP_LINK:
1002 		h->amp_num++;
1003 		break;
1004 	case LE_LINK:
1005 		h->le_num++;
1006 		if (c->role == HCI_ROLE_SLAVE)
1007 			h->le_num_peripheral++;
1008 		break;
1009 	case SCO_LINK:
1010 	case ESCO_LINK:
1011 		h->sco_num++;
1012 		break;
1013 	case ISO_LINK:
1014 		h->iso_num++;
1015 		break;
1016 	}
1017 }
1018 
1019 static inline void hci_conn_hash_del(struct hci_dev *hdev, struct hci_conn *c)
1020 {
1021 	struct hci_conn_hash *h = &hdev->conn_hash;
1022 
1023 	list_del_rcu(&c->list);
1024 	synchronize_rcu();
1025 
1026 	switch (c->type) {
1027 	case ACL_LINK:
1028 		h->acl_num--;
1029 		break;
1030 	case AMP_LINK:
1031 		h->amp_num--;
1032 		break;
1033 	case LE_LINK:
1034 		h->le_num--;
1035 		if (c->role == HCI_ROLE_SLAVE)
1036 			h->le_num_peripheral--;
1037 		break;
1038 	case SCO_LINK:
1039 	case ESCO_LINK:
1040 		h->sco_num--;
1041 		break;
1042 	case ISO_LINK:
1043 		h->iso_num--;
1044 		break;
1045 	}
1046 }
1047 
1048 static inline unsigned int hci_conn_num(struct hci_dev *hdev, __u8 type)
1049 {
1050 	struct hci_conn_hash *h = &hdev->conn_hash;
1051 	switch (type) {
1052 	case ACL_LINK:
1053 		return h->acl_num;
1054 	case AMP_LINK:
1055 		return h->amp_num;
1056 	case LE_LINK:
1057 		return h->le_num;
1058 	case SCO_LINK:
1059 	case ESCO_LINK:
1060 		return h->sco_num;
1061 	case ISO_LINK:
1062 		return h->iso_num;
1063 	default:
1064 		return 0;
1065 	}
1066 }
1067 
1068 static inline unsigned int hci_conn_count(struct hci_dev *hdev)
1069 {
1070 	struct hci_conn_hash *c = &hdev->conn_hash;
1071 
1072 	return c->acl_num + c->amp_num + c->sco_num + c->le_num + c->iso_num;
1073 }
1074 
1075 static inline __u8 hci_conn_lookup_type(struct hci_dev *hdev, __u16 handle)
1076 {
1077 	struct hci_conn_hash *h = &hdev->conn_hash;
1078 	struct hci_conn *c;
1079 	__u8 type = INVALID_LINK;
1080 
1081 	rcu_read_lock();
1082 
1083 	list_for_each_entry_rcu(c, &h->list, list) {
1084 		if (c->handle == handle) {
1085 			type = c->type;
1086 			break;
1087 		}
1088 	}
1089 
1090 	rcu_read_unlock();
1091 
1092 	return type;
1093 }
1094 
1095 static inline struct hci_conn *hci_conn_hash_lookup_bis(struct hci_dev *hdev,
1096 							bdaddr_t *ba,
1097 							__u8 big, __u8 bis)
1098 {
1099 	struct hci_conn_hash *h = &hdev->conn_hash;
1100 	struct hci_conn  *c;
1101 
1102 	rcu_read_lock();
1103 
1104 	list_for_each_entry_rcu(c, &h->list, list) {
1105 		if (bacmp(&c->dst, ba) || c->type != ISO_LINK)
1106 			continue;
1107 
1108 		if (c->iso_qos.bcast.big == big && c->iso_qos.bcast.bis == bis) {
1109 			rcu_read_unlock();
1110 			return c;
1111 		}
1112 	}
1113 	rcu_read_unlock();
1114 
1115 	return NULL;
1116 }
1117 
1118 static inline struct hci_conn *hci_conn_hash_lookup_handle(struct hci_dev *hdev,
1119 								__u16 handle)
1120 {
1121 	struct hci_conn_hash *h = &hdev->conn_hash;
1122 	struct hci_conn  *c;
1123 
1124 	rcu_read_lock();
1125 
1126 	list_for_each_entry_rcu(c, &h->list, list) {
1127 		if (c->handle == handle) {
1128 			rcu_read_unlock();
1129 			return c;
1130 		}
1131 	}
1132 	rcu_read_unlock();
1133 
1134 	return NULL;
1135 }
1136 
1137 static inline struct hci_conn *hci_conn_hash_lookup_ba(struct hci_dev *hdev,
1138 							__u8 type, bdaddr_t *ba)
1139 {
1140 	struct hci_conn_hash *h = &hdev->conn_hash;
1141 	struct hci_conn  *c;
1142 
1143 	rcu_read_lock();
1144 
1145 	list_for_each_entry_rcu(c, &h->list, list) {
1146 		if (c->type == type && !bacmp(&c->dst, ba)) {
1147 			rcu_read_unlock();
1148 			return c;
1149 		}
1150 	}
1151 
1152 	rcu_read_unlock();
1153 
1154 	return NULL;
1155 }
1156 
1157 static inline struct hci_conn *hci_conn_hash_lookup_le(struct hci_dev *hdev,
1158 						       bdaddr_t *ba,
1159 						       __u8 ba_type)
1160 {
1161 	struct hci_conn_hash *h = &hdev->conn_hash;
1162 	struct hci_conn  *c;
1163 
1164 	rcu_read_lock();
1165 
1166 	list_for_each_entry_rcu(c, &h->list, list) {
1167 		if (c->type != LE_LINK)
1168 		       continue;
1169 
1170 		if (ba_type == c->dst_type && !bacmp(&c->dst, ba)) {
1171 			rcu_read_unlock();
1172 			return c;
1173 		}
1174 	}
1175 
1176 	rcu_read_unlock();
1177 
1178 	return NULL;
1179 }
1180 
1181 static inline struct hci_conn *hci_conn_hash_lookup_cis(struct hci_dev *hdev,
1182 							bdaddr_t *ba,
1183 							__u8 ba_type,
1184 							__u8 cig,
1185 							__u8 id)
1186 {
1187 	struct hci_conn_hash *h = &hdev->conn_hash;
1188 	struct hci_conn  *c;
1189 
1190 	rcu_read_lock();
1191 
1192 	list_for_each_entry_rcu(c, &h->list, list) {
1193 		if (c->type != ISO_LINK)
1194 			continue;
1195 
1196 		/* Match CIG ID if set */
1197 		if (cig != BT_ISO_QOS_CIG_UNSET && cig != c->iso_qos.ucast.cig)
1198 			continue;
1199 
1200 		/* Match CIS ID if set */
1201 		if (id != BT_ISO_QOS_CIS_UNSET && id != c->iso_qos.ucast.cis)
1202 			continue;
1203 
1204 		/* Match destination address if set */
1205 		if (!ba || (ba_type == c->dst_type && !bacmp(&c->dst, ba))) {
1206 			rcu_read_unlock();
1207 			return c;
1208 		}
1209 	}
1210 
1211 	rcu_read_unlock();
1212 
1213 	return NULL;
1214 }
1215 
1216 static inline struct hci_conn *hci_conn_hash_lookup_cig(struct hci_dev *hdev,
1217 							__u8 handle)
1218 {
1219 	struct hci_conn_hash *h = &hdev->conn_hash;
1220 	struct hci_conn  *c;
1221 
1222 	rcu_read_lock();
1223 
1224 	list_for_each_entry_rcu(c, &h->list, list) {
1225 		if (c->type != ISO_LINK)
1226 			continue;
1227 
1228 		if (handle == c->iso_qos.ucast.cig) {
1229 			rcu_read_unlock();
1230 			return c;
1231 		}
1232 	}
1233 
1234 	rcu_read_unlock();
1235 
1236 	return NULL;
1237 }
1238 
1239 static inline struct hci_conn *hci_conn_hash_lookup_big(struct hci_dev *hdev,
1240 							__u8 handle)
1241 {
1242 	struct hci_conn_hash *h = &hdev->conn_hash;
1243 	struct hci_conn  *c;
1244 
1245 	rcu_read_lock();
1246 
1247 	list_for_each_entry_rcu(c, &h->list, list) {
1248 		if (bacmp(&c->dst, BDADDR_ANY) || c->type != ISO_LINK)
1249 			continue;
1250 
1251 		if (handle == c->iso_qos.bcast.big) {
1252 			rcu_read_unlock();
1253 			return c;
1254 		}
1255 	}
1256 
1257 	rcu_read_unlock();
1258 
1259 	return NULL;
1260 }
1261 
1262 static inline struct hci_conn *hci_conn_hash_lookup_state(struct hci_dev *hdev,
1263 							__u8 type, __u16 state)
1264 {
1265 	struct hci_conn_hash *h = &hdev->conn_hash;
1266 	struct hci_conn  *c;
1267 
1268 	rcu_read_lock();
1269 
1270 	list_for_each_entry_rcu(c, &h->list, list) {
1271 		if (c->type == type && c->state == state) {
1272 			rcu_read_unlock();
1273 			return c;
1274 		}
1275 	}
1276 
1277 	rcu_read_unlock();
1278 
1279 	return NULL;
1280 }
1281 
1282 typedef void (*hci_conn_func_t)(struct hci_conn *conn, void *data);
1283 static inline void hci_conn_hash_list_state(struct hci_dev *hdev,
1284 					    hci_conn_func_t func, __u8 type,
1285 					    __u16 state, void *data)
1286 {
1287 	struct hci_conn_hash *h = &hdev->conn_hash;
1288 	struct hci_conn  *c;
1289 
1290 	if (!func)
1291 		return;
1292 
1293 	rcu_read_lock();
1294 
1295 	list_for_each_entry_rcu(c, &h->list, list) {
1296 		if (c->type == type && c->state == state)
1297 			func(c, data);
1298 	}
1299 
1300 	rcu_read_unlock();
1301 }
1302 
1303 static inline struct hci_conn *hci_lookup_le_connect(struct hci_dev *hdev)
1304 {
1305 	struct hci_conn_hash *h = &hdev->conn_hash;
1306 	struct hci_conn  *c;
1307 
1308 	rcu_read_lock();
1309 
1310 	list_for_each_entry_rcu(c, &h->list, list) {
1311 		if (c->type == LE_LINK && c->state == BT_CONNECT &&
1312 		    !test_bit(HCI_CONN_SCANNING, &c->flags)) {
1313 			rcu_read_unlock();
1314 			return c;
1315 		}
1316 	}
1317 
1318 	rcu_read_unlock();
1319 
1320 	return NULL;
1321 }
1322 
1323 int hci_disconnect(struct hci_conn *conn, __u8 reason);
1324 bool hci_setup_sync(struct hci_conn *conn, __u16 handle);
1325 void hci_sco_setup(struct hci_conn *conn, __u8 status);
1326 bool hci_iso_setup_path(struct hci_conn *conn);
1327 int hci_le_create_cis(struct hci_conn *conn);
1328 
1329 struct hci_conn *hci_conn_add(struct hci_dev *hdev, int type, bdaddr_t *dst,
1330 			      u8 role);
1331 void hci_conn_del(struct hci_conn *conn);
1332 void hci_conn_hash_flush(struct hci_dev *hdev);
1333 void hci_conn_check_pending(struct hci_dev *hdev);
1334 
1335 struct hci_chan *hci_chan_create(struct hci_conn *conn);
1336 void hci_chan_del(struct hci_chan *chan);
1337 void hci_chan_list_flush(struct hci_conn *conn);
1338 struct hci_chan *hci_chan_lookup_handle(struct hci_dev *hdev, __u16 handle);
1339 
1340 struct hci_conn *hci_connect_le_scan(struct hci_dev *hdev, bdaddr_t *dst,
1341 				     u8 dst_type, u8 sec_level,
1342 				     u16 conn_timeout,
1343 				     enum conn_reasons conn_reason);
1344 struct hci_conn *hci_connect_le(struct hci_dev *hdev, bdaddr_t *dst,
1345 				u8 dst_type, bool dst_resolved, u8 sec_level,
1346 				u16 conn_timeout, u8 role);
1347 struct hci_conn *hci_connect_acl(struct hci_dev *hdev, bdaddr_t *dst,
1348 				 u8 sec_level, u8 auth_type,
1349 				 enum conn_reasons conn_reason);
1350 struct hci_conn *hci_connect_sco(struct hci_dev *hdev, int type, bdaddr_t *dst,
1351 				 __u16 setting, struct bt_codec *codec);
1352 struct hci_conn *hci_bind_cis(struct hci_dev *hdev, bdaddr_t *dst,
1353 			      __u8 dst_type, struct bt_iso_qos *qos);
1354 struct hci_conn *hci_connect_cis(struct hci_dev *hdev, bdaddr_t *dst,
1355 				 __u8 dst_type, struct bt_iso_qos *qos);
1356 struct hci_conn *hci_connect_bis(struct hci_dev *hdev, bdaddr_t *dst,
1357 				 __u8 dst_type, struct bt_iso_qos *qos,
1358 				 __u8 data_len, __u8 *data);
1359 int hci_pa_create_sync(struct hci_dev *hdev, bdaddr_t *dst, __u8 dst_type,
1360 		       __u8 sid, struct bt_iso_qos *qos);
1361 int hci_le_big_create_sync(struct hci_dev *hdev, struct bt_iso_qos *qos,
1362 			   __u16 sync_handle, __u8 num_bis, __u8 bis[]);
1363 int hci_conn_check_link_mode(struct hci_conn *conn);
1364 int hci_conn_check_secure(struct hci_conn *conn, __u8 sec_level);
1365 int hci_conn_security(struct hci_conn *conn, __u8 sec_level, __u8 auth_type,
1366 		      bool initiator);
1367 int hci_conn_switch_role(struct hci_conn *conn, __u8 role);
1368 
1369 void hci_conn_enter_active_mode(struct hci_conn *conn, __u8 force_active);
1370 
1371 void hci_conn_failed(struct hci_conn *conn, u8 status);
1372 
1373 /*
1374  * hci_conn_get() and hci_conn_put() are used to control the life-time of an
1375  * "hci_conn" object. They do not guarantee that the hci_conn object is running,
1376  * working or anything else. They just guarantee that the object is available
1377  * and can be dereferenced. So you can use its locks, local variables and any
1378  * other constant data.
1379  * Before accessing runtime data, you _must_ lock the object and then check that
1380  * it is still running. As soon as you release the locks, the connection might
1381  * get dropped, though.
1382  *
1383  * On the other hand, hci_conn_hold() and hci_conn_drop() are used to control
1384  * how long the underlying connection is held. So every channel that runs on the
1385  * hci_conn object calls this to prevent the connection from disappearing. As
1386  * long as you hold a device, you must also guarantee that you have a valid
1387  * reference to the device via hci_conn_get() (or the initial reference from
1388  * hci_conn_add()).
1389  * The hold()/drop() ref-count is known to drop below 0 sometimes, which doesn't
1390  * break because nobody cares for that. But this means, we cannot use
1391  * _get()/_drop() in it, but require the caller to have a valid ref (FIXME).
1392  */
1393 
1394 static inline struct hci_conn *hci_conn_get(struct hci_conn *conn)
1395 {
1396 	get_device(&conn->dev);
1397 	return conn;
1398 }
1399 
1400 static inline void hci_conn_put(struct hci_conn *conn)
1401 {
1402 	put_device(&conn->dev);
1403 }
1404 
1405 static inline struct hci_conn *hci_conn_hold(struct hci_conn *conn)
1406 {
1407 	BT_DBG("hcon %p orig refcnt %d", conn, atomic_read(&conn->refcnt));
1408 
1409 	atomic_inc(&conn->refcnt);
1410 	cancel_delayed_work(&conn->disc_work);
1411 
1412 	return conn;
1413 }
1414 
1415 static inline void hci_conn_drop(struct hci_conn *conn)
1416 {
1417 	BT_DBG("hcon %p orig refcnt %d", conn, atomic_read(&conn->refcnt));
1418 
1419 	if (atomic_dec_and_test(&conn->refcnt)) {
1420 		unsigned long timeo;
1421 
1422 		switch (conn->type) {
1423 		case ACL_LINK:
1424 		case LE_LINK:
1425 			cancel_delayed_work(&conn->idle_work);
1426 			if (conn->state == BT_CONNECTED) {
1427 				timeo = conn->disc_timeout;
1428 				if (!conn->out)
1429 					timeo *= 2;
1430 			} else {
1431 				timeo = 0;
1432 			}
1433 			break;
1434 
1435 		case AMP_LINK:
1436 			timeo = conn->disc_timeout;
1437 			break;
1438 
1439 		default:
1440 			timeo = 0;
1441 			break;
1442 		}
1443 
1444 		cancel_delayed_work(&conn->disc_work);
1445 		queue_delayed_work(conn->hdev->workqueue,
1446 				   &conn->disc_work, timeo);
1447 	}
1448 }
1449 
1450 /* ----- HCI Devices ----- */
1451 static inline void hci_dev_put(struct hci_dev *d)
1452 {
1453 	BT_DBG("%s orig refcnt %d", d->name,
1454 	       kref_read(&d->dev.kobj.kref));
1455 
1456 	put_device(&d->dev);
1457 }
1458 
1459 static inline struct hci_dev *hci_dev_hold(struct hci_dev *d)
1460 {
1461 	BT_DBG("%s orig refcnt %d", d->name,
1462 	       kref_read(&d->dev.kobj.kref));
1463 
1464 	get_device(&d->dev);
1465 	return d;
1466 }
1467 
1468 #define hci_dev_lock(d)		mutex_lock(&d->lock)
1469 #define hci_dev_unlock(d)	mutex_unlock(&d->lock)
1470 
1471 #define to_hci_dev(d) container_of(d, struct hci_dev, dev)
1472 #define to_hci_conn(c) container_of(c, struct hci_conn, dev)
1473 
1474 static inline void *hci_get_drvdata(struct hci_dev *hdev)
1475 {
1476 	return dev_get_drvdata(&hdev->dev);
1477 }
1478 
1479 static inline void hci_set_drvdata(struct hci_dev *hdev, void *data)
1480 {
1481 	dev_set_drvdata(&hdev->dev, data);
1482 }
1483 
1484 static inline void *hci_get_priv(struct hci_dev *hdev)
1485 {
1486 	return (char *)hdev + sizeof(*hdev);
1487 }
1488 
1489 struct hci_dev *hci_dev_get(int index);
1490 struct hci_dev *hci_get_route(bdaddr_t *dst, bdaddr_t *src, u8 src_type);
1491 
1492 struct hci_dev *hci_alloc_dev_priv(int sizeof_priv);
1493 
1494 static inline struct hci_dev *hci_alloc_dev(void)
1495 {
1496 	return hci_alloc_dev_priv(0);
1497 }
1498 
1499 void hci_free_dev(struct hci_dev *hdev);
1500 int hci_register_dev(struct hci_dev *hdev);
1501 void hci_unregister_dev(struct hci_dev *hdev);
1502 void hci_release_dev(struct hci_dev *hdev);
1503 int hci_register_suspend_notifier(struct hci_dev *hdev);
1504 int hci_unregister_suspend_notifier(struct hci_dev *hdev);
1505 int hci_suspend_dev(struct hci_dev *hdev);
1506 int hci_resume_dev(struct hci_dev *hdev);
1507 int hci_reset_dev(struct hci_dev *hdev);
1508 int hci_recv_frame(struct hci_dev *hdev, struct sk_buff *skb);
1509 int hci_recv_diag(struct hci_dev *hdev, struct sk_buff *skb);
1510 __printf(2, 3) void hci_set_hw_info(struct hci_dev *hdev, const char *fmt, ...);
1511 __printf(2, 3) void hci_set_fw_info(struct hci_dev *hdev, const char *fmt, ...);
1512 
1513 static inline void hci_set_msft_opcode(struct hci_dev *hdev, __u16 opcode)
1514 {
1515 #if IS_ENABLED(CONFIG_BT_MSFTEXT)
1516 	hdev->msft_opcode = opcode;
1517 #endif
1518 }
1519 
1520 static inline void hci_set_aosp_capable(struct hci_dev *hdev)
1521 {
1522 #if IS_ENABLED(CONFIG_BT_AOSPEXT)
1523 	hdev->aosp_capable = true;
1524 #endif
1525 }
1526 
1527 static inline void hci_devcd_setup(struct hci_dev *hdev)
1528 {
1529 #ifdef CONFIG_DEV_COREDUMP
1530 	INIT_WORK(&hdev->dump.dump_rx, hci_devcd_rx);
1531 	INIT_DELAYED_WORK(&hdev->dump.dump_timeout, hci_devcd_timeout);
1532 	skb_queue_head_init(&hdev->dump.dump_q);
1533 #endif
1534 }
1535 
1536 int hci_dev_open(__u16 dev);
1537 int hci_dev_close(__u16 dev);
1538 int hci_dev_do_close(struct hci_dev *hdev);
1539 int hci_dev_reset(__u16 dev);
1540 int hci_dev_reset_stat(__u16 dev);
1541 int hci_dev_cmd(unsigned int cmd, void __user *arg);
1542 int hci_get_dev_list(void __user *arg);
1543 int hci_get_dev_info(void __user *arg);
1544 int hci_get_conn_list(void __user *arg);
1545 int hci_get_conn_info(struct hci_dev *hdev, void __user *arg);
1546 int hci_get_auth_info(struct hci_dev *hdev, void __user *arg);
1547 int hci_inquiry(void __user *arg);
1548 
1549 struct bdaddr_list *hci_bdaddr_list_lookup(struct list_head *list,
1550 					   bdaddr_t *bdaddr, u8 type);
1551 struct bdaddr_list_with_irk *hci_bdaddr_list_lookup_with_irk(
1552 				    struct list_head *list, bdaddr_t *bdaddr,
1553 				    u8 type);
1554 struct bdaddr_list_with_flags *
1555 hci_bdaddr_list_lookup_with_flags(struct list_head *list, bdaddr_t *bdaddr,
1556 				  u8 type);
1557 int hci_bdaddr_list_add(struct list_head *list, bdaddr_t *bdaddr, u8 type);
1558 int hci_bdaddr_list_add_with_irk(struct list_head *list, bdaddr_t *bdaddr,
1559 				 u8 type, u8 *peer_irk, u8 *local_irk);
1560 int hci_bdaddr_list_add_with_flags(struct list_head *list, bdaddr_t *bdaddr,
1561 				   u8 type, u32 flags);
1562 int hci_bdaddr_list_del(struct list_head *list, bdaddr_t *bdaddr, u8 type);
1563 int hci_bdaddr_list_del_with_irk(struct list_head *list, bdaddr_t *bdaddr,
1564 				 u8 type);
1565 int hci_bdaddr_list_del_with_flags(struct list_head *list, bdaddr_t *bdaddr,
1566 				   u8 type);
1567 void hci_bdaddr_list_clear(struct list_head *list);
1568 
1569 struct hci_conn_params *hci_conn_params_lookup(struct hci_dev *hdev,
1570 					       bdaddr_t *addr, u8 addr_type);
1571 struct hci_conn_params *hci_conn_params_add(struct hci_dev *hdev,
1572 					    bdaddr_t *addr, u8 addr_type);
1573 void hci_conn_params_del(struct hci_dev *hdev, bdaddr_t *addr, u8 addr_type);
1574 void hci_conn_params_clear_disabled(struct hci_dev *hdev);
1575 void hci_conn_params_free(struct hci_conn_params *param);
1576 
1577 void hci_pend_le_list_del_init(struct hci_conn_params *param);
1578 void hci_pend_le_list_add(struct hci_conn_params *param,
1579 			  struct list_head *list);
1580 struct hci_conn_params *hci_pend_le_action_lookup(struct list_head *list,
1581 						  bdaddr_t *addr,
1582 						  u8 addr_type);
1583 
1584 void hci_uuids_clear(struct hci_dev *hdev);
1585 
1586 void hci_link_keys_clear(struct hci_dev *hdev);
1587 struct link_key *hci_find_link_key(struct hci_dev *hdev, bdaddr_t *bdaddr);
1588 struct link_key *hci_add_link_key(struct hci_dev *hdev, struct hci_conn *conn,
1589 				  bdaddr_t *bdaddr, u8 *val, u8 type,
1590 				  u8 pin_len, bool *persistent);
1591 struct smp_ltk *hci_add_ltk(struct hci_dev *hdev, bdaddr_t *bdaddr,
1592 			    u8 addr_type, u8 type, u8 authenticated,
1593 			    u8 tk[16], u8 enc_size, __le16 ediv, __le64 rand);
1594 struct smp_ltk *hci_find_ltk(struct hci_dev *hdev, bdaddr_t *bdaddr,
1595 			     u8 addr_type, u8 role);
1596 int hci_remove_ltk(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 bdaddr_type);
1597 void hci_smp_ltks_clear(struct hci_dev *hdev);
1598 int hci_remove_link_key(struct hci_dev *hdev, bdaddr_t *bdaddr);
1599 
1600 struct smp_irk *hci_find_irk_by_rpa(struct hci_dev *hdev, bdaddr_t *rpa);
1601 struct smp_irk *hci_find_irk_by_addr(struct hci_dev *hdev, bdaddr_t *bdaddr,
1602 				     u8 addr_type);
1603 struct smp_irk *hci_add_irk(struct hci_dev *hdev, bdaddr_t *bdaddr,
1604 			    u8 addr_type, u8 val[16], bdaddr_t *rpa);
1605 void hci_remove_irk(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 addr_type);
1606 bool hci_is_blocked_key(struct hci_dev *hdev, u8 type, u8 val[16]);
1607 void hci_blocked_keys_clear(struct hci_dev *hdev);
1608 void hci_smp_irks_clear(struct hci_dev *hdev);
1609 
1610 bool hci_bdaddr_is_paired(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 type);
1611 
1612 void hci_remote_oob_data_clear(struct hci_dev *hdev);
1613 struct oob_data *hci_find_remote_oob_data(struct hci_dev *hdev,
1614 					  bdaddr_t *bdaddr, u8 bdaddr_type);
1615 int hci_add_remote_oob_data(struct hci_dev *hdev, bdaddr_t *bdaddr,
1616 			    u8 bdaddr_type, u8 *hash192, u8 *rand192,
1617 			    u8 *hash256, u8 *rand256);
1618 int hci_remove_remote_oob_data(struct hci_dev *hdev, bdaddr_t *bdaddr,
1619 			       u8 bdaddr_type);
1620 
1621 void hci_adv_instances_clear(struct hci_dev *hdev);
1622 struct adv_info *hci_find_adv_instance(struct hci_dev *hdev, u8 instance);
1623 struct adv_info *hci_get_next_instance(struct hci_dev *hdev, u8 instance);
1624 struct adv_info *hci_add_adv_instance(struct hci_dev *hdev, u8 instance,
1625 				      u32 flags, u16 adv_data_len, u8 *adv_data,
1626 				      u16 scan_rsp_len, u8 *scan_rsp_data,
1627 				      u16 timeout, u16 duration, s8 tx_power,
1628 				      u32 min_interval, u32 max_interval,
1629 				      u8 mesh_handle);
1630 struct adv_info *hci_add_per_instance(struct hci_dev *hdev, u8 instance,
1631 				      u32 flags, u8 data_len, u8 *data,
1632 				      u32 min_interval, u32 max_interval);
1633 int hci_set_adv_instance_data(struct hci_dev *hdev, u8 instance,
1634 			 u16 adv_data_len, u8 *adv_data,
1635 			 u16 scan_rsp_len, u8 *scan_rsp_data);
1636 int hci_remove_adv_instance(struct hci_dev *hdev, u8 instance);
1637 void hci_adv_instances_set_rpa_expired(struct hci_dev *hdev, bool rpa_expired);
1638 u32 hci_adv_instance_flags(struct hci_dev *hdev, u8 instance);
1639 bool hci_adv_instance_is_scannable(struct hci_dev *hdev, u8 instance);
1640 
1641 void hci_adv_monitors_clear(struct hci_dev *hdev);
1642 void hci_free_adv_monitor(struct hci_dev *hdev, struct adv_monitor *monitor);
1643 int hci_add_adv_monitor(struct hci_dev *hdev, struct adv_monitor *monitor);
1644 int hci_remove_single_adv_monitor(struct hci_dev *hdev, u16 handle);
1645 int hci_remove_all_adv_monitor(struct hci_dev *hdev);
1646 bool hci_is_adv_monitoring(struct hci_dev *hdev);
1647 int hci_get_adv_monitor_offload_ext(struct hci_dev *hdev);
1648 
1649 void hci_event_packet(struct hci_dev *hdev, struct sk_buff *skb);
1650 
1651 void hci_init_sysfs(struct hci_dev *hdev);
1652 void hci_conn_init_sysfs(struct hci_conn *conn);
1653 void hci_conn_add_sysfs(struct hci_conn *conn);
1654 void hci_conn_del_sysfs(struct hci_conn *conn);
1655 
1656 #define SET_HCIDEV_DEV(hdev, pdev) ((hdev)->dev.parent = (pdev))
1657 #define GET_HCIDEV_DEV(hdev) ((hdev)->dev.parent)
1658 
1659 /* ----- LMP capabilities ----- */
1660 #define lmp_encrypt_capable(dev)   ((dev)->features[0][0] & LMP_ENCRYPT)
1661 #define lmp_rswitch_capable(dev)   ((dev)->features[0][0] & LMP_RSWITCH)
1662 #define lmp_hold_capable(dev)      ((dev)->features[0][0] & LMP_HOLD)
1663 #define lmp_sniff_capable(dev)     ((dev)->features[0][0] & LMP_SNIFF)
1664 #define lmp_park_capable(dev)      ((dev)->features[0][1] & LMP_PARK)
1665 #define lmp_inq_rssi_capable(dev)  ((dev)->features[0][3] & LMP_RSSI_INQ)
1666 #define lmp_esco_capable(dev)      ((dev)->features[0][3] & LMP_ESCO)
1667 #define lmp_bredr_capable(dev)     (!((dev)->features[0][4] & LMP_NO_BREDR))
1668 #define lmp_le_capable(dev)        ((dev)->features[0][4] & LMP_LE)
1669 #define lmp_sniffsubr_capable(dev) ((dev)->features[0][5] & LMP_SNIFF_SUBR)
1670 #define lmp_pause_enc_capable(dev) ((dev)->features[0][5] & LMP_PAUSE_ENC)
1671 #define lmp_esco_2m_capable(dev)   ((dev)->features[0][5] & LMP_EDR_ESCO_2M)
1672 #define lmp_ext_inq_capable(dev)   ((dev)->features[0][6] & LMP_EXT_INQ)
1673 #define lmp_le_br_capable(dev)     (!!((dev)->features[0][6] & LMP_SIMUL_LE_BR))
1674 #define lmp_ssp_capable(dev)       ((dev)->features[0][6] & LMP_SIMPLE_PAIR)
1675 #define lmp_no_flush_capable(dev)  ((dev)->features[0][6] & LMP_NO_FLUSH)
1676 #define lmp_lsto_capable(dev)      ((dev)->features[0][7] & LMP_LSTO)
1677 #define lmp_inq_tx_pwr_capable(dev) ((dev)->features[0][7] & LMP_INQ_TX_PWR)
1678 #define lmp_ext_feat_capable(dev)  ((dev)->features[0][7] & LMP_EXTFEATURES)
1679 #define lmp_transp_capable(dev)    ((dev)->features[0][2] & LMP_TRANSPARENT)
1680 #define lmp_edr_2m_capable(dev)    ((dev)->features[0][3] & LMP_EDR_2M)
1681 #define lmp_edr_3m_capable(dev)    ((dev)->features[0][3] & LMP_EDR_3M)
1682 #define lmp_edr_3slot_capable(dev) ((dev)->features[0][4] & LMP_EDR_3SLOT)
1683 #define lmp_edr_5slot_capable(dev) ((dev)->features[0][5] & LMP_EDR_5SLOT)
1684 
1685 /* ----- Extended LMP capabilities ----- */
1686 #define lmp_cpb_central_capable(dev) ((dev)->features[2][0] & LMP_CPB_CENTRAL)
1687 #define lmp_cpb_peripheral_capable(dev) ((dev)->features[2][0] & LMP_CPB_PERIPHERAL)
1688 #define lmp_sync_train_capable(dev) ((dev)->features[2][0] & LMP_SYNC_TRAIN)
1689 #define lmp_sync_scan_capable(dev)  ((dev)->features[2][0] & LMP_SYNC_SCAN)
1690 #define lmp_sc_capable(dev)         ((dev)->features[2][1] & LMP_SC)
1691 #define lmp_ping_capable(dev)       ((dev)->features[2][1] & LMP_PING)
1692 
1693 /* ----- Host capabilities ----- */
1694 #define lmp_host_ssp_capable(dev)  ((dev)->features[1][0] & LMP_HOST_SSP)
1695 #define lmp_host_sc_capable(dev)   ((dev)->features[1][0] & LMP_HOST_SC)
1696 #define lmp_host_le_capable(dev)   (!!((dev)->features[1][0] & LMP_HOST_LE))
1697 #define lmp_host_le_br_capable(dev) (!!((dev)->features[1][0] & LMP_HOST_LE_BREDR))
1698 
1699 #define hdev_is_powered(dev)   (test_bit(HCI_UP, &(dev)->flags) && \
1700 				!hci_dev_test_flag(dev, HCI_AUTO_OFF))
1701 #define bredr_sc_enabled(dev)  (lmp_sc_capable(dev) && \
1702 				hci_dev_test_flag(dev, HCI_SC_ENABLED))
1703 #define rpa_valid(dev)         (bacmp(&dev->rpa, BDADDR_ANY) && \
1704 				!hci_dev_test_flag(dev, HCI_RPA_EXPIRED))
1705 #define adv_rpa_valid(adv)     (bacmp(&adv->random_addr, BDADDR_ANY) && \
1706 				!adv->rpa_expired)
1707 
1708 #define scan_1m(dev) (((dev)->le_tx_def_phys & HCI_LE_SET_PHY_1M) || \
1709 		      ((dev)->le_rx_def_phys & HCI_LE_SET_PHY_1M))
1710 
1711 #define le_2m_capable(dev) (((dev)->le_features[1] & HCI_LE_PHY_2M))
1712 
1713 #define scan_2m(dev) (((dev)->le_tx_def_phys & HCI_LE_SET_PHY_2M) || \
1714 		      ((dev)->le_rx_def_phys & HCI_LE_SET_PHY_2M))
1715 
1716 #define le_coded_capable(dev) (((dev)->le_features[1] & HCI_LE_PHY_CODED))
1717 
1718 #define scan_coded(dev) (((dev)->le_tx_def_phys & HCI_LE_SET_PHY_CODED) || \
1719 			 ((dev)->le_rx_def_phys & HCI_LE_SET_PHY_CODED))
1720 
1721 #define ll_privacy_capable(dev) ((dev)->le_features[0] & HCI_LE_LL_PRIVACY)
1722 
1723 /* Use LL Privacy based address resolution if supported */
1724 #define use_ll_privacy(dev) (ll_privacy_capable(dev) && \
1725 			     hci_dev_test_flag(dev, HCI_ENABLE_LL_PRIVACY))
1726 
1727 #define privacy_mode_capable(dev) (use_ll_privacy(dev) && \
1728 				   (hdev->commands[39] & 0x04))
1729 
1730 /* Use enhanced synchronous connection if command is supported and its quirk
1731  * has not been set.
1732  */
1733 #define enhanced_sync_conn_capable(dev) \
1734 	(((dev)->commands[29] & 0x08) && \
1735 	 !test_bit(HCI_QUIRK_BROKEN_ENHANCED_SETUP_SYNC_CONN, &(dev)->quirks))
1736 
1737 /* Use ext scanning if set ext scan param and ext scan enable is supported */
1738 #define use_ext_scan(dev) (((dev)->commands[37] & 0x20) && \
1739 			   ((dev)->commands[37] & 0x40) && \
1740 			   !test_bit(HCI_QUIRK_BROKEN_EXT_SCAN, &(dev)->quirks))
1741 
1742 /* Use ext create connection if command is supported */
1743 #define use_ext_conn(dev) ((dev)->commands[37] & 0x80)
1744 
1745 /* Extended advertising support */
1746 #define ext_adv_capable(dev) (((dev)->le_features[1] & HCI_LE_EXT_ADV))
1747 
1748 /* BLUETOOTH CORE SPECIFICATION Version 5.3 | Vol 4, Part E page 1789:
1749  *
1750  * C24: Mandatory if the LE Controller supports Connection State and either
1751  * LE Feature (LL Privacy) or LE Feature (Extended Advertising) is supported
1752  */
1753 #define use_enhanced_conn_complete(dev) (ll_privacy_capable(dev) || \
1754 					 ext_adv_capable(dev))
1755 
1756 /* Periodic advertising support */
1757 #define per_adv_capable(dev) (((dev)->le_features[1] & HCI_LE_PERIODIC_ADV))
1758 
1759 /* CIS Master/Slave and BIS support */
1760 #define iso_capable(dev) (cis_capable(dev) || bis_capable(dev))
1761 #define cis_capable(dev) \
1762 	(cis_central_capable(dev) || cis_peripheral_capable(dev))
1763 #define cis_central_capable(dev) \
1764 	((dev)->le_features[3] & HCI_LE_CIS_CENTRAL)
1765 #define cis_peripheral_capable(dev) \
1766 	((dev)->le_features[3] & HCI_LE_CIS_PERIPHERAL)
1767 #define bis_capable(dev) ((dev)->le_features[3] & HCI_LE_ISO_BROADCASTER)
1768 
1769 #define mws_transport_config_capable(dev) (((dev)->commands[30] & 0x08) && \
1770 	(!test_bit(HCI_QUIRK_BROKEN_MWS_TRANSPORT_CONFIG, &(dev)->quirks)))
1771 
1772 /* ----- HCI protocols ----- */
1773 #define HCI_PROTO_DEFER             0x01
1774 
1775 static inline int hci_proto_connect_ind(struct hci_dev *hdev, bdaddr_t *bdaddr,
1776 					__u8 type, __u8 *flags)
1777 {
1778 	switch (type) {
1779 	case ACL_LINK:
1780 		return l2cap_connect_ind(hdev, bdaddr);
1781 
1782 	case SCO_LINK:
1783 	case ESCO_LINK:
1784 		return sco_connect_ind(hdev, bdaddr, flags);
1785 
1786 	case ISO_LINK:
1787 		return iso_connect_ind(hdev, bdaddr, flags);
1788 
1789 	default:
1790 		BT_ERR("unknown link type %d", type);
1791 		return -EINVAL;
1792 	}
1793 }
1794 
1795 static inline int hci_proto_disconn_ind(struct hci_conn *conn)
1796 {
1797 	if (conn->type != ACL_LINK && conn->type != LE_LINK)
1798 		return HCI_ERROR_REMOTE_USER_TERM;
1799 
1800 	return l2cap_disconn_ind(conn);
1801 }
1802 
1803 /* ----- HCI callbacks ----- */
1804 struct hci_cb {
1805 	struct list_head list;
1806 
1807 	char *name;
1808 
1809 	void (*connect_cfm)	(struct hci_conn *conn, __u8 status);
1810 	void (*disconn_cfm)	(struct hci_conn *conn, __u8 status);
1811 	void (*security_cfm)	(struct hci_conn *conn, __u8 status,
1812 								__u8 encrypt);
1813 	void (*key_change_cfm)	(struct hci_conn *conn, __u8 status);
1814 	void (*role_switch_cfm)	(struct hci_conn *conn, __u8 status, __u8 role);
1815 };
1816 
1817 static inline void hci_connect_cfm(struct hci_conn *conn, __u8 status)
1818 {
1819 	struct hci_cb *cb;
1820 
1821 	mutex_lock(&hci_cb_list_lock);
1822 	list_for_each_entry(cb, &hci_cb_list, list) {
1823 		if (cb->connect_cfm)
1824 			cb->connect_cfm(conn, status);
1825 	}
1826 	mutex_unlock(&hci_cb_list_lock);
1827 
1828 	if (conn->connect_cfm_cb)
1829 		conn->connect_cfm_cb(conn, status);
1830 }
1831 
1832 static inline void hci_disconn_cfm(struct hci_conn *conn, __u8 reason)
1833 {
1834 	struct hci_cb *cb;
1835 
1836 	mutex_lock(&hci_cb_list_lock);
1837 	list_for_each_entry(cb, &hci_cb_list, list) {
1838 		if (cb->disconn_cfm)
1839 			cb->disconn_cfm(conn, reason);
1840 	}
1841 	mutex_unlock(&hci_cb_list_lock);
1842 
1843 	if (conn->disconn_cfm_cb)
1844 		conn->disconn_cfm_cb(conn, reason);
1845 }
1846 
1847 static inline void hci_auth_cfm(struct hci_conn *conn, __u8 status)
1848 {
1849 	struct hci_cb *cb;
1850 	__u8 encrypt;
1851 
1852 	if (test_bit(HCI_CONN_ENCRYPT_PEND, &conn->flags))
1853 		return;
1854 
1855 	encrypt = test_bit(HCI_CONN_ENCRYPT, &conn->flags) ? 0x01 : 0x00;
1856 
1857 	mutex_lock(&hci_cb_list_lock);
1858 	list_for_each_entry(cb, &hci_cb_list, list) {
1859 		if (cb->security_cfm)
1860 			cb->security_cfm(conn, status, encrypt);
1861 	}
1862 	mutex_unlock(&hci_cb_list_lock);
1863 
1864 	if (conn->security_cfm_cb)
1865 		conn->security_cfm_cb(conn, status);
1866 }
1867 
1868 static inline void hci_encrypt_cfm(struct hci_conn *conn, __u8 status)
1869 {
1870 	struct hci_cb *cb;
1871 	__u8 encrypt;
1872 
1873 	if (conn->state == BT_CONFIG) {
1874 		if (!status)
1875 			conn->state = BT_CONNECTED;
1876 
1877 		hci_connect_cfm(conn, status);
1878 		hci_conn_drop(conn);
1879 		return;
1880 	}
1881 
1882 	if (!test_bit(HCI_CONN_ENCRYPT, &conn->flags))
1883 		encrypt = 0x00;
1884 	else if (test_bit(HCI_CONN_AES_CCM, &conn->flags))
1885 		encrypt = 0x02;
1886 	else
1887 		encrypt = 0x01;
1888 
1889 	if (!status) {
1890 		if (conn->sec_level == BT_SECURITY_SDP)
1891 			conn->sec_level = BT_SECURITY_LOW;
1892 
1893 		if (conn->pending_sec_level > conn->sec_level)
1894 			conn->sec_level = conn->pending_sec_level;
1895 	}
1896 
1897 	mutex_lock(&hci_cb_list_lock);
1898 	list_for_each_entry(cb, &hci_cb_list, list) {
1899 		if (cb->security_cfm)
1900 			cb->security_cfm(conn, status, encrypt);
1901 	}
1902 	mutex_unlock(&hci_cb_list_lock);
1903 
1904 	if (conn->security_cfm_cb)
1905 		conn->security_cfm_cb(conn, status);
1906 }
1907 
1908 static inline void hci_key_change_cfm(struct hci_conn *conn, __u8 status)
1909 {
1910 	struct hci_cb *cb;
1911 
1912 	mutex_lock(&hci_cb_list_lock);
1913 	list_for_each_entry(cb, &hci_cb_list, list) {
1914 		if (cb->key_change_cfm)
1915 			cb->key_change_cfm(conn, status);
1916 	}
1917 	mutex_unlock(&hci_cb_list_lock);
1918 }
1919 
1920 static inline void hci_role_switch_cfm(struct hci_conn *conn, __u8 status,
1921 								__u8 role)
1922 {
1923 	struct hci_cb *cb;
1924 
1925 	mutex_lock(&hci_cb_list_lock);
1926 	list_for_each_entry(cb, &hci_cb_list, list) {
1927 		if (cb->role_switch_cfm)
1928 			cb->role_switch_cfm(conn, status, role);
1929 	}
1930 	mutex_unlock(&hci_cb_list_lock);
1931 }
1932 
1933 static inline bool hci_bdaddr_is_rpa(bdaddr_t *bdaddr, u8 addr_type)
1934 {
1935 	if (addr_type != ADDR_LE_DEV_RANDOM)
1936 		return false;
1937 
1938 	if ((bdaddr->b[5] & 0xc0) == 0x40)
1939 	       return true;
1940 
1941 	return false;
1942 }
1943 
1944 static inline bool hci_is_identity_address(bdaddr_t *addr, u8 addr_type)
1945 {
1946 	if (addr_type == ADDR_LE_DEV_PUBLIC)
1947 		return true;
1948 
1949 	/* Check for Random Static address type */
1950 	if ((addr->b[5] & 0xc0) == 0xc0)
1951 		return true;
1952 
1953 	return false;
1954 }
1955 
1956 static inline struct smp_irk *hci_get_irk(struct hci_dev *hdev,
1957 					  bdaddr_t *bdaddr, u8 addr_type)
1958 {
1959 	if (!hci_bdaddr_is_rpa(bdaddr, addr_type))
1960 		return NULL;
1961 
1962 	return hci_find_irk_by_rpa(hdev, bdaddr);
1963 }
1964 
1965 static inline int hci_check_conn_params(u16 min, u16 max, u16 latency,
1966 					u16 to_multiplier)
1967 {
1968 	u16 max_latency;
1969 
1970 	if (min > max || min < 6 || max > 3200)
1971 		return -EINVAL;
1972 
1973 	if (to_multiplier < 10 || to_multiplier > 3200)
1974 		return -EINVAL;
1975 
1976 	if (max >= to_multiplier * 8)
1977 		return -EINVAL;
1978 
1979 	max_latency = (to_multiplier * 4 / max) - 1;
1980 	if (latency > 499 || latency > max_latency)
1981 		return -EINVAL;
1982 
1983 	return 0;
1984 }
1985 
1986 int hci_register_cb(struct hci_cb *hcb);
1987 int hci_unregister_cb(struct hci_cb *hcb);
1988 
1989 int __hci_cmd_send(struct hci_dev *hdev, u16 opcode, u32 plen,
1990 		   const void *param);
1991 
1992 int hci_send_cmd(struct hci_dev *hdev, __u16 opcode, __u32 plen,
1993 		 const void *param);
1994 void hci_send_acl(struct hci_chan *chan, struct sk_buff *skb, __u16 flags);
1995 void hci_send_sco(struct hci_conn *conn, struct sk_buff *skb);
1996 void hci_send_iso(struct hci_conn *conn, struct sk_buff *skb);
1997 
1998 void *hci_sent_cmd_data(struct hci_dev *hdev, __u16 opcode);
1999 void *hci_recv_event_data(struct hci_dev *hdev, __u8 event);
2000 
2001 u32 hci_conn_get_phy(struct hci_conn *conn);
2002 
2003 /* ----- HCI Sockets ----- */
2004 void hci_send_to_sock(struct hci_dev *hdev, struct sk_buff *skb);
2005 void hci_send_to_channel(unsigned short channel, struct sk_buff *skb,
2006 			 int flag, struct sock *skip_sk);
2007 void hci_send_to_monitor(struct hci_dev *hdev, struct sk_buff *skb);
2008 void hci_send_monitor_ctrl_event(struct hci_dev *hdev, u16 event,
2009 				 void *data, u16 data_len, ktime_t tstamp,
2010 				 int flag, struct sock *skip_sk);
2011 
2012 void hci_sock_dev_event(struct hci_dev *hdev, int event);
2013 
2014 #define HCI_MGMT_VAR_LEN	BIT(0)
2015 #define HCI_MGMT_NO_HDEV	BIT(1)
2016 #define HCI_MGMT_UNTRUSTED	BIT(2)
2017 #define HCI_MGMT_UNCONFIGURED	BIT(3)
2018 #define HCI_MGMT_HDEV_OPTIONAL	BIT(4)
2019 
2020 struct hci_mgmt_handler {
2021 	int (*func) (struct sock *sk, struct hci_dev *hdev, void *data,
2022 		     u16 data_len);
2023 	size_t data_len;
2024 	unsigned long flags;
2025 };
2026 
2027 struct hci_mgmt_chan {
2028 	struct list_head list;
2029 	unsigned short channel;
2030 	size_t handler_count;
2031 	const struct hci_mgmt_handler *handlers;
2032 	void (*hdev_init) (struct sock *sk, struct hci_dev *hdev);
2033 };
2034 
2035 int hci_mgmt_chan_register(struct hci_mgmt_chan *c);
2036 void hci_mgmt_chan_unregister(struct hci_mgmt_chan *c);
2037 
2038 /* Management interface */
2039 #define DISCOV_TYPE_BREDR		(BIT(BDADDR_BREDR))
2040 #define DISCOV_TYPE_LE			(BIT(BDADDR_LE_PUBLIC) | \
2041 					 BIT(BDADDR_LE_RANDOM))
2042 #define DISCOV_TYPE_INTERLEAVED		(BIT(BDADDR_BREDR) | \
2043 					 BIT(BDADDR_LE_PUBLIC) | \
2044 					 BIT(BDADDR_LE_RANDOM))
2045 
2046 /* These LE scan and inquiry parameters were chosen according to LE General
2047  * Discovery Procedure specification.
2048  */
2049 #define DISCOV_LE_SCAN_WIN		0x12
2050 #define DISCOV_LE_SCAN_INT		0x12
2051 #define DISCOV_LE_TIMEOUT		10240	/* msec */
2052 #define DISCOV_INTERLEAVED_TIMEOUT	5120	/* msec */
2053 #define DISCOV_INTERLEAVED_INQUIRY_LEN	0x04
2054 #define DISCOV_BREDR_INQUIRY_LEN	0x08
2055 #define DISCOV_LE_RESTART_DELAY		msecs_to_jiffies(200)	/* msec */
2056 #define DISCOV_LE_FAST_ADV_INT_MIN	0x00A0	/* 100 msec */
2057 #define DISCOV_LE_FAST_ADV_INT_MAX	0x00F0	/* 150 msec */
2058 #define DISCOV_LE_PER_ADV_INT_MIN	0x00A0	/* 200 msec */
2059 #define DISCOV_LE_PER_ADV_INT_MAX	0x00A0	/* 200 msec */
2060 #define DISCOV_LE_ADV_MESH_MIN		0x00A0  /* 100 msec */
2061 #define DISCOV_LE_ADV_MESH_MAX		0x00A0  /* 100 msec */
2062 #define INTERVAL_TO_MS(x)		(((x) * 10) / 0x10)
2063 
2064 #define NAME_RESOLVE_DURATION		msecs_to_jiffies(10240)	/* 10.24 sec */
2065 
2066 void mgmt_fill_version_info(void *ver);
2067 int mgmt_new_settings(struct hci_dev *hdev);
2068 void mgmt_index_added(struct hci_dev *hdev);
2069 void mgmt_index_removed(struct hci_dev *hdev);
2070 void mgmt_set_powered_failed(struct hci_dev *hdev, int err);
2071 void mgmt_power_on(struct hci_dev *hdev, int err);
2072 void __mgmt_power_off(struct hci_dev *hdev);
2073 void mgmt_new_link_key(struct hci_dev *hdev, struct link_key *key,
2074 		       bool persistent);
2075 void mgmt_device_connected(struct hci_dev *hdev, struct hci_conn *conn,
2076 			   u8 *name, u8 name_len);
2077 void mgmt_device_disconnected(struct hci_dev *hdev, bdaddr_t *bdaddr,
2078 			      u8 link_type, u8 addr_type, u8 reason,
2079 			      bool mgmt_connected);
2080 void mgmt_disconnect_failed(struct hci_dev *hdev, bdaddr_t *bdaddr,
2081 			    u8 link_type, u8 addr_type, u8 status);
2082 void mgmt_connect_failed(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 link_type,
2083 			 u8 addr_type, u8 status);
2084 void mgmt_pin_code_request(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 secure);
2085 void mgmt_pin_code_reply_complete(struct hci_dev *hdev, bdaddr_t *bdaddr,
2086 				  u8 status);
2087 void mgmt_pin_code_neg_reply_complete(struct hci_dev *hdev, bdaddr_t *bdaddr,
2088 				      u8 status);
2089 int mgmt_user_confirm_request(struct hci_dev *hdev, bdaddr_t *bdaddr,
2090 			      u8 link_type, u8 addr_type, u32 value,
2091 			      u8 confirm_hint);
2092 int mgmt_user_confirm_reply_complete(struct hci_dev *hdev, bdaddr_t *bdaddr,
2093 				     u8 link_type, u8 addr_type, u8 status);
2094 int mgmt_user_confirm_neg_reply_complete(struct hci_dev *hdev, bdaddr_t *bdaddr,
2095 					 u8 link_type, u8 addr_type, u8 status);
2096 int mgmt_user_passkey_request(struct hci_dev *hdev, bdaddr_t *bdaddr,
2097 			      u8 link_type, u8 addr_type);
2098 int mgmt_user_passkey_reply_complete(struct hci_dev *hdev, bdaddr_t *bdaddr,
2099 				     u8 link_type, u8 addr_type, u8 status);
2100 int mgmt_user_passkey_neg_reply_complete(struct hci_dev *hdev, bdaddr_t *bdaddr,
2101 					 u8 link_type, u8 addr_type, u8 status);
2102 int mgmt_user_passkey_notify(struct hci_dev *hdev, bdaddr_t *bdaddr,
2103 			     u8 link_type, u8 addr_type, u32 passkey,
2104 			     u8 entered);
2105 void mgmt_auth_failed(struct hci_conn *conn, u8 status);
2106 void mgmt_auth_enable_complete(struct hci_dev *hdev, u8 status);
2107 void mgmt_set_class_of_dev_complete(struct hci_dev *hdev, u8 *dev_class,
2108 				    u8 status);
2109 void mgmt_set_local_name_complete(struct hci_dev *hdev, u8 *name, u8 status);
2110 void mgmt_start_discovery_complete(struct hci_dev *hdev, u8 status);
2111 void mgmt_stop_discovery_complete(struct hci_dev *hdev, u8 status);
2112 void mgmt_device_found(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 link_type,
2113 		       u8 addr_type, u8 *dev_class, s8 rssi, u32 flags,
2114 		       u8 *eir, u16 eir_len, u8 *scan_rsp, u8 scan_rsp_len,
2115 		       u64 instant);
2116 void mgmt_remote_name(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 link_type,
2117 		      u8 addr_type, s8 rssi, u8 *name, u8 name_len);
2118 void mgmt_discovering(struct hci_dev *hdev, u8 discovering);
2119 void mgmt_suspending(struct hci_dev *hdev, u8 state);
2120 void mgmt_resuming(struct hci_dev *hdev, u8 reason, bdaddr_t *bdaddr,
2121 		   u8 addr_type);
2122 bool mgmt_powering_down(struct hci_dev *hdev);
2123 void mgmt_new_ltk(struct hci_dev *hdev, struct smp_ltk *key, bool persistent);
2124 void mgmt_new_irk(struct hci_dev *hdev, struct smp_irk *irk, bool persistent);
2125 void mgmt_new_csrk(struct hci_dev *hdev, struct smp_csrk *csrk,
2126 		   bool persistent);
2127 void mgmt_new_conn_param(struct hci_dev *hdev, bdaddr_t *bdaddr,
2128 			 u8 bdaddr_type, u8 store_hint, u16 min_interval,
2129 			 u16 max_interval, u16 latency, u16 timeout);
2130 void mgmt_smp_complete(struct hci_conn *conn, bool complete);
2131 bool mgmt_get_connectable(struct hci_dev *hdev);
2132 u8 mgmt_get_adv_discov_flags(struct hci_dev *hdev);
2133 void mgmt_advertising_added(struct sock *sk, struct hci_dev *hdev,
2134 			    u8 instance);
2135 void mgmt_advertising_removed(struct sock *sk, struct hci_dev *hdev,
2136 			      u8 instance);
2137 void mgmt_adv_monitor_removed(struct hci_dev *hdev, u16 handle);
2138 int mgmt_phy_configuration_changed(struct hci_dev *hdev, struct sock *skip);
2139 void mgmt_adv_monitor_device_lost(struct hci_dev *hdev, u16 handle,
2140 				  bdaddr_t *bdaddr, u8 addr_type);
2141 
2142 int hci_abort_conn(struct hci_conn *conn, u8 reason);
2143 u8 hci_le_conn_update(struct hci_conn *conn, u16 min, u16 max, u16 latency,
2144 		      u16 to_multiplier);
2145 void hci_le_start_enc(struct hci_conn *conn, __le16 ediv, __le64 rand,
2146 		      __u8 ltk[16], __u8 key_size);
2147 
2148 void hci_copy_identity_address(struct hci_dev *hdev, bdaddr_t *bdaddr,
2149 			       u8 *bdaddr_type);
2150 
2151 #define SCO_AIRMODE_MASK       0x0003
2152 #define SCO_AIRMODE_CVSD       0x0000
2153 #define SCO_AIRMODE_TRANSP     0x0003
2154 
2155 #define LOCAL_CODEC_ACL_MASK	BIT(0)
2156 #define LOCAL_CODEC_SCO_MASK	BIT(1)
2157 
2158 #define TRANSPORT_TYPE_MAX	0x04
2159 
2160 #endif /* __HCI_CORE_H */
2161