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