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