File: /usr/src/linux/drivers/parport/parport_serial.c

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/serial.h>
27     #include <linux/serialP.h>
28     #include <linux/list.h>
29     
30     #include <asm/serial.h>
31     
32     enum parport_pc_pci_cards {
33     	titan_110l = 0,
34     	titan_210l,
35     	netmos_9735,
36     	netmos_9835,
37     	avlab_1s1p,
38     	avlab_1s1p_650,
39     	avlab_1s1p_850,
40     	avlab_1s2p,
41     	avlab_1s2p_650,
42     	avlab_1s2p_850,
43     	avlab_2s1p,
44     	avlab_2s1p_650,
45     	avlab_2s1p_850,
46     };
47     
48     
49     /* each element directly indexed from enum list, above */
50     static struct parport_pc_pci {
51     	int numports;
52     	struct { /* BAR (base address registers) numbers in the config
53                         space header */
54     		int lo;
55     		int hi; /* -1 if not there, >6 for offset-method (max
56                                BAR is 6) */
57     	} addr[4];
58     } cards[] __devinitdata = {
59     	/* titan_110l */		{ 1, { { 3, -1 }, } },
60     	/* titan_210l */		{ 1, { { 3, -1 }, } },
61     	/* netmos_9735 (not tested) */	{ 1, { { 2, 3 }, } },
62     	/* netmos_9835 (not tested) */	{ 1, { { 2, 3 }, } },
63     	/* avlab_1s1p     */		{ 1, { { 1, 2}, } },
64     	/* avlab_1s1p_650 */		{ 1, { { 1, 2}, } },
65     	/* avlab_1s1p_850 */		{ 1, { { 1, 2}, } },
66     	/* avlab_1s2p     */		{ 2, { { 1, 2}, { 3, 4 },} },
67     	/* avlab_1s2p_650 */		{ 2, { { 1, 2}, { 3, 4 },} },
68     	/* avlab_1s2p_850 */		{ 2, { { 1, 2}, { 3, 4 },} },
69     	/* avlab_2s1p     */		{ 1, { { 2, 3}, } },
70     	/* avlab_2s1p_650 */		{ 1, { { 2, 3}, } },
71     	/* avlab_2s1p_850 */		{ 1, { { 2, 3}, } },
72     };
73     
74     static struct pci_device_id parport_serial_pci_tbl[] __devinitdata = {
75     	/* PCI cards */
76     	{ PCI_VENDOR_ID_TITAN, PCI_DEVICE_ID_TITAN_110L,
77     	  PCI_ANY_ID, PCI_ANY_ID, 0, 0, titan_110l },
78     	{ PCI_VENDOR_ID_TITAN, PCI_DEVICE_ID_TITAN_210L,
79     	  PCI_ANY_ID, PCI_ANY_ID, 0, 0, titan_210l },
80     	{ PCI_VENDOR_ID_NETMOS, PCI_DEVICE_ID_NETMOS_9735,
81     	  PCI_ANY_ID, PCI_ANY_ID, 0, 0, netmos_9735 },
82     	{ PCI_VENDOR_ID_NETMOS, PCI_DEVICE_ID_NETMOS_9835,
83     	  PCI_ANY_ID, PCI_ANY_ID, 0, 0, netmos_9835 },
84     	/* PCI_VENDOR_ID_AVLAB/Intek21 has another bunch of cards ...*/
85     	{ 0x14db, 0x2110, PCI_ANY_ID, PCI_ANY_ID, 0, 0, avlab_1s1p},
86     	{ 0x14db, 0x2111, PCI_ANY_ID, PCI_ANY_ID, 0, 0, avlab_1s1p_650},
87     	{ 0x14db, 0x2112, PCI_ANY_ID, PCI_ANY_ID, 0, 0, avlab_1s1p_850},
88     	{ 0x14db, 0x2140, PCI_ANY_ID, PCI_ANY_ID, 0, 0, avlab_1s2p},
89     	{ 0x14db, 0x2141, PCI_ANY_ID, PCI_ANY_ID, 0, 0, avlab_1s2p_650},
90     	{ 0x14db, 0x2142, PCI_ANY_ID, PCI_ANY_ID, 0, 0, avlab_1s2p_850},
91     	{ 0x14db, 0x2160, PCI_ANY_ID, PCI_ANY_ID, 0, 0, avlab_2s1p},
92     	{ 0x14db, 0x2161, PCI_ANY_ID, PCI_ANY_ID, 0, 0, avlab_2s1p_650},
93     	{ 0x14db, 0x2162, PCI_ANY_ID, PCI_ANY_ID, 0, 0, avlab_2s1p_850},
94     	{ 0, } /* terminate list */
95     };
96     MODULE_DEVICE_TABLE(pci,parport_serial_pci_tbl);
97     
98     struct pci_board_no_ids {
99     	int flags;
100     	int num_ports;
101     	int base_baud;
102     	int uart_offset;
103     	int reg_shift;
104     	int (*init_fn)(struct pci_dev *dev, struct pci_board_no_ids *board,
105     			int enable);
106     	int first_uart_offset;
107     };
108     
109     static struct pci_board_no_ids pci_boards[] __devinitdata = {
110     	/*
111     	 * PCI Flags, Number of Ports, Base (Maximum) Baud Rate,
112     	 * Offset to get to next UART's registers,
113     	 * Register shift to use for memory-mapped I/O,
114     	 * Initialization function, first UART offset
115     	 */
116     
117     // Cards not tested are marked n/t
118     // If you have one of these cards and it works for you, please tell me..
119     
120     /* titan_110l */	{ SPCI_FL_BASE1 | SPCI_FL_BASE_TABLE, 1, 921600 },
121     /* titan_210l */	{ SPCI_FL_BASE1 | SPCI_FL_BASE_TABLE, 2, 921600 },
122     /* netmos_9735 (n/t)*/	{ SPCI_FL_BASE0 | SPCI_FL_BASE_TABLE, 2, 115200 },
123     /* netmos_9835 (n/t)*/	{ SPCI_FL_BASE0 | SPCI_FL_BASE_TABLE, 2, 115200 },
124     /* avlab_1s1p (n/t) */	{ SPCI_FL_BASE0 | SPCI_FL_BASE_TABLE, 1, 115200 },
125     /* avlab_1s1p_650 (nt)*/{ SPCI_FL_BASE0 | SPCI_FL_BASE_TABLE, 1, 115200 },
126     /* avlab_1s1p_850 (nt)*/{ SPCI_FL_BASE0 | SPCI_FL_BASE_TABLE, 1, 115200 },
127     /* avlab_1s2p (n/t) */	{ SPCI_FL_BASE0 | SPCI_FL_BASE_TABLE, 1, 115200 },
128     /* avlab_1s2p_650 (nt)*/{ SPCI_FL_BASE0 | SPCI_FL_BASE_TABLE, 1, 115200 },
129     /* avlab_1s2p_850 (nt)*/{ SPCI_FL_BASE0 | SPCI_FL_BASE_TABLE, 1, 115200 },
130     /* avlab_2s1p (n/t) */	{ SPCI_FL_BASE0 | SPCI_FL_BASE_TABLE, 2, 115200 },
131     /* avlab_2s1p_650 (nt)*/{ SPCI_FL_BASE0 | SPCI_FL_BASE_TABLE, 2, 115200 },
132     /* avlab_2s1p_850 (nt)*/{ SPCI_FL_BASE0 | SPCI_FL_BASE_TABLE, 2, 115200 },
133     };
134     
135     struct parport_serial_private {
136     	int num_ser;
137     	int line[20];
138     	struct pci_board_no_ids ser;
139     	int num_par;
140     	struct parport *port[PARPORT_MAX];
141     };
142     
143     static int __devinit get_pci_port (struct pci_dev *dev,
144     				   struct pci_board_no_ids *board,
145     				   struct serial_struct *req,
146     				   int idx)
147     {
148     	unsigned long port;
149     	int base_idx;
150     	int max_port;
151     	int offset;
152     
153     	base_idx = SPCI_FL_GET_BASE(board->flags);
154     	if (board->flags & SPCI_FL_BASE_TABLE)
155     		base_idx += idx;
156     
157     	if (board->flags & SPCI_FL_REGION_SZ_CAP) {
158     		max_port = pci_resource_len(dev, base_idx) / 8;
159     		if (idx >= max_port)
160     			return 1;
161     	}
162     			
163     	offset = board->first_uart_offset;
164     
165     	/* Timedia/SUNIX uses a mixture of BARs and offsets */
166     	/* Ugh, this is ugly as all hell --- TYT */
167     	if(dev->vendor == PCI_VENDOR_ID_TIMEDIA )  /* 0x1409 */
168     		switch(idx) {
169     			case 0: base_idx=0;
170     				break;
171     			case 1: base_idx=0; offset=8;
172     				break;
173     			case 2: base_idx=1; 
174     				break;
175     			case 3: base_idx=1; offset=8;
176     				break;
177     			case 4: /* BAR 2*/
178     			case 5: /* BAR 3 */
179     			case 6: /* BAR 4*/
180     			case 7: base_idx=idx-2; /* BAR 5*/
181     		}
182       
183     	port =  pci_resource_start(dev, base_idx) + offset;
184     
185     	if ((board->flags & SPCI_FL_BASE_TABLE) == 0)
186     		port += idx * (board->uart_offset ? board->uart_offset : 8);
187     
188     	if (pci_resource_flags (dev, base_idx) & IORESOURCE_IO) {
189     		int high_bits_offset = ((sizeof(long)-sizeof(int))*8);
190     		req->port = port;
191     		if (high_bits_offset)
192     			req->port_high = port >> high_bits_offset;
193     		else
194     			req->port_high = 0;
195     		return 0;
196     	}
197     	req->io_type = SERIAL_IO_MEM;
198     	req->iomem_base = ioremap(port, board->uart_offset);
199     	req->iomem_reg_shift = board->reg_shift;
200     	req->port = 0;
201     	return req->iomem_base ? 0 : 1;
202     }
203     
204     /* Register the serial port(s) of a PCI card. */
205     static int __devinit serial_register (struct pci_dev *dev,
206     				      const struct pci_device_id *id)
207     {
208     	struct pci_board_no_ids *board = &pci_boards[id->driver_data];
209     	struct parport_serial_private *priv = pci_get_drvdata (dev);
210     	struct serial_struct serial_req;
211     	int base_baud;
212     	int k;
213     	int success = 0;
214     
215     	priv->ser = *board;
216     	if (board->init_fn && ((board->init_fn) (dev, board, 1) != 0))
217     		return 1;
218     
219     	base_baud = board->base_baud;
220     	if (!base_baud)
221     		base_baud = BASE_BAUD;
222     	memset (&serial_req, 0, sizeof (serial_req));
223     
224     	for (k = 0; k < board->num_ports; k++) {
225     		int line;
226     		serial_req.irq = dev->irq;
227     		if (get_pci_port (dev, board, &serial_req, k))
228     			break;
229     		serial_req.flags = ASYNC_SKIP_TEST | ASYNC_AUTOPROBE;
230     		line = register_serial (&serial_req);
231     		if (line < 0) {
232     			printk (KERN_DEBUG
233     				"parport_serial: register_serial failed\n");
234     			continue;
235     		}
236     		priv->line[priv->num_ser++] = line;
237     		success = 1;
238     	}
239     
240     	return success ? 0 : 1;
241     }
242     
243     /* Register the parallel port(s) of a PCI card. */
244     static int __devinit parport_register (struct pci_dev *dev,
245     				       const struct pci_device_id *id)
246     {
247     	struct parport_serial_private *priv = pci_get_drvdata (dev);
248     	int i = id->driver_data, n;
249     	int success = 0;
250     
251     	for (n = 0; n < cards[i].numports; n++) {
252     		struct parport *port;
253     		int lo = cards[i].addr[n].lo;
254     		int hi = cards[i].addr[n].hi;
255     		unsigned long io_lo, io_hi;
256     		io_lo = pci_resource_start (dev, lo);
257     		io_hi = 0;
258     		if ((hi >= 0) && (hi <= 6))
259     			io_hi = pci_resource_start (dev, hi);
260     		else if (hi > 6)
261     			io_lo += hi; /* Reinterpret the meaning of
262                                             "hi" as an offset (see SYBA
263                                             def.) */
264     		/* TODO: test if sharing interrupts works */
265     		printk (KERN_DEBUG "PCI parallel port detected: %04x:%04x, "
266     			"I/O at %#lx(%#lx)\n",
267     			parport_serial_pci_tbl[i].vendor,
268     			parport_serial_pci_tbl[i].device, io_lo, io_hi);
269     		port = parport_pc_probe_port (io_lo, io_hi, PARPORT_IRQ_NONE,
270     					      PARPORT_DMA_NONE, dev);
271     		if (port) {
272     			priv->port[priv->num_par++] = port;
273     			success = 1;
274     		}
275     	}
276     
277     	return success ? 0 : 1;
278     }
279     
280     static int __devinit parport_serial_pci_probe (struct pci_dev *dev,
281     					       const struct pci_device_id *id)
282     {
283     	struct parport_serial_private *priv;
284     	int err;
285     
286     	priv = kmalloc (sizeof *priv, GFP_KERNEL);
287     	if (!priv)
288     		return -ENOMEM;
289     	priv->num_ser = priv->num_par = 0;
290     	pci_set_drvdata (dev, priv);
291     
292     	err = pci_enable_device (dev);
293     	if (err) {
294     		pci_set_drvdata (dev, NULL);
295     		kfree (priv);
296     		return err;
297     	}
298     
299     	if (parport_register (dev, id)) {
300     		pci_set_drvdata (dev, NULL);
301     		kfree (priv);
302     		return -ENODEV;
303     	}
304     
305     	if (serial_register (dev, id)) {
306     		int i;
307     		for (i = 0; i < priv->num_par; i++)
308     			parport_pc_unregister_port (priv->port[i]);
309     		pci_set_drvdata (dev, NULL);
310     		kfree (priv);
311     		return -ENODEV;
312     	}
313     
314     	return 0;
315     }
316     
317     static void __devexit parport_serial_pci_remove (struct pci_dev *dev)
318     {
319     	struct parport_serial_private *priv = pci_get_drvdata (dev);
320     	int i;
321     
322     	// Serial ports
323     	for (i = 0; i < priv->num_ser; i++) {
324     		unregister_serial (priv->line[i]);
325     
326     		if (priv->ser.init_fn)
327     			(priv->ser.init_fn) (dev, &priv->ser, 0);
328     	}
329     	pci_set_drvdata (dev, NULL);
330     	
331     	// Parallel ports
332     	for (i = 0; i < priv->num_par; i++)
333     		parport_pc_unregister_port (priv->port[i]);
334     
335     	kfree (priv);
336     	return;
337     }
338     
339     static struct pci_driver parport_serial_pci_driver = {
340     	name:		"parport_serial",
341     	id_table:	parport_serial_pci_tbl,
342     	probe:		parport_serial_pci_probe,
343     	remove:		parport_serial_pci_remove,
344     };
345     
346     
347     static int __init parport_serial_init (void)
348     {
349     	return pci_module_init (&parport_serial_pci_driver);
350     }
351     
352     static void __exit parport_serial_exit (void)
353     {
354     	pci_unregister_driver (&parport_serial_pci_driver);
355     	return;
356     }
357     
358     MODULE_AUTHOR("Tim Waugh <twaugh@redhat.com>");
359     MODULE_DESCRIPTION("Driver for common parallel+serial multi-I/O PCI cards");
360     
361     module_init(parport_serial_init);
362     module_exit(parport_serial_exit);
363