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