xref: /linux/drivers/parport/parport_serial.c (revision de2fe5e07d58424bc286fff3fd3c1b0bf933cd58)
1 /*
2  * Support for common PCI multi-I/O cards (which is most of them)
3  *
4  * Copyright (C) 2001  Tim Waugh <twaugh@redhat.com>
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version
9  * 2 of the License, or (at your option) any later version.
10  *
11  *
12  * Multi-function PCI cards are supposed to present separate logical
13  * devices on the bus.  A common thing to do seems to be to just use
14  * one logical device with lots of base address registers for both
15  * parallel ports and serial ports.  This driver is for dealing with
16  * that.
17  *
18  */
19 
20 #include <linux/types.h>
21 #include <linux/module.h>
22 #include <linux/init.h>
23 #include <linux/pci.h>
24 #include <linux/parport.h>
25 #include <linux/parport_pc.h>
26 #include <linux/8250_pci.h>
27 
28 enum parport_pc_pci_cards {
29 	titan_110l = 0,
30 	titan_210l,
31 	netmos_9xx5_combo,
32 	netmos_9855,
33 	avlab_1s1p,
34 	avlab_1s2p,
35 	avlab_2s1p,
36 	siig_1s1p_10x,
37 	siig_2s1p_10x,
38 	siig_2p1s_20x,
39 	siig_1s1p_20x,
40 	siig_2s1p_20x,
41 };
42 
43 /* each element directly indexed from enum list, above */
44 struct parport_pc_pci {
45 	int numports;
46 	struct { /* BAR (base address registers) numbers in the config
47                     space header */
48 		int lo;
49 		int hi; /* -1 if not there, >6 for offset-method (max
50                            BAR is 6) */
51 	} addr[4];
52 
53 	/* If set, this is called immediately after pci_enable_device.
54 	 * If it returns non-zero, no probing will take place and the
55 	 * ports will not be used. */
56 	int (*preinit_hook) (struct pci_dev *pdev, struct parport_pc_pci *card,
57 				int autoirq, int autodma);
58 
59 	/* If set, this is called after probing for ports.  If 'failed'
60 	 * is non-zero we couldn't use any of the ports. */
61 	void (*postinit_hook) (struct pci_dev *pdev,
62 				struct parport_pc_pci *card, int failed);
63 };
64 
65 static int __devinit netmos_parallel_init(struct pci_dev *dev, struct parport_pc_pci *card, int autoirq, int autodma)
66 {
67 	/*
68 	 * Netmos uses the subdevice ID to indicate the number of parallel
69 	 * and serial ports.  The form is 0x00PS, where <P> is the number of
70 	 * parallel ports and <S> is the number of serial ports.
71 	 */
72 	card->numports = (dev->subsystem_device & 0xf0) >> 4;
73 	return 0;
74 }
75 
76 static struct parport_pc_pci cards[] __devinitdata = {
77 	/* titan_110l */		{ 1, { { 3, -1 }, } },
78 	/* titan_210l */		{ 1, { { 3, -1 }, } },
79 	/* netmos_9xx5_combo */		{ 1, { { 2, -1 }, }, netmos_parallel_init },
80 	/* netmos_9855 */		{ 1, { { 0, -1 }, }, netmos_parallel_init },
81 	/* avlab_1s1p     */		{ 1, { { 1, 2}, } },
82 	/* avlab_1s2p     */		{ 2, { { 1, 2}, { 3, 4 },} },
83 	/* avlab_2s1p     */		{ 1, { { 2, 3}, } },
84 	/* siig_1s1p_10x */		{ 1, { { 3, 4 }, } },
85 	/* siig_2s1p_10x */		{ 1, { { 4, 5 }, } },
86 	/* siig_2p1s_20x */		{ 2, { { 1, 2 }, { 3, 4 }, } },
87 	/* siig_1s1p_20x */		{ 1, { { 1, 2 }, } },
88 	/* siig_2s1p_20x */		{ 1, { { 2, 3 }, } },
89 };
90 
91 static struct pci_device_id parport_serial_pci_tbl[] = {
92 	/* PCI cards */
93 	{ PCI_VENDOR_ID_TITAN, PCI_DEVICE_ID_TITAN_110L,
94 	  PCI_ANY_ID, PCI_ANY_ID, 0, 0, titan_110l },
95 	{ PCI_VENDOR_ID_TITAN, PCI_DEVICE_ID_TITAN_210L,
96 	  PCI_ANY_ID, PCI_ANY_ID, 0, 0, titan_210l },
97 	{ PCI_VENDOR_ID_NETMOS, PCI_DEVICE_ID_NETMOS_9735,
98 	  PCI_ANY_ID, PCI_ANY_ID, 0, 0, netmos_9xx5_combo },
99 	{ PCI_VENDOR_ID_NETMOS, PCI_DEVICE_ID_NETMOS_9745,
100 	  PCI_ANY_ID, PCI_ANY_ID, 0, 0, netmos_9xx5_combo },
101 	{ PCI_VENDOR_ID_NETMOS, PCI_DEVICE_ID_NETMOS_9835,
102 	  PCI_ANY_ID, PCI_ANY_ID, 0, 0, netmos_9xx5_combo },
103 	{ PCI_VENDOR_ID_NETMOS, PCI_DEVICE_ID_NETMOS_9835,
104 	  PCI_ANY_ID, PCI_ANY_ID, 0, 0, netmos_9xx5_combo },
105 	{ PCI_VENDOR_ID_NETMOS, PCI_DEVICE_ID_NETMOS_9845,
106 	  PCI_ANY_ID, PCI_ANY_ID, 0, 0, netmos_9xx5_combo },
107 	{ PCI_VENDOR_ID_NETMOS, PCI_DEVICE_ID_NETMOS_9855,
108 	  PCI_ANY_ID, PCI_ANY_ID, 0, 0, netmos_9855 },
109 	/* PCI_VENDOR_ID_AVLAB/Intek21 has another bunch of cards ...*/
110 	{ PCI_VENDOR_ID_AFAVLAB, 0x2110,
111 	  PCI_ANY_ID, PCI_ANY_ID, 0, 0, avlab_1s1p },
112 	{ PCI_VENDOR_ID_AFAVLAB, 0x2111,
113 	  PCI_ANY_ID, PCI_ANY_ID, 0, 0, avlab_1s1p },
114 	{ PCI_VENDOR_ID_AFAVLAB, 0x2112,
115 	  PCI_ANY_ID, PCI_ANY_ID, 0, 0, avlab_1s1p },
116 	{ PCI_VENDOR_ID_AFAVLAB, 0x2140,
117 	  PCI_ANY_ID, PCI_ANY_ID, 0, 0, avlab_1s2p },
118 	{ PCI_VENDOR_ID_AFAVLAB, 0x2141,
119 	  PCI_ANY_ID, PCI_ANY_ID, 0, 0, avlab_1s2p },
120 	{ PCI_VENDOR_ID_AFAVLAB, 0x2142,
121 	  PCI_ANY_ID, PCI_ANY_ID, 0, 0, avlab_1s2p },
122 	{ PCI_VENDOR_ID_AFAVLAB, 0x2160,
123 	  PCI_ANY_ID, PCI_ANY_ID, 0, 0, avlab_2s1p },
124 	{ PCI_VENDOR_ID_AFAVLAB, 0x2161,
125 	  PCI_ANY_ID, PCI_ANY_ID, 0, 0, avlab_2s1p },
126 	{ PCI_VENDOR_ID_AFAVLAB, 0x2162,
127 	  PCI_ANY_ID, PCI_ANY_ID, 0, 0, avlab_2s1p },
128 	{ PCI_VENDOR_ID_SIIG, PCI_DEVICE_ID_SIIG_1S1P_10x_550,
129 	  PCI_ANY_ID, PCI_ANY_ID, 0, 0, siig_1s1p_10x },
130 	{ PCI_VENDOR_ID_SIIG, PCI_DEVICE_ID_SIIG_1S1P_10x_650,
131 	  PCI_ANY_ID, PCI_ANY_ID, 0, 0, siig_1s1p_10x },
132 	{ PCI_VENDOR_ID_SIIG, PCI_DEVICE_ID_SIIG_1S1P_10x_850,
133 	  PCI_ANY_ID, PCI_ANY_ID, 0, 0, siig_1s1p_10x },
134 	{ PCI_VENDOR_ID_SIIG, PCI_DEVICE_ID_SIIG_2S1P_10x_550,
135 	  PCI_ANY_ID, PCI_ANY_ID, 0, 0, siig_2s1p_10x },
136 	{ PCI_VENDOR_ID_SIIG, PCI_DEVICE_ID_SIIG_2S1P_10x_650,
137 	  PCI_ANY_ID, PCI_ANY_ID, 0, 0, siig_2s1p_10x },
138 	{ PCI_VENDOR_ID_SIIG, PCI_DEVICE_ID_SIIG_2S1P_10x_850,
139 	  PCI_ANY_ID, PCI_ANY_ID, 0, 0, siig_2s1p_10x },
140 	{ PCI_VENDOR_ID_SIIG, PCI_DEVICE_ID_SIIG_2P1S_20x_550,
141 	  PCI_ANY_ID, PCI_ANY_ID, 0, 0, siig_2p1s_20x },
142 	{ PCI_VENDOR_ID_SIIG, PCI_DEVICE_ID_SIIG_2P1S_20x_650,
143 	  PCI_ANY_ID, PCI_ANY_ID, 0, 0, siig_2p1s_20x },
144 	{ PCI_VENDOR_ID_SIIG, PCI_DEVICE_ID_SIIG_2P1S_20x_850,
145 	  PCI_ANY_ID, PCI_ANY_ID, 0, 0, siig_2p1s_20x },
146 	{ PCI_VENDOR_ID_SIIG, PCI_DEVICE_ID_SIIG_1S1P_20x_550,
147 	  PCI_ANY_ID, PCI_ANY_ID, 0, 0, siig_2s1p_20x },
148 	{ PCI_VENDOR_ID_SIIG, PCI_DEVICE_ID_SIIG_1S1P_20x_650,
149 	  PCI_ANY_ID, PCI_ANY_ID, 0, 0, siig_1s1p_20x },
150 	{ PCI_VENDOR_ID_SIIG, PCI_DEVICE_ID_SIIG_1S1P_20x_850,
151 	  PCI_ANY_ID, PCI_ANY_ID, 0, 0, siig_1s1p_20x },
152 	{ PCI_VENDOR_ID_SIIG, PCI_DEVICE_ID_SIIG_2S1P_20x_550,
153 	  PCI_ANY_ID, PCI_ANY_ID, 0, 0, siig_2s1p_20x },
154 	{ PCI_VENDOR_ID_SIIG, PCI_DEVICE_ID_SIIG_2S1P_20x_650,
155 	  PCI_ANY_ID, PCI_ANY_ID, 0, 0, siig_2s1p_20x },
156 	{ PCI_VENDOR_ID_SIIG, PCI_DEVICE_ID_SIIG_2S1P_20x_850,
157 	  PCI_ANY_ID, PCI_ANY_ID, 0, 0, siig_2s1p_20x },
158 
159 	{ 0, } /* terminate list */
160 };
161 MODULE_DEVICE_TABLE(pci,parport_serial_pci_tbl);
162 
163 /*
164  * This table describes the serial "geometry" of these boards.  Any
165  * quirks for these can be found in drivers/serial/8250_pci.c
166  *
167  * Cards not tested are marked n/t
168  * If you have one of these cards and it works for you, please tell me..
169  */
170 static struct pciserial_board pci_parport_serial_boards[] __devinitdata = {
171 	[titan_110l] = {
172 		.flags		= FL_BASE1 | FL_BASE_BARS,
173 		.num_ports	= 1,
174 		.base_baud	= 921600,
175 		.uart_offset	= 8,
176 	},
177 	[titan_210l] = {
178 		.flags		= FL_BASE1 | FL_BASE_BARS,
179 		.num_ports	= 2,
180 		.base_baud	= 921600,
181 		.uart_offset	= 8,
182 	},
183 	[netmos_9xx5_combo] = {
184 		.flags		= FL_BASE0 | FL_BASE_BARS,
185 		.num_ports	= 1,
186 		.base_baud	= 115200,
187 		.uart_offset	= 8,
188 	},
189 	[netmos_9855] = {
190 		.flags		= FL_BASE2 | FL_BASE_BARS,
191 		.num_ports	= 1,
192 		.base_baud	= 115200,
193 		.uart_offset	= 8,
194 	},
195 	[avlab_1s1p] = { /* n/t */
196 		.flags		= FL_BASE0 | FL_BASE_BARS,
197 		.num_ports	= 1,
198 		.base_baud	= 115200,
199 		.uart_offset	= 8,
200 	},
201 	[avlab_1s2p] = { /* n/t */
202 		.flags		= FL_BASE0 | FL_BASE_BARS,
203 		.num_ports	= 1,
204 		.base_baud	= 115200,
205 		.uart_offset	= 8,
206 	},
207 	[avlab_2s1p] = { /* n/t */
208 		.flags		= FL_BASE0 | FL_BASE_BARS,
209 		.num_ports	= 2,
210 		.base_baud	= 115200,
211 		.uart_offset	= 8,
212 	},
213 	[siig_1s1p_10x] = {
214 		.flags		= FL_BASE2,
215 		.num_ports	= 1,
216 		.base_baud	= 460800,
217 		.uart_offset	= 8,
218 	},
219 	[siig_2s1p_10x] = {
220 		.flags		= FL_BASE2,
221 		.num_ports	= 1,
222 		.base_baud	= 921600,
223 		.uart_offset	= 8,
224 	},
225 	[siig_2p1s_20x] = {
226 		.flags		= FL_BASE0,
227 		.num_ports	= 1,
228 		.base_baud	= 921600,
229 		.uart_offset	= 8,
230 	},
231 	[siig_1s1p_20x] = {
232 		.flags		= FL_BASE0,
233 		.num_ports	= 1,
234 		.base_baud	= 921600,
235 		.uart_offset	= 8,
236 	},
237 	[siig_2s1p_20x] = {
238 		.flags		= FL_BASE0,
239 		.num_ports	= 1,
240 		.base_baud	= 921600,
241 		.uart_offset	= 8,
242 	},
243 };
244 
245 struct parport_serial_private {
246 	struct serial_private	*serial;
247 	int num_par;
248 	struct parport *port[PARPORT_MAX];
249 	struct parport_pc_pci par;
250 };
251 
252 /* Register the serial port(s) of a PCI card. */
253 static int __devinit serial_register (struct pci_dev *dev,
254 				      const struct pci_device_id *id)
255 {
256 	struct parport_serial_private *priv = pci_get_drvdata (dev);
257 	struct pciserial_board *board;
258 	struct serial_private *serial;
259 
260 	board = &pci_parport_serial_boards[id->driver_data];
261 	serial = pciserial_init_ports(dev, board);
262 
263 	if (IS_ERR(serial))
264 		return PTR_ERR(serial);
265 
266 	priv->serial = serial;
267 	return 0;
268 }
269 
270 /* Register the parallel port(s) of a PCI card. */
271 static int __devinit parport_register (struct pci_dev *dev,
272 				       const struct pci_device_id *id)
273 {
274 	struct parport_pc_pci *card;
275 	struct parport_serial_private *priv = pci_get_drvdata (dev);
276 	int n, success = 0;
277 
278 	priv->par = cards[id->driver_data];
279 	card = &priv->par;
280 	if (card->preinit_hook &&
281 	    card->preinit_hook (dev, card, PARPORT_IRQ_NONE, PARPORT_DMA_NONE))
282 		return -ENODEV;
283 
284 	for (n = 0; n < card->numports; n++) {
285 		struct parport *port;
286 		int lo = card->addr[n].lo;
287 		int hi = card->addr[n].hi;
288 		unsigned long io_lo, io_hi;
289 
290 		if (priv->num_par == ARRAY_SIZE (priv->port)) {
291 			printk (KERN_WARNING
292 				"parport_serial: %s: only %zu parallel ports "
293 				"supported (%d reported)\n", pci_name (dev),
294 				ARRAY_SIZE(priv->port), card->numports);
295 			break;
296 		}
297 
298 		io_lo = pci_resource_start (dev, lo);
299 		io_hi = 0;
300 		if ((hi >= 0) && (hi <= 6))
301 			io_hi = pci_resource_start (dev, hi);
302 		else if (hi > 6)
303 			io_lo += hi; /* Reinterpret the meaning of
304                                         "hi" as an offset (see SYBA
305                                         def.) */
306 		/* TODO: test if sharing interrupts works */
307 		dev_dbg(&dev->dev, "PCI parallel port detected: I/O at "
308 			"%#lx(%#lx)\n", io_lo, io_hi);
309 		port = parport_pc_probe_port (io_lo, io_hi, PARPORT_IRQ_NONE,
310 					      PARPORT_DMA_NONE, dev);
311 		if (port) {
312 			priv->port[priv->num_par++] = port;
313 			success = 1;
314 		}
315 	}
316 
317 	if (card->postinit_hook)
318 		card->postinit_hook (dev, card, !success);
319 
320 	return 0;
321 }
322 
323 static int __devinit parport_serial_pci_probe (struct pci_dev *dev,
324 					       const struct pci_device_id *id)
325 {
326 	struct parport_serial_private *priv;
327 	int err;
328 
329 	priv = kmalloc (sizeof *priv, GFP_KERNEL);
330 	if (!priv)
331 		return -ENOMEM;
332 	memset(priv, 0, sizeof(struct parport_serial_private));
333 	pci_set_drvdata (dev, priv);
334 
335 	err = pci_enable_device (dev);
336 	if (err) {
337 		pci_set_drvdata (dev, NULL);
338 		kfree (priv);
339 		return err;
340 	}
341 
342 	if (parport_register (dev, id)) {
343 		pci_set_drvdata (dev, NULL);
344 		kfree (priv);
345 		return -ENODEV;
346 	}
347 
348 	if (serial_register (dev, id)) {
349 		int i;
350 		for (i = 0; i < priv->num_par; i++)
351 			parport_pc_unregister_port (priv->port[i]);
352 		pci_set_drvdata (dev, NULL);
353 		kfree (priv);
354 		return -ENODEV;
355 	}
356 
357 	return 0;
358 }
359 
360 static void __devexit parport_serial_pci_remove (struct pci_dev *dev)
361 {
362 	struct parport_serial_private *priv = pci_get_drvdata (dev);
363 	int i;
364 
365 	pci_set_drvdata(dev, NULL);
366 
367 	// Serial ports
368 	if (priv->serial)
369 		pciserial_remove_ports(priv->serial);
370 
371 	// Parallel ports
372 	for (i = 0; i < priv->num_par; i++)
373 		parport_pc_unregister_port (priv->port[i]);
374 
375 	kfree (priv);
376 	return;
377 }
378 
379 static int parport_serial_pci_suspend(struct pci_dev *dev, pm_message_t state)
380 {
381 	struct parport_serial_private *priv = pci_get_drvdata(dev);
382 
383 	if (priv->serial)
384 		pciserial_suspend_ports(priv->serial);
385 
386 	/* FIXME: What about parport? */
387 
388 	pci_save_state(dev);
389 	pci_set_power_state(dev, pci_choose_state(dev, state));
390 	return 0;
391 }
392 
393 static int parport_serial_pci_resume(struct pci_dev *dev)
394 {
395 	struct parport_serial_private *priv = pci_get_drvdata(dev);
396 
397 	pci_set_power_state(dev, PCI_D0);
398 	pci_restore_state(dev);
399 
400 	/*
401 	 * The device may have been disabled.  Re-enable it.
402 	 */
403 	pci_enable_device(dev);
404 
405 	if (priv->serial)
406 		pciserial_resume_ports(priv->serial);
407 
408 	/* FIXME: What about parport? */
409 
410 	return 0;
411 }
412 
413 static struct pci_driver parport_serial_pci_driver = {
414 	.name		= "parport_serial",
415 	.id_table	= parport_serial_pci_tbl,
416 	.probe		= parport_serial_pci_probe,
417 	.remove		= __devexit_p(parport_serial_pci_remove),
418 	.suspend	= parport_serial_pci_suspend,
419 	.resume		= parport_serial_pci_resume,
420 };
421 
422 
423 static int __init parport_serial_init (void)
424 {
425 	return pci_register_driver (&parport_serial_pci_driver);
426 }
427 
428 static void __exit parport_serial_exit (void)
429 {
430 	pci_unregister_driver (&parport_serial_pci_driver);
431 	return;
432 }
433 
434 MODULE_AUTHOR("Tim Waugh <twaugh@redhat.com>");
435 MODULE_DESCRIPTION("Driver for common parallel+serial multi-I/O PCI cards");
436 MODULE_LICENSE("GPL");
437 
438 module_init(parport_serial_init);
439 module_exit(parport_serial_exit);
440