drivers/tty/serial/8250_pnp.c

   1 /*
   2  *  Probe module for 8250/16550-type ISAPNP serial ports.
   3  *
   4  *  Based on drivers/char/serial.c, by Linus Torvalds, Theodore Ts'o.
   5  *
   6  *  Copyright (C) 2001 Russell King, All Rights Reserved.
   7  *
   8  *  Ported to the Linux PnP Layer - (C) Adam Belay.
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License.
  13  */
  14 #include <linux/module.h>
  15 #include <linux/init.h>
  16 #include <linux/pci.h>
  17 #include <linux/pnp.h>
  18 #include <linux/string.h>
  19 #include <linux/kernel.h>
  20 #include <linux/serial_core.h>
  21 #include <linux/bitops.h>
  22
  23 #include <asm/byteorder.h>
  24
  25 #include "8250.h"
  26
  27 #define UNKNOWN_DEV 0x3000
  28
  29
  30 static const struct pnp_device_id pnp_dev_table[] = {
  31         /* Archtek America Corp. */
  32         /* Archtek SmartLink Modem 3334BT Plug & Play */
  33         {       "AAC000F",              0       },
  34         /* Anchor Datacomm BV */
  35         /* SXPro 144 External Data Fax Modem Plug & Play */
  36         {       "ADC0001",              0       },
  37         /* SXPro 288 External Data Fax Modem Plug & Play */
  38         {       "ADC0002",              0       },
  39         /* PROLiNK 1456VH ISA PnP K56flex Fax Modem */
  40         {       "AEI0250",              0       },
  41         /* Actiontec ISA PNP 56K X2 Fax Modem */
  42         {       "AEI1240",              0       },
  43         /* Rockwell 56K ACF II Fax+Data+Voice Modem */
  44         {       "AKY1021",              0 /*SPCI_FL_NO_SHIRQ*/  },
  45         /*
  46          * ALi Fast Infrared Controller
  47          * Native driver (ali-ircc) is broken so at least
  48          * it can be used with irtty-sir.
  49          */
  50         {       "ALI5123",              0       },
  51         /* AZT3005 PnP SOUND DEVICE */
  52         {       "AZT4001",              0       },
  53         /* Best Data Products Inc. Smart One 336F PnP Modem */
  54         {       "BDP3336",              0       },
  55         /*  Boca Research */
  56         /* Boca Complete Ofc Communicator 14.4 Data-FAX */
  57         {       "BRI0A49",              0       },
  58         /* Boca Research 33,600 ACF Modem */
  59         {       "BRI1400",              0       },
  60         /* Boca 33.6 Kbps Internal FD34FSVD */
  61         {       "BRI3400",              0       },
  62         /* Boca 33.6 Kbps Internal FD34FSVD */
  63         {       "BRI0A49",              0       },
  64         /* Best Data Products Inc. Smart One 336F PnP Modem */
  65         {       "BDP3336",              0       },
  66         /* Computer Peripherals Inc */
  67         /* EuroViVa CommCenter-33.6 SP PnP */
  68         {       "CPI4050",              0       },
  69         /* Creative Labs */
  70         /* Creative Labs Phone Blaster 28.8 DSVD PnP Voice */
  71         {       "CTL3001",              0       },
  72         /* Creative Labs Modem Blaster 28.8 DSVD PnP Voice */
  73         {       "CTL3011",              0       },
  74         /* Davicom ISA 33.6K Modem */
  75         {       "DAV0336",              0       },
  76         /* Creative */
  77         /* Creative Modem Blaster Flash56 DI5601-1 */
  78         {       "DMB1032",              0       },
  79         /* Creative Modem Blaster V.90 DI5660 */
  80         {       "DMB2001",              0       },
  81         /* E-Tech */
  82         /* E-Tech CyberBULLET PC56RVP */
  83         {       "ETT0002",              0       },
  84         /* FUJITSU */
  85         /* Fujitsu 33600 PnP-I2 R Plug & Play */
  86         {       "FUJ0202",              0       },
  87         /* Fujitsu FMV-FX431 Plug & Play */
  88         {       "FUJ0205",              0       },
  89         /* Fujitsu 33600 PnP-I4 R Plug & Play */
  90         {       "FUJ0206",              0       },
  91         /* Fujitsu Fax Voice 33600 PNP-I5 R Plug & Play */
  92         {       "FUJ0209",              0       },
  93         /* Archtek America Corp. */
  94         /* Archtek SmartLink Modem 3334BT Plug & Play */
  95         {       "GVC000F",              0       },
  96         /* Archtek SmartLink Modem 3334BRV 33.6K Data Fax Voice */
  97         {       "GVC0303",              0       },
  98         /* Hayes */
  99         /* Hayes Optima 288 V.34-V.FC + FAX + Voice Plug & Play */
 100         {       "HAY0001",              0       },
 101         /* Hayes Optima 336 V.34 + FAX + Voice PnP */
 102         {       "HAY000C",              0       },
 103         /* Hayes Optima 336B V.34 + FAX + Voice PnP */
 104         {       "HAY000D",              0       },
 105         /* Hayes Accura 56K Ext Fax Modem PnP */
 106         {       "HAY5670",              0       },
 107         /* Hayes Accura 56K Ext Fax Modem PnP */
 108         {       "HAY5674",              0       },
 109         /* Hayes Accura 56K Fax Modem PnP */
 110         {       "HAY5675",              0       },
 111         /* Hayes 288, V.34 + FAX */
 112         {       "HAYF000",              0       },
 113         /* Hayes Optima 288 V.34 + FAX + Voice, Plug & Play */
 114         {       "HAYF001",              0       },
 115         /* IBM */
 116         /* IBM Thinkpad 701 Internal Modem Voice */
 117         {       "IBM0033",              0       },
 118         /* Intermec */
 119         /* Intermec CV60 touchscreen port */
 120         {       "PNP4972",              0       },
 121         /* Intertex */
 122         /* Intertex 28k8 33k6 Voice EXT PnP */
 123         {       "IXDC801",              0       },
 124         /* Intertex 33k6 56k Voice EXT PnP */
 125         {       "IXDC901",              0       },
 126         /* Intertex 28k8 33k6 Voice SP EXT PnP */
 127         {       "IXDD801",              0       },
 128         /* Intertex 33k6 56k Voice SP EXT PnP */
 129         {       "IXDD901",              0       },
 130         /* Intertex 28k8 33k6 Voice SP INT PnP */
 131         {       "IXDF401",              0       },
 132         /* Intertex 28k8 33k6 Voice SP EXT PnP */
 133         {       "IXDF801",              0       },
 134         /* Intertex 33k6 56k Voice SP EXT PnP */
 135         {       "IXDF901",              0       },
 136         /* Kortex International */
 137         /* KORTEX 28800 Externe PnP */
 138         {       "KOR4522",              0       },
 139         /* KXPro 33.6 Vocal ASVD PnP */
 140         {       "KORF661",              0       },
 141         /* Lasat */
 142         /* LASAT Internet 33600 PnP */
 143         {       "LAS4040",              0       },
 144         /* Lasat Safire 560 PnP */
 145         {       "LAS4540",              0       },
 146         /* Lasat Safire 336  PnP */
 147         {       "LAS5440",              0       },
 148         /* Microcom, Inc. */
 149         /* Microcom TravelPorte FAST V.34 Plug & Play */
 150         {       "MNP0281",              0       },
 151         /* Microcom DeskPorte V.34 FAST or FAST+ Plug & Play */
 152         {       "MNP0336",              0       },
 153         /* Microcom DeskPorte FAST EP 28.8 Plug & Play */
 154         {       "MNP0339",              0       },
 155         /* Microcom DeskPorte 28.8P Plug & Play */
 156         {       "MNP0342",              0       },
 157         /* Microcom DeskPorte FAST ES 28.8 Plug & Play */
 158         {       "MNP0500",              0       },
 159         /* Microcom DeskPorte FAST ES 28.8 Plug & Play */
 160         {       "MNP0501",              0       },
 161         /* Microcom DeskPorte 28.8S Internal Plug & Play */
 162         {       "MNP0502",              0       },
 163         /* Motorola */
 164         /* Motorola BitSURFR Plug & Play */
 165         {       "MOT1105",              0       },
 166         /* Motorola TA210 Plug & Play */
 167         {       "MOT1111",              0       },
 168         /* Motorola HMTA 200 (ISDN) Plug & Play */
 169         {       "MOT1114",              0       },
 170         /* Motorola BitSURFR Plug & Play */
 171         {       "MOT1115",              0       },
 172         /* Motorola Lifestyle 28.8 Internal */
 173         {       "MOT1190",              0       },
 174         /* Motorola V.3400 Plug & Play */
 175         {       "MOT1501",              0       },
 176         /* Motorola Lifestyle 28.8 V.34 Plug & Play */
 177         {       "MOT1502",              0       },
 178         /* Motorola Power 28.8 V.34 Plug & Play */
 179         {       "MOT1505",              0       },
 180         /* Motorola ModemSURFR External 28.8 Plug & Play */
 181         {       "MOT1509",              0       },
 182         /* Motorola Premier 33.6 Desktop Plug & Play */
 183         {       "MOT150A",              0       },
 184         /* Motorola VoiceSURFR 56K External PnP */
 185         {       "MOT150F",              0       },
 186         /* Motorola ModemSURFR 56K External PnP */
 187         {       "MOT1510",              0       },
 188         /* Motorola ModemSURFR 56K Internal PnP */
 189         {       "MOT1550",              0       },
 190         /* Motorola ModemSURFR Internal 28.8 Plug & Play */
 191         {       "MOT1560",              0       },
 192         /* Motorola Premier 33.6 Internal Plug & Play */
 193         {       "MOT1580",              0       },
 194         /* Motorola OnlineSURFR 28.8 Internal Plug & Play */
 195         {       "MOT15B0",              0       },
 196         /* Motorola VoiceSURFR 56K Internal PnP */
 197         {       "MOT15F0",              0       },
 198         /* Com 1 */
 199         /*  Deskline K56 Phone System PnP */
 200         {       "MVX00A1",              0       },
 201         /* PC Rider K56 Phone System PnP */
 202         {       "MVX00F2",              0       },
 203         /* NEC 98NOTE SPEAKER PHONE FAX MODEM(33600bps) */
 204         {       "nEC8241",              0       },
 205         /* Pace 56 Voice Internal Plug & Play Modem */
 206         {       "PMC2430",              0       },
 207         /* Generic */
 208         /* Generic standard PC COM port  */
 209         {       "PNP0500",              0       },
 210         /* Generic 16550A-compatible COM port */
 211         {       "PNP0501",              0       },
 212         /* Compaq 14400 Modem */
 213         {       "PNPC000",              0       },
 214         /* Compaq 2400/9600 Modem */
 215         {       "PNPC001",              0       },
 216         /* Dial-Up Networking Serial Cable between 2 PCs */
 217         {       "PNPC031",              0       },
 218         /* Dial-Up Networking Parallel Cable between 2 PCs */
 219         {       "PNPC032",              0       },
 220         /* Standard 9600 bps Modem */
 221         {       "PNPC100",              0       },
 222         /* Standard 14400 bps Modem */
 223         {       "PNPC101",              0       },
 224         /*  Standard 28800 bps Modem*/
 225         {       "PNPC102",              0       },
 226         /*  Standard Modem*/
 227         {       "PNPC103",              0       },
 228         /*  Standard 9600 bps Modem*/
 229         {       "PNPC104",              0       },
 230         /*  Standard 14400 bps Modem*/
 231         {       "PNPC105",              0       },
 232         /*  Standard 28800 bps Modem*/
 233         {       "PNPC106",              0       },
 234         /*  Standard Modem */
 235         {       "PNPC107",              0       },
 236         /* Standard 9600 bps Modem */
 237         {       "PNPC108",              0       },
 238         /* Standard 14400 bps Modem */
 239         {       "PNPC109",              0       },
 240         /* Standard 28800 bps Modem */
 241         {       "PNPC10A",              0       },
 242         /* Standard Modem */
 243         {       "PNPC10B",              0       },
 244         /* Standard 9600 bps Modem */
 245         {       "PNPC10C",              0       },
 246         /* Standard 14400 bps Modem */
 247         {       "PNPC10D",              0       },
 248         /* Standard 28800 bps Modem */
 249         {       "PNPC10E",              0       },
 250         /* Standard Modem */
 251         {       "PNPC10F",              0       },
 252         /* Standard PCMCIA Card Modem */
 253         {       "PNP2000",              0       },
 254         /* Rockwell */
 255         /* Modular Technology */
 256         /* Rockwell 33.6 DPF Internal PnP */
 257         /* Modular Technology 33.6 Internal PnP */
 258         {       "ROK0030",              0       },
 259         /* Kortex International */
 260         /* KORTEX 14400 Externe PnP */
 261         {       "ROK0100",              0       },
 262         /* Rockwell 28.8 */
 263         {       "ROK4120",              0       },
 264         /* Viking Components, Inc */
 265         /* Viking 28.8 INTERNAL Fax+Data+Voice PnP */
 266         {       "ROK4920",              0       },
 267         /* Rockwell */
 268         /* British Telecom */
 269         /* Modular Technology */
 270         /* Rockwell 33.6 DPF External PnP */
 271         /* BT Prologue 33.6 External PnP */
 272         /* Modular Technology 33.6 External PnP */
 273         {       "RSS00A0",              0       },
 274         /* Viking 56K FAX INT */
 275         {       "RSS0262",              0       },
 276         /* K56 par,VV,Voice,Speakphone,AudioSpan,PnP */
 277         {       "RSS0250",              0       },
 278         /* SupraExpress 28.8 Data/Fax PnP modem */
 279         {       "SUP1310",              0       },
 280         /* SupraExpress 336i PnP Voice Modem */
 281         {       "SUP1381",              0       },
 282         /* SupraExpress 33.6 Data/Fax PnP modem */
 283         {       "SUP1421",              0       },
 284         /* SupraExpress 33.6 Data/Fax PnP modem */
 285         {       "SUP1590",              0       },
 286         /* SupraExpress 336i Sp ASVD */
 287         {       "SUP1620",              0       },
 288         /* SupraExpress 33.6 Data/Fax PnP modem */
 289         {       "SUP1760",              0       },
 290         /* SupraExpress 56i Sp Intl */
 291         {       "SUP2171",              0       },
 292         /* Phoebe Micro */
 293         /* Phoebe Micro 33.6 Data Fax 1433VQH Plug & Play */
 294         {       "TEX0011",              0       },
 295         /* Archtek America Corp. */
 296         /* Archtek SmartLink Modem 3334BT Plug & Play */
 297         {       "UAC000F",              0       },
 298         /* 3Com Corp. */
 299         /* Gateway Telepath IIvi 33.6 */
 300         {       "USR0000",              0       },
 301         /* U.S. Robotics Sporster 33.6K Fax INT PnP */
 302         {       "USR0002",              0       },
 303         /*  Sportster Vi 14.4 PnP FAX Voicemail */
 304         {       "USR0004",              0       },
 305         /* U.S. Robotics 33.6K Voice INT PnP */
 306         {       "USR0006",              0       },
 307         /* U.S. Robotics 33.6K Voice EXT PnP */
 308         {       "USR0007",              0       },
 309         /* U.S. Robotics Courier V.Everything INT PnP */
 310         {       "USR0009",              0       },
 311         /* U.S. Robotics 33.6K Voice INT PnP */
 312         {       "USR2002",              0       },
 313         /* U.S. Robotics 56K Voice INT PnP */
 314         {       "USR2070",              0       },
 315         /* U.S. Robotics 56K Voice EXT PnP */
 316         {       "USR2080",              0       },
 317         /* U.S. Robotics 56K FAX INT */
 318         {       "USR3031",              0       },
 319         /* U.S. Robotics 56K FAX INT */
 320         {       "USR3050",              0       },
 321         /* U.S. Robotics 56K Voice INT PnP */
 322         {       "USR3070",              0       },
 323         /* U.S. Robotics 56K Voice EXT PnP */
 324         {       "USR3080",              0       },
 325         /* U.S. Robotics 56K Voice INT PnP */
 326         {       "USR3090",              0       },
 327         /* U.S. Robotics 56K Message  */
 328         {       "USR9100",              0       },
 329         /* U.S. Robotics 56K FAX EXT PnP*/
 330         {       "USR9160",              0       },
 331         /* U.S. Robotics 56K FAX INT PnP*/
 332         {       "USR9170",              0       },
 333         /* U.S. Robotics 56K Voice EXT PnP*/
 334         {       "USR9180",              0       },
 335         /* U.S. Robotics 56K Voice INT PnP*/
 336         {       "USR9190",              0       },
 337         /* Wacom tablets */
 338         {       "WACFXXX",              0       },
 339         /* Compaq touchscreen */
 340         {       "FPI2002",              0 },
 341         /* Fujitsu Stylistic touchscreens */
 342         {       "FUJ02B2",              0 },
 343         {       "FUJ02B3",              0 },
 344         /* Fujitsu Stylistic LT touchscreens */
 345         {       "FUJ02B4",              0 },
 346         /* Passive Fujitsu Stylistic touchscreens */
 347         {       "FUJ02B6",              0 },
 348         {       "FUJ02B7",              0 },
 349         {       "FUJ02B8",              0 },
 350         {       "FUJ02B9",              0 },
 351         {       "FUJ02BC",              0 },
 352         /* Fujitsu Wacom Tablet PC device */
 353         {       "FUJ02E5",              0       },
 354         /* Fujitsu P-series tablet PC device */
 355         {       "FUJ02E6",              0       },
 356         /* Fujitsu Wacom 2FGT Tablet PC device */
 357         {       "FUJ02E7",              0       },
 358         /* Fujitsu Wacom 1FGT Tablet PC device */
 359         {       "FUJ02E9",              0       },
 360         /*
 361          * LG C1 EXPRESS DUAL (C1-PB11A3) touch screen (actually a FUJ02E6 in
 362          * disguise)
 363          */
 364         {       "LTS0001",              0       },
 365         /* Rockwell's (PORALiNK) 33600 INT PNP */
 366         {       "WCI0003",              0       },
 367         /* Unknown PnP modems */
 368         {       "PNPCXXX",              UNKNOWN_DEV     },
 369         /* More unknown PnP modems */
 370         {       "PNPDXXX",              UNKNOWN_DEV     },
 371         {       "",                     0       }
 372 };
 373
 374 MODULE_DEVICE_TABLE(pnp, pnp_dev_table);
 375
 376 static char *modem_names[] __devinitdata = {
 377         "MODEM", "Modem", "modem", "FAX", "Fax", "fax",
 378         "56K", "56k", "K56", "33.6", "28.8", "14.4",
 379         "33,600", "28,800", "14,400", "33.600", "28.800", "14.400",
 380         "33600", "28800", "14400", "V.90", "V.34", "V.32", NULL
 381 };
 382
 383 static int __devinit check_name(char *name)
 384 {
 385         char **tmp;
 386
 387         for (tmp = modem_names; *tmp; tmp++)
 388                 if (strstr(name, *tmp))
 389                         return 1;
 390
 391         return 0;
 392 }
 393
 394 static int __devinit check_resources(struct pnp_dev *dev)
 395 {
 396         resource_size_t base[] = {0x2f8, 0x3f8, 0x2e8, 0x3e8};
 397         int i;
 398
 399         for (i = 0; i < ARRAY_SIZE(base); i++) {
 400                 if (pnp_possible_config(dev, IORESOURCE_IO, base[i], 8))
 401                         return 1;
 402         }
 403
 404         return 0;
 405 }
 406
 407 /*
 408  * Given a complete unknown PnP device, try to use some heuristics to
 409  * detect modems. Currently use such heuristic set:
 410  *     - dev->name or dev->bus->name must contain "modem" substring;
 411  *     - device must have only one IO region (8 byte long) with base address
 412  *       0x2e8, 0x3e8, 0x2f8 or 0x3f8.
 413  *
 414  * Such detection looks very ugly, but can detect at least some of numerous
 415  * PnP modems, alternatively we must hardcode all modems in pnp_devices[]
 416  * table.
 417  */
 418 static int __devinit serial_pnp_guess_board(struct pnp_dev *dev, int *flags)
 419 {
 420         if (!(check_name(pnp_dev_name(dev)) ||
 421                 (dev->card && check_name(dev->card->name))))
 422                         return -ENODEV;
 423
 424         if (check_resources(dev))
 425                 return 0;
 426
 427         return -ENODEV;
 428 }
 429
 430 static int __devinit
 431 serial_pnp_probe(struct pnp_dev *dev, const struct pnp_device_id *dev_id)
 432 {
 433         struct uart_port port;
 434         int ret, line, flags = dev_id->driver_data;
 435
 436         if (flags & UNKNOWN_DEV) {
 437                 ret = serial_pnp_guess_board(dev, &flags);
 438                 if (ret < 0)
 439                         return ret;
 440         }
 441
 442         memset(&port, 0, sizeof(struct uart_port));
 443         if (pnp_irq_valid(dev, 0))
 444                 port.irq = pnp_irq(dev, 0);
 445         if (pnp_port_valid(dev, 0)) {
 446                 port.iobase = pnp_port_start(dev, 0);
 447                 port.iotype = UPIO_PORT;
 448         } else if (pnp_mem_valid(dev, 0)) {
 449                 port.mapbase = pnp_mem_start(dev, 0);
 450                 port.iotype = UPIO_MEM;
 451                 port.flags = UPF_IOREMAP;
 452         } else
 453                 return -ENODEV;
 454
 455 #ifdef SERIAL_DEBUG_PNP
 456         printk(KERN_DEBUG
 457                 "Setup PNP port: port %x, mem 0x%lx, irq %d, type %d\n",
 458                        port.iobase, port.mapbase, port.irq, port.iotype);
 459 #endif
 460
 461         port.flags |= UPF_SKIP_TEST | UPF_BOOT_AUTOCONF;
 462         if (pnp_irq_flags(dev, 0) & IORESOURCE_IRQ_SHAREABLE)
 463                 port.flags |= UPF_SHARE_IRQ;
 464         port.uartclk = 1843200;
 465         port.dev = &dev->dev;
 466
 467         line = serial8250_register_port(&port);
 468         if (line < 0)
 469                 return -ENODEV;
 470
 471         pnp_set_drvdata(dev, (void *)((long)line + 1));
 472         return 0;
 473 }
 474
 475 static void __devexit serial_pnp_remove(struct pnp_dev *dev)
 476 {
 477         long line = (long)pnp_get_drvdata(dev);
 478         if (line)
 479                 serial8250_unregister_port(line - 1);
 480 }
 481
 482 #ifdef CONFIG_PM
 483 static int serial_pnp_suspend(struct pnp_dev *dev, pm_message_t state)
 484 {
 485         long line = (long)pnp_get_drvdata(dev);
 486
 487         if (!line)
 488                 return -ENODEV;
 489         serial8250_suspend_port(line - 1);
 490         return 0;
 491 }
 492
 493 static int serial_pnp_resume(struct pnp_dev *dev)
 494 {
 495         long line = (long)pnp_get_drvdata(dev);
 496
 497         if (!line)
 498                 return -ENODEV;
 499         serial8250_resume_port(line - 1);
 500         return 0;
 501 }
 502 #else
 503 #define serial_pnp_suspend NULL
 504 #define serial_pnp_resume NULL
 505 #endif /* CONFIG_PM */
 506
 507 static struct pnp_driver serial_pnp_driver = {
 508         .name           = "serial",
 509         .probe          = serial_pnp_probe,
 510         .remove         = __devexit_p(serial_pnp_remove),
 511         .suspend        = serial_pnp_suspend,
 512         .resume         = serial_pnp_resume,
 513         .id_table       = pnp_dev_table,
 514 };
 515
 516 static int __init serial8250_pnp_init(void)
 517 {
 518         return pnp_register_driver(&serial_pnp_driver);
 519 }
 520
 521 static void __exit serial8250_pnp_exit(void)
 522 {
 523         pnp_unregister_driver(&serial_pnp_driver);
 524 }
 525
 526 module_init(serial8250_pnp_init);
 527 module_exit(serial8250_pnp_exit);
 528
 529 MODULE_LICENSE("GPL");
 530 MODULE_DESCRIPTION("Generic 8250/16x50 PnP serial driver");