1 // SPDX-License-Identifier: GPL-2.0+
4 * Copyright (C) 2011-2015 Bernd Porr, mail@berndporr.me.uk
9 * Description: University of Stirling USB DAQ & INCITE Technology Limited
10 * Devices: [ITL] USB-DUX-SIGMA (usbduxsigma)
11 * Author: Bernd Porr <mail@berndporr.me.uk>
12 * Updated: 20 July 2015
17 * I must give credit here to Chris Baugher who
18 * wrote the driver for AT-MIO-16d. I used some parts of this
19 * driver. I also must give credits to David Brownell
20 * who supported me with the USB development.
22 * Note: the raw data from the A/D converter is 24 bit big endian
23 * anything else is little endian to/from the dux board
27 * 0.1: initial version
28 * 0.2: all basic functions implemented, digital I/O only for one port
29 * 0.3: proper vendor ID and driver name
30 * 0.4: fixed D/A voltage range
31 * 0.5: various bug fixes, health check at startup
32 * 0.6: corrected wrong input range
33 * 0.7: rewrite code that urb->interval is always 1
36 #include <linux/kernel.h>
37 #include <linux/module.h>
38 #include <linux/slab.h>
39 #include <linux/input.h>
40 #include <linux/fcntl.h>
41 #include <linux/compiler.h>
42 #include <asm/unaligned.h>
44 #include "../comedi_usb.h"
46 /* timeout for the USB-transfer in ms*/
47 #define BULK_TIMEOUT 1000
49 /* constants for "firmware" upload and download */
50 #define FIRMWARE "usbduxsigma_firmware.bin"
51 #define FIRMWARE_MAX_LEN 0x4000
52 #define USBDUXSUB_FIRMWARE 0xa0
53 #define VENDOR_DIR_IN 0xc0
54 #define VENDOR_DIR_OUT 0x40
56 /* internal addresses of the 8051 processor */
57 #define USBDUXSUB_CPUCS 0xE600
59 /* 300Hz max frequ under PWM */
60 #define MIN_PWM_PERIOD ((long)(1E9 / 300))
62 /* Default PWM frequency */
63 #define PWM_DEFAULT_PERIOD ((long)(1E9 / 100))
65 /* Number of channels (16 AD and offset)*/
66 #define NUMCHANNELS 16
68 /* Size of one A/D value */
69 #define SIZEADIN ((sizeof(u32)))
72 * Size of the async input-buffer IN BYTES, the DIO state is transmitted
75 #define SIZEINBUF (((NUMCHANNELS + 1) * SIZEADIN))
78 #define SIZEINSNBUF 16
80 /* Number of DA channels */
81 #define NUMOUTCHANNELS 8
83 /* size of one value for the D/A converter: channel and value */
84 #define SIZEDAOUT ((sizeof(u8) + sizeof(uint16_t)))
87 * Size of the output-buffer in bytes
88 * Actually only the first 4 triplets are used but for the
89 * high speed mode we need to pad it to 8 (microframes).
91 #define SIZEOUTBUF ((8 * SIZEDAOUT))
94 * Size of the buffer for the dux commands: just now max size is determined
95 * by the analogue out + command byte + panic bytes...
97 #define SIZEOFDUXBUFFER ((8 * SIZEDAOUT + 2))
99 /* Number of in-URBs which receive the data: min=2 */
100 #define NUMOFINBUFFERSFULL 5
102 /* Number of out-URBs which send the data: min=2 */
103 #define NUMOFOUTBUFFERSFULL 5
105 /* Number of in-URBs which receive the data: min=5 */
106 /* must have more buffers due to buggy USB ctr */
107 #define NUMOFINBUFFERSHIGH 10
109 /* Number of out-URBs which send the data: min=5 */
110 /* must have more buffers due to buggy USB ctr */
111 #define NUMOFOUTBUFFERSHIGH 10
113 /* number of retries to get the right dux command */
116 /* bulk transfer commands to usbduxsigma */
117 #define USBBUXSIGMA_AD_CMD 9
118 #define USBDUXSIGMA_DA_CMD 1
119 #define USBDUXSIGMA_DIO_CFG_CMD 2
120 #define USBDUXSIGMA_DIO_BITS_CMD 3
121 #define USBDUXSIGMA_SINGLE_AD_CMD 4
122 #define USBDUXSIGMA_PWM_ON_CMD 7
123 #define USBDUXSIGMA_PWM_OFF_CMD 8
125 static const struct comedi_lrange usbduxsigma_ai_range = {
127 BIP_RANGE(2.5 * 0x800000 / 0x780000 / 2.0)
131 struct usbduxsigma_private {
132 /* actual number of in-buffers */
134 /* actual number of out-buffers */
136 /* ISO-transfer handling: buffers */
137 struct urb **ai_urbs;
138 struct urb **ao_urbs;
139 /* pwm-transfer handling */
142 unsigned int pwm_period;
143 /* PWM internal delay for the GPIF in the FX2 */
145 /* size of the PWM buffer which holds the bit pattern */
147 /* input buffer for the ISO-transfer */
149 /* input buffer for single insn */
152 unsigned high_speed:1;
153 unsigned ai_cmd_running:1;
154 unsigned ao_cmd_running:1;
155 unsigned pwm_cmd_running:1;
157 /* time between samples in units of the timer */
158 unsigned int ai_timer;
159 unsigned int ao_timer;
160 /* counter between acquisitions */
161 unsigned int ai_counter;
162 unsigned int ao_counter;
163 /* interval in frames/uframes */
164 unsigned int ai_interval;
170 static void usbduxsigma_unlink_urbs(struct urb **urbs, int num_urbs)
174 for (i = 0; i < num_urbs; i++)
175 usb_kill_urb(urbs[i]);
178 static void usbduxsigma_ai_stop(struct comedi_device *dev, int do_unlink)
180 struct usbduxsigma_private *devpriv = dev->private;
182 if (do_unlink && devpriv->ai_urbs)
183 usbduxsigma_unlink_urbs(devpriv->ai_urbs, devpriv->n_ai_urbs);
185 devpriv->ai_cmd_running = 0;
188 static int usbduxsigma_ai_cancel(struct comedi_device *dev,
189 struct comedi_subdevice *s)
191 struct usbduxsigma_private *devpriv = dev->private;
193 mutex_lock(&devpriv->mut);
194 /* unlink only if it is really running */
195 usbduxsigma_ai_stop(dev, devpriv->ai_cmd_running);
196 mutex_unlock(&devpriv->mut);
201 static void usbduxsigma_ai_handle_urb(struct comedi_device *dev,
202 struct comedi_subdevice *s,
205 struct usbduxsigma_private *devpriv = dev->private;
206 struct comedi_async *async = s->async;
207 struct comedi_cmd *cmd = &async->cmd;
212 if ((urb->actual_length > 0) && (urb->status != -EXDEV)) {
213 devpriv->ai_counter--;
214 if (devpriv->ai_counter == 0) {
215 devpriv->ai_counter = devpriv->ai_timer;
218 * Get the data from the USB bus and hand it over
219 * to comedi. Note, first byte is the DIO state.
221 for (i = 0; i < cmd->chanlist_len; i++) {
222 val = be32_to_cpu(devpriv->in_buf[i + 1]);
223 val &= 0x00ffffff; /* strip status byte */
224 val = comedi_offset_munge(s, val);
225 if (!comedi_buf_write_samples(s, &val, 1))
229 if (cmd->stop_src == TRIG_COUNT &&
230 async->scans_done >= cmd->stop_arg)
231 async->events |= COMEDI_CB_EOA;
235 /* if command is still running, resubmit urb */
236 if (!(async->events & COMEDI_CB_CANCEL_MASK)) {
237 urb->dev = comedi_to_usb_dev(dev);
238 ret = usb_submit_urb(urb, GFP_ATOMIC);
240 dev_err(dev->class_dev, "urb resubmit failed (%d)\n",
242 if (ret == -EL2NSYNC)
243 dev_err(dev->class_dev,
244 "buggy USB host controller or bug in IRQ handler\n");
245 async->events |= COMEDI_CB_ERROR;
250 static void usbduxsigma_ai_urb_complete(struct urb *urb)
252 struct comedi_device *dev = urb->context;
253 struct usbduxsigma_private *devpriv = dev->private;
254 struct comedi_subdevice *s = dev->read_subdev;
255 struct comedi_async *async = s->async;
257 /* exit if not running a command, do not resubmit urb */
258 if (!devpriv->ai_cmd_running)
261 switch (urb->status) {
263 /* copy the result in the transfer buffer */
264 memcpy(devpriv->in_buf, urb->transfer_buffer, SIZEINBUF);
265 usbduxsigma_ai_handle_urb(dev, s, urb);
270 * error in the ISOchronous data
271 * we don't copy the data into the transfer buffer
272 * and recycle the last data byte
274 dev_dbg(dev->class_dev, "CRC error in ISO IN stream\n");
275 usbduxsigma_ai_handle_urb(dev, s, urb);
282 /* happens after an unlink command */
283 async->events |= COMEDI_CB_ERROR;
288 dev_err(dev->class_dev, "non-zero urb status (%d)\n",
290 async->events |= COMEDI_CB_ERROR;
295 * comedi_handle_events() cannot be used in this driver. The (*cancel)
296 * operation would unlink the urb.
298 if (async->events & COMEDI_CB_CANCEL_MASK)
299 usbduxsigma_ai_stop(dev, 0);
301 comedi_event(dev, s);
304 static void usbduxsigma_ao_stop(struct comedi_device *dev, int do_unlink)
306 struct usbduxsigma_private *devpriv = dev->private;
308 if (do_unlink && devpriv->ao_urbs)
309 usbduxsigma_unlink_urbs(devpriv->ao_urbs, devpriv->n_ao_urbs);
311 devpriv->ao_cmd_running = 0;
314 static int usbduxsigma_ao_cancel(struct comedi_device *dev,
315 struct comedi_subdevice *s)
317 struct usbduxsigma_private *devpriv = dev->private;
319 mutex_lock(&devpriv->mut);
320 /* unlink only if it is really running */
321 usbduxsigma_ao_stop(dev, devpriv->ao_cmd_running);
322 mutex_unlock(&devpriv->mut);
327 static void usbduxsigma_ao_handle_urb(struct comedi_device *dev,
328 struct comedi_subdevice *s,
331 struct usbduxsigma_private *devpriv = dev->private;
332 struct comedi_async *async = s->async;
333 struct comedi_cmd *cmd = &async->cmd;
338 devpriv->ao_counter--;
339 if (devpriv->ao_counter == 0) {
340 devpriv->ao_counter = devpriv->ao_timer;
342 if (cmd->stop_src == TRIG_COUNT &&
343 async->scans_done >= cmd->stop_arg) {
344 async->events |= COMEDI_CB_EOA;
348 /* transmit data to the USB bus */
349 datap = urb->transfer_buffer;
350 *datap++ = cmd->chanlist_len;
351 for (i = 0; i < cmd->chanlist_len; i++) {
352 unsigned int chan = CR_CHAN(cmd->chanlist[i]);
355 if (!comedi_buf_read_samples(s, &val, 1)) {
356 dev_err(dev->class_dev, "buffer underflow\n");
357 async->events |= COMEDI_CB_OVERFLOW;
363 s->readback[chan] = val;
367 /* if command is still running, resubmit urb */
368 if (!(async->events & COMEDI_CB_CANCEL_MASK)) {
369 urb->transfer_buffer_length = SIZEOUTBUF;
370 urb->dev = comedi_to_usb_dev(dev);
372 urb->interval = 1; /* (u)frames */
373 urb->number_of_packets = 1;
374 urb->iso_frame_desc[0].offset = 0;
375 urb->iso_frame_desc[0].length = SIZEOUTBUF;
376 urb->iso_frame_desc[0].status = 0;
377 ret = usb_submit_urb(urb, GFP_ATOMIC);
379 dev_err(dev->class_dev, "urb resubmit failed (%d)\n",
381 if (ret == -EL2NSYNC)
382 dev_err(dev->class_dev,
383 "buggy USB host controller or bug in IRQ handler\n");
384 async->events |= COMEDI_CB_ERROR;
389 static void usbduxsigma_ao_urb_complete(struct urb *urb)
391 struct comedi_device *dev = urb->context;
392 struct usbduxsigma_private *devpriv = dev->private;
393 struct comedi_subdevice *s = dev->write_subdev;
394 struct comedi_async *async = s->async;
396 /* exit if not running a command, do not resubmit urb */
397 if (!devpriv->ao_cmd_running)
400 switch (urb->status) {
402 usbduxsigma_ao_handle_urb(dev, s, urb);
409 /* happens after an unlink command */
410 async->events |= COMEDI_CB_ERROR;
415 dev_err(dev->class_dev, "non-zero urb status (%d)\n",
417 async->events |= COMEDI_CB_ERROR;
422 * comedi_handle_events() cannot be used in this driver. The (*cancel)
423 * operation would unlink the urb.
425 if (async->events & COMEDI_CB_CANCEL_MASK)
426 usbduxsigma_ao_stop(dev, 0);
428 comedi_event(dev, s);
431 static int usbduxsigma_submit_urbs(struct comedi_device *dev,
432 struct urb **urbs, int num_urbs,
435 struct usb_device *usb = comedi_to_usb_dev(dev);
440 /* Submit all URBs and start the transfer on the bus */
441 for (i = 0; i < num_urbs; i++) {
444 /* in case of a resubmission after an unlink... */
450 urb->transfer_flags = URB_ISO_ASAP;
452 ret = usb_submit_urb(urb, GFP_ATOMIC);
459 static int usbduxsigma_chans_to_interval(int num_chan)
468 static int usbduxsigma_ai_cmdtest(struct comedi_device *dev,
469 struct comedi_subdevice *s,
470 struct comedi_cmd *cmd)
472 struct usbduxsigma_private *devpriv = dev->private;
473 int high_speed = devpriv->high_speed;
474 int interval = usbduxsigma_chans_to_interval(cmd->chanlist_len);
478 /* Step 1 : check if triggers are trivially valid */
480 err |= comedi_check_trigger_src(&cmd->start_src, TRIG_NOW | TRIG_INT);
481 err |= comedi_check_trigger_src(&cmd->scan_begin_src, TRIG_TIMER);
482 err |= comedi_check_trigger_src(&cmd->convert_src, TRIG_NOW);
483 err |= comedi_check_trigger_src(&cmd->scan_end_src, TRIG_COUNT);
484 err |= comedi_check_trigger_src(&cmd->stop_src, TRIG_COUNT | TRIG_NONE);
489 /* Step 2a : make sure trigger sources are unique */
491 err |= comedi_check_trigger_is_unique(cmd->start_src);
492 err |= comedi_check_trigger_is_unique(cmd->stop_src);
494 /* Step 2b : and mutually compatible */
499 /* Step 3: check if arguments are trivially valid */
501 err |= comedi_check_trigger_arg_is(&cmd->start_arg, 0);
505 * In high speed mode microframes are possible.
506 * However, during one microframe we can roughly
507 * sample two channels. Thus, the more channels
508 * are in the channel list the more time we need.
510 err |= comedi_check_trigger_arg_min(&cmd->scan_begin_arg,
511 (125000 * interval));
514 /* 1kHz scans every USB frame */
515 err |= comedi_check_trigger_arg_min(&cmd->scan_begin_arg,
519 err |= comedi_check_trigger_arg_is(&cmd->scan_end_arg,
522 if (cmd->stop_src == TRIG_COUNT)
523 err |= comedi_check_trigger_arg_min(&cmd->stop_arg, 1);
525 err |= comedi_check_trigger_arg_is(&cmd->stop_arg, 0);
530 /* Step 4: fix up any arguments */
532 tmp = rounddown(cmd->scan_begin_arg, high_speed ? 125000 : 1000000);
533 err |= comedi_check_trigger_arg_is(&cmd->scan_begin_arg, tmp);
542 * creates the ADC command for the MAX1271
543 * range is the range value from comedi
545 static void create_adc_command(unsigned int chan,
546 u8 *muxsg0, u8 *muxsg1)
549 (*muxsg0) = (*muxsg0) | (1 << chan);
551 (*muxsg1) = (*muxsg1) | (1 << (chan - 8));
554 static int usbbuxsigma_send_cmd(struct comedi_device *dev, int cmd_type)
556 struct usb_device *usb = comedi_to_usb_dev(dev);
557 struct usbduxsigma_private *devpriv = dev->private;
560 devpriv->dux_commands[0] = cmd_type;
562 return usb_bulk_msg(usb, usb_sndbulkpipe(usb, 1),
563 devpriv->dux_commands, SIZEOFDUXBUFFER,
564 &nsent, BULK_TIMEOUT);
567 static int usbduxsigma_receive_cmd(struct comedi_device *dev, int command)
569 struct usb_device *usb = comedi_to_usb_dev(dev);
570 struct usbduxsigma_private *devpriv = dev->private;
575 for (i = 0; i < RETRIES; i++) {
576 ret = usb_bulk_msg(usb, usb_rcvbulkpipe(usb, 8),
577 devpriv->insn_buf, SIZEINSNBUF,
578 &nrec, BULK_TIMEOUT);
582 if (devpriv->insn_buf[0] == command)
586 * This is only reached if the data has been requested a
587 * couple of times and the command was not received.
592 static int usbduxsigma_ai_inttrig(struct comedi_device *dev,
593 struct comedi_subdevice *s,
594 unsigned int trig_num)
596 struct usbduxsigma_private *devpriv = dev->private;
597 struct comedi_cmd *cmd = &s->async->cmd;
600 if (trig_num != cmd->start_arg)
603 mutex_lock(&devpriv->mut);
604 if (!devpriv->ai_cmd_running) {
605 devpriv->ai_cmd_running = 1;
606 ret = usbduxsigma_submit_urbs(dev, devpriv->ai_urbs,
607 devpriv->n_ai_urbs, 1);
609 devpriv->ai_cmd_running = 0;
610 mutex_unlock(&devpriv->mut);
613 s->async->inttrig = NULL;
615 mutex_unlock(&devpriv->mut);
620 static int usbduxsigma_ai_cmd(struct comedi_device *dev,
621 struct comedi_subdevice *s)
623 struct usbduxsigma_private *devpriv = dev->private;
624 struct comedi_cmd *cmd = &s->async->cmd;
625 unsigned int len = cmd->chanlist_len;
632 mutex_lock(&devpriv->mut);
634 if (devpriv->high_speed) {
636 * every 2 channels get a time window of 125us. Thus, if we
637 * sample all 16 channels we need 1ms. If we sample only one
638 * channel we need only 125us
640 unsigned int interval = usbduxsigma_chans_to_interval(len);
642 devpriv->ai_interval = interval;
643 devpriv->ai_timer = cmd->scan_begin_arg / (125000 * interval);
645 /* interval always 1ms */
646 devpriv->ai_interval = 1;
647 devpriv->ai_timer = cmd->scan_begin_arg / 1000000;
650 for (i = 0; i < len; i++) {
651 unsigned int chan = CR_CHAN(cmd->chanlist[i]);
653 create_adc_command(chan, &muxsg0, &muxsg1);
656 devpriv->dux_commands[1] = devpriv->ai_interval;
657 devpriv->dux_commands[2] = len; /* num channels per time step */
658 devpriv->dux_commands[3] = 0x12; /* CONFIG0 */
659 devpriv->dux_commands[4] = 0x03; /* CONFIG1: 23kHz sample, delay 0us */
660 devpriv->dux_commands[5] = 0x00; /* CONFIG3: diff. channels off */
661 devpriv->dux_commands[6] = muxsg0;
662 devpriv->dux_commands[7] = muxsg1;
663 devpriv->dux_commands[8] = sysred;
665 ret = usbbuxsigma_send_cmd(dev, USBBUXSIGMA_AD_CMD);
667 mutex_unlock(&devpriv->mut);
671 devpriv->ai_counter = devpriv->ai_timer;
673 if (cmd->start_src == TRIG_NOW) {
674 /* enable this acquisition operation */
675 devpriv->ai_cmd_running = 1;
676 ret = usbduxsigma_submit_urbs(dev, devpriv->ai_urbs,
677 devpriv->n_ai_urbs, 1);
679 devpriv->ai_cmd_running = 0;
680 mutex_unlock(&devpriv->mut);
683 s->async->inttrig = NULL;
684 } else { /* TRIG_INT */
685 s->async->inttrig = usbduxsigma_ai_inttrig;
688 mutex_unlock(&devpriv->mut);
693 static int usbduxsigma_ai_insn_read(struct comedi_device *dev,
694 struct comedi_subdevice *s,
695 struct comedi_insn *insn,
698 struct usbduxsigma_private *devpriv = dev->private;
699 unsigned int chan = CR_CHAN(insn->chanspec);
706 mutex_lock(&devpriv->mut);
707 if (devpriv->ai_cmd_running) {
708 mutex_unlock(&devpriv->mut);
712 create_adc_command(chan, &muxsg0, &muxsg1);
714 /* Mode 0 is used to get a single conversion on demand */
715 devpriv->dux_commands[1] = 0x16; /* CONFIG0: chopper on */
716 devpriv->dux_commands[2] = 0x80; /* CONFIG1: 2kHz sampling rate */
717 devpriv->dux_commands[3] = 0x00; /* CONFIG3: diff. channels off */
718 devpriv->dux_commands[4] = muxsg0;
719 devpriv->dux_commands[5] = muxsg1;
720 devpriv->dux_commands[6] = sysred;
723 ret = usbbuxsigma_send_cmd(dev, USBDUXSIGMA_SINGLE_AD_CMD);
725 mutex_unlock(&devpriv->mut);
729 for (i = 0; i < insn->n; i++) {
732 ret = usbduxsigma_receive_cmd(dev, USBDUXSIGMA_SINGLE_AD_CMD);
734 mutex_unlock(&devpriv->mut);
738 /* 32 bits big endian from the A/D converter */
739 val = be32_to_cpu(get_unaligned((__be32
740 *)(devpriv->insn_buf + 1)));
741 val &= 0x00ffffff; /* strip status byte */
742 data[i] = comedi_offset_munge(s, val);
744 mutex_unlock(&devpriv->mut);
749 static int usbduxsigma_ao_insn_read(struct comedi_device *dev,
750 struct comedi_subdevice *s,
751 struct comedi_insn *insn,
754 struct usbduxsigma_private *devpriv = dev->private;
757 mutex_lock(&devpriv->mut);
758 ret = comedi_readback_insn_read(dev, s, insn, data);
759 mutex_unlock(&devpriv->mut);
764 static int usbduxsigma_ao_insn_write(struct comedi_device *dev,
765 struct comedi_subdevice *s,
766 struct comedi_insn *insn,
769 struct usbduxsigma_private *devpriv = dev->private;
770 unsigned int chan = CR_CHAN(insn->chanspec);
774 mutex_lock(&devpriv->mut);
775 if (devpriv->ao_cmd_running) {
776 mutex_unlock(&devpriv->mut);
780 for (i = 0; i < insn->n; i++) {
781 devpriv->dux_commands[1] = 1; /* num channels */
782 devpriv->dux_commands[2] = data[i]; /* value */
783 devpriv->dux_commands[3] = chan; /* channel number */
784 ret = usbbuxsigma_send_cmd(dev, USBDUXSIGMA_DA_CMD);
786 mutex_unlock(&devpriv->mut);
789 s->readback[chan] = data[i];
791 mutex_unlock(&devpriv->mut);
796 static int usbduxsigma_ao_inttrig(struct comedi_device *dev,
797 struct comedi_subdevice *s,
798 unsigned int trig_num)
800 struct usbduxsigma_private *devpriv = dev->private;
801 struct comedi_cmd *cmd = &s->async->cmd;
804 if (trig_num != cmd->start_arg)
807 mutex_lock(&devpriv->mut);
808 if (!devpriv->ao_cmd_running) {
809 devpriv->ao_cmd_running = 1;
810 ret = usbduxsigma_submit_urbs(dev, devpriv->ao_urbs,
811 devpriv->n_ao_urbs, 0);
813 devpriv->ao_cmd_running = 0;
814 mutex_unlock(&devpriv->mut);
817 s->async->inttrig = NULL;
819 mutex_unlock(&devpriv->mut);
824 static int usbduxsigma_ao_cmdtest(struct comedi_device *dev,
825 struct comedi_subdevice *s,
826 struct comedi_cmd *cmd)
828 struct usbduxsigma_private *devpriv = dev->private;
832 /* Step 1 : check if triggers are trivially valid */
834 err |= comedi_check_trigger_src(&cmd->start_src, TRIG_NOW | TRIG_INT);
837 * For now, always use "scan" timing with all channels updated at once
838 * (cmd->scan_begin_src == TRIG_TIMER, cmd->convert_src == TRIG_NOW).
840 * In a future version, "convert" timing with channels updated
841 * indivually may be supported in high speed mode
842 * (cmd->scan_begin_src == TRIG_FOLLOW, cmd->convert_src == TRIG_TIMER).
844 err |= comedi_check_trigger_src(&cmd->scan_begin_src, TRIG_TIMER);
845 err |= comedi_check_trigger_src(&cmd->convert_src, TRIG_NOW);
846 err |= comedi_check_trigger_src(&cmd->scan_end_src, TRIG_COUNT);
847 err |= comedi_check_trigger_src(&cmd->stop_src, TRIG_COUNT | TRIG_NONE);
850 mutex_unlock(&devpriv->mut);
854 /* Step 2a : make sure trigger sources are unique */
856 err |= comedi_check_trigger_is_unique(cmd->start_src);
857 err |= comedi_check_trigger_is_unique(cmd->stop_src);
859 /* Step 2b : and mutually compatible */
864 /* Step 3: check if arguments are trivially valid */
866 err |= comedi_check_trigger_arg_is(&cmd->start_arg, 0);
868 err |= comedi_check_trigger_arg_min(&cmd->scan_begin_arg, 1000000);
870 err |= comedi_check_trigger_arg_is(&cmd->scan_end_arg,
873 if (cmd->stop_src == TRIG_COUNT)
874 err |= comedi_check_trigger_arg_min(&cmd->stop_arg, 1);
876 err |= comedi_check_trigger_arg_is(&cmd->stop_arg, 0);
881 /* Step 4: fix up any arguments */
883 tmp = rounddown(cmd->scan_begin_arg, 1000000);
884 err |= comedi_check_trigger_arg_is(&cmd->scan_begin_arg, tmp);
892 static int usbduxsigma_ao_cmd(struct comedi_device *dev,
893 struct comedi_subdevice *s)
895 struct usbduxsigma_private *devpriv = dev->private;
896 struct comedi_cmd *cmd = &s->async->cmd;
899 mutex_lock(&devpriv->mut);
902 * For now, only "scan" timing is supported. A future version may
903 * support "convert" timing in high speed mode.
905 * Timing of the scan: every 1ms all channels updated at once.
907 devpriv->ao_timer = cmd->scan_begin_arg / 1000000;
909 devpriv->ao_counter = devpriv->ao_timer;
911 if (cmd->start_src == TRIG_NOW) {
912 /* enable this acquisition operation */
913 devpriv->ao_cmd_running = 1;
914 ret = usbduxsigma_submit_urbs(dev, devpriv->ao_urbs,
915 devpriv->n_ao_urbs, 0);
917 devpriv->ao_cmd_running = 0;
918 mutex_unlock(&devpriv->mut);
921 s->async->inttrig = NULL;
922 } else { /* TRIG_INT */
923 s->async->inttrig = usbduxsigma_ao_inttrig;
926 mutex_unlock(&devpriv->mut);
931 static int usbduxsigma_dio_insn_config(struct comedi_device *dev,
932 struct comedi_subdevice *s,
933 struct comedi_insn *insn,
938 ret = comedi_dio_insn_config(dev, s, insn, data, 0);
943 * We don't tell the firmware here as it would take 8 frames
944 * to submit the information. We do it in the (*insn_bits).
949 static int usbduxsigma_dio_insn_bits(struct comedi_device *dev,
950 struct comedi_subdevice *s,
951 struct comedi_insn *insn,
954 struct usbduxsigma_private *devpriv = dev->private;
957 mutex_lock(&devpriv->mut);
959 comedi_dio_update_state(s, data);
961 /* Always update the hardware. See the (*insn_config). */
962 devpriv->dux_commands[1] = s->io_bits & 0xff;
963 devpriv->dux_commands[4] = s->state & 0xff;
964 devpriv->dux_commands[2] = (s->io_bits >> 8) & 0xff;
965 devpriv->dux_commands[5] = (s->state >> 8) & 0xff;
966 devpriv->dux_commands[3] = (s->io_bits >> 16) & 0xff;
967 devpriv->dux_commands[6] = (s->state >> 16) & 0xff;
969 ret = usbbuxsigma_send_cmd(dev, USBDUXSIGMA_DIO_BITS_CMD);
972 ret = usbduxsigma_receive_cmd(dev, USBDUXSIGMA_DIO_BITS_CMD);
976 s->state = devpriv->insn_buf[1] |
977 (devpriv->insn_buf[2] << 8) |
978 (devpriv->insn_buf[3] << 16);
984 mutex_unlock(&devpriv->mut);
989 static void usbduxsigma_pwm_stop(struct comedi_device *dev, int do_unlink)
991 struct usbduxsigma_private *devpriv = dev->private;
994 if (devpriv->pwm_urb)
995 usb_kill_urb(devpriv->pwm_urb);
998 devpriv->pwm_cmd_running = 0;
1001 static int usbduxsigma_pwm_cancel(struct comedi_device *dev,
1002 struct comedi_subdevice *s)
1004 struct usbduxsigma_private *devpriv = dev->private;
1006 /* unlink only if it is really running */
1007 usbduxsigma_pwm_stop(dev, devpriv->pwm_cmd_running);
1009 return usbbuxsigma_send_cmd(dev, USBDUXSIGMA_PWM_OFF_CMD);
1012 static void usbduxsigma_pwm_urb_complete(struct urb *urb)
1014 struct comedi_device *dev = urb->context;
1015 struct usbduxsigma_private *devpriv = dev->private;
1018 switch (urb->status) {
1027 /* happens after an unlink command */
1028 if (devpriv->pwm_cmd_running)
1029 usbduxsigma_pwm_stop(dev, 0); /* w/o unlink */
1034 if (devpriv->pwm_cmd_running) {
1035 dev_err(dev->class_dev, "non-zero urb status (%d)\n",
1037 usbduxsigma_pwm_stop(dev, 0); /* w/o unlink */
1042 if (!devpriv->pwm_cmd_running)
1045 urb->transfer_buffer_length = devpriv->pwm_buf_sz;
1046 urb->dev = comedi_to_usb_dev(dev);
1048 ret = usb_submit_urb(urb, GFP_ATOMIC);
1050 dev_err(dev->class_dev, "urb resubmit failed (%d)\n", ret);
1051 if (ret == -EL2NSYNC)
1052 dev_err(dev->class_dev,
1053 "buggy USB host controller or bug in IRQ handler\n");
1054 usbduxsigma_pwm_stop(dev, 0); /* w/o unlink */
1058 static int usbduxsigma_submit_pwm_urb(struct comedi_device *dev)
1060 struct usb_device *usb = comedi_to_usb_dev(dev);
1061 struct usbduxsigma_private *devpriv = dev->private;
1062 struct urb *urb = devpriv->pwm_urb;
1064 /* in case of a resubmission after an unlink... */
1065 usb_fill_bulk_urb(urb, usb, usb_sndbulkpipe(usb, 4),
1066 urb->transfer_buffer, devpriv->pwm_buf_sz,
1067 usbduxsigma_pwm_urb_complete, dev);
1069 return usb_submit_urb(urb, GFP_ATOMIC);
1072 static int usbduxsigma_pwm_period(struct comedi_device *dev,
1073 struct comedi_subdevice *s,
1074 unsigned int period)
1076 struct usbduxsigma_private *devpriv = dev->private;
1079 if (period < MIN_PWM_PERIOD)
1082 fx2delay = (period / (6 * 512 * 1000 / 33)) - 6;
1086 devpriv->pwm_delay = fx2delay;
1087 devpriv->pwm_period = period;
1091 static int usbduxsigma_pwm_start(struct comedi_device *dev,
1092 struct comedi_subdevice *s)
1094 struct usbduxsigma_private *devpriv = dev->private;
1097 if (devpriv->pwm_cmd_running)
1100 devpriv->dux_commands[1] = devpriv->pwm_delay;
1101 ret = usbbuxsigma_send_cmd(dev, USBDUXSIGMA_PWM_ON_CMD);
1105 memset(devpriv->pwm_urb->transfer_buffer, 0, devpriv->pwm_buf_sz);
1107 devpriv->pwm_cmd_running = 1;
1108 ret = usbduxsigma_submit_pwm_urb(dev);
1110 devpriv->pwm_cmd_running = 0;
1117 static void usbduxsigma_pwm_pattern(struct comedi_device *dev,
1118 struct comedi_subdevice *s,
1123 struct usbduxsigma_private *devpriv = dev->private;
1124 char pwm_mask = (1 << chan); /* DIO bit for the PWM data */
1125 char sgn_mask = (16 << chan); /* DIO bit for the sign */
1126 char *buf = (char *)(devpriv->pwm_urb->transfer_buffer);
1127 int szbuf = devpriv->pwm_buf_sz;
1130 for (i = 0; i < szbuf; i++) {
1144 static int usbduxsigma_pwm_write(struct comedi_device *dev,
1145 struct comedi_subdevice *s,
1146 struct comedi_insn *insn,
1149 unsigned int chan = CR_CHAN(insn->chanspec);
1152 * It doesn't make sense to support more than one value here
1153 * because it would just overwrite the PWM buffer.
1159 * The sign is set via a special INSN only, this gives us 8 bits
1160 * for normal operation, sign is 0 by default.
1162 usbduxsigma_pwm_pattern(dev, s, chan, data[0], 0);
1167 static int usbduxsigma_pwm_config(struct comedi_device *dev,
1168 struct comedi_subdevice *s,
1169 struct comedi_insn *insn,
1172 struct usbduxsigma_private *devpriv = dev->private;
1173 unsigned int chan = CR_CHAN(insn->chanspec);
1176 case INSN_CONFIG_ARM:
1178 * if not zero the PWM is limited to a certain time which is
1179 * not supported here
1183 return usbduxsigma_pwm_start(dev, s);
1184 case INSN_CONFIG_DISARM:
1185 return usbduxsigma_pwm_cancel(dev, s);
1186 case INSN_CONFIG_GET_PWM_STATUS:
1187 data[1] = devpriv->pwm_cmd_running;
1189 case INSN_CONFIG_PWM_SET_PERIOD:
1190 return usbduxsigma_pwm_period(dev, s, data[1]);
1191 case INSN_CONFIG_PWM_GET_PERIOD:
1192 data[1] = devpriv->pwm_period;
1194 case INSN_CONFIG_PWM_SET_H_BRIDGE:
1197 * data[2] = sign (for a relay)
1199 usbduxsigma_pwm_pattern(dev, s, chan, data[1], (data[2] != 0));
1201 case INSN_CONFIG_PWM_GET_H_BRIDGE:
1202 /* values are not kept in this driver, nothing to return */
1208 static int usbduxsigma_getstatusinfo(struct comedi_device *dev, int chan)
1210 struct comedi_subdevice *s = dev->read_subdev;
1211 struct usbduxsigma_private *devpriv = dev->private;
1219 sysred = 0; /* ADC zero */
1222 sysred = 1; /* ADC offset */
1225 sysred = 4; /* VCC */
1228 sysred = 8; /* temperature */
1231 sysred = 16; /* gain */
1234 sysred = 32; /* ref */
1238 devpriv->dux_commands[1] = 0x12; /* CONFIG0 */
1239 devpriv->dux_commands[2] = 0x80; /* CONFIG1: 2kHz sampling rate */
1240 devpriv->dux_commands[3] = 0x00; /* CONFIG3: diff. channels off */
1241 devpriv->dux_commands[4] = 0;
1242 devpriv->dux_commands[5] = 0;
1243 devpriv->dux_commands[6] = sysred;
1244 ret = usbbuxsigma_send_cmd(dev, USBDUXSIGMA_SINGLE_AD_CMD);
1248 ret = usbduxsigma_receive_cmd(dev, USBDUXSIGMA_SINGLE_AD_CMD);
1252 /* 32 bits big endian from the A/D converter */
1253 val = be32_to_cpu(get_unaligned((__be32 *)(devpriv->insn_buf + 1)));
1254 val &= 0x00ffffff; /* strip status byte */
1256 return (int)comedi_offset_munge(s, val);
1259 static int usbduxsigma_firmware_upload(struct comedi_device *dev,
1260 const u8 *data, size_t size,
1261 unsigned long context)
1263 struct usb_device *usb = comedi_to_usb_dev(dev);
1271 if (size > FIRMWARE_MAX_LEN) {
1272 dev_err(dev->class_dev, "firmware binary too large for FX2\n");
1276 /* we generate a local buffer for the firmware */
1277 buf = kmemdup(data, size, GFP_KERNEL);
1281 /* we need a malloc'ed buffer for usb_control_msg() */
1282 tmp = kmalloc(1, GFP_KERNEL);
1288 /* stop the current firmware on the device */
1289 *tmp = 1; /* 7f92 to one */
1290 ret = usb_control_msg(usb, usb_sndctrlpipe(usb, 0),
1293 USBDUXSUB_CPUCS, 0x0000,
1297 dev_err(dev->class_dev, "can not stop firmware\n");
1301 /* upload the new firmware to the device */
1302 ret = usb_control_msg(usb, usb_sndctrlpipe(usb, 0),
1309 dev_err(dev->class_dev, "firmware upload failed\n");
1313 /* start the new firmware on the device */
1314 *tmp = 0; /* 7f92 to zero */
1315 ret = usb_control_msg(usb, usb_sndctrlpipe(usb, 0),
1318 USBDUXSUB_CPUCS, 0x0000,
1322 dev_err(dev->class_dev, "can not start firmware\n");
1330 static int usbduxsigma_alloc_usb_buffers(struct comedi_device *dev)
1332 struct usb_device *usb = comedi_to_usb_dev(dev);
1333 struct usbduxsigma_private *devpriv = dev->private;
1337 devpriv->dux_commands = kzalloc(SIZEOFDUXBUFFER, GFP_KERNEL);
1338 devpriv->in_buf = kzalloc(SIZEINBUF, GFP_KERNEL);
1339 devpriv->insn_buf = kzalloc(SIZEINSNBUF, GFP_KERNEL);
1340 devpriv->ai_urbs = kcalloc(devpriv->n_ai_urbs, sizeof(urb), GFP_KERNEL);
1341 devpriv->ao_urbs = kcalloc(devpriv->n_ao_urbs, sizeof(urb), GFP_KERNEL);
1342 if (!devpriv->dux_commands || !devpriv->in_buf || !devpriv->insn_buf ||
1343 !devpriv->ai_urbs || !devpriv->ao_urbs)
1346 for (i = 0; i < devpriv->n_ai_urbs; i++) {
1347 /* one frame: 1ms */
1348 urb = usb_alloc_urb(1, GFP_KERNEL);
1351 devpriv->ai_urbs[i] = urb;
1353 /* will be filled later with a pointer to the comedi-device */
1354 /* and ONLY then the urb should be submitted */
1355 urb->context = NULL;
1356 urb->pipe = usb_rcvisocpipe(usb, 6);
1357 urb->transfer_flags = URB_ISO_ASAP;
1358 urb->transfer_buffer = kzalloc(SIZEINBUF, GFP_KERNEL);
1359 if (!urb->transfer_buffer)
1361 urb->complete = usbduxsigma_ai_urb_complete;
1362 urb->number_of_packets = 1;
1363 urb->transfer_buffer_length = SIZEINBUF;
1364 urb->iso_frame_desc[0].offset = 0;
1365 urb->iso_frame_desc[0].length = SIZEINBUF;
1368 for (i = 0; i < devpriv->n_ao_urbs; i++) {
1369 /* one frame: 1ms */
1370 urb = usb_alloc_urb(1, GFP_KERNEL);
1373 devpriv->ao_urbs[i] = urb;
1375 /* will be filled later with a pointer to the comedi-device */
1376 /* and ONLY then the urb should be submitted */
1377 urb->context = NULL;
1378 urb->pipe = usb_sndisocpipe(usb, 2);
1379 urb->transfer_flags = URB_ISO_ASAP;
1380 urb->transfer_buffer = kzalloc(SIZEOUTBUF, GFP_KERNEL);
1381 if (!urb->transfer_buffer)
1383 urb->complete = usbduxsigma_ao_urb_complete;
1384 urb->number_of_packets = 1;
1385 urb->transfer_buffer_length = SIZEOUTBUF;
1386 urb->iso_frame_desc[0].offset = 0;
1387 urb->iso_frame_desc[0].length = SIZEOUTBUF;
1388 urb->interval = 1; /* (u)frames */
1391 if (devpriv->pwm_buf_sz) {
1392 urb = usb_alloc_urb(0, GFP_KERNEL);
1395 devpriv->pwm_urb = urb;
1397 urb->transfer_buffer = kzalloc(devpriv->pwm_buf_sz,
1399 if (!urb->transfer_buffer)
1406 static void usbduxsigma_free_usb_buffers(struct comedi_device *dev)
1408 struct usbduxsigma_private *devpriv = dev->private;
1412 urb = devpriv->pwm_urb;
1414 kfree(urb->transfer_buffer);
1417 if (devpriv->ao_urbs) {
1418 for (i = 0; i < devpriv->n_ao_urbs; i++) {
1419 urb = devpriv->ao_urbs[i];
1421 kfree(urb->transfer_buffer);
1425 kfree(devpriv->ao_urbs);
1427 if (devpriv->ai_urbs) {
1428 for (i = 0; i < devpriv->n_ai_urbs; i++) {
1429 urb = devpriv->ai_urbs[i];
1431 kfree(urb->transfer_buffer);
1435 kfree(devpriv->ai_urbs);
1437 kfree(devpriv->insn_buf);
1438 kfree(devpriv->in_buf);
1439 kfree(devpriv->dux_commands);
1442 static int usbduxsigma_auto_attach(struct comedi_device *dev,
1443 unsigned long context_unused)
1445 struct usb_interface *intf = comedi_to_usb_interface(dev);
1446 struct usb_device *usb = comedi_to_usb_dev(dev);
1447 struct usbduxsigma_private *devpriv;
1448 struct comedi_subdevice *s;
1452 devpriv = comedi_alloc_devpriv(dev, sizeof(*devpriv));
1456 mutex_init(&devpriv->mut);
1458 usb_set_intfdata(intf, devpriv);
1460 devpriv->high_speed = (usb->speed == USB_SPEED_HIGH);
1461 if (devpriv->high_speed) {
1462 devpriv->n_ai_urbs = NUMOFINBUFFERSHIGH;
1463 devpriv->n_ao_urbs = NUMOFOUTBUFFERSHIGH;
1464 devpriv->pwm_buf_sz = 512;
1466 devpriv->n_ai_urbs = NUMOFINBUFFERSFULL;
1467 devpriv->n_ao_urbs = NUMOFOUTBUFFERSFULL;
1470 ret = usbduxsigma_alloc_usb_buffers(dev);
1474 /* setting to alternate setting 3: enabling iso ep and bulk ep. */
1475 ret = usb_set_interface(usb, intf->altsetting->desc.bInterfaceNumber,
1478 dev_err(dev->class_dev,
1479 "could not set alternate setting 3 in high speed\n");
1483 ret = comedi_load_firmware(dev, &usb->dev, FIRMWARE,
1484 usbduxsigma_firmware_upload, 0);
1488 ret = comedi_alloc_subdevices(dev, (devpriv->high_speed) ? 4 : 3);
1492 /* Analog Input subdevice */
1493 s = &dev->subdevices[0];
1494 dev->read_subdev = s;
1495 s->type = COMEDI_SUBD_AI;
1496 s->subdev_flags = SDF_READABLE | SDF_GROUND | SDF_CMD_READ | SDF_LSAMPL;
1497 s->n_chan = NUMCHANNELS;
1498 s->len_chanlist = NUMCHANNELS;
1499 s->maxdata = 0x00ffffff;
1500 s->range_table = &usbduxsigma_ai_range;
1501 s->insn_read = usbduxsigma_ai_insn_read;
1502 s->do_cmdtest = usbduxsigma_ai_cmdtest;
1503 s->do_cmd = usbduxsigma_ai_cmd;
1504 s->cancel = usbduxsigma_ai_cancel;
1506 /* Analog Output subdevice */
1507 s = &dev->subdevices[1];
1508 dev->write_subdev = s;
1509 s->type = COMEDI_SUBD_AO;
1510 s->subdev_flags = SDF_WRITABLE | SDF_GROUND | SDF_CMD_WRITE;
1512 s->len_chanlist = s->n_chan;
1513 s->maxdata = 0x00ff;
1514 s->range_table = &range_unipolar2_5;
1515 s->insn_write = usbduxsigma_ao_insn_write;
1516 s->insn_read = usbduxsigma_ao_insn_read;
1517 s->do_cmdtest = usbduxsigma_ao_cmdtest;
1518 s->do_cmd = usbduxsigma_ao_cmd;
1519 s->cancel = usbduxsigma_ao_cancel;
1521 ret = comedi_alloc_subdev_readback(s);
1525 /* Digital I/O subdevice */
1526 s = &dev->subdevices[2];
1527 s->type = COMEDI_SUBD_DIO;
1528 s->subdev_flags = SDF_READABLE | SDF_WRITABLE;
1531 s->range_table = &range_digital;
1532 s->insn_bits = usbduxsigma_dio_insn_bits;
1533 s->insn_config = usbduxsigma_dio_insn_config;
1535 if (devpriv->high_speed) {
1536 /* Timer / pwm subdevice */
1537 s = &dev->subdevices[3];
1538 s->type = COMEDI_SUBD_PWM;
1539 s->subdev_flags = SDF_WRITABLE | SDF_PWM_HBRIDGE;
1541 s->maxdata = devpriv->pwm_buf_sz;
1542 s->insn_write = usbduxsigma_pwm_write;
1543 s->insn_config = usbduxsigma_pwm_config;
1545 usbduxsigma_pwm_period(dev, s, PWM_DEFAULT_PERIOD);
1548 offset = usbduxsigma_getstatusinfo(dev, 0);
1550 dev_err(dev->class_dev,
1551 "Communication to USBDUXSIGMA failed! Check firmware and cabling.\n");
1555 dev_info(dev->class_dev, "ADC_zero = %x\n", offset);
1560 static void usbduxsigma_detach(struct comedi_device *dev)
1562 struct usb_interface *intf = comedi_to_usb_interface(dev);
1563 struct usbduxsigma_private *devpriv = dev->private;
1565 usb_set_intfdata(intf, NULL);
1570 mutex_lock(&devpriv->mut);
1572 /* force unlink all urbs */
1573 usbduxsigma_ai_stop(dev, 1);
1574 usbduxsigma_ao_stop(dev, 1);
1575 usbduxsigma_pwm_stop(dev, 1);
1577 usbduxsigma_free_usb_buffers(dev);
1579 mutex_unlock(&devpriv->mut);
1581 mutex_destroy(&devpriv->mut);
1584 static struct comedi_driver usbduxsigma_driver = {
1585 .driver_name = "usbduxsigma",
1586 .module = THIS_MODULE,
1587 .auto_attach = usbduxsigma_auto_attach,
1588 .detach = usbduxsigma_detach,
1591 static int usbduxsigma_usb_probe(struct usb_interface *intf,
1592 const struct usb_device_id *id)
1594 return comedi_usb_auto_config(intf, &usbduxsigma_driver, 0);
1597 static const struct usb_device_id usbduxsigma_usb_table[] = {
1598 { USB_DEVICE(0x13d8, 0x0020) },
1599 { USB_DEVICE(0x13d8, 0x0021) },
1600 { USB_DEVICE(0x13d8, 0x0022) },
1603 MODULE_DEVICE_TABLE(usb, usbduxsigma_usb_table);
1605 static struct usb_driver usbduxsigma_usb_driver = {
1606 .name = "usbduxsigma",
1607 .probe = usbduxsigma_usb_probe,
1608 .disconnect = comedi_usb_auto_unconfig,
1609 .id_table = usbduxsigma_usb_table,
1611 module_comedi_usb_driver(usbduxsigma_driver, usbduxsigma_usb_driver);
1613 MODULE_AUTHOR("Bernd Porr, mail@berndporr.me.uk");
1614 MODULE_DESCRIPTION("Stirling/ITL USB-DUX SIGMA -- mail@berndporr.me.uk");
1615 MODULE_LICENSE("GPL");
1616 MODULE_FIRMWARE(FIRMWARE);