ssv_dnp.c revision c0d1482252b9b87c62b8d0ddb7ceecc369c6e34e
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
62static const struct dnp_board dnp_boards[] = {	/* we only support one DNP 'board'   */
63	{			/* variant at the moment             */
64	      name:	"dnp-1486",
65	      ai_chans:16,
66	      ai_bits:	12,
67	      have_dio:1,
68		},
69};
70
71/* Useful for shorthand access to the particular board structure ----------- */
72#define thisboard ((const struct dnp_board *)dev->board_ptr)
73
74/* This structure is for data unique to the DNP driver --------------------- */
75struct dnp_private_data {
76
77	//
78};
79
80
81/* Shorthand macro for faster access to the private data ------------------- */
82#define devpriv ((dnp_private *)dev->private)
83
84/* ------------------------------------------------------------------------- */
85/* The struct comedi_driver structure tells the Comedi core module which functions  */
86/* to call to configure/deconfigure (attach/detach) the board, and also      */
87/* about the kernel module that contains the device code.                    */
88/*                                                                           */
89/* In the following section we define the API of this driver.                */
90/* ------------------------------------------------------------------------- */
91
92static int dnp_attach(struct comedi_device * dev, struct comedi_devconfig * it);
93static int dnp_detach(struct comedi_device * dev);
94
95static struct comedi_driver driver_dnp = {
96      driver_name:"ssv_dnp",
97      module:THIS_MODULE,
98      attach:dnp_attach,
99      detach:dnp_detach,
100      board_name:&dnp_boards[0].name,
101	/* only necessary for non-PnP devs   */
102      offset:sizeof(struct dnp_board),/* like ISA-PnP, PCI or PCMCIA.      */
103      num_names:sizeof(dnp_boards) / sizeof(struct dnp_board),
104};
105
106COMEDI_INITCLEANUP(driver_dnp);
107
108static int dnp_dio_insn_bits(struct comedi_device * dev,
109	struct comedi_subdevice * s, struct comedi_insn * insn, unsigned int * data);
110
111static int dnp_dio_insn_config(struct comedi_device * dev,
112	struct comedi_subdevice * s, struct comedi_insn * insn, unsigned int * data);
113
114/* ------------------------------------------------------------------------- */
115/* Attach is called by comedi core to configure the driver for a particular  */
116/* board. If you specified a board_name array in the driver structure,       */
117/* dev->board_ptr contains that address.                                     */
118/* ------------------------------------------------------------------------- */
119
120static int dnp_attach(struct comedi_device * dev, struct comedi_devconfig * it)
121{
122
123	struct comedi_subdevice *s;
124
125	printk("comedi%d: dnp: ", dev->minor);
126
127	/* Autoprobing: this should find out which board we have. Currently only   */
128	/* the 1486 board is supported and autoprobing is not implemented :-)      */
129	//dev->board_ptr = dnp_probe(dev);
130
131	/* Initialize the name of the board. We can use the "thisboard" macro now. */
132	dev->board_name = thisboard->name;
133
134	/* Allocate the private structure area. alloc_private() is a convenient    */
135	/* macro defined in comedidev.h.                                           */
136	if (alloc_private(dev, sizeof(struct dnp_private_data)) < 0)
137		return -ENOMEM;
138
139	/* Allocate the subdevice structures. alloc_subdevice() is a convenient    */
140	/* macro defined in comedidev.h.                                           */
141
142	if (alloc_subdevices(dev, 1) < 0)
143		return -ENOMEM;
144
145	s = dev->subdevices + 0;
146	/* digital i/o subdevice                                                   */
147	s->type = COMEDI_SUBD_DIO;
148	s->subdev_flags = SDF_READABLE | SDF_WRITABLE;
149	s->n_chan = 20;
150	s->maxdata = 1;
151	s->range_table = &range_digital;
152	s->insn_bits = dnp_dio_insn_bits;
153	s->insn_config = dnp_dio_insn_config;
154
155	printk("attached\n");
156
157	/* We use the I/O ports 0x22,0x23 and 0xa3-0xa9, which are always
158	 * allocated for the primary 8259, so we don't need to allocate them
159	 * ourselves. */
160
161	/* configure all ports as input (default)                                  */
162	outb(PAMR, CSCIR);
163	outb(0x00, CSCDR);
164	outb(PBMR, CSCIR);
165	outb(0x00, CSCDR);
166	outb(PCMR, CSCIR);
167	outb((inb(CSCDR) & 0xAA), CSCDR);
168
169	return 1;
170
171}
172
173/* ------------------------------------------------------------------------- */
174/* detach is called to deconfigure a device. It should deallocate the        */
175/* resources. This function is also called when _attach() fails, so it       */
176/* should be careful not to release resources that were not necessarily      */
177/* allocated by _attach(). dev->private and dev->subdevices are              */
178/* deallocated automatically by the core.                                    */
179/* ------------------------------------------------------------------------- */
180
181static int dnp_detach(struct comedi_device * dev)
182{
183
184	/* configure all ports as input (default)                                  */
185	outb(PAMR, CSCIR);
186	outb(0x00, CSCDR);
187	outb(PBMR, CSCIR);
188	outb(0x00, CSCDR);
189	outb(PCMR, CSCIR);
190	outb((inb(CSCDR) & 0xAA), CSCDR);
191
192	/* announce that we are finished                                           */
193	printk("comedi%d: dnp: remove\n", dev->minor);
194
195	return 0;
196
197}
198
199/* ------------------------------------------------------------------------- */
200/* The insn_bits interface allows packed reading/writing of DIO channels.    */
201/* The comedi core can convert between insn_bits and insn_read/write, so you */
202/* are able to use these instructions as well.                               */
203/* ------------------------------------------------------------------------- */
204
205static int dnp_dio_insn_bits(struct comedi_device * dev,
206	struct comedi_subdevice * s, struct comedi_insn * insn, unsigned int * data)
207{
208
209	if (insn->n != 2)
210		return -EINVAL;	/* insn uses data[0] and data[1]     */
211
212	/* The insn data is a mask in data[0] and the new data in data[1], each    */
213	/* channel cooresponding to a bit.                                         */
214
215	/* Ports A and B are straight forward: each bit corresponds to an output   */
216	/* pin with the same order. Port C is different: bits 0...3 correspond to  */
217	/* bits 4...7 of the output register (PCDR).                               */
218
219	if (data[0]) {
220
221		outb(PADR, CSCIR);
222		outb((inb(CSCDR)
223				& ~(u8) (data[0] & 0x0000FF))
224			| (u8) (data[1] & 0x0000FF), CSCDR);
225
226		outb(PBDR, CSCIR);
227		outb((inb(CSCDR)
228				& ~(u8) ((data[0] & 0x00FF00) >> 8))
229			| (u8) ((data[1] & 0x00FF00) >> 8), CSCDR);
230
231		outb(PCDR, CSCIR);
232		outb((inb(CSCDR)
233				& ~(u8) ((data[0] & 0x0F0000) >> 12))
234			| (u8) ((data[1] & 0x0F0000) >> 12), CSCDR);
235	}
236
237	/* on return, data[1] contains the value of the digital input lines.       */
238	outb(PADR, CSCIR);
239	data[0] = inb(CSCDR);
240	outb(PBDR, CSCIR);
241	data[0] += inb(CSCDR) << 8;
242	outb(PCDR, CSCIR);
243	data[0] += ((inb(CSCDR) & 0xF0) << 12);
244
245	return 2;
246
247}
248
249/* ------------------------------------------------------------------------- */
250/* Configure the direction of the bidirectional digital i/o pins. chanspec   */
251/* contains the channel to be changed and data[0] contains either            */
252/* COMEDI_INPUT or COMEDI_OUTPUT.                                            */
253/* ------------------------------------------------------------------------- */
254
255static int dnp_dio_insn_config(struct comedi_device * dev,
256	struct comedi_subdevice * s, struct comedi_insn * insn, unsigned int * data)
257{
258
259	u8 register_buffer;
260
261	int chan = CR_CHAN(insn->chanspec);	/* reduces chanspec to lower 16 bits */
262
263	switch (data[0]) {
264	case INSN_CONFIG_DIO_OUTPUT:
265	case INSN_CONFIG_DIO_INPUT:
266		break;
267	case INSN_CONFIG_DIO_QUERY:
268		data[1] =
269			(inb(CSCDR) & (1 << chan)) ? COMEDI_OUTPUT :
270			COMEDI_INPUT;
271		return insn->n;
272		break;
273	default:
274		return -EINVAL;
275		break;
276	}
277	/* Test: which port does the channel belong to?                            */
278
279	/* We have to pay attention with port C: this is the meaning of PCMR:      */
280	/* Bit in PCMR:              7 6 5 4 3 2 1 0                               */
281	/* Corresponding port C pin: d 3 d 2 d 1 d 0   d= don't touch              */
282
283	if ((chan >= 0) && (chan <= 7)) {
284		/* this is port A */
285		outb(PAMR, CSCIR);
286	} else if ((chan >= 8) && (chan <= 15)) {
287		/* this is port B */
288		chan -= 8;
289		outb(PBMR, CSCIR);
290	} else if ((chan >= 16) && (chan <= 19)) {
291		/* this is port C; multiplication with 2 brings bits into correct        */
292		/* position for PCMR!                                                    */
293		chan -= 16;
294		chan *= 2;
295		outb(PCMR, CSCIR);
296	} else {
297		return -EINVAL;
298	}
299
300	/* read 'old' direction of the port and set bits (out=1, in=0)             */
301	register_buffer = inb(CSCDR);
302	if (data[0] == COMEDI_OUTPUT) {
303		register_buffer |= (1 << chan);
304	} else {
305		register_buffer &= ~(1 << chan);
306	}
307	outb(register_buffer, CSCDR);
308
309	return 1;
310
311}
312