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