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 inline void bfusb_wait_for_urb(struct urb *urb)
103 while (atomic_read(&urb->count) > 1) {
104 current->state = TASK_UNINTERRUPTIBLE;
105 schedule_timeout((5 * HZ + 999) / 1000);
109 static struct urb *bfusb_get_completed(struct bfusb *bfusb)
112 struct urb *urb = NULL;
114 BT_DBG("bfusb %p", bfusb);
116 skb = skb_dequeue(&bfusb->completed_q);
118 urb = ((struct bfusb_scb *) skb->cb)->urb;
125 static void bfusb_unlink_urbs(struct bfusb *bfusb)
130 BT_DBG("bfusb %p", bfusb);
132 while ((skb = skb_dequeue(&bfusb->pending_q))) {
133 urb = ((struct bfusb_scb *) skb->cb)->urb;
135 bfusb_wait_for_urb(urb);
136 skb_queue_tail(&bfusb->completed_q, skb);
139 while ((urb = bfusb_get_completed(bfusb)))
144 static int bfusb_send_bulk(struct bfusb *bfusb, struct sk_buff *skb)
146 struct bfusb_scb *scb = (void *) skb->cb;
147 struct urb *urb = bfusb_get_completed(bfusb);
150 BT_DBG("bfusb %p skb %p len %d", bfusb, skb, skb->len);
152 if (!urb && !(urb = usb_alloc_urb(0, GFP_ATOMIC)))
155 pipe = usb_sndbulkpipe(bfusb->udev, bfusb->bulk_out_ep);
157 usb_fill_bulk_urb(urb, bfusb->udev, pipe, skb->data, skb->len,
158 bfusb_tx_complete, skb);
162 skb_queue_tail(&bfusb->pending_q, skb);
164 err = usb_submit_urb(urb, GFP_ATOMIC);
166 BT_ERR("%s bulk tx submit failed urb %p err %d",
167 bfusb->hdev->name, urb, err);
171 atomic_inc(&bfusb->pending_tx);
176 static void bfusb_tx_wakeup(struct bfusb *bfusb)
180 BT_DBG("bfusb %p", bfusb);
182 if (test_and_set_bit(BFUSB_TX_PROCESS, &bfusb->state)) {
183 set_bit(BFUSB_TX_WAKEUP, &bfusb->state);
188 clear_bit(BFUSB_TX_WAKEUP, &bfusb->state);
190 while ((atomic_read(&bfusb->pending_tx) < BFUSB_MAX_BULK_TX) &&
191 (skb = skb_dequeue(&bfusb->transmit_q))) {
192 if (bfusb_send_bulk(bfusb, skb) < 0) {
193 skb_queue_head(&bfusb->transmit_q, skb);
198 } while (test_bit(BFUSB_TX_WAKEUP, &bfusb->state));
200 clear_bit(BFUSB_TX_PROCESS, &bfusb->state);
203 static void bfusb_tx_complete(struct urb *urb, struct pt_regs *regs)
205 struct sk_buff *skb = (struct sk_buff *) urb->context;
206 struct bfusb *bfusb = (struct bfusb *) skb->dev;
208 BT_DBG("bfusb %p urb %p skb %p len %d", bfusb, urb, skb, skb->len);
210 atomic_dec(&bfusb->pending_tx);
212 if (!test_bit(HCI_RUNNING, &bfusb->hdev->flags))
216 bfusb->hdev->stat.byte_tx += skb->len;
218 bfusb->hdev->stat.err_tx++;
220 read_lock(&bfusb->lock);
223 skb_queue_tail(&bfusb->completed_q, skb);
225 bfusb_tx_wakeup(bfusb);
227 read_unlock(&bfusb->lock);
231 static int bfusb_rx_submit(struct bfusb *bfusb, struct urb *urb)
233 struct bfusb_scb *scb;
235 int err, pipe, size = HCI_MAX_FRAME_SIZE + 32;
237 BT_DBG("bfusb %p urb %p", bfusb, urb);
239 if (!urb && !(urb = usb_alloc_urb(0, GFP_ATOMIC)))
242 if (!(skb = bt_skb_alloc(size, GFP_ATOMIC))) {
247 skb->dev = (void *) bfusb;
249 scb = (struct bfusb_scb *) skb->cb;
252 pipe = usb_rcvbulkpipe(bfusb->udev, bfusb->bulk_in_ep);
254 usb_fill_bulk_urb(urb, bfusb->udev, pipe, skb->data, size,
255 bfusb_rx_complete, skb);
257 skb_queue_tail(&bfusb->pending_q, skb);
259 err = usb_submit_urb(urb, GFP_ATOMIC);
261 BT_ERR("%s bulk rx submit failed urb %p err %d",
262 bfusb->hdev->name, urb, err);
271 static inline int bfusb_recv_block(struct bfusb *bfusb, int hdr, unsigned char *data, int len)
273 BT_DBG("bfusb %p hdr 0x%02x data %p len %d", bfusb, hdr, data, len);
276 BT_ERR("%s error in block", bfusb->hdev->name);
277 if (bfusb->reassembly)
278 kfree_skb(bfusb->reassembly);
279 bfusb->reassembly = NULL;
285 unsigned char pkt_type;
288 if (bfusb->reassembly) {
289 BT_ERR("%s unexpected start block", bfusb->hdev->name);
290 kfree_skb(bfusb->reassembly);
291 bfusb->reassembly = NULL;
295 BT_ERR("%s no packet type found", bfusb->hdev->name);
299 pkt_type = *data++; len--;
303 if (len >= HCI_EVENT_HDR_SIZE) {
304 struct hci_event_hdr *hdr = (struct hci_event_hdr *) data;
305 pkt_len = HCI_EVENT_HDR_SIZE + hdr->plen;
307 BT_ERR("%s event block is too short", bfusb->hdev->name);
312 case HCI_ACLDATA_PKT:
313 if (len >= HCI_ACL_HDR_SIZE) {
314 struct hci_acl_hdr *hdr = (struct hci_acl_hdr *) data;
315 pkt_len = HCI_ACL_HDR_SIZE + __le16_to_cpu(hdr->dlen);
317 BT_ERR("%s data block is too short", bfusb->hdev->name);
322 case HCI_SCODATA_PKT:
323 if (len >= HCI_SCO_HDR_SIZE) {
324 struct hci_sco_hdr *hdr = (struct hci_sco_hdr *) data;
325 pkt_len = HCI_SCO_HDR_SIZE + hdr->dlen;
327 BT_ERR("%s audio block is too short", bfusb->hdev->name);
333 skb = bt_skb_alloc(pkt_len, GFP_ATOMIC);
335 BT_ERR("%s no memory for the packet", bfusb->hdev->name);
339 skb->dev = (void *) bfusb->hdev;
340 skb->pkt_type = pkt_type;
342 bfusb->reassembly = skb;
344 if (!bfusb->reassembly) {
345 BT_ERR("%s unexpected continuation block", bfusb->hdev->name);
351 memcpy(skb_put(bfusb->reassembly, len), data, len);
354 hci_recv_frame(bfusb->reassembly);
355 bfusb->reassembly = NULL;
361 static void bfusb_rx_complete(struct urb *urb, struct pt_regs *regs)
363 struct sk_buff *skb = (struct sk_buff *) urb->context;
364 struct bfusb *bfusb = (struct bfusb *) skb->dev;
365 unsigned char *buf = urb->transfer_buffer;
366 int count = urb->actual_length;
369 BT_DBG("bfusb %p urb %p skb %p len %d", bfusb, urb, skb, skb->len);
371 read_lock(&bfusb->lock);
373 if (!test_bit(HCI_RUNNING, &bfusb->hdev->flags))
376 if (urb->status || !count)
379 bfusb->hdev->stat.byte_rx += count;
384 hdr = buf[0] | (buf[1] << 8);
391 len = (buf[2] == 0) ? 256 : buf[2];
397 BT_ERR("%s block extends over URB buffer ranges",
401 if ((hdr & 0xe1) == 0xc1)
402 bfusb_recv_block(bfusb, hdr, buf, len);
411 bfusb_rx_submit(bfusb, urb);
413 read_unlock(&bfusb->lock);
418 urb->dev = bfusb->udev;
420 err = usb_submit_urb(urb, GFP_ATOMIC);
422 BT_ERR("%s bulk resubmit failed urb %p err %d",
423 bfusb->hdev->name, urb, err);
427 read_unlock(&bfusb->lock);
431 static int bfusb_open(struct hci_dev *hdev)
433 struct bfusb *bfusb = (struct bfusb *) hdev->driver_data;
437 BT_DBG("hdev %p bfusb %p", hdev, bfusb);
439 if (test_and_set_bit(HCI_RUNNING, &hdev->flags))
442 write_lock_irqsave(&bfusb->lock, flags);
444 err = bfusb_rx_submit(bfusb, NULL);
446 for (i = 1; i < BFUSB_MAX_BULK_RX; i++)
447 bfusb_rx_submit(bfusb, NULL);
449 clear_bit(HCI_RUNNING, &hdev->flags);
452 write_unlock_irqrestore(&bfusb->lock, flags);
457 static int bfusb_flush(struct hci_dev *hdev)
459 struct bfusb *bfusb = (struct bfusb *) hdev->driver_data;
461 BT_DBG("hdev %p bfusb %p", hdev, bfusb);
463 skb_queue_purge(&bfusb->transmit_q);
468 static int bfusb_close(struct hci_dev *hdev)
470 struct bfusb *bfusb = (struct bfusb *) hdev->driver_data;
473 BT_DBG("hdev %p bfusb %p", hdev, bfusb);
475 if (!test_and_clear_bit(HCI_RUNNING, &hdev->flags))
478 write_lock_irqsave(&bfusb->lock, flags);
479 write_unlock_irqrestore(&bfusb->lock, flags);
481 bfusb_unlink_urbs(bfusb);
487 static int bfusb_send_frame(struct sk_buff *skb)
489 struct hci_dev *hdev = (struct hci_dev *) skb->dev;
491 struct sk_buff *nskb;
492 unsigned char buf[3];
493 int sent = 0, size, count;
495 BT_DBG("hdev %p skb %p type %d len %d", hdev, skb, skb->pkt_type, skb->len);
498 BT_ERR("Frame for unknown HCI device (hdev=NULL)");
502 if (!test_bit(HCI_RUNNING, &hdev->flags))
505 bfusb = (struct bfusb *) hdev->driver_data;
507 switch (skb->pkt_type) {
508 case HCI_COMMAND_PKT:
511 case HCI_ACLDATA_PKT:
514 case HCI_SCODATA_PKT:
519 /* Prepend skb with frame type */
520 memcpy(skb_push(skb, 1), &(skb->pkt_type), 1);
524 /* Max HCI frame size seems to be 1511 + 1 */
525 if (!(nskb = bt_skb_alloc(count + 32, GFP_ATOMIC))) {
526 BT_ERR("Can't allocate memory for new packet");
530 nskb->dev = (void *) bfusb;
533 size = min_t(uint, count, BFUSB_MAX_BLOCK_SIZE);
535 buf[0] = 0xc1 | ((sent == 0) ? 0x04 : 0) | ((count == size) ? 0x08 : 0);
537 buf[2] = (size == BFUSB_MAX_BLOCK_SIZE) ? 0 : size;
539 memcpy(skb_put(nskb, 3), buf, 3);
540 memcpy(skb_put(nskb, size), skb->data + sent, size);
546 /* Don't send frame with multiple size of bulk max packet */
547 if ((nskb->len % bfusb->bulk_pkt_size) == 0) {
550 memcpy(skb_put(nskb, 2), buf, 2);
553 read_lock(&bfusb->lock);
555 skb_queue_tail(&bfusb->transmit_q, nskb);
556 bfusb_tx_wakeup(bfusb);
558 read_unlock(&bfusb->lock);
565 static void bfusb_destruct(struct hci_dev *hdev)
567 struct bfusb *bfusb = (struct bfusb *) hdev->driver_data;
569 BT_DBG("hdev %p bfusb %p", hdev, bfusb);
574 static int bfusb_ioctl(struct hci_dev *hdev, unsigned int cmd, unsigned long arg)
580 static int bfusb_load_firmware(struct bfusb *bfusb, unsigned char *firmware, int count)
583 int err, pipe, len, size, sent = 0;
585 BT_DBG("bfusb %p udev %p", bfusb, bfusb->udev);
587 BT_INFO("BlueFRITZ! USB loading firmware");
589 pipe = usb_sndctrlpipe(bfusb->udev, 0);
591 if (usb_control_msg(bfusb->udev, pipe, USB_REQ_SET_CONFIGURATION,
592 0, 1, 0, NULL, 0, HZ * USB_CTRL_SET_TIMEOUT) < 0) {
593 BT_ERR("Can't change to loading configuration");
597 buf = kmalloc(BFUSB_MAX_BLOCK_SIZE + 3, GFP_ATOMIC);
599 BT_ERR("Can't allocate memory chunk for firmware");
603 pipe = usb_sndbulkpipe(bfusb->udev, bfusb->bulk_out_ep);
606 size = min_t(uint, count, BFUSB_MAX_BLOCK_SIZE + 3);
608 memcpy(buf, firmware + sent, size);
610 err = usb_bulk_msg(bfusb->udev, pipe, buf, size,
611 &len, BFUSB_BLOCK_TIMEOUT);
613 if (err || (len != size)) {
614 BT_ERR("Error in firmware loading");
622 if ((err = usb_bulk_msg(bfusb->udev, pipe, NULL, 0,
623 &len, BFUSB_BLOCK_TIMEOUT)) < 0) {
624 BT_ERR("Error in null packet request");
628 pipe = usb_sndctrlpipe(bfusb->udev, 0);
630 if ((err = usb_control_msg(bfusb->udev, pipe, USB_REQ_SET_CONFIGURATION,
631 0, 2, 0, NULL, 0, HZ * USB_CTRL_SET_TIMEOUT)) < 0) {
632 BT_ERR("Can't change to running configuration");
636 BT_INFO("BlueFRITZ! USB device ready");
644 pipe = usb_sndctrlpipe(bfusb->udev, 0);
646 usb_control_msg(bfusb->udev, pipe, USB_REQ_SET_CONFIGURATION,
647 0, 0, 0, NULL, 0, HZ * USB_CTRL_SET_TIMEOUT);
652 static int bfusb_probe(struct usb_interface *intf, const struct usb_device_id *id)
654 const struct firmware *firmware;
655 struct usb_device *udev = interface_to_usbdev(intf);
656 struct usb_host_endpoint *bulk_out_ep;
657 struct usb_host_endpoint *bulk_in_ep;
658 struct hci_dev *hdev;
661 BT_DBG("intf %p id %p", intf, id);
663 /* Check number of endpoints */
664 if (intf->altsetting[0].desc.bNumEndpoints < 2)
667 bulk_out_ep = &intf->altsetting[0].endpoint[0];
668 bulk_in_ep = &intf->altsetting[0].endpoint[1];
670 if (!bulk_out_ep || !bulk_in_ep) {
671 BT_ERR("Bulk endpoints not found");
675 /* Initialize control structure and load firmware */
676 if (!(bfusb = kmalloc(sizeof(struct bfusb), GFP_KERNEL))) {
677 BT_ERR("Can't allocate memory for control structure");
681 memset(bfusb, 0, sizeof(struct bfusb));
684 bfusb->bulk_in_ep = bulk_in_ep->desc.bEndpointAddress;
685 bfusb->bulk_out_ep = bulk_out_ep->desc.bEndpointAddress;
686 bfusb->bulk_pkt_size = bulk_out_ep->desc.wMaxPacketSize;
688 bfusb->lock = RW_LOCK_UNLOCKED;
690 bfusb->reassembly = NULL;
692 skb_queue_head_init(&bfusb->transmit_q);
693 skb_queue_head_init(&bfusb->pending_q);
694 skb_queue_head_init(&bfusb->completed_q);
696 if (request_firmware(&firmware, "bfubase.frm", &udev->dev) < 0) {
697 BT_ERR("Firmware request failed");
701 BT_DBG("firmware data %p size %d", firmware->data, firmware->size);
703 if (bfusb_load_firmware(bfusb, firmware->data, firmware->size) < 0) {
704 BT_ERR("Firmware loading failed");
708 release_firmware(firmware);
710 /* Initialize and register HCI device */
711 hdev = hci_alloc_dev();
713 BT_ERR("Can't allocate HCI device");
719 hdev->type = HCI_USB;
720 hdev->driver_data = bfusb;
721 SET_HCIDEV_DEV(hdev, &intf->dev);
723 hdev->open = bfusb_open;
724 hdev->close = bfusb_close;
725 hdev->flush = bfusb_flush;
726 hdev->send = bfusb_send_frame;
727 hdev->destruct = bfusb_destruct;
728 hdev->ioctl = bfusb_ioctl;
730 hdev->owner = THIS_MODULE;
732 if (hci_register_dev(hdev) < 0) {
733 BT_ERR("Can't register HCI device");
738 usb_set_intfdata(intf, bfusb);
743 release_firmware(firmware);
752 static void bfusb_disconnect(struct usb_interface *intf)
754 struct bfusb *bfusb = usb_get_intfdata(intf);
755 struct hci_dev *hdev = bfusb->hdev;
757 BT_DBG("intf %p", intf);
762 usb_set_intfdata(intf, NULL);
766 if (hci_unregister_dev(hdev) < 0)
767 BT_ERR("Can't unregister HCI device %s", hdev->name);
772 static struct usb_driver bfusb_driver = {
773 .owner = THIS_MODULE,
775 .probe = bfusb_probe,
776 .disconnect = bfusb_disconnect,
777 .id_table = bfusb_table,
780 static int __init bfusb_init(void)
784 BT_INFO("BlueFRITZ! USB driver ver %s", VERSION);
786 if ((err = usb_register(&bfusb_driver)) < 0)
787 BT_ERR("Failed to register BlueFRITZ! USB driver");
792 static void __exit bfusb_exit(void)
794 usb_deregister(&bfusb_driver);
797 module_init(bfusb_init);
798 module_exit(bfusb_exit);
800 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
801 MODULE_DESCRIPTION("BlueFRITZ! USB driver ver " VERSION);
802 MODULE_VERSION(VERSION);
803 MODULE_LICENSE("GPL");