drivers/ide/alim15x3.c

   1 /*
   2  *  Copyright (C) 1998-2000 Michel Aubry, Maintainer
   3  *  Copyright (C) 1998-2000 Andrzej Krzysztofowicz, Maintainer
   4  *  Copyright (C) 1999-2000 CJ, cjtsai@ali.com.tw, Maintainer
   5  *
   6  *  Copyright (C) 1998-2000 Andre Hedrick (andre@linux-ide.org)
   7  *  May be copied or modified under the terms of the GNU General Public License
   8  *  Copyright (C) 2002 Alan Cox
   9  *  ALi (now ULi M5228) support by Clear Zhang <Clear.Zhang@ali.com.tw>
  10  *  Copyright (C) 2007 MontaVista Software, Inc. <source@mvista.com>
  11  *  Copyright (C) 2007-2010 Bartlomiej Zolnierkiewicz
  12  *
  13  *  (U)DMA capable version of ali 1533/1543(C), 1535(D)
  14  *
  15  **********************************************************************
  16  *  9/7/99 --Parts from the above author are included and need to be
  17  *  converted into standard interface, once I finish the thought.
  18  *
  19  *  Recent changes
  20  *      Don't use LBA48 mode on ALi <= 0xC4
  21  *      Don't poke 0x79 with a non ALi northbridge
  22  *      Don't flip undefined bits on newer chipsets (fix Fujitsu laptop hang)
  23  *      Allow UDMA6 on revisions > 0xC4
  24  *
  25  *  Documentation
  26  *      Chipset documentation available under NDA only
  27  *
  28  */
  29
  30 #include <linux/module.h>
  31 #include <linux/types.h>
  32 #include <linux/kernel.h>
  33 #include <linux/pci.h>
  34 #include <linux/ide.h>
  35 #include <linux/init.h>
  36 #include <linux/dmi.h>
  37
  38 #include <asm/io.h>
  39
  40 #define DRV_NAME "alim15x3"
  41
  42 /*
  43  *      ALi devices are not plug in. Otherwise these static values would
  44  *      need to go. They ought to go away anyway
  45  */
  46
  47 static u8 m5229_revision;
  48 static u8 chip_is_1543c_e;
  49 static struct pci_dev *isa_dev;
  50
  51 static void ali_fifo_control(ide_hwif_t *hwif, ide_drive_t *drive, int on)
  52 {
  53         struct pci_dev *pdev = to_pci_dev(hwif->dev);
  54         int pio_fifo = 0x54 + hwif->channel;
  55         u8 fifo;
  56         int shift = 4 * (drive->dn & 1);
  57
  58         pci_read_config_byte(pdev, pio_fifo, &fifo);
  59         fifo &= ~(0x0F << shift);
  60         fifo |= (on << shift);
  61         pci_write_config_byte(pdev, pio_fifo, fifo);
  62 }
  63
  64 /**
  65  *      ali_set_pio_mode        -       set host controller for PIO mode
  66  *      @hwif: port
  67  *      @drive: drive
  68  *
  69  *      Program the controller for the given PIO mode.
  70  */
  71
  72 static void ali_set_pio_mode(ide_hwif_t *hwif, ide_drive_t *drive)
  73 {
  74         struct pci_dev *dev = to_pci_dev(hwif->dev);
  75         ide_drive_t *pair = ide_get_pair_dev(drive);
  76         int bus_speed = ide_pci_clk ? ide_pci_clk : 33;
  77         unsigned long T =  1000000 / bus_speed; /* PCI clock based */
  78         int port = hwif->channel ? 0x5c : 0x58;
  79         u8 unit = drive->dn & 1;
  80         struct ide_timing t;
  81
  82         ide_timing_compute(drive, drive->pio_mode, &t, T, 1);
  83         if (pair) {
  84                 struct ide_timing p;
  85
  86                 ide_timing_compute(pair, pair->pio_mode, &p, T, 1);
  87                 ide_timing_merge(&p, &t, &t, IDE_TIMING_SETUP);
  88                 if (pair->dma_mode) {
  89                         ide_timing_compute(pair, pair->dma_mode, &p, T, 1);
  90                         ide_timing_merge(&p, &t, &t, IDE_TIMING_SETUP);
  91                 }
  92         }
  93
  94         t.setup = clamp_val(t.setup, 1, 8) & 7;
  95         t.active = clamp_val(t.active, 1, 8) & 7;
  96         t.recover = clamp_val(t.recover, 1, 16) & 15;
  97
  98         /*
  99          * PIO mode => ATA FIFO on, ATAPI FIFO off
 100          */
 101         ali_fifo_control(hwif, drive, (drive->media == ide_disk) ? 0x05 : 0x00);
 102
 103         pci_write_config_byte(dev, port, t.setup);
 104         pci_write_config_byte(dev, port + unit + 2,
 105                               (t.active << 4) | t.recover);
 106 }
 107
 108 /**
 109  *      ali_udma_filter         -       compute UDMA mask
 110  *      @drive: IDE device
 111  *
 112  *      Return available UDMA modes.
 113  *
 114  *      The actual rules for the ALi are:
 115  *              No UDMA on revisions <= 0x20
 116  *              Disk only for revisions < 0xC2
 117  *              Not WDC drives on M1543C-E (?)
 118  */
 119
 120 static u8 ali_udma_filter(ide_drive_t *drive)
 121 {
 122         if (m5229_revision > 0x20 && m5229_revision < 0xC2) {
 123                 if (drive->media != ide_disk)
 124                         return 0;
 125                 if (chip_is_1543c_e &&
 126                     strstr((char *)&drive->id[ATA_ID_PROD], "WDC "))
 127                         return 0;
 128         }
 129
 130         return drive->hwif->ultra_mask;
 131 }
 132
 133 /**
 134  *      ali_set_dma_mode        -       set host controller for DMA mode
 135  *      @hwif: port
 136  *      @drive: drive
 137  *
 138  *      Configure the hardware for the desired IDE transfer mode.
 139  */
 140
 141 static void ali_set_dma_mode(ide_hwif_t *hwif, ide_drive_t *drive)
 142 {
 143         struct pci_dev *dev     = to_pci_dev(hwif->dev);
 144         const u8 speed          = drive->dma_mode;
 145         u8 speed1               = speed;
 146         u8 unit                 = drive->dn & 1;
 147         u8 tmpbyte              = 0x00;
 148         int m5229_udma          = (hwif->channel) ? 0x57 : 0x56;
 149
 150         if (speed == XFER_UDMA_6)
 151                 speed1 = 0x47;
 152
 153         if (speed < XFER_UDMA_0) {
 154                 u8 ultra_enable = (unit) ? 0x7f : 0xf7;
 155                 /*
 156                  * clear "ultra enable" bit
 157                  */
 158                 pci_read_config_byte(dev, m5229_udma, &tmpbyte);
 159                 tmpbyte &= ultra_enable;
 160                 pci_write_config_byte(dev, m5229_udma, tmpbyte);
 161
 162                 /*
 163                  * FIXME: Oh, my... DMA timings are never set.
 164                  */
 165         } else {
 166                 pci_read_config_byte(dev, m5229_udma, &tmpbyte);
 167                 tmpbyte &= (0x0f << ((1-unit) << 2));
 168                 /*
 169                  * enable ultra dma and set timing
 170                  */
 171                 tmpbyte |= ((0x08 | ((4-speed1)&0x07)) << (unit << 2));
 172                 pci_write_config_byte(dev, m5229_udma, tmpbyte);
 173                 if (speed >= XFER_UDMA_3) {
 174                         pci_read_config_byte(dev, 0x4b, &tmpbyte);
 175                         tmpbyte |= 1;
 176                         pci_write_config_byte(dev, 0x4b, tmpbyte);
 177                 }
 178         }
 179 }
 180
 181 /**
 182  *      ali_dma_check   -       DMA check
 183  *      @drive: target device
 184  *      @cmd: command
 185  *
 186  *      Returns 1 if the DMA cannot be performed, zero on success.
 187  */
 188
 189 static int ali_dma_check(ide_drive_t *drive, struct ide_cmd *cmd)
 190 {
 191         if (m5229_revision < 0xC2 && drive->media != ide_disk) {
 192                 if (cmd->tf_flags & IDE_TFLAG_WRITE)
 193                         return 1;       /* try PIO instead of DMA */
 194         }
 195         return 0;
 196 }
 197
 198 /**
 199  *      init_chipset_ali15x3    -       Initialise an ALi IDE controller
 200  *      @dev: PCI device
 201  *
 202  *      This function initializes the ALI IDE controller and where
 203  *      appropriate also sets up the 1533 southbridge.
 204  */
 205
 206 static int init_chipset_ali15x3(struct pci_dev *dev)
 207 {
 208         unsigned long flags;
 209         u8 tmpbyte;
 210         struct pci_dev *north = pci_get_slot(dev->bus, PCI_DEVFN(0,0));
 211
 212         m5229_revision = dev->revision;
 213
 214         isa_dev = pci_get_device(PCI_VENDOR_ID_AL, PCI_DEVICE_ID_AL_M1533, NULL);
 215
 216         local_irq_save(flags);
 217
 218         if (m5229_revision < 0xC2) {
 219                 /*
 220                  * revision 0x20 (1543-E, 1543-F)
 221                  * revision 0xC0, 0xC1 (1543C-C, 1543C-D, 1543C-E)
 222                  * clear CD-ROM DMA write bit, m5229, 0x4b, bit 7
 223                  */
 224                 pci_read_config_byte(dev, 0x4b, &tmpbyte);
 225                 /*
 226                  * clear bit 7
 227                  */
 228                 pci_write_config_byte(dev, 0x4b, tmpbyte & 0x7F);
 229                 /*
 230                  * check m1533, 0x5e, bit 1~4 == 1001 => & 00011110 = 00010010
 231                  */
 232                 if (m5229_revision >= 0x20 && isa_dev) {
 233                         pci_read_config_byte(isa_dev, 0x5e, &tmpbyte);
 234                         chip_is_1543c_e = ((tmpbyte & 0x1e) == 0x12) ? 1: 0;
 235                 }
 236                 goto out;
 237         }
 238
 239         /*
 240          * 1543C-B?, 1535, 1535D, 1553
 241          * Note 1: not all "motherboard" support this detection
 242          * Note 2: if no udma 66 device, the detection may "error".
 243          *         but in this case, we will not set the device to
 244          *         ultra 66, the detection result is not important
 245          */
 246
 247         /*
 248          * enable "Cable Detection", m5229, 0x4b, bit3
 249          */
 250         pci_read_config_byte(dev, 0x4b, &tmpbyte);
 251         pci_write_config_byte(dev, 0x4b, tmpbyte | 0x08);
 252
 253         /*
 254          * We should only tune the 1533 enable if we are using an ALi
 255          * North bridge. We might have no north found on some zany
 256          * box without a device at 0:0.0. The ALi bridge will be at
 257          * 0:0.0 so if we didn't find one we know what is cooking.
 258          */
 259         if (north && north->vendor != PCI_VENDOR_ID_AL)
 260                 goto out;
 261
 262         if (m5229_revision < 0xC5 && isa_dev)
 263         {
 264                 /*
 265                  * set south-bridge's enable bit, m1533, 0x79
 266                  */
 267
 268                 pci_read_config_byte(isa_dev, 0x79, &tmpbyte);
 269                 if (m5229_revision == 0xC2) {
 270                         /*
 271                          * 1543C-B0 (m1533, 0x79, bit 2)
 272                          */
 273                         pci_write_config_byte(isa_dev, 0x79, tmpbyte | 0x04);
 274                 } else if (m5229_revision >= 0xC3) {
 275                         /*
 276                          * 1553/1535 (m1533, 0x79, bit 1)
 277                          */
 278                         pci_write_config_byte(isa_dev, 0x79, tmpbyte | 0x02);
 279                 }
 280         }
 281
 282 out:
 283         /*
 284          * CD_ROM DMA on (m5229, 0x53, bit0)
 285          *      Enable this bit even if we want to use PIO.
 286          * PIO FIFO off (m5229, 0x53, bit1)
 287          *      The hardware will use 0x54h and 0x55h to control PIO FIFO.
 288          *      (Not on later devices it seems)
 289          *
 290          *      0x53 changes meaning on later revs - we must no touch
 291          *      bit 1 on them.  Need to check if 0x20 is the right break.
 292          */
 293         if (m5229_revision >= 0x20) {
 294                 pci_read_config_byte(dev, 0x53, &tmpbyte);
 295
 296                 if (m5229_revision <= 0x20)
 297                         tmpbyte = (tmpbyte & (~0x02)) | 0x01;
 298                 else if (m5229_revision == 0xc7 || m5229_revision == 0xc8)
 299                         tmpbyte |= 0x03;
 300                 else
 301                         tmpbyte |= 0x01;
 302
 303                 pci_write_config_byte(dev, 0x53, tmpbyte);
 304         }
 305         pci_dev_put(north);
 306         pci_dev_put(isa_dev);
 307         local_irq_restore(flags);
 308         return 0;
 309 }
 310
 311 /*
 312  *      Cable special cases
 313  */
 314
 315 static const struct dmi_system_id cable_dmi_table[] = {
 316         {
 317                 .ident = "HP Pavilion N5430",
 318                 .matches = {
 319                         DMI_MATCH(DMI_BOARD_VENDOR, "Hewlett-Packard"),
 320                         DMI_MATCH(DMI_BOARD_VERSION, "OmniBook N32N-736"),
 321                 },
 322         },
 323         {
 324                 .ident = "Toshiba Satellite S1800-814",
 325                 .matches = {
 326                         DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
 327                         DMI_MATCH(DMI_PRODUCT_NAME, "S1800-814"),
 328                 },
 329         },
 330         { }
 331 };
 332
 333 static int ali_cable_override(struct pci_dev *pdev)
 334 {
 335         /* Fujitsu P2000 */
 336         if (pdev->subsystem_vendor == 0x10CF &&
 337             pdev->subsystem_device == 0x10AF)
 338                 return 1;
 339
 340         /* Mitac 8317 (Winbook-A) and relatives */
 341         if (pdev->subsystem_vendor == 0x1071 &&
 342             pdev->subsystem_device == 0x8317)
 343                 return 1;
 344
 345         /* Systems by DMI */
 346         if (dmi_check_system(cable_dmi_table))
 347                 return 1;
 348
 349         return 0;
 350 }
 351
 352 /**
 353  *      ali_cable_detect        -       cable detection
 354  *      @hwif: IDE interface
 355  *
 356  *      This checks if the controller and the cable are capable
 357  *      of UDMA66 transfers. It doesn't check the drives.
 358  */
 359
 360 static u8 ali_cable_detect(ide_hwif_t *hwif)
 361 {
 362         struct pci_dev *dev = to_pci_dev(hwif->dev);
 363         u8 cbl = ATA_CBL_PATA40, tmpbyte;
 364
 365         if (m5229_revision >= 0xC2) {
 366                 /*
 367                  * m5229 80-pin cable detection (from Host View)
 368                  *
 369                  * 0x4a bit0 is 0 => primary channel has 80-pin
 370                  * 0x4a bit1 is 0 => secondary channel has 80-pin
 371                  *
 372                  * Certain laptops use short but suitable cables
 373                  * and don't implement the detect logic.
 374                  */
 375                 if (ali_cable_override(dev))
 376                         cbl = ATA_CBL_PATA40_SHORT;
 377                 else {
 378                         pci_read_config_byte(dev, 0x4a, &tmpbyte);
 379                         if ((tmpbyte & (1 << hwif->channel)) == 0)
 380                                 cbl = ATA_CBL_PATA80;
 381                 }
 382         }
 383
 384         return cbl;
 385 }
 386
 387 #ifndef CONFIG_SPARC64
 388 /**
 389  *      init_hwif_ali15x3       -       Initialize the ALI IDE x86 stuff
 390  *      @hwif: interface to configure
 391  *
 392  *      Obtain the IRQ tables for an ALi based IDE solution on the PC
 393  *      class platforms. This part of the code isn't applicable to the
 394  *      Sparc systems.
 395  */
 396
 397 static void __devinit init_hwif_ali15x3 (ide_hwif_t *hwif)
 398 {
 399         u8 ideic, inmir;
 400         s8 irq_routing_table[] = { -1,  9, 3, 10, 4,  5, 7,  6,
 401                                       1, 11, 0, 12, 0, 14, 0, 15 };
 402         int irq = -1;
 403
 404         if (isa_dev) {
 405                 /*
 406                  * read IDE interface control
 407                  */
 408                 pci_read_config_byte(isa_dev, 0x58, &ideic);
 409
 410                 /* bit0, bit1 */
 411                 ideic = ideic & 0x03;
 412
 413                 /* get IRQ for IDE Controller */
 414                 if ((hwif->channel && ideic == 0x03) ||
 415                     (!hwif->channel && !ideic)) {
 416                         /*
 417                          * get SIRQ1 routing table
 418                          */
 419                         pci_read_config_byte(isa_dev, 0x44, &inmir);
 420                         inmir = inmir & 0x0f;
 421                         irq = irq_routing_table[inmir];
 422                 } else if (hwif->channel && !(ideic & 0x01)) {
 423                         /*
 424                          * get SIRQ2 routing table
 425                          */
 426                         pci_read_config_byte(isa_dev, 0x75, &inmir);
 427                         inmir = inmir & 0x0f;
 428                         irq = irq_routing_table[inmir];
 429                 }
 430                 if(irq >= 0)
 431                         hwif->irq = irq;
 432         }
 433 }
 434 #else
 435 #define init_hwif_ali15x3 NULL
 436 #endif /* CONFIG_SPARC64 */
 437
 438 /**
 439  *      init_dma_ali15x3        -       set up DMA on ALi15x3
 440  *      @hwif: IDE interface
 441  *      @d: IDE port info
 442  *
 443  *      Set up the DMA functionality on the ALi 15x3.
 444  */
 445
 446 static int __devinit init_dma_ali15x3(ide_hwif_t *hwif,
 447                                       const struct ide_port_info *d)
 448 {
 449         struct pci_dev *dev = to_pci_dev(hwif->dev);
 450         unsigned long base = ide_pci_dma_base(hwif, d);
 451
 452         if (base == 0)
 453                 return -1;
 454
 455         hwif->dma_base = base;
 456
 457         if (ide_pci_check_simplex(hwif, d) < 0)
 458                 return -1;
 459
 460         if (ide_pci_set_master(dev, d->name) < 0)
 461                 return -1;
 462
 463         if (!hwif->channel)
 464                 outb(inb(base + 2) & 0x60, base + 2);
 465
 466         printk(KERN_INFO "    %s: BM-DMA at 0x%04lx-0x%04lx\n",
 467                          hwif->name, base, base + 7);
 468
 469         if (ide_allocate_dma_engine(hwif))
 470                 return -1;
 471
 472         return 0;
 473 }
 474
 475 static const struct ide_port_ops ali_port_ops = {
 476         .set_pio_mode           = ali_set_pio_mode,
 477         .set_dma_mode           = ali_set_dma_mode,
 478         .udma_filter            = ali_udma_filter,
 479         .cable_detect           = ali_cable_detect,
 480 };
 481
 482 static const struct ide_dma_ops ali_dma_ops = {
 483         .dma_host_set           = ide_dma_host_set,
 484         .dma_setup              = ide_dma_setup,
 485         .dma_start              = ide_dma_start,
 486         .dma_end                = ide_dma_end,
 487         .dma_test_irq           = ide_dma_test_irq,
 488         .dma_lost_irq           = ide_dma_lost_irq,
 489         .dma_check              = ali_dma_check,
 490         .dma_timer_expiry       = ide_dma_sff_timer_expiry,
 491         .dma_sff_read_status    = ide_dma_sff_read_status,
 492 };
 493
 494 static const struct ide_port_info ali15x3_chipset __devinitdata = {
 495         .name           = DRV_NAME,
 496         .init_chipset   = init_chipset_ali15x3,
 497         .init_hwif      = init_hwif_ali15x3,
 498         .init_dma       = init_dma_ali15x3,
 499         .port_ops       = &ali_port_ops,
 500         .dma_ops        = &sff_dma_ops,
 501         .pio_mask       = ATA_PIO5,
 502         .swdma_mask     = ATA_SWDMA2,
 503         .mwdma_mask     = ATA_MWDMA2,
 504 };
 505
 506 /**
 507  *      alim15x3_init_one       -       set up an ALi15x3 IDE controller
 508  *      @dev: PCI device to set up
 509  *
 510  *      Perform the actual set up for an ALi15x3 that has been found by the
 511  *      hot plug layer.
 512  */
 513
 514 static int __devinit alim15x3_init_one(struct pci_dev *dev, const struct pci_device_id *id)
 515 {
 516         struct ide_port_info d = ali15x3_chipset;
 517         u8 rev = dev->revision, idx = id->driver_data;
 518
 519         /* don't use LBA48 DMA on ALi devices before rev 0xC5 */
 520         if (rev <= 0xC4)
 521                 d.host_flags |= IDE_HFLAG_NO_LBA48_DMA;
 522
 523         if (rev >= 0x20) {
 524                 if (rev == 0x20)
 525                         d.host_flags |= IDE_HFLAG_NO_ATAPI_DMA;
 526
 527                 if (rev < 0xC2)
 528                         d.udma_mask = ATA_UDMA2;
 529                 else if (rev == 0xC2 || rev == 0xC3)
 530                         d.udma_mask = ATA_UDMA4;
 531                 else if (rev == 0xC4)
 532                         d.udma_mask = ATA_UDMA5;
 533                 else
 534                         d.udma_mask = ATA_UDMA6;
 535
 536                 d.dma_ops = &ali_dma_ops;
 537         } else {
 538                 d.host_flags |= IDE_HFLAG_NO_DMA;
 539
 540                 d.mwdma_mask = d.swdma_mask = 0;
 541         }
 542
 543         if (idx == 0)
 544                 d.host_flags |= IDE_HFLAG_CLEAR_SIMPLEX;
 545
 546         return ide_pci_init_one(dev, &d, NULL);
 547 }
 548
 549
 550 static const struct pci_device_id alim15x3_pci_tbl[] = {
 551         { PCI_VDEVICE(AL, PCI_DEVICE_ID_AL_M5229), 0 },
 552         { PCI_VDEVICE(AL, PCI_DEVICE_ID_AL_M5228), 1 },
 553         { 0, },
 554 };
 555 MODULE_DEVICE_TABLE(pci, alim15x3_pci_tbl);
 556
 557 static struct pci_driver alim15x3_pci_driver = {
 558         .name           = "ALI15x3_IDE",
 559         .id_table       = alim15x3_pci_tbl,
 560         .probe          = alim15x3_init_one,
 561         .remove         = ide_pci_remove,
 562         .suspend        = ide_pci_suspend,
 563         .resume         = ide_pci_resume,
 564 };
 565
 566 static int __init ali15x3_ide_init(void)
 567 {
 568         return ide_pci_register_driver(&alim15x3_pci_driver);
 569 }
 570
 571 static void __exit ali15x3_ide_exit(void)
 572 {
 573         pci_unregister_driver(&alim15x3_pci_driver);
 574 }
 575
 576 module_init(ali15x3_ide_init);
 577 module_exit(ali15x3_ide_exit);
 578
 579 MODULE_AUTHOR("Michael Aubry, Andrzej Krzysztofowicz, CJ, Andre Hedrick, Alan Cox, Bartlomiej Zolnierkiewicz");
 580 MODULE_DESCRIPTION("PCI driver module for ALi 15x3 IDE");
 581 MODULE_LICENSE("GPL");