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 struct usb_driver bfusb_driver
;
50 static struct usb_device_id bfusb_table
[] = {
51 /* AVM BlueFRITZ! USB */
52 { USB_DEVICE(0x057c, 0x2200) },
54 { } /* Terminating entry */
57 MODULE_DEVICE_TABLE(usb
, bfusb_table
);
59 #define BFUSB_MAX_BLOCK_SIZE 256
61 #define BFUSB_BLOCK_TIMEOUT 3000
63 #define BFUSB_TX_PROCESS 1
64 #define BFUSB_TX_WAKEUP 2
66 #define BFUSB_MAX_BULK_TX 2
67 #define BFUSB_MAX_BULK_RX 2
74 struct usb_device
*udev
;
76 unsigned int bulk_in_ep
;
77 unsigned int bulk_out_ep
;
78 unsigned int bulk_pkt_size
;
82 struct sk_buff_head transmit_q
;
84 struct sk_buff
*reassembly
;
87 struct sk_buff_head pending_q
;
88 struct sk_buff_head completed_q
;
91 struct bfusb_data_scb
{
95 static void bfusb_tx_complete(struct urb
*urb
);
96 static void bfusb_rx_complete(struct urb
*urb
);
98 static struct urb
*bfusb_get_completed(struct bfusb_data
*data
)
101 struct urb
*urb
= NULL
;
103 BT_DBG("bfusb %p", data
);
105 skb
= skb_dequeue(&data
->completed_q
);
107 urb
= ((struct bfusb_data_scb
*) skb
->cb
)->urb
;
114 static void bfusb_unlink_urbs(struct bfusb_data
*data
)
119 BT_DBG("bfusb %p", data
);
121 while ((skb
= skb_dequeue(&data
->pending_q
))) {
122 urb
= ((struct bfusb_data_scb
*) skb
->cb
)->urb
;
124 skb_queue_tail(&data
->completed_q
, skb
);
127 while ((urb
= bfusb_get_completed(data
)))
131 static int bfusb_send_bulk(struct bfusb_data
*data
, struct sk_buff
*skb
)
133 struct bfusb_data_scb
*scb
= (void *) skb
->cb
;
134 struct urb
*urb
= bfusb_get_completed(data
);
137 BT_DBG("bfusb %p skb %p len %d", data
, skb
, skb
->len
);
139 if (!urb
&& !(urb
= usb_alloc_urb(0, GFP_ATOMIC
)))
142 pipe
= usb_sndbulkpipe(data
->udev
, data
->bulk_out_ep
);
144 usb_fill_bulk_urb(urb
, data
->udev
, pipe
, skb
->data
, skb
->len
,
145 bfusb_tx_complete
, skb
);
149 skb_queue_tail(&data
->pending_q
, skb
);
151 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
153 BT_ERR("%s bulk tx submit failed urb %p err %d",
154 data
->hdev
->name
, urb
, err
);
155 skb_unlink(skb
, &data
->pending_q
);
158 atomic_inc(&data
->pending_tx
);
163 static void bfusb_tx_wakeup(struct bfusb_data
*data
)
167 BT_DBG("bfusb %p", data
);
169 if (test_and_set_bit(BFUSB_TX_PROCESS
, &data
->state
)) {
170 set_bit(BFUSB_TX_WAKEUP
, &data
->state
);
175 clear_bit(BFUSB_TX_WAKEUP
, &data
->state
);
177 while ((atomic_read(&data
->pending_tx
) < BFUSB_MAX_BULK_TX
) &&
178 (skb
= skb_dequeue(&data
->transmit_q
))) {
179 if (bfusb_send_bulk(data
, skb
) < 0) {
180 skb_queue_head(&data
->transmit_q
, skb
);
185 } while (test_bit(BFUSB_TX_WAKEUP
, &data
->state
));
187 clear_bit(BFUSB_TX_PROCESS
, &data
->state
);
190 static void bfusb_tx_complete(struct urb
*urb
)
192 struct sk_buff
*skb
= (struct sk_buff
*) urb
->context
;
193 struct bfusb_data
*data
= (struct bfusb_data
*) skb
->dev
;
195 BT_DBG("bfusb %p urb %p skb %p len %d", data
, urb
, skb
, skb
->len
);
197 atomic_dec(&data
->pending_tx
);
199 if (!test_bit(HCI_RUNNING
, &data
->hdev
->flags
))
203 data
->hdev
->stat
.byte_tx
+= skb
->len
;
205 data
->hdev
->stat
.err_tx
++;
207 read_lock(&data
->lock
);
209 skb_unlink(skb
, &data
->pending_q
);
210 skb_queue_tail(&data
->completed_q
, skb
);
212 bfusb_tx_wakeup(data
);
214 read_unlock(&data
->lock
);
218 static int bfusb_rx_submit(struct bfusb_data
*data
, struct urb
*urb
)
220 struct bfusb_data_scb
*scb
;
222 int err
, pipe
, size
= HCI_MAX_FRAME_SIZE
+ 32;
224 BT_DBG("bfusb %p urb %p", bfusb
, urb
);
226 if (!urb
&& !(urb
= usb_alloc_urb(0, GFP_ATOMIC
)))
229 skb
= bt_skb_alloc(size
, GFP_ATOMIC
);
235 skb
->dev
= (void *) data
;
237 scb
= (struct bfusb_data_scb
*) skb
->cb
;
240 pipe
= usb_rcvbulkpipe(data
->udev
, data
->bulk_in_ep
);
242 usb_fill_bulk_urb(urb
, data
->udev
, pipe
, skb
->data
, size
,
243 bfusb_rx_complete
, skb
);
245 skb_queue_tail(&data
->pending_q
, skb
);
247 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
249 BT_ERR("%s bulk rx submit failed urb %p err %d",
250 data
->hdev
->name
, urb
, err
);
251 skb_unlink(skb
, &data
->pending_q
);
259 static inline int bfusb_recv_block(struct bfusb_data
*data
, int hdr
, unsigned char *buf
, int len
)
261 BT_DBG("bfusb %p hdr 0x%02x data %p len %d", data
, hdr
, buf
, len
);
264 BT_ERR("%s error in block", data
->hdev
->name
);
265 if (data
->reassembly
)
266 kfree_skb(data
->reassembly
);
267 data
->reassembly
= NULL
;
273 unsigned char pkt_type
;
276 if (data
->reassembly
) {
277 BT_ERR("%s unexpected start block", data
->hdev
->name
);
278 kfree_skb(data
->reassembly
);
279 data
->reassembly
= NULL
;
283 BT_ERR("%s no packet type found", data
->hdev
->name
);
287 pkt_type
= *buf
++; len
--;
291 if (len
>= HCI_EVENT_HDR_SIZE
) {
292 struct hci_event_hdr
*hdr
= (struct hci_event_hdr
*) buf
;
293 pkt_len
= HCI_EVENT_HDR_SIZE
+ hdr
->plen
;
295 BT_ERR("%s event block is too short", data
->hdev
->name
);
300 case HCI_ACLDATA_PKT
:
301 if (len
>= HCI_ACL_HDR_SIZE
) {
302 struct hci_acl_hdr
*hdr
= (struct hci_acl_hdr
*) buf
;
303 pkt_len
= HCI_ACL_HDR_SIZE
+ __le16_to_cpu(hdr
->dlen
);
305 BT_ERR("%s data block is too short", data
->hdev
->name
);
310 case HCI_SCODATA_PKT
:
311 if (len
>= HCI_SCO_HDR_SIZE
) {
312 struct hci_sco_hdr
*hdr
= (struct hci_sco_hdr
*) buf
;
313 pkt_len
= HCI_SCO_HDR_SIZE
+ hdr
->dlen
;
315 BT_ERR("%s audio block is too short", data
->hdev
->name
);
321 skb
= bt_skb_alloc(pkt_len
, GFP_ATOMIC
);
323 BT_ERR("%s no memory for the packet", data
->hdev
->name
);
327 skb
->dev
= (void *) data
->hdev
;
328 bt_cb(skb
)->pkt_type
= pkt_type
;
330 data
->reassembly
= skb
;
332 if (!data
->reassembly
) {
333 BT_ERR("%s unexpected continuation block", data
->hdev
->name
);
339 memcpy(skb_put(data
->reassembly
, len
), buf
, len
);
342 hci_recv_frame(data
->reassembly
);
343 data
->reassembly
= NULL
;
349 static void bfusb_rx_complete(struct urb
*urb
)
351 struct sk_buff
*skb
= (struct sk_buff
*) urb
->context
;
352 struct bfusb_data
*data
= (struct bfusb_data
*) skb
->dev
;
353 unsigned char *buf
= urb
->transfer_buffer
;
354 int count
= urb
->actual_length
;
357 BT_DBG("bfusb %p urb %p skb %p len %d", bfusb
, urb
, skb
, skb
->len
);
359 read_lock(&data
->lock
);
361 if (!test_bit(HCI_RUNNING
, &data
->hdev
->flags
))
364 if (urb
->status
|| !count
)
367 data
->hdev
->stat
.byte_rx
+= count
;
372 hdr
= buf
[0] | (buf
[1] << 8);
379 len
= (buf
[2] == 0) ? 256 : buf
[2];
385 BT_ERR("%s block extends over URB buffer ranges",
389 if ((hdr
& 0xe1) == 0xc1)
390 bfusb_recv_block(data
, hdr
, buf
, len
);
396 skb_unlink(skb
, &data
->pending_q
);
399 bfusb_rx_submit(data
, urb
);
401 read_unlock(&data
->lock
);
406 urb
->dev
= data
->udev
;
408 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
410 BT_ERR("%s bulk resubmit failed urb %p err %d",
411 data
->hdev
->name
, urb
, err
);
415 read_unlock(&data
->lock
);
418 static int bfusb_open(struct hci_dev
*hdev
)
420 struct bfusb_data
*data
= hdev
->driver_data
;
424 BT_DBG("hdev %p bfusb %p", hdev
, data
);
426 if (test_and_set_bit(HCI_RUNNING
, &hdev
->flags
))
429 write_lock_irqsave(&data
->lock
, flags
);
431 err
= bfusb_rx_submit(data
, NULL
);
433 for (i
= 1; i
< BFUSB_MAX_BULK_RX
; i
++)
434 bfusb_rx_submit(data
, NULL
);
436 clear_bit(HCI_RUNNING
, &hdev
->flags
);
439 write_unlock_irqrestore(&data
->lock
, flags
);
444 static int bfusb_flush(struct hci_dev
*hdev
)
446 struct bfusb_data
*data
= hdev
->driver_data
;
448 BT_DBG("hdev %p bfusb %p", hdev
, data
);
450 skb_queue_purge(&data
->transmit_q
);
455 static int bfusb_close(struct hci_dev
*hdev
)
457 struct bfusb_data
*data
= hdev
->driver_data
;
460 BT_DBG("hdev %p bfusb %p", hdev
, data
);
462 if (!test_and_clear_bit(HCI_RUNNING
, &hdev
->flags
))
465 write_lock_irqsave(&data
->lock
, flags
);
466 write_unlock_irqrestore(&data
->lock
, flags
);
468 bfusb_unlink_urbs(data
);
474 static int bfusb_send_frame(struct sk_buff
*skb
)
476 struct hci_dev
*hdev
= (struct hci_dev
*) skb
->dev
;
477 struct bfusb_data
*data
;
478 struct sk_buff
*nskb
;
479 unsigned char buf
[3];
480 int sent
= 0, size
, count
;
482 BT_DBG("hdev %p skb %p type %d len %d", hdev
, skb
, bt_cb(skb
)->pkt_type
, skb
->len
);
485 BT_ERR("Frame for unknown HCI device (hdev=NULL)");
489 if (!test_bit(HCI_RUNNING
, &hdev
->flags
))
492 data
= hdev
->driver_data
;
494 switch (bt_cb(skb
)->pkt_type
) {
495 case HCI_COMMAND_PKT
:
498 case HCI_ACLDATA_PKT
:
501 case HCI_SCODATA_PKT
:
506 /* Prepend skb with frame type */
507 memcpy(skb_push(skb
, 1), &bt_cb(skb
)->pkt_type
, 1);
511 /* Max HCI frame size seems to be 1511 + 1 */
512 nskb
= bt_skb_alloc(count
+ 32, GFP_ATOMIC
);
514 BT_ERR("Can't allocate memory for new packet");
518 nskb
->dev
= (void *) data
;
521 size
= min_t(uint
, count
, BFUSB_MAX_BLOCK_SIZE
);
523 buf
[0] = 0xc1 | ((sent
== 0) ? 0x04 : 0) | ((count
== size
) ? 0x08 : 0);
525 buf
[2] = (size
== BFUSB_MAX_BLOCK_SIZE
) ? 0 : size
;
527 memcpy(skb_put(nskb
, 3), buf
, 3);
528 skb_copy_from_linear_data_offset(skb
, sent
, skb_put(nskb
, size
), size
);
534 /* Don't send frame with multiple size of bulk max packet */
535 if ((nskb
->len
% data
->bulk_pkt_size
) == 0) {
538 memcpy(skb_put(nskb
, 2), buf
, 2);
541 read_lock(&data
->lock
);
543 skb_queue_tail(&data
->transmit_q
, nskb
);
544 bfusb_tx_wakeup(data
);
546 read_unlock(&data
->lock
);
553 static void bfusb_destruct(struct hci_dev
*hdev
)
555 struct bfusb_data
*data
= hdev
->driver_data
;
557 BT_DBG("hdev %p bfusb %p", hdev
, data
);
562 static int bfusb_ioctl(struct hci_dev
*hdev
, unsigned int cmd
, unsigned long arg
)
567 static int bfusb_load_firmware(struct bfusb_data
*data
,
568 const unsigned char *firmware
, int count
)
571 int err
, pipe
, len
, size
, sent
= 0;
573 BT_DBG("bfusb %p udev %p", data
, data
->udev
);
575 BT_INFO("BlueFRITZ! USB loading firmware");
577 pipe
= usb_sndctrlpipe(data
->udev
, 0);
579 if (usb_control_msg(data
->udev
, pipe
, USB_REQ_SET_CONFIGURATION
,
580 0, 1, 0, NULL
, 0, USB_CTRL_SET_TIMEOUT
) < 0) {
581 BT_ERR("Can't change to loading configuration");
585 data
->udev
->toggle
[0] = data
->udev
->toggle
[1] = 0;
587 buf
= kmalloc(BFUSB_MAX_BLOCK_SIZE
+ 3, GFP_ATOMIC
);
589 BT_ERR("Can't allocate memory chunk for firmware");
593 pipe
= usb_sndbulkpipe(data
->udev
, data
->bulk_out_ep
);
596 size
= min_t(uint
, count
, BFUSB_MAX_BLOCK_SIZE
+ 3);
598 memcpy(buf
, firmware
+ sent
, size
);
600 err
= usb_bulk_msg(data
->udev
, pipe
, buf
, size
,
601 &len
, BFUSB_BLOCK_TIMEOUT
);
603 if (err
|| (len
!= size
)) {
604 BT_ERR("Error in firmware loading");
612 err
= usb_bulk_msg(data
->udev
, pipe
, NULL
, 0,
613 &len
, BFUSB_BLOCK_TIMEOUT
);
615 BT_ERR("Error in null packet request");
619 pipe
= usb_sndctrlpipe(data
->udev
, 0);
621 err
= usb_control_msg(data
->udev
, pipe
, USB_REQ_SET_CONFIGURATION
,
622 0, 2, 0, NULL
, 0, USB_CTRL_SET_TIMEOUT
);
624 BT_ERR("Can't change to running configuration");
628 data
->udev
->toggle
[0] = data
->udev
->toggle
[1] = 0;
630 BT_INFO("BlueFRITZ! USB device ready");
638 pipe
= usb_sndctrlpipe(data
->udev
, 0);
640 usb_control_msg(data
->udev
, pipe
, USB_REQ_SET_CONFIGURATION
,
641 0, 0, 0, NULL
, 0, USB_CTRL_SET_TIMEOUT
);
646 static int bfusb_probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
648 const struct firmware
*firmware
;
649 struct usb_device
*udev
= interface_to_usbdev(intf
);
650 struct usb_host_endpoint
*bulk_out_ep
;
651 struct usb_host_endpoint
*bulk_in_ep
;
652 struct hci_dev
*hdev
;
653 struct bfusb_data
*data
;
655 BT_DBG("intf %p id %p", intf
, id
);
657 /* Check number of endpoints */
658 if (intf
->cur_altsetting
->desc
.bNumEndpoints
< 2)
661 bulk_out_ep
= &intf
->cur_altsetting
->endpoint
[0];
662 bulk_in_ep
= &intf
->cur_altsetting
->endpoint
[1];
664 if (!bulk_out_ep
|| !bulk_in_ep
) {
665 BT_ERR("Bulk endpoints not found");
669 /* Initialize control structure and load firmware */
670 data
= kzalloc(sizeof(struct bfusb_data
), GFP_KERNEL
);
672 BT_ERR("Can't allocate memory for control structure");
677 data
->bulk_in_ep
= bulk_in_ep
->desc
.bEndpointAddress
;
678 data
->bulk_out_ep
= bulk_out_ep
->desc
.bEndpointAddress
;
679 data
->bulk_pkt_size
= le16_to_cpu(bulk_out_ep
->desc
.wMaxPacketSize
);
681 rwlock_init(&data
->lock
);
683 data
->reassembly
= NULL
;
685 skb_queue_head_init(&data
->transmit_q
);
686 skb_queue_head_init(&data
->pending_q
);
687 skb_queue_head_init(&data
->completed_q
);
689 if (request_firmware(&firmware
, "bfubase.frm", &udev
->dev
) < 0) {
690 BT_ERR("Firmware request failed");
694 BT_DBG("firmware data %p size %d", firmware
->data
, firmware
->size
);
696 if (bfusb_load_firmware(data
, firmware
->data
, firmware
->size
) < 0) {
697 BT_ERR("Firmware loading failed");
701 release_firmware(firmware
);
703 /* Initialize and register HCI device */
704 hdev
= hci_alloc_dev();
706 BT_ERR("Can't allocate HCI device");
712 hdev
->type
= HCI_USB
;
713 hdev
->driver_data
= data
;
714 SET_HCIDEV_DEV(hdev
, &intf
->dev
);
716 hdev
->open
= bfusb_open
;
717 hdev
->close
= bfusb_close
;
718 hdev
->flush
= bfusb_flush
;
719 hdev
->send
= bfusb_send_frame
;
720 hdev
->destruct
= bfusb_destruct
;
721 hdev
->ioctl
= bfusb_ioctl
;
723 hdev
->owner
= THIS_MODULE
;
725 if (hci_register_dev(hdev
) < 0) {
726 BT_ERR("Can't register HCI device");
731 usb_set_intfdata(intf
, data
);
736 release_firmware(firmware
);
745 static void bfusb_disconnect(struct usb_interface
*intf
)
747 struct bfusb_data
*data
= usb_get_intfdata(intf
);
748 struct hci_dev
*hdev
= data
->hdev
;
750 BT_DBG("intf %p", intf
);
755 usb_set_intfdata(intf
, NULL
);
759 if (hci_unregister_dev(hdev
) < 0)
760 BT_ERR("Can't unregister HCI device %s", hdev
->name
);
765 static struct usb_driver bfusb_driver
= {
767 .probe
= bfusb_probe
,
768 .disconnect
= bfusb_disconnect
,
769 .id_table
= bfusb_table
,
772 static int __init
bfusb_init(void)
776 BT_INFO("BlueFRITZ! USB driver ver %s", VERSION
);
778 err
= usb_register(&bfusb_driver
);
780 BT_ERR("Failed to register BlueFRITZ! USB driver");
785 static void __exit
bfusb_exit(void)
787 usb_deregister(&bfusb_driver
);
790 module_init(bfusb_init
);
791 module_exit(bfusb_exit
);
793 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
794 MODULE_DESCRIPTION("BlueFRITZ! USB driver ver " VERSION
);
795 MODULE_VERSION(VERSION
);
796 MODULE_LICENSE("GPL");
797 MODULE_FIRMWARE("bfubase.frm");