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