xref: /linux/include/net/bluetooth/hci_core.h (revision 7bb377107c72a40ab7505341f8626c8eb79a0cb7)
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/leds.h>
29 #include <linux/rculist.h>
30 
31 #include <net/bluetooth/hci.h>
32 #include <net/bluetooth/hci_sock.h>
33 
34 /* HCI priority */
35 #define HCI_PRIO_MAX	7
36 
37 /* HCI Core structures */
38 struct inquiry_data {
39 	bdaddr_t	bdaddr;
40 	__u8		pscan_rep_mode;
41 	__u8		pscan_period_mode;
42 	__u8		pscan_mode;
43 	__u8		dev_class[3];
44 	__le16		clock_offset;
45 	__s8		rssi;
46 	__u8		ssp_mode;
47 };
48 
49 struct inquiry_entry {
50 	struct list_head	all;		/* inq_cache.all */
51 	struct list_head	list;		/* unknown or resolve */
52 	enum {
53 		NAME_NOT_KNOWN,
54 		NAME_NEEDED,
55 		NAME_PENDING,
56 		NAME_KNOWN,
57 	} name_state;
58 	__u32			timestamp;
59 	struct inquiry_data	data;
60 };
61 
62 struct discovery_state {
63 	int			type;
64 	enum {
65 		DISCOVERY_STOPPED,
66 		DISCOVERY_STARTING,
67 		DISCOVERY_FINDING,
68 		DISCOVERY_RESOLVING,
69 		DISCOVERY_STOPPING,
70 	} state;
71 	struct list_head	all;	/* All devices found during inquiry */
72 	struct list_head	unknown;	/* Name state not known */
73 	struct list_head	resolve;	/* Name needs to be resolved */
74 	__u32			timestamp;
75 	bdaddr_t		last_adv_addr;
76 	u8			last_adv_addr_type;
77 	s8			last_adv_rssi;
78 	u32			last_adv_flags;
79 	u8			last_adv_data[HCI_MAX_AD_LENGTH];
80 	u8			last_adv_data_len;
81 	bool			report_invalid_rssi;
82 	bool			result_filtering;
83 	bool			limited;
84 	s8			rssi;
85 	u16			uuid_count;
86 	u8			(*uuids)[16];
87 	unsigned long		scan_start;
88 	unsigned long		scan_duration;
89 };
90 
91 #define SUSPEND_NOTIFIER_TIMEOUT	msecs_to_jiffies(2000) /* 2 seconds */
92 
93 enum suspend_tasks {
94 	SUSPEND_PAUSE_DISCOVERY,
95 	SUSPEND_UNPAUSE_DISCOVERY,
96 
97 	SUSPEND_PAUSE_ADVERTISING,
98 	SUSPEND_UNPAUSE_ADVERTISING,
99 
100 	SUSPEND_SCAN_DISABLE,
101 	SUSPEND_SCAN_ENABLE,
102 	SUSPEND_DISCONNECTING,
103 
104 	SUSPEND_POWERING_DOWN,
105 
106 	SUSPEND_PREPARE_NOTIFIER,
107 	__SUSPEND_NUM_TASKS
108 };
109 
110 enum suspended_state {
111 	BT_RUNNING = 0,
112 	BT_SUSPEND_DISCONNECT,
113 	BT_SUSPEND_COMPLETE,
114 };
115 
116 struct hci_conn_hash {
117 	struct list_head list;
118 	unsigned int     acl_num;
119 	unsigned int     amp_num;
120 	unsigned int     sco_num;
121 	unsigned int     le_num;
122 	unsigned int     le_num_slave;
123 };
124 
125 struct bdaddr_list {
126 	struct list_head list;
127 	bdaddr_t bdaddr;
128 	u8 bdaddr_type;
129 };
130 
131 struct bdaddr_list_with_irk {
132 	struct list_head list;
133 	bdaddr_t bdaddr;
134 	u8 bdaddr_type;
135 	u8 peer_irk[16];
136 	u8 local_irk[16];
137 };
138 
139 struct bt_uuid {
140 	struct list_head list;
141 	u8 uuid[16];
142 	u8 size;
143 	u8 svc_hint;
144 };
145 
146 struct blocked_key {
147 	struct list_head list;
148 	struct rcu_head rcu;
149 	u8 type;
150 	u8 val[16];
151 };
152 
153 struct smp_csrk {
154 	bdaddr_t bdaddr;
155 	u8 bdaddr_type;
156 	u8 type;
157 	u8 val[16];
158 };
159 
160 struct smp_ltk {
161 	struct list_head list;
162 	struct rcu_head rcu;
163 	bdaddr_t bdaddr;
164 	u8 bdaddr_type;
165 	u8 authenticated;
166 	u8 type;
167 	u8 enc_size;
168 	__le16 ediv;
169 	__le64 rand;
170 	u8 val[16];
171 };
172 
173 struct smp_irk {
174 	struct list_head list;
175 	struct rcu_head rcu;
176 	bdaddr_t rpa;
177 	bdaddr_t bdaddr;
178 	u8 addr_type;
179 	u8 val[16];
180 };
181 
182 struct link_key {
183 	struct list_head list;
184 	struct rcu_head rcu;
185 	bdaddr_t bdaddr;
186 	u8 type;
187 	u8 val[HCI_LINK_KEY_SIZE];
188 	u8 pin_len;
189 };
190 
191 struct oob_data {
192 	struct list_head list;
193 	bdaddr_t bdaddr;
194 	u8 bdaddr_type;
195 	u8 present;
196 	u8 hash192[16];
197 	u8 rand192[16];
198 	u8 hash256[16];
199 	u8 rand256[16];
200 };
201 
202 struct adv_info {
203 	struct list_head list;
204 	bool pending;
205 	__u8	instance;
206 	__u32	flags;
207 	__u16	timeout;
208 	__u16	remaining_time;
209 	__u16	duration;
210 	__u16	adv_data_len;
211 	__u8	adv_data[HCI_MAX_AD_LENGTH];
212 	__u16	scan_rsp_len;
213 	__u8	scan_rsp_data[HCI_MAX_AD_LENGTH];
214 	__s8	tx_power;
215 	bdaddr_t	random_addr;
216 	bool 		rpa_expired;
217 	struct delayed_work	rpa_expired_cb;
218 };
219 
220 #define HCI_MAX_ADV_INSTANCES		5
221 #define HCI_DEFAULT_ADV_DURATION	2
222 
223 #define HCI_MAX_SHORT_NAME_LENGTH	10
224 
225 /* Min encryption key size to match with SMP */
226 #define HCI_MIN_ENC_KEY_SIZE		7
227 
228 /* Default LE RPA expiry time, 15 minutes */
229 #define HCI_DEFAULT_RPA_TIMEOUT		(15 * 60)
230 
231 /* Default min/max age of connection information (1s/3s) */
232 #define DEFAULT_CONN_INFO_MIN_AGE	1000
233 #define DEFAULT_CONN_INFO_MAX_AGE	3000
234 /* Default authenticated payload timeout 30s */
235 #define DEFAULT_AUTH_PAYLOAD_TIMEOUT   0x0bb8
236 
237 struct amp_assoc {
238 	__u16	len;
239 	__u16	offset;
240 	__u16	rem_len;
241 	__u16	len_so_far;
242 	__u8	data[HCI_MAX_AMP_ASSOC_SIZE];
243 };
244 
245 #define HCI_MAX_PAGES	3
246 
247 struct hci_dev {
248 	struct list_head list;
249 	struct mutex	lock;
250 
251 	char		name[8];
252 	unsigned long	flags;
253 	__u16		id;
254 	__u8		bus;
255 	__u8		dev_type;
256 	bdaddr_t	bdaddr;
257 	bdaddr_t	setup_addr;
258 	bdaddr_t	public_addr;
259 	bdaddr_t	random_addr;
260 	bdaddr_t	static_addr;
261 	__u8		adv_addr_type;
262 	__u8		dev_name[HCI_MAX_NAME_LENGTH];
263 	__u8		short_name[HCI_MAX_SHORT_NAME_LENGTH];
264 	__u8		eir[HCI_MAX_EIR_LENGTH];
265 	__u16		appearance;
266 	__u8		dev_class[3];
267 	__u8		major_class;
268 	__u8		minor_class;
269 	__u8		max_page;
270 	__u8		features[HCI_MAX_PAGES][8];
271 	__u8		le_features[8];
272 	__u8		le_white_list_size;
273 	__u8		le_resolv_list_size;
274 	__u8		le_num_of_adv_sets;
275 	__u8		le_states[8];
276 	__u8		commands[64];
277 	__u8		hci_ver;
278 	__u16		hci_rev;
279 	__u8		lmp_ver;
280 	__u16		manufacturer;
281 	__u16		lmp_subver;
282 	__u16		voice_setting;
283 	__u8		num_iac;
284 	__u8		stored_max_keys;
285 	__u8		stored_num_keys;
286 	__u8		io_capability;
287 	__s8		inq_tx_power;
288 	__u8		err_data_reporting;
289 	__u16		page_scan_interval;
290 	__u16		page_scan_window;
291 	__u8		page_scan_type;
292 	__u8		le_adv_channel_map;
293 	__u16		le_adv_min_interval;
294 	__u16		le_adv_max_interval;
295 	__u8		le_scan_type;
296 	__u16		le_scan_interval;
297 	__u16		le_scan_window;
298 	__u16		le_conn_min_interval;
299 	__u16		le_conn_max_interval;
300 	__u16		le_conn_latency;
301 	__u16		le_supv_timeout;
302 	__u16		le_def_tx_len;
303 	__u16		le_def_tx_time;
304 	__u16		le_max_tx_len;
305 	__u16		le_max_tx_time;
306 	__u16		le_max_rx_len;
307 	__u16		le_max_rx_time;
308 	__u8		le_max_key_size;
309 	__u8		le_min_key_size;
310 	__u16		discov_interleaved_timeout;
311 	__u16		conn_info_min_age;
312 	__u16		conn_info_max_age;
313 	__u16		auth_payload_timeout;
314 	__u8		min_enc_key_size;
315 	__u8		max_enc_key_size;
316 	__u8		pairing_opts;
317 	__u8		ssp_debug_mode;
318 	__u8		hw_error_code;
319 	__u32		clock;
320 
321 	__u16		devid_source;
322 	__u16		devid_vendor;
323 	__u16		devid_product;
324 	__u16		devid_version;
325 
326 	__u16		pkt_type;
327 	__u16		esco_type;
328 	__u16		link_policy;
329 	__u16		link_mode;
330 
331 	__u32		idle_timeout;
332 	__u16		sniff_min_interval;
333 	__u16		sniff_max_interval;
334 
335 	__u8		amp_status;
336 	__u32		amp_total_bw;
337 	__u32		amp_max_bw;
338 	__u32		amp_min_latency;
339 	__u32		amp_max_pdu;
340 	__u8		amp_type;
341 	__u16		amp_pal_cap;
342 	__u16		amp_assoc_size;
343 	__u32		amp_max_flush_to;
344 	__u32		amp_be_flush_to;
345 
346 	struct amp_assoc	loc_assoc;
347 
348 	__u8		flow_ctl_mode;
349 
350 	unsigned int	auto_accept_delay;
351 
352 	unsigned long	quirks;
353 
354 	atomic_t	cmd_cnt;
355 	unsigned int	acl_cnt;
356 	unsigned int	sco_cnt;
357 	unsigned int	le_cnt;
358 
359 	unsigned int	acl_mtu;
360 	unsigned int	sco_mtu;
361 	unsigned int	le_mtu;
362 	unsigned int	acl_pkts;
363 	unsigned int	sco_pkts;
364 	unsigned int	le_pkts;
365 
366 	__u16		block_len;
367 	__u16		block_mtu;
368 	__u16		num_blocks;
369 	__u16		block_cnt;
370 
371 	unsigned long	acl_last_tx;
372 	unsigned long	sco_last_tx;
373 	unsigned long	le_last_tx;
374 
375 	__u8		le_tx_def_phys;
376 	__u8		le_rx_def_phys;
377 
378 	struct workqueue_struct	*workqueue;
379 	struct workqueue_struct	*req_workqueue;
380 
381 	struct work_struct	power_on;
382 	struct delayed_work	power_off;
383 	struct work_struct	error_reset;
384 
385 	__u16			discov_timeout;
386 	struct delayed_work	discov_off;
387 
388 	struct delayed_work	service_cache;
389 
390 	struct delayed_work	cmd_timer;
391 
392 	struct work_struct	rx_work;
393 	struct work_struct	cmd_work;
394 	struct work_struct	tx_work;
395 
396 	struct work_struct	discov_update;
397 	struct work_struct	bg_scan_update;
398 	struct work_struct	scan_update;
399 	struct work_struct	connectable_update;
400 	struct work_struct	discoverable_update;
401 	struct delayed_work	le_scan_disable;
402 	struct delayed_work	le_scan_restart;
403 
404 	struct sk_buff_head	rx_q;
405 	struct sk_buff_head	raw_q;
406 	struct sk_buff_head	cmd_q;
407 
408 	struct sk_buff		*sent_cmd;
409 
410 	struct mutex		req_lock;
411 	wait_queue_head_t	req_wait_q;
412 	__u32			req_status;
413 	__u32			req_result;
414 	struct sk_buff		*req_skb;
415 
416 	void			*smp_data;
417 	void			*smp_bredr_data;
418 
419 	struct discovery_state	discovery;
420 
421 	int			discovery_old_state;
422 	bool			discovery_paused;
423 	int			advertising_old_state;
424 	bool			advertising_paused;
425 
426 	struct notifier_block	suspend_notifier;
427 	struct work_struct	suspend_prepare;
428 	enum suspended_state	suspend_state_next;
429 	enum suspended_state	suspend_state;
430 	bool			scanning_paused;
431 	bool			suspended;
432 
433 	wait_queue_head_t	suspend_wait_q;
434 	DECLARE_BITMAP(suspend_tasks, __SUSPEND_NUM_TASKS);
435 
436 	struct hci_conn_hash	conn_hash;
437 
438 	struct list_head	mgmt_pending;
439 	struct list_head	blacklist;
440 	struct list_head	whitelist;
441 	struct list_head	wakeable;
442 	struct list_head	uuids;
443 	struct list_head	link_keys;
444 	struct list_head	long_term_keys;
445 	struct list_head	identity_resolving_keys;
446 	struct list_head	remote_oob_data;
447 	struct list_head	le_white_list;
448 	struct list_head	le_resolv_list;
449 	struct list_head	le_conn_params;
450 	struct list_head	pend_le_conns;
451 	struct list_head	pend_le_reports;
452 	struct list_head	blocked_keys;
453 
454 	struct hci_dev_stats	stat;
455 
456 	atomic_t		promisc;
457 
458 	const char		*hw_info;
459 	const char		*fw_info;
460 	struct dentry		*debugfs;
461 
462 	struct device		dev;
463 
464 	struct rfkill		*rfkill;
465 
466 	DECLARE_BITMAP(dev_flags, __HCI_NUM_FLAGS);
467 
468 	__s8			adv_tx_power;
469 	__u8			adv_data[HCI_MAX_AD_LENGTH];
470 	__u8			adv_data_len;
471 	__u8			scan_rsp_data[HCI_MAX_AD_LENGTH];
472 	__u8			scan_rsp_data_len;
473 
474 	struct list_head	adv_instances;
475 	unsigned int		adv_instance_cnt;
476 	__u8			cur_adv_instance;
477 	__u16			adv_instance_timeout;
478 	struct delayed_work	adv_instance_expire;
479 
480 	__u8			irk[16];
481 	__u32			rpa_timeout;
482 	struct delayed_work	rpa_expired;
483 	bdaddr_t		rpa;
484 
485 #if IS_ENABLED(CONFIG_BT_LEDS)
486 	struct led_trigger	*power_led;
487 #endif
488 
489 #if IS_ENABLED(CONFIG_BT_MSFTEXT)
490 	__u16			msft_opcode;
491 	void			*msft_data;
492 #endif
493 
494 	int (*open)(struct hci_dev *hdev);
495 	int (*close)(struct hci_dev *hdev);
496 	int (*flush)(struct hci_dev *hdev);
497 	int (*setup)(struct hci_dev *hdev);
498 	int (*shutdown)(struct hci_dev *hdev);
499 	int (*send)(struct hci_dev *hdev, struct sk_buff *skb);
500 	void (*notify)(struct hci_dev *hdev, unsigned int evt);
501 	void (*hw_error)(struct hci_dev *hdev, u8 code);
502 	int (*post_init)(struct hci_dev *hdev);
503 	int (*set_diag)(struct hci_dev *hdev, bool enable);
504 	int (*set_bdaddr)(struct hci_dev *hdev, const bdaddr_t *bdaddr);
505 	void (*cmd_timeout)(struct hci_dev *hdev);
506 };
507 
508 #define HCI_PHY_HANDLE(handle)	(handle & 0xff)
509 
510 struct hci_conn {
511 	struct list_head list;
512 
513 	atomic_t	refcnt;
514 
515 	bdaddr_t	dst;
516 	__u8		dst_type;
517 	bdaddr_t	src;
518 	__u8		src_type;
519 	bdaddr_t	init_addr;
520 	__u8		init_addr_type;
521 	bdaddr_t	resp_addr;
522 	__u8		resp_addr_type;
523 	__u16		handle;
524 	__u16		state;
525 	__u8		mode;
526 	__u8		type;
527 	__u8		role;
528 	bool		out;
529 	__u8		attempt;
530 	__u8		dev_class[3];
531 	__u8		features[HCI_MAX_PAGES][8];
532 	__u16		pkt_type;
533 	__u16		link_policy;
534 	__u8		key_type;
535 	__u8		auth_type;
536 	__u8		sec_level;
537 	__u8		pending_sec_level;
538 	__u8		pin_length;
539 	__u8		enc_key_size;
540 	__u8		io_capability;
541 	__u32		passkey_notify;
542 	__u8		passkey_entered;
543 	__u16		disc_timeout;
544 	__u16		conn_timeout;
545 	__u16		setting;
546 	__u16		auth_payload_timeout;
547 	__u16		le_conn_min_interval;
548 	__u16		le_conn_max_interval;
549 	__u16		le_conn_interval;
550 	__u16		le_conn_latency;
551 	__u16		le_supv_timeout;
552 	__u8		le_adv_data[HCI_MAX_AD_LENGTH];
553 	__u8		le_adv_data_len;
554 	__u8		le_tx_phy;
555 	__u8		le_rx_phy;
556 	__s8		rssi;
557 	__s8		tx_power;
558 	__s8		max_tx_power;
559 	unsigned long	flags;
560 
561 	__u32		clock;
562 	__u16		clock_accuracy;
563 
564 	unsigned long	conn_info_timestamp;
565 
566 	__u8		remote_cap;
567 	__u8		remote_auth;
568 	__u8		remote_id;
569 
570 	unsigned int	sent;
571 
572 	struct sk_buff_head data_q;
573 	struct list_head chan_list;
574 
575 	struct delayed_work disc_work;
576 	struct delayed_work auto_accept_work;
577 	struct delayed_work idle_work;
578 	struct delayed_work le_conn_timeout;
579 	struct work_struct  le_scan_cleanup;
580 
581 	struct device	dev;
582 	struct dentry	*debugfs;
583 
584 	struct hci_dev	*hdev;
585 	void		*l2cap_data;
586 	void		*sco_data;
587 	struct amp_mgr	*amp_mgr;
588 
589 	struct hci_conn	*link;
590 
591 	void (*connect_cfm_cb)	(struct hci_conn *conn, u8 status);
592 	void (*security_cfm_cb)	(struct hci_conn *conn, u8 status);
593 	void (*disconn_cfm_cb)	(struct hci_conn *conn, u8 reason);
594 };
595 
596 struct hci_chan {
597 	struct list_head list;
598 	__u16 handle;
599 	struct hci_conn *conn;
600 	struct sk_buff_head data_q;
601 	unsigned int	sent;
602 	__u8		state;
603 };
604 
605 struct hci_conn_params {
606 	struct list_head list;
607 	struct list_head action;
608 
609 	bdaddr_t addr;
610 	u8 addr_type;
611 
612 	u16 conn_min_interval;
613 	u16 conn_max_interval;
614 	u16 conn_latency;
615 	u16 supervision_timeout;
616 
617 	enum {
618 		HCI_AUTO_CONN_DISABLED,
619 		HCI_AUTO_CONN_REPORT,
620 		HCI_AUTO_CONN_DIRECT,
621 		HCI_AUTO_CONN_ALWAYS,
622 		HCI_AUTO_CONN_LINK_LOSS,
623 		HCI_AUTO_CONN_EXPLICIT,
624 	} auto_connect;
625 
626 	struct hci_conn *conn;
627 	bool explicit_connect;
628 	bool wakeable;
629 };
630 
631 extern struct list_head hci_dev_list;
632 extern struct list_head hci_cb_list;
633 extern rwlock_t hci_dev_list_lock;
634 extern struct mutex hci_cb_list_lock;
635 
636 #define hci_dev_set_flag(hdev, nr)             set_bit((nr), (hdev)->dev_flags)
637 #define hci_dev_clear_flag(hdev, nr)           clear_bit((nr), (hdev)->dev_flags)
638 #define hci_dev_change_flag(hdev, nr)          change_bit((nr), (hdev)->dev_flags)
639 #define hci_dev_test_flag(hdev, nr)            test_bit((nr), (hdev)->dev_flags)
640 #define hci_dev_test_and_set_flag(hdev, nr)    test_and_set_bit((nr), (hdev)->dev_flags)
641 #define hci_dev_test_and_clear_flag(hdev, nr)  test_and_clear_bit((nr), (hdev)->dev_flags)
642 #define hci_dev_test_and_change_flag(hdev, nr) test_and_change_bit((nr), (hdev)->dev_flags)
643 
644 #define hci_dev_clear_volatile_flags(hdev)			\
645 	do {							\
646 		hci_dev_clear_flag(hdev, HCI_LE_SCAN);		\
647 		hci_dev_clear_flag(hdev, HCI_LE_ADV);		\
648 		hci_dev_clear_flag(hdev, HCI_LL_RPA_RESOLUTION);\
649 		hci_dev_clear_flag(hdev, HCI_PERIODIC_INQ);	\
650 	} while (0)
651 
652 /* ----- HCI interface to upper protocols ----- */
653 int l2cap_connect_ind(struct hci_dev *hdev, bdaddr_t *bdaddr);
654 int l2cap_disconn_ind(struct hci_conn *hcon);
655 void l2cap_recv_acldata(struct hci_conn *hcon, struct sk_buff *skb, u16 flags);
656 
657 #if IS_ENABLED(CONFIG_BT_BREDR)
658 int sco_connect_ind(struct hci_dev *hdev, bdaddr_t *bdaddr, __u8 *flags);
659 void sco_recv_scodata(struct hci_conn *hcon, struct sk_buff *skb);
660 #else
661 static inline int sco_connect_ind(struct hci_dev *hdev, bdaddr_t *bdaddr,
662 				  __u8 *flags)
663 {
664 	return 0;
665 }
666 
667 static inline void sco_recv_scodata(struct hci_conn *hcon, struct sk_buff *skb)
668 {
669 }
670 #endif
671 
672 /* ----- Inquiry cache ----- */
673 #define INQUIRY_CACHE_AGE_MAX   (HZ*30)   /* 30 seconds */
674 #define INQUIRY_ENTRY_AGE_MAX   (HZ*60)   /* 60 seconds */
675 
676 static inline void discovery_init(struct hci_dev *hdev)
677 {
678 	hdev->discovery.state = DISCOVERY_STOPPED;
679 	INIT_LIST_HEAD(&hdev->discovery.all);
680 	INIT_LIST_HEAD(&hdev->discovery.unknown);
681 	INIT_LIST_HEAD(&hdev->discovery.resolve);
682 	hdev->discovery.report_invalid_rssi = true;
683 	hdev->discovery.rssi = HCI_RSSI_INVALID;
684 }
685 
686 static inline void hci_discovery_filter_clear(struct hci_dev *hdev)
687 {
688 	hdev->discovery.result_filtering = false;
689 	hdev->discovery.report_invalid_rssi = true;
690 	hdev->discovery.rssi = HCI_RSSI_INVALID;
691 	hdev->discovery.uuid_count = 0;
692 	kfree(hdev->discovery.uuids);
693 	hdev->discovery.uuids = NULL;
694 	hdev->discovery.scan_start = 0;
695 	hdev->discovery.scan_duration = 0;
696 }
697 
698 bool hci_discovery_active(struct hci_dev *hdev);
699 
700 void hci_discovery_set_state(struct hci_dev *hdev, int state);
701 
702 static inline int inquiry_cache_empty(struct hci_dev *hdev)
703 {
704 	return list_empty(&hdev->discovery.all);
705 }
706 
707 static inline long inquiry_cache_age(struct hci_dev *hdev)
708 {
709 	struct discovery_state *c = &hdev->discovery;
710 	return jiffies - c->timestamp;
711 }
712 
713 static inline long inquiry_entry_age(struct inquiry_entry *e)
714 {
715 	return jiffies - e->timestamp;
716 }
717 
718 struct inquiry_entry *hci_inquiry_cache_lookup(struct hci_dev *hdev,
719 					       bdaddr_t *bdaddr);
720 struct inquiry_entry *hci_inquiry_cache_lookup_unknown(struct hci_dev *hdev,
721 						       bdaddr_t *bdaddr);
722 struct inquiry_entry *hci_inquiry_cache_lookup_resolve(struct hci_dev *hdev,
723 						       bdaddr_t *bdaddr,
724 						       int state);
725 void hci_inquiry_cache_update_resolve(struct hci_dev *hdev,
726 				      struct inquiry_entry *ie);
727 u32 hci_inquiry_cache_update(struct hci_dev *hdev, struct inquiry_data *data,
728 			     bool name_known);
729 void hci_inquiry_cache_flush(struct hci_dev *hdev);
730 
731 /* ----- HCI Connections ----- */
732 enum {
733 	HCI_CONN_AUTH_PEND,
734 	HCI_CONN_REAUTH_PEND,
735 	HCI_CONN_ENCRYPT_PEND,
736 	HCI_CONN_RSWITCH_PEND,
737 	HCI_CONN_MODE_CHANGE_PEND,
738 	HCI_CONN_SCO_SETUP_PEND,
739 	HCI_CONN_MGMT_CONNECTED,
740 	HCI_CONN_SSP_ENABLED,
741 	HCI_CONN_SC_ENABLED,
742 	HCI_CONN_AES_CCM,
743 	HCI_CONN_POWER_SAVE,
744 	HCI_CONN_FLUSH_KEY,
745 	HCI_CONN_ENCRYPT,
746 	HCI_CONN_AUTH,
747 	HCI_CONN_SECURE,
748 	HCI_CONN_FIPS,
749 	HCI_CONN_STK_ENCRYPT,
750 	HCI_CONN_AUTH_INITIATOR,
751 	HCI_CONN_DROP,
752 	HCI_CONN_PARAM_REMOVAL_PEND,
753 	HCI_CONN_NEW_LINK_KEY,
754 	HCI_CONN_SCANNING,
755 	HCI_CONN_AUTH_FAILURE,
756 };
757 
758 static inline bool hci_conn_ssp_enabled(struct hci_conn *conn)
759 {
760 	struct hci_dev *hdev = conn->hdev;
761 	return hci_dev_test_flag(hdev, HCI_SSP_ENABLED) &&
762 	       test_bit(HCI_CONN_SSP_ENABLED, &conn->flags);
763 }
764 
765 static inline bool hci_conn_sc_enabled(struct hci_conn *conn)
766 {
767 	struct hci_dev *hdev = conn->hdev;
768 	return hci_dev_test_flag(hdev, HCI_SC_ENABLED) &&
769 	       test_bit(HCI_CONN_SC_ENABLED, &conn->flags);
770 }
771 
772 static inline void hci_conn_hash_add(struct hci_dev *hdev, struct hci_conn *c)
773 {
774 	struct hci_conn_hash *h = &hdev->conn_hash;
775 	list_add_rcu(&c->list, &h->list);
776 	switch (c->type) {
777 	case ACL_LINK:
778 		h->acl_num++;
779 		break;
780 	case AMP_LINK:
781 		h->amp_num++;
782 		break;
783 	case LE_LINK:
784 		h->le_num++;
785 		if (c->role == HCI_ROLE_SLAVE)
786 			h->le_num_slave++;
787 		break;
788 	case SCO_LINK:
789 	case ESCO_LINK:
790 		h->sco_num++;
791 		break;
792 	}
793 }
794 
795 static inline void hci_conn_hash_del(struct hci_dev *hdev, struct hci_conn *c)
796 {
797 	struct hci_conn_hash *h = &hdev->conn_hash;
798 
799 	list_del_rcu(&c->list);
800 	synchronize_rcu();
801 
802 	switch (c->type) {
803 	case ACL_LINK:
804 		h->acl_num--;
805 		break;
806 	case AMP_LINK:
807 		h->amp_num--;
808 		break;
809 	case LE_LINK:
810 		h->le_num--;
811 		if (c->role == HCI_ROLE_SLAVE)
812 			h->le_num_slave--;
813 		break;
814 	case SCO_LINK:
815 	case ESCO_LINK:
816 		h->sco_num--;
817 		break;
818 	}
819 }
820 
821 static inline unsigned int hci_conn_num(struct hci_dev *hdev, __u8 type)
822 {
823 	struct hci_conn_hash *h = &hdev->conn_hash;
824 	switch (type) {
825 	case ACL_LINK:
826 		return h->acl_num;
827 	case AMP_LINK:
828 		return h->amp_num;
829 	case LE_LINK:
830 		return h->le_num;
831 	case SCO_LINK:
832 	case ESCO_LINK:
833 		return h->sco_num;
834 	default:
835 		return 0;
836 	}
837 }
838 
839 static inline unsigned int hci_conn_count(struct hci_dev *hdev)
840 {
841 	struct hci_conn_hash *c = &hdev->conn_hash;
842 
843 	return c->acl_num + c->amp_num + c->sco_num + c->le_num;
844 }
845 
846 static inline __u8 hci_conn_lookup_type(struct hci_dev *hdev, __u16 handle)
847 {
848 	struct hci_conn_hash *h = &hdev->conn_hash;
849 	struct hci_conn *c;
850 	__u8 type = INVALID_LINK;
851 
852 	rcu_read_lock();
853 
854 	list_for_each_entry_rcu(c, &h->list, list) {
855 		if (c->handle == handle) {
856 			type = c->type;
857 			break;
858 		}
859 	}
860 
861 	rcu_read_unlock();
862 
863 	return type;
864 }
865 
866 static inline struct hci_conn *hci_conn_hash_lookup_handle(struct hci_dev *hdev,
867 								__u16 handle)
868 {
869 	struct hci_conn_hash *h = &hdev->conn_hash;
870 	struct hci_conn  *c;
871 
872 	rcu_read_lock();
873 
874 	list_for_each_entry_rcu(c, &h->list, list) {
875 		if (c->handle == handle) {
876 			rcu_read_unlock();
877 			return c;
878 		}
879 	}
880 	rcu_read_unlock();
881 
882 	return NULL;
883 }
884 
885 static inline struct hci_conn *hci_conn_hash_lookup_ba(struct hci_dev *hdev,
886 							__u8 type, bdaddr_t *ba)
887 {
888 	struct hci_conn_hash *h = &hdev->conn_hash;
889 	struct hci_conn  *c;
890 
891 	rcu_read_lock();
892 
893 	list_for_each_entry_rcu(c, &h->list, list) {
894 		if (c->type == type && !bacmp(&c->dst, ba)) {
895 			rcu_read_unlock();
896 			return c;
897 		}
898 	}
899 
900 	rcu_read_unlock();
901 
902 	return NULL;
903 }
904 
905 static inline struct hci_conn *hci_conn_hash_lookup_le(struct hci_dev *hdev,
906 						       bdaddr_t *ba,
907 						       __u8 ba_type)
908 {
909 	struct hci_conn_hash *h = &hdev->conn_hash;
910 	struct hci_conn  *c;
911 
912 	rcu_read_lock();
913 
914 	list_for_each_entry_rcu(c, &h->list, list) {
915 		if (c->type != LE_LINK)
916 		       continue;
917 
918 		if (ba_type == c->dst_type && !bacmp(&c->dst, ba)) {
919 			rcu_read_unlock();
920 			return c;
921 		}
922 	}
923 
924 	rcu_read_unlock();
925 
926 	return NULL;
927 }
928 
929 static inline struct hci_conn *hci_conn_hash_lookup_state(struct hci_dev *hdev,
930 							__u8 type, __u16 state)
931 {
932 	struct hci_conn_hash *h = &hdev->conn_hash;
933 	struct hci_conn  *c;
934 
935 	rcu_read_lock();
936 
937 	list_for_each_entry_rcu(c, &h->list, list) {
938 		if (c->type == type && c->state == state) {
939 			rcu_read_unlock();
940 			return c;
941 		}
942 	}
943 
944 	rcu_read_unlock();
945 
946 	return NULL;
947 }
948 
949 static inline struct hci_conn *hci_lookup_le_connect(struct hci_dev *hdev)
950 {
951 	struct hci_conn_hash *h = &hdev->conn_hash;
952 	struct hci_conn  *c;
953 
954 	rcu_read_lock();
955 
956 	list_for_each_entry_rcu(c, &h->list, list) {
957 		if (c->type == LE_LINK && c->state == BT_CONNECT &&
958 		    !test_bit(HCI_CONN_SCANNING, &c->flags)) {
959 			rcu_read_unlock();
960 			return c;
961 		}
962 	}
963 
964 	rcu_read_unlock();
965 
966 	return NULL;
967 }
968 
969 int hci_disconnect(struct hci_conn *conn, __u8 reason);
970 bool hci_setup_sync(struct hci_conn *conn, __u16 handle);
971 void hci_sco_setup(struct hci_conn *conn, __u8 status);
972 
973 struct hci_conn *hci_conn_add(struct hci_dev *hdev, int type, bdaddr_t *dst,
974 			      u8 role);
975 int hci_conn_del(struct hci_conn *conn);
976 void hci_conn_hash_flush(struct hci_dev *hdev);
977 void hci_conn_check_pending(struct hci_dev *hdev);
978 
979 struct hci_chan *hci_chan_create(struct hci_conn *conn);
980 void hci_chan_del(struct hci_chan *chan);
981 void hci_chan_list_flush(struct hci_conn *conn);
982 struct hci_chan *hci_chan_lookup_handle(struct hci_dev *hdev, __u16 handle);
983 
984 struct hci_conn *hci_connect_le_scan(struct hci_dev *hdev, bdaddr_t *dst,
985 				     u8 dst_type, u8 sec_level,
986 				     u16 conn_timeout);
987 struct hci_conn *hci_connect_le(struct hci_dev *hdev, bdaddr_t *dst,
988 				u8 dst_type, u8 sec_level, u16 conn_timeout,
989 				u8 role, bdaddr_t *direct_rpa);
990 struct hci_conn *hci_connect_acl(struct hci_dev *hdev, bdaddr_t *dst,
991 				 u8 sec_level, u8 auth_type);
992 struct hci_conn *hci_connect_sco(struct hci_dev *hdev, int type, bdaddr_t *dst,
993 				 __u16 setting);
994 int hci_conn_check_link_mode(struct hci_conn *conn);
995 int hci_conn_check_secure(struct hci_conn *conn, __u8 sec_level);
996 int hci_conn_security(struct hci_conn *conn, __u8 sec_level, __u8 auth_type,
997 		      bool initiator);
998 int hci_conn_switch_role(struct hci_conn *conn, __u8 role);
999 
1000 void hci_conn_enter_active_mode(struct hci_conn *conn, __u8 force_active);
1001 
1002 void hci_le_conn_failed(struct hci_conn *conn, u8 status);
1003 
1004 /*
1005  * hci_conn_get() and hci_conn_put() are used to control the life-time of an
1006  * "hci_conn" object. They do not guarantee that the hci_conn object is running,
1007  * working or anything else. They just guarantee that the object is available
1008  * and can be dereferenced. So you can use its locks, local variables and any
1009  * other constant data.
1010  * Before accessing runtime data, you _must_ lock the object and then check that
1011  * it is still running. As soon as you release the locks, the connection might
1012  * get dropped, though.
1013  *
1014  * On the other hand, hci_conn_hold() and hci_conn_drop() are used to control
1015  * how long the underlying connection is held. So every channel that runs on the
1016  * hci_conn object calls this to prevent the connection from disappearing. As
1017  * long as you hold a device, you must also guarantee that you have a valid
1018  * reference to the device via hci_conn_get() (or the initial reference from
1019  * hci_conn_add()).
1020  * The hold()/drop() ref-count is known to drop below 0 sometimes, which doesn't
1021  * break because nobody cares for that. But this means, we cannot use
1022  * _get()/_drop() in it, but require the caller to have a valid ref (FIXME).
1023  */
1024 
1025 static inline struct hci_conn *hci_conn_get(struct hci_conn *conn)
1026 {
1027 	get_device(&conn->dev);
1028 	return conn;
1029 }
1030 
1031 static inline void hci_conn_put(struct hci_conn *conn)
1032 {
1033 	put_device(&conn->dev);
1034 }
1035 
1036 static inline void hci_conn_hold(struct hci_conn *conn)
1037 {
1038 	BT_DBG("hcon %p orig refcnt %d", conn, atomic_read(&conn->refcnt));
1039 
1040 	atomic_inc(&conn->refcnt);
1041 	cancel_delayed_work(&conn->disc_work);
1042 }
1043 
1044 static inline void hci_conn_drop(struct hci_conn *conn)
1045 {
1046 	BT_DBG("hcon %p orig refcnt %d", conn, atomic_read(&conn->refcnt));
1047 
1048 	if (atomic_dec_and_test(&conn->refcnt)) {
1049 		unsigned long timeo;
1050 
1051 		switch (conn->type) {
1052 		case ACL_LINK:
1053 		case LE_LINK:
1054 			cancel_delayed_work(&conn->idle_work);
1055 			if (conn->state == BT_CONNECTED) {
1056 				timeo = conn->disc_timeout;
1057 				if (!conn->out)
1058 					timeo *= 2;
1059 			} else {
1060 				timeo = 0;
1061 			}
1062 			break;
1063 
1064 		case AMP_LINK:
1065 			timeo = conn->disc_timeout;
1066 			break;
1067 
1068 		default:
1069 			timeo = 0;
1070 			break;
1071 		}
1072 
1073 		cancel_delayed_work(&conn->disc_work);
1074 		queue_delayed_work(conn->hdev->workqueue,
1075 				   &conn->disc_work, timeo);
1076 	}
1077 }
1078 
1079 /* ----- HCI Devices ----- */
1080 static inline void hci_dev_put(struct hci_dev *d)
1081 {
1082 	BT_DBG("%s orig refcnt %d", d->name,
1083 	       kref_read(&d->dev.kobj.kref));
1084 
1085 	put_device(&d->dev);
1086 }
1087 
1088 static inline struct hci_dev *hci_dev_hold(struct hci_dev *d)
1089 {
1090 	BT_DBG("%s orig refcnt %d", d->name,
1091 	       kref_read(&d->dev.kobj.kref));
1092 
1093 	get_device(&d->dev);
1094 	return d;
1095 }
1096 
1097 #define hci_dev_lock(d)		mutex_lock(&d->lock)
1098 #define hci_dev_unlock(d)	mutex_unlock(&d->lock)
1099 
1100 #define to_hci_dev(d) container_of(d, struct hci_dev, dev)
1101 #define to_hci_conn(c) container_of(c, struct hci_conn, dev)
1102 
1103 static inline void *hci_get_drvdata(struct hci_dev *hdev)
1104 {
1105 	return dev_get_drvdata(&hdev->dev);
1106 }
1107 
1108 static inline void hci_set_drvdata(struct hci_dev *hdev, void *data)
1109 {
1110 	dev_set_drvdata(&hdev->dev, data);
1111 }
1112 
1113 struct hci_dev *hci_dev_get(int index);
1114 struct hci_dev *hci_get_route(bdaddr_t *dst, bdaddr_t *src, u8 src_type);
1115 
1116 struct hci_dev *hci_alloc_dev(void);
1117 void hci_free_dev(struct hci_dev *hdev);
1118 int hci_register_dev(struct hci_dev *hdev);
1119 void hci_unregister_dev(struct hci_dev *hdev);
1120 int hci_suspend_dev(struct hci_dev *hdev);
1121 int hci_resume_dev(struct hci_dev *hdev);
1122 int hci_reset_dev(struct hci_dev *hdev);
1123 int hci_recv_frame(struct hci_dev *hdev, struct sk_buff *skb);
1124 int hci_recv_diag(struct hci_dev *hdev, struct sk_buff *skb);
1125 __printf(2, 3) void hci_set_hw_info(struct hci_dev *hdev, const char *fmt, ...);
1126 __printf(2, 3) void hci_set_fw_info(struct hci_dev *hdev, const char *fmt, ...);
1127 
1128 static inline void hci_set_msft_opcode(struct hci_dev *hdev, __u16 opcode)
1129 {
1130 #if IS_ENABLED(CONFIG_BT_MSFTEXT)
1131 	hdev->msft_opcode = opcode;
1132 #endif
1133 }
1134 
1135 int hci_dev_open(__u16 dev);
1136 int hci_dev_close(__u16 dev);
1137 int hci_dev_do_close(struct hci_dev *hdev);
1138 int hci_dev_reset(__u16 dev);
1139 int hci_dev_reset_stat(__u16 dev);
1140 int hci_dev_cmd(unsigned int cmd, void __user *arg);
1141 int hci_get_dev_list(void __user *arg);
1142 int hci_get_dev_info(void __user *arg);
1143 int hci_get_conn_list(void __user *arg);
1144 int hci_get_conn_info(struct hci_dev *hdev, void __user *arg);
1145 int hci_get_auth_info(struct hci_dev *hdev, void __user *arg);
1146 int hci_inquiry(void __user *arg);
1147 
1148 struct bdaddr_list *hci_bdaddr_list_lookup(struct list_head *list,
1149 					   bdaddr_t *bdaddr, u8 type);
1150 struct bdaddr_list_with_irk *hci_bdaddr_list_lookup_with_irk(
1151 				    struct list_head *list, bdaddr_t *bdaddr,
1152 				    u8 type);
1153 int hci_bdaddr_list_add(struct list_head *list, bdaddr_t *bdaddr, u8 type);
1154 int hci_bdaddr_list_add_with_irk(struct list_head *list, bdaddr_t *bdaddr,
1155 					u8 type, u8 *peer_irk, u8 *local_irk);
1156 int hci_bdaddr_list_del(struct list_head *list, bdaddr_t *bdaddr, u8 type);
1157 int hci_bdaddr_list_del_with_irk(struct list_head *list, bdaddr_t *bdaddr,
1158 								u8 type);
1159 void hci_bdaddr_list_clear(struct list_head *list);
1160 
1161 struct hci_conn_params *hci_conn_params_lookup(struct hci_dev *hdev,
1162 					       bdaddr_t *addr, u8 addr_type);
1163 struct hci_conn_params *hci_conn_params_add(struct hci_dev *hdev,
1164 					    bdaddr_t *addr, u8 addr_type);
1165 void hci_conn_params_del(struct hci_dev *hdev, bdaddr_t *addr, u8 addr_type);
1166 void hci_conn_params_clear_disabled(struct hci_dev *hdev);
1167 
1168 struct hci_conn_params *hci_pend_le_action_lookup(struct list_head *list,
1169 						  bdaddr_t *addr,
1170 						  u8 addr_type);
1171 
1172 void hci_uuids_clear(struct hci_dev *hdev);
1173 
1174 void hci_link_keys_clear(struct hci_dev *hdev);
1175 struct link_key *hci_find_link_key(struct hci_dev *hdev, bdaddr_t *bdaddr);
1176 struct link_key *hci_add_link_key(struct hci_dev *hdev, struct hci_conn *conn,
1177 				  bdaddr_t *bdaddr, u8 *val, u8 type,
1178 				  u8 pin_len, bool *persistent);
1179 struct smp_ltk *hci_add_ltk(struct hci_dev *hdev, bdaddr_t *bdaddr,
1180 			    u8 addr_type, u8 type, u8 authenticated,
1181 			    u8 tk[16], u8 enc_size, __le16 ediv, __le64 rand);
1182 struct smp_ltk *hci_find_ltk(struct hci_dev *hdev, bdaddr_t *bdaddr,
1183 			     u8 addr_type, u8 role);
1184 int hci_remove_ltk(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 bdaddr_type);
1185 void hci_smp_ltks_clear(struct hci_dev *hdev);
1186 int hci_remove_link_key(struct hci_dev *hdev, bdaddr_t *bdaddr);
1187 
1188 struct smp_irk *hci_find_irk_by_rpa(struct hci_dev *hdev, bdaddr_t *rpa);
1189 struct smp_irk *hci_find_irk_by_addr(struct hci_dev *hdev, bdaddr_t *bdaddr,
1190 				     u8 addr_type);
1191 struct smp_irk *hci_add_irk(struct hci_dev *hdev, bdaddr_t *bdaddr,
1192 			    u8 addr_type, u8 val[16], bdaddr_t *rpa);
1193 void hci_remove_irk(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 addr_type);
1194 bool hci_is_blocked_key(struct hci_dev *hdev, u8 type, u8 val[16]);
1195 void hci_blocked_keys_clear(struct hci_dev *hdev);
1196 void hci_smp_irks_clear(struct hci_dev *hdev);
1197 
1198 bool hci_bdaddr_is_paired(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 type);
1199 
1200 void hci_remote_oob_data_clear(struct hci_dev *hdev);
1201 struct oob_data *hci_find_remote_oob_data(struct hci_dev *hdev,
1202 					  bdaddr_t *bdaddr, u8 bdaddr_type);
1203 int hci_add_remote_oob_data(struct hci_dev *hdev, bdaddr_t *bdaddr,
1204 			    u8 bdaddr_type, u8 *hash192, u8 *rand192,
1205 			    u8 *hash256, u8 *rand256);
1206 int hci_remove_remote_oob_data(struct hci_dev *hdev, bdaddr_t *bdaddr,
1207 			       u8 bdaddr_type);
1208 
1209 void hci_adv_instances_clear(struct hci_dev *hdev);
1210 struct adv_info *hci_find_adv_instance(struct hci_dev *hdev, u8 instance);
1211 struct adv_info *hci_get_next_instance(struct hci_dev *hdev, u8 instance);
1212 int hci_add_adv_instance(struct hci_dev *hdev, u8 instance, u32 flags,
1213 			 u16 adv_data_len, u8 *adv_data,
1214 			 u16 scan_rsp_len, u8 *scan_rsp_data,
1215 			 u16 timeout, u16 duration);
1216 int hci_remove_adv_instance(struct hci_dev *hdev, u8 instance);
1217 void hci_adv_instances_set_rpa_expired(struct hci_dev *hdev, bool rpa_expired);
1218 
1219 void hci_event_packet(struct hci_dev *hdev, struct sk_buff *skb);
1220 
1221 void hci_init_sysfs(struct hci_dev *hdev);
1222 void hci_conn_init_sysfs(struct hci_conn *conn);
1223 void hci_conn_add_sysfs(struct hci_conn *conn);
1224 void hci_conn_del_sysfs(struct hci_conn *conn);
1225 
1226 #define SET_HCIDEV_DEV(hdev, pdev) ((hdev)->dev.parent = (pdev))
1227 
1228 /* ----- LMP capabilities ----- */
1229 #define lmp_encrypt_capable(dev)   ((dev)->features[0][0] & LMP_ENCRYPT)
1230 #define lmp_rswitch_capable(dev)   ((dev)->features[0][0] & LMP_RSWITCH)
1231 #define lmp_hold_capable(dev)      ((dev)->features[0][0] & LMP_HOLD)
1232 #define lmp_sniff_capable(dev)     ((dev)->features[0][0] & LMP_SNIFF)
1233 #define lmp_park_capable(dev)      ((dev)->features[0][1] & LMP_PARK)
1234 #define lmp_inq_rssi_capable(dev)  ((dev)->features[0][3] & LMP_RSSI_INQ)
1235 #define lmp_esco_capable(dev)      ((dev)->features[0][3] & LMP_ESCO)
1236 #define lmp_bredr_capable(dev)     (!((dev)->features[0][4] & LMP_NO_BREDR))
1237 #define lmp_le_capable(dev)        ((dev)->features[0][4] & LMP_LE)
1238 #define lmp_sniffsubr_capable(dev) ((dev)->features[0][5] & LMP_SNIFF_SUBR)
1239 #define lmp_pause_enc_capable(dev) ((dev)->features[0][5] & LMP_PAUSE_ENC)
1240 #define lmp_ext_inq_capable(dev)   ((dev)->features[0][6] & LMP_EXT_INQ)
1241 #define lmp_le_br_capable(dev)     (!!((dev)->features[0][6] & LMP_SIMUL_LE_BR))
1242 #define lmp_ssp_capable(dev)       ((dev)->features[0][6] & LMP_SIMPLE_PAIR)
1243 #define lmp_no_flush_capable(dev)  ((dev)->features[0][6] & LMP_NO_FLUSH)
1244 #define lmp_lsto_capable(dev)      ((dev)->features[0][7] & LMP_LSTO)
1245 #define lmp_inq_tx_pwr_capable(dev) ((dev)->features[0][7] & LMP_INQ_TX_PWR)
1246 #define lmp_ext_feat_capable(dev)  ((dev)->features[0][7] & LMP_EXTFEATURES)
1247 #define lmp_transp_capable(dev)    ((dev)->features[0][2] & LMP_TRANSPARENT)
1248 #define lmp_edr_2m_capable(dev)    ((dev)->features[0][3] & LMP_EDR_2M)
1249 #define lmp_edr_3m_capable(dev)    ((dev)->features[0][3] & LMP_EDR_3M)
1250 #define lmp_edr_3slot_capable(dev) ((dev)->features[0][4] & LMP_EDR_3SLOT)
1251 #define lmp_edr_5slot_capable(dev) ((dev)->features[0][5] & LMP_EDR_5SLOT)
1252 
1253 /* ----- Extended LMP capabilities ----- */
1254 #define lmp_csb_master_capable(dev) ((dev)->features[2][0] & LMP_CSB_MASTER)
1255 #define lmp_csb_slave_capable(dev)  ((dev)->features[2][0] & LMP_CSB_SLAVE)
1256 #define lmp_sync_train_capable(dev) ((dev)->features[2][0] & LMP_SYNC_TRAIN)
1257 #define lmp_sync_scan_capable(dev)  ((dev)->features[2][0] & LMP_SYNC_SCAN)
1258 #define lmp_sc_capable(dev)         ((dev)->features[2][1] & LMP_SC)
1259 #define lmp_ping_capable(dev)       ((dev)->features[2][1] & LMP_PING)
1260 
1261 /* ----- Host capabilities ----- */
1262 #define lmp_host_ssp_capable(dev)  ((dev)->features[1][0] & LMP_HOST_SSP)
1263 #define lmp_host_sc_capable(dev)   ((dev)->features[1][0] & LMP_HOST_SC)
1264 #define lmp_host_le_capable(dev)   (!!((dev)->features[1][0] & LMP_HOST_LE))
1265 #define lmp_host_le_br_capable(dev) (!!((dev)->features[1][0] & LMP_HOST_LE_BREDR))
1266 
1267 #define hdev_is_powered(dev)   (test_bit(HCI_UP, &(dev)->flags) && \
1268 				!hci_dev_test_flag(dev, HCI_AUTO_OFF))
1269 #define bredr_sc_enabled(dev)  (lmp_sc_capable(dev) && \
1270 				hci_dev_test_flag(dev, HCI_SC_ENABLED))
1271 
1272 #define scan_1m(dev) (((dev)->le_tx_def_phys & HCI_LE_SET_PHY_1M) || \
1273 		      ((dev)->le_rx_def_phys & HCI_LE_SET_PHY_1M))
1274 
1275 #define scan_2m(dev) (((dev)->le_tx_def_phys & HCI_LE_SET_PHY_2M) || \
1276 		      ((dev)->le_rx_def_phys & HCI_LE_SET_PHY_2M))
1277 
1278 #define scan_coded(dev) (((dev)->le_tx_def_phys & HCI_LE_SET_PHY_CODED) || \
1279 			 ((dev)->le_rx_def_phys & HCI_LE_SET_PHY_CODED))
1280 
1281 /* Use ext scanning if set ext scan param and ext scan enable is supported */
1282 #define use_ext_scan(dev) (((dev)->commands[37] & 0x20) && \
1283 			   ((dev)->commands[37] & 0x40))
1284 /* Use ext create connection if command is supported */
1285 #define use_ext_conn(dev) ((dev)->commands[37] & 0x80)
1286 
1287 /* Extended advertising support */
1288 #define ext_adv_capable(dev) (((dev)->le_features[1] & HCI_LE_EXT_ADV))
1289 
1290 /* ----- HCI protocols ----- */
1291 #define HCI_PROTO_DEFER             0x01
1292 
1293 static inline int hci_proto_connect_ind(struct hci_dev *hdev, bdaddr_t *bdaddr,
1294 					__u8 type, __u8 *flags)
1295 {
1296 	switch (type) {
1297 	case ACL_LINK:
1298 		return l2cap_connect_ind(hdev, bdaddr);
1299 
1300 	case SCO_LINK:
1301 	case ESCO_LINK:
1302 		return sco_connect_ind(hdev, bdaddr, flags);
1303 
1304 	default:
1305 		BT_ERR("unknown link type %d", type);
1306 		return -EINVAL;
1307 	}
1308 }
1309 
1310 static inline int hci_proto_disconn_ind(struct hci_conn *conn)
1311 {
1312 	if (conn->type != ACL_LINK && conn->type != LE_LINK)
1313 		return HCI_ERROR_REMOTE_USER_TERM;
1314 
1315 	return l2cap_disconn_ind(conn);
1316 }
1317 
1318 /* ----- HCI callbacks ----- */
1319 struct hci_cb {
1320 	struct list_head list;
1321 
1322 	char *name;
1323 
1324 	void (*connect_cfm)	(struct hci_conn *conn, __u8 status);
1325 	void (*disconn_cfm)	(struct hci_conn *conn, __u8 status);
1326 	void (*security_cfm)	(struct hci_conn *conn, __u8 status,
1327 								__u8 encrypt);
1328 	void (*key_change_cfm)	(struct hci_conn *conn, __u8 status);
1329 	void (*role_switch_cfm)	(struct hci_conn *conn, __u8 status, __u8 role);
1330 };
1331 
1332 static inline void hci_connect_cfm(struct hci_conn *conn, __u8 status)
1333 {
1334 	struct hci_cb *cb;
1335 
1336 	mutex_lock(&hci_cb_list_lock);
1337 	list_for_each_entry(cb, &hci_cb_list, list) {
1338 		if (cb->connect_cfm)
1339 			cb->connect_cfm(conn, status);
1340 	}
1341 	mutex_unlock(&hci_cb_list_lock);
1342 
1343 	if (conn->connect_cfm_cb)
1344 		conn->connect_cfm_cb(conn, status);
1345 }
1346 
1347 static inline void hci_disconn_cfm(struct hci_conn *conn, __u8 reason)
1348 {
1349 	struct hci_cb *cb;
1350 
1351 	mutex_lock(&hci_cb_list_lock);
1352 	list_for_each_entry(cb, &hci_cb_list, list) {
1353 		if (cb->disconn_cfm)
1354 			cb->disconn_cfm(conn, reason);
1355 	}
1356 	mutex_unlock(&hci_cb_list_lock);
1357 
1358 	if (conn->disconn_cfm_cb)
1359 		conn->disconn_cfm_cb(conn, reason);
1360 }
1361 
1362 static inline void hci_auth_cfm(struct hci_conn *conn, __u8 status)
1363 {
1364 	struct hci_cb *cb;
1365 	__u8 encrypt;
1366 
1367 	if (test_bit(HCI_CONN_ENCRYPT_PEND, &conn->flags))
1368 		return;
1369 
1370 	encrypt = test_bit(HCI_CONN_ENCRYPT, &conn->flags) ? 0x01 : 0x00;
1371 
1372 	mutex_lock(&hci_cb_list_lock);
1373 	list_for_each_entry(cb, &hci_cb_list, list) {
1374 		if (cb->security_cfm)
1375 			cb->security_cfm(conn, status, encrypt);
1376 	}
1377 	mutex_unlock(&hci_cb_list_lock);
1378 
1379 	if (conn->security_cfm_cb)
1380 		conn->security_cfm_cb(conn, status);
1381 }
1382 
1383 static inline void hci_encrypt_cfm(struct hci_conn *conn, __u8 status,
1384 								__u8 encrypt)
1385 {
1386 	struct hci_cb *cb;
1387 
1388 	if (conn->sec_level == BT_SECURITY_SDP)
1389 		conn->sec_level = BT_SECURITY_LOW;
1390 
1391 	if (conn->pending_sec_level > conn->sec_level)
1392 		conn->sec_level = conn->pending_sec_level;
1393 
1394 	mutex_lock(&hci_cb_list_lock);
1395 	list_for_each_entry(cb, &hci_cb_list, list) {
1396 		if (cb->security_cfm)
1397 			cb->security_cfm(conn, status, encrypt);
1398 	}
1399 	mutex_unlock(&hci_cb_list_lock);
1400 
1401 	if (conn->security_cfm_cb)
1402 		conn->security_cfm_cb(conn, status);
1403 }
1404 
1405 static inline void hci_key_change_cfm(struct hci_conn *conn, __u8 status)
1406 {
1407 	struct hci_cb *cb;
1408 
1409 	mutex_lock(&hci_cb_list_lock);
1410 	list_for_each_entry(cb, &hci_cb_list, list) {
1411 		if (cb->key_change_cfm)
1412 			cb->key_change_cfm(conn, status);
1413 	}
1414 	mutex_unlock(&hci_cb_list_lock);
1415 }
1416 
1417 static inline void hci_role_switch_cfm(struct hci_conn *conn, __u8 status,
1418 								__u8 role)
1419 {
1420 	struct hci_cb *cb;
1421 
1422 	mutex_lock(&hci_cb_list_lock);
1423 	list_for_each_entry(cb, &hci_cb_list, list) {
1424 		if (cb->role_switch_cfm)
1425 			cb->role_switch_cfm(conn, status, role);
1426 	}
1427 	mutex_unlock(&hci_cb_list_lock);
1428 }
1429 
1430 static inline void *eir_get_data(u8 *eir, size_t eir_len, u8 type,
1431 				 size_t *data_len)
1432 {
1433 	size_t parsed = 0;
1434 
1435 	if (eir_len < 2)
1436 		return NULL;
1437 
1438 	while (parsed < eir_len - 1) {
1439 		u8 field_len = eir[0];
1440 
1441 		if (field_len == 0)
1442 			break;
1443 
1444 		parsed += field_len + 1;
1445 
1446 		if (parsed > eir_len)
1447 			break;
1448 
1449 		if (eir[1] != type) {
1450 			eir += field_len + 1;
1451 			continue;
1452 		}
1453 
1454 		/* Zero length data */
1455 		if (field_len == 1)
1456 			return NULL;
1457 
1458 		if (data_len)
1459 			*data_len = field_len - 1;
1460 
1461 		return &eir[2];
1462 	}
1463 
1464 	return NULL;
1465 }
1466 
1467 static inline bool hci_bdaddr_is_rpa(bdaddr_t *bdaddr, u8 addr_type)
1468 {
1469 	if (addr_type != ADDR_LE_DEV_RANDOM)
1470 		return false;
1471 
1472 	if ((bdaddr->b[5] & 0xc0) == 0x40)
1473 	       return true;
1474 
1475 	return false;
1476 }
1477 
1478 static inline bool hci_is_identity_address(bdaddr_t *addr, u8 addr_type)
1479 {
1480 	if (addr_type == ADDR_LE_DEV_PUBLIC)
1481 		return true;
1482 
1483 	/* Check for Random Static address type */
1484 	if ((addr->b[5] & 0xc0) == 0xc0)
1485 		return true;
1486 
1487 	return false;
1488 }
1489 
1490 static inline struct smp_irk *hci_get_irk(struct hci_dev *hdev,
1491 					  bdaddr_t *bdaddr, u8 addr_type)
1492 {
1493 	if (!hci_bdaddr_is_rpa(bdaddr, addr_type))
1494 		return NULL;
1495 
1496 	return hci_find_irk_by_rpa(hdev, bdaddr);
1497 }
1498 
1499 static inline int hci_check_conn_params(u16 min, u16 max, u16 latency,
1500 					u16 to_multiplier)
1501 {
1502 	u16 max_latency;
1503 
1504 	if (min > max || min < 6 || max > 3200)
1505 		return -EINVAL;
1506 
1507 	if (to_multiplier < 10 || to_multiplier > 3200)
1508 		return -EINVAL;
1509 
1510 	if (max >= to_multiplier * 8)
1511 		return -EINVAL;
1512 
1513 	max_latency = (to_multiplier * 4 / max) - 1;
1514 	if (latency > 499 || latency > max_latency)
1515 		return -EINVAL;
1516 
1517 	return 0;
1518 }
1519 
1520 int hci_register_cb(struct hci_cb *hcb);
1521 int hci_unregister_cb(struct hci_cb *hcb);
1522 
1523 struct sk_buff *__hci_cmd_sync(struct hci_dev *hdev, u16 opcode, u32 plen,
1524 			       const void *param, u32 timeout);
1525 struct sk_buff *__hci_cmd_sync_ev(struct hci_dev *hdev, u16 opcode, u32 plen,
1526 				  const void *param, u8 event, u32 timeout);
1527 int __hci_cmd_send(struct hci_dev *hdev, u16 opcode, u32 plen,
1528 		   const void *param);
1529 
1530 int hci_send_cmd(struct hci_dev *hdev, __u16 opcode, __u32 plen,
1531 		 const void *param);
1532 void hci_send_acl(struct hci_chan *chan, struct sk_buff *skb, __u16 flags);
1533 void hci_send_sco(struct hci_conn *conn, struct sk_buff *skb);
1534 
1535 void *hci_sent_cmd_data(struct hci_dev *hdev, __u16 opcode);
1536 
1537 struct sk_buff *hci_cmd_sync(struct hci_dev *hdev, u16 opcode, u32 plen,
1538 			     const void *param, u32 timeout);
1539 
1540 u32 hci_conn_get_phy(struct hci_conn *conn);
1541 
1542 /* ----- HCI Sockets ----- */
1543 void hci_send_to_sock(struct hci_dev *hdev, struct sk_buff *skb);
1544 void hci_send_to_channel(unsigned short channel, struct sk_buff *skb,
1545 			 int flag, struct sock *skip_sk);
1546 void hci_send_to_monitor(struct hci_dev *hdev, struct sk_buff *skb);
1547 void hci_send_monitor_ctrl_event(struct hci_dev *hdev, u16 event,
1548 				 void *data, u16 data_len, ktime_t tstamp,
1549 				 int flag, struct sock *skip_sk);
1550 
1551 void hci_sock_dev_event(struct hci_dev *hdev, int event);
1552 
1553 #define HCI_MGMT_VAR_LEN	BIT(0)
1554 #define HCI_MGMT_NO_HDEV	BIT(1)
1555 #define HCI_MGMT_UNTRUSTED	BIT(2)
1556 #define HCI_MGMT_UNCONFIGURED	BIT(3)
1557 
1558 struct hci_mgmt_handler {
1559 	int (*func) (struct sock *sk, struct hci_dev *hdev, void *data,
1560 		     u16 data_len);
1561 	size_t data_len;
1562 	unsigned long flags;
1563 };
1564 
1565 struct hci_mgmt_chan {
1566 	struct list_head list;
1567 	unsigned short channel;
1568 	size_t handler_count;
1569 	const struct hci_mgmt_handler *handlers;
1570 	void (*hdev_init) (struct sock *sk, struct hci_dev *hdev);
1571 };
1572 
1573 int hci_mgmt_chan_register(struct hci_mgmt_chan *c);
1574 void hci_mgmt_chan_unregister(struct hci_mgmt_chan *c);
1575 
1576 /* Management interface */
1577 #define DISCOV_TYPE_BREDR		(BIT(BDADDR_BREDR))
1578 #define DISCOV_TYPE_LE			(BIT(BDADDR_LE_PUBLIC) | \
1579 					 BIT(BDADDR_LE_RANDOM))
1580 #define DISCOV_TYPE_INTERLEAVED		(BIT(BDADDR_BREDR) | \
1581 					 BIT(BDADDR_LE_PUBLIC) | \
1582 					 BIT(BDADDR_LE_RANDOM))
1583 
1584 /* These LE scan and inquiry parameters were chosen according to LE General
1585  * Discovery Procedure specification.
1586  */
1587 #define DISCOV_LE_SCAN_WIN		0x12
1588 #define DISCOV_LE_SCAN_INT		0x12
1589 #define DISCOV_LE_TIMEOUT		10240	/* msec */
1590 #define DISCOV_INTERLEAVED_TIMEOUT	5120	/* msec */
1591 #define DISCOV_INTERLEAVED_INQUIRY_LEN	0x04
1592 #define DISCOV_BREDR_INQUIRY_LEN	0x08
1593 #define DISCOV_LE_RESTART_DELAY		msecs_to_jiffies(200)	/* msec */
1594 #define DISCOV_LE_FAST_ADV_INT_MIN     100     /* msec */
1595 #define DISCOV_LE_FAST_ADV_INT_MAX     150     /* msec */
1596 
1597 void mgmt_fill_version_info(void *ver);
1598 int mgmt_new_settings(struct hci_dev *hdev);
1599 void mgmt_index_added(struct hci_dev *hdev);
1600 void mgmt_index_removed(struct hci_dev *hdev);
1601 void mgmt_set_powered_failed(struct hci_dev *hdev, int err);
1602 void mgmt_power_on(struct hci_dev *hdev, int err);
1603 void __mgmt_power_off(struct hci_dev *hdev);
1604 void mgmt_new_link_key(struct hci_dev *hdev, struct link_key *key,
1605 		       bool persistent);
1606 void mgmt_device_connected(struct hci_dev *hdev, struct hci_conn *conn,
1607 			   u32 flags, u8 *name, u8 name_len);
1608 void mgmt_device_disconnected(struct hci_dev *hdev, bdaddr_t *bdaddr,
1609 			      u8 link_type, u8 addr_type, u8 reason,
1610 			      bool mgmt_connected);
1611 void mgmt_disconnect_failed(struct hci_dev *hdev, bdaddr_t *bdaddr,
1612 			    u8 link_type, u8 addr_type, u8 status);
1613 void mgmt_connect_failed(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 link_type,
1614 			 u8 addr_type, u8 status);
1615 void mgmt_pin_code_request(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 secure);
1616 void mgmt_pin_code_reply_complete(struct hci_dev *hdev, bdaddr_t *bdaddr,
1617 				  u8 status);
1618 void mgmt_pin_code_neg_reply_complete(struct hci_dev *hdev, bdaddr_t *bdaddr,
1619 				      u8 status);
1620 int mgmt_user_confirm_request(struct hci_dev *hdev, bdaddr_t *bdaddr,
1621 			      u8 link_type, u8 addr_type, u32 value,
1622 			      u8 confirm_hint);
1623 int mgmt_user_confirm_reply_complete(struct hci_dev *hdev, bdaddr_t *bdaddr,
1624 				     u8 link_type, u8 addr_type, u8 status);
1625 int mgmt_user_confirm_neg_reply_complete(struct hci_dev *hdev, bdaddr_t *bdaddr,
1626 					 u8 link_type, u8 addr_type, u8 status);
1627 int mgmt_user_passkey_request(struct hci_dev *hdev, bdaddr_t *bdaddr,
1628 			      u8 link_type, u8 addr_type);
1629 int mgmt_user_passkey_reply_complete(struct hci_dev *hdev, bdaddr_t *bdaddr,
1630 				     u8 link_type, u8 addr_type, u8 status);
1631 int mgmt_user_passkey_neg_reply_complete(struct hci_dev *hdev, bdaddr_t *bdaddr,
1632 					 u8 link_type, u8 addr_type, u8 status);
1633 int mgmt_user_passkey_notify(struct hci_dev *hdev, bdaddr_t *bdaddr,
1634 			     u8 link_type, u8 addr_type, u32 passkey,
1635 			     u8 entered);
1636 void mgmt_auth_failed(struct hci_conn *conn, u8 status);
1637 void mgmt_auth_enable_complete(struct hci_dev *hdev, u8 status);
1638 void mgmt_ssp_enable_complete(struct hci_dev *hdev, u8 enable, u8 status);
1639 void mgmt_set_class_of_dev_complete(struct hci_dev *hdev, u8 *dev_class,
1640 				    u8 status);
1641 void mgmt_set_local_name_complete(struct hci_dev *hdev, u8 *name, u8 status);
1642 void mgmt_start_discovery_complete(struct hci_dev *hdev, u8 status);
1643 void mgmt_stop_discovery_complete(struct hci_dev *hdev, u8 status);
1644 void mgmt_device_found(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 link_type,
1645 		       u8 addr_type, u8 *dev_class, s8 rssi, u32 flags,
1646 		       u8 *eir, u16 eir_len, u8 *scan_rsp, u8 scan_rsp_len);
1647 void mgmt_remote_name(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 link_type,
1648 		      u8 addr_type, s8 rssi, u8 *name, u8 name_len);
1649 void mgmt_discovering(struct hci_dev *hdev, u8 discovering);
1650 bool mgmt_powering_down(struct hci_dev *hdev);
1651 void mgmt_new_ltk(struct hci_dev *hdev, struct smp_ltk *key, bool persistent);
1652 void mgmt_new_irk(struct hci_dev *hdev, struct smp_irk *irk, bool persistent);
1653 void mgmt_new_csrk(struct hci_dev *hdev, struct smp_csrk *csrk,
1654 		   bool persistent);
1655 void mgmt_new_conn_param(struct hci_dev *hdev, bdaddr_t *bdaddr,
1656 			 u8 bdaddr_type, u8 store_hint, u16 min_interval,
1657 			 u16 max_interval, u16 latency, u16 timeout);
1658 void mgmt_smp_complete(struct hci_conn *conn, bool complete);
1659 bool mgmt_get_connectable(struct hci_dev *hdev);
1660 void mgmt_set_connectable_complete(struct hci_dev *hdev, u8 status);
1661 void mgmt_set_discoverable_complete(struct hci_dev *hdev, u8 status);
1662 u8 mgmt_get_adv_discov_flags(struct hci_dev *hdev);
1663 void mgmt_advertising_added(struct sock *sk, struct hci_dev *hdev,
1664 			    u8 instance);
1665 void mgmt_advertising_removed(struct sock *sk, struct hci_dev *hdev,
1666 			      u8 instance);
1667 int mgmt_phy_configuration_changed(struct hci_dev *hdev, struct sock *skip);
1668 
1669 u8 hci_le_conn_update(struct hci_conn *conn, u16 min, u16 max, u16 latency,
1670 		      u16 to_multiplier);
1671 void hci_le_start_enc(struct hci_conn *conn, __le16 ediv, __le64 rand,
1672 		      __u8 ltk[16], __u8 key_size);
1673 
1674 void hci_copy_identity_address(struct hci_dev *hdev, bdaddr_t *bdaddr,
1675 			       u8 *bdaddr_type);
1676 
1677 #define SCO_AIRMODE_MASK       0x0003
1678 #define SCO_AIRMODE_CVSD       0x0000
1679 #define SCO_AIRMODE_TRANSP     0x0003
1680 
1681 #endif /* __HCI_CORE_H */
1682