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 <asm/termios.h>
42 #include <asm/ioctls.h>
43 #include <linux/serial.h>
44 #include <linux/poll.h>
47 * Board descriptions for two imaginary boards. Describing the
48 * boards in this way is optional, and completely driver-dependent.
49 * Some drivers use arrays such as this, other do not.
51 struct serial2002_board
{
55 static const struct serial2002_board serial2002_boards
[] = {
61 * Useful for shorthand access to the particular board structure
63 #define thisboard ((const struct serial2002_board *)dev->board_ptr)
65 struct serial2002_range_table_t
{
69 struct comedi_krange range
;
72 struct serial2002_private
{
74 int port
; /* /dev/ttyS<port> */
75 int speed
; /* baudrate */
77 unsigned int ao_readback
[32];
78 unsigned char digital_in_mapping
[32];
79 unsigned char digital_out_mapping
[32];
80 unsigned char analog_in_mapping
[32];
81 unsigned char analog_out_mapping
[32];
82 unsigned char encoder_in_mapping
[32];
83 struct serial2002_range_table_t in_range
[32], out_range
[32];
87 * most drivers define the following macro to make it easy to
88 * access the private structure.
90 #define devpriv ((struct serial2002_private *)dev->private)
92 static int serial2002_attach(struct comedi_device
*dev
,
93 struct comedi_devconfig
*it
);
94 static int serial2002_detach(struct comedi_device
*dev
);
95 struct comedi_driver driver_serial2002
= {
96 .driver_name
= "serial2002",
97 .module
= THIS_MODULE
,
98 .attach
= serial2002_attach
,
99 .detach
= serial2002_detach
,
100 .board_name
= &serial2002_boards
[0].name
,
101 .offset
= sizeof(struct serial2002_board
),
102 .num_names
= ARRAY_SIZE(serial2002_boards
),
105 static int serial2002_di_rinsn(struct comedi_device
*dev
,
106 struct comedi_subdevice
*s
,
107 struct comedi_insn
*insn
, unsigned int *data
);
108 static int serial2002_do_winsn(struct comedi_device
*dev
,
109 struct comedi_subdevice
*s
,
110 struct comedi_insn
*insn
, unsigned int *data
);
111 static int serial2002_ai_rinsn(struct comedi_device
*dev
,
112 struct comedi_subdevice
*s
,
113 struct comedi_insn
*insn
, unsigned int *data
);
114 static int serial2002_ao_winsn(struct comedi_device
*dev
,
115 struct comedi_subdevice
*s
,
116 struct comedi_insn
*insn
, unsigned int *data
);
117 static int serial2002_ao_rinsn(struct comedi_device
*dev
,
118 struct comedi_subdevice
*s
,
119 struct comedi_insn
*insn
, unsigned int *data
);
122 enum { is_invalid
, is_digital
, is_channel
} kind
;
127 static long tty_ioctl(struct file
*f
, unsigned op
, unsigned long param
)
129 if (f
->f_op
->unlocked_ioctl
)
130 return f
->f_op
->unlocked_ioctl(f
, op
, param
);
135 static int tty_write(struct file
*f
, unsigned char *buf
, int count
)
143 result
= f
->f_op
->write(f
, buf
, count
, &f
->f_pos
);
149 static int tty_read(struct file
*f
, int timeout
)
160 struct poll_wqueues table
;
161 struct timeval start
, now
;
163 do_gettimeofday(&start
);
164 poll_initwait(&table
);
169 mask
= f
->f_op
->poll(f
, &table
.pt
);
170 if (mask
& (POLLRDNORM
| POLLRDBAND
| POLLIN
|
171 POLLHUP
| POLLERR
)) {
174 do_gettimeofday(&now
);
176 (1000000 * (now
.tv_sec
- start
.tv_sec
) +
177 now
.tv_usec
- start
.tv_usec
);
178 if (elapsed
> timeout
) {
181 set_current_state(TASK_INTERRUPTIBLE
);
182 schedule_timeout(((timeout
-
183 elapsed
) * HZ
) / 10000);
185 poll_freewait(&table
);
190 if (f
->f_op
->read(f
, &ch
, 1, &f
->f_pos
) == 1) {
195 /* Device does not support poll, busy wait */
201 if (retries
>= timeout
) {
206 if (f
->f_op
->read(f
, &ch
, 1, &f
->f_pos
) == 1) {
218 static void tty_setspeed(struct file
*f
, int speed
)
226 struct termios settings
;
228 tty_ioctl(f
, TCGETS
, (unsigned long)&settings
);
229 /* printk("Speed: %d\n", settings.c_cflag & (CBAUD | CBAUDEX)); */
230 settings
.c_iflag
= 0;
231 settings
.c_oflag
= 0;
232 settings
.c_lflag
= 0;
233 settings
.c_cflag
= CLOCAL
| CS8
| CREAD
;
234 settings
.c_cc
[VMIN
] = 0;
235 settings
.c_cc
[VTIME
] = 0;
238 settings
.c_cflag
|= B2400
;
242 settings
.c_cflag
|= B4800
;
246 settings
.c_cflag
|= B9600
;
250 settings
.c_cflag
|= B19200
;
254 settings
.c_cflag
|= B38400
;
258 settings
.c_cflag
|= B57600
;
262 settings
.c_cflag
|= B115200
;
266 settings
.c_cflag
|= B9600
;
270 tty_ioctl(f
, TCSETS
, (unsigned long)&settings
);
271 /* printk("Speed: %d\n", settings.c_cflag & (CBAUD | CBAUDEX)); */
274 /* Set low latency */
275 struct serial_struct settings
;
277 tty_ioctl(f
, TIOCGSERIAL
, (unsigned long)&settings
);
278 settings
.flags
|= ASYNC_LOW_LATENCY
;
279 tty_ioctl(f
, TIOCSSERIAL
, (unsigned long)&settings
);
285 static void poll_digital(struct file
*f
, int channel
)
289 cmd
= 0x40 | (channel
& 0x1f);
290 tty_write(f
, &cmd
, 1);
293 static void poll_channel(struct file
*f
, int channel
)
297 cmd
= 0x60 | (channel
& 0x1f);
298 tty_write(f
, &cmd
, 1);
301 static struct serial_data
serial_read(struct file
*f
, int timeout
)
303 struct serial_data result
;
306 result
.kind
= is_invalid
;
311 int data
= tty_read(f
, timeout
);
315 printk("serial2002 error\n");
317 } else if (data
& 0x80) {
318 result
.value
= (result
.value
<< 7) | (data
& 0x7f);
321 switch ((data
>> 5) & 0x03) {
324 result
.kind
= is_digital
;
329 result
.kind
= is_digital
;
335 (result
.value
<< 2) | ((data
& 0x60) >> 5);
336 result
.kind
= is_channel
;
338 result
.index
= data
& 0x1f;
346 static void serial_write(struct file
*f
, struct serial_data data
)
348 if (data
.kind
== is_digital
) {
350 ((data
.value
<< 5) & 0x20) | (data
.index
& 0x1f);
351 tty_write(f
, &ch
, 1);
355 if (data
.value
>= (1L << 30)) {
356 ch
[i
] = 0x80 | ((data
.value
>> 30) & 0x03);
359 if (data
.value
>= (1L << 23)) {
360 ch
[i
] = 0x80 | ((data
.value
>> 23) & 0x7f);
363 if (data
.value
>= (1L << 16)) {
364 ch
[i
] = 0x80 | ((data
.value
>> 16) & 0x7f);
367 if (data
.value
>= (1L << 9)) {
368 ch
[i
] = 0x80 | ((data
.value
>> 9) & 0x7f);
371 ch
[i
] = 0x80 | ((data
.value
>> 2) & 0x7f);
373 ch
[i
] = ((data
.value
<< 5) & 0x60) | (data
.index
& 0x1f);
379 static int serial_2002_open(struct comedi_device
*dev
)
384 sprintf(port
, "/dev/ttyS%d", devpriv
->port
);
385 devpriv
->tty
= filp_open(port
, O_RDWR
, 0);
386 if (IS_ERR(devpriv
->tty
)) {
387 result
= (int)PTR_ERR(devpriv
->tty
);
388 printk("serial_2002: file open error = %d\n", result
);
398 struct config_t
*dig_in_config
;
399 struct config_t
*dig_out_config
;
400 struct config_t
*chan_in_config
;
401 struct config_t
*chan_out_config
;
405 dig_in_config
= kcalloc(32, sizeof(struct config_t
),
407 dig_out_config
= kcalloc(32, sizeof(struct config_t
),
409 chan_in_config
= kcalloc(32, sizeof(struct config_t
),
411 chan_out_config
= kcalloc(32, sizeof(struct config_t
),
413 if (!dig_in_config
|| !dig_out_config
414 || !chan_in_config
|| !chan_out_config
) {
416 goto err_alloc_configs
;
419 tty_setspeed(devpriv
->tty
, devpriv
->speed
);
420 poll_channel(devpriv
->tty
, 31); /* Start reading configuration */
422 struct serial_data data
;
424 data
= serial_read(devpriv
->tty
, 1000);
425 if (data
.kind
!= is_channel
|| data
.index
!= 31
426 || !(data
.value
& 0xe0)) {
429 int command
, channel
, kind
;
430 struct config_t
*cur_config
= NULL
;
432 channel
= data
.value
& 0x1f;
433 kind
= (data
.value
>> 5) & 0x7;
434 command
= (data
.value
>> 8) & 0x3;
437 cur_config
= dig_in_config
;
441 cur_config
= dig_out_config
;
445 cur_config
= chan_in_config
;
449 cur_config
= chan_out_config
;
453 cur_config
= chan_in_config
;
459 cur_config
[channel
].kind
= kind
;
462 cur_config
[channel
].bits
505 cur_config
[channel
].min
546 cur_config
[channel
].max
554 for (i
= 0; i
<= 4; i
++) {
555 /* Fill in subdev data */
557 unsigned char *mapping
= NULL
;
558 struct serial2002_range_table_t
*range
= NULL
;
564 mapping
= devpriv
->digital_in_mapping
;
570 mapping
= devpriv
->digital_out_mapping
;
576 mapping
= devpriv
->analog_in_mapping
;
577 range
= devpriv
->in_range
;
583 mapping
= devpriv
->analog_out_mapping
;
584 range
= devpriv
->out_range
;
590 mapping
= devpriv
->encoder_in_mapping
;
591 range
= devpriv
->in_range
;
601 struct comedi_subdevice
*s
;
602 const struct comedi_lrange
**range_table_list
=
604 unsigned int *maxdata_list
;
607 for (chan
= 0, j
= 0; j
< 32; j
++) {
608 if (c
[j
].kind
== kind
) {
612 s
= &dev
->subdevices
[i
];
615 kfree(s
->maxdata_list
);
616 s
->maxdata_list
= maxdata_list
=
617 kmalloc(sizeof(unsigned int) * s
->n_chan
,
619 if (!s
->maxdata_list
)
620 break; /* error handled below */
621 kfree(s
->range_table_list
);
622 s
->range_table
= NULL
;
623 s
->range_table_list
= NULL
;
625 s
->range_table_list
= range_table_list
=
628 serial2002_range_table_t
) *
629 s
->n_chan
, GFP_KERNEL
);
630 if (!s
->range_table_list
)
631 break; /* err handled below */
633 for (chan
= 0, j
= 0; j
< 32; j
++) {
634 if (c
[j
].kind
== kind
) {
644 range_table_list
[chan
] =
650 ((long long)1 << c
[j
].bits
)
658 /* Failed to allocate maxdata_list or range_table_list
659 * for a subdevice that needed it. */
661 for (i
= 0; i
<= 4; i
++) {
662 struct comedi_subdevice
*s
;
664 s
= &dev
->subdevices
[i
];
665 kfree(s
->maxdata_list
);
666 s
->maxdata_list
= NULL
;
667 kfree(s
->range_table_list
);
668 s
->range_table_list
= NULL
;
673 kfree(dig_in_config
);
674 kfree(dig_out_config
);
675 kfree(chan_in_config
);
676 kfree(chan_out_config
);
680 filp_close(devpriv
->tty
, 0);
688 static void serial_2002_close(struct comedi_device
*dev
)
690 if (!IS_ERR(devpriv
->tty
) && (devpriv
->tty
!= 0)) {
691 filp_close(devpriv
->tty
, 0);
695 static int serial2002_di_rinsn(struct comedi_device
*dev
,
696 struct comedi_subdevice
*s
,
697 struct comedi_insn
*insn
, unsigned int *data
)
702 chan
= devpriv
->digital_in_mapping
[CR_CHAN(insn
->chanspec
)];
703 for (n
= 0; n
< insn
->n
; n
++) {
704 struct serial_data read
;
706 poll_digital(devpriv
->tty
, chan
);
708 read
= serial_read(devpriv
->tty
, 1000);
709 if (read
.kind
!= is_digital
|| read
.index
== chan
) {
713 data
[n
] = read
.value
;
718 static int serial2002_do_winsn(struct comedi_device
*dev
,
719 struct comedi_subdevice
*s
,
720 struct comedi_insn
*insn
, unsigned int *data
)
725 chan
= devpriv
->digital_out_mapping
[CR_CHAN(insn
->chanspec
)];
726 for (n
= 0; n
< insn
->n
; n
++) {
727 struct serial_data write
;
729 write
.kind
= is_digital
;
731 write
.value
= data
[n
];
732 serial_write(devpriv
->tty
, write
);
737 static int serial2002_ai_rinsn(struct comedi_device
*dev
,
738 struct comedi_subdevice
*s
,
739 struct comedi_insn
*insn
, unsigned int *data
)
744 chan
= devpriv
->analog_in_mapping
[CR_CHAN(insn
->chanspec
)];
745 for (n
= 0; n
< insn
->n
; n
++) {
746 struct serial_data read
;
748 poll_channel(devpriv
->tty
, chan
);
750 read
= serial_read(devpriv
->tty
, 1000);
751 if (read
.kind
!= is_channel
|| read
.index
== chan
) {
755 data
[n
] = read
.value
;
760 static int serial2002_ao_winsn(struct comedi_device
*dev
,
761 struct comedi_subdevice
*s
,
762 struct comedi_insn
*insn
, unsigned int *data
)
767 chan
= devpriv
->analog_out_mapping
[CR_CHAN(insn
->chanspec
)];
768 for (n
= 0; n
< insn
->n
; n
++) {
769 struct serial_data write
;
771 write
.kind
= is_channel
;
773 write
.value
= data
[n
];
774 serial_write(devpriv
->tty
, write
);
775 devpriv
->ao_readback
[chan
] = data
[n
];
780 static int serial2002_ao_rinsn(struct comedi_device
*dev
,
781 struct comedi_subdevice
*s
,
782 struct comedi_insn
*insn
, unsigned int *data
)
785 int chan
= CR_CHAN(insn
->chanspec
);
787 for (n
= 0; n
< insn
->n
; n
++) {
788 data
[n
] = devpriv
->ao_readback
[chan
];
794 static int serial2002_ei_rinsn(struct comedi_device
*dev
,
795 struct comedi_subdevice
*s
,
796 struct comedi_insn
*insn
, unsigned int *data
)
801 chan
= devpriv
->encoder_in_mapping
[CR_CHAN(insn
->chanspec
)];
802 for (n
= 0; n
< insn
->n
; n
++) {
803 struct serial_data read
;
805 poll_channel(devpriv
->tty
, chan
);
807 read
= serial_read(devpriv
->tty
, 1000);
808 if (read
.kind
!= is_channel
|| read
.index
== chan
) {
812 data
[n
] = read
.value
;
817 static int serial2002_attach(struct comedi_device
*dev
,
818 struct comedi_devconfig
*it
)
820 struct comedi_subdevice
*s
;
822 printk("comedi%d: serial2002: ", dev
->minor
);
823 dev
->board_name
= thisboard
->name
;
824 if (alloc_private(dev
, sizeof(struct serial2002_private
)) < 0) {
827 dev
->open
= serial_2002_open
;
828 dev
->close
= serial_2002_close
;
829 devpriv
->port
= it
->options
[0];
830 devpriv
->speed
= it
->options
[1];
831 printk("/dev/ttyS%d @ %d\n", devpriv
->port
, devpriv
->speed
);
833 if (alloc_subdevices(dev
, 5) < 0)
836 /* digital input subdevice */
837 s
= dev
->subdevices
+ 0;
838 s
->type
= COMEDI_SUBD_DI
;
839 s
->subdev_flags
= SDF_READABLE
;
842 s
->range_table
= &range_digital
;
843 s
->insn_read
= &serial2002_di_rinsn
;
845 /* digital output subdevice */
846 s
= dev
->subdevices
+ 1;
847 s
->type
= COMEDI_SUBD_DO
;
848 s
->subdev_flags
= SDF_WRITEABLE
;
851 s
->range_table
= &range_digital
;
852 s
->insn_write
= &serial2002_do_winsn
;
854 /* analog input subdevice */
855 s
= dev
->subdevices
+ 2;
856 s
->type
= COMEDI_SUBD_AI
;
857 s
->subdev_flags
= SDF_READABLE
| SDF_GROUND
;
861 s
->insn_read
= &serial2002_ai_rinsn
;
863 /* analog output subdevice */
864 s
= dev
->subdevices
+ 3;
865 s
->type
= COMEDI_SUBD_AO
;
866 s
->subdev_flags
= SDF_WRITEABLE
;
870 s
->insn_write
= &serial2002_ao_winsn
;
871 s
->insn_read
= &serial2002_ao_rinsn
;
873 /* encoder input subdevice */
874 s
= dev
->subdevices
+ 4;
875 s
->type
= COMEDI_SUBD_COUNTER
;
876 s
->subdev_flags
= SDF_READABLE
| SDF_LSAMPL
;
880 s
->insn_read
= &serial2002_ei_rinsn
;
885 static int serial2002_detach(struct comedi_device
*dev
)
887 struct comedi_subdevice
*s
;
890 printk("comedi%d: serial2002: remove\n", dev
->minor
);
891 for (i
= 0; i
< 5; i
++) {
892 s
= &dev
->subdevices
[i
];
893 if (s
->maxdata_list
) {
894 kfree(s
->maxdata_list
);
896 if (s
->range_table_list
) {
897 kfree(s
->range_table_list
);
903 static int __init
driver_serial2002_init_module(void)
905 return comedi_driver_register(&driver_serial2002
);
908 static void __exit
driver_serial2002_cleanup_module(void)
910 comedi_driver_unregister(&driver_serial2002
);
913 module_init(driver_serial2002_init_module
);
914 module_exit(driver_serial2002_cleanup_module
);
916 MODULE_AUTHOR("Comedi http://www.comedi.org");
917 MODULE_DESCRIPTION("Comedi low-level driver");
918 MODULE_LICENSE("GPL");