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/sched.h>
31 #include <linux/errno.h>
32 #include <linux/skbuff.h>
34 #include <linux/device.h>
35 #include <linux/firmware.h>
37 #include <linux/usb.h>
39 #include <net/bluetooth/bluetooth.h>
40 #include <net/bluetooth/hci_core.h>
42 #ifndef CONFIG_BT_HCIBFUSB_DEBUG
49 static int ignore
= 0;
51 static struct usb_driver bfusb_driver
;
53 static struct usb_device_id bfusb_table
[] = {
54 /* AVM BlueFRITZ! USB */
55 { USB_DEVICE(0x057c, 0x2200) },
57 { } /* Terminating entry */
60 MODULE_DEVICE_TABLE(usb
, bfusb_table
);
62 #define BFUSB_MAX_BLOCK_SIZE 256
64 #define BFUSB_BLOCK_TIMEOUT 3000
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
;
94 struct bfusb_data_scb
{
98 static void bfusb_tx_complete(struct urb
*urb
);
99 static void bfusb_rx_complete(struct urb
*urb
);
101 static struct urb
*bfusb_get_completed(struct bfusb_data
*data
)
104 struct urb
*urb
= NULL
;
106 BT_DBG("bfusb %p", data
);
108 skb
= skb_dequeue(&data
->completed_q
);
110 urb
= ((struct bfusb_data_scb
*) skb
->cb
)->urb
;
117 static void bfusb_unlink_urbs(struct bfusb_data
*data
)
122 BT_DBG("bfusb %p", data
);
124 while ((skb
= skb_dequeue(&data
->pending_q
))) {
125 urb
= ((struct bfusb_data_scb
*) skb
->cb
)->urb
;
127 skb_queue_tail(&data
->completed_q
, skb
);
130 while ((urb
= bfusb_get_completed(data
)))
134 static int bfusb_send_bulk(struct bfusb_data
*data
, struct sk_buff
*skb
)
136 struct bfusb_data_scb
*scb
= (void *) skb
->cb
;
137 struct urb
*urb
= bfusb_get_completed(data
);
140 BT_DBG("bfusb %p skb %p len %d", data
, skb
, skb
->len
);
142 if (!urb
&& !(urb
= usb_alloc_urb(0, GFP_ATOMIC
)))
145 pipe
= usb_sndbulkpipe(data
->udev
, data
->bulk_out_ep
);
147 usb_fill_bulk_urb(urb
, data
->udev
, pipe
, skb
->data
, skb
->len
,
148 bfusb_tx_complete
, skb
);
152 skb_queue_tail(&data
->pending_q
, skb
);
154 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
156 BT_ERR("%s bulk tx submit failed urb %p err %d",
157 data
->hdev
->name
, urb
, err
);
158 skb_unlink(skb
, &data
->pending_q
);
161 atomic_inc(&data
->pending_tx
);
166 static void bfusb_tx_wakeup(struct bfusb_data
*data
)
170 BT_DBG("bfusb %p", data
);
172 if (test_and_set_bit(BFUSB_TX_PROCESS
, &data
->state
)) {
173 set_bit(BFUSB_TX_WAKEUP
, &data
->state
);
178 clear_bit(BFUSB_TX_WAKEUP
, &data
->state
);
180 while ((atomic_read(&data
->pending_tx
) < BFUSB_MAX_BULK_TX
) &&
181 (skb
= skb_dequeue(&data
->transmit_q
))) {
182 if (bfusb_send_bulk(data
, skb
) < 0) {
183 skb_queue_head(&data
->transmit_q
, skb
);
188 } while (test_bit(BFUSB_TX_WAKEUP
, &data
->state
));
190 clear_bit(BFUSB_TX_PROCESS
, &data
->state
);
193 static void bfusb_tx_complete(struct urb
*urb
)
195 struct sk_buff
*skb
= (struct sk_buff
*) urb
->context
;
196 struct bfusb_data
*data
= (struct bfusb_data
*) skb
->dev
;
198 BT_DBG("bfusb %p urb %p skb %p len %d", data
, urb
, skb
, skb
->len
);
200 atomic_dec(&data
->pending_tx
);
202 if (!test_bit(HCI_RUNNING
, &data
->hdev
->flags
))
206 data
->hdev
->stat
.byte_tx
+= skb
->len
;
208 data
->hdev
->stat
.err_tx
++;
210 read_lock(&data
->lock
);
212 skb_unlink(skb
, &data
->pending_q
);
213 skb_queue_tail(&data
->completed_q
, skb
);
215 bfusb_tx_wakeup(data
);
217 read_unlock(&data
->lock
);
221 static int bfusb_rx_submit(struct bfusb_data
*data
, struct urb
*urb
)
223 struct bfusb_data_scb
*scb
;
225 int err
, pipe
, size
= HCI_MAX_FRAME_SIZE
+ 32;
227 BT_DBG("bfusb %p urb %p", bfusb
, urb
);
229 if (!urb
&& !(urb
= usb_alloc_urb(0, GFP_ATOMIC
)))
232 skb
= bt_skb_alloc(size
, GFP_ATOMIC
);
238 skb
->dev
= (void *) data
;
240 scb
= (struct bfusb_data_scb
*) skb
->cb
;
243 pipe
= usb_rcvbulkpipe(data
->udev
, data
->bulk_in_ep
);
245 usb_fill_bulk_urb(urb
, data
->udev
, pipe
, skb
->data
, size
,
246 bfusb_rx_complete
, skb
);
248 skb_queue_tail(&data
->pending_q
, skb
);
250 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
252 BT_ERR("%s bulk rx submit failed urb %p err %d",
253 data
->hdev
->name
, urb
, err
);
254 skb_unlink(skb
, &data
->pending_q
);
262 static inline int bfusb_recv_block(struct bfusb_data
*data
, int hdr
, unsigned char *buf
, int len
)
264 BT_DBG("bfusb %p hdr 0x%02x data %p len %d", data
, hdr
, buf
, len
);
267 BT_ERR("%s error in block", data
->hdev
->name
);
268 if (data
->reassembly
)
269 kfree_skb(data
->reassembly
);
270 data
->reassembly
= NULL
;
276 unsigned char pkt_type
;
279 if (data
->reassembly
) {
280 BT_ERR("%s unexpected start block", data
->hdev
->name
);
281 kfree_skb(data
->reassembly
);
282 data
->reassembly
= NULL
;
286 BT_ERR("%s no packet type found", data
->hdev
->name
);
290 pkt_type
= *buf
++; len
--;
294 if (len
>= HCI_EVENT_HDR_SIZE
) {
295 struct hci_event_hdr
*hdr
= (struct hci_event_hdr
*) buf
;
296 pkt_len
= HCI_EVENT_HDR_SIZE
+ hdr
->plen
;
298 BT_ERR("%s event block is too short", data
->hdev
->name
);
303 case HCI_ACLDATA_PKT
:
304 if (len
>= HCI_ACL_HDR_SIZE
) {
305 struct hci_acl_hdr
*hdr
= (struct hci_acl_hdr
*) buf
;
306 pkt_len
= HCI_ACL_HDR_SIZE
+ __le16_to_cpu(hdr
->dlen
);
308 BT_ERR("%s data block is too short", data
->hdev
->name
);
313 case HCI_SCODATA_PKT
:
314 if (len
>= HCI_SCO_HDR_SIZE
) {
315 struct hci_sco_hdr
*hdr
= (struct hci_sco_hdr
*) buf
;
316 pkt_len
= HCI_SCO_HDR_SIZE
+ hdr
->dlen
;
318 BT_ERR("%s audio block is too short", data
->hdev
->name
);
324 skb
= bt_skb_alloc(pkt_len
, GFP_ATOMIC
);
326 BT_ERR("%s no memory for the packet", data
->hdev
->name
);
330 skb
->dev
= (void *) data
->hdev
;
331 bt_cb(skb
)->pkt_type
= pkt_type
;
333 data
->reassembly
= skb
;
335 if (!data
->reassembly
) {
336 BT_ERR("%s unexpected continuation block", data
->hdev
->name
);
342 memcpy(skb_put(data
->reassembly
, len
), buf
, len
);
345 hci_recv_frame(data
->reassembly
);
346 data
->reassembly
= NULL
;
352 static void bfusb_rx_complete(struct urb
*urb
)
354 struct sk_buff
*skb
= (struct sk_buff
*) urb
->context
;
355 struct bfusb_data
*data
= (struct bfusb_data
*) 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(&data
->lock
);
364 if (!test_bit(HCI_RUNNING
, &data
->hdev
->flags
))
367 if (urb
->status
|| !count
)
370 data
->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(data
, hdr
, buf
, len
);
399 skb_unlink(skb
, &data
->pending_q
);
402 bfusb_rx_submit(data
, urb
);
404 read_unlock(&data
->lock
);
409 urb
->dev
= data
->udev
;
411 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
413 BT_ERR("%s bulk resubmit failed urb %p err %d",
414 data
->hdev
->name
, urb
, err
);
418 read_unlock(&data
->lock
);
421 static int bfusb_open(struct hci_dev
*hdev
)
423 struct bfusb_data
*data
= hdev
->driver_data
;
427 BT_DBG("hdev %p bfusb %p", hdev
, data
);
429 if (test_and_set_bit(HCI_RUNNING
, &hdev
->flags
))
432 write_lock_irqsave(&data
->lock
, flags
);
434 err
= bfusb_rx_submit(data
, NULL
);
436 for (i
= 1; i
< BFUSB_MAX_BULK_RX
; i
++)
437 bfusb_rx_submit(data
, NULL
);
439 clear_bit(HCI_RUNNING
, &hdev
->flags
);
442 write_unlock_irqrestore(&data
->lock
, flags
);
447 static int bfusb_flush(struct hci_dev
*hdev
)
449 struct bfusb_data
*data
= hdev
->driver_data
;
451 BT_DBG("hdev %p bfusb %p", hdev
, data
);
453 skb_queue_purge(&data
->transmit_q
);
458 static int bfusb_close(struct hci_dev
*hdev
)
460 struct bfusb_data
*data
= hdev
->driver_data
;
463 BT_DBG("hdev %p bfusb %p", hdev
, data
);
465 if (!test_and_clear_bit(HCI_RUNNING
, &hdev
->flags
))
468 write_lock_irqsave(&data
->lock
, flags
);
469 write_unlock_irqrestore(&data
->lock
, flags
);
471 bfusb_unlink_urbs(data
);
477 static int bfusb_send_frame(struct sk_buff
*skb
)
479 struct hci_dev
*hdev
= (struct hci_dev
*) skb
->dev
;
480 struct bfusb_data
*data
;
481 struct sk_buff
*nskb
;
482 unsigned char buf
[3];
483 int sent
= 0, size
, count
;
485 BT_DBG("hdev %p skb %p type %d len %d", hdev
, skb
, bt_cb(skb
)->pkt_type
, skb
->len
);
488 BT_ERR("Frame for unknown HCI device (hdev=NULL)");
492 if (!test_bit(HCI_RUNNING
, &hdev
->flags
))
495 data
= hdev
->driver_data
;
497 switch (bt_cb(skb
)->pkt_type
) {
498 case HCI_COMMAND_PKT
:
501 case HCI_ACLDATA_PKT
:
504 case HCI_SCODATA_PKT
:
509 /* Prepend skb with frame type */
510 memcpy(skb_push(skb
, 1), &bt_cb(skb
)->pkt_type
, 1);
514 /* Max HCI frame size seems to be 1511 + 1 */
515 nskb
= bt_skb_alloc(count
+ 32, GFP_ATOMIC
);
517 BT_ERR("Can't allocate memory for new packet");
521 nskb
->dev
= (void *) data
;
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
% data
->bulk_pkt_size
) == 0) {
541 memcpy(skb_put(nskb
, 2), buf
, 2);
544 read_lock(&data
->lock
);
546 skb_queue_tail(&data
->transmit_q
, nskb
);
547 bfusb_tx_wakeup(data
);
549 read_unlock(&data
->lock
);
556 static void bfusb_destruct(struct hci_dev
*hdev
)
558 struct bfusb_data
*data
= hdev
->driver_data
;
560 BT_DBG("hdev %p bfusb %p", hdev
, data
);
565 static int bfusb_ioctl(struct hci_dev
*hdev
, unsigned int cmd
, unsigned long arg
)
570 static int bfusb_load_firmware(struct bfusb_data
*data
, 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");