include/linux/libata.h

   1 /*
   2  *  Copyright 2003-2005 Red Hat, Inc.  All rights reserved.
   3  *  Copyright 2003-2005 Jeff Garzik
   4  *
   5  *
   6  *  This program is free software; you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation; either version 2, or (at your option)
   9  *  any later version.
  10  *
  11  *  This program is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with this program; see the file COPYING.  If not, write to
  18  *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  19  *
  20  *
  21  *  libata documentation is available via 'make {ps|pdf}docs',
  22  *  as Documentation/DocBook/libata.*
  23  *
  24  */
  25
  26 #ifndef __LINUX_LIBATA_H__
  27 #define __LINUX_LIBATA_H__
  28
  29 #include <linux/delay.h>
  30 #include <linux/jiffies.h>
  31 #include <linux/interrupt.h>
  32 #include <linux/dma-mapping.h>
  33 #include <linux/scatterlist.h>
  34 #include <linux/io.h>
  35 #include <linux/ata.h>
  36 #include <linux/workqueue.h>
  37 #include <scsi/scsi_host.h>
  38 #include <linux/acpi.h>
  39 #include <linux/cdrom.h>
  40
  41 /*
  42  * Define if arch has non-standard setup.  This is a _PCI_ standard
  43  * not a legacy or ISA standard.
  44  */
  45 #ifdef CONFIG_ATA_NONSTANDARD
  46 #include <asm/libata-portmap.h>
  47 #else
  48 #include <asm-generic/libata-portmap.h>
  49 #endif
  50
  51 /*
  52  * compile-time options: to be removed as soon as all the drivers are
  53  * converted to the new debugging mechanism
  54  */
  55 #undef ATA_DEBUG                /* debugging output */
  56 #undef ATA_VERBOSE_DEBUG        /* yet more debugging output */
  57 #undef ATA_IRQ_TRAP             /* define to ack screaming irqs */
  58 #undef ATA_NDEBUG               /* define to disable quick runtime checks */
  59
  60
  61 /* note: prints function name for you */
  62 #ifdef ATA_DEBUG
  63 #define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __func__, ## args)
  64 #ifdef ATA_VERBOSE_DEBUG
  65 #define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __func__, ## args)
  66 #else
  67 #define VPRINTK(fmt, args...)
  68 #endif  /* ATA_VERBOSE_DEBUG */
  69 #else
  70 #define DPRINTK(fmt, args...)
  71 #define VPRINTK(fmt, args...)
  72 #endif  /* ATA_DEBUG */
  73
  74 #define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __func__, ## args)
  75
  76 /* NEW: debug levels */
  77 #define HAVE_LIBATA_MSG 1
  78
  79 enum {
  80         ATA_MSG_DRV     = 0x0001,
  81         ATA_MSG_INFO    = 0x0002,
  82         ATA_MSG_PROBE   = 0x0004,
  83         ATA_MSG_WARN    = 0x0008,
  84         ATA_MSG_MALLOC  = 0x0010,
  85         ATA_MSG_CTL     = 0x0020,
  86         ATA_MSG_INTR    = 0x0040,
  87         ATA_MSG_ERR     = 0x0080,
  88 };
  89
  90 #define ata_msg_drv(p)    ((p)->msg_enable & ATA_MSG_DRV)
  91 #define ata_msg_info(p)   ((p)->msg_enable & ATA_MSG_INFO)
  92 #define ata_msg_probe(p)  ((p)->msg_enable & ATA_MSG_PROBE)
  93 #define ata_msg_warn(p)   ((p)->msg_enable & ATA_MSG_WARN)
  94 #define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC)
  95 #define ata_msg_ctl(p)    ((p)->msg_enable & ATA_MSG_CTL)
  96 #define ata_msg_intr(p)   ((p)->msg_enable & ATA_MSG_INTR)
  97 #define ata_msg_err(p)    ((p)->msg_enable & ATA_MSG_ERR)
  98
  99 static inline u32 ata_msg_init(int dval, int default_msg_enable_bits)
 100 {
 101         if (dval < 0 || dval >= (sizeof(u32) * 8))
 102                 return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */
 103         if (!dval)
 104                 return 0;
 105         return (1 << dval) - 1;
 106 }
 107
 108 /* defines only for the constants which don't work well as enums */
 109 #define ATA_TAG_POISON          0xfafbfcfdU
 110
 111 enum {
 112         /* various global constants */
 113         LIBATA_MAX_PRD          = ATA_MAX_PRD / 2,
 114         LIBATA_DUMB_MAX_PRD     = ATA_MAX_PRD / 4,      /* Worst case */
 115         ATA_DEF_QUEUE           = 1,
 116         /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
 117         ATA_MAX_QUEUE           = 32,
 118         ATA_TAG_INTERNAL        = ATA_MAX_QUEUE - 1,
 119         ATA_SHORT_PAUSE         = 16,
 120
 121         ATAPI_MAX_DRAIN         = 16 << 10,
 122
 123         ATA_ALL_DEVICES         = (1 << ATA_MAX_DEVICES) - 1,
 124
 125         ATA_SHT_EMULATED        = 1,
 126         ATA_SHT_CMD_PER_LUN     = 1,
 127         ATA_SHT_THIS_ID         = -1,
 128         ATA_SHT_USE_CLUSTERING  = 1,
 129
 130         /* struct ata_device stuff */
 131         ATA_DFLAG_LBA           = (1 << 0), /* device supports LBA */
 132         ATA_DFLAG_LBA48         = (1 << 1), /* device supports LBA48 */
 133         ATA_DFLAG_CDB_INTR      = (1 << 2), /* device asserts INTRQ when ready for CDB */
 134         ATA_DFLAG_NCQ           = (1 << 3), /* device supports NCQ */
 135         ATA_DFLAG_FLUSH_EXT     = (1 << 4), /* do FLUSH_EXT instead of FLUSH */
 136         ATA_DFLAG_ACPI_PENDING  = (1 << 5), /* ACPI resume action pending */
 137         ATA_DFLAG_ACPI_FAILED   = (1 << 6), /* ACPI on devcfg has failed */
 138         ATA_DFLAG_AN            = (1 << 7), /* AN configured */
 139         ATA_DFLAG_HIPM          = (1 << 8), /* device supports HIPM */
 140         ATA_DFLAG_DIPM          = (1 << 9), /* device supports DIPM */
 141         ATA_DFLAG_DMADIR        = (1 << 10), /* device requires DMADIR */
 142         ATA_DFLAG_CFG_MASK      = (1 << 12) - 1,
 143
 144         ATA_DFLAG_PIO           = (1 << 12), /* device limited to PIO mode */
 145         ATA_DFLAG_NCQ_OFF       = (1 << 13), /* device limited to non-NCQ mode */
 146         ATA_DFLAG_SLEEPING      = (1 << 15), /* device is sleeping */
 147         ATA_DFLAG_DUBIOUS_XFER  = (1 << 16), /* data transfer not verified */
 148         ATA_DFLAG_NO_UNLOAD     = (1 << 17), /* device doesn't support unload */
 149         ATA_DFLAG_UNLOCK_HPA    = (1 << 18), /* unlock HPA */
 150         ATA_DFLAG_INIT_MASK     = (1 << 24) - 1,
 151
 152         ATA_DFLAG_DETACH        = (1 << 24),
 153         ATA_DFLAG_DETACHED      = (1 << 25),
 154
 155         ATA_DEV_UNKNOWN         = 0,    /* unknown device */
 156         ATA_DEV_ATA             = 1,    /* ATA device */
 157         ATA_DEV_ATA_UNSUP       = 2,    /* ATA device (unsupported) */
 158         ATA_DEV_ATAPI           = 3,    /* ATAPI device */
 159         ATA_DEV_ATAPI_UNSUP     = 4,    /* ATAPI device (unsupported) */
 160         ATA_DEV_PMP             = 5,    /* SATA port multiplier */
 161         ATA_DEV_PMP_UNSUP       = 6,    /* SATA port multiplier (unsupported) */
 162         ATA_DEV_SEMB            = 7,    /* SEMB */
 163         ATA_DEV_SEMB_UNSUP      = 8,    /* SEMB (unsupported) */
 164         ATA_DEV_NONE            = 9,    /* no device */
 165
 166         /* struct ata_link flags */
 167         ATA_LFLAG_NO_HRST       = (1 << 1), /* avoid hardreset */
 168         ATA_LFLAG_NO_SRST       = (1 << 2), /* avoid softreset */
 169         ATA_LFLAG_ASSUME_ATA    = (1 << 3), /* assume ATA class */
 170         ATA_LFLAG_ASSUME_SEMB   = (1 << 4), /* assume SEMB class */
 171         ATA_LFLAG_ASSUME_CLASS  = ATA_LFLAG_ASSUME_ATA | ATA_LFLAG_ASSUME_SEMB,
 172         ATA_LFLAG_NO_RETRY      = (1 << 5), /* don't retry this link */
 173         ATA_LFLAG_DISABLED      = (1 << 6), /* link is disabled */
 174         ATA_LFLAG_SW_ACTIVITY   = (1 << 7), /* keep activity stats */
 175
 176         /* struct ata_port flags */
 177         ATA_FLAG_SLAVE_POSS     = (1 << 0), /* host supports slave dev */
 178                                             /* (doesn't imply presence) */
 179         ATA_FLAG_SATA           = (1 << 1),
 180         ATA_FLAG_NO_LEGACY      = (1 << 2), /* no legacy mode check */
 181         ATA_FLAG_MMIO           = (1 << 3), /* use MMIO, not PIO */
 182         ATA_FLAG_SRST           = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */
 183         ATA_FLAG_SATA_RESET     = (1 << 5), /* (obsolete) use COMRESET */
 184         ATA_FLAG_NO_ATAPI       = (1 << 6), /* No ATAPI support */
 185         ATA_FLAG_PIO_DMA        = (1 << 7), /* PIO cmds via DMA */
 186         ATA_FLAG_PIO_LBA48      = (1 << 8), /* Host DMA engine is LBA28 only */
 187         ATA_FLAG_PIO_POLLING    = (1 << 9), /* use polling PIO if LLD
 188                                              * doesn't handle PIO interrupts */
 189         ATA_FLAG_NCQ            = (1 << 10), /* host supports NCQ */
 190         ATA_FLAG_NO_POWEROFF_SPINDOWN = (1 << 11), /* don't spindown before poweroff */
 191         ATA_FLAG_NO_HIBERNATE_SPINDOWN = (1 << 12), /* don't spindown before hibernation */
 192         ATA_FLAG_DEBUGMSG       = (1 << 13),
 193         ATA_FLAG_FPDMA_AA               = (1 << 14), /* driver supports Auto-Activate */
 194         ATA_FLAG_IGN_SIMPLEX    = (1 << 15), /* ignore SIMPLEX */
 195         ATA_FLAG_NO_IORDY       = (1 << 16), /* controller lacks iordy */
 196         ATA_FLAG_ACPI_SATA      = (1 << 17), /* need native SATA ACPI layout */
 197         ATA_FLAG_AN             = (1 << 18), /* controller supports AN */
 198         ATA_FLAG_PMP            = (1 << 19), /* controller supports PMP */
 199         ATA_FLAG_IPM            = (1 << 20), /* driver can handle IPM */
 200         ATA_FLAG_EM             = (1 << 21), /* driver supports enclosure
 201                                               * management */
 202         ATA_FLAG_SW_ACTIVITY    = (1 << 22), /* driver supports sw activity
 203                                               * led */
 204
 205         /* bits 24:31 of ap->flags are reserved for LLD specific flags */
 206
 207
 208         /* struct ata_port pflags */
 209         ATA_PFLAG_EH_PENDING    = (1 << 0), /* EH pending */
 210         ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */
 211         ATA_PFLAG_FROZEN        = (1 << 2), /* port is frozen */
 212         ATA_PFLAG_RECOVERED     = (1 << 3), /* recovery action performed */
 213         ATA_PFLAG_LOADING       = (1 << 4), /* boot/loading probe */
 214         ATA_PFLAG_SCSI_HOTPLUG  = (1 << 6), /* SCSI hotplug scheduled */
 215         ATA_PFLAG_INITIALIZING  = (1 << 7), /* being initialized, don't touch */
 216         ATA_PFLAG_RESETTING     = (1 << 8), /* reset in progress */
 217         ATA_PFLAG_UNLOADING     = (1 << 9), /* driver is being unloaded */
 218         ATA_PFLAG_UNLOADED      = (1 << 10), /* driver is unloaded */
 219
 220         ATA_PFLAG_SUSPENDED     = (1 << 17), /* port is suspended (power) */
 221         ATA_PFLAG_PM_PENDING    = (1 << 18), /* PM operation pending */
 222         ATA_PFLAG_INIT_GTM_VALID = (1 << 19), /* initial gtm data valid */
 223
 224         ATA_PFLAG_PIO32         = (1 << 20),  /* 32bit PIO */
 225         ATA_PFLAG_PIO32CHANGE   = (1 << 21),  /* 32bit PIO can be turned on/off */
 226
 227         /* struct ata_queued_cmd flags */
 228         ATA_QCFLAG_ACTIVE       = (1 << 0), /* cmd not yet ack'd to scsi lyer */
 229         ATA_QCFLAG_DMAMAP       = (1 << 1), /* SG table is DMA mapped */
 230         ATA_QCFLAG_IO           = (1 << 3), /* standard IO command */
 231         ATA_QCFLAG_RESULT_TF    = (1 << 4), /* result TF requested */
 232         ATA_QCFLAG_CLEAR_EXCL   = (1 << 5), /* clear excl_link on completion */
 233         ATA_QCFLAG_QUIET        = (1 << 6), /* don't report device error */
 234         ATA_QCFLAG_RETRY        = (1 << 7), /* retry after failure */
 235
 236         ATA_QCFLAG_FAILED       = (1 << 16), /* cmd failed and is owned by EH */
 237         ATA_QCFLAG_SENSE_VALID  = (1 << 17), /* sense data valid */
 238         ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
 239
 240         /* host set flags */
 241         ATA_HOST_SIMPLEX        = (1 << 0),     /* Host is simplex, one DMA channel per host only */
 242         ATA_HOST_STARTED        = (1 << 1),     /* Host started */
 243         ATA_HOST_PARALLEL_SCAN  = (1 << 2),     /* Ports on this host can be scanned in parallel */
 244
 245         /* bits 24:31 of host->flags are reserved for LLD specific flags */
 246
 247         /* various lengths of time */
 248         ATA_TMOUT_BOOT          = 30000,        /* heuristic */
 249         ATA_TMOUT_BOOT_QUICK    =  7000,        /* heuristic */
 250         ATA_TMOUT_INTERNAL_QUICK = 5000,
 251         ATA_TMOUT_MAX_PARK      = 30000,
 252
 253         /*
 254          * GoVault needs 2s and iVDR disk HHD424020F7SV00 800ms.  2s
 255          * is too much without parallel probing.  Use 2s if parallel
 256          * probing is available, 800ms otherwise.
 257          */
 258         ATA_TMOUT_FF_WAIT_LONG  =  2000,
 259         ATA_TMOUT_FF_WAIT       =   800,
 260
 261         /* Spec mandates to wait for ">= 2ms" before checking status
 262          * after reset.  We wait 150ms, because that was the magic
 263          * delay used for ATAPI devices in Hale Landis's ATADRVR, for
 264          * the period of time between when the ATA command register is
 265          * written, and then status is checked.  Because waiting for
 266          * "a while" before checking status is fine, post SRST, we
 267          * perform this magic delay here as well.
 268          *
 269          * Old drivers/ide uses the 2mS rule and then waits for ready.
 270          */
 271         ATA_WAIT_AFTER_RESET    =  150,
 272
 273         /* If PMP is supported, we have to do follow-up SRST.  As some
 274          * PMPs don't send D2H Reg FIS after hardreset, LLDs are
 275          * advised to wait only for the following duration before
 276          * doing SRST.
 277          */
 278         ATA_TMOUT_PMP_SRST_WAIT = 5000,
 279
 280         /* ATA bus states */
 281         BUS_UNKNOWN             = 0,
 282         BUS_DMA                 = 1,
 283         BUS_IDLE                = 2,
 284         BUS_NOINTR              = 3,
 285         BUS_NODATA              = 4,
 286         BUS_TIMER               = 5,
 287         BUS_PIO                 = 6,
 288         BUS_EDD                 = 7,
 289         BUS_IDENTIFY            = 8,
 290         BUS_PACKET              = 9,
 291
 292         /* SATA port states */
 293         PORT_UNKNOWN            = 0,
 294         PORT_ENABLED            = 1,
 295         PORT_DISABLED           = 2,
 296
 297         /* encoding various smaller bitmaps into a single
 298          * unsigned long bitmap
 299          */
 300         ATA_NR_PIO_MODES        = 7,
 301         ATA_NR_MWDMA_MODES      = 5,
 302         ATA_NR_UDMA_MODES       = 8,
 303
 304         ATA_SHIFT_PIO           = 0,
 305         ATA_SHIFT_MWDMA         = ATA_SHIFT_PIO + ATA_NR_PIO_MODES,
 306         ATA_SHIFT_UDMA          = ATA_SHIFT_MWDMA + ATA_NR_MWDMA_MODES,
 307
 308         /* size of buffer to pad xfers ending on unaligned boundaries */
 309         ATA_DMA_PAD_SZ          = 4,
 310
 311         /* ering size */
 312         ATA_ERING_SIZE          = 32,
 313
 314         /* return values for ->qc_defer */
 315         ATA_DEFER_LINK          = 1,
 316         ATA_DEFER_PORT          = 2,
 317
 318         /* desc_len for ata_eh_info and context */
 319         ATA_EH_DESC_LEN         = 80,
 320
 321         /* reset / recovery action types */
 322         ATA_EH_REVALIDATE       = (1 << 0),
 323         ATA_EH_SOFTRESET        = (1 << 1), /* meaningful only in ->prereset */
 324         ATA_EH_HARDRESET        = (1 << 2), /* meaningful only in ->prereset */
 325         ATA_EH_RESET            = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
 326         ATA_EH_ENABLE_LINK      = (1 << 3),
 327         ATA_EH_LPM              = (1 << 4),  /* link power management action */
 328         ATA_EH_PARK             = (1 << 5), /* unload heads and stop I/O */
 329
 330         ATA_EH_PERDEV_MASK      = ATA_EH_REVALIDATE | ATA_EH_PARK,
 331         ATA_EH_ALL_ACTIONS      = ATA_EH_REVALIDATE | ATA_EH_RESET |
 332                                   ATA_EH_ENABLE_LINK | ATA_EH_LPM,
 333
 334         /* ata_eh_info->flags */
 335         ATA_EHI_HOTPLUGGED      = (1 << 0),  /* could have been hotplugged */
 336         ATA_EHI_NO_AUTOPSY      = (1 << 2),  /* no autopsy */
 337         ATA_EHI_QUIET           = (1 << 3),  /* be quiet */
 338
 339         ATA_EHI_DID_SOFTRESET   = (1 << 16), /* already soft-reset this port */
 340         ATA_EHI_DID_HARDRESET   = (1 << 17), /* already soft-reset this port */
 341         ATA_EHI_PRINTINFO       = (1 << 18), /* print configuration info */
 342         ATA_EHI_SETMODE         = (1 << 19), /* configure transfer mode */
 343         ATA_EHI_POST_SETMODE    = (1 << 20), /* revaildating after setmode */
 344
 345         ATA_EHI_DID_RESET       = ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
 346
 347         /* mask of flags to transfer *to* the slave link */
 348         ATA_EHI_TO_SLAVE_MASK   = ATA_EHI_NO_AUTOPSY | ATA_EHI_QUIET,
 349
 350         /* max tries if error condition is still set after ->error_handler */
 351         ATA_EH_MAX_TRIES        = 5,
 352
 353         /* sometimes resuming a link requires several retries */
 354         ATA_LINK_RESUME_TRIES   = 5,
 355
 356         /* how hard are we gonna try to probe/recover devices */
 357         ATA_PROBE_MAX_TRIES     = 3,
 358         ATA_EH_DEV_TRIES        = 3,
 359         ATA_EH_PMP_TRIES        = 5,
 360         ATA_EH_PMP_LINK_TRIES   = 3,
 361
 362         SATA_PMP_RW_TIMEOUT     = 3000,         /* PMP read/write timeout */
 363
 364         /* This should match the actual table size of
 365          * ata_eh_cmd_timeout_table in libata-eh.c.
 366          */
 367         ATA_EH_CMD_TIMEOUT_TABLE_SIZE = 6,
 368
 369         /* Horkage types. May be set by libata or controller on drives
 370            (some horkage may be drive/controller pair dependant */
 371
 372         ATA_HORKAGE_DIAGNOSTIC  = (1 << 0),     /* Failed boot diag */
 373         ATA_HORKAGE_NODMA       = (1 << 1),     /* DMA problems */
 374         ATA_HORKAGE_NONCQ       = (1 << 2),     /* Don't use NCQ */
 375         ATA_HORKAGE_MAX_SEC_128 = (1 << 3),     /* Limit max sects to 128 */
 376         ATA_HORKAGE_BROKEN_HPA  = (1 << 4),     /* Broken HPA */
 377         ATA_HORKAGE_DISABLE     = (1 << 5),     /* Disable it */
 378         ATA_HORKAGE_HPA_SIZE    = (1 << 6),     /* native size off by one */
 379         ATA_HORKAGE_IPM         = (1 << 7),     /* Link PM problems */
 380         ATA_HORKAGE_IVB         = (1 << 8),     /* cbl det validity bit bugs */
 381         ATA_HORKAGE_STUCK_ERR   = (1 << 9),     /* stuck ERR on next PACKET */
 382         ATA_HORKAGE_BRIDGE_OK   = (1 << 10),    /* no bridge limits */
 383         ATA_HORKAGE_ATAPI_MOD16_DMA = (1 << 11), /* use ATAPI DMA for commands
 384                                                     not multiple of 16 bytes */
 385         ATA_HORKAGE_FIRMWARE_WARN = (1 << 12),  /* firmware update warning */
 386         ATA_HORKAGE_1_5_GBPS    = (1 << 13),    /* force 1.5 Gbps */
 387         ATA_HORKAGE_NOSETXFER   = (1 << 14),    /* skip SETXFER, SATA only */
 388         ATA_HORKAGE_BROKEN_FPDMA_AA     = (1 << 15),    /* skip AA */
 389
 390          /* DMA mask for user DMA control: User visible values; DO NOT
 391             renumber */
 392         ATA_DMA_MASK_ATA        = (1 << 0),     /* DMA on ATA Disk */
 393         ATA_DMA_MASK_ATAPI      = (1 << 1),     /* DMA on ATAPI */
 394         ATA_DMA_MASK_CFA        = (1 << 2),     /* DMA on CF Card */
 395
 396         /* ATAPI command types */
 397         ATAPI_READ              = 0,            /* READs */
 398         ATAPI_WRITE             = 1,            /* WRITEs */
 399         ATAPI_READ_CD           = 2,            /* READ CD [MSF] */
 400         ATAPI_PASS_THRU         = 3,            /* SAT pass-thru */
 401         ATAPI_MISC              = 4,            /* the rest */
 402
 403         /* Timing constants */
 404         ATA_TIMING_SETUP        = (1 << 0),
 405         ATA_TIMING_ACT8B        = (1 << 1),
 406         ATA_TIMING_REC8B        = (1 << 2),
 407         ATA_TIMING_CYC8B        = (1 << 3),
 408         ATA_TIMING_8BIT         = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
 409                                   ATA_TIMING_CYC8B,
 410         ATA_TIMING_ACTIVE       = (1 << 4),
 411         ATA_TIMING_RECOVER      = (1 << 5),
 412         ATA_TIMING_DMACK_HOLD   = (1 << 6),
 413         ATA_TIMING_CYCLE        = (1 << 7),
 414         ATA_TIMING_UDMA         = (1 << 8),
 415         ATA_TIMING_ALL          = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
 416                                   ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
 417                                   ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
 418                                   ATA_TIMING_DMACK_HOLD | ATA_TIMING_CYCLE |
 419                                   ATA_TIMING_UDMA,
 420
 421         /* ACPI constants */
 422         ATA_ACPI_FILTER_SETXFER = 1 << 0,
 423         ATA_ACPI_FILTER_LOCK    = 1 << 1,
 424         ATA_ACPI_FILTER_DIPM    = 1 << 2,
 425         ATA_ACPI_FILTER_FPDMA_OFFSET = 1 << 3,  /* FPDMA non-zero offset */
 426         ATA_ACPI_FILTER_FPDMA_AA = 1 << 4,      /* FPDMA auto activate */
 427
 428         ATA_ACPI_FILTER_DEFAULT = ATA_ACPI_FILTER_SETXFER |
 429                                   ATA_ACPI_FILTER_LOCK |
 430                                   ATA_ACPI_FILTER_DIPM,
 431 };
 432
 433 enum ata_xfer_mask {
 434         ATA_MASK_PIO            = ((1LU << ATA_NR_PIO_MODES) - 1)
 435                                         << ATA_SHIFT_PIO,
 436         ATA_MASK_MWDMA          = ((1LU << ATA_NR_MWDMA_MODES) - 1)
 437                                         << ATA_SHIFT_MWDMA,
 438         ATA_MASK_UDMA           = ((1LU << ATA_NR_UDMA_MODES) - 1)
 439                                         << ATA_SHIFT_UDMA,
 440 };
 441
 442 enum hsm_task_states {
 443         HSM_ST_IDLE,            /* no command on going */
 444         HSM_ST_FIRST,           /* (waiting the device to)
 445                                    write CDB or first data block */
 446         HSM_ST,                 /* (waiting the device to) transfer data */
 447         HSM_ST_LAST,            /* (waiting the device to) complete command */
 448         HSM_ST_ERR,             /* error */
 449 };
 450
 451 enum ata_completion_errors {
 452         AC_ERR_DEV              = (1 << 0), /* device reported error */
 453         AC_ERR_HSM              = (1 << 1), /* host state machine violation */
 454         AC_ERR_TIMEOUT          = (1 << 2), /* timeout */
 455         AC_ERR_MEDIA            = (1 << 3), /* media error */
 456         AC_ERR_ATA_BUS          = (1 << 4), /* ATA bus error */
 457         AC_ERR_HOST_BUS         = (1 << 5), /* host bus error */
 458         AC_ERR_SYSTEM           = (1 << 6), /* system error */
 459         AC_ERR_INVALID          = (1 << 7), /* invalid argument */
 460         AC_ERR_OTHER            = (1 << 8), /* unknown */
 461         AC_ERR_NODEV_HINT       = (1 << 9), /* polling device detection hint */
 462         AC_ERR_NCQ              = (1 << 10), /* marker for offending NCQ qc */
 463 };
 464
 465 /* forward declarations */
 466 struct scsi_device;
 467 struct ata_port_operations;
 468 struct ata_port;
 469 struct ata_link;
 470 struct ata_queued_cmd;
 471
 472 /* typedefs */
 473 typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
 474 typedef int (*ata_prereset_fn_t)(struct ata_link *link, unsigned long deadline);
 475 typedef int (*ata_reset_fn_t)(struct ata_link *link, unsigned int *classes,
 476                               unsigned long deadline);
 477 typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes);
 478
 479 /*
 480  * host pm policy: If you alter this, you also need to alter libata-scsi.c
 481  * (for the ascii descriptions)
 482  */
 483 enum link_pm {
 484         NOT_AVAILABLE,
 485         MIN_POWER,
 486         MAX_PERFORMANCE,
 487         MEDIUM_POWER,
 488 };
 489 extern struct device_attribute dev_attr_link_power_management_policy;
 490 extern struct device_attribute dev_attr_unload_heads;
 491 extern struct device_attribute dev_attr_em_message_type;
 492 extern struct device_attribute dev_attr_em_message;
 493 extern struct device_attribute dev_attr_sw_activity;
 494
 495 enum sw_activity {
 496         OFF,
 497         BLINK_ON,
 498         BLINK_OFF,
 499 };
 500
 501 #ifdef CONFIG_ATA_SFF
 502 struct ata_ioports {
 503         void __iomem            *cmd_addr;
 504         void __iomem            *data_addr;
 505         void __iomem            *error_addr;
 506         void __iomem            *feature_addr;
 507         void __iomem            *nsect_addr;
 508         void __iomem            *lbal_addr;
 509         void __iomem            *lbam_addr;
 510         void __iomem            *lbah_addr;
 511         void __iomem            *device_addr;
 512         void __iomem            *status_addr;
 513         void __iomem            *command_addr;
 514         void __iomem            *altstatus_addr;
 515         void __iomem            *ctl_addr;
 516 #ifdef CONFIG_ATA_BMDMA
 517         void __iomem            *bmdma_addr;
 518 #endif /* CONFIG_ATA_BMDMA */
 519         void __iomem            *scr_addr;
 520 };
 521 #endif /* CONFIG_ATA_SFF */
 522
 523 struct ata_host {
 524         spinlock_t              lock;
 525         struct device           *dev;
 526         void __iomem * const    *iomap;
 527         unsigned int            n_ports;
 528         void                    *private_data;
 529         struct ata_port_operations *ops;
 530         unsigned long           flags;
 531 #ifdef CONFIG_ATA_ACPI
 532         acpi_handle             acpi_handle;
 533 #endif
 534         struct ata_port         *simplex_claimed;       /* channel owning the DMA */
 535         struct ata_port         *ports[0];
 536 };
 537
 538 struct ata_queued_cmd {
 539         struct ata_port         *ap;
 540         struct ata_device       *dev;
 541
 542         struct scsi_cmnd        *scsicmd;
 543         void                    (*scsidone)(struct scsi_cmnd *);
 544
 545         struct ata_taskfile     tf;
 546         u8                      cdb[ATAPI_CDB_LEN];
 547
 548         unsigned long           flags;          /* ATA_QCFLAG_xxx */
 549         unsigned int            tag;
 550         unsigned int            n_elem;
 551         unsigned int            orig_n_elem;
 552
 553         int                     dma_dir;
 554
 555         unsigned int            sect_size;
 556
 557         unsigned int            nbytes;
 558         unsigned int            extrabytes;
 559         unsigned int            curbytes;
 560
 561         struct scatterlist      *cursg;
 562         unsigned int            cursg_ofs;
 563
 564         struct scatterlist      sgent;
 565
 566         struct scatterlist      *sg;
 567
 568         unsigned int            err_mask;
 569         struct ata_taskfile     result_tf;
 570         ata_qc_cb_t             complete_fn;
 571
 572         void                    *private_data;
 573         void                    *lldd_task;
 574 };
 575
 576 struct ata_port_stats {
 577         unsigned long           unhandled_irq;
 578         unsigned long           idle_irq;
 579         unsigned long           rw_reqbuf;
 580 };
 581
 582 struct ata_ering_entry {
 583         unsigned int            eflags;
 584         unsigned int            err_mask;
 585         u64                     timestamp;
 586 };
 587
 588 struct ata_ering {
 589         int                     cursor;
 590         struct ata_ering_entry  ring[ATA_ERING_SIZE];
 591 };
 592
 593 struct ata_device {
 594         struct ata_link         *link;
 595         unsigned int            devno;          /* 0 or 1 */
 596         unsigned int            horkage;        /* List of broken features */
 597         unsigned long           flags;          /* ATA_DFLAG_xxx */
 598         struct scsi_device      *sdev;          /* attached SCSI device */
 599         void                    *private_data;
 600 #ifdef CONFIG_ATA_ACPI
 601         acpi_handle             acpi_handle;
 602         union acpi_object       *gtf_cache;
 603         unsigned int            gtf_filter;
 604 #endif
 605         /* n_sector is CLEAR_BEGIN, read comment above CLEAR_BEGIN */
 606         u64                     n_sectors;      /* size of device, if ATA */
 607         u64                     n_native_sectors; /* native size, if ATA */
 608         unsigned int            class;          /* ATA_DEV_xxx */
 609         unsigned long           unpark_deadline;
 610
 611         u8                      pio_mode;
 612         u8                      dma_mode;
 613         u8                      xfer_mode;
 614         unsigned int            xfer_shift;     /* ATA_SHIFT_xxx */
 615
 616         unsigned int            multi_count;    /* sectors count for
 617                                                    READ/WRITE MULTIPLE */
 618         unsigned int            max_sectors;    /* per-device max sectors */
 619         unsigned int            cdb_len;
 620
 621         /* per-dev xfer mask */
 622         unsigned long           pio_mask;
 623         unsigned long           mwdma_mask;
 624         unsigned long           udma_mask;
 625
 626         /* for CHS addressing */
 627         u16                     cylinders;      /* Number of cylinders */
 628         u16                     heads;          /* Number of heads */
 629         u16                     sectors;        /* Number of sectors per track */
 630
 631         union {
 632                 u16             id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
 633                 u32             gscr[SATA_PMP_GSCR_DWORDS]; /* PMP GSCR block */
 634         };
 635
 636         /* error history */
 637         int                     spdn_cnt;
 638         /* ering is CLEAR_END, read comment above CLEAR_END */
 639         struct ata_ering        ering;
 640 };
 641
 642 /* Fields between ATA_DEVICE_CLEAR_BEGIN and ATA_DEVICE_CLEAR_END are
 643  * cleared to zero on ata_dev_init().
 644  */
 645 #define ATA_DEVICE_CLEAR_BEGIN          offsetof(struct ata_device, n_sectors)
 646 #define ATA_DEVICE_CLEAR_END            offsetof(struct ata_device, ering)
 647
 648 struct ata_eh_info {
 649         struct ata_device       *dev;           /* offending device */
 650         u32                     serror;         /* SError from LLDD */
 651         unsigned int            err_mask;       /* port-wide err_mask */
 652         unsigned int            action;         /* ATA_EH_* action mask */
 653         unsigned int            dev_action[ATA_MAX_DEVICES]; /* dev EH action */
 654         unsigned int            flags;          /* ATA_EHI_* flags */
 655
 656         unsigned int            probe_mask;
 657
 658         char                    desc[ATA_EH_DESC_LEN];
 659         int                     desc_len;
 660 };
 661
 662 struct ata_eh_context {
 663         struct ata_eh_info      i;
 664         int                     tries[ATA_MAX_DEVICES];
 665         int                     cmd_timeout_idx[ATA_MAX_DEVICES]
 666                                                [ATA_EH_CMD_TIMEOUT_TABLE_SIZE];
 667         unsigned int            classes[ATA_MAX_DEVICES];
 668         unsigned int            did_probe_mask;
 669         unsigned int            unloaded_mask;
 670         unsigned int            saved_ncq_enabled;
 671         u8                      saved_xfer_mode[ATA_MAX_DEVICES];
 672         /* timestamp for the last reset attempt or success */
 673         unsigned long           last_reset;
 674 };
 675
 676 struct ata_acpi_drive
 677 {
 678         u32 pio;
 679         u32 dma;
 680 } __packed;
 681
 682 struct ata_acpi_gtm {
 683         struct ata_acpi_drive drive[2];
 684         u32 flags;
 685 } __packed;
 686
 687 struct ata_link {
 688         struct ata_port         *ap;
 689         int                     pmp;            /* port multiplier port # */
 690
 691         unsigned int            active_tag;     /* active tag on this link */
 692         u32                     sactive;        /* active NCQ commands */
 693
 694         unsigned int            flags;          /* ATA_LFLAG_xxx */
 695
 696         u32                     saved_scontrol; /* SControl on probe */
 697         unsigned int            hw_sata_spd_limit;
 698         unsigned int            sata_spd_limit;
 699         unsigned int            sata_spd;       /* current SATA PHY speed */
 700
 701         /* record runtime error info, protected by host_set lock */
 702         struct ata_eh_info      eh_info;
 703         /* EH context */
 704         struct ata_eh_context   eh_context;
 705
 706         struct ata_device       device[ATA_MAX_DEVICES];
 707 };
 708
 709 struct ata_port {
 710         struct Scsi_Host        *scsi_host; /* our co-allocated scsi host */
 711         struct ata_port_operations *ops;
 712         spinlock_t              *lock;
 713         /* Flags owned by the EH context. Only EH should touch these once the
 714            port is active */
 715         unsigned long           flags;  /* ATA_FLAG_xxx */
 716         /* Flags that change dynamically, protected by ap->lock */
 717         unsigned int            pflags; /* ATA_PFLAG_xxx */
 718         unsigned int            print_id; /* user visible unique port ID */
 719         unsigned int            port_no; /* 0 based port no. inside the host */
 720
 721 #ifdef CONFIG_ATA_SFF
 722         struct ata_ioports      ioaddr; /* ATA cmd/ctl/dma register blocks */
 723         u8                      ctl;    /* cache of ATA control register */
 724         u8                      last_ctl;       /* Cache last written value */
 725         struct delayed_work     sff_pio_task;
 726 #ifdef CONFIG_ATA_BMDMA
 727         struct ata_bmdma_prd    *bmdma_prd;     /* BMDMA SG list */
 728         dma_addr_t              bmdma_prd_dma;  /* and its DMA mapping */
 729 #endif /* CONFIG_ATA_BMDMA */
 730 #endif /* CONFIG_ATA_SFF */
 731
 732         unsigned int            pio_mask;
 733         unsigned int            mwdma_mask;
 734         unsigned int            udma_mask;
 735         unsigned int            cbl;    /* cable type; ATA_CBL_xxx */
 736
 737         struct ata_queued_cmd   qcmd[ATA_MAX_QUEUE];
 738         unsigned long           qc_allocated;
 739         unsigned int            qc_active;
 740         int                     nr_active_links; /* #links with active qcs */
 741
 742         struct ata_link         link;           /* host default link */
 743         struct ata_link         *slave_link;    /* see ata_slave_link_init() */
 744
 745         int                     nr_pmp_links;   /* nr of available PMP links */
 746         struct ata_link         *pmp_link;      /* array of PMP links */
 747         struct ata_link         *excl_link;     /* for PMP qc exclusion */
 748
 749         struct ata_port_stats   stats;
 750         struct ata_host         *host;
 751         struct device           *dev;
 752
 753         struct delayed_work     hotplug_task;
 754         struct work_struct      scsi_rescan_task;
 755
 756         unsigned int            hsm_task_state;
 757
 758         u32                     msg_enable;
 759         struct list_head        eh_done_q;
 760         wait_queue_head_t       eh_wait_q;
 761         int                     eh_tries;
 762         struct completion       park_req_pending;
 763
 764         pm_message_t            pm_mesg;
 765         int                     *pm_result;
 766         enum link_pm            pm_policy;
 767
 768         struct timer_list       fastdrain_timer;
 769         unsigned long           fastdrain_cnt;
 770
 771         int                     em_message_type;
 772         void                    *private_data;
 773
 774 #ifdef CONFIG_ATA_ACPI
 775         acpi_handle             acpi_handle;
 776         struct ata_acpi_gtm     __acpi_init_gtm; /* use ata_acpi_init_gtm() */
 777 #endif
 778         /* owned by EH */
 779         u8                      sector_buf[ATA_SECT_SIZE] ____cacheline_aligned;
 780 };
 781
 782 /* The following initializer overrides a method to NULL whether one of
 783  * its parent has the method defined or not.  This is equivalent to
 784  * ERR_PTR(-ENOENT).  Unfortunately, ERR_PTR doesn't render a constant
 785  * expression and thus can't be used as an initializer.
 786  */
 787 #define ATA_OP_NULL             (void *)(unsigned long)(-ENOENT)
 788
 789 struct ata_port_operations {
 790         /*
 791          * Command execution
 792          */
 793         int  (*qc_defer)(struct ata_queued_cmd *qc);
 794         int  (*check_atapi_dma)(struct ata_queued_cmd *qc);
 795         void (*qc_prep)(struct ata_queued_cmd *qc);
 796         unsigned int (*qc_issue)(struct ata_queued_cmd *qc);
 797         bool (*qc_fill_rtf)(struct ata_queued_cmd *qc);
 798
 799         /*
 800          * Configuration and exception handling
 801          */
 802         int  (*cable_detect)(struct ata_port *ap);
 803         unsigned long (*mode_filter)(struct ata_device *dev, unsigned long xfer_mask);
 804         void (*set_piomode)(struct ata_port *ap, struct ata_device *dev);
 805         void (*set_dmamode)(struct ata_port *ap, struct ata_device *dev);
 806         int  (*set_mode)(struct ata_link *link, struct ata_device **r_failed_dev);
 807         unsigned int (*read_id)(struct ata_device *dev, struct ata_taskfile *tf, u16 *id);
 808
 809         void (*dev_config)(struct ata_device *dev);
 810
 811         void (*freeze)(struct ata_port *ap);
 812         void (*thaw)(struct ata_port *ap);
 813         ata_prereset_fn_t       prereset;
 814         ata_reset_fn_t          softreset;
 815         ata_reset_fn_t          hardreset;
 816         ata_postreset_fn_t      postreset;
 817         ata_prereset_fn_t       pmp_prereset;
 818         ata_reset_fn_t          pmp_softreset;
 819         ata_reset_fn_t          pmp_hardreset;
 820         ata_postreset_fn_t      pmp_postreset;
 821         void (*error_handler)(struct ata_port *ap);
 822         void (*lost_interrupt)(struct ata_port *ap);
 823         void (*post_internal_cmd)(struct ata_queued_cmd *qc);
 824
 825         /*
 826          * Optional features
 827          */
 828         int  (*scr_read)(struct ata_link *link, unsigned int sc_reg, u32 *val);
 829         int  (*scr_write)(struct ata_link *link, unsigned int sc_reg, u32 val);
 830         void (*pmp_attach)(struct ata_port *ap);
 831         void (*pmp_detach)(struct ata_port *ap);
 832         int  (*enable_pm)(struct ata_port *ap, enum link_pm policy);
 833         void (*disable_pm)(struct ata_port *ap);
 834
 835         /*
 836          * Start, stop, suspend and resume
 837          */
 838         int  (*port_suspend)(struct ata_port *ap, pm_message_t mesg);
 839         int  (*port_resume)(struct ata_port *ap);
 840         int  (*port_start)(struct ata_port *ap);
 841         void (*port_stop)(struct ata_port *ap);
 842         void (*host_stop)(struct ata_host *host);
 843
 844 #ifdef CONFIG_ATA_SFF
 845         /*
 846          * SFF / taskfile oriented ops
 847          */
 848         void (*sff_dev_select)(struct ata_port *ap, unsigned int device);
 849         void (*sff_set_devctl)(struct ata_port *ap, u8 ctl);
 850         u8   (*sff_check_status)(struct ata_port *ap);
 851         u8   (*sff_check_altstatus)(struct ata_port *ap);
 852         void (*sff_tf_load)(struct ata_port *ap, const struct ata_taskfile *tf);
 853         void (*sff_tf_read)(struct ata_port *ap, struct ata_taskfile *tf);
 854         void (*sff_exec_command)(struct ata_port *ap,
 855                                  const struct ata_taskfile *tf);
 856         unsigned int (*sff_data_xfer)(struct ata_device *dev,
 857                         unsigned char *buf, unsigned int buflen, int rw);
 858         void (*sff_irq_on)(struct ata_port *);
 859         bool (*sff_irq_check)(struct ata_port *);
 860         void (*sff_irq_clear)(struct ata_port *);
 861         void (*sff_drain_fifo)(struct ata_queued_cmd *qc);
 862
 863 #ifdef CONFIG_ATA_BMDMA
 864         void (*bmdma_setup)(struct ata_queued_cmd *qc);
 865         void (*bmdma_start)(struct ata_queued_cmd *qc);
 866         void (*bmdma_stop)(struct ata_queued_cmd *qc);
 867         u8   (*bmdma_status)(struct ata_port *ap);
 868 #endif /* CONFIG_ATA_BMDMA */
 869 #endif /* CONFIG_ATA_SFF */
 870
 871         ssize_t (*em_show)(struct ata_port *ap, char *buf);
 872         ssize_t (*em_store)(struct ata_port *ap, const char *message,
 873                             size_t size);
 874         ssize_t (*sw_activity_show)(struct ata_device *dev, char *buf);
 875         ssize_t (*sw_activity_store)(struct ata_device *dev,
 876                                      enum sw_activity val);
 877         /*
 878          * Obsolete
 879          */
 880         void (*phy_reset)(struct ata_port *ap);
 881         void (*eng_timeout)(struct ata_port *ap);
 882
 883         /*
 884          * ->inherits must be the last field and all the preceding
 885          * fields must be pointers.
 886          */
 887         const struct ata_port_operations        *inherits;
 888 };
 889
 890 struct ata_port_info {
 891         unsigned long           flags;
 892         unsigned long           link_flags;
 893         unsigned long           pio_mask;
 894         unsigned long           mwdma_mask;
 895         unsigned long           udma_mask;
 896         struct ata_port_operations *port_ops;
 897         void                    *private_data;
 898 };
 899
 900 struct ata_timing {
 901         unsigned short mode;            /* ATA mode */
 902         unsigned short setup;           /* t1 */
 903         unsigned short act8b;           /* t2 for 8-bit I/O */
 904         unsigned short rec8b;           /* t2i for 8-bit I/O */
 905         unsigned short cyc8b;           /* t0 for 8-bit I/O */
 906         unsigned short active;          /* t2 or tD */
 907         unsigned short recover;         /* t2i or tK */
 908         unsigned short dmack_hold;      /* tj */
 909         unsigned short cycle;           /* t0 */
 910         unsigned short udma;            /* t2CYCTYP/2 */
 911 };
 912
 913 /*
 914  * Core layer - drivers/ata/libata-core.c
 915  */
 916 extern const unsigned long sata_deb_timing_normal[];
 917 extern const unsigned long sata_deb_timing_hotplug[];
 918 extern const unsigned long sata_deb_timing_long[];
 919
 920 extern struct ata_port_operations ata_dummy_port_ops;
 921 extern const struct ata_port_info ata_dummy_port_info;
 922
 923 static inline const unsigned long *
 924 sata_ehc_deb_timing(struct ata_eh_context *ehc)
 925 {
 926         if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
 927                 return sata_deb_timing_hotplug;
 928         else
 929                 return sata_deb_timing_normal;
 930 }
 931
 932 static inline int ata_port_is_dummy(struct ata_port *ap)
 933 {
 934         return ap->ops == &ata_dummy_port_ops;
 935 }
 936
 937 extern int sata_set_spd(struct ata_link *link);
 938 extern int ata_std_prereset(struct ata_link *link, unsigned long deadline);
 939 extern int ata_wait_after_reset(struct ata_link *link, unsigned long deadline,
 940                                 int (*check_ready)(struct ata_link *link));
 941 extern int sata_link_debounce(struct ata_link *link,
 942                         const unsigned long *params, unsigned long deadline);
 943 extern int sata_link_resume(struct ata_link *link, const unsigned long *params,
 944                             unsigned long deadline);
 945 extern int sata_link_hardreset(struct ata_link *link,
 946                         const unsigned long *timing, unsigned long deadline,
 947                         bool *online, int (*check_ready)(struct ata_link *));
 948 extern int sata_std_hardreset(struct ata_link *link, unsigned int *class,
 949                               unsigned long deadline);
 950 extern void ata_std_postreset(struct ata_link *link, unsigned int *classes);
 951
 952 extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
 953 extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
 954                         const struct ata_port_info * const * ppi, int n_ports);
 955 extern int ata_slave_link_init(struct ata_port *ap);
 956 extern int ata_host_start(struct ata_host *host);
 957 extern int ata_host_register(struct ata_host *host,
 958                              struct scsi_host_template *sht);
 959 extern int ata_host_activate(struct ata_host *host, int irq,
 960                              irq_handler_t irq_handler, unsigned long irq_flags,
 961                              struct scsi_host_template *sht);
 962 extern void ata_host_detach(struct ata_host *host);
 963 extern void ata_host_init(struct ata_host *, struct device *,
 964                           unsigned long, struct ata_port_operations *);
 965 extern int ata_scsi_detect(struct scsi_host_template *sht);
 966 extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
 967 extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
 968 extern int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *dev,
 969                             int cmd, void __user *arg);
 970 extern void ata_sas_port_destroy(struct ata_port *);
 971 extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
 972                                            struct ata_port_info *, struct Scsi_Host *);
 973 extern int ata_sas_port_init(struct ata_port *);
 974 extern int ata_sas_port_start(struct ata_port *ap);
 975 extern void ata_sas_port_stop(struct ata_port *ap);
 976 extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
 977 extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
 978                             struct ata_port *ap);
 979 extern int sata_scr_valid(struct ata_link *link);
 980 extern int sata_scr_read(struct ata_link *link, int reg, u32 *val);
 981 extern int sata_scr_write(struct ata_link *link, int reg, u32 val);
 982 extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val);
 983 extern bool ata_link_online(struct ata_link *link);
 984 extern bool ata_link_offline(struct ata_link *link);
 985 #ifdef CONFIG_PM
 986 extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
 987 extern void ata_host_resume(struct ata_host *host);
 988 #endif
 989 extern int ata_ratelimit(void);
 990 extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
 991                              unsigned long interval, unsigned long timeout);
 992 extern int atapi_cmd_type(u8 opcode);
 993 extern void ata_tf_to_fis(const struct ata_taskfile *tf,
 994                           u8 pmp, int is_cmd, u8 *fis);
 995 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
 996 extern unsigned long ata_pack_xfermask(unsigned long pio_mask,
 997                         unsigned long mwdma_mask, unsigned long udma_mask);
 998 extern void ata_unpack_xfermask(unsigned long xfer_mask,
 999                         unsigned long *pio_mask, unsigned long *mwdma_mask,
1000                         unsigned long *udma_mask);
1001 extern u8 ata_xfer_mask2mode(unsigned long xfer_mask);
1002 extern unsigned long ata_xfer_mode2mask(u8 xfer_mode);
1003 extern int ata_xfer_mode2shift(unsigned long xfer_mode);
1004 extern const char *ata_mode_string(unsigned long xfer_mask);
1005 extern unsigned long ata_id_xfermask(const u16 *id);
1006 extern int ata_std_qc_defer(struct ata_queued_cmd *qc);
1007 extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
1008 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
1009                  unsigned int n_elem);
1010 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
1011 extern void ata_dev_disable(struct ata_device *adev);
1012 extern void ata_id_string(const u16 *id, unsigned char *s,
1013                           unsigned int ofs, unsigned int len);
1014 extern void ata_id_c_string(const u16 *id, unsigned char *s,
1015                             unsigned int ofs, unsigned int len);
1016 extern unsigned int ata_do_dev_read_id(struct ata_device *dev,
1017                                         struct ata_taskfile *tf, u16 *id);
1018 extern void ata_qc_complete(struct ata_queued_cmd *qc);
1019 extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active);
1020 extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
1021                               void (*done)(struct scsi_cmnd *));
1022 extern int ata_std_bios_param(struct scsi_device *sdev,
1023                               struct block_device *bdev,
1024                               sector_t capacity, int geom[]);
1025 extern int ata_scsi_slave_config(struct scsi_device *sdev);
1026 extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
1027 extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
1028                                        int queue_depth, int reason);
1029 extern struct ata_device *ata_dev_pair(struct ata_device *adev);
1030 extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
1031
1032 extern int ata_cable_40wire(struct ata_port *ap);
1033 extern int ata_cable_80wire(struct ata_port *ap);
1034 extern int ata_cable_sata(struct ata_port *ap);
1035 extern int ata_cable_ignore(struct ata_port *ap);
1036 extern int ata_cable_unknown(struct ata_port *ap);
1037
1038 /* Timing helpers */
1039 extern unsigned int ata_pio_need_iordy(const struct ata_device *);
1040 extern const struct ata_timing *ata_timing_find_mode(u8 xfer_mode);
1041 extern int ata_timing_compute(struct ata_device *, unsigned short,
1042                               struct ata_timing *, int, int);
1043 extern void ata_timing_merge(const struct ata_timing *,
1044                              const struct ata_timing *, struct ata_timing *,
1045                              unsigned int);
1046 extern u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle);
1047
1048 /* PCI */
1049 #ifdef CONFIG_PCI
1050 struct pci_dev;
1051
1052 struct pci_bits {
1053         unsigned int            reg;    /* PCI config register to read */
1054         unsigned int            width;  /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
1055         unsigned long           mask;
1056         unsigned long           val;
1057 };
1058
1059 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
1060 extern void ata_pci_remove_one(struct pci_dev *pdev);
1061
1062 #ifdef CONFIG_PM
1063 extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
1064 extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
1065 extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
1066 extern int ata_pci_device_resume(struct pci_dev *pdev);
1067 #endif /* CONFIG_PM */
1068 #endif /* CONFIG_PCI */
1069
1070 /*
1071  * ACPI - drivers/ata/libata-acpi.c
1072  */
1073 #ifdef CONFIG_ATA_ACPI
1074 static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1075 {
1076         if (ap->pflags & ATA_PFLAG_INIT_GTM_VALID)
1077                 return &ap->__acpi_init_gtm;
1078         return NULL;
1079 }
1080 int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm);
1081 int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *stm);
1082 unsigned long ata_acpi_gtm_xfermask(struct ata_device *dev,
1083                                     const struct ata_acpi_gtm *gtm);
1084 int ata_acpi_cbl_80wire(struct ata_port *ap, const struct ata_acpi_gtm *gtm);
1085 #else
1086 static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1087 {
1088         return NULL;
1089 }
1090
1091 static inline int ata_acpi_stm(const struct ata_port *ap,
1092                                struct ata_acpi_gtm *stm)
1093 {
1094         return -ENOSYS;
1095 }
1096
1097 static inline int ata_acpi_gtm(const struct ata_port *ap,
1098                                struct ata_acpi_gtm *stm)
1099 {
1100         return -ENOSYS;
1101 }
1102
1103 static inline unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev,
1104                                         const struct ata_acpi_gtm *gtm)
1105 {
1106         return 0;
1107 }
1108
1109 static inline int ata_acpi_cbl_80wire(struct ata_port *ap,
1110                                       const struct ata_acpi_gtm *gtm)
1111 {
1112         return 0;
1113 }
1114 #endif
1115
1116 /*
1117  * EH - drivers/ata/libata-eh.c
1118  */
1119 extern void ata_port_schedule_eh(struct ata_port *ap);
1120 extern int ata_link_abort(struct ata_link *link);
1121 extern int ata_port_abort(struct ata_port *ap);
1122 extern int ata_port_freeze(struct ata_port *ap);
1123 extern int sata_async_notification(struct ata_port *ap);
1124
1125 extern void ata_eh_freeze_port(struct ata_port *ap);
1126 extern void ata_eh_thaw_port(struct ata_port *ap);
1127
1128 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
1129 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
1130 extern void ata_eh_analyze_ncq_error(struct ata_link *link);
1131
1132 extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
1133                       ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
1134                       ata_postreset_fn_t postreset);
1135 extern void ata_std_error_handler(struct ata_port *ap);
1136
1137 /*
1138  * Base operations to inherit from and initializers for sht
1139  *
1140  * Operations
1141  *
1142  * base  : Common to all libata drivers.
1143  * sata  : SATA controllers w/ native interface.
1144  * pmp   : SATA controllers w/ PMP support.
1145  * sff   : SFF ATA controllers w/o BMDMA support.
1146  * bmdma : SFF ATA controllers w/ BMDMA support.
1147  *
1148  * sht initializers
1149  *
1150  * BASE  : Common to all libata drivers.  The user must set
1151  *         sg_tablesize and dma_boundary.
1152  * PIO   : SFF ATA controllers w/ only PIO support.
1153  * BMDMA : SFF ATA controllers w/ BMDMA support.  sg_tablesize and
1154  *         dma_boundary are set to BMDMA limits.
1155  * NCQ   : SATA controllers supporting NCQ.  The user must set
1156  *         sg_tablesize, dma_boundary and can_queue.
1157  */
1158 extern const struct ata_port_operations ata_base_port_ops;
1159 extern const struct ata_port_operations sata_port_ops;
1160 extern struct device_attribute *ata_common_sdev_attrs[];
1161
1162 #define ATA_BASE_SHT(drv_name)                                  \
1163         .module                 = THIS_MODULE,                  \
1164         .name                   = drv_name,                     \
1165         .ioctl                  = ata_scsi_ioctl,               \
1166         .queuecommand           = ata_scsi_queuecmd,            \
1167         .can_queue              = ATA_DEF_QUEUE,                \
1168         .this_id                = ATA_SHT_THIS_ID,              \
1169         .cmd_per_lun            = ATA_SHT_CMD_PER_LUN,          \
1170         .emulated               = ATA_SHT_EMULATED,             \
1171         .use_clustering         = ATA_SHT_USE_CLUSTERING,       \
1172         .proc_name              = drv_name,                     \
1173         .slave_configure        = ata_scsi_slave_config,        \
1174         .slave_destroy          = ata_scsi_slave_destroy,       \
1175         .bios_param             = ata_std_bios_param,           \
1176         .sdev_attrs             = ata_common_sdev_attrs
1177
1178 #define ATA_NCQ_SHT(drv_name)                                   \
1179         ATA_BASE_SHT(drv_name),                                 \
1180         .change_queue_depth     = ata_scsi_change_queue_depth
1181
1182 /*
1183  * PMP helpers
1184  */
1185 #ifdef CONFIG_SATA_PMP
1186 static inline bool sata_pmp_supported(struct ata_port *ap)
1187 {
1188         return ap->flags & ATA_FLAG_PMP;
1189 }
1190
1191 static inline bool sata_pmp_attached(struct ata_port *ap)
1192 {
1193         return ap->nr_pmp_links != 0;
1194 }
1195
1196 static inline int ata_is_host_link(const struct ata_link *link)
1197 {
1198         return link == &link->ap->link || link == link->ap->slave_link;
1199 }
1200 #else /* CONFIG_SATA_PMP */
1201 static inline bool sata_pmp_supported(struct ata_port *ap)
1202 {
1203         return false;
1204 }
1205
1206 static inline bool sata_pmp_attached(struct ata_port *ap)
1207 {
1208         return false;
1209 }
1210
1211 static inline int ata_is_host_link(const struct ata_link *link)
1212 {
1213         return 1;
1214 }
1215 #endif /* CONFIG_SATA_PMP */
1216
1217 static inline int sata_srst_pmp(struct ata_link *link)
1218 {
1219         if (sata_pmp_supported(link->ap) && ata_is_host_link(link))
1220                 return SATA_PMP_CTRL_PORT;
1221         return link->pmp;
1222 }
1223
1224 /*
1225  * printk helpers
1226  */
1227 #define ata_port_printk(ap, lv, fmt, args...) \
1228         printk("%sata%u: "fmt, lv, (ap)->print_id , ##args)
1229
1230 #define ata_link_printk(link, lv, fmt, args...) do { \
1231         if (sata_pmp_attached((link)->ap) || (link)->ap->slave_link)    \
1232                 printk("%sata%u.%02u: "fmt, lv, (link)->ap->print_id,   \
1233                        (link)->pmp , ##args); \
1234         else \
1235                 printk("%sata%u: "fmt, lv, (link)->ap->print_id , ##args); \
1236         } while(0)
1237
1238 #define ata_dev_printk(dev, lv, fmt, args...) \
1239         printk("%sata%u.%02u: "fmt, lv, (dev)->link->ap->print_id,      \
1240                (dev)->link->pmp + (dev)->devno , ##args)
1241
1242 /*
1243  * ata_eh_info helpers
1244  */
1245 extern void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...)
1246         __attribute__ ((format (printf, 2, 3)));
1247 extern void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...)
1248         __attribute__ ((format (printf, 2, 3)));
1249 extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
1250
1251 static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
1252 {
1253         ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
1254         ehi->flags |= ATA_EHI_HOTPLUGGED;
1255         ehi->action |= ATA_EH_RESET | ATA_EH_ENABLE_LINK;
1256         ehi->err_mask |= AC_ERR_ATA_BUS;
1257 }
1258
1259 /*
1260  * port description helpers
1261  */
1262 extern void ata_port_desc(struct ata_port *ap, const char *fmt, ...)
1263         __attribute__ ((format (printf, 2, 3)));
1264 #ifdef CONFIG_PCI
1265 extern void ata_port_pbar_desc(struct ata_port *ap, int bar, ssize_t offset,
1266                                const char *name);
1267 #endif
1268
1269 static inline unsigned int ata_tag_valid(unsigned int tag)
1270 {
1271         return (tag < ATA_MAX_QUEUE) ? 1 : 0;
1272 }
1273
1274 static inline unsigned int ata_tag_internal(unsigned int tag)
1275 {
1276         return tag == ATA_TAG_INTERNAL;
1277 }
1278
1279 /*
1280  * device helpers
1281  */
1282 static inline unsigned int ata_class_enabled(unsigned int class)
1283 {
1284         return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI ||
1285                 class == ATA_DEV_PMP || class == ATA_DEV_SEMB;
1286 }
1287
1288 static inline unsigned int ata_class_disabled(unsigned int class)
1289 {
1290         return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP ||
1291                 class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP;
1292 }
1293
1294 static inline unsigned int ata_class_absent(unsigned int class)
1295 {
1296         return !ata_class_enabled(class) && !ata_class_disabled(class);
1297 }
1298
1299 static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1300 {
1301         return ata_class_enabled(dev->class);
1302 }
1303
1304 static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1305 {
1306         return ata_class_disabled(dev->class);
1307 }
1308
1309 static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1310 {
1311         return ata_class_absent(dev->class);
1312 }
1313
1314 /*
1315  * link helpers
1316  */
1317 static inline int ata_link_max_devices(const struct ata_link *link)
1318 {
1319         if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS)
1320                 return 2;
1321         return 1;
1322 }
1323
1324 static inline int ata_link_active(struct ata_link *link)
1325 {
1326         return ata_tag_valid(link->active_tag) || link->sactive;
1327 }
1328
1329 /*
1330  * Iterators
1331  *
1332  * ATA_LITER_* constants are used to select link iteration mode and
1333  * ATA_DITER_* device iteration mode.
1334  *
1335  * For a custom iteration directly using ata_{link|dev}_next(), if
1336  * @link or @dev, respectively, is NULL, the first element is
1337  * returned.  @dev and @link can be any valid device or link and the
1338  * next element according to the iteration mode will be returned.
1339  * After the last element, NULL is returned.
1340  */
1341 enum ata_link_iter_mode {
1342         ATA_LITER_EDGE,         /* if present, PMP links only; otherwise,
1343                                  * host link.  no slave link */
1344         ATA_LITER_HOST_FIRST,   /* host link followed by PMP or slave links */
1345         ATA_LITER_PMP_FIRST,    /* PMP links followed by host link,
1346                                  * slave link still comes after host link */
1347 };
1348
1349 enum ata_dev_iter_mode {
1350         ATA_DITER_ENABLED,
1351         ATA_DITER_ENABLED_REVERSE,
1352         ATA_DITER_ALL,
1353         ATA_DITER_ALL_REVERSE,
1354 };
1355
1356 extern struct ata_link *ata_link_next(struct ata_link *link,
1357                                       struct ata_port *ap,
1358                                       enum ata_link_iter_mode mode);
1359
1360 extern struct ata_device *ata_dev_next(struct ata_device *dev,
1361                                        struct ata_link *link,
1362                                        enum ata_dev_iter_mode mode);
1363
1364 /*
1365  * Shortcut notation for iterations
1366  *
1367  * ata_for_each_link() iterates over each link of @ap according to
1368  * @mode.  @link points to the current link in the loop.  @link is
1369  * NULL after loop termination.  ata_for_each_dev() works the same way
1370  * except that it iterates over each device of @link.
1371  *
1372  * Note that the mode prefixes ATA_{L|D}ITER_ shouldn't need to be
1373  * specified when using the following shorthand notations.  Only the
1374  * mode itself (EDGE, HOST_FIRST, ENABLED, etc...) should be
1375  * specified.  This not only increases brevity but also makes it
1376  * impossible to use ATA_LITER_* for device iteration or vice-versa.
1377  */
1378 #define ata_for_each_link(link, ap, mode) \
1379         for ((link) = ata_link_next(NULL, (ap), ATA_LITER_##mode); (link); \
1380              (link) = ata_link_next((link), (ap), ATA_LITER_##mode))
1381
1382 #define ata_for_each_dev(dev, link, mode) \
1383         for ((dev) = ata_dev_next(NULL, (link), ATA_DITER_##mode); (dev); \
1384              (dev) = ata_dev_next((dev), (link), ATA_DITER_##mode))
1385
1386 /**
1387  *      ata_ncq_enabled - Test whether NCQ is enabled
1388  *      @dev: ATA device to test for
1389  *
1390  *      LOCKING:
1391  *      spin_lock_irqsave(host lock)
1392  *
1393  *      RETURNS:
1394  *      1 if NCQ is enabled for @dev, 0 otherwise.
1395  */
1396 static inline int ata_ncq_enabled(struct ata_device *dev)
1397 {
1398         return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1399                               ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1400 }
1401
1402 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1403 {
1404         qc->tf.ctl |= ATA_NIEN;
1405 }
1406
1407 static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1408                                                        unsigned int tag)
1409 {
1410         if (likely(ata_tag_valid(tag)))
1411                 return &ap->qcmd[tag];
1412         return NULL;
1413 }
1414
1415 static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1416                                                      unsigned int tag)
1417 {
1418         struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1419
1420         if (unlikely(!qc) || !ap->ops->error_handler)
1421                 return qc;
1422
1423         if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1424                           ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1425                 return qc;
1426
1427         return NULL;
1428 }
1429
1430 static inline unsigned int ata_qc_raw_nbytes(struct ata_queued_cmd *qc)
1431 {
1432         return qc->nbytes - min(qc->extrabytes, qc->nbytes);
1433 }
1434
1435 static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1436 {
1437         memset(tf, 0, sizeof(*tf));
1438
1439 #ifdef CONFIG_ATA_SFF
1440         tf->ctl = dev->link->ap->ctl;
1441 #else
1442         tf->ctl = ATA_DEVCTL_OBS;
1443 #endif
1444         if (dev->devno == 0)
1445                 tf->device = ATA_DEVICE_OBS;
1446         else
1447                 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1448 }
1449
1450 static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1451 {
1452         qc->dma_dir = DMA_NONE;
1453         qc->sg = NULL;
1454         qc->flags = 0;
1455         qc->cursg = NULL;
1456         qc->cursg_ofs = 0;
1457         qc->nbytes = qc->extrabytes = qc->curbytes = 0;
1458         qc->n_elem = 0;
1459         qc->err_mask = 0;
1460         qc->sect_size = ATA_SECT_SIZE;
1461
1462         ata_tf_init(qc->dev, &qc->tf);
1463
1464         /* init result_tf such that it indicates normal completion */
1465         qc->result_tf.command = ATA_DRDY;
1466         qc->result_tf.feature = 0;
1467 }
1468
1469 static inline int ata_try_flush_cache(const struct ata_device *dev)
1470 {
1471         return ata_id_wcache_enabled(dev->id) ||
1472                ata_id_has_flush(dev->id) ||
1473                ata_id_has_flush_ext(dev->id);
1474 }
1475
1476 static inline unsigned int ac_err_mask(u8 status)
1477 {
1478         if (status & (ATA_BUSY | ATA_DRQ))
1479                 return AC_ERR_HSM;
1480         if (status & (ATA_ERR | ATA_DF))
1481                 return AC_ERR_DEV;
1482         return 0;
1483 }
1484
1485 static inline unsigned int __ac_err_mask(u8 status)
1486 {
1487         unsigned int mask = ac_err_mask(status);
1488         if (mask == 0)
1489                 return AC_ERR_OTHER;
1490         return mask;
1491 }
1492
1493 static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1494 {
1495         return *(struct ata_port **)&host->hostdata[0];
1496 }
1497
1498 static inline int ata_check_ready(u8 status)
1499 {
1500         if (!(status & ATA_BUSY))
1501                 return 1;
1502
1503         /* 0xff indicates either no device or device not ready */
1504         if (status == 0xff)
1505                 return -ENODEV;
1506
1507         return 0;
1508 }
1509
1510 static inline unsigned long ata_deadline(unsigned long from_jiffies,
1511                                          unsigned long timeout_msecs)
1512 {
1513         return from_jiffies + msecs_to_jiffies(timeout_msecs);
1514 }
1515
1516 /* Don't open code these in drivers as there are traps. Firstly the range may
1517    change in future hardware and specs, secondly 0xFF means 'no DMA' but is
1518    > UDMA_0. Dyma ddreigiau */
1519
1520 static inline int ata_using_mwdma(struct ata_device *adev)
1521 {
1522         if (adev->dma_mode >= XFER_MW_DMA_0 && adev->dma_mode <= XFER_MW_DMA_4)
1523                 return 1;
1524         return 0;
1525 }
1526
1527 static inline int ata_using_udma(struct ata_device *adev)
1528 {
1529         if (adev->dma_mode >= XFER_UDMA_0 && adev->dma_mode <= XFER_UDMA_7)
1530                 return 1;
1531         return 0;
1532 }
1533
1534 static inline int ata_dma_enabled(struct ata_device *adev)
1535 {
1536         return (adev->dma_mode == 0xFF ? 0 : 1);
1537 }
1538
1539 /**************************************************************************
1540  * PMP - drivers/ata/libata-pmp.c
1541  */
1542 #ifdef CONFIG_SATA_PMP
1543
1544 extern const struct ata_port_operations sata_pmp_port_ops;
1545
1546 extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc);
1547 extern void sata_pmp_error_handler(struct ata_port *ap);
1548
1549 #else /* CONFIG_SATA_PMP */
1550
1551 #define sata_pmp_port_ops               sata_port_ops
1552 #define sata_pmp_qc_defer_cmd_switch    ata_std_qc_defer
1553 #define sata_pmp_error_handler          ata_std_error_handler
1554
1555 #endif /* CONFIG_SATA_PMP */
1556
1557
1558 /**************************************************************************
1559  * SFF - drivers/ata/libata-sff.c
1560  */
1561 #ifdef CONFIG_ATA_SFF
1562
1563 extern const struct ata_port_operations ata_sff_port_ops;
1564 extern const struct ata_port_operations ata_bmdma32_port_ops;
1565
1566 /* PIO only, sg_tablesize and dma_boundary limits can be removed */
1567 #define ATA_PIO_SHT(drv_name)                                   \
1568         ATA_BASE_SHT(drv_name),                                 \
1569         .sg_tablesize           = LIBATA_MAX_PRD,               \
1570         .dma_boundary           = ATA_DMA_BOUNDARY
1571
1572 extern void ata_sff_dev_select(struct ata_port *ap, unsigned int device);
1573 extern u8 ata_sff_check_status(struct ata_port *ap);
1574 extern void ata_sff_pause(struct ata_port *ap);
1575 extern void ata_sff_dma_pause(struct ata_port *ap);
1576 extern int ata_sff_busy_sleep(struct ata_port *ap,
1577                               unsigned long timeout_pat, unsigned long timeout);
1578 extern int ata_sff_wait_ready(struct ata_link *link, unsigned long deadline);
1579 extern void ata_sff_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
1580 extern void ata_sff_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
1581 extern void ata_sff_exec_command(struct ata_port *ap,
1582                                  const struct ata_taskfile *tf);
1583 extern unsigned int ata_sff_data_xfer(struct ata_device *dev,
1584                         unsigned char *buf, unsigned int buflen, int rw);
1585 extern unsigned int ata_sff_data_xfer32(struct ata_device *dev,
1586                         unsigned char *buf, unsigned int buflen, int rw);
1587 extern unsigned int ata_sff_data_xfer_noirq(struct ata_device *dev,
1588                         unsigned char *buf, unsigned int buflen, int rw);
1589 extern void ata_sff_irq_on(struct ata_port *ap);
1590 extern void ata_sff_irq_clear(struct ata_port *ap);
1591 extern int ata_sff_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
1592                             u8 status, int in_wq);
1593 extern void ata_sff_queue_pio_task(struct ata_port *ap, unsigned long delay);
1594 extern unsigned int ata_sff_qc_issue(struct ata_queued_cmd *qc);
1595 extern bool ata_sff_qc_fill_rtf(struct ata_queued_cmd *qc);
1596 extern unsigned int ata_sff_port_intr(struct ata_port *ap,
1597                                       struct ata_queued_cmd *qc);
1598 extern irqreturn_t ata_sff_interrupt(int irq, void *dev_instance);
1599 extern void ata_sff_lost_interrupt(struct ata_port *ap);
1600 extern void ata_sff_freeze(struct ata_port *ap);
1601 extern void ata_sff_thaw(struct ata_port *ap);
1602 extern int ata_sff_prereset(struct ata_link *link, unsigned long deadline);
1603 extern unsigned int ata_sff_dev_classify(struct ata_device *dev, int present,
1604                                           u8 *r_err);
1605 extern int ata_sff_wait_after_reset(struct ata_link *link, unsigned int devmask,
1606                                     unsigned long deadline);
1607 extern int ata_sff_softreset(struct ata_link *link, unsigned int *classes,
1608                              unsigned long deadline);
1609 extern int sata_sff_hardreset(struct ata_link *link, unsigned int *class,
1610                                unsigned long deadline);
1611 extern void ata_sff_postreset(struct ata_link *link, unsigned int *classes);
1612 extern void ata_sff_drain_fifo(struct ata_queued_cmd *qc);
1613 extern void ata_sff_error_handler(struct ata_port *ap);
1614 extern void ata_sff_std_ports(struct ata_ioports *ioaddr);
1615 #ifdef CONFIG_PCI
1616 extern int ata_pci_sff_init_host(struct ata_host *host);
1617 extern int ata_pci_sff_prepare_host(struct pci_dev *pdev,
1618                                     const struct ata_port_info * const * ppi,
1619                                     struct ata_host **r_host);
1620 extern int ata_pci_sff_activate_host(struct ata_host *host,
1621                                      irq_handler_t irq_handler,
1622                                      struct scsi_host_template *sht);
1623 extern int ata_pci_sff_init_one(struct pci_dev *pdev,
1624                 const struct ata_port_info * const * ppi,
1625                 struct scsi_host_template *sht, void *host_priv, int hflags);
1626 #endif /* CONFIG_PCI */
1627
1628 #ifdef CONFIG_ATA_BMDMA
1629
1630 extern const struct ata_port_operations ata_bmdma_port_ops;
1631
1632 #define ATA_BMDMA_SHT(drv_name)                                 \
1633         ATA_BASE_SHT(drv_name),                                 \
1634         .sg_tablesize           = LIBATA_MAX_PRD,               \
1635         .dma_boundary           = ATA_DMA_BOUNDARY
1636
1637 extern void ata_bmdma_qc_prep(struct ata_queued_cmd *qc);
1638 extern unsigned int ata_bmdma_qc_issue(struct ata_queued_cmd *qc);
1639 extern void ata_bmdma_dumb_qc_prep(struct ata_queued_cmd *qc);
1640 extern unsigned int ata_bmdma_port_intr(struct ata_port *ap,
1641                                       struct ata_queued_cmd *qc);
1642 extern irqreturn_t ata_bmdma_interrupt(int irq, void *dev_instance);
1643 extern void ata_bmdma_error_handler(struct ata_port *ap);
1644 extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
1645 extern void ata_bmdma_irq_clear(struct ata_port *ap);
1646 extern void ata_bmdma_setup(struct ata_queued_cmd *qc);
1647 extern void ata_bmdma_start(struct ata_queued_cmd *qc);
1648 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
1649 extern u8 ata_bmdma_status(struct ata_port *ap);
1650 extern int ata_bmdma_port_start(struct ata_port *ap);
1651 extern int ata_bmdma_port_start32(struct ata_port *ap);
1652
1653 #ifdef CONFIG_PCI
1654 extern int ata_pci_bmdma_clear_simplex(struct pci_dev *pdev);
1655 extern void ata_pci_bmdma_init(struct ata_host *host);
1656 extern int ata_pci_bmdma_prepare_host(struct pci_dev *pdev,
1657                                       const struct ata_port_info * const * ppi,
1658                                       struct ata_host **r_host);
1659 extern int ata_pci_bmdma_init_one(struct pci_dev *pdev,
1660                                   const struct ata_port_info * const * ppi,
1661                                   struct scsi_host_template *sht,
1662                                   void *host_priv, int hflags);
1663 #endif /* CONFIG_PCI */
1664 #endif /* CONFIG_ATA_BMDMA */
1665
1666 /**
1667  *      ata_sff_busy_wait - Wait for a port status register
1668  *      @ap: Port to wait for.
1669  *      @bits: bits that must be clear
1670  *      @max: number of 10uS waits to perform
1671  *
1672  *      Waits up to max*10 microseconds for the selected bits in the port's
1673  *      status register to be cleared.
1674  *      Returns final value of status register.
1675  *
1676  *      LOCKING:
1677  *      Inherited from caller.
1678  */
1679 static inline u8 ata_sff_busy_wait(struct ata_port *ap, unsigned int bits,
1680                                    unsigned int max)
1681 {
1682         u8 status;
1683
1684         do {
1685                 udelay(10);
1686                 status = ap->ops->sff_check_status(ap);
1687                 max--;
1688         } while (status != 0xff && (status & bits) && (max > 0));
1689
1690         return status;
1691 }
1692
1693 /**
1694  *      ata_wait_idle - Wait for a port to be idle.
1695  *      @ap: Port to wait for.
1696  *
1697  *      Waits up to 10ms for port's BUSY and DRQ signals to clear.
1698  *      Returns final value of status register.
1699  *
1700  *      LOCKING:
1701  *      Inherited from caller.
1702  */
1703 static inline u8 ata_wait_idle(struct ata_port *ap)
1704 {
1705         u8 status = ata_sff_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1706
1707 #ifdef ATA_DEBUG
1708         if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
1709                 ata_port_printk(ap, KERN_DEBUG, "abnormal Status 0x%X\n",
1710                                 status);
1711 #endif
1712
1713         return status;
1714 }
1715 #endif /* CONFIG_ATA_SFF */
1716
1717 #endif /* __LINUX_LIBATA_H__ */