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