2 * Copyright (C) 2004 Bernd Porr, Bernd.Porr@f2s.com
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 * I must give credit here to Chris Baugher who
21 * wrote the driver for AT-MIO-16d. I used some parts of this
22 * driver. I also must give credits to David Brownell
23 * who supported me with the USB development.
29 * 0.9: Dropping the first data packet which seems to be from the last transfer.
30 * Buffer overflows in the FX2 are handed over to comedi.
31 * 0.92: Dropping now 4 packets. The quad buffer has to be emptied.
32 * Added insn command basically for testing. Sample rate is
34 * 0.99: Ian Abbott pointed out a bug which has been corrected. Thanks!
35 * 0.99a: added external trigger.
36 * 1.00: added firmware kernel request to the driver which fixed
37 * udev coldplug problem
40 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
42 #include <linux/kernel.h>
43 #include <linux/firmware.h>
44 #include <linux/module.h>
45 #include <linux/init.h>
46 #include <linux/slab.h>
47 #include <linux/input.h>
48 #include <linux/usb.h>
49 #include <linux/fcntl.h>
50 #include <linux/compiler.h>
51 #include "comedi_fc.h"
52 #include "../comedidev.h"
55 * timeout for the USB-transfer
60 * constants for "firmware" upload and download
62 #define FIRMWARE "usbduxfast_firmware.bin"
63 #define USBDUXFASTSUB_FIRMWARE 0xA0
64 #define VENDOR_DIR_IN 0xC0
65 #define VENDOR_DIR_OUT 0x40
68 * internal addresses of the 8051 processor
70 #define USBDUXFASTSUB_CPUCS 0xE600
73 * max lenghth of the transfer-buffer for software upload
78 * input endpoint number
83 * endpoint for the A/D channellist: bulk OUT
85 #define CHANNELLISTEP 4
90 #define NUMCHANNELS 32
93 * size of the waveform descriptor
98 * size of one A/D value
100 #define SIZEADIN (sizeof(int16_t))
103 * size of the input-buffer IN BYTES
105 #define SIZEINBUF 512
110 #define SIZEINSNBUF 512
113 * size of the buffer for the dux commands in bytes
115 #define SIZEOFDUXBUFFER 256
118 * number of in-URBs which receive the data: min=5
120 #define NUMOFINBUFFERSHIGH 10
123 * total number of usbduxfast devices
125 #define NUMUSBDUXFAST 16
128 * analogue in subdevice
133 * min delay steps for more than one channel
134 * basically when the mux gives up ;-)
136 * steps at 30MHz in the FX2
138 #define MIN_SAMPLING_PERIOD 9
141 * max number of 1/30MHz delay steps
143 #define MAX_SAMPLING_PERIOD 500
146 * number of received packets to ignore before we start handing data
147 * over to comedi, it's quad buffering and we have to ignore 4 packets
149 #define PACKETS_TO_IGNORE 4
154 static const struct comedi_lrange range_usbduxfast_ai_range = {
155 2, {BIP_RANGE(0.75), BIP_RANGE(0.5)}
159 * private structure of one subdevice
161 * this is the structure which holds all the data of this driver
162 * one sub device just now: A/D
164 struct usbduxfastsub_s {
165 int attached; /* is attached? */
166 int probed; /* is it associated with a subdevice? */
167 struct usb_device *usbdev; /* pointer to the usb-device */
168 struct urb *urbIn; /* BULK-transfer handling: urb */
169 int8_t *transfer_buffer;
170 int16_t *insnBuffer; /* input buffer for single insn */
171 int ifnum; /* interface number */
172 struct usb_interface *interface; /* interface structure */
173 /* comedi device for the interrupt context */
174 struct comedi_device *comedidev;
175 short int ai_cmd_running; /* asynchronous command is running */
176 short int ai_continous; /* continous acquisition */
177 long int ai_sample_count; /* number of samples to acquire */
178 uint8_t *dux_commands; /* commands */
179 int ignore; /* counter which ignores the first
181 struct semaphore sem;
185 * The pointer to the private usb-data of the driver
186 * is also the private data for the comedi-device.
187 * This has to be global as the usb subsystem needs
188 * global variables. The other reason is that this
189 * structure must be there _before_ any comedi
190 * command is issued. The usb subsystem must be
191 * initialised before comedi can access it.
193 static struct usbduxfastsub_s usbduxfastsub[NUMUSBDUXFAST];
195 static DEFINE_SEMAPHORE(start_stop_sem);
198 * bulk transfers to usbduxfast
200 #define SENDADCOMMANDS 0
201 #define SENDINITEP6 1
203 static int send_dux_commands(struct usbduxfastsub_s *udfs, int cmd_type)
207 udfs->dux_commands[0] = cmd_type;
209 #ifdef CONFIG_COMEDI_DEBUG
210 printk(KERN_DEBUG "comedi%d: usbduxfast: dux_commands: ",
211 udfs->comedidev->minor);
212 for (tmp = 0; tmp < SIZEOFDUXBUFFER; tmp++)
213 printk(" %02x", udfs->dux_commands[tmp]);
217 tmp = usb_bulk_msg(udfs->usbdev,
218 usb_sndbulkpipe(udfs->usbdev, CHANNELLISTEP),
219 udfs->dux_commands, SIZEOFDUXBUFFER, &nsent, 10000);
221 dev_err(&udfs->interface->dev,
222 "could not transmit dux_commands to the usb-device, err=%d\n",
228 * Stops the data acquision.
229 * It should be safe to call this function from any context.
231 static int usbduxfastsub_unlink_InURBs(struct usbduxfastsub_s *udfs)
236 if (udfs && udfs->urbIn) {
237 udfs->ai_cmd_running = 0;
238 /* waits until a running transfer is over */
239 usb_kill_urb(udfs->urbIn);
242 #ifdef CONFIG_COMEDI_DEBUG
243 printk(KERN_DEBUG "comedi: usbduxfast: unlinked InURB: res=%d\n", j);
249 * This will stop a running acquisition operation.
250 * Is called from within this driver from both the
251 * interrupt context and from comedi.
253 static int usbduxfast_ai_stop(struct usbduxfastsub_s *udfs, int do_unlink)
258 pr_err("%s: udfs=NULL!\n", __func__);
261 #ifdef CONFIG_COMEDI_DEBUG
262 printk(KERN_DEBUG "comedi: usbduxfast_ai_stop\n");
265 udfs->ai_cmd_running = 0;
269 ret = usbduxfastsub_unlink_InURBs(udfs);
275 * This will cancel a running acquisition operation.
276 * This is called by comedi but never from inside the driver.
278 static int usbduxfast_ai_cancel(struct comedi_device *dev,
279 struct comedi_subdevice *s)
281 struct usbduxfastsub_s *udfs;
284 /* force unlink of all urbs */
285 #ifdef CONFIG_COMEDI_DEBUG
286 printk(KERN_DEBUG "comedi: usbduxfast_ai_cancel\n");
290 dev_err(dev->class_dev, "%s: udfs=NULL\n", __func__);
299 ret = usbduxfast_ai_stop(udfs, 1);
307 * interrupt service routine
309 static void usbduxfastsub_ai_Irq(struct urb *urb)
312 struct usbduxfastsub_s *udfs;
313 struct comedi_device *this_comedidev;
314 struct comedi_subdevice *s;
316 /* sanity checks - is the urb there? */
318 pr_err("ao int-handler called with urb=NULL!\n");
321 /* the context variable points to the subdevice */
322 this_comedidev = urb->context;
323 if (!this_comedidev) {
324 pr_err("urb context is a NULL pointer!\n");
327 /* the private structure of the subdevice is usbduxfastsub_s */
328 udfs = this_comedidev->private;
330 pr_err("private of comedi subdev is a NULL pointer!\n");
333 /* are we running a command? */
334 if (unlikely(!udfs->ai_cmd_running)) {
336 * not running a command
337 * do not continue execution if no asynchronous command
338 * is running in particular not resubmit
343 if (unlikely(!udfs->attached)) {
344 /* no comedi device there */
347 /* subdevice which is the AD converter */
348 s = &this_comedidev->subdevices[SUBDEV_AD];
350 /* first we test if something unusual has just happened */
351 switch (urb->status) {
356 * happens after an unlink command or when the device
363 /* tell this comedi */
364 s->async->events |= COMEDI_CB_EOA;
365 s->async->events |= COMEDI_CB_ERROR;
366 comedi_event(udfs->comedidev, s);
367 /* stop the transfer w/o unlink */
368 usbduxfast_ai_stop(udfs, 0);
372 pr_err("non-zero urb status received in ai intr context: %d\n",
374 s->async->events |= COMEDI_CB_EOA;
375 s->async->events |= COMEDI_CB_ERROR;
376 comedi_event(udfs->comedidev, s);
377 usbduxfast_ai_stop(udfs, 0);
382 if (!udfs->ai_continous) {
383 /* not continuous, fixed number of samples */
384 n = urb->actual_length / sizeof(uint16_t);
385 if (unlikely(udfs->ai_sample_count < n)) {
387 * we have send only a fraction of the bytes
390 cfc_write_array_to_buffer(s,
391 urb->transfer_buffer,
392 udfs->ai_sample_count
394 usbduxfast_ai_stop(udfs, 0);
395 /* tell comedi that the acquistion is over */
396 s->async->events |= COMEDI_CB_EOA;
397 comedi_event(udfs->comedidev, s);
400 udfs->ai_sample_count -= n;
402 /* write the full buffer to comedi */
403 err = cfc_write_array_to_buffer(s, urb->transfer_buffer,
405 if (unlikely(err == 0)) {
406 /* buffer overflow */
407 usbduxfast_ai_stop(udfs, 0);
411 /* tell comedi that data is there */
412 comedi_event(udfs->comedidev, s);
415 /* ignore this packet */
420 * command is still running
421 * resubmit urb for BULK transfer
423 urb->dev = udfs->usbdev;
425 err = usb_submit_urb(urb, GFP_ATOMIC);
427 dev_err(&urb->dev->dev,
428 "urb resubm failed: %d", err);
429 s->async->events |= COMEDI_CB_EOA;
430 s->async->events |= COMEDI_CB_ERROR;
431 comedi_event(udfs->comedidev, s);
432 usbduxfast_ai_stop(udfs, 0);
436 static int usbduxfastsub_start(struct usbduxfastsub_s *udfs)
439 unsigned char local_transfer_buffer[16];
442 local_transfer_buffer[0] = 0;
443 /* bRequest, "Firmware" */
444 ret = usb_control_msg(udfs->usbdev, usb_sndctrlpipe(udfs->usbdev, 0),
445 USBDUXFASTSUB_FIRMWARE,
446 VENDOR_DIR_OUT, /* bmRequestType */
447 USBDUXFASTSUB_CPUCS, /* Value */
449 /* address of the transfer buffer */
450 local_transfer_buffer,
452 EZTIMEOUT); /* Timeout */
454 dev_err(&udfs->interface->dev,
455 "control msg failed (start)\n");
462 static int usbduxfastsub_stop(struct usbduxfastsub_s *udfs)
465 unsigned char local_transfer_buffer[16];
468 local_transfer_buffer[0] = 1;
469 /* bRequest, "Firmware" */
470 ret = usb_control_msg(udfs->usbdev, usb_sndctrlpipe(udfs->usbdev, 0),
471 USBDUXFASTSUB_FIRMWARE,
472 VENDOR_DIR_OUT, /* bmRequestType */
473 USBDUXFASTSUB_CPUCS, /* Value */
475 local_transfer_buffer, 1, /* Length */
476 EZTIMEOUT); /* Timeout */
478 dev_err(&udfs->interface->dev,
479 "control msg failed (stop)\n");
486 static int usbduxfastsub_upload(struct usbduxfastsub_s *udfs,
487 unsigned char *local_transfer_buffer,
488 unsigned int startAddr, unsigned int len)
492 #ifdef CONFIG_COMEDI_DEBUG
493 printk(KERN_DEBUG "comedi: usbduxfast: uploading %d bytes", len);
494 printk(KERN_DEBUG " to addr %d, first byte=%d.\n",
495 startAddr, local_transfer_buffer[0]);
497 /* brequest, firmware */
498 ret = usb_control_msg(udfs->usbdev, usb_sndctrlpipe(udfs->usbdev, 0),
499 USBDUXFASTSUB_FIRMWARE,
500 VENDOR_DIR_OUT, /* bmRequestType */
501 startAddr, /* value */
503 /* our local safe buffer */
504 local_transfer_buffer,
506 EZTIMEOUT); /* timeout */
508 #ifdef CONFIG_COMEDI_DEBUG
509 printk(KERN_DEBUG "comedi_: usbduxfast: result=%d\n", ret);
513 dev_err(&udfs->interface->dev, "uppload failed\n");
520 static int usbduxfastsub_submit_InURBs(struct usbduxfastsub_s *udfs)
527 usb_fill_bulk_urb(udfs->urbIn, udfs->usbdev,
528 usb_rcvbulkpipe(udfs->usbdev, BULKINEP),
529 udfs->transfer_buffer,
530 SIZEINBUF, usbduxfastsub_ai_Irq, udfs->comedidev);
532 #ifdef CONFIG_COMEDI_DEBUG
533 printk(KERN_DEBUG "comedi%d: usbduxfast: submitting in-urb: "
534 "0x%p,0x%p\n", udfs->comedidev->minor, udfs->urbIn->context,
537 ret = usb_submit_urb(udfs->urbIn, GFP_ATOMIC);
539 dev_err(&udfs->interface->dev,
540 "ai: usb_submit_urb error %d\n", ret);
546 static int usbduxfast_ai_cmdtest(struct comedi_device *dev,
547 struct comedi_subdevice *s,
548 struct comedi_cmd *cmd)
550 struct usbduxfastsub_s *udfs = dev->private;
558 /* Step 1 : check if triggers are trivially valid */
560 err |= cfc_check_trigger_src(&cmd->start_src,
561 TRIG_NOW | TRIG_EXT | TRIG_INT);
562 err |= cfc_check_trigger_src(&cmd->scan_begin_src,
563 TRIG_TIMER | TRIG_FOLLOW | TRIG_EXT);
564 err |= cfc_check_trigger_src(&cmd->convert_src, TRIG_TIMER | TRIG_EXT);
565 err |= cfc_check_trigger_src(&cmd->scan_end_src, TRIG_COUNT);
566 err |= cfc_check_trigger_src(&cmd->stop_src, TRIG_COUNT | TRIG_NONE);
571 /* Step 2a : make sure trigger sources are unique */
573 err |= cfc_check_trigger_is_unique(cmd->start_src);
574 err |= cfc_check_trigger_is_unique(cmd->scan_begin_src);
575 err |= cfc_check_trigger_is_unique(cmd->convert_src);
576 err |= cfc_check_trigger_is_unique(cmd->stop_src);
578 /* Step 2b : and mutually compatible */
580 /* can't have external stop and start triggers at once */
581 if (cmd->start_src == TRIG_EXT && cmd->stop_src == TRIG_EXT)
587 /* Step 3: check if arguments are trivially valid */
589 if (cmd->start_src == TRIG_NOW)
590 err |= cfc_check_trigger_arg_is(&cmd->start_arg, 0);
592 if (!cmd->chanlist_len)
595 err |= cfc_check_trigger_arg_is(&cmd->scan_end_arg, cmd->chanlist_len);
597 if (cmd->chanlist_len == 1)
600 minSamplPer = MIN_SAMPLING_PERIOD;
602 if (cmd->convert_src == TRIG_TIMER) {
603 steps = cmd->convert_arg * 30;
604 if (steps < (minSamplPer * 1000))
605 steps = minSamplPer * 1000;
607 if (steps > (MAX_SAMPLING_PERIOD * 1000))
608 steps = MAX_SAMPLING_PERIOD * 1000;
612 err |= cfc_check_trigger_arg_is(&cmd->convert_arg, tmp);
615 if (cmd->scan_begin_src == TRIG_TIMER)
619 switch (cmd->stop_src) {
621 err |= cfc_check_trigger_arg_min(&cmd->stop_arg, 1);
624 err |= cfc_check_trigger_arg_is(&cmd->stop_arg, 0);
627 * TRIG_EXT doesn't care since it doesn't trigger
628 * off a numbered channel
637 /* step 4: fix up any arguments */
643 static int usbduxfast_ai_inttrig(struct comedi_device *dev,
644 struct comedi_subdevice *s,
645 unsigned int trignum)
648 struct usbduxfastsub_s *udfs = dev->private;
658 #ifdef CONFIG_COMEDI_DEBUG
659 printk(KERN_DEBUG "comedi%d: usbduxfast_ai_inttrig\n", dev->minor);
663 dev_err(dev->class_dev, "%s: invalid trignum\n", __func__);
667 if (!udfs->ai_cmd_running) {
668 udfs->ai_cmd_running = 1;
669 ret = usbduxfastsub_submit_InURBs(udfs);
671 dev_err(dev->class_dev,
672 "%s: urbSubmit: err=%d\n", __func__, ret);
673 udfs->ai_cmd_running = 0;
677 s->async->inttrig = NULL;
679 dev_err(dev->class_dev,
680 "ai_inttrig but acqu is already running\n");
687 * offsets for the GPIF bytes
688 * the first byte is the command byte
690 #define LENBASE (1+0x00)
691 #define OPBASE (1+0x08)
692 #define OUTBASE (1+0x10)
693 #define LOGBASE (1+0x18)
695 static int usbduxfast_ai_cmd(struct comedi_device *dev,
696 struct comedi_subdevice *s)
698 struct comedi_cmd *cmd = &s->async->cmd;
699 unsigned int chan, gain, rngmask = 0xff;
701 struct usbduxfastsub_s *udfs;
703 long steps, steps_tmp;
705 #ifdef CONFIG_COMEDI_DEBUG
706 printk(KERN_DEBUG "comedi%d: usbduxfast_ai_cmd\n", dev->minor);
717 if (udfs->ai_cmd_running) {
718 dev_err(dev->class_dev,
719 "ai_cmd not possible. Another ai_cmd is running.\n");
723 /* set current channel of the running acquisition to zero */
724 s->async->cur_chan = 0;
727 * ignore the first buffers from the device if there
728 * is an error condition
730 udfs->ignore = PACKETS_TO_IGNORE;
732 if (cmd->chanlist_len > 0) {
733 gain = CR_RANGE(cmd->chanlist[0]);
734 for (i = 0; i < cmd->chanlist_len; ++i) {
735 chan = CR_CHAN(cmd->chanlist[i]);
737 dev_err(dev->class_dev,
738 "cmd is accepting only consecutive channels.\n");
742 if ((gain != CR_RANGE(cmd->chanlist[i]))
743 && (cmd->chanlist_len > 3)) {
744 dev_err(dev->class_dev,
745 "the gain must be the same for all channels.\n");
749 if (i >= NUMCHANNELS) {
750 dev_err(dev->class_dev,
751 "channel list too long\n");
757 if (cmd->scan_begin_src == TRIG_TIMER) {
758 dev_err(dev->class_dev,
759 "scan_begin_src==TRIG_TIMER not valid.\n");
763 if (cmd->convert_src == TRIG_TIMER)
764 steps = (cmd->convert_arg * 30) / 1000;
766 if ((steps < MIN_SAMPLING_PERIOD) && (cmd->chanlist_len != 1)) {
767 dev_err(dev->class_dev,
768 "ai_cmd: steps=%ld, scan_begin_arg=%d. Not properly tested by cmdtest?\n",
769 steps, cmd->scan_begin_arg);
773 if (steps > MAX_SAMPLING_PERIOD) {
774 dev_err(dev->class_dev, "ai_cmd: sampling rate too low.\n");
778 if ((cmd->start_src == TRIG_EXT) && (cmd->chanlist_len != 1)
779 && (cmd->chanlist_len != 16)) {
780 dev_err(dev->class_dev,
781 "ai_cmd: TRIG_EXT only with 1 or 16 channels possible.\n");
785 #ifdef CONFIG_COMEDI_DEBUG
786 printk(KERN_DEBUG "comedi%d: usbduxfast: steps=%ld, convert_arg=%u\n",
787 dev->minor, steps, cmd->convert_arg);
790 switch (cmd->chanlist_len) {
796 if (CR_RANGE(cmd->chanlist[0]) > 0)
797 rngmask = 0xff - 0x04;
802 * for external trigger: looping in this state until
803 * the RDY0 pin becomes zero
806 /* we loop here until ready has been set */
807 if (cmd->start_src == TRIG_EXT) {
808 /* branch back to state 0 */
809 udfs->dux_commands[LENBASE + 0] = 0x01;
810 /* deceision state w/o data */
811 udfs->dux_commands[OPBASE + 0] = 0x01;
812 udfs->dux_commands[OUTBASE + 0] = 0xFF & rngmask;
814 udfs->dux_commands[LOGBASE + 0] = 0x00;
815 } else { /* we just proceed to state 1 */
816 udfs->dux_commands[LENBASE + 0] = 1;
817 udfs->dux_commands[OPBASE + 0] = 0;
818 udfs->dux_commands[OUTBASE + 0] = 0xFF & rngmask;
819 udfs->dux_commands[LOGBASE + 0] = 0;
822 if (steps < MIN_SAMPLING_PERIOD) {
823 /* for fast single channel aqu without mux */
826 * we just stay here at state 1 and rexecute
827 * the same state this gives us 30MHz sampling
831 /* branch back to state 1 */
832 udfs->dux_commands[LENBASE + 1] = 0x89;
833 /* deceision state with data */
834 udfs->dux_commands[OPBASE + 1] = 0x03;
835 udfs->dux_commands[OUTBASE + 1] =
838 udfs->dux_commands[LOGBASE + 1] = 0xFF;
841 * we loop through two states: data and delay
844 udfs->dux_commands[LENBASE + 1] = steps - 1;
846 udfs->dux_commands[OPBASE + 1] = 0x02;
847 udfs->dux_commands[OUTBASE + 1] =
850 udfs->dux_commands[LOGBASE + 1] = 0;
851 /* branch back to state 1 */
852 udfs->dux_commands[LENBASE + 2] = 0x09;
853 /* deceision state w/o data */
854 udfs->dux_commands[OPBASE + 2] = 0x01;
855 udfs->dux_commands[OUTBASE + 2] =
858 udfs->dux_commands[LOGBASE + 2] = 0xFF;
862 * we loop through 3 states: 2x delay and 1x data
863 * this gives a min sampling rate of 60kHz
866 /* we have 1 state with duration 1 */
869 /* do the first part of the delay */
870 udfs->dux_commands[LENBASE + 1] = steps / 2;
871 udfs->dux_commands[OPBASE + 1] = 0;
872 udfs->dux_commands[OUTBASE + 1] = 0xFF & rngmask;
873 udfs->dux_commands[LOGBASE + 1] = 0;
875 /* and the second part */
876 udfs->dux_commands[LENBASE + 2] = steps - steps / 2;
877 udfs->dux_commands[OPBASE + 2] = 0;
878 udfs->dux_commands[OUTBASE + 2] = 0xFF & rngmask;
879 udfs->dux_commands[LOGBASE + 2] = 0;
881 /* get the data and branch back */
883 /* branch back to state 1 */
884 udfs->dux_commands[LENBASE + 3] = 0x09;
885 /* deceision state w data */
886 udfs->dux_commands[OPBASE + 3] = 0x03;
887 udfs->dux_commands[OUTBASE + 3] = 0xFF & rngmask;
889 udfs->dux_commands[LOGBASE + 3] = 0xFF;
896 * commit data to the FIFO
899 if (CR_RANGE(cmd->chanlist[0]) > 0)
900 rngmask = 0xff - 0x04;
904 udfs->dux_commands[LENBASE + 0] = 1;
906 udfs->dux_commands[OPBASE + 0] = 0x02;
907 udfs->dux_commands[OUTBASE + 0] = 0xFF & rngmask;
908 udfs->dux_commands[LOGBASE + 0] = 0;
910 /* we have 1 state with duration 1: state 0 */
911 steps_tmp = steps - 1;
913 if (CR_RANGE(cmd->chanlist[1]) > 0)
914 rngmask = 0xff - 0x04;
918 /* do the first part of the delay */
919 udfs->dux_commands[LENBASE + 1] = steps_tmp / 2;
920 udfs->dux_commands[OPBASE + 1] = 0;
922 udfs->dux_commands[OUTBASE + 1] = 0xFE & rngmask;
923 udfs->dux_commands[LOGBASE + 1] = 0;
925 /* and the second part */
926 udfs->dux_commands[LENBASE + 2] = steps_tmp - steps_tmp / 2;
927 udfs->dux_commands[OPBASE + 2] = 0;
928 udfs->dux_commands[OUTBASE + 2] = 0xFF & rngmask;
929 udfs->dux_commands[LOGBASE + 2] = 0;
931 udfs->dux_commands[LENBASE + 3] = 1;
933 udfs->dux_commands[OPBASE + 3] = 0x02;
934 udfs->dux_commands[OUTBASE + 3] = 0xFF & rngmask;
935 udfs->dux_commands[LOGBASE + 3] = 0;
938 * we have 2 states with duration 1: step 6 and
941 steps_tmp = steps - 2;
943 if (CR_RANGE(cmd->chanlist[0]) > 0)
944 rngmask = 0xff - 0x04;
948 /* do the first part of the delay */
949 udfs->dux_commands[LENBASE + 4] = steps_tmp / 2;
950 udfs->dux_commands[OPBASE + 4] = 0;
952 udfs->dux_commands[OUTBASE + 4] = (0xFF - 0x02) & rngmask;
953 udfs->dux_commands[LOGBASE + 4] = 0;
955 /* and the second part */
956 udfs->dux_commands[LENBASE + 5] = steps_tmp - steps_tmp / 2;
957 udfs->dux_commands[OPBASE + 5] = 0;
958 udfs->dux_commands[OUTBASE + 5] = 0xFF & rngmask;
959 udfs->dux_commands[LOGBASE + 5] = 0;
961 udfs->dux_commands[LENBASE + 6] = 1;
962 udfs->dux_commands[OPBASE + 6] = 0;
963 udfs->dux_commands[OUTBASE + 6] = 0xFF & rngmask;
964 udfs->dux_commands[LOGBASE + 6] = 0;
971 for (j = 0; j < 1; j++) {
972 if (CR_RANGE(cmd->chanlist[j]) > 0)
973 rngmask = 0xff - 0x04;
977 * commit data to the FIFO and do the first part
980 udfs->dux_commands[LENBASE + j * 2] = steps / 2;
982 udfs->dux_commands[OPBASE + j * 2] = 0x02;
984 udfs->dux_commands[OUTBASE + j * 2] = 0xFF & rngmask;
985 udfs->dux_commands[LOGBASE + j * 2] = 0;
987 if (CR_RANGE(cmd->chanlist[j + 1]) > 0)
988 rngmask = 0xff - 0x04;
992 /* do the second part of the delay */
993 udfs->dux_commands[LENBASE + j * 2 + 1] =
996 udfs->dux_commands[OPBASE + j * 2 + 1] = 0;
998 udfs->dux_commands[OUTBASE + j * 2 + 1] =
1000 udfs->dux_commands[LOGBASE + j * 2 + 1] = 0;
1003 /* 2 steps with duration 1: the idele step and step 6: */
1004 steps_tmp = steps - 2;
1006 /* commit data to the FIFO and do the first part of the delay */
1007 udfs->dux_commands[LENBASE + 4] = steps_tmp / 2;
1009 udfs->dux_commands[OPBASE + 4] = 0x02;
1010 udfs->dux_commands[OUTBASE + 4] = 0xFF & rngmask;
1011 udfs->dux_commands[LOGBASE + 4] = 0;
1013 if (CR_RANGE(cmd->chanlist[0]) > 0)
1014 rngmask = 0xff - 0x04;
1018 /* do the second part of the delay */
1019 udfs->dux_commands[LENBASE + 5] = steps_tmp - steps_tmp / 2;
1021 udfs->dux_commands[OPBASE + 5] = 0;
1023 udfs->dux_commands[OUTBASE + 5] = (0xFF - 0x02) & rngmask;
1024 udfs->dux_commands[LOGBASE + 5] = 0;
1026 udfs->dux_commands[LENBASE + 6] = 1;
1027 udfs->dux_commands[OPBASE + 6] = 0;
1028 udfs->dux_commands[OUTBASE + 6] = 0xFF & rngmask;
1029 udfs->dux_commands[LOGBASE + 6] = 0;
1032 if (CR_RANGE(cmd->chanlist[0]) > 0)
1033 rngmask = 0xff - 0x04;
1037 if (cmd->start_src == TRIG_EXT) {
1039 * we loop here until ready has been set
1042 /* branch back to state 0 */
1043 udfs->dux_commands[LENBASE + 0] = 0x01;
1044 /* deceision state w/o data */
1045 udfs->dux_commands[OPBASE + 0] = 0x01;
1047 udfs->dux_commands[OUTBASE + 0] =
1048 (0xFF - 0x02) & rngmask;
1050 udfs->dux_commands[LOGBASE + 0] = 0x00;
1053 * we just proceed to state 1
1056 /* 30us reset pulse */
1057 udfs->dux_commands[LENBASE + 0] = 255;
1058 udfs->dux_commands[OPBASE + 0] = 0;
1060 udfs->dux_commands[OUTBASE + 0] =
1061 (0xFF - 0x02) & rngmask;
1062 udfs->dux_commands[LOGBASE + 0] = 0;
1065 /* commit data to the FIFO */
1066 udfs->dux_commands[LENBASE + 1] = 1;
1068 udfs->dux_commands[OPBASE + 1] = 0x02;
1069 udfs->dux_commands[OUTBASE + 1] = 0xFF & rngmask;
1070 udfs->dux_commands[LOGBASE + 1] = 0;
1072 /* we have 2 states with duration 1 */
1075 /* do the first part of the delay */
1076 udfs->dux_commands[LENBASE + 2] = steps / 2;
1077 udfs->dux_commands[OPBASE + 2] = 0;
1078 udfs->dux_commands[OUTBASE + 2] = 0xFE & rngmask;
1079 udfs->dux_commands[LOGBASE + 2] = 0;
1081 /* and the second part */
1082 udfs->dux_commands[LENBASE + 3] = steps - steps / 2;
1083 udfs->dux_commands[OPBASE + 3] = 0;
1084 udfs->dux_commands[OUTBASE + 3] = 0xFF & rngmask;
1085 udfs->dux_commands[LOGBASE + 3] = 0;
1087 /* branch back to state 1 */
1088 udfs->dux_commands[LENBASE + 4] = 0x09;
1089 /* deceision state w/o data */
1090 udfs->dux_commands[OPBASE + 4] = 0x01;
1091 udfs->dux_commands[OUTBASE + 4] = 0xFF & rngmask;
1092 /* doesn't matter */
1093 udfs->dux_commands[LOGBASE + 4] = 0xFF;
1098 dev_err(dev->class_dev, "unsupported combination of channels\n");
1103 #ifdef CONFIG_COMEDI_DEBUG
1104 printk(KERN_DEBUG "comedi %d: sending commands to the usb device\n",
1107 /* 0 means that the AD commands are sent */
1108 result = send_dux_commands(udfs, SENDADCOMMANDS);
1110 dev_err(dev->class_dev,
1111 "adc command could not be submitted. Aborting...\n");
1115 if (cmd->stop_src == TRIG_COUNT) {
1116 udfs->ai_sample_count = cmd->stop_arg * cmd->scan_end_arg;
1117 if (udfs->ai_sample_count < 1) {
1118 dev_err(dev->class_dev,
1119 "(cmd->stop_arg)*(cmd->scan_end_arg)<1, aborting.\n");
1123 udfs->ai_continous = 0;
1125 /* continous acquisition */
1126 udfs->ai_continous = 1;
1127 udfs->ai_sample_count = 0;
1130 if ((cmd->start_src == TRIG_NOW) || (cmd->start_src == TRIG_EXT)) {
1131 /* enable this acquisition operation */
1132 udfs->ai_cmd_running = 1;
1133 ret = usbduxfastsub_submit_InURBs(udfs);
1135 udfs->ai_cmd_running = 0;
1136 /* fixme: unlink here?? */
1140 s->async->inttrig = NULL;
1144 * don't enable the acquision operation
1145 * wait for an internal signal
1147 s->async->inttrig = usbduxfast_ai_inttrig;
1155 * Mode 0 is used to get a single conversion on demand.
1157 static int usbduxfast_ai_insn_read(struct comedi_device *dev,
1158 struct comedi_subdevice *s,
1159 struct comedi_insn *insn, unsigned int *data)
1161 int i, j, n, actual_length;
1162 int chan, range, rngmask;
1164 struct usbduxfastsub_s *udfs;
1166 udfs = dev->private;
1168 dev_err(dev->class_dev, "%s: no usb dev.\n", __func__);
1171 #ifdef CONFIG_COMEDI_DEBUG
1172 printk(KERN_DEBUG "comedi%d: ai_insn_read, insn->n=%d, "
1173 "insn->subdev=%d\n", dev->minor, insn->n, insn->subdev);
1176 if (!udfs->probed) {
1180 if (udfs->ai_cmd_running) {
1181 dev_err(dev->class_dev,
1182 "ai_insn_read not possible. Async Command is running.\n");
1186 /* sample one channel */
1187 chan = CR_CHAN(insn->chanspec);
1188 range = CR_RANGE(insn->chanspec);
1189 /* set command for the first channel */
1192 rngmask = 0xff - 0x04;
1196 /* commit data to the FIFO */
1197 udfs->dux_commands[LENBASE + 0] = 1;
1199 udfs->dux_commands[OPBASE + 0] = 0x02;
1200 udfs->dux_commands[OUTBASE + 0] = 0xFF & rngmask;
1201 udfs->dux_commands[LOGBASE + 0] = 0;
1203 /* do the first part of the delay */
1204 udfs->dux_commands[LENBASE + 1] = 12;
1205 udfs->dux_commands[OPBASE + 1] = 0;
1206 udfs->dux_commands[OUTBASE + 1] = 0xFE & rngmask;
1207 udfs->dux_commands[LOGBASE + 1] = 0;
1209 udfs->dux_commands[LENBASE + 2] = 1;
1210 udfs->dux_commands[OPBASE + 2] = 0;
1211 udfs->dux_commands[OUTBASE + 2] = 0xFE & rngmask;
1212 udfs->dux_commands[LOGBASE + 2] = 0;
1214 udfs->dux_commands[LENBASE + 3] = 1;
1215 udfs->dux_commands[OPBASE + 3] = 0;
1216 udfs->dux_commands[OUTBASE + 3] = 0xFE & rngmask;
1217 udfs->dux_commands[LOGBASE + 3] = 0;
1219 udfs->dux_commands[LENBASE + 4] = 1;
1220 udfs->dux_commands[OPBASE + 4] = 0;
1221 udfs->dux_commands[OUTBASE + 4] = 0xFE & rngmask;
1222 udfs->dux_commands[LOGBASE + 4] = 0;
1225 udfs->dux_commands[LENBASE + 5] = 12;
1226 udfs->dux_commands[OPBASE + 5] = 0;
1227 udfs->dux_commands[OUTBASE + 5] = 0xFF & rngmask;
1228 udfs->dux_commands[LOGBASE + 5] = 0;
1230 udfs->dux_commands[LENBASE + 6] = 1;
1231 udfs->dux_commands[OPBASE + 6] = 0;
1232 udfs->dux_commands[OUTBASE + 6] = 0xFF & rngmask;
1233 udfs->dux_commands[LOGBASE + 0] = 0;
1235 #ifdef CONFIG_COMEDI_DEBUG
1236 printk(KERN_DEBUG "comedi %d: sending commands to the usb device\n",
1239 /* 0 means that the AD commands are sent */
1240 err = send_dux_commands(udfs, SENDADCOMMANDS);
1242 dev_err(dev->class_dev,
1243 "adc command could not be submitted. Aborting...\n");
1247 #ifdef CONFIG_COMEDI_DEBUG
1248 printk(KERN_DEBUG "comedi%d: usbduxfast: submitting in-urb: "
1249 "0x%p,0x%p\n", udfs->comedidev->minor, udfs->urbIn->context,
1252 for (i = 0; i < PACKETS_TO_IGNORE; i++) {
1253 err = usb_bulk_msg(udfs->usbdev,
1254 usb_rcvbulkpipe(udfs->usbdev, BULKINEP),
1255 udfs->transfer_buffer, SIZEINBUF,
1256 &actual_length, 10000);
1258 dev_err(dev->class_dev, "insn timeout. No data.\n");
1264 for (i = 0; i < insn->n;) {
1265 err = usb_bulk_msg(udfs->usbdev,
1266 usb_rcvbulkpipe(udfs->usbdev, BULKINEP),
1267 udfs->transfer_buffer, SIZEINBUF,
1268 &actual_length, 10000);
1270 dev_err(dev->class_dev, "insn data error: %d\n", err);
1274 n = actual_length / sizeof(uint16_t);
1275 if ((n % 16) != 0) {
1276 dev_err(dev->class_dev, "insn data packet corrupted.\n");
1280 for (j = chan; (j < n) && (i < insn->n); j = j + 16) {
1281 data[i] = ((uint16_t *) (udfs->transfer_buffer))[j];
1289 #define FIRMWARE_MAX_LEN 0x2000
1291 static int firmwareUpload(struct usbduxfastsub_s *usbduxfastsub,
1292 const u8 *firmwareBinary, int sizeFirmware)
1297 if (!firmwareBinary)
1300 if (sizeFirmware > FIRMWARE_MAX_LEN) {
1301 dev_err(&usbduxfastsub->interface->dev,
1302 "comedi_: usbduxfast firmware binary it too large for FX2.\n");
1306 /* we generate a local buffer for the firmware */
1307 fwBuf = kmemdup(firmwareBinary, sizeFirmware, GFP_KERNEL);
1309 dev_err(&usbduxfastsub->interface->dev,
1310 "comedi_: mem alloc for firmware failed\n");
1314 ret = usbduxfastsub_stop(usbduxfastsub);
1316 dev_err(&usbduxfastsub->interface->dev,
1317 "comedi_: can not stop firmware\n");
1322 ret = usbduxfastsub_upload(usbduxfastsub, fwBuf, 0, sizeFirmware);
1324 dev_err(&usbduxfastsub->interface->dev,
1325 "comedi_: firmware upload failed\n");
1329 ret = usbduxfastsub_start(usbduxfastsub);
1331 dev_err(&usbduxfastsub->interface->dev,
1332 "comedi_: can not start firmware\n");
1340 static void tidy_up(struct usbduxfastsub_s *udfs)
1342 #ifdef CONFIG_COMEDI_DEBUG
1343 printk(KERN_DEBUG "comedi_: usbduxfast: tiding up\n");
1349 /* shows the usb subsystem that the driver is down */
1350 if (udfs->interface)
1351 usb_set_intfdata(udfs->interface, NULL);
1356 /* waits until a running transfer is over */
1357 usb_kill_urb(udfs->urbIn);
1359 kfree(udfs->transfer_buffer);
1360 udfs->transfer_buffer = NULL;
1362 usb_free_urb(udfs->urbIn);
1366 kfree(udfs->insnBuffer);
1367 udfs->insnBuffer = NULL;
1369 kfree(udfs->dux_commands);
1370 udfs->dux_commands = NULL;
1372 udfs->ai_cmd_running = 0;
1375 static int usbduxfast_attach_common(struct comedi_device *dev,
1376 struct usbduxfastsub_s *udfs)
1379 struct comedi_subdevice *s;
1382 /* pointer back to the corresponding comedi device */
1383 udfs->comedidev = dev;
1384 dev->board_name = "usbduxfast";
1385 ret = comedi_alloc_subdevices(dev, 1);
1390 /* private structure is also simply the usb-structure */
1391 dev->private = udfs;
1392 /* the first subdevice is the A/D converter */
1393 s = &dev->subdevices[SUBDEV_AD];
1395 * the URBs get the comedi subdevice which is responsible for reading
1396 * this is the subdevice which reads data
1398 dev->read_subdev = s;
1399 /* the subdevice receives as private structure the usb-structure */
1402 s->type = COMEDI_SUBD_AI;
1403 /* readable and ref is to ground */
1404 s->subdev_flags = SDF_READABLE | SDF_GROUND | SDF_CMD_READ;
1407 /* length of the channellist */
1408 s->len_chanlist = 16;
1409 /* callback functions */
1410 s->insn_read = usbduxfast_ai_insn_read;
1411 s->do_cmdtest = usbduxfast_ai_cmdtest;
1412 s->do_cmd = usbduxfast_ai_cmd;
1413 s->cancel = usbduxfast_ai_cancel;
1414 /* max value from the A/D converter (12bit+1 bit for overflow) */
1415 s->maxdata = 0x1000;
1416 /* range table to convert to physical units */
1417 s->range_table = &range_usbduxfast_ai_range;
1418 /* finally decide that it's attached */
1421 dev_info(dev->class_dev, "successfully attached to usbduxfast.\n");
1425 static int usbduxfast_auto_attach(struct comedi_device *dev,
1426 unsigned long context_unused)
1428 struct usb_interface *uinterf = comedi_to_usb_interface(dev);
1430 struct usbduxfastsub_s *udfs;
1432 dev->private = NULL;
1433 down(&start_stop_sem);
1434 udfs = usb_get_intfdata(uinterf);
1435 if (!udfs || !udfs->probed) {
1436 dev_err(dev->class_dev,
1437 "usbduxfast: error: auto_attach failed, not connected\n");
1439 } else if (udfs->attached) {
1440 dev_err(dev->class_dev,
1441 "usbduxfast: error: auto_attach failed, already attached\n");
1444 ret = usbduxfast_attach_common(dev, udfs);
1445 up(&start_stop_sem);
1449 static void usbduxfast_detach(struct comedi_device *dev)
1451 struct usbduxfastsub_s *usb = dev->private;
1455 down(&start_stop_sem);
1456 dev->private = NULL;
1458 usb->comedidev = NULL;
1459 up(&start_stop_sem);
1464 static struct comedi_driver usbduxfast_driver = {
1465 .driver_name = "usbduxfast",
1466 .module = THIS_MODULE,
1467 .auto_attach = usbduxfast_auto_attach,
1468 .detach = usbduxfast_detach,
1471 static void usbduxfast_firmware_request_complete_handler(const struct firmware
1474 struct usbduxfastsub_s *usbduxfastsub_tmp = context;
1475 struct usb_interface *uinterf = usbduxfastsub_tmp->interface;
1482 * we need to upload the firmware here because fw will be
1483 * freed once we've left this function
1485 ret = firmwareUpload(usbduxfastsub_tmp, fw->data, fw->size);
1488 dev_err(&uinterf->dev,
1489 "Could not upload firmware (err=%d)\n", ret);
1493 comedi_usb_auto_config(uinterf, &usbduxfast_driver, 0);
1495 release_firmware(fw);
1498 static int usbduxfast_usb_probe(struct usb_interface *uinterf,
1499 const struct usb_device_id *id)
1501 struct usb_device *udev = interface_to_usbdev(uinterf);
1506 if (udev->speed != USB_SPEED_HIGH) {
1507 dev_err(&uinterf->dev,
1508 "This driver needs USB 2.0 to operate. Aborting...\n");
1511 #ifdef CONFIG_COMEDI_DEBUG
1512 printk(KERN_DEBUG "comedi_: usbduxfast_: finding a free structure for "
1513 "the usb-device\n");
1515 down(&start_stop_sem);
1516 /* look for a free place in the usbduxfast array */
1518 for (i = 0; i < NUMUSBDUXFAST; i++) {
1519 if (!usbduxfastsub[i].probed) {
1527 dev_err(&uinterf->dev,
1528 "Too many usbduxfast-devices connected.\n");
1529 up(&start_stop_sem);
1532 #ifdef CONFIG_COMEDI_DEBUG
1533 printk(KERN_DEBUG "comedi_: usbduxfast: usbduxfastsub[%d] is ready to "
1534 "connect to comedi.\n", index);
1537 sema_init(&(usbduxfastsub[index].sem), 1);
1538 /* save a pointer to the usb device */
1539 usbduxfastsub[index].usbdev = udev;
1541 /* save the interface itself */
1542 usbduxfastsub[index].interface = uinterf;
1543 /* get the interface number from the interface */
1544 usbduxfastsub[index].ifnum = uinterf->altsetting->desc.bInterfaceNumber;
1546 * hand the private data over to the usb subsystem
1547 * will be needed for disconnect
1549 usb_set_intfdata(uinterf, &(usbduxfastsub[index]));
1551 #ifdef CONFIG_COMEDI_DEBUG
1552 printk(KERN_DEBUG "comedi_: usbduxfast: ifnum=%d\n",
1553 usbduxfastsub[index].ifnum);
1555 /* create space for the commands going to the usb device */
1556 usbduxfastsub[index].dux_commands = kmalloc(SIZEOFDUXBUFFER,
1558 if (!usbduxfastsub[index].dux_commands) {
1559 tidy_up(&(usbduxfastsub[index]));
1560 up(&start_stop_sem);
1563 /* create space of the instruction buffer */
1564 usbduxfastsub[index].insnBuffer = kmalloc(SIZEINSNBUF, GFP_KERNEL);
1565 if (!usbduxfastsub[index].insnBuffer) {
1566 tidy_up(&(usbduxfastsub[index]));
1567 up(&start_stop_sem);
1570 /* setting to alternate setting 1: enabling bulk ep */
1571 i = usb_set_interface(usbduxfastsub[index].usbdev,
1572 usbduxfastsub[index].ifnum, 1);
1574 dev_err(&uinterf->dev,
1575 "usbduxfast%d: could not switch to alternate setting 1.\n",
1577 tidy_up(&(usbduxfastsub[index]));
1578 up(&start_stop_sem);
1581 usbduxfastsub[index].urbIn = usb_alloc_urb(0, GFP_KERNEL);
1582 if (!usbduxfastsub[index].urbIn) {
1583 dev_err(&uinterf->dev,
1584 "usbduxfast%d: Could not alloc. urb\n", index);
1585 tidy_up(&(usbduxfastsub[index]));
1586 up(&start_stop_sem);
1589 usbduxfastsub[index].transfer_buffer = kmalloc(SIZEINBUF, GFP_KERNEL);
1590 if (!usbduxfastsub[index].transfer_buffer) {
1591 tidy_up(&(usbduxfastsub[index]));
1592 up(&start_stop_sem);
1595 /* we've reached the bottom of the function */
1596 usbduxfastsub[index].probed = 1;
1597 up(&start_stop_sem);
1599 ret = request_firmware_nowait(THIS_MODULE,
1604 usbduxfastsub + index,
1605 usbduxfast_firmware_request_complete_handler);
1608 dev_err(&uinterf->dev, "could not load firmware (err=%d)\n", ret);
1612 dev_info(&uinterf->dev,
1613 "usbduxfast%d has been successfully initialized.\n", index);
1618 static void usbduxfast_usb_disconnect(struct usb_interface *intf)
1620 struct usbduxfastsub_s *udfs = usb_get_intfdata(intf);
1621 struct usb_device *udev = interface_to_usbdev(intf);
1624 dev_err(&intf->dev, "disconnect called with null pointer.\n");
1627 if (udfs->usbdev != udev) {
1628 dev_err(&intf->dev, "BUG! called with wrong ptr!!!\n");
1632 comedi_usb_auto_unconfig(intf);
1634 down(&start_stop_sem);
1638 up(&start_stop_sem);
1640 #ifdef CONFIG_COMEDI_DEBUG
1641 printk(KERN_DEBUG "comedi_: usbduxfast: disconnected from the usb\n");
1645 static const struct usb_device_id usbduxfast_usb_table[] = {
1646 /* { USB_DEVICE(0x4b4, 0x8613) }, testing */
1647 { USB_DEVICE(0x13d8, 0x0010) }, /* real ID */
1648 { USB_DEVICE(0x13d8, 0x0011) }, /* real ID */
1651 MODULE_DEVICE_TABLE(usb, usbduxfast_usb_table);
1653 static struct usb_driver usbduxfast_usb_driver = {
1654 #ifdef COMEDI_HAVE_USB_DRIVER_OWNER
1655 .owner = THIS_MODULE,
1657 .name = "usbduxfast",
1658 .probe = usbduxfast_usb_probe,
1659 .disconnect = usbduxfast_usb_disconnect,
1660 .id_table = usbduxfast_usb_table,
1662 module_comedi_usb_driver(usbduxfast_driver, usbduxfast_usb_driver);
1664 MODULE_AUTHOR("Bernd Porr, BerndPorr@f2s.com");
1665 MODULE_DESCRIPTION("USB-DUXfast, BerndPorr@f2s.com");
1666 MODULE_LICENSE("GPL");
1667 MODULE_FIRMWARE(FIRMWARE);