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>
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, struct list_head *src)
72 struct list_head *tmp;
75 spin_lock_irqsave (&s->lock, flags);
77 if (list_empty (src)) {
78 // no elements in source buffer
83 list_move_tail (tmp, dst);
85 err: spin_unlock_irqrestore (&s->lock, flags);
88 /*-------------------------------------------------------------------*/
90 static void dump_urb (struct urb *urb)
93 dbg("dev :%p", urb->dev);
94 dbg("pipe :%08X", urb->pipe);
95 dbg("status :%d", urb->status);
96 dbg("transfer_flags :%08X", urb->transfer_flags);
97 dbg("transfer_buffer :%p", urb->transfer_buffer);
98 dbg("transfer_buffer_length:%d", urb->transfer_buffer_length);
99 dbg("actual_length :%d", urb->actual_length);
100 dbg("setup_packet :%p", urb->setup_packet);
101 dbg("start_frame :%d", urb->start_frame);
102 dbg("number_of_packets :%d", urb->number_of_packets);
103 dbg("interval :%d", urb->interval);
104 dbg("error_count :%d", urb->error_count);
105 dbg("context :%p", urb->context);
106 dbg("complete :%p", urb->complete);
109 /*-------------------------------------------------------------------*/
110 static int dabusb_cancel_queue (pdabusb_t s, struct list_head *q)
115 dbg("dabusb_cancel_queue");
117 spin_lock_irqsave (&s->lock, flags);
119 list_for_each_entry(b, q, 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 kfree(b->purb->transfer_buffer);
143 usb_free_urb(b->purb);
152 /*-------------------------------------------------------------------*/
153 static int dabusb_free_buffers (pdabusb_t s)
156 dbg("dabusb_free_buffers");
158 spin_lock_irqsave(&s->lock, flags);
160 dabusb_free_queue (&s->free_buff_list);
161 dabusb_free_queue (&s->rec_buff_list);
163 spin_unlock_irqrestore(&s->lock, flags);
168 /*-------------------------------------------------------------------*/
169 static void dabusb_iso_complete (struct urb *purb)
171 pbuff_t b = purb->context;
176 void *buf = purb->transfer_buffer;
178 dbg("dabusb_iso_complete");
180 // process if URB was not killed
181 if (purb->status != -ENOENT) {
182 unsigned int pipe = usb_rcvisocpipe (purb->dev, _DABUSB_ISOPIPE);
183 int pipesize = usb_maxpacket (purb->dev, pipe, usb_pipeout (pipe));
184 for (i = 0; i < purb->number_of_packets; i++)
185 if (!purb->iso_frame_desc[i].status) {
186 len = purb->iso_frame_desc[i].actual_length;
187 if (len <= pipesize) {
188 memcpy (buf + dst, buf + purb->iso_frame_desc[i].offset, len);
192 dev_err(&purb->dev->dev,
193 "dabusb_iso_complete: invalid len %d\n", len);
196 dev_warn(&purb->dev->dev, "dabusb_iso_complete: corrupted packet status: %d\n", purb->iso_frame_desc[i].status);
197 if (dst != purb->actual_length)
198 dev_err(&purb->dev->dev,
199 "dst!=purb->actual_length:%d!=%d\n",
200 dst, purb->actual_length);
203 if (atomic_dec_and_test (&s->pending_io) && !s->remove_pending && s->state != _stopped) {
205 dev_err(&purb->dev->dev, "overrun (%d)\n", s->overruns);
209 /*-------------------------------------------------------------------*/
210 static int dabusb_alloc_buffers (pdabusb_t s)
212 int transfer_len = 0;
214 unsigned int pipe = usb_rcvisocpipe (s->usbdev, _DABUSB_ISOPIPE);
215 int pipesize = usb_maxpacket (s->usbdev, pipe, usb_pipeout (pipe));
216 int packets = _ISOPIPESIZE / pipesize;
217 int transfer_buffer_length = packets * pipesize;
220 dbg("dabusb_alloc_buffers pipesize:%d packets:%d transfer_buffer_len:%d",
221 pipesize, packets, transfer_buffer_length);
223 while (transfer_len < (s->total_buffer_size << 10)) {
224 b = kzalloc(sizeof (buff_t), GFP_KERNEL);
226 dev_err(&s->usbdev->dev,
227 "kzalloc(sizeof(buff_t))==NULL\n");
231 b->purb = usb_alloc_urb(packets, GFP_KERNEL);
233 dev_err(&s->usbdev->dev, "usb_alloc_urb == NULL\n");
238 b->purb->transfer_buffer = kmalloc (transfer_buffer_length, GFP_KERNEL);
239 if (!b->purb->transfer_buffer) {
242 dev_err(&s->usbdev->dev,
243 "kmalloc(%d)==NULL\n", transfer_buffer_length);
247 b->purb->transfer_buffer_length = transfer_buffer_length;
248 b->purb->number_of_packets = packets;
249 b->purb->complete = dabusb_iso_complete;
250 b->purb->context = b;
251 b->purb->dev = s->usbdev;
252 b->purb->pipe = pipe;
253 b->purb->transfer_flags = URB_ISO_ASAP;
255 for (i = 0; i < packets; i++) {
256 b->purb->iso_frame_desc[i].offset = i * pipesize;
257 b->purb->iso_frame_desc[i].length = pipesize;
260 transfer_len += transfer_buffer_length;
261 list_add_tail (&b->buff_list, &s->free_buff_list);
263 s->got_mem = transfer_len;
268 dabusb_free_buffers (s);
271 /*-------------------------------------------------------------------*/
272 static int dabusb_bulk (pdabusb_t s, pbulk_transfer_t pb)
281 pipe = usb_rcvbulkpipe (s->usbdev, 2);
283 pipe = usb_sndbulkpipe (s->usbdev, 2);
285 ret=usb_bulk_msg(s->usbdev, pipe, pb->data, pb->size, &actual_length, 100);
287 dev_err(&s->usbdev->dev,
288 "usb_bulk_msg failed(%d)\n", ret);
290 if (usb_set_interface (s->usbdev, _DABUSB_IF, 1) < 0) {
291 dev_err(&s->usbdev->dev, "set_interface failed\n");
297 if( ret == -EPIPE ) {
298 dev_warn(&s->usbdev->dev, "CLEAR_FEATURE request to remove STALL condition.\n");
299 if(usb_clear_halt(s->usbdev, usb_pipeendpoint(pipe)))
300 dev_err(&s->usbdev->dev, "request failed\n");
303 pb->size = actual_length;
306 /* --------------------------------------------------------------------- */
307 static int dabusb_writemem (pdabusb_t s, int pos, const unsigned char *data,
311 unsigned char *transfer_buffer = kmalloc (len, GFP_KERNEL);
313 if (!transfer_buffer) {
314 dev_err(&s->usbdev->dev,
315 "dabusb_writemem: kmalloc(%d) failed.\n", len);
319 memcpy (transfer_buffer, data, len);
321 ret=usb_control_msg(s->usbdev, usb_sndctrlpipe( s->usbdev, 0 ), 0xa0, 0x40, pos, 0, transfer_buffer, len, 300);
323 kfree (transfer_buffer);
326 /* --------------------------------------------------------------------- */
327 static int dabusb_8051_reset (pdabusb_t s, unsigned char reset_bit)
329 dbg("dabusb_8051_reset: %d",reset_bit);
330 return dabusb_writemem (s, CPUCS_REG, &reset_bit, 1);
332 /* --------------------------------------------------------------------- */
333 static int dabusb_loadmem (pdabusb_t s, const char *fname)
336 const struct ihex_binrec *rec;
337 const struct firmware *fw;
339 dbg("Enter dabusb_loadmem (internal)");
341 ret = request_ihex_firmware(&fw, "dabusb/firmware.fw", &s->usbdev->dev);
343 dev_err(&s->usbdev->dev,
344 "Failed to load \"dabusb/firmware.fw\": %d\n", ret);
347 ret = dabusb_8051_reset (s, 1);
349 for (rec = (const struct ihex_binrec *)fw->data; rec;
350 rec = ihex_next_binrec(rec)) {
351 dbg("dabusb_writemem: %04X %p %d)", be32_to_cpu(rec->addr),
352 rec->data, be16_to_cpu(rec->len));
354 ret = dabusb_writemem(s, be32_to_cpu(rec->addr), rec->data,
355 be16_to_cpu(rec->len));
357 dev_err(&s->usbdev->dev,
358 "dabusb_writemem failed (%d %04X %p %d)\n",
359 ret, be32_to_cpu(rec->addr),
360 rec->data, be16_to_cpu(rec->len));
364 ret = dabusb_8051_reset (s, 0);
365 release_firmware(fw);
367 dbg("dabusb_loadmem: exit");
371 /* --------------------------------------------------------------------- */
372 static int dabusb_fpga_clear (pdabusb_t s, pbulk_transfer_t b)
380 dbg("dabusb_fpga_clear");
382 return dabusb_bulk (s, b);
384 /* --------------------------------------------------------------------- */
385 static int dabusb_fpga_init (pdabusb_t s, pbulk_transfer_t b)
393 dbg("dabusb_fpga_init");
395 return dabusb_bulk (s, b);
397 /* --------------------------------------------------------------------- */
398 static int dabusb_fpga_download (pdabusb_t s, const char *fname)
400 pbulk_transfer_t b = kmalloc (sizeof (bulk_transfer_t), GFP_KERNEL);
401 const struct firmware *fw;
402 unsigned int blen, n;
405 dbg("Enter dabusb_fpga_download (internal)");
408 dev_err(&s->usbdev->dev,
409 "kmalloc(sizeof(bulk_transfer_t))==NULL\n");
413 ret = request_firmware(&fw, "dabusb/bitstream.bin", &s->usbdev->dev);
415 dev_err(&s->usbdev->dev,
416 "Failed to load \"dabusb/bitstream.bin\": %d\n", ret);
422 ret = dabusb_fpga_clear (s, b);
424 blen = fw->data[73] + (fw->data[72] << 8);
426 dbg("Bitstream len: %i", blen);
433 for (n = 0; n <= blen + 60; n += 60) {
434 // some cclks for startup
436 memcpy (b->data + 4, fw->data + 74 + n, 60);
437 ret = dabusb_bulk (s, b);
439 dev_err(&s->usbdev->dev, "dabusb_bulk failed.\n");
445 ret = dabusb_fpga_init (s, b);
447 release_firmware(fw);
449 dbg("exit dabusb_fpga_download");
454 static int dabusb_stop (pdabusb_t s)
459 dabusb_cancel_queue (s, &s->rec_buff_list);
461 dbg("pending_io: %d", s->pending_io.counter);
463 s->pending_io.counter = 0;
467 static int dabusb_startrek (pdabusb_t s)
469 if (!s->got_mem && s->state != _started) {
471 dbg("dabusb_startrek");
473 if (dabusb_alloc_buffers (s) < 0)
480 if (!list_empty (&s->free_buff_list)) {
484 while (!dabusb_add_buf_tail (s, &s->rec_buff_list, &s->free_buff_list)) {
486 dbg("submitting: end:%p s->rec_buff_list:%p", s->rec_buff_list.prev, &s->rec_buff_list);
488 end = list_entry (s->rec_buff_list.prev, buff_t, buff_list);
490 ret = usb_submit_urb (end->purb, GFP_KERNEL);
492 dev_err(&s->usbdev->dev,
493 "usb_submit_urb returned:%d\n", ret);
494 if (dabusb_add_buf_tail (s, &s->free_buff_list, &s->rec_buff_list))
495 dev_err(&s->usbdev->dev,
496 "startrek: dabusb_add_buf_tail failed\n");
500 atomic_inc (&s->pending_io);
502 dbg("pending_io: %d",s->pending_io.counter);
508 static ssize_t dabusb_read (struct file *file, char __user *buf, size_t count, loff_t * ppos)
510 pdabusb_t s = (pdabusb_t) file->private_data;
516 struct urb *purb = NULL;
523 if (s->remove_pending)
533 spin_lock_irqsave (&s->lock, flags);
535 if (list_empty (&s->rec_buff_list)) {
537 spin_unlock_irqrestore(&s->lock, flags);
539 dev_err(&s->usbdev->dev,
540 "error: rec_buf_list is empty\n");
544 b = list_entry (s->rec_buff_list.next, buff_t, buff_list);
547 spin_unlock_irqrestore(&s->lock, flags);
549 if (purb->status == -EINPROGRESS) {
550 if (file->f_flags & O_NONBLOCK) // return nonblocking
557 interruptible_sleep_on (&s->wait);
559 if (signal_pending (current)) {
565 spin_lock_irqsave (&s->lock, flags);
567 if (list_empty (&s->rec_buff_list)) {
568 spin_unlock_irqrestore(&s->lock, flags);
569 dev_err(&s->usbdev->dev,
570 "error: still no buffer available.\n");
573 spin_unlock_irqrestore(&s->lock, flags);
576 if (s->remove_pending) {
581 rem = purb->actual_length - s->readptr; // set remaining bytes to copy
588 dbg("copy_to_user:%p %p %d",buf, purb->transfer_buffer + s->readptr, cnt);
590 if (copy_to_user (buf, purb->transfer_buffer + s->readptr, cnt)) {
591 dev_err(&s->usbdev->dev, "read: copy_to_user failed\n");
602 if (s->readptr == purb->actual_length) {
603 // finished, take next buffer
604 if (dabusb_add_buf_tail (s, &s->free_buff_list, &s->rec_buff_list))
605 dev_err(&s->usbdev->dev,
606 "read: dabusb_add_buf_tail failed\n");
610 err: //mutex_unlock(&s->mutex);
614 static int dabusb_open (struct inode *inode, struct file *file)
616 int devnum = iminor(inode);
619 if (devnum < DABUSB_MINOR || devnum >= (DABUSB_MINOR + NRDABUSB))
622 s = &dabusb[devnum - DABUSB_MINOR];
625 mutex_lock(&s->mutex);
627 while (!s->usbdev || s->opened) {
628 mutex_unlock(&s->mutex);
630 if (file->f_flags & O_NONBLOCK) {
633 msleep_interruptible(500);
635 if (signal_pending (current)) {
638 mutex_lock(&s->mutex);
640 if (usb_set_interface (s->usbdev, _DABUSB_IF, 1) < 0) {
641 mutex_unlock(&s->mutex);
642 dev_err(&s->usbdev->dev, "set_interface failed\n");
646 mutex_unlock(&s->mutex);
649 file->private_data = s;
651 return nonseekable_open(inode, file);
654 static int dabusb_release (struct inode *inode, struct file *file)
656 pdabusb_t s = (pdabusb_t) file->private_data;
658 dbg("dabusb_release");
660 mutex_lock(&s->mutex);
662 dabusb_free_buffers (s);
663 mutex_unlock(&s->mutex);
665 if (!s->remove_pending) {
666 if (usb_set_interface (s->usbdev, _DABUSB_IF, 0) < 0)
667 dev_err(&s->usbdev->dev, "set_interface failed\n");
670 wake_up (&s->remove_ok);
676 static int dabusb_ioctl (struct inode *inode, struct file *file, unsigned int cmd, unsigned long arg)
678 pdabusb_t s = (pdabusb_t) file->private_data;
679 pbulk_transfer_t pbulk;
681 int version = DABUSB_VERSION;
685 if (s->remove_pending)
688 mutex_lock(&s->mutex);
691 mutex_unlock(&s->mutex);
698 pbulk = kmalloc(sizeof (bulk_transfer_t), GFP_KERNEL);
705 if (copy_from_user (pbulk, (void __user *) arg, sizeof (bulk_transfer_t))) {
711 ret=dabusb_bulk (s, pbulk);
713 if (copy_to_user((void __user *)arg, pbulk,
714 sizeof(bulk_transfer_t)))
719 case IOCTL_DAB_OVERRUNS:
720 ret = put_user (s->overruns, (unsigned int __user *) arg);
723 case IOCTL_DAB_VERSION:
724 ret = put_user (version, (unsigned int __user *) arg);
731 mutex_unlock(&s->mutex);
735 static const struct file_operations dabusb_fops =
737 .owner = THIS_MODULE,
740 .ioctl = dabusb_ioctl,
742 .release = dabusb_release,
745 static struct usb_class_driver dabusb_class = {
747 .fops = &dabusb_fops,
748 .minor_base = DABUSB_MINOR,
752 /* --------------------------------------------------------------------- */
753 static int dabusb_probe (struct usb_interface *intf,
754 const struct usb_device_id *id)
756 struct usb_device *usbdev = interface_to_usbdev(intf);
760 dbg("dabusb: probe: vendor id 0x%x, device id 0x%x ifnum:%d",
761 le16_to_cpu(usbdev->descriptor.idVendor),
762 le16_to_cpu(usbdev->descriptor.idProduct),
763 intf->altsetting->desc.bInterfaceNumber);
765 /* We don't handle multiple configurations */
766 if (usbdev->descriptor.bNumConfigurations != 1)
769 if (intf->altsetting->desc.bInterfaceNumber != _DABUSB_IF &&
770 le16_to_cpu(usbdev->descriptor.idProduct) == 0x9999)
775 s = &dabusb[intf->minor];
777 mutex_lock(&s->mutex);
778 s->remove_pending = 0;
780 s->devnum = intf->minor;
782 if (usb_reset_configuration (usbdev) < 0) {
783 dev_err(&intf->dev, "reset_configuration failed\n");
786 if (le16_to_cpu(usbdev->descriptor.idProduct) == 0x2131) {
787 dabusb_loadmem (s, NULL);
791 dabusb_fpga_download (s, NULL);
793 if (usb_set_interface (s->usbdev, _DABUSB_IF, 0) < 0) {
794 dev_err(&intf->dev, "set_interface failed\n");
798 dbg("bound to interface: %d", intf->altsetting->desc.bInterfaceNumber);
799 usb_set_intfdata (intf, s);
800 mutex_unlock(&s->mutex);
802 retval = usb_register_dev(intf, &dabusb_class);
804 usb_set_intfdata (intf, NULL);
811 mutex_unlock(&s->mutex);
816 static void dabusb_disconnect (struct usb_interface *intf)
819 pdabusb_t s = usb_get_intfdata (intf);
821 dbg("dabusb_disconnect");
823 init_waitqueue_entry(&__wait, current);
825 usb_set_intfdata (intf, NULL);
827 usb_deregister_dev (intf, &dabusb_class);
828 s->remove_pending = 1;
830 add_wait_queue(&s->remove_ok, &__wait);
831 set_current_state(TASK_UNINTERRUPTIBLE);
832 if (s->state == _started)
834 current->state = TASK_RUNNING;
835 remove_wait_queue(&s->remove_ok, &__wait);
842 static struct usb_device_id dabusb_ids [] = {
843 // { USB_DEVICE(0x0547, 0x2131) }, /* An2131 chip, no boot ROM */
844 { USB_DEVICE(0x0547, 0x9999) },
845 { } /* Terminating entry */
848 MODULE_DEVICE_TABLE (usb, dabusb_ids);
850 static struct usb_driver dabusb_driver = {
852 .probe = dabusb_probe,
853 .disconnect = dabusb_disconnect,
854 .id_table = dabusb_ids,
857 /* --------------------------------------------------------------------- */
859 static int __init dabusb_init (void)
864 /* initialize struct */
865 for (u = 0; u < NRDABUSB; u++) {
866 pdabusb_t s = &dabusb[u];
867 memset (s, 0, sizeof (dabusb_t));
868 mutex_init (&s->mutex);
870 s->total_buffer_size = buffers;
871 init_waitqueue_head (&s->wait);
872 init_waitqueue_head (&s->remove_ok);
873 spin_lock_init (&s->lock);
874 INIT_LIST_HEAD (&s->free_buff_list);
875 INIT_LIST_HEAD (&s->rec_buff_list);
878 /* register misc device */
879 retval = usb_register(&dabusb_driver);
883 dbg("dabusb_init: driver registered");
885 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
892 static void __exit dabusb_cleanup (void)
894 dbg("dabusb_cleanup");
896 usb_deregister (&dabusb_driver);
899 /* --------------------------------------------------------------------- */
901 MODULE_AUTHOR( DRIVER_AUTHOR );
902 MODULE_DESCRIPTION( DRIVER_DESC );
903 MODULE_LICENSE("GPL");
905 module_param(buffers, int, 0);
906 MODULE_PARM_DESC (buffers, "Number of buffers (default=256)");
908 module_init (dabusb_init);
909 module_exit (dabusb_cleanup);
911 /* --------------------------------------------------------------------- */