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