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