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