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