1 /*****************************************************************************/
4 * dabusb.c -- dab usb driver.
6 * Copyright (C) 1999 Deti Fliegl (deti@fliegl.de)
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., 675 Mass Ave, Cambridge, MA 02139, USA.
24 * $Id: dabusb.c,v 1.54 2000/07/24 21:39:39 deti Exp $
28 /*****************************************************************************/
30 #include <linux/module.h>
31 #include <linux/socket.h>
32 #include <linux/list.h>
33 #include <linux/vmalloc.h>
34 #include <linux/slab.h>
35 #include <linux/init.h>
36 #include <linux/uaccess.h>
37 #include <linux/atomic.h>
38 #include <linux/delay.h>
39 #include <linux/usb.h>
40 #include <linux/mutex.h>
41 #include <linux/firmware.h>
42 #include <linux/ihex.h>
49 #define DRIVER_VERSION "v1.54"
50 #define DRIVER_AUTHOR "Deti Fliegl, deti@fliegl.de"
51 #define DRIVER_DESC "DAB-USB Interface Driver for Linux (c)1999"
53 /* --------------------------------------------------------------------- */
55 #ifdef CONFIG_USB_DYNAMIC_MINORS
61 /*-------------------------------------------------------------------*/
63 static dabusb_t dabusb[NRDABUSB];
64 static int buffers = 256;
65 static struct usb_driver dabusb_driver;
67 /*-------------------------------------------------------------------*/
69 static int dabusb_add_buf_tail(pdabusb_t s, struct list_head *dst,
70 struct list_head *src)
73 struct list_head *tmp;
76 spin_lock_irqsave(&s->lock, flags);
78 if (list_empty(src)) {
79 /* no elements in source buffer */
84 list_move_tail(tmp, dst);
86 err: spin_unlock_irqrestore(&s->lock, flags);
89 /*-------------------------------------------------------------------*/
91 static void dump_urb(struct urb *urb)
94 dbg("dev :%p", urb->dev);
95 dbg("pipe :%08X", urb->pipe);
96 dbg("status :%d", urb->status);
97 dbg("transfer_flags :%08X", urb->transfer_flags);
98 dbg("transfer_buffer :%p", urb->transfer_buffer);
99 dbg("transfer_buffer_length:%d", urb->transfer_buffer_length);
100 dbg("actual_length :%d", urb->actual_length);
101 dbg("setup_packet :%p", urb->setup_packet);
102 dbg("start_frame :%d", urb->start_frame);
103 dbg("number_of_packets :%d", urb->number_of_packets);
104 dbg("interval :%d", urb->interval);
105 dbg("error_count :%d", urb->error_count);
106 dbg("context :%p", urb->context);
107 dbg("complete :%p", urb->complete);
110 /*-------------------------------------------------------------------*/
111 static int dabusb_cancel_queue(pdabusb_t s, struct list_head *q)
116 dbg("dabusb_cancel_queue");
118 spin_lock_irqsave(&s->lock, flags);
120 list_for_each_entry(b, q, buff_list) {
124 usb_unlink_urb(b->purb);
126 spin_unlock_irqrestore(&s->lock, flags);
129 /*-------------------------------------------------------------------*/
130 static int dabusb_free_queue(struct list_head *q)
132 struct list_head *tmp;
136 dbg("dabusb_free_queue");
137 for (p = q->next; p != q;) {
138 b = list_entry(p, buff_t, buff_list);
143 kfree(b->purb->transfer_buffer);
144 usb_free_urb(b->purb);
153 /*-------------------------------------------------------------------*/
154 static int dabusb_free_buffers(pdabusb_t s)
157 dbg("dabusb_free_buffers");
159 spin_lock_irqsave(&s->lock, flags);
161 dabusb_free_queue(&s->free_buff_list);
162 dabusb_free_queue(&s->rec_buff_list);
164 spin_unlock_irqrestore(&s->lock, flags);
169 /*-------------------------------------------------------------------*/
170 static void dabusb_iso_complete(struct urb *purb)
172 pbuff_t b = purb->context;
177 void *buf = purb->transfer_buffer;
179 dbg("dabusb_iso_complete");
181 /* process if URB was not killed */
182 if (purb->status != -ENOENT) {
183 unsigned int pipe = usb_rcvisocpipe(purb->dev, _DABUSB_ISOPIPE);
184 int pipesize = usb_maxpacket(purb->dev, pipe,
186 for (i = 0; i < purb->number_of_packets; i++)
187 if (!purb->iso_frame_desc[i].status) {
188 len = purb->iso_frame_desc[i].actual_length;
189 if (len <= pipesize) {
190 memcpy(buf + dst, buf + purb->iso_frame_desc[i].offset, len);
193 dev_err(&purb->dev->dev,
194 "dabusb_iso_complete: invalid len %d\n",
197 dev_warn(&purb->dev->dev,
198 "dabusb_iso_complete: corrupted packet status: %d\n",
199 purb->iso_frame_desc[i].status);
200 if (dst != purb->actual_length)
201 dev_err(&purb->dev->dev,
202 "dst!=purb->actual_length:%d!=%d\n",
203 dst, purb->actual_length);
206 if (atomic_dec_and_test(&s->pending_io) &&
207 !s->remove_pending && s->state != _stopped) {
209 dev_err(&purb->dev->dev, "overrun (%d)\n", s->overruns);
213 /*-------------------------------------------------------------------*/
214 static int dabusb_alloc_buffers(pdabusb_t s)
216 int transfer_len = 0;
218 unsigned int pipe = usb_rcvisocpipe(s->usbdev, _DABUSB_ISOPIPE);
219 int pipesize = usb_maxpacket(s->usbdev, pipe, usb_pipeout(pipe));
220 int packets = _ISOPIPESIZE / pipesize;
221 int transfer_buffer_length = packets * pipesize;
224 dbg("dabusb_alloc_buffers pipesize:%d packets:%d transfer_buffer_len:%d",
225 pipesize, packets, transfer_buffer_length);
227 while (transfer_len < (s->total_buffer_size << 10)) {
228 b = kzalloc(sizeof(buff_t), GFP_KERNEL);
230 dev_err(&s->usbdev->dev,
231 "kzalloc(sizeof(buff_t))==NULL\n");
235 b->purb = usb_alloc_urb(packets, GFP_KERNEL);
237 dev_err(&s->usbdev->dev, "usb_alloc_urb == NULL\n");
242 b->purb->transfer_buffer = kmalloc(transfer_buffer_length,
244 if (!b->purb->transfer_buffer) {
247 dev_err(&s->usbdev->dev,
248 "kmalloc(%d)==NULL\n", transfer_buffer_length);
252 b->purb->transfer_buffer_length = transfer_buffer_length;
253 b->purb->number_of_packets = packets;
254 b->purb->complete = dabusb_iso_complete;
255 b->purb->context = b;
256 b->purb->dev = s->usbdev;
257 b->purb->pipe = pipe;
258 b->purb->transfer_flags = URB_ISO_ASAP;
260 for (i = 0; i < packets; i++) {
261 b->purb->iso_frame_desc[i].offset = i * pipesize;
262 b->purb->iso_frame_desc[i].length = pipesize;
265 transfer_len += transfer_buffer_length;
266 list_add_tail(&b->buff_list, &s->free_buff_list);
268 s->got_mem = transfer_len;
273 dabusb_free_buffers(s);
276 /*-------------------------------------------------------------------*/
277 static int dabusb_bulk(pdabusb_t s, pbulk_transfer_t pb)
286 pipe = usb_rcvbulkpipe(s->usbdev, 2);
288 pipe = usb_sndbulkpipe(s->usbdev, 2);
290 ret = usb_bulk_msg(s->usbdev, pipe, pb->data,
291 pb->size, &actual_length, 100);
293 dev_err(&s->usbdev->dev,
294 "usb_bulk_msg failed(%d)\n", ret);
296 if (usb_set_interface(s->usbdev, _DABUSB_IF, 1) < 0) {
297 dev_err(&s->usbdev->dev, "set_interface failed\n");
304 dev_warn(&s->usbdev->dev, "CLEAR_FEATURE request to remove STALL condition.\n");
305 if (usb_clear_halt(s->usbdev, usb_pipeendpoint(pipe)))
306 dev_err(&s->usbdev->dev, "request failed\n");
309 pb->size = actual_length;
312 /* --------------------------------------------------------------------- */
313 static int dabusb_writemem(pdabusb_t s, int pos, const unsigned char *data,
317 unsigned char *transfer_buffer = kmalloc(len, GFP_KERNEL);
319 if (!transfer_buffer) {
320 dev_err(&s->usbdev->dev,
321 "dabusb_writemem: kmalloc(%d) failed.\n", len);
325 memcpy(transfer_buffer, data, len);
327 ret = usb_control_msg(s->usbdev, usb_sndctrlpipe(s->usbdev, 0),
328 0xa0, 0x40, pos, 0, transfer_buffer, len, 300);
330 kfree(transfer_buffer);
333 /* --------------------------------------------------------------------- */
334 static int dabusb_8051_reset(pdabusb_t s, unsigned char reset_bit)
336 dbg("dabusb_8051_reset: %d", reset_bit);
337 return dabusb_writemem(s, CPUCS_REG, &reset_bit, 1);
339 /* --------------------------------------------------------------------- */
340 static int dabusb_loadmem(pdabusb_t s, const char *fname)
343 const struct ihex_binrec *rec;
344 const struct firmware *uninitialized_var(fw);
346 dbg("Enter dabusb_loadmem (internal)");
348 ret = request_ihex_firmware(&fw, "dabusb/firmware.fw", &s->usbdev->dev);
350 dev_err(&s->usbdev->dev,
351 "Failed to load \"dabusb/firmware.fw\": %d\n", ret);
354 ret = dabusb_8051_reset(s, 1);
356 for (rec = (const struct ihex_binrec *)fw->data; rec;
357 rec = ihex_next_binrec(rec)) {
358 dbg("dabusb_writemem: %04X %p %d)", be32_to_cpu(rec->addr),
359 rec->data, be16_to_cpu(rec->len));
361 ret = dabusb_writemem(s, be32_to_cpu(rec->addr), rec->data,
362 be16_to_cpu(rec->len));
364 dev_err(&s->usbdev->dev,
365 "dabusb_writemem failed (%d %04X %p %d)\n",
366 ret, be32_to_cpu(rec->addr),
367 rec->data, be16_to_cpu(rec->len));
371 ret = dabusb_8051_reset(s, 0);
372 release_firmware(fw);
374 dbg("dabusb_loadmem: exit");
378 /* --------------------------------------------------------------------- */
379 static int dabusb_fpga_clear(pdabusb_t s, pbulk_transfer_t b)
387 dbg("dabusb_fpga_clear");
389 return dabusb_bulk(s, b);
391 /* --------------------------------------------------------------------- */
392 static int dabusb_fpga_init(pdabusb_t s, pbulk_transfer_t b)
400 dbg("dabusb_fpga_init");
402 return dabusb_bulk(s, b);
404 /* --------------------------------------------------------------------- */
405 static int dabusb_fpga_download(pdabusb_t s, const char *fname)
407 pbulk_transfer_t b = kmalloc(sizeof(bulk_transfer_t), GFP_KERNEL);
408 const struct firmware *fw;
409 unsigned int blen, n;
412 dbg("Enter dabusb_fpga_download (internal)");
415 dev_err(&s->usbdev->dev,
416 "kmalloc(sizeof(bulk_transfer_t))==NULL\n");
420 ret = request_firmware(&fw, "dabusb/bitstream.bin", &s->usbdev->dev);
422 dev_err(&s->usbdev->dev,
423 "Failed to load \"dabusb/bitstream.bin\": %d\n", ret);
429 ret = dabusb_fpga_clear(s, b);
431 blen = fw->data[73] + (fw->data[72] << 8);
433 dbg("Bitstream len: %i", blen);
440 for (n = 0; n <= blen + 60; n += 60) {
441 /* some cclks for startup */
443 memcpy(b->data + 4, fw->data + 74 + n, 60);
444 ret = dabusb_bulk(s, b);
446 dev_err(&s->usbdev->dev, "dabusb_bulk failed.\n");
452 ret = dabusb_fpga_init(s, b);
454 release_firmware(fw);
456 dbg("exit dabusb_fpga_download");
461 static int dabusb_stop(pdabusb_t s)
466 dabusb_cancel_queue(s, &s->rec_buff_list);
468 dbg("pending_io: %d", s->pending_io.counter);
470 s->pending_io.counter = 0;
474 static int dabusb_startrek(pdabusb_t s)
476 if (!s->got_mem && s->state != _started) {
478 dbg("dabusb_startrek");
480 if (dabusb_alloc_buffers(s) < 0)
487 if (!list_empty(&s->free_buff_list)) {
491 while (!dabusb_add_buf_tail(s, &s->rec_buff_list, &s->free_buff_list)) {
493 dbg("submitting: end:%p s->rec_buff_list:%p",
494 s->rec_buff_list.prev, &s->rec_buff_list);
496 end = list_entry(s->rec_buff_list.prev,
499 ret = usb_submit_urb(end->purb, GFP_KERNEL);
501 dev_err(&s->usbdev->dev,
502 "usb_submit_urb returned:%d\n", ret);
503 if (dabusb_add_buf_tail(s, &s->free_buff_list,
505 dev_err(&s->usbdev->dev,
506 "startrek: dabusb_add_buf_tail failed\n");
509 atomic_inc(&s->pending_io);
511 dbg("pending_io: %d", s->pending_io.counter);
517 static ssize_t dabusb_read(struct file *file, char __user *buf,
518 size_t count, loff_t *ppos)
520 pdabusb_t s = (pdabusb_t)file->private_data;
526 struct urb *purb = NULL;
533 if (s->remove_pending)
543 spin_lock_irqsave(&s->lock, flags);
545 if (list_empty(&s->rec_buff_list)) {
547 spin_unlock_irqrestore(&s->lock, flags);
549 dev_err(&s->usbdev->dev,
550 "error: rec_buf_list is empty\n");
554 b = list_entry(s->rec_buff_list.next, buff_t, buff_list);
557 spin_unlock_irqrestore(&s->lock, flags);
559 if (purb->status == -EINPROGRESS) {
560 /* return nonblocking */
561 if (file->f_flags & O_NONBLOCK) {
567 interruptible_sleep_on(&s->wait);
569 if (signal_pending(current)) {
575 spin_lock_irqsave(&s->lock, flags);
577 if (list_empty(&s->rec_buff_list)) {
578 spin_unlock_irqrestore(&s->lock, flags);
579 dev_err(&s->usbdev->dev,
580 "error: still no buffer available.\n");
583 spin_unlock_irqrestore(&s->lock, flags);
586 if (s->remove_pending) {
591 /* set remaining bytes to copy */
592 rem = purb->actual_length - s->readptr;
599 dbg("copy_to_user:%p %p %d", buf,
600 purb->transfer_buffer + s->readptr, cnt);
602 if (copy_to_user(buf,
603 purb->transfer_buffer + s->readptr,
605 dev_err(&s->usbdev->dev, "read: copy_to_user failed\n");
616 if (s->readptr == purb->actual_length) {
617 /* finished, take next buffer */
618 if (dabusb_add_buf_tail(s, &s->free_buff_list,
620 dev_err(&s->usbdev->dev,
621 "read: dabusb_add_buf_tail failed\n");
625 err: /*mutex_unlock(&s->mutex);*/
629 static int dabusb_open(struct inode *inode, struct file *file)
631 int devnum = iminor(inode);
635 if (devnum < DABUSB_MINOR || devnum >= (DABUSB_MINOR + NRDABUSB))
638 s = &dabusb[devnum - DABUSB_MINOR];
641 mutex_lock(&s->mutex);
643 while (!s->usbdev || s->opened) {
644 mutex_unlock(&s->mutex);
646 if (file->f_flags & O_NONBLOCK)
648 msleep_interruptible(500);
650 if (signal_pending(current))
652 mutex_lock(&s->mutex);
654 if (usb_set_interface(s->usbdev, _DABUSB_IF, 1) < 0) {
655 mutex_unlock(&s->mutex);
656 dev_err(&s->usbdev->dev, "set_interface failed\n");
660 mutex_unlock(&s->mutex);
663 file->private_data = s;
665 r = nonseekable_open(inode, file);
669 static int dabusb_release(struct inode *inode, struct file *file)
671 pdabusb_t s = (pdabusb_t)file->private_data;
673 dbg("dabusb_release");
675 mutex_lock(&s->mutex);
677 dabusb_free_buffers(s);
678 mutex_unlock(&s->mutex);
680 if (!s->remove_pending) {
681 if (usb_set_interface(s->usbdev, _DABUSB_IF, 0) < 0)
682 dev_err(&s->usbdev->dev, "set_interface failed\n");
684 wake_up(&s->remove_ok);
690 static long dabusb_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
692 pdabusb_t s = (pdabusb_t)file->private_data;
693 pbulk_transfer_t pbulk;
695 int version = DABUSB_VERSION;
699 if (s->remove_pending)
702 mutex_lock(&s->mutex);
705 mutex_unlock(&s->mutex);
712 pbulk = memdup_user((void __user *)arg,
713 sizeof(bulk_transfer_t));
716 ret = PTR_ERR(pbulk);
720 ret = dabusb_bulk(s, pbulk);
722 if (copy_to_user((void __user *)arg, pbulk,
723 sizeof(bulk_transfer_t)))
728 case IOCTL_DAB_OVERRUNS:
729 ret = put_user(s->overruns, (unsigned int __user *) arg);
732 case IOCTL_DAB_VERSION:
733 ret = put_user(version, (unsigned int __user *) arg);
740 mutex_unlock(&s->mutex);
744 static const struct file_operations dabusb_fops = {
745 .owner = THIS_MODULE,
748 .unlocked_ioctl = dabusb_ioctl,
750 .release = dabusb_release,
753 static char *dabusb_devnode(struct device *dev, mode_t *mode)
755 return kasprintf(GFP_KERNEL, "usb/%s", dev_name(dev));
758 static struct usb_class_driver dabusb_class = {
760 .devnode = dabusb_devnode,
761 .fops = &dabusb_fops,
762 .minor_base = DABUSB_MINOR,
766 /* --------------------------------------------------------------------- */
767 static int dabusb_probe(struct usb_interface *intf,
768 const struct usb_device_id *id)
770 struct usb_device *usbdev = interface_to_usbdev(intf);
774 dbg("dabusb: probe: vendor id 0x%x, device id 0x%x ifnum:%d",
775 le16_to_cpu(usbdev->descriptor.idVendor),
776 le16_to_cpu(usbdev->descriptor.idProduct),
777 intf->altsetting->desc.bInterfaceNumber);
779 /* We don't handle multiple configurations */
780 if (usbdev->descriptor.bNumConfigurations != 1)
783 if (intf->altsetting->desc.bInterfaceNumber != _DABUSB_IF &&
784 le16_to_cpu(usbdev->descriptor.idProduct) == 0x9999)
789 s = &dabusb[intf->minor];
791 mutex_lock(&s->mutex);
792 s->remove_pending = 0;
794 s->devnum = intf->minor;
796 if (usb_reset_configuration(usbdev) < 0) {
797 dev_err(&intf->dev, "reset_configuration failed\n");
800 if (le16_to_cpu(usbdev->descriptor.idProduct) == 0x2131) {
801 dabusb_loadmem(s, NULL);
804 dabusb_fpga_download(s, NULL);
806 if (usb_set_interface(s->usbdev, _DABUSB_IF, 0) < 0) {
807 dev_err(&intf->dev, "set_interface failed\n");
811 dbg("bound to interface: %d", intf->altsetting->desc.bInterfaceNumber);
812 usb_set_intfdata(intf, s);
813 mutex_unlock(&s->mutex);
815 retval = usb_register_dev(intf, &dabusb_class);
817 usb_set_intfdata(intf, NULL);
824 mutex_unlock(&s->mutex);
829 static void dabusb_disconnect(struct usb_interface *intf)
832 pdabusb_t s = usb_get_intfdata(intf);
834 dbg("dabusb_disconnect");
836 init_waitqueue_entry(&__wait, current);
838 usb_set_intfdata(intf, NULL);
840 usb_deregister_dev(intf, &dabusb_class);
841 s->remove_pending = 1;
843 add_wait_queue(&s->remove_ok, &__wait);
844 set_current_state(TASK_UNINTERRUPTIBLE);
845 if (s->state == _started)
847 current->state = TASK_RUNNING;
848 remove_wait_queue(&s->remove_ok, &__wait);
855 static struct usb_device_id dabusb_ids[] = {
856 /* { USB_DEVICE(0x0547, 0x2131) },*/ /* An2131 chip, no boot ROM */
857 { USB_DEVICE(0x0547, 0x9999) },
858 { } /* Terminating entry */
861 MODULE_DEVICE_TABLE(usb, dabusb_ids);
863 static struct usb_driver dabusb_driver = {
865 .probe = dabusb_probe,
866 .disconnect = dabusb_disconnect,
867 .id_table = dabusb_ids,
870 /* --------------------------------------------------------------------- */
872 static int __init dabusb_init(void)
877 /* initialize struct */
878 for (u = 0; u < NRDABUSB; u++) {
879 pdabusb_t s = &dabusb[u];
880 memset(s, 0, sizeof(dabusb_t));
881 mutex_init(&s->mutex);
883 s->total_buffer_size = buffers;
884 init_waitqueue_head(&s->wait);
885 init_waitqueue_head(&s->remove_ok);
886 spin_lock_init(&s->lock);
887 INIT_LIST_HEAD(&s->free_buff_list);
888 INIT_LIST_HEAD(&s->rec_buff_list);
891 /* register misc device */
892 retval = usb_register(&dabusb_driver);
896 dbg("dabusb_init: driver registered");
898 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
905 static void __exit dabusb_cleanup(void)
907 dbg("dabusb_cleanup");
909 usb_deregister(&dabusb_driver);
912 /* --------------------------------------------------------------------- */
914 MODULE_AUTHOR(DRIVER_AUTHOR);
915 MODULE_DESCRIPTION(DRIVER_DESC);
916 MODULE_LICENSE("GPL");
917 MODULE_FIRMWARE("dabusb/firmware.fw");
918 MODULE_FIRMWARE("dabusb/bitstream.bin");
920 module_param(buffers, int, 0);
921 MODULE_PARM_DESC(buffers, "Number of buffers (default=256)");
923 module_init(dabusb_init);
924 module_exit(dabusb_cleanup);
926 /* --------------------------------------------------------------------- */