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 <asm/uaccess.h>
37 #include <asm/atomic.h>
38 #include <linux/delay.h>
39 #include <linux/usb.h>
40 #include <linux/mutex.h>
43 #include "dabfirmware.h"
48 #define DRIVER_VERSION "v1.54"
49 #define DRIVER_AUTHOR "Deti Fliegl, deti@fliegl.de"
50 #define DRIVER_DESC "DAB-USB Interface Driver for Linux (c)1999"
52 /* --------------------------------------------------------------------- */
54 #ifdef CONFIG_USB_DYNAMIC_MINORS
60 /*-------------------------------------------------------------------*/
62 static dabusb_t dabusb[NRDABUSB];
63 static int buffers = 256;
64 static struct usb_driver dabusb_driver;
66 /*-------------------------------------------------------------------*/
68 static int dabusb_add_buf_tail (pdabusb_t s, struct list_head *dst, struct list_head *src)
71 struct list_head *tmp;
74 spin_lock_irqsave (&s->lock, flags);
76 if (list_empty (src)) {
77 // no elements in source buffer
82 list_move_tail (tmp, dst);
84 err: spin_unlock_irqrestore (&s->lock, flags);
87 /*-------------------------------------------------------------------*/
89 static void dump_urb (struct urb *urb)
92 dbg("dev :%p", urb->dev);
93 dbg("pipe :%08X", urb->pipe);
94 dbg("status :%d", urb->status);
95 dbg("transfer_flags :%08X", urb->transfer_flags);
96 dbg("transfer_buffer :%p", urb->transfer_buffer);
97 dbg("transfer_buffer_length:%d", urb->transfer_buffer_length);
98 dbg("actual_length :%d", urb->actual_length);
99 dbg("setup_packet :%p", urb->setup_packet);
100 dbg("start_frame :%d", urb->start_frame);
101 dbg("number_of_packets :%d", urb->number_of_packets);
102 dbg("interval :%d", urb->interval);
103 dbg("error_count :%d", urb->error_count);
104 dbg("context :%p", urb->context);
105 dbg("complete :%p", urb->complete);
108 /*-------------------------------------------------------------------*/
109 static int dabusb_cancel_queue (pdabusb_t s, struct list_head *q)
114 dbg("dabusb_cancel_queue");
116 spin_lock_irqsave (&s->lock, flags);
118 list_for_each_entry(b, q, buff_list) {
122 usb_unlink_urb (b->purb);
124 spin_unlock_irqrestore (&s->lock, flags);
127 /*-------------------------------------------------------------------*/
128 static int dabusb_free_queue (struct list_head *q)
130 struct list_head *tmp;
134 dbg("dabusb_free_queue");
135 for (p = q->next; p != q;) {
136 b = list_entry (p, buff_t, buff_list);
141 kfree(b->purb->transfer_buffer);
142 usb_free_urb(b->purb);
151 /*-------------------------------------------------------------------*/
152 static int dabusb_free_buffers (pdabusb_t s)
155 dbg("dabusb_free_buffers");
157 spin_lock_irqsave(&s->lock, flags);
159 dabusb_free_queue (&s->free_buff_list);
160 dabusb_free_queue (&s->rec_buff_list);
162 spin_unlock_irqrestore(&s->lock, flags);
167 /*-------------------------------------------------------------------*/
168 static void dabusb_iso_complete (struct urb *purb)
170 pbuff_t b = purb->context;
175 void *buf = purb->transfer_buffer;
177 dbg("dabusb_iso_complete");
179 // process if URB was not killed
180 if (purb->status != -ENOENT) {
181 unsigned int pipe = usb_rcvisocpipe (purb->dev, _DABUSB_ISOPIPE);
182 int pipesize = usb_maxpacket (purb->dev, pipe, usb_pipeout (pipe));
183 for (i = 0; i < purb->number_of_packets; i++)
184 if (!purb->iso_frame_desc[i].status) {
185 len = purb->iso_frame_desc[i].actual_length;
186 if (len <= pipesize) {
187 memcpy (buf + dst, buf + purb->iso_frame_desc[i].offset, len);
191 err("dabusb_iso_complete: invalid len %d", len);
194 warn("dabusb_iso_complete: corrupted packet status: %d", purb->iso_frame_desc[i].status);
195 if (dst != purb->actual_length)
196 err("dst!=purb->actual_length:%d!=%d", dst, purb->actual_length);
199 if (atomic_dec_and_test (&s->pending_io) && !s->remove_pending && s->state != _stopped) {
201 err("overrun (%d)", s->overruns);
205 /*-------------------------------------------------------------------*/
206 static int dabusb_alloc_buffers (pdabusb_t s)
208 int transfer_len = 0;
210 unsigned int pipe = usb_rcvisocpipe (s->usbdev, _DABUSB_ISOPIPE);
211 int pipesize = usb_maxpacket (s->usbdev, pipe, usb_pipeout (pipe));
212 int packets = _ISOPIPESIZE / pipesize;
213 int transfer_buffer_length = packets * pipesize;
216 dbg("dabusb_alloc_buffers pipesize:%d packets:%d transfer_buffer_len:%d",
217 pipesize, packets, transfer_buffer_length);
219 while (transfer_len < (s->total_buffer_size << 10)) {
220 b = kzalloc(sizeof (buff_t), GFP_KERNEL);
222 err("kzalloc(sizeof(buff_t))==NULL");
226 b->purb = usb_alloc_urb(packets, GFP_KERNEL);
228 err("usb_alloc_urb == NULL");
233 b->purb->transfer_buffer = kmalloc (transfer_buffer_length, GFP_KERNEL);
234 if (!b->purb->transfer_buffer) {
237 err("kmalloc(%d)==NULL", transfer_buffer_length);
241 b->purb->transfer_buffer_length = transfer_buffer_length;
242 b->purb->number_of_packets = packets;
243 b->purb->complete = dabusb_iso_complete;
244 b->purb->context = b;
245 b->purb->dev = s->usbdev;
246 b->purb->pipe = pipe;
247 b->purb->transfer_flags = URB_ISO_ASAP;
249 for (i = 0; i < packets; i++) {
250 b->purb->iso_frame_desc[i].offset = i * pipesize;
251 b->purb->iso_frame_desc[i].length = pipesize;
254 transfer_len += transfer_buffer_length;
255 list_add_tail (&b->buff_list, &s->free_buff_list);
257 s->got_mem = transfer_len;
262 dabusb_free_buffers (s);
265 /*-------------------------------------------------------------------*/
266 static int dabusb_bulk (pdabusb_t s, pbulk_transfer_t pb)
275 pipe = usb_rcvbulkpipe (s->usbdev, 2);
277 pipe = usb_sndbulkpipe (s->usbdev, 2);
279 ret=usb_bulk_msg(s->usbdev, pipe, pb->data, pb->size, &actual_length, 100);
281 err("dabusb: usb_bulk_msg failed(%d)",ret);
283 if (usb_set_interface (s->usbdev, _DABUSB_IF, 1) < 0) {
284 err("set_interface failed");
290 if( ret == -EPIPE ) {
291 warn("CLEAR_FEATURE request to remove STALL condition.");
292 if(usb_clear_halt(s->usbdev, usb_pipeendpoint(pipe)))
293 err("request failed");
296 pb->size = actual_length;
299 /* --------------------------------------------------------------------- */
300 static int dabusb_writemem (pdabusb_t s, int pos, unsigned char *data, int len)
303 unsigned char *transfer_buffer = kmalloc (len, GFP_KERNEL);
305 if (!transfer_buffer) {
306 err("dabusb_writemem: kmalloc(%d) failed.", len);
310 memcpy (transfer_buffer, data, len);
312 ret=usb_control_msg(s->usbdev, usb_sndctrlpipe( s->usbdev, 0 ), 0xa0, 0x40, pos, 0, transfer_buffer, len, 300);
314 kfree (transfer_buffer);
317 /* --------------------------------------------------------------------- */
318 static int dabusb_8051_reset (pdabusb_t s, unsigned char reset_bit)
320 dbg("dabusb_8051_reset: %d",reset_bit);
321 return dabusb_writemem (s, CPUCS_REG, &reset_bit, 1);
323 /* --------------------------------------------------------------------- */
324 static int dabusb_loadmem (pdabusb_t s, const char *fname)
327 PINTEL_HEX_RECORD ptr = firmware;
329 dbg("Enter dabusb_loadmem (internal)");
331 ret = dabusb_8051_reset (s, 1);
332 while (ptr->Type == 0) {
334 dbg("dabusb_writemem: %04X %p %d)", ptr->Address, ptr->Data, ptr->Length);
336 ret = dabusb_writemem (s, ptr->Address, ptr->Data, ptr->Length);
338 err("dabusb_writemem failed (%d %04X %p %d)", ret, ptr->Address, ptr->Data, ptr->Length);
343 ret = dabusb_8051_reset (s, 0);
345 dbg("dabusb_loadmem: exit");
349 /* --------------------------------------------------------------------- */
350 static int dabusb_fpga_clear (pdabusb_t s, pbulk_transfer_t b)
358 dbg("dabusb_fpga_clear");
360 return dabusb_bulk (s, b);
362 /* --------------------------------------------------------------------- */
363 static int dabusb_fpga_init (pdabusb_t s, pbulk_transfer_t b)
371 dbg("dabusb_fpga_init");
373 return dabusb_bulk (s, b);
375 /* --------------------------------------------------------------------- */
376 static int dabusb_fpga_download (pdabusb_t s, const char *fname)
378 pbulk_transfer_t b = kmalloc (sizeof (bulk_transfer_t), GFP_KERNEL);
379 unsigned int blen, n;
381 unsigned char *buf = bitstream;
383 dbg("Enter dabusb_fpga_download (internal)");
386 err("kmalloc(sizeof(bulk_transfer_t))==NULL");
391 ret = dabusb_fpga_clear (s, b);
393 blen = buf[73] + (buf[72] << 8);
395 dbg("Bitstream len: %i", blen);
402 for (n = 0; n <= blen + 60; n += 60) {
403 // some cclks for startup
405 memcpy (b->data + 4, buf + 74 + n, 60);
406 ret = dabusb_bulk (s, b);
408 err("dabusb_bulk failed.");
414 ret = dabusb_fpga_init (s, b);
417 dbg("exit dabusb_fpga_download");
422 static int dabusb_stop (pdabusb_t s)
427 dabusb_cancel_queue (s, &s->rec_buff_list);
429 dbg("pending_io: %d", s->pending_io.counter);
431 s->pending_io.counter = 0;
435 static int dabusb_startrek (pdabusb_t s)
437 if (!s->got_mem && s->state != _started) {
439 dbg("dabusb_startrek");
441 if (dabusb_alloc_buffers (s) < 0)
448 if (!list_empty (&s->free_buff_list)) {
452 while (!dabusb_add_buf_tail (s, &s->rec_buff_list, &s->free_buff_list)) {
454 dbg("submitting: end:%p s->rec_buff_list:%p", s->rec_buff_list.prev, &s->rec_buff_list);
456 end = list_entry (s->rec_buff_list.prev, buff_t, buff_list);
458 ret = usb_submit_urb (end->purb, GFP_KERNEL);
460 err("usb_submit_urb returned:%d", ret);
461 if (dabusb_add_buf_tail (s, &s->free_buff_list, &s->rec_buff_list))
462 err("startrek: dabusb_add_buf_tail failed");
466 atomic_inc (&s->pending_io);
468 dbg("pending_io: %d",s->pending_io.counter);
474 static ssize_t dabusb_read (struct file *file, char __user *buf, size_t count, loff_t * ppos)
476 pdabusb_t s = (pdabusb_t) file->private_data;
482 struct urb *purb = NULL;
489 if (s->remove_pending)
499 spin_lock_irqsave (&s->lock, flags);
501 if (list_empty (&s->rec_buff_list)) {
503 spin_unlock_irqrestore(&s->lock, flags);
505 err("error: rec_buf_list is empty");
509 b = list_entry (s->rec_buff_list.next, buff_t, buff_list);
512 spin_unlock_irqrestore(&s->lock, flags);
514 if (purb->status == -EINPROGRESS) {
515 if (file->f_flags & O_NONBLOCK) // return nonblocking
522 interruptible_sleep_on (&s->wait);
524 if (signal_pending (current)) {
530 spin_lock_irqsave (&s->lock, flags);
532 if (list_empty (&s->rec_buff_list)) {
533 spin_unlock_irqrestore(&s->lock, flags);
534 err("error: still no buffer available.");
537 spin_unlock_irqrestore(&s->lock, flags);
540 if (s->remove_pending) {
545 rem = purb->actual_length - s->readptr; // set remaining bytes to copy
552 dbg("copy_to_user:%p %p %d",buf, purb->transfer_buffer + s->readptr, cnt);
554 if (copy_to_user (buf, purb->transfer_buffer + s->readptr, cnt)) {
555 err("read: copy_to_user failed");
566 if (s->readptr == purb->actual_length) {
567 // finished, take next buffer
568 if (dabusb_add_buf_tail (s, &s->free_buff_list, &s->rec_buff_list))
569 err("read: dabusb_add_buf_tail failed");
573 err: //mutex_unlock(&s->mutex);
577 static int dabusb_open (struct inode *inode, struct file *file)
579 int devnum = iminor(inode);
582 if (devnum < DABUSB_MINOR || devnum >= (DABUSB_MINOR + NRDABUSB))
585 s = &dabusb[devnum - DABUSB_MINOR];
588 mutex_lock(&s->mutex);
590 while (!s->usbdev || s->opened) {
591 mutex_unlock(&s->mutex);
593 if (file->f_flags & O_NONBLOCK) {
596 msleep_interruptible(500);
598 if (signal_pending (current)) {
601 mutex_lock(&s->mutex);
603 if (usb_set_interface (s->usbdev, _DABUSB_IF, 1) < 0) {
604 mutex_unlock(&s->mutex);
605 err("set_interface failed");
609 mutex_unlock(&s->mutex);
612 file->private_data = s;
614 return nonseekable_open(inode, file);
617 static int dabusb_release (struct inode *inode, struct file *file)
619 pdabusb_t s = (pdabusb_t) file->private_data;
621 dbg("dabusb_release");
623 mutex_lock(&s->mutex);
625 dabusb_free_buffers (s);
626 mutex_unlock(&s->mutex);
628 if (!s->remove_pending) {
629 if (usb_set_interface (s->usbdev, _DABUSB_IF, 0) < 0)
630 err("set_interface failed");
633 wake_up (&s->remove_ok);
639 static int dabusb_ioctl (struct inode *inode, struct file *file, unsigned int cmd, unsigned long arg)
641 pdabusb_t s = (pdabusb_t) file->private_data;
642 pbulk_transfer_t pbulk;
644 int version = DABUSB_VERSION;
648 if (s->remove_pending)
651 mutex_lock(&s->mutex);
654 mutex_unlock(&s->mutex);
661 pbulk = kmalloc(sizeof (bulk_transfer_t), GFP_KERNEL);
668 if (copy_from_user (pbulk, (void __user *) arg, sizeof (bulk_transfer_t))) {
674 ret=dabusb_bulk (s, pbulk);
676 if (copy_to_user((void __user *)arg, pbulk,
677 sizeof(bulk_transfer_t)))
682 case IOCTL_DAB_OVERRUNS:
683 ret = put_user (s->overruns, (unsigned int __user *) arg);
686 case IOCTL_DAB_VERSION:
687 ret = put_user (version, (unsigned int __user *) arg);
694 mutex_unlock(&s->mutex);
698 static const struct file_operations dabusb_fops =
700 .owner = THIS_MODULE,
703 .ioctl = dabusb_ioctl,
705 .release = dabusb_release,
708 static struct usb_class_driver dabusb_class = {
710 .fops = &dabusb_fops,
711 .minor_base = DABUSB_MINOR,
715 /* --------------------------------------------------------------------- */
716 static int dabusb_probe (struct usb_interface *intf,
717 const struct usb_device_id *id)
719 struct usb_device *usbdev = interface_to_usbdev(intf);
723 dbg("dabusb: probe: vendor id 0x%x, device id 0x%x ifnum:%d",
724 le16_to_cpu(usbdev->descriptor.idVendor),
725 le16_to_cpu(usbdev->descriptor.idProduct),
726 intf->altsetting->desc.bInterfaceNumber);
728 /* We don't handle multiple configurations */
729 if (usbdev->descriptor.bNumConfigurations != 1)
732 if (intf->altsetting->desc.bInterfaceNumber != _DABUSB_IF &&
733 le16_to_cpu(usbdev->descriptor.idProduct) == 0x9999)
738 s = &dabusb[intf->minor];
740 mutex_lock(&s->mutex);
741 s->remove_pending = 0;
743 s->devnum = intf->minor;
745 if (usb_reset_configuration (usbdev) < 0) {
746 err("reset_configuration failed");
749 if (le16_to_cpu(usbdev->descriptor.idProduct) == 0x2131) {
750 dabusb_loadmem (s, NULL);
754 dabusb_fpga_download (s, NULL);
756 if (usb_set_interface (s->usbdev, _DABUSB_IF, 0) < 0) {
757 err("set_interface failed");
761 dbg("bound to interface: %d", intf->altsetting->desc.bInterfaceNumber);
762 usb_set_intfdata (intf, s);
763 mutex_unlock(&s->mutex);
765 retval = usb_register_dev(intf, &dabusb_class);
767 usb_set_intfdata (intf, NULL);
774 mutex_unlock(&s->mutex);
779 static void dabusb_disconnect (struct usb_interface *intf)
782 pdabusb_t s = usb_get_intfdata (intf);
784 dbg("dabusb_disconnect");
786 init_waitqueue_entry(&__wait, current);
788 usb_set_intfdata (intf, NULL);
790 usb_deregister_dev (intf, &dabusb_class);
791 s->remove_pending = 1;
793 add_wait_queue(&s->remove_ok, &__wait);
794 set_current_state(TASK_UNINTERRUPTIBLE);
795 if (s->state == _started)
797 current->state = TASK_RUNNING;
798 remove_wait_queue(&s->remove_ok, &__wait);
805 static struct usb_device_id dabusb_ids [] = {
806 // { USB_DEVICE(0x0547, 0x2131) }, /* An2131 chip, no boot ROM */
807 { USB_DEVICE(0x0547, 0x9999) },
808 { } /* Terminating entry */
811 MODULE_DEVICE_TABLE (usb, dabusb_ids);
813 static struct usb_driver dabusb_driver = {
815 .probe = dabusb_probe,
816 .disconnect = dabusb_disconnect,
817 .id_table = dabusb_ids,
820 /* --------------------------------------------------------------------- */
822 static int __init dabusb_init (void)
827 /* initialize struct */
828 for (u = 0; u < NRDABUSB; u++) {
829 pdabusb_t s = &dabusb[u];
830 memset (s, 0, sizeof (dabusb_t));
831 mutex_init (&s->mutex);
833 s->total_buffer_size = buffers;
834 init_waitqueue_head (&s->wait);
835 init_waitqueue_head (&s->remove_ok);
836 spin_lock_init (&s->lock);
837 INIT_LIST_HEAD (&s->free_buff_list);
838 INIT_LIST_HEAD (&s->rec_buff_list);
841 /* register misc device */
842 retval = usb_register(&dabusb_driver);
846 dbg("dabusb_init: driver registered");
848 info(DRIVER_VERSION ":" DRIVER_DESC);
854 static void __exit dabusb_cleanup (void)
856 dbg("dabusb_cleanup");
858 usb_deregister (&dabusb_driver);
861 /* --------------------------------------------------------------------- */
863 MODULE_AUTHOR( DRIVER_AUTHOR );
864 MODULE_DESCRIPTION( DRIVER_DESC );
865 MODULE_LICENSE("GPL");
867 module_param(buffers, int, 0);
868 MODULE_PARM_DESC (buffers, "Number of buffers (default=256)");
870 module_init (dabusb_init);
871 module_exit (dabusb_cleanup);
873 /* --------------------------------------------------------------------- */