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