2 comedi/drivers/cb_pcidio.c
3 A Comedi driver for PCI-DIO24H & PCI-DIO48H of ComputerBoards (currently MeasurementComputing)
5 COMEDI - Linux Control and Measurement Device Interface
6 Copyright (C) 2000 David A. Schleef <ds@schleef.org>
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.
25 Description: ComputerBoards' DIO boards with PCI interface
26 Devices: [Measurement Computing] PCI-DIO24 (cb_pcidio), PCI-DIO24H, PCI-DIO48H
27 Author: Yoshiya Matsuzaka
28 Updated: Mon, 29 Oct 2007 15:40:47 +0000
31 This driver has been modified from skel.c of comedi-0.7.70.
33 Configuration Options:
34 [0] - PCI bus of device (optional)
35 [1] - PCI slot of device (optional)
36 If bus/slot is not specified, the first available PCI device will
39 Passing a zero for an option is the same as leaving it unspecified.
42 /*------------------------------ HEADER FILES ---------------------------------*/
43 #include "../comedidev.h"
44 #include "comedi_pci.h"
47 /*-------------------------- MACROS and DATATYPES -----------------------------*/
48 #define PCI_VENDOR_ID_CB 0x1307
51 * Board descriptions for two imaginary boards. Describing the
52 * boards in this way is optional, and completely driver-dependent.
53 * Some drivers use arrays such as this, other do not.
55 typedef struct pcidio_board_struct {
56 const char *name; // anme of the board
57 int n_8255; // number of 8255 chips on board
59 // indices of base address regions
60 int pcicontroler_badrindex;
61 int dioregs_badrindex;
64 static const pcidio_board pcidio_boards[] = {
68 pcicontroler_badrindex:1,
74 pcicontroler_badrindex:1,
80 pcicontroler_badrindex:0,
85 /* This is used by modprobe to translate PCI IDs to drivers. Should
86 * only be used for PCI and ISA-PnP devices */
87 /* Please add your PCI vendor ID to comedidev.h, and it will be forwarded
89 static DEFINE_PCI_DEVICE_TABLE(pcidio_pci_table) = {
90 {PCI_VENDOR_ID_CB, 0x0028, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0},
91 {PCI_VENDOR_ID_CB, 0x0014, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0},
92 {PCI_VENDOR_ID_CB, 0x000b, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0},
96 MODULE_DEVICE_TABLE(pci, pcidio_pci_table);
99 * Useful for shorthand access to the particular board structure
101 #define thisboard ((const pcidio_board *)dev->board_ptr)
103 /* this structure is for data unique to this hardware driver. If
104 several hardware drivers keep similar information in this structure,
105 feel free to suggest moving the variable to the struct comedi_device struct. */
107 int data; // curently unused
109 /* would be useful for a PCI device */
110 struct pci_dev *pci_dev;
112 /* used for DO readback, curently unused */
113 unsigned int do_readback[4]; /* up to 4 unsigned int suffice to hold 96 bits for PCI-DIO96 */
115 unsigned long dio_reg_base; // address of port A of the first 8255 chip on board
119 * most drivers define the following macro to make it easy to
120 * access the private structure.
122 #define devpriv ((pcidio_private *)dev->private)
125 * The struct comedi_driver structure tells the Comedi core module
126 * which functions to call to configure/deconfigure (attach/detach)
127 * the board, and also about the kernel module that contains
130 static int pcidio_attach(struct comedi_device * dev, struct comedi_devconfig * it);
131 static int pcidio_detach(struct comedi_device * dev);
132 static struct comedi_driver driver_cb_pcidio = {
133 driver_name:"cb_pcidio",
135 attach:pcidio_attach,
136 detach:pcidio_detach,
137 /* It is not necessary to implement the following members if you are
138 * writing a driver for a ISA PnP or PCI card */
139 /* Most drivers will support multiple types of boards by
140 * having an array of board structures. These were defined
141 * in pcidio_boards[] above. Note that the element 'name'
142 * was first in the structure -- Comedi uses this fact to
143 * extract the name of the board without knowing any details
144 * about the structure except for its length.
145 * When a device is attached (by comedi_config), the name
146 * of the device is given to Comedi, and Comedi tries to
147 * match it by going through the list of board names. If
148 * there is a match, the address of the pointer is put
149 * into dev->board_ptr and driver->attach() is called.
151 * Note that these are not necessary if you can determine
152 * the type of board in software. ISA PnP, PCI, and PCMCIA
153 * devices are such boards.
155 // The following fields should NOT be initialized if you are dealing with PCI devices
156 // board_name: pcidio_boards,
157 // offset: sizeof(pcidio_board),
158 // num_names: sizeof(pcidio_boards) / sizeof(pcidio_board),
161 /*------------------------------- FUNCTIONS -----------------------------------*/
164 * Attach is called by the Comedi core to configure the driver
165 * for a particular board. If you specified a board_name array
166 * in the driver structure, dev->board_ptr contains that
169 static int pcidio_attach(struct comedi_device * dev, struct comedi_devconfig * it)
171 struct pci_dev *pcidev = NULL;
175 printk("comedi%d: cb_pcidio: \n", dev->minor);
178 * Allocate the private structure area. alloc_private() is a
179 * convenient macro defined in comedidev.h.
181 if (alloc_private(dev, sizeof(pcidio_private)) < 0)
184 * If you can probe the device to determine what device in a series
185 * it is, this is the place to do it. Otherwise, dev->board_ptr
186 * should already be initialized.
189 * Probe the device to determine what device in the series it is.
192 for (pcidev = pci_get_device(PCI_ANY_ID, PCI_ANY_ID, NULL);
194 pcidev = pci_get_device(PCI_ANY_ID, PCI_ANY_ID, pcidev)) {
195 // is it not a computer boards card?
196 if (pcidev->vendor != PCI_VENDOR_ID_CB)
198 // loop through cards supported by this driver
200 index < sizeof pcidio_boards / sizeof(pcidio_board);
202 if (pcidio_pci_table[index].device != pcidev->device)
205 // was a particular bus/slot requested?
206 if (it->options[0] || it->options[1]) {
207 // are we on the wrong bus/slot?
208 if (pcidev->bus->number != it->options[0] ||
209 PCI_SLOT(pcidev->devfn) !=
214 dev->board_ptr = pcidio_boards + index;
219 printk("No supported ComputerBoards/MeasurementComputing card found on "
220 "requested position\n");
226 * Initialize dev->board_name. Note that we can use the "thisboard"
227 * macro now, since we just initialized it in the last line.
229 dev->board_name = thisboard->name;
231 devpriv->pci_dev = pcidev;
232 printk("Found %s on bus %i, slot %i\n", thisboard->name,
233 devpriv->pci_dev->bus->number,
234 PCI_SLOT(devpriv->pci_dev->devfn));
235 if (comedi_pci_enable(pcidev, thisboard->name)) {
236 printk("cb_pcidio: failed to enable PCI device and request regions\n");
239 devpriv->dio_reg_base
241 pci_resource_start(devpriv->pci_dev,
242 pcidio_boards[index].dioregs_badrindex);
245 * Allocate the subdevice structures. alloc_subdevice() is a
246 * convenient macro defined in comedidev.h.
248 if (alloc_subdevices(dev, thisboard->n_8255) < 0)
251 for (i = 0; i < thisboard->n_8255; i++) {
252 subdev_8255_init(dev, dev->subdevices + i,
253 NULL, devpriv->dio_reg_base + i * 4);
254 printk(" subdev %d: base = 0x%lx\n", i,
255 devpriv->dio_reg_base + i * 4);
258 printk("attached\n");
263 * _detach is called to deconfigure a device. It should deallocate
265 * This function is also called when _attach() fails, so it should be
266 * careful not to release resources that were not necessarily
267 * allocated by _attach(). dev->private and dev->subdevices are
268 * deallocated automatically by the core.
270 static int pcidio_detach(struct comedi_device * dev)
272 printk("comedi%d: cb_pcidio: remove\n", dev->minor);
274 if (devpriv->pci_dev) {
275 if (devpriv->dio_reg_base) {
276 comedi_pci_disable(devpriv->pci_dev);
278 pci_dev_put(devpriv->pci_dev);
281 if (dev->subdevices) {
283 for (i = 0; i < thisboard->n_8255; i++) {
284 subdev_8255_cleanup(dev, dev->subdevices + i);
291 * A convenient macro that defines init_module() and cleanup_module(),
294 COMEDI_PCI_INITCLEANUP(driver_cb_pcidio, pcidio_pci_table);