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