drivers/ide/ide-iops.c

   1 /*
   2  *  Copyright (C) 2000-2002     Andre Hedrick <andre@linux-ide.org>
   3  *  Copyright (C) 2003          Red Hat
   4  *
   5  */
   6
   7 #include <linux/module.h>
   8 #include <linux/types.h>
   9 #include <linux/string.h>
  10 #include <linux/kernel.h>
  11 #include <linux/timer.h>
  12 #include <linux/mm.h>
  13 #include <linux/interrupt.h>
  14 #include <linux/major.h>
  15 #include <linux/errno.h>
  16 #include <linux/genhd.h>
  17 #include <linux/blkpg.h>
  18 #include <linux/slab.h>
  19 #include <linux/pci.h>
  20 #include <linux/delay.h>
  21 #include <linux/ide.h>
  22 #include <linux/bitops.h>
  23 #include <linux/nmi.h>
  24
  25 #include <asm/byteorder.h>
  26 #include <asm/irq.h>
  27 #include <asm/uaccess.h>
  28 #include <asm/io.h>
  29
  30 void SELECT_DRIVE(ide_drive_t *drive)
  31 {
  32         ide_hwif_t *hwif = drive->hwif;
  33         const struct ide_port_ops *port_ops = hwif->port_ops;
  34         ide_task_t task;
  35
  36         if (port_ops && port_ops->selectproc)
  37                 port_ops->selectproc(drive);
  38
  39         memset(&task, 0, sizeof(task));
  40         task.tf_flags = IDE_TFLAG_OUT_DEVICE;
  41
  42         drive->hwif->tp_ops->tf_load(drive, &task);
  43 }
  44
  45 void SELECT_MASK(ide_drive_t *drive, int mask)
  46 {
  47         const struct ide_port_ops *port_ops = drive->hwif->port_ops;
  48
  49         if (port_ops && port_ops->maskproc)
  50                 port_ops->maskproc(drive, mask);
  51 }
  52
  53 u8 ide_read_error(ide_drive_t *drive)
  54 {
  55         ide_task_t task;
  56
  57         memset(&task, 0, sizeof(task));
  58         task.tf_flags = IDE_TFLAG_IN_FEATURE;
  59
  60         drive->hwif->tp_ops->tf_read(drive, &task);
  61
  62         return task.tf.error;
  63 }
  64 EXPORT_SYMBOL_GPL(ide_read_error);
  65
  66 void ide_fix_driveid(u16 *id)
  67 {
  68 #ifndef __LITTLE_ENDIAN
  69 # ifdef __BIG_ENDIAN
  70         int i;
  71
  72         for (i = 0; i < 256; i++)
  73                 id[i] = __le16_to_cpu(id[i]);
  74 # else
  75 #  error "Please fix <asm/byteorder.h>"
  76 # endif
  77 #endif
  78 }
  79
  80 /*
  81  * ide_fixstring() cleans up and (optionally) byte-swaps a text string,
  82  * removing leading/trailing blanks and compressing internal blanks.
  83  * It is primarily used to tidy up the model name/number fields as
  84  * returned by the ATA_CMD_ID_ATA[PI] commands.
  85  */
  86
  87 void ide_fixstring(u8 *s, const int bytecount, const int byteswap)
  88 {
  89         u8 *p, *end = &s[bytecount & ~1]; /* bytecount must be even */
  90
  91         if (byteswap) {
  92                 /* convert from big-endian to host byte order */
  93                 for (p = s ; p != end ; p += 2)
  94                         be16_to_cpus((u16 *) p);
  95         }
  96
  97         /* strip leading blanks */
  98         p = s;
  99         while (s != end && *s == ' ')
 100                 ++s;
 101         /* compress internal blanks and strip trailing blanks */
 102         while (s != end && *s) {
 103                 if (*s++ != ' ' || (s != end && *s && *s != ' '))
 104                         *p++ = *(s-1);
 105         }
 106         /* wipe out trailing garbage */
 107         while (p != end)
 108                 *p++ = '\0';
 109 }
 110 EXPORT_SYMBOL(ide_fixstring);
 111
 112 /*
 113  * This routine busy-waits for the drive status to be not "busy".
 114  * It then checks the status for all of the "good" bits and none
 115  * of the "bad" bits, and if all is okay it returns 0.  All other
 116  * cases return error -- caller may then invoke ide_error().
 117  *
 118  * This routine should get fixed to not hog the cpu during extra long waits..
 119  * That could be done by busy-waiting for the first jiffy or two, and then
 120  * setting a timer to wake up at half second intervals thereafter,
 121  * until timeout is achieved, before timing out.
 122  */
 123 static int __ide_wait_stat(ide_drive_t *drive, u8 good, u8 bad,
 124                            unsigned long timeout, u8 *rstat)
 125 {
 126         ide_hwif_t *hwif = drive->hwif;
 127         const struct ide_tp_ops *tp_ops = hwif->tp_ops;
 128         unsigned long flags;
 129         int i;
 130         u8 stat;
 131
 132         udelay(1);      /* spec allows drive 400ns to assert "BUSY" */
 133         stat = tp_ops->read_status(hwif);
 134
 135         if (stat & ATA_BUSY) {
 136                 local_save_flags(flags);
 137                 local_irq_enable_in_hardirq();
 138                 timeout += jiffies;
 139                 while ((stat = tp_ops->read_status(hwif)) & ATA_BUSY) {
 140                         if (time_after(jiffies, timeout)) {
 141                                 /*
 142                                  * One last read after the timeout in case
 143                                  * heavy interrupt load made us not make any
 144                                  * progress during the timeout..
 145                                  */
 146                                 stat = tp_ops->read_status(hwif);
 147                                 if ((stat & ATA_BUSY) == 0)
 148                                         break;
 149
 150                                 local_irq_restore(flags);
 151                                 *rstat = stat;
 152                                 return -EBUSY;
 153                         }
 154                 }
 155                 local_irq_restore(flags);
 156         }
 157         /*
 158          * Allow status to settle, then read it again.
 159          * A few rare drives vastly violate the 400ns spec here,
 160          * so we'll wait up to 10usec for a "good" status
 161          * rather than expensively fail things immediately.
 162          * This fix courtesy of Matthew Faupel & Niccolo Rigacci.
 163          */
 164         for (i = 0; i < 10; i++) {
 165                 udelay(1);
 166                 stat = tp_ops->read_status(hwif);
 167
 168                 if (OK_STAT(stat, good, bad)) {
 169                         *rstat = stat;
 170                         return 0;
 171                 }
 172         }
 173         *rstat = stat;
 174         return -EFAULT;
 175 }
 176
 177 /*
 178  * In case of error returns error value after doing "*startstop = ide_error()".
 179  * The caller should return the updated value of "startstop" in this case,
 180  * "startstop" is unchanged when the function returns 0.
 181  */
 182 int ide_wait_stat(ide_startstop_t *startstop, ide_drive_t *drive, u8 good,
 183                   u8 bad, unsigned long timeout)
 184 {
 185         int err;
 186         u8 stat;
 187
 188         /* bail early if we've exceeded max_failures */
 189         if (drive->max_failures && (drive->failures > drive->max_failures)) {
 190                 *startstop = ide_stopped;
 191                 return 1;
 192         }
 193
 194         err = __ide_wait_stat(drive, good, bad, timeout, &stat);
 195
 196         if (err) {
 197                 char *s = (err == -EBUSY) ? "status timeout" : "status error";
 198                 *startstop = ide_error(drive, s, stat);
 199         }
 200
 201         return err;
 202 }
 203 EXPORT_SYMBOL(ide_wait_stat);
 204
 205 /**
 206  *      ide_in_drive_list       -       look for drive in black/white list
 207  *      @id: drive identifier
 208  *      @table: list to inspect
 209  *
 210  *      Look for a drive in the blacklist and the whitelist tables
 211  *      Returns 1 if the drive is found in the table.
 212  */
 213
 214 int ide_in_drive_list(u16 *id, const struct drive_list_entry *table)
 215 {
 216         for ( ; table->id_model; table++)
 217                 if ((!strcmp(table->id_model, (char *)&id[ATA_ID_PROD])) &&
 218                     (!table->id_firmware ||
 219                      strstr((char *)&id[ATA_ID_FW_REV], table->id_firmware)))
 220                         return 1;
 221         return 0;
 222 }
 223 EXPORT_SYMBOL_GPL(ide_in_drive_list);
 224
 225 /*
 226  * Early UDMA66 devices don't set bit14 to 1, only bit13 is valid.
 227  * We list them here and depend on the device side cable detection for them.
 228  *
 229  * Some optical devices with the buggy firmwares have the same problem.
 230  */
 231 static const struct drive_list_entry ivb_list[] = {
 232         { "QUANTUM FIREBALLlct10 05"    , "A03.0900"    },
 233         { "TSSTcorp CDDVDW SH-S202J"    , "SB00"        },
 234         { "TSSTcorp CDDVDW SH-S202J"    , "SB01"        },
 235         { "TSSTcorp CDDVDW SH-S202N"    , "SB00"        },
 236         { "TSSTcorp CDDVDW SH-S202N"    , "SB01"        },
 237         { "TSSTcorp CDDVDW SH-S202H"    , "SB00"        },
 238         { "TSSTcorp CDDVDW SH-S202H"    , "SB01"        },
 239         { "SAMSUNG SP0822N"             , "WA100-10"    },
 240         { NULL                          , NULL          }
 241 };
 242
 243 /*
 244  *  All hosts that use the 80c ribbon must use!
 245  *  The name is derived from upper byte of word 93 and the 80c ribbon.
 246  */
 247 u8 eighty_ninty_three(ide_drive_t *drive)
 248 {
 249         ide_hwif_t *hwif = drive->hwif;
 250         u16 *id = drive->id;
 251         int ivb = ide_in_drive_list(id, ivb_list);
 252
 253         if (hwif->cbl == ATA_CBL_PATA40_SHORT)
 254                 return 1;
 255
 256         if (ivb)
 257                 printk(KERN_DEBUG "%s: skipping word 93 validity check\n",
 258                                   drive->name);
 259
 260         if (ata_id_is_sata(id) && !ivb)
 261                 return 1;
 262
 263         if (hwif->cbl != ATA_CBL_PATA80 && !ivb)
 264                 goto no_80w;
 265
 266         /*
 267          * FIXME:
 268          * - change master/slave IDENTIFY order
 269          * - force bit13 (80c cable present) check also for !ivb devices
 270          *   (unless the slave device is pre-ATA3)
 271          */
 272         if ((id[ATA_ID_HW_CONFIG] & 0x4000) ||
 273             (ivb && (id[ATA_ID_HW_CONFIG] & 0x2000)))
 274                 return 1;
 275
 276 no_80w:
 277         if (drive->dev_flags & IDE_DFLAG_UDMA33_WARNED)
 278                 return 0;
 279
 280         printk(KERN_WARNING "%s: %s side 80-wire cable detection failed, "
 281                             "limiting max speed to UDMA33\n",
 282                             drive->name,
 283                             hwif->cbl == ATA_CBL_PATA80 ? "drive" : "host");
 284
 285         drive->dev_flags |= IDE_DFLAG_UDMA33_WARNED;
 286
 287         return 0;
 288 }
 289
 290 int ide_driveid_update(ide_drive_t *drive)
 291 {
 292         ide_hwif_t *hwif = drive->hwif;
 293         const struct ide_tp_ops *tp_ops = hwif->tp_ops;
 294         u16 *id;
 295         unsigned long flags;
 296         int use_altstatus = 0, rc;
 297         u8 a, uninitialized_var(s);
 298
 299         id = kmalloc(SECTOR_SIZE, GFP_ATOMIC);
 300         if (id == NULL)
 301                 return 0;
 302
 303         /*
 304          * Re-read drive->id for possible DMA mode
 305          * change (copied from ide-probe.c)
 306          */
 307
 308         SELECT_MASK(drive, 1);
 309         tp_ops->set_irq(hwif, 0);
 310         msleep(50);
 311
 312         if (hwif->io_ports.ctl_addr &&
 313             (hwif->host_flags & IDE_HFLAG_BROKEN_ALTSTATUS) == 0) {
 314                 a = tp_ops->read_altstatus(hwif);
 315                 s = tp_ops->read_status(hwif);
 316                 if ((a ^ s) & ~ATA_IDX)
 317                         /* ancient Seagate drives, broken interfaces */
 318                         printk(KERN_INFO "%s: probing with STATUS(0x%02x) "
 319                                          "instead of ALTSTATUS(0x%02x)\n",
 320                                          drive->name, s, a);
 321                 else
 322                         /* use non-intrusive polling */
 323                         use_altstatus = 1;
 324         }
 325
 326         tp_ops->exec_command(hwif, ATA_CMD_ID_ATA);
 327
 328         if (ide_busy_sleep(hwif, WAIT_WORSTCASE / 2, use_altstatus)) {
 329                 rc = 1;
 330                 goto out_err;
 331         }
 332
 333         msleep(50);     /* wait for IRQ and ATA_DRQ */
 334
 335         s = tp_ops->read_status(hwif);
 336
 337         if (!OK_STAT(s, ATA_DRQ, BAD_R_STAT)) {
 338                 rc = 2;
 339                 goto out_err;
 340         }
 341
 342         local_irq_save(flags);
 343         tp_ops->input_data(drive, NULL, id, SECTOR_SIZE);
 344         (void)tp_ops->read_status(hwif);        /* clear drive IRQ */
 345         local_irq_enable();
 346         local_irq_restore(flags);
 347
 348         ide_fix_driveid(id);
 349
 350         SELECT_MASK(drive, 0);
 351
 352         drive->id[ATA_ID_UDMA_MODES]  = id[ATA_ID_UDMA_MODES];
 353         drive->id[ATA_ID_MWDMA_MODES] = id[ATA_ID_MWDMA_MODES];
 354         drive->id[ATA_ID_SWDMA_MODES] = id[ATA_ID_SWDMA_MODES];
 355         /* anything more ? */
 356
 357         kfree(id);
 358
 359         if ((drive->dev_flags & IDE_DFLAG_USING_DMA) && ide_id_dma_bug(drive))
 360                 ide_dma_off(drive);
 361
 362         return 1;
 363 out_err:
 364         SELECT_MASK(drive, 0);
 365         if (rc == 2)
 366                 printk(KERN_ERR "%s: %s: bad status\n", drive->name, __func__);
 367         kfree(id);
 368         return 0;
 369 }
 370
 371 int ide_config_drive_speed(ide_drive_t *drive, u8 speed)
 372 {
 373         ide_hwif_t *hwif = drive->hwif;
 374         const struct ide_tp_ops *tp_ops = hwif->tp_ops;
 375         u16 *id = drive->id, i;
 376         int error = 0;
 377         u8 stat;
 378         ide_task_t task;
 379
 380 #ifdef CONFIG_BLK_DEV_IDEDMA
 381         if (hwif->dma_ops)      /* check if host supports DMA */
 382                 hwif->dma_ops->dma_host_set(drive, 0);
 383 #endif
 384
 385         /* Skip setting PIO flow-control modes on pre-EIDE drives */
 386         if ((speed & 0xf8) == XFER_PIO_0 && ata_id_has_iordy(drive->id) == 0)
 387                 goto skip;
 388
 389         /*
 390          * Don't use ide_wait_cmd here - it will
 391          * attempt to set_geometry and recalibrate,
 392          * but for some reason these don't work at
 393          * this point (lost interrupt).
 394          */
 395
 396         /*
 397          *      FIXME: we race against the running IRQ here if
 398          *      this is called from non IRQ context. If we use
 399          *      disable_irq() we hang on the error path. Work
 400          *      is needed.
 401          */
 402         disable_irq_nosync(hwif->irq);
 403
 404         udelay(1);
 405         SELECT_DRIVE(drive);
 406         SELECT_MASK(drive, 1);
 407         udelay(1);
 408         tp_ops->set_irq(hwif, 0);
 409
 410         memset(&task, 0, sizeof(task));
 411         task.tf_flags = IDE_TFLAG_OUT_FEATURE | IDE_TFLAG_OUT_NSECT;
 412         task.tf.feature = SETFEATURES_XFER;
 413         task.tf.nsect   = speed;
 414
 415         tp_ops->tf_load(drive, &task);
 416
 417         tp_ops->exec_command(hwif, ATA_CMD_SET_FEATURES);
 418
 419         if (drive->quirk_list == 2)
 420                 tp_ops->set_irq(hwif, 1);
 421
 422         error = __ide_wait_stat(drive, drive->ready_stat,
 423                                 ATA_BUSY | ATA_DRQ | ATA_ERR,
 424                                 WAIT_CMD, &stat);
 425
 426         SELECT_MASK(drive, 0);
 427
 428         enable_irq(hwif->irq);
 429
 430         if (error) {
 431                 (void) ide_dump_status(drive, "set_drive_speed_status", stat);
 432                 return error;
 433         }
 434
 435         id[ATA_ID_UDMA_MODES]  &= ~0xFF00;
 436         id[ATA_ID_MWDMA_MODES] &= ~0x0F00;
 437         id[ATA_ID_SWDMA_MODES] &= ~0x0F00;
 438
 439  skip:
 440 #ifdef CONFIG_BLK_DEV_IDEDMA
 441         if (speed >= XFER_SW_DMA_0 && (drive->dev_flags & IDE_DFLAG_USING_DMA))
 442                 hwif->dma_ops->dma_host_set(drive, 1);
 443         else if (hwif->dma_ops) /* check if host supports DMA */
 444                 ide_dma_off_quietly(drive);
 445 #endif
 446
 447         if (speed >= XFER_UDMA_0) {
 448                 i = 1 << (speed - XFER_UDMA_0);
 449                 id[ATA_ID_UDMA_MODES] |= (i << 8 | i);
 450         } else if (speed >= XFER_MW_DMA_0) {
 451                 i = 1 << (speed - XFER_MW_DMA_0);
 452                 id[ATA_ID_MWDMA_MODES] |= (i << 8 | i);
 453         } else if (speed >= XFER_SW_DMA_0) {
 454                 i = 1 << (speed - XFER_SW_DMA_0);
 455                 id[ATA_ID_SWDMA_MODES] |= (i << 8 | i);
 456         }
 457
 458         if (!drive->init_speed)
 459                 drive->init_speed = speed;
 460         drive->current_speed = speed;
 461         return error;
 462 }
 463
 464 /*
 465  * This should get invoked any time we exit the driver to
 466  * wait for an interrupt response from a drive.  handler() points
 467  * at the appropriate code to handle the next interrupt, and a
 468  * timer is started to prevent us from waiting forever in case
 469  * something goes wrong (see the ide_timer_expiry() handler later on).
 470  *
 471  * See also ide_execute_command
 472  */
 473 void __ide_set_handler(ide_drive_t *drive, ide_handler_t *handler,
 474                        unsigned int timeout, ide_expiry_t *expiry)
 475 {
 476         ide_hwif_t *hwif = drive->hwif;
 477
 478         BUG_ON(hwif->handler);
 479         hwif->handler           = handler;
 480         hwif->expiry            = expiry;
 481         hwif->timer.expires     = jiffies + timeout;
 482         hwif->req_gen_timer     = hwif->req_gen;
 483         add_timer(&hwif->timer);
 484 }
 485
 486 void ide_set_handler (ide_drive_t *drive, ide_handler_t *handler,
 487                       unsigned int timeout, ide_expiry_t *expiry)
 488 {
 489         ide_hwif_t *hwif = drive->hwif;
 490         unsigned long flags;
 491
 492         spin_lock_irqsave(&hwif->lock, flags);
 493         __ide_set_handler(drive, handler, timeout, expiry);
 494         spin_unlock_irqrestore(&hwif->lock, flags);
 495 }
 496 EXPORT_SYMBOL(ide_set_handler);
 497
 498 /**
 499  *      ide_execute_command     -       execute an IDE command
 500  *      @drive: IDE drive to issue the command against
 501  *      @command: command byte to write
 502  *      @handler: handler for next phase
 503  *      @timeout: timeout for command
 504  *      @expiry:  handler to run on timeout
 505  *
 506  *      Helper function to issue an IDE command. This handles the
 507  *      atomicity requirements, command timing and ensures that the
 508  *      handler and IRQ setup do not race. All IDE command kick off
 509  *      should go via this function or do equivalent locking.
 510  */
 511
 512 void ide_execute_command(ide_drive_t *drive, u8 cmd, ide_handler_t *handler,
 513                          unsigned timeout, ide_expiry_t *expiry)
 514 {
 515         ide_hwif_t *hwif = drive->hwif;
 516         unsigned long flags;
 517
 518         spin_lock_irqsave(&hwif->lock, flags);
 519         __ide_set_handler(drive, handler, timeout, expiry);
 520         hwif->tp_ops->exec_command(hwif, cmd);
 521         /*
 522          * Drive takes 400nS to respond, we must avoid the IRQ being
 523          * serviced before that.
 524          *
 525          * FIXME: we could skip this delay with care on non shared devices
 526          */
 527         ndelay(400);
 528         spin_unlock_irqrestore(&hwif->lock, flags);
 529 }
 530 EXPORT_SYMBOL(ide_execute_command);
 531
 532 void ide_execute_pkt_cmd(ide_drive_t *drive)
 533 {
 534         ide_hwif_t *hwif = drive->hwif;
 535         unsigned long flags;
 536
 537         spin_lock_irqsave(&hwif->lock, flags);
 538         hwif->tp_ops->exec_command(hwif, ATA_CMD_PACKET);
 539         ndelay(400);
 540         spin_unlock_irqrestore(&hwif->lock, flags);
 541 }
 542 EXPORT_SYMBOL_GPL(ide_execute_pkt_cmd);
 543
 544 /*
 545  * ide_wait_not_busy() waits for the currently selected device on the hwif
 546  * to report a non-busy status, see comments in ide_probe_port().
 547  */
 548 int ide_wait_not_busy(ide_hwif_t *hwif, unsigned long timeout)
 549 {
 550         u8 stat = 0;
 551
 552         while (timeout--) {
 553                 /*
 554                  * Turn this into a schedule() sleep once I'm sure
 555                  * about locking issues (2.5 work ?).
 556                  */
 557                 mdelay(1);
 558                 stat = hwif->tp_ops->read_status(hwif);
 559                 if ((stat & ATA_BUSY) == 0)
 560                         return 0;
 561                 /*
 562                  * Assume a value of 0xff means nothing is connected to
 563                  * the interface and it doesn't implement the pull-down
 564                  * resistor on D7.
 565                  */
 566                 if (stat == 0xff)
 567                         return -ENODEV;
 568                 touch_softlockup_watchdog();
 569                 touch_nmi_watchdog();
 570         }
 571         return -EBUSY;
 572 }