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