include/linux/libata.h

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