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 int ignore
= 0;
52 static struct usb_driver bfusb_driver
;
54 static struct usb_device_id bfusb_table
[] = {
55 /* AVM BlueFRITZ! USB */
56 { USB_DEVICE(0x057c, 0x2200) },
58 { } /* Terminating entry */
61 MODULE_DEVICE_TABLE(usb
, bfusb_table
);
64 #define BFUSB_MAX_BLOCK_SIZE 256
66 #define BFUSB_BLOCK_TIMEOUT 3000
68 #define BFUSB_TX_PROCESS 1
69 #define BFUSB_TX_WAKEUP 2
71 #define BFUSB_MAX_BULK_TX 2
72 #define BFUSB_MAX_BULK_RX 2
79 struct usb_device
*udev
;
81 unsigned int bulk_in_ep
;
82 unsigned int bulk_out_ep
;
83 unsigned int bulk_pkt_size
;
87 struct sk_buff_head transmit_q
;
89 struct sk_buff
*reassembly
;
92 struct sk_buff_head pending_q
;
93 struct sk_buff_head completed_q
;
100 static void bfusb_tx_complete(struct urb
*urb
, struct pt_regs
*regs
);
101 static void bfusb_rx_complete(struct urb
*urb
, struct pt_regs
*regs
);
103 static struct urb
*bfusb_get_completed(struct bfusb
*bfusb
)
106 struct urb
*urb
= NULL
;
108 BT_DBG("bfusb %p", bfusb
);
110 skb
= skb_dequeue(&bfusb
->completed_q
);
112 urb
= ((struct bfusb_scb
*) skb
->cb
)->urb
;
119 static void bfusb_unlink_urbs(struct bfusb
*bfusb
)
124 BT_DBG("bfusb %p", bfusb
);
126 while ((skb
= skb_dequeue(&bfusb
->pending_q
))) {
127 urb
= ((struct bfusb_scb
*) skb
->cb
)->urb
;
129 skb_queue_tail(&bfusb
->completed_q
, skb
);
132 while ((urb
= bfusb_get_completed(bfusb
)))
137 static int bfusb_send_bulk(struct bfusb
*bfusb
, struct sk_buff
*skb
)
139 struct bfusb_scb
*scb
= (void *) skb
->cb
;
140 struct urb
*urb
= bfusb_get_completed(bfusb
);
143 BT_DBG("bfusb %p skb %p len %d", bfusb
, skb
, skb
->len
);
145 if (!urb
&& !(urb
= usb_alloc_urb(0, GFP_ATOMIC
)))
148 pipe
= usb_sndbulkpipe(bfusb
->udev
, bfusb
->bulk_out_ep
);
150 usb_fill_bulk_urb(urb
, bfusb
->udev
, pipe
, skb
->data
, skb
->len
,
151 bfusb_tx_complete
, skb
);
155 skb_queue_tail(&bfusb
->pending_q
, skb
);
157 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
159 BT_ERR("%s bulk tx submit failed urb %p err %d",
160 bfusb
->hdev
->name
, urb
, err
);
161 skb_unlink(skb
, &bfusb
->pending_q
);
164 atomic_inc(&bfusb
->pending_tx
);
169 static void bfusb_tx_wakeup(struct bfusb
*bfusb
)
173 BT_DBG("bfusb %p", bfusb
);
175 if (test_and_set_bit(BFUSB_TX_PROCESS
, &bfusb
->state
)) {
176 set_bit(BFUSB_TX_WAKEUP
, &bfusb
->state
);
181 clear_bit(BFUSB_TX_WAKEUP
, &bfusb
->state
);
183 while ((atomic_read(&bfusb
->pending_tx
) < BFUSB_MAX_BULK_TX
) &&
184 (skb
= skb_dequeue(&bfusb
->transmit_q
))) {
185 if (bfusb_send_bulk(bfusb
, skb
) < 0) {
186 skb_queue_head(&bfusb
->transmit_q
, skb
);
191 } while (test_bit(BFUSB_TX_WAKEUP
, &bfusb
->state
));
193 clear_bit(BFUSB_TX_PROCESS
, &bfusb
->state
);
196 static void bfusb_tx_complete(struct urb
*urb
, struct pt_regs
*regs
)
198 struct sk_buff
*skb
= (struct sk_buff
*) urb
->context
;
199 struct bfusb
*bfusb
= (struct bfusb
*) skb
->dev
;
201 BT_DBG("bfusb %p urb %p skb %p len %d", bfusb
, urb
, skb
, skb
->len
);
203 atomic_dec(&bfusb
->pending_tx
);
205 if (!test_bit(HCI_RUNNING
, &bfusb
->hdev
->flags
))
209 bfusb
->hdev
->stat
.byte_tx
+= skb
->len
;
211 bfusb
->hdev
->stat
.err_tx
++;
213 read_lock(&bfusb
->lock
);
215 skb_unlink(skb
, &bfusb
->pending_q
);
216 skb_queue_tail(&bfusb
->completed_q
, skb
);
218 bfusb_tx_wakeup(bfusb
);
220 read_unlock(&bfusb
->lock
);
224 static int bfusb_rx_submit(struct bfusb
*bfusb
, struct urb
*urb
)
226 struct bfusb_scb
*scb
;
228 int err
, pipe
, size
= HCI_MAX_FRAME_SIZE
+ 32;
230 BT_DBG("bfusb %p urb %p", bfusb
, urb
);
232 if (!urb
&& !(urb
= usb_alloc_urb(0, GFP_ATOMIC
)))
235 if (!(skb
= bt_skb_alloc(size
, GFP_ATOMIC
))) {
240 skb
->dev
= (void *) bfusb
;
242 scb
= (struct bfusb_scb
*) skb
->cb
;
245 pipe
= usb_rcvbulkpipe(bfusb
->udev
, bfusb
->bulk_in_ep
);
247 usb_fill_bulk_urb(urb
, bfusb
->udev
, pipe
, skb
->data
, size
,
248 bfusb_rx_complete
, skb
);
250 skb_queue_tail(&bfusb
->pending_q
, skb
);
252 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
254 BT_ERR("%s bulk rx submit failed urb %p err %d",
255 bfusb
->hdev
->name
, urb
, err
);
256 skb_unlink(skb
, &bfusb
->pending_q
);
264 static inline int bfusb_recv_block(struct bfusb
*bfusb
, int hdr
, unsigned char *data
, int len
)
266 BT_DBG("bfusb %p hdr 0x%02x data %p len %d", bfusb
, hdr
, data
, len
);
269 BT_ERR("%s error in block", bfusb
->hdev
->name
);
270 if (bfusb
->reassembly
)
271 kfree_skb(bfusb
->reassembly
);
272 bfusb
->reassembly
= NULL
;
278 unsigned char pkt_type
;
281 if (bfusb
->reassembly
) {
282 BT_ERR("%s unexpected start block", bfusb
->hdev
->name
);
283 kfree_skb(bfusb
->reassembly
);
284 bfusb
->reassembly
= NULL
;
288 BT_ERR("%s no packet type found", bfusb
->hdev
->name
);
292 pkt_type
= *data
++; len
--;
296 if (len
>= HCI_EVENT_HDR_SIZE
) {
297 struct hci_event_hdr
*hdr
= (struct hci_event_hdr
*) data
;
298 pkt_len
= HCI_EVENT_HDR_SIZE
+ hdr
->plen
;
300 BT_ERR("%s event block is too short", bfusb
->hdev
->name
);
305 case HCI_ACLDATA_PKT
:
306 if (len
>= HCI_ACL_HDR_SIZE
) {
307 struct hci_acl_hdr
*hdr
= (struct hci_acl_hdr
*) data
;
308 pkt_len
= HCI_ACL_HDR_SIZE
+ __le16_to_cpu(hdr
->dlen
);
310 BT_ERR("%s data block is too short", bfusb
->hdev
->name
);
315 case HCI_SCODATA_PKT
:
316 if (len
>= HCI_SCO_HDR_SIZE
) {
317 struct hci_sco_hdr
*hdr
= (struct hci_sco_hdr
*) data
;
318 pkt_len
= HCI_SCO_HDR_SIZE
+ hdr
->dlen
;
320 BT_ERR("%s audio block is too short", bfusb
->hdev
->name
);
326 skb
= bt_skb_alloc(pkt_len
, GFP_ATOMIC
);
328 BT_ERR("%s no memory for the packet", bfusb
->hdev
->name
);
332 skb
->dev
= (void *) bfusb
->hdev
;
333 bt_cb(skb
)->pkt_type
= pkt_type
;
335 bfusb
->reassembly
= skb
;
337 if (!bfusb
->reassembly
) {
338 BT_ERR("%s unexpected continuation block", bfusb
->hdev
->name
);
344 memcpy(skb_put(bfusb
->reassembly
, len
), data
, len
);
347 hci_recv_frame(bfusb
->reassembly
);
348 bfusb
->reassembly
= NULL
;
354 static void bfusb_rx_complete(struct urb
*urb
, struct pt_regs
*regs
)
356 struct sk_buff
*skb
= (struct sk_buff
*) urb
->context
;
357 struct bfusb
*bfusb
= (struct bfusb
*) skb
->dev
;
358 unsigned char *buf
= urb
->transfer_buffer
;
359 int count
= urb
->actual_length
;
362 BT_DBG("bfusb %p urb %p skb %p len %d", bfusb
, urb
, skb
, skb
->len
);
364 read_lock(&bfusb
->lock
);
366 if (!test_bit(HCI_RUNNING
, &bfusb
->hdev
->flags
))
369 if (urb
->status
|| !count
)
372 bfusb
->hdev
->stat
.byte_rx
+= count
;
377 hdr
= buf
[0] | (buf
[1] << 8);
384 len
= (buf
[2] == 0) ? 256 : buf
[2];
390 BT_ERR("%s block extends over URB buffer ranges",
394 if ((hdr
& 0xe1) == 0xc1)
395 bfusb_recv_block(bfusb
, hdr
, buf
, len
);
401 skb_unlink(skb
, &bfusb
->pending_q
);
404 bfusb_rx_submit(bfusb
, urb
);
406 read_unlock(&bfusb
->lock
);
411 urb
->dev
= bfusb
->udev
;
413 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
415 BT_ERR("%s bulk resubmit failed urb %p err %d",
416 bfusb
->hdev
->name
, urb
, err
);
420 read_unlock(&bfusb
->lock
);
424 static int bfusb_open(struct hci_dev
*hdev
)
426 struct bfusb
*bfusb
= (struct bfusb
*) hdev
->driver_data
;
430 BT_DBG("hdev %p bfusb %p", hdev
, bfusb
);
432 if (test_and_set_bit(HCI_RUNNING
, &hdev
->flags
))
435 write_lock_irqsave(&bfusb
->lock
, flags
);
437 err
= bfusb_rx_submit(bfusb
, NULL
);
439 for (i
= 1; i
< BFUSB_MAX_BULK_RX
; i
++)
440 bfusb_rx_submit(bfusb
, NULL
);
442 clear_bit(HCI_RUNNING
, &hdev
->flags
);
445 write_unlock_irqrestore(&bfusb
->lock
, flags
);
450 static int bfusb_flush(struct hci_dev
*hdev
)
452 struct bfusb
*bfusb
= (struct bfusb
*) hdev
->driver_data
;
454 BT_DBG("hdev %p bfusb %p", hdev
, bfusb
);
456 skb_queue_purge(&bfusb
->transmit_q
);
461 static int bfusb_close(struct hci_dev
*hdev
)
463 struct bfusb
*bfusb
= (struct bfusb
*) hdev
->driver_data
;
466 BT_DBG("hdev %p bfusb %p", hdev
, bfusb
);
468 if (!test_and_clear_bit(HCI_RUNNING
, &hdev
->flags
))
471 write_lock_irqsave(&bfusb
->lock
, flags
);
472 write_unlock_irqrestore(&bfusb
->lock
, flags
);
474 bfusb_unlink_urbs(bfusb
);
480 static int bfusb_send_frame(struct sk_buff
*skb
)
482 struct hci_dev
*hdev
= (struct hci_dev
*) skb
->dev
;
484 struct sk_buff
*nskb
;
485 unsigned char buf
[3];
486 int sent
= 0, size
, count
;
488 BT_DBG("hdev %p skb %p type %d len %d", hdev
, skb
, bt_cb(skb
)->pkt_type
, skb
->len
);
491 BT_ERR("Frame for unknown HCI device (hdev=NULL)");
495 if (!test_bit(HCI_RUNNING
, &hdev
->flags
))
498 bfusb
= (struct bfusb
*) hdev
->driver_data
;
500 switch (bt_cb(skb
)->pkt_type
) {
501 case HCI_COMMAND_PKT
:
504 case HCI_ACLDATA_PKT
:
507 case HCI_SCODATA_PKT
:
512 /* Prepend skb with frame type */
513 memcpy(skb_push(skb
, 1), &bt_cb(skb
)->pkt_type
, 1);
517 /* Max HCI frame size seems to be 1511 + 1 */
518 if (!(nskb
= bt_skb_alloc(count
+ 32, GFP_ATOMIC
))) {
519 BT_ERR("Can't allocate memory for new packet");
523 nskb
->dev
= (void *) bfusb
;
526 size
= min_t(uint
, count
, BFUSB_MAX_BLOCK_SIZE
);
528 buf
[0] = 0xc1 | ((sent
== 0) ? 0x04 : 0) | ((count
== size
) ? 0x08 : 0);
530 buf
[2] = (size
== BFUSB_MAX_BLOCK_SIZE
) ? 0 : size
;
532 memcpy(skb_put(nskb
, 3), buf
, 3);
533 memcpy(skb_put(nskb
, size
), skb
->data
+ sent
, size
);
539 /* Don't send frame with multiple size of bulk max packet */
540 if ((nskb
->len
% bfusb
->bulk_pkt_size
) == 0) {
543 memcpy(skb_put(nskb
, 2), buf
, 2);
546 read_lock(&bfusb
->lock
);
548 skb_queue_tail(&bfusb
->transmit_q
, nskb
);
549 bfusb_tx_wakeup(bfusb
);
551 read_unlock(&bfusb
->lock
);
558 static void bfusb_destruct(struct hci_dev
*hdev
)
560 struct bfusb
*bfusb
= (struct bfusb
*) hdev
->driver_data
;
562 BT_DBG("hdev %p bfusb %p", hdev
, bfusb
);
567 static int bfusb_ioctl(struct hci_dev
*hdev
, unsigned int cmd
, unsigned long arg
)
573 static int bfusb_load_firmware(struct bfusb
*bfusb
, unsigned char *firmware
, int count
)
576 int err
, pipe
, len
, size
, sent
= 0;
578 BT_DBG("bfusb %p udev %p", bfusb
, bfusb
->udev
);
580 BT_INFO("BlueFRITZ! USB loading firmware");
582 pipe
= usb_sndctrlpipe(bfusb
->udev
, 0);
584 if (usb_control_msg(bfusb
->udev
, pipe
, USB_REQ_SET_CONFIGURATION
,
585 0, 1, 0, NULL
, 0, USB_CTRL_SET_TIMEOUT
) < 0) {
586 BT_ERR("Can't change to loading configuration");
590 bfusb
->udev
->toggle
[0] = bfusb
->udev
->toggle
[1] = 0;
592 buf
= kmalloc(BFUSB_MAX_BLOCK_SIZE
+ 3, GFP_ATOMIC
);
594 BT_ERR("Can't allocate memory chunk for firmware");
598 pipe
= usb_sndbulkpipe(bfusb
->udev
, bfusb
->bulk_out_ep
);
601 size
= min_t(uint
, count
, BFUSB_MAX_BLOCK_SIZE
+ 3);
603 memcpy(buf
, firmware
+ sent
, size
);
605 err
= usb_bulk_msg(bfusb
->udev
, pipe
, buf
, size
,
606 &len
, BFUSB_BLOCK_TIMEOUT
);
608 if (err
|| (len
!= size
)) {
609 BT_ERR("Error in firmware loading");
617 if ((err
= usb_bulk_msg(bfusb
->udev
, pipe
, NULL
, 0,
618 &len
, BFUSB_BLOCK_TIMEOUT
)) < 0) {
619 BT_ERR("Error in null packet request");
623 pipe
= usb_sndctrlpipe(bfusb
->udev
, 0);
625 if ((err
= usb_control_msg(bfusb
->udev
, pipe
, USB_REQ_SET_CONFIGURATION
,
626 0, 2, 0, NULL
, 0, USB_CTRL_SET_TIMEOUT
)) < 0) {
627 BT_ERR("Can't change to running configuration");
631 bfusb
->udev
->toggle
[0] = bfusb
->udev
->toggle
[1] = 0;
633 BT_INFO("BlueFRITZ! USB device ready");
641 pipe
= usb_sndctrlpipe(bfusb
->udev
, 0);
643 usb_control_msg(bfusb
->udev
, pipe
, USB_REQ_SET_CONFIGURATION
,
644 0, 0, 0, NULL
, 0, USB_CTRL_SET_TIMEOUT
);
649 static int bfusb_probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
651 const struct firmware
*firmware
;
652 struct usb_device
*udev
= interface_to_usbdev(intf
);
653 struct usb_host_endpoint
*bulk_out_ep
;
654 struct usb_host_endpoint
*bulk_in_ep
;
655 struct hci_dev
*hdev
;
658 BT_DBG("intf %p id %p", intf
, id
);
663 /* Check number of endpoints */
664 if (intf
->cur_altsetting
->desc
.bNumEndpoints
< 2)
667 bulk_out_ep
= &intf
->cur_altsetting
->endpoint
[0];
668 bulk_in_ep
= &intf
->cur_altsetting
->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
= kzalloc(sizeof(struct bfusb
), GFP_KERNEL
))) {
677 BT_ERR("Can't allocate memory for control structure");
682 bfusb
->bulk_in_ep
= bulk_in_ep
->desc
.bEndpointAddress
;
683 bfusb
->bulk_out_ep
= bulk_out_ep
->desc
.bEndpointAddress
;
684 bfusb
->bulk_pkt_size
= le16_to_cpu(bulk_out_ep
->desc
.wMaxPacketSize
);
686 rwlock_init(&bfusb
->lock
);
688 bfusb
->reassembly
= NULL
;
690 skb_queue_head_init(&bfusb
->transmit_q
);
691 skb_queue_head_init(&bfusb
->pending_q
);
692 skb_queue_head_init(&bfusb
->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(bfusb
, 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
= bfusb
;
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
, bfusb
);
741 release_firmware(firmware
);
750 static void bfusb_disconnect(struct usb_interface
*intf
)
752 struct bfusb
*bfusb
= usb_get_intfdata(intf
);
753 struct hci_dev
*hdev
= bfusb
->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 if ((err
= usb_register(&bfusb_driver
)) < 0)
784 BT_ERR("Failed to register BlueFRITZ! USB driver");
789 static void __exit
bfusb_exit(void)
791 usb_deregister(&bfusb_driver
);
794 module_init(bfusb_init
);
795 module_exit(bfusb_exit
);
797 module_param(ignore
, bool, 0644);
798 MODULE_PARM_DESC(ignore
, "Ignore devices from the matching table");
800 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
801 MODULE_DESCRIPTION("BlueFRITZ! USB driver ver " VERSION
);
802 MODULE_VERSION(VERSION
);
803 MODULE_LICENSE("GPL");