2 BlueZ - Bluetooth protocol stack for Linux
3 Copyright (C) 2000-2001 Qualcomm Incorporated
5 Written 2000,2001 by Maxim Krasnyansky <maxk@qualcomm.com>
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;
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.
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.
28 #include <net/bluetooth/hci.h>
30 /* HCI upper protocols */
31 #define HCI_PROTO_L2CAP 0
32 #define HCI_PROTO_SCO 1
34 /* HCI Core structures */
38 __u8 pscan_period_mode;
46 struct inquiry_entry {
47 struct inquiry_entry *next;
49 struct inquiry_data data;
52 struct inquiry_cache {
55 struct inquiry_entry *list;
58 struct hci_conn_hash {
59 struct list_head list;
66 struct list_head list;
91 __u16 sniff_min_interval;
92 __u16 sniff_max_interval;
100 unsigned int acl_mtu;
101 unsigned int sco_mtu;
102 unsigned int acl_pkts;
103 unsigned int sco_pkts;
105 unsigned long cmd_last_tx;
106 unsigned long acl_last_tx;
107 unsigned long sco_last_tx;
109 struct tasklet_struct cmd_task;
110 struct tasklet_struct rx_task;
111 struct tasklet_struct tx_task;
113 struct sk_buff_head rx_q;
114 struct sk_buff_head raw_q;
115 struct sk_buff_head cmd_q;
117 struct sk_buff *sent_cmd;
118 struct sk_buff *reassembly[3];
120 struct semaphore req_lock;
121 wait_queue_head_t req_wait_q;
125 struct inquiry_cache inq_cache;
126 struct hci_conn_hash conn_hash;
128 struct hci_dev_stats stat;
130 struct sk_buff_head driver_init;
137 struct device *parent;
140 struct module *owner;
142 int (*open)(struct hci_dev *hdev);
143 int (*close)(struct hci_dev *hdev);
144 int (*flush)(struct hci_dev *hdev);
145 int (*send)(struct sk_buff *skb);
146 void (*destruct)(struct hci_dev *hdev);
147 void (*notify)(struct hci_dev *hdev, unsigned int evt);
148 int (*ioctl)(struct hci_dev *hdev, unsigned int cmd, unsigned long arg);
152 struct list_head list;
179 struct sk_buff_head data_q;
181 struct timer_list disc_timer;
182 struct timer_list idle_timer;
184 struct work_struct work_add;
185 struct work_struct work_del;
189 struct hci_dev *hdev;
194 struct hci_conn *link;
197 extern struct hci_proto *hci_proto[];
198 extern struct list_head hci_dev_list;
199 extern struct list_head hci_cb_list;
200 extern rwlock_t hci_dev_list_lock;
201 extern rwlock_t hci_cb_list_lock;
203 /* ----- Inquiry cache ----- */
204 #define INQUIRY_CACHE_AGE_MAX (HZ*30) // 30 seconds
205 #define INQUIRY_ENTRY_AGE_MAX (HZ*60) // 60 seconds
207 #define inquiry_cache_lock(c) spin_lock(&c->lock)
208 #define inquiry_cache_unlock(c) spin_unlock(&c->lock)
209 #define inquiry_cache_lock_bh(c) spin_lock_bh(&c->lock)
210 #define inquiry_cache_unlock_bh(c) spin_unlock_bh(&c->lock)
212 static inline void inquiry_cache_init(struct hci_dev *hdev)
214 struct inquiry_cache *c = &hdev->inq_cache;
215 spin_lock_init(&c->lock);
219 static inline int inquiry_cache_empty(struct hci_dev *hdev)
221 struct inquiry_cache *c = &hdev->inq_cache;
222 return (c->list == NULL);
225 static inline long inquiry_cache_age(struct hci_dev *hdev)
227 struct inquiry_cache *c = &hdev->inq_cache;
228 return jiffies - c->timestamp;
231 static inline long inquiry_entry_age(struct inquiry_entry *e)
233 return jiffies - e->timestamp;
236 struct inquiry_entry *hci_inquiry_cache_lookup(struct hci_dev *hdev, bdaddr_t *bdaddr);
237 void hci_inquiry_cache_update(struct hci_dev *hdev, struct inquiry_data *data);
239 /* ----- HCI Connections ----- */
242 HCI_CONN_ENCRYPT_PEND,
243 HCI_CONN_RSWITCH_PEND,
244 HCI_CONN_MODE_CHANGE_PEND,
247 static inline void hci_conn_hash_init(struct hci_dev *hdev)
249 struct hci_conn_hash *h = &hdev->conn_hash;
250 INIT_LIST_HEAD(&h->list);
251 spin_lock_init(&h->lock);
256 static inline void hci_conn_hash_add(struct hci_dev *hdev, struct hci_conn *c)
258 struct hci_conn_hash *h = &hdev->conn_hash;
259 list_add(&c->list, &h->list);
260 if (c->type == ACL_LINK)
266 static inline void hci_conn_hash_del(struct hci_dev *hdev, struct hci_conn *c)
268 struct hci_conn_hash *h = &hdev->conn_hash;
270 if (c->type == ACL_LINK)
276 static inline struct hci_conn *hci_conn_hash_lookup_handle(struct hci_dev *hdev,
279 struct hci_conn_hash *h = &hdev->conn_hash;
283 list_for_each(p, &h->list) {
284 c = list_entry(p, struct hci_conn, list);
285 if (c->handle == handle)
291 static inline struct hci_conn *hci_conn_hash_lookup_ba(struct hci_dev *hdev,
292 __u8 type, bdaddr_t *ba)
294 struct hci_conn_hash *h = &hdev->conn_hash;
298 list_for_each(p, &h->list) {
299 c = list_entry(p, struct hci_conn, list);
300 if (c->type == type && !bacmp(&c->dst, ba))
306 static inline struct hci_conn *hci_conn_hash_lookup_state(struct hci_dev *hdev,
307 __u8 type, __u16 state)
309 struct hci_conn_hash *h = &hdev->conn_hash;
313 list_for_each(p, &h->list) {
314 c = list_entry(p, struct hci_conn, list);
315 if (c->type == type && c->state == state)
321 void hci_acl_connect(struct hci_conn *conn);
322 void hci_acl_disconn(struct hci_conn *conn, __u8 reason);
323 void hci_add_sco(struct hci_conn *conn, __u16 handle);
324 void hci_setup_sync(struct hci_conn *conn, __u16 handle);
326 struct hci_conn *hci_conn_add(struct hci_dev *hdev, int type, bdaddr_t *dst);
327 int hci_conn_del(struct hci_conn *conn);
328 void hci_conn_hash_flush(struct hci_dev *hdev);
329 void hci_conn_check_pending(struct hci_dev *hdev);
331 struct hci_conn *hci_connect(struct hci_dev *hdev, int type, bdaddr_t *dst, __u8 sec_level, __u8 auth_type);
332 int hci_conn_check_link_mode(struct hci_conn *conn);
333 int hci_conn_security(struct hci_conn *conn, __u8 sec_level, __u8 auth_type);
334 int hci_conn_change_link_key(struct hci_conn *conn);
335 int hci_conn_switch_role(struct hci_conn *conn, __u8 role);
337 void hci_conn_enter_active_mode(struct hci_conn *conn);
338 void hci_conn_enter_sniff_mode(struct hci_conn *conn);
340 static inline void hci_conn_hold(struct hci_conn *conn)
342 atomic_inc(&conn->refcnt);
343 del_timer(&conn->disc_timer);
346 static inline void hci_conn_put(struct hci_conn *conn)
348 if (atomic_dec_and_test(&conn->refcnt)) {
350 if (conn->type == ACL_LINK) {
351 del_timer(&conn->idle_timer);
352 if (conn->state == BT_CONNECTED) {
353 timeo = msecs_to_jiffies(conn->disc_timeout);
357 timeo = msecs_to_jiffies(10);
359 timeo = msecs_to_jiffies(10);
360 mod_timer(&conn->disc_timer, jiffies + timeo);
364 /* ----- HCI tasks ----- */
365 static inline void hci_sched_cmd(struct hci_dev *hdev)
367 tasklet_schedule(&hdev->cmd_task);
370 static inline void hci_sched_rx(struct hci_dev *hdev)
372 tasklet_schedule(&hdev->rx_task);
375 static inline void hci_sched_tx(struct hci_dev *hdev)
377 tasklet_schedule(&hdev->tx_task);
380 /* ----- HCI Devices ----- */
381 static inline void __hci_dev_put(struct hci_dev *d)
383 if (atomic_dec_and_test(&d->refcnt))
387 static inline void hci_dev_put(struct hci_dev *d)
390 module_put(d->owner);
393 static inline struct hci_dev *__hci_dev_hold(struct hci_dev *d)
395 atomic_inc(&d->refcnt);
399 static inline struct hci_dev *hci_dev_hold(struct hci_dev *d)
401 if (try_module_get(d->owner))
402 return __hci_dev_hold(d);
406 #define hci_dev_lock(d) spin_lock(&d->lock)
407 #define hci_dev_unlock(d) spin_unlock(&d->lock)
408 #define hci_dev_lock_bh(d) spin_lock_bh(&d->lock)
409 #define hci_dev_unlock_bh(d) spin_unlock_bh(&d->lock)
411 struct hci_dev *hci_dev_get(int index);
412 struct hci_dev *hci_get_route(bdaddr_t *src, bdaddr_t *dst);
414 struct hci_dev *hci_alloc_dev(void);
415 void hci_free_dev(struct hci_dev *hdev);
416 int hci_register_dev(struct hci_dev *hdev);
417 int hci_unregister_dev(struct hci_dev *hdev);
418 int hci_suspend_dev(struct hci_dev *hdev);
419 int hci_resume_dev(struct hci_dev *hdev);
420 int hci_dev_open(__u16 dev);
421 int hci_dev_close(__u16 dev);
422 int hci_dev_reset(__u16 dev);
423 int hci_dev_reset_stat(__u16 dev);
424 int hci_dev_cmd(unsigned int cmd, void __user *arg);
425 int hci_get_dev_list(void __user *arg);
426 int hci_get_dev_info(void __user *arg);
427 int hci_get_conn_list(void __user *arg);
428 int hci_get_conn_info(struct hci_dev *hdev, void __user *arg);
429 int hci_get_auth_info(struct hci_dev *hdev, void __user *arg);
430 int hci_inquiry(void __user *arg);
432 void hci_event_packet(struct hci_dev *hdev, struct sk_buff *skb);
434 /* Receive frame from HCI drivers */
435 static inline int hci_recv_frame(struct sk_buff *skb)
437 struct hci_dev *hdev = (struct hci_dev *) skb->dev;
438 if (!hdev || (!test_bit(HCI_UP, &hdev->flags)
439 && !test_bit(HCI_INIT, &hdev->flags))) {
445 bt_cb(skb)->incoming = 1;
448 __net_timestamp(skb);
450 /* Queue frame for rx task */
451 skb_queue_tail(&hdev->rx_q, skb);
456 int hci_recv_fragment(struct hci_dev *hdev, int type, void *data, int count);
458 int hci_register_sysfs(struct hci_dev *hdev);
459 void hci_unregister_sysfs(struct hci_dev *hdev);
460 void hci_conn_init_sysfs(struct hci_conn *conn);
461 void hci_conn_add_sysfs(struct hci_conn *conn);
462 void hci_conn_del_sysfs(struct hci_conn *conn);
464 #define SET_HCIDEV_DEV(hdev, pdev) ((hdev)->parent = (pdev))
466 /* ----- LMP capabilities ----- */
467 #define lmp_rswitch_capable(dev) ((dev)->features[0] & LMP_RSWITCH)
468 #define lmp_encrypt_capable(dev) ((dev)->features[0] & LMP_ENCRYPT)
469 #define lmp_sniff_capable(dev) ((dev)->features[0] & LMP_SNIFF)
470 #define lmp_sniffsubr_capable(dev) ((dev)->features[5] & LMP_SNIFF_SUBR)
471 #define lmp_esco_capable(dev) ((dev)->features[3] & LMP_ESCO)
472 #define lmp_ssp_capable(dev) ((dev)->features[6] & LMP_SIMPLE_PAIR)
474 /* ----- HCI protocols ----- */
482 int (*connect_ind) (struct hci_dev *hdev, bdaddr_t *bdaddr, __u8 type);
483 int (*connect_cfm) (struct hci_conn *conn, __u8 status);
484 int (*disconn_ind) (struct hci_conn *conn);
485 int (*disconn_cfm) (struct hci_conn *conn, __u8 reason);
486 int (*recv_acldata) (struct hci_conn *conn, struct sk_buff *skb, __u16 flags);
487 int (*recv_scodata) (struct hci_conn *conn, struct sk_buff *skb);
488 int (*security_cfm) (struct hci_conn *conn, __u8 status, __u8 encrypt);
491 static inline int hci_proto_connect_ind(struct hci_dev *hdev, bdaddr_t *bdaddr, __u8 type)
493 register struct hci_proto *hp;
496 hp = hci_proto[HCI_PROTO_L2CAP];
497 if (hp && hp->connect_ind)
498 mask |= hp->connect_ind(hdev, bdaddr, type);
500 hp = hci_proto[HCI_PROTO_SCO];
501 if (hp && hp->connect_ind)
502 mask |= hp->connect_ind(hdev, bdaddr, type);
507 static inline void hci_proto_connect_cfm(struct hci_conn *conn, __u8 status)
509 register struct hci_proto *hp;
511 hp = hci_proto[HCI_PROTO_L2CAP];
512 if (hp && hp->connect_cfm)
513 hp->connect_cfm(conn, status);
515 hp = hci_proto[HCI_PROTO_SCO];
516 if (hp && hp->connect_cfm)
517 hp->connect_cfm(conn, status);
520 static inline int hci_proto_disconn_ind(struct hci_conn *conn)
522 register struct hci_proto *hp;
525 hp = hci_proto[HCI_PROTO_L2CAP];
526 if (hp && hp->disconn_ind)
527 reason = hp->disconn_ind(conn);
529 hp = hci_proto[HCI_PROTO_SCO];
530 if (hp && hp->disconn_ind)
531 reason = hp->disconn_ind(conn);
536 static inline void hci_proto_disconn_cfm(struct hci_conn *conn, __u8 reason)
538 register struct hci_proto *hp;
540 hp = hci_proto[HCI_PROTO_L2CAP];
541 if (hp && hp->disconn_cfm)
542 hp->disconn_cfm(conn, reason);
544 hp = hci_proto[HCI_PROTO_SCO];
545 if (hp && hp->disconn_cfm)
546 hp->disconn_cfm(conn, reason);
549 static inline void hci_proto_auth_cfm(struct hci_conn *conn, __u8 status)
551 register struct hci_proto *hp;
554 if (test_bit(HCI_CONN_ENCRYPT_PEND, &conn->pend))
557 encrypt = (conn->link_mode & HCI_LM_ENCRYPT) ? 0x01 : 0x00;
559 hp = hci_proto[HCI_PROTO_L2CAP];
560 if (hp && hp->security_cfm)
561 hp->security_cfm(conn, status, encrypt);
563 hp = hci_proto[HCI_PROTO_SCO];
564 if (hp && hp->security_cfm)
565 hp->security_cfm(conn, status, encrypt);
568 static inline void hci_proto_encrypt_cfm(struct hci_conn *conn, __u8 status, __u8 encrypt)
570 register struct hci_proto *hp;
572 hp = hci_proto[HCI_PROTO_L2CAP];
573 if (hp && hp->security_cfm)
574 hp->security_cfm(conn, status, encrypt);
576 hp = hci_proto[HCI_PROTO_SCO];
577 if (hp && hp->security_cfm)
578 hp->security_cfm(conn, status, encrypt);
581 int hci_register_proto(struct hci_proto *hproto);
582 int hci_unregister_proto(struct hci_proto *hproto);
584 /* ----- HCI callbacks ----- */
586 struct list_head list;
590 void (*security_cfm) (struct hci_conn *conn, __u8 status, __u8 encrypt);
591 void (*key_change_cfm) (struct hci_conn *conn, __u8 status);
592 void (*role_switch_cfm) (struct hci_conn *conn, __u8 status, __u8 role);
595 static inline void hci_auth_cfm(struct hci_conn *conn, __u8 status)
600 hci_proto_auth_cfm(conn, status);
602 if (test_bit(HCI_CONN_ENCRYPT_PEND, &conn->pend))
605 encrypt = (conn->link_mode & HCI_LM_ENCRYPT) ? 0x01 : 0x00;
607 read_lock_bh(&hci_cb_list_lock);
608 list_for_each(p, &hci_cb_list) {
609 struct hci_cb *cb = list_entry(p, struct hci_cb, list);
610 if (cb->security_cfm)
611 cb->security_cfm(conn, status, encrypt);
613 read_unlock_bh(&hci_cb_list_lock);
616 static inline void hci_encrypt_cfm(struct hci_conn *conn, __u8 status, __u8 encrypt)
620 if (conn->sec_level == BT_SECURITY_SDP)
621 conn->sec_level = BT_SECURITY_LOW;
623 hci_proto_encrypt_cfm(conn, status, encrypt);
625 read_lock_bh(&hci_cb_list_lock);
626 list_for_each(p, &hci_cb_list) {
627 struct hci_cb *cb = list_entry(p, struct hci_cb, list);
628 if (cb->security_cfm)
629 cb->security_cfm(conn, status, encrypt);
631 read_unlock_bh(&hci_cb_list_lock);
634 static inline void hci_key_change_cfm(struct hci_conn *conn, __u8 status)
638 read_lock_bh(&hci_cb_list_lock);
639 list_for_each(p, &hci_cb_list) {
640 struct hci_cb *cb = list_entry(p, struct hci_cb, list);
641 if (cb->key_change_cfm)
642 cb->key_change_cfm(conn, status);
644 read_unlock_bh(&hci_cb_list_lock);
647 static inline void hci_role_switch_cfm(struct hci_conn *conn, __u8 status, __u8 role)
651 read_lock_bh(&hci_cb_list_lock);
652 list_for_each(p, &hci_cb_list) {
653 struct hci_cb *cb = list_entry(p, struct hci_cb, list);
654 if (cb->role_switch_cfm)
655 cb->role_switch_cfm(conn, status, role);
657 read_unlock_bh(&hci_cb_list_lock);
660 int hci_register_cb(struct hci_cb *hcb);
661 int hci_unregister_cb(struct hci_cb *hcb);
663 int hci_register_notifier(struct notifier_block *nb);
664 int hci_unregister_notifier(struct notifier_block *nb);
666 int hci_send_cmd(struct hci_dev *hdev, __u16 opcode, __u32 plen, void *param);
667 int hci_send_acl(struct hci_conn *conn, struct sk_buff *skb, __u16 flags);
668 int hci_send_sco(struct hci_conn *conn, struct sk_buff *skb);
670 void *hci_sent_cmd_data(struct hci_dev *hdev, __u16 opcode);
672 void hci_si_event(struct hci_dev *hdev, int type, int dlen, void *data);
674 /* ----- HCI Sockets ----- */
675 void hci_send_to_sock(struct hci_dev *hdev, struct sk_buff *skb);
677 /* HCI info for socket */
678 #define hci_pi(sk) ((struct hci_pinfo *) sk)
682 struct hci_dev *hdev;
683 struct hci_filter filter;
687 /* HCI security filter */
688 #define HCI_SFLT_MAX_OGF 5
690 struct hci_sec_filter {
693 __u32 ocf_mask[HCI_SFLT_MAX_OGF + 1][4];
696 /* ----- HCI requests ----- */
697 #define HCI_REQ_DONE 0
698 #define HCI_REQ_PEND 1
699 #define HCI_REQ_CANCELED 2
701 #define hci_req_lock(d) down(&d->req_lock)
702 #define hci_req_unlock(d) up(&d->req_lock)
704 void hci_req_complete(struct hci_dev *hdev, int result);
706 #endif /* __HCI_CORE_H */