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 const 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
);
135 urb
= usb_alloc_urb(0, GFP_ATOMIC
);
140 pipe
= usb_sndbulkpipe(data
->udev
, data
->bulk_out_ep
);
142 usb_fill_bulk_urb(urb
, data
->udev
, pipe
, skb
->data
, skb
->len
,
143 bfusb_tx_complete
, skb
);
147 skb_queue_tail(&data
->pending_q
, skb
);
149 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
151 BT_ERR("%s bulk tx submit failed urb %p err %d",
152 data
->hdev
->name
, urb
, err
);
153 skb_unlink(skb
, &data
->pending_q
);
156 atomic_inc(&data
->pending_tx
);
161 static void bfusb_tx_wakeup(struct bfusb_data
*data
)
165 BT_DBG("bfusb %p", data
);
167 if (test_and_set_bit(BFUSB_TX_PROCESS
, &data
->state
)) {
168 set_bit(BFUSB_TX_WAKEUP
, &data
->state
);
173 clear_bit(BFUSB_TX_WAKEUP
, &data
->state
);
175 while ((atomic_read(&data
->pending_tx
) < BFUSB_MAX_BULK_TX
) &&
176 (skb
= skb_dequeue(&data
->transmit_q
))) {
177 if (bfusb_send_bulk(data
, skb
) < 0) {
178 skb_queue_head(&data
->transmit_q
, skb
);
183 } while (test_bit(BFUSB_TX_WAKEUP
, &data
->state
));
185 clear_bit(BFUSB_TX_PROCESS
, &data
->state
);
188 static void bfusb_tx_complete(struct urb
*urb
)
190 struct sk_buff
*skb
= (struct sk_buff
*) urb
->context
;
191 struct bfusb_data
*data
= (struct bfusb_data
*) skb
->dev
;
193 BT_DBG("bfusb %p urb %p skb %p len %d", data
, urb
, skb
, skb
->len
);
195 atomic_dec(&data
->pending_tx
);
197 if (!test_bit(HCI_RUNNING
, &data
->hdev
->flags
))
201 data
->hdev
->stat
.byte_tx
+= skb
->len
;
203 data
->hdev
->stat
.err_tx
++;
205 read_lock(&data
->lock
);
207 skb_unlink(skb
, &data
->pending_q
);
208 skb_queue_tail(&data
->completed_q
, skb
);
210 bfusb_tx_wakeup(data
);
212 read_unlock(&data
->lock
);
216 static int bfusb_rx_submit(struct bfusb_data
*data
, struct urb
*urb
)
218 struct bfusb_data_scb
*scb
;
220 int err
, pipe
, size
= HCI_MAX_FRAME_SIZE
+ 32;
222 BT_DBG("bfusb %p urb %p", data
, urb
);
225 urb
= usb_alloc_urb(0, GFP_ATOMIC
);
230 skb
= bt_skb_alloc(size
, GFP_ATOMIC
);
236 skb
->dev
= (void *) data
;
238 scb
= (struct bfusb_data_scb
*) skb
->cb
;
241 pipe
= usb_rcvbulkpipe(data
->udev
, data
->bulk_in_ep
);
243 usb_fill_bulk_urb(urb
, data
->udev
, pipe
, skb
->data
, size
,
244 bfusb_rx_complete
, skb
);
246 skb_queue_tail(&data
->pending_q
, skb
);
248 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
250 BT_ERR("%s bulk rx submit failed urb %p err %d",
251 data
->hdev
->name
, urb
, err
);
252 skb_unlink(skb
, &data
->pending_q
);
260 static inline int bfusb_recv_block(struct bfusb_data
*data
, int hdr
, unsigned char *buf
, int len
)
262 BT_DBG("bfusb %p hdr 0x%02x data %p len %d", data
, hdr
, buf
, len
);
265 BT_ERR("%s error in block", data
->hdev
->name
);
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 bt_cb(skb
)->pkt_type
= pkt_type
;
329 data
->reassembly
= skb
;
331 if (!data
->reassembly
) {
332 BT_ERR("%s unexpected continuation block", data
->hdev
->name
);
338 memcpy(skb_put(data
->reassembly
, len
), buf
, len
);
341 hci_recv_frame(data
->hdev
, data
->reassembly
);
342 data
->reassembly
= NULL
;
348 static void bfusb_rx_complete(struct urb
*urb
)
350 struct sk_buff
*skb
= (struct sk_buff
*) urb
->context
;
351 struct bfusb_data
*data
= (struct bfusb_data
*) skb
->dev
;
352 unsigned char *buf
= urb
->transfer_buffer
;
353 int count
= urb
->actual_length
;
356 BT_DBG("bfusb %p urb %p skb %p len %d", data
, urb
, skb
, skb
->len
);
358 read_lock(&data
->lock
);
360 if (!test_bit(HCI_RUNNING
, &data
->hdev
->flags
))
363 if (urb
->status
|| !count
)
366 data
->hdev
->stat
.byte_rx
+= count
;
371 hdr
= buf
[0] | (buf
[1] << 8);
378 len
= (buf
[2] == 0) ? 256 : buf
[2];
384 BT_ERR("%s block extends over URB buffer ranges",
388 if ((hdr
& 0xe1) == 0xc1)
389 bfusb_recv_block(data
, hdr
, buf
, len
);
395 skb_unlink(skb
, &data
->pending_q
);
398 bfusb_rx_submit(data
, urb
);
400 read_unlock(&data
->lock
);
405 urb
->dev
= data
->udev
;
407 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
409 BT_ERR("%s bulk resubmit failed urb %p err %d",
410 data
->hdev
->name
, urb
, err
);
414 read_unlock(&data
->lock
);
417 static int bfusb_open(struct hci_dev
*hdev
)
419 struct bfusb_data
*data
= hci_get_drvdata(hdev
);
423 BT_DBG("hdev %p bfusb %p", hdev
, data
);
425 write_lock_irqsave(&data
->lock
, flags
);
427 err
= bfusb_rx_submit(data
, NULL
);
429 for (i
= 1; i
< BFUSB_MAX_BULK_RX
; i
++)
430 bfusb_rx_submit(data
, NULL
);
433 write_unlock_irqrestore(&data
->lock
, flags
);
438 static int bfusb_flush(struct hci_dev
*hdev
)
440 struct bfusb_data
*data
= hci_get_drvdata(hdev
);
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
= hci_get_drvdata(hdev
);
454 BT_DBG("hdev %p bfusb %p", hdev
, data
);
456 write_lock_irqsave(&data
->lock
, flags
);
457 write_unlock_irqrestore(&data
->lock
, flags
);
459 bfusb_unlink_urbs(data
);
465 static int bfusb_send_frame(struct hci_dev
*hdev
, struct sk_buff
*skb
)
467 struct bfusb_data
*data
= hci_get_drvdata(hdev
);
468 struct sk_buff
*nskb
;
469 unsigned char buf
[3];
470 int sent
= 0, size
, count
;
472 BT_DBG("hdev %p skb %p type %d len %d", hdev
, skb
, bt_cb(skb
)->pkt_type
, skb
->len
);
474 switch (bt_cb(skb
)->pkt_type
) {
475 case HCI_COMMAND_PKT
:
478 case HCI_ACLDATA_PKT
:
481 case HCI_SCODATA_PKT
:
486 /* Prepend skb with frame type */
487 memcpy(skb_push(skb
, 1), &bt_cb(skb
)->pkt_type
, 1);
491 /* Max HCI frame size seems to be 1511 + 1 */
492 nskb
= bt_skb_alloc(count
+ 32, GFP_ATOMIC
);
494 BT_ERR("Can't allocate memory for new packet");
498 nskb
->dev
= (void *) data
;
501 size
= min_t(uint
, count
, BFUSB_MAX_BLOCK_SIZE
);
503 buf
[0] = 0xc1 | ((sent
== 0) ? 0x04 : 0) | ((count
== size
) ? 0x08 : 0);
505 buf
[2] = (size
== BFUSB_MAX_BLOCK_SIZE
) ? 0 : size
;
507 memcpy(skb_put(nskb
, 3), buf
, 3);
508 skb_copy_from_linear_data_offset(skb
, sent
, skb_put(nskb
, size
), size
);
514 /* Don't send frame with multiple size of bulk max packet */
515 if ((nskb
->len
% data
->bulk_pkt_size
) == 0) {
518 memcpy(skb_put(nskb
, 2), buf
, 2);
521 read_lock(&data
->lock
);
523 skb_queue_tail(&data
->transmit_q
, nskb
);
524 bfusb_tx_wakeup(data
);
526 read_unlock(&data
->lock
);
533 static int bfusb_load_firmware(struct bfusb_data
*data
,
534 const unsigned char *firmware
, int count
)
537 int err
, pipe
, len
, size
, sent
= 0;
539 BT_DBG("bfusb %p udev %p", data
, data
->udev
);
541 BT_INFO("BlueFRITZ! USB loading firmware");
543 buf
= kmalloc(BFUSB_MAX_BLOCK_SIZE
+ 3, GFP_KERNEL
);
545 BT_ERR("Can't allocate memory chunk for firmware");
549 pipe
= usb_sndctrlpipe(data
->udev
, 0);
551 if (usb_control_msg(data
->udev
, pipe
, USB_REQ_SET_CONFIGURATION
,
552 0, 1, 0, NULL
, 0, USB_CTRL_SET_TIMEOUT
) < 0) {
553 BT_ERR("Can't change to loading configuration");
558 data
->udev
->toggle
[0] = data
->udev
->toggle
[1] = 0;
560 pipe
= usb_sndbulkpipe(data
->udev
, data
->bulk_out_ep
);
563 size
= min_t(uint
, count
, BFUSB_MAX_BLOCK_SIZE
+ 3);
565 memcpy(buf
, firmware
+ sent
, size
);
567 err
= usb_bulk_msg(data
->udev
, pipe
, buf
, size
,
568 &len
, BFUSB_BLOCK_TIMEOUT
);
570 if (err
|| (len
!= size
)) {
571 BT_ERR("Error in firmware loading");
579 err
= usb_bulk_msg(data
->udev
, pipe
, NULL
, 0,
580 &len
, BFUSB_BLOCK_TIMEOUT
);
582 BT_ERR("Error in null packet request");
586 pipe
= usb_sndctrlpipe(data
->udev
, 0);
588 err
= usb_control_msg(data
->udev
, pipe
, USB_REQ_SET_CONFIGURATION
,
589 0, 2, 0, NULL
, 0, USB_CTRL_SET_TIMEOUT
);
591 BT_ERR("Can't change to running configuration");
595 data
->udev
->toggle
[0] = data
->udev
->toggle
[1] = 0;
597 BT_INFO("BlueFRITZ! USB device ready");
605 pipe
= usb_sndctrlpipe(data
->udev
, 0);
607 usb_control_msg(data
->udev
, pipe
, USB_REQ_SET_CONFIGURATION
,
608 0, 0, 0, NULL
, 0, USB_CTRL_SET_TIMEOUT
);
613 static int bfusb_probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
615 const struct firmware
*firmware
;
616 struct usb_device
*udev
= interface_to_usbdev(intf
);
617 struct usb_host_endpoint
*bulk_out_ep
;
618 struct usb_host_endpoint
*bulk_in_ep
;
619 struct hci_dev
*hdev
;
620 struct bfusb_data
*data
;
622 BT_DBG("intf %p id %p", intf
, id
);
624 /* Check number of endpoints */
625 if (intf
->cur_altsetting
->desc
.bNumEndpoints
< 2)
628 bulk_out_ep
= &intf
->cur_altsetting
->endpoint
[0];
629 bulk_in_ep
= &intf
->cur_altsetting
->endpoint
[1];
631 if (!bulk_out_ep
|| !bulk_in_ep
) {
632 BT_ERR("Bulk endpoints not found");
636 /* Initialize control structure and load firmware */
637 data
= devm_kzalloc(&intf
->dev
, sizeof(struct bfusb_data
), GFP_KERNEL
);
639 BT_ERR("Can't allocate memory for control structure");
644 data
->bulk_in_ep
= bulk_in_ep
->desc
.bEndpointAddress
;
645 data
->bulk_out_ep
= bulk_out_ep
->desc
.bEndpointAddress
;
646 data
->bulk_pkt_size
= le16_to_cpu(bulk_out_ep
->desc
.wMaxPacketSize
);
648 rwlock_init(&data
->lock
);
650 data
->reassembly
= NULL
;
652 skb_queue_head_init(&data
->transmit_q
);
653 skb_queue_head_init(&data
->pending_q
);
654 skb_queue_head_init(&data
->completed_q
);
656 if (request_firmware(&firmware
, "bfubase.frm", &udev
->dev
) < 0) {
657 BT_ERR("Firmware request failed");
661 BT_DBG("firmware data %p size %zu", firmware
->data
, firmware
->size
);
663 if (bfusb_load_firmware(data
, firmware
->data
, firmware
->size
) < 0) {
664 BT_ERR("Firmware loading failed");
668 release_firmware(firmware
);
670 /* Initialize and register HCI device */
671 hdev
= hci_alloc_dev();
673 BT_ERR("Can't allocate HCI device");
680 hci_set_drvdata(hdev
, data
);
681 SET_HCIDEV_DEV(hdev
, &intf
->dev
);
683 hdev
->open
= bfusb_open
;
684 hdev
->close
= bfusb_close
;
685 hdev
->flush
= bfusb_flush
;
686 hdev
->send
= bfusb_send_frame
;
688 set_bit(HCI_QUIRK_BROKEN_LOCAL_COMMANDS
, &hdev
->quirks
);
690 if (hci_register_dev(hdev
) < 0) {
691 BT_ERR("Can't register HCI device");
696 usb_set_intfdata(intf
, data
);
701 release_firmware(firmware
);
707 static void bfusb_disconnect(struct usb_interface
*intf
)
709 struct bfusb_data
*data
= usb_get_intfdata(intf
);
710 struct hci_dev
*hdev
= data
->hdev
;
712 BT_DBG("intf %p", intf
);
717 usb_set_intfdata(intf
, NULL
);
721 hci_unregister_dev(hdev
);
725 static struct usb_driver bfusb_driver
= {
727 .probe
= bfusb_probe
,
728 .disconnect
= bfusb_disconnect
,
729 .id_table
= bfusb_table
,
730 .disable_hub_initiated_lpm
= 1,
733 module_usb_driver(bfusb_driver
);
735 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
736 MODULE_DESCRIPTION("BlueFRITZ! USB driver ver " VERSION
);
737 MODULE_VERSION(VERSION
);
738 MODULE_LICENSE("GPL");
739 MODULE_FIRMWARE("bfubase.frm");