1/* National Semiconductor NS87560UBD Super I/O controller used in 2 * HP [BCJ]x000 workstations. 3 * 4 * This chip is a horrid piece of engineering, and National 5 * denies any knowledge of its existence. Thus no datasheet is 6 * available off www.national.com. 7 * 8 * (C) Copyright 2000 Linuxcare, Inc. 9 * (C) Copyright 2000 Linuxcare Canada, Inc. 10 * (C) Copyright 2000 Martin K. Petersen <mkp@linuxcare.com> 11 * (C) Copyright 2000 Alex deVries <alex@onefishtwo.ca> 12 * (C) Copyright 2001 John Marvin <jsm fc hp com> 13 * (C) Copyright 2003 Grant Grundler <grundler parisc-linux org> 14 * (C) Copyright 2005 Kyle McMartin <kyle@parisc-linux.org> 15 * (C) Copyright 2006 Helge Deller <deller@gmx.de> 16 * 17 * This program is free software; you can redistribute it and/or 18 * modify it under the terms of the GNU General Public License as 19 * published by the Free Software Foundation; either version 2 of 20 * the License, or (at your option) any later version. 21 * 22 * The initial version of this is by Martin Peterson. Alex deVries 23 * has spent a bit of time trying to coax it into working. 24 * 25 * Major changes to get basic interrupt infrastructure working to 26 * hopefully be able to support all SuperIO devices. Currently 27 * works with serial. -- John Marvin <jsm@fc.hp.com> 28 * 29 * Converted superio_init() to be a PCI_FIXUP_FINAL callee. 30 * -- Kyle McMartin <kyle@parisc-linux.org> 31 */ 32 33 34/* NOTES: 35 * 36 * Function 0 is an IDE controller. It is identical to a PC87415 IDE 37 * controller (and identifies itself as such). 38 * 39 * Function 1 is a "Legacy I/O" controller. Under this function is a 40 * whole mess of legacy I/O peripherals. Of course, HP hasn't enabled 41 * all the functionality in hardware, but the following is available: 42 * 43 * Two 16550A compatible serial controllers 44 * An IEEE 1284 compatible parallel port 45 * A floppy disk controller 46 * 47 * Function 2 is a USB controller. 48 * 49 * We must be incredibly careful during initialization. Since all 50 * interrupts are routed through function 1 (which is not allowed by 51 * the PCI spec), we need to program the PICs on the legacy I/O port 52 * *before* we attempt to set up IDE and USB. @#$!& 53 * 54 * According to HP, devices are only enabled by firmware if they have 55 * a physical device connected. 56 * 57 * Configuration register bits: 58 * 0x5A: FDC, SP1, IDE1, SP2, IDE2, PAR, Reserved, P92 59 * 0x5B: RTC, 8259, 8254, DMA1, DMA2, KBC, P61, APM 60 * 61 */ 62 63#include <linux/errno.h> 64#include <linux/init.h> 65#include <linux/module.h> 66#include <linux/types.h> 67#include <linux/interrupt.h> 68#include <linux/ioport.h> 69#include <linux/serial.h> 70#include <linux/pci.h> 71#include <linux/parport.h> 72#include <linux/parport_pc.h> 73#include <linux/termios.h> 74#include <linux/tty.h> 75#include <linux/serial_core.h> 76#include <linux/delay.h> 77 78#include <asm/io.h> 79#include <asm/hardware.h> 80#include <asm/superio.h> 81 82static struct superio_device sio_dev; 83 84 85#undef DEBUG_SUPERIO_INIT 86 87#ifdef DEBUG_SUPERIO_INIT 88#define DBG_INIT(x...) printk(x) 89#else 90#define DBG_INIT(x...) 91#endif 92 93#define SUPERIO "SuperIO" 94#define PFX SUPERIO ": " 95 96static irqreturn_t 97superio_interrupt(int parent_irq, void *devp) 98{ 99 u8 results; 100 u8 local_irq; 101 102 /* Poll the 8259 to see if there's an interrupt. */ 103 outb (OCW3_POLL,IC_PIC1+0); 104 105 results = inb(IC_PIC1+0); 106 107 /* 108 * Bit 7: 1 = active Interrupt; 0 = no Interrupt pending 109 * Bits 6-3: zero 110 * Bits 2-0: highest priority, active requesting interrupt ID (0-7) 111 */ 112 if ((results & 0x80) == 0) { 113 /* I suspect "spurious" interrupts are from unmasking an IRQ. 114 * We don't know if an interrupt was/is pending and thus 115 * just call the handler for that IRQ as if it were pending. 116 */ 117 return IRQ_NONE; 118 } 119 120 /* Check to see which device is interrupting */ 121 local_irq = results & 0x0f; 122 123 if (local_irq == 2 || local_irq > 7) { 124 printk(KERN_ERR PFX "slave interrupted!\n"); 125 return IRQ_HANDLED; 126 } 127 128 if (local_irq == 7) { 129 130 /* Could be spurious. Check in service bits */ 131 132 outb(OCW3_ISR,IC_PIC1+0); 133 results = inb(IC_PIC1+0); 134 if ((results & 0x80) == 0) { /* if ISR7 not set: spurious */ 135 printk(KERN_WARNING PFX "spurious interrupt!\n"); 136 return IRQ_HANDLED; 137 } 138 } 139 140 /* Call the appropriate device's interrupt */ 141 __do_IRQ(local_irq); 142 143 /* set EOI - forces a new interrupt if a lower priority device 144 * still needs service. 145 */ 146 outb((OCW2_SEOI|local_irq),IC_PIC1 + 0); 147 return IRQ_HANDLED; 148} 149 150/* Initialize Super I/O device */ 151static void 152superio_init(struct pci_dev *pcidev) 153{ 154 struct superio_device *sio = &sio_dev; 155 struct pci_dev *pdev = sio->lio_pdev; 156 u16 word; 157 158 if (sio->suckyio_irq_enabled) 159 return; 160 161 BUG_ON(!pdev); 162 BUG_ON(!sio->usb_pdev); 163 164 /* use the IRQ iosapic found for USB INT D... */ 165 pdev->irq = sio->usb_pdev->irq; 166 167 /* ...then properly fixup the USB to point at suckyio PIC */ 168 sio->usb_pdev->irq = superio_fixup_irq(sio->usb_pdev); 169 170 printk(KERN_INFO PFX "Found NS87560 Legacy I/O device at %s (IRQ %i) \n", 171 pci_name(pdev), pdev->irq); 172 173 pci_read_config_dword (pdev, SIO_SP1BAR, &sio->sp1_base); 174 sio->sp1_base &= ~1; 175 printk(KERN_INFO PFX "Serial port 1 at 0x%x\n", sio->sp1_base); 176 177 pci_read_config_dword (pdev, SIO_SP2BAR, &sio->sp2_base); 178 sio->sp2_base &= ~1; 179 printk(KERN_INFO PFX "Serial port 2 at 0x%x\n", sio->sp2_base); 180 181 pci_read_config_dword (pdev, SIO_PPBAR, &sio->pp_base); 182 sio->pp_base &= ~1; 183 printk(KERN_INFO PFX "Parallel port at 0x%x\n", sio->pp_base); 184 185 pci_read_config_dword (pdev, SIO_FDCBAR, &sio->fdc_base); 186 sio->fdc_base &= ~1; 187 printk(KERN_INFO PFX "Floppy controller at 0x%x\n", sio->fdc_base); 188 pci_read_config_dword (pdev, SIO_ACPIBAR, &sio->acpi_base); 189 sio->acpi_base &= ~1; 190 printk(KERN_INFO PFX "ACPI at 0x%x\n", sio->acpi_base); 191 192 request_region (IC_PIC1, 0x1f, "pic1"); 193 request_region (IC_PIC2, 0x1f, "pic2"); 194 request_region (sio->acpi_base, 0x1f, "acpi"); 195 196 /* Enable the legacy I/O function */ 197 pci_read_config_word (pdev, PCI_COMMAND, &word); 198 word |= PCI_COMMAND_SERR | PCI_COMMAND_PARITY | PCI_COMMAND_IO; 199 pci_write_config_word (pdev, PCI_COMMAND, word); 200 201 pci_set_master (pdev); 202 pci_enable_device(pdev); 203 204 205 /* 0x64 - 0x67 : 206 DMA Rtg 2 207 DMA Rtg 3 208 DMA Chan Ctl 209 TRIGGER_1 == 0x82 USB & IDE level triggered, rest to edge 210 */ 211 pci_write_config_dword (pdev, 0x64, 0x82000000U); 212 213 /* 0x68 - 0x6b : 214 TRIGGER_2 == 0x00 all edge triggered (not used) 215 CFG_IR_SER == 0x43 SerPort1 = IRQ3, SerPort2 = IRQ4 216 CFG_IR_PF == 0x65 ParPort = IRQ5, FloppyCtlr = IRQ6 217 CFG_IR_IDE == 0x07 IDE1 = IRQ7, reserved 218 */ 219 pci_write_config_dword (pdev, TRIGGER_2, 0x07654300U); 220 221 /* 0x6c - 0x6f : 222 CFG_IR_INTAB == 0x00 223 CFG_IR_INTCD == 0x10 USB = IRQ1 224 CFG_IR_PS2 == 0x00 225 CFG_IR_FXBUS == 0x00 226 */ 227 pci_write_config_dword (pdev, CFG_IR_INTAB, 0x00001000U); 228 229 /* 0x70 - 0x73 : 230 CFG_IR_USB == 0x00 not used. USB is connected to INTD. 231 CFG_IR_ACPI == 0x00 not used. 232 DMA Priority == 0x4c88 Power on default value. NFC. 233 */ 234 pci_write_config_dword (pdev, CFG_IR_USB, 0x4c880000U); 235 236 /* PIC1 Initialization Command Word register programming */ 237 outb (0x11,IC_PIC1+0); /* ICW1: ICW4 write req | ICW1 */ 238 outb (0x00,IC_PIC1+1); /* ICW2: interrupt vector table - not used */ 239 outb (0x04,IC_PIC1+1); /* ICW3: Cascade */ 240 outb (0x01,IC_PIC1+1); /* ICW4: x86 mode */ 241 242 /* PIC1 Program Operational Control Words */ 243 outb (0xff,IC_PIC1+1); /* OCW1: Mask all interrupts */ 244 outb (0xc2,IC_PIC1+0); /* OCW2: priority (3-7,0-2) */ 245 246 /* PIC2 Initialization Command Word register programming */ 247 outb (0x11,IC_PIC2+0); /* ICW1: ICW4 write req | ICW1 */ 248 outb (0x00,IC_PIC2+1); /* ICW2: N/A */ 249 outb (0x02,IC_PIC2+1); /* ICW3: Slave ID code */ 250 outb (0x01,IC_PIC2+1); /* ICW4: x86 mode */ 251 252 /* Program Operational Control Words */ 253 outb (0xff,IC_PIC1+1); /* OCW1: Mask all interrupts */ 254 outb (0x68,IC_PIC1+0); /* OCW3: OCW3 select | ESMM | SMM */ 255 256 /* Write master mask reg */ 257 outb (0xff,IC_PIC1+1); 258 259 /* Setup USB power regulation */ 260 outb(1, sio->acpi_base + USB_REG_CR); 261 if (inb(sio->acpi_base + USB_REG_CR) & 1) 262 printk(KERN_INFO PFX "USB regulator enabled\n"); 263 else 264 printk(KERN_ERR PFX "USB regulator not initialized!\n"); 265 266 if (request_irq(pdev->irq, superio_interrupt, IRQF_DISABLED, 267 SUPERIO, (void *)sio)) { 268 269 printk(KERN_ERR PFX "could not get irq\n"); 270 BUG(); 271 return; 272 } 273 274 sio->suckyio_irq_enabled = 1; 275} 276DECLARE_PCI_FIXUP_FINAL(PCI_VENDOR_ID_NS, PCI_DEVICE_ID_NS_87560_LIO, superio_init); 277 278static void superio_disable_irq(unsigned int irq) 279{ 280 u8 r8; 281 282 if ((irq < 1) || (irq == 2) || (irq > 7)) { 283 printk(KERN_ERR PFX "Illegal irq number.\n"); 284 BUG(); 285 return; 286 } 287 288 /* Mask interrupt */ 289 290 r8 = inb(IC_PIC1+1); 291 r8 |= (1 << irq); 292 outb (r8,IC_PIC1+1); 293} 294 295static void superio_enable_irq(unsigned int irq) 296{ 297 u8 r8; 298 299 if ((irq < 1) || (irq == 2) || (irq > 7)) { 300 printk(KERN_ERR PFX "Illegal irq number (%d).\n", irq); 301 BUG(); 302 return; 303 } 304 305 /* Unmask interrupt */ 306 r8 = inb(IC_PIC1+1); 307 r8 &= ~(1 << irq); 308 outb (r8,IC_PIC1+1); 309} 310 311static unsigned int superio_startup_irq(unsigned int irq) 312{ 313 superio_enable_irq(irq); 314 return 0; 315} 316 317static struct hw_interrupt_type superio_interrupt_type = { 318 .typename = SUPERIO, 319 .startup = superio_startup_irq, 320 .shutdown = superio_disable_irq, 321 .enable = superio_enable_irq, 322 .disable = superio_disable_irq, 323 .ack = no_ack_irq, 324 .end = no_end_irq, 325}; 326 327#ifdef DEBUG_SUPERIO_INIT 328static unsigned short expected_device[3] = { 329 PCI_DEVICE_ID_NS_87415, 330 PCI_DEVICE_ID_NS_87560_LIO, 331 PCI_DEVICE_ID_NS_87560_USB 332}; 333#endif 334 335int superio_fixup_irq(struct pci_dev *pcidev) 336{ 337 int local_irq, i; 338 339#ifdef DEBUG_SUPERIO_INIT 340 int fn; 341 fn = PCI_FUNC(pcidev->devfn); 342 343 /* Verify the function number matches the expected device id. */ 344 if (expected_device[fn] != pcidev->device) { 345 BUG(); 346 return -1; 347 } 348 printk("superio_fixup_irq(%s) ven 0x%x dev 0x%x from %p\n", 349 pci_name(pcidev), 350 pcidev->vendor, pcidev->device, 351 __builtin_return_address(0)); 352#endif 353 354 for (i = 0; i < 16; i++) { 355 irq_desc[i].chip = &superio_interrupt_type; 356 } 357 358 /* 359 * We don't allocate a SuperIO irq for the legacy IO function, 360 * since it is a "bridge". Instead, we will allocate irq's for 361 * each legacy device as they are initialized. 362 */ 363 364 switch(pcidev->device) { 365 case PCI_DEVICE_ID_NS_87415: /* Function 0 */ 366 local_irq = IDE_IRQ; 367 break; 368 case PCI_DEVICE_ID_NS_87560_LIO: /* Function 1 */ 369 sio_dev.lio_pdev = pcidev; /* save for superio_init() */ 370 return -1; 371 case PCI_DEVICE_ID_NS_87560_USB: /* Function 2 */ 372 sio_dev.usb_pdev = pcidev; /* save for superio_init() */ 373 local_irq = USB_IRQ; 374 break; 375 default: 376 local_irq = -1; 377 BUG(); 378 break; 379 } 380 381 return local_irq; 382} 383 384static void __init superio_serial_init(void) 385{ 386#ifdef CONFIG_SERIAL_8250 387 int retval; 388 struct uart_port serial_port; 389 390 memset(&serial_port, 0, sizeof(serial_port)); 391 serial_port.iotype = UPIO_PORT; 392 serial_port.type = PORT_16550A; 393 serial_port.uartclk = 115200*16; 394 serial_port.fifosize = 16; 395 spin_lock_init(&serial_port.lock); 396 397 /* serial port #1 */ 398 serial_port.iobase = sio_dev.sp1_base; 399 serial_port.irq = SP1_IRQ; 400 serial_port.line = 0; 401 retval = early_serial_setup(&serial_port); 402 if (retval < 0) { 403 printk(KERN_WARNING PFX "Register Serial #0 failed.\n"); 404 return; 405 } 406 407 /* serial port #2 */ 408 serial_port.iobase = sio_dev.sp2_base; 409 serial_port.irq = SP2_IRQ; 410 serial_port.line = 1; 411 retval = early_serial_setup(&serial_port); 412 if (retval < 0) 413 printk(KERN_WARNING PFX "Register Serial #1 failed.\n"); 414#endif /* CONFIG_SERIAL_8250 */ 415} 416 417 418static void __init superio_parport_init(void) 419{ 420#ifdef CONFIG_PARPORT_PC 421 if (!parport_pc_probe_port(sio_dev.pp_base, 422 0 /*base_hi*/, 423 PAR_IRQ, 424 PARPORT_DMA_NONE /* dma */, 425 NULL /*struct pci_dev* */) ) 426 427 printk(KERN_WARNING PFX "Probing parallel port failed.\n"); 428#endif /* CONFIG_PARPORT_PC */ 429} 430 431 432static void superio_fixup_pci(struct pci_dev *pdev) 433{ 434 u8 prog; 435 436 pdev->class |= 0x5; 437 pci_write_config_byte(pdev, PCI_CLASS_PROG, pdev->class); 438 439 pci_read_config_byte(pdev, PCI_CLASS_PROG, &prog); 440 printk("PCI: Enabled native mode for NS87415 (pif=0x%x)\n", prog); 441} 442DECLARE_PCI_FIXUP_EARLY(PCI_VENDOR_ID_NS, PCI_DEVICE_ID_NS_87415, superio_fixup_pci); 443 444 445static int __init 446superio_probe(struct pci_dev *dev, const struct pci_device_id *id) 447{ 448 struct superio_device *sio = &sio_dev; 449 450 /* 451 ** superio_probe(00:0e.0) ven 0x100b dev 0x2 sv 0x0 sd 0x0 class 0x1018a 452 ** superio_probe(00:0e.1) ven 0x100b dev 0xe sv 0x0 sd 0x0 class 0x68000 453 ** superio_probe(00:0e.2) ven 0x100b dev 0x12 sv 0x0 sd 0x0 class 0xc0310 454 */ 455 DBG_INIT("superio_probe(%s) ven 0x%x dev 0x%x sv 0x%x sd 0x%x class 0x%x\n", 456 pci_name(dev), 457 dev->vendor, dev->device, 458 dev->subsystem_vendor, dev->subsystem_device, 459 dev->class); 460 461 BUG_ON(!sio->suckyio_irq_enabled); /* Enabled by PCI_FIXUP_FINAL */ 462 463 if (dev->device == PCI_DEVICE_ID_NS_87560_LIO) { /* Function 1 */ 464 superio_parport_init(); 465 superio_serial_init(); 466 return 0; 467 } else if (dev->device == PCI_DEVICE_ID_NS_87415) { /* Function 0 */ 468 DBG_INIT("superio_probe: ignoring IDE 87415\n"); 469 } else if (dev->device == PCI_DEVICE_ID_NS_87560_USB) { /* Function 2 */ 470 DBG_INIT("superio_probe: ignoring USB OHCI controller\n"); 471 } else { 472 DBG_INIT("superio_probe: WTF? Fire Extinguisher?\n"); 473 } 474 475 /* Let appropriate other driver claim this device. */ 476 return -ENODEV; 477} 478 479static const struct pci_device_id superio_tbl[] = { 480 { PCI_DEVICE(PCI_VENDOR_ID_NS, PCI_DEVICE_ID_NS_87560_LIO) }, 481 { PCI_DEVICE(PCI_VENDOR_ID_NS, PCI_DEVICE_ID_NS_87560_USB) }, 482 { PCI_DEVICE(PCI_VENDOR_ID_NS, PCI_DEVICE_ID_NS_87415) }, 483 { 0, } 484}; 485 486static struct pci_driver superio_driver = { 487 .name = SUPERIO, 488 .id_table = superio_tbl, 489 .probe = superio_probe, 490}; 491 492static int __init superio_modinit(void) 493{ 494 return pci_register_driver(&superio_driver); 495} 496 497static void __exit superio_exit(void) 498{ 499 pci_unregister_driver(&superio_driver); 500} 501 502module_init(superio_modinit); 503module_exit(superio_exit); 504