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/miscdevice.h>
33 #include <linux/list.h>
34 #include <linux/vmalloc.h>
35 #include <linux/slab.h>
36 #include <linux/init.h>
37 #include <asm/uaccess.h>
38 #include <asm/atomic.h>
39 #include <linux/delay.h>
40 #include <linux/usb.h>
41 #include <linux/smp_lock.h>
44 #include "dabfirmware.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 /* --------------------------------------------------------------------- */
57 /*-------------------------------------------------------------------*/
59 static dabusb_t dabusb[NRDABUSB];
60 static int buffers = 256;
62 /*-------------------------------------------------------------------*/
64 static int dabusb_add_buf_tail (pdabusb_t s, struct list_head *dst, struct list_head *src)
67 struct list_head *tmp;
70 spin_lock_irqsave (&s->lock, flags);
72 if (list_empty (src)) {
73 // no elements in source buffer
79 list_add_tail (tmp, dst);
81 err: spin_unlock_irqrestore (&s->lock, flags);
84 /*-------------------------------------------------------------------*/
86 static void dump_urb (struct urb *purb)
89 dbg("next :%p", purb->next);
90 dbg("dev :%p", purb->dev);
91 dbg("pipe :%08X", purb->pipe);
92 dbg("status :%d", purb->status);
93 dbg("transfer_flags :%08X", purb->transfer_flags);
94 dbg("transfer_buffer :%p", purb->transfer_buffer);
95 dbg("transfer_buffer_length:%d", purb->transfer_buffer_length);
96 dbg("actual_length :%d", purb->actual_length);
97 dbg("setup_packet :%p", purb->setup_packet);
98 dbg("start_frame :%d", purb->start_frame);
99 dbg("number_of_packets :%d", purb->number_of_packets);
100 dbg("interval :%d", purb->interval);
101 dbg("error_count :%d", purb->error_count);
102 dbg("context :%p", purb->context);
103 dbg("complete :%p", purb->complete);
106 /*-------------------------------------------------------------------*/
107 static int dabusb_cancel_queue (pdabusb_t s, struct list_head *q)
113 dbg("dabusb_cancel_queue");
115 spin_lock_irqsave (&s->lock, flags);
117 for (p = q->next; p != q; p = p->next) {
118 b = list_entry (p, buff_t, buff_list);
123 usb_unlink_urb (b->purb);
125 spin_unlock_irqrestore (&s->lock, flags);
128 /*-------------------------------------------------------------------*/
129 static int dabusb_free_queue (struct list_head *q)
131 struct list_head *tmp;
135 dbg("dabusb_free_queue");
136 for (p = q->next; p != q;) {
137 b = list_entry (p, buff_t, buff_list);
142 if (b->purb->transfer_buffer)
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, usb_pipeout (pipe));
185 for (i = 0; i < purb->number_of_packets; i++)
186 if (!purb->iso_frame_desc[i].status) {
187 len = purb->iso_frame_desc[i].actual_length;
188 if (len <= pipesize) {
189 memcpy (buf + dst, buf + purb->iso_frame_desc[i].offset, len);
193 err("dabusb_iso_complete: invalid len %d", len);
196 warn("dabusb_iso_complete: corrupted packet status: %d", purb->iso_frame_desc[i].status);
197 if (dst != purb->actual_length)
198 err("dst!=purb->actual_length:%d!=%d", dst, purb->actual_length);
201 if (atomic_dec_and_test (&s->pending_io) && !s->remove_pending && s->state != _stopped) {
203 err("overrun (%d)", s->overruns);
207 /*-------------------------------------------------------------------*/
208 static int dabusb_alloc_buffers (pdabusb_t s)
212 unsigned int pipe = usb_rcvisocpipe (s->usbdev, _DABUSB_ISOPIPE);
213 int pipesize = usb_maxpacket (s->usbdev, pipe, usb_pipeout (pipe));
214 int packets = _ISOPIPESIZE / pipesize;
215 int transfer_buffer_length = packets * pipesize;
218 dbg("dabusb_alloc_buffers pipesize:%d packets:%d transfer_buffer_len:%d",
219 pipesize, packets, transfer_buffer_length);
221 while (buffers < (s->total_buffer_size << 10)) {
222 b = (pbuff_t) kmalloc (sizeof (buff_t), GFP_KERNEL);
224 err("kmalloc(sizeof(buff_t))==NULL");
227 memset (b, 0, sizeof (buff_t));
229 b->purb = usb_alloc_urb(packets);
231 err("usb_alloc_urb == NULL");
236 b->purb->transfer_buffer = kmalloc (transfer_buffer_length, GFP_KERNEL);
237 if (!b->purb->transfer_buffer) {
240 err("kmalloc(%d)==NULL", transfer_buffer_length);
244 b->purb->transfer_buffer_length = transfer_buffer_length;
245 b->purb->number_of_packets = packets;
246 b->purb->complete = dabusb_iso_complete;
247 b->purb->context = b;
248 b->purb->dev = s->usbdev;
249 b->purb->pipe = pipe;
250 b->purb->transfer_flags = USB_ISO_ASAP;
252 for (i = 0; i < packets; i++) {
253 b->purb->iso_frame_desc[i].offset = i * pipesize;
254 b->purb->iso_frame_desc[i].length = pipesize;
257 buffers += transfer_buffer_length;
258 list_add_tail (&b->buff_list, &s->free_buff_list);
260 s->got_mem = buffers;
265 dabusb_free_buffers (s);
268 /*-------------------------------------------------------------------*/
269 static int dabusb_bulk (pdabusb_t s, pbulk_transfer_t pb)
278 pipe = usb_rcvbulkpipe (s->usbdev, 2);
280 pipe = usb_sndbulkpipe (s->usbdev, 2);
282 ret=usb_bulk_msg(s->usbdev, pipe, pb->data, pb->size, &actual_length, 100);
284 err("dabusb: usb_bulk_msg failed(%d)",ret);
286 if (usb_set_interface (s->usbdev, _DABUSB_IF, 1) < 0) {
287 err("set_interface failed");
293 if( ret == -EPIPE ) {
294 warn("CLEAR_FEATURE request to remove STALL condition.");
295 if(usb_clear_halt(s->usbdev, usb_pipeendpoint(pipe)))
296 err("request failed");
299 pb->size = actual_length;
302 /* --------------------------------------------------------------------- */
303 static int dabusb_writemem (pdabusb_t s, int pos, unsigned char *data, int len)
306 unsigned char *transfer_buffer = kmalloc (len, GFP_KERNEL);
308 if (!transfer_buffer) {
309 err("dabusb_writemem: kmalloc(%d) failed.", len);
313 memcpy (transfer_buffer, data, len);
315 ret=usb_control_msg(s->usbdev, usb_sndctrlpipe( s->usbdev, 0 ), 0xa0, 0x40, pos, 0, transfer_buffer, len, 300);
317 kfree (transfer_buffer);
320 /* --------------------------------------------------------------------- */
321 static int dabusb_8051_reset (pdabusb_t s, unsigned char reset_bit)
323 dbg("dabusb_8051_reset: %d",reset_bit);
324 return dabusb_writemem (s, CPUCS_REG, &reset_bit, 1);
326 /* --------------------------------------------------------------------- */
327 static int dabusb_loadmem (pdabusb_t s, const char *fname)
330 PINTEL_HEX_RECORD ptr = firmware;
332 dbg("Enter dabusb_loadmem (internal)");
334 ret = dabusb_8051_reset (s, 1);
335 while (ptr->Type == 0) {
337 dbg("dabusb_writemem: %04X %p %d)", ptr->Address, ptr->Data, ptr->Length);
339 ret = dabusb_writemem (s, ptr->Address, ptr->Data, ptr->Length);
341 err("dabusb_writemem failed (%d %04X %p %d)", ret, ptr->Address, ptr->Data, ptr->Length);
346 ret = dabusb_8051_reset (s, 0);
348 dbg("dabusb_loadmem: exit");
352 /* --------------------------------------------------------------------- */
353 static int dabusb_fpga_clear (pdabusb_t s, pbulk_transfer_t b)
361 dbg("dabusb_fpga_clear");
363 return dabusb_bulk (s, b);
365 /* --------------------------------------------------------------------- */
366 static int dabusb_fpga_init (pdabusb_t s, pbulk_transfer_t b)
374 dbg("dabusb_fpga_init");
376 return dabusb_bulk (s, b);
378 /* --------------------------------------------------------------------- */
379 static int dabusb_fpga_download (pdabusb_t s, const char *fname)
381 pbulk_transfer_t b = kmalloc (sizeof (bulk_transfer_t), GFP_KERNEL);
382 unsigned int blen, n;
384 unsigned char *buf = bitstream;
386 dbg("Enter dabusb_fpga_download (internal)");
389 err("kmalloc(sizeof(bulk_transfer_t))==NULL");
394 ret = dabusb_fpga_clear (s, b);
396 blen = buf[73] + (buf[72] << 8);
398 dbg("Bitstream len: %i", blen);
405 for (n = 0; n <= blen + 60; n += 60) {
406 // some cclks for startup
408 memcpy (b->data + 4, buf + 74 + n, 60);
409 ret = dabusb_bulk (s, b);
411 err("dabusb_bulk failed.");
417 ret = dabusb_fpga_init (s, b);
420 dbg("exit dabusb_fpga_download");
425 static int dabusb_stop (pdabusb_t s)
430 dabusb_cancel_queue (s, &s->rec_buff_list);
432 dbg("pending_io: %d", s->pending_io.counter);
434 s->pending_io.counter = 0;
438 static int dabusb_startrek (pdabusb_t s)
440 if (!s->got_mem && s->state != _started) {
442 dbg("dabusb_startrek");
444 if (dabusb_alloc_buffers (s) < 0)
451 if (!list_empty (&s->free_buff_list)) {
455 while (!dabusb_add_buf_tail (s, &s->rec_buff_list, &s->free_buff_list)) {
457 dbg("submitting: end:%p s->rec_buff_list:%p", s->rec_buff_list.prev, &s->rec_buff_list);
459 end = list_entry (s->rec_buff_list.prev, buff_t, buff_list);
461 ret = usb_submit_urb (end->purb);
463 err("usb_submit_urb returned:%d", ret);
464 if (dabusb_add_buf_tail (s, &s->free_buff_list, &s->rec_buff_list))
465 err("startrek: dabusb_add_buf_tail failed");
469 atomic_inc (&s->pending_io);
471 dbg("pending_io: %d",s->pending_io.counter);
477 static ssize_t dabusb_read (struct file *file, char *buf, size_t count, loff_t * ppos)
479 pdabusb_t s = (pdabusb_t) file->private_data;
485 struct urb *purb = NULL;
492 if (s->remove_pending)
502 spin_lock_irqsave (&s->lock, flags);
504 if (list_empty (&s->rec_buff_list)) {
506 spin_unlock_irqrestore(&s->lock, flags);
508 err("error: rec_buf_list is empty");
512 b = list_entry (s->rec_buff_list.next, buff_t, buff_list);
515 spin_unlock_irqrestore(&s->lock, flags);
517 if (purb->status == -EINPROGRESS) {
518 if (file->f_flags & O_NONBLOCK) // return nonblocking
525 interruptible_sleep_on (&s->wait);
527 if (signal_pending (current)) {
533 spin_lock_irqsave (&s->lock, flags);
535 if (list_empty (&s->rec_buff_list)) {
536 spin_unlock_irqrestore(&s->lock, flags);
537 err("error: still no buffer available.");
540 spin_unlock_irqrestore(&s->lock, flags);
543 if (s->remove_pending) {
548 rem = purb->actual_length - s->readptr; // set remaining bytes to copy
555 dbg("copy_to_user:%p %p %d",buf, purb->transfer_buffer + s->readptr, cnt);
557 if (copy_to_user (buf, purb->transfer_buffer + s->readptr, cnt)) {
558 err("read: copy_to_user failed");
569 if (s->readptr == purb->actual_length) {
570 // finished, take next buffer
571 if (dabusb_add_buf_tail (s, &s->free_buff_list, &s->rec_buff_list))
572 err("read: dabusb_add_buf_tail failed");
576 err: //up(&s->mutex);
580 static int dabusb_open (struct inode *inode, struct file *file)
582 int devnum = MINOR (inode->i_rdev);
585 if (devnum < DABUSB_MINOR || devnum >= (DABUSB_MINOR + NRDABUSB))
588 s = &dabusb[devnum - DABUSB_MINOR];
593 while (!s->usbdev || s->opened) {
596 if (file->f_flags & O_NONBLOCK) {
599 schedule_timeout (HZ / 2);
601 if (signal_pending (current)) {
606 if (usb_set_interface (s->usbdev, _DABUSB_IF, 1) < 0) {
607 err("set_interface failed");
615 file->private_data = s;
620 static int dabusb_release (struct inode *inode, struct file *file)
622 pdabusb_t s = (pdabusb_t) file->private_data;
624 dbg("dabusb_release");
629 dabusb_free_buffers (s);
632 if (!s->remove_pending) {
633 if (usb_set_interface (s->usbdev, _DABUSB_IF, 0) < 0)
634 err("set_interface failed");
637 wake_up (&s->remove_ok);
644 static int dabusb_ioctl (struct inode *inode, struct file *file, unsigned int cmd, unsigned long arg)
646 pdabusb_t s = (pdabusb_t) file->private_data;
647 pbulk_transfer_t pbulk;
649 int version = DABUSB_VERSION;
653 if (s->remove_pending)
666 pbulk = (pbulk_transfer_t) kmalloc (sizeof (bulk_transfer_t), GFP_KERNEL);
673 if (copy_from_user (pbulk, (void *) arg, sizeof (bulk_transfer_t))) {
679 ret=dabusb_bulk (s, pbulk);
681 ret = copy_to_user ((void *) arg, pbulk, sizeof (bulk_transfer_t));
685 case IOCTL_DAB_OVERRUNS:
686 ret = put_user (s->overruns, (unsigned int *) arg);
689 case IOCTL_DAB_VERSION:
690 ret = put_user (version, (unsigned int *) arg);
701 static struct file_operations dabusb_fops =
708 release: dabusb_release,
711 static int dabusb_find_struct (void)
715 for (u = 0; u < NRDABUSB; u++) {
716 pdabusb_t s = &dabusb[u];
723 /* --------------------------------------------------------------------- */
724 static void *dabusb_probe (struct usb_device *usbdev, unsigned int ifnum,
725 const struct usb_device_id *id)
730 dbg("dabusb: probe: vendor id 0x%x, device id 0x%x ifnum:%d",
731 usbdev->descriptor.idVendor, usbdev->descriptor.idProduct, ifnum);
733 /* We don't handle multiple configurations */
734 if (usbdev->descriptor.bNumConfigurations != 1)
737 if (ifnum != _DABUSB_IF && usbdev->descriptor.idProduct == 0x9999)
740 devnum = dabusb_find_struct ();
747 s->remove_pending = 0;
750 if (usb_set_configuration (usbdev, usbdev->config[0].bConfigurationValue) < 0) {
751 err("set_configuration failed");
754 if (usbdev->descriptor.idProduct == 0x2131) {
755 dabusb_loadmem (s, NULL);
759 dabusb_fpga_download (s, NULL);
761 if (usb_set_interface (s->usbdev, _DABUSB_IF, 0) < 0) {
762 err("set_interface failed");
766 dbg("bound to interface: %d", ifnum);
777 static void dabusb_disconnect (struct usb_device *usbdev, void *ptr)
779 pdabusb_t s = (pdabusb_t) ptr;
781 dbg("dabusb_disconnect");
783 s->remove_pending = 1;
785 if (s->state == _started)
786 sleep_on (&s->remove_ok);
792 static struct usb_device_id dabusb_ids [] = {
793 { USB_DEVICE(0x0547, 0x2131) },
794 { USB_DEVICE(0x0547, 0x9999) },
795 { } /* Terminating entry */
798 MODULE_DEVICE_TABLE (usb, dabusb_ids);
800 static struct usb_driver dabusb_driver =
804 disconnect: dabusb_disconnect,
807 id_table: dabusb_ids,
810 /* --------------------------------------------------------------------- */
812 static int __init dabusb_init (void)
816 /* initialize struct */
817 for (u = 0; u < NRDABUSB; u++) {
818 pdabusb_t s = &dabusb[u];
819 memset (s, 0, sizeof (dabusb_t));
820 init_MUTEX (&s->mutex);
822 s->total_buffer_size = buffers;
823 init_waitqueue_head (&s->wait);
824 init_waitqueue_head (&s->remove_ok);
825 spin_lock_init (&s->lock);
826 INIT_LIST_HEAD (&s->free_buff_list);
827 INIT_LIST_HEAD (&s->rec_buff_list);
830 /* register misc device */
831 if (usb_register(&dabusb_driver))
834 dbg("dabusb_init: driver registered");
836 info(DRIVER_VERSION ":" DRIVER_DESC);
841 static void __exit dabusb_cleanup (void)
843 dbg("dabusb_cleanup");
845 usb_deregister (&dabusb_driver);
848 /* --------------------------------------------------------------------- */
850 MODULE_AUTHOR( DRIVER_AUTHOR );
851 MODULE_DESCRIPTION( DRIVER_DESC );
852 MODULE_LICENSE("GPL");
854 MODULE_PARM (buffers, "i");
855 MODULE_PARM_DESC (buffers, "Number of buffers (default=256)");
857 module_init (dabusb_init);
858 module_exit (dabusb_cleanup);
860 /* --------------------------------------------------------------------- */