2 comedi/drivers/serial2002.c
3 Skeleton code for a Comedi driver
5 COMEDI - Linux Control and Measurement Device Interface
6 Copyright (C) 2002 Anders Blomdell <anders.blomdell@control.lth.se>
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.
26 Description: Driver for serial connected hardware
28 Author: Anders Blomdell
29 Updated: Fri, 7 Jun 2002 12:56:45 -0700
30 Status: in development
34 #include "../comedidev.h"
36 #include <linux/delay.h>
37 #include <linux/ioport.h>
38 #include <linux/sched.h>
39 #include <linux/slab.h>
41 #include <linux/termios.h>
42 #include <asm/ioctls.h>
43 #include <linux/serial.h>
44 #include <linux/poll.h>
46 struct serial2002_board {
51 * Useful for shorthand access to the particular board structure
53 #define thisboard ((const struct serial2002_board *)dev->board_ptr)
55 struct serial2002_range_table_t {
59 struct comedi_krange range;
62 struct serial2002_private {
64 int port; /* /dev/ttyS<port> */
65 int speed; /* baudrate */
67 unsigned int ao_readback[32];
68 unsigned char digital_in_mapping[32];
69 unsigned char digital_out_mapping[32];
70 unsigned char analog_in_mapping[32];
71 unsigned char analog_out_mapping[32];
72 unsigned char encoder_in_mapping[32];
73 struct serial2002_range_table_t in_range[32], out_range[32];
77 * most drivers define the following macro to make it easy to
78 * access the private structure.
80 #define devpriv ((struct serial2002_private *)dev->private)
83 enum { is_invalid, is_digital, is_channel } kind;
88 static long tty_ioctl(struct file *f, unsigned op, unsigned long param)
90 if (f->f_op->unlocked_ioctl)
91 return f->f_op->unlocked_ioctl(f, op, param);
96 static int tty_write(struct file *f, unsigned char *buf, int count)
104 result = f->f_op->write(f, buf, count, &f->f_pos);
111 * On 2.6.26.3 this occaisonally gave me page faults, worked around by
112 * settings.c_cc[VMIN] = 0; settings.c_cc[VTIME] = 0
114 static int tty_available(struct file *f)
121 tty_ioctl(f, FIONREAD, (unsigned long)&result);
127 static int tty_read(struct file *f, int timeout)
138 struct poll_wqueues table;
139 struct timeval start, now;
141 do_gettimeofday(&start);
142 poll_initwait(&table);
147 mask = f->f_op->poll(f, &table.pt);
148 if (mask & (POLLRDNORM | POLLRDBAND | POLLIN |
149 POLLHUP | POLLERR)) {
152 do_gettimeofday(&now);
154 (1000000 * (now.tv_sec - start.tv_sec) +
155 now.tv_usec - start.tv_usec);
156 if (elapsed > timeout)
158 set_current_state(TASK_INTERRUPTIBLE);
159 schedule_timeout(((timeout -
160 elapsed) * HZ) / 10000);
162 poll_freewait(&table);
167 if (f->f_op->read(f, &ch, 1, &f->f_pos) == 1)
171 /* Device does not support poll, busy wait */
177 if (retries >= timeout)
181 if (f->f_op->read(f, &ch, 1, &f->f_pos) == 1) {
193 static void tty_setspeed(struct file *f, int speed)
201 struct termios settings;
203 tty_ioctl(f, TCGETS, (unsigned long)&settings);
204 /* printk("Speed: %d\n", settings.c_cflag & (CBAUD | CBAUDEX)); */
205 settings.c_iflag = 0;
206 settings.c_oflag = 0;
207 settings.c_lflag = 0;
208 settings.c_cflag = CLOCAL | CS8 | CREAD;
209 settings.c_cc[VMIN] = 0;
210 settings.c_cc[VTIME] = 0;
213 settings.c_cflag |= B2400;
217 settings.c_cflag |= B4800;
221 settings.c_cflag |= B9600;
225 settings.c_cflag |= B19200;
229 settings.c_cflag |= B38400;
233 settings.c_cflag |= B57600;
237 settings.c_cflag |= B115200;
241 settings.c_cflag |= B9600;
245 tty_ioctl(f, TCSETS, (unsigned long)&settings);
246 /* printk("Speed: %d\n", settings.c_cflag & (CBAUD | CBAUDEX)); */
249 /* Set low latency */
250 struct serial_struct settings;
252 tty_ioctl(f, TIOCGSERIAL, (unsigned long)&settings);
253 settings.flags |= ASYNC_LOW_LATENCY;
254 tty_ioctl(f, TIOCSSERIAL, (unsigned long)&settings);
260 static void poll_digital(struct file *f, int channel)
264 cmd = 0x40 | (channel & 0x1f);
265 tty_write(f, &cmd, 1);
268 static void poll_channel(struct file *f, int channel)
272 cmd = 0x60 | (channel & 0x1f);
273 tty_write(f, &cmd, 1);
276 static struct serial_data serial_read(struct file *f, int timeout)
278 struct serial_data result;
281 result.kind = is_invalid;
286 int data = tty_read(f, timeout);
290 printk(KERN_ERR "serial2002 error\n");
292 } else if (data & 0x80) {
293 result.value = (result.value << 7) | (data & 0x7f);
296 switch ((data >> 5) & 0x03) {
299 result.kind = is_digital;
304 result.kind = is_digital;
310 (result.value << 2) | ((data & 0x60) >> 5);
311 result.kind = is_channel;
313 result.index = data & 0x1f;
321 static void serial_write(struct file *f, struct serial_data data)
323 if (data.kind == is_digital) {
325 ((data.value << 5) & 0x20) | (data.index & 0x1f);
326 tty_write(f, &ch, 1);
330 if (data.value >= (1L << 30)) {
331 ch[i] = 0x80 | ((data.value >> 30) & 0x03);
334 if (data.value >= (1L << 23)) {
335 ch[i] = 0x80 | ((data.value >> 23) & 0x7f);
338 if (data.value >= (1L << 16)) {
339 ch[i] = 0x80 | ((data.value >> 16) & 0x7f);
342 if (data.value >= (1L << 9)) {
343 ch[i] = 0x80 | ((data.value >> 9) & 0x7f);
346 ch[i] = 0x80 | ((data.value >> 2) & 0x7f);
348 ch[i] = ((data.value << 5) & 0x60) | (data.index & 0x1f);
354 static int serial_2002_open(struct comedi_device *dev)
359 sprintf(port, "/dev/ttyS%d", devpriv->port);
360 devpriv->tty = filp_open(port, O_RDWR, 0);
361 if (IS_ERR(devpriv->tty)) {
362 result = (int)PTR_ERR(devpriv->tty);
363 printk(KERN_ERR "serial_2002: file open error = %d\n", result);
373 struct config_t *dig_in_config;
374 struct config_t *dig_out_config;
375 struct config_t *chan_in_config;
376 struct config_t *chan_out_config;
380 dig_in_config = kcalloc(32, sizeof(struct config_t),
382 dig_out_config = kcalloc(32, sizeof(struct config_t),
384 chan_in_config = kcalloc(32, sizeof(struct config_t),
386 chan_out_config = kcalloc(32, sizeof(struct config_t),
388 if (!dig_in_config || !dig_out_config
389 || !chan_in_config || !chan_out_config) {
391 goto err_alloc_configs;
394 tty_setspeed(devpriv->tty, devpriv->speed);
395 poll_channel(devpriv->tty, 31); /* Start reading configuration */
397 struct serial_data data;
399 data = serial_read(devpriv->tty, 1000);
400 if (data.kind != is_channel || data.index != 31
401 || !(data.value & 0xe0)) {
404 int command, channel, kind;
405 struct config_t *cur_config = NULL;
407 channel = data.value & 0x1f;
408 kind = (data.value >> 5) & 0x7;
409 command = (data.value >> 8) & 0x3;
412 cur_config = dig_in_config;
416 cur_config = dig_out_config;
420 cur_config = chan_in_config;
424 cur_config = chan_out_config;
428 cur_config = chan_in_config;
434 cur_config[channel].kind = kind;
437 cur_config[channel].bits
479 cur_config[channel].min
519 cur_config[channel].max
527 for (i = 0; i <= 4; i++) {
528 /* Fill in subdev data */
530 unsigned char *mapping = NULL;
531 struct serial2002_range_table_t *range = NULL;
537 mapping = devpriv->digital_in_mapping;
543 mapping = devpriv->digital_out_mapping;
549 mapping = devpriv->analog_in_mapping;
550 range = devpriv->in_range;
556 mapping = devpriv->analog_out_mapping;
557 range = devpriv->out_range;
563 mapping = devpriv->encoder_in_mapping;
564 range = devpriv->in_range;
574 struct comedi_subdevice *s;
575 const struct comedi_lrange **range_table_list =
577 unsigned int *maxdata_list;
580 for (chan = 0, j = 0; j < 32; j++) {
581 if (c[j].kind == kind)
584 s = &dev->subdevices[i];
587 kfree(s->maxdata_list);
588 s->maxdata_list = maxdata_list =
589 kmalloc(sizeof(unsigned int) * s->n_chan,
591 if (!s->maxdata_list)
592 break; /* error handled below */
593 kfree(s->range_table_list);
594 s->range_table = NULL;
595 s->range_table_list = NULL;
597 s->range_table_list = range_table_list =
600 serial2002_range_table_t) *
601 s->n_chan, GFP_KERNEL);
602 if (!s->range_table_list)
603 break; /* err handled below */
605 for (chan = 0, j = 0; j < 32; j++) {
606 if (c[j].kind == kind) {
615 range_table_list[chan] =
621 ((long long)1 << c[j].bits)
629 /* Failed to allocate maxdata_list or range_table_list
630 * for a subdevice that needed it. */
632 for (i = 0; i <= 4; i++) {
633 struct comedi_subdevice *s;
635 s = &dev->subdevices[i];
636 kfree(s->maxdata_list);
637 s->maxdata_list = NULL;
638 kfree(s->range_table_list);
639 s->range_table_list = NULL;
644 kfree(dig_in_config);
645 kfree(dig_out_config);
646 kfree(chan_in_config);
647 kfree(chan_out_config);
651 filp_close(devpriv->tty, 0);
659 static void serial_2002_close(struct comedi_device *dev)
661 if (!IS_ERR(devpriv->tty) && (devpriv->tty != 0))
662 filp_close(devpriv->tty, 0);
665 static int serial2002_di_rinsn(struct comedi_device *dev,
666 struct comedi_subdevice *s,
667 struct comedi_insn *insn, unsigned int *data)
672 chan = devpriv->digital_in_mapping[CR_CHAN(insn->chanspec)];
673 for (n = 0; n < insn->n; n++) {
674 struct serial_data read;
676 poll_digital(devpriv->tty, chan);
678 read = serial_read(devpriv->tty, 1000);
679 if (read.kind != is_digital || read.index == chan)
682 data[n] = read.value;
687 static int serial2002_do_winsn(struct comedi_device *dev,
688 struct comedi_subdevice *s,
689 struct comedi_insn *insn, unsigned int *data)
694 chan = devpriv->digital_out_mapping[CR_CHAN(insn->chanspec)];
695 for (n = 0; n < insn->n; n++) {
696 struct serial_data write;
698 write.kind = is_digital;
700 write.value = data[n];
701 serial_write(devpriv->tty, write);
706 static int serial2002_ai_rinsn(struct comedi_device *dev,
707 struct comedi_subdevice *s,
708 struct comedi_insn *insn, unsigned int *data)
713 chan = devpriv->analog_in_mapping[CR_CHAN(insn->chanspec)];
714 for (n = 0; n < insn->n; n++) {
715 struct serial_data read;
717 poll_channel(devpriv->tty, chan);
719 read = serial_read(devpriv->tty, 1000);
720 if (read.kind != is_channel || read.index == chan)
723 data[n] = read.value;
728 static int serial2002_ao_winsn(struct comedi_device *dev,
729 struct comedi_subdevice *s,
730 struct comedi_insn *insn, unsigned int *data)
735 chan = devpriv->analog_out_mapping[CR_CHAN(insn->chanspec)];
736 for (n = 0; n < insn->n; n++) {
737 struct serial_data write;
739 write.kind = is_channel;
741 write.value = data[n];
742 serial_write(devpriv->tty, write);
743 devpriv->ao_readback[chan] = data[n];
748 static int serial2002_ao_rinsn(struct comedi_device *dev,
749 struct comedi_subdevice *s,
750 struct comedi_insn *insn, unsigned int *data)
753 int chan = CR_CHAN(insn->chanspec);
755 for (n = 0; n < insn->n; n++)
756 data[n] = devpriv->ao_readback[chan];
761 static int serial2002_ei_rinsn(struct comedi_device *dev,
762 struct comedi_subdevice *s,
763 struct comedi_insn *insn, unsigned int *data)
768 chan = devpriv->encoder_in_mapping[CR_CHAN(insn->chanspec)];
769 for (n = 0; n < insn->n; n++) {
770 struct serial_data read;
772 poll_channel(devpriv->tty, chan);
774 read = serial_read(devpriv->tty, 1000);
775 if (read.kind != is_channel || read.index == chan)
778 data[n] = read.value;
783 static int serial2002_attach(struct comedi_device *dev,
784 struct comedi_devconfig *it)
786 struct comedi_subdevice *s;
788 dev_dbg(dev->hw_dev, "comedi%d: attached\n", dev->minor);
789 dev->board_name = thisboard->name;
790 if (alloc_private(dev, sizeof(struct serial2002_private)) < 0)
792 dev->open = serial_2002_open;
793 dev->close = serial_2002_close;
794 devpriv->port = it->options[0];
795 devpriv->speed = it->options[1];
796 dev_dbg(dev->hw_dev, "/dev/ttyS%d @ %d\n", devpriv->port,
799 if (alloc_subdevices(dev, 5) < 0)
802 /* digital input subdevice */
803 s = dev->subdevices + 0;
804 s->type = COMEDI_SUBD_DI;
805 s->subdev_flags = SDF_READABLE;
808 s->range_table = &range_digital;
809 s->insn_read = &serial2002_di_rinsn;
811 /* digital output subdevice */
812 s = dev->subdevices + 1;
813 s->type = COMEDI_SUBD_DO;
814 s->subdev_flags = SDF_WRITEABLE;
817 s->range_table = &range_digital;
818 s->insn_write = &serial2002_do_winsn;
820 /* analog input subdevice */
821 s = dev->subdevices + 2;
822 s->type = COMEDI_SUBD_AI;
823 s->subdev_flags = SDF_READABLE | SDF_GROUND;
827 s->insn_read = &serial2002_ai_rinsn;
829 /* analog output subdevice */
830 s = dev->subdevices + 3;
831 s->type = COMEDI_SUBD_AO;
832 s->subdev_flags = SDF_WRITEABLE;
836 s->insn_write = &serial2002_ao_winsn;
837 s->insn_read = &serial2002_ao_rinsn;
839 /* encoder input subdevice */
840 s = dev->subdevices + 4;
841 s->type = COMEDI_SUBD_COUNTER;
842 s->subdev_flags = SDF_READABLE | SDF_LSAMPL;
846 s->insn_read = &serial2002_ei_rinsn;
851 static int serial2002_detach(struct comedi_device *dev)
853 struct comedi_subdevice *s;
856 dev_dbg(dev->hw_dev, "comedi%d: remove\n", dev->minor);
857 for (i = 0; i < 5; i++) {
858 s = &dev->subdevices[i];
859 kfree(s->maxdata_list);
860 kfree(s->range_table_list);
865 static const struct serial2002_board serial2002_boards[] = {
871 static struct comedi_driver serial2002_driver = {
872 .driver_name = "serial2002",
873 .module = THIS_MODULE,
874 .attach = serial2002_attach,
875 .detach = serial2002_detach,
876 .board_name = &serial2002_boards[0].name,
877 .offset = sizeof(struct serial2002_board),
878 .num_names = ARRAY_SIZE(serial2002_boards),
880 module_comedi_driver(serial2002_driver);
882 MODULE_AUTHOR("Comedi http://www.comedi.org");
883 MODULE_DESCRIPTION("Comedi low-level driver");
884 MODULE_LICENSE("GPL");