3 * AVM BlueFRITZ! USB driver
5 * Copyright (C) 2003 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/config.h>
25 #include <linux/module.h>
27 #include <linux/kernel.h>
28 #include <linux/init.h>
29 #include <linux/slab.h>
30 #include <linux/types.h>
31 #include <linux/sched.h>
32 #include <linux/errno.h>
33 #include <linux/skbuff.h>
35 #include <linux/device.h>
36 #include <linux/firmware.h>
38 #include <linux/usb.h>
40 #include <net/bluetooth/bluetooth.h>
41 #include <net/bluetooth/hci_core.h>
43 #ifndef CONFIG_BT_HCIBFUSB_DEBUG
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);
62 #define BFUSB_MAX_BLOCK_SIZE 256
64 #define BFUSB_BLOCK_TIMEOUT (HZ * 3)
66 #define BFUSB_TX_PROCESS 1
67 #define BFUSB_TX_WAKEUP 2
69 #define BFUSB_MAX_BULK_TX 2
70 #define BFUSB_MAX_BULK_RX 2
77 struct usb_device *udev;
79 unsigned int bulk_in_ep;
80 unsigned int bulk_out_ep;
81 unsigned int bulk_pkt_size;
85 struct sk_buff_head transmit_q;
87 struct sk_buff *reassembly;
90 struct sk_buff_head pending_q;
91 struct sk_buff_head completed_q;
98 static void bfusb_tx_complete(struct urb *urb, struct pt_regs *regs);
99 static void bfusb_rx_complete(struct urb *urb, struct pt_regs *regs);
101 static struct urb *bfusb_get_completed(struct bfusb *bfusb)
104 struct urb *urb = NULL;
106 BT_DBG("bfusb %p", bfusb);
108 skb = skb_dequeue(&bfusb->completed_q);
110 urb = ((struct bfusb_scb *) skb->cb)->urb;
117 static void bfusb_unlink_urbs(struct bfusb *bfusb)
122 BT_DBG("bfusb %p", bfusb);
124 while ((skb = skb_dequeue(&bfusb->pending_q))) {
125 urb = ((struct bfusb_scb *) skb->cb)->urb;
127 skb_queue_tail(&bfusb->completed_q, skb);
130 while ((urb = bfusb_get_completed(bfusb)))
135 static int bfusb_send_bulk(struct bfusb *bfusb, struct sk_buff *skb)
137 struct bfusb_scb *scb = (void *) skb->cb;
138 struct urb *urb = bfusb_get_completed(bfusb);
141 BT_DBG("bfusb %p skb %p len %d", bfusb, skb, skb->len);
143 if (!urb && !(urb = usb_alloc_urb(0, GFP_ATOMIC)))
146 pipe = usb_sndbulkpipe(bfusb->udev, bfusb->bulk_out_ep);
148 usb_fill_bulk_urb(urb, bfusb->udev, pipe, skb->data, skb->len,
149 bfusb_tx_complete, skb);
153 skb_queue_tail(&bfusb->pending_q, skb);
155 err = usb_submit_urb(urb, GFP_ATOMIC);
157 BT_ERR("%s bulk tx submit failed urb %p err %d",
158 bfusb->hdev->name, urb, err);
162 atomic_inc(&bfusb->pending_tx);
167 static void bfusb_tx_wakeup(struct bfusb *bfusb)
171 BT_DBG("bfusb %p", bfusb);
173 if (test_and_set_bit(BFUSB_TX_PROCESS, &bfusb->state)) {
174 set_bit(BFUSB_TX_WAKEUP, &bfusb->state);
179 clear_bit(BFUSB_TX_WAKEUP, &bfusb->state);
181 while ((atomic_read(&bfusb->pending_tx) < BFUSB_MAX_BULK_TX) &&
182 (skb = skb_dequeue(&bfusb->transmit_q))) {
183 if (bfusb_send_bulk(bfusb, skb) < 0) {
184 skb_queue_head(&bfusb->transmit_q, skb);
189 } while (test_bit(BFUSB_TX_WAKEUP, &bfusb->state));
191 clear_bit(BFUSB_TX_PROCESS, &bfusb->state);
194 static void bfusb_tx_complete(struct urb *urb, struct pt_regs *regs)
196 struct sk_buff *skb = (struct sk_buff *) urb->context;
197 struct bfusb *bfusb = (struct bfusb *) skb->dev;
199 BT_DBG("bfusb %p urb %p skb %p len %d", bfusb, urb, skb, skb->len);
201 atomic_dec(&bfusb->pending_tx);
203 if (!test_bit(HCI_RUNNING, &bfusb->hdev->flags))
207 bfusb->hdev->stat.byte_tx += skb->len;
209 bfusb->hdev->stat.err_tx++;
211 read_lock(&bfusb->lock);
214 skb_queue_tail(&bfusb->completed_q, skb);
216 bfusb_tx_wakeup(bfusb);
218 read_unlock(&bfusb->lock);
222 static int bfusb_rx_submit(struct bfusb *bfusb, struct urb *urb)
224 struct bfusb_scb *scb;
226 int err, pipe, size = HCI_MAX_FRAME_SIZE + 32;
228 BT_DBG("bfusb %p urb %p", bfusb, urb);
230 if (!urb && !(urb = usb_alloc_urb(0, GFP_ATOMIC)))
233 if (!(skb = bt_skb_alloc(size, GFP_ATOMIC))) {
238 skb->dev = (void *) bfusb;
240 scb = (struct bfusb_scb *) skb->cb;
243 pipe = usb_rcvbulkpipe(bfusb->udev, bfusb->bulk_in_ep);
245 usb_fill_bulk_urb(urb, bfusb->udev, pipe, skb->data, size,
246 bfusb_rx_complete, skb);
248 skb_queue_tail(&bfusb->pending_q, skb);
250 err = usb_submit_urb(urb, GFP_ATOMIC);
252 BT_ERR("%s bulk rx submit failed urb %p err %d",
253 bfusb->hdev->name, urb, err);
262 static inline int bfusb_recv_block(struct bfusb *bfusb, int hdr, unsigned char *data, int len)
264 BT_DBG("bfusb %p hdr 0x%02x data %p len %d", bfusb, hdr, data, len);
267 BT_ERR("%s error in block", bfusb->hdev->name);
268 if (bfusb->reassembly)
269 kfree_skb(bfusb->reassembly);
270 bfusb->reassembly = NULL;
276 unsigned char pkt_type;
279 if (bfusb->reassembly) {
280 BT_ERR("%s unexpected start block", bfusb->hdev->name);
281 kfree_skb(bfusb->reassembly);
282 bfusb->reassembly = NULL;
286 BT_ERR("%s no packet type found", bfusb->hdev->name);
290 pkt_type = *data++; len--;
294 if (len >= HCI_EVENT_HDR_SIZE) {
295 struct hci_event_hdr *hdr = (struct hci_event_hdr *) data;
296 pkt_len = HCI_EVENT_HDR_SIZE + hdr->plen;
298 BT_ERR("%s event block is too short", bfusb->hdev->name);
303 case HCI_ACLDATA_PKT:
304 if (len >= HCI_ACL_HDR_SIZE) {
305 struct hci_acl_hdr *hdr = (struct hci_acl_hdr *) data;
306 pkt_len = HCI_ACL_HDR_SIZE + __le16_to_cpu(hdr->dlen);
308 BT_ERR("%s data block is too short", bfusb->hdev->name);
313 case HCI_SCODATA_PKT:
314 if (len >= HCI_SCO_HDR_SIZE) {
315 struct hci_sco_hdr *hdr = (struct hci_sco_hdr *) data;
316 pkt_len = HCI_SCO_HDR_SIZE + hdr->dlen;
318 BT_ERR("%s audio block is too short", bfusb->hdev->name);
324 skb = bt_skb_alloc(pkt_len, GFP_ATOMIC);
326 BT_ERR("%s no memory for the packet", bfusb->hdev->name);
330 skb->dev = (void *) bfusb->hdev;
331 skb->pkt_type = pkt_type;
333 bfusb->reassembly = skb;
335 if (!bfusb->reassembly) {
336 BT_ERR("%s unexpected continuation block", bfusb->hdev->name);
342 memcpy(skb_put(bfusb->reassembly, len), data, len);
345 hci_recv_frame(bfusb->reassembly);
346 bfusb->reassembly = NULL;
352 static void bfusb_rx_complete(struct urb *urb, struct pt_regs *regs)
354 struct sk_buff *skb = (struct sk_buff *) urb->context;
355 struct bfusb *bfusb = (struct bfusb *) skb->dev;
356 unsigned char *buf = urb->transfer_buffer;
357 int count = urb->actual_length;
360 BT_DBG("bfusb %p urb %p skb %p len %d", bfusb, urb, skb, skb->len);
362 read_lock(&bfusb->lock);
364 if (!test_bit(HCI_RUNNING, &bfusb->hdev->flags))
367 if (urb->status || !count)
370 bfusb->hdev->stat.byte_rx += count;
375 hdr = buf[0] | (buf[1] << 8);
382 len = (buf[2] == 0) ? 256 : buf[2];
388 BT_ERR("%s block extends over URB buffer ranges",
392 if ((hdr & 0xe1) == 0xc1)
393 bfusb_recv_block(bfusb, hdr, buf, len);
402 bfusb_rx_submit(bfusb, urb);
404 read_unlock(&bfusb->lock);
409 urb->dev = bfusb->udev;
411 err = usb_submit_urb(urb, GFP_ATOMIC);
413 BT_ERR("%s bulk resubmit failed urb %p err %d",
414 bfusb->hdev->name, urb, err);
418 read_unlock(&bfusb->lock);
422 static int bfusb_open(struct hci_dev *hdev)
424 struct bfusb *bfusb = (struct bfusb *) hdev->driver_data;
428 BT_DBG("hdev %p bfusb %p", hdev, bfusb);
430 if (test_and_set_bit(HCI_RUNNING, &hdev->flags))
433 write_lock_irqsave(&bfusb->lock, flags);
435 err = bfusb_rx_submit(bfusb, NULL);
437 for (i = 1; i < BFUSB_MAX_BULK_RX; i++)
438 bfusb_rx_submit(bfusb, NULL);
440 clear_bit(HCI_RUNNING, &hdev->flags);
443 write_unlock_irqrestore(&bfusb->lock, flags);
448 static int bfusb_flush(struct hci_dev *hdev)
450 struct bfusb *bfusb = (struct bfusb *) hdev->driver_data;
452 BT_DBG("hdev %p bfusb %p", hdev, bfusb);
454 skb_queue_purge(&bfusb->transmit_q);
459 static int bfusb_close(struct hci_dev *hdev)
461 struct bfusb *bfusb = (struct bfusb *) hdev->driver_data;
464 BT_DBG("hdev %p bfusb %p", hdev, bfusb);
466 if (!test_and_clear_bit(HCI_RUNNING, &hdev->flags))
469 write_lock_irqsave(&bfusb->lock, flags);
470 write_unlock_irqrestore(&bfusb->lock, flags);
472 bfusb_unlink_urbs(bfusb);
478 static int bfusb_send_frame(struct sk_buff *skb)
480 struct hci_dev *hdev = (struct hci_dev *) skb->dev;
482 struct sk_buff *nskb;
483 unsigned char buf[3];
484 int sent = 0, size, count;
486 BT_DBG("hdev %p skb %p type %d len %d", hdev, skb, skb->pkt_type, skb->len);
489 BT_ERR("Frame for unknown HCI device (hdev=NULL)");
493 if (!test_bit(HCI_RUNNING, &hdev->flags))
496 bfusb = (struct bfusb *) hdev->driver_data;
498 switch (skb->pkt_type) {
499 case HCI_COMMAND_PKT:
502 case HCI_ACLDATA_PKT:
505 case HCI_SCODATA_PKT:
510 /* Prepend skb with frame type */
511 memcpy(skb_push(skb, 1), &(skb->pkt_type), 1);
515 /* Max HCI frame size seems to be 1511 + 1 */
516 if (!(nskb = bt_skb_alloc(count + 32, GFP_ATOMIC))) {
517 BT_ERR("Can't allocate memory for new packet");
521 nskb->dev = (void *) bfusb;
524 size = min_t(uint, count, BFUSB_MAX_BLOCK_SIZE);
526 buf[0] = 0xc1 | ((sent == 0) ? 0x04 : 0) | ((count == size) ? 0x08 : 0);
528 buf[2] = (size == BFUSB_MAX_BLOCK_SIZE) ? 0 : size;
530 memcpy(skb_put(nskb, 3), buf, 3);
531 memcpy(skb_put(nskb, size), skb->data + sent, size);
537 /* Don't send frame with multiple size of bulk max packet */
538 if ((nskb->len % bfusb->bulk_pkt_size) == 0) {
541 memcpy(skb_put(nskb, 2), buf, 2);
544 read_lock(&bfusb->lock);
546 skb_queue_tail(&bfusb->transmit_q, nskb);
547 bfusb_tx_wakeup(bfusb);
549 read_unlock(&bfusb->lock);
556 static void bfusb_destruct(struct hci_dev *hdev)
558 struct bfusb *bfusb = (struct bfusb *) hdev->driver_data;
560 BT_DBG("hdev %p bfusb %p", hdev, bfusb);
565 static int bfusb_ioctl(struct hci_dev *hdev, unsigned int cmd, unsigned long arg)
571 static int bfusb_load_firmware(struct bfusb *bfusb, unsigned char *firmware, int count)
574 int err, pipe, len, size, sent = 0;
576 BT_DBG("bfusb %p udev %p", bfusb, bfusb->udev);
578 BT_INFO("BlueFRITZ! USB loading firmware");
580 pipe = usb_sndctrlpipe(bfusb->udev, 0);
582 if (usb_control_msg(bfusb->udev, pipe, USB_REQ_SET_CONFIGURATION,
583 0, 1, 0, NULL, 0, HZ * USB_CTRL_SET_TIMEOUT) < 0) {
584 BT_ERR("Can't change to loading configuration");
588 bfusb->udev->toggle[0] = bfusb->udev->toggle[1] = 0;
590 buf = kmalloc(BFUSB_MAX_BLOCK_SIZE + 3, GFP_ATOMIC);
592 BT_ERR("Can't allocate memory chunk for firmware");
596 pipe = usb_sndbulkpipe(bfusb->udev, bfusb->bulk_out_ep);
599 size = min_t(uint, count, BFUSB_MAX_BLOCK_SIZE + 3);
601 memcpy(buf, firmware + sent, size);
603 err = usb_bulk_msg(bfusb->udev, pipe, buf, size,
604 &len, BFUSB_BLOCK_TIMEOUT);
606 if (err || (len != size)) {
607 BT_ERR("Error in firmware loading");
615 if ((err = usb_bulk_msg(bfusb->udev, pipe, NULL, 0,
616 &len, BFUSB_BLOCK_TIMEOUT)) < 0) {
617 BT_ERR("Error in null packet request");
621 pipe = usb_sndctrlpipe(bfusb->udev, 0);
623 if ((err = usb_control_msg(bfusb->udev, pipe, USB_REQ_SET_CONFIGURATION,
624 0, 2, 0, NULL, 0, HZ * USB_CTRL_SET_TIMEOUT)) < 0) {
625 BT_ERR("Can't change to running configuration");
629 bfusb->udev->toggle[0] = bfusb->udev->toggle[1] = 0;
631 BT_INFO("BlueFRITZ! USB device ready");
639 pipe = usb_sndctrlpipe(bfusb->udev, 0);
641 usb_control_msg(bfusb->udev, pipe, USB_REQ_SET_CONFIGURATION,
642 0, 0, 0, NULL, 0, HZ * USB_CTRL_SET_TIMEOUT);
647 static int bfusb_probe(struct usb_interface *intf, const struct usb_device_id *id)
649 const struct firmware *firmware;
650 struct usb_device *udev = interface_to_usbdev(intf);
651 struct usb_host_endpoint *bulk_out_ep;
652 struct usb_host_endpoint *bulk_in_ep;
653 struct hci_dev *hdev;
656 BT_DBG("intf %p id %p", intf, id);
658 /* Check number of endpoints */
659 if (intf->cur_altsetting->desc.bNumEndpoints < 2)
662 bulk_out_ep = &intf->cur_altsetting->endpoint[0];
663 bulk_in_ep = &intf->cur_altsetting->endpoint[1];
665 if (!bulk_out_ep || !bulk_in_ep) {
666 BT_ERR("Bulk endpoints not found");
670 /* Initialize control structure and load firmware */
671 if (!(bfusb = kmalloc(sizeof(struct bfusb), GFP_KERNEL))) {
672 BT_ERR("Can't allocate memory for control structure");
676 memset(bfusb, 0, sizeof(struct bfusb));
679 bfusb->bulk_in_ep = bulk_in_ep->desc.bEndpointAddress;
680 bfusb->bulk_out_ep = bulk_out_ep->desc.bEndpointAddress;
681 bfusb->bulk_pkt_size = bulk_out_ep->desc.wMaxPacketSize;
683 bfusb->lock = RW_LOCK_UNLOCKED;
685 bfusb->reassembly = NULL;
687 skb_queue_head_init(&bfusb->transmit_q);
688 skb_queue_head_init(&bfusb->pending_q);
689 skb_queue_head_init(&bfusb->completed_q);
691 if (request_firmware(&firmware, "bfubase.frm", &udev->dev) < 0) {
692 BT_ERR("Firmware request failed");
696 BT_DBG("firmware data %p size %d", firmware->data, firmware->size);
698 if (bfusb_load_firmware(bfusb, firmware->data, firmware->size) < 0) {
699 BT_ERR("Firmware loading failed");
703 release_firmware(firmware);
705 /* Initialize and register HCI device */
706 hdev = hci_alloc_dev();
708 BT_ERR("Can't allocate HCI device");
714 hdev->type = HCI_USB;
715 hdev->driver_data = bfusb;
716 SET_HCIDEV_DEV(hdev, &intf->dev);
718 hdev->open = bfusb_open;
719 hdev->close = bfusb_close;
720 hdev->flush = bfusb_flush;
721 hdev->send = bfusb_send_frame;
722 hdev->destruct = bfusb_destruct;
723 hdev->ioctl = bfusb_ioctl;
725 hdev->owner = THIS_MODULE;
727 if (hci_register_dev(hdev) < 0) {
728 BT_ERR("Can't register HCI device");
733 usb_set_intfdata(intf, bfusb);
738 release_firmware(firmware);
747 static void bfusb_disconnect(struct usb_interface *intf)
749 struct bfusb *bfusb = usb_get_intfdata(intf);
750 struct hci_dev *hdev = bfusb->hdev;
752 BT_DBG("intf %p", intf);
757 usb_set_intfdata(intf, NULL);
761 if (hci_unregister_dev(hdev) < 0)
762 BT_ERR("Can't unregister HCI device %s", hdev->name);
767 static struct usb_driver bfusb_driver = {
768 .owner = THIS_MODULE,
770 .probe = bfusb_probe,
771 .disconnect = bfusb_disconnect,
772 .id_table = bfusb_table,
775 static int __init bfusb_init(void)
779 BT_INFO("BlueFRITZ! USB driver ver %s", VERSION);
781 if ((err = usb_register(&bfusb_driver)) < 0)
782 BT_ERR("Failed to register BlueFRITZ! USB driver");
787 static void __exit bfusb_exit(void)
789 usb_deregister(&bfusb_driver);
792 module_init(bfusb_init);
793 module_exit(bfusb_exit);
795 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
796 MODULE_DESCRIPTION("BlueFRITZ! USB driver ver " VERSION);
797 MODULE_VERSION(VERSION);
798 MODULE_LICENSE("GPL");