ssv_dnp.c revision 06033fced289985294e5a3f694646014d80b48cc
1/*
2    comedi/drivers/ssv_dnp.c
3    generic comedi driver for SSV Embedded Systems' DIL/Net-PCs
4    Copyright (C) 2001 Robert Schwebel <robert@schwebel.de>
5
6    COMEDI - Linux Control and Measurement Device Interface
7    Copyright (C) 2000 David A. Schleef <ds@schleef.org>
8
9    This program is free software; you can redistribute it and/or modify
10    it under the terms of the GNU General Public License as published by
11    the Free Software Foundation; either version 2 of the License, or
12    (at your option) any later version.
13
14    This program is distributed in the hope that it will be useful,
15    but WITHOUT ANY WARRANTY; without even the implied warranty of
16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17    GNU General Public License for more details.
18
19    You should have received a copy of the GNU General Public License
20    along with this program; if not, write to the Free Software
21    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22
23*/
24/*
25Driver: ssv_dnp
26Description: SSV Embedded Systems DIL/Net-PC
27Author: Robert Schwebel <robert@schwebel.de>
28Devices: [SSV Embedded Systems] DIL/Net-PC 1486 (dnp-1486)
29Status: unknown
30*/
31
32/* include files ----------------------------------------------------------- */
33
34#include "../comedidev.h"
35
36/* Some global definitions: the registers of the DNP ----------------------- */
37/*                                                                           */
38/* For port A and B the mode register has bits corresponding to the output   */
39/* pins, where Bit-N = 0 -> input, Bit-N = 1 -> output. Note that bits       */
40/* 4 to 7 correspond to pin 0..3 for port C data register. Ensure that bits  */
41/* 0..3 remain unchanged! For details about Port C Mode Register see         */
42/* the remarks in dnp_insn_config() below.                                   */
43
44#define CSCIR 0x22		/* Chip Setup and Control Index Register     */
45#define CSCDR 0x23		/* Chip Setup and Control Data Register      */
46#define PAMR  0xa5		/* Port A Mode Register                      */
47#define PADR  0xa9		/* Port A Data Register                      */
48#define PBMR  0xa4		/* Port B Mode Register                      */
49#define PBDR  0xa8		/* Port B Data Register                      */
50#define PCMR  0xa3		/* Port C Mode Register                      */
51#define PCDR  0xa7		/* Port C Data Register                      */
52
53/* This data structure holds information about the supported boards -------- */
54
55struct dnp_board {
56	const char *name;
57	int ai_chans;
58	int ai_bits;
59	int have_dio;
60};
61
62/* We only support one DNP 'board' variant at the moment */
63static const struct dnp_board dnp_boards[] = {
64{
65	 .name = "dnp-1486",
66	 .ai_chans = 16,
67	 .ai_bits = 12,
68	 .have_dio = 1,
69	 },
70};
71
72/* Useful for shorthand access to the particular board structure ----------- */
73#define thisboard ((const struct dnp_board *)dev->board_ptr)
74
75/* This structure is for data unique to the DNP driver --------------------- */
76struct dnp_private_data {
77
78};
79
80/* Shorthand macro for faster access to the private data ------------------- */
81#define devpriv ((dnp_private *)dev->private)
82
83/* ------------------------------------------------------------------------- */
84/* The struct comedi_driver structure tells the Comedi core module which     */
85/* functions to call to configure/deconfigure (attach/detach) the board, and */
86/* also about the kernel module that contains the device code.               */
87/*                                                                           */
88/* In the following section we define the API of this driver.                */
89/* ------------------------------------------------------------------------- */
90
91static int dnp_attach(struct comedi_device *dev, struct comedi_devconfig *it);
92static int dnp_detach(struct comedi_device *dev);
93
94static struct comedi_driver driver_dnp = {
95	.driver_name = "ssv_dnp",
96	.module = THIS_MODULE,
97	.attach = dnp_attach,
98	.detach = dnp_detach,
99	.board_name = &dnp_boards[0].name,
100	/* only necessary for non-PnP devs   */
101	.offset = sizeof(struct dnp_board),   /* like ISA-PnP, PCI or PCMCIA */
102	.num_names = ARRAY_SIZE(dnp_boards),
103};
104
105COMEDI_INITCLEANUP(driver_dnp);
106
107static int dnp_dio_insn_bits(struct comedi_device *dev,
108			     struct comedi_subdevice *s,
109			     struct comedi_insn *insn, unsigned int *data);
110
111static int dnp_dio_insn_config(struct comedi_device *dev,
112			       struct comedi_subdevice *s,
113			       struct comedi_insn *insn, unsigned int *data);
114
115/* ------------------------------------------------------------------------- */
116/* Attach is called by comedi core to configure the driver for a particular  */
117/* board. If you specified a board_name array in the driver structure,       */
118/* dev->board_ptr contains that address.                                     */
119/* ------------------------------------------------------------------------- */
120
121static int dnp_attach(struct comedi_device *dev, struct comedi_devconfig *it)
122{
123
124	struct comedi_subdevice *s;
125
126	printk(KERN_INFO "comedi%d: dnp: ", dev->minor);
127
128	/* Autoprobing: this should find out which board we have. Currently  */
129	/* only the 1486 board is supported and autoprobing is not           */
130	/* implemented :-)                                                   */
131	/* dev->board_ptr = dnp_probe(dev); */
132
133	/* Initialize the name of the board.                                 */
134	/* We can use the "thisboard" macro now.                             */
135	dev->board_name = thisboard->name;
136
137	/* Allocate the private structure area. alloc_private() is a         */
138	/* convenient macro defined in comedidev.h.                          */
139	if (alloc_private(dev, sizeof(struct dnp_private_data)) < 0)
140		return -ENOMEM;
141
142	/* Allocate the subdevice structures. alloc_subdevice() is a         */
143	/* convenient macro defined in comedidev.h.                          */
144
145	if (alloc_subdevices(dev, 1) < 0)
146		return -ENOMEM;
147
148	s = dev->subdevices + 0;
149	/* digital i/o subdevice                                             */
150	s->type = COMEDI_SUBD_DIO;
151	s->subdev_flags = SDF_READABLE | SDF_WRITABLE;
152	s->n_chan = 20;
153	s->maxdata = 1;
154	s->range_table = &range_digital;
155	s->insn_bits = dnp_dio_insn_bits;
156	s->insn_config = dnp_dio_insn_config;
157
158	printk("attached\n");
159
160	/* We use the I/O ports 0x22,0x23 and 0xa3-0xa9, which are always
161	 * allocated for the primary 8259, so we don't need to allocate them
162	 * ourselves. */
163
164	/* configure all ports as input (default)                            */
165	outb(PAMR, CSCIR);
166	outb(0x00, CSCDR);
167	outb(PBMR, CSCIR);
168	outb(0x00, CSCDR);
169	outb(PCMR, CSCIR);
170	outb((inb(CSCDR) & 0xAA), CSCDR);
171
172	return 1;
173
174}
175
176/* ------------------------------------------------------------------------- */
177/* detach is called to deconfigure a device. It should deallocate the        */
178/* resources. This function is also called when _attach() fails, so it       */
179/* should be careful not to release resources that were not necessarily      */
180/* allocated by _attach(). dev->private and dev->subdevices are              */
181/* deallocated automatically by the core.                                    */
182/* ------------------------------------------------------------------------- */
183
184static int dnp_detach(struct comedi_device *dev)
185{
186
187	/* configure all ports as input (default)                            */
188	outb(PAMR, CSCIR);
189	outb(0x00, CSCDR);
190	outb(PBMR, CSCIR);
191	outb(0x00, CSCDR);
192	outb(PCMR, CSCIR);
193	outb((inb(CSCDR) & 0xAA), CSCDR);
194
195	/* announce that we are finished                                     */
196	printk(KERN_INFO "comedi%d: dnp: remove\n", dev->minor);
197
198	return 0;
199
200}
201
202/* ------------------------------------------------------------------------- */
203/* The insn_bits interface allows packed reading/writing of DIO channels.    */
204/* The comedi core can convert between insn_bits and insn_read/write, so you */
205/* are able to use these instructions as well.                               */
206/* ------------------------------------------------------------------------- */
207
208static int dnp_dio_insn_bits(struct comedi_device *dev,
209			     struct comedi_subdevice *s,
210			     struct comedi_insn *insn, unsigned int *data)
211{
212
213	if (insn->n != 2)
214		return -EINVAL;	/* insn uses data[0] and data[1]     */
215
216	/* The insn data is a mask in data[0] and the new data in data[1],   */
217	/* each channel cooresponding to a bit.                              */
218
219	/* Ports A and B are straight forward: each bit corresponds to an    */
220	/* output pin with the same order. Port C is different: bits 0...3   */
221	/* correspond to bits 4...7 of the output register (PCDR).           */
222
223	if (data[0]) {
224
225		outb(PADR, CSCIR);
226		outb((inb(CSCDR)
227		      & ~(u8) (data[0] & 0x0000FF))
228		     | (u8) (data[1] & 0x0000FF), CSCDR);
229
230		outb(PBDR, CSCIR);
231		outb((inb(CSCDR)
232		      & ~(u8) ((data[0] & 0x00FF00) >> 8))
233		     | (u8) ((data[1] & 0x00FF00) >> 8), CSCDR);
234
235		outb(PCDR, CSCIR);
236		outb((inb(CSCDR)
237		      & ~(u8) ((data[0] & 0x0F0000) >> 12))
238		     | (u8) ((data[1] & 0x0F0000) >> 12), CSCDR);
239	}
240
241	/* on return, data[1] contains the value of the digital input lines. */
242	outb(PADR, CSCIR);
243	data[0] = inb(CSCDR);
244	outb(PBDR, CSCIR);
245	data[0] += inb(CSCDR) << 8;
246	outb(PCDR, CSCIR);
247	data[0] += ((inb(CSCDR) & 0xF0) << 12);
248
249	return 2;
250
251}
252
253/* ------------------------------------------------------------------------- */
254/* Configure the direction of the bidirectional digital i/o pins. chanspec   */
255/* contains the channel to be changed and data[0] contains either            */
256/* COMEDI_INPUT or COMEDI_OUTPUT.                                            */
257/* ------------------------------------------------------------------------- */
258
259static int dnp_dio_insn_config(struct comedi_device *dev,
260			       struct comedi_subdevice *s,
261			       struct comedi_insn *insn, unsigned int *data)
262{
263
264	u8 register_buffer;
265
266	/* reduces chanspec to lower 16 bits */
267	int chan = CR_CHAN(insn->chanspec);
268
269	switch (data[0]) {
270	case INSN_CONFIG_DIO_OUTPUT:
271	case INSN_CONFIG_DIO_INPUT:
272		break;
273	case INSN_CONFIG_DIO_QUERY:
274		data[1] =
275		    (inb(CSCDR) & (1 << chan)) ? COMEDI_OUTPUT : COMEDI_INPUT;
276		return insn->n;
277		break;
278	default:
279		return -EINVAL;
280		break;
281	}
282	/* Test: which port does the channel belong to?                       */
283
284	/* We have to pay attention with port C: this is the meaning of PCMR: */
285	/* Bit in PCMR:              7 6 5 4 3 2 1 0                          */
286	/* Corresponding port C pin: d 3 d 2 d 1 d 0   d= don't touch         */
287
288	if ((chan >= 0) && (chan <= 7)) {
289		/* this is port A */
290		outb(PAMR, CSCIR);
291	} else if ((chan >= 8) && (chan <= 15)) {
292		/* this is port B */
293		chan -= 8;
294		outb(PBMR, CSCIR);
295	} else if ((chan >= 16) && (chan <= 19)) {
296		/* this is port C; multiplication with 2 brings bits into     */
297		/* correct position for PCMR!                                 */
298		chan -= 16;
299		chan *= 2;
300		outb(PCMR, CSCIR);
301	} else {
302		return -EINVAL;
303	}
304
305	/* read 'old' direction of the port and set bits (out=1, in=0)        */
306	register_buffer = inb(CSCDR);
307	if (data[0] == COMEDI_OUTPUT)
308		register_buffer |= (1 << chan);
309	else
310		register_buffer &= ~(1 << chan);
311
312	outb(register_buffer, CSCDR);
313
314	return 1;
315
316}
317