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