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