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