drivers/ata/libata-core.c

   1 /*
   2  *  libata-core.c - helper library for ATA
   3  *
   4  *  Maintained by:  Jeff Garzik <jgarzik@pobox.com>
   5  *                  Please ALWAYS copy linux-ide@vger.kernel.org
   6  *                  on emails.
   7  *
   8  *  Copyright 2003-2004 Red Hat, Inc.  All rights reserved.
   9  *  Copyright 2003-2004 Jeff Garzik
  10  *
  11  *
  12  *  This program is free software; you can redistribute it and/or modify
  13  *  it under the terms of the GNU General Public License as published by
  14  *  the Free Software Foundation; either version 2, or (at your option)
  15  *  any later version.
  16  *
  17  *  This program is distributed in the hope that it will be useful,
  18  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  *  GNU General Public License for more details.
  21  *
  22  *  You should have received a copy of the GNU General Public License
  23  *  along with this program; see the file COPYING.  If not, write to
  24  *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  25  *
  26  *
  27  *  libata documentation is available via 'make {ps|pdf}docs',
  28  *  as Documentation/DocBook/libata.*
  29  *
  30  *  Hardware documentation available from http://www.t13.org/ and
  31  *  http://www.sata-io.org/
  32  *
  33  */
  34
  35 #include <linux/kernel.h>
  36 #include <linux/module.h>
  37 #include <linux/pci.h>
  38 #include <linux/init.h>
  39 #include <linux/list.h>
  40 #include <linux/mm.h>
  41 #include <linux/highmem.h>
  42 #include <linux/spinlock.h>
  43 #include <linux/blkdev.h>
  44 #include <linux/delay.h>
  45 #include <linux/timer.h>
  46 #include <linux/interrupt.h>
  47 #include <linux/completion.h>
  48 #include <linux/suspend.h>
  49 #include <linux/workqueue.h>
  50 #include <linux/jiffies.h>
  51 #include <linux/scatterlist.h>
  52 #include <scsi/scsi.h>
  53 #include <scsi/scsi_cmnd.h>
  54 #include <scsi/scsi_host.h>
  55 #include <linux/libata.h>
  56 #include <asm/io.h>
  57 #include <asm/semaphore.h>
  58 #include <asm/byteorder.h>
  59
  60 #include "libata.h"
  61
  62 /* debounce timing parameters in msecs { interval, duration, timeout } */
  63 const unsigned long sata_deb_timing_normal[]            = {   5,  100, 2000 };
  64 const unsigned long sata_deb_timing_hotplug[]           = {  25,  500, 2000 };
  65 const unsigned long sata_deb_timing_long[]              = { 100, 2000, 5000 };
  66
  67 static unsigned int ata_dev_init_params(struct ata_device *dev,
  68                                         u16 heads, u16 sectors);
  69 static unsigned int ata_dev_set_xfermode(struct ata_device *dev);
  70 static void ata_dev_xfermask(struct ata_device *dev);
  71
  72 static unsigned int ata_unique_id = 1;
  73 static struct workqueue_struct *ata_wq;
  74
  75 struct workqueue_struct *ata_aux_wq;
  76
  77 int atapi_enabled = 1;
  78 module_param(atapi_enabled, int, 0444);
  79 MODULE_PARM_DESC(atapi_enabled, "Enable discovery of ATAPI devices (0=off, 1=on)");
  80
  81 int atapi_dmadir = 0;
  82 module_param(atapi_dmadir, int, 0444);
  83 MODULE_PARM_DESC(atapi_dmadir, "Enable ATAPI DMADIR bridge support (0=off, 1=on)");
  84
  85 int libata_fua = 0;
  86 module_param_named(fua, libata_fua, int, 0444);
  87 MODULE_PARM_DESC(fua, "FUA support (0=off, 1=on)");
  88
  89 static int ata_probe_timeout = ATA_TMOUT_INTERNAL / HZ;
  90 module_param(ata_probe_timeout, int, 0444);
  91 MODULE_PARM_DESC(ata_probe_timeout, "Set ATA probing timeout (seconds)");
  92
  93 MODULE_AUTHOR("Jeff Garzik");
  94 MODULE_DESCRIPTION("Library module for ATA devices");
  95 MODULE_LICENSE("GPL");
  96 MODULE_VERSION(DRV_VERSION);
  97
  98
  99 /**
 100  *      ata_tf_to_fis - Convert ATA taskfile to SATA FIS structure
 101  *      @tf: Taskfile to convert
 102  *      @fis: Buffer into which data will output
 103  *      @pmp: Port multiplier port
 104  *
 105  *      Converts a standard ATA taskfile to a Serial ATA
 106  *      FIS structure (Register - Host to Device).
 107  *
 108  *      LOCKING:
 109  *      Inherited from caller.
 110  */
 111
 112 void ata_tf_to_fis(const struct ata_taskfile *tf, u8 *fis, u8 pmp)
 113 {
 114         fis[0] = 0x27;  /* Register - Host to Device FIS */
 115         fis[1] = (pmp & 0xf) | (1 << 7); /* Port multiplier number,
 116                                             bit 7 indicates Command FIS */
 117         fis[2] = tf->command;
 118         fis[3] = tf->feature;
 119
 120         fis[4] = tf->lbal;
 121         fis[5] = tf->lbam;
 122         fis[6] = tf->lbah;
 123         fis[7] = tf->device;
 124
 125         fis[8] = tf->hob_lbal;
 126         fis[9] = tf->hob_lbam;
 127         fis[10] = tf->hob_lbah;
 128         fis[11] = tf->hob_feature;
 129
 130         fis[12] = tf->nsect;
 131         fis[13] = tf->hob_nsect;
 132         fis[14] = 0;
 133         fis[15] = tf->ctl;
 134
 135         fis[16] = 0;
 136         fis[17] = 0;
 137         fis[18] = 0;
 138         fis[19] = 0;
 139 }
 140
 141 /**
 142  *      ata_tf_from_fis - Convert SATA FIS to ATA taskfile
 143  *      @fis: Buffer from which data will be input
 144  *      @tf: Taskfile to output
 145  *
 146  *      Converts a serial ATA FIS structure to a standard ATA taskfile.
 147  *
 148  *      LOCKING:
 149  *      Inherited from caller.
 150  */
 151
 152 void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf)
 153 {
 154         tf->command     = fis[2];       /* status */
 155         tf->feature     = fis[3];       /* error */
 156
 157         tf->lbal        = fis[4];
 158         tf->lbam        = fis[5];
 159         tf->lbah        = fis[6];
 160         tf->device      = fis[7];
 161
 162         tf->hob_lbal    = fis[8];
 163         tf->hob_lbam    = fis[9];
 164         tf->hob_lbah    = fis[10];
 165
 166         tf->nsect       = fis[12];
 167         tf->hob_nsect   = fis[13];
 168 }
 169
 170 static const u8 ata_rw_cmds[] = {
 171         /* pio multi */
 172         ATA_CMD_READ_MULTI,
 173         ATA_CMD_WRITE_MULTI,
 174         ATA_CMD_READ_MULTI_EXT,
 175         ATA_CMD_WRITE_MULTI_EXT,
 176         0,
 177         0,
 178         0,
 179         ATA_CMD_WRITE_MULTI_FUA_EXT,
 180         /* pio */
 181         ATA_CMD_PIO_READ,
 182         ATA_CMD_PIO_WRITE,
 183         ATA_CMD_PIO_READ_EXT,
 184         ATA_CMD_PIO_WRITE_EXT,
 185         0,
 186         0,
 187         0,
 188         0,
 189         /* dma */
 190         ATA_CMD_READ,
 191         ATA_CMD_WRITE,
 192         ATA_CMD_READ_EXT,
 193         ATA_CMD_WRITE_EXT,
 194         0,
 195         0,
 196         0,
 197         ATA_CMD_WRITE_FUA_EXT
 198 };
 199
 200 /**
 201  *      ata_rwcmd_protocol - set taskfile r/w commands and protocol
 202  *      @qc: command to examine and configure
 203  *
 204  *      Examine the device configuration and tf->flags to calculate
 205  *      the proper read/write commands and protocol to use.
 206  *
 207  *      LOCKING:
 208  *      caller.
 209  */
 210 int ata_rwcmd_protocol(struct ata_queued_cmd *qc)
 211 {
 212         struct ata_taskfile *tf = &qc->tf;
 213         struct ata_device *dev = qc->dev;
 214         u8 cmd;
 215
 216         int index, fua, lba48, write;
 217
 218         fua = (tf->flags & ATA_TFLAG_FUA) ? 4 : 0;
 219         lba48 = (tf->flags & ATA_TFLAG_LBA48) ? 2 : 0;
 220         write = (tf->flags & ATA_TFLAG_WRITE) ? 1 : 0;
 221
 222         if (dev->flags & ATA_DFLAG_PIO) {
 223                 tf->protocol = ATA_PROT_PIO;
 224                 index = dev->multi_count ? 0 : 8;
 225         } else if (lba48 && (qc->ap->flags & ATA_FLAG_PIO_LBA48)) {
 226                 /* Unable to use DMA due to host limitation */
 227                 tf->protocol = ATA_PROT_PIO;
 228                 index = dev->multi_count ? 0 : 8;
 229         } else {
 230                 tf->protocol = ATA_PROT_DMA;
 231                 index = 16;
 232         }
 233
 234         cmd = ata_rw_cmds[index + fua + lba48 + write];
 235         if (cmd) {
 236                 tf->command = cmd;
 237                 return 0;
 238         }
 239         return -1;
 240 }
 241
 242 /**
 243  *      ata_pack_xfermask - Pack pio, mwdma and udma masks into xfer_mask
 244  *      @pio_mask: pio_mask
 245  *      @mwdma_mask: mwdma_mask
 246  *      @udma_mask: udma_mask
 247  *
 248  *      Pack @pio_mask, @mwdma_mask and @udma_mask into a single
 249  *      unsigned int xfer_mask.
 250  *
 251  *      LOCKING:
 252  *      None.
 253  *
 254  *      RETURNS:
 255  *      Packed xfer_mask.
 256  */
 257 static unsigned int ata_pack_xfermask(unsigned int pio_mask,
 258                                       unsigned int mwdma_mask,
 259                                       unsigned int udma_mask)
 260 {
 261         return ((pio_mask << ATA_SHIFT_PIO) & ATA_MASK_PIO) |
 262                 ((mwdma_mask << ATA_SHIFT_MWDMA) & ATA_MASK_MWDMA) |
 263                 ((udma_mask << ATA_SHIFT_UDMA) & ATA_MASK_UDMA);
 264 }
 265
 266 /**
 267  *      ata_unpack_xfermask - Unpack xfer_mask into pio, mwdma and udma masks
 268  *      @xfer_mask: xfer_mask to unpack
 269  *      @pio_mask: resulting pio_mask
 270  *      @mwdma_mask: resulting mwdma_mask
 271  *      @udma_mask: resulting udma_mask
 272  *
 273  *      Unpack @xfer_mask into @pio_mask, @mwdma_mask and @udma_mask.
 274  *      Any NULL distination masks will be ignored.
 275  */
 276 static void ata_unpack_xfermask(unsigned int xfer_mask,
 277                                 unsigned int *pio_mask,
 278                                 unsigned int *mwdma_mask,
 279                                 unsigned int *udma_mask)
 280 {
 281         if (pio_mask)
 282                 *pio_mask = (xfer_mask & ATA_MASK_PIO) >> ATA_SHIFT_PIO;
 283         if (mwdma_mask)
 284                 *mwdma_mask = (xfer_mask & ATA_MASK_MWDMA) >> ATA_SHIFT_MWDMA;
 285         if (udma_mask)
 286                 *udma_mask = (xfer_mask & ATA_MASK_UDMA) >> ATA_SHIFT_UDMA;
 287 }
 288
 289 static const struct ata_xfer_ent {
 290         int shift, bits;
 291         u8 base;
 292 } ata_xfer_tbl[] = {
 293         { ATA_SHIFT_PIO, ATA_BITS_PIO, XFER_PIO_0 },
 294         { ATA_SHIFT_MWDMA, ATA_BITS_MWDMA, XFER_MW_DMA_0 },
 295         { ATA_SHIFT_UDMA, ATA_BITS_UDMA, XFER_UDMA_0 },
 296         { -1, },
 297 };
 298
 299 /**
 300  *      ata_xfer_mask2mode - Find matching XFER_* for the given xfer_mask
 301  *      @xfer_mask: xfer_mask of interest
 302  *
 303  *      Return matching XFER_* value for @xfer_mask.  Only the highest
 304  *      bit of @xfer_mask is considered.
 305  *
 306  *      LOCKING:
 307  *      None.
 308  *
 309  *      RETURNS:
 310  *      Matching XFER_* value, 0 if no match found.
 311  */
 312 static u8 ata_xfer_mask2mode(unsigned int xfer_mask)
 313 {
 314         int highbit = fls(xfer_mask) - 1;
 315         const struct ata_xfer_ent *ent;
 316
 317         for (ent = ata_xfer_tbl; ent->shift >= 0; ent++)
 318                 if (highbit >= ent->shift && highbit < ent->shift + ent->bits)
 319                         return ent->base + highbit - ent->shift;
 320         return 0;
 321 }
 322
 323 /**
 324  *      ata_xfer_mode2mask - Find matching xfer_mask for XFER_*
 325  *      @xfer_mode: XFER_* of interest
 326  *
 327  *      Return matching xfer_mask for @xfer_mode.
 328  *
 329  *      LOCKING:
 330  *      None.
 331  *
 332  *      RETURNS:
 333  *      Matching xfer_mask, 0 if no match found.
 334  */
 335 static unsigned int ata_xfer_mode2mask(u8 xfer_mode)
 336 {
 337         const struct ata_xfer_ent *ent;
 338
 339         for (ent = ata_xfer_tbl; ent->shift >= 0; ent++)
 340                 if (xfer_mode >= ent->base && xfer_mode < ent->base + ent->bits)
 341                         return 1 << (ent->shift + xfer_mode - ent->base);
 342         return 0;
 343 }
 344
 345 /**
 346  *      ata_xfer_mode2shift - Find matching xfer_shift for XFER_*
 347  *      @xfer_mode: XFER_* of interest
 348  *
 349  *      Return matching xfer_shift for @xfer_mode.
 350  *
 351  *      LOCKING:
 352  *      None.
 353  *
 354  *      RETURNS:
 355  *      Matching xfer_shift, -1 if no match found.
 356  */
 357 static int ata_xfer_mode2shift(unsigned int xfer_mode)
 358 {
 359         const struct ata_xfer_ent *ent;
 360
 361         for (ent = ata_xfer_tbl; ent->shift >= 0; ent++)
 362                 if (xfer_mode >= ent->base && xfer_mode < ent->base + ent->bits)
 363                         return ent->shift;
 364         return -1;
 365 }
 366
 367 /**
 368  *      ata_mode_string - convert xfer_mask to string
 369  *      @xfer_mask: mask of bits supported; only highest bit counts.
 370  *
 371  *      Determine string which represents the highest speed
 372  *      (highest bit in @modemask).
 373  *
 374  *      LOCKING:
 375  *      None.
 376  *
 377  *      RETURNS:
 378  *      Constant C string representing highest speed listed in
 379  *      @mode_mask, or the constant C string "<n/a>".
 380  */
 381 static const char *ata_mode_string(unsigned int xfer_mask)
 382 {
 383         static const char * const xfer_mode_str[] = {
 384                 "PIO0",
 385                 "PIO1",
 386                 "PIO2",
 387                 "PIO3",
 388                 "PIO4",
 389                 "PIO5",
 390                 "PIO6",
 391                 "MWDMA0",
 392                 "MWDMA1",
 393                 "MWDMA2",
 394                 "MWDMA3",
 395                 "MWDMA4",
 396                 "UDMA/16",
 397                 "UDMA/25",
 398                 "UDMA/33",
 399                 "UDMA/44",
 400                 "UDMA/66",
 401                 "UDMA/100",
 402                 "UDMA/133",
 403                 "UDMA7",
 404         };
 405         int highbit;
 406
 407         highbit = fls(xfer_mask) - 1;
 408         if (highbit >= 0 && highbit < ARRAY_SIZE(xfer_mode_str))
 409                 return xfer_mode_str[highbit];
 410         return "<n/a>";
 411 }
 412
 413 static const char *sata_spd_string(unsigned int spd)
 414 {
 415         static const char * const spd_str[] = {
 416                 "1.5 Gbps",
 417                 "3.0 Gbps",
 418         };
 419
 420         if (spd == 0 || (spd - 1) >= ARRAY_SIZE(spd_str))
 421                 return "<unknown>";
 422         return spd_str[spd - 1];
 423 }
 424
 425 void ata_dev_disable(struct ata_device *dev)
 426 {
 427         if (ata_dev_enabled(dev) && ata_msg_drv(dev->ap)) {
 428                 ata_dev_printk(dev, KERN_WARNING, "disabled\n");
 429                 dev->class++;
 430         }
 431 }
 432
 433 /**
 434  *      ata_pio_devchk - PATA device presence detection
 435  *      @ap: ATA channel to examine
 436  *      @device: Device to examine (starting at zero)
 437  *
 438  *      This technique was originally described in
 439  *      Hale Landis's ATADRVR (www.ata-atapi.com), and
 440  *      later found its way into the ATA/ATAPI spec.
 441  *
 442  *      Write a pattern to the ATA shadow registers,
 443  *      and if a device is present, it will respond by
 444  *      correctly storing and echoing back the
 445  *      ATA shadow register contents.
 446  *
 447  *      LOCKING:
 448  *      caller.
 449  */
 450
 451 static unsigned int ata_pio_devchk(struct ata_port *ap,
 452                                    unsigned int device)
 453 {
 454         struct ata_ioports *ioaddr = &ap->ioaddr;
 455         u8 nsect, lbal;
 456
 457         ap->ops->dev_select(ap, device);
 458
 459         outb(0x55, ioaddr->nsect_addr);
 460         outb(0xaa, ioaddr->lbal_addr);
 461
 462         outb(0xaa, ioaddr->nsect_addr);
 463         outb(0x55, ioaddr->lbal_addr);
 464
 465         outb(0x55, ioaddr->nsect_addr);
 466         outb(0xaa, ioaddr->lbal_addr);
 467
 468         nsect = inb(ioaddr->nsect_addr);
 469         lbal = inb(ioaddr->lbal_addr);
 470
 471         if ((nsect == 0x55) && (lbal == 0xaa))
 472                 return 1;       /* we found a device */
 473
 474         return 0;               /* nothing found */
 475 }
 476
 477 /**
 478  *      ata_mmio_devchk - PATA device presence detection
 479  *      @ap: ATA channel to examine
 480  *      @device: Device to examine (starting at zero)
 481  *
 482  *      This technique was originally described in
 483  *      Hale Landis's ATADRVR (www.ata-atapi.com), and
 484  *      later found its way into the ATA/ATAPI spec.
 485  *
 486  *      Write a pattern to the ATA shadow registers,
 487  *      and if a device is present, it will respond by
 488  *      correctly storing and echoing back the
 489  *      ATA shadow register contents.
 490  *
 491  *      LOCKING:
 492  *      caller.
 493  */
 494
 495 static unsigned int ata_mmio_devchk(struct ata_port *ap,
 496                                     unsigned int device)
 497 {
 498         struct ata_ioports *ioaddr = &ap->ioaddr;
 499         u8 nsect, lbal;
 500
 501         ap->ops->dev_select(ap, device);
 502
 503         writeb(0x55, (void __iomem *) ioaddr->nsect_addr);
 504         writeb(0xaa, (void __iomem *) ioaddr->lbal_addr);
 505
 506         writeb(0xaa, (void __iomem *) ioaddr->nsect_addr);
 507         writeb(0x55, (void __iomem *) ioaddr->lbal_addr);
 508
 509         writeb(0x55, (void __iomem *) ioaddr->nsect_addr);
 510         writeb(0xaa, (void __iomem *) ioaddr->lbal_addr);
 511
 512         nsect = readb((void __iomem *) ioaddr->nsect_addr);
 513         lbal = readb((void __iomem *) ioaddr->lbal_addr);
 514
 515         if ((nsect == 0x55) && (lbal == 0xaa))
 516                 return 1;       /* we found a device */
 517
 518         return 0;               /* nothing found */
 519 }
 520
 521 /**
 522  *      ata_devchk - PATA device presence detection
 523  *      @ap: ATA channel to examine
 524  *      @device: Device to examine (starting at zero)
 525  *
 526  *      Dispatch ATA device presence detection, depending
 527  *      on whether we are using PIO or MMIO to talk to the
 528  *      ATA shadow registers.
 529  *
 530  *      LOCKING:
 531  *      caller.
 532  */
 533
 534 static unsigned int ata_devchk(struct ata_port *ap,
 535                                     unsigned int device)
 536 {
 537         if (ap->flags & ATA_FLAG_MMIO)
 538                 return ata_mmio_devchk(ap, device);
 539         return ata_pio_devchk(ap, device);
 540 }
 541
 542 /**
 543  *      ata_dev_classify - determine device type based on ATA-spec signature
 544  *      @tf: ATA taskfile register set for device to be identified
 545  *
 546  *      Determine from taskfile register contents whether a device is
 547  *      ATA or ATAPI, as per "Signature and persistence" section
 548  *      of ATA/PI spec (volume 1, sect 5.14).
 549  *
 550  *      LOCKING:
 551  *      None.
 552  *
 553  *      RETURNS:
 554  *      Device type, %ATA_DEV_ATA, %ATA_DEV_ATAPI, or %ATA_DEV_UNKNOWN
 555  *      the event of failure.
 556  */
 557
 558 unsigned int ata_dev_classify(const struct ata_taskfile *tf)
 559 {
 560         /* Apple's open source Darwin code hints that some devices only
 561          * put a proper signature into the LBA mid/high registers,
 562          * So, we only check those.  It's sufficient for uniqueness.
 563          */
 564
 565         if (((tf->lbam == 0) && (tf->lbah == 0)) ||
 566             ((tf->lbam == 0x3c) && (tf->lbah == 0xc3))) {
 567                 DPRINTK("found ATA device by sig\n");
 568                 return ATA_DEV_ATA;
 569         }
 570
 571         if (((tf->lbam == 0x14) && (tf->lbah == 0xeb)) ||
 572             ((tf->lbam == 0x69) && (tf->lbah == 0x96))) {
 573                 DPRINTK("found ATAPI device by sig\n");
 574                 return ATA_DEV_ATAPI;
 575         }
 576
 577         DPRINTK("unknown device\n");
 578         return ATA_DEV_UNKNOWN;
 579 }
 580
 581 /**
 582  *      ata_dev_try_classify - Parse returned ATA device signature
 583  *      @ap: ATA channel to examine
 584  *      @device: Device to examine (starting at zero)
 585  *      @r_err: Value of error register on completion
 586  *
 587  *      After an event -- SRST, E.D.D., or SATA COMRESET -- occurs,
 588  *      an ATA/ATAPI-defined set of values is placed in the ATA
 589  *      shadow registers, indicating the results of device detection
 590  *      and diagnostics.
 591  *
 592  *      Select the ATA device, and read the values from the ATA shadow
 593  *      registers.  Then parse according to the Error register value,
 594  *      and the spec-defined values examined by ata_dev_classify().
 595  *
 596  *      LOCKING:
 597  *      caller.
 598  *
 599  *      RETURNS:
 600  *      Device type - %ATA_DEV_ATA, %ATA_DEV_ATAPI or %ATA_DEV_NONE.
 601  */
 602
 603 static unsigned int
 604 ata_dev_try_classify(struct ata_port *ap, unsigned int device, u8 *r_err)
 605 {
 606         struct ata_taskfile tf;
 607         unsigned int class;
 608         u8 err;
 609
 610         ap->ops->dev_select(ap, device);
 611
 612         memset(&tf, 0, sizeof(tf));
 613
 614         ap->ops->tf_read(ap, &tf);
 615         err = tf.feature;
 616         if (r_err)
 617                 *r_err = err;
 618
 619         /* see if device passed diags: if master then continue and warn later */
 620         if (err == 0 && device == 0)
 621                 /* diagnostic fail : do nothing _YET_ */
 622                 ap->device[device].horkage |= ATA_HORKAGE_DIAGNOSTIC;
 623         else if (err == 1)
 624                 /* do nothing */ ;
 625         else if ((device == 0) && (err == 0x81))
 626                 /* do nothing */ ;
 627         else
 628                 return ATA_DEV_NONE;
 629
 630         /* determine if device is ATA or ATAPI */
 631         class = ata_dev_classify(&tf);
 632
 633         if (class == ATA_DEV_UNKNOWN)
 634                 return ATA_DEV_NONE;
 635         if ((class == ATA_DEV_ATA) && (ata_chk_status(ap) == 0))
 636                 return ATA_DEV_NONE;
 637         return class;
 638 }
 639
 640 /**
 641  *      ata_id_string - Convert IDENTIFY DEVICE page into string
 642  *      @id: IDENTIFY DEVICE results we will examine
 643  *      @s: string into which data is output
 644  *      @ofs: offset into identify device page
 645  *      @len: length of string to return. must be an even number.
 646  *
 647  *      The strings in the IDENTIFY DEVICE page are broken up into
 648  *      16-bit chunks.  Run through the string, and output each
 649  *      8-bit chunk linearly, regardless of platform.
 650  *
 651  *      LOCKING:
 652  *      caller.
 653  */
 654
 655 void ata_id_string(const u16 *id, unsigned char *s,
 656                    unsigned int ofs, unsigned int len)
 657 {
 658         unsigned int c;
 659
 660         while (len > 0) {
 661                 c = id[ofs] >> 8;
 662                 *s = c;
 663                 s++;
 664
 665                 c = id[ofs] & 0xff;
 666                 *s = c;
 667                 s++;
 668
 669                 ofs++;
 670                 len -= 2;
 671         }
 672 }
 673
 674 /**
 675  *      ata_id_c_string - Convert IDENTIFY DEVICE page into C string
 676  *      @id: IDENTIFY DEVICE results we will examine
 677  *      @s: string into which data is output
 678  *      @ofs: offset into identify device page
 679  *      @len: length of string to return. must be an odd number.
 680  *
 681  *      This function is identical to ata_id_string except that it
 682  *      trims trailing spaces and terminates the resulting string with
 683  *      null.  @len must be actual maximum length (even number) + 1.
 684  *
 685  *      LOCKING:
 686  *      caller.
 687  */
 688 void ata_id_c_string(const u16 *id, unsigned char *s,
 689                      unsigned int ofs, unsigned int len)
 690 {
 691         unsigned char *p;
 692
 693         WARN_ON(!(len & 1));
 694
 695         ata_id_string(id, s, ofs, len - 1);
 696
 697         p = s + strnlen(s, len - 1);
 698         while (p > s && p[-1] == ' ')
 699                 p--;
 700         *p = '\0';
 701 }
 702
 703 static u64 ata_id_n_sectors(const u16 *id)
 704 {
 705         if (ata_id_has_lba(id)) {
 706                 if (ata_id_has_lba48(id))
 707                         return ata_id_u64(id, 100);
 708                 else
 709                         return ata_id_u32(id, 60);
 710         } else {
 711                 if (ata_id_current_chs_valid(id))
 712                         return ata_id_u32(id, 57);
 713                 else
 714                         return id[1] * id[3] * id[6];
 715         }
 716 }
 717
 718 /**
 719  *      ata_noop_dev_select - Select device 0/1 on ATA bus
 720  *      @ap: ATA channel to manipulate
 721  *      @device: ATA device (numbered from zero) to select
 722  *
 723  *      This function performs no actual function.
 724  *
 725  *      May be used as the dev_select() entry in ata_port_operations.
 726  *
 727  *      LOCKING:
 728  *      caller.
 729  */
 730 void ata_noop_dev_select (struct ata_port *ap, unsigned int device)
 731 {
 732 }
 733
 734
 735 /**
 736  *      ata_std_dev_select - Select device 0/1 on ATA bus
 737  *      @ap: ATA channel to manipulate
 738  *      @device: ATA device (numbered from zero) to select
 739  *
 740  *      Use the method defined in the ATA specification to
 741  *      make either device 0, or device 1, active on the
 742  *      ATA channel.  Works with both PIO and MMIO.
 743  *
 744  *      May be used as the dev_select() entry in ata_port_operations.
 745  *
 746  *      LOCKING:
 747  *      caller.
 748  */
 749
 750 void ata_std_dev_select (struct ata_port *ap, unsigned int device)
 751 {
 752         u8 tmp;
 753
 754         if (device == 0)
 755                 tmp = ATA_DEVICE_OBS;
 756         else
 757                 tmp = ATA_DEVICE_OBS | ATA_DEV1;
 758
 759         if (ap->flags & ATA_FLAG_MMIO) {
 760                 writeb(tmp, (void __iomem *) ap->ioaddr.device_addr);
 761         } else {
 762                 outb(tmp, ap->ioaddr.device_addr);
 763         }
 764         ata_pause(ap);          /* needed; also flushes, for mmio */
 765 }
 766
 767 /**
 768  *      ata_dev_select - Select device 0/1 on ATA bus
 769  *      @ap: ATA channel to manipulate
 770  *      @device: ATA device (numbered from zero) to select
 771  *      @wait: non-zero to wait for Status register BSY bit to clear
 772  *      @can_sleep: non-zero if context allows sleeping
 773  *
 774  *      Use the method defined in the ATA specification to
 775  *      make either device 0, or device 1, active on the
 776  *      ATA channel.
 777  *
 778  *      This is a high-level version of ata_std_dev_select(),
 779  *      which additionally provides the services of inserting
 780  *      the proper pauses and status polling, where needed.
 781  *
 782  *      LOCKING:
 783  *      caller.
 784  */
 785
 786 void ata_dev_select(struct ata_port *ap, unsigned int device,
 787                            unsigned int wait, unsigned int can_sleep)
 788 {
 789         if (ata_msg_probe(ap))
 790                 ata_port_printk(ap, KERN_INFO, "ata_dev_select: ENTER, ata%u: "
 791                                 "device %u, wait %u\n", ap->id, device, wait);
 792
 793         if (wait)
 794                 ata_wait_idle(ap);
 795
 796         ap->ops->dev_select(ap, device);
 797
 798         if (wait) {
 799                 if (can_sleep && ap->device[device].class == ATA_DEV_ATAPI)
 800                         msleep(150);
 801                 ata_wait_idle(ap);
 802         }
 803 }
 804
 805 /**
 806  *      ata_dump_id - IDENTIFY DEVICE info debugging output
 807  *      @id: IDENTIFY DEVICE page to dump
 808  *
 809  *      Dump selected 16-bit words from the given IDENTIFY DEVICE
 810  *      page.
 811  *
 812  *      LOCKING:
 813  *      caller.
 814  */
 815
 816 static inline void ata_dump_id(const u16 *id)
 817 {
 818         DPRINTK("49==0x%04x  "
 819                 "53==0x%04x  "
 820                 "63==0x%04x  "
 821                 "64==0x%04x  "
 822                 "75==0x%04x  \n",
 823                 id[49],
 824                 id[53],
 825                 id[63],
 826                 id[64],
 827                 id[75]);
 828         DPRINTK("80==0x%04x  "
 829                 "81==0x%04x  "
 830                 "82==0x%04x  "
 831                 "83==0x%04x  "
 832                 "84==0x%04x  \n",
 833                 id[80],
 834                 id[81],
 835                 id[82],
 836                 id[83],
 837                 id[84]);
 838         DPRINTK("88==0x%04x  "
 839                 "93==0x%04x\n",
 840                 id[88],
 841                 id[93]);
 842 }
 843
 844 /**
 845  *      ata_id_xfermask - Compute xfermask from the given IDENTIFY data
 846  *      @id: IDENTIFY data to compute xfer mask from
 847  *
 848  *      Compute the xfermask for this device. This is not as trivial
 849  *      as it seems if we must consider early devices correctly.
 850  *
 851  *      FIXME: pre IDE drive timing (do we care ?).
 852  *
 853  *      LOCKING:
 854  *      None.
 855  *
 856  *      RETURNS:
 857  *      Computed xfermask
 858  */
 859 static unsigned int ata_id_xfermask(const u16 *id)
 860 {
 861         unsigned int pio_mask, mwdma_mask, udma_mask;
 862
 863         /* Usual case. Word 53 indicates word 64 is valid */
 864         if (id[ATA_ID_FIELD_VALID] & (1 << 1)) {
 865                 pio_mask = id[ATA_ID_PIO_MODES] & 0x03;
 866                 pio_mask <<= 3;
 867                 pio_mask |= 0x7;
 868         } else {
 869                 /* If word 64 isn't valid then Word 51 high byte holds
 870                  * the PIO timing number for the maximum. Turn it into
 871                  * a mask.
 872                  */
 873                 u8 mode = id[ATA_ID_OLD_PIO_MODES] & 0xFF;
 874                 if (mode < 5)   /* Valid PIO range */
 875                         pio_mask = (2 << mode) - 1;
 876                 else
 877                         pio_mask = 1;
 878
 879                 /* But wait.. there's more. Design your standards by
 880                  * committee and you too can get a free iordy field to
 881                  * process. However its the speeds not the modes that
 882                  * are supported... Note drivers using the timing API
 883                  * will get this right anyway
 884                  */
 885         }
 886
 887         mwdma_mask = id[ATA_ID_MWDMA_MODES] & 0x07;
 888
 889         if (ata_id_is_cfa(id)) {
 890                 /*
 891                  *      Process compact flash extended modes
 892                  */
 893                 int pio = id[163] & 0x7;
 894                 int dma = (id[163] >> 3) & 7;
 895
 896                 if (pio)
 897                         pio_mask |= (1 << 5);
 898                 if (pio > 1)
 899                         pio_mask |= (1 << 6);
 900                 if (dma)
 901                         mwdma_mask |= (1 << 3);
 902                 if (dma > 1)
 903                         mwdma_mask |= (1 << 4);
 904         }
 905
 906         udma_mask = 0;
 907         if (id[ATA_ID_FIELD_VALID] & (1 << 2))
 908                 udma_mask = id[ATA_ID_UDMA_MODES] & 0xff;
 909
 910         return ata_pack_xfermask(pio_mask, mwdma_mask, udma_mask);
 911 }
 912
 913 /**
 914  *      ata_port_queue_task - Queue port_task
 915  *      @ap: The ata_port to queue port_task for
 916  *      @fn: workqueue function to be scheduled
 917  *      @data: data value to pass to workqueue function
 918  *      @delay: delay time for workqueue function
 919  *
 920  *      Schedule @fn(@data) for execution after @delay jiffies using
 921  *      port_task.  There is one port_task per port and it's the
 922  *      user(low level driver)'s responsibility to make sure that only
 923  *      one task is active at any given time.
 924  *
 925  *      libata core layer takes care of synchronization between
 926  *      port_task and EH.  ata_port_queue_task() may be ignored for EH
 927  *      synchronization.
 928  *
 929  *      LOCKING:
 930  *      Inherited from caller.
 931  */
 932 void ata_port_queue_task(struct ata_port *ap, void (*fn)(void *), void *data,
 933                          unsigned long delay)
 934 {
 935         int rc;
 936
 937         if (ap->pflags & ATA_PFLAG_FLUSH_PORT_TASK)
 938                 return;
 939
 940         PREPARE_WORK(&ap->port_task, fn, data);
 941
 942         if (!delay)
 943                 rc = queue_work(ata_wq, &ap->port_task);
 944         else
 945                 rc = queue_delayed_work(ata_wq, &ap->port_task, delay);
 946
 947         /* rc == 0 means that another user is using port task */
 948         WARN_ON(rc == 0);
 949 }
 950
 951 /**
 952  *      ata_port_flush_task - Flush port_task
 953  *      @ap: The ata_port to flush port_task for
 954  *
 955  *      After this function completes, port_task is guranteed not to
 956  *      be running or scheduled.
 957  *
 958  *      LOCKING:
 959  *      Kernel thread context (may sleep)
 960  */
 961 void ata_port_flush_task(struct ata_port *ap)
 962 {
 963         unsigned long flags;
 964
 965         DPRINTK("ENTER\n");
 966
 967         spin_lock_irqsave(ap->lock, flags);
 968         ap->pflags |= ATA_PFLAG_FLUSH_PORT_TASK;
 969         spin_unlock_irqrestore(ap->lock, flags);
 970
 971         DPRINTK("flush #1\n");
 972         flush_workqueue(ata_wq);
 973
 974         /*
 975          * At this point, if a task is running, it's guaranteed to see
 976          * the FLUSH flag; thus, it will never queue pio tasks again.
 977          * Cancel and flush.
 978          */
 979         if (!cancel_delayed_work(&ap->port_task)) {
 980                 if (ata_msg_ctl(ap))
 981                         ata_port_printk(ap, KERN_DEBUG, "%s: flush #2\n",
 982                                         __FUNCTION__);
 983                 flush_workqueue(ata_wq);
 984         }
 985
 986         spin_lock_irqsave(ap->lock, flags);
 987         ap->pflags &= ~ATA_PFLAG_FLUSH_PORT_TASK;
 988         spin_unlock_irqrestore(ap->lock, flags);
 989
 990         if (ata_msg_ctl(ap))
 991                 ata_port_printk(ap, KERN_DEBUG, "%s: EXIT\n", __FUNCTION__);
 992 }
 993
 994 void ata_qc_complete_internal(struct ata_queued_cmd *qc)
 995 {
 996         struct completion *waiting = qc->private_data;
 997
 998         complete(waiting);
 999 }
1000
1001 /**
1002  *      ata_exec_internal - execute libata internal command
1003  *      @dev: Device to which the command is sent
1004  *      @tf: Taskfile registers for the command and the result
1005  *      @cdb: CDB for packet command
1006  *      @dma_dir: Data tranfer direction of the command
1007  *      @buf: Data buffer of the command
1008  *      @buflen: Length of data buffer
1009  *
1010  *      Executes libata internal command with timeout.  @tf contains
1011  *      command on entry and result on return.  Timeout and error
1012  *      conditions are reported via return value.  No recovery action
1013  *      is taken after a command times out.  It's caller's duty to
1014  *      clean up after timeout.
1015  *
1016  *      LOCKING:
1017  *      None.  Should be called with kernel context, might sleep.
1018  *
1019  *      RETURNS:
1020  *      Zero on success, AC_ERR_* mask on failure
1021  */
1022 unsigned ata_exec_internal(struct ata_device *dev,
1023                            struct ata_taskfile *tf, const u8 *cdb,
1024                            int dma_dir, void *buf, unsigned int buflen)
1025 {
1026         struct ata_port *ap = dev->ap;
1027         u8 command = tf->command;
1028         struct ata_queued_cmd *qc;
1029         unsigned int tag, preempted_tag;
1030         u32 preempted_sactive, preempted_qc_active;
1031         DECLARE_COMPLETION_ONSTACK(wait);
1032         unsigned long flags;
1033         unsigned int err_mask;
1034         int rc;
1035
1036         spin_lock_irqsave(ap->lock, flags);
1037
1038         /* no internal command while frozen */
1039         if (ap->pflags & ATA_PFLAG_FROZEN) {
1040                 spin_unlock_irqrestore(ap->lock, flags);
1041                 return AC_ERR_SYSTEM;
1042         }
1043
1044         /* initialize internal qc */
1045
1046         /* XXX: Tag 0 is used for drivers with legacy EH as some
1047          * drivers choke if any other tag is given.  This breaks
1048          * ata_tag_internal() test for those drivers.  Don't use new
1049          * EH stuff without converting to it.
1050          */
1051         if (ap->ops->error_handler)
1052                 tag = ATA_TAG_INTERNAL;
1053         else
1054                 tag = 0;
1055
1056         if (test_and_set_bit(tag, &ap->qc_allocated))
1057                 BUG();
1058         qc = __ata_qc_from_tag(ap, tag);
1059
1060         qc->tag = tag;
1061         qc->scsicmd = NULL;
1062         qc->ap = ap;
1063         qc->dev = dev;
1064         ata_qc_reinit(qc);
1065
1066         preempted_tag = ap->active_tag;
1067         preempted_sactive = ap->sactive;
1068         preempted_qc_active = ap->qc_active;
1069         ap->active_tag = ATA_TAG_POISON;
1070         ap->sactive = 0;
1071         ap->qc_active = 0;
1072
1073         /* prepare & issue qc */
1074         qc->tf = *tf;
1075         if (cdb)
1076                 memcpy(qc->cdb, cdb, ATAPI_CDB_LEN);
1077         qc->flags |= ATA_QCFLAG_RESULT_TF;
1078         qc->dma_dir = dma_dir;
1079         if (dma_dir != DMA_NONE) {
1080                 ata_sg_init_one(qc, buf, buflen);
1081                 qc->nsect = buflen / ATA_SECT_SIZE;
1082         }
1083
1084         qc->private_data = &wait;
1085         qc->complete_fn = ata_qc_complete_internal;
1086
1087         ata_qc_issue(qc);
1088
1089         spin_unlock_irqrestore(ap->lock, flags);
1090
1091         rc = wait_for_completion_timeout(&wait, ata_probe_timeout);
1092
1093         ata_port_flush_task(ap);
1094
1095         if (!rc) {
1096                 spin_lock_irqsave(ap->lock, flags);
1097
1098                 /* We're racing with irq here.  If we lose, the
1099                  * following test prevents us from completing the qc
1100                  * twice.  If we win, the port is frozen and will be
1101                  * cleaned up by ->post_internal_cmd().
1102                  */
1103                 if (qc->flags & ATA_QCFLAG_ACTIVE) {
1104                         qc->err_mask |= AC_ERR_TIMEOUT;
1105
1106                         if (ap->ops->error_handler)
1107                                 ata_port_freeze(ap);
1108                         else
1109                                 ata_qc_complete(qc);
1110
1111                         if (ata_msg_warn(ap))
1112                                 ata_dev_printk(dev, KERN_WARNING,
1113                                         "qc timeout (cmd 0x%x)\n", command);
1114                 }
1115
1116                 spin_unlock_irqrestore(ap->lock, flags);
1117         }
1118
1119         /* do post_internal_cmd */
1120         if (ap->ops->post_internal_cmd)
1121                 ap->ops->post_internal_cmd(qc);
1122
1123         if (qc->flags & ATA_QCFLAG_FAILED && !qc->err_mask) {
1124                 if (ata_msg_warn(ap))
1125                         ata_dev_printk(dev, KERN_WARNING,
1126                                 "zero err_mask for failed "
1127                                 "internal command, assuming AC_ERR_OTHER\n");
1128                 qc->err_mask |= AC_ERR_OTHER;
1129         }
1130
1131         /* finish up */
1132         spin_lock_irqsave(ap->lock, flags);
1133
1134         *tf = qc->result_tf;
1135         err_mask = qc->err_mask;
1136
1137         ata_qc_free(qc);
1138         ap->active_tag = preempted_tag;
1139         ap->sactive = preempted_sactive;
1140         ap->qc_active = preempted_qc_active;
1141
1142         /* XXX - Some LLDDs (sata_mv) disable port on command failure.
1143          * Until those drivers are fixed, we detect the condition
1144          * here, fail the command with AC_ERR_SYSTEM and reenable the
1145          * port.
1146          *
1147          * Note that this doesn't change any behavior as internal
1148          * command failure results in disabling the device in the
1149          * higher layer for LLDDs without new reset/EH callbacks.
1150          *
1151          * Kill the following code as soon as those drivers are fixed.
1152          */
1153         if (ap->flags & ATA_FLAG_DISABLED) {
1154                 err_mask |= AC_ERR_SYSTEM;
1155                 ata_port_probe(ap);
1156         }
1157
1158         spin_unlock_irqrestore(ap->lock, flags);
1159
1160         return err_mask;
1161 }
1162
1163 /**
1164  *      ata_do_simple_cmd - execute simple internal command
1165  *      @dev: Device to which the command is sent
1166  *      @cmd: Opcode to execute
1167  *
1168  *      Execute a 'simple' command, that only consists of the opcode
1169  *      'cmd' itself, without filling any other registers
1170  *
1171  *      LOCKING:
1172  *      Kernel thread context (may sleep).
1173  *
1174  *      RETURNS:
1175  *      Zero on success, AC_ERR_* mask on failure
1176  */
1177 unsigned int ata_do_simple_cmd(struct ata_device *dev, u8 cmd)
1178 {
1179         struct ata_taskfile tf;
1180
1181         ata_tf_init(dev, &tf);
1182
1183         tf.command = cmd;
1184         tf.flags |= ATA_TFLAG_DEVICE;
1185         tf.protocol = ATA_PROT_NODATA;
1186
1187         return ata_exec_internal(dev, &tf, NULL, DMA_NONE, NULL, 0);
1188 }
1189
1190 /**
1191  *      ata_pio_need_iordy      -       check if iordy needed
1192  *      @adev: ATA device
1193  *
1194  *      Check if the current speed of the device requires IORDY. Used
1195  *      by various controllers for chip configuration.
1196  */
1197
1198 unsigned int ata_pio_need_iordy(const struct ata_device *adev)
1199 {
1200         int pio;
1201         int speed = adev->pio_mode - XFER_PIO_0;
1202
1203         if (speed < 2)
1204                 return 0;
1205         if (speed > 2)
1206                 return 1;
1207
1208         /* If we have no drive specific rule, then PIO 2 is non IORDY */
1209
1210         if (adev->id[ATA_ID_FIELD_VALID] & 2) { /* EIDE */
1211                 pio = adev->id[ATA_ID_EIDE_PIO];
1212                 /* Is the speed faster than the drive allows non IORDY ? */
1213                 if (pio) {
1214                         /* This is cycle times not frequency - watch the logic! */
1215                         if (pio > 240)  /* PIO2 is 240nS per cycle */
1216                                 return 1;
1217                         return 0;
1218                 }
1219         }
1220         return 0;
1221 }
1222
1223 /**
1224  *      ata_dev_read_id - Read ID data from the specified device
1225  *      @dev: target device
1226  *      @p_class: pointer to class of the target device (may be changed)
1227  *      @flags: ATA_READID_* flags
1228  *      @id: buffer to read IDENTIFY data into
1229  *
1230  *      Read ID data from the specified device.  ATA_CMD_ID_ATA is
1231  *      performed on ATA devices and ATA_CMD_ID_ATAPI on ATAPI
1232  *      devices.  This function also issues ATA_CMD_INIT_DEV_PARAMS
1233  *      for pre-ATA4 drives.
1234  *
1235  *      LOCKING:
1236  *      Kernel thread context (may sleep)
1237  *
1238  *      RETURNS:
1239  *      0 on success, -errno otherwise.
1240  */
1241 int ata_dev_read_id(struct ata_device *dev, unsigned int *p_class,
1242                     unsigned int flags, u16 *id)
1243 {
1244         struct ata_port *ap = dev->ap;
1245         unsigned int class = *p_class;
1246         struct ata_taskfile tf;
1247         unsigned int err_mask = 0;
1248         const char *reason;
1249         int rc;
1250
1251         if (ata_msg_ctl(ap))
1252                 ata_dev_printk(dev, KERN_DEBUG, "%s: ENTER, host %u, dev %u\n",
1253                                __FUNCTION__, ap->id, dev->devno);
1254
1255         ata_dev_select(ap, dev->devno, 1, 1); /* select device 0/1 */
1256
1257  retry:
1258         ata_tf_init(dev, &tf);
1259
1260         switch (class) {
1261         case ATA_DEV_ATA:
1262                 tf.command = ATA_CMD_ID_ATA;
1263                 break;
1264         case ATA_DEV_ATAPI:
1265                 tf.command = ATA_CMD_ID_ATAPI;
1266                 break;
1267         default:
1268                 rc = -ENODEV;
1269                 reason = "unsupported class";
1270                 goto err_out;
1271         }
1272
1273         tf.protocol = ATA_PROT_PIO;
1274
1275         /* presence detection using polling IDENTIFY? */
1276         if (flags & ATA_READID_DETECT)
1277                 tf.flags |= ATA_TFLAG_POLLING;
1278
1279         err_mask = ata_exec_internal(dev, &tf, NULL, DMA_FROM_DEVICE,
1280                                      id, sizeof(id[0]) * ATA_ID_WORDS);
1281         if (err_mask) {
1282                 if ((flags & ATA_READID_DETECT) &&
1283                     (err_mask & AC_ERR_NODEV_HINT)) {
1284                         DPRINTK("ata%u.%d: NODEV after polling detection\n",
1285                                 ap->id, dev->devno);
1286                         return -ENOENT;
1287                 }
1288
1289                 rc = -EIO;
1290                 reason = "I/O error";
1291                 goto err_out;
1292         }
1293
1294         swap_buf_le16(id, ATA_ID_WORDS);
1295
1296         /* sanity check */
1297         rc = -EINVAL;
1298         reason = "device reports illegal type";
1299
1300         if (class == ATA_DEV_ATA) {
1301                 if (!ata_id_is_ata(id) && !ata_id_is_cfa(id))
1302                         goto err_out;
1303         } else {
1304                 if (ata_id_is_ata(id))
1305                         goto err_out;
1306         }
1307
1308         if ((flags & ATA_READID_POSTRESET) && class == ATA_DEV_ATA) {
1309                 /*
1310                  * The exact sequence expected by certain pre-ATA4 drives is:
1311                  * SRST RESET
1312                  * IDENTIFY
1313                  * INITIALIZE DEVICE PARAMETERS
1314                  * anything else..
1315                  * Some drives were very specific about that exact sequence.
1316                  */
1317                 if (ata_id_major_version(id) < 4 || !ata_id_has_lba(id)) {
1318                         err_mask = ata_dev_init_params(dev, id[3], id[6]);
1319                         if (err_mask) {
1320                                 rc = -EIO;
1321                                 reason = "INIT_DEV_PARAMS failed";
1322                                 goto err_out;
1323                         }
1324
1325                         /* current CHS translation info (id[53-58]) might be
1326                          * changed. reread the identify device info.
1327                          */
1328                         flags &= ~ATA_READID_POSTRESET;
1329                         goto retry;
1330                 }
1331         }
1332
1333         *p_class = class;
1334
1335         return 0;
1336
1337  err_out:
1338         if (ata_msg_warn(ap))
1339                 ata_dev_printk(dev, KERN_WARNING, "failed to IDENTIFY "
1340                                "(%s, err_mask=0x%x)\n", reason, err_mask);
1341         return rc;
1342 }
1343
1344 static inline u8 ata_dev_knobble(struct ata_device *dev)
1345 {
1346         return ((dev->ap->cbl == ATA_CBL_SATA) && (!ata_id_is_sata(dev->id)));
1347 }
1348
1349 static void ata_dev_config_ncq(struct ata_device *dev,
1350                                char *desc, size_t desc_sz)
1351 {
1352         struct ata_port *ap = dev->ap;
1353         int hdepth = 0, ddepth = ata_id_queue_depth(dev->id);
1354
1355         if (!ata_id_has_ncq(dev->id)) {
1356                 desc[0] = '\0';
1357                 return;
1358         }
1359         if (ata_device_blacklisted(dev) & ATA_HORKAGE_NONCQ) {
1360                 snprintf(desc, desc_sz, "NCQ (not used)");
1361                 return;
1362         }
1363         if (ap->flags & ATA_FLAG_NCQ) {
1364                 hdepth = min(ap->scsi_host->can_queue, ATA_MAX_QUEUE - 1);
1365                 dev->flags |= ATA_DFLAG_NCQ;
1366         }
1367
1368         if (hdepth >= ddepth)
1369                 snprintf(desc, desc_sz, "NCQ (depth %d)", ddepth);
1370         else
1371                 snprintf(desc, desc_sz, "NCQ (depth %d/%d)", hdepth, ddepth);
1372 }
1373
1374 static void ata_set_port_max_cmd_len(struct ata_port *ap)
1375 {
1376         int i;
1377
1378         if (ap->scsi_host) {
1379                 unsigned int len = 0;
1380
1381                 for (i = 0; i < ATA_MAX_DEVICES; i++)
1382                         len = max(len, ap->device[i].cdb_len);
1383
1384                 ap->scsi_host->max_cmd_len = len;
1385         }
1386 }
1387
1388 /**
1389  *      ata_dev_configure - Configure the specified ATA/ATAPI device
1390  *      @dev: Target device to configure
1391  *
1392  *      Configure @dev according to @dev->id.  Generic and low-level
1393  *      driver specific fixups are also applied.
1394  *
1395  *      LOCKING:
1396  *      Kernel thread context (may sleep)
1397  *
1398  *      RETURNS:
1399  *      0 on success, -errno otherwise
1400  */
1401 int ata_dev_configure(struct ata_device *dev)
1402 {
1403         struct ata_port *ap = dev->ap;
1404         int print_info = ap->eh_context.i.flags & ATA_EHI_PRINTINFO;
1405         const u16 *id = dev->id;
1406         unsigned int xfer_mask;
1407         char revbuf[7];         /* XYZ-99\0 */
1408         int rc;
1409
1410         if (!ata_dev_enabled(dev) && ata_msg_info(ap)) {
1411                 ata_dev_printk(dev, KERN_INFO,
1412                                "%s: ENTER/EXIT (host %u, dev %u) -- nodev\n",
1413                                __FUNCTION__, ap->id, dev->devno);
1414                 return 0;
1415         }
1416
1417         if (ata_msg_probe(ap))
1418                 ata_dev_printk(dev, KERN_DEBUG, "%s: ENTER, host %u, dev %u\n",
1419                                __FUNCTION__, ap->id, dev->devno);
1420
1421         /* print device capabilities */
1422         if (ata_msg_probe(ap))
1423                 ata_dev_printk(dev, KERN_DEBUG,
1424                                "%s: cfg 49:%04x 82:%04x 83:%04x 84:%04x "
1425                                "85:%04x 86:%04x 87:%04x 88:%04x\n",
1426                                __FUNCTION__,
1427                                id[49], id[82], id[83], id[84],
1428                                id[85], id[86], id[87], id[88]);
1429
1430         /* initialize to-be-configured parameters */
1431         dev->flags &= ~ATA_DFLAG_CFG_MASK;
1432         dev->max_sectors = 0;
1433         dev->cdb_len = 0;
1434         dev->n_sectors = 0;
1435         dev->cylinders = 0;
1436         dev->heads = 0;
1437         dev->sectors = 0;
1438
1439         /*
1440          * common ATA, ATAPI feature tests
1441          */
1442
1443         /* find max transfer mode; for printk only */
1444         xfer_mask = ata_id_xfermask(id);
1445
1446         if (ata_msg_probe(ap))
1447                 ata_dump_id(id);
1448
1449         /* ATA-specific feature tests */
1450         if (dev->class == ATA_DEV_ATA) {
1451                 if (ata_id_is_cfa(id)) {
1452                         if (id[162] & 1) /* CPRM may make this media unusable */
1453                                 ata_dev_printk(dev, KERN_WARNING, "ata%u: device %u  supports DRM functions and may not be fully accessable.\n",
1454                                         ap->id, dev->devno);
1455                         snprintf(revbuf, 7, "CFA");
1456                 }
1457                 else
1458                         snprintf(revbuf, 7, "ATA-%d",  ata_id_major_version(id));
1459
1460                 dev->n_sectors = ata_id_n_sectors(id);
1461
1462                 if (ata_id_has_lba(id)) {
1463                         const char *lba_desc;
1464                         char ncq_desc[20];
1465
1466                         lba_desc = "LBA";
1467                         dev->flags |= ATA_DFLAG_LBA;
1468                         if (ata_id_has_lba48(id)) {
1469                                 dev->flags |= ATA_DFLAG_LBA48;
1470                                 lba_desc = "LBA48";
1471
1472                                 if (dev->n_sectors >= (1UL << 28) &&
1473                                     ata_id_has_flush_ext(id))
1474                                         dev->flags |= ATA_DFLAG_FLUSH_EXT;
1475                         }
1476
1477                         /* config NCQ */
1478                         ata_dev_config_ncq(dev, ncq_desc, sizeof(ncq_desc));
1479
1480                         /* print device info to dmesg */
1481                         if (ata_msg_drv(ap) && print_info)
1482                                 ata_dev_printk(dev, KERN_INFO, "%s, "
1483                                         "max %s, %Lu sectors: %s %s\n",
1484                                         revbuf,
1485                                         ata_mode_string(xfer_mask),
1486                                         (unsigned long long)dev->n_sectors,
1487                                         lba_desc, ncq_desc);
1488                 } else {
1489                         /* CHS */
1490
1491                         /* Default translation */
1492                         dev->cylinders  = id[1];
1493                         dev->heads      = id[3];
1494                         dev->sectors    = id[6];
1495
1496                         if (ata_id_current_chs_valid(id)) {
1497                                 /* Current CHS translation is valid. */
1498                                 dev->cylinders = id[54];
1499                                 dev->heads     = id[55];
1500                                 dev->sectors   = id[56];
1501                         }
1502
1503                         /* print device info to dmesg */
1504                         if (ata_msg_drv(ap) && print_info)
1505                                 ata_dev_printk(dev, KERN_INFO, "%s, "
1506                                         "max %s, %Lu sectors: CHS %u/%u/%u\n",
1507                                         revbuf,
1508                                         ata_mode_string(xfer_mask),
1509                                         (unsigned long long)dev->n_sectors,
1510                                         dev->cylinders, dev->heads,
1511                                         dev->sectors);
1512                 }
1513
1514                 if (dev->id[59] & 0x100) {
1515                         dev->multi_count = dev->id[59] & 0xff;
1516                         if (ata_msg_drv(ap) && print_info)
1517                                 ata_dev_printk(dev, KERN_INFO,
1518                                         "ata%u: dev %u multi count %u\n",
1519                                         ap->id, dev->devno, dev->multi_count);
1520                 }
1521
1522                 dev->cdb_len = 16;
1523         }
1524
1525         /* ATAPI-specific feature tests */
1526         else if (dev->class == ATA_DEV_ATAPI) {
1527                 char *cdb_intr_string = "";
1528
1529                 rc = atapi_cdb_len(id);
1530                 if ((rc < 12) || (rc > ATAPI_CDB_LEN)) {
1531                         if (ata_msg_warn(ap))
1532                                 ata_dev_printk(dev, KERN_WARNING,
1533                                                "unsupported CDB len\n");
1534                         rc = -EINVAL;
1535                         goto err_out_nosup;
1536                 }
1537                 dev->cdb_len = (unsigned int) rc;
1538
1539                 if (ata_id_cdb_intr(dev->id)) {
1540                         dev->flags |= ATA_DFLAG_CDB_INTR;
1541                         cdb_intr_string = ", CDB intr";
1542                 }
1543
1544                 /* print device info to dmesg */
1545                 if (ata_msg_drv(ap) && print_info)
1546                         ata_dev_printk(dev, KERN_INFO, "ATAPI, max %s%s\n",
1547                                        ata_mode_string(xfer_mask),
1548                                        cdb_intr_string);
1549         }
1550
1551         /* determine max_sectors */
1552         dev->max_sectors = ATA_MAX_SECTORS;
1553         if (dev->flags & ATA_DFLAG_LBA48)
1554                 dev->max_sectors = ATA_MAX_SECTORS_LBA48;
1555
1556         if (dev->horkage & ATA_HORKAGE_DIAGNOSTIC) {
1557                 /* Let the user know. We don't want to disallow opens for
1558                    rescue purposes, or in case the vendor is just a blithering
1559                    idiot */
1560                 if (print_info) {
1561                         ata_dev_printk(dev, KERN_WARNING,
1562 "Drive reports diagnostics failure. This may indicate a drive\n");
1563                         ata_dev_printk(dev, KERN_WARNING,
1564 "fault or invalid emulation. Contact drive vendor for information.\n");
1565                 }
1566         }
1567
1568         ata_set_port_max_cmd_len(ap);
1569
1570         /* limit bridge transfers to udma5, 200 sectors */
1571         if (ata_dev_knobble(dev)) {
1572                 if (ata_msg_drv(ap) && print_info)
1573                         ata_dev_printk(dev, KERN_INFO,
1574                                        "applying bridge limits\n");
1575                 dev->udma_mask &= ATA_UDMA5;
1576                 dev->max_sectors = ATA_MAX_SECTORS;
1577         }
1578
1579         if (ap->ops->dev_config)
1580                 ap->ops->dev_config(ap, dev);
1581
1582         if (ata_msg_probe(ap))
1583                 ata_dev_printk(dev, KERN_DEBUG, "%s: EXIT, drv_stat = 0x%x\n",
1584                         __FUNCTION__, ata_chk_status(ap));
1585         return 0;
1586
1587 err_out_nosup:
1588         if (ata_msg_probe(ap))
1589                 ata_dev_printk(dev, KERN_DEBUG,
1590                                "%s: EXIT, err\n", __FUNCTION__);
1591         return rc;
1592 }
1593
1594 /**
1595  *      ata_bus_probe - Reset and probe ATA bus
1596  *      @ap: Bus to probe
1597  *
1598  *      Master ATA bus probing function.  Initiates a hardware-dependent
1599  *      bus reset, then attempts to identify any devices found on
1600  *      the bus.
1601  *
1602  *      LOCKING:
1603  *      PCI/etc. bus probe sem.
1604  *
1605  *      RETURNS:
1606  *      Zero on success, negative errno otherwise.
1607  */
1608
1609 int ata_bus_probe(struct ata_port *ap)
1610 {
1611         unsigned int classes[ATA_MAX_DEVICES];
1612         int tries[ATA_MAX_DEVICES];
1613         int i, rc, down_xfermask;
1614         struct ata_device *dev;
1615
1616         ata_port_probe(ap);
1617
1618         for (i = 0; i < ATA_MAX_DEVICES; i++)
1619                 tries[i] = ATA_PROBE_MAX_TRIES;
1620
1621  retry:
1622         down_xfermask = 0;
1623
1624         /* reset and determine device classes */
1625         ap->ops->phy_reset(ap);
1626
1627         for (i = 0; i < ATA_MAX_DEVICES; i++) {
1628                 dev = &ap->device[i];
1629
1630                 if (!(ap->flags & ATA_FLAG_DISABLED) &&
1631                     dev->class != ATA_DEV_UNKNOWN)
1632                         classes[dev->devno] = dev->class;
1633                 else
1634                         classes[dev->devno] = ATA_DEV_NONE;
1635
1636                 dev->class = ATA_DEV_UNKNOWN;
1637         }
1638
1639         ata_port_probe(ap);
1640
1641         /* after the reset the device state is PIO 0 and the controller
1642            state is undefined. Record the mode */
1643
1644         for (i = 0; i < ATA_MAX_DEVICES; i++)
1645                 ap->device[i].pio_mode = XFER_PIO_0;
1646
1647         /* read IDENTIFY page and configure devices */
1648         for (i = 0; i < ATA_MAX_DEVICES; i++) {
1649                 dev = &ap->device[i];
1650
1651                 if (tries[i])
1652                         dev->class = classes[i];
1653
1654                 if (!ata_dev_enabled(dev))
1655                         continue;
1656
1657                 rc = ata_dev_read_id(dev, &dev->class, ATA_READID_POSTRESET,
1658                                      dev->id);
1659                 if (rc)
1660                         goto fail;
1661
1662                 ap->eh_context.i.flags |= ATA_EHI_PRINTINFO;
1663                 rc = ata_dev_configure(dev);
1664                 ap->eh_context.i.flags &= ~ATA_EHI_PRINTINFO;
1665                 if (rc)
1666                         goto fail;
1667         }
1668
1669         /* configure transfer mode */
1670         rc = ata_set_mode(ap, &dev);
1671         if (rc) {
1672                 down_xfermask = 1;
1673                 goto fail;
1674         }
1675
1676         for (i = 0; i < ATA_MAX_DEVICES; i++)
1677                 if (ata_dev_enabled(&ap->device[i]))
1678                         return 0;
1679
1680         /* no device present, disable port */
1681         ata_port_disable(ap);
1682         ap->ops->port_disable(ap);
1683         return -ENODEV;
1684
1685  fail:
1686         switch (rc) {
1687         case -EINVAL:
1688         case -ENODEV:
1689                 tries[dev->devno] = 0;
1690                 break;
1691         case -EIO:
1692                 sata_down_spd_limit(ap);
1693                 /* fall through */
1694         default:
1695                 tries[dev->devno]--;
1696                 if (down_xfermask &&
1697                     ata_down_xfermask_limit(dev, tries[dev->devno] == 1))
1698                         tries[dev->devno] = 0;
1699         }
1700
1701         if (!tries[dev->devno]) {
1702                 ata_down_xfermask_limit(dev, 1);
1703                 ata_dev_disable(dev);
1704         }
1705
1706         goto retry;
1707 }
1708
1709 /**
1710  *      ata_port_probe - Mark port as enabled
1711  *      @ap: Port for which we indicate enablement
1712  *
1713  *      Modify @ap data structure such that the system
1714  *      thinks that the entire port is enabled.
1715  *
1716  *      LOCKING: host lock, or some other form of
1717  *      serialization.
1718  */
1719
1720 void ata_port_probe(struct ata_port *ap)
1721 {
1722         ap->flags &= ~ATA_FLAG_DISABLED;
1723 }
1724
1725 /**
1726  *      sata_print_link_status - Print SATA link status
1727  *      @ap: SATA port to printk link status about
1728  *
1729  *      This function prints link speed and status of a SATA link.
1730  *
1731  *      LOCKING:
1732  *      None.
1733  */
1734 static void sata_print_link_status(struct ata_port *ap)
1735 {
1736         u32 sstatus, scontrol, tmp;
1737
1738         if (sata_scr_read(ap, SCR_STATUS, &sstatus))
1739                 return;
1740         sata_scr_read(ap, SCR_CONTROL, &scontrol);
1741
1742         if (ata_port_online(ap)) {
1743                 tmp = (sstatus >> 4) & 0xf;
1744                 ata_port_printk(ap, KERN_INFO,
1745                                 "SATA link up %s (SStatus %X SControl %X)\n",
1746                                 sata_spd_string(tmp), sstatus, scontrol);
1747         } else {
1748                 ata_port_printk(ap, KERN_INFO,
1749                                 "SATA link down (SStatus %X SControl %X)\n",
1750                                 sstatus, scontrol);
1751         }
1752 }
1753
1754 /**
1755  *      __sata_phy_reset - Wake/reset a low-level SATA PHY
1756  *      @ap: SATA port associated with target SATA PHY.
1757  *
1758  *      This function issues commands to standard SATA Sxxx
1759  *      PHY registers, to wake up the phy (and device), and
1760  *      clear any reset condition.
1761  *
1762  *      LOCKING:
1763  *      PCI/etc. bus probe sem.
1764  *
1765  */
1766 void __sata_phy_reset(struct ata_port *ap)
1767 {
1768         u32 sstatus;
1769         unsigned long timeout = jiffies + (HZ * 5);
1770
1771         if (ap->flags & ATA_FLAG_SATA_RESET) {
1772                 /* issue phy wake/reset */
1773                 sata_scr_write_flush(ap, SCR_CONTROL, 0x301);
1774                 /* Couldn't find anything in SATA I/II specs, but
1775                  * AHCI-1.1 10.4.2 says at least 1 ms. */
1776                 mdelay(1);
1777         }
1778         /* phy wake/clear reset */
1779         sata_scr_write_flush(ap, SCR_CONTROL, 0x300);
1780
1781         /* wait for phy to become ready, if necessary */
1782         do {
1783                 msleep(200);
1784                 sata_scr_read(ap, SCR_STATUS, &sstatus);
1785                 if ((sstatus & 0xf) != 1)
1786                         break;
1787         } while (time_before(jiffies, timeout));
1788
1789         /* print link status */
1790         sata_print_link_status(ap);
1791
1792         /* TODO: phy layer with polling, timeouts, etc. */
1793         if (!ata_port_offline(ap))
1794                 ata_port_probe(ap);
1795         else
1796                 ata_port_disable(ap);
1797
1798         if (ap->flags & ATA_FLAG_DISABLED)
1799                 return;
1800
1801         if (ata_busy_sleep(ap, ATA_TMOUT_BOOT_QUICK, ATA_TMOUT_BOOT)) {
1802                 ata_port_disable(ap);
1803                 return;
1804         }
1805
1806         ap->cbl = ATA_CBL_SATA;
1807 }
1808
1809 /**
1810  *      sata_phy_reset - Reset SATA bus.
1811  *      @ap: SATA port associated with target SATA PHY.
1812  *
1813  *      This function resets the SATA bus, and then probes
1814  *      the bus for devices.
1815  *
1816  *      LOCKING:
1817  *      PCI/etc. bus probe sem.
1818  *
1819  */
1820 void sata_phy_reset(struct ata_port *ap)
1821 {
1822         __sata_phy_reset(ap);
1823         if (ap->flags & ATA_FLAG_DISABLED)
1824                 return;
1825         ata_bus_reset(ap);
1826 }
1827
1828 /**
1829  *      ata_dev_pair            -       return other device on cable
1830  *      @adev: device
1831  *
1832  *      Obtain the other device on the same cable, or if none is
1833  *      present NULL is returned
1834  */
1835
1836 struct ata_device *ata_dev_pair(struct ata_device *adev)
1837 {
1838         struct ata_port *ap = adev->ap;
1839         struct ata_device *pair = &ap->device[1 - adev->devno];
1840         if (!ata_dev_enabled(pair))
1841                 return NULL;
1842         return pair;
1843 }
1844
1845 /**
1846  *      ata_port_disable - Disable port.
1847  *      @ap: Port to be disabled.
1848  *
1849  *      Modify @ap data structure such that the system
1850  *      thinks that the entire port is disabled, and should
1851  *      never attempt to probe or communicate with devices
1852  *      on this port.
1853  *
1854  *      LOCKING: host lock, or some other form of
1855  *      serialization.
1856  */
1857
1858 void ata_port_disable(struct ata_port *ap)
1859 {
1860         ap->device[0].class = ATA_DEV_NONE;
1861         ap->device[1].class = ATA_DEV_NONE;
1862         ap->flags |= ATA_FLAG_DISABLED;
1863 }
1864
1865 /**
1866  *      sata_down_spd_limit - adjust SATA spd limit downward
1867  *      @ap: Port to adjust SATA spd limit for
1868  *
1869  *      Adjust SATA spd limit of @ap downward.  Note that this
1870  *      function only adjusts the limit.  The change must be applied
1871  *      using sata_set_spd().
1872  *
1873  *      LOCKING:
1874  *      Inherited from caller.
1875  *
1876  *      RETURNS:
1877  *      0 on success, negative errno on failure
1878  */
1879 int sata_down_spd_limit(struct ata_port *ap)
1880 {
1881         u32 sstatus, spd, mask;
1882         int rc, highbit;
1883
1884         rc = sata_scr_read(ap, SCR_STATUS, &sstatus);
1885         if (rc)
1886                 return rc;
1887
1888         mask = ap->sata_spd_limit;
1889         if (mask <= 1)
1890                 return -EINVAL;
1891         highbit = fls(mask) - 1;
1892         mask &= ~(1 << highbit);
1893
1894         spd = (sstatus >> 4) & 0xf;
1895         if (spd <= 1)
1896                 return -EINVAL;
1897         spd--;
1898         mask &= (1 << spd) - 1;
1899         if (!mask)
1900                 return -EINVAL;
1901
1902         ap->sata_spd_limit = mask;
1903
1904         ata_port_printk(ap, KERN_WARNING, "limiting SATA link speed to %s\n",
1905                         sata_spd_string(fls(mask)));
1906
1907         return 0;
1908 }
1909
1910 static int __sata_set_spd_needed(struct ata_port *ap, u32 *scontrol)
1911 {
1912         u32 spd, limit;
1913
1914         if (ap->sata_spd_limit == UINT_MAX)
1915                 limit = 0;
1916         else
1917                 limit = fls(ap->sata_spd_limit);
1918
1919         spd = (*scontrol >> 4) & 0xf;
1920         *scontrol = (*scontrol & ~0xf0) | ((limit & 0xf) << 4);
1921
1922         return spd != limit;
1923 }
1924
1925 /**
1926  *      sata_set_spd_needed - is SATA spd configuration needed
1927  *      @ap: Port in question
1928  *
1929  *      Test whether the spd limit in SControl matches
1930  *      @ap->sata_spd_limit.  This function is used to determine
1931  *      whether hardreset is necessary to apply SATA spd
1932  *      configuration.
1933  *
1934  *      LOCKING:
1935  *      Inherited from caller.
1936  *
1937  *      RETURNS:
1938  *      1 if SATA spd configuration is needed, 0 otherwise.
1939  */
1940 int sata_set_spd_needed(struct ata_port *ap)
1941 {
1942         u32 scontrol;
1943
1944         if (sata_scr_read(ap, SCR_CONTROL, &scontrol))
1945                 return 0;
1946
1947         return __sata_set_spd_needed(ap, &scontrol);
1948 }
1949
1950 /**
1951  *      sata_set_spd - set SATA spd according to spd limit
1952  *      @ap: Port to set SATA spd for
1953  *
1954  *      Set SATA spd of @ap according to sata_spd_limit.
1955  *
1956  *      LOCKING:
1957  *      Inherited from caller.
1958  *
1959  *      RETURNS:
1960  *      0 if spd doesn't need to be changed, 1 if spd has been
1961  *      changed.  Negative errno if SCR registers are inaccessible.
1962  */
1963 int sata_set_spd(struct ata_port *ap)
1964 {
1965         u32 scontrol;
1966         int rc;
1967
1968         if ((rc = sata_scr_read(ap, SCR_CONTROL, &scontrol)))
1969                 return rc;
1970
1971         if (!__sata_set_spd_needed(ap, &scontrol))
1972                 return 0;
1973
1974         if ((rc = sata_scr_write(ap, SCR_CONTROL, scontrol)))
1975                 return rc;
1976
1977         return 1;
1978 }
1979
1980 /*
1981  * This mode timing computation functionality is ported over from
1982  * drivers/ide/ide-timing.h and was originally written by Vojtech Pavlik
1983  */
1984 /*
1985  * PIO 0-4, MWDMA 0-2 and UDMA 0-6 timings (in nanoseconds).
1986  * These were taken from ATA/ATAPI-6 standard, rev 0a, except
1987  * for UDMA6, which is currently supported only by Maxtor drives.
1988  *
1989  * For PIO 5/6 MWDMA 3/4 see the CFA specification 3.0.
1990  */
1991
1992 static const struct ata_timing ata_timing[] = {
1993
1994         { XFER_UDMA_6,     0,   0,   0,   0,   0,   0,   0,  15 },
1995         { XFER_UDMA_5,     0,   0,   0,   0,   0,   0,   0,  20 },
1996         { XFER_UDMA_4,     0,   0,   0,   0,   0,   0,   0,  30 },
1997         { XFER_UDMA_3,     0,   0,   0,   0,   0,   0,   0,  45 },
1998
1999         { XFER_MW_DMA_4,  25,   0,   0,   0,  55,  20,  80,   0 },
2000         { XFER_MW_DMA_3,  25,   0,   0,   0,  65,  25, 100,   0 },
2001         { XFER_UDMA_2,     0,   0,   0,   0,   0,   0,   0,  60 },
2002         { XFER_UDMA_1,     0,   0,   0,   0,   0,   0,   0,  80 },
2003         { XFER_UDMA_0,     0,   0,   0,   0,   0,   0,   0, 120 },
2004
2005 /*      { XFER_UDMA_SLOW,  0,   0,   0,   0,   0,   0,   0, 150 }, */
2006
2007         { XFER_MW_DMA_2,  25,   0,   0,   0,  70,  25, 120,   0 },
2008         { XFER_MW_DMA_1,  45,   0,   0,   0,  80,  50, 150,   0 },
2009         { XFER_MW_DMA_0,  60,   0,   0,   0, 215, 215, 480,   0 },
2010
2011         { XFER_SW_DMA_2,  60,   0,   0,   0, 120, 120, 240,   0 },
2012         { XFER_SW_DMA_1,  90,   0,   0,   0, 240, 240, 480,   0 },
2013         { XFER_SW_DMA_0, 120,   0,   0,   0, 480, 480, 960,   0 },
2014
2015         { XFER_PIO_6,     10,  55,  20,  80,  55,  20,  80,   0 },
2016         { XFER_PIO_5,     15,  65,  25, 100,  65,  25, 100,   0 },
2017         { XFER_PIO_4,     25,  70,  25, 120,  70,  25, 120,   0 },
2018         { XFER_PIO_3,     30,  80,  70, 180,  80,  70, 180,   0 },
2019
2020         { XFER_PIO_2,     30, 290,  40, 330, 100,  90, 240,   0 },
2021         { XFER_PIO_1,     50, 290,  93, 383, 125, 100, 383,   0 },
2022         { XFER_PIO_0,     70, 290, 240, 600, 165, 150, 600,   0 },
2023
2024 /*      { XFER_PIO_SLOW, 120, 290, 240, 960, 290, 240, 960,   0 }, */
2025
2026         { 0xFF }
2027 };
2028
2029 #define ENOUGH(v,unit)          (((v)-1)/(unit)+1)
2030 #define EZ(v,unit)              ((v)?ENOUGH(v,unit):0)
2031
2032 static void ata_timing_quantize(const struct ata_timing *t, struct ata_timing *q, int T, int UT)
2033 {
2034         q->setup   = EZ(t->setup   * 1000,  T);
2035         q->act8b   = EZ(t->act8b   * 1000,  T);
2036         q->rec8b   = EZ(t->rec8b   * 1000,  T);
2037         q->cyc8b   = EZ(t->cyc8b   * 1000,  T);
2038         q->active  = EZ(t->active  * 1000,  T);
2039         q->recover = EZ(t->recover * 1000,  T);
2040         q->cycle   = EZ(t->cycle   * 1000,  T);
2041         q->udma    = EZ(t->udma    * 1000, UT);
2042 }
2043
2044 void ata_timing_merge(const struct ata_timing *a, const struct ata_timing *b,
2045                       struct ata_timing *m, unsigned int what)
2046 {
2047         if (what & ATA_TIMING_SETUP  ) m->setup   = max(a->setup,   b->setup);
2048         if (what & ATA_TIMING_ACT8B  ) m->act8b   = max(a->act8b,   b->act8b);
2049         if (what & ATA_TIMING_REC8B  ) m->rec8b   = max(a->rec8b,   b->rec8b);
2050         if (what & ATA_TIMING_CYC8B  ) m->cyc8b   = max(a->cyc8b,   b->cyc8b);
2051         if (what & ATA_TIMING_ACTIVE ) m->active  = max(a->active,  b->active);
2052         if (what & ATA_TIMING_RECOVER) m->recover = max(a->recover, b->recover);
2053         if (what & ATA_TIMING_CYCLE  ) m->cycle   = max(a->cycle,   b->cycle);
2054         if (what & ATA_TIMING_UDMA   ) m->udma    = max(a->udma,    b->udma);
2055 }
2056
2057 static const struct ata_timing* ata_timing_find_mode(unsigned short speed)
2058 {
2059         const struct ata_timing *t;
2060
2061         for (t = ata_timing; t->mode != speed; t++)
2062                 if (t->mode == 0xFF)
2063                         return NULL;
2064         return t;
2065 }
2066
2067 int ata_timing_compute(struct ata_device *adev, unsigned short speed,
2068                        struct ata_timing *t, int T, int UT)
2069 {
2070         const struct ata_timing *s;
2071         struct ata_timing p;
2072
2073         /*
2074          * Find the mode.
2075          */
2076
2077         if (!(s = ata_timing_find_mode(speed)))
2078                 return -EINVAL;
2079
2080         memcpy(t, s, sizeof(*s));
2081
2082         /*
2083          * If the drive is an EIDE drive, it can tell us it needs extended
2084          * PIO/MW_DMA cycle timing.
2085          */
2086
2087         if (adev->id[ATA_ID_FIELD_VALID] & 2) { /* EIDE drive */
2088                 memset(&p, 0, sizeof(p));
2089                 if(speed >= XFER_PIO_0 && speed <= XFER_SW_DMA_0) {
2090                         if (speed <= XFER_PIO_2) p.cycle = p.cyc8b = adev->id[ATA_ID_EIDE_PIO];
2091                                             else p.cycle = p.cyc8b = adev->id[ATA_ID_EIDE_PIO_IORDY];
2092                 } else if(speed >= XFER_MW_DMA_0 && speed <= XFER_MW_DMA_2) {
2093                         p.cycle = adev->id[ATA_ID_EIDE_DMA_MIN];
2094                 }
2095                 ata_timing_merge(&p, t, t, ATA_TIMING_CYCLE | ATA_TIMING_CYC8B);
2096         }
2097
2098         /*
2099          * Convert the timing to bus clock counts.
2100          */
2101
2102         ata_timing_quantize(t, t, T, UT);
2103
2104         /*
2105          * Even in DMA/UDMA modes we still use PIO access for IDENTIFY,
2106          * S.M.A.R.T * and some other commands. We have to ensure that the
2107          * DMA cycle timing is slower/equal than the fastest PIO timing.
2108          */
2109
2110         if (speed > XFER_PIO_4) {
2111                 ata_timing_compute(adev, adev->pio_mode, &p, T, UT);
2112                 ata_timing_merge(&p, t, t, ATA_TIMING_ALL);
2113         }
2114
2115         /*
2116          * Lengthen active & recovery time so that cycle time is correct.
2117          */
2118
2119         if (t->act8b + t->rec8b < t->cyc8b) {
2120                 t->act8b += (t->cyc8b - (t->act8b + t->rec8b)) / 2;
2121                 t->rec8b = t->cyc8b - t->act8b;
2122         }
2123
2124         if (t->active + t->recover < t->cycle) {
2125                 t->active += (t->cycle - (t->active + t->recover)) / 2;
2126                 t->recover = t->cycle - t->active;
2127         }
2128
2129         return 0;
2130 }
2131
2132 /**
2133  *      ata_down_xfermask_limit - adjust dev xfer masks downward
2134  *      @dev: Device to adjust xfer masks
2135  *      @force_pio0: Force PIO0
2136  *
2137  *      Adjust xfer masks of @dev downward.  Note that this function
2138  *      does not apply the change.  Invoking ata_set_mode() afterwards
2139  *      will apply the limit.
2140  *
2141  *      LOCKING:
2142  *      Inherited from caller.
2143  *
2144  *      RETURNS:
2145  *      0 on success, negative errno on failure
2146  */
2147 int ata_down_xfermask_limit(struct ata_device *dev, int force_pio0)
2148 {
2149         unsigned long xfer_mask;
2150         int highbit;
2151
2152         xfer_mask = ata_pack_xfermask(dev->pio_mask, dev->mwdma_mask,
2153                                       dev->udma_mask);
2154
2155         if (!xfer_mask)
2156                 goto fail;
2157         /* don't gear down to MWDMA from UDMA, go directly to PIO */
2158         if (xfer_mask & ATA_MASK_UDMA)
2159                 xfer_mask &= ~ATA_MASK_MWDMA;
2160
2161         highbit = fls(xfer_mask) - 1;
2162         xfer_mask &= ~(1 << highbit);
2163         if (force_pio0)
2164                 xfer_mask &= 1 << ATA_SHIFT_PIO;
2165         if (!xfer_mask)
2166                 goto fail;
2167
2168         ata_unpack_xfermask(xfer_mask, &dev->pio_mask, &dev->mwdma_mask,
2169                             &dev->udma_mask);
2170
2171         ata_dev_printk(dev, KERN_WARNING, "limiting speed to %s\n",
2172                        ata_mode_string(xfer_mask));
2173
2174         return 0;
2175
2176  fail:
2177         return -EINVAL;
2178 }
2179
2180 static int ata_dev_set_mode(struct ata_device *dev)
2181 {
2182         struct ata_eh_context *ehc = &dev->ap->eh_context;
2183         unsigned int err_mask;
2184         int rc;
2185
2186         dev->flags &= ~ATA_DFLAG_PIO;
2187         if (dev->xfer_shift == ATA_SHIFT_PIO)
2188                 dev->flags |= ATA_DFLAG_PIO;
2189
2190         err_mask = ata_dev_set_xfermode(dev);
2191         if (err_mask) {
2192                 ata_dev_printk(dev, KERN_ERR, "failed to set xfermode "
2193                                "(err_mask=0x%x)\n", err_mask);
2194                 return -EIO;
2195         }
2196
2197         ehc->i.flags |= ATA_EHI_POST_SETMODE;
2198         rc = ata_dev_revalidate(dev, 0);
2199         ehc->i.flags &= ~ATA_EHI_POST_SETMODE;
2200         if (rc)
2201                 return rc;
2202
2203         DPRINTK("xfer_shift=%u, xfer_mode=0x%x\n",
2204                 dev->xfer_shift, (int)dev->xfer_mode);
2205
2206         ata_dev_printk(dev, KERN_INFO, "configured for %s\n",
2207                        ata_mode_string(ata_xfer_mode2mask(dev->xfer_mode)));
2208         return 0;
2209 }
2210
2211 /**
2212  *      ata_set_mode - Program timings and issue SET FEATURES - XFER
2213  *      @ap: port on which timings will be programmed
2214  *      @r_failed_dev: out paramter for failed device
2215  *
2216  *      Set ATA device disk transfer mode (PIO3, UDMA6, etc.).  If
2217  *      ata_set_mode() fails, pointer to the failing device is
2218  *      returned in @r_failed_dev.
2219  *
2220  *      LOCKING:
2221  *      PCI/etc. bus probe sem.
2222  *
2223  *      RETURNS:
2224  *      0 on success, negative errno otherwise
2225  */
2226 int ata_set_mode(struct ata_port *ap, struct ata_device **r_failed_dev)
2227 {
2228         struct ata_device *dev;
2229         int i, rc = 0, used_dma = 0, found = 0;
2230
2231         /* has private set_mode? */
2232         if (ap->ops->set_mode) {
2233                 /* FIXME: make ->set_mode handle no device case and
2234                  * return error code and failing device on failure.
2235                  */
2236                 for (i = 0; i < ATA_MAX_DEVICES; i++) {
2237                         if (ata_dev_ready(&ap->device[i])) {
2238                                 ap->ops->set_mode(ap);
2239                                 break;
2240                         }
2241                 }
2242                 return 0;
2243         }
2244
2245         /* step 1: calculate xfer_mask */
2246         for (i = 0; i < ATA_MAX_DEVICES; i++) {
2247                 unsigned int pio_mask, dma_mask;
2248
2249                 dev = &ap->device[i];
2250
2251                 if (!ata_dev_enabled(dev))
2252                         continue;
2253
2254                 ata_dev_xfermask(dev);
2255
2256                 pio_mask = ata_pack_xfermask(dev->pio_mask, 0, 0);
2257                 dma_mask = ata_pack_xfermask(0, dev->mwdma_mask, dev->udma_mask);
2258                 dev->pio_mode = ata_xfer_mask2mode(pio_mask);
2259                 dev->dma_mode = ata_xfer_mask2mode(dma_mask);
2260
2261                 found = 1;
2262                 if (dev->dma_mode)
2263                         used_dma = 1;
2264         }
2265         if (!found)
2266                 goto out;
2267
2268         /* step 2: always set host PIO timings */
2269         for (i = 0; i < ATA_MAX_DEVICES; i++) {
2270                 dev = &ap->device[i];
2271                 if (!ata_dev_enabled(dev))
2272                         continue;
2273
2274                 if (!dev->pio_mode) {
2275                         ata_dev_printk(dev, KERN_WARNING, "no PIO support\n");
2276                         rc = -EINVAL;
2277                         goto out;
2278                 }
2279
2280                 dev->xfer_mode = dev->pio_mode;
2281                 dev->xfer_shift = ATA_SHIFT_PIO;
2282                 if (ap->ops->set_piomode)
2283                         ap->ops->set_piomode(ap, dev);
2284         }
2285
2286         /* step 3: set host DMA timings */
2287         for (i = 0; i < ATA_MAX_DEVICES; i++) {
2288                 dev = &ap->device[i];
2289
2290                 if (!ata_dev_enabled(dev) || !dev->dma_mode)
2291                         continue;
2292
2293                 dev->xfer_mode = dev->dma_mode;
2294                 dev->xfer_shift = ata_xfer_mode2shift(dev->dma_mode);
2295                 if (ap->ops->set_dmamode)
2296                         ap->ops->set_dmamode(ap, dev);
2297         }
2298
2299         /* step 4: update devices' xfer mode */
2300         for (i = 0; i < ATA_MAX_DEVICES; i++) {
2301                 dev = &ap->device[i];
2302
2303                 /* don't udpate suspended devices' xfer mode */
2304                 if (!ata_dev_ready(dev))
2305                         continue;
2306
2307                 rc = ata_dev_set_mode(dev);
2308                 if (rc)
2309                         goto out;
2310         }
2311
2312         /* Record simplex status. If we selected DMA then the other
2313          * host channels are not permitted to do so.
2314          */
2315         if (used_dma && (ap->host->flags & ATA_HOST_SIMPLEX))
2316                 ap->host->simplex_claimed = 1;
2317
2318         /* step5: chip specific finalisation */
2319         if (ap->ops->post_set_mode)
2320                 ap->ops->post_set_mode(ap);
2321
2322  out:
2323         if (rc)
2324                 *r_failed_dev = dev;
2325         return rc;
2326 }
2327
2328 /**
2329  *      ata_tf_to_host - issue ATA taskfile to host controller
2330  *      @ap: port to which command is being issued
2331  *      @tf: ATA taskfile register set
2332  *
2333  *      Issues ATA taskfile register set to ATA host controller,
2334  *      with proper synchronization with interrupt handler and
2335  *      other threads.
2336  *
2337  *      LOCKING:
2338  *      spin_lock_irqsave(host lock)
2339  */
2340
2341 static inline void ata_tf_to_host(struct ata_port *ap,
2342                                   const struct ata_taskfile *tf)
2343 {
2344         ap->ops->tf_load(ap, tf);
2345         ap->ops->exec_command(ap, tf);
2346 }
2347
2348 /**
2349  *      ata_busy_sleep - sleep until BSY clears, or timeout
2350  *      @ap: port containing status register to be polled
2351  *      @tmout_pat: impatience timeout
2352  *      @tmout: overall timeout
2353  *
2354  *      Sleep until ATA Status register bit BSY clears,
2355  *      or a timeout occurs.
2356  *
2357  *      LOCKING:
2358  *      Kernel thread context (may sleep).
2359  *
2360  *      RETURNS:
2361  *      0 on success, -errno otherwise.
2362  */
2363 int ata_busy_sleep(struct ata_port *ap,
2364                    unsigned long tmout_pat, unsigned long tmout)
2365 {
2366         unsigned long timer_start, timeout;
2367         u8 status;
2368
2369         status = ata_busy_wait(ap, ATA_BUSY, 300);
2370         timer_start = jiffies;
2371         timeout = timer_start + tmout_pat;
2372         while (status != 0xff && (status & ATA_BUSY) &&
2373                time_before(jiffies, timeout)) {
2374                 msleep(50);
2375                 status = ata_busy_wait(ap, ATA_BUSY, 3);
2376         }
2377
2378         if (status != 0xff && (status & ATA_BUSY))
2379                 ata_port_printk(ap, KERN_WARNING,
2380                                 "port is slow to respond, please be patient "
2381                                 "(Status 0x%x)\n", status);
2382
2383         timeout = timer_start + tmout;
2384         while (status != 0xff && (status & ATA_BUSY) &&
2385                time_before(jiffies, timeout)) {
2386                 msleep(50);
2387                 status = ata_chk_status(ap);
2388         }
2389
2390         if (status == 0xff)
2391                 return -ENODEV;
2392
2393         if (status & ATA_BUSY) {
2394                 ata_port_printk(ap, KERN_ERR, "port failed to respond "
2395                                 "(%lu secs, Status 0x%x)\n",
2396                                 tmout / HZ, status);
2397                 return -EBUSY;
2398         }
2399
2400         return 0;
2401 }
2402
2403 static void ata_bus_post_reset(struct ata_port *ap, unsigned int devmask)
2404 {
2405         struct ata_ioports *ioaddr = &ap->ioaddr;
2406         unsigned int dev0 = devmask & (1 << 0);
2407         unsigned int dev1 = devmask & (1 << 1);
2408         unsigned long timeout;
2409
2410         /* if device 0 was found in ata_devchk, wait for its
2411          * BSY bit to clear
2412          */
2413         if (dev0)
2414                 ata_busy_sleep(ap, ATA_TMOUT_BOOT_QUICK, ATA_TMOUT_BOOT);
2415
2416         /* if device 1 was found in ata_devchk, wait for
2417          * register access, then wait for BSY to clear
2418          */
2419         timeout = jiffies + ATA_TMOUT_BOOT;
2420         while (dev1) {
2421                 u8 nsect, lbal;
2422
2423                 ap->ops->dev_select(ap, 1);
2424                 if (ap->flags & ATA_FLAG_MMIO) {
2425                         nsect = readb((void __iomem *) ioaddr->nsect_addr);
2426                         lbal = readb((void __iomem *) ioaddr->lbal_addr);
2427                 } else {
2428                         nsect = inb(ioaddr->nsect_addr);
2429                         lbal = inb(ioaddr->lbal_addr);
2430                 }
2431                 if ((nsect == 1) && (lbal == 1))
2432                         break;
2433                 if (time_after(jiffies, timeout)) {
2434                         dev1 = 0;
2435                         break;
2436                 }
2437                 msleep(50);     /* give drive a breather */
2438         }
2439         if (dev1)
2440                 ata_busy_sleep(ap, ATA_TMOUT_BOOT_QUICK, ATA_TMOUT_BOOT);
2441
2442         /* is all this really necessary? */
2443         ap->ops->dev_select(ap, 0);
2444         if (dev1)
2445                 ap->ops->dev_select(ap, 1);
2446         if (dev0)
2447                 ap->ops->dev_select(ap, 0);
2448 }
2449
2450 static unsigned int ata_bus_softreset(struct ata_port *ap,
2451                                       unsigned int devmask)
2452 {
2453         struct ata_ioports *ioaddr = &ap->ioaddr;
2454
2455         DPRINTK("ata%u: bus reset via SRST\n", ap->id);
2456
2457         /* software reset.  causes dev0 to be selected */
2458         if (ap->flags & ATA_FLAG_MMIO) {
2459                 writeb(ap->ctl, (void __iomem *) ioaddr->ctl_addr);
2460                 udelay(20);     /* FIXME: flush */
2461                 writeb(ap->ctl | ATA_SRST, (void __iomem *) ioaddr->ctl_addr);
2462                 udelay(20);     /* FIXME: flush */
2463                 writeb(ap->ctl, (void __iomem *) ioaddr->ctl_addr);
2464         } else {
2465                 outb(ap->ctl, ioaddr->ctl_addr);
2466                 udelay(10);
2467                 outb(ap->ctl | ATA_SRST, ioaddr->ctl_addr);
2468                 udelay(10);
2469                 outb(ap->ctl, ioaddr->ctl_addr);
2470         }
2471
2472         /* spec mandates ">= 2ms" before checking status.
2473          * We wait 150ms, because that was the magic delay used for
2474          * ATAPI devices in Hale Landis's ATADRVR, for the period of time
2475          * between when the ATA command register is written, and then
2476          * status is checked.  Because waiting for "a while" before
2477          * checking status is fine, post SRST, we perform this magic
2478          * delay here as well.
2479          *
2480          * Old drivers/ide uses the 2mS rule and then waits for ready
2481          */
2482         msleep(150);
2483
2484         /* Before we perform post reset processing we want to see if
2485          * the bus shows 0xFF because the odd clown forgets the D7
2486          * pulldown resistor.
2487          */
2488         if (ata_check_status(ap) == 0xFF)
2489                 return 0;
2490
2491         ata_bus_post_reset(ap, devmask);
2492
2493         return 0;
2494 }
2495
2496 /**
2497  *      ata_bus_reset - reset host port and associated ATA channel
2498  *      @ap: port to reset
2499  *
2500  *      This is typically the first time we actually start issuing
2501  *      commands to the ATA channel.  We wait for BSY to clear, then
2502  *      issue EXECUTE DEVICE DIAGNOSTIC command, polling for its
2503  *      result.  Determine what devices, if any, are on the channel
2504  *      by looking at the device 0/1 error register.  Look at the signature
2505  *      stored in each device's taskfile registers, to determine if
2506  *      the device is ATA or ATAPI.
2507  *
2508  *      LOCKING:
2509  *      PCI/etc. bus probe sem.
2510  *      Obtains host lock.
2511  *
2512  *      SIDE EFFECTS:
2513  *      Sets ATA_FLAG_DISABLED if bus reset fails.
2514  */
2515
2516 void ata_bus_reset(struct ata_port *ap)
2517 {
2518         struct ata_ioports *ioaddr = &ap->ioaddr;
2519         unsigned int slave_possible = ap->flags & ATA_FLAG_SLAVE_POSS;
2520         u8 err;
2521         unsigned int dev0, dev1 = 0, devmask = 0;
2522
2523         DPRINTK("ENTER, host %u, port %u\n", ap->id, ap->port_no);
2524
2525         /* determine if device 0/1 are present */
2526         if (ap->flags & ATA_FLAG_SATA_RESET)
2527                 dev0 = 1;
2528         else {
2529                 dev0 = ata_devchk(ap, 0);
2530                 if (slave_possible)
2531                         dev1 = ata_devchk(ap, 1);
2532         }
2533
2534         if (dev0)
2535                 devmask |= (1 << 0);
2536         if (dev1)
2537                 devmask |= (1 << 1);
2538
2539         /* select device 0 again */
2540         ap->ops->dev_select(ap, 0);
2541
2542         /* issue bus reset */
2543         if (ap->flags & ATA_FLAG_SRST)
2544                 if (ata_bus_softreset(ap, devmask))
2545                         goto err_out;
2546
2547         /*
2548          * determine by signature whether we have ATA or ATAPI devices
2549          */
2550         ap->device[0].class = ata_dev_try_classify(ap, 0, &err);
2551         if ((slave_possible) && (err != 0x81))
2552                 ap->device[1].class = ata_dev_try_classify(ap, 1, &err);
2553
2554         /* re-enable interrupts */
2555         if (ap->ioaddr.ctl_addr)        /* FIXME: hack. create a hook instead */
2556                 ata_irq_on(ap);
2557
2558         /* is double-select really necessary? */
2559         if (ap->device[1].class != ATA_DEV_NONE)
2560                 ap->ops->dev_select(ap, 1);
2561         if (ap->device[0].class != ATA_DEV_NONE)
2562                 ap->ops->dev_select(ap, 0);
2563
2564         /* if no devices were detected, disable this port */
2565         if ((ap->device[0].class == ATA_DEV_NONE) &&
2566             (ap->device[1].class == ATA_DEV_NONE))
2567                 goto err_out;
2568
2569         if (ap->flags & (ATA_FLAG_SATA_RESET | ATA_FLAG_SRST)) {
2570                 /* set up device control for ATA_FLAG_SATA_RESET */
2571                 if (ap->flags & ATA_FLAG_MMIO)
2572                         writeb(ap->ctl, (void __iomem *) ioaddr->ctl_addr);
2573                 else
2574                         outb(ap->ctl, ioaddr->ctl_addr);
2575         }
2576
2577         DPRINTK("EXIT\n");
2578         return;
2579
2580 err_out:
2581         ata_port_printk(ap, KERN_ERR, "disabling port\n");
2582         ap->ops->port_disable(ap);
2583
2584         DPRINTK("EXIT\n");
2585 }
2586
2587 /**
2588  *      sata_phy_debounce - debounce SATA phy status
2589  *      @ap: ATA port to debounce SATA phy status for
2590  *      @params: timing parameters { interval, duratinon, timeout } in msec
2591  *
2592  *      Make sure SStatus of @ap reaches stable state, determined by
2593  *      holding the same value where DET is not 1 for @duration polled
2594  *      every @interval, before @timeout.  Timeout constraints the
2595  *      beginning of the stable state.  Because, after hot unplugging,
2596  *      DET gets stuck at 1 on some controllers, this functions waits
2597  *      until timeout then returns 0 if DET is stable at 1.
2598  *
2599  *      LOCKING:
2600  *      Kernel thread context (may sleep)
2601  *
2602  *      RETURNS:
2603  *      0 on success, -errno on failure.
2604  */
2605 int sata_phy_debounce(struct ata_port *ap, const unsigned long *params)
2606 {
2607         unsigned long interval_msec = params[0];
2608         unsigned long duration = params[1] * HZ / 1000;
2609         unsigned long timeout = jiffies + params[2] * HZ / 1000;
2610         unsigned long last_jiffies;
2611         u32 last, cur;
2612         int rc;
2613
2614         if ((rc = sata_scr_read(ap, SCR_STATUS, &cur)))
2615                 return rc;
2616         cur &= 0xf;
2617
2618         last = cur;
2619         last_jiffies = jiffies;
2620
2621         while (1) {
2622                 msleep(interval_msec);
2623                 if ((rc = sata_scr_read(ap, SCR_STATUS, &cur)))
2624                         return rc;
2625                 cur &= 0xf;
2626
2627                 /* DET stable? */
2628                 if (cur == last) {
2629                         if (cur == 1 && time_before(jiffies, timeout))
2630                                 continue;
2631                         if (time_after(jiffies, last_jiffies + duration))
2632                                 return 0;
2633                         continue;
2634                 }
2635
2636                 /* unstable, start over */
2637                 last = cur;
2638                 last_jiffies = jiffies;
2639
2640                 /* check timeout */
2641                 if (time_after(jiffies, timeout))
2642                         return -EBUSY;
2643         }
2644 }
2645
2646 /**
2647  *      sata_phy_resume - resume SATA phy
2648  *      @ap: ATA port to resume SATA phy for
2649  *      @params: timing parameters { interval, duratinon, timeout } in msec
2650  *
2651  *      Resume SATA phy of @ap and debounce it.
2652  *
2653  *      LOCKING:
2654  *      Kernel thread context (may sleep)
2655  *
2656  *      RETURNS:
2657  *      0 on success, -errno on failure.
2658  */
2659 int sata_phy_resume(struct ata_port *ap, const unsigned long *params)
2660 {
2661         u32 scontrol;
2662         int rc;
2663
2664         if ((rc = sata_scr_read(ap, SCR_CONTROL, &scontrol)))
2665                 return rc;
2666
2667         scontrol = (scontrol & 0x0f0) | 0x300;
2668
2669         if ((rc = sata_scr_write(ap, SCR_CONTROL, scontrol)))
2670                 return rc;
2671
2672         /* Some PHYs react badly if SStatus is pounded immediately
2673          * after resuming.  Delay 200ms before debouncing.
2674          */
2675         msleep(200);
2676
2677         return sata_phy_debounce(ap, params);
2678 }
2679
2680 static void ata_wait_spinup(struct ata_port *ap)
2681 {
2682         struct ata_eh_context *ehc = &ap->eh_context;
2683         unsigned long end, secs;
2684         int rc;
2685
2686         /* first, debounce phy if SATA */
2687         if (ap->cbl == ATA_CBL_SATA) {
2688                 rc = sata_phy_debounce(ap, sata_deb_timing_hotplug);
2689
2690                 /* if debounced successfully and offline, no need to wait */
2691                 if ((rc == 0 || rc == -EOPNOTSUPP) && ata_port_offline(ap))
2692                         return;
2693         }
2694
2695         /* okay, let's give the drive time to spin up */
2696         end = ehc->i.hotplug_timestamp + ATA_SPINUP_WAIT * HZ / 1000;
2697         secs = ((end - jiffies) + HZ - 1) / HZ;
2698
2699         if (time_after(jiffies, end))
2700                 return;
2701
2702         if (secs > 5)
2703                 ata_port_printk(ap, KERN_INFO, "waiting for device to spin up "
2704                                 "(%lu secs)\n", secs);
2705
2706         schedule_timeout_uninterruptible(end - jiffies);
2707 }
2708
2709 /**
2710  *      ata_std_prereset - prepare for reset
2711  *      @ap: ATA port to be reset
2712  *
2713  *      @ap is about to be reset.  Initialize it.
2714  *
2715  *      LOCKING:
2716  *      Kernel thread context (may sleep)
2717  *
2718  *      RETURNS:
2719  *      0 on success, -errno otherwise.
2720  */
2721 int ata_std_prereset(struct ata_port *ap)
2722 {
2723         struct ata_eh_context *ehc = &ap->eh_context;
2724         const unsigned long *timing = sata_ehc_deb_timing(ehc);
2725         int rc;
2726
2727         /* handle link resume & hotplug spinup */
2728         if ((ehc->i.flags & ATA_EHI_RESUME_LINK) &&
2729             (ap->flags & ATA_FLAG_HRST_TO_RESUME))
2730                 ehc->i.action |= ATA_EH_HARDRESET;
2731
2732         if ((ehc->i.flags & ATA_EHI_HOTPLUGGED) &&
2733             (ap->flags & ATA_FLAG_SKIP_D2H_BSY))
2734                 ata_wait_spinup(ap);
2735
2736         /* if we're about to do hardreset, nothing more to do */
2737         if (ehc->i.action & ATA_EH_HARDRESET)
2738                 return 0;
2739
2740         /* if SATA, resume phy */
2741         if (ap->cbl == ATA_CBL_SATA) {
2742                 rc = sata_phy_resume(ap, timing);
2743                 if (rc && rc != -EOPNOTSUPP) {
2744                         /* phy resume failed */
2745                         ata_port_printk(ap, KERN_WARNING, "failed to resume "
2746                                         "link for reset (errno=%d)\n", rc);
2747                         return rc;
2748                 }
2749         }
2750
2751         /* Wait for !BSY if the controller can wait for the first D2H
2752          * Reg FIS and we don't know that no device is attached.
2753          */
2754         if (!(ap->flags & ATA_FLAG_SKIP_D2H_BSY) && !ata_port_offline(ap))
2755                 ata_busy_sleep(ap, ATA_TMOUT_BOOT_QUICK, ATA_TMOUT_BOOT);
2756
2757         return 0;
2758 }
2759
2760 /**
2761  *      ata_std_softreset - reset host port via ATA SRST
2762  *      @ap: port to reset
2763  *      @classes: resulting classes of attached devices
2764  *
2765  *      Reset host port using ATA SRST.
2766  *
2767  *      LOCKING:
2768  *      Kernel thread context (may sleep)
2769  *
2770  *      RETURNS:
2771  *      0 on success, -errno otherwise.
2772  */
2773 int ata_std_softreset(struct ata_port *ap, unsigned int *classes)
2774 {
2775         unsigned int slave_possible = ap->flags & ATA_FLAG_SLAVE_POSS;
2776         unsigned int devmask = 0, err_mask;
2777         u8 err;
2778
2779         DPRINTK("ENTER\n");
2780
2781         if (ata_port_offline(ap)) {
2782                 classes[0] = ATA_DEV_NONE;
2783                 goto out;
2784         }
2785
2786         /* determine if device 0/1 are present */
2787         if (ata_devchk(ap, 0))
2788                 devmask |= (1 << 0);
2789         if (slave_possible && ata_devchk(ap, 1))
2790                 devmask |= (1 << 1);
2791
2792         /* select device 0 again */
2793         ap->ops->dev_select(ap, 0);
2794
2795         /* issue bus reset */
2796         DPRINTK("about to softreset, devmask=%x\n", devmask);
2797         err_mask = ata_bus_softreset(ap, devmask);
2798         if (err_mask) {
2799                 ata_port_printk(ap, KERN_ERR, "SRST failed (err_mask=0x%x)\n",
2800                                 err_mask);
2801                 return -EIO;
2802         }
2803
2804         /* determine by signature whether we have ATA or ATAPI devices */
2805         classes[0] = ata_dev_try_classify(ap, 0, &err);
2806         if (slave_possible && err != 0x81)
2807                 classes[1] = ata_dev_try_classify(ap, 1, &err);
2808
2809  out:
2810         DPRINTK("EXIT, classes[0]=%u [1]=%u\n", classes[0], classes[1]);
2811         return 0;
2812 }
2813
2814 /**
2815  *      sata_port_hardreset - reset port via SATA phy reset
2816  *      @ap: port to reset
2817  *      @timing: timing parameters { interval, duratinon, timeout } in msec
2818  *
2819  *      SATA phy-reset host port using DET bits of SControl register.
2820  *
2821  *      LOCKING:
2822  *      Kernel thread context (may sleep)
2823  *
2824  *      RETURNS:
2825  *      0 on success, -errno otherwise.
2826  */
2827 int sata_port_hardreset(struct ata_port *ap, const unsigned long *timing)
2828 {
2829         u32 scontrol;
2830         int rc;
2831
2832         DPRINTK("ENTER\n");
2833
2834         if (sata_set_spd_needed(ap)) {
2835                 /* SATA spec says nothing about how to reconfigure
2836                  * spd.  To be on the safe side, turn off phy during
2837                  * reconfiguration.  This works for at least ICH7 AHCI
2838                  * and Sil3124.
2839                  */
2840                 if ((rc = sata_scr_read(ap, SCR_CONTROL, &scontrol)))
2841                         goto out;
2842
2843                 scontrol = (scontrol & 0x0f0) | 0x304;
2844
2845                 if ((rc = sata_scr_write(ap, SCR_CONTROL, scontrol)))
2846                         goto out;
2847
2848                 sata_set_spd(ap);
2849         }
2850
2851         /* issue phy wake/reset */
2852         if ((rc = sata_scr_read(ap, SCR_CONTROL, &scontrol)))
2853                 goto out;
2854
2855         scontrol = (scontrol & 0x0f0) | 0x301;
2856
2857         if ((rc = sata_scr_write_flush(ap, SCR_CONTROL, scontrol)))
2858                 goto out;
2859
2860         /* Couldn't find anything in SATA I/II specs, but AHCI-1.1
2861          * 10.4.2 says at least 1 ms.
2862          */
2863         msleep(1);
2864
2865         /* bring phy back */
2866         rc = sata_phy_resume(ap, timing);
2867  out:
2868         DPRINTK("EXIT, rc=%d\n", rc);
2869         return rc;
2870 }
2871
2872 /**
2873  *      sata_std_hardreset - reset host port via SATA phy reset
2874  *      @ap: port to reset
2875  *      @class: resulting class of attached device
2876  *
2877  *      SATA phy-reset host port using DET bits of SControl register,
2878  *      wait for !BSY and classify the attached device.
2879  *
2880  *      LOCKING:
2881  *      Kernel thread context (may sleep)
2882  *
2883  *      RETURNS:
2884  *      0 on success, -errno otherwise.
2885  */
2886 int sata_std_hardreset(struct ata_port *ap, unsigned int *class)
2887 {
2888         const unsigned long *timing = sata_ehc_deb_timing(&ap->eh_context);
2889         int rc;
2890
2891         DPRINTK("ENTER\n");
2892
2893         /* do hardreset */
2894         rc = sata_port_hardreset(ap, timing);
2895         if (rc) {
2896                 ata_port_printk(ap, KERN_ERR,
2897                                 "COMRESET failed (errno=%d)\n", rc);
2898                 return rc;
2899         }
2900
2901         /* TODO: phy layer with polling, timeouts, etc. */
2902         if (ata_port_offline(ap)) {
2903                 *class = ATA_DEV_NONE;
2904                 DPRINTK("EXIT, link offline\n");
2905                 return 0;
2906         }
2907
2908         if (ata_busy_sleep(ap, ATA_TMOUT_BOOT_QUICK, ATA_TMOUT_BOOT)) {
2909                 ata_port_printk(ap, KERN_ERR,
2910                                 "COMRESET failed (device not ready)\n");
2911                 return -EIO;
2912         }
2913
2914         ap->ops->dev_select(ap, 0);     /* probably unnecessary */
2915
2916         *class = ata_dev_try_classify(ap, 0, NULL);
2917
2918         DPRINTK("EXIT, class=%u\n", *class);
2919         return 0;
2920 }
2921
2922 /**
2923  *      ata_std_postreset - standard postreset callback
2924  *      @ap: the target ata_port
2925  *      @classes: classes of attached devices
2926  *
2927  *      This function is invoked after a successful reset.  Note that
2928  *      the device might have been reset more than once using
2929  *      different reset methods before postreset is invoked.
2930  *
2931  *      LOCKING:
2932  *      Kernel thread context (may sleep)
2933  */
2934 void ata_std_postreset(struct ata_port *ap, unsigned int *classes)
2935 {
2936         u32 serror;
2937
2938         DPRINTK("ENTER\n");
2939
2940         /* print link status */
2941         sata_print_link_status(ap);
2942
2943         /* clear SError */
2944         if (sata_scr_read(ap, SCR_ERROR, &serror) == 0)
2945                 sata_scr_write(ap, SCR_ERROR, serror);
2946
2947         /* re-enable interrupts */
2948         if (!ap->ops->error_handler) {
2949                 /* FIXME: hack. create a hook instead */
2950                 if (ap->ioaddr.ctl_addr)
2951                         ata_irq_on(ap);
2952         }
2953
2954         /* is double-select really necessary? */
2955         if (classes[0] != ATA_DEV_NONE)
2956                 ap->ops->dev_select(ap, 1);
2957         if (classes[1] != ATA_DEV_NONE)
2958                 ap->ops->dev_select(ap, 0);
2959
2960         /* bail out if no device is present */
2961         if (classes[0] == ATA_DEV_NONE && classes[1] == ATA_DEV_NONE) {
2962                 DPRINTK("EXIT, no device\n");
2963                 return;
2964         }
2965
2966         /* set up device control */
2967         if (ap->ioaddr.ctl_addr) {
2968                 if (ap->flags & ATA_FLAG_MMIO)
2969                         writeb(ap->ctl, (void __iomem *) ap->ioaddr.ctl_addr);
2970                 else
2971                         outb(ap->ctl, ap->ioaddr.ctl_addr);
2972         }
2973
2974         DPRINTK("EXIT\n");
2975 }
2976
2977 /**
2978  *      ata_dev_same_device - Determine whether new ID matches configured device
2979  *      @dev: device to compare against
2980  *      @new_class: class of the new device
2981  *      @new_id: IDENTIFY page of the new device
2982  *
2983  *      Compare @new_class and @new_id against @dev and determine
2984  *      whether @dev is the device indicated by @new_class and
2985  *      @new_id.
2986  *
2987  *      LOCKING:
2988  *      None.
2989  *
2990  *      RETURNS:
2991  *      1 if @dev matches @new_class and @new_id, 0 otherwise.
2992  */
2993 static int ata_dev_same_device(struct ata_device *dev, unsigned int new_class,
2994                                const u16 *new_id)
2995 {
2996         const u16 *old_id = dev->id;
2997         unsigned char model[2][41], serial[2][21];
2998         u64 new_n_sectors;
2999
3000         if (dev->class != new_class) {
3001                 ata_dev_printk(dev, KERN_INFO, "class mismatch %d != %d\n",
3002                                dev->class, new_class);
3003                 return 0;
3004         }
3005
3006         ata_id_c_string(old_id, model[0], ATA_ID_PROD_OFS, sizeof(model[0]));
3007         ata_id_c_string(new_id, model[1], ATA_ID_PROD_OFS, sizeof(model[1]));
3008         ata_id_c_string(old_id, serial[0], ATA_ID_SERNO_OFS, sizeof(serial[0]));
3009         ata_id_c_string(new_id, serial[1], ATA_ID_SERNO_OFS, sizeof(serial[1]));
3010         new_n_sectors = ata_id_n_sectors(new_id);
3011
3012         if (strcmp(model[0], model[1])) {
3013                 ata_dev_printk(dev, KERN_INFO, "model number mismatch "
3014                                "'%s' != '%s'\n", model[0], model[1]);
3015                 return 0;
3016         }
3017
3018         if (strcmp(serial[0], serial[1])) {
3019                 ata_dev_printk(dev, KERN_INFO, "serial number mismatch "
3020                                "'%s' != '%s'\n", serial[0], serial[1]);
3021                 return 0;
3022         }
3023
3024         if (dev->class == ATA_DEV_ATA && dev->n_sectors != new_n_sectors) {
3025                 ata_dev_printk(dev, KERN_INFO, "n_sectors mismatch "
3026                                "%llu != %llu\n",
3027                                (unsigned long long)dev->n_sectors,
3028                                (unsigned long long)new_n_sectors);
3029                 return 0;
3030         }
3031
3032         return 1;
3033 }
3034
3035 /**
3036  *      ata_dev_revalidate - Revalidate ATA device
3037  *      @dev: device to revalidate
3038  *      @readid_flags: read ID flags
3039  *
3040  *      Re-read IDENTIFY page and make sure @dev is still attached to
3041  *      the port.
3042  *
3043  *      LOCKING:
3044  *      Kernel thread context (may sleep)
3045  *
3046  *      RETURNS:
3047  *      0 on success, negative errno otherwise
3048  */
3049 int ata_dev_revalidate(struct ata_device *dev, unsigned int readid_flags)
3050 {
3051         unsigned int class = dev->class;
3052         u16 *id = (void *)dev->ap->sector_buf;
3053         int rc;
3054
3055         if (!ata_dev_enabled(dev)) {
3056                 rc = -ENODEV;
3057                 goto fail;
3058         }
3059
3060         /* read ID data */
3061         rc = ata_dev_read_id(dev, &class, readid_flags, id);
3062         if (rc)
3063                 goto fail;
3064
3065         /* is the device still there? */
3066         if (!ata_dev_same_device(dev, class, id)) {
3067                 rc = -ENODEV;
3068                 goto fail;
3069         }
3070
3071         memcpy(dev->id, id, sizeof(id[0]) * ATA_ID_WORDS);
3072
3073         /* configure device according to the new ID */
3074         rc = ata_dev_configure(dev);
3075         if (rc == 0)
3076                 return 0;
3077
3078  fail:
3079         ata_dev_printk(dev, KERN_ERR, "revalidation failed (errno=%d)\n", rc);
3080         return rc;
3081 }
3082
3083 struct ata_blacklist_entry {
3084         const char *model_num;
3085         const char *model_rev;
3086         unsigned long horkage;
3087 };
3088
3089 static const struct ata_blacklist_entry ata_device_blacklist [] = {
3090         /* Devices with DMA related problems under Linux */
3091         { "WDC AC11000H",       NULL,           ATA_HORKAGE_NODMA },
3092         { "WDC AC22100H",       NULL,           ATA_HORKAGE_NODMA },
3093         { "WDC AC32500H",       NULL,           ATA_HORKAGE_NODMA },
3094         { "WDC AC33100H",       NULL,           ATA_HORKAGE_NODMA },
3095         { "WDC AC31600H",       NULL,           ATA_HORKAGE_NODMA },
3096         { "WDC AC32100H",       "24.09P07",     ATA_HORKAGE_NODMA },
3097         { "WDC AC23200L",       "21.10N21",     ATA_HORKAGE_NODMA },
3098         { "Compaq CRD-8241B",   NULL,           ATA_HORKAGE_NODMA },
3099         { "CRD-8400B",          NULL,           ATA_HORKAGE_NODMA },
3100         { "CRD-8480B",          NULL,           ATA_HORKAGE_NODMA },
3101         { "CRD-8482B",          NULL,           ATA_HORKAGE_NODMA },
3102         { "CRD-84",             NULL,           ATA_HORKAGE_NODMA },
3103         { "SanDisk SDP3B",      NULL,           ATA_HORKAGE_NODMA },
3104         { "SanDisk SDP3B-64",   NULL,           ATA_HORKAGE_NODMA },
3105         { "SANYO CD-ROM CRD",   NULL,           ATA_HORKAGE_NODMA },
3106         { "HITACHI CDR-8",      NULL,           ATA_HORKAGE_NODMA },
3107         { "HITACHI CDR-8335",   NULL,           ATA_HORKAGE_NODMA },
3108         { "HITACHI CDR-8435",   NULL,           ATA_HORKAGE_NODMA },
3109         { "Toshiba CD-ROM XM-6202B", NULL,      ATA_HORKAGE_NODMA },
3110         { "TOSHIBA CD-ROM XM-1702BC", NULL,     ATA_HORKAGE_NODMA },
3111         { "CD-532E-A",          NULL,           ATA_HORKAGE_NODMA },
3112         { "E-IDE CD-ROM CR-840",NULL,           ATA_HORKAGE_NODMA },
3113         { "CD-ROM Drive/F5A",   NULL,           ATA_HORKAGE_NODMA },
3114         { "WPI CDD-820",        NULL,           ATA_HORKAGE_NODMA },
3115         { "SAMSUNG CD-ROM SC-148C", NULL,       ATA_HORKAGE_NODMA },
3116         { "SAMSUNG CD-ROM SC",  NULL,           ATA_HORKAGE_NODMA },
3117         { "SanDisk SDP3B-64",   NULL,           ATA_HORKAGE_NODMA },
3118         { "ATAPI CD-ROM DRIVE 40X MAXIMUM",NULL,ATA_HORKAGE_NODMA },
3119         { "_NEC DV5800A",       NULL,           ATA_HORKAGE_NODMA },
3120         { "SAMSUNG CD-ROM SN-124","N001",       ATA_HORKAGE_NODMA },
3121
3122         /* Devices we expect to fail diagnostics */
3123
3124         /* Devices where NCQ should be avoided */
3125         /* NCQ is slow */
3126         { "WDC WD740ADFD-00",   NULL,           ATA_HORKAGE_NONCQ },
3127
3128         /* Devices with NCQ limits */
3129
3130         /* End Marker */
3131         { }
3132 };
3133
3134 static int ata_strim(char *s, size_t len)
3135 {
3136         len = strnlen(s, len);
3137
3138         /* ATAPI specifies that empty space is blank-filled; remove blanks */
3139         while ((len > 0) && (s[len - 1] == ' ')) {
3140                 len--;
3141                 s[len] = 0;
3142         }
3143         return len;
3144 }
3145
3146 unsigned long ata_device_blacklisted(const struct ata_device *dev)
3147 {
3148         unsigned char model_num[40];
3149         unsigned char model_rev[16];
3150         unsigned int nlen, rlen;
3151         const struct ata_blacklist_entry *ad = ata_device_blacklist;
3152
3153         ata_id_string(dev->id, model_num, ATA_ID_PROD_OFS,
3154                           sizeof(model_num));
3155         ata_id_string(dev->id, model_rev, ATA_ID_FW_REV_OFS,
3156                           sizeof(model_rev));
3157         nlen = ata_strim(model_num, sizeof(model_num));
3158         rlen = ata_strim(model_rev, sizeof(model_rev));
3159
3160         while (ad->model_num) {
3161                 if (!strncmp(ad->model_num, model_num, nlen)) {
3162                         if (ad->model_rev == NULL)
3163                                 return ad->horkage;
3164                         if (!strncmp(ad->model_rev, model_rev, rlen))
3165                                 return ad->horkage;
3166                 }
3167                 ad++;
3168         }
3169         return 0;
3170 }
3171
3172 static int ata_dma_blacklisted(const struct ata_device *dev)
3173 {
3174         /* We don't support polling DMA.
3175          * DMA blacklist those ATAPI devices with CDB-intr (and use PIO)
3176          * if the LLDD handles only interrupts in the HSM_ST_LAST state.
3177          */
3178         if ((dev->ap->flags & ATA_FLAG_PIO_POLLING) &&
3179             (dev->flags & ATA_DFLAG_CDB_INTR))
3180                 return 1;
3181         return (ata_device_blacklisted(dev) & ATA_HORKAGE_NODMA) ? 1 : 0;
3182 }
3183
3184 /**
3185  *      ata_dev_xfermask - Compute supported xfermask of the given device
3186  *      @dev: Device to compute xfermask for
3187  *
3188  *      Compute supported xfermask of @dev and store it in
3189  *      dev->*_mask.  This function is responsible for applying all
3190  *      known limits including host controller limits, device
3191  *      blacklist, etc...
3192  *
3193  *      LOCKING:
3194  *      None.
3195  */
3196 static void ata_dev_xfermask(struct ata_device *dev)
3197 {
3198         struct ata_port *ap = dev->ap;
3199         struct ata_host *host = ap->host;
3200         unsigned long xfer_mask;
3201
3202         /* controller modes available */
3203         xfer_mask = ata_pack_xfermask(ap->pio_mask,
3204                                       ap->mwdma_mask, ap->udma_mask);
3205
3206         /* Apply cable rule here.  Don't apply it early because when
3207          * we handle hot plug the cable type can itself change.
3208          */
3209         if (ap->cbl == ATA_CBL_PATA40)
3210                 xfer_mask &= ~(0xF8 << ATA_SHIFT_UDMA);
3211         /* Apply drive side cable rule. Unknown or 80 pin cables reported
3212          * host side are checked drive side as well. Cases where we know a
3213          * 40wire cable is used safely for 80 are not checked here.
3214          */
3215         if (ata_drive_40wire(dev->id) && (ap->cbl == ATA_CBL_PATA_UNK || ap->cbl == ATA_CBL_PATA80))
3216                 xfer_mask &= ~(0xF8 << ATA_SHIFT_UDMA);
3217
3218
3219         xfer_mask &= ata_pack_xfermask(dev->pio_mask,
3220                                        dev->mwdma_mask, dev->udma_mask);
3221         xfer_mask &= ata_id_xfermask(dev->id);
3222
3223         /*
3224          *      CFA Advanced TrueIDE timings are not allowed on a shared
3225          *      cable
3226          */
3227         if (ata_dev_pair(dev)) {
3228                 /* No PIO5 or PIO6 */
3229                 xfer_mask &= ~(0x03 << (ATA_SHIFT_PIO + 5));
3230                 /* No MWDMA3 or MWDMA 4 */
3231                 xfer_mask &= ~(0x03 << (ATA_SHIFT_MWDMA + 3));
3232         }
3233
3234         if (ata_dma_blacklisted(dev)) {
3235                 xfer_mask &= ~(ATA_MASK_MWDMA | ATA_MASK_UDMA);
3236                 ata_dev_printk(dev, KERN_WARNING,
3237                                "device is on DMA blacklist, disabling DMA\n");
3238         }
3239
3240         if ((host->flags & ATA_HOST_SIMPLEX) && host->simplex_claimed) {
3241                 xfer_mask &= ~(ATA_MASK_MWDMA | ATA_MASK_UDMA);
3242                 ata_dev_printk(dev, KERN_WARNING, "simplex DMA is claimed by "
3243                                "other device, disabling DMA\n");
3244         }
3245
3246         if (ap->ops->mode_filter)
3247                 xfer_mask = ap->ops->mode_filter(ap, dev, xfer_mask);
3248
3249         ata_unpack_xfermask(xfer_mask, &dev->pio_mask,
3250                             &dev->mwdma_mask, &dev->udma_mask);
3251 }
3252
3253 /**
3254  *      ata_dev_set_xfermode - Issue SET FEATURES - XFER MODE command
3255  *      @dev: Device to which command will be sent
3256  *
3257  *      Issue SET FEATURES - XFER MODE command to device @dev
3258  *      on port @ap.
3259  *
3260  *      LOCKING:
3261  *      PCI/etc. bus probe sem.
3262  *
3263  *      RETURNS:
3264  *      0 on success, AC_ERR_* mask otherwise.
3265  */
3266
3267 static unsigned int ata_dev_set_xfermode(struct ata_device *dev)
3268 {
3269         struct ata_taskfile tf;
3270         unsigned int err_mask;
3271
3272         /* set up set-features taskfile */
3273         DPRINTK("set features - xfer mode\n");
3274
3275         ata_tf_init(dev, &tf);
3276         tf.command = ATA_CMD_SET_FEATURES;
3277         tf.feature = SETFEATURES_XFER;
3278         tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
3279         tf.protocol = ATA_PROT_NODATA;
3280         tf.nsect = dev->xfer_mode;
3281
3282         err_mask = ata_exec_internal(dev, &tf, NULL, DMA_NONE, NULL, 0);
3283
3284         DPRINTK("EXIT, err_mask=%x\n", err_mask);
3285         return err_mask;
3286 }
3287
3288 /**
3289  *      ata_dev_init_params - Issue INIT DEV PARAMS command
3290  *      @dev: Device to which command will be sent
3291  *      @heads: Number of heads (taskfile parameter)
3292  *      @sectors: Number of sectors (taskfile parameter)
3293  *
3294  *      LOCKING:
3295  *      Kernel thread context (may sleep)
3296  *
3297  *      RETURNS:
3298  *      0 on success, AC_ERR_* mask otherwise.
3299  */
3300 static unsigned int ata_dev_init_params(struct ata_device *dev,
3301                                         u16 heads, u16 sectors)
3302 {
3303         struct ata_taskfile tf;
3304         unsigned int err_mask;
3305
3306         /* Number of sectors per track 1-255. Number of heads 1-16 */
3307         if (sectors < 1 || sectors > 255 || heads < 1 || heads > 16)
3308                 return AC_ERR_INVALID;
3309
3310         /* set up init dev params taskfile */
3311         DPRINTK("init dev params \n");
3312
3313         ata_tf_init(dev, &tf);
3314         tf.command = ATA_CMD_INIT_DEV_PARAMS;
3315         tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
3316         tf.protocol = ATA_PROT_NODATA;
3317         tf.nsect = sectors;
3318         tf.device |= (heads - 1) & 0x0f; /* max head = num. of heads - 1 */
3319
3320         err_mask = ata_exec_internal(dev, &tf, NULL, DMA_NONE, NULL, 0);
3321
3322         DPRINTK("EXIT, err_mask=%x\n", err_mask);
3323         return err_mask;
3324 }
3325
3326 /**
3327  *      ata_sg_clean - Unmap DMA memory associated with command
3328  *      @qc: Command containing DMA memory to be released
3329  *
3330  *      Unmap all mapped DMA memory associated with this command.
3331  *
3332  *      LOCKING:
3333  *      spin_lock_irqsave(host lock)
3334  */
3335
3336 static void ata_sg_clean(struct ata_queued_cmd *qc)
3337 {
3338         struct ata_port *ap = qc->ap;
3339         struct scatterlist *sg = qc->__sg;
3340         int dir = qc->dma_dir;
3341         void *pad_buf = NULL;
3342
3343         WARN_ON(!(qc->flags & ATA_QCFLAG_DMAMAP));
3344         WARN_ON(sg == NULL);
3345
3346         if (qc->flags & ATA_QCFLAG_SINGLE)
3347                 WARN_ON(qc->n_elem > 1);
3348
3349         VPRINTK("unmapping %u sg elements\n", qc->n_elem);
3350
3351         /* if we padded the buffer out to 32-bit bound, and data
3352          * xfer direction is from-device, we must copy from the
3353          * pad buffer back into the supplied buffer
3354          */
3355         if (qc->pad_len && !(qc->tf.flags & ATA_TFLAG_WRITE))
3356                 pad_buf = ap->pad + (qc->tag * ATA_DMA_PAD_SZ);
3357
3358         if (qc->flags & ATA_QCFLAG_SG) {
3359                 if (qc->n_elem)
3360                         dma_unmap_sg(ap->dev, sg, qc->n_elem, dir);
3361                 /* restore last sg */
3362                 sg[qc->orig_n_elem - 1].length += qc->pad_len;
3363                 if (pad_buf) {
3364                         struct scatterlist *psg = &qc->pad_sgent;
3365                         void *addr = kmap_atomic(psg->page, KM_IRQ0);
3366                         memcpy(addr + psg->offset, pad_buf, qc->pad_len);
3367                         kunmap_atomic(addr, KM_IRQ0);
3368                 }
3369         } else {
3370                 if (qc->n_elem)
3371                         dma_unmap_single(ap->dev,
3372                                 sg_dma_address(&sg[0]), sg_dma_len(&sg[0]),
3373                                 dir);
3374                 /* restore sg */
3375                 sg->length += qc->pad_len;
3376                 if (pad_buf)
3377                         memcpy(qc->buf_virt + sg->length - qc->pad_len,
3378                                pad_buf, qc->pad_len);
3379         }
3380
3381         qc->flags &= ~ATA_QCFLAG_DMAMAP;
3382         qc->__sg = NULL;
3383 }
3384
3385 /**
3386  *      ata_fill_sg - Fill PCI IDE PRD table
3387  *      @qc: Metadata associated with taskfile to be transferred
3388  *
3389  *      Fill PCI IDE PRD (scatter-gather) table with segments
3390  *      associated with the current disk command.
3391  *
3392  *      LOCKING:
3393  *      spin_lock_irqsave(host lock)
3394  *
3395  */
3396 static void ata_fill_sg(struct ata_queued_cmd *qc)
3397 {
3398         struct ata_port *ap = qc->ap;
3399         struct scatterlist *sg;
3400         unsigned int idx;
3401
3402         WARN_ON(qc->__sg == NULL);
3403         WARN_ON(qc->n_elem == 0 && qc->pad_len == 0);
3404
3405         idx = 0;
3406         ata_for_each_sg(sg, qc) {
3407                 u32 addr, offset;
3408                 u32 sg_len, len;
3409
3410                 /* determine if physical DMA addr spans 64K boundary.
3411                  * Note h/w doesn't support 64-bit, so we unconditionally
3412                  * truncate dma_addr_t to u32.
3413                  */
3414                 addr = (u32) sg_dma_address(sg);
3415                 sg_len = sg_dma_len(sg);
3416
3417                 while (sg_len) {
3418                         offset = addr & 0xffff;
3419                         len = sg_len;
3420                         if ((offset + sg_len) > 0x10000)
3421                                 len = 0x10000 - offset;
3422
3423                         ap->prd[idx].addr = cpu_to_le32(addr);
3424                         ap->prd[idx].flags_len = cpu_to_le32(len & 0xffff);
3425                         VPRINTK("PRD[%u] = (0x%X, 0x%X)\n", idx, addr, len);
3426
3427                         idx++;
3428                         sg_len -= len;
3429                         addr += len;
3430                 }
3431         }
3432
3433         if (idx)
3434                 ap->prd[idx - 1].flags_len |= cpu_to_le32(ATA_PRD_EOT);
3435 }
3436 /**
3437  *      ata_check_atapi_dma - Check whether ATAPI DMA can be supported
3438  *      @qc: Metadata associated with taskfile to check
3439  *
3440  *      Allow low-level driver to filter ATA PACKET commands, returning
3441  *      a status indicating whether or not it is OK to use DMA for the
3442  *      supplied PACKET command.
3443  *
3444  *      LOCKING:
3445  *      spin_lock_irqsave(host lock)
3446  *
3447  *      RETURNS: 0 when ATAPI DMA can be used
3448  *               nonzero otherwise
3449  */
3450 int ata_check_atapi_dma(struct ata_queued_cmd *qc)
3451 {
3452         struct ata_port *ap = qc->ap;
3453         int rc = 0; /* Assume ATAPI DMA is OK by default */
3454
3455         if (ap->ops->check_atapi_dma)
3456                 rc = ap->ops->check_atapi_dma(qc);
3457
3458         return rc;
3459 }
3460 /**
3461  *      ata_qc_prep - Prepare taskfile for submission
3462  *      @qc: Metadata associated with taskfile to be prepared
3463  *
3464  *      Prepare ATA taskfile for submission.
3465  *
3466  *      LOCKING:
3467  *      spin_lock_irqsave(host lock)
3468  */
3469 void ata_qc_prep(struct ata_queued_cmd *qc)
3470 {
3471         if (!(qc->flags & ATA_QCFLAG_DMAMAP))
3472                 return;
3473
3474         ata_fill_sg(qc);
3475 }
3476
3477 void ata_noop_qc_prep(struct ata_queued_cmd *qc) { }
3478
3479 /**
3480  *      ata_sg_init_one - Associate command with memory buffer
3481  *      @qc: Command to be associated
3482  *      @buf: Memory buffer
3483  *      @buflen: Length of memory buffer, in bytes.
3484  *
3485  *      Initialize the data-related elements of queued_cmd @qc
3486  *      to point to a single memory buffer, @buf of byte length @buflen.
3487  *
3488  *      LOCKING:
3489  *      spin_lock_irqsave(host lock)
3490  */
3491
3492 void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf, unsigned int buflen)
3493 {
3494         qc->flags |= ATA_QCFLAG_SINGLE;
3495
3496         qc->__sg = &qc->sgent;
3497         qc->n_elem = 1;
3498         qc->orig_n_elem = 1;
3499         qc->buf_virt = buf;
3500         qc->nbytes = buflen;
3501
3502         sg_init_one(&qc->sgent, buf, buflen);
3503 }
3504
3505 /**
3506  *      ata_sg_init - Associate command with scatter-gather table.
3507  *      @qc: Command to be associated
3508  *      @sg: Scatter-gather table.
3509  *      @n_elem: Number of elements in s/g table.
3510  *
3511  *      Initialize the data-related elements of queued_cmd @qc
3512  *      to point to a scatter-gather table @sg, containing @n_elem
3513  *      elements.
3514  *
3515  *      LOCKING:
3516  *      spin_lock_irqsave(host lock)
3517  */
3518
3519 void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
3520                  unsigned int n_elem)
3521 {
3522         qc->flags |= ATA_QCFLAG_SG;
3523         qc->__sg = sg;
3524         qc->n_elem = n_elem;
3525         qc->orig_n_elem = n_elem;
3526 }
3527
3528 /**
3529  *      ata_sg_setup_one - DMA-map the memory buffer associated with a command.
3530  *      @qc: Command with memory buffer to be mapped.
3531  *
3532  *      DMA-map the memory buffer associated with queued_cmd @qc.
3533  *
3534  *      LOCKING:
3535  *      spin_lock_irqsave(host lock)
3536  *
3537  *      RETURNS:
3538  *      Zero on success, negative on error.
3539  */
3540
3541 static int ata_sg_setup_one(struct ata_queued_cmd *qc)
3542 {
3543         struct ata_port *ap = qc->ap;
3544         int dir = qc->dma_dir;
3545         struct scatterlist *sg = qc->__sg;
3546         dma_addr_t dma_address;
3547         int trim_sg = 0;
3548
3549         /* we must lengthen transfers to end on a 32-bit boundary */
3550         qc->pad_len = sg->length & 3;
3551         if (qc->pad_len) {
3552                 void *pad_buf = ap->pad + (qc->tag * ATA_DMA_PAD_SZ);
3553                 struct scatterlist *psg = &qc->pad_sgent;
3554
3555                 WARN_ON(qc->dev->class != ATA_DEV_ATAPI);
3556
3557                 memset(pad_buf, 0, ATA_DMA_PAD_SZ);
3558
3559                 if (qc->tf.flags & ATA_TFLAG_WRITE)
3560                         memcpy(pad_buf, qc->buf_virt + sg->length - qc->pad_len,
3561                                qc->pad_len);
3562
3563                 sg_dma_address(psg) = ap->pad_dma + (qc->tag * ATA_DMA_PAD_SZ);
3564                 sg_dma_len(psg) = ATA_DMA_PAD_SZ;
3565                 /* trim sg */
3566                 sg->length -= qc->pad_len;
3567                 if (sg->length == 0)
3568                         trim_sg = 1;
3569
3570                 DPRINTK("padding done, sg->length=%u pad_len=%u\n",
3571                         sg->length, qc->pad_len);
3572         }
3573
3574         if (trim_sg) {
3575                 qc->n_elem--;
3576                 goto skip_map;
3577         }
3578
3579         dma_address = dma_map_single(ap->dev, qc->buf_virt,
3580                                      sg->length, dir);
3581         if (dma_mapping_error(dma_address)) {
3582                 /* restore sg */
3583                 sg->length += qc->pad_len;
3584                 return -1;
3585         }
3586
3587         sg_dma_address(sg) = dma_address;
3588         sg_dma_len(sg) = sg->length;
3589
3590 skip_map:
3591         DPRINTK("mapped buffer of %d bytes for %s\n", sg_dma_len(sg),
3592                 qc->tf.flags & ATA_TFLAG_WRITE ? "write" : "read");
3593
3594         return 0;
3595 }
3596
3597 /**
3598  *      ata_sg_setup - DMA-map the scatter-gather table associated with a command.
3599  *      @qc: Command with scatter-gather table to be mapped.
3600  *
3601  *      DMA-map the scatter-gather table associated with queued_cmd @qc.
3602  *
3603  *      LOCKING:
3604  *      spin_lock_irqsave(host lock)
3605  *
3606  *      RETURNS:
3607  *      Zero on success, negative on error.
3608  *
3609  */
3610
3611 static int ata_sg_setup(struct ata_queued_cmd *qc)
3612 {
3613         struct ata_port *ap = qc->ap;
3614         struct scatterlist *sg = qc->__sg;
3615         struct scatterlist *lsg = &sg[qc->n_elem - 1];
3616         int n_elem, pre_n_elem, dir, trim_sg = 0;
3617
3618         VPRINTK("ENTER, ata%u\n", ap->id);
3619         WARN_ON(!(qc->flags & ATA_QCFLAG_SG));
3620
3621         /* we must lengthen transfers to end on a 32-bit boundary */
3622         qc->pad_len = lsg->length & 3;
3623         if (qc->pad_len) {
3624                 void *pad_buf = ap->pad + (qc->tag * ATA_DMA_PAD_SZ);
3625                 struct scatterlist *psg = &qc->pad_sgent;
3626                 unsigned int offset;
3627
3628                 WARN_ON(qc->dev->class != ATA_DEV_ATAPI);
3629
3630                 memset(pad_buf, 0, ATA_DMA_PAD_SZ);
3631
3632                 /*
3633                  * psg->page/offset are used to copy to-be-written
3634                  * data in this function or read data in ata_sg_clean.
3635                  */
3636                 offset = lsg->offset + lsg->length - qc->pad_len;
3637                 psg->page = nth_page(lsg->page, offset >> PAGE_SHIFT);
3638                 psg->offset = offset_in_page(offset);
3639
3640                 if (qc->tf.flags & ATA_TFLAG_WRITE) {
3641                         void *addr = kmap_atomic(psg->page, KM_IRQ0);
3642                         memcpy(pad_buf, addr + psg->offset, qc->pad_len);
3643                         kunmap_atomic(addr, KM_IRQ0);
3644                 }
3645
3646                 sg_dma_address(psg) = ap->pad_dma + (qc->tag * ATA_DMA_PAD_SZ);
3647                 sg_dma_len(psg) = ATA_DMA_PAD_SZ;
3648                 /* trim last sg */
3649                 lsg->length -= qc->pad_len;
3650                 if (lsg->length == 0)
3651                         trim_sg = 1;
3652
3653                 DPRINTK("padding done, sg[%d].length=%u pad_len=%u\n",
3654                         qc->n_elem - 1, lsg->length, qc->pad_len);
3655         }
3656
3657         pre_n_elem = qc->n_elem;
3658         if (trim_sg && pre_n_elem)
3659                 pre_n_elem--;
3660
3661         if (!pre_n_elem) {
3662                 n_elem = 0;
3663                 goto skip_map;
3664         }
3665
3666         dir = qc->dma_dir;
3667         n_elem = dma_map_sg(ap->dev, sg, pre_n_elem, dir);
3668         if (n_elem < 1) {
3669                 /* restore last sg */
3670                 lsg->length += qc->pad_len;
3671                 return -1;
3672         }
3673
3674         DPRINTK("%d sg elements mapped\n", n_elem);
3675
3676 skip_map:
3677         qc->n_elem = n_elem;
3678
3679         return 0;
3680 }
3681
3682 /**
3683  *      swap_buf_le16 - swap halves of 16-bit words in place
3684  *      @buf:  Buffer to swap
3685  *      @buf_words:  Number of 16-bit words in buffer.
3686  *
3687  *      Swap halves of 16-bit words if needed to convert from
3688  *      little-endian byte order to native cpu byte order, or
3689  *      vice-versa.
3690  *
3691  *      LOCKING:
3692  *      Inherited from caller.
3693  */
3694 void swap_buf_le16(u16 *buf, unsigned int buf_words)
3695 {
3696 #ifdef __BIG_ENDIAN
3697         unsigned int i;
3698
3699         for (i = 0; i < buf_words; i++)
3700                 buf[i] = le16_to_cpu(buf[i]);
3701 #endif /* __BIG_ENDIAN */
3702 }
3703
3704 /**
3705  *      ata_mmio_data_xfer - Transfer data by MMIO
3706  *      @adev: device for this I/O
3707  *      @buf: data buffer
3708  *      @buflen: buffer length
3709  *      @write_data: read/write
3710  *
3711  *      Transfer data from/to the device data register by MMIO.
3712  *
3713  *      LOCKING:
3714  *      Inherited from caller.
3715  */
3716
3717 void ata_mmio_data_xfer(struct ata_device *adev, unsigned char *buf,
3718                         unsigned int buflen, int write_data)
3719 {
3720         struct ata_port *ap = adev->ap;
3721         unsigned int i;
3722         unsigned int words = buflen >> 1;
3723         u16 *buf16 = (u16 *) buf;
3724         void __iomem *mmio = (void __iomem *)ap->ioaddr.data_addr;
3725
3726         /* Transfer multiple of 2 bytes */
3727         if (write_data) {
3728                 for (i = 0; i < words; i++)
3729                         writew(le16_to_cpu(buf16[i]), mmio);
3730         } else {
3731                 for (i = 0; i < words; i++)
3732                         buf16[i] = cpu_to_le16(readw(mmio));
3733         }
3734
3735         /* Transfer trailing 1 byte, if any. */
3736         if (unlikely(buflen & 0x01)) {
3737                 u16 align_buf[1] = { 0 };
3738                 unsigned char *trailing_buf = buf + buflen - 1;
3739
3740                 if (write_data) {
3741                         memcpy(align_buf, trailing_buf, 1);
3742                         writew(le16_to_cpu(align_buf[0]), mmio);
3743                 } else {
3744                         align_buf[0] = cpu_to_le16(readw(mmio));
3745                         memcpy(trailing_buf, align_buf, 1);
3746                 }
3747         }
3748 }
3749
3750 /**
3751  *      ata_pio_data_xfer - Transfer data by PIO
3752  *      @adev: device to target
3753  *      @buf: data buffer
3754  *      @buflen: buffer length
3755  *      @write_data: read/write
3756  *
3757  *      Transfer data from/to the device data register by PIO.
3758  *
3759  *      LOCKING:
3760  *      Inherited from caller.
3761  */
3762
3763 void ata_pio_data_xfer(struct ata_device *adev, unsigned char *buf,
3764                        unsigned int buflen, int write_data)
3765 {
3766         struct ata_port *ap = adev->ap;
3767         unsigned int words = buflen >> 1;
3768
3769         /* Transfer multiple of 2 bytes */
3770         if (write_data)
3771                 outsw(ap->ioaddr.data_addr, buf, words);
3772         else
3773                 insw(ap->ioaddr.data_addr, buf, words);
3774
3775         /* Transfer trailing 1 byte, if any. */
3776         if (unlikely(buflen & 0x01)) {
3777                 u16 align_buf[1] = { 0 };
3778                 unsigned char *trailing_buf = buf + buflen - 1;
3779
3780                 if (write_data) {
3781                         memcpy(align_buf, trailing_buf, 1);
3782                         outw(le16_to_cpu(align_buf[0]), ap->ioaddr.data_addr);
3783                 } else {
3784                         align_buf[0] = cpu_to_le16(inw(ap->ioaddr.data_addr));
3785                         memcpy(trailing_buf, align_buf, 1);
3786                 }
3787         }
3788 }
3789
3790 /**
3791  *      ata_pio_data_xfer_noirq - Transfer data by PIO
3792  *      @adev: device to target
3793  *      @buf: data buffer
3794  *      @buflen: buffer length
3795  *      @write_data: read/write
3796  *
3797  *      Transfer data from/to the device data register by PIO. Do the
3798  *      transfer with interrupts disabled.
3799  *
3800  *      LOCKING:
3801  *      Inherited from caller.
3802  */
3803
3804 void ata_pio_data_xfer_noirq(struct ata_device *adev, unsigned char *buf,
3805                                     unsigned int buflen, int write_data)
3806 {
3807         unsigned long flags;
3808         local_irq_save(flags);
3809         ata_pio_data_xfer(adev, buf, buflen, write_data);
3810         local_irq_restore(flags);
3811 }
3812
3813
3814 /**
3815  *      ata_pio_sector - Transfer ATA_SECT_SIZE (512 bytes) of data.
3816  *      @qc: Command on going
3817  *
3818  *      Transfer ATA_SECT_SIZE of data from/to the ATA device.
3819  *
3820  *      LOCKING:
3821  *      Inherited from caller.
3822  */
3823
3824 static void ata_pio_sector(struct ata_queued_cmd *qc)
3825 {
3826         int do_write = (qc->tf.flags & ATA_TFLAG_WRITE);
3827         struct scatterlist *sg = qc->__sg;
3828         struct ata_port *ap = qc->ap;
3829         struct page *page;
3830         unsigned int offset;
3831         unsigned char *buf;
3832
3833         if (qc->cursect == (qc->nsect - 1))
3834                 ap->hsm_task_state = HSM_ST_LAST;
3835
3836         page = sg[qc->cursg].page;
3837         offset = sg[qc->cursg].offset + qc->cursg_ofs * ATA_SECT_SIZE;
3838
3839         /* get the current page and offset */
3840         page = nth_page(page, (offset >> PAGE_SHIFT));
3841         offset %= PAGE_SIZE;
3842
3843         DPRINTK("data %s\n", qc->tf.flags & ATA_TFLAG_WRITE ? "write" : "read");
3844
3845         if (PageHighMem(page)) {
3846                 unsigned long flags;
3847
3848                 /* FIXME: use a bounce buffer */
3849                 local_irq_save(flags);
3850                 buf = kmap_atomic(page, KM_IRQ0);
3851
3852                 /* do the actual data transfer */
3853                 ap->ops->data_xfer(qc->dev, buf + offset, ATA_SECT_SIZE, do_write);
3854
3855                 kunmap_atomic(buf, KM_IRQ0);
3856                 local_irq_restore(flags);
3857         } else {
3858                 buf = page_address(page);
3859                 ap->ops->data_xfer(qc->dev, buf + offset, ATA_SECT_SIZE, do_write);
3860         }
3861
3862         qc->cursect++;
3863         qc->cursg_ofs++;
3864
3865         if ((qc->cursg_ofs * ATA_SECT_SIZE) == (&sg[qc->cursg])->length) {
3866                 qc->cursg++;
3867                 qc->cursg_ofs = 0;
3868         }
3869 }
3870
3871 /**
3872  *      ata_pio_sectors - Transfer one or many 512-byte sectors.
3873  *      @qc: Command on going
3874  *
3875  *      Transfer one or many ATA_SECT_SIZE of data from/to the
3876  *      ATA device for the DRQ request.
3877  *
3878  *      LOCKING:
3879  *      Inherited from caller.
3880  */
3881
3882 static void ata_pio_sectors(struct ata_queued_cmd *qc)
3883 {
3884         if (is_multi_taskfile(&qc->tf)) {
3885                 /* READ/WRITE MULTIPLE */
3886                 unsigned int nsect;
3887
3888                 WARN_ON(qc->dev->multi_count == 0);
3889
3890                 nsect = min(qc->nsect - qc->cursect, qc->dev->multi_count);
3891                 while (nsect--)
3892                         ata_pio_sector(qc);
3893         } else
3894                 ata_pio_sector(qc);
3895 }
3896
3897 /**
3898  *      atapi_send_cdb - Write CDB bytes to hardware
3899  *      @ap: Port to which ATAPI device is attached.
3900  *      @qc: Taskfile currently active
3901  *
3902  *      When device has indicated its readiness to accept
3903  *      a CDB, this function is called.  Send the CDB.
3904  *
3905  *      LOCKING:
3906  *      caller.
3907  */
3908
3909 static void atapi_send_cdb(struct ata_port *ap, struct ata_queued_cmd *qc)
3910 {
3911         /* send SCSI cdb */
3912         DPRINTK("send cdb\n");
3913         WARN_ON(qc->dev->cdb_len < 12);
3914
3915         ap->ops->data_xfer(qc->dev, qc->cdb, qc->dev->cdb_len, 1);
3916         ata_altstatus(ap); /* flush */
3917
3918         switch (qc->tf.protocol) {
3919         case ATA_PROT_ATAPI:
3920                 ap->hsm_task_state = HSM_ST;
3921                 break;
3922         case ATA_PROT_ATAPI_NODATA:
3923                 ap->hsm_task_state = HSM_ST_LAST;
3924                 break;
3925         case ATA_PROT_ATAPI_DMA:
3926                 ap->hsm_task_state = HSM_ST_LAST;
3927                 /* initiate bmdma */
3928                 ap->ops->bmdma_start(qc);
3929                 break;
3930         }
3931 }
3932
3933 /**
3934  *      __atapi_pio_bytes - Transfer data from/to the ATAPI device.
3935  *      @qc: Command on going
3936  *      @bytes: number of bytes
3937  *
3938  *      Transfer Transfer data from/to the ATAPI device.
3939  *
3940  *      LOCKING:
3941  *      Inherited from caller.
3942  *
3943  */
3944
3945 static void __atapi_pio_bytes(struct ata_queued_cmd *qc, unsigned int bytes)
3946 {
3947         int do_write = (qc->tf.flags & ATA_TFLAG_WRITE);
3948         struct scatterlist *sg = qc->__sg;
3949         struct ata_port *ap = qc->ap;
3950         struct page *page;
3951         unsigned char *buf;
3952         unsigned int offset, count;
3953
3954         if (qc->curbytes + bytes >= qc->nbytes)
3955                 ap->hsm_task_state = HSM_ST_LAST;
3956
3957 next_sg:
3958         if (unlikely(qc->cursg >= qc->n_elem)) {
3959                 /*
3960                  * The end of qc->sg is reached and the device expects
3961                  * more data to transfer. In order not to overrun qc->sg
3962                  * and fulfill length specified in the byte count register,
3963                  *    - for read case, discard trailing data from the device
3964                  *    - for write case, padding zero data to the device
3965                  */
3966                 u16 pad_buf[1] = { 0 };
3967                 unsigned int words = bytes >> 1;
3968                 unsigned int i;
3969
3970                 if (words) /* warning if bytes > 1 */
3971                         ata_dev_printk(qc->dev, KERN_WARNING,
3972                                        "%u bytes trailing data\n", bytes);
3973
3974                 for (i = 0; i < words; i++)
3975                         ap->ops->data_xfer(qc->dev, (unsigned char*)pad_buf, 2, do_write);
3976
3977                 ap->hsm_task_state = HSM_ST_LAST;
3978                 return;
3979         }
3980
3981         sg = &qc->__sg[qc->cursg];
3982
3983         page = sg->page;
3984         offset = sg->offset + qc->cursg_ofs;
3985
3986         /* get the current page and offset */
3987         page = nth_page(page, (offset >> PAGE_SHIFT));
3988         offset %= PAGE_SIZE;
3989
3990         /* don't overrun current sg */
3991         count = min(sg->length - qc->cursg_ofs, bytes);
3992
3993         /* don't cross page boundaries */
3994         count = min(count, (unsigned int)PAGE_SIZE - offset);
3995
3996         DPRINTK("data %s\n", qc->tf.flags & ATA_TFLAG_WRITE ? "write" : "read");
3997
3998         if (PageHighMem(page)) {
3999                 unsigned long flags;
4000
4001                 /* FIXME: use bounce buffer */
4002                 local_irq_save(flags);
4003                 buf = kmap_atomic(page, KM_IRQ0);
4004
4005                 /* do the actual data transfer */
4006                 ap->ops->data_xfer(qc->dev,  buf + offset, count, do_write);
4007
4008                 kunmap_atomic(buf, KM_IRQ0);
4009                 local_irq_restore(flags);
4010         } else {
4011                 buf = page_address(page);
4012                 ap->ops->data_xfer(qc->dev,  buf + offset, count, do_write);
4013         }
4014
4015         bytes -= count;
4016         qc->curbytes += count;
4017         qc->cursg_ofs += count;
4018
4019         if (qc->cursg_ofs == sg->length) {
4020                 qc->cursg++;
4021                 qc->cursg_ofs = 0;
4022         }
4023
4024         if (bytes)
4025                 goto next_sg;
4026 }
4027
4028 /**
4029  *      atapi_pio_bytes - Transfer data from/to the ATAPI device.
4030  *      @qc: Command on going
4031  *
4032  *      Transfer Transfer data from/to the ATAPI device.
4033  *
4034  *      LOCKING:
4035  *      Inherited from caller.
4036  */
4037
4038 static void atapi_pio_bytes(struct ata_queued_cmd *qc)
4039 {
4040         struct ata_port *ap = qc->ap;
4041         struct ata_device *dev = qc->dev;
4042         unsigned int ireason, bc_lo, bc_hi, bytes;
4043         int i_write, do_write = (qc->tf.flags & ATA_TFLAG_WRITE) ? 1 : 0;
4044
4045         /* Abuse qc->result_tf for temp storage of intermediate TF
4046          * here to save some kernel stack usage.
4047          * For normal completion, qc->result_tf is not relevant. For
4048          * error, qc->result_tf is later overwritten by ata_qc_complete().
4049          * So, the correctness of qc->result_tf is not affected.
4050          */
4051         ap->ops->tf_read(ap, &qc->result_tf);
4052         ireason = qc->result_tf.nsect;
4053         bc_lo = qc->result_tf.lbam;
4054         bc_hi = qc->result_tf.lbah;
4055         bytes = (bc_hi << 8) | bc_lo;
4056
4057         /* shall be cleared to zero, indicating xfer of data */
4058         if (ireason & (1 << 0))
4059                 goto err_out;
4060
4061         /* make sure transfer direction matches expected */
4062         i_write = ((ireason & (1 << 1)) == 0) ? 1 : 0;
4063         if (do_write != i_write)
4064                 goto err_out;
4065
4066         VPRINTK("ata%u: xfering %d bytes\n", ap->id, bytes);
4067
4068         __atapi_pio_bytes(qc, bytes);
4069
4070         return;
4071
4072 err_out:
4073         ata_dev_printk(dev, KERN_INFO, "ATAPI check failed\n");
4074         qc->err_mask |= AC_ERR_HSM;
4075         ap->hsm_task_state = HSM_ST_ERR;
4076 }
4077
4078 /**
4079  *      ata_hsm_ok_in_wq - Check if the qc can be handled in the workqueue.
4080  *      @ap: the target ata_port
4081  *      @qc: qc on going
4082  *
4083  *      RETURNS:
4084  *      1 if ok in workqueue, 0 otherwise.
4085  */
4086
4087 static inline int ata_hsm_ok_in_wq(struct ata_port *ap, struct ata_queued_cmd *qc)
4088 {
4089         if (qc->tf.flags & ATA_TFLAG_POLLING)
4090                 return 1;
4091
4092         if (ap->hsm_task_state == HSM_ST_FIRST) {
4093                 if (qc->tf.protocol == ATA_PROT_PIO &&
4094                     (qc->tf.flags & ATA_TFLAG_WRITE))
4095                     return 1;
4096
4097                 if (is_atapi_taskfile(&qc->tf) &&
4098                     !(qc->dev->flags & ATA_DFLAG_CDB_INTR))
4099                         return 1;
4100         }
4101
4102         return 0;
4103 }
4104
4105 /**
4106  *      ata_hsm_qc_complete - finish a qc running on standard HSM
4107  *      @qc: Command to complete
4108  *      @in_wq: 1 if called from workqueue, 0 otherwise
4109  *
4110  *      Finish @qc which is running on standard HSM.
4111  *
4112  *      LOCKING:
4113  *      If @in_wq is zero, spin_lock_irqsave(host lock).
4114  *      Otherwise, none on entry and grabs host lock.
4115  */
4116 static void ata_hsm_qc_complete(struct ata_queued_cmd *qc, int in_wq)
4117 {
4118         struct ata_port *ap = qc->ap;
4119         unsigned long flags;
4120
4121         if (ap->ops->error_handler) {
4122                 if (in_wq) {
4123                         spin_lock_irqsave(ap->lock, flags);
4124
4125                         /* EH might have kicked in while host lock is
4126                          * released.
4127                          */
4128                         qc = ata_qc_from_tag(ap, qc->tag);
4129                         if (qc) {
4130                                 if (likely(!(qc->err_mask & AC_ERR_HSM))) {
4131                                         ata_irq_on(ap);
4132                                         ata_qc_complete(qc);
4133                                 } else
4134                                         ata_port_freeze(ap);
4135                         }
4136
4137                         spin_unlock_irqrestore(ap->lock, flags);
4138                 } else {
4139                         if (likely(!(qc->err_mask & AC_ERR_HSM)))
4140                                 ata_qc_complete(qc);
4141                         else
4142                                 ata_port_freeze(ap);
4143                 }
4144         } else {
4145                 if (in_wq) {
4146                         spin_lock_irqsave(ap->lock, flags);
4147                         ata_irq_on(ap);
4148                         ata_qc_complete(qc);
4149                         spin_unlock_irqrestore(ap->lock, flags);
4150                 } else
4151                         ata_qc_complete(qc);
4152         }
4153
4154         ata_altstatus(ap); /* flush */
4155 }
4156
4157 /**
4158  *      ata_hsm_move - move the HSM to the next state.
4159  *      @ap: the target ata_port
4160  *      @qc: qc on going
4161  *      @status: current device status
4162  *      @in_wq: 1 if called from workqueue, 0 otherwise
4163  *
4164  *      RETURNS:
4165  *      1 when poll next status needed, 0 otherwise.
4166  */
4167 int ata_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
4168                  u8 status, int in_wq)
4169 {
4170         unsigned long flags = 0;
4171         int poll_next;
4172
4173         WARN_ON((qc->flags & ATA_QCFLAG_ACTIVE) == 0);
4174
4175         /* Make sure ata_qc_issue_prot() does not throw things
4176          * like DMA polling into the workqueue. Notice that
4177          * in_wq is not equivalent to (qc->tf.flags & ATA_TFLAG_POLLING).
4178          */
4179         WARN_ON(in_wq != ata_hsm_ok_in_wq(ap, qc));
4180
4181 fsm_start:
4182         DPRINTK("ata%u: protocol %d task_state %d (dev_stat 0x%X)\n",
4183                 ap->id, qc->tf.protocol, ap->hsm_task_state, status);
4184
4185         switch (ap->hsm_task_state) {
4186         case HSM_ST_FIRST:
4187                 /* Send first data block or PACKET CDB */
4188
4189                 /* If polling, we will stay in the work queue after
4190                  * sending the data. Otherwise, interrupt handler
4191                  * takes over after sending the data.
4192                  */
4193                 poll_next = (qc->tf.flags & ATA_TFLAG_POLLING);
4194
4195                 /* check device status */
4196                 if (unlikely((status & ATA_DRQ) == 0)) {
4197                         /* handle BSY=0, DRQ=0 as error */
4198                         if (likely(status & (ATA_ERR | ATA_DF)))
4199                                 /* device stops HSM for abort/error */
4200                                 qc->err_mask |= AC_ERR_DEV;
4201                         else
4202                                 /* HSM violation. Let EH handle this */
4203                                 qc->err_mask |= AC_ERR_HSM;
4204
4205                         ap->hsm_task_state = HSM_ST_ERR;
4206                         goto fsm_start;
4207                 }
4208
4209                 /* Device should not ask for data transfer (DRQ=1)
4210                  * when it finds something wrong.
4211                  * We ignore DRQ here and stop the HSM by
4212                  * changing hsm_task_state to HSM_ST_ERR and
4213                  * let the EH abort the command or reset the device.
4214                  */
4215                 if (unlikely(status & (ATA_ERR | ATA_DF))) {
4216                         printk(KERN_WARNING "ata%d: DRQ=1 with device error, dev_stat 0x%X\n",
4217                                ap->id, status);
4218                         qc->err_mask |= AC_ERR_HSM;
4219                         ap->hsm_task_state = HSM_ST_ERR;
4220                         goto fsm_start;
4221                 }
4222
4223                 /* Send the CDB (atapi) or the first data block (ata pio out).
4224                  * During the state transition, interrupt handler shouldn't
4225                  * be invoked before the data transfer is complete and
4226                  * hsm_task_state is changed. Hence, the following locking.
4227                  */
4228                 if (in_wq)
4229                         spin_lock_irqsave(ap->lock, flags);
4230
4231                 if (qc->tf.protocol == ATA_PROT_PIO) {
4232                         /* PIO data out protocol.
4233                          * send first data block.
4234                          */
4235
4236                         /* ata_pio_sectors() might change the state
4237                          * to HSM_ST_LAST. so, the state is changed here
4238                          * before ata_pio_sectors().
4239                          */
4240                         ap->hsm_task_state = HSM_ST;
4241                         ata_pio_sectors(qc);
4242                         ata_altstatus(ap); /* flush */
4243                 } else
4244                         /* send CDB */
4245                         atapi_send_cdb(ap, qc);
4246
4247                 if (in_wq)
4248                         spin_unlock_irqrestore(ap->lock, flags);
4249
4250                 /* if polling, ata_pio_task() handles the rest.
4251                  * otherwise, interrupt handler takes over from here.
4252                  */
4253                 break;
4254
4255         case HSM_ST:
4256                 /* complete command or read/write the data register */
4257                 if (qc->tf.protocol == ATA_PROT_ATAPI) {
4258                         /* ATAPI PIO protocol */
4259                         if ((status & ATA_DRQ) == 0) {
4260                                 /* No more data to transfer or device error.
4261                                  * Device error will be tagged in HSM_ST_LAST.
4262                                  */
4263                                 ap->hsm_task_state = HSM_ST_LAST;
4264                                 goto fsm_start;
4265                         }
4266
4267                         /* Device should not ask for data transfer (DRQ=1)
4268                          * when it finds something wrong.
4269                          * We ignore DRQ here and stop the HSM by
4270                          * changing hsm_task_state to HSM_ST_ERR and
4271                          * let the EH abort the command or reset the device.
4272                          */
4273                         if (unlikely(status & (ATA_ERR | ATA_DF))) {
4274                                 printk(KERN_WARNING "ata%d: DRQ=1 with device error, dev_stat 0x%X\n",
4275                                        ap->id, status);
4276                                 qc->err_mask |= AC_ERR_HSM;
4277                                 ap->hsm_task_state = HSM_ST_ERR;
4278                                 goto fsm_start;
4279                         }
4280
4281                         atapi_pio_bytes(qc);
4282
4283                         if (unlikely(ap->hsm_task_state == HSM_ST_ERR))
4284                                 /* bad ireason reported by device */
4285                                 goto fsm_start;
4286
4287                 } else {
4288                         /* ATA PIO protocol */
4289                         if (unlikely((status & ATA_DRQ) == 0)) {
4290                                 /* handle BSY=0, DRQ=0 as error */
4291                                 if (likely(status & (ATA_ERR | ATA_DF)))
4292                                         /* device stops HSM for abort/error */
4293                                         qc->err_mask |= AC_ERR_DEV;
4294                                 else
4295                                         /* HSM violation. Let EH handle this.
4296                                          * Phantom devices also trigger this
4297                                          * condition.  Mark hint.
4298                                          */
4299                                         qc->err_mask |= AC_ERR_HSM |
4300                                                         AC_ERR_NODEV_HINT;
4301
4302                                 ap->hsm_task_state = HSM_ST_ERR;
4303                                 goto fsm_start;
4304                         }
4305
4306                         /* For PIO reads, some devices may ask for
4307                          * data transfer (DRQ=1) alone with ERR=1.
4308                          * We respect DRQ here and transfer one
4309                          * block of junk data before changing the
4310                          * hsm_task_state to HSM_ST_ERR.
4311                          *
4312                          * For PIO writes, ERR=1 DRQ=1 doesn't make
4313                          * sense since the data block has been
4314                          * transferred to the device.
4315                          */
4316                         if (unlikely(status & (ATA_ERR | ATA_DF))) {
4317                                 /* data might be corrputed */
4318                                 qc->err_mask |= AC_ERR_DEV;
4319
4320                                 if (!(qc->tf.flags & ATA_TFLAG_WRITE)) {
4321                                         ata_pio_sectors(qc);
4322                                         ata_altstatus(ap);
4323                                         status = ata_wait_idle(ap);
4324                                 }
4325
4326                                 if (status & (ATA_BUSY | ATA_DRQ))
4327                                         qc->err_mask |= AC_ERR_HSM;
4328
4329                                 /* ata_pio_sectors() might change the
4330                                  * state to HSM_ST_LAST. so, the state
4331                                  * is changed after ata_pio_sectors().
4332                                  */
4333                                 ap->hsm_task_state = HSM_ST_ERR;
4334                                 goto fsm_start;
4335                         }
4336
4337                         ata_pio_sectors(qc);
4338
4339                         if (ap->hsm_task_state == HSM_ST_LAST &&
4340                             (!(qc->tf.flags & ATA_TFLAG_WRITE))) {
4341                                 /* all data read */
4342                                 ata_altstatus(ap);
4343                                 status = ata_wait_idle(ap);
4344                                 goto fsm_start;
4345                         }
4346                 }
4347
4348                 ata_altstatus(ap); /* flush */
4349                 poll_next = 1;
4350                 break;
4351
4352         case HSM_ST_LAST:
4353                 if (unlikely(!ata_ok(status))) {
4354                         qc->err_mask |= __ac_err_mask(status);
4355                         ap->hsm_task_state = HSM_ST_ERR;
4356                         goto fsm_start;
4357                 }
4358
4359                 /* no more data to transfer */
4360                 DPRINTK("ata%u: dev %u command complete, drv_stat 0x%x\n",
4361                         ap->id, qc->dev->devno, status);
4362
4363                 WARN_ON(qc->err_mask);
4364
4365                 ap->hsm_task_state = HSM_ST_IDLE;
4366
4367                 /* complete taskfile transaction */
4368                 ata_hsm_qc_complete(qc, in_wq);
4369
4370                 poll_next = 0;
4371                 break;
4372
4373         case HSM_ST_ERR:
4374                 /* make sure qc->err_mask is available to
4375                  * know what's wrong and recover
4376                  */
4377                 WARN_ON(qc->err_mask == 0);
4378
4379                 ap->hsm_task_state = HSM_ST_IDLE;
4380
4381                 /* complete taskfile transaction */
4382                 ata_hsm_qc_complete(qc, in_wq);
4383
4384                 poll_next = 0;
4385                 break;
4386         default:
4387                 poll_next = 0;
4388                 BUG();
4389         }
4390
4391         return poll_next;
4392 }
4393
4394 static void ata_pio_task(void *_data)
4395 {
4396         struct ata_queued_cmd *qc = _data;
4397         struct ata_port *ap = qc->ap;
4398         u8 status;
4399         int poll_next;
4400
4401 fsm_start:
4402         WARN_ON(ap->hsm_task_state == HSM_ST_IDLE);
4403
4404         /*
4405          * This is purely heuristic.  This is a fast path.
4406          * Sometimes when we enter, BSY will be cleared in
4407          * a chk-status or two.  If not, the drive is probably seeking
4408          * or something.  Snooze for a couple msecs, then
4409          * chk-status again.  If still busy, queue delayed work.
4410          */
4411         status = ata_busy_wait(ap, ATA_BUSY, 5);
4412         if (status & ATA_BUSY) {
4413                 msleep(2);
4414                 status = ata_busy_wait(ap, ATA_BUSY, 10);
4415                 if (status & ATA_BUSY) {
4416                         ata_port_queue_task(ap, ata_pio_task, qc, ATA_SHORT_PAUSE);
4417                         return;
4418                 }
4419         }
4420
4421         /* move the HSM */
4422         poll_next = ata_hsm_move(ap, qc, status, 1);
4423
4424         /* another command or interrupt handler
4425          * may be running at this point.
4426          */
4427         if (poll_next)
4428                 goto fsm_start;
4429 }
4430
4431 /**
4432  *      ata_qc_new - Request an available ATA command, for queueing
4433  *      @ap: Port associated with device @dev
4434  *      @dev: Device from whom we request an available command structure
4435  *
4436  *      LOCKING:
4437  *      None.
4438  */
4439
4440 static struct ata_queued_cmd *ata_qc_new(struct ata_port *ap)
4441 {
4442         struct ata_queued_cmd *qc = NULL;
4443         unsigned int i;
4444
4445         /* no command while frozen */
4446         if (unlikely(ap->pflags & ATA_PFLAG_FROZEN))
4447                 return NULL;
4448
4449         /* the last tag is reserved for internal command. */
4450         for (i = 0; i < ATA_MAX_QUEUE - 1; i++)
4451                 if (!test_and_set_bit(i, &ap->qc_allocated)) {
4452                         qc = __ata_qc_from_tag(ap, i);
4453                         break;
4454                 }
4455
4456         if (qc)
4457                 qc->tag = i;
4458
4459         return qc;
4460 }
4461
4462 /**
4463  *      ata_qc_new_init - Request an available ATA command, and initialize it
4464  *      @dev: Device from whom we request an available command structure
4465  *
4466  *      LOCKING:
4467  *      None.
4468  */
4469
4470 struct ata_queued_cmd *ata_qc_new_init(struct ata_device *dev)
4471 {
4472         struct ata_port *ap = dev->ap;
4473         struct ata_queued_cmd *qc;
4474
4475         qc = ata_qc_new(ap);
4476         if (qc) {
4477                 qc->scsicmd = NULL;
4478                 qc->ap = ap;
4479                 qc->dev = dev;
4480
4481                 ata_qc_reinit(qc);
4482         }
4483
4484         return qc;
4485 }
4486
4487 /**
4488  *      ata_qc_free - free unused ata_queued_cmd
4489  *      @qc: Command to complete
4490  *
4491  *      Designed to free unused ata_queued_cmd object
4492  *      in case something prevents using it.
4493  *
4494  *      LOCKING:
4495  *      spin_lock_irqsave(host lock)
4496  */
4497 void ata_qc_free(struct ata_queued_cmd *qc)
4498 {
4499         struct ata_port *ap = qc->ap;
4500         unsigned int tag;
4501
4502         WARN_ON(qc == NULL);    /* ata_qc_from_tag _might_ return NULL */
4503
4504         qc->flags = 0;
4505         tag = qc->tag;
4506         if (likely(ata_tag_valid(tag))) {
4507                 qc->tag = ATA_TAG_POISON;
4508                 clear_bit(tag, &ap->qc_allocated);
4509         }
4510 }
4511
4512 void __ata_qc_complete(struct ata_queued_cmd *qc)
4513 {
4514         struct ata_port *ap = qc->ap;
4515
4516         WARN_ON(qc == NULL);    /* ata_qc_from_tag _might_ return NULL */
4517         WARN_ON(!(qc->flags & ATA_QCFLAG_ACTIVE));
4518
4519         if (likely(qc->flags & ATA_QCFLAG_DMAMAP))
4520                 ata_sg_clean(qc);
4521
4522         /* command should be marked inactive atomically with qc completion */
4523         if (qc->tf.protocol == ATA_PROT_NCQ)
4524                 ap->sactive &= ~(1 << qc->tag);
4525         else
4526                 ap->active_tag = ATA_TAG_POISON;
4527
4528         /* atapi: mark qc as inactive to prevent the interrupt handler
4529          * from completing the command twice later, before the error handler
4530          * is called. (when rc != 0 and atapi request sense is needed)
4531          */
4532         qc->flags &= ~ATA_QCFLAG_ACTIVE;
4533         ap->qc_active &= ~(1 << qc->tag);
4534
4535         /* call completion callback */
4536         qc->complete_fn(qc);
4537 }
4538
4539 /**
4540  *      ata_qc_complete - Complete an active ATA command
4541  *      @qc: Command to complete
4542  *      @err_mask: ATA Status register contents
4543  *
4544  *      Indicate to the mid and upper layers that an ATA
4545  *      command has completed, with either an ok or not-ok status.
4546  *
4547  *      LOCKING:
4548  *      spin_lock_irqsave(host lock)
4549  */
4550 void ata_qc_complete(struct ata_queued_cmd *qc)
4551 {
4552         struct ata_port *ap = qc->ap;
4553
4554         /* XXX: New EH and old EH use different mechanisms to
4555          * synchronize EH with regular execution path.
4556          *
4557          * In new EH, a failed qc is marked with ATA_QCFLAG_FAILED.
4558          * Normal execution path is responsible for not accessing a
4559          * failed qc.  libata core enforces the rule by returning NULL
4560          * from ata_qc_from_tag() for failed qcs.
4561          *
4562          * Old EH depends on ata_qc_complete() nullifying completion
4563          * requests if ATA_QCFLAG_EH_SCHEDULED is set.  Old EH does
4564          * not synchronize with interrupt handler.  Only PIO task is
4565          * taken care of.
4566          */
4567         if (ap->ops->error_handler) {
4568                 WARN_ON(ap->pflags & ATA_PFLAG_FROZEN);
4569
4570                 if (unlikely(qc->err_mask))
4571                         qc->flags |= ATA_QCFLAG_FAILED;
4572
4573                 if (unlikely(qc->flags & ATA_QCFLAG_FAILED)) {
4574                         if (!ata_tag_internal(qc->tag)) {
4575                                 /* always fill result TF for failed qc */
4576                                 ap->ops->tf_read(ap, &qc->result_tf);
4577                                 ata_qc_schedule_eh(qc);
4578                                 return;
4579                         }
4580                 }
4581
4582                 /* read result TF if requested */
4583                 if (qc->flags & ATA_QCFLAG_RESULT_TF)
4584                         ap->ops->tf_read(ap, &qc->result_tf);
4585
4586                 __ata_qc_complete(qc);
4587         } else {
4588                 if (qc->flags & ATA_QCFLAG_EH_SCHEDULED)
4589                         return;
4590
4591                 /* read result TF if failed or requested */
4592                 if (qc->err_mask || qc->flags & ATA_QCFLAG_RESULT_TF)
4593                         ap->ops->tf_read(ap, &qc->result_tf);
4594
4595                 __ata_qc_complete(qc);
4596         }
4597 }
4598
4599 /**
4600  *      ata_qc_complete_multiple - Complete multiple qcs successfully
4601  *      @ap: port in question
4602  *      @qc_active: new qc_active mask
4603  *      @finish_qc: LLDD callback invoked before completing a qc
4604  *
4605  *      Complete in-flight commands.  This functions is meant to be
4606  *      called from low-level driver's interrupt routine to complete
4607  *      requests normally.  ap->qc_active and @qc_active is compared
4608  *      and commands are completed accordingly.
4609  *
4610  *      LOCKING:
4611  *      spin_lock_irqsave(host lock)
4612  *
4613  *      RETURNS:
4614  *      Number of completed commands on success, -errno otherwise.
4615  */
4616 int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active,
4617                              void (*finish_qc)(struct ata_queued_cmd *))
4618 {
4619         int nr_done = 0;
4620         u32 done_mask;
4621         int i;
4622
4623         done_mask = ap->qc_active ^ qc_active;
4624
4625         if (unlikely(done_mask & qc_active)) {
4626                 ata_port_printk(ap, KERN_ERR, "illegal qc_active transition "
4627                                 "(%08x->%08x)\n", ap->qc_active, qc_active);
4628                 return -EINVAL;
4629         }
4630
4631         for (i = 0; i < ATA_MAX_QUEUE; i++) {
4632                 struct ata_queued_cmd *qc;
4633
4634                 if (!(done_mask & (1 << i)))
4635                         continue;
4636
4637                 if ((qc = ata_qc_from_tag(ap, i))) {
4638                         if (finish_qc)
4639                                 finish_qc(qc);
4640                         ata_qc_complete(qc);
4641                         nr_done++;
4642                 }
4643         }
4644
4645         return nr_done;
4646 }
4647
4648 static inline int ata_should_dma_map(struct ata_queued_cmd *qc)
4649 {
4650         struct ata_port *ap = qc->ap;
4651
4652         switch (qc->tf.protocol) {
4653         case ATA_PROT_NCQ:
4654         case ATA_PROT_DMA:
4655         case ATA_PROT_ATAPI_DMA:
4656                 return 1;
4657
4658         case ATA_PROT_ATAPI:
4659         case ATA_PROT_PIO:
4660                 if (ap->flags & ATA_FLAG_PIO_DMA)
4661                         return 1;
4662
4663                 /* fall through */
4664
4665         default:
4666                 return 0;
4667         }
4668
4669         /* never reached */
4670 }
4671
4672 /**
4673  *      ata_qc_issue - issue taskfile to device
4674  *      @qc: command to issue to device
4675  *
4676  *      Prepare an ATA command to submission to device.
4677  *      This includes mapping the data into a DMA-able
4678  *      area, filling in the S/G table, and finally
4679  *      writing the taskfile to hardware, starting the command.
4680  *
4681  *      LOCKING:
4682  *      spin_lock_irqsave(host lock)
4683  */
4684 void ata_qc_issue(struct ata_queued_cmd *qc)
4685 {
4686         struct ata_port *ap = qc->ap;
4687
4688         /* Make sure only one non-NCQ command is outstanding.  The
4689          * check is skipped for old EH because it reuses active qc to
4690          * request ATAPI sense.
4691          */
4692         WARN_ON(ap->ops->error_handler && ata_tag_valid(ap->active_tag));
4693
4694         if (qc->tf.protocol == ATA_PROT_NCQ) {
4695                 WARN_ON(ap->sactive & (1 << qc->tag));
4696                 ap->sactive |= 1 << qc->tag;
4697         } else {
4698                 WARN_ON(ap->sactive);
4699                 ap->active_tag = qc->tag;
4700         }
4701
4702         qc->flags |= ATA_QCFLAG_ACTIVE;
4703         ap->qc_active |= 1 << qc->tag;
4704
4705         if (ata_should_dma_map(qc)) {
4706                 if (qc->flags & ATA_QCFLAG_SG) {
4707                         if (ata_sg_setup(qc))
4708                                 goto sg_err;
4709                 } else if (qc->flags & ATA_QCFLAG_SINGLE) {
4710                         if (ata_sg_setup_one(qc))
4711                                 goto sg_err;
4712                 }
4713         } else {
4714                 qc->flags &= ~ATA_QCFLAG_DMAMAP;
4715         }
4716
4717         ap->ops->qc_prep(qc);
4718
4719         qc->err_mask |= ap->ops->qc_issue(qc);
4720         if (unlikely(qc->err_mask))
4721                 goto err;
4722         return;
4723
4724 sg_err:
4725         qc->flags &= ~ATA_QCFLAG_DMAMAP;
4726         qc->err_mask |= AC_ERR_SYSTEM;
4727 err:
4728         ata_qc_complete(qc);
4729 }
4730
4731 /**
4732  *      ata_qc_issue_prot - issue taskfile to device in proto-dependent manner
4733  *      @qc: command to issue to device
4734  *
4735  *      Using various libata functions and hooks, this function
4736  *      starts an ATA command.  ATA commands are grouped into
4737  *      classes called "protocols", and issuing each type of protocol
4738  *      is slightly different.
4739  *
4740  *      May be used as the qc_issue() entry in ata_port_operations.
4741  *
4742  *      LOCKING:
4743  *      spin_lock_irqsave(host lock)
4744  *
4745  *      RETURNS:
4746  *      Zero on success, AC_ERR_* mask on failure
4747  */
4748
4749 unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc)
4750 {
4751         struct ata_port *ap = qc->ap;
4752
4753         /* Use polling pio if the LLD doesn't handle
4754          * interrupt driven pio and atapi CDB interrupt.
4755          */
4756         if (ap->flags & ATA_FLAG_PIO_POLLING) {
4757                 switch (qc->tf.protocol) {
4758                 case ATA_PROT_PIO:
4759                 case ATA_PROT_ATAPI:
4760                 case ATA_PROT_ATAPI_NODATA:
4761                         qc->tf.flags |= ATA_TFLAG_POLLING;
4762                         break;
4763                 case ATA_PROT_ATAPI_DMA:
4764                         if (qc->dev->flags & ATA_DFLAG_CDB_INTR)
4765                                 /* see ata_dma_blacklisted() */
4766                                 BUG();
4767                         break;
4768                 default:
4769                         break;
4770                 }
4771         }
4772
4773         /* select the device */
4774         ata_dev_select(ap, qc->dev->devno, 1, 0);
4775
4776         /* start the command */
4777         switch (qc->tf.protocol) {
4778         case ATA_PROT_NODATA:
4779                 if (qc->tf.flags & ATA_TFLAG_POLLING)
4780                         ata_qc_set_polling(qc);
4781
4782                 ata_tf_to_host(ap, &qc->tf);
4783                 ap->hsm_task_state = HSM_ST_LAST;
4784
4785                 if (qc->tf.flags & ATA_TFLAG_POLLING)
4786                         ata_port_queue_task(ap, ata_pio_task, qc, 0);
4787
4788                 break;
4789
4790         case ATA_PROT_DMA:
4791                 WARN_ON(qc->tf.flags & ATA_TFLAG_POLLING);
4792
4793                 ap->ops->tf_load(ap, &qc->tf);   /* load tf registers */
4794                 ap->ops->bmdma_setup(qc);           /* set up bmdma */
4795                 ap->ops->bmdma_start(qc);           /* initiate bmdma */
4796                 ap->hsm_task_state = HSM_ST_LAST;
4797                 break;
4798
4799         case ATA_PROT_PIO:
4800                 if (qc->tf.flags & ATA_TFLAG_POLLING)
4801                         ata_qc_set_polling(qc);
4802
4803                 ata_tf_to_host(ap, &qc->tf);
4804
4805                 if (qc->tf.flags & ATA_TFLAG_WRITE) {
4806                         /* PIO data out protocol */
4807                         ap->hsm_task_state = HSM_ST_FIRST;
4808                         ata_port_queue_task(ap, ata_pio_task, qc, 0);
4809
4810                         /* always send first data block using
4811                          * the ata_pio_task() codepath.
4812                          */
4813                 } else {
4814                         /* PIO data in protocol */
4815                         ap->hsm_task_state = HSM_ST;
4816
4817                         if (qc->tf.flags & ATA_TFLAG_POLLING)
4818                                 ata_port_queue_task(ap, ata_pio_task, qc, 0);
4819
4820                         /* if polling, ata_pio_task() handles the rest.
4821                          * otherwise, interrupt handler takes over from here.
4822                          */
4823                 }
4824
4825                 break;
4826
4827         case ATA_PROT_ATAPI:
4828         case ATA_PROT_ATAPI_NODATA:
4829                 if (qc->tf.flags & ATA_TFLAG_POLLING)
4830                         ata_qc_set_polling(qc);
4831
4832                 ata_tf_to_host(ap, &qc->tf);
4833
4834                 ap->hsm_task_state = HSM_ST_FIRST;
4835
4836                 /* send cdb by polling if no cdb interrupt */
4837                 if ((!(qc->dev->flags & ATA_DFLAG_CDB_INTR)) ||
4838                     (qc->tf.flags & ATA_TFLAG_POLLING))
4839                         ata_port_queue_task(ap, ata_pio_task, qc, 0);
4840                 break;
4841
4842         case ATA_PROT_ATAPI_DMA:
4843                 WARN_ON(qc->tf.flags & ATA_TFLAG_POLLING);
4844
4845                 ap->ops->tf_load(ap, &qc->tf);   /* load tf registers */
4846                 ap->ops->bmdma_setup(qc);           /* set up bmdma */
4847                 ap->hsm_task_state = HSM_ST_FIRST;
4848
4849                 /* send cdb by polling if no cdb interrupt */
4850                 if (!(qc->dev->flags & ATA_DFLAG_CDB_INTR))
4851                         ata_port_queue_task(ap, ata_pio_task, qc, 0);
4852                 break;
4853
4854         default:
4855                 WARN_ON(1);
4856                 return AC_ERR_SYSTEM;
4857         }
4858
4859         return 0;
4860 }
4861
4862 /**
4863  *      ata_host_intr - Handle host interrupt for given (port, task)
4864  *      @ap: Port on which interrupt arrived (possibly...)
4865  *      @qc: Taskfile currently active in engine
4866  *
4867  *      Handle host interrupt for given queued command.  Currently,
4868  *      only DMA interrupts are handled.  All other commands are
4869  *      handled via polling with interrupts disabled (nIEN bit).
4870  *
4871  *      LOCKING:
4872  *      spin_lock_irqsave(host lock)
4873  *
4874  *      RETURNS:
4875  *      One if interrupt was handled, zero if not (shared irq).
4876  */
4877
4878 inline unsigned int ata_host_intr (struct ata_port *ap,
4879                                    struct ata_queued_cmd *qc)
4880 {
4881         u8 status, host_stat = 0;
4882
4883         VPRINTK("ata%u: protocol %d task_state %d\n",
4884                 ap->id, qc->tf.protocol, ap->hsm_task_state);
4885
4886         /* Check whether we are expecting interrupt in this state */
4887         switch (ap->hsm_task_state) {
4888         case HSM_ST_FIRST:
4889                 /* Some pre-ATAPI-4 devices assert INTRQ
4890                  * at this state when ready to receive CDB.
4891                  */
4892
4893                 /* Check the ATA_DFLAG_CDB_INTR flag is enough here.
4894                  * The flag was turned on only for atapi devices.
4895                  * No need to check is_atapi_taskfile(&qc->tf) again.
4896                  */
4897                 if (!(qc->dev->flags & ATA_DFLAG_CDB_INTR))
4898                         goto idle_irq;
4899                 break;
4900         case HSM_ST_LAST:
4901                 if (qc->tf.protocol == ATA_PROT_DMA ||
4902                     qc->tf.protocol == ATA_PROT_ATAPI_DMA) {
4903                         /* check status of DMA engine */
4904                         host_stat = ap->ops->bmdma_status(ap);
4905                         VPRINTK("ata%u: host_stat 0x%X\n", ap->id, host_stat);
4906
4907                         /* if it's not our irq... */
4908                         if (!(host_stat & ATA_DMA_INTR))
4909                                 goto idle_irq;
4910
4911                         /* before we do anything else, clear DMA-Start bit */
4912                         ap->ops->bmdma_stop(qc);
4913
4914                         if (unlikely(host_stat & ATA_DMA_ERR)) {
4915                                 /* error when transfering data to/from memory */
4916                                 qc->err_mask |= AC_ERR_HOST_BUS;
4917                                 ap->hsm_task_state = HSM_ST_ERR;
4918                         }
4919                 }
4920                 break;
4921         case HSM_ST:
4922                 break;
4923         default:
4924                 goto idle_irq;
4925         }
4926
4927         /* check altstatus */
4928         status = ata_altstatus(ap);
4929         if (status & ATA_BUSY)
4930                 goto idle_irq;
4931
4932         /* check main status, clearing INTRQ */
4933         status = ata_chk_status(ap);
4934         if (unlikely(status & ATA_BUSY))
4935                 goto idle_irq;
4936
4937         /* ack bmdma irq events */
4938         ap->ops->irq_clear(ap);
4939
4940         ata_hsm_move(ap, qc, status, 0);
4941         return 1;       /* irq handled */
4942
4943 idle_irq:
4944         ap->stats.idle_irq++;
4945
4946 #ifdef ATA_IRQ_TRAP
4947         if ((ap->stats.idle_irq % 1000) == 0) {
4948                 ata_irq_ack(ap, 0); /* debug trap */
4949                 ata_port_printk(ap, KERN_WARNING, "irq trap\n");
4950                 return 1;
4951         }
4952 #endif
4953         return 0;       /* irq not handled */
4954 }
4955
4956 /**
4957  *      ata_interrupt - Default ATA host interrupt handler
4958  *      @irq: irq line (unused)
4959  *      @dev_instance: pointer to our ata_host information structure
4960  *
4961  *      Default interrupt handler for PCI IDE devices.  Calls
4962  *      ata_host_intr() for each port that is not disabled.
4963  *
4964  *      LOCKING:
4965  *      Obtains host lock during operation.
4966  *
4967  *      RETURNS:
4968  *      IRQ_NONE or IRQ_HANDLED.
4969  */
4970
4971 irqreturn_t ata_interrupt (int irq, void *dev_instance)
4972 {
4973         struct ata_host *host = dev_instance;
4974         unsigned int i;
4975         unsigned int handled = 0;
4976         unsigned long flags;
4977
4978         /* TODO: make _irqsave conditional on x86 PCI IDE legacy mode */
4979         spin_lock_irqsave(&host->lock, flags);
4980
4981         for (i = 0; i < host->n_ports; i++) {
4982                 struct ata_port *ap;
4983
4984                 ap = host->ports[i];
4985                 if (ap &&
4986                     !(ap->flags & ATA_FLAG_DISABLED)) {
4987                         struct ata_queued_cmd *qc;
4988
4989                         qc = ata_qc_from_tag(ap, ap->active_tag);
4990                         if (qc && (!(qc->tf.flags & ATA_TFLAG_POLLING)) &&
4991                             (qc->flags & ATA_QCFLAG_ACTIVE))
4992                                 handled |= ata_host_intr(ap, qc);
4993                 }
4994         }
4995
4996         spin_unlock_irqrestore(&host->lock, flags);
4997
4998         return IRQ_RETVAL(handled);
4999 }
5000
5001 /**
5002  *      sata_scr_valid - test whether SCRs are accessible
5003  *      @ap: ATA port to test SCR accessibility for
5004  *
5005  *      Test whether SCRs are accessible for @ap.
5006  *
5007  *      LOCKING:
5008  *      None.
5009  *
5010  *      RETURNS:
5011  *      1 if SCRs are accessible, 0 otherwise.
5012  */
5013 int sata_scr_valid(struct ata_port *ap)
5014 {
5015         return ap->cbl == ATA_CBL_SATA && ap->ops->scr_read;
5016 }
5017
5018 /**
5019  *      sata_scr_read - read SCR register of the specified port
5020  *      @ap: ATA port to read SCR for
5021  *      @reg: SCR to read
5022  *      @val: Place to store read value
5023  *
5024  *      Read SCR register @reg of @ap into *@val.  This function is
5025  *      guaranteed to succeed if the cable type of the port is SATA
5026  *      and the port implements ->scr_read.
5027  *
5028  *      LOCKING:
5029  *      None.
5030  *
5031  *      RETURNS:
5032  *      0 on success, negative errno on failure.
5033  */
5034 int sata_scr_read(struct ata_port *ap, int reg, u32 *val)
5035 {
5036         if (sata_scr_valid(ap)) {
5037                 *val = ap->ops->scr_read(ap, reg);
5038                 return 0;
5039         }
5040         return -EOPNOTSUPP;
5041 }
5042
5043 /**
5044  *      sata_scr_write - write SCR register of the specified port
5045  *      @ap: ATA port to write SCR for
5046  *      @reg: SCR to write
5047  *      @val: value to write
5048  *
5049  *      Write @val to SCR register @reg of @ap.  This function is
5050  *      guaranteed to succeed if the cable type of the port is SATA
5051  *      and the port implements ->scr_read.
5052  *
5053  *      LOCKING:
5054  *      None.
5055  *
5056  *      RETURNS:
5057  *      0 on success, negative errno on failure.
5058  */
5059 int sata_scr_write(struct ata_port *ap, int reg, u32 val)
5060 {
5061         if (sata_scr_valid(ap)) {
5062                 ap->ops->scr_write(ap, reg, val);
5063                 return 0;
5064         }
5065         return -EOPNOTSUPP;
5066 }
5067
5068 /**
5069  *      sata_scr_write_flush - write SCR register of the specified port and flush
5070  *      @ap: ATA port to write SCR for
5071  *      @reg: SCR to write
5072  *      @val: value to write
5073  *
5074  *      This function is identical to sata_scr_write() except that this
5075  *      function performs flush after writing to the register.
5076  *
5077  *      LOCKING:
5078  *      None.
5079  *
5080  *      RETURNS:
5081  *      0 on success, negative errno on failure.
5082  */
5083 int sata_scr_write_flush(struct ata_port *ap, int reg, u32 val)
5084 {
5085         if (sata_scr_valid(ap)) {
5086                 ap->ops->scr_write(ap, reg, val);
5087                 ap->ops->scr_read(ap, reg);
5088                 return 0;
5089         }
5090         return -EOPNOTSUPP;
5091 }
5092
5093 /**
5094  *      ata_port_online - test whether the given port is online
5095  *      @ap: ATA port to test
5096  *
5097  *      Test whether @ap is online.  Note that this function returns 0
5098  *      if online status of @ap cannot be obtained, so
5099  *      ata_port_online(ap) != !ata_port_offline(ap).
5100  *
5101  *      LOCKING:
5102  *      None.
5103  *
5104  *      RETURNS:
5105  *      1 if the port online status is available and online.
5106  */
5107 int ata_port_online(struct ata_port *ap)
5108 {
5109         u32 sstatus;
5110
5111         if (!sata_scr_read(ap, SCR_STATUS, &sstatus) && (sstatus & 0xf) == 0x3)
5112                 return 1;
5113         return 0;
5114 }
5115
5116 /**
5117  *      ata_port_offline - test whether the given port is offline
5118  *      @ap: ATA port to test
5119  *
5120  *      Test whether @ap is offline.  Note that this function returns
5121  *      0 if offline status of @ap cannot be obtained, so
5122  *      ata_port_online(ap) != !ata_port_offline(ap).
5123  *
5124  *      LOCKING:
5125  *      None.
5126  *
5127  *      RETURNS:
5128  *      1 if the port offline status is available and offline.
5129  */
5130 int ata_port_offline(struct ata_port *ap)
5131 {
5132         u32 sstatus;
5133
5134         if (!sata_scr_read(ap, SCR_STATUS, &sstatus) && (sstatus & 0xf) != 0x3)
5135                 return 1;
5136         return 0;
5137 }
5138
5139 int ata_flush_cache(struct ata_device *dev)
5140 {
5141         unsigned int err_mask;
5142         u8 cmd;
5143
5144         if (!ata_try_flush_cache(dev))
5145                 return 0;
5146
5147         if (dev->flags & ATA_DFLAG_FLUSH_EXT)
5148                 cmd = ATA_CMD_FLUSH_EXT;
5149         else
5150                 cmd = ATA_CMD_FLUSH;
5151
5152         err_mask = ata_do_simple_cmd(dev, cmd);
5153         if (err_mask) {
5154                 ata_dev_printk(dev, KERN_ERR, "failed to flush cache\n");
5155                 return -EIO;
5156         }
5157
5158         return 0;
5159 }
5160
5161 static int ata_host_request_pm(struct ata_host *host, pm_message_t mesg,
5162                                unsigned int action, unsigned int ehi_flags,
5163                                int wait)
5164 {
5165         unsigned long flags;
5166         int i, rc;
5167
5168         for (i = 0; i < host->n_ports; i++) {
5169                 struct ata_port *ap = host->ports[i];
5170
5171                 /* Previous resume operation might still be in
5172                  * progress.  Wait for PM_PENDING to clear.
5173                  */
5174                 if (ap->pflags & ATA_PFLAG_PM_PENDING) {
5175                         ata_port_wait_eh(ap);
5176                         WARN_ON(ap->pflags & ATA_PFLAG_PM_PENDING);
5177                 }
5178
5179                 /* request PM ops to EH */
5180                 spin_lock_irqsave(ap->lock, flags);
5181
5182                 ap->pm_mesg = mesg;
5183                 if (wait) {
5184                         rc = 0;
5185                         ap->pm_result = &rc;
5186                 }
5187
5188                 ap->pflags |= ATA_PFLAG_PM_PENDING;
5189                 ap->eh_info.action |= action;
5190                 ap->eh_info.flags |= ehi_flags;
5191
5192                 ata_port_schedule_eh(ap);
5193
5194                 spin_unlock_irqrestore(ap->lock, flags);
5195
5196                 /* wait and check result */
5197                 if (wait) {
5198                         ata_port_wait_eh(ap);
5199                         WARN_ON(ap->pflags & ATA_PFLAG_PM_PENDING);
5200                         if (rc)
5201                                 return rc;
5202                 }
5203         }
5204
5205         return 0;
5206 }
5207
5208 /**
5209  *      ata_host_suspend - suspend host
5210  *      @host: host to suspend
5211  *      @mesg: PM message
5212  *
5213  *      Suspend @host.  Actual operation is performed by EH.  This
5214  *      function requests EH to perform PM operations and waits for EH
5215  *      to finish.
5216  *
5217  *      LOCKING:
5218  *      Kernel thread context (may sleep).
5219  *
5220  *      RETURNS:
5221  *      0 on success, -errno on failure.
5222  */
5223 int ata_host_suspend(struct ata_host *host, pm_message_t mesg)
5224 {
5225         int i, j, rc;
5226
5227         rc = ata_host_request_pm(host, mesg, 0, ATA_EHI_QUIET, 1);
5228         if (rc)
5229                 goto fail;
5230
5231         /* EH is quiescent now.  Fail if we have any ready device.
5232          * This happens if hotplug occurs between completion of device
5233          * suspension and here.
5234          */
5235         for (i = 0; i < host->n_ports; i++) {
5236                 struct ata_port *ap = host->ports[i];
5237
5238                 for (j = 0; j < ATA_MAX_DEVICES; j++) {
5239                         struct ata_device *dev = &ap->device[j];
5240
5241                         if (ata_dev_ready(dev)) {
5242                                 ata_port_printk(ap, KERN_WARNING,
5243                                                 "suspend failed, device %d "
5244                                                 "still active\n", dev->devno);
5245                                 rc = -EBUSY;
5246                                 goto fail;
5247                         }
5248                 }
5249         }
5250
5251         host->dev->power.power_state = mesg;
5252         return 0;
5253
5254  fail:
5255         ata_host_resume(host);
5256         return rc;
5257 }
5258
5259 /**
5260  *      ata_host_resume - resume host
5261  *      @host: host to resume
5262  *
5263  *      Resume @host.  Actual operation is performed by EH.  This
5264  *      function requests EH to perform PM operations and returns.
5265  *      Note that all resume operations are performed parallely.
5266  *
5267  *      LOCKING:
5268  *      Kernel thread context (may sleep).
5269  */
5270 void ata_host_resume(struct ata_host *host)
5271 {
5272         ata_host_request_pm(host, PMSG_ON, ATA_EH_SOFTRESET,
5273                             ATA_EHI_NO_AUTOPSY | ATA_EHI_QUIET, 0);
5274         host->dev->power.power_state = PMSG_ON;
5275 }
5276
5277 /**
5278  *      ata_port_start - Set port up for dma.
5279  *      @ap: Port to initialize
5280  *
5281  *      Called just after data structures for each port are
5282  *      initialized.  Allocates space for PRD table.
5283  *
5284  *      May be used as the port_start() entry in ata_port_operations.
5285  *
5286  *      LOCKING:
5287  *      Inherited from caller.
5288  */
5289
5290 int ata_port_start (struct ata_port *ap)
5291 {
5292         struct device *dev = ap->dev;
5293         int rc;
5294
5295         ap->prd = dma_alloc_coherent(dev, ATA_PRD_TBL_SZ, &ap->prd_dma, GFP_KERNEL);
5296         if (!ap->prd)
5297                 return -ENOMEM;
5298
5299         rc = ata_pad_alloc(ap, dev);
5300         if (rc) {
5301                 dma_free_coherent(dev, ATA_PRD_TBL_SZ, ap->prd, ap->prd_dma);
5302                 return rc;
5303         }
5304
5305         DPRINTK("prd alloc, virt %p, dma %llx\n", ap->prd, (unsigned long long) ap->prd_dma);
5306
5307         return 0;
5308 }
5309
5310
5311 /**
5312  *      ata_port_stop - Undo ata_port_start()
5313  *      @ap: Port to shut down
5314  *
5315  *      Frees the PRD table.
5316  *
5317  *      May be used as the port_stop() entry in ata_port_operations.
5318  *
5319  *      LOCKING:
5320  *      Inherited from caller.
5321  */
5322
5323 void ata_port_stop (struct ata_port *ap)
5324 {
5325         struct device *dev = ap->dev;
5326
5327         dma_free_coherent(dev, ATA_PRD_TBL_SZ, ap->prd, ap->prd_dma);
5328         ata_pad_free(ap, dev);
5329 }
5330
5331 void ata_host_stop (struct ata_host *host)
5332 {
5333         if (host->mmio_base)
5334                 iounmap(host->mmio_base);
5335 }
5336
5337 /**
5338  *      ata_dev_init - Initialize an ata_device structure
5339  *      @dev: Device structure to initialize
5340  *
5341  *      Initialize @dev in preparation for probing.
5342  *
5343  *      LOCKING:
5344  *      Inherited from caller.
5345  */
5346 void ata_dev_init(struct ata_device *dev)
5347 {
5348         struct ata_port *ap = dev->ap;
5349         unsigned long flags;
5350
5351         /* SATA spd limit is bound to the first device */
5352         ap->sata_spd_limit = ap->hw_sata_spd_limit;
5353
5354         /* High bits of dev->flags are used to record warm plug
5355          * requests which occur asynchronously.  Synchronize using
5356          * host lock.
5357          */
5358         spin_lock_irqsave(ap->lock, flags);
5359         dev->flags &= ~ATA_DFLAG_INIT_MASK;
5360         spin_unlock_irqrestore(ap->lock, flags);
5361
5362         memset((void *)dev + ATA_DEVICE_CLEAR_OFFSET, 0,
5363                sizeof(*dev) - ATA_DEVICE_CLEAR_OFFSET);
5364         dev->pio_mask = UINT_MAX;
5365         dev->mwdma_mask = UINT_MAX;
5366         dev->udma_mask = UINT_MAX;
5367 }
5368
5369 /**
5370  *      ata_port_init - Initialize an ata_port structure
5371  *      @ap: Structure to initialize
5372  *      @host: Collection of hosts to which @ap belongs
5373  *      @ent: Probe information provided by low-level driver
5374  *      @port_no: Port number associated with this ata_port
5375  *
5376  *      Initialize a new ata_port structure.
5377  *
5378  *      LOCKING:
5379  *      Inherited from caller.
5380  */
5381 void ata_port_init(struct ata_port *ap, struct ata_host *host,
5382                    const struct ata_probe_ent *ent, unsigned int port_no)
5383 {
5384         unsigned int i;
5385
5386         ap->lock = &host->lock;
5387         ap->flags = ATA_FLAG_DISABLED;
5388         ap->id = ata_unique_id++;
5389         ap->ctl = ATA_DEVCTL_OBS;
5390         ap->host = host;
5391         ap->dev = ent->dev;
5392         ap->port_no = port_no;
5393         if (port_no == 1 && ent->pinfo2) {
5394                 ap->pio_mask = ent->pinfo2->pio_mask;
5395                 ap->mwdma_mask = ent->pinfo2->mwdma_mask;
5396                 ap->udma_mask = ent->pinfo2->udma_mask;
5397                 ap->flags |= ent->pinfo2->flags;
5398                 ap->ops = ent->pinfo2->port_ops;
5399         } else {
5400                 ap->pio_mask = ent->pio_mask;
5401                 ap->mwdma_mask = ent->mwdma_mask;
5402                 ap->udma_mask = ent->udma_mask;
5403                 ap->flags |= ent->port_flags;
5404                 ap->ops = ent->port_ops;
5405         }
5406         ap->hw_sata_spd_limit = UINT_MAX;
5407         ap->active_tag = ATA_TAG_POISON;
5408         ap->last_ctl = 0xFF;
5409
5410 #if defined(ATA_VERBOSE_DEBUG)
5411         /* turn on all debugging levels */
5412         ap->msg_enable = 0x00FF;
5413 #elif defined(ATA_DEBUG)
5414         ap->msg_enable = ATA_MSG_DRV | ATA_MSG_INFO | ATA_MSG_CTL | ATA_MSG_WARN | ATA_MSG_ERR;
5415 #else
5416         ap->msg_enable = ATA_MSG_DRV | ATA_MSG_ERR | ATA_MSG_WARN;
5417 #endif
5418
5419         INIT_WORK(&ap->port_task, NULL, NULL);
5420         INIT_WORK(&ap->hotplug_task, ata_scsi_hotplug, ap);
5421         INIT_WORK(&ap->scsi_rescan_task, ata_scsi_dev_rescan, ap);
5422         INIT_LIST_HEAD(&ap->eh_done_q);
5423         init_waitqueue_head(&ap->eh_wait_q);
5424
5425         /* set cable type */
5426         ap->cbl = ATA_CBL_NONE;
5427         if (ap->flags & ATA_FLAG_SATA)
5428                 ap->cbl = ATA_CBL_SATA;
5429
5430         for (i = 0; i < ATA_MAX_DEVICES; i++) {
5431                 struct ata_device *dev = &ap->device[i];
5432                 dev->ap = ap;
5433                 dev->devno = i;
5434                 ata_dev_init(dev);
5435         }
5436
5437 #ifdef ATA_IRQ_TRAP
5438         ap->stats.unhandled_irq = 1;
5439         ap->stats.idle_irq = 1;
5440 #endif
5441
5442         memcpy(&ap->ioaddr, &ent->port[port_no], sizeof(struct ata_ioports));
5443 }
5444
5445 /**
5446  *      ata_port_init_shost - Initialize SCSI host associated with ATA port
5447  *      @ap: ATA port to initialize SCSI host for
5448  *      @shost: SCSI host associated with @ap
5449  *
5450  *      Initialize SCSI host @shost associated with ATA port @ap.
5451  *
5452  *      LOCKING:
5453  *      Inherited from caller.
5454  */
5455 static void ata_port_init_shost(struct ata_port *ap, struct Scsi_Host *shost)
5456 {
5457         ap->scsi_host = shost;
5458
5459         shost->unique_id = ap->id;
5460         shost->max_id = 16;
5461         shost->max_lun = 1;
5462         shost->max_channel = 1;
5463         shost->max_cmd_len = 12;
5464 }
5465
5466 /**
5467  *      ata_port_add - Attach low-level ATA driver to system
5468  *      @ent: Information provided by low-level driver
5469  *      @host: Collections of ports to which we add
5470  *      @port_no: Port number associated with this host
5471  *
5472  *      Attach low-level ATA driver to system.
5473  *
5474  *      LOCKING:
5475  *      PCI/etc. bus probe sem.
5476  *
5477  *      RETURNS:
5478  *      New ata_port on success, for NULL on error.
5479  */
5480 static struct ata_port * ata_port_add(const struct ata_probe_ent *ent,
5481                                       struct ata_host *host,
5482                                       unsigned int port_no)
5483 {
5484         struct Scsi_Host *shost;
5485         struct ata_port *ap;
5486
5487         DPRINTK("ENTER\n");
5488
5489         if (!ent->port_ops->error_handler &&
5490             !(ent->port_flags & (ATA_FLAG_SATA_RESET | ATA_FLAG_SRST))) {
5491                 printk(KERN_ERR "ata%u: no reset mechanism available\n",
5492                        port_no);
5493                 return NULL;
5494         }
5495
5496         shost = scsi_host_alloc(ent->sht, sizeof(struct ata_port));
5497         if (!shost)
5498                 return NULL;
5499
5500         shost->transportt = &ata_scsi_transport_template;
5501
5502         ap = ata_shost_to_port(shost);
5503
5504         ata_port_init(ap, host, ent, port_no);
5505         ata_port_init_shost(ap, shost);
5506
5507         return ap;
5508 }
5509
5510 /**
5511  *      ata_sas_host_init - Initialize a host struct
5512  *      @host:  host to initialize
5513  *      @dev:   device host is attached to
5514  *      @flags: host flags
5515  *      @ops:   port_ops
5516  *
5517  *      LOCKING:
5518  *      PCI/etc. bus probe sem.
5519  *
5520  */
5521
5522 void ata_host_init(struct ata_host *host, struct device *dev,
5523                    unsigned long flags, const struct ata_port_operations *ops)
5524 {
5525         spin_lock_init(&host->lock);
5526         host->dev = dev;
5527         host->flags = flags;
5528         host->ops = ops;
5529 }
5530
5531 /**
5532  *      ata_device_add - Register hardware device with ATA and SCSI layers
5533  *      @ent: Probe information describing hardware device to be registered
5534  *
5535  *      This function processes the information provided in the probe
5536  *      information struct @ent, allocates the necessary ATA and SCSI
5537  *      host information structures, initializes them, and registers
5538  *      everything with requisite kernel subsystems.
5539  *
5540  *      This function requests irqs, probes the ATA bus, and probes
5541  *      the SCSI bus.
5542  *
5543  *      LOCKING:
5544  *      PCI/etc. bus probe sem.
5545  *
5546  *      RETURNS:
5547  *      Number of ports registered.  Zero on error (no ports registered).
5548  */
5549 int ata_device_add(const struct ata_probe_ent *ent)
5550 {
5551         unsigned int i;
5552         struct device *dev = ent->dev;
5553         struct ata_host *host;
5554         int rc;
5555
5556         DPRINTK("ENTER\n");
5557
5558         if (ent->irq == 0) {
5559                 dev_printk(KERN_ERR, dev, "is not available: No interrupt assigned.\n");
5560                 return 0;
5561         }
5562         /* alloc a container for our list of ATA ports (buses) */
5563         host = kzalloc(sizeof(struct ata_host) +
5564                        (ent->n_ports * sizeof(void *)), GFP_KERNEL);
5565         if (!host)
5566                 return 0;
5567
5568         ata_host_init(host, dev, ent->_host_flags, ent->port_ops);
5569         host->n_ports = ent->n_ports;
5570         host->irq = ent->irq;
5571         host->irq2 = ent->irq2;
5572         host->mmio_base = ent->mmio_base;
5573         host->private_data = ent->private_data;
5574
5575         /* register each port bound to this device */
5576         for (i = 0; i < host->n_ports; i++) {
5577                 struct ata_port *ap;
5578                 unsigned long xfer_mode_mask;
5579                 int irq_line = ent->irq;
5580
5581                 ap = ata_port_add(ent, host, i);
5582                 host->ports[i] = ap;
5583                 if (!ap)
5584                         goto err_out;
5585
5586                 /* dummy? */
5587                 if (ent->dummy_port_mask & (1 << i)) {
5588                         ata_port_printk(ap, KERN_INFO, "DUMMY\n");
5589                         ap->ops = &ata_dummy_port_ops;
5590                         continue;
5591                 }
5592
5593                 /* start port */
5594                 rc = ap->ops->port_start(ap);
5595                 if (rc) {
5596                         host->ports[i] = NULL;
5597                         scsi_host_put(ap->scsi_host);
5598                         goto err_out;
5599                 }
5600
5601                 /* Report the secondary IRQ for second channel legacy */
5602                 if (i == 1 && ent->irq2)
5603                         irq_line = ent->irq2;
5604
5605                 xfer_mode_mask =(ap->udma_mask << ATA_SHIFT_UDMA) |
5606                                 (ap->mwdma_mask << ATA_SHIFT_MWDMA) |
5607                                 (ap->pio_mask << ATA_SHIFT_PIO);
5608
5609                 /* print per-port info to dmesg */
5610                 ata_port_printk(ap, KERN_INFO, "%cATA max %s cmd 0x%lX "
5611                                 "ctl 0x%lX bmdma 0x%lX irq %d\n",
5612                                 ap->flags & ATA_FLAG_SATA ? 'S' : 'P',
5613                                 ata_mode_string(xfer_mode_mask),
5614                                 ap->ioaddr.cmd_addr,
5615                                 ap->ioaddr.ctl_addr,
5616                                 ap->ioaddr.bmdma_addr,
5617                                 irq_line);
5618
5619                 ata_chk_status(ap);
5620                 host->ops->irq_clear(ap);
5621                 ata_eh_freeze_port(ap); /* freeze port before requesting IRQ */
5622         }
5623
5624         /* obtain irq, that may be shared between channels */
5625         rc = request_irq(ent->irq, ent->port_ops->irq_handler, ent->irq_flags,
5626                          DRV_NAME, host);
5627         if (rc) {
5628                 dev_printk(KERN_ERR, dev, "irq %lu request failed: %d\n",
5629                            ent->irq, rc);
5630                 goto err_out;
5631         }
5632
5633         /* do we have a second IRQ for the other channel, eg legacy mode */
5634         if (ent->irq2) {
5635                 /* We will get weird core code crashes later if this is true
5636                    so trap it now */
5637                 BUG_ON(ent->irq == ent->irq2);
5638
5639                 rc = request_irq(ent->irq2, ent->port_ops->irq_handler, ent->irq_flags,
5640                          DRV_NAME, host);
5641                 if (rc) {
5642                         dev_printk(KERN_ERR, dev, "irq %lu request failed: %d\n",
5643                                    ent->irq2, rc);
5644                         goto err_out_free_irq;
5645                 }
5646         }
5647
5648         /* perform each probe synchronously */
5649         DPRINTK("probe begin\n");
5650         for (i = 0; i < host->n_ports; i++) {
5651                 struct ata_port *ap = host->ports[i];
5652                 u32 scontrol;
5653                 int rc;
5654
5655                 /* init sata_spd_limit to the current value */
5656                 if (sata_scr_read(ap, SCR_CONTROL, &scontrol) == 0) {
5657                         int spd = (scontrol >> 4) & 0xf;
5658                         ap->hw_sata_spd_limit &= (1 << spd) - 1;
5659                 }
5660                 ap->sata_spd_limit = ap->hw_sata_spd_limit;
5661
5662                 rc = scsi_add_host(ap->scsi_host, dev);
5663                 if (rc) {
5664                         ata_port_printk(ap, KERN_ERR, "scsi_add_host failed\n");
5665                         /* FIXME: do something useful here */
5666                         /* FIXME: handle unconditional calls to
5667                          * scsi_scan_host and ata_host_remove, below,
5668                          * at the very least
5669                          */
5670                 }
5671
5672                 if (ap->ops->error_handler) {
5673                         struct ata_eh_info *ehi = &ap->eh_info;
5674                         unsigned long flags;
5675
5676                         ata_port_probe(ap);
5677
5678                         /* kick EH for boot probing */
5679                         spin_lock_irqsave(ap->lock, flags);
5680
5681                         ehi->probe_mask = (1 << ATA_MAX_DEVICES) - 1;
5682                         ehi->action |= ATA_EH_SOFTRESET;
5683                         ehi->flags |= ATA_EHI_NO_AUTOPSY | ATA_EHI_QUIET;
5684
5685                         ap->pflags |= ATA_PFLAG_LOADING;
5686                         ata_port_schedule_eh(ap);
5687
5688                         spin_unlock_irqrestore(ap->lock, flags);
5689
5690                         /* wait for EH to finish */
5691                         ata_port_wait_eh(ap);
5692                 } else {
5693                         DPRINTK("ata%u: bus probe begin\n", ap->id);
5694                         rc = ata_bus_probe(ap);
5695                         DPRINTK("ata%u: bus probe end\n", ap->id);
5696
5697                         if (rc) {
5698                                 /* FIXME: do something useful here?
5699                                  * Current libata behavior will
5700                                  * tear down everything when
5701                                  * the module is removed
5702                                  * or the h/w is unplugged.
5703                                  */
5704                         }
5705                 }
5706         }
5707
5708         /* probes are done, now scan each port's disk(s) */
5709         DPRINTK("host probe begin\n");
5710         for (i = 0; i < host->n_ports; i++) {
5711                 struct ata_port *ap = host->ports[i];
5712
5713                 ata_scsi_scan_host(ap);
5714         }
5715
5716         dev_set_drvdata(dev, host);
5717
5718         VPRINTK("EXIT, returning %u\n", ent->n_ports);
5719         return ent->n_ports; /* success */
5720
5721 err_out_free_irq:
5722         free_irq(ent->irq, host);
5723 err_out:
5724         for (i = 0; i < host->n_ports; i++) {
5725                 struct ata_port *ap = host->ports[i];
5726                 if (ap) {
5727                         ap->ops->port_stop(ap);
5728                         scsi_host_put(ap->scsi_host);
5729                 }
5730         }
5731
5732         kfree(host);
5733         VPRINTK("EXIT, returning 0\n");
5734         return 0;
5735 }
5736
5737 /**
5738  *      ata_port_detach - Detach ATA port in prepration of device removal
5739  *      @ap: ATA port to be detached
5740  *
5741  *      Detach all ATA devices and the associated SCSI devices of @ap;
5742  *      then, remove the associated SCSI host.  @ap is guaranteed to
5743  *      be quiescent on return from this function.
5744  *
5745  *      LOCKING:
5746  *      Kernel thread context (may sleep).
5747  */
5748 void ata_port_detach(struct ata_port *ap)
5749 {
5750         unsigned long flags;
5751         int i;
5752
5753         if (!ap->ops->error_handler)
5754                 goto skip_eh;
5755
5756         /* tell EH we're leaving & flush EH */
5757         spin_lock_irqsave(ap->lock, flags);
5758         ap->pflags |= ATA_PFLAG_UNLOADING;
5759         spin_unlock_irqrestore(ap->lock, flags);
5760
5761         ata_port_wait_eh(ap);
5762
5763         /* EH is now guaranteed to see UNLOADING, so no new device
5764          * will be attached.  Disable all existing devices.
5765          */
5766         spin_lock_irqsave(ap->lock, flags);
5767
5768         for (i = 0; i < ATA_MAX_DEVICES; i++)
5769                 ata_dev_disable(&ap->device[i]);
5770
5771         spin_unlock_irqrestore(ap->lock, flags);
5772
5773         /* Final freeze & EH.  All in-flight commands are aborted.  EH
5774          * will be skipped and retrials will be terminated with bad
5775          * target.
5776          */
5777         spin_lock_irqsave(ap->lock, flags);
5778         ata_port_freeze(ap);    /* won't be thawed */
5779         spin_unlock_irqrestore(ap->lock, flags);
5780
5781         ata_port_wait_eh(ap);
5782
5783         /* Flush hotplug task.  The sequence is similar to
5784          * ata_port_flush_task().
5785          */
5786         flush_workqueue(ata_aux_wq);
5787         cancel_delayed_work(&ap->hotplug_task);
5788         flush_workqueue(ata_aux_wq);
5789
5790  skip_eh:
5791         /* remove the associated SCSI host */
5792         scsi_remove_host(ap->scsi_host);
5793 }
5794
5795 /**
5796  *      ata_host_remove - PCI layer callback for device removal
5797  *      @host: ATA host set that was removed
5798  *
5799  *      Unregister all objects associated with this host set. Free those
5800  *      objects.
5801  *
5802  *      LOCKING:
5803  *      Inherited from calling layer (may sleep).
5804  */
5805
5806 void ata_host_remove(struct ata_host *host)
5807 {
5808         unsigned int i;
5809
5810         for (i = 0; i < host->n_ports; i++)
5811                 ata_port_detach(host->ports[i]);
5812
5813         free_irq(host->irq, host);
5814         if (host->irq2)
5815                 free_irq(host->irq2, host);
5816
5817         for (i = 0; i < host->n_ports; i++) {
5818                 struct ata_port *ap = host->ports[i];
5819
5820                 ata_scsi_release(ap->scsi_host);
5821
5822                 if ((ap->flags & ATA_FLAG_NO_LEGACY) == 0) {
5823                         struct ata_ioports *ioaddr = &ap->ioaddr;
5824
5825                         /* FIXME: Add -ac IDE pci mods to remove these special cases */
5826                         if (ioaddr->cmd_addr == ATA_PRIMARY_CMD)
5827                                 release_region(ATA_PRIMARY_CMD, 8);
5828                         else if (ioaddr->cmd_addr == ATA_SECONDARY_CMD)
5829                                 release_region(ATA_SECONDARY_CMD, 8);
5830                 }
5831
5832                 scsi_host_put(ap->scsi_host);
5833         }
5834
5835         if (host->ops->host_stop)
5836                 host->ops->host_stop(host);
5837
5838         kfree(host);
5839 }
5840
5841 /**
5842  *      ata_scsi_release - SCSI layer callback hook for host unload
5843  *      @shost: libata host to be unloaded
5844  *
5845  *      Performs all duties necessary to shut down a libata port...
5846  *      Kill port kthread, disable port, and release resources.
5847  *
5848  *      LOCKING:
5849  *      Inherited from SCSI layer.
5850  *
5851  *      RETURNS:
5852  *      One.
5853  */
5854
5855 int ata_scsi_release(struct Scsi_Host *shost)
5856 {
5857         struct ata_port *ap = ata_shost_to_port(shost);
5858
5859         DPRINTK("ENTER\n");
5860
5861         ap->ops->port_disable(ap);
5862         ap->ops->port_stop(ap);
5863
5864         DPRINTK("EXIT\n");
5865         return 1;
5866 }
5867
5868 struct ata_probe_ent *
5869 ata_probe_ent_alloc(struct device *dev, const struct ata_port_info *port)
5870 {
5871         struct ata_probe_ent *probe_ent;
5872
5873         probe_ent = kzalloc(sizeof(*probe_ent), GFP_KERNEL);
5874         if (!probe_ent) {
5875                 printk(KERN_ERR DRV_NAME "(%s): out of memory\n",
5876                        kobject_name(&(dev->kobj)));
5877                 return NULL;
5878         }
5879
5880         INIT_LIST_HEAD(&probe_ent->node);
5881         probe_ent->dev = dev;
5882
5883         probe_ent->sht = port->sht;
5884         probe_ent->port_flags = port->flags;
5885         probe_ent->pio_mask = port->pio_mask;
5886         probe_ent->mwdma_mask = port->mwdma_mask;
5887         probe_ent->udma_mask = port->udma_mask;
5888         probe_ent->port_ops = port->port_ops;
5889         probe_ent->private_data = port->private_data;
5890
5891         return probe_ent;
5892 }
5893
5894 /**
5895  *      ata_std_ports - initialize ioaddr with standard port offsets.
5896  *      @ioaddr: IO address structure to be initialized
5897  *
5898  *      Utility function which initializes data_addr, error_addr,
5899  *      feature_addr, nsect_addr, lbal_addr, lbam_addr, lbah_addr,
5900  *      device_addr, status_addr, and command_addr to standard offsets
5901  *      relative to cmd_addr.
5902  *
5903  *      Does not set ctl_addr, altstatus_addr, bmdma_addr, or scr_addr.
5904  */
5905
5906 void ata_std_ports(struct ata_ioports *ioaddr)
5907 {
5908         ioaddr->data_addr = ioaddr->cmd_addr + ATA_REG_DATA;
5909         ioaddr->error_addr = ioaddr->cmd_addr + ATA_REG_ERR;
5910         ioaddr->feature_addr = ioaddr->cmd_addr + ATA_REG_FEATURE;
5911         ioaddr->nsect_addr = ioaddr->cmd_addr + ATA_REG_NSECT;
5912         ioaddr->lbal_addr = ioaddr->cmd_addr + ATA_REG_LBAL;
5913         ioaddr->lbam_addr = ioaddr->cmd_addr + ATA_REG_LBAM;
5914         ioaddr->lbah_addr = ioaddr->cmd_addr + ATA_REG_LBAH;
5915         ioaddr->device_addr = ioaddr->cmd_addr + ATA_REG_DEVICE;
5916         ioaddr->status_addr = ioaddr->cmd_addr + ATA_REG_STATUS;
5917         ioaddr->command_addr = ioaddr->cmd_addr + ATA_REG_CMD;
5918 }
5919
5920
5921 #ifdef CONFIG_PCI
5922
5923 void ata_pci_host_stop (struct ata_host *host)
5924 {
5925         struct pci_dev *pdev = to_pci_dev(host->dev);
5926
5927         pci_iounmap(pdev, host->mmio_base);
5928 }
5929
5930 /**
5931  *      ata_pci_remove_one - PCI layer callback for device removal
5932  *      @pdev: PCI device that was removed
5933  *
5934  *      PCI layer indicates to libata via this hook that
5935  *      hot-unplug or module unload event has occurred.
5936  *      Handle this by unregistering all objects associated
5937  *      with this PCI device.  Free those objects.  Then finally
5938  *      release PCI resources and disable device.
5939  *
5940  *      LOCKING:
5941  *      Inherited from PCI layer (may sleep).
5942  */
5943
5944 void ata_pci_remove_one (struct pci_dev *pdev)
5945 {
5946         struct device *dev = pci_dev_to_dev(pdev);
5947         struct ata_host *host = dev_get_drvdata(dev);
5948
5949         ata_host_remove(host);
5950
5951         pci_release_regions(pdev);
5952         pci_disable_device(pdev);
5953         dev_set_drvdata(dev, NULL);
5954 }
5955
5956 /* move to PCI subsystem */
5957 int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits)
5958 {
5959         unsigned long tmp = 0;
5960
5961         switch (bits->width) {
5962         case 1: {
5963                 u8 tmp8 = 0;
5964                 pci_read_config_byte(pdev, bits->reg, &tmp8);
5965                 tmp = tmp8;
5966                 break;
5967         }
5968         case 2: {
5969                 u16 tmp16 = 0;
5970                 pci_read_config_word(pdev, bits->reg, &tmp16);
5971                 tmp = tmp16;
5972                 break;
5973         }
5974         case 4: {
5975                 u32 tmp32 = 0;
5976                 pci_read_config_dword(pdev, bits->reg, &tmp32);
5977                 tmp = tmp32;
5978                 break;
5979         }
5980
5981         default:
5982                 return -EINVAL;
5983         }
5984
5985         tmp &= bits->mask;
5986
5987         return (tmp == bits->val) ? 1 : 0;
5988 }
5989
5990 void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg)
5991 {
5992         pci_save_state(pdev);
5993
5994         if (mesg.event == PM_EVENT_SUSPEND) {
5995                 pci_disable_device(pdev);
5996                 pci_set_power_state(pdev, PCI_D3hot);
5997         }
5998 }
5999
6000 void ata_pci_device_do_resume(struct pci_dev *pdev)
6001 {
6002         pci_set_power_state(pdev, PCI_D0);
6003         pci_restore_state(pdev);
6004         pci_enable_device(pdev);
6005         pci_set_master(pdev);
6006 }
6007
6008 int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg)
6009 {
6010         struct ata_host *host = dev_get_drvdata(&pdev->dev);
6011         int rc = 0;
6012
6013         rc = ata_host_suspend(host, mesg);
6014         if (rc)
6015                 return rc;
6016
6017         ata_pci_device_do_suspend(pdev, mesg);
6018
6019         return 0;
6020 }
6021
6022 int ata_pci_device_resume(struct pci_dev *pdev)
6023 {
6024         struct ata_host *host = dev_get_drvdata(&pdev->dev);
6025
6026         ata_pci_device_do_resume(pdev);
6027         ata_host_resume(host);
6028         return 0;
6029 }
6030 #endif /* CONFIG_PCI */
6031
6032
6033 static int __init ata_init(void)
6034 {
6035         ata_probe_timeout *= HZ;
6036         ata_wq = create_workqueue("ata");
6037         if (!ata_wq)
6038                 return -ENOMEM;
6039
6040         ata_aux_wq = create_singlethread_workqueue("ata_aux");
6041         if (!ata_aux_wq) {
6042                 destroy_workqueue(ata_wq);
6043                 return -ENOMEM;
6044         }
6045
6046         printk(KERN_DEBUG "libata version " DRV_VERSION " loaded.\n");
6047         return 0;
6048 }
6049
6050 static void __exit ata_exit(void)
6051 {
6052         destroy_workqueue(ata_wq);
6053         destroy_workqueue(ata_aux_wq);
6054 }
6055
6056 subsys_initcall(ata_init);
6057 module_exit(ata_exit);
6058
6059 static unsigned long ratelimit_time;
6060 static DEFINE_SPINLOCK(ata_ratelimit_lock);
6061
6062 int ata_ratelimit(void)
6063 {
6064         int rc;
6065         unsigned long flags;
6066
6067         spin_lock_irqsave(&ata_ratelimit_lock, flags);
6068
6069         if (time_after(jiffies, ratelimit_time)) {
6070                 rc = 1;
6071                 ratelimit_time = jiffies + (HZ/5);
6072         } else
6073                 rc = 0;
6074
6075         spin_unlock_irqrestore(&ata_ratelimit_lock, flags);
6076
6077         return rc;
6078 }
6079
6080 /**
6081  *      ata_wait_register - wait until register value changes
6082  *      @reg: IO-mapped register
6083  *      @mask: Mask to apply to read register value
6084  *      @val: Wait condition
6085  *      @interval_msec: polling interval in milliseconds
6086  *      @timeout_msec: timeout in milliseconds
6087  *
6088  *      Waiting for some bits of register to change is a common
6089  *      operation for ATA controllers.  This function reads 32bit LE
6090  *      IO-mapped register @reg and tests for the following condition.
6091  *
6092  *      (*@reg & mask) != val
6093  *
6094  *      If the condition is met, it returns; otherwise, the process is
6095  *      repeated after @interval_msec until timeout.
6096  *
6097  *      LOCKING:
6098  *      Kernel thread context (may sleep)
6099  *
6100  *      RETURNS:
6101  *      The final register value.
6102  */
6103 u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
6104                       unsigned long interval_msec,
6105                       unsigned long timeout_msec)
6106 {
6107         unsigned long timeout;
6108         u32 tmp;
6109
6110         tmp = ioread32(reg);
6111
6112         /* Calculate timeout _after_ the first read to make sure
6113          * preceding writes reach the controller before starting to
6114          * eat away the timeout.
6115          */
6116         timeout = jiffies + (timeout_msec * HZ) / 1000;
6117
6118         while ((tmp & mask) == val && time_before(jiffies, timeout)) {
6119                 msleep(interval_msec);
6120                 tmp = ioread32(reg);
6121         }
6122
6123         return tmp;
6124 }
6125
6126 /*
6127  * Dummy port_ops
6128  */
6129 static void ata_dummy_noret(struct ata_port *ap)        { }
6130 static int ata_dummy_ret0(struct ata_port *ap)          { return 0; }
6131 static void ata_dummy_qc_noret(struct ata_queued_cmd *qc) { }
6132
6133 static u8 ata_dummy_check_status(struct ata_port *ap)
6134 {
6135         return ATA_DRDY;
6136 }
6137
6138 static unsigned int ata_dummy_qc_issue(struct ata_queued_cmd *qc)
6139 {
6140         return AC_ERR_SYSTEM;
6141 }
6142
6143 const struct ata_port_operations ata_dummy_port_ops = {
6144         .port_disable           = ata_port_disable,
6145         .check_status           = ata_dummy_check_status,
6146         .check_altstatus        = ata_dummy_check_status,
6147         .dev_select             = ata_noop_dev_select,
6148         .qc_prep                = ata_noop_qc_prep,
6149         .qc_issue               = ata_dummy_qc_issue,
6150         .freeze                 = ata_dummy_noret,
6151         .thaw                   = ata_dummy_noret,
6152         .error_handler          = ata_dummy_noret,
6153         .post_internal_cmd      = ata_dummy_qc_noret,
6154         .irq_clear              = ata_dummy_noret,
6155         .port_start             = ata_dummy_ret0,
6156         .port_stop              = ata_dummy_noret,
6157 };
6158
6159 /*
6160  * libata is essentially a library of internal helper functions for
6161  * low-level ATA host controller drivers.  As such, the API/ABI is
6162  * likely to change as new drivers are added and updated.
6163  * Do not depend on ABI/API stability.
6164  */
6165
6166 EXPORT_SYMBOL_GPL(sata_deb_timing_normal);
6167 EXPORT_SYMBOL_GPL(sata_deb_timing_hotplug);
6168 EXPORT_SYMBOL_GPL(sata_deb_timing_long);
6169 EXPORT_SYMBOL_GPL(ata_dummy_port_ops);
6170 EXPORT_SYMBOL_GPL(ata_std_bios_param);
6171 EXPORT_SYMBOL_GPL(ata_std_ports);
6172 EXPORT_SYMBOL_GPL(ata_host_init);
6173 EXPORT_SYMBOL_GPL(ata_device_add);
6174 EXPORT_SYMBOL_GPL(ata_port_detach);
6175 EXPORT_SYMBOL_GPL(ata_host_remove);
6176 EXPORT_SYMBOL_GPL(ata_sg_init);
6177 EXPORT_SYMBOL_GPL(ata_sg_init_one);
6178 EXPORT_SYMBOL_GPL(ata_hsm_move);
6179 EXPORT_SYMBOL_GPL(ata_qc_complete);
6180 EXPORT_SYMBOL_GPL(ata_qc_complete_multiple);
6181 EXPORT_SYMBOL_GPL(ata_qc_issue_prot);
6182 EXPORT_SYMBOL_GPL(ata_tf_load);
6183 EXPORT_SYMBOL_GPL(ata_tf_read);
6184 EXPORT_SYMBOL_GPL(ata_noop_dev_select);
6185 EXPORT_SYMBOL_GPL(ata_std_dev_select);
6186 EXPORT_SYMBOL_GPL(ata_tf_to_fis);
6187 EXPORT_SYMBOL_GPL(ata_tf_from_fis);
6188 EXPORT_SYMBOL_GPL(ata_check_status);
6189 EXPORT_SYMBOL_GPL(ata_altstatus);
6190 EXPORT_SYMBOL_GPL(ata_exec_command);
6191 EXPORT_SYMBOL_GPL(ata_port_start);
6192 EXPORT_SYMBOL_GPL(ata_port_stop);
6193 EXPORT_SYMBOL_GPL(ata_host_stop);
6194 EXPORT_SYMBOL_GPL(ata_interrupt);
6195 EXPORT_SYMBOL_GPL(ata_mmio_data_xfer);
6196 EXPORT_SYMBOL_GPL(ata_pio_data_xfer);
6197 EXPORT_SYMBOL_GPL(ata_pio_data_xfer_noirq);
6198 EXPORT_SYMBOL_GPL(ata_qc_prep);
6199 EXPORT_SYMBOL_GPL(ata_noop_qc_prep);
6200 EXPORT_SYMBOL_GPL(ata_bmdma_setup);
6201 EXPORT_SYMBOL_GPL(ata_bmdma_start);
6202 EXPORT_SYMBOL_GPL(ata_bmdma_irq_clear);
6203 EXPORT_SYMBOL_GPL(ata_bmdma_status);
6204 EXPORT_SYMBOL_GPL(ata_bmdma_stop);
6205 EXPORT_SYMBOL_GPL(ata_bmdma_freeze);
6206 EXPORT_SYMBOL_GPL(ata_bmdma_thaw);
6207 EXPORT_SYMBOL_GPL(ata_bmdma_drive_eh);
6208 EXPORT_SYMBOL_GPL(ata_bmdma_error_handler);
6209 EXPORT_SYMBOL_GPL(ata_bmdma_post_internal_cmd);
6210 EXPORT_SYMBOL_GPL(ata_port_probe);
6211 EXPORT_SYMBOL_GPL(sata_set_spd);
6212 EXPORT_SYMBOL_GPL(sata_phy_debounce);
6213 EXPORT_SYMBOL_GPL(sata_phy_resume);
6214 EXPORT_SYMBOL_GPL(sata_phy_reset);
6215 EXPORT_SYMBOL_GPL(__sata_phy_reset);
6216 EXPORT_SYMBOL_GPL(ata_bus_reset);
6217 EXPORT_SYMBOL_GPL(ata_std_prereset);
6218 EXPORT_SYMBOL_GPL(ata_std_softreset);
6219 EXPORT_SYMBOL_GPL(sata_port_hardreset);
6220 EXPORT_SYMBOL_GPL(sata_std_hardreset);
6221 EXPORT_SYMBOL_GPL(ata_std_postreset);
6222 EXPORT_SYMBOL_GPL(ata_dev_classify);
6223 EXPORT_SYMBOL_GPL(ata_dev_pair);
6224 EXPORT_SYMBOL_GPL(ata_port_disable);
6225 EXPORT_SYMBOL_GPL(ata_ratelimit);
6226 EXPORT_SYMBOL_GPL(ata_wait_register);
6227 EXPORT_SYMBOL_GPL(ata_busy_sleep);
6228 EXPORT_SYMBOL_GPL(ata_port_queue_task);
6229 EXPORT_SYMBOL_GPL(ata_scsi_ioctl);
6230 EXPORT_SYMBOL_GPL(ata_scsi_queuecmd);
6231 EXPORT_SYMBOL_GPL(ata_scsi_slave_config);
6232 EXPORT_SYMBOL_GPL(ata_scsi_slave_destroy);
6233 EXPORT_SYMBOL_GPL(ata_scsi_change_queue_depth);
6234 EXPORT_SYMBOL_GPL(ata_scsi_release);
6235 EXPORT_SYMBOL_GPL(ata_host_intr);
6236 EXPORT_SYMBOL_GPL(sata_scr_valid);
6237 EXPORT_SYMBOL_GPL(sata_scr_read);
6238 EXPORT_SYMBOL_GPL(sata_scr_write);
6239 EXPORT_SYMBOL_GPL(sata_scr_write_flush);
6240 EXPORT_SYMBOL_GPL(ata_port_online);
6241 EXPORT_SYMBOL_GPL(ata_port_offline);
6242 EXPORT_SYMBOL_GPL(ata_host_suspend);
6243 EXPORT_SYMBOL_GPL(ata_host_resume);
6244 EXPORT_SYMBOL_GPL(ata_id_string);
6245 EXPORT_SYMBOL_GPL(ata_id_c_string);
6246 EXPORT_SYMBOL_GPL(ata_device_blacklisted);
6247 EXPORT_SYMBOL_GPL(ata_scsi_simulate);
6248
6249 EXPORT_SYMBOL_GPL(ata_pio_need_iordy);
6250 EXPORT_SYMBOL_GPL(ata_timing_compute);
6251 EXPORT_SYMBOL_GPL(ata_timing_merge);
6252
6253 #ifdef CONFIG_PCI
6254 EXPORT_SYMBOL_GPL(pci_test_config_bits);
6255 EXPORT_SYMBOL_GPL(ata_pci_host_stop);
6256 EXPORT_SYMBOL_GPL(ata_pci_init_native_mode);
6257 EXPORT_SYMBOL_GPL(ata_pci_init_one);
6258 EXPORT_SYMBOL_GPL(ata_pci_remove_one);
6259 EXPORT_SYMBOL_GPL(ata_pci_device_do_suspend);
6260 EXPORT_SYMBOL_GPL(ata_pci_device_do_resume);
6261 EXPORT_SYMBOL_GPL(ata_pci_device_suspend);
6262 EXPORT_SYMBOL_GPL(ata_pci_device_resume);
6263 EXPORT_SYMBOL_GPL(ata_pci_default_filter);
6264 EXPORT_SYMBOL_GPL(ata_pci_clear_simplex);
6265 #endif /* CONFIG_PCI */
6266
6267 EXPORT_SYMBOL_GPL(ata_scsi_device_suspend);
6268 EXPORT_SYMBOL_GPL(ata_scsi_device_resume);
6269
6270 EXPORT_SYMBOL_GPL(ata_eng_timeout);
6271 EXPORT_SYMBOL_GPL(ata_port_schedule_eh);
6272 EXPORT_SYMBOL_GPL(ata_port_abort);
6273 EXPORT_SYMBOL_GPL(ata_port_freeze);
6274 EXPORT_SYMBOL_GPL(ata_eh_freeze_port);
6275 EXPORT_SYMBOL_GPL(ata_eh_thaw_port);
6276 EXPORT_SYMBOL_GPL(ata_eh_qc_complete);
6277 EXPORT_SYMBOL_GPL(ata_eh_qc_retry);
6278 EXPORT_SYMBOL_GPL(ata_do_eh);