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 static const char *udma_str[] =
  25          { "UDMA/16", "UDMA/25",  "UDMA/33",  "UDMA/44",
  26            "UDMA/66", "UDMA/100", "UDMA/133", "UDMA7" };
  27 static const char *mwdma_str[] =
  28         { "MWDMA0", "MWDMA1", "MWDMA2" };
  29 static const char *swdma_str[] =
  30         { "SWDMA0", "SWDMA1", "SWDMA2" };
  31 static const char *pio_str[] =
  32         { "PIO0", "PIO1", "PIO2", "PIO3", "PIO4", "PIO5" };
  33
  34 /**
  35  *      ide_xfer_verbose        -       return IDE mode names
  36  *      @mode: transfer mode
  37  *
  38  *      Returns a constant string giving the name of the mode
  39  *      requested.
  40  */
  41
  42 const char *ide_xfer_verbose(u8 mode)
  43 {
  44         const char *s;
  45         u8 i = mode & 0xf;
  46
  47         if (mode >= XFER_UDMA_0 && mode <= XFER_UDMA_7)
  48                 s = udma_str[i];
  49         else if (mode >= XFER_MW_DMA_0 && mode <= XFER_MW_DMA_2)
  50                 s = mwdma_str[i];
  51         else if (mode >= XFER_SW_DMA_0 && mode <= XFER_SW_DMA_2)
  52                 s = swdma_str[i];
  53         else if (mode >= XFER_PIO_0 && mode <= XFER_PIO_5)
  54                 s = pio_str[i & 0x7];
  55         else if (mode == XFER_PIO_SLOW)
  56                 s = "PIO SLOW";
  57         else
  58                 s = "XFER ERROR";
  59
  60         return s;
  61 }
  62
  63 EXPORT_SYMBOL(ide_xfer_verbose);
  64
  65 /**
  66  *      ide_rate_filter         -       filter transfer mode
  67  *      @drive: IDE device
  68  *      @speed: desired speed
  69  *
  70  *      Given the available transfer modes this function returns
  71  *      the best available speed at or below the speed requested.
  72  *
  73  *      TODO: check device PIO capabilities
  74  */
  75
  76 static u8 ide_rate_filter(ide_drive_t *drive, u8 speed)
  77 {
  78         ide_hwif_t *hwif = drive->hwif;
  79         u8 mode = ide_find_dma_mode(drive, speed);
  80
  81         if (mode == 0) {
  82                 if (hwif->pio_mask)
  83                         mode = fls(hwif->pio_mask) - 1 + XFER_PIO_0;
  84                 else
  85                         mode = XFER_PIO_4;
  86         }
  87
  88 //      printk("%s: mode 0x%02x, speed 0x%02x\n", __FUNCTION__, mode, speed);
  89
  90         return min(speed, mode);
  91 }
  92
  93 /*
  94  * Standard (generic) timings for PIO modes, from ATA2 specification.
  95  * These timings are for access to the IDE data port register *only*.
  96  * Some drives may specify a mode, while also specifying a different
  97  * value for cycle_time (from drive identification data).
  98  */
  99 const ide_pio_timings_t ide_pio_timings[6] = {
 100         { 70,   165,    600 },  /* PIO Mode 0 */
 101         { 50,   125,    383 },  /* PIO Mode 1 */
 102         { 30,   100,    240 },  /* PIO Mode 2 */
 103         { 30,   80,     180 },  /* PIO Mode 3 with IORDY */
 104         { 25,   70,     120 },  /* PIO Mode 4 with IORDY */
 105         { 20,   50,     100 }   /* PIO Mode 5 with IORDY (nonstandard) */
 106 };
 107
 108 EXPORT_SYMBOL_GPL(ide_pio_timings);
 109
 110 /*
 111  * Shared data/functions for determining best PIO mode for an IDE drive.
 112  * Most of this stuff originally lived in cmd640.c, and changes to the
 113  * ide_pio_blacklist[] table should be made with EXTREME CAUTION to avoid
 114  * breaking the fragile cmd640.c support.
 115  */
 116
 117 /*
 118  * Black list. Some drives incorrectly report their maximal PIO mode,
 119  * at least in respect to CMD640. Here we keep info on some known drives.
 120  */
 121 static struct ide_pio_info {
 122         const char      *name;
 123         int             pio;
 124 } ide_pio_blacklist [] = {
 125 /*      { "Conner Peripherals 1275MB - CFS1275A", 4 }, */
 126         { "Conner Peripherals 540MB - CFS540A", 3 },
 127
 128         { "WDC AC2700",  3 },
 129         { "WDC AC2540",  3 },
 130         { "WDC AC2420",  3 },
 131         { "WDC AC2340",  3 },
 132         { "WDC AC2250",  0 },
 133         { "WDC AC2200",  0 },
 134         { "WDC AC21200", 4 },
 135         { "WDC AC2120",  0 },
 136         { "WDC AC2850",  3 },
 137         { "WDC AC1270",  3 },
 138         { "WDC AC1170",  1 },
 139         { "WDC AC1210",  1 },
 140         { "WDC AC280",   0 },
 141 /*      { "WDC AC21000", 4 }, */
 142         { "WDC AC31000", 3 },
 143         { "WDC AC31200", 3 },
 144 /*      { "WDC AC31600", 4 }, */
 145
 146         { "Maxtor 7131 AT", 1 },
 147         { "Maxtor 7171 AT", 1 },
 148         { "Maxtor 7213 AT", 1 },
 149         { "Maxtor 7245 AT", 1 },
 150         { "Maxtor 7345 AT", 1 },
 151         { "Maxtor 7546 AT", 3 },
 152         { "Maxtor 7540 AV", 3 },
 153
 154         { "SAMSUNG SHD-3121A", 1 },
 155         { "SAMSUNG SHD-3122A", 1 },
 156         { "SAMSUNG SHD-3172A", 1 },
 157
 158 /*      { "ST51080A", 4 },
 159  *      { "ST51270A", 4 },
 160  *      { "ST31220A", 4 },
 161  *      { "ST31640A", 4 },
 162  *      { "ST32140A", 4 },
 163  *      { "ST3780A",  4 },
 164  */
 165         { "ST5660A",  3 },
 166         { "ST3660A",  3 },
 167         { "ST3630A",  3 },
 168         { "ST3655A",  3 },
 169         { "ST3391A",  3 },
 170         { "ST3390A",  1 },
 171         { "ST3600A",  1 },
 172         { "ST3290A",  0 },
 173         { "ST3144A",  0 },
 174         { "ST3491A",  1 },      /* reports 3, should be 1 or 2 (depending on */
 175                                 /* drive) according to Seagates FIND-ATA program */
 176
 177         { "QUANTUM ELS127A", 0 },
 178         { "QUANTUM ELS170A", 0 },
 179         { "QUANTUM LPS240A", 0 },
 180         { "QUANTUM LPS210A", 3 },
 181         { "QUANTUM LPS270A", 3 },
 182         { "QUANTUM LPS365A", 3 },
 183         { "QUANTUM LPS540A", 3 },
 184         { "QUANTUM LIGHTNING 540A", 3 },
 185         { "QUANTUM LIGHTNING 730A", 3 },
 186
 187         { "QUANTUM FIREBALL_540", 3 }, /* Older Quantum Fireballs don't work */
 188         { "QUANTUM FIREBALL_640", 3 },
 189         { "QUANTUM FIREBALL_1080", 3 },
 190         { "QUANTUM FIREBALL_1280", 3 },
 191         { NULL, 0 }
 192 };
 193
 194 /**
 195  *      ide_scan_pio_blacklist  -       check for a blacklisted drive
 196  *      @model: Drive model string
 197  *
 198  *      This routine searches the ide_pio_blacklist for an entry
 199  *      matching the start/whole of the supplied model name.
 200  *
 201  *      Returns -1 if no match found.
 202  *      Otherwise returns the recommended PIO mode from ide_pio_blacklist[].
 203  */
 204
 205 static int ide_scan_pio_blacklist (char *model)
 206 {
 207         struct ide_pio_info *p;
 208
 209         for (p = ide_pio_blacklist; p->name != NULL; p++) {
 210                 if (strncmp(p->name, model, strlen(p->name)) == 0)
 211                         return p->pio;
 212         }
 213         return -1;
 214 }
 215
 216 unsigned int ide_pio_cycle_time(ide_drive_t *drive, u8 pio)
 217 {
 218         struct hd_driveid *id = drive->id;
 219         int cycle_time = 0;
 220
 221         if (id->field_valid & 2) {
 222                 if (id->capability & 8)
 223                         cycle_time = id->eide_pio_iordy;
 224                 else
 225                         cycle_time = id->eide_pio;
 226         }
 227
 228         /* conservative "downgrade" for all pre-ATA2 drives */
 229         if (pio < 3) {
 230                 if (cycle_time && cycle_time < ide_pio_timings[pio].cycle_time)
 231                         cycle_time = 0; /* use standard timing */
 232         }
 233
 234         return cycle_time ? cycle_time : ide_pio_timings[pio].cycle_time;
 235 }
 236
 237 EXPORT_SYMBOL_GPL(ide_pio_cycle_time);
 238
 239 /**
 240  *      ide_get_best_pio_mode   -       get PIO mode from drive
 241  *      @drive: drive to consider
 242  *      @mode_wanted: preferred mode
 243  *      @max_mode: highest allowed mode
 244  *
 245  *      This routine returns the recommended PIO settings for a given drive,
 246  *      based on the drive->id information and the ide_pio_blacklist[].
 247  *
 248  *      Drive PIO mode is auto-selected if 255 is passed as mode_wanted.
 249  *      This is used by most chipset support modules when "auto-tuning".
 250  */
 251
 252 u8 ide_get_best_pio_mode (ide_drive_t *drive, u8 mode_wanted, u8 max_mode)
 253 {
 254         int pio_mode;
 255         struct hd_driveid* id = drive->id;
 256         int overridden  = 0;
 257
 258         if (mode_wanted != 255)
 259                 return min_t(u8, mode_wanted, max_mode);
 260
 261         if ((drive->hwif->host_flags & IDE_HFLAG_PIO_NO_BLACKLIST) == 0 &&
 262             (pio_mode = ide_scan_pio_blacklist(id->model)) != -1) {
 263                 printk(KERN_INFO "%s: is on PIO blacklist\n", drive->name);
 264         } else {
 265                 pio_mode = id->tPIO;
 266                 if (pio_mode > 2) {     /* 2 is maximum allowed tPIO value */
 267                         pio_mode = 2;
 268                         overridden = 1;
 269                 }
 270                 if (id->field_valid & 2) {        /* drive implements ATA2? */
 271                         if (id->capability & 8) { /* IORDY supported? */
 272                                 if (id->eide_pio_modes & 7) {
 273                                         overridden = 0;
 274                                         if (id->eide_pio_modes & 4)
 275                                                 pio_mode = 5;
 276                                         else if (id->eide_pio_modes & 2)
 277                                                 pio_mode = 4;
 278                                         else
 279                                                 pio_mode = 3;
 280                                 }
 281                         }
 282                 }
 283
 284                 if (overridden)
 285                         printk(KERN_INFO "%s: tPIO > 2, assuming tPIO = 2\n",
 286                                          drive->name);
 287
 288                 /*
 289                  * Conservative "downgrade" for all pre-ATA2 drives
 290                  */
 291                 if ((drive->hwif->host_flags & IDE_HFLAG_PIO_NO_DOWNGRADE) == 0 &&
 292                     pio_mode && pio_mode < 4) {
 293                         pio_mode--;
 294                         printk(KERN_INFO "%s: applying conservative "
 295                                          "PIO \"downgrade\"\n", drive->name);
 296                 }
 297         }
 298
 299         if (pio_mode > max_mode)
 300                 pio_mode = max_mode;
 301
 302         return pio_mode;
 303 }
 304
 305 EXPORT_SYMBOL_GPL(ide_get_best_pio_mode);
 306
 307 /* req_pio == "255" for auto-tune */
 308 void ide_set_pio(ide_drive_t *drive, u8 req_pio)
 309 {
 310         ide_hwif_t *hwif = drive->hwif;
 311         u8 host_pio, pio;
 312
 313         if (hwif->set_pio_mode == NULL)
 314                 return;
 315
 316         BUG_ON(hwif->pio_mask == 0x00);
 317
 318         host_pio = fls(hwif->pio_mask) - 1;
 319
 320         pio = ide_get_best_pio_mode(drive, req_pio, host_pio);
 321
 322         /*
 323          * TODO:
 324          * - report device max PIO mode
 325          * - check req_pio != 255 against device max PIO mode
 326          */
 327         printk(KERN_DEBUG "%s: host max PIO%d wanted PIO%d%s selected PIO%d\n",
 328                           drive->name, host_pio, req_pio,
 329                           req_pio == 255 ? "(auto-tune)" : "", pio);
 330
 331         (void)ide_set_pio_mode(drive, XFER_PIO_0 + pio);
 332 }
 333
 334 EXPORT_SYMBOL_GPL(ide_set_pio);
 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                 struct device *dev = drive->hwif->dev;
 353
 354                 if (dev && dev->dma_mask)
 355                         addr = *dev->dma_mask;
 356         }
 357
 358         if (drive->queue)
 359                 blk_queue_bounce_limit(drive->queue, addr);
 360 }
 361
 362 int ide_set_pio_mode(ide_drive_t *drive, const u8 mode)
 363 {
 364         ide_hwif_t *hwif = drive->hwif;
 365
 366         if (hwif->set_pio_mode == NULL)
 367                 return -1;
 368
 369         /*
 370          * TODO: temporary hack for some legacy host drivers that didn't
 371          * set transfer mode on the device in ->set_pio_mode method...
 372          */
 373         if (hwif->set_dma_mode == NULL) {
 374                 hwif->set_pio_mode(drive, mode - XFER_PIO_0);
 375                 return 0;
 376         }
 377
 378         if (hwif->host_flags & IDE_HFLAG_POST_SET_MODE) {
 379                 if (ide_config_drive_speed(drive, mode))
 380                         return -1;
 381                 hwif->set_pio_mode(drive, mode - XFER_PIO_0);
 382                 return 0;
 383         } else {
 384                 hwif->set_pio_mode(drive, mode - XFER_PIO_0);
 385                 return ide_config_drive_speed(drive, mode);
 386         }
 387 }
 388
 389 int ide_set_dma_mode(ide_drive_t *drive, const u8 mode)
 390 {
 391         ide_hwif_t *hwif = drive->hwif;
 392
 393         if (hwif->set_dma_mode == NULL)
 394                 return -1;
 395
 396         if (hwif->host_flags & IDE_HFLAG_POST_SET_MODE) {
 397                 if (ide_config_drive_speed(drive, mode))
 398                         return -1;
 399                 hwif->set_dma_mode(drive, mode);
 400                 return 0;
 401         } else {
 402                 hwif->set_dma_mode(drive, mode);
 403                 return ide_config_drive_speed(drive, mode);
 404         }
 405 }
 406
 407 EXPORT_SYMBOL_GPL(ide_set_dma_mode);
 408
 409 /**
 410  *      ide_set_xfer_rate       -       set transfer rate
 411  *      @drive: drive to set
 412  *      @rate: speed to attempt to set
 413  *
 414  *      General helper for setting the speed of an IDE device. This
 415  *      function knows about user enforced limits from the configuration
 416  *      which ->set_pio_mode/->set_dma_mode does not.
 417  */
 418
 419 int ide_set_xfer_rate(ide_drive_t *drive, u8 rate)
 420 {
 421         ide_hwif_t *hwif = drive->hwif;
 422
 423         if (hwif->set_dma_mode == NULL)
 424                 return -1;
 425
 426         rate = ide_rate_filter(drive, rate);
 427
 428         if (rate >= XFER_PIO_0 && rate <= XFER_PIO_5)
 429                 return ide_set_pio_mode(drive, rate);
 430
 431         /*
 432          * TODO: transfer modes 0x00-0x07 passed from the user-space are
 433          * currently handled here which needs fixing (please note that such
 434          * case could happen iff the transfer mode has already been set on
 435          * the device by ide-proc.c::set_xfer_rate()).
 436          */
 437         if (rate < XFER_PIO_0) {
 438                 if (hwif->host_flags & IDE_HFLAG_ABUSE_SET_DMA_MODE)
 439                         return ide_set_dma_mode(drive, rate);
 440                 else
 441                         return ide_config_drive_speed(drive, rate);
 442         }
 443
 444         return ide_set_dma_mode(drive, rate);
 445 }
 446
 447 static void ide_dump_opcode(ide_drive_t *drive)
 448 {
 449         struct request *rq;
 450         ide_task_t *task = NULL;
 451
 452         spin_lock(&ide_lock);
 453         rq = NULL;
 454         if (HWGROUP(drive))
 455                 rq = HWGROUP(drive)->rq;
 456         spin_unlock(&ide_lock);
 457         if (!rq)
 458                 return;
 459
 460         if (rq->cmd_type == REQ_TYPE_ATA_TASKFILE)
 461                 task = rq->special;
 462
 463         printk("ide: failed opcode was: ");
 464         if (task == NULL)
 465                 printk(KERN_CONT "unknown\n");
 466         else
 467                 printk(KERN_CONT "0x%02x\n", task->tf.command);
 468 }
 469
 470 u64 ide_get_lba_addr(struct ide_taskfile *tf, int lba48)
 471 {
 472         u32 high, low;
 473
 474         if (lba48)
 475                 high = (tf->hob_lbah << 16) | (tf->hob_lbam << 8) |
 476                         tf->hob_lbal;
 477         else
 478                 high = tf->device & 0xf;
 479         low  = (tf->lbah << 16) | (tf->lbam << 8) | tf->lbal;
 480
 481         return ((u64)high << 24) | low;
 482 }
 483 EXPORT_SYMBOL_GPL(ide_get_lba_addr);
 484
 485 static void ide_dump_sector(ide_drive_t *drive)
 486 {
 487         ide_task_t task;
 488         struct ide_taskfile *tf = &task.tf;
 489         int lba48 = (drive->addressing == 1) ? 1 : 0;
 490
 491         memset(&task, 0, sizeof(task));
 492         if (lba48)
 493                 task.tf_flags = IDE_TFLAG_IN_LBA | IDE_TFLAG_IN_HOB_LBA |
 494                                 IDE_TFLAG_LBA48;
 495         else
 496                 task.tf_flags = IDE_TFLAG_IN_LBA | IDE_TFLAG_IN_DEVICE;
 497
 498         ide_tf_read(drive, &task);
 499
 500         if (lba48 || (tf->device & ATA_LBA))
 501                 printk(", LBAsect=%llu",
 502                         (unsigned long long)ide_get_lba_addr(tf, lba48));
 503         else
 504                 printk(", CHS=%d/%d/%d", (tf->lbah << 8) + tf->lbam,
 505                                          tf->device & 0xf, tf->lbal);
 506 }
 507
 508 static void ide_dump_ata_error(ide_drive_t *drive, u8 err)
 509 {
 510         printk("{ ");
 511         if (err & ABRT_ERR)     printk("DriveStatusError ");
 512         if (err & ICRC_ERR)
 513                 printk((err & ABRT_ERR) ? "BadCRC " : "BadSector ");
 514         if (err & ECC_ERR)      printk("UncorrectableError ");
 515         if (err & ID_ERR)       printk("SectorIdNotFound ");
 516         if (err & TRK0_ERR)     printk("TrackZeroNotFound ");
 517         if (err & MARK_ERR)     printk("AddrMarkNotFound ");
 518         printk("}");
 519         if ((err & (BBD_ERR | ABRT_ERR)) == BBD_ERR ||
 520             (err & (ECC_ERR|ID_ERR|MARK_ERR))) {
 521                 ide_dump_sector(drive);
 522                 if (HWGROUP(drive) && HWGROUP(drive)->rq)
 523                         printk(", sector=%llu",
 524                                (unsigned long long)HWGROUP(drive)->rq->sector);
 525         }
 526         printk("\n");
 527 }
 528
 529 static void ide_dump_atapi_error(ide_drive_t *drive, u8 err)
 530 {
 531         printk("{ ");
 532         if (err & ILI_ERR)      printk("IllegalLengthIndication ");
 533         if (err & EOM_ERR)      printk("EndOfMedia ");
 534         if (err & ABRT_ERR)     printk("AbortedCommand ");
 535         if (err & MCR_ERR)      printk("MediaChangeRequested ");
 536         if (err & LFS_ERR)      printk("LastFailedSense=0x%02x ",
 537                                        (err & LFS_ERR) >> 4);
 538         printk("}\n");
 539 }
 540
 541 /**
 542  *      ide_dump_status         -       translate ATA/ATAPI error
 543  *      @drive: drive that status applies to
 544  *      @msg: text message to print
 545  *      @stat: status byte to decode
 546  *
 547  *      Error reporting, in human readable form (luxurious, but a memory hog).
 548  *      Combines the drive name, message and status byte to provide a
 549  *      user understandable explanation of the device error.
 550  */
 551
 552 u8 ide_dump_status(ide_drive_t *drive, const char *msg, u8 stat)
 553 {
 554         unsigned long flags;
 555         u8 err = 0;
 556
 557         local_irq_save(flags);
 558         printk("%s: %s: status=0x%02x { ", drive->name, msg, stat);
 559         if (stat & BUSY_STAT)
 560                 printk("Busy ");
 561         else {
 562                 if (stat & READY_STAT)  printk("DriveReady ");
 563                 if (stat & WRERR_STAT)  printk("DeviceFault ");
 564                 if (stat & SEEK_STAT)   printk("SeekComplete ");
 565                 if (stat & DRQ_STAT)    printk("DataRequest ");
 566                 if (stat & ECC_STAT)    printk("CorrectedError ");
 567                 if (stat & INDEX_STAT)  printk("Index ");
 568                 if (stat & ERR_STAT)    printk("Error ");
 569         }
 570         printk("}\n");
 571         if ((stat & (BUSY_STAT|ERR_STAT)) == ERR_STAT) {
 572                 err = ide_read_error(drive);
 573                 printk("%s: %s: error=0x%02x ", drive->name, msg, err);
 574                 if (drive->media == ide_disk)
 575                         ide_dump_ata_error(drive, err);
 576                 else
 577                         ide_dump_atapi_error(drive, err);
 578         }
 579         ide_dump_opcode(drive);
 580         local_irq_restore(flags);
 581         return err;
 582 }
 583
 584 EXPORT_SYMBOL(ide_dump_status);