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