drivers/tty/serial/8250/8250_exar.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  *  Probe module for 8250/16550-type Exar chips PCI serial ports.
   4  *
   5  *  Based on drivers/tty/serial/8250/8250_pci.c,
   6  *
   7  *  Copyright (C) 2017 Sudip Mukherjee, All Rights Reserved.
   8  */
   9 #include <linux/acpi.h>
  10 #include <linux/dmi.h>
  11 #include <linux/io.h>
  12 #include <linux/kernel.h>
  13 #include <linux/module.h>
  14 #include <linux/pci.h>
  15 #include <linux/property.h>
  16 #include <linux/serial_core.h>
  17 #include <linux/serial_reg.h>
  18 #include <linux/slab.h>
  19 #include <linux/string.h>
  20 #include <linux/tty.h>
  21 #include <linux/8250_pci.h>
  22 #include <linux/delay.h>
  23
  24 #include <asm/byteorder.h>
  25
  26 #include "8250.h"
  27
  28 #define PCI_DEVICE_ID_ACCESSIO_COM_2S           0x1052
  29 #define PCI_DEVICE_ID_ACCESSIO_COM_4S           0x105d
  30 #define PCI_DEVICE_ID_ACCESSIO_COM_8S           0x106c
  31 #define PCI_DEVICE_ID_ACCESSIO_COM232_8         0x10a8
  32 #define PCI_DEVICE_ID_ACCESSIO_COM_2SM          0x10d2
  33 #define PCI_DEVICE_ID_ACCESSIO_COM_4SM          0x10db
  34 #define PCI_DEVICE_ID_ACCESSIO_COM_8SM          0x10ea
  35
  36 #define PCI_DEVICE_ID_COMMTECH_4224PCI335       0x0002
  37 #define PCI_DEVICE_ID_COMMTECH_4222PCI335       0x0004
  38 #define PCI_DEVICE_ID_COMMTECH_2324PCI335       0x000a
  39 #define PCI_DEVICE_ID_COMMTECH_2328PCI335       0x000b
  40 #define PCI_DEVICE_ID_COMMTECH_4224PCIE         0x0020
  41 #define PCI_DEVICE_ID_COMMTECH_4228PCIE         0x0021
  42 #define PCI_DEVICE_ID_COMMTECH_4222PCIE         0x0022
  43 #define PCI_DEVICE_ID_EXAR_XR17V4358            0x4358
  44 #define PCI_DEVICE_ID_EXAR_XR17V8358            0x8358
  45
  46 #define UART_EXAR_INT0          0x80
  47 #define UART_EXAR_8XMODE        0x88    /* 8X sampling rate select */
  48 #define UART_EXAR_SLEEP         0x8b    /* Sleep mode */
  49 #define UART_EXAR_DVID          0x8d    /* Device identification */
  50
  51 #define UART_EXAR_FCTR          0x08    /* Feature Control Register */
  52 #define UART_FCTR_EXAR_IRDA     0x10    /* IrDa data encode select */
  53 #define UART_FCTR_EXAR_485      0x20    /* Auto 485 half duplex dir ctl */
  54 #define UART_FCTR_EXAR_TRGA     0x00    /* FIFO trigger table A */
  55 #define UART_FCTR_EXAR_TRGB     0x60    /* FIFO trigger table B */
  56 #define UART_FCTR_EXAR_TRGC     0x80    /* FIFO trigger table C */
  57 #define UART_FCTR_EXAR_TRGD     0xc0    /* FIFO trigger table D programmable */
  58
  59 #define UART_EXAR_TXTRG         0x0a    /* Tx FIFO trigger level write-only */
  60 #define UART_EXAR_RXTRG         0x0b    /* Rx FIFO trigger level write-only */
  61
  62 #define UART_EXAR_MPIOINT_7_0   0x8f    /* MPIOINT[7:0] */
  63 #define UART_EXAR_MPIOLVL_7_0   0x90    /* MPIOLVL[7:0] */
  64 #define UART_EXAR_MPIO3T_7_0    0x91    /* MPIO3T[7:0] */
  65 #define UART_EXAR_MPIOINV_7_0   0x92    /* MPIOINV[7:0] */
  66 #define UART_EXAR_MPIOSEL_7_0   0x93    /* MPIOSEL[7:0] */
  67 #define UART_EXAR_MPIOOD_7_0    0x94    /* MPIOOD[7:0] */
  68 #define UART_EXAR_MPIOINT_15_8  0x95    /* MPIOINT[15:8] */
  69 #define UART_EXAR_MPIOLVL_15_8  0x96    /* MPIOLVL[15:8] */
  70 #define UART_EXAR_MPIO3T_15_8   0x97    /* MPIO3T[15:8] */
  71 #define UART_EXAR_MPIOINV_15_8  0x98    /* MPIOINV[15:8] */
  72 #define UART_EXAR_MPIOSEL_15_8  0x99    /* MPIOSEL[15:8] */
  73 #define UART_EXAR_MPIOOD_15_8   0x9a    /* MPIOOD[15:8] */
  74
  75 #define UART_EXAR_RS485_DLY(x)  ((x) << 4)
  76
  77 /*
  78  * IOT2040 MPIO wiring semantics:
  79  *
  80  * MPIO         Port    Function
  81  * ----         ----    --------
  82  * 0            2       Mode bit 0
  83  * 1            2       Mode bit 1
  84  * 2            2       Terminate bus
  85  * 3            -       <reserved>
  86  * 4            3       Mode bit 0
  87  * 5            3       Mode bit 1
  88  * 6            3       Terminate bus
  89  * 7            -       <reserved>
  90  * 8            2       Enable
  91  * 9            3       Enable
  92  * 10           -       Red LED
  93  * 11..15       -       <unused>
  94  */
  95
  96 /* IOT2040 MPIOs 0..7 */
  97 #define IOT2040_UART_MODE_RS232         0x01
  98 #define IOT2040_UART_MODE_RS485         0x02
  99 #define IOT2040_UART_MODE_RS422         0x03
 100 #define IOT2040_UART_TERMINATE_BUS      0x04
 101
 102 #define IOT2040_UART1_MASK              0x0f
 103 #define IOT2040_UART2_SHIFT             4
 104
 105 #define IOT2040_UARTS_DEFAULT_MODE      0x11    /* both RS232 */
 106 #define IOT2040_UARTS_GPIO_LO_MODE      0x88    /* reserved pins as input */
 107
 108 /* IOT2040 MPIOs 8..15 */
 109 #define IOT2040_UARTS_ENABLE            0x03
 110 #define IOT2040_UARTS_GPIO_HI_MODE      0xF8    /* enable & LED as outputs */
 111
 112 struct exar8250;
 113
 114 struct exar8250_platform {
 115         int (*rs485_config)(struct uart_port *, struct serial_rs485 *);
 116         int (*register_gpio)(struct pci_dev *, struct uart_8250_port *);
 117 };
 118
 119 /**
 120  * struct exar8250_board - board information
 121  * @num_ports: number of serial ports
 122  * @reg_shift: describes UART register mapping in PCI memory
 123  * @setup: quirk run at ->probe() stage
 124  * @exit: quirk run at ->remove() stage
 125  */
 126 struct exar8250_board {
 127         unsigned int num_ports;
 128         unsigned int reg_shift;
 129         int     (*setup)(struct exar8250 *, struct pci_dev *,
 130                          struct uart_8250_port *, int);
 131         void    (*exit)(struct pci_dev *pcidev);
 132 };
 133
 134 struct exar8250 {
 135         unsigned int            nr;
 136         struct exar8250_board   *board;
 137         void __iomem            *virt;
 138         int                     line[];
 139 };
 140
 141 static void exar_pm(struct uart_port *port, unsigned int state, unsigned int old)
 142 {
 143         /*
 144          * Exar UARTs have a SLEEP register that enables or disables each UART
 145          * to enter sleep mode separately. On the XR17V35x the register
 146          * is accessible to each UART at the UART_EXAR_SLEEP offset, but
 147          * the UART channel may only write to the corresponding bit.
 148          */
 149         serial_port_out(port, UART_EXAR_SLEEP, state ? 0xff : 0);
 150 }
 151
 152 /*
 153  * XR17V35x UARTs have an extra fractional divisor register (DLD)
 154  * Calculate divisor with extra 4-bit fractional portion
 155  */
 156 static unsigned int xr17v35x_get_divisor(struct uart_port *p, unsigned int baud,
 157                                          unsigned int *frac)
 158 {
 159         unsigned int quot_16;
 160
 161         quot_16 = DIV_ROUND_CLOSEST(p->uartclk, baud);
 162         *frac = quot_16 & 0x0f;
 163
 164         return quot_16 >> 4;
 165 }
 166
 167 static void xr17v35x_set_divisor(struct uart_port *p, unsigned int baud,
 168                                  unsigned int quot, unsigned int quot_frac)
 169 {
 170         serial8250_do_set_divisor(p, baud, quot, quot_frac);
 171
 172         /* Preserve bits not related to baudrate; DLD[7:4]. */
 173         quot_frac |= serial_port_in(p, 0x2) & 0xf0;
 174         serial_port_out(p, 0x2, quot_frac);
 175 }
 176
 177 static int xr17v35x_startup(struct uart_port *port)
 178 {
 179         /*
 180          * First enable access to IER [7:5], ISR [5:4], FCR [5:4],
 181          * MCR [7:5] and MSR [7:0]
 182          */
 183         serial_port_out(port, UART_XR_EFR, UART_EFR_ECB);
 184
 185         /*
 186          * Make sure all interrups are masked until initialization is
 187          * complete and the FIFOs are cleared
 188          */
 189         serial_port_out(port, UART_IER, 0);
 190
 191         return serial8250_do_startup(port);
 192 }
 193
 194 static void exar_shutdown(struct uart_port *port)
 195 {
 196         unsigned char lsr;
 197         bool tx_complete = false;
 198         struct uart_8250_port *up = up_to_u8250p(port);
 199         struct circ_buf *xmit = &port->state->xmit;
 200         int i = 0;
 201
 202         do {
 203                 lsr = serial_in(up, UART_LSR);
 204                 if (lsr & (UART_LSR_TEMT | UART_LSR_THRE))
 205                         tx_complete = true;
 206                 else
 207                         tx_complete = false;
 208                 usleep_range(1000, 1100);
 209         } while (!uart_circ_empty(xmit) && !tx_complete && i++ < 1000);
 210
 211         serial8250_do_shutdown(port);
 212 }
 213
 214 static int default_setup(struct exar8250 *priv, struct pci_dev *pcidev,
 215                          int idx, unsigned int offset,
 216                          struct uart_8250_port *port)
 217 {
 218         const struct exar8250_board *board = priv->board;
 219         unsigned int bar = 0;
 220         unsigned char status;
 221
 222         port->port.iotype = UPIO_MEM;
 223         port->port.mapbase = pci_resource_start(pcidev, bar) + offset;
 224         port->port.membase = priv->virt + offset;
 225         port->port.regshift = board->reg_shift;
 226
 227         /*
 228          * XR17V35x UARTs have an extra divisor register, DLD that gets enabled
 229          * with when DLAB is set which will cause the device to incorrectly match
 230          * and assign port type to PORT_16650. The EFR for this UART is found
 231          * at offset 0x09. Instead check the Deice ID (DVID) register
 232          * for a 2, 4 or 8 port UART.
 233          */
 234         status = readb(port->port.membase + UART_EXAR_DVID);
 235         if (status == 0x82 || status == 0x84 || status == 0x88) {
 236                 port->port.type = PORT_XR17V35X;
 237
 238                 port->port.get_divisor = xr17v35x_get_divisor;
 239                 port->port.set_divisor = xr17v35x_set_divisor;
 240
 241                 port->port.startup = xr17v35x_startup;
 242         } else {
 243                 port->port.type = PORT_XR17D15X;
 244         }
 245
 246         port->port.pm = exar_pm;
 247         port->port.shutdown = exar_shutdown;
 248
 249         return 0;
 250 }
 251
 252 static int
 253 pci_fastcom335_setup(struct exar8250 *priv, struct pci_dev *pcidev,
 254                      struct uart_8250_port *port, int idx)
 255 {
 256         unsigned int offset = idx * 0x200;
 257         unsigned int baud = 1843200;
 258         u8 __iomem *p;
 259         int err;
 260
 261         port->port.uartclk = baud * 16;
 262
 263         err = default_setup(priv, pcidev, idx, offset, port);
 264         if (err)
 265                 return err;
 266
 267         p = port->port.membase;
 268
 269         writeb(0x00, p + UART_EXAR_8XMODE);
 270         writeb(UART_FCTR_EXAR_TRGD, p + UART_EXAR_FCTR);
 271         writeb(32, p + UART_EXAR_TXTRG);
 272         writeb(32, p + UART_EXAR_RXTRG);
 273
 274         /*
 275          * Setup Multipurpose Input/Output pins.
 276          */
 277         if (idx == 0) {
 278                 switch (pcidev->device) {
 279                 case PCI_DEVICE_ID_COMMTECH_4222PCI335:
 280                 case PCI_DEVICE_ID_COMMTECH_4224PCI335:
 281                         writeb(0x78, p + UART_EXAR_MPIOLVL_7_0);
 282                         writeb(0x00, p + UART_EXAR_MPIOINV_7_0);
 283                         writeb(0x00, p + UART_EXAR_MPIOSEL_7_0);
 284                         break;
 285                 case PCI_DEVICE_ID_COMMTECH_2324PCI335:
 286                 case PCI_DEVICE_ID_COMMTECH_2328PCI335:
 287                         writeb(0x00, p + UART_EXAR_MPIOLVL_7_0);
 288                         writeb(0xc0, p + UART_EXAR_MPIOINV_7_0);
 289                         writeb(0xc0, p + UART_EXAR_MPIOSEL_7_0);
 290                         break;
 291                 }
 292                 writeb(0x00, p + UART_EXAR_MPIOINT_7_0);
 293                 writeb(0x00, p + UART_EXAR_MPIO3T_7_0);
 294                 writeb(0x00, p + UART_EXAR_MPIOOD_7_0);
 295         }
 296
 297         return 0;
 298 }
 299
 300 static int
 301 pci_connect_tech_setup(struct exar8250 *priv, struct pci_dev *pcidev,
 302                        struct uart_8250_port *port, int idx)
 303 {
 304         unsigned int offset = idx * 0x200;
 305         unsigned int baud = 1843200;
 306
 307         port->port.uartclk = baud * 16;
 308         return default_setup(priv, pcidev, idx, offset, port);
 309 }
 310
 311 static int
 312 pci_xr17c154_setup(struct exar8250 *priv, struct pci_dev *pcidev,
 313                    struct uart_8250_port *port, int idx)
 314 {
 315         unsigned int offset = idx * 0x200;
 316         unsigned int baud = 921600;
 317
 318         port->port.uartclk = baud * 16;
 319         return default_setup(priv, pcidev, idx, offset, port);
 320 }
 321
 322 static void setup_gpio(struct pci_dev *pcidev, u8 __iomem *p)
 323 {
 324         /*
 325          * The Commtech adapters required the MPIOs to be driven low. The Exar
 326          * devices will export them as GPIOs, so we pre-configure them safely
 327          * as inputs.
 328          */
 329
 330         u8 dir = 0x00;
 331
 332         if  ((pcidev->vendor == PCI_VENDOR_ID_EXAR) &&
 333                 (pcidev->subsystem_vendor != PCI_VENDOR_ID_SEALEVEL)) {
 334                 // Configure GPIO as inputs for Commtech adapters
 335                 dir = 0xff;
 336         } else {
 337                 // Configure GPIO as outputs for SeaLevel adapters
 338                 dir = 0x00;
 339         }
 340
 341         writeb(0x00, p + UART_EXAR_MPIOINT_7_0);
 342         writeb(0x00, p + UART_EXAR_MPIOLVL_7_0);
 343         writeb(0x00, p + UART_EXAR_MPIO3T_7_0);
 344         writeb(0x00, p + UART_EXAR_MPIOINV_7_0);
 345         writeb(dir,  p + UART_EXAR_MPIOSEL_7_0);
 346         writeb(0x00, p + UART_EXAR_MPIOOD_7_0);
 347         writeb(0x00, p + UART_EXAR_MPIOINT_15_8);
 348         writeb(0x00, p + UART_EXAR_MPIOLVL_15_8);
 349         writeb(0x00, p + UART_EXAR_MPIO3T_15_8);
 350         writeb(0x00, p + UART_EXAR_MPIOINV_15_8);
 351         writeb(dir,  p + UART_EXAR_MPIOSEL_15_8);
 352         writeb(0x00, p + UART_EXAR_MPIOOD_15_8);
 353 }
 354
 355 static void *
 356 __xr17v35x_register_gpio(struct pci_dev *pcidev,
 357                          const struct software_node *node)
 358 {
 359         struct platform_device *pdev;
 360
 361         pdev = platform_device_alloc("gpio_exar", PLATFORM_DEVID_AUTO);
 362         if (!pdev)
 363                 return NULL;
 364
 365         pdev->dev.parent = &pcidev->dev;
 366         ACPI_COMPANION_SET(&pdev->dev, ACPI_COMPANION(&pcidev->dev));
 367
 368         if (device_add_software_node(&pdev->dev, node) < 0 ||
 369             platform_device_add(pdev) < 0) {
 370                 platform_device_put(pdev);
 371                 return NULL;
 372         }
 373
 374         return pdev;
 375 }
 376
 377 static const struct property_entry exar_gpio_properties[] = {
 378         PROPERTY_ENTRY_U32("exar,first-pin", 0),
 379         PROPERTY_ENTRY_U32("ngpios", 16),
 380         { }
 381 };
 382
 383 static const struct software_node exar_gpio_node = {
 384         .properties = exar_gpio_properties,
 385 };
 386
 387 static int xr17v35x_register_gpio(struct pci_dev *pcidev,
 388                                   struct uart_8250_port *port)
 389 {
 390         if (pcidev->vendor == PCI_VENDOR_ID_EXAR)
 391                 port->port.private_data =
 392                         __xr17v35x_register_gpio(pcidev, &exar_gpio_node);
 393
 394         return 0;
 395 }
 396
 397 static int generic_rs485_config(struct uart_port *port,
 398                                 struct serial_rs485 *rs485)
 399 {
 400         bool is_rs485 = !!(rs485->flags & SER_RS485_ENABLED);
 401         u8 __iomem *p = port->membase;
 402         u8 value;
 403
 404         value = readb(p + UART_EXAR_FCTR);
 405         if (is_rs485)
 406                 value |= UART_FCTR_EXAR_485;
 407         else
 408                 value &= ~UART_FCTR_EXAR_485;
 409
 410         writeb(value, p + UART_EXAR_FCTR);
 411
 412         if (is_rs485)
 413                 writeb(UART_EXAR_RS485_DLY(4), p + UART_MSR);
 414
 415         port->rs485 = *rs485;
 416
 417         return 0;
 418 }
 419
 420 static const struct exar8250_platform exar8250_default_platform = {
 421         .register_gpio = xr17v35x_register_gpio,
 422         .rs485_config = generic_rs485_config,
 423 };
 424
 425 static int iot2040_rs485_config(struct uart_port *port,
 426                                 struct serial_rs485 *rs485)
 427 {
 428         bool is_rs485 = !!(rs485->flags & SER_RS485_ENABLED);
 429         u8 __iomem *p = port->membase;
 430         u8 mask = IOT2040_UART1_MASK;
 431         u8 mode, value;
 432
 433         if (is_rs485) {
 434                 if (rs485->flags & SER_RS485_RX_DURING_TX)
 435                         mode = IOT2040_UART_MODE_RS422;
 436                 else
 437                         mode = IOT2040_UART_MODE_RS485;
 438
 439                 if (rs485->flags & SER_RS485_TERMINATE_BUS)
 440                         mode |= IOT2040_UART_TERMINATE_BUS;
 441         } else {
 442                 mode = IOT2040_UART_MODE_RS232;
 443         }
 444
 445         if (port->line == 3) {
 446                 mask <<= IOT2040_UART2_SHIFT;
 447                 mode <<= IOT2040_UART2_SHIFT;
 448         }
 449
 450         value = readb(p + UART_EXAR_MPIOLVL_7_0);
 451         value &= ~mask;
 452         value |= mode;
 453         writeb(value, p + UART_EXAR_MPIOLVL_7_0);
 454
 455         return generic_rs485_config(port, rs485);
 456 }
 457
 458 static const struct property_entry iot2040_gpio_properties[] = {
 459         PROPERTY_ENTRY_U32("exar,first-pin", 10),
 460         PROPERTY_ENTRY_U32("ngpios", 1),
 461         { }
 462 };
 463
 464 static const struct software_node iot2040_gpio_node = {
 465         .properties = iot2040_gpio_properties,
 466 };
 467
 468 static int iot2040_register_gpio(struct pci_dev *pcidev,
 469                               struct uart_8250_port *port)
 470 {
 471         u8 __iomem *p = port->port.membase;
 472
 473         writeb(IOT2040_UARTS_DEFAULT_MODE, p + UART_EXAR_MPIOLVL_7_0);
 474         writeb(IOT2040_UARTS_GPIO_LO_MODE, p + UART_EXAR_MPIOSEL_7_0);
 475         writeb(IOT2040_UARTS_ENABLE, p + UART_EXAR_MPIOLVL_15_8);
 476         writeb(IOT2040_UARTS_GPIO_HI_MODE, p + UART_EXAR_MPIOSEL_15_8);
 477
 478         port->port.private_data =
 479                 __xr17v35x_register_gpio(pcidev, &iot2040_gpio_node);
 480
 481         return 0;
 482 }
 483
 484 static const struct exar8250_platform iot2040_platform = {
 485         .rs485_config = iot2040_rs485_config,
 486         .register_gpio = iot2040_register_gpio,
 487 };
 488
 489 /*
 490  * For SIMATIC IOT2000, only IOT2040 and its variants have the Exar device,
 491  * IOT2020 doesn't have. Therefore it is sufficient to match on the common
 492  * board name after the device was found.
 493  */
 494 static const struct dmi_system_id exar_platforms[] = {
 495         {
 496                 .matches = {
 497                         DMI_EXACT_MATCH(DMI_BOARD_NAME, "SIMATIC IOT2000"),
 498                 },
 499                 .driver_data = (void *)&iot2040_platform,
 500         },
 501         {}
 502 };
 503
 504 static int
 505 pci_xr17v35x_setup(struct exar8250 *priv, struct pci_dev *pcidev,
 506                    struct uart_8250_port *port, int idx)
 507 {
 508         const struct exar8250_platform *platform;
 509         const struct dmi_system_id *dmi_match;
 510         unsigned int offset = idx * 0x400;
 511         unsigned int baud = 7812500;
 512         u8 __iomem *p;
 513         int ret;
 514
 515         dmi_match = dmi_first_match(exar_platforms);
 516         if (dmi_match)
 517                 platform = dmi_match->driver_data;
 518         else
 519                 platform = &exar8250_default_platform;
 520
 521         port->port.uartclk = baud * 16;
 522         port->port.rs485_config = platform->rs485_config;
 523
 524         /*
 525          * Setup the UART clock for the devices on expansion slot to
 526          * half the clock speed of the main chip (which is 125MHz)
 527          */
 528         if (idx >= 8)
 529                 port->port.uartclk /= 2;
 530
 531         ret = default_setup(priv, pcidev, idx, offset, port);
 532         if (ret)
 533                 return ret;
 534
 535         p = port->port.membase;
 536
 537         writeb(0x00, p + UART_EXAR_8XMODE);
 538         writeb(UART_FCTR_EXAR_TRGD, p + UART_EXAR_FCTR);
 539         writeb(128, p + UART_EXAR_TXTRG);
 540         writeb(128, p + UART_EXAR_RXTRG);
 541
 542         if (idx == 0) {
 543                 /* Setup Multipurpose Input/Output pins. */
 544                 setup_gpio(pcidev, p);
 545
 546                 ret = platform->register_gpio(pcidev, port);
 547         }
 548
 549         return ret;
 550 }
 551
 552 static void pci_xr17v35x_exit(struct pci_dev *pcidev)
 553 {
 554         struct exar8250 *priv = pci_get_drvdata(pcidev);
 555         struct uart_8250_port *port = serial8250_get_port(priv->line[0]);
 556         struct platform_device *pdev = port->port.private_data;
 557
 558         device_remove_software_node(&pdev->dev);
 559         platform_device_unregister(pdev);
 560         port->port.private_data = NULL;
 561 }
 562
 563 static inline void exar_misc_clear(struct exar8250 *priv)
 564 {
 565         /* Clear all PCI interrupts by reading INT0. No effect on IIR */
 566         readb(priv->virt + UART_EXAR_INT0);
 567
 568         /* Clear INT0 for Expansion Interface slave ports, too */
 569         if (priv->board->num_ports > 8)
 570                 readb(priv->virt + 0x2000 + UART_EXAR_INT0);
 571 }
 572
 573 /*
 574  * These Exar UARTs have an extra interrupt indicator that could fire for a
 575  * few interrupts that are not presented/cleared through IIR.  One of which is
 576  * a wakeup interrupt when coming out of sleep.  These interrupts are only
 577  * cleared by reading global INT0 or INT1 registers as interrupts are
 578  * associated with channel 0. The INT[3:0] registers _are_ accessible from each
 579  * channel's address space, but for the sake of bus efficiency we register a
 580  * dedicated handler at the PCI device level to handle them.
 581  */
 582 static irqreturn_t exar_misc_handler(int irq, void *data)
 583 {
 584         exar_misc_clear(data);
 585
 586         return IRQ_HANDLED;
 587 }
 588
 589 static int
 590 exar_pci_probe(struct pci_dev *pcidev, const struct pci_device_id *ent)
 591 {
 592         unsigned int nr_ports, i, bar = 0, maxnr;
 593         struct exar8250_board *board;
 594         struct uart_8250_port uart;
 595         struct exar8250 *priv;
 596         int rc;
 597
 598         board = (struct exar8250_board *)ent->driver_data;
 599         if (!board)
 600                 return -EINVAL;
 601
 602         rc = pcim_enable_device(pcidev);
 603         if (rc)
 604                 return rc;
 605
 606         maxnr = pci_resource_len(pcidev, bar) >> (board->reg_shift + 3);
 607
 608         nr_ports = board->num_ports ? board->num_ports : pcidev->device & 0x0f;
 609
 610         priv = devm_kzalloc(&pcidev->dev, struct_size(priv, line, nr_ports), GFP_KERNEL);
 611         if (!priv)
 612                 return -ENOMEM;
 613
 614         priv->board = board;
 615         priv->virt = pcim_iomap(pcidev, bar, 0);
 616         if (!priv->virt)
 617                 return -ENOMEM;
 618
 619         pci_set_master(pcidev);
 620
 621         rc = pci_alloc_irq_vectors(pcidev, 1, 1, PCI_IRQ_ALL_TYPES);
 622         if (rc < 0)
 623                 return rc;
 624
 625         memset(&uart, 0, sizeof(uart));
 626         uart.port.flags = UPF_SHARE_IRQ | UPF_EXAR_EFR | UPF_FIXED_TYPE | UPF_FIXED_PORT;
 627         uart.port.irq = pci_irq_vector(pcidev, 0);
 628         uart.port.dev = &pcidev->dev;
 629
 630         rc = devm_request_irq(&pcidev->dev, uart.port.irq, exar_misc_handler,
 631                          IRQF_SHARED, "exar_uart", priv);
 632         if (rc)
 633                 return rc;
 634
 635         /* Clear interrupts */
 636         exar_misc_clear(priv);
 637
 638         for (i = 0; i < nr_ports && i < maxnr; i++) {
 639                 rc = board->setup(priv, pcidev, &uart, i);
 640                 if (rc) {
 641                         dev_err(&pcidev->dev, "Failed to setup port %u\n", i);
 642                         break;
 643                 }
 644
 645                 dev_dbg(&pcidev->dev, "Setup PCI port: port %lx, irq %d, type %d\n",
 646                         uart.port.iobase, uart.port.irq, uart.port.iotype);
 647
 648                 priv->line[i] = serial8250_register_8250_port(&uart);
 649                 if (priv->line[i] < 0) {
 650                         dev_err(&pcidev->dev,
 651                                 "Couldn't register serial port %lx, irq %d, type %d, error %d\n",
 652                                 uart.port.iobase, uart.port.irq,
 653                                 uart.port.iotype, priv->line[i]);
 654                         break;
 655                 }
 656         }
 657         priv->nr = i;
 658         pci_set_drvdata(pcidev, priv);
 659         return 0;
 660 }
 661
 662 static void exar_pci_remove(struct pci_dev *pcidev)
 663 {
 664         struct exar8250 *priv = pci_get_drvdata(pcidev);
 665         unsigned int i;
 666
 667         for (i = 0; i < priv->nr; i++)
 668                 serial8250_unregister_port(priv->line[i]);
 669
 670         if (priv->board->exit)
 671                 priv->board->exit(pcidev);
 672 }
 673
 674 static int __maybe_unused exar_suspend(struct device *dev)
 675 {
 676         struct pci_dev *pcidev = to_pci_dev(dev);
 677         struct exar8250 *priv = pci_get_drvdata(pcidev);
 678         unsigned int i;
 679
 680         for (i = 0; i < priv->nr; i++)
 681                 if (priv->line[i] >= 0)
 682                         serial8250_suspend_port(priv->line[i]);
 683
 684         /* Ensure that every init quirk is properly torn down */
 685         if (priv->board->exit)
 686                 priv->board->exit(pcidev);
 687
 688         return 0;
 689 }
 690
 691 static int __maybe_unused exar_resume(struct device *dev)
 692 {
 693         struct exar8250 *priv = dev_get_drvdata(dev);
 694         unsigned int i;
 695
 696         exar_misc_clear(priv);
 697
 698         for (i = 0; i < priv->nr; i++)
 699                 if (priv->line[i] >= 0)
 700                         serial8250_resume_port(priv->line[i]);
 701
 702         return 0;
 703 }
 704
 705 static SIMPLE_DEV_PM_OPS(exar_pci_pm, exar_suspend, exar_resume);
 706
 707 static const struct exar8250_board acces_com_2x = {
 708         .num_ports      = 2,
 709         .setup          = pci_xr17c154_setup,
 710 };
 711
 712 static const struct exar8250_board acces_com_4x = {
 713         .num_ports      = 4,
 714         .setup          = pci_xr17c154_setup,
 715 };
 716
 717 static const struct exar8250_board acces_com_8x = {
 718         .num_ports      = 8,
 719         .setup          = pci_xr17c154_setup,
 720 };
 721
 722
 723 static const struct exar8250_board pbn_fastcom335_2 = {
 724         .num_ports      = 2,
 725         .setup          = pci_fastcom335_setup,
 726 };
 727
 728 static const struct exar8250_board pbn_fastcom335_4 = {
 729         .num_ports      = 4,
 730         .setup          = pci_fastcom335_setup,
 731 };
 732
 733 static const struct exar8250_board pbn_fastcom335_8 = {
 734         .num_ports      = 8,
 735         .setup          = pci_fastcom335_setup,
 736 };
 737
 738 static const struct exar8250_board pbn_connect = {
 739         .setup          = pci_connect_tech_setup,
 740 };
 741
 742 static const struct exar8250_board pbn_exar_ibm_saturn = {
 743         .num_ports      = 1,
 744         .setup          = pci_xr17c154_setup,
 745 };
 746
 747 static const struct exar8250_board pbn_exar_XR17C15x = {
 748         .setup          = pci_xr17c154_setup,
 749 };
 750
 751 static const struct exar8250_board pbn_exar_XR17V35x = {
 752         .setup          = pci_xr17v35x_setup,
 753         .exit           = pci_xr17v35x_exit,
 754 };
 755
 756 static const struct exar8250_board pbn_fastcom35x_2 = {
 757         .num_ports      = 2,
 758         .setup          = pci_xr17v35x_setup,
 759         .exit           = pci_xr17v35x_exit,
 760 };
 761
 762 static const struct exar8250_board pbn_fastcom35x_4 = {
 763         .num_ports      = 4,
 764         .setup          = pci_xr17v35x_setup,
 765         .exit           = pci_xr17v35x_exit,
 766 };
 767
 768 static const struct exar8250_board pbn_fastcom35x_8 = {
 769         .num_ports      = 8,
 770         .setup          = pci_xr17v35x_setup,
 771         .exit           = pci_xr17v35x_exit,
 772 };
 773
 774 static const struct exar8250_board pbn_exar_XR17V4358 = {
 775         .num_ports      = 12,
 776         .setup          = pci_xr17v35x_setup,
 777         .exit           = pci_xr17v35x_exit,
 778 };
 779
 780 static const struct exar8250_board pbn_exar_XR17V8358 = {
 781         .num_ports      = 16,
 782         .setup          = pci_xr17v35x_setup,
 783         .exit           = pci_xr17v35x_exit,
 784 };
 785
 786 #define CONNECT_DEVICE(devid, sdevid, bd) {                             \
 787         PCI_DEVICE_SUB(                                                 \
 788                 PCI_VENDOR_ID_EXAR,                                     \
 789                 PCI_DEVICE_ID_EXAR_##devid,                             \
 790                 PCI_SUBVENDOR_ID_CONNECT_TECH,                          \
 791                 PCI_SUBDEVICE_ID_CONNECT_TECH_PCI_##sdevid), 0, 0,      \
 792                 (kernel_ulong_t)&bd                                     \
 793         }
 794
 795 #define EXAR_DEVICE(vend, devid, bd) { PCI_DEVICE_DATA(vend, devid, &bd) }
 796
 797 #define IBM_DEVICE(devid, sdevid, bd) {                 \
 798         PCI_DEVICE_SUB(                                 \
 799                 PCI_VENDOR_ID_EXAR,                     \
 800                 PCI_DEVICE_ID_EXAR_##devid,             \
 801                 PCI_VENDOR_ID_IBM,                      \
 802                 PCI_SUBDEVICE_ID_IBM_##sdevid), 0, 0,   \
 803                 (kernel_ulong_t)&bd                     \
 804         }
 805
 806 static const struct pci_device_id exar_pci_tbl[] = {
 807         EXAR_DEVICE(ACCESSIO, COM_2S, acces_com_2x),
 808         EXAR_DEVICE(ACCESSIO, COM_4S, acces_com_4x),
 809         EXAR_DEVICE(ACCESSIO, COM_8S, acces_com_8x),
 810         EXAR_DEVICE(ACCESSIO, COM232_8, acces_com_8x),
 811         EXAR_DEVICE(ACCESSIO, COM_2SM, acces_com_2x),
 812         EXAR_DEVICE(ACCESSIO, COM_4SM, acces_com_4x),
 813         EXAR_DEVICE(ACCESSIO, COM_8SM, acces_com_8x),
 814
 815         CONNECT_DEVICE(XR17C152, UART_2_232, pbn_connect),
 816         CONNECT_DEVICE(XR17C154, UART_4_232, pbn_connect),
 817         CONNECT_DEVICE(XR17C158, UART_8_232, pbn_connect),
 818         CONNECT_DEVICE(XR17C152, UART_1_1, pbn_connect),
 819         CONNECT_DEVICE(XR17C154, UART_2_2, pbn_connect),
 820         CONNECT_DEVICE(XR17C158, UART_4_4, pbn_connect),
 821         CONNECT_DEVICE(XR17C152, UART_2, pbn_connect),
 822         CONNECT_DEVICE(XR17C154, UART_4, pbn_connect),
 823         CONNECT_DEVICE(XR17C158, UART_8, pbn_connect),
 824         CONNECT_DEVICE(XR17C152, UART_2_485, pbn_connect),
 825         CONNECT_DEVICE(XR17C154, UART_4_485, pbn_connect),
 826         CONNECT_DEVICE(XR17C158, UART_8_485, pbn_connect),
 827
 828         IBM_DEVICE(XR17C152, SATURN_SERIAL_ONE_PORT, pbn_exar_ibm_saturn),
 829
 830         /* Exar Corp. XR17C15[248] Dual/Quad/Octal UART */
 831         EXAR_DEVICE(EXAR, XR17C152, pbn_exar_XR17C15x),
 832         EXAR_DEVICE(EXAR, XR17C154, pbn_exar_XR17C15x),
 833         EXAR_DEVICE(EXAR, XR17C158, pbn_exar_XR17C15x),
 834
 835         /* Exar Corp. XR17V[48]35[248] Dual/Quad/Octal/Hexa PCIe UARTs */
 836         EXAR_DEVICE(EXAR, XR17V352, pbn_exar_XR17V35x),
 837         EXAR_DEVICE(EXAR, XR17V354, pbn_exar_XR17V35x),
 838         EXAR_DEVICE(EXAR, XR17V358, pbn_exar_XR17V35x),
 839         EXAR_DEVICE(EXAR, XR17V4358, pbn_exar_XR17V4358),
 840         EXAR_DEVICE(EXAR, XR17V8358, pbn_exar_XR17V8358),
 841         EXAR_DEVICE(COMMTECH, 4222PCIE, pbn_fastcom35x_2),
 842         EXAR_DEVICE(COMMTECH, 4224PCIE, pbn_fastcom35x_4),
 843         EXAR_DEVICE(COMMTECH, 4228PCIE, pbn_fastcom35x_8),
 844
 845         EXAR_DEVICE(COMMTECH, 4222PCI335, pbn_fastcom335_2),
 846         EXAR_DEVICE(COMMTECH, 4224PCI335, pbn_fastcom335_4),
 847         EXAR_DEVICE(COMMTECH, 2324PCI335, pbn_fastcom335_4),
 848         EXAR_DEVICE(COMMTECH, 2328PCI335, pbn_fastcom335_8),
 849         { 0, }
 850 };
 851 MODULE_DEVICE_TABLE(pci, exar_pci_tbl);
 852
 853 static struct pci_driver exar_pci_driver = {
 854         .name           = "exar_serial",
 855         .probe          = exar_pci_probe,
 856         .remove         = exar_pci_remove,
 857         .driver         = {
 858                 .pm     = &exar_pci_pm,
 859         },
 860         .id_table       = exar_pci_tbl,
 861 };
 862 module_pci_driver(exar_pci_driver);
 863
 864 MODULE_LICENSE("GPL");
 865 MODULE_DESCRIPTION("Exar Serial Driver");
 866 MODULE_AUTHOR("Sudip Mukherjee <sudip.mukherjee@codethink.co.uk>");