3 * AVM BlueFRITZ! USB driver
5 * Copyright (C) 2003-2006 Marcel Holtmann <marcel@holtmann.org>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 #include <linux/module.h>
26 #include <linux/kernel.h>
27 #include <linux/init.h>
28 #include <linux/slab.h>
29 #include <linux/types.h>
30 #include <linux/errno.h>
31 #include <linux/skbuff.h>
33 #include <linux/device.h>
34 #include <linux/firmware.h>
36 #include <linux/usb.h>
38 #include <net/bluetooth/bluetooth.h>
39 #include <net/bluetooth/hci_core.h>
41 #ifndef CONFIG_BT_HCIBFUSB_DEBUG
48 static int ignore = 0;
50 static struct usb_driver bfusb_driver;
52 static struct usb_device_id bfusb_table[] = {
53 /* AVM BlueFRITZ! USB */
54 { USB_DEVICE(0x057c, 0x2200) },
56 { } /* Terminating entry */
59 MODULE_DEVICE_TABLE(usb, bfusb_table);
61 #define BFUSB_MAX_BLOCK_SIZE 256
63 #define BFUSB_BLOCK_TIMEOUT 3000
65 #define BFUSB_TX_PROCESS 1
66 #define BFUSB_TX_WAKEUP 2
68 #define BFUSB_MAX_BULK_TX 2
69 #define BFUSB_MAX_BULK_RX 2
76 struct usb_device *udev;
78 unsigned int bulk_in_ep;
79 unsigned int bulk_out_ep;
80 unsigned int bulk_pkt_size;
84 struct sk_buff_head transmit_q;
86 struct sk_buff *reassembly;
89 struct sk_buff_head pending_q;
90 struct sk_buff_head completed_q;
93 struct bfusb_data_scb {
97 static void bfusb_tx_complete(struct urb *urb);
98 static void bfusb_rx_complete(struct urb *urb);
100 static struct urb *bfusb_get_completed(struct bfusb_data *data)
103 struct urb *urb = NULL;
105 BT_DBG("bfusb %p", data);
107 skb = skb_dequeue(&data->completed_q);
109 urb = ((struct bfusb_data_scb *) skb->cb)->urb;
116 static void bfusb_unlink_urbs(struct bfusb_data *data)
121 BT_DBG("bfusb %p", data);
123 while ((skb = skb_dequeue(&data->pending_q))) {
124 urb = ((struct bfusb_data_scb *) skb->cb)->urb;
126 skb_queue_tail(&data->completed_q, skb);
129 while ((urb = bfusb_get_completed(data)))
133 static int bfusb_send_bulk(struct bfusb_data *data, struct sk_buff *skb)
135 struct bfusb_data_scb *scb = (void *) skb->cb;
136 struct urb *urb = bfusb_get_completed(data);
139 BT_DBG("bfusb %p skb %p len %d", data, skb, skb->len);
141 if (!urb && !(urb = usb_alloc_urb(0, GFP_ATOMIC)))
144 pipe = usb_sndbulkpipe(data->udev, data->bulk_out_ep);
146 usb_fill_bulk_urb(urb, data->udev, pipe, skb->data, skb->len,
147 bfusb_tx_complete, skb);
151 skb_queue_tail(&data->pending_q, skb);
153 err = usb_submit_urb(urb, GFP_ATOMIC);
155 BT_ERR("%s bulk tx submit failed urb %p err %d",
156 data->hdev->name, urb, err);
157 skb_unlink(skb, &data->pending_q);
160 atomic_inc(&data->pending_tx);
165 static void bfusb_tx_wakeup(struct bfusb_data *data)
169 BT_DBG("bfusb %p", data);
171 if (test_and_set_bit(BFUSB_TX_PROCESS, &data->state)) {
172 set_bit(BFUSB_TX_WAKEUP, &data->state);
177 clear_bit(BFUSB_TX_WAKEUP, &data->state);
179 while ((atomic_read(&data->pending_tx) < BFUSB_MAX_BULK_TX) &&
180 (skb = skb_dequeue(&data->transmit_q))) {
181 if (bfusb_send_bulk(data, skb) < 0) {
182 skb_queue_head(&data->transmit_q, skb);
187 } while (test_bit(BFUSB_TX_WAKEUP, &data->state));
189 clear_bit(BFUSB_TX_PROCESS, &data->state);
192 static void bfusb_tx_complete(struct urb *urb)
194 struct sk_buff *skb = (struct sk_buff *) urb->context;
195 struct bfusb_data *data = (struct bfusb_data *) skb->dev;
197 BT_DBG("bfusb %p urb %p skb %p len %d", data, urb, skb, skb->len);
199 atomic_dec(&data->pending_tx);
201 if (!test_bit(HCI_RUNNING, &data->hdev->flags))
205 data->hdev->stat.byte_tx += skb->len;
207 data->hdev->stat.err_tx++;
209 read_lock(&data->lock);
211 skb_unlink(skb, &data->pending_q);
212 skb_queue_tail(&data->completed_q, skb);
214 bfusb_tx_wakeup(data);
216 read_unlock(&data->lock);
220 static int bfusb_rx_submit(struct bfusb_data *data, struct urb *urb)
222 struct bfusb_data_scb *scb;
224 int err, pipe, size = HCI_MAX_FRAME_SIZE + 32;
226 BT_DBG("bfusb %p urb %p", bfusb, urb);
228 if (!urb && !(urb = usb_alloc_urb(0, GFP_ATOMIC)))
231 skb = bt_skb_alloc(size, GFP_ATOMIC);
237 skb->dev = (void *) data;
239 scb = (struct bfusb_data_scb *) skb->cb;
242 pipe = usb_rcvbulkpipe(data->udev, data->bulk_in_ep);
244 usb_fill_bulk_urb(urb, data->udev, pipe, skb->data, size,
245 bfusb_rx_complete, skb);
247 skb_queue_tail(&data->pending_q, skb);
249 err = usb_submit_urb(urb, GFP_ATOMIC);
251 BT_ERR("%s bulk rx submit failed urb %p err %d",
252 data->hdev->name, urb, err);
253 skb_unlink(skb, &data->pending_q);
261 static inline int bfusb_recv_block(struct bfusb_data *data, int hdr, unsigned char *buf, int len)
263 BT_DBG("bfusb %p hdr 0x%02x data %p len %d", data, hdr, buf, len);
266 BT_ERR("%s error in block", data->hdev->name);
267 if (data->reassembly)
268 kfree_skb(data->reassembly);
269 data->reassembly = NULL;
275 unsigned char pkt_type;
278 if (data->reassembly) {
279 BT_ERR("%s unexpected start block", data->hdev->name);
280 kfree_skb(data->reassembly);
281 data->reassembly = NULL;
285 BT_ERR("%s no packet type found", data->hdev->name);
289 pkt_type = *buf++; len--;
293 if (len >= HCI_EVENT_HDR_SIZE) {
294 struct hci_event_hdr *hdr = (struct hci_event_hdr *) buf;
295 pkt_len = HCI_EVENT_HDR_SIZE + hdr->plen;
297 BT_ERR("%s event block is too short", data->hdev->name);
302 case HCI_ACLDATA_PKT:
303 if (len >= HCI_ACL_HDR_SIZE) {
304 struct hci_acl_hdr *hdr = (struct hci_acl_hdr *) buf;
305 pkt_len = HCI_ACL_HDR_SIZE + __le16_to_cpu(hdr->dlen);
307 BT_ERR("%s data block is too short", data->hdev->name);
312 case HCI_SCODATA_PKT:
313 if (len >= HCI_SCO_HDR_SIZE) {
314 struct hci_sco_hdr *hdr = (struct hci_sco_hdr *) buf;
315 pkt_len = HCI_SCO_HDR_SIZE + hdr->dlen;
317 BT_ERR("%s audio block is too short", data->hdev->name);
323 skb = bt_skb_alloc(pkt_len, GFP_ATOMIC);
325 BT_ERR("%s no memory for the packet", data->hdev->name);
329 skb->dev = (void *) data->hdev;
330 bt_cb(skb)->pkt_type = pkt_type;
332 data->reassembly = skb;
334 if (!data->reassembly) {
335 BT_ERR("%s unexpected continuation block", data->hdev->name);
341 memcpy(skb_put(data->reassembly, len), buf, len);
344 hci_recv_frame(data->reassembly);
345 data->reassembly = NULL;
351 static void bfusb_rx_complete(struct urb *urb)
353 struct sk_buff *skb = (struct sk_buff *) urb->context;
354 struct bfusb_data *data = (struct bfusb_data *) skb->dev;
355 unsigned char *buf = urb->transfer_buffer;
356 int count = urb->actual_length;
359 BT_DBG("bfusb %p urb %p skb %p len %d", bfusb, urb, skb, skb->len);
361 read_lock(&data->lock);
363 if (!test_bit(HCI_RUNNING, &data->hdev->flags))
366 if (urb->status || !count)
369 data->hdev->stat.byte_rx += count;
374 hdr = buf[0] | (buf[1] << 8);
381 len = (buf[2] == 0) ? 256 : buf[2];
387 BT_ERR("%s block extends over URB buffer ranges",
391 if ((hdr & 0xe1) == 0xc1)
392 bfusb_recv_block(data, hdr, buf, len);
398 skb_unlink(skb, &data->pending_q);
401 bfusb_rx_submit(data, urb);
403 read_unlock(&data->lock);
408 urb->dev = data->udev;
410 err = usb_submit_urb(urb, GFP_ATOMIC);
412 BT_ERR("%s bulk resubmit failed urb %p err %d",
413 data->hdev->name, urb, err);
417 read_unlock(&data->lock);
420 static int bfusb_open(struct hci_dev *hdev)
422 struct bfusb_data *data = hdev->driver_data;
426 BT_DBG("hdev %p bfusb %p", hdev, data);
428 if (test_and_set_bit(HCI_RUNNING, &hdev->flags))
431 write_lock_irqsave(&data->lock, flags);
433 err = bfusb_rx_submit(data, NULL);
435 for (i = 1; i < BFUSB_MAX_BULK_RX; i++)
436 bfusb_rx_submit(data, NULL);
438 clear_bit(HCI_RUNNING, &hdev->flags);
441 write_unlock_irqrestore(&data->lock, flags);
446 static int bfusb_flush(struct hci_dev *hdev)
448 struct bfusb_data *data = hdev->driver_data;
450 BT_DBG("hdev %p bfusb %p", hdev, data);
452 skb_queue_purge(&data->transmit_q);
457 static int bfusb_close(struct hci_dev *hdev)
459 struct bfusb_data *data = hdev->driver_data;
462 BT_DBG("hdev %p bfusb %p", hdev, data);
464 if (!test_and_clear_bit(HCI_RUNNING, &hdev->flags))
467 write_lock_irqsave(&data->lock, flags);
468 write_unlock_irqrestore(&data->lock, flags);
470 bfusb_unlink_urbs(data);
476 static int bfusb_send_frame(struct sk_buff *skb)
478 struct hci_dev *hdev = (struct hci_dev *) skb->dev;
479 struct bfusb_data *data;
480 struct sk_buff *nskb;
481 unsigned char buf[3];
482 int sent = 0, size, count;
484 BT_DBG("hdev %p skb %p type %d len %d", hdev, skb, bt_cb(skb)->pkt_type, skb->len);
487 BT_ERR("Frame for unknown HCI device (hdev=NULL)");
491 if (!test_bit(HCI_RUNNING, &hdev->flags))
494 data = hdev->driver_data;
496 switch (bt_cb(skb)->pkt_type) {
497 case HCI_COMMAND_PKT:
500 case HCI_ACLDATA_PKT:
503 case HCI_SCODATA_PKT:
508 /* Prepend skb with frame type */
509 memcpy(skb_push(skb, 1), &bt_cb(skb)->pkt_type, 1);
513 /* Max HCI frame size seems to be 1511 + 1 */
514 nskb = bt_skb_alloc(count + 32, GFP_ATOMIC);
516 BT_ERR("Can't allocate memory for new packet");
520 nskb->dev = (void *) data;
523 size = min_t(uint, count, BFUSB_MAX_BLOCK_SIZE);
525 buf[0] = 0xc1 | ((sent == 0) ? 0x04 : 0) | ((count == size) ? 0x08 : 0);
527 buf[2] = (size == BFUSB_MAX_BLOCK_SIZE) ? 0 : size;
529 memcpy(skb_put(nskb, 3), buf, 3);
530 skb_copy_from_linear_data_offset(skb, sent, skb_put(nskb, size), size);
536 /* Don't send frame with multiple size of bulk max packet */
537 if ((nskb->len % data->bulk_pkt_size) == 0) {
540 memcpy(skb_put(nskb, 2), buf, 2);
543 read_lock(&data->lock);
545 skb_queue_tail(&data->transmit_q, nskb);
546 bfusb_tx_wakeup(data);
548 read_unlock(&data->lock);
555 static void bfusb_destruct(struct hci_dev *hdev)
557 struct bfusb_data *data = hdev->driver_data;
559 BT_DBG("hdev %p bfusb %p", hdev, data);
564 static int bfusb_ioctl(struct hci_dev *hdev, unsigned int cmd, unsigned long arg)
569 static int bfusb_load_firmware(struct bfusb_data *data,
570 const unsigned char *firmware, int count)
573 int err, pipe, len, size, sent = 0;
575 BT_DBG("bfusb %p udev %p", data, data->udev);
577 BT_INFO("BlueFRITZ! USB loading firmware");
579 pipe = usb_sndctrlpipe(data->udev, 0);
581 if (usb_control_msg(data->udev, pipe, USB_REQ_SET_CONFIGURATION,
582 0, 1, 0, NULL, 0, USB_CTRL_SET_TIMEOUT) < 0) {
583 BT_ERR("Can't change to loading configuration");
587 data->udev->toggle[0] = data->udev->toggle[1] = 0;
589 buf = kmalloc(BFUSB_MAX_BLOCK_SIZE + 3, GFP_ATOMIC);
591 BT_ERR("Can't allocate memory chunk for firmware");
595 pipe = usb_sndbulkpipe(data->udev, data->bulk_out_ep);
598 size = min_t(uint, count, BFUSB_MAX_BLOCK_SIZE + 3);
600 memcpy(buf, firmware + sent, size);
602 err = usb_bulk_msg(data->udev, pipe, buf, size,
603 &len, BFUSB_BLOCK_TIMEOUT);
605 if (err || (len != size)) {
606 BT_ERR("Error in firmware loading");
614 err = usb_bulk_msg(data->udev, pipe, NULL, 0,
615 &len, BFUSB_BLOCK_TIMEOUT);
617 BT_ERR("Error in null packet request");
621 pipe = usb_sndctrlpipe(data->udev, 0);
623 err = usb_control_msg(data->udev, pipe, USB_REQ_SET_CONFIGURATION,
624 0, 2, 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
626 BT_ERR("Can't change to running configuration");
630 data->udev->toggle[0] = data->udev->toggle[1] = 0;
632 BT_INFO("BlueFRITZ! USB device ready");
640 pipe = usb_sndctrlpipe(data->udev, 0);
642 usb_control_msg(data->udev, pipe, USB_REQ_SET_CONFIGURATION,
643 0, 0, 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
648 static int bfusb_probe(struct usb_interface *intf, const struct usb_device_id *id)
650 const struct firmware *firmware;
651 struct usb_device *udev = interface_to_usbdev(intf);
652 struct usb_host_endpoint *bulk_out_ep;
653 struct usb_host_endpoint *bulk_in_ep;
654 struct hci_dev *hdev;
655 struct bfusb_data *data;
657 BT_DBG("intf %p id %p", intf, id);
662 /* Check number of endpoints */
663 if (intf->cur_altsetting->desc.bNumEndpoints < 2)
666 bulk_out_ep = &intf->cur_altsetting->endpoint[0];
667 bulk_in_ep = &intf->cur_altsetting->endpoint[1];
669 if (!bulk_out_ep || !bulk_in_ep) {
670 BT_ERR("Bulk endpoints not found");
674 /* Initialize control structure and load firmware */
675 data = kzalloc(sizeof(struct bfusb_data), GFP_KERNEL);
677 BT_ERR("Can't allocate memory for control structure");
682 data->bulk_in_ep = bulk_in_ep->desc.bEndpointAddress;
683 data->bulk_out_ep = bulk_out_ep->desc.bEndpointAddress;
684 data->bulk_pkt_size = le16_to_cpu(bulk_out_ep->desc.wMaxPacketSize);
686 rwlock_init(&data->lock);
688 data->reassembly = NULL;
690 skb_queue_head_init(&data->transmit_q);
691 skb_queue_head_init(&data->pending_q);
692 skb_queue_head_init(&data->completed_q);
694 if (request_firmware(&firmware, "bfubase.frm", &udev->dev) < 0) {
695 BT_ERR("Firmware request failed");
699 BT_DBG("firmware data %p size %d", firmware->data, firmware->size);
701 if (bfusb_load_firmware(data, firmware->data, firmware->size) < 0) {
702 BT_ERR("Firmware loading failed");
706 release_firmware(firmware);
708 /* Initialize and register HCI device */
709 hdev = hci_alloc_dev();
711 BT_ERR("Can't allocate HCI device");
717 hdev->type = HCI_USB;
718 hdev->driver_data = data;
719 SET_HCIDEV_DEV(hdev, &intf->dev);
721 hdev->open = bfusb_open;
722 hdev->close = bfusb_close;
723 hdev->flush = bfusb_flush;
724 hdev->send = bfusb_send_frame;
725 hdev->destruct = bfusb_destruct;
726 hdev->ioctl = bfusb_ioctl;
728 hdev->owner = THIS_MODULE;
730 if (hci_register_dev(hdev) < 0) {
731 BT_ERR("Can't register HCI device");
736 usb_set_intfdata(intf, data);
741 release_firmware(firmware);
750 static void bfusb_disconnect(struct usb_interface *intf)
752 struct bfusb_data *data = usb_get_intfdata(intf);
753 struct hci_dev *hdev = data->hdev;
755 BT_DBG("intf %p", intf);
760 usb_set_intfdata(intf, NULL);
764 if (hci_unregister_dev(hdev) < 0)
765 BT_ERR("Can't unregister HCI device %s", hdev->name);
770 static struct usb_driver bfusb_driver = {
772 .probe = bfusb_probe,
773 .disconnect = bfusb_disconnect,
774 .id_table = bfusb_table,
777 static int __init bfusb_init(void)
781 BT_INFO("BlueFRITZ! USB driver ver %s", VERSION);
783 err = usb_register(&bfusb_driver);
785 BT_ERR("Failed to register BlueFRITZ! USB driver");
790 static void __exit bfusb_exit(void)
792 usb_deregister(&bfusb_driver);
795 module_init(bfusb_init);
796 module_exit(bfusb_exit);
798 module_param(ignore, bool, 0644);
799 MODULE_PARM_DESC(ignore, "Ignore devices from the matching table");
801 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
802 MODULE_DESCRIPTION("BlueFRITZ! USB driver ver " VERSION);
803 MODULE_VERSION(VERSION);
804 MODULE_LICENSE("GPL");
805 MODULE_FIRMWARE("bfubase.frm");