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