drivers/ide/pci/piix.c

   1 /*
   2  *  Copyright (C) 1998-1999 Andrzej Krzysztofowicz, Author and Maintainer
   3  *  Copyright (C) 1998-2000 Andre Hedrick <andre@linux-ide.org>
   4  *  Copyright (C) 2003 Red Hat Inc <alan@redhat.com>
   5  *  Copyright (C) 2006-2007 MontaVista Software, Inc. <source@mvista.com>
   6  *
   7  *  May be copied or modified under the terms of the GNU General Public License
   8  *
   9  * Documentation:
  10  *
  11  *      Publically available from Intel web site. Errata documentation
  12  * is also publically available. As an aide to anyone hacking on this
  13  * driver the list of errata that are relevant is below.going back to
  14  * PIIX4. Older device documentation is now a bit tricky to find.
  15  *
  16  * Errata of note:
  17  *
  18  * Unfixable
  19  *      PIIX4    errata #9      - Only on ultra obscure hw
  20  *      ICH3     errata #13     - Not observed to affect real hw
  21  *                                by Intel
  22  *
  23  * Things we must deal with
  24  *      PIIX4   errata #10      - BM IDE hang with non UDMA
  25  *                                (must stop/start dma to recover)
  26  *      440MX   errata #15      - As PIIX4 errata #10
  27  *      PIIX4   errata #15      - Must not read control registers
  28  *                                during a PIO transfer
  29  *      440MX   errata #13      - As PIIX4 errata #15
  30  *      ICH2    errata #21      - DMA mode 0 doesn't work right
  31  *      ICH0/1  errata #55      - As ICH2 errata #21
  32  *      ICH2    spec c #9       - Extra operations needed to handle
  33  *                                drive hotswap [NOT YET SUPPORTED]
  34  *      ICH2    spec c #20      - IDE PRD must not cross a 64K boundary
  35  *                                and must be dword aligned
  36  *      ICH2    spec c #24      - UDMA mode 4,5 t85/86 should be 6ns not 3.3
  37  *
  38  * Should have been BIOS fixed:
  39  *      450NX:  errata #19      - DMA hangs on old 450NX
  40  *      450NX:  errata #20      - DMA hangs on old 450NX
  41  *      450NX:  errata #25      - Corruption with DMA on old 450NX
  42  *      ICH3    errata #15      - IDE deadlock under high load
  43  *                                (BIOS must set dev 31 fn 0 bit 23)
  44  *      ICH3    errata #18      - Don't use native mode
  45  */
  46
  47 #include <linux/types.h>
  48 #include <linux/module.h>
  49 #include <linux/kernel.h>
  50 #include <linux/pci.h>
  51 #include <linux/hdreg.h>
  52 #include <linux/ide.h>
  53 #include <linux/init.h>
  54
  55 #include <asm/io.h>
  56
  57 #define DRV_NAME "piix"
  58
  59 static int no_piix_dma;
  60
  61 /**
  62  *      piix_set_pio_mode       -       set host controller for PIO mode
  63  *      @drive: drive
  64  *      @pio: PIO mode number
  65  *
  66  *      Set the interface PIO mode based upon the settings done by AMI BIOS.
  67  */
  68
  69 static void piix_set_pio_mode(ide_drive_t *drive, const u8 pio)
  70 {
  71         ide_hwif_t *hwif        = HWIF(drive);
  72         struct pci_dev *dev     = to_pci_dev(hwif->dev);
  73         int is_slave            = drive->dn & 1;
  74         int master_port         = hwif->channel ? 0x42 : 0x40;
  75         int slave_port          = 0x44;
  76         unsigned long flags;
  77         u16 master_data;
  78         u8 slave_data;
  79         static DEFINE_SPINLOCK(tune_lock);
  80         int control = 0;
  81
  82                                      /* ISP  RTC */
  83         static const u8 timings[][2]= {
  84                                         { 0, 0 },
  85                                         { 0, 0 },
  86                                         { 1, 0 },
  87                                         { 2, 1 },
  88                                         { 2, 3 }, };
  89
  90         /*
  91          * Master vs slave is synchronized above us but the slave register is
  92          * shared by the two hwifs so the corner case of two slave timeouts in
  93          * parallel must be locked.
  94          */
  95         spin_lock_irqsave(&tune_lock, flags);
  96         pci_read_config_word(dev, master_port, &master_data);
  97
  98         if (pio > 1)
  99                 control |= 1;   /* Programmable timing on */
 100         if (drive->media == ide_disk)
 101                 control |= 4;   /* Prefetch, post write */
 102         if (pio > 2)
 103                 control |= 2;   /* IORDY */
 104         if (is_slave) {
 105                 master_data |=  0x4000;
 106                 master_data &= ~0x0070;
 107                 if (pio > 1) {
 108                         /* Set PPE, IE and TIME */
 109                         master_data |= control << 4;
 110                 }
 111                 pci_read_config_byte(dev, slave_port, &slave_data);
 112                 slave_data &= hwif->channel ? 0x0f : 0xf0;
 113                 slave_data |= ((timings[pio][0] << 2) | timings[pio][1]) <<
 114                                (hwif->channel ? 4 : 0);
 115         } else {
 116                 master_data &= ~0x3307;
 117                 if (pio > 1) {
 118                         /* enable PPE, IE and TIME */
 119                         master_data |= control;
 120                 }
 121                 master_data |= (timings[pio][0] << 12) | (timings[pio][1] << 8);
 122         }
 123         pci_write_config_word(dev, master_port, master_data);
 124         if (is_slave)
 125                 pci_write_config_byte(dev, slave_port, slave_data);
 126         spin_unlock_irqrestore(&tune_lock, flags);
 127 }
 128
 129 /**
 130  *      piix_set_dma_mode       -       set host controller for DMA mode
 131  *      @drive: drive
 132  *      @speed: DMA mode
 133  *
 134  *      Set a PIIX host controller to the desired DMA mode.  This involves
 135  *      programming the right timing data into the PCI configuration space.
 136  */
 137
 138 static void piix_set_dma_mode(ide_drive_t *drive, const u8 speed)
 139 {
 140         ide_hwif_t *hwif        = HWIF(drive);
 141         struct pci_dev *dev     = to_pci_dev(hwif->dev);
 142         u8 maslave              = hwif->channel ? 0x42 : 0x40;
 143         int a_speed             = 3 << (drive->dn * 4);
 144         int u_flag              = 1 << drive->dn;
 145         int v_flag              = 0x01 << drive->dn;
 146         int w_flag              = 0x10 << drive->dn;
 147         int u_speed             = 0;
 148         int                     sitre;
 149         u16                     reg4042, reg4a;
 150         u8                      reg48, reg54, reg55;
 151
 152         pci_read_config_word(dev, maslave, &reg4042);
 153         sitre = (reg4042 & 0x4000) ? 1 : 0;
 154         pci_read_config_byte(dev, 0x48, &reg48);
 155         pci_read_config_word(dev, 0x4a, &reg4a);
 156         pci_read_config_byte(dev, 0x54, &reg54);
 157         pci_read_config_byte(dev, 0x55, &reg55);
 158
 159         if (speed >= XFER_UDMA_0) {
 160                 u8 udma = speed - XFER_UDMA_0;
 161
 162                 u_speed = min_t(u8, 2 - (udma & 1), udma) << (drive->dn * 4);
 163
 164                 if (!(reg48 & u_flag))
 165                         pci_write_config_byte(dev, 0x48, reg48 | u_flag);
 166                 if (speed == XFER_UDMA_5) {
 167                         pci_write_config_byte(dev, 0x55, (u8) reg55|w_flag);
 168                 } else {
 169                         pci_write_config_byte(dev, 0x55, (u8) reg55 & ~w_flag);
 170                 }
 171                 if ((reg4a & a_speed) != u_speed)
 172                         pci_write_config_word(dev, 0x4a, (reg4a & ~a_speed) | u_speed);
 173                 if (speed > XFER_UDMA_2) {
 174                         if (!(reg54 & v_flag))
 175                                 pci_write_config_byte(dev, 0x54, reg54 | v_flag);
 176                 } else
 177                         pci_write_config_byte(dev, 0x54, reg54 & ~v_flag);
 178         } else {
 179                 const u8 mwdma_to_pio[] = { 0, 3, 4 };
 180                 u8 pio;
 181
 182                 if (reg48 & u_flag)
 183                         pci_write_config_byte(dev, 0x48, reg48 & ~u_flag);
 184                 if (reg4a & a_speed)
 185                         pci_write_config_word(dev, 0x4a, reg4a & ~a_speed);
 186                 if (reg54 & v_flag)
 187                         pci_write_config_byte(dev, 0x54, reg54 & ~v_flag);
 188                 if (reg55 & w_flag)
 189                         pci_write_config_byte(dev, 0x55, (u8) reg55 & ~w_flag);
 190
 191                 if (speed >= XFER_MW_DMA_0)
 192                         pio = mwdma_to_pio[speed - XFER_MW_DMA_0];
 193                 else
 194                         pio = 2; /* only SWDMA2 is allowed */
 195
 196                 piix_set_pio_mode(drive, pio);
 197         }
 198 }
 199
 200 /**
 201  *      init_chipset_ich        -       set up the ICH chipset
 202  *      @dev: PCI device to set up
 203  *
 204  *      Initialize the PCI device as required.  For the ICH this turns
 205  *      out to be nice and simple.
 206  */
 207
 208 static unsigned int __devinit init_chipset_ich(struct pci_dev *dev)
 209 {
 210         u32 extra = 0;
 211
 212         pci_read_config_dword(dev, 0x54, &extra);
 213         pci_write_config_dword(dev, 0x54, extra | 0x400);
 214
 215         return 0;
 216 }
 217
 218 /**
 219  *      piix_dma_clear_irq      -       clear BMDMA status
 220  *      @drive: IDE drive to clear
 221  *
 222  *      Called from ide_intr() for PIO interrupts
 223  *      to clear BMDMA status as needed by ICHx
 224  */
 225 static void piix_dma_clear_irq(ide_drive_t *drive)
 226 {
 227         ide_hwif_t *hwif = HWIF(drive);
 228         u8 dma_stat;
 229
 230         /* clear the INTR & ERROR bits */
 231         dma_stat = inb(hwif->dma_base + ATA_DMA_STATUS);
 232         /* Should we force the bit as well ? */
 233         outb(dma_stat, hwif->dma_base + ATA_DMA_STATUS);
 234 }
 235
 236 struct ich_laptop {
 237         u16 device;
 238         u16 subvendor;
 239         u16 subdevice;
 240 };
 241
 242 /*
 243  *      List of laptops that use short cables rather than 80 wire
 244  */
 245
 246 static const struct ich_laptop ich_laptop[] = {
 247         /* devid, subvendor, subdev */
 248         { 0x27DF, 0x1025, 0x0102 },     /* ICH7 on Acer 5602aWLMi */
 249         { 0x27DF, 0x0005, 0x0280 },     /* ICH7 on Acer 5602WLMi */
 250         { 0x27DF, 0x1025, 0x0110 },     /* ICH7 on Acer 3682WLMi */
 251         { 0x27DF, 0x1043, 0x1267 },     /* ICH7 on Asus W5F */
 252         { 0x27DF, 0x103C, 0x30A1 },     /* ICH7 on HP Compaq nc2400 */
 253         { 0x24CA, 0x1025, 0x0061 },     /* ICH4 on Acer Aspire 2023WLMi */
 254         { 0x2653, 0x1043, 0x82D8 },     /* ICH6M on Asus Eee 701 */
 255         /* end marker */
 256         { 0, }
 257 };
 258
 259 static u8 __devinit piix_cable_detect(ide_hwif_t *hwif)
 260 {
 261         struct pci_dev *pdev = to_pci_dev(hwif->dev);
 262         const struct ich_laptop *lap = &ich_laptop[0];
 263         u8 reg54h = 0, mask = hwif->channel ? 0xc0 : 0x30;
 264
 265         /* check for specials */
 266         while (lap->device) {
 267                 if (lap->device == pdev->device &&
 268                     lap->subvendor == pdev->subsystem_vendor &&
 269                     lap->subdevice == pdev->subsystem_device) {
 270                         return ATA_CBL_PATA40_SHORT;
 271                 }
 272                 lap++;
 273         }
 274
 275         pci_read_config_byte(pdev, 0x54, &reg54h);
 276
 277         return (reg54h & mask) ? ATA_CBL_PATA80 : ATA_CBL_PATA40;
 278 }
 279
 280 /**
 281  *      init_hwif_piix          -       fill in the hwif for the PIIX
 282  *      @hwif: IDE interface
 283  *
 284  *      Set up the ide_hwif_t for the PIIX interface according to the
 285  *      capabilities of the hardware.
 286  */
 287
 288 static void __devinit init_hwif_piix(ide_hwif_t *hwif)
 289 {
 290         if (!hwif->dma_base)
 291                 return;
 292
 293         if (no_piix_dma)
 294                 hwif->ultra_mask = hwif->mwdma_mask = hwif->swdma_mask = 0;
 295 }
 296
 297 static void __devinit init_hwif_ich(ide_hwif_t *hwif)
 298 {
 299         init_hwif_piix(hwif);
 300
 301         /* ICHx need to clear the BMDMA status for all interrupts */
 302         if (hwif->dma_base)
 303                 hwif->ide_dma_clear_irq = &piix_dma_clear_irq;
 304 }
 305
 306 static const struct ide_port_ops piix_port_ops = {
 307         .set_pio_mode           = piix_set_pio_mode,
 308         .set_dma_mode           = piix_set_dma_mode,
 309         .cable_detect           = piix_cable_detect,
 310 };
 311
 312 #ifndef CONFIG_IA64
 313  #define IDE_HFLAGS_PIIX IDE_HFLAG_LEGACY_IRQS
 314 #else
 315  #define IDE_HFLAGS_PIIX 0
 316 #endif
 317
 318 #define DECLARE_PIIX_DEV(udma) \
 319         {                                               \
 320                 .name           = DRV_NAME,             \
 321                 .init_hwif      = init_hwif_piix,       \
 322                 .enablebits     = {{0x41,0x80,0x80}, {0x43,0x80,0x80}}, \
 323                 .port_ops       = &piix_port_ops,       \
 324                 .host_flags     = IDE_HFLAGS_PIIX,      \
 325                 .pio_mask       = ATA_PIO4,             \
 326                 .swdma_mask     = ATA_SWDMA2_ONLY,      \
 327                 .mwdma_mask     = ATA_MWDMA12_ONLY,     \
 328                 .udma_mask      = udma,                 \
 329         }
 330
 331 #define DECLARE_ICH_DEV(udma) \
 332         { \
 333                 .name           = DRV_NAME, \
 334                 .init_chipset   = init_chipset_ich, \
 335                 .init_hwif      = init_hwif_ich, \
 336                 .enablebits     = {{0x41,0x80,0x80}, {0x43,0x80,0x80}}, \
 337                 .port_ops       = &piix_port_ops, \
 338                 .host_flags     = IDE_HFLAGS_PIIX, \
 339                 .pio_mask       = ATA_PIO4, \
 340                 .swdma_mask     = ATA_SWDMA2_ONLY, \
 341                 .mwdma_mask     = ATA_MWDMA12_ONLY, \
 342                 .udma_mask      = udma, \
 343         }
 344
 345 static const struct ide_port_info piix_pci_info[] __devinitdata = {
 346         /* 0: MPIIX */
 347         {       /*
 348                  * MPIIX actually has only a single IDE channel mapped to
 349                  * the primary or secondary ports depending on the value
 350                  * of the bit 14 of the IDETIM register at offset 0x6c
 351                  */
 352                 .name           = DRV_NAME,
 353                 .enablebits     = {{0x6d,0xc0,0x80}, {0x6d,0xc0,0xc0}},
 354                 .host_flags     = IDE_HFLAG_ISA_PORTS | IDE_HFLAG_NO_DMA |
 355                                   IDE_HFLAGS_PIIX,
 356                 .pio_mask       = ATA_PIO4,
 357                 /* This is a painful system best to let it self tune for now */
 358         },
 359         /* 1: PIIXa/PIIXb/PIIX3 */
 360         DECLARE_PIIX_DEV(0x00), /* no udma */
 361         /* 2: PIIX4 */
 362         DECLARE_PIIX_DEV(ATA_UDMA2),
 363         /* 3: ICH0 */
 364         DECLARE_ICH_DEV(ATA_UDMA2),
 365         /* 4: ICH */
 366         DECLARE_ICH_DEV(ATA_UDMA4),
 367         /* 5: PIIX4 */
 368         DECLARE_PIIX_DEV(ATA_UDMA4),
 369         /* 6: ICH[2-7]/ICH[2-3]M/C-ICH/ICH5-SATA/ESB2/ICH8M */
 370         DECLARE_ICH_DEV(ATA_UDMA5),
 371 };
 372
 373 /**
 374  *      piix_init_one   -       called when a PIIX is found
 375  *      @dev: the piix device
 376  *      @id: the matching pci id
 377  *
 378  *      Called when the PCI registration layer (or the IDE initialization)
 379  *      finds a device matching our IDE device tables.
 380  */
 381
 382 static int __devinit piix_init_one(struct pci_dev *dev, const struct pci_device_id *id)
 383 {
 384         return ide_pci_init_one(dev, &piix_pci_info[id->driver_data], NULL);
 385 }
 386
 387 /**
 388  *      piix_check_450nx        -       Check for problem 450NX setup
 389  *
 390  *      Check for the present of 450NX errata #19 and errata #25. If
 391  *      they are found, disable use of DMA IDE
 392  */
 393
 394 static void __devinit piix_check_450nx(void)
 395 {
 396         struct pci_dev *pdev = NULL;
 397         u16 cfg;
 398         while((pdev=pci_get_device(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82454NX, pdev))!=NULL)
 399         {
 400                 /* Look for 450NX PXB. Check for problem configurations
 401                    A PCI quirk checks bit 6 already */
 402                 pci_read_config_word(pdev, 0x41, &cfg);
 403                 /* Only on the original revision: IDE DMA can hang */
 404                 if (pdev->revision == 0x00)
 405                         no_piix_dma = 1;
 406                 /* On all revisions below 5 PXB bus lock must be disabled for IDE */
 407                 else if (cfg & (1<<14) && pdev->revision < 5)
 408                         no_piix_dma = 2;
 409         }
 410         if(no_piix_dma)
 411                 printk(KERN_WARNING DRV_NAME ": 450NX errata present, disabling IDE DMA.\n");
 412         if(no_piix_dma == 2)
 413                 printk(KERN_WARNING DRV_NAME ": A BIOS update may resolve this.\n");
 414 }
 415
 416 static const struct pci_device_id piix_pci_tbl[] = {
 417         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_82371FB_0),  1 },
 418         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_82371FB_1),  1 },
 419         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_82371MX),    0 },
 420         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_82371SB_1),  1 },
 421         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_82371AB),    2 },
 422         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_82801AB_1),  3 },
 423         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_82443MX_1),  2 },
 424         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_82801AA_1),  4 },
 425         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_82372FB_1),  5 },
 426         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_82451NX),    2 },
 427         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_82801BA_9),  6 },
 428         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_82801BA_8),  6 },
 429         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_82801CA_10), 6 },
 430         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_82801CA_11), 6 },
 431         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_82801DB_11), 6 },
 432         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_82801EB_11), 6 },
 433         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_82801E_11),  6 },
 434         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_82801DB_10), 6 },
 435 #ifdef CONFIG_BLK_DEV_IDE_SATA
 436         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_82801EB_1),  6 },
 437 #endif
 438         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_ESB_2),      6 },
 439         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_ICH6_19),    6 },
 440         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_ICH7_21),    6 },
 441         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_82801DB_1),  6 },
 442         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_ESB2_18),    6 },
 443         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_ICH8_6),     6 },
 444         { 0, },
 445 };
 446 MODULE_DEVICE_TABLE(pci, piix_pci_tbl);
 447
 448 static struct pci_driver driver = {
 449         .name           = "PIIX_IDE",
 450         .id_table       = piix_pci_tbl,
 451         .probe          = piix_init_one,
 452         .remove         = ide_pci_remove,
 453 };
 454
 455 static int __init piix_ide_init(void)
 456 {
 457         piix_check_450nx();
 458         return ide_pci_register_driver(&driver);
 459 }
 460
 461 static void __exit piix_ide_exit(void)
 462 {
 463         pci_unregister_driver(&driver);
 464 }
 465
 466 module_init(piix_ide_init);
 467 module_exit(piix_ide_exit);
 468
 469 MODULE_AUTHOR("Andre Hedrick, Andrzej Krzysztofowicz");
 470 MODULE_DESCRIPTION("PCI driver module for Intel PIIX IDE");
 471 MODULE_LICENSE("GPL");