spi: fix spi.h kernel-doc warning
[linux-2.6/libata-dev.git] / drivers / bluetooth / bfusb.c
blobb8ac1c549a1c75507700c8f608f844233314ea7e
1 /*
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 #define VERSION "1.2"
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
64 struct bfusb_data {
65 struct hci_dev *hdev;
67 unsigned long state;
69 struct usb_device *udev;
71 unsigned int bulk_in_ep;
72 unsigned int bulk_out_ep;
73 unsigned int bulk_pkt_size;
75 rwlock_t lock;
77 struct sk_buff_head transmit_q;
79 struct sk_buff *reassembly;
81 atomic_t pending_tx;
82 struct sk_buff_head pending_q;
83 struct sk_buff_head completed_q;
86 struct bfusb_data_scb {
87 struct urb *urb;
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)
95 struct sk_buff *skb;
96 struct urb *urb = NULL;
98 BT_DBG("bfusb %p", data);
100 skb = skb_dequeue(&data->completed_q);
101 if (skb) {
102 urb = ((struct bfusb_data_scb *) skb->cb)->urb;
103 kfree_skb(skb);
106 return urb;
109 static void bfusb_unlink_urbs(struct bfusb_data *data)
111 struct sk_buff *skb;
112 struct urb *urb;
114 BT_DBG("bfusb %p", data);
116 while ((skb = skb_dequeue(&data->pending_q))) {
117 urb = ((struct bfusb_data_scb *) skb->cb)->urb;
118 usb_kill_urb(urb);
119 skb_queue_tail(&data->completed_q, skb);
122 while ((urb = bfusb_get_completed(data)))
123 usb_free_urb(urb);
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);
130 int err, pipe;
132 BT_DBG("bfusb %p skb %p len %d", data, skb, skb->len);
134 if (!urb && !(urb = usb_alloc_urb(0, GFP_ATOMIC)))
135 return -ENOMEM;
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);
142 scb->urb = urb;
144 skb_queue_tail(&data->pending_q, skb);
146 err = usb_submit_urb(urb, GFP_ATOMIC);
147 if (err) {
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);
151 usb_free_urb(urb);
152 } else
153 atomic_inc(&data->pending_tx);
155 return err;
158 static void bfusb_tx_wakeup(struct bfusb_data *data)
160 struct sk_buff *skb;
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);
166 return;
169 do {
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);
176 break;
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))
195 return;
197 if (!urb->status)
198 data->hdev->stat.byte_tx += skb->len;
199 else
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;
216 struct sk_buff *skb;
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)))
222 return -ENOMEM;
224 skb = bt_skb_alloc(size, GFP_ATOMIC);
225 if (!skb) {
226 usb_free_urb(urb);
227 return -ENOMEM;
230 skb->dev = (void *) data;
232 scb = (struct bfusb_data_scb *) skb->cb;
233 scb->urb = urb;
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);
243 if (err) {
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);
247 kfree_skb(skb);
248 usb_free_urb(urb);
251 return err;
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);
258 if (hdr & 0x10) {
259 BT_ERR("%s error in block", data->hdev->name);
260 kfree_skb(data->reassembly);
261 data->reassembly = NULL;
262 return -EIO;
265 if (hdr & 0x04) {
266 struct sk_buff *skb;
267 unsigned char pkt_type;
268 int pkt_len = 0;
270 if (data->reassembly) {
271 BT_ERR("%s unexpected start block", data->hdev->name);
272 kfree_skb(data->reassembly);
273 data->reassembly = NULL;
276 if (len < 1) {
277 BT_ERR("%s no packet type found", data->hdev->name);
278 return -EPROTO;
281 pkt_type = *buf++; len--;
283 switch (pkt_type) {
284 case HCI_EVENT_PKT:
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;
288 } else {
289 BT_ERR("%s event block is too short", data->hdev->name);
290 return -EILSEQ;
292 break;
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);
298 } else {
299 BT_ERR("%s data block is too short", data->hdev->name);
300 return -EILSEQ;
302 break;
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;
308 } else {
309 BT_ERR("%s audio block is too short", data->hdev->name);
310 return -EILSEQ;
312 break;
315 skb = bt_skb_alloc(pkt_len, GFP_ATOMIC);
316 if (!skb) {
317 BT_ERR("%s no memory for the packet", data->hdev->name);
318 return -ENOMEM;
321 skb->dev = (void *) data->hdev;
322 bt_cb(skb)->pkt_type = pkt_type;
324 data->reassembly = skb;
325 } else {
326 if (!data->reassembly) {
327 BT_ERR("%s unexpected continuation block", data->hdev->name);
328 return -EIO;
332 if (len > 0)
333 memcpy(skb_put(data->reassembly, len), buf, len);
335 if (hdr & 0x08) {
336 hci_recv_frame(data->reassembly);
337 data->reassembly = NULL;
340 return 0;
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;
349 int err, hdr, len;
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))
356 goto unlock;
358 if (urb->status || !count)
359 goto resubmit;
361 data->hdev->stat.byte_rx += count;
363 skb_put(skb, count);
365 while (count) {
366 hdr = buf[0] | (buf[1] << 8);
368 if (hdr & 0x4000) {
369 len = 0;
370 count -= 2;
371 buf += 2;
372 } else {
373 len = (buf[2] == 0) ? 256 : buf[2];
374 count -= 3;
375 buf += 3;
378 if (count < len) {
379 BT_ERR("%s block extends over URB buffer ranges",
380 data->hdev->name);
383 if ((hdr & 0xe1) == 0xc1)
384 bfusb_recv_block(data, hdr, buf, len);
386 count -= len;
387 buf += len;
390 skb_unlink(skb, &data->pending_q);
391 kfree_skb(skb);
393 bfusb_rx_submit(data, urb);
395 read_unlock(&data->lock);
397 return;
399 resubmit:
400 urb->dev = data->udev;
402 err = usb_submit_urb(urb, GFP_ATOMIC);
403 if (err) {
404 BT_ERR("%s bulk resubmit failed urb %p err %d",
405 data->hdev->name, urb, err);
408 unlock:
409 read_unlock(&data->lock);
412 static int bfusb_open(struct hci_dev *hdev)
414 struct bfusb_data *data = hci_get_drvdata(hdev);
415 unsigned long flags;
416 int i, err;
418 BT_DBG("hdev %p bfusb %p", hdev, data);
420 if (test_and_set_bit(HCI_RUNNING, &hdev->flags))
421 return 0;
423 write_lock_irqsave(&data->lock, flags);
425 err = bfusb_rx_submit(data, NULL);
426 if (!err) {
427 for (i = 1; i < BFUSB_MAX_BULK_RX; i++)
428 bfusb_rx_submit(data, NULL);
429 } else {
430 clear_bit(HCI_RUNNING, &hdev->flags);
433 write_unlock_irqrestore(&data->lock, flags);
435 return err;
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);
446 return 0;
449 static int bfusb_close(struct hci_dev *hdev)
451 struct bfusb_data *data = hci_get_drvdata(hdev);
452 unsigned long flags;
454 BT_DBG("hdev %p bfusb %p", hdev, data);
456 if (!test_and_clear_bit(HCI_RUNNING, &hdev->flags))
457 return 0;
459 write_lock_irqsave(&data->lock, flags);
460 write_unlock_irqrestore(&data->lock, flags);
462 bfusb_unlink_urbs(data);
463 bfusb_flush(hdev);
465 return 0;
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);
478 if (!hdev) {
479 BT_ERR("Frame for unknown HCI device (hdev=NULL)");
480 return -ENODEV;
483 if (!test_bit(HCI_RUNNING, &hdev->flags))
484 return -EBUSY;
486 data = hci_get_drvdata(hdev);
488 switch (bt_cb(skb)->pkt_type) {
489 case HCI_COMMAND_PKT:
490 hdev->stat.cmd_tx++;
491 break;
492 case HCI_ACLDATA_PKT:
493 hdev->stat.acl_tx++;
494 break;
495 case HCI_SCODATA_PKT:
496 hdev->stat.sco_tx++;
497 break;
500 /* Prepend skb with frame type */
501 memcpy(skb_push(skb, 1), &bt_cb(skb)->pkt_type, 1);
503 count = skb->len;
505 /* Max HCI frame size seems to be 1511 + 1 */
506 nskb = bt_skb_alloc(count + 32, GFP_ATOMIC);
507 if (!nskb) {
508 BT_ERR("Can't allocate memory for new packet");
509 return -ENOMEM;
512 nskb->dev = (void *) data;
514 while (count) {
515 size = min_t(uint, count, BFUSB_MAX_BLOCK_SIZE);
517 buf[0] = 0xc1 | ((sent == 0) ? 0x04 : 0) | ((count == size) ? 0x08 : 0);
518 buf[1] = 0x00;
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);
524 sent += size;
525 count -= size;
528 /* Don't send frame with multiple size of bulk max packet */
529 if ((nskb->len % data->bulk_pkt_size) == 0) {
530 buf[0] = 0xdd;
531 buf[1] = 0x00;
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);
542 kfree_skb(skb);
544 return 0;
547 static int bfusb_ioctl(struct hci_dev *hdev, unsigned int cmd, unsigned long arg)
549 return -ENOIOCTLCMD;
552 static int bfusb_load_firmware(struct bfusb_data *data,
553 const unsigned char *firmware, int count)
555 unsigned char *buf;
556 int err, pipe, len, size, sent = 0;
558 BT_DBG("bfusb %p udev %p", data, data->udev);
560 BT_INFO("BlueFRITZ! USB loading firmware");
562 buf = kmalloc(BFUSB_MAX_BLOCK_SIZE + 3, GFP_KERNEL);
563 if (!buf) {
564 BT_ERR("Can't allocate memory chunk for firmware");
565 return -ENOMEM;
568 pipe = usb_sndctrlpipe(data->udev, 0);
570 if (usb_control_msg(data->udev, pipe, USB_REQ_SET_CONFIGURATION,
571 0, 1, 0, NULL, 0, USB_CTRL_SET_TIMEOUT) < 0) {
572 BT_ERR("Can't change to loading configuration");
573 kfree(buf);
574 return -EBUSY;
577 data->udev->toggle[0] = data->udev->toggle[1] = 0;
579 pipe = usb_sndbulkpipe(data->udev, data->bulk_out_ep);
581 while (count) {
582 size = min_t(uint, count, BFUSB_MAX_BLOCK_SIZE + 3);
584 memcpy(buf, firmware + sent, size);
586 err = usb_bulk_msg(data->udev, pipe, buf, size,
587 &len, BFUSB_BLOCK_TIMEOUT);
589 if (err || (len != size)) {
590 BT_ERR("Error in firmware loading");
591 goto error;
594 sent += size;
595 count -= size;
598 err = usb_bulk_msg(data->udev, pipe, NULL, 0,
599 &len, BFUSB_BLOCK_TIMEOUT);
600 if (err < 0) {
601 BT_ERR("Error in null packet request");
602 goto error;
605 pipe = usb_sndctrlpipe(data->udev, 0);
607 err = usb_control_msg(data->udev, pipe, USB_REQ_SET_CONFIGURATION,
608 0, 2, 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
609 if (err < 0) {
610 BT_ERR("Can't change to running configuration");
611 goto error;
614 data->udev->toggle[0] = data->udev->toggle[1] = 0;
616 BT_INFO("BlueFRITZ! USB device ready");
618 kfree(buf);
619 return 0;
621 error:
622 kfree(buf);
624 pipe = usb_sndctrlpipe(data->udev, 0);
626 usb_control_msg(data->udev, pipe, USB_REQ_SET_CONFIGURATION,
627 0, 0, 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
629 return err;
632 static int bfusb_probe(struct usb_interface *intf, const struct usb_device_id *id)
634 const struct firmware *firmware;
635 struct usb_device *udev = interface_to_usbdev(intf);
636 struct usb_host_endpoint *bulk_out_ep;
637 struct usb_host_endpoint *bulk_in_ep;
638 struct hci_dev *hdev;
639 struct bfusb_data *data;
641 BT_DBG("intf %p id %p", intf, id);
643 /* Check number of endpoints */
644 if (intf->cur_altsetting->desc.bNumEndpoints < 2)
645 return -EIO;
647 bulk_out_ep = &intf->cur_altsetting->endpoint[0];
648 bulk_in_ep = &intf->cur_altsetting->endpoint[1];
650 if (!bulk_out_ep || !bulk_in_ep) {
651 BT_ERR("Bulk endpoints not found");
652 goto done;
655 /* Initialize control structure and load firmware */
656 data = kzalloc(sizeof(struct bfusb_data), GFP_KERNEL);
657 if (!data) {
658 BT_ERR("Can't allocate memory for control structure");
659 goto done;
662 data->udev = udev;
663 data->bulk_in_ep = bulk_in_ep->desc.bEndpointAddress;
664 data->bulk_out_ep = bulk_out_ep->desc.bEndpointAddress;
665 data->bulk_pkt_size = le16_to_cpu(bulk_out_ep->desc.wMaxPacketSize);
667 rwlock_init(&data->lock);
669 data->reassembly = NULL;
671 skb_queue_head_init(&data->transmit_q);
672 skb_queue_head_init(&data->pending_q);
673 skb_queue_head_init(&data->completed_q);
675 if (request_firmware(&firmware, "bfubase.frm", &udev->dev) < 0) {
676 BT_ERR("Firmware request failed");
677 goto error;
680 BT_DBG("firmware data %p size %zu", firmware->data, firmware->size);
682 if (bfusb_load_firmware(data, firmware->data, firmware->size) < 0) {
683 BT_ERR("Firmware loading failed");
684 goto release;
687 release_firmware(firmware);
689 /* Initialize and register HCI device */
690 hdev = hci_alloc_dev();
691 if (!hdev) {
692 BT_ERR("Can't allocate HCI device");
693 goto error;
696 data->hdev = hdev;
698 hdev->bus = HCI_USB;
699 hci_set_drvdata(hdev, data);
700 SET_HCIDEV_DEV(hdev, &intf->dev);
702 hdev->open = bfusb_open;
703 hdev->close = bfusb_close;
704 hdev->flush = bfusb_flush;
705 hdev->send = bfusb_send_frame;
706 hdev->ioctl = bfusb_ioctl;
708 if (hci_register_dev(hdev) < 0) {
709 BT_ERR("Can't register HCI device");
710 hci_free_dev(hdev);
711 goto error;
714 usb_set_intfdata(intf, data);
716 return 0;
718 release:
719 release_firmware(firmware);
721 error:
722 kfree(data);
724 done:
725 return -EIO;
728 static void bfusb_disconnect(struct usb_interface *intf)
730 struct bfusb_data *data = usb_get_intfdata(intf);
731 struct hci_dev *hdev = data->hdev;
733 BT_DBG("intf %p", intf);
735 if (!hdev)
736 return;
738 usb_set_intfdata(intf, NULL);
740 bfusb_close(hdev);
742 hci_unregister_dev(hdev);
743 hci_free_dev(hdev);
744 kfree(data);
747 static struct usb_driver bfusb_driver = {
748 .name = "bfusb",
749 .probe = bfusb_probe,
750 .disconnect = bfusb_disconnect,
751 .id_table = bfusb_table,
754 module_usb_driver(bfusb_driver);
756 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
757 MODULE_DESCRIPTION("BlueFRITZ! USB driver ver " VERSION);
758 MODULE_VERSION(VERSION);
759 MODULE_LICENSE("GPL");
760 MODULE_FIRMWARE("bfubase.frm");