2 comedi/drivers/amplc_pc263.c
3 Driver for Amplicon PC263 and PCI263 relay boards.
5 Copyright (C) 2002 MEV Ltd. <http://www.mev.co.uk/>
7 COMEDI - Linux Control and Measurement Device Interface
8 Copyright (C) 2000 David A. Schleef <ds@schleef.org>
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 2 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
22 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
27 Description: Amplicon PC263, PCI263
28 Author: Ian Abbott <abbotti@mev.co.uk>
29 Devices: [Amplicon] PC263 (pc263), PCI263 (pci263 or amplc_pc263)
30 Updated: Wed, 22 Oct 2008 14:10:53 +0100
33 Configuration options - PC263:
34 [0] - I/O port base address
36 Configuration options - PCI263:
37 [0] - PCI bus of device (optional)
38 [1] - PCI slot of device (optional)
39 If bus/slot is not specified, the first available PCI device will be
42 Each board appears as one subdevice, with 16 digital outputs, each
43 connected to a reed-relay. Relay contacts are closed when output is 1.
44 The state of the outputs can be read.
47 #include "../comedidev.h"
49 #define PC263_DRIVER_NAME "amplc_pc263"
51 #define DO_ISA IS_ENABLED(CONFIG_COMEDI_AMPLC_PC263_ISA)
52 #define DO_PCI IS_ENABLED(CONFIG_COMEDI_AMPLC_PC263_PCI)
54 /* PCI263 PCI configuration register information */
55 #define PCI_VENDOR_ID_AMPLICON 0x14dc
56 #define PCI_DEVICE_ID_AMPLICON_PCI263 0x000c
57 #define PCI_DEVICE_ID_INVALID 0xffff
59 /* PC263 / PCI263 registers */
60 #define PC263_IO_SIZE 2
63 * Board descriptions for Amplicon PC263 / PCI263.
66 enum pc263_bustype { isa_bustype, pci_bustype };
67 enum pc263_model { pc263_model, pci263_model, anypci_model };
72 enum pc263_bustype bustype;
73 enum pc263_model model;
75 static const struct pc263_board pc263_boards[] = {
79 .bustype = isa_bustype,
86 .devid = PCI_DEVICE_ID_AMPLICON_PCI263,
87 .bustype = pci_bustype,
88 .model = pci263_model,
91 .name = PC263_DRIVER_NAME,
92 .devid = PCI_DEVICE_ID_INVALID,
93 .bustype = pci_bustype,
94 .model = anypci_model, /* wildcard */
99 /* test if ISA supported and this is an ISA board */
100 static inline bool is_isa_board(const struct pc263_board *board)
102 return DO_ISA && board->bustype == isa_bustype;
105 /* test if PCI supported and this is a PCI board */
106 static inline bool is_pci_board(const struct pc263_board *board)
108 return DO_PCI && board->bustype == pci_bustype;
112 * This function looks for a board matching the supplied PCI device.
114 static const struct pc263_board *pc263_find_pci_board(struct pci_dev *pci_dev)
118 for (i = 0; i < ARRAY_SIZE(pc263_boards); i++)
119 if (is_pci_board(&pc263_boards[i]) &&
120 pci_dev->device == pc263_boards[i].devid)
121 return &pc263_boards[i];
127 * This function looks for a PCI device matching the requested board name,
130 static struct pci_dev *pc263_find_pci_dev(struct comedi_device *dev,
131 struct comedi_devconfig *it)
133 const struct pc263_board *thisboard = comedi_board(dev);
134 struct pci_dev *pci_dev = NULL;
135 int bus = it->options[0];
136 int slot = it->options[1];
138 for_each_pci_dev(pci_dev) {
140 if (bus != pci_dev->bus->number ||
141 slot != PCI_SLOT(pci_dev->devfn))
144 if (pci_dev->vendor != PCI_VENDOR_ID_AMPLICON)
147 if (thisboard->model == anypci_model) {
148 /* Wildcard board matches any supported PCI board. */
149 const struct pc263_board *foundboard;
151 foundboard = pc263_find_pci_board(pci_dev);
152 if (foundboard == NULL)
154 /* Replace wildcard board_ptr. */
155 dev->board_ptr = thisboard = foundboard;
157 /* Match specific model name. */
158 if (pci_dev->device != thisboard->devid)
163 dev_err(dev->class_dev,
164 "No supported board found! (req. bus %d, slot %d)\n",
169 * This function checks and requests an I/O region, reporting an error
170 * if there is a conflict.
172 static int pc263_request_region(struct comedi_device *dev, unsigned long from,
173 unsigned long extent)
175 if (!from || !request_region(from, extent, PC263_DRIVER_NAME)) {
176 dev_err(dev->class_dev, "I/O port conflict (%#lx,%lu)!\n",
183 static int pc263_do_insn_bits(struct comedi_device *dev,
184 struct comedi_subdevice *s,
185 struct comedi_insn *insn, unsigned int *data)
187 /* The insn data is a mask in data[0] and the new data
188 * in data[1], each channel cooresponding to a bit. */
190 s->state &= ~data[0];
191 s->state |= data[0] & data[1];
192 /* Write out the new digital output lines */
193 outb(s->state & 0xFF, dev->iobase);
194 outb(s->state >> 8, dev->iobase + 1);
199 static void pc263_report_attach(struct comedi_device *dev)
201 const struct pc263_board *thisboard = comedi_board(dev);
202 struct pci_dev *pcidev = comedi_to_pci_dev(dev);
205 if (is_isa_board(thisboard))
206 snprintf(tmpbuf, sizeof(tmpbuf), "(base %#lx) ", dev->iobase);
207 else if (is_pci_board(thisboard))
208 snprintf(tmpbuf, sizeof(tmpbuf), "(pci %s) ",
212 dev_info(dev->class_dev, "%s %sattached\n", dev->board_name, tmpbuf);
215 static int pc263_common_attach(struct comedi_device *dev, unsigned long iobase)
217 const struct pc263_board *thisboard = comedi_board(dev);
218 struct comedi_subdevice *s;
221 dev->board_name = thisboard->name;
222 dev->iobase = iobase;
224 ret = comedi_alloc_subdevices(dev, 1);
228 s = &dev->subdevices[0];
229 /* digital output subdevice */
230 s->type = COMEDI_SUBD_DO;
231 s->subdev_flags = SDF_READABLE | SDF_WRITABLE;
234 s->range_table = &range_digital;
235 s->insn_bits = pc263_do_insn_bits;
236 /* read initial relay state */
237 s->state = inb(dev->iobase) | (inb(dev->iobase + 1) << 8);
239 pc263_report_attach(dev);
243 static int pc263_pci_common_attach(struct comedi_device *dev,
244 struct pci_dev *pci_dev)
246 unsigned long iobase;
249 comedi_set_hw_dev(dev, &pci_dev->dev);
251 ret = comedi_pci_enable(pci_dev, PC263_DRIVER_NAME);
253 dev_err(dev->class_dev,
254 "error! cannot enable PCI device and request regions!\n");
257 iobase = pci_resource_start(pci_dev, 2);
258 return pc263_common_attach(dev, iobase);
262 * Attach is called by the Comedi core to configure the driver
263 * for a particular board. If you specified a board_name array
264 * in the driver structure, dev->board_ptr contains that
267 static int pc263_attach(struct comedi_device *dev, struct comedi_devconfig *it)
269 const struct pc263_board *thisboard = comedi_board(dev);
272 dev_info(dev->class_dev, PC263_DRIVER_NAME ": attach\n");
274 /* Process options and reserve resources according to bus type. */
275 if (is_isa_board(thisboard)) {
276 unsigned long iobase = it->options[0];
277 ret = pc263_request_region(dev, iobase, PC263_IO_SIZE);
280 return pc263_common_attach(dev, iobase);
281 } else if (is_pci_board(thisboard)) {
282 struct pci_dev *pci_dev;
284 pci_dev = pc263_find_pci_dev(dev, it);
287 return pc263_pci_common_attach(dev, pci_dev);
289 dev_err(dev->class_dev, PC263_DRIVER_NAME
290 ": BUG! cannot determine board type!\n");
295 * The attach_pci hook (if non-NULL) is called at PCI probe time in preference
296 * to the "manual" attach hook. dev->board_ptr is NULL on entry. There should
297 * be a board entry matching the supplied PCI device.
299 static int __devinit pc263_attach_pci(struct comedi_device *dev,
300 struct pci_dev *pci_dev)
305 dev_info(dev->class_dev, PC263_DRIVER_NAME ": attach pci %s\n",
307 dev->board_ptr = pc263_find_pci_board(pci_dev);
308 if (dev->board_ptr == NULL) {
309 dev_err(dev->class_dev, "BUG! cannot determine board type!\n");
313 * Need to 'get' the PCI device to match the 'put' in pc263_detach().
314 * TODO: Remove the pci_dev_get() and matching pci_dev_put() once
315 * support for manual attachment of PCI devices via pc263_attach()
318 pci_dev_get(pci_dev);
319 return pc263_pci_common_attach(dev, pci_dev);
322 static void pc263_detach(struct comedi_device *dev)
324 const struct pc263_board *thisboard = comedi_board(dev);
326 if (is_isa_board(thisboard)) {
328 release_region(dev->iobase, PC263_IO_SIZE);
329 } else if (is_pci_board(thisboard)) {
330 struct pci_dev *pcidev = comedi_to_pci_dev(dev);
333 comedi_pci_disable(pcidev);
340 * The struct comedi_driver structure tells the Comedi core module
341 * which functions to call to configure/deconfigure (attach/detach)
342 * the board, and also about the kernel module that contains
345 static struct comedi_driver amplc_pc263_driver = {
346 .driver_name = PC263_DRIVER_NAME,
347 .module = THIS_MODULE,
348 .attach = pc263_attach,
349 .attach_pci = pc263_attach_pci,
350 .detach = pc263_detach,
351 .board_name = &pc263_boards[0].name,
352 .offset = sizeof(struct pc263_board),
353 .num_names = ARRAY_SIZE(pc263_boards),
357 static DEFINE_PCI_DEVICE_TABLE(pc263_pci_table) = {
358 { PCI_DEVICE(PCI_VENDOR_ID_AMPLICON, PCI_DEVICE_ID_AMPLICON_PCI263) },
361 MODULE_DEVICE_TABLE(pci, pc263_pci_table);
363 static int __devinit amplc_pc263_pci_probe(struct pci_dev *dev,
364 const struct pci_device_id
367 return comedi_pci_auto_config(dev, &lc_pc263_driver);
370 static void __devexit amplc_pc263_pci_remove(struct pci_dev *dev)
372 comedi_pci_auto_unconfig(dev);
375 static struct pci_driver amplc_pc263_pci_driver = {
376 .name = PC263_DRIVER_NAME,
377 .id_table = pc263_pci_table,
378 .probe = &lc_pc263_pci_probe,
379 .remove = __devexit_p(&lc_pc263_pci_remove)
381 module_comedi_pci_driver(amplc_pc263_driver, amplc_pc263_pci_driver);
383 module_comedi_driver(amplc_pc263_driver);
386 MODULE_AUTHOR("Comedi http://www.comedi.org");
387 MODULE_DESCRIPTION("Comedi low-level driver");
388 MODULE_LICENSE("GPL");