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