xref: /linux/include/net/bluetooth/hci_core.h (revision 08ec212c0f92cbf30e3ecc7349f18151714041d6)
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 <net/bluetooth/hci.h>
29 
30 /* HCI priority */
31 #define HCI_PRIO_MAX	7
32 
33 /* HCI Core structures */
34 struct inquiry_data {
35 	bdaddr_t	bdaddr;
36 	__u8		pscan_rep_mode;
37 	__u8		pscan_period_mode;
38 	__u8		pscan_mode;
39 	__u8		dev_class[3];
40 	__le16		clock_offset;
41 	__s8		rssi;
42 	__u8		ssp_mode;
43 };
44 
45 struct inquiry_entry {
46 	struct list_head	all;		/* inq_cache.all */
47 	struct list_head	list;		/* unknown or resolve */
48 	enum {
49 		NAME_NOT_KNOWN,
50 		NAME_NEEDED,
51 		NAME_PENDING,
52 		NAME_KNOWN,
53 	} name_state;
54 	__u32			timestamp;
55 	struct inquiry_data	data;
56 };
57 
58 struct discovery_state {
59 	int			type;
60 	enum {
61 		DISCOVERY_STOPPED,
62 		DISCOVERY_STARTING,
63 		DISCOVERY_FINDING,
64 		DISCOVERY_RESOLVING,
65 		DISCOVERY_STOPPING,
66 	} state;
67 	struct list_head	all;	/* All devices found during inquiry */
68 	struct list_head	unknown;	/* Name state not known */
69 	struct list_head	resolve;	/* Name needs to be resolved */
70 	__u32			timestamp;
71 };
72 
73 struct hci_conn_hash {
74 	struct list_head list;
75 	unsigned int     acl_num;
76 	unsigned int     sco_num;
77 	unsigned int     le_num;
78 };
79 
80 struct bdaddr_list {
81 	struct list_head list;
82 	bdaddr_t bdaddr;
83 };
84 
85 struct bt_uuid {
86 	struct list_head list;
87 	u8 uuid[16];
88 	u8 svc_hint;
89 };
90 
91 struct smp_ltk {
92 	struct list_head list;
93 	bdaddr_t bdaddr;
94 	u8 bdaddr_type;
95 	u8 authenticated;
96 	u8 type;
97 	u8 enc_size;
98 	__le16 ediv;
99 	u8 rand[8];
100 	u8 val[16];
101 } __packed;
102 
103 struct link_key {
104 	struct list_head list;
105 	bdaddr_t bdaddr;
106 	u8 type;
107 	u8 val[HCI_LINK_KEY_SIZE];
108 	u8 pin_len;
109 };
110 
111 struct oob_data {
112 	struct list_head list;
113 	bdaddr_t bdaddr;
114 	u8 hash[16];
115 	u8 randomizer[16];
116 };
117 
118 struct le_scan_params {
119 	u8 type;
120 	u16 interval;
121 	u16 window;
122 	int timeout;
123 };
124 
125 #define HCI_MAX_SHORT_NAME_LENGTH	10
126 
127 #define NUM_REASSEMBLY 4
128 struct hci_dev {
129 	struct list_head list;
130 	struct mutex	lock;
131 
132 	char		name[8];
133 	unsigned long	flags;
134 	__u16		id;
135 	__u8		bus;
136 	__u8		dev_type;
137 	bdaddr_t	bdaddr;
138 	__u8		dev_name[HCI_MAX_NAME_LENGTH];
139 	__u8		short_name[HCI_MAX_SHORT_NAME_LENGTH];
140 	__u8		eir[HCI_MAX_EIR_LENGTH];
141 	__u8		dev_class[3];
142 	__u8		major_class;
143 	__u8		minor_class;
144 	__u8		features[8];
145 	__u8		host_features[8];
146 	__u8		commands[64];
147 	__u8		hci_ver;
148 	__u16		hci_rev;
149 	__u8		lmp_ver;
150 	__u16		manufacturer;
151 	__u16		lmp_subver;
152 	__u16		voice_setting;
153 	__u8		io_capability;
154 	__s8		inq_tx_power;
155 	__u16		devid_source;
156 	__u16		devid_vendor;
157 	__u16		devid_product;
158 	__u16		devid_version;
159 
160 	__u16		pkt_type;
161 	__u16		esco_type;
162 	__u16		link_policy;
163 	__u16		link_mode;
164 
165 	__u32		idle_timeout;
166 	__u16		sniff_min_interval;
167 	__u16		sniff_max_interval;
168 
169 	__u8		amp_status;
170 	__u32		amp_total_bw;
171 	__u32		amp_max_bw;
172 	__u32		amp_min_latency;
173 	__u32		amp_max_pdu;
174 	__u8		amp_type;
175 	__u16		amp_pal_cap;
176 	__u16		amp_assoc_size;
177 	__u32		amp_max_flush_to;
178 	__u32		amp_be_flush_to;
179 
180 	__u8		flow_ctl_mode;
181 
182 	unsigned int	auto_accept_delay;
183 
184 	unsigned long	quirks;
185 
186 	atomic_t	cmd_cnt;
187 	unsigned int	acl_cnt;
188 	unsigned int	sco_cnt;
189 	unsigned int	le_cnt;
190 
191 	unsigned int	acl_mtu;
192 	unsigned int	sco_mtu;
193 	unsigned int	le_mtu;
194 	unsigned int	acl_pkts;
195 	unsigned int	sco_pkts;
196 	unsigned int	le_pkts;
197 
198 	__u16		block_len;
199 	__u16		block_mtu;
200 	__u16		num_blocks;
201 	__u16		block_cnt;
202 
203 	unsigned long	acl_last_tx;
204 	unsigned long	sco_last_tx;
205 	unsigned long	le_last_tx;
206 
207 	struct workqueue_struct	*workqueue;
208 
209 	struct work_struct	power_on;
210 	struct delayed_work	power_off;
211 
212 	__u16			discov_timeout;
213 	struct delayed_work	discov_off;
214 
215 	struct delayed_work	service_cache;
216 
217 	struct timer_list	cmd_timer;
218 
219 	struct work_struct	rx_work;
220 	struct work_struct	cmd_work;
221 	struct work_struct	tx_work;
222 
223 	struct sk_buff_head	rx_q;
224 	struct sk_buff_head	raw_q;
225 	struct sk_buff_head	cmd_q;
226 
227 	struct sk_buff		*sent_cmd;
228 	struct sk_buff		*reassembly[NUM_REASSEMBLY];
229 
230 	struct mutex		req_lock;
231 	wait_queue_head_t	req_wait_q;
232 	__u32			req_status;
233 	__u32			req_result;
234 
235 	__u16			init_last_cmd;
236 
237 	struct list_head	mgmt_pending;
238 
239 	struct discovery_state	discovery;
240 	struct hci_conn_hash	conn_hash;
241 	struct list_head	blacklist;
242 
243 	struct list_head	uuids;
244 
245 	struct list_head	link_keys;
246 
247 	struct list_head	long_term_keys;
248 
249 	struct list_head	remote_oob_data;
250 
251 	struct hci_dev_stats	stat;
252 
253 	struct sk_buff_head	driver_init;
254 
255 	void			*core_data;
256 
257 	atomic_t		promisc;
258 
259 	struct dentry		*debugfs;
260 
261 	struct device		dev;
262 
263 	struct rfkill		*rfkill;
264 
265 	unsigned long		dev_flags;
266 
267 	struct delayed_work	le_scan_disable;
268 
269 	struct work_struct	le_scan;
270 	struct le_scan_params	le_scan_params;
271 
272 	int (*open)(struct hci_dev *hdev);
273 	int (*close)(struct hci_dev *hdev);
274 	int (*flush)(struct hci_dev *hdev);
275 	int (*send)(struct sk_buff *skb);
276 	void (*notify)(struct hci_dev *hdev, unsigned int evt);
277 	int (*ioctl)(struct hci_dev *hdev, unsigned int cmd, unsigned long arg);
278 };
279 
280 struct hci_conn {
281 	struct list_head list;
282 
283 	atomic_t	refcnt;
284 
285 	bdaddr_t	dst;
286 	__u8		dst_type;
287 	__u16		handle;
288 	__u16		state;
289 	__u8		mode;
290 	__u8		type;
291 	bool		out;
292 	__u8		attempt;
293 	__u8		dev_class[3];
294 	__u8		features[8];
295 	__u16		interval;
296 	__u16		pkt_type;
297 	__u16		link_policy;
298 	__u32		link_mode;
299 	__u8		key_type;
300 	__u8		auth_type;
301 	__u8		sec_level;
302 	__u8		pending_sec_level;
303 	__u8		pin_length;
304 	__u8		enc_key_size;
305 	__u8		io_capability;
306 	__u32		passkey_notify;
307 	__u8		passkey_entered;
308 	__u16		disc_timeout;
309 	unsigned long	flags;
310 
311 	__u8		remote_cap;
312 	__u8		remote_auth;
313 	bool		flush_key;
314 
315 	unsigned int	sent;
316 
317 	struct sk_buff_head data_q;
318 	struct list_head chan_list;
319 
320 	struct delayed_work disc_work;
321 	struct timer_list idle_timer;
322 	struct timer_list auto_accept_timer;
323 
324 	struct device	dev;
325 	atomic_t	devref;
326 
327 	struct hci_dev	*hdev;
328 	void		*l2cap_data;
329 	void		*sco_data;
330 	void		*smp_conn;
331 	struct amp_mgr	*amp_mgr;
332 
333 	struct hci_conn	*link;
334 
335 	void (*connect_cfm_cb)	(struct hci_conn *conn, u8 status);
336 	void (*security_cfm_cb)	(struct hci_conn *conn, u8 status);
337 	void (*disconn_cfm_cb)	(struct hci_conn *conn, u8 reason);
338 };
339 
340 struct hci_chan {
341 	struct list_head list;
342 
343 	struct hci_conn *conn;
344 	struct sk_buff_head data_q;
345 	unsigned int	sent;
346 };
347 
348 extern struct list_head hci_dev_list;
349 extern struct list_head hci_cb_list;
350 extern rwlock_t hci_dev_list_lock;
351 extern rwlock_t hci_cb_list_lock;
352 
353 /* ----- HCI interface to upper protocols ----- */
354 extern int l2cap_connect_ind(struct hci_dev *hdev, bdaddr_t *bdaddr);
355 extern void l2cap_connect_cfm(struct hci_conn *hcon, u8 status);
356 extern int l2cap_disconn_ind(struct hci_conn *hcon);
357 extern void l2cap_disconn_cfm(struct hci_conn *hcon, u8 reason);
358 extern int l2cap_security_cfm(struct hci_conn *hcon, u8 status, u8 encrypt);
359 extern int l2cap_recv_acldata(struct hci_conn *hcon, struct sk_buff *skb,
360 			      u16 flags);
361 
362 extern int sco_connect_ind(struct hci_dev *hdev, bdaddr_t *bdaddr);
363 extern void sco_connect_cfm(struct hci_conn *hcon, __u8 status);
364 extern void sco_disconn_cfm(struct hci_conn *hcon, __u8 reason);
365 extern int sco_recv_scodata(struct hci_conn *hcon, struct sk_buff *skb);
366 
367 /* ----- Inquiry cache ----- */
368 #define INQUIRY_CACHE_AGE_MAX   (HZ*30)   /* 30 seconds */
369 #define INQUIRY_ENTRY_AGE_MAX   (HZ*60)   /* 60 seconds */
370 
371 static inline void discovery_init(struct hci_dev *hdev)
372 {
373 	hdev->discovery.state = DISCOVERY_STOPPED;
374 	INIT_LIST_HEAD(&hdev->discovery.all);
375 	INIT_LIST_HEAD(&hdev->discovery.unknown);
376 	INIT_LIST_HEAD(&hdev->discovery.resolve);
377 }
378 
379 bool hci_discovery_active(struct hci_dev *hdev);
380 
381 void hci_discovery_set_state(struct hci_dev *hdev, int state);
382 
383 static inline int inquiry_cache_empty(struct hci_dev *hdev)
384 {
385 	return list_empty(&hdev->discovery.all);
386 }
387 
388 static inline long inquiry_cache_age(struct hci_dev *hdev)
389 {
390 	struct discovery_state *c = &hdev->discovery;
391 	return jiffies - c->timestamp;
392 }
393 
394 static inline long inquiry_entry_age(struct inquiry_entry *e)
395 {
396 	return jiffies - e->timestamp;
397 }
398 
399 struct inquiry_entry *hci_inquiry_cache_lookup(struct hci_dev *hdev,
400 					       bdaddr_t *bdaddr);
401 struct inquiry_entry *hci_inquiry_cache_lookup_unknown(struct hci_dev *hdev,
402 						       bdaddr_t *bdaddr);
403 struct inquiry_entry *hci_inquiry_cache_lookup_resolve(struct hci_dev *hdev,
404 						       bdaddr_t *bdaddr,
405 						       int state);
406 void hci_inquiry_cache_update_resolve(struct hci_dev *hdev,
407 				      struct inquiry_entry *ie);
408 bool hci_inquiry_cache_update(struct hci_dev *hdev, struct inquiry_data *data,
409 			      bool name_known, bool *ssp);
410 
411 /* ----- HCI Connections ----- */
412 enum {
413 	HCI_CONN_AUTH_PEND,
414 	HCI_CONN_REAUTH_PEND,
415 	HCI_CONN_ENCRYPT_PEND,
416 	HCI_CONN_RSWITCH_PEND,
417 	HCI_CONN_MODE_CHANGE_PEND,
418 	HCI_CONN_SCO_SETUP_PEND,
419 	HCI_CONN_LE_SMP_PEND,
420 	HCI_CONN_MGMT_CONNECTED,
421 	HCI_CONN_SSP_ENABLED,
422 	HCI_CONN_POWER_SAVE,
423 	HCI_CONN_REMOTE_OOB,
424 };
425 
426 static inline bool hci_conn_ssp_enabled(struct hci_conn *conn)
427 {
428 	struct hci_dev *hdev = conn->hdev;
429 	return test_bit(HCI_SSP_ENABLED, &hdev->dev_flags) &&
430 	       test_bit(HCI_CONN_SSP_ENABLED, &conn->flags);
431 }
432 
433 static inline void hci_conn_hash_add(struct hci_dev *hdev, struct hci_conn *c)
434 {
435 	struct hci_conn_hash *h = &hdev->conn_hash;
436 	list_add_rcu(&c->list, &h->list);
437 	switch (c->type) {
438 	case ACL_LINK:
439 		h->acl_num++;
440 		break;
441 	case LE_LINK:
442 		h->le_num++;
443 		break;
444 	case SCO_LINK:
445 	case ESCO_LINK:
446 		h->sco_num++;
447 		break;
448 	}
449 }
450 
451 static inline void hci_conn_hash_del(struct hci_dev *hdev, struct hci_conn *c)
452 {
453 	struct hci_conn_hash *h = &hdev->conn_hash;
454 
455 	list_del_rcu(&c->list);
456 	synchronize_rcu();
457 
458 	switch (c->type) {
459 	case ACL_LINK:
460 		h->acl_num--;
461 		break;
462 	case LE_LINK:
463 		h->le_num--;
464 		break;
465 	case SCO_LINK:
466 	case ESCO_LINK:
467 		h->sco_num--;
468 		break;
469 	}
470 }
471 
472 static inline unsigned int hci_conn_num(struct hci_dev *hdev, __u8 type)
473 {
474 	struct hci_conn_hash *h = &hdev->conn_hash;
475 	switch (type) {
476 	case ACL_LINK:
477 		return h->acl_num;
478 	case LE_LINK:
479 		return h->le_num;
480 	case SCO_LINK:
481 	case ESCO_LINK:
482 		return h->sco_num;
483 	default:
484 		return 0;
485 	}
486 }
487 
488 static inline struct hci_conn *hci_conn_hash_lookup_handle(struct hci_dev *hdev,
489 								__u16 handle)
490 {
491 	struct hci_conn_hash *h = &hdev->conn_hash;
492 	struct hci_conn  *c;
493 
494 	rcu_read_lock();
495 
496 	list_for_each_entry_rcu(c, &h->list, list) {
497 		if (c->handle == handle) {
498 			rcu_read_unlock();
499 			return c;
500 		}
501 	}
502 	rcu_read_unlock();
503 
504 	return NULL;
505 }
506 
507 static inline struct hci_conn *hci_conn_hash_lookup_ba(struct hci_dev *hdev,
508 							__u8 type, bdaddr_t *ba)
509 {
510 	struct hci_conn_hash *h = &hdev->conn_hash;
511 	struct hci_conn  *c;
512 
513 	rcu_read_lock();
514 
515 	list_for_each_entry_rcu(c, &h->list, list) {
516 		if (c->type == type && !bacmp(&c->dst, ba)) {
517 			rcu_read_unlock();
518 			return c;
519 		}
520 	}
521 
522 	rcu_read_unlock();
523 
524 	return NULL;
525 }
526 
527 static inline struct hci_conn *hci_conn_hash_lookup_state(struct hci_dev *hdev,
528 							__u8 type, __u16 state)
529 {
530 	struct hci_conn_hash *h = &hdev->conn_hash;
531 	struct hci_conn  *c;
532 
533 	rcu_read_lock();
534 
535 	list_for_each_entry_rcu(c, &h->list, list) {
536 		if (c->type == type && c->state == state) {
537 			rcu_read_unlock();
538 			return c;
539 		}
540 	}
541 
542 	rcu_read_unlock();
543 
544 	return NULL;
545 }
546 
547 void hci_acl_disconn(struct hci_conn *conn, __u8 reason);
548 void hci_setup_sync(struct hci_conn *conn, __u16 handle);
549 void hci_sco_setup(struct hci_conn *conn, __u8 status);
550 
551 struct hci_conn *hci_conn_add(struct hci_dev *hdev, int type, bdaddr_t *dst);
552 int hci_conn_del(struct hci_conn *conn);
553 void hci_conn_hash_flush(struct hci_dev *hdev);
554 void hci_conn_check_pending(struct hci_dev *hdev);
555 
556 struct hci_chan *hci_chan_create(struct hci_conn *conn);
557 void hci_chan_del(struct hci_chan *chan);
558 void hci_chan_list_flush(struct hci_conn *conn);
559 
560 struct hci_conn *hci_connect(struct hci_dev *hdev, int type, bdaddr_t *dst,
561 			     __u8 dst_type, __u8 sec_level, __u8 auth_type);
562 int hci_conn_check_link_mode(struct hci_conn *conn);
563 int hci_conn_check_secure(struct hci_conn *conn, __u8 sec_level);
564 int hci_conn_security(struct hci_conn *conn, __u8 sec_level, __u8 auth_type);
565 int hci_conn_change_link_key(struct hci_conn *conn);
566 int hci_conn_switch_role(struct hci_conn *conn, __u8 role);
567 
568 void hci_conn_enter_active_mode(struct hci_conn *conn, __u8 force_active);
569 
570 void hci_conn_hold_device(struct hci_conn *conn);
571 void hci_conn_put_device(struct hci_conn *conn);
572 
573 static inline void hci_conn_hold(struct hci_conn *conn)
574 {
575 	BT_DBG("hcon %p orig refcnt %d", conn, atomic_read(&conn->refcnt));
576 
577 	atomic_inc(&conn->refcnt);
578 	cancel_delayed_work(&conn->disc_work);
579 }
580 
581 static inline void hci_conn_put(struct hci_conn *conn)
582 {
583 	BT_DBG("hcon %p orig refcnt %d", conn, atomic_read(&conn->refcnt));
584 
585 	if (atomic_dec_and_test(&conn->refcnt)) {
586 		unsigned long timeo;
587 		if (conn->type == ACL_LINK || conn->type == LE_LINK) {
588 			del_timer(&conn->idle_timer);
589 			if (conn->state == BT_CONNECTED) {
590 				timeo = conn->disc_timeout;
591 				if (!conn->out)
592 					timeo *= 2;
593 			} else {
594 				timeo = msecs_to_jiffies(10);
595 			}
596 		} else {
597 			timeo = msecs_to_jiffies(10);
598 		}
599 		cancel_delayed_work(&conn->disc_work);
600 		queue_delayed_work(conn->hdev->workqueue,
601 					&conn->disc_work, timeo);
602 	}
603 }
604 
605 /* ----- HCI Devices ----- */
606 static inline void hci_dev_put(struct hci_dev *d)
607 {
608 	BT_DBG("%s orig refcnt %d", d->name,
609 	       atomic_read(&d->dev.kobj.kref.refcount));
610 
611 	put_device(&d->dev);
612 }
613 
614 static inline struct hci_dev *hci_dev_hold(struct hci_dev *d)
615 {
616 	BT_DBG("%s orig refcnt %d", d->name,
617 	       atomic_read(&d->dev.kobj.kref.refcount));
618 
619 	get_device(&d->dev);
620 	return d;
621 }
622 
623 #define hci_dev_lock(d)		mutex_lock(&d->lock)
624 #define hci_dev_unlock(d)	mutex_unlock(&d->lock)
625 
626 #define to_hci_dev(d) container_of(d, struct hci_dev, dev)
627 #define to_hci_conn(c) container_of(c, struct hci_conn, dev)
628 
629 static inline void *hci_get_drvdata(struct hci_dev *hdev)
630 {
631 	return dev_get_drvdata(&hdev->dev);
632 }
633 
634 static inline void hci_set_drvdata(struct hci_dev *hdev, void *data)
635 {
636 	dev_set_drvdata(&hdev->dev, data);
637 }
638 
639 /* hci_dev_list shall be locked */
640 static inline uint8_t __hci_num_ctrl(void)
641 {
642 	uint8_t count = 0;
643 	struct list_head *p;
644 
645 	list_for_each(p, &hci_dev_list) {
646 		count++;
647 	}
648 
649 	return count;
650 }
651 
652 struct hci_dev *hci_dev_get(int index);
653 struct hci_dev *hci_get_route(bdaddr_t *src, bdaddr_t *dst);
654 
655 struct hci_dev *hci_alloc_dev(void);
656 void hci_free_dev(struct hci_dev *hdev);
657 int hci_register_dev(struct hci_dev *hdev);
658 void hci_unregister_dev(struct hci_dev *hdev);
659 int hci_suspend_dev(struct hci_dev *hdev);
660 int hci_resume_dev(struct hci_dev *hdev);
661 int hci_dev_open(__u16 dev);
662 int hci_dev_close(__u16 dev);
663 int hci_dev_reset(__u16 dev);
664 int hci_dev_reset_stat(__u16 dev);
665 int hci_dev_cmd(unsigned int cmd, void __user *arg);
666 int hci_get_dev_list(void __user *arg);
667 int hci_get_dev_info(void __user *arg);
668 int hci_get_conn_list(void __user *arg);
669 int hci_get_conn_info(struct hci_dev *hdev, void __user *arg);
670 int hci_get_auth_info(struct hci_dev *hdev, void __user *arg);
671 int hci_inquiry(void __user *arg);
672 
673 struct bdaddr_list *hci_blacklist_lookup(struct hci_dev *hdev,
674 					 bdaddr_t *bdaddr);
675 int hci_blacklist_clear(struct hci_dev *hdev);
676 int hci_blacklist_add(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 type);
677 int hci_blacklist_del(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 type);
678 
679 int hci_uuids_clear(struct hci_dev *hdev);
680 
681 int hci_link_keys_clear(struct hci_dev *hdev);
682 struct link_key *hci_find_link_key(struct hci_dev *hdev, bdaddr_t *bdaddr);
683 int hci_add_link_key(struct hci_dev *hdev, struct hci_conn *conn, int new_key,
684 		     bdaddr_t *bdaddr, u8 *val, u8 type, u8 pin_len);
685 struct smp_ltk *hci_find_ltk(struct hci_dev *hdev, __le16 ediv, u8 rand[8]);
686 int hci_add_ltk(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 addr_type, u8 type,
687 		int new_key, u8 authenticated, u8 tk[16], u8 enc_size,
688 		__le16 ediv, u8 rand[8]);
689 struct smp_ltk *hci_find_ltk_by_addr(struct hci_dev *hdev, bdaddr_t *bdaddr,
690 				     u8 addr_type);
691 int hci_remove_ltk(struct hci_dev *hdev, bdaddr_t *bdaddr);
692 int hci_smp_ltks_clear(struct hci_dev *hdev);
693 int hci_remove_link_key(struct hci_dev *hdev, bdaddr_t *bdaddr);
694 
695 int hci_remote_oob_data_clear(struct hci_dev *hdev);
696 struct oob_data *hci_find_remote_oob_data(struct hci_dev *hdev,
697 							bdaddr_t *bdaddr);
698 int hci_add_remote_oob_data(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 *hash,
699 								u8 *randomizer);
700 int hci_remove_remote_oob_data(struct hci_dev *hdev, bdaddr_t *bdaddr);
701 
702 void hci_event_packet(struct hci_dev *hdev, struct sk_buff *skb);
703 
704 int hci_recv_frame(struct sk_buff *skb);
705 int hci_recv_fragment(struct hci_dev *hdev, int type, void *data, int count);
706 int hci_recv_stream_fragment(struct hci_dev *hdev, void *data, int count);
707 
708 void hci_init_sysfs(struct hci_dev *hdev);
709 int hci_add_sysfs(struct hci_dev *hdev);
710 void hci_del_sysfs(struct hci_dev *hdev);
711 void hci_conn_init_sysfs(struct hci_conn *conn);
712 void hci_conn_add_sysfs(struct hci_conn *conn);
713 void hci_conn_del_sysfs(struct hci_conn *conn);
714 
715 #define SET_HCIDEV_DEV(hdev, pdev) ((hdev)->dev.parent = (pdev))
716 
717 /* ----- LMP capabilities ----- */
718 #define lmp_rswitch_capable(dev)   ((dev)->features[0] & LMP_RSWITCH)
719 #define lmp_encrypt_capable(dev)   ((dev)->features[0] & LMP_ENCRYPT)
720 #define lmp_sniff_capable(dev)     ((dev)->features[0] & LMP_SNIFF)
721 #define lmp_sniffsubr_capable(dev) ((dev)->features[5] & LMP_SNIFF_SUBR)
722 #define lmp_esco_capable(dev)      ((dev)->features[3] & LMP_ESCO)
723 #define lmp_ssp_capable(dev)       ((dev)->features[6] & LMP_SIMPLE_PAIR)
724 #define lmp_no_flush_capable(dev)  ((dev)->features[6] & LMP_NO_FLUSH)
725 #define lmp_le_capable(dev)        ((dev)->features[4] & LMP_LE)
726 #define lmp_bredr_capable(dev)     (!((dev)->features[4] & LMP_NO_BREDR))
727 
728 /* ----- Extended LMP capabilities ----- */
729 #define lmp_host_le_capable(dev)   ((dev)->host_features[0] & LMP_HOST_LE)
730 
731 /* ----- HCI protocols ----- */
732 static inline int hci_proto_connect_ind(struct hci_dev *hdev, bdaddr_t *bdaddr,
733 								__u8 type)
734 {
735 	switch (type) {
736 	case ACL_LINK:
737 		return l2cap_connect_ind(hdev, bdaddr);
738 
739 	case SCO_LINK:
740 	case ESCO_LINK:
741 		return sco_connect_ind(hdev, bdaddr);
742 
743 	default:
744 		BT_ERR("unknown link type %d", type);
745 		return -EINVAL;
746 	}
747 }
748 
749 static inline void hci_proto_connect_cfm(struct hci_conn *conn, __u8 status)
750 {
751 	switch (conn->type) {
752 	case ACL_LINK:
753 	case LE_LINK:
754 		l2cap_connect_cfm(conn, status);
755 		break;
756 
757 	case SCO_LINK:
758 	case ESCO_LINK:
759 		sco_connect_cfm(conn, status);
760 		break;
761 
762 	default:
763 		BT_ERR("unknown link type %d", conn->type);
764 		break;
765 	}
766 
767 	if (conn->connect_cfm_cb)
768 		conn->connect_cfm_cb(conn, status);
769 }
770 
771 static inline int hci_proto_disconn_ind(struct hci_conn *conn)
772 {
773 	if (conn->type != ACL_LINK && conn->type != LE_LINK)
774 		return HCI_ERROR_REMOTE_USER_TERM;
775 
776 	return l2cap_disconn_ind(conn);
777 }
778 
779 static inline void hci_proto_disconn_cfm(struct hci_conn *conn, __u8 reason)
780 {
781 	switch (conn->type) {
782 	case ACL_LINK:
783 	case LE_LINK:
784 		l2cap_disconn_cfm(conn, reason);
785 		break;
786 
787 	case SCO_LINK:
788 	case ESCO_LINK:
789 		sco_disconn_cfm(conn, reason);
790 		break;
791 
792 	default:
793 		BT_ERR("unknown link type %d", conn->type);
794 		break;
795 	}
796 
797 	if (conn->disconn_cfm_cb)
798 		conn->disconn_cfm_cb(conn, reason);
799 }
800 
801 static inline void hci_proto_auth_cfm(struct hci_conn *conn, __u8 status)
802 {
803 	__u8 encrypt;
804 
805 	if (conn->type != ACL_LINK && conn->type != LE_LINK)
806 		return;
807 
808 	if (test_bit(HCI_CONN_ENCRYPT_PEND, &conn->flags))
809 		return;
810 
811 	encrypt = (conn->link_mode & HCI_LM_ENCRYPT) ? 0x01 : 0x00;
812 	l2cap_security_cfm(conn, status, encrypt);
813 
814 	if (conn->security_cfm_cb)
815 		conn->security_cfm_cb(conn, status);
816 }
817 
818 static inline void hci_proto_encrypt_cfm(struct hci_conn *conn, __u8 status,
819 								__u8 encrypt)
820 {
821 	if (conn->type != ACL_LINK && conn->type != LE_LINK)
822 		return;
823 
824 	l2cap_security_cfm(conn, status, encrypt);
825 
826 	if (conn->security_cfm_cb)
827 		conn->security_cfm_cb(conn, status);
828 }
829 
830 /* ----- HCI callbacks ----- */
831 struct hci_cb {
832 	struct list_head list;
833 
834 	char *name;
835 
836 	void (*security_cfm)	(struct hci_conn *conn, __u8 status,
837 								__u8 encrypt);
838 	void (*key_change_cfm)	(struct hci_conn *conn, __u8 status);
839 	void (*role_switch_cfm)	(struct hci_conn *conn, __u8 status, __u8 role);
840 };
841 
842 static inline void hci_auth_cfm(struct hci_conn *conn, __u8 status)
843 {
844 	struct list_head *p;
845 	__u8 encrypt;
846 
847 	hci_proto_auth_cfm(conn, status);
848 
849 	if (test_bit(HCI_CONN_ENCRYPT_PEND, &conn->flags))
850 		return;
851 
852 	encrypt = (conn->link_mode & HCI_LM_ENCRYPT) ? 0x01 : 0x00;
853 
854 	read_lock(&hci_cb_list_lock);
855 	list_for_each(p, &hci_cb_list) {
856 		struct hci_cb *cb = list_entry(p, struct hci_cb, list);
857 		if (cb->security_cfm)
858 			cb->security_cfm(conn, status, encrypt);
859 	}
860 	read_unlock(&hci_cb_list_lock);
861 }
862 
863 static inline void hci_encrypt_cfm(struct hci_conn *conn, __u8 status,
864 								__u8 encrypt)
865 {
866 	struct list_head *p;
867 
868 	if (conn->sec_level == BT_SECURITY_SDP)
869 		conn->sec_level = BT_SECURITY_LOW;
870 
871 	if (conn->pending_sec_level > conn->sec_level)
872 		conn->sec_level = conn->pending_sec_level;
873 
874 	hci_proto_encrypt_cfm(conn, status, encrypt);
875 
876 	read_lock(&hci_cb_list_lock);
877 	list_for_each(p, &hci_cb_list) {
878 		struct hci_cb *cb = list_entry(p, struct hci_cb, list);
879 		if (cb->security_cfm)
880 			cb->security_cfm(conn, status, encrypt);
881 	}
882 	read_unlock(&hci_cb_list_lock);
883 }
884 
885 static inline void hci_key_change_cfm(struct hci_conn *conn, __u8 status)
886 {
887 	struct list_head *p;
888 
889 	read_lock(&hci_cb_list_lock);
890 	list_for_each(p, &hci_cb_list) {
891 		struct hci_cb *cb = list_entry(p, struct hci_cb, list);
892 		if (cb->key_change_cfm)
893 			cb->key_change_cfm(conn, status);
894 	}
895 	read_unlock(&hci_cb_list_lock);
896 }
897 
898 static inline void hci_role_switch_cfm(struct hci_conn *conn, __u8 status,
899 								__u8 role)
900 {
901 	struct list_head *p;
902 
903 	read_lock(&hci_cb_list_lock);
904 	list_for_each(p, &hci_cb_list) {
905 		struct hci_cb *cb = list_entry(p, struct hci_cb, list);
906 		if (cb->role_switch_cfm)
907 			cb->role_switch_cfm(conn, status, role);
908 	}
909 	read_unlock(&hci_cb_list_lock);
910 }
911 
912 static inline bool eir_has_data_type(u8 *data, size_t data_len, u8 type)
913 {
914 	size_t parsed = 0;
915 
916 	if (data_len < 2)
917 		return false;
918 
919 	while (parsed < data_len - 1) {
920 		u8 field_len = data[0];
921 
922 		if (field_len == 0)
923 			break;
924 
925 		parsed += field_len + 1;
926 
927 		if (parsed > data_len)
928 			break;
929 
930 		if (data[1] == type)
931 			return true;
932 
933 		data += field_len + 1;
934 	}
935 
936 	return false;
937 }
938 
939 static inline size_t eir_get_length(u8 *eir, size_t eir_len)
940 {
941 	size_t parsed = 0;
942 
943 	while (parsed < eir_len) {
944 		u8 field_len = eir[0];
945 
946 		if (field_len == 0)
947 			return parsed;
948 
949 		parsed += field_len + 1;
950 		eir += field_len + 1;
951 	}
952 
953 	return eir_len;
954 }
955 
956 static inline u16 eir_append_data(u8 *eir, u16 eir_len, u8 type, u8 *data,
957 				  u8 data_len)
958 {
959 	eir[eir_len++] = sizeof(type) + data_len;
960 	eir[eir_len++] = type;
961 	memcpy(&eir[eir_len], data, data_len);
962 	eir_len += data_len;
963 
964 	return eir_len;
965 }
966 
967 int hci_register_cb(struct hci_cb *hcb);
968 int hci_unregister_cb(struct hci_cb *hcb);
969 
970 int hci_send_cmd(struct hci_dev *hdev, __u16 opcode, __u32 plen, void *param);
971 void hci_send_acl(struct hci_chan *chan, struct sk_buff *skb, __u16 flags);
972 void hci_send_sco(struct hci_conn *conn, struct sk_buff *skb);
973 
974 void *hci_sent_cmd_data(struct hci_dev *hdev, __u16 opcode);
975 
976 /* ----- HCI Sockets ----- */
977 void hci_send_to_sock(struct hci_dev *hdev, struct sk_buff *skb);
978 void hci_send_to_control(struct sk_buff *skb, struct sock *skip_sk);
979 void hci_send_to_monitor(struct hci_dev *hdev, struct sk_buff *skb);
980 
981 void hci_sock_dev_event(struct hci_dev *hdev, int event);
982 
983 /* Management interface */
984 #define DISCOV_TYPE_BREDR		(BIT(BDADDR_BREDR))
985 #define DISCOV_TYPE_LE			(BIT(BDADDR_LE_PUBLIC) | \
986 					 BIT(BDADDR_LE_RANDOM))
987 #define DISCOV_TYPE_INTERLEAVED		(BIT(BDADDR_BREDR) | \
988 					 BIT(BDADDR_LE_PUBLIC) | \
989 					 BIT(BDADDR_LE_RANDOM))
990 
991 int mgmt_control(struct sock *sk, struct msghdr *msg, size_t len);
992 int mgmt_index_added(struct hci_dev *hdev);
993 int mgmt_index_removed(struct hci_dev *hdev);
994 int mgmt_powered(struct hci_dev *hdev, u8 powered);
995 int mgmt_discoverable(struct hci_dev *hdev, u8 discoverable);
996 int mgmt_connectable(struct hci_dev *hdev, u8 connectable);
997 int mgmt_write_scan_failed(struct hci_dev *hdev, u8 scan, u8 status);
998 int mgmt_new_link_key(struct hci_dev *hdev, struct link_key *key,
999 		      bool persistent);
1000 int mgmt_device_connected(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 link_type,
1001 			  u8 addr_type, u32 flags, u8 *name, u8 name_len,
1002 			  u8 *dev_class);
1003 int mgmt_device_disconnected(struct hci_dev *hdev, bdaddr_t *bdaddr,
1004 			     u8 link_type, u8 addr_type, u8 reason);
1005 int mgmt_disconnect_failed(struct hci_dev *hdev, bdaddr_t *bdaddr,
1006 			   u8 link_type, u8 addr_type, u8 status);
1007 int mgmt_connect_failed(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 link_type,
1008 			u8 addr_type, u8 status);
1009 int mgmt_pin_code_request(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 secure);
1010 int mgmt_pin_code_reply_complete(struct hci_dev *hdev, bdaddr_t *bdaddr,
1011 				 u8 status);
1012 int mgmt_pin_code_neg_reply_complete(struct hci_dev *hdev, bdaddr_t *bdaddr,
1013 				     u8 status);
1014 int mgmt_user_confirm_request(struct hci_dev *hdev, bdaddr_t *bdaddr,
1015 			      u8 link_type, u8 addr_type, __le32 value,
1016 			      u8 confirm_hint);
1017 int mgmt_user_confirm_reply_complete(struct hci_dev *hdev, bdaddr_t *bdaddr,
1018 				     u8 link_type, u8 addr_type, u8 status);
1019 int mgmt_user_confirm_neg_reply_complete(struct hci_dev *hdev, bdaddr_t *bdaddr,
1020 					 u8 link_type, u8 addr_type, u8 status);
1021 int mgmt_user_passkey_request(struct hci_dev *hdev, bdaddr_t *bdaddr,
1022 			      u8 link_type, u8 addr_type);
1023 int mgmt_user_passkey_reply_complete(struct hci_dev *hdev, bdaddr_t *bdaddr,
1024 				     u8 link_type, u8 addr_type, u8 status);
1025 int mgmt_user_passkey_neg_reply_complete(struct hci_dev *hdev, bdaddr_t *bdaddr,
1026 					 u8 link_type, u8 addr_type, u8 status);
1027 int mgmt_user_passkey_notify(struct hci_dev *hdev, bdaddr_t *bdaddr,
1028 			     u8 link_type, u8 addr_type, u32 passkey,
1029 			     u8 entered);
1030 int mgmt_auth_failed(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 link_type,
1031 		     u8 addr_type, u8 status);
1032 int mgmt_auth_enable_complete(struct hci_dev *hdev, u8 status);
1033 int mgmt_ssp_enable_complete(struct hci_dev *hdev, u8 enable, u8 status);
1034 int mgmt_set_class_of_dev_complete(struct hci_dev *hdev, u8 *dev_class,
1035 				   u8 status);
1036 int mgmt_set_local_name_complete(struct hci_dev *hdev, u8 *name, u8 status);
1037 int mgmt_read_local_oob_data_reply_complete(struct hci_dev *hdev, u8 *hash,
1038 					    u8 *randomizer, u8 status);
1039 int mgmt_le_enable_complete(struct hci_dev *hdev, u8 enable, u8 status);
1040 int mgmt_device_found(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 link_type,
1041 		      u8 addr_type, u8 *dev_class, s8 rssi, u8 cfm_name,
1042 		      u8 ssp, u8 *eir, u16 eir_len);
1043 int mgmt_remote_name(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 link_type,
1044 		     u8 addr_type, s8 rssi, u8 *name, u8 name_len);
1045 int mgmt_start_discovery_failed(struct hci_dev *hdev, u8 status);
1046 int mgmt_stop_discovery_failed(struct hci_dev *hdev, u8 status);
1047 int mgmt_discovering(struct hci_dev *hdev, u8 discovering);
1048 int mgmt_interleaved_discovery(struct hci_dev *hdev);
1049 int mgmt_device_blocked(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 type);
1050 int mgmt_device_unblocked(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 type);
1051 bool mgmt_valid_hdev(struct hci_dev *hdev);
1052 int mgmt_new_ltk(struct hci_dev *hdev, struct smp_ltk *key, u8 persistent);
1053 
1054 /* HCI info for socket */
1055 #define hci_pi(sk) ((struct hci_pinfo *) sk)
1056 
1057 struct hci_pinfo {
1058 	struct bt_sock    bt;
1059 	struct hci_dev    *hdev;
1060 	struct hci_filter filter;
1061 	__u32             cmsg_mask;
1062 	unsigned short   channel;
1063 };
1064 
1065 /* HCI security filter */
1066 #define HCI_SFLT_MAX_OGF  5
1067 
1068 struct hci_sec_filter {
1069 	__u32 type_mask;
1070 	__u32 event_mask[2];
1071 	__u32 ocf_mask[HCI_SFLT_MAX_OGF + 1][4];
1072 };
1073 
1074 /* ----- HCI requests ----- */
1075 #define HCI_REQ_DONE	  0
1076 #define HCI_REQ_PEND	  1
1077 #define HCI_REQ_CANCELED  2
1078 
1079 #define hci_req_lock(d)		mutex_lock(&d->req_lock)
1080 #define hci_req_unlock(d)	mutex_unlock(&d->req_lock)
1081 
1082 void hci_req_complete(struct hci_dev *hdev, __u16 cmd, int result);
1083 
1084 void hci_le_conn_update(struct hci_conn *conn, u16 min, u16 max,
1085 					u16 latency, u16 to_multiplier);
1086 void hci_le_start_enc(struct hci_conn *conn, __le16 ediv, __u8 rand[8],
1087 							__u8 ltk[16]);
1088 int hci_do_inquiry(struct hci_dev *hdev, u8 length);
1089 int hci_cancel_inquiry(struct hci_dev *hdev);
1090 int hci_le_scan(struct hci_dev *hdev, u8 type, u16 interval, u16 window,
1091 		int timeout);
1092 int hci_cancel_le_scan(struct hci_dev *hdev);
1093 
1094 u8 bdaddr_to_le(u8 bdaddr_type);
1095 
1096 #endif /* __HCI_CORE_H */
1097