xref: /openbmc/linux/include/net/bluetooth/hci_core.h (revision 90099433)
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 	bool		flush_key;
318 
319 	unsigned int	sent;
320 
321 	struct sk_buff_head data_q;
322 	struct list_head chan_list;
323 
324 	struct delayed_work disc_work;
325 	struct timer_list idle_timer;
326 	struct timer_list auto_accept_timer;
327 
328 	struct device	dev;
329 	atomic_t	devref;
330 
331 	struct hci_dev	*hdev;
332 	void		*l2cap_data;
333 	void		*sco_data;
334 	void		*smp_conn;
335 
336 	struct hci_conn	*link;
337 
338 	void (*connect_cfm_cb)	(struct hci_conn *conn, u8 status);
339 	void (*security_cfm_cb)	(struct hci_conn *conn, u8 status);
340 	void (*disconn_cfm_cb)	(struct hci_conn *conn, u8 reason);
341 };
342 
343 struct hci_chan {
344 	struct list_head list;
345 
346 	struct hci_conn *conn;
347 	struct sk_buff_head data_q;
348 	unsigned int	sent;
349 };
350 
351 extern struct list_head hci_dev_list;
352 extern struct list_head hci_cb_list;
353 extern rwlock_t hci_dev_list_lock;
354 extern rwlock_t hci_cb_list_lock;
355 
356 /* ----- HCI interface to upper protocols ----- */
357 extern int l2cap_connect_ind(struct hci_dev *hdev, bdaddr_t *bdaddr);
358 extern int l2cap_connect_cfm(struct hci_conn *hcon, u8 status);
359 extern int l2cap_disconn_ind(struct hci_conn *hcon);
360 extern int l2cap_disconn_cfm(struct hci_conn *hcon, u8 reason);
361 extern int l2cap_security_cfm(struct hci_conn *hcon, u8 status, u8 encrypt);
362 extern int l2cap_recv_acldata(struct hci_conn *hcon, struct sk_buff *skb, u16 flags);
363 
364 extern int sco_connect_ind(struct hci_dev *hdev, bdaddr_t *bdaddr);
365 extern int sco_connect_cfm(struct hci_conn *hcon, __u8 status);
366 extern int sco_disconn_cfm(struct hci_conn *hcon, __u8 reason);
367 extern int sco_recv_scodata(struct hci_conn *hcon, struct sk_buff *skb);
368 
369 /* ----- Inquiry cache ----- */
370 #define INQUIRY_CACHE_AGE_MAX   (HZ*30)   /* 30 seconds */
371 #define INQUIRY_ENTRY_AGE_MAX   (HZ*60)   /* 60 seconds */
372 
373 static inline void discovery_init(struct hci_dev *hdev)
374 {
375 	hdev->discovery.state = DISCOVERY_STOPPED;
376 	INIT_LIST_HEAD(&hdev->discovery.all);
377 	INIT_LIST_HEAD(&hdev->discovery.unknown);
378 	INIT_LIST_HEAD(&hdev->discovery.resolve);
379 }
380 
381 bool hci_discovery_active(struct hci_dev *hdev);
382 
383 void hci_discovery_set_state(struct hci_dev *hdev, int state);
384 
385 static inline int inquiry_cache_empty(struct hci_dev *hdev)
386 {
387 	return list_empty(&hdev->discovery.all);
388 }
389 
390 static inline long inquiry_cache_age(struct hci_dev *hdev)
391 {
392 	struct discovery_state *c = &hdev->discovery;
393 	return jiffies - c->timestamp;
394 }
395 
396 static inline long inquiry_entry_age(struct inquiry_entry *e)
397 {
398 	return jiffies - e->timestamp;
399 }
400 
401 struct inquiry_entry *hci_inquiry_cache_lookup(struct hci_dev *hdev,
402 					       bdaddr_t *bdaddr);
403 struct inquiry_entry *hci_inquiry_cache_lookup_unknown(struct hci_dev *hdev,
404 						       bdaddr_t *bdaddr);
405 struct inquiry_entry *hci_inquiry_cache_lookup_resolve(struct hci_dev *hdev,
406 						       bdaddr_t *bdaddr,
407 						       int state);
408 void hci_inquiry_cache_update_resolve(struct hci_dev *hdev,
409 				      struct inquiry_entry *ie);
410 bool hci_inquiry_cache_update(struct hci_dev *hdev, struct inquiry_data *data,
411 			      bool name_known, bool *ssp);
412 
413 /* ----- HCI Connections ----- */
414 enum {
415 	HCI_CONN_AUTH_PEND,
416 	HCI_CONN_REAUTH_PEND,
417 	HCI_CONN_ENCRYPT_PEND,
418 	HCI_CONN_RSWITCH_PEND,
419 	HCI_CONN_MODE_CHANGE_PEND,
420 	HCI_CONN_SCO_SETUP_PEND,
421 	HCI_CONN_LE_SMP_PEND,
422 	HCI_CONN_MGMT_CONNECTED,
423 	HCI_CONN_SSP_ENABLED,
424 	HCI_CONN_POWER_SAVE,
425 	HCI_CONN_REMOTE_OOB,
426 };
427 
428 static inline bool hci_conn_ssp_enabled(struct hci_conn *conn)
429 {
430 	struct hci_dev *hdev = conn->hdev;
431 	return (test_bit(HCI_SSP_ENABLED, &hdev->dev_flags) &&
432 				test_bit(HCI_CONN_SSP_ENABLED, &conn->flags));
433 }
434 
435 static inline void hci_conn_hash_init(struct hci_dev *hdev)
436 {
437 	struct hci_conn_hash *h = &hdev->conn_hash;
438 	INIT_LIST_HEAD(&h->list);
439 	h->acl_num = 0;
440 	h->sco_num = 0;
441 	h->le_num = 0;
442 }
443 
444 static inline void hci_conn_hash_add(struct hci_dev *hdev, struct hci_conn *c)
445 {
446 	struct hci_conn_hash *h = &hdev->conn_hash;
447 	list_add_rcu(&c->list, &h->list);
448 	switch (c->type) {
449 	case ACL_LINK:
450 		h->acl_num++;
451 		break;
452 	case LE_LINK:
453 		h->le_num++;
454 		break;
455 	case SCO_LINK:
456 	case ESCO_LINK:
457 		h->sco_num++;
458 		break;
459 	}
460 }
461 
462 static inline void hci_conn_hash_del(struct hci_dev *hdev, struct hci_conn *c)
463 {
464 	struct hci_conn_hash *h = &hdev->conn_hash;
465 
466 	list_del_rcu(&c->list);
467 	synchronize_rcu();
468 
469 	switch (c->type) {
470 	case ACL_LINK:
471 		h->acl_num--;
472 		break;
473 	case LE_LINK:
474 		h->le_num--;
475 		break;
476 	case SCO_LINK:
477 	case ESCO_LINK:
478 		h->sco_num--;
479 		break;
480 	}
481 }
482 
483 static inline unsigned int hci_conn_num(struct hci_dev *hdev, __u8 type)
484 {
485 	struct hci_conn_hash *h = &hdev->conn_hash;
486 	switch (type) {
487 	case ACL_LINK:
488 		return h->acl_num;
489 	case LE_LINK:
490 		return h->le_num;
491 	case SCO_LINK:
492 	case ESCO_LINK:
493 		return h->sco_num;
494 	default:
495 		return 0;
496 	}
497 }
498 
499 static inline struct hci_conn *hci_conn_hash_lookup_handle(struct hci_dev *hdev,
500 								__u16 handle)
501 {
502 	struct hci_conn_hash *h = &hdev->conn_hash;
503 	struct hci_conn  *c;
504 
505 	rcu_read_lock();
506 
507 	list_for_each_entry_rcu(c, &h->list, list) {
508 		if (c->handle == handle) {
509 			rcu_read_unlock();
510 			return c;
511 		}
512 	}
513 	rcu_read_unlock();
514 
515 	return NULL;
516 }
517 
518 static inline struct hci_conn *hci_conn_hash_lookup_ba(struct hci_dev *hdev,
519 							__u8 type, bdaddr_t *ba)
520 {
521 	struct hci_conn_hash *h = &hdev->conn_hash;
522 	struct hci_conn  *c;
523 
524 	rcu_read_lock();
525 
526 	list_for_each_entry_rcu(c, &h->list, list) {
527 		if (c->type == type && !bacmp(&c->dst, ba)) {
528 			rcu_read_unlock();
529 			return c;
530 		}
531 	}
532 
533 	rcu_read_unlock();
534 
535 	return NULL;
536 }
537 
538 static inline struct hci_conn *hci_conn_hash_lookup_state(struct hci_dev *hdev,
539 							__u8 type, __u16 state)
540 {
541 	struct hci_conn_hash *h = &hdev->conn_hash;
542 	struct hci_conn  *c;
543 
544 	rcu_read_lock();
545 
546 	list_for_each_entry_rcu(c, &h->list, list) {
547 		if (c->type == type && c->state == state) {
548 			rcu_read_unlock();
549 			return c;
550 		}
551 	}
552 
553 	rcu_read_unlock();
554 
555 	return NULL;
556 }
557 
558 void hci_acl_connect(struct hci_conn *conn);
559 void hci_acl_disconn(struct hci_conn *conn, __u8 reason);
560 void hci_add_sco(struct hci_conn *conn, __u16 handle);
561 void hci_setup_sync(struct hci_conn *conn, __u16 handle);
562 void hci_sco_setup(struct hci_conn *conn, __u8 status);
563 
564 struct hci_conn *hci_conn_add(struct hci_dev *hdev, int type, bdaddr_t *dst);
565 int hci_conn_del(struct hci_conn *conn);
566 void hci_conn_hash_flush(struct hci_dev *hdev);
567 void hci_conn_check_pending(struct hci_dev *hdev);
568 
569 struct hci_chan *hci_chan_create(struct hci_conn *conn);
570 int hci_chan_del(struct hci_chan *chan);
571 void hci_chan_list_flush(struct hci_conn *conn);
572 
573 struct hci_conn *hci_connect(struct hci_dev *hdev, int type, bdaddr_t *dst,
574 						__u8 sec_level, __u8 auth_type);
575 int hci_conn_check_link_mode(struct hci_conn *conn);
576 int hci_conn_check_secure(struct hci_conn *conn, __u8 sec_level);
577 int hci_conn_security(struct hci_conn *conn, __u8 sec_level, __u8 auth_type);
578 int hci_conn_change_link_key(struct hci_conn *conn);
579 int hci_conn_switch_role(struct hci_conn *conn, __u8 role);
580 
581 void hci_conn_enter_active_mode(struct hci_conn *conn, __u8 force_active);
582 
583 void hci_conn_hold_device(struct hci_conn *conn);
584 void hci_conn_put_device(struct hci_conn *conn);
585 
586 static inline void hci_conn_hold(struct hci_conn *conn)
587 {
588 	atomic_inc(&conn->refcnt);
589 	cancel_delayed_work(&conn->disc_work);
590 }
591 
592 static inline void hci_conn_put(struct hci_conn *conn)
593 {
594 	if (atomic_dec_and_test(&conn->refcnt)) {
595 		unsigned long timeo;
596 		if (conn->type == ACL_LINK || conn->type == LE_LINK) {
597 			del_timer(&conn->idle_timer);
598 			if (conn->state == BT_CONNECTED) {
599 				timeo = msecs_to_jiffies(conn->disc_timeout);
600 				if (!conn->out)
601 					timeo *= 2;
602 			} else {
603 				timeo = msecs_to_jiffies(10);
604 			}
605 		} else {
606 			timeo = msecs_to_jiffies(10);
607 		}
608 		cancel_delayed_work(&conn->disc_work);
609 		queue_delayed_work(conn->hdev->workqueue,
610 					&conn->disc_work, timeo);
611 	}
612 }
613 
614 /* ----- HCI Devices ----- */
615 static inline void hci_dev_put(struct hci_dev *d)
616 {
617 	put_device(&d->dev);
618 }
619 
620 static inline struct hci_dev *hci_dev_hold(struct hci_dev *d)
621 {
622 	get_device(&d->dev);
623 	return d;
624 }
625 
626 #define hci_dev_lock(d)		mutex_lock(&d->lock)
627 #define hci_dev_unlock(d)	mutex_unlock(&d->lock)
628 
629 #define to_hci_dev(d) container_of(d, struct hci_dev, dev)
630 #define to_hci_conn(c) container_of(c, struct hci_conn, dev)
631 
632 static inline void *hci_get_drvdata(struct hci_dev *hdev)
633 {
634 	return dev_get_drvdata(&hdev->dev);
635 }
636 
637 static inline void hci_set_drvdata(struct hci_dev *hdev, void *data)
638 {
639 	dev_set_drvdata(&hdev->dev, data);
640 }
641 
642 struct hci_dev *hci_dev_get(int index);
643 struct hci_dev *hci_get_route(bdaddr_t *src, bdaddr_t *dst);
644 
645 struct hci_dev *hci_alloc_dev(void);
646 void hci_free_dev(struct hci_dev *hdev);
647 int hci_register_dev(struct hci_dev *hdev);
648 void hci_unregister_dev(struct hci_dev *hdev);
649 int hci_suspend_dev(struct hci_dev *hdev);
650 int hci_resume_dev(struct hci_dev *hdev);
651 int hci_dev_open(__u16 dev);
652 int hci_dev_close(__u16 dev);
653 int hci_dev_reset(__u16 dev);
654 int hci_dev_reset_stat(__u16 dev);
655 int hci_dev_cmd(unsigned int cmd, void __user *arg);
656 int hci_get_dev_list(void __user *arg);
657 int hci_get_dev_info(void __user *arg);
658 int hci_get_conn_list(void __user *arg);
659 int hci_get_conn_info(struct hci_dev *hdev, void __user *arg);
660 int hci_get_auth_info(struct hci_dev *hdev, void __user *arg);
661 int hci_inquiry(void __user *arg);
662 
663 struct bdaddr_list *hci_blacklist_lookup(struct hci_dev *hdev, bdaddr_t *bdaddr);
664 int hci_blacklist_clear(struct hci_dev *hdev);
665 int hci_blacklist_add(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 type);
666 int hci_blacklist_del(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 type);
667 
668 int hci_uuids_clear(struct hci_dev *hdev);
669 
670 int hci_link_keys_clear(struct hci_dev *hdev);
671 struct link_key *hci_find_link_key(struct hci_dev *hdev, bdaddr_t *bdaddr);
672 int hci_add_link_key(struct hci_dev *hdev, struct hci_conn *conn, int new_key,
673 		     bdaddr_t *bdaddr, u8 *val, u8 type, u8 pin_len);
674 struct smp_ltk *hci_find_ltk(struct hci_dev *hdev, __le16 ediv, u8 rand[8]);
675 int hci_add_ltk(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 addr_type, u8 type,
676 		int new_key, u8 authenticated, u8 tk[16], u8 enc_size, u16 ediv,
677 		u8 rand[8]);
678 struct smp_ltk *hci_find_ltk_by_addr(struct hci_dev *hdev, bdaddr_t *bdaddr,
679 				     u8 addr_type);
680 int hci_remove_ltk(struct hci_dev *hdev, bdaddr_t *bdaddr);
681 int hci_smp_ltks_clear(struct hci_dev *hdev);
682 int hci_remove_link_key(struct hci_dev *hdev, bdaddr_t *bdaddr);
683 
684 int hci_remote_oob_data_clear(struct hci_dev *hdev);
685 struct oob_data *hci_find_remote_oob_data(struct hci_dev *hdev,
686 							bdaddr_t *bdaddr);
687 int hci_add_remote_oob_data(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 *hash,
688 								u8 *randomizer);
689 int hci_remove_remote_oob_data(struct hci_dev *hdev, bdaddr_t *bdaddr);
690 
691 #define ADV_CLEAR_TIMEOUT (3*60*HZ) /* Three minutes */
692 int hci_adv_entries_clear(struct hci_dev *hdev);
693 struct adv_entry *hci_find_adv_entry(struct hci_dev *hdev, bdaddr_t *bdaddr);
694 int hci_add_adv_entry(struct hci_dev *hdev,
695 					struct hci_ev_le_advertising_info *ev);
696 
697 void hci_del_off_timer(struct hci_dev *hdev);
698 
699 void hci_event_packet(struct hci_dev *hdev, struct sk_buff *skb);
700 
701 int hci_recv_frame(struct sk_buff *skb);
702 int hci_recv_fragment(struct hci_dev *hdev, int type, void *data, int count);
703 int hci_recv_stream_fragment(struct hci_dev *hdev, void *data, int count);
704 
705 void hci_init_sysfs(struct hci_dev *hdev);
706 int hci_add_sysfs(struct hci_dev *hdev);
707 void hci_del_sysfs(struct hci_dev *hdev);
708 void hci_conn_init_sysfs(struct hci_conn *conn);
709 void hci_conn_add_sysfs(struct hci_conn *conn);
710 void hci_conn_del_sysfs(struct hci_conn *conn);
711 
712 #define SET_HCIDEV_DEV(hdev, pdev) ((hdev)->parent = (pdev))
713 
714 /* ----- LMP capabilities ----- */
715 #define lmp_rswitch_capable(dev)   ((dev)->features[0] & LMP_RSWITCH)
716 #define lmp_encrypt_capable(dev)   ((dev)->features[0] & LMP_ENCRYPT)
717 #define lmp_sniff_capable(dev)     ((dev)->features[0] & LMP_SNIFF)
718 #define lmp_sniffsubr_capable(dev) ((dev)->features[5] & LMP_SNIFF_SUBR)
719 #define lmp_esco_capable(dev)      ((dev)->features[3] & LMP_ESCO)
720 #define lmp_ssp_capable(dev)       ((dev)->features[6] & LMP_SIMPLE_PAIR)
721 #define lmp_no_flush_capable(dev)  ((dev)->features[6] & LMP_NO_FLUSH)
722 #define lmp_le_capable(dev)        ((dev)->features[4] & LMP_LE)
723 #define lmp_bredr_capable(dev)     (!((dev)->features[4] & LMP_NO_BREDR))
724 
725 /* ----- Extended LMP capabilities ----- */
726 #define lmp_host_le_capable(dev)   ((dev)->host_features[0] & LMP_HOST_LE)
727 
728 /* ----- HCI protocols ----- */
729 static inline int hci_proto_connect_ind(struct hci_dev *hdev, bdaddr_t *bdaddr,
730 								__u8 type)
731 {
732 	switch (type) {
733 	case ACL_LINK:
734 		return l2cap_connect_ind(hdev, bdaddr);
735 
736 	case SCO_LINK:
737 	case ESCO_LINK:
738 		return sco_connect_ind(hdev, bdaddr);
739 
740 	default:
741 		BT_ERR("unknown link type %d", type);
742 		return -EINVAL;
743 	}
744 }
745 
746 static inline void hci_proto_connect_cfm(struct hci_conn *conn, __u8 status)
747 {
748 	switch (conn->type) {
749 	case ACL_LINK:
750 	case LE_LINK:
751 		l2cap_connect_cfm(conn, status);
752 		break;
753 
754 	case SCO_LINK:
755 	case ESCO_LINK:
756 		sco_connect_cfm(conn, status);
757 		break;
758 
759 	default:
760 		BT_ERR("unknown link type %d", conn->type);
761 		break;
762 	}
763 
764 	if (conn->connect_cfm_cb)
765 		conn->connect_cfm_cb(conn, status);
766 }
767 
768 static inline int hci_proto_disconn_ind(struct hci_conn *conn)
769 {
770 	if (conn->type != ACL_LINK && conn->type != LE_LINK)
771 		return HCI_ERROR_REMOTE_USER_TERM;
772 
773 	return l2cap_disconn_ind(conn);
774 }
775 
776 static inline void hci_proto_disconn_cfm(struct hci_conn *conn, __u8 reason)
777 {
778 	switch (conn->type) {
779 	case ACL_LINK:
780 	case LE_LINK:
781 		l2cap_disconn_cfm(conn, reason);
782 		break;
783 
784 	case SCO_LINK:
785 	case ESCO_LINK:
786 		sco_disconn_cfm(conn, reason);
787 		break;
788 
789 	default:
790 		BT_ERR("unknown link type %d", conn->type);
791 		break;
792 	}
793 
794 	if (conn->disconn_cfm_cb)
795 		conn->disconn_cfm_cb(conn, reason);
796 }
797 
798 static inline void hci_proto_auth_cfm(struct hci_conn *conn, __u8 status)
799 {
800 	__u8 encrypt;
801 
802 	if (conn->type != ACL_LINK && conn->type != LE_LINK)
803 		return;
804 
805 	if (test_bit(HCI_CONN_ENCRYPT_PEND, &conn->flags))
806 		return;
807 
808 	encrypt = (conn->link_mode & HCI_LM_ENCRYPT) ? 0x01 : 0x00;
809 	l2cap_security_cfm(conn, status, encrypt);
810 
811 	if (conn->security_cfm_cb)
812 		conn->security_cfm_cb(conn, status);
813 }
814 
815 static inline void hci_proto_encrypt_cfm(struct hci_conn *conn, __u8 status,
816 								__u8 encrypt)
817 {
818 	if (conn->type != ACL_LINK && conn->type != LE_LINK)
819 		return;
820 
821 	l2cap_security_cfm(conn, status, encrypt);
822 
823 	if (conn->security_cfm_cb)
824 		conn->security_cfm_cb(conn, status);
825 }
826 
827 /* ----- HCI callbacks ----- */
828 struct hci_cb {
829 	struct list_head list;
830 
831 	char *name;
832 
833 	void (*security_cfm)	(struct hci_conn *conn, __u8 status,
834 								__u8 encrypt);
835 	void (*key_change_cfm)	(struct hci_conn *conn, __u8 status);
836 	void (*role_switch_cfm)	(struct hci_conn *conn, __u8 status, __u8 role);
837 };
838 
839 static inline void hci_auth_cfm(struct hci_conn *conn, __u8 status)
840 {
841 	struct list_head *p;
842 	__u8 encrypt;
843 
844 	hci_proto_auth_cfm(conn, status);
845 
846 	if (test_bit(HCI_CONN_ENCRYPT_PEND, &conn->flags))
847 		return;
848 
849 	encrypt = (conn->link_mode & HCI_LM_ENCRYPT) ? 0x01 : 0x00;
850 
851 	read_lock(&hci_cb_list_lock);
852 	list_for_each(p, &hci_cb_list) {
853 		struct hci_cb *cb = list_entry(p, struct hci_cb, list);
854 		if (cb->security_cfm)
855 			cb->security_cfm(conn, status, encrypt);
856 	}
857 	read_unlock(&hci_cb_list_lock);
858 }
859 
860 static inline void hci_encrypt_cfm(struct hci_conn *conn, __u8 status,
861 								__u8 encrypt)
862 {
863 	struct list_head *p;
864 
865 	if (conn->sec_level == BT_SECURITY_SDP)
866 		conn->sec_level = BT_SECURITY_LOW;
867 
868 	if (conn->pending_sec_level > conn->sec_level)
869 		conn->sec_level = conn->pending_sec_level;
870 
871 	hci_proto_encrypt_cfm(conn, status, encrypt);
872 
873 	read_lock(&hci_cb_list_lock);
874 	list_for_each(p, &hci_cb_list) {
875 		struct hci_cb *cb = list_entry(p, struct hci_cb, list);
876 		if (cb->security_cfm)
877 			cb->security_cfm(conn, status, encrypt);
878 	}
879 	read_unlock(&hci_cb_list_lock);
880 }
881 
882 static inline void hci_key_change_cfm(struct hci_conn *conn, __u8 status)
883 {
884 	struct list_head *p;
885 
886 	read_lock(&hci_cb_list_lock);
887 	list_for_each(p, &hci_cb_list) {
888 		struct hci_cb *cb = list_entry(p, struct hci_cb, list);
889 		if (cb->key_change_cfm)
890 			cb->key_change_cfm(conn, status);
891 	}
892 	read_unlock(&hci_cb_list_lock);
893 }
894 
895 static inline void hci_role_switch_cfm(struct hci_conn *conn, __u8 status,
896 								__u8 role)
897 {
898 	struct list_head *p;
899 
900 	read_lock(&hci_cb_list_lock);
901 	list_for_each(p, &hci_cb_list) {
902 		struct hci_cb *cb = list_entry(p, struct hci_cb, list);
903 		if (cb->role_switch_cfm)
904 			cb->role_switch_cfm(conn, status, role);
905 	}
906 	read_unlock(&hci_cb_list_lock);
907 }
908 
909 static inline bool eir_has_data_type(u8 *data, size_t data_len, u8 type)
910 {
911 	size_t parsed = 0;
912 
913 	if (data_len < 2)
914 		return false;
915 
916 	while (parsed < data_len - 1) {
917 		u8 field_len = data[0];
918 
919 		if (field_len == 0)
920 			break;
921 
922 		parsed += field_len + 1;
923 
924 		if (parsed > data_len)
925 			break;
926 
927 		if (data[1] == type)
928 			return true;
929 
930 		data += field_len + 1;
931 	}
932 
933 	return false;
934 }
935 
936 static inline u16 eir_append_data(u8 *eir, u16 eir_len, u8 type, u8 *data,
937 				  u8 data_len)
938 {
939 	eir[eir_len++] = sizeof(type) + data_len;
940 	eir[eir_len++] = type;
941 	memcpy(&eir[eir_len], data, data_len);
942 	eir_len += data_len;
943 
944 	return eir_len;
945 }
946 
947 int hci_register_cb(struct hci_cb *hcb);
948 int hci_unregister_cb(struct hci_cb *hcb);
949 
950 int hci_send_cmd(struct hci_dev *hdev, __u16 opcode, __u32 plen, void *param);
951 void hci_send_acl(struct hci_chan *chan, struct sk_buff *skb, __u16 flags);
952 void hci_send_sco(struct hci_conn *conn, struct sk_buff *skb);
953 
954 void *hci_sent_cmd_data(struct hci_dev *hdev, __u16 opcode);
955 
956 /* ----- HCI Sockets ----- */
957 void hci_send_to_sock(struct hci_dev *hdev, struct sk_buff *skb);
958 void hci_send_to_control(struct sk_buff *skb, struct sock *skip_sk);
959 void hci_send_to_monitor(struct hci_dev *hdev, struct sk_buff *skb);
960 
961 void hci_sock_dev_event(struct hci_dev *hdev, int event);
962 
963 /* Management interface */
964 #define MGMT_ADDR_BREDR			0x00
965 #define MGMT_ADDR_LE_PUBLIC		0x01
966 #define MGMT_ADDR_LE_RANDOM		0x02
967 #define MGMT_ADDR_INVALID		0xff
968 
969 #define DISCOV_TYPE_BREDR		(BIT(MGMT_ADDR_BREDR))
970 #define DISCOV_TYPE_LE			(BIT(MGMT_ADDR_LE_PUBLIC) | \
971 						BIT(MGMT_ADDR_LE_RANDOM))
972 #define DISCOV_TYPE_INTERLEAVED		(BIT(MGMT_ADDR_BREDR) | \
973 						BIT(MGMT_ADDR_LE_PUBLIC) | \
974 						BIT(MGMT_ADDR_LE_RANDOM))
975 
976 int mgmt_control(struct sock *sk, struct msghdr *msg, size_t len);
977 int mgmt_index_added(struct hci_dev *hdev);
978 int mgmt_index_removed(struct hci_dev *hdev);
979 int mgmt_powered(struct hci_dev *hdev, u8 powered);
980 int mgmt_discoverable(struct hci_dev *hdev, u8 discoverable);
981 int mgmt_connectable(struct hci_dev *hdev, u8 connectable);
982 int mgmt_write_scan_failed(struct hci_dev *hdev, u8 scan, u8 status);
983 int mgmt_new_link_key(struct hci_dev *hdev, struct link_key *key,
984 		      bool persistent);
985 int mgmt_device_connected(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 link_type,
986 			  u8 addr_type, u32 flags, u8 *name, u8 name_len,
987 			  u8 *dev_class);
988 int mgmt_device_disconnected(struct hci_dev *hdev, bdaddr_t *bdaddr,
989 			     u8 link_type, u8 addr_type);
990 int mgmt_disconnect_failed(struct hci_dev *hdev, bdaddr_t *bdaddr,
991 			   u8 link_type, u8 addr_type, u8 status);
992 int mgmt_connect_failed(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 link_type,
993 			u8 addr_type, u8 status);
994 int mgmt_pin_code_request(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 secure);
995 int mgmt_pin_code_reply_complete(struct hci_dev *hdev, bdaddr_t *bdaddr,
996 				 u8 status);
997 int mgmt_pin_code_neg_reply_complete(struct hci_dev *hdev, bdaddr_t *bdaddr,
998 				     u8 status);
999 int mgmt_user_confirm_request(struct hci_dev *hdev, bdaddr_t *bdaddr,
1000 			      u8 link_type, u8 addr_type, __le32 value,
1001 			      u8 confirm_hint);
1002 int mgmt_user_confirm_reply_complete(struct hci_dev *hdev, bdaddr_t *bdaddr,
1003 				     u8 link_type, u8 addr_type, u8 status);
1004 int mgmt_user_confirm_neg_reply_complete(struct hci_dev *hdev, bdaddr_t *bdaddr,
1005 					 u8 link_type, u8 addr_type, u8 status);
1006 int mgmt_user_passkey_request(struct hci_dev *hdev, bdaddr_t *bdaddr,
1007 			      u8 link_type, u8 addr_type);
1008 int mgmt_user_passkey_reply_complete(struct hci_dev *hdev, bdaddr_t *bdaddr,
1009 				     u8 link_type, u8 addr_type, u8 status);
1010 int mgmt_user_passkey_neg_reply_complete(struct hci_dev *hdev, bdaddr_t *bdaddr,
1011 					 u8 link_type, u8 addr_type, u8 status);
1012 int mgmt_auth_failed(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 link_type,
1013 		     u8 addr_type, u8 status);
1014 int mgmt_auth_enable_complete(struct hci_dev *hdev, u8 status);
1015 int mgmt_ssp_enable_complete(struct hci_dev *hdev, u8 enable, u8 status);
1016 int mgmt_set_class_of_dev_complete(struct hci_dev *hdev, u8 *dev_class,
1017 				   u8 status);
1018 int mgmt_set_local_name_complete(struct hci_dev *hdev, u8 *name, u8 status);
1019 int mgmt_read_local_oob_data_reply_complete(struct hci_dev *hdev, u8 *hash,
1020 					    u8 *randomizer, u8 status);
1021 int mgmt_le_enable_complete(struct hci_dev *hdev, u8 enable, u8 status);
1022 int mgmt_device_found(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 link_type,
1023 		      u8 addr_type, u8 *dev_class, s8 rssi, u8 cfm_name,
1024 		      u8 ssp, u8 *eir, u16 eir_len);
1025 int mgmt_remote_name(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 link_type,
1026 		     u8 addr_type, s8 rssi, u8 *name, u8 name_len);
1027 int mgmt_start_discovery_failed(struct hci_dev *hdev, u8 status);
1028 int mgmt_stop_discovery_failed(struct hci_dev *hdev, u8 status);
1029 int mgmt_discovering(struct hci_dev *hdev, u8 discovering);
1030 int mgmt_interleaved_discovery(struct hci_dev *hdev);
1031 int mgmt_device_blocked(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 type);
1032 int mgmt_device_unblocked(struct hci_dev *hdev, bdaddr_t *bdaddr, u8 type);
1033 
1034 int mgmt_new_ltk(struct hci_dev *hdev, struct smp_ltk *key, u8 persistent);
1035 
1036 /* HCI info for socket */
1037 #define hci_pi(sk) ((struct hci_pinfo *) sk)
1038 
1039 struct hci_pinfo {
1040 	struct bt_sock    bt;
1041 	struct hci_dev    *hdev;
1042 	struct hci_filter filter;
1043 	__u32             cmsg_mask;
1044 	unsigned short   channel;
1045 };
1046 
1047 /* HCI security filter */
1048 #define HCI_SFLT_MAX_OGF  5
1049 
1050 struct hci_sec_filter {
1051 	__u32 type_mask;
1052 	__u32 event_mask[2];
1053 	__u32 ocf_mask[HCI_SFLT_MAX_OGF + 1][4];
1054 };
1055 
1056 /* ----- HCI requests ----- */
1057 #define HCI_REQ_DONE	  0
1058 #define HCI_REQ_PEND	  1
1059 #define HCI_REQ_CANCELED  2
1060 
1061 #define hci_req_lock(d)		mutex_lock(&d->req_lock)
1062 #define hci_req_unlock(d)	mutex_unlock(&d->req_lock)
1063 
1064 void hci_req_complete(struct hci_dev *hdev, __u16 cmd, int result);
1065 
1066 void hci_le_conn_update(struct hci_conn *conn, u16 min, u16 max,
1067 					u16 latency, u16 to_multiplier);
1068 void hci_le_start_enc(struct hci_conn *conn, __le16 ediv, __u8 rand[8],
1069 							__u8 ltk[16]);
1070 void hci_le_ltk_reply(struct hci_conn *conn, u8 ltk[16]);
1071 void hci_le_ltk_neg_reply(struct hci_conn *conn);
1072 
1073 int hci_do_inquiry(struct hci_dev *hdev, u8 length);
1074 int hci_cancel_inquiry(struct hci_dev *hdev);
1075 int hci_le_scan(struct hci_dev *hdev, u8 type, u16 interval, u16 window,
1076 		int timeout);
1077 
1078 #endif /* __HCI_CORE_H */
1079