2 BlueZ - Bluetooth protocol stack for Linux
3 Copyright (c) 2000-2001, 2010, Code Aurora Forum. All rights reserved.
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;
69 #define NUM_REASSEMBLY 4
71 struct list_head list;
97 __u16 sniff_min_interval;
98 __u16 sniff_max_interval;
100 unsigned long quirks;
103 unsigned int acl_cnt;
104 unsigned int sco_cnt;
106 unsigned int acl_mtu;
107 unsigned int sco_mtu;
108 unsigned int acl_pkts;
109 unsigned int sco_pkts;
111 unsigned long cmd_last_tx;
112 unsigned long acl_last_tx;
113 unsigned long sco_last_tx;
115 struct workqueue_struct *workqueue;
117 struct tasklet_struct cmd_task;
118 struct tasklet_struct rx_task;
119 struct tasklet_struct tx_task;
121 struct sk_buff_head rx_q;
122 struct sk_buff_head raw_q;
123 struct sk_buff_head cmd_q;
125 struct sk_buff *sent_cmd;
126 struct sk_buff *reassembly[NUM_REASSEMBLY];
128 struct mutex req_lock;
129 wait_queue_head_t req_wait_q;
134 struct inquiry_cache inq_cache;
135 struct hci_conn_hash conn_hash;
136 struct list_head blacklist;
138 struct hci_dev_stats stat;
140 struct sk_buff_head driver_init;
147 struct dentry *debugfs;
149 struct device *parent;
152 struct rfkill *rfkill;
154 struct module *owner;
156 int (*open)(struct hci_dev *hdev);
157 int (*close)(struct hci_dev *hdev);
158 int (*flush)(struct hci_dev *hdev);
159 int (*send)(struct sk_buff *skb);
160 void (*destruct)(struct hci_dev *hdev);
161 void (*notify)(struct hci_dev *hdev, unsigned int evt);
162 int (*ioctl)(struct hci_dev *hdev, unsigned int cmd, unsigned long arg);
166 struct list_head list;
193 struct sk_buff_head data_q;
195 struct timer_list disc_timer;
196 struct timer_list idle_timer;
198 struct work_struct work_add;
199 struct work_struct work_del;
204 struct hci_dev *hdev;
209 struct hci_conn *link;
212 extern struct hci_proto *hci_proto[];
213 extern struct list_head hci_dev_list;
214 extern struct list_head hci_cb_list;
215 extern rwlock_t hci_dev_list_lock;
216 extern rwlock_t hci_cb_list_lock;
218 /* ----- Inquiry cache ----- */
219 #define INQUIRY_CACHE_AGE_MAX (HZ*30) /* 30 seconds */
220 #define INQUIRY_ENTRY_AGE_MAX (HZ*60) /* 60 seconds */
222 #define inquiry_cache_lock(c) spin_lock(&c->lock)
223 #define inquiry_cache_unlock(c) spin_unlock(&c->lock)
224 #define inquiry_cache_lock_bh(c) spin_lock_bh(&c->lock)
225 #define inquiry_cache_unlock_bh(c) spin_unlock_bh(&c->lock)
227 static inline void inquiry_cache_init(struct hci_dev *hdev)
229 struct inquiry_cache *c = &hdev->inq_cache;
230 spin_lock_init(&c->lock);
234 static inline int inquiry_cache_empty(struct hci_dev *hdev)
236 struct inquiry_cache *c = &hdev->inq_cache;
237 return c->list == NULL;
240 static inline long inquiry_cache_age(struct hci_dev *hdev)
242 struct inquiry_cache *c = &hdev->inq_cache;
243 return jiffies - c->timestamp;
246 static inline long inquiry_entry_age(struct inquiry_entry *e)
248 return jiffies - e->timestamp;
251 struct inquiry_entry *hci_inquiry_cache_lookup(struct hci_dev *hdev, bdaddr_t *bdaddr);
252 void hci_inquiry_cache_update(struct hci_dev *hdev, struct inquiry_data *data);
254 /* ----- HCI Connections ----- */
257 HCI_CONN_ENCRYPT_PEND,
258 HCI_CONN_RSWITCH_PEND,
259 HCI_CONN_MODE_CHANGE_PEND,
260 HCI_CONN_SCO_SETUP_PEND,
263 static inline void hci_conn_hash_init(struct hci_dev *hdev)
265 struct hci_conn_hash *h = &hdev->conn_hash;
266 INIT_LIST_HEAD(&h->list);
267 spin_lock_init(&h->lock);
272 static inline void hci_conn_hash_add(struct hci_dev *hdev, struct hci_conn *c)
274 struct hci_conn_hash *h = &hdev->conn_hash;
275 list_add(&c->list, &h->list);
276 if (c->type == ACL_LINK)
282 static inline void hci_conn_hash_del(struct hci_dev *hdev, struct hci_conn *c)
284 struct hci_conn_hash *h = &hdev->conn_hash;
286 if (c->type == ACL_LINK)
292 static inline struct hci_conn *hci_conn_hash_lookup_handle(struct hci_dev *hdev,
295 struct hci_conn_hash *h = &hdev->conn_hash;
299 list_for_each(p, &h->list) {
300 c = list_entry(p, struct hci_conn, list);
301 if (c->handle == handle)
307 static inline struct hci_conn *hci_conn_hash_lookup_ba(struct hci_dev *hdev,
308 __u8 type, bdaddr_t *ba)
310 struct hci_conn_hash *h = &hdev->conn_hash;
314 list_for_each(p, &h->list) {
315 c = list_entry(p, struct hci_conn, list);
316 if (c->type == type && !bacmp(&c->dst, ba))
322 static inline struct hci_conn *hci_conn_hash_lookup_state(struct hci_dev *hdev,
323 __u8 type, __u16 state)
325 struct hci_conn_hash *h = &hdev->conn_hash;
329 list_for_each(p, &h->list) {
330 c = list_entry(p, struct hci_conn, list);
331 if (c->type == type && c->state == state)
337 void hci_acl_connect(struct hci_conn *conn);
338 void hci_acl_disconn(struct hci_conn *conn, __u8 reason);
339 void hci_add_sco(struct hci_conn *conn, __u16 handle);
340 void hci_setup_sync(struct hci_conn *conn, __u16 handle);
341 void hci_sco_setup(struct hci_conn *conn, __u8 status);
343 struct hci_conn *hci_conn_add(struct hci_dev *hdev, int type, bdaddr_t *dst);
344 int hci_conn_del(struct hci_conn *conn);
345 void hci_conn_hash_flush(struct hci_dev *hdev);
346 void hci_conn_check_pending(struct hci_dev *hdev);
348 struct hci_conn *hci_connect(struct hci_dev *hdev, int type, bdaddr_t *dst, __u8 sec_level, __u8 auth_type);
349 int hci_conn_check_link_mode(struct hci_conn *conn);
350 int hci_conn_security(struct hci_conn *conn, __u8 sec_level, __u8 auth_type);
351 int hci_conn_change_link_key(struct hci_conn *conn);
352 int hci_conn_switch_role(struct hci_conn *conn, __u8 role);
354 void hci_conn_enter_active_mode(struct hci_conn *conn);
355 void hci_conn_enter_sniff_mode(struct hci_conn *conn);
357 void hci_conn_hold_device(struct hci_conn *conn);
358 void hci_conn_put_device(struct hci_conn *conn);
360 static inline void hci_conn_hold(struct hci_conn *conn)
362 atomic_inc(&conn->refcnt);
363 del_timer(&conn->disc_timer);
366 static inline void hci_conn_put(struct hci_conn *conn)
368 if (atomic_dec_and_test(&conn->refcnt)) {
370 if (conn->type == ACL_LINK) {
371 del_timer(&conn->idle_timer);
372 if (conn->state == BT_CONNECTED) {
373 timeo = msecs_to_jiffies(conn->disc_timeout);
377 timeo = msecs_to_jiffies(10);
379 timeo = msecs_to_jiffies(10);
380 mod_timer(&conn->disc_timer, jiffies + timeo);
384 /* ----- HCI Devices ----- */
385 static inline void __hci_dev_put(struct hci_dev *d)
387 if (atomic_dec_and_test(&d->refcnt))
391 static inline void hci_dev_put(struct hci_dev *d)
394 module_put(d->owner);
397 static inline struct hci_dev *__hci_dev_hold(struct hci_dev *d)
399 atomic_inc(&d->refcnt);
403 static inline struct hci_dev *hci_dev_hold(struct hci_dev *d)
405 if (try_module_get(d->owner))
406 return __hci_dev_hold(d);
410 #define hci_dev_lock(d) spin_lock(&d->lock)
411 #define hci_dev_unlock(d) spin_unlock(&d->lock)
412 #define hci_dev_lock_bh(d) spin_lock_bh(&d->lock)
413 #define hci_dev_unlock_bh(d) spin_unlock_bh(&d->lock)
415 struct hci_dev *hci_dev_get(int index);
416 struct hci_dev *hci_get_route(bdaddr_t *src, bdaddr_t *dst);
418 struct hci_dev *hci_alloc_dev(void);
419 void hci_free_dev(struct hci_dev *hdev);
420 int hci_register_dev(struct hci_dev *hdev);
421 int hci_unregister_dev(struct hci_dev *hdev);
422 int hci_suspend_dev(struct hci_dev *hdev);
423 int hci_resume_dev(struct hci_dev *hdev);
424 int hci_dev_open(__u16 dev);
425 int hci_dev_close(__u16 dev);
426 int hci_dev_reset(__u16 dev);
427 int hci_dev_reset_stat(__u16 dev);
428 int hci_dev_cmd(unsigned int cmd, void __user *arg);
429 int hci_get_dev_list(void __user *arg);
430 int hci_get_dev_info(void __user *arg);
431 int hci_get_conn_list(void __user *arg);
432 int hci_get_conn_info(struct hci_dev *hdev, void __user *arg);
433 int hci_get_auth_info(struct hci_dev *hdev, void __user *arg);
434 int hci_inquiry(void __user *arg);
436 struct bdaddr_list *hci_blacklist_lookup(struct hci_dev *hdev, bdaddr_t *bdaddr);
437 int hci_blacklist_clear(struct hci_dev *hdev);
439 void hci_event_packet(struct hci_dev *hdev, struct sk_buff *skb);
441 int hci_recv_frame(struct sk_buff *skb);
442 int hci_recv_fragment(struct hci_dev *hdev, int type, void *data, int count);
443 int hci_recv_stream_fragment(struct hci_dev *hdev, void *data, int count);
445 int hci_register_sysfs(struct hci_dev *hdev);
446 void hci_unregister_sysfs(struct hci_dev *hdev);
447 void hci_conn_init_sysfs(struct hci_conn *conn);
448 void hci_conn_add_sysfs(struct hci_conn *conn);
449 void hci_conn_del_sysfs(struct hci_conn *conn);
451 #define SET_HCIDEV_DEV(hdev, pdev) ((hdev)->parent = (pdev))
453 /* ----- LMP capabilities ----- */
454 #define lmp_rswitch_capable(dev) ((dev)->features[0] & LMP_RSWITCH)
455 #define lmp_encrypt_capable(dev) ((dev)->features[0] & LMP_ENCRYPT)
456 #define lmp_sniff_capable(dev) ((dev)->features[0] & LMP_SNIFF)
457 #define lmp_sniffsubr_capable(dev) ((dev)->features[5] & LMP_SNIFF_SUBR)
458 #define lmp_esco_capable(dev) ((dev)->features[3] & LMP_ESCO)
459 #define lmp_ssp_capable(dev) ((dev)->features[6] & LMP_SIMPLE_PAIR)
461 /* ----- HCI protocols ----- */
469 int (*connect_ind) (struct hci_dev *hdev, bdaddr_t *bdaddr, __u8 type);
470 int (*connect_cfm) (struct hci_conn *conn, __u8 status);
471 int (*disconn_ind) (struct hci_conn *conn);
472 int (*disconn_cfm) (struct hci_conn *conn, __u8 reason);
473 int (*recv_acldata) (struct hci_conn *conn, struct sk_buff *skb, __u16 flags);
474 int (*recv_scodata) (struct hci_conn *conn, struct sk_buff *skb);
475 int (*security_cfm) (struct hci_conn *conn, __u8 status, __u8 encrypt);
478 static inline int hci_proto_connect_ind(struct hci_dev *hdev, bdaddr_t *bdaddr, __u8 type)
480 register struct hci_proto *hp;
483 hp = hci_proto[HCI_PROTO_L2CAP];
484 if (hp && hp->connect_ind)
485 mask |= hp->connect_ind(hdev, bdaddr, type);
487 hp = hci_proto[HCI_PROTO_SCO];
488 if (hp && hp->connect_ind)
489 mask |= hp->connect_ind(hdev, bdaddr, type);
494 static inline void hci_proto_connect_cfm(struct hci_conn *conn, __u8 status)
496 register struct hci_proto *hp;
498 hp = hci_proto[HCI_PROTO_L2CAP];
499 if (hp && hp->connect_cfm)
500 hp->connect_cfm(conn, status);
502 hp = hci_proto[HCI_PROTO_SCO];
503 if (hp && hp->connect_cfm)
504 hp->connect_cfm(conn, status);
507 static inline int hci_proto_disconn_ind(struct hci_conn *conn)
509 register struct hci_proto *hp;
512 hp = hci_proto[HCI_PROTO_L2CAP];
513 if (hp && hp->disconn_ind)
514 reason = hp->disconn_ind(conn);
516 hp = hci_proto[HCI_PROTO_SCO];
517 if (hp && hp->disconn_ind)
518 reason = hp->disconn_ind(conn);
523 static inline void hci_proto_disconn_cfm(struct hci_conn *conn, __u8 reason)
525 register struct hci_proto *hp;
527 hp = hci_proto[HCI_PROTO_L2CAP];
528 if (hp && hp->disconn_cfm)
529 hp->disconn_cfm(conn, reason);
531 hp = hci_proto[HCI_PROTO_SCO];
532 if (hp && hp->disconn_cfm)
533 hp->disconn_cfm(conn, reason);
536 static inline void hci_proto_auth_cfm(struct hci_conn *conn, __u8 status)
538 register struct hci_proto *hp;
541 if (test_bit(HCI_CONN_ENCRYPT_PEND, &conn->pend))
544 encrypt = (conn->link_mode & HCI_LM_ENCRYPT) ? 0x01 : 0x00;
546 hp = hci_proto[HCI_PROTO_L2CAP];
547 if (hp && hp->security_cfm)
548 hp->security_cfm(conn, status, encrypt);
550 hp = hci_proto[HCI_PROTO_SCO];
551 if (hp && hp->security_cfm)
552 hp->security_cfm(conn, status, encrypt);
555 static inline void hci_proto_encrypt_cfm(struct hci_conn *conn, __u8 status, __u8 encrypt)
557 register struct hci_proto *hp;
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 int hci_register_proto(struct hci_proto *hproto);
569 int hci_unregister_proto(struct hci_proto *hproto);
571 /* ----- HCI callbacks ----- */
573 struct list_head list;
577 void (*security_cfm) (struct hci_conn *conn, __u8 status, __u8 encrypt);
578 void (*key_change_cfm) (struct hci_conn *conn, __u8 status);
579 void (*role_switch_cfm) (struct hci_conn *conn, __u8 status, __u8 role);
582 static inline void hci_auth_cfm(struct hci_conn *conn, __u8 status)
587 hci_proto_auth_cfm(conn, status);
589 if (test_bit(HCI_CONN_ENCRYPT_PEND, &conn->pend))
592 encrypt = (conn->link_mode & HCI_LM_ENCRYPT) ? 0x01 : 0x00;
594 read_lock_bh(&hci_cb_list_lock);
595 list_for_each(p, &hci_cb_list) {
596 struct hci_cb *cb = list_entry(p, struct hci_cb, list);
597 if (cb->security_cfm)
598 cb->security_cfm(conn, status, encrypt);
600 read_unlock_bh(&hci_cb_list_lock);
603 static inline void hci_encrypt_cfm(struct hci_conn *conn, __u8 status, __u8 encrypt)
607 if (conn->sec_level == BT_SECURITY_SDP)
608 conn->sec_level = BT_SECURITY_LOW;
610 hci_proto_encrypt_cfm(conn, status, encrypt);
612 read_lock_bh(&hci_cb_list_lock);
613 list_for_each(p, &hci_cb_list) {
614 struct hci_cb *cb = list_entry(p, struct hci_cb, list);
615 if (cb->security_cfm)
616 cb->security_cfm(conn, status, encrypt);
618 read_unlock_bh(&hci_cb_list_lock);
621 static inline void hci_key_change_cfm(struct hci_conn *conn, __u8 status)
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->key_change_cfm)
629 cb->key_change_cfm(conn, status);
631 read_unlock_bh(&hci_cb_list_lock);
634 static inline void hci_role_switch_cfm(struct hci_conn *conn, __u8 status, __u8 role)
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->role_switch_cfm)
642 cb->role_switch_cfm(conn, status, role);
644 read_unlock_bh(&hci_cb_list_lock);
647 int hci_register_cb(struct hci_cb *hcb);
648 int hci_unregister_cb(struct hci_cb *hcb);
650 int hci_register_notifier(struct notifier_block *nb);
651 int hci_unregister_notifier(struct notifier_block *nb);
653 int hci_send_cmd(struct hci_dev *hdev, __u16 opcode, __u32 plen, void *param);
654 void hci_send_acl(struct hci_conn *conn, struct sk_buff *skb, __u16 flags);
655 void hci_send_sco(struct hci_conn *conn, struct sk_buff *skb);
657 void *hci_sent_cmd_data(struct hci_dev *hdev, __u16 opcode);
659 void hci_si_event(struct hci_dev *hdev, int type, int dlen, void *data);
661 /* ----- HCI Sockets ----- */
662 void hci_send_to_sock(struct hci_dev *hdev, struct sk_buff *skb);
664 /* Management interface */
665 int mgmt_control(struct sock *sk, struct msghdr *msg, size_t len);
666 int mgmt_index_added(u16 index);
667 int mgmt_index_removed(u16 index);
669 /* HCI info for socket */
670 #define hci_pi(sk) ((struct hci_pinfo *) sk)
674 struct hci_dev *hdev;
675 struct hci_filter filter;
677 unsigned short channel;
680 /* HCI security filter */
681 #define HCI_SFLT_MAX_OGF 5
683 struct hci_sec_filter {
686 __u32 ocf_mask[HCI_SFLT_MAX_OGF + 1][4];
689 /* ----- HCI requests ----- */
690 #define HCI_REQ_DONE 0
691 #define HCI_REQ_PEND 1
692 #define HCI_REQ_CANCELED 2
694 #define hci_req_lock(d) mutex_lock(&d->req_lock)
695 #define hci_req_unlock(d) mutex_unlock(&d->req_lock)
697 void hci_req_complete(struct hci_dev *hdev, __u16 cmd, int result);
699 #endif /* __HCI_CORE_H */