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