drivers/ide/ide-lib.c

   1 #include <linux/module.h>
   2 #include <linux/types.h>
   3 #include <linux/string.h>
   4 #include <linux/kernel.h>
   5 #include <linux/timer.h>
   6 #include <linux/mm.h>
   7 #include <linux/interrupt.h>
   8 #include <linux/major.h>
   9 #include <linux/errno.h>
  10 #include <linux/genhd.h>
  11 #include <linux/blkpg.h>
  12 #include <linux/slab.h>
  13 #include <linux/pci.h>
  14 #include <linux/delay.h>
  15 #include <linux/hdreg.h>
  16 #include <linux/ide.h>
  17 #include <linux/bitops.h>
  18
  19 #include <asm/byteorder.h>
  20 #include <asm/irq.h>
  21 #include <asm/uaccess.h>
  22 #include <asm/io.h>
  23
  24 /*
  25  *      IDE library routines. These are plug in code that most
  26  *      drivers can use but occasionally may be weird enough
  27  *      to want to do their own thing with
  28  *
  29  *      Add common non I/O op stuff here. Make sure it has proper
  30  *      kernel-doc function headers or your patch will be rejected
  31  */
  32
  33
  34 /**
  35  *      ide_xfer_verbose        -       return IDE mode names
  36  *      @xfer_rate: rate to name
  37  *
  38  *      Returns a constant string giving the name of the mode
  39  *      requested.
  40  */
  41
  42 char *ide_xfer_verbose (u8 xfer_rate)
  43 {
  44         switch(xfer_rate) {
  45                 case XFER_UDMA_7:       return("UDMA 7");
  46                 case XFER_UDMA_6:       return("UDMA 6");
  47                 case XFER_UDMA_5:       return("UDMA 5");
  48                 case XFER_UDMA_4:       return("UDMA 4");
  49                 case XFER_UDMA_3:       return("UDMA 3");
  50                 case XFER_UDMA_2:       return("UDMA 2");
  51                 case XFER_UDMA_1:       return("UDMA 1");
  52                 case XFER_UDMA_0:       return("UDMA 0");
  53                 case XFER_MW_DMA_2:     return("MW DMA 2");
  54                 case XFER_MW_DMA_1:     return("MW DMA 1");
  55                 case XFER_MW_DMA_0:     return("MW DMA 0");
  56                 case XFER_SW_DMA_2:     return("SW DMA 2");
  57                 case XFER_SW_DMA_1:     return("SW DMA 1");
  58                 case XFER_SW_DMA_0:     return("SW DMA 0");
  59                 case XFER_PIO_4:        return("PIO 4");
  60                 case XFER_PIO_3:        return("PIO 3");
  61                 case XFER_PIO_2:        return("PIO 2");
  62                 case XFER_PIO_1:        return("PIO 1");
  63                 case XFER_PIO_0:        return("PIO 0");
  64                 case XFER_PIO_SLOW:     return("PIO SLOW");
  65                 default:                return("XFER ERROR");
  66         }
  67 }
  68
  69 EXPORT_SYMBOL(ide_xfer_verbose);
  70
  71 /**
  72  *      ide_rate_filter         -       filter transfer mode
  73  *      @drive: IDE device
  74  *      @speed: desired speed
  75  *
  76  *      Given the available transfer modes this function returns
  77  *      the best available speed at or below the speed requested.
  78  *
  79  *      FIXME: filter also PIO/SWDMA/MWDMA modes
  80  */
  81
  82 u8 ide_rate_filter(ide_drive_t *drive, u8 speed)
  83 {
  84 #ifdef CONFIG_BLK_DEV_IDEDMA
  85         ide_hwif_t *hwif = drive->hwif;
  86         u8 mask = hwif->ultra_mask, mode = XFER_MW_DMA_2;
  87
  88         if (hwif->udma_filter)
  89                 mask = hwif->udma_filter(drive);
  90
  91         /*
  92          * TODO: speed > XFER_UDMA_2 extra check is needed to avoid false
  93          * cable warning from eighty_ninty_three(), moving ide_rate_filter()
  94          * calls from ->speedproc to core code will make this hack go away
  95          */
  96         if (speed > XFER_UDMA_2) {
  97                 if ((mask & 0x78) && (eighty_ninty_three(drive) == 0))
  98                         mask &= 0x07;
  99         }
 100
 101         if (mask)
 102                 mode = fls(mask) - 1 + XFER_UDMA_0;
 103
 104 //      printk("%s: mode 0x%02x, speed 0x%02x\n", __FUNCTION__, mode, speed);
 105
 106         return min(speed, mode);
 107 #else /* !CONFIG_BLK_DEV_IDEDMA */
 108         return min(speed, (u8)XFER_PIO_4);
 109 #endif /* CONFIG_BLK_DEV_IDEDMA */
 110 }
 111
 112 EXPORT_SYMBOL(ide_rate_filter);
 113
 114 int ide_use_fast_pio(ide_drive_t *drive)
 115 {
 116         struct hd_driveid *id = drive->id;
 117
 118         if ((id->capability & 1) && drive->autodma)
 119                 return 1;
 120
 121         if ((id->capability & 8) || (id->field_valid & 2))
 122                 return 1;
 123
 124         return 0;
 125 }
 126
 127 EXPORT_SYMBOL_GPL(ide_use_fast_pio);
 128
 129 /*
 130  * Standard (generic) timings for PIO modes, from ATA2 specification.
 131  * These timings are for access to the IDE data port register *only*.
 132  * Some drives may specify a mode, while also specifying a different
 133  * value for cycle_time (from drive identification data).
 134  */
 135 const ide_pio_timings_t ide_pio_timings[6] = {
 136         { 70,   165,    600 },  /* PIO Mode 0 */
 137         { 50,   125,    383 },  /* PIO Mode 1 */
 138         { 30,   100,    240 },  /* PIO Mode 2 */
 139         { 30,   80,     180 },  /* PIO Mode 3 with IORDY */
 140         { 25,   70,     120 },  /* PIO Mode 4 with IORDY */
 141         { 20,   50,     100 }   /* PIO Mode 5 with IORDY (nonstandard) */
 142 };
 143
 144 EXPORT_SYMBOL_GPL(ide_pio_timings);
 145
 146 /*
 147  * Shared data/functions for determining best PIO mode for an IDE drive.
 148  * Most of this stuff originally lived in cmd640.c, and changes to the
 149  * ide_pio_blacklist[] table should be made with EXTREME CAUTION to avoid
 150  * breaking the fragile cmd640.c support.
 151  */
 152
 153 /*
 154  * Black list. Some drives incorrectly report their maximal PIO mode,
 155  * at least in respect to CMD640. Here we keep info on some known drives.
 156  */
 157 static struct ide_pio_info {
 158         const char      *name;
 159         int             pio;
 160 } ide_pio_blacklist [] = {
 161 /*      { "Conner Peripherals 1275MB - CFS1275A", 4 }, */
 162         { "Conner Peripherals 540MB - CFS540A", 3 },
 163
 164         { "WDC AC2700",  3 },
 165         { "WDC AC2540",  3 },
 166         { "WDC AC2420",  3 },
 167         { "WDC AC2340",  3 },
 168         { "WDC AC2250",  0 },
 169         { "WDC AC2200",  0 },
 170         { "WDC AC21200", 4 },
 171         { "WDC AC2120",  0 },
 172         { "WDC AC2850",  3 },
 173         { "WDC AC1270",  3 },
 174         { "WDC AC1170",  1 },
 175         { "WDC AC1210",  1 },
 176         { "WDC AC280",   0 },
 177 /*      { "WDC AC21000", 4 }, */
 178         { "WDC AC31000", 3 },
 179         { "WDC AC31200", 3 },
 180 /*      { "WDC AC31600", 4 }, */
 181
 182         { "Maxtor 7131 AT", 1 },
 183         { "Maxtor 7171 AT", 1 },
 184         { "Maxtor 7213 AT", 1 },
 185         { "Maxtor 7245 AT", 1 },
 186         { "Maxtor 7345 AT", 1 },
 187         { "Maxtor 7546 AT", 3 },
 188         { "Maxtor 7540 AV", 3 },
 189
 190         { "SAMSUNG SHD-3121A", 1 },
 191         { "SAMSUNG SHD-3122A", 1 },
 192         { "SAMSUNG SHD-3172A", 1 },
 193
 194 /*      { "ST51080A", 4 },
 195  *      { "ST51270A", 4 },
 196  *      { "ST31220A", 4 },
 197  *      { "ST31640A", 4 },
 198  *      { "ST32140A", 4 },
 199  *      { "ST3780A",  4 },
 200  */
 201         { "ST5660A",  3 },
 202         { "ST3660A",  3 },
 203         { "ST3630A",  3 },
 204         { "ST3655A",  3 },
 205         { "ST3391A",  3 },
 206         { "ST3390A",  1 },
 207         { "ST3600A",  1 },
 208         { "ST3290A",  0 },
 209         { "ST3144A",  0 },
 210         { "ST3491A",  1 },      /* reports 3, should be 1 or 2 (depending on */
 211                                 /* drive) according to Seagates FIND-ATA program */
 212
 213         { "QUANTUM ELS127A", 0 },
 214         { "QUANTUM ELS170A", 0 },
 215         { "QUANTUM LPS240A", 0 },
 216         { "QUANTUM LPS210A", 3 },
 217         { "QUANTUM LPS270A", 3 },
 218         { "QUANTUM LPS365A", 3 },
 219         { "QUANTUM LPS540A", 3 },
 220         { "QUANTUM LIGHTNING 540A", 3 },
 221         { "QUANTUM LIGHTNING 730A", 3 },
 222
 223         { "QUANTUM FIREBALL_540", 3 }, /* Older Quantum Fireballs don't work */
 224         { "QUANTUM FIREBALL_640", 3 },
 225         { "QUANTUM FIREBALL_1080", 3 },
 226         { "QUANTUM FIREBALL_1280", 3 },
 227         { NULL, 0 }
 228 };
 229
 230 /**
 231  *      ide_scan_pio_blacklist  -       check for a blacklisted drive
 232  *      @model: Drive model string
 233  *
 234  *      This routine searches the ide_pio_blacklist for an entry
 235  *      matching the start/whole of the supplied model name.
 236  *
 237  *      Returns -1 if no match found.
 238  *      Otherwise returns the recommended PIO mode from ide_pio_blacklist[].
 239  */
 240
 241 static int ide_scan_pio_blacklist (char *model)
 242 {
 243         struct ide_pio_info *p;
 244
 245         for (p = ide_pio_blacklist; p->name != NULL; p++) {
 246                 if (strncmp(p->name, model, strlen(p->name)) == 0)
 247                         return p->pio;
 248         }
 249         return -1;
 250 }
 251
 252 /**
 253  *      ide_get_best_pio_mode   -       get PIO mode from drive
 254  *      @drive: drive to consider
 255  *      @mode_wanted: preferred mode
 256  *      @max_mode: highest allowed mode
 257  *      @d: PIO data
 258  *
 259  *      This routine returns the recommended PIO settings for a given drive,
 260  *      based on the drive->id information and the ide_pio_blacklist[].
 261  *
 262  *      Drive PIO mode is auto-selected if 255 is passed as mode_wanted.
 263  *      This is used by most chipset support modules when "auto-tuning".
 264  */
 265
 266 u8 ide_get_best_pio_mode (ide_drive_t *drive, u8 mode_wanted, u8 max_mode, ide_pio_data_t *d)
 267 {
 268         int pio_mode;
 269         int cycle_time = 0;
 270         int use_iordy = 0;
 271         struct hd_driveid* id = drive->id;
 272         int overridden  = 0;
 273
 274         if (mode_wanted != 255) {
 275                 pio_mode = mode_wanted;
 276                 use_iordy = (pio_mode > 2);
 277         } else if (!drive->id) {
 278                 pio_mode = 0;
 279         } else if ((pio_mode = ide_scan_pio_blacklist(id->model)) != -1) {
 280                 overridden = 1;
 281                 use_iordy = (pio_mode > 2);
 282         } else {
 283                 pio_mode = id->tPIO;
 284                 if (pio_mode > 2) {     /* 2 is maximum allowed tPIO value */
 285                         pio_mode = 2;
 286                         overridden = 1;
 287                 }
 288                 if (id->field_valid & 2) {        /* drive implements ATA2? */
 289                         if (id->capability & 8) { /* drive supports use_iordy? */
 290                                 use_iordy = 1;
 291                                 cycle_time = id->eide_pio_iordy;
 292                                 if (id->eide_pio_modes & 7) {
 293                                         overridden = 0;
 294                                         if (id->eide_pio_modes & 4)
 295                                                 pio_mode = 5;
 296                                         else if (id->eide_pio_modes & 2)
 297                                                 pio_mode = 4;
 298                                         else
 299                                                 pio_mode = 3;
 300                                 }
 301                         } else {
 302                                 cycle_time = id->eide_pio;
 303                         }
 304                 }
 305
 306                 /*
 307                  * Conservative "downgrade" for all pre-ATA2 drives
 308                  */
 309                 if (pio_mode && pio_mode < 4) {
 310                         pio_mode--;
 311                         overridden = 1;
 312                         if (cycle_time && cycle_time < ide_pio_timings[pio_mode].cycle_time)
 313                                 cycle_time = 0; /* use standard timing */
 314                 }
 315         }
 316         if (pio_mode > max_mode) {
 317                 pio_mode = max_mode;
 318                 cycle_time = 0;
 319         }
 320         if (d) {
 321                 d->pio_mode = pio_mode;
 322                 d->cycle_time = cycle_time ? cycle_time : ide_pio_timings[pio_mode].cycle_time;
 323                 d->use_iordy = use_iordy;
 324                 d->overridden = overridden;
 325         }
 326         return pio_mode;
 327 }
 328
 329 EXPORT_SYMBOL_GPL(ide_get_best_pio_mode);
 330
 331 /**
 332  *      ide_toggle_bounce       -       handle bounce buffering
 333  *      @drive: drive to update
 334  *      @on: on/off boolean
 335  *
 336  *      Enable or disable bounce buffering for the device. Drives move
 337  *      between PIO and DMA and that changes the rules we need.
 338  */
 339
 340 void ide_toggle_bounce(ide_drive_t *drive, int on)
 341 {
 342         u64 addr = BLK_BOUNCE_HIGH;     /* dma64_addr_t */
 343
 344         if (!PCI_DMA_BUS_IS_PHYS) {
 345                 addr = BLK_BOUNCE_ANY;
 346         } else if (on && drive->media == ide_disk) {
 347                 if (HWIF(drive)->pci_dev)
 348                         addr = HWIF(drive)->pci_dev->dma_mask;
 349         }
 350
 351         if (drive->queue)
 352                 blk_queue_bounce_limit(drive->queue, addr);
 353 }
 354
 355 /**
 356  *      ide_set_xfer_rate       -       set transfer rate
 357  *      @drive: drive to set
 358  *      @speed: speed to attempt to set
 359  *
 360  *      General helper for setting the speed of an IDE device. This
 361  *      function knows about user enforced limits from the configuration
 362  *      which speedproc() does not.  High level drivers should never
 363  *      invoke speedproc() directly.
 364  */
 365
 366 int ide_set_xfer_rate(ide_drive_t *drive, u8 rate)
 367 {
 368 #ifndef CONFIG_BLK_DEV_IDEDMA
 369         rate = min(rate, (u8) XFER_PIO_4);
 370 #endif
 371         if(HWIF(drive)->speedproc)
 372                 return HWIF(drive)->speedproc(drive, rate);
 373         else
 374                 return -1;
 375 }
 376
 377 static void ide_dump_opcode(ide_drive_t *drive)
 378 {
 379         struct request *rq;
 380         u8 opcode = 0;
 381         int found = 0;
 382
 383         spin_lock(&ide_lock);
 384         rq = NULL;
 385         if (HWGROUP(drive))
 386                 rq = HWGROUP(drive)->rq;
 387         spin_unlock(&ide_lock);
 388         if (!rq)
 389                 return;
 390         if (rq->cmd_type == REQ_TYPE_ATA_CMD ||
 391             rq->cmd_type == REQ_TYPE_ATA_TASK) {
 392                 char *args = rq->buffer;
 393                 if (args) {
 394                         opcode = args[0];
 395                         found = 1;
 396                 }
 397         } else if (rq->cmd_type == REQ_TYPE_ATA_TASKFILE) {
 398                 ide_task_t *args = rq->special;
 399                 if (args) {
 400                         task_struct_t *tf = (task_struct_t *) args->tfRegister;
 401                         opcode = tf->command;
 402                         found = 1;
 403                 }
 404         }
 405
 406         printk("ide: failed opcode was: ");
 407         if (!found)
 408                 printk("unknown\n");
 409         else
 410                 printk("0x%02x\n", opcode);
 411 }
 412
 413 static u8 ide_dump_ata_status(ide_drive_t *drive, const char *msg, u8 stat)
 414 {
 415         ide_hwif_t *hwif = HWIF(drive);
 416         unsigned long flags;
 417         u8 err = 0;
 418
 419         local_irq_save(flags);
 420         printk("%s: %s: status=0x%02x { ", drive->name, msg, stat);
 421         if (stat & BUSY_STAT)
 422                 printk("Busy ");
 423         else {
 424                 if (stat & READY_STAT)  printk("DriveReady ");
 425                 if (stat & WRERR_STAT)  printk("DeviceFault ");
 426                 if (stat & SEEK_STAT)   printk("SeekComplete ");
 427                 if (stat & DRQ_STAT)    printk("DataRequest ");
 428                 if (stat & ECC_STAT)    printk("CorrectedError ");
 429                 if (stat & INDEX_STAT)  printk("Index ");
 430                 if (stat & ERR_STAT)    printk("Error ");
 431         }
 432         printk("}\n");
 433         if ((stat & (BUSY_STAT|ERR_STAT)) == ERR_STAT) {
 434                 err = hwif->INB(IDE_ERROR_REG);
 435                 printk("%s: %s: error=0x%02x { ", drive->name, msg, err);
 436                 if (err & ABRT_ERR)     printk("DriveStatusError ");
 437                 if (err & ICRC_ERR)
 438                         printk((err & ABRT_ERR) ? "BadCRC " : "BadSector ");
 439                 if (err & ECC_ERR)      printk("UncorrectableError ");
 440                 if (err & ID_ERR)       printk("SectorIdNotFound ");
 441                 if (err & TRK0_ERR)     printk("TrackZeroNotFound ");
 442                 if (err & MARK_ERR)     printk("AddrMarkNotFound ");
 443                 printk("}");
 444                 if ((err & (BBD_ERR | ABRT_ERR)) == BBD_ERR ||
 445                     (err & (ECC_ERR|ID_ERR|MARK_ERR))) {
 446                         if (drive->addressing == 1) {
 447                                 __u64 sectors = 0;
 448                                 u32 low = 0, high = 0;
 449                                 low = ide_read_24(drive);
 450                                 hwif->OUTB(drive->ctl|0x80, IDE_CONTROL_REG);
 451                                 high = ide_read_24(drive);
 452                                 sectors = ((__u64)high << 24) | low;
 453                                 printk(", LBAsect=%llu, high=%d, low=%d",
 454                                        (unsigned long long) sectors,
 455                                        high, low);
 456                         } else {
 457                                 u8 cur = hwif->INB(IDE_SELECT_REG);
 458                                 if (cur & 0x40) {       /* using LBA? */
 459                                         printk(", LBAsect=%ld", (unsigned long)
 460                                          ((cur&0xf)<<24)
 461                                          |(hwif->INB(IDE_HCYL_REG)<<16)
 462                                          |(hwif->INB(IDE_LCYL_REG)<<8)
 463                                          | hwif->INB(IDE_SECTOR_REG));
 464                                 } else {
 465                                         printk(", CHS=%d/%d/%d",
 466                                          (hwif->INB(IDE_HCYL_REG)<<8) +
 467                                           hwif->INB(IDE_LCYL_REG),
 468                                           cur & 0xf,
 469                                           hwif->INB(IDE_SECTOR_REG));
 470                                 }
 471                         }
 472                         if (HWGROUP(drive) && HWGROUP(drive)->rq)
 473                                 printk(", sector=%llu",
 474                                         (unsigned long long)HWGROUP(drive)->rq->sector);
 475                 }
 476                 printk("\n");
 477         }
 478         ide_dump_opcode(drive);
 479         local_irq_restore(flags);
 480         return err;
 481 }
 482
 483 /**
 484  *      ide_dump_atapi_status       -       print human readable atapi status
 485  *      @drive: drive that status applies to
 486  *      @msg: text message to print
 487  *      @stat: status byte to decode
 488  *
 489  *      Error reporting, in human readable form (luxurious, but a memory hog).
 490  */
 491
 492 static u8 ide_dump_atapi_status(ide_drive_t *drive, const char *msg, u8 stat)
 493 {
 494         unsigned long flags;
 495
 496         atapi_status_t status;
 497         atapi_error_t error;
 498
 499         status.all = stat;
 500         error.all = 0;
 501         local_irq_save(flags);
 502         printk("%s: %s: status=0x%02x { ", drive->name, msg, stat);
 503         if (status.b.bsy)
 504                 printk("Busy ");
 505         else {
 506                 if (status.b.drdy)      printk("DriveReady ");
 507                 if (status.b.df)        printk("DeviceFault ");
 508                 if (status.b.dsc)       printk("SeekComplete ");
 509                 if (status.b.drq)       printk("DataRequest ");
 510                 if (status.b.corr)      printk("CorrectedError ");
 511                 if (status.b.idx)       printk("Index ");
 512                 if (status.b.check)     printk("Error ");
 513         }
 514         printk("}\n");
 515         if (status.b.check && !status.b.bsy) {
 516                 error.all = HWIF(drive)->INB(IDE_ERROR_REG);
 517                 printk("%s: %s: error=0x%02x { ", drive->name, msg, error.all);
 518                 if (error.b.ili)        printk("IllegalLengthIndication ");
 519                 if (error.b.eom)        printk("EndOfMedia ");
 520                 if (error.b.abrt)       printk("AbortedCommand ");
 521                 if (error.b.mcr)        printk("MediaChangeRequested ");
 522                 if (error.b.sense_key)  printk("LastFailedSense=0x%02x ",
 523                                                 error.b.sense_key);
 524                 printk("}\n");
 525         }
 526         ide_dump_opcode(drive);
 527         local_irq_restore(flags);
 528         return error.all;
 529 }
 530
 531 /**
 532  *      ide_dump_status         -       translate ATA/ATAPI error
 533  *      @drive: drive the error occured on
 534  *      @msg: information string
 535  *      @stat: status byte
 536  *
 537  *      Error reporting, in human readable form (luxurious, but a memory hog).
 538  *      Combines the drive name, message and status byte to provide a
 539  *      user understandable explanation of the device error.
 540  */
 541
 542 u8 ide_dump_status(ide_drive_t *drive, const char *msg, u8 stat)
 543 {
 544         if (drive->media == ide_disk)
 545                 return ide_dump_ata_status(drive, msg, stat);
 546         return ide_dump_atapi_status(drive, msg, stat);
 547 }
 548
 549 EXPORT_SYMBOL(ide_dump_status);