xref: /linux/drivers/comedi/drivers/8255_pci.c (revision 0be3ff0c)
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * COMEDI driver for generic PCI based 8255 digital i/o boards
4  * Copyright (C) 2012 H Hartley Sweeten <hsweeten@visionengravers.com>
5  *
6  * Based on the tested adl_pci7296 driver written by:
7  *	Jon Grierson <jd@renko.co.uk>
8  * and the experimental cb_pcidio driver written by:
9  *	Yoshiya Matsuzaka
10  *
11  * COMEDI - Linux Control and Measurement Device Interface
12  * Copyright (C) 2000 David A. Schleef <ds@schleef.org>
13  */
14 
15 /*
16  * Driver: 8255_pci
17  * Description: Generic PCI based 8255 Digital I/O boards
18  * Devices: [ADLink] PCI-7224 (adl_pci-7224), PCI-7248 (adl_pci-7248),
19  *   PCI-7296 (adl_pci-7296),
20  *   [Measurement Computing] PCI-DIO24 (cb_pci-dio24),
21  *   PCI-DIO24H (cb_pci-dio24h), PCI-DIO48H (cb_pci-dio48h),
22  *   PCI-DIO96H (cb_pci-dio96h),
23  *   [National Instruments] PCI-DIO-96 (ni_pci-dio-96),
24  *   PCI-DIO-96B (ni_pci-dio-96b), PXI-6508 (ni_pxi-6508),
25  *   PCI-6503 (ni_pci-6503), PCI-6503B (ni_pci-6503b),
26  *   PCI-6503X (ni_pci-6503x), PXI-6503 (ni_pxi-6503)
27  * Author: H Hartley Sweeten <hsweeten@visionengravers.com>
28  * Updated: Wed, 12 Sep 2012 11:52:01 -0700
29  * Status: untested
30  *
31  * These boards have one or more 8255 digital I/O chips, each of which
32  * is supported as a separate 24-channel DIO subdevice.
33  *
34  * Boards with 24 DIO channels (1 DIO subdevice):
35  *
36  *   PCI-7224, PCI-DIO24, PCI-DIO24H, PCI-6503, PCI-6503B, PCI-6503X,
37  *   PXI-6503
38  *
39  * Boards with 48 DIO channels (2 DIO subdevices):
40  *
41  *   PCI-7248, PCI-DIO48H
42  *
43  * Boards with 96 DIO channels (4 DIO subdevices):
44  *
45  *   PCI-7296, PCI-DIO96H, PCI-DIO-96, PCI-DIO-96B, PXI-6508
46  *
47  * Some of these boards also have an 8254 programmable timer/counter
48  * chip.  This chip is not currently supported by this driver.
49  *
50  * Interrupt support for these boards is also not currently supported.
51  *
52  * Configuration Options: not applicable, uses PCI auto config.
53  */
54 
55 #include <linux/module.h>
56 #include <linux/comedi/comedi_pci.h>
57 #include <linux/comedi/comedi_8255.h>
58 
59 enum pci_8255_boardid {
60 	BOARD_ADLINK_PCI7224,
61 	BOARD_ADLINK_PCI7248,
62 	BOARD_ADLINK_PCI7296,
63 	BOARD_CB_PCIDIO24,
64 	BOARD_CB_PCIDIO24H,
65 	BOARD_CB_PCIDIO48H_OLD,
66 	BOARD_CB_PCIDIO48H_NEW,
67 	BOARD_CB_PCIDIO96H,
68 	BOARD_NI_PCIDIO96,
69 	BOARD_NI_PCIDIO96B,
70 	BOARD_NI_PXI6508,
71 	BOARD_NI_PCI6503,
72 	BOARD_NI_PCI6503B,
73 	BOARD_NI_PCI6503X,
74 	BOARD_NI_PXI_6503,
75 };
76 
77 struct pci_8255_boardinfo {
78 	const char *name;
79 	int dio_badr;
80 	int n_8255;
81 	unsigned int has_mite:1;
82 };
83 
84 static const struct pci_8255_boardinfo pci_8255_boards[] = {
85 	[BOARD_ADLINK_PCI7224] = {
86 		.name		= "adl_pci-7224",
87 		.dio_badr	= 2,
88 		.n_8255		= 1,
89 	},
90 	[BOARD_ADLINK_PCI7248] = {
91 		.name		= "adl_pci-7248",
92 		.dio_badr	= 2,
93 		.n_8255		= 2,
94 	},
95 	[BOARD_ADLINK_PCI7296] = {
96 		.name		= "adl_pci-7296",
97 		.dio_badr	= 2,
98 		.n_8255		= 4,
99 	},
100 	[BOARD_CB_PCIDIO24] = {
101 		.name		= "cb_pci-dio24",
102 		.dio_badr	= 2,
103 		.n_8255		= 1,
104 	},
105 	[BOARD_CB_PCIDIO24H] = {
106 		.name		= "cb_pci-dio24h",
107 		.dio_badr	= 2,
108 		.n_8255		= 1,
109 	},
110 	[BOARD_CB_PCIDIO48H_OLD] = {
111 		.name		= "cb_pci-dio48h",
112 		.dio_badr	= 1,
113 		.n_8255		= 2,
114 	},
115 	[BOARD_CB_PCIDIO48H_NEW] = {
116 		.name		= "cb_pci-dio48h",
117 		.dio_badr	= 2,
118 		.n_8255		= 2,
119 	},
120 	[BOARD_CB_PCIDIO96H] = {
121 		.name		= "cb_pci-dio96h",
122 		.dio_badr	= 2,
123 		.n_8255		= 4,
124 	},
125 	[BOARD_NI_PCIDIO96] = {
126 		.name		= "ni_pci-dio-96",
127 		.dio_badr	= 1,
128 		.n_8255		= 4,
129 		.has_mite	= 1,
130 	},
131 	[BOARD_NI_PCIDIO96B] = {
132 		.name		= "ni_pci-dio-96b",
133 		.dio_badr	= 1,
134 		.n_8255		= 4,
135 		.has_mite	= 1,
136 	},
137 	[BOARD_NI_PXI6508] = {
138 		.name		= "ni_pxi-6508",
139 		.dio_badr	= 1,
140 		.n_8255		= 4,
141 		.has_mite	= 1,
142 	},
143 	[BOARD_NI_PCI6503] = {
144 		.name		= "ni_pci-6503",
145 		.dio_badr	= 1,
146 		.n_8255		= 1,
147 		.has_mite	= 1,
148 	},
149 	[BOARD_NI_PCI6503B] = {
150 		.name		= "ni_pci-6503b",
151 		.dio_badr	= 1,
152 		.n_8255		= 1,
153 		.has_mite	= 1,
154 	},
155 	[BOARD_NI_PCI6503X] = {
156 		.name		= "ni_pci-6503x",
157 		.dio_badr	= 1,
158 		.n_8255		= 1,
159 		.has_mite	= 1,
160 	},
161 	[BOARD_NI_PXI_6503] = {
162 		.name		= "ni_pxi-6503",
163 		.dio_badr	= 1,
164 		.n_8255		= 1,
165 		.has_mite	= 1,
166 	},
167 };
168 
169 /* ripped from mite.h and mite_setup2() to avoid mite dependency */
170 #define MITE_IODWBSR	0xc0	/* IO Device Window Base Size Register */
171 #define WENAB		BIT(7)	/* window enable */
172 
173 static int pci_8255_mite_init(struct pci_dev *pcidev)
174 {
175 	void __iomem *mite_base;
176 	u32 main_phys_addr;
177 
178 	/* ioremap the MITE registers (BAR 0) temporarily */
179 	mite_base = pci_ioremap_bar(pcidev, 0);
180 	if (!mite_base)
181 		return -ENOMEM;
182 
183 	/* set data window to main registers (BAR 1) */
184 	main_phys_addr = pci_resource_start(pcidev, 1);
185 	writel(main_phys_addr | WENAB, mite_base + MITE_IODWBSR);
186 
187 	/* finished with MITE registers */
188 	iounmap(mite_base);
189 	return 0;
190 }
191 
192 static int pci_8255_auto_attach(struct comedi_device *dev,
193 				unsigned long context)
194 {
195 	struct pci_dev *pcidev = comedi_to_pci_dev(dev);
196 	const struct pci_8255_boardinfo *board = NULL;
197 	struct comedi_subdevice *s;
198 	int ret;
199 	int i;
200 
201 	if (context < ARRAY_SIZE(pci_8255_boards))
202 		board = &pci_8255_boards[context];
203 	if (!board)
204 		return -ENODEV;
205 	dev->board_ptr = board;
206 	dev->board_name = board->name;
207 
208 	ret = comedi_pci_enable(dev);
209 	if (ret)
210 		return ret;
211 
212 	if (board->has_mite) {
213 		ret = pci_8255_mite_init(pcidev);
214 		if (ret)
215 			return ret;
216 	}
217 
218 	if ((pci_resource_flags(pcidev, board->dio_badr) & IORESOURCE_MEM)) {
219 		dev->mmio = pci_ioremap_bar(pcidev, board->dio_badr);
220 		if (!dev->mmio)
221 			return -ENOMEM;
222 	} else {
223 		dev->iobase = pci_resource_start(pcidev, board->dio_badr);
224 	}
225 
226 	/*
227 	 * One, two, or four subdevices are setup by this driver depending
228 	 * on the number of channels provided by the board. Each subdevice
229 	 * has 24 channels supported by the 8255 module.
230 	 */
231 	ret = comedi_alloc_subdevices(dev, board->n_8255);
232 	if (ret)
233 		return ret;
234 
235 	for (i = 0; i < board->n_8255; i++) {
236 		s = &dev->subdevices[i];
237 		if (dev->mmio)
238 			ret = subdev_8255_mm_init(dev, s, NULL, i * I8255_SIZE);
239 		else
240 			ret = subdev_8255_init(dev, s, NULL, i * I8255_SIZE);
241 		if (ret)
242 			return ret;
243 	}
244 
245 	return 0;
246 }
247 
248 static struct comedi_driver pci_8255_driver = {
249 	.driver_name	= "8255_pci",
250 	.module		= THIS_MODULE,
251 	.auto_attach	= pci_8255_auto_attach,
252 	.detach		= comedi_pci_detach,
253 };
254 
255 static int pci_8255_pci_probe(struct pci_dev *dev,
256 			      const struct pci_device_id *id)
257 {
258 	return comedi_pci_auto_config(dev, &pci_8255_driver, id->driver_data);
259 }
260 
261 static const struct pci_device_id pci_8255_pci_table[] = {
262 	{ PCI_VDEVICE(ADLINK, 0x7224), BOARD_ADLINK_PCI7224 },
263 	{ PCI_VDEVICE(ADLINK, 0x7248), BOARD_ADLINK_PCI7248 },
264 	{ PCI_VDEVICE(ADLINK, 0x7296), BOARD_ADLINK_PCI7296 },
265 	{ PCI_VDEVICE(CB, 0x0028), BOARD_CB_PCIDIO24 },
266 	{ PCI_VDEVICE(CB, 0x0014), BOARD_CB_PCIDIO24H },
267 	{ PCI_DEVICE_SUB(PCI_VENDOR_ID_CB, 0x000b, 0x0000, 0x0000),
268 	  .driver_data = BOARD_CB_PCIDIO48H_OLD },
269 	{ PCI_DEVICE_SUB(PCI_VENDOR_ID_CB, 0x000b, PCI_VENDOR_ID_CB, 0x000b),
270 	  .driver_data = BOARD_CB_PCIDIO48H_NEW },
271 	{ PCI_VDEVICE(CB, 0x0017), BOARD_CB_PCIDIO96H },
272 	{ PCI_VDEVICE(NI, 0x0160), BOARD_NI_PCIDIO96 },
273 	{ PCI_VDEVICE(NI, 0x1630), BOARD_NI_PCIDIO96B },
274 	{ PCI_VDEVICE(NI, 0x13c0), BOARD_NI_PXI6508 },
275 	{ PCI_VDEVICE(NI, 0x0400), BOARD_NI_PCI6503 },
276 	{ PCI_VDEVICE(NI, 0x1250), BOARD_NI_PCI6503B },
277 	{ PCI_VDEVICE(NI, 0x17d0), BOARD_NI_PCI6503X },
278 	{ PCI_VDEVICE(NI, 0x1800), BOARD_NI_PXI_6503 },
279 	{ 0 }
280 };
281 MODULE_DEVICE_TABLE(pci, pci_8255_pci_table);
282 
283 static struct pci_driver pci_8255_pci_driver = {
284 	.name		= "8255_pci",
285 	.id_table	= pci_8255_pci_table,
286 	.probe		= pci_8255_pci_probe,
287 	.remove		= comedi_pci_auto_unconfig,
288 };
289 module_comedi_pci_driver(pci_8255_driver, pci_8255_pci_driver);
290 
291 MODULE_DESCRIPTION("COMEDI - Generic PCI based 8255 Digital I/O boards");
292 MODULE_AUTHOR("Comedi https://www.comedi.org");
293 MODULE_LICENSE("GPL");
294