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
);
150 * On 2.6.26.3 this occaisonally gave me page faults, worked around by
151 * settings.c_cc[VMIN] = 0; settings.c_cc[VTIME] = 0
153 static int tty_available(struct file
*f
)
160 tty_ioctl(f
, FIONREAD
, (unsigned long)&result
);
166 static int tty_read(struct file
*f
, int timeout
)
177 struct poll_wqueues table
;
178 struct timeval start
, now
;
180 do_gettimeofday(&start
);
181 poll_initwait(&table
);
186 mask
= f
->f_op
->poll(f
, &table
.pt
);
187 if (mask
& (POLLRDNORM
| POLLRDBAND
| POLLIN
|
188 POLLHUP
| POLLERR
)) {
191 do_gettimeofday(&now
);
193 (1000000 * (now
.tv_sec
- start
.tv_sec
) +
194 now
.tv_usec
- start
.tv_usec
);
195 if (elapsed
> timeout
) {
198 set_current_state(TASK_INTERRUPTIBLE
);
199 schedule_timeout(((timeout
-
200 elapsed
) * HZ
) / 10000);
202 poll_freewait(&table
);
207 if (f
->f_op
->read(f
, &ch
, 1, &f
->f_pos
) == 1) {
212 /* Device does not support poll, busy wait */
218 if (retries
>= timeout
) {
223 if (f
->f_op
->read(f
, &ch
, 1, &f
->f_pos
) == 1) {
235 static void tty_setspeed(struct file
*f
, int speed
)
243 struct termios settings
;
245 tty_ioctl(f
, TCGETS
, (unsigned long)&settings
);
246 /* printk("Speed: %d\n", settings.c_cflag & (CBAUD | CBAUDEX)); */
247 settings
.c_iflag
= 0;
248 settings
.c_oflag
= 0;
249 settings
.c_lflag
= 0;
250 settings
.c_cflag
= CLOCAL
| CS8
| CREAD
;
251 settings
.c_cc
[VMIN
] = 0;
252 settings
.c_cc
[VTIME
] = 0;
255 settings
.c_cflag
|= B2400
;
259 settings
.c_cflag
|= B4800
;
263 settings
.c_cflag
|= B9600
;
267 settings
.c_cflag
|= B19200
;
271 settings
.c_cflag
|= B38400
;
275 settings
.c_cflag
|= B57600
;
279 settings
.c_cflag
|= B115200
;
283 settings
.c_cflag
|= B9600
;
287 tty_ioctl(f
, TCSETS
, (unsigned long)&settings
);
288 /* printk("Speed: %d\n", settings.c_cflag & (CBAUD | CBAUDEX)); */
291 /* Set low latency */
292 struct serial_struct settings
;
294 tty_ioctl(f
, TIOCGSERIAL
, (unsigned long)&settings
);
295 settings
.flags
|= ASYNC_LOW_LATENCY
;
296 tty_ioctl(f
, TIOCSSERIAL
, (unsigned long)&settings
);
302 static void poll_digital(struct file
*f
, int channel
)
306 cmd
= 0x40 | (channel
& 0x1f);
307 tty_write(f
, &cmd
, 1);
310 static void poll_channel(struct file
*f
, int channel
)
314 cmd
= 0x60 | (channel
& 0x1f);
315 tty_write(f
, &cmd
, 1);
318 static struct serial_data
serial_read(struct file
*f
, int timeout
)
320 struct serial_data result
;
323 result
.kind
= is_invalid
;
328 int data
= tty_read(f
, timeout
);
332 printk("serial2002 error\n");
334 } else if (data
& 0x80) {
335 result
.value
= (result
.value
<< 7) | (data
& 0x7f);
338 switch ((data
>> 5) & 0x03) {
341 result
.kind
= is_digital
;
346 result
.kind
= is_digital
;
352 (result
.value
<< 2) | ((data
& 0x60) >> 5);
353 result
.kind
= is_channel
;
355 result
.index
= data
& 0x1f;
363 static void serial_write(struct file
*f
, struct serial_data data
)
365 if (data
.kind
== is_digital
) {
367 ((data
.value
<< 5) & 0x20) | (data
.index
& 0x1f);
368 tty_write(f
, &ch
, 1);
372 if (data
.value
>= (1L << 30)) {
373 ch
[i
] = 0x80 | ((data
.value
>> 30) & 0x03);
376 if (data
.value
>= (1L << 23)) {
377 ch
[i
] = 0x80 | ((data
.value
>> 23) & 0x7f);
380 if (data
.value
>= (1L << 16)) {
381 ch
[i
] = 0x80 | ((data
.value
>> 16) & 0x7f);
384 if (data
.value
>= (1L << 9)) {
385 ch
[i
] = 0x80 | ((data
.value
>> 9) & 0x7f);
388 ch
[i
] = 0x80 | ((data
.value
>> 2) & 0x7f);
390 ch
[i
] = ((data
.value
<< 5) & 0x60) | (data
.index
& 0x1f);
396 static void serial_2002_open(struct comedi_device
*dev
)
400 sprintf(port
, "/dev/ttyS%d", devpriv
->port
);
401 devpriv
->tty
= filp_open(port
, O_RDWR
, 0);
402 if (IS_ERR(devpriv
->tty
)) {
403 printk("serial_2002: file open error = %ld\n",
404 PTR_ERR(devpriv
->tty
));
414 struct config_t dig_in_config
[32];
415 struct config_t dig_out_config
[32];
416 struct config_t chan_in_config
[32];
417 struct config_t chan_out_config
[32];
420 for (i
= 0; i
< 32; i
++) {
421 dig_in_config
[i
].kind
= 0;
422 dig_in_config
[i
].bits
= 0;
423 dig_in_config
[i
].min
= 0;
424 dig_in_config
[i
].max
= 0;
425 dig_out_config
[i
].kind
= 0;
426 dig_out_config
[i
].bits
= 0;
427 dig_out_config
[i
].min
= 0;
428 dig_out_config
[i
].max
= 0;
429 chan_in_config
[i
].kind
= 0;
430 chan_in_config
[i
].bits
= 0;
431 chan_in_config
[i
].min
= 0;
432 chan_in_config
[i
].max
= 0;
433 chan_out_config
[i
].kind
= 0;
434 chan_out_config
[i
].bits
= 0;
435 chan_out_config
[i
].min
= 0;
436 chan_out_config
[i
].max
= 0;
439 tty_setspeed(devpriv
->tty
, devpriv
->speed
);
440 poll_channel(devpriv
->tty
, 31); /* Start reading configuration */
442 struct serial_data data
;
444 data
= serial_read(devpriv
->tty
, 1000);
445 if (data
.kind
!= is_channel
|| data
.index
!= 31
446 || !(data
.value
& 0xe0)) {
449 int command
, channel
, kind
;
450 struct config_t
*cur_config
= 0;
452 channel
= data
.value
& 0x1f;
453 kind
= (data
.value
>> 5) & 0x7;
454 command
= (data
.value
>> 8) & 0x3;
457 cur_config
= dig_in_config
;
461 cur_config
= dig_out_config
;
465 cur_config
= chan_in_config
;
469 cur_config
= chan_out_config
;
473 cur_config
= chan_in_config
;
479 cur_config
[channel
].kind
= kind
;
482 cur_config
[channel
].bits
525 cur_config
[channel
].min
566 cur_config
[channel
].max
574 for (i
= 0; i
<= 4; i
++) {
575 /* Fill in subdev data */
577 unsigned char *mapping
= 0;
578 struct serial2002_range_table_t
*range
= 0;
584 mapping
= devpriv
->digital_in_mapping
;
590 mapping
= devpriv
->digital_out_mapping
;
596 mapping
= devpriv
->analog_in_mapping
;
597 range
= devpriv
->in_range
;
603 mapping
= devpriv
->analog_out_mapping
;
604 range
= devpriv
->out_range
;
610 mapping
= devpriv
->encoder_in_mapping
;
611 range
= devpriv
->in_range
;
621 struct comedi_subdevice
*s
;
622 const struct comedi_lrange
**range_table_list
=
624 unsigned int *maxdata_list
;
627 for (chan
= 0, j
= 0; j
< 32; j
++) {
628 if (c
[j
].kind
== kind
) {
632 s
= &dev
->subdevices
[i
];
635 if (s
->maxdata_list
) {
636 kfree(s
->maxdata_list
);
638 s
->maxdata_list
= maxdata_list
=
639 kmalloc(sizeof(unsigned int) * s
->n_chan
,
641 if (s
->range_table_list
) {
642 kfree(s
->range_table_list
);
646 s
->range_table_list
= range_table_list
=
649 serial2002_range_table_t
) *
650 s
->n_chan
, GFP_KERNEL
);
652 for (chan
= 0, j
= 0; j
< 32; j
++) {
653 if (c
[j
].kind
== kind
) {
663 range_table_list
[chan
] =
669 ((long long)1 << c
[j
].bits
)
679 static void serial_2002_close(struct comedi_device
*dev
)
681 if (!IS_ERR(devpriv
->tty
) && (devpriv
->tty
!= 0)) {
682 filp_close(devpriv
->tty
, 0);
686 static int serial2002_di_rinsn(struct comedi_device
*dev
,
687 struct comedi_subdevice
*s
,
688 struct comedi_insn
*insn
, unsigned int *data
)
693 chan
= devpriv
->digital_in_mapping
[CR_CHAN(insn
->chanspec
)];
694 for (n
= 0; n
< insn
->n
; n
++) {
695 struct serial_data read
;
697 poll_digital(devpriv
->tty
, chan
);
699 read
= serial_read(devpriv
->tty
, 1000);
700 if (read
.kind
!= is_digital
|| read
.index
== chan
) {
704 data
[n
] = read
.value
;
709 static int serial2002_do_winsn(struct comedi_device
*dev
,
710 struct comedi_subdevice
*s
,
711 struct comedi_insn
*insn
, unsigned int *data
)
716 chan
= devpriv
->digital_out_mapping
[CR_CHAN(insn
->chanspec
)];
717 for (n
= 0; n
< insn
->n
; n
++) {
718 struct serial_data write
;
720 write
.kind
= is_digital
;
722 write
.value
= data
[n
];
723 serial_write(devpriv
->tty
, write
);
728 static int serial2002_ai_rinsn(struct comedi_device
*dev
,
729 struct comedi_subdevice
*s
,
730 struct comedi_insn
*insn
, unsigned int *data
)
735 chan
= devpriv
->analog_in_mapping
[CR_CHAN(insn
->chanspec
)];
736 for (n
= 0; n
< insn
->n
; n
++) {
737 struct serial_data read
;
739 poll_channel(devpriv
->tty
, chan
);
741 read
= serial_read(devpriv
->tty
, 1000);
742 if (read
.kind
!= is_channel
|| read
.index
== chan
) {
746 data
[n
] = read
.value
;
751 static int serial2002_ao_winsn(struct comedi_device
*dev
,
752 struct comedi_subdevice
*s
,
753 struct comedi_insn
*insn
, unsigned int *data
)
758 chan
= devpriv
->analog_out_mapping
[CR_CHAN(insn
->chanspec
)];
759 for (n
= 0; n
< insn
->n
; n
++) {
760 struct serial_data write
;
762 write
.kind
= is_channel
;
764 write
.value
= data
[n
];
765 serial_write(devpriv
->tty
, write
);
766 devpriv
->ao_readback
[chan
] = data
[n
];
771 static int serial2002_ao_rinsn(struct comedi_device
*dev
,
772 struct comedi_subdevice
*s
,
773 struct comedi_insn
*insn
, unsigned int *data
)
776 int chan
= CR_CHAN(insn
->chanspec
);
778 for (n
= 0; n
< insn
->n
; n
++) {
779 data
[n
] = devpriv
->ao_readback
[chan
];
785 static int serial2002_ei_rinsn(struct comedi_device
*dev
,
786 struct comedi_subdevice
*s
,
787 struct comedi_insn
*insn
, unsigned int *data
)
792 chan
= devpriv
->encoder_in_mapping
[CR_CHAN(insn
->chanspec
)];
793 for (n
= 0; n
< insn
->n
; n
++) {
794 struct serial_data read
;
796 poll_channel(devpriv
->tty
, chan
);
798 read
= serial_read(devpriv
->tty
, 1000);
799 if (read
.kind
!= is_channel
|| read
.index
== chan
) {
803 data
[n
] = read
.value
;
808 static int serial2002_attach(struct comedi_device
*dev
,
809 struct comedi_devconfig
*it
)
811 struct comedi_subdevice
*s
;
813 printk("comedi%d: serial2002: ", dev
->minor
);
814 dev
->board_name
= thisboard
->name
;
815 if (alloc_private(dev
, sizeof(struct serial2002_private
)) < 0) {
818 dev
->open
= serial_2002_open
;
819 dev
->close
= serial_2002_close
;
820 devpriv
->port
= it
->options
[0];
821 devpriv
->speed
= it
->options
[1];
822 printk("/dev/ttyS%d @ %d\n", devpriv
->port
, devpriv
->speed
);
824 if (alloc_subdevices(dev
, 5) < 0)
827 /* digital input subdevice */
828 s
= dev
->subdevices
+ 0;
829 s
->type
= COMEDI_SUBD_DI
;
830 s
->subdev_flags
= SDF_READABLE
;
833 s
->range_table
= &range_digital
;
834 s
->insn_read
= &serial2002_di_rinsn
;
836 /* digital output subdevice */
837 s
= dev
->subdevices
+ 1;
838 s
->type
= COMEDI_SUBD_DO
;
839 s
->subdev_flags
= SDF_WRITEABLE
;
842 s
->range_table
= &range_digital
;
843 s
->insn_write
= &serial2002_do_winsn
;
845 /* analog input subdevice */
846 s
= dev
->subdevices
+ 2;
847 s
->type
= COMEDI_SUBD_AI
;
848 s
->subdev_flags
= SDF_READABLE
| SDF_GROUND
;
852 s
->insn_read
= &serial2002_ai_rinsn
;
854 /* analog output subdevice */
855 s
= dev
->subdevices
+ 3;
856 s
->type
= COMEDI_SUBD_AO
;
857 s
->subdev_flags
= SDF_WRITEABLE
;
861 s
->insn_write
= &serial2002_ao_winsn
;
862 s
->insn_read
= &serial2002_ao_rinsn
;
864 /* encoder input subdevice */
865 s
= dev
->subdevices
+ 4;
866 s
->type
= COMEDI_SUBD_COUNTER
;
867 s
->subdev_flags
= SDF_READABLE
| SDF_LSAMPL
;
871 s
->insn_read
= &serial2002_ei_rinsn
;
876 static int serial2002_detach(struct comedi_device
*dev
)
878 struct comedi_subdevice
*s
;
881 printk("comedi%d: serial2002: remove\n", dev
->minor
);
882 for (i
= 0; i
< 4; i
++) {
883 s
= &dev
->subdevices
[i
];
884 if (s
->maxdata_list
) {
885 kfree(s
->maxdata_list
);
887 if (s
->range_table_list
) {
888 kfree(s
->range_table_list
);
894 COMEDI_INITCLEANUP(driver_serial2002
);