Version:  2.0.40 2.2.26 2.4.37 3.12 3.13 3.14 3.15 3.16 3.17 3.18 3.19 4.0 4.1 4.2 4.3 4.4 4.5 4.6 4.7 4.8 4.9

Linux/drivers/tty/serial/8250/serial_cs.c

  1 /*======================================================================
  2 
  3     A driver for PCMCIA serial devices
  4 
  5     serial_cs.c 1.134 2002/05/04 05:48:53
  6 
  7     The contents of this file are subject to the Mozilla Public
  8     License Version 1.1 (the "License"); you may not use this file
  9     except in compliance with the License. You may obtain a copy of
 10     the License at http://www.mozilla.org/MPL/
 11 
 12     Software distributed under the License is distributed on an "AS
 13     IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
 14     implied. See the License for the specific language governing
 15     rights and limitations under the License.
 16 
 17     The initial developer of the original code is David A. Hinds
 18     <dahinds@users.sourceforge.net>.  Portions created by David A. Hinds
 19     are Copyright (C) 1999 David A. Hinds.  All Rights Reserved.
 20 
 21     Alternatively, the contents of this file may be used under the
 22     terms of the GNU General Public License version 2 (the "GPL"), in which
 23     case the provisions of the GPL are applicable instead of the
 24     above.  If you wish to allow the use of your version of this file
 25     only under the terms of the GPL and not to allow others to use
 26     your version of this file under the MPL, indicate your decision
 27     by deleting the provisions above and replace them with the notice
 28     and other provisions required by the GPL.  If you do not delete
 29     the provisions above, a recipient may use your version of this
 30     file under either the MPL or the GPL.
 31 
 32 ======================================================================*/
 33 
 34 #include <linux/module.h>
 35 #include <linux/moduleparam.h>
 36 #include <linux/kernel.h>
 37 #include <linux/ptrace.h>
 38 #include <linux/slab.h>
 39 #include <linux/string.h>
 40 #include <linux/timer.h>
 41 #include <linux/serial_core.h>
 42 #include <linux/delay.h>
 43 #include <linux/major.h>
 44 #include <asm/io.h>
 45 
 46 #include <pcmcia/cistpl.h>
 47 #include <pcmcia/ciscode.h>
 48 #include <pcmcia/ds.h>
 49 #include <pcmcia/cisreg.h>
 50 
 51 #include "8250.h"
 52 
 53 
 54 /*====================================================================*/
 55 
 56 /* Parameters that can be set with 'insmod' */
 57 
 58 /* Enable the speaker? */
 59 static int do_sound = 1;
 60 /* Skip strict UART tests? */
 61 static int buggy_uart;
 62 
 63 module_param(do_sound, int, 0444);
 64 module_param(buggy_uart, int, 0444);
 65 
 66 /*====================================================================*/
 67 
 68 /* Table of multi-port card ID's */
 69 
 70 struct serial_quirk {
 71         unsigned int manfid;
 72         unsigned int prodid;
 73         int multi;              /* 1 = multifunction, > 1 = # ports */
 74         void (*config)(struct pcmcia_device *);
 75         void (*setup)(struct pcmcia_device *, struct uart_8250_port *);
 76         void (*wakeup)(struct pcmcia_device *);
 77         int (*post)(struct pcmcia_device *);
 78 };
 79 
 80 struct serial_info {
 81         struct pcmcia_device    *p_dev;
 82         int                     ndev;
 83         int                     multi;
 84         int                     slave;
 85         int                     manfid;
 86         int                     prodid;
 87         int                     c950ctrl;
 88         int                     line[4];
 89         const struct serial_quirk *quirk;
 90 };
 91 
 92 struct serial_cfg_mem {
 93         tuple_t tuple;
 94         cisparse_t parse;
 95         u_char buf[256];
 96 };
 97 
 98 /*
 99  * vers_1 5.0, "Brain Boxes", "2-Port RS232 card", "r6"
100  * manfid 0x0160, 0x0104
101  * This card appears to have a 14.7456MHz clock.
102  */
103 /* Generic Modem: MD55x (GPRS/EDGE) have
104  * Elan VPU16551 UART with 14.7456MHz oscillator
105  * manfid 0x015D, 0x4C45
106  */
107 static void quirk_setup_brainboxes_0104(struct pcmcia_device *link, struct uart_8250_port *uart)
108 {
109         uart->port.uartclk = 14745600;
110 }
111 
112 static int quirk_post_ibm(struct pcmcia_device *link)
113 {
114         u8 val;
115         int ret;
116 
117         ret = pcmcia_read_config_byte(link, 0x800, &val);
118         if (ret)
119                 goto failed;
120 
121         ret = pcmcia_write_config_byte(link, 0x800, val | 1);
122         if (ret)
123                 goto failed;
124         return 0;
125 
126  failed:
127         return -ENODEV;
128 }
129 
130 /*
131  * Nokia cards are not really multiport cards.  Shouldn't this
132  * be handled by setting the quirk entry .multi = 0 | 1 ?
133  */
134 static void quirk_config_nokia(struct pcmcia_device *link)
135 {
136         struct serial_info *info = link->priv;
137 
138         if (info->multi > 1)
139                 info->multi = 1;
140 }
141 
142 static void quirk_wakeup_oxsemi(struct pcmcia_device *link)
143 {
144         struct serial_info *info = link->priv;
145 
146         if (info->c950ctrl)
147                 outb(12, info->c950ctrl + 1);
148 }
149 
150 /* request_region? oxsemi branch does no request_region too... */
151 /*
152  * This sequence is needed to properly initialize MC45 attached to OXCF950.
153  * I tried decreasing these msleep()s, but it worked properly (survived
154  * 1000 stop/start operations) with these timeouts (or bigger).
155  */
156 static void quirk_wakeup_possio_gcc(struct pcmcia_device *link)
157 {
158         struct serial_info *info = link->priv;
159         unsigned int ctrl = info->c950ctrl;
160 
161         outb(0xA, ctrl + 1);
162         msleep(100);
163         outb(0xE, ctrl + 1);
164         msleep(300);
165         outb(0xC, ctrl + 1);
166         msleep(100);
167         outb(0xE, ctrl + 1);
168         msleep(200);
169         outb(0xF, ctrl + 1);
170         msleep(100);
171         outb(0xE, ctrl + 1);
172         msleep(100);
173         outb(0xC, ctrl + 1);
174 }
175 
176 /*
177  * Socket Dual IO: this enables irq's for second port
178  */
179 static void quirk_config_socket(struct pcmcia_device *link)
180 {
181         struct serial_info *info = link->priv;
182 
183         if (info->multi)
184                 link->config_flags |= CONF_ENABLE_ESR;
185 }
186 
187 static const struct serial_quirk quirks[] = {
188         {
189                 .manfid = 0x0160,
190                 .prodid = 0x0104,
191                 .multi  = -1,
192                 .setup  = quirk_setup_brainboxes_0104,
193         }, {
194                 .manfid = 0x015D,
195                 .prodid = 0x4C45,
196                 .multi  = -1,
197                 .setup  = quirk_setup_brainboxes_0104,
198         }, {
199                 .manfid = MANFID_IBM,
200                 .prodid = ~0,
201                 .multi  = -1,
202                 .post   = quirk_post_ibm,
203         }, {
204                 .manfid = MANFID_INTEL,
205                 .prodid = PRODID_INTEL_DUAL_RS232,
206                 .multi  = 2,
207         }, {
208                 .manfid = MANFID_NATINST,
209                 .prodid = PRODID_NATINST_QUAD_RS232,
210                 .multi  = 4,
211         }, {
212                 .manfid = MANFID_NOKIA,
213                 .prodid = ~0,
214                 .multi  = -1,
215                 .config = quirk_config_nokia,
216         }, {
217                 .manfid = MANFID_OMEGA,
218                 .prodid = PRODID_OMEGA_QSP_100,
219                 .multi  = 4,
220         }, {
221                 .manfid = MANFID_OXSEMI,
222                 .prodid = ~0,
223                 .multi  = -1,
224                 .wakeup = quirk_wakeup_oxsemi,
225         }, {
226                 .manfid = MANFID_POSSIO,
227                 .prodid = PRODID_POSSIO_GCC,
228                 .multi  = -1,
229                 .wakeup = quirk_wakeup_possio_gcc,
230         }, {
231                 .manfid = MANFID_QUATECH,
232                 .prodid = PRODID_QUATECH_DUAL_RS232,
233                 .multi  = 2,
234         }, {
235                 .manfid = MANFID_QUATECH,
236                 .prodid = PRODID_QUATECH_DUAL_RS232_D1,
237                 .multi  = 2,
238         }, {
239                 .manfid = MANFID_QUATECH,
240                 .prodid = PRODID_QUATECH_DUAL_RS232_G,
241                 .multi  = 2,
242         }, {
243                 .manfid = MANFID_QUATECH,
244                 .prodid = PRODID_QUATECH_QUAD_RS232,
245                 .multi  = 4,
246         }, {
247                 .manfid = MANFID_SOCKET,
248                 .prodid = PRODID_SOCKET_DUAL_RS232,
249                 .multi  = 2,
250                 .config = quirk_config_socket,
251         }, {
252                 .manfid = MANFID_SOCKET,
253                 .prodid = ~0,
254                 .multi  = -1,
255                 .config = quirk_config_socket,
256         }
257 };
258 
259 
260 static int serial_config(struct pcmcia_device *link);
261 
262 
263 static void serial_remove(struct pcmcia_device *link)
264 {
265         struct serial_info *info = link->priv;
266         int i;
267 
268         dev_dbg(&link->dev, "serial_release\n");
269 
270         /*
271          * Recheck to see if the device is still configured.
272          */
273         for (i = 0; i < info->ndev; i++)
274                 serial8250_unregister_port(info->line[i]);
275 
276         if (!info->slave)
277                 pcmcia_disable_device(link);
278 }
279 
280 static int serial_suspend(struct pcmcia_device *link)
281 {
282         struct serial_info *info = link->priv;
283         int i;
284 
285         for (i = 0; i < info->ndev; i++)
286                 serial8250_suspend_port(info->line[i]);
287 
288         return 0;
289 }
290 
291 static int serial_resume(struct pcmcia_device *link)
292 {
293         struct serial_info *info = link->priv;
294         int i;
295 
296         for (i = 0; i < info->ndev; i++)
297                 serial8250_resume_port(info->line[i]);
298 
299         if (info->quirk && info->quirk->wakeup)
300                 info->quirk->wakeup(link);
301 
302         return 0;
303 }
304 
305 static int serial_probe(struct pcmcia_device *link)
306 {
307         struct serial_info *info;
308 
309         dev_dbg(&link->dev, "serial_attach()\n");
310 
311         /* Create new serial device */
312         info = kzalloc(sizeof(*info), GFP_KERNEL);
313         if (!info)
314                 return -ENOMEM;
315         info->p_dev = link;
316         link->priv = info;
317 
318         link->config_flags |= CONF_ENABLE_IRQ | CONF_AUTO_SET_IO;
319         if (do_sound)
320                 link->config_flags |= CONF_ENABLE_SPKR;
321 
322         return serial_config(link);
323 }
324 
325 static void serial_detach(struct pcmcia_device *link)
326 {
327         struct serial_info *info = link->priv;
328 
329         dev_dbg(&link->dev, "serial_detach\n");
330 
331         /*
332          * Ensure that the ports have been released.
333          */
334         serial_remove(link);
335 
336         /* free bits */
337         kfree(info);
338 }
339 
340 /*====================================================================*/
341 
342 static int setup_serial(struct pcmcia_device *handle, struct serial_info *info,
343                         unsigned int iobase, int irq)
344 {
345         struct uart_8250_port uart;
346         int line;
347 
348         memset(&uart, 0, sizeof(uart));
349         uart.port.iobase = iobase;
350         uart.port.irq = irq;
351         uart.port.flags = UPF_BOOT_AUTOCONF | UPF_SKIP_TEST | UPF_SHARE_IRQ;
352         uart.port.uartclk = 1843200;
353         uart.port.dev = &handle->dev;
354         if (buggy_uart)
355                 uart.port.flags |= UPF_BUGGY_UART;
356 
357         if (info->quirk && info->quirk->setup)
358                 info->quirk->setup(handle, &uart);
359 
360         line = serial8250_register_8250_port(&uart);
361         if (line < 0) {
362                 pr_err("serial_cs: serial8250_register_8250_port() at 0x%04lx, irq %d failed\n",
363                                                         (unsigned long)iobase, irq);
364                 return -EINVAL;
365         }
366 
367         info->line[info->ndev] = line;
368         info->ndev++;
369 
370         return 0;
371 }
372 
373 /*====================================================================*/
374 
375 static int pfc_config(struct pcmcia_device *p_dev)
376 {
377         unsigned int port = 0;
378         struct serial_info *info = p_dev->priv;
379 
380         if ((p_dev->resource[1]->end != 0) &&
381                 (resource_size(p_dev->resource[1]) == 8)) {
382                 port = p_dev->resource[1]->start;
383                 info->slave = 1;
384         } else if ((info->manfid == MANFID_OSITECH) &&
385                 (resource_size(p_dev->resource[0]) == 0x40)) {
386                 port = p_dev->resource[0]->start + 0x28;
387                 info->slave = 1;
388         }
389         if (info->slave)
390                 return setup_serial(p_dev, info, port, p_dev->irq);
391 
392         dev_warn(&p_dev->dev, "no usable port range found, giving up\n");
393         return -ENODEV;
394 }
395 
396 static int simple_config_check(struct pcmcia_device *p_dev, void *priv_data)
397 {
398         static const int size_table[2] = { 8, 16 };
399         int *try = priv_data;
400 
401         if (p_dev->resource[0]->start == 0)
402                 return -ENODEV;
403 
404         if ((*try & 0x1) == 0)
405                 p_dev->io_lines = 16;
406 
407         if (p_dev->resource[0]->end != size_table[(*try >> 1)])
408                 return -ENODEV;
409 
410         p_dev->resource[0]->end = 8;
411         p_dev->resource[0]->flags &= ~IO_DATA_PATH_WIDTH;
412         p_dev->resource[0]->flags |= IO_DATA_PATH_WIDTH_8;
413 
414         return pcmcia_request_io(p_dev);
415 }
416 
417 static int simple_config_check_notpicky(struct pcmcia_device *p_dev,
418                                         void *priv_data)
419 {
420         static const unsigned int base[5] = { 0x3f8, 0x2f8, 0x3e8, 0x2e8, 0x0 };
421         int j;
422 
423         if (p_dev->io_lines > 3)
424                 return -ENODEV;
425 
426         p_dev->resource[0]->flags &= ~IO_DATA_PATH_WIDTH;
427         p_dev->resource[0]->flags |= IO_DATA_PATH_WIDTH_8;
428         p_dev->resource[0]->end = 8;
429 
430         for (j = 0; j < 5; j++) {
431                 p_dev->resource[0]->start = base[j];
432                 p_dev->io_lines = base[j] ? 16 : 3;
433                 if (!pcmcia_request_io(p_dev))
434                         return 0;
435         }
436         return -ENODEV;
437 }
438 
439 static int simple_config(struct pcmcia_device *link)
440 {
441         struct serial_info *info = link->priv;
442         int i = -ENODEV, try;
443 
444         /*
445          * First pass: look for a config entry that looks normal.
446          * Two tries: without IO aliases, then with aliases.
447          */
448         link->config_flags |= CONF_AUTO_SET_VPP;
449         for (try = 0; try < 4; try++)
450                 if (!pcmcia_loop_config(link, simple_config_check, &try))
451                         goto found_port;
452 
453         /*
454          * Second pass: try to find an entry that isn't picky about
455          * its base address, then try to grab any standard serial port
456          * address, and finally try to get any free port.
457          */
458         if (!pcmcia_loop_config(link, simple_config_check_notpicky, NULL))
459                 goto found_port;
460 
461         dev_warn(&link->dev, "no usable port range found, giving up\n");
462         return -1;
463 
464 found_port:
465         if (info->multi && (info->manfid == MANFID_3COM))
466                 link->config_index &= ~(0x08);
467 
468         /*
469          * Apply any configuration quirks.
470          */
471         if (info->quirk && info->quirk->config)
472                 info->quirk->config(link);
473 
474         i = pcmcia_enable_device(link);
475         if (i != 0)
476                 return -1;
477         return setup_serial(link, info, link->resource[0]->start, link->irq);
478 }
479 
480 static int multi_config_check(struct pcmcia_device *p_dev, void *priv_data)
481 {
482         int *multi = priv_data;
483 
484         if (p_dev->resource[1]->end)
485                 return -EINVAL;
486 
487         /*
488          * The quad port cards have bad CIS's, so just look for a
489          * window larger than 8 ports and assume it will be right.
490          */
491         if (p_dev->resource[0]->end <= 8)
492                 return -EINVAL;
493 
494         p_dev->resource[0]->flags &= ~IO_DATA_PATH_WIDTH;
495         p_dev->resource[0]->flags |= IO_DATA_PATH_WIDTH_8;
496         p_de