adl_pci6208.c revision 0a85b6f0ab0d2edb0d41b32697111ce0e4f43496
1/*
2    comedi/drivers/adl_pci6208.c
3
4    Hardware driver for ADLink 6208 series cards:
5	card	     | voltage output    | current output
6	-------------+-------------------+---------------
7	PCI-6208V    |  8 channels       | -
8	PCI-6216V    | 16 channels       | -
9	PCI-6208A    |  8 channels       | 8 channels
10
11    COMEDI - Linux Control and Measurement Device Interface
12    Copyright (C) 2000 David A. Schleef <ds@schleef.org>
13
14    This program is free software; you can redistribute it and/or modify
15    it under the terms of the GNU General Public License as published by
16    the Free Software Foundation; either version 2 of the License, or
17    (at your option) any later version.
18
19    This program is distributed in the hope that it will be useful,
20    but WITHOUT ANY WARRANTY; without even the implied warranty of
21    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
22    GNU General Public License for more details.
23
24    You should have received a copy of the GNU General Public License
25    along with this program; if not, write to the Free Software
26    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
27*/
28/*
29Driver: adl_pci6208
30Description: ADLink PCI-6208A
31Devices: [ADLink] PCI-6208A (adl_pci6208)
32Author: nsyeow <nsyeow@pd.jaring.my>
33Updated: Fri, 30 Jan 2004 14:44:27 +0800
34Status: untested
35
36Configuration Options:
37  none
38
39References:
40	- ni_660x.c
41	- adl_pci9111.c		copied the entire pci setup section
42	- adl_pci9118.c
43*/
44/*
45 * These headers should be followed by a blank line, and any comments
46 * you wish to say about the driver.  The comment area is the place
47 * to put any known bugs, limitations, unsupported features, supported
48 * command triggers, whether or not commands are supported on particular
49 * subdevices, etc.
50 *
51 * Somewhere in the comment should be information about configuration
52 * options that are used with comedi_config.
53 */
54#include "../comedidev.h"
55#include "comedi_pci.h"
56
57#define PCI6208_DRIVER_NAME 	"adl_pci6208"
58
59/* Board descriptions */
60struct pci6208_board {
61	const char *name;
62	unsigned short dev_id;	/* `lspci` will show you this */
63	int ao_chans;
64	/* int ao_bits; */
65};
66
67static const struct pci6208_board pci6208_boards[] = {
68	/*{
69	   .name = "pci6208v",
70	   .dev_id = 0x6208,      // not sure
71	   .ao_chans = 8
72	   // , .ao_bits = 16
73	   },
74	   {
75	   .name = "pci6216v",
76	   .dev_id = 0x6208,      // not sure
77	   .ao_chans = 16
78	   // , .ao_bits = 16
79	   }, */
80	{
81	 .name = "pci6208a",
82	 .dev_id = 0x6208,
83	 .ao_chans = 8
84	 /* ,    .ao_bits = 16 */
85	 }
86};
87
88/* This is used by modprobe to translate PCI IDs to drivers.  Should
89 * only be used for PCI and ISA-PnP devices */
90static DEFINE_PCI_DEVICE_TABLE(pci6208_pci_table) = {
91	/* { PCI_VENDOR_ID_ADLINK, 0x6208, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0 }, */
92	/* { PCI_VENDOR_ID_ADLINK, 0x6208, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0 }, */
93	{
94	PCI_VENDOR_ID_ADLINK, 0x6208, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0}, {
95	0}
96};
97
98MODULE_DEVICE_TABLE(pci, pci6208_pci_table);
99
100/* Will be initialized in pci6208_find device(). */
101#define thisboard ((const struct pci6208_board *)dev->board_ptr)
102
103struct pci6208_private {
104	int data;
105	struct pci_dev *pci_dev;	/* for a PCI device */
106	unsigned int ao_readback[2];	/* Used for AO readback */
107};
108
109#define devpriv ((struct pci6208_private *)dev->private)
110
111static int pci6208_attach(struct comedi_device *dev,
112			  struct comedi_devconfig *it);
113static int pci6208_detach(struct comedi_device *dev);
114
115static struct comedi_driver driver_pci6208 = {
116	.driver_name = PCI6208_DRIVER_NAME,
117	.module = THIS_MODULE,
118	.attach = pci6208_attach,
119	.detach = pci6208_detach,
120};
121
122COMEDI_PCI_INITCLEANUP(driver_pci6208, pci6208_pci_table);
123
124static int pci6208_find_device(struct comedi_device *dev, int bus, int slot);
125static int
126pci6208_pci_setup(struct pci_dev *pci_dev, unsigned long *io_base_ptr,
127		  int dev_minor);
128
129/*read/write functions*/
130static int pci6208_ao_winsn(struct comedi_device *dev,
131			    struct comedi_subdevice *s,
132			    struct comedi_insn *insn, unsigned int *data);
133static int pci6208_ao_rinsn(struct comedi_device *dev,
134			    struct comedi_subdevice *s,
135			    struct comedi_insn *insn, unsigned int *data);
136/* static int pci6208_dio_insn_bits(struct comedi_device *dev,struct comedi_subdevice *s, */
137/* struct comedi_insn *insn,unsigned int *data); */
138/* static int pci6208_dio_insn_config(struct comedi_device *dev,struct comedi_subdevice *s, */
139/* struct comedi_insn *insn,unsigned int *data); */
140
141/*
142 * Attach is called by the Comedi core to configure the driver
143 * for a particular board.  If you specified a board_name array
144 * in the driver structure, dev->board_ptr contains that
145 * address.
146 */
147static int pci6208_attach(struct comedi_device *dev,
148			  struct comedi_devconfig *it)
149{
150	struct comedi_subdevice *s;
151	int retval;
152	unsigned long io_base;
153
154	printk("comedi%d: pci6208: ", dev->minor);
155
156	retval = alloc_private(dev, sizeof(struct pci6208_private));
157	if (retval < 0)
158		return retval;
159
160	retval = pci6208_find_device(dev, it->options[0], it->options[1]);
161	if (retval < 0)
162		return retval;
163
164	retval = pci6208_pci_setup(devpriv->pci_dev, &io_base, dev->minor);
165	if (retval < 0)
166		return retval;
167
168	dev->iobase = io_base;
169	dev->board_name = thisboard->name;
170
171/*
172 * Allocate the subdevice structures.  alloc_subdevice() is a
173 * convenient macro defined in comedidev.h.
174 */
175	if (alloc_subdevices(dev, 2) < 0)
176		return -ENOMEM;
177
178	s = dev->subdevices + 0;
179	/* analog output subdevice */
180	s->type = COMEDI_SUBD_AO;
181	s->subdev_flags = SDF_WRITABLE;	/* anything else to add here?? */
182	s->n_chan = thisboard->ao_chans;
183	s->maxdata = 0xffff;	/* 16-bit DAC */
184	s->range_table = &range_bipolar10;	/* this needs to be checked. */
185	s->insn_write = pci6208_ao_winsn;
186	s->insn_read = pci6208_ao_rinsn;
187
188	/* s=dev->subdevices+1; */
189	/* digital i/o subdevice */
190	/* s->type=COMEDI_SUBD_DIO; */
191	/* s->subdev_flags=SDF_READABLE|SDF_WRITABLE; */
192	/* s->n_chan=16; */
193	/* s->maxdata=1; */
194	/* s->range_table=&range_digital; */
195	/* s->insn_bits = pci6208_dio_insn_bits; */
196	/* s->insn_config = pci6208_dio_insn_config; */
197
198	printk("attached\n");
199
200	return 1;
201}
202
203/*
204 * _detach is called to deconfigure a device.  It should deallocate
205 * resources.
206 * This function is also called when _attach() fails, so it should be
207 * careful not to release resources that were not necessarily
208 * allocated by _attach().  dev->private and dev->subdevices are
209 * deallocated automatically by the core.
210 */
211static int pci6208_detach(struct comedi_device *dev)
212{
213	printk("comedi%d: pci6208: remove\n", dev->minor);
214
215	if (devpriv && devpriv->pci_dev) {
216		if (dev->iobase) {
217			comedi_pci_disable(devpriv->pci_dev);
218		}
219		pci_dev_put(devpriv->pci_dev);
220	}
221
222	return 0;
223}
224
225static int pci6208_ao_winsn(struct comedi_device *dev,
226			    struct comedi_subdevice *s,
227			    struct comedi_insn *insn, unsigned int *data)
228{
229	int i = 0, Data_Read;
230	unsigned short chan = CR_CHAN(insn->chanspec);
231	unsigned long invert = 1 << (16 - 1);
232	unsigned long out_value;
233	/* Writing a list of values to an AO channel is probably not
234	 * very useful, but that's how the interface is defined. */
235	for (i = 0; i < insn->n; i++) {
236		out_value = data[i] ^ invert;
237		/* a typical programming sequence */
238		do {
239			Data_Read = (inw(dev->iobase) & 1);
240		} while (Data_Read);
241		outw(out_value, dev->iobase + (0x02 * chan));
242		devpriv->ao_readback[chan] = out_value;
243	}
244
245	/* return the number of samples read/written */
246	return i;
247}
248
249/* AO subdevices should have a read insn as well as a write insn.
250 * Usually this means copying a value stored in devpriv. */
251static int pci6208_ao_rinsn(struct comedi_device *dev,
252			    struct comedi_subdevice *s,
253			    struct comedi_insn *insn, unsigned int *data)
254{
255	int i;
256	int chan = CR_CHAN(insn->chanspec);
257
258	for (i = 0; i < insn->n; i++)
259		data[i] = devpriv->ao_readback[chan];
260
261	return i;
262}
263
264/* DIO devices are slightly special.  Although it is possible to
265 * implement the insn_read/insn_write interface, it is much more
266 * useful to applications if you implement the insn_bits interface.
267 * This allows packed reading/writing of the DIO channels.  The
268 * comedi core can convert between insn_bits and insn_read/write */
269/* static int pci6208_dio_insn_bits(struct comedi_device *dev,struct comedi_subdevice *s, */
270/* struct comedi_insn *insn,unsigned int *data) */
271/* { */
272/* if(insn->n!=2)return -EINVAL; */
273
274	/* The insn data is a mask in data[0] and the new data
275	 * in data[1], each channel cooresponding to a bit. */
276/* if(data[0]){ */
277/* s->state &= ~data[0]; */
278/* s->state |= data[0]&data[1]; */
279		/* Write out the new digital output lines */
280		/* outw(s->state,dev->iobase + SKEL_DIO); */
281/* } */
282
283	/* on return, data[1] contains the value of the digital
284	 * input and output lines. */
285	/* data[1]=inw(dev->iobase + SKEL_DIO); */
286	/* or we could just return the software copy of the output values if
287	 * it was a purely digital output subdevice */
288	/* data[1]=s->state; */
289
290/* return 2; */
291/* } */
292
293/* static int pci6208_dio_insn_config(struct comedi_device *dev,struct comedi_subdevice *s, */
294/* struct comedi_insn *insn,unsigned int *data) */
295/* { */
296/* int chan=CR_CHAN(insn->chanspec); */
297
298	/* The input or output configuration of each digital line is
299	 * configured by a special insn_config instruction.  chanspec
300	 * contains the channel to be changed, and data[0] contains the
301	 * value COMEDI_INPUT or COMEDI_OUTPUT. */
302
303/* if(data[0]==COMEDI_OUTPUT){ */
304/* s->io_bits |= 1<<chan; */
305/* }else{ */
306/* s->io_bits &= ~(1<<chan); */
307/* } */
308	/* outw(s->io_bits,dev->iobase + SKEL_DIO_CONFIG); */
309
310/* return 1; */
311/* } */
312
313static int pci6208_find_device(struct comedi_device *dev, int bus, int slot)
314{
315	struct pci_dev *pci_dev;
316	int i;
317
318	for (pci_dev = pci_get_device(PCI_ANY_ID, PCI_ANY_ID, NULL);
319	     pci_dev != NULL;
320	     pci_dev = pci_get_device(PCI_ANY_ID, PCI_ANY_ID, pci_dev)) {
321		if (pci_dev->vendor == PCI_VENDOR_ID_ADLINK) {
322			for (i = 0; i < ARRAY_SIZE(pci6208_boards); i++) {
323				if (pci6208_boards[i].dev_id == pci_dev->device) {
324					/*  was a particular bus/slot requested? */
325					if ((bus != 0) || (slot != 0)) {
326						/*  are we on the wrong bus/slot? */
327						if (pci_dev->bus->number
328						    != bus ||
329						    PCI_SLOT(pci_dev->devfn)
330						    != slot) {
331							continue;
332						}
333					}
334					dev->board_ptr = pci6208_boards + i;
335					goto found;
336				}
337			}
338		}
339	}
340
341	printk("comedi%d: no supported board found! (req. bus/slot : %d/%d)\n",
342	       dev->minor, bus, slot);
343	return -EIO;
344
345found:
346	printk("comedi%d: found %s (b:s:f=%d:%d:%d) , irq=%d\n",
347	       dev->minor,
348	       pci6208_boards[i].name,
349	       pci_dev->bus->number,
350	       PCI_SLOT(pci_dev->devfn),
351	       PCI_FUNC(pci_dev->devfn), pci_dev->irq);
352
353	/*  TODO: Warn about non-tested boards. */
354	/* switch(board->device_id) */
355	/* { */
356	/* }; */
357
358	devpriv->pci_dev = pci_dev;
359
360	return 0;
361}
362
363static int
364pci6208_pci_setup(struct pci_dev *pci_dev, unsigned long *io_base_ptr,
365		  int dev_minor)
366{
367	unsigned long io_base, io_range, lcr_io_base, lcr_io_range;
368
369	/*  Enable PCI device and request regions */
370	if (comedi_pci_enable(pci_dev, PCI6208_DRIVER_NAME) < 0) {
371		printk
372		    ("comedi%d: Failed to enable PCI device and request regions\n",
373		     dev_minor);
374		return -EIO;
375	}
376	/*  Read local configuration register base address [PCI_BASE_ADDRESS #1]. */
377	lcr_io_base = pci_resource_start(pci_dev, 1);
378	lcr_io_range = pci_resource_len(pci_dev, 1);
379
380	printk("comedi%d: local config registers at address 0x%4lx [0x%4lx]\n",
381	       dev_minor, lcr_io_base, lcr_io_range);
382
383	/*  Read PCI6208 register base address [PCI_BASE_ADDRESS #2]. */
384	io_base = pci_resource_start(pci_dev, 2);
385	io_range = pci_resource_end(pci_dev, 2) - io_base + 1;
386
387	printk("comedi%d: 6208 registers at address 0x%4lx [0x%4lx]\n",
388	       dev_minor, io_base, io_range);
389
390	*io_base_ptr = io_base;
391	/* devpriv->io_range = io_range; */
392	/* devpriv->is_valid=0; */
393	/* devpriv->lcr_io_base=lcr_io_base; */
394	/* devpriv->lcr_io_range=lcr_io_range; */
395
396	return 0;
397}
398