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>
43 static struct usb_driver bfusb_driver;
45 static struct usb_device_id bfusb_table[] = {
46 /* AVM BlueFRITZ! USB */
47 { USB_DEVICE(0x057c, 0x2200) },
49 { } /* Terminating entry */
52 MODULE_DEVICE_TABLE(usb, bfusb_table);
54 #define BFUSB_MAX_BLOCK_SIZE 256
56 #define BFUSB_BLOCK_TIMEOUT 3000
58 #define BFUSB_TX_PROCESS 1
59 #define BFUSB_TX_WAKEUP 2
61 #define BFUSB_MAX_BULK_TX 2
62 #define BFUSB_MAX_BULK_RX 2
69 struct usb_device *udev;
71 unsigned int bulk_in_ep;
72 unsigned int bulk_out_ep;
73 unsigned int bulk_pkt_size;
77 struct sk_buff_head transmit_q;
79 struct sk_buff *reassembly;
82 struct sk_buff_head pending_q;
83 struct sk_buff_head completed_q;
86 struct bfusb_data_scb {
90 static void bfusb_tx_complete(struct urb *urb);
91 static void bfusb_rx_complete(struct urb *urb);
93 static struct urb *bfusb_get_completed(struct bfusb_data *data)
96 struct urb *urb = NULL;
98 BT_DBG("bfusb %p", data);
100 skb = skb_dequeue(&data->completed_q);
102 urb = ((struct bfusb_data_scb *) skb->cb)->urb;
109 static void bfusb_unlink_urbs(struct bfusb_data *data)
114 BT_DBG("bfusb %p", data);
116 while ((skb = skb_dequeue(&data->pending_q))) {
117 urb = ((struct bfusb_data_scb *) skb->cb)->urb;
119 skb_queue_tail(&data->completed_q, skb);
122 while ((urb = bfusb_get_completed(data)))
126 static int bfusb_send_bulk(struct bfusb_data *data, struct sk_buff *skb)
128 struct bfusb_data_scb *scb = (void *) skb->cb;
129 struct urb *urb = bfusb_get_completed(data);
132 BT_DBG("bfusb %p skb %p len %d", data, skb, skb->len);
134 if (!urb && !(urb = usb_alloc_urb(0, GFP_ATOMIC)))
137 pipe = usb_sndbulkpipe(data->udev, data->bulk_out_ep);
139 usb_fill_bulk_urb(urb, data->udev, pipe, skb->data, skb->len,
140 bfusb_tx_complete, skb);
144 skb_queue_tail(&data->pending_q, skb);
146 err = usb_submit_urb(urb, GFP_ATOMIC);
148 BT_ERR("%s bulk tx submit failed urb %p err %d",
149 data->hdev->name, urb, err);
150 skb_unlink(skb, &data->pending_q);
153 atomic_inc(&data->pending_tx);
158 static void bfusb_tx_wakeup(struct bfusb_data *data)
162 BT_DBG("bfusb %p", data);
164 if (test_and_set_bit(BFUSB_TX_PROCESS, &data->state)) {
165 set_bit(BFUSB_TX_WAKEUP, &data->state);
170 clear_bit(BFUSB_TX_WAKEUP, &data->state);
172 while ((atomic_read(&data->pending_tx) < BFUSB_MAX_BULK_TX) &&
173 (skb = skb_dequeue(&data->transmit_q))) {
174 if (bfusb_send_bulk(data, skb) < 0) {
175 skb_queue_head(&data->transmit_q, skb);
180 } while (test_bit(BFUSB_TX_WAKEUP, &data->state));
182 clear_bit(BFUSB_TX_PROCESS, &data->state);
185 static void bfusb_tx_complete(struct urb *urb)
187 struct sk_buff *skb = (struct sk_buff *) urb->context;
188 struct bfusb_data *data = (struct bfusb_data *) skb->dev;
190 BT_DBG("bfusb %p urb %p skb %p len %d", data, urb, skb, skb->len);
192 atomic_dec(&data->pending_tx);
194 if (!test_bit(HCI_RUNNING, &data->hdev->flags))
198 data->hdev->stat.byte_tx += skb->len;
200 data->hdev->stat.err_tx++;
202 read_lock(&data->lock);
204 skb_unlink(skb, &data->pending_q);
205 skb_queue_tail(&data->completed_q, skb);
207 bfusb_tx_wakeup(data);
209 read_unlock(&data->lock);
213 static int bfusb_rx_submit(struct bfusb_data *data, struct urb *urb)
215 struct bfusb_data_scb *scb;
217 int err, pipe, size = HCI_MAX_FRAME_SIZE + 32;
219 BT_DBG("bfusb %p urb %p", data, urb);
221 if (!urb && !(urb = usb_alloc_urb(0, GFP_ATOMIC)))
224 skb = bt_skb_alloc(size, GFP_ATOMIC);
230 skb->dev = (void *) data;
232 scb = (struct bfusb_data_scb *) skb->cb;
235 pipe = usb_rcvbulkpipe(data->udev, data->bulk_in_ep);
237 usb_fill_bulk_urb(urb, data->udev, pipe, skb->data, size,
238 bfusb_rx_complete, skb);
240 skb_queue_tail(&data->pending_q, skb);
242 err = usb_submit_urb(urb, GFP_ATOMIC);
244 BT_ERR("%s bulk rx submit failed urb %p err %d",
245 data->hdev->name, urb, err);
246 skb_unlink(skb, &data->pending_q);
254 static inline int bfusb_recv_block(struct bfusb_data *data, int hdr, unsigned char *buf, int len)
256 BT_DBG("bfusb %p hdr 0x%02x data %p len %d", data, hdr, buf, len);
259 BT_ERR("%s error in block", data->hdev->name);
260 kfree_skb(data->reassembly);
261 data->reassembly = NULL;
267 unsigned char pkt_type;
270 if (data->reassembly) {
271 BT_ERR("%s unexpected start block", data->hdev->name);
272 kfree_skb(data->reassembly);
273 data->reassembly = NULL;
277 BT_ERR("%s no packet type found", data->hdev->name);
281 pkt_type = *buf++; len--;
285 if (len >= HCI_EVENT_HDR_SIZE) {
286 struct hci_event_hdr *hdr = (struct hci_event_hdr *) buf;
287 pkt_len = HCI_EVENT_HDR_SIZE + hdr->plen;
289 BT_ERR("%s event block is too short", data->hdev->name);
294 case HCI_ACLDATA_PKT:
295 if (len >= HCI_ACL_HDR_SIZE) {
296 struct hci_acl_hdr *hdr = (struct hci_acl_hdr *) buf;
297 pkt_len = HCI_ACL_HDR_SIZE + __le16_to_cpu(hdr->dlen);
299 BT_ERR("%s data block is too short", data->hdev->name);
304 case HCI_SCODATA_PKT:
305 if (len >= HCI_SCO_HDR_SIZE) {
306 struct hci_sco_hdr *hdr = (struct hci_sco_hdr *) buf;
307 pkt_len = HCI_SCO_HDR_SIZE + hdr->dlen;
309 BT_ERR("%s audio block is too short", data->hdev->name);
315 skb = bt_skb_alloc(pkt_len, GFP_ATOMIC);
317 BT_ERR("%s no memory for the packet", data->hdev->name);
321 skb->dev = (void *) data->hdev;
322 bt_cb(skb)->pkt_type = pkt_type;
324 data->reassembly = skb;
326 if (!data->reassembly) {
327 BT_ERR("%s unexpected continuation block", data->hdev->name);
333 memcpy(skb_put(data->reassembly, len), buf, len);
336 hci_recv_frame(data->reassembly);
337 data->reassembly = NULL;
343 static void bfusb_rx_complete(struct urb *urb)
345 struct sk_buff *skb = (struct sk_buff *) urb->context;
346 struct bfusb_data *data = (struct bfusb_data *) skb->dev;
347 unsigned char *buf = urb->transfer_buffer;
348 int count = urb->actual_length;
351 BT_DBG("bfusb %p urb %p skb %p len %d", data, urb, skb, skb->len);
353 read_lock(&data->lock);
355 if (!test_bit(HCI_RUNNING, &data->hdev->flags))
358 if (urb->status || !count)
361 data->hdev->stat.byte_rx += count;
366 hdr = buf[0] | (buf[1] << 8);
373 len = (buf[2] == 0) ? 256 : buf[2];
379 BT_ERR("%s block extends over URB buffer ranges",
383 if ((hdr & 0xe1) == 0xc1)
384 bfusb_recv_block(data, hdr, buf, len);
390 skb_unlink(skb, &data->pending_q);
393 bfusb_rx_submit(data, urb);
395 read_unlock(&data->lock);
400 urb->dev = data->udev;
402 err = usb_submit_urb(urb, GFP_ATOMIC);
404 BT_ERR("%s bulk resubmit failed urb %p err %d",
405 data->hdev->name, urb, err);
409 read_unlock(&data->lock);
412 static int bfusb_open(struct hci_dev *hdev)
414 struct bfusb_data *data = hdev->driver_data;
418 BT_DBG("hdev %p bfusb %p", hdev, data);
420 if (test_and_set_bit(HCI_RUNNING, &hdev->flags))
423 write_lock_irqsave(&data->lock, flags);
425 err = bfusb_rx_submit(data, NULL);
427 for (i = 1; i < BFUSB_MAX_BULK_RX; i++)
428 bfusb_rx_submit(data, NULL);
430 clear_bit(HCI_RUNNING, &hdev->flags);
433 write_unlock_irqrestore(&data->lock, flags);
438 static int bfusb_flush(struct hci_dev *hdev)
440 struct bfusb_data *data = hdev->driver_data;
442 BT_DBG("hdev %p bfusb %p", hdev, data);
444 skb_queue_purge(&data->transmit_q);
449 static int bfusb_close(struct hci_dev *hdev)
451 struct bfusb_data *data = hdev->driver_data;
454 BT_DBG("hdev %p bfusb %p", hdev, data);
456 if (!test_and_clear_bit(HCI_RUNNING, &hdev->flags))
459 write_lock_irqsave(&data->lock, flags);
460 write_unlock_irqrestore(&data->lock, flags);
462 bfusb_unlink_urbs(data);
468 static int bfusb_send_frame(struct sk_buff *skb)
470 struct hci_dev *hdev = (struct hci_dev *) skb->dev;
471 struct bfusb_data *data;
472 struct sk_buff *nskb;
473 unsigned char buf[3];
474 int sent = 0, size, count;
476 BT_DBG("hdev %p skb %p type %d len %d", hdev, skb, bt_cb(skb)->pkt_type, skb->len);
479 BT_ERR("Frame for unknown HCI device (hdev=NULL)");
483 if (!test_bit(HCI_RUNNING, &hdev->flags))
486 data = hdev->driver_data;
488 switch (bt_cb(skb)->pkt_type) {
489 case HCI_COMMAND_PKT:
492 case HCI_ACLDATA_PKT:
495 case HCI_SCODATA_PKT:
500 /* Prepend skb with frame type */
501 memcpy(skb_push(skb, 1), &bt_cb(skb)->pkt_type, 1);
505 /* Max HCI frame size seems to be 1511 + 1 */
506 nskb = bt_skb_alloc(count + 32, GFP_ATOMIC);
508 BT_ERR("Can't allocate memory for new packet");
512 nskb->dev = (void *) data;
515 size = min_t(uint, count, BFUSB_MAX_BLOCK_SIZE);
517 buf[0] = 0xc1 | ((sent == 0) ? 0x04 : 0) | ((count == size) ? 0x08 : 0);
519 buf[2] = (size == BFUSB_MAX_BLOCK_SIZE) ? 0 : size;
521 memcpy(skb_put(nskb, 3), buf, 3);
522 skb_copy_from_linear_data_offset(skb, sent, skb_put(nskb, size), size);
528 /* Don't send frame with multiple size of bulk max packet */
529 if ((nskb->len % data->bulk_pkt_size) == 0) {
532 memcpy(skb_put(nskb, 2), buf, 2);
535 read_lock(&data->lock);
537 skb_queue_tail(&data->transmit_q, nskb);
538 bfusb_tx_wakeup(data);
540 read_unlock(&data->lock);
547 static void bfusb_destruct(struct hci_dev *hdev)
549 struct bfusb_data *data = hdev->driver_data;
551 BT_DBG("hdev %p bfusb %p", hdev, data);
556 static int bfusb_ioctl(struct hci_dev *hdev, unsigned int cmd, unsigned long arg)
561 static int bfusb_load_firmware(struct bfusb_data *data,
562 const unsigned char *firmware, int count)
565 int err, pipe, len, size, sent = 0;
567 BT_DBG("bfusb %p udev %p", data, data->udev);
569 BT_INFO("BlueFRITZ! USB loading firmware");
571 pipe = usb_sndctrlpipe(data->udev, 0);
573 if (usb_control_msg(data->udev, pipe, USB_REQ_SET_CONFIGURATION,
574 0, 1, 0, NULL, 0, USB_CTRL_SET_TIMEOUT) < 0) {
575 BT_ERR("Can't change to loading configuration");
579 data->udev->toggle[0] = data->udev->toggle[1] = 0;
581 buf = kmalloc(BFUSB_MAX_BLOCK_SIZE + 3, GFP_ATOMIC);
583 BT_ERR("Can't allocate memory chunk for firmware");
587 pipe = usb_sndbulkpipe(data->udev, data->bulk_out_ep);
590 size = min_t(uint, count, BFUSB_MAX_BLOCK_SIZE + 3);
592 memcpy(buf, firmware + sent, size);
594 err = usb_bulk_msg(data->udev, pipe, buf, size,
595 &len, BFUSB_BLOCK_TIMEOUT);
597 if (err || (len != size)) {
598 BT_ERR("Error in firmware loading");
606 err = usb_bulk_msg(data->udev, pipe, NULL, 0,
607 &len, BFUSB_BLOCK_TIMEOUT);
609 BT_ERR("Error in null packet request");
613 pipe = usb_sndctrlpipe(data->udev, 0);
615 err = usb_control_msg(data->udev, pipe, USB_REQ_SET_CONFIGURATION,
616 0, 2, 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
618 BT_ERR("Can't change to running configuration");
622 data->udev->toggle[0] = data->udev->toggle[1] = 0;
624 BT_INFO("BlueFRITZ! USB device ready");
632 pipe = usb_sndctrlpipe(data->udev, 0);
634 usb_control_msg(data->udev, pipe, USB_REQ_SET_CONFIGURATION,
635 0, 0, 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
640 static int bfusb_probe(struct usb_interface *intf, const struct usb_device_id *id)
642 const struct firmware *firmware;
643 struct usb_device *udev = interface_to_usbdev(intf);
644 struct usb_host_endpoint *bulk_out_ep;
645 struct usb_host_endpoint *bulk_in_ep;
646 struct hci_dev *hdev;
647 struct bfusb_data *data;
649 BT_DBG("intf %p id %p", intf, id);
651 /* Check number of endpoints */
652 if (intf->cur_altsetting->desc.bNumEndpoints < 2)
655 bulk_out_ep = &intf->cur_altsetting->endpoint[0];
656 bulk_in_ep = &intf->cur_altsetting->endpoint[1];
658 if (!bulk_out_ep || !bulk_in_ep) {
659 BT_ERR("Bulk endpoints not found");
663 /* Initialize control structure and load firmware */
664 data = kzalloc(sizeof(struct bfusb_data), GFP_KERNEL);
666 BT_ERR("Can't allocate memory for control structure");
671 data->bulk_in_ep = bulk_in_ep->desc.bEndpointAddress;
672 data->bulk_out_ep = bulk_out_ep->desc.bEndpointAddress;
673 data->bulk_pkt_size = le16_to_cpu(bulk_out_ep->desc.wMaxPacketSize);
675 rwlock_init(&data->lock);
677 data->reassembly = NULL;
679 skb_queue_head_init(&data->transmit_q);
680 skb_queue_head_init(&data->pending_q);
681 skb_queue_head_init(&data->completed_q);
683 if (request_firmware(&firmware, "bfubase.frm", &udev->dev) < 0) {
684 BT_ERR("Firmware request failed");
688 BT_DBG("firmware data %p size %zu", firmware->data, firmware->size);
690 if (bfusb_load_firmware(data, firmware->data, firmware->size) < 0) {
691 BT_ERR("Firmware loading failed");
695 release_firmware(firmware);
697 /* Initialize and register HCI device */
698 hdev = hci_alloc_dev();
700 BT_ERR("Can't allocate HCI device");
707 hdev->driver_data = data;
708 SET_HCIDEV_DEV(hdev, &intf->dev);
710 hdev->open = bfusb_open;
711 hdev->close = bfusb_close;
712 hdev->flush = bfusb_flush;
713 hdev->send = bfusb_send_frame;
714 hdev->destruct = bfusb_destruct;
715 hdev->ioctl = bfusb_ioctl;
717 hdev->owner = THIS_MODULE;
719 if (hci_register_dev(hdev) < 0) {
720 BT_ERR("Can't register HCI device");
725 usb_set_intfdata(intf, data);
730 release_firmware(firmware);
739 static void bfusb_disconnect(struct usb_interface *intf)
741 struct bfusb_data *data = usb_get_intfdata(intf);
742 struct hci_dev *hdev = data->hdev;
744 BT_DBG("intf %p", intf);
749 usb_set_intfdata(intf, NULL);
753 hci_unregister_dev(hdev);
757 static struct usb_driver bfusb_driver = {
759 .probe = bfusb_probe,
760 .disconnect = bfusb_disconnect,
761 .id_table = bfusb_table,
764 static int __init bfusb_init(void)
768 BT_INFO("BlueFRITZ! USB driver ver %s", VERSION);
770 err = usb_register(&bfusb_driver);
772 BT_ERR("Failed to register BlueFRITZ! USB driver");
777 static void __exit bfusb_exit(void)
779 usb_deregister(&bfusb_driver);
782 module_init(bfusb_init);
783 module_exit(bfusb_exit);
785 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
786 MODULE_DESCRIPTION("BlueFRITZ! USB driver ver " VERSION);
787 MODULE_VERSION(VERSION);
788 MODULE_LICENSE("GPL");
789 MODULE_FIRMWARE("bfubase.frm");