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