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_DB_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, u16 *id);
 888
 889         void (*dev_config)(struct ata_device *dev);
 890
 891         void (*freeze)(struct ata_port *ap);
 892         void (*thaw)(struct ata_port *ap);
 893         ata_prereset_fn_t       prereset;
 894         ata_reset_fn_t          softreset;
 895         ata_reset_fn_t          hardreset;
 896         ata_postreset_fn_t      postreset;
 897         ata_prereset_fn_t       pmp_prereset;
 898         ata_reset_fn_t          pmp_softreset;
 899         ata_reset_fn_t          pmp_hardreset;
 900         ata_postreset_fn_t      pmp_postreset;
 901         void (*error_handler)(struct ata_port *ap);
 902         void (*lost_interrupt)(struct ata_port *ap);
 903         void (*post_internal_cmd)(struct ata_queued_cmd *qc);
 904         void (*sched_eh)(struct ata_port *ap);
 905         void (*end_eh)(struct ata_port *ap);
 906
 907         /*
 908          * Optional features
 909          */
 910         int  (*scr_read)(struct ata_link *link, unsigned int sc_reg, u32 *val);
 911         int  (*scr_write)(struct ata_link *link, unsigned int sc_reg, u32 val);
 912         void (*pmp_attach)(struct ata_port *ap);
 913         void (*pmp_detach)(struct ata_port *ap);
 914         int  (*set_lpm)(struct ata_link *link, enum ata_lpm_policy policy,
 915                         unsigned hints);
 916
 917         /*
 918          * Start, stop, suspend and resume
 919          */
 920         int  (*port_suspend)(struct ata_port *ap, pm_message_t mesg);
 921         int  (*port_resume)(struct ata_port *ap);
 922         int  (*port_start)(struct ata_port *ap);
 923         void (*port_stop)(struct ata_port *ap);
 924         void (*host_stop)(struct ata_host *host);
 925
 926 #ifdef CONFIG_ATA_SFF
 927         /*
 928          * SFF / taskfile oriented ops
 929          */
 930         void (*sff_dev_select)(struct ata_port *ap, unsigned int device);
 931         void (*sff_set_devctl)(struct ata_port *ap, u8 ctl);
 932         u8   (*sff_check_status)(struct ata_port *ap);
 933         u8   (*sff_check_altstatus)(struct ata_port *ap);
 934         void (*sff_tf_load)(struct ata_port *ap, const struct ata_taskfile *tf);
 935         void (*sff_tf_read)(struct ata_port *ap, struct ata_taskfile *tf);
 936         void (*sff_exec_command)(struct ata_port *ap,
 937                                  const struct ata_taskfile *tf);
 938         unsigned int (*sff_data_xfer)(struct ata_queued_cmd *qc,
 939                         unsigned char *buf, unsigned int buflen, int rw);
 940         void (*sff_irq_on)(struct ata_port *);
 941         bool (*sff_irq_check)(struct ata_port *);
 942         void (*sff_irq_clear)(struct ata_port *);
 943         void (*sff_drain_fifo)(struct ata_queued_cmd *qc);
 944
 945 #ifdef CONFIG_ATA_BMDMA
 946         void (*bmdma_setup)(struct ata_queued_cmd *qc);
 947         void (*bmdma_start)(struct ata_queued_cmd *qc);
 948         void (*bmdma_stop)(struct ata_queued_cmd *qc);
 949         u8   (*bmdma_status)(struct ata_port *ap);
 950 #endif /* CONFIG_ATA_BMDMA */
 951 #endif /* CONFIG_ATA_SFF */
 952
 953         ssize_t (*em_show)(struct ata_port *ap, char *buf);
 954         ssize_t (*em_store)(struct ata_port *ap, const char *message,
 955                             size_t size);
 956         ssize_t (*sw_activity_show)(struct ata_device *dev, char *buf);
 957         ssize_t (*sw_activity_store)(struct ata_device *dev,
 958                                      enum sw_activity val);
 959         ssize_t (*transmit_led_message)(struct ata_port *ap, u32 state,
 960                                         ssize_t size);
 961
 962         /*
 963          * Obsolete
 964          */
 965         void (*phy_reset)(struct ata_port *ap);
 966         void (*eng_timeout)(struct ata_port *ap);
 967
 968         /*
 969          * ->inherits must be the last field and all the preceding
 970          * fields must be pointers.
 971          */
 972         const struct ata_port_operations        *inherits;
 973 };
 974
 975 struct ata_port_info {
 976         unsigned long           flags;
 977         unsigned long           link_flags;
 978         unsigned long           pio_mask;
 979         unsigned long           mwdma_mask;
 980         unsigned long           udma_mask;
 981         struct ata_port_operations *port_ops;
 982         void                    *private_data;
 983 };
 984
 985 struct ata_timing {
 986         unsigned short mode;            /* ATA mode */
 987         unsigned short setup;           /* t1 */
 988         unsigned short act8b;           /* t2 for 8-bit I/O */
 989         unsigned short rec8b;           /* t2i for 8-bit I/O */
 990         unsigned short cyc8b;           /* t0 for 8-bit I/O */
 991         unsigned short active;          /* t2 or tD */
 992         unsigned short recover;         /* t2i or tK */
 993         unsigned short dmack_hold;      /* tj */
 994         unsigned short cycle;           /* t0 */
 995         unsigned short udma;            /* t2CYCTYP/2 */
 996 };
 997
 998 /*
 999  * Core layer - drivers/ata/libata-core.c
1000  */
1001 extern struct ata_port_operations ata_dummy_port_ops;
1002 extern const struct ata_port_info ata_dummy_port_info;
1003
1004 static inline bool ata_is_atapi(u8 prot)
1005 {
1006         return prot & ATA_PROT_FLAG_ATAPI;
1007 }
1008
1009 static inline bool ata_is_pio(u8 prot)
1010 {
1011         return prot & ATA_PROT_FLAG_PIO;
1012 }
1013
1014 static inline bool ata_is_dma(u8 prot)
1015 {
1016         return prot & ATA_PROT_FLAG_DMA;
1017 }
1018
1019 static inline bool ata_is_ncq(u8 prot)
1020 {
1021         return prot & ATA_PROT_FLAG_NCQ;
1022 }
1023
1024 static inline bool ata_is_data(u8 prot)
1025 {
1026         return prot & (ATA_PROT_FLAG_PIO | ATA_PROT_FLAG_DMA);
1027 }
1028
1029 static inline int is_multi_taskfile(struct ata_taskfile *tf)
1030 {
1031         return (tf->command == ATA_CMD_READ_MULTI) ||
1032                (tf->command == ATA_CMD_WRITE_MULTI) ||
1033                (tf->command == ATA_CMD_READ_MULTI_EXT) ||
1034                (tf->command == ATA_CMD_WRITE_MULTI_EXT) ||
1035                (tf->command == ATA_CMD_WRITE_MULTI_FUA_EXT);
1036 }
1037
1038 static inline int ata_port_is_dummy(struct ata_port *ap)
1039 {
1040         return ap->ops == &ata_dummy_port_ops;
1041 }
1042
1043 extern int ata_std_prereset(struct ata_link *link, unsigned long deadline);
1044 extern int ata_wait_after_reset(struct ata_link *link, unsigned long deadline,
1045                                 int (*check_ready)(struct ata_link *link));
1046 extern int sata_std_hardreset(struct ata_link *link, unsigned int *class,
1047                               unsigned long deadline);
1048 extern void ata_std_postreset(struct ata_link *link, unsigned int *classes);
1049
1050 extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
1051 extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
1052                         const struct ata_port_info * const * ppi, int n_ports);
1053 extern void ata_host_get(struct ata_host *host);
1054 extern void ata_host_put(struct ata_host *host);
1055 extern int ata_host_start(struct ata_host *host);
1056 extern int ata_host_register(struct ata_host *host,
1057                              struct scsi_host_template *sht);
1058 extern int ata_host_activate(struct ata_host *host, int irq,
1059                              irq_handler_t irq_handler, unsigned long irq_flags,
1060                              struct scsi_host_template *sht);
1061 extern void ata_host_detach(struct ata_host *host);
1062 extern void ata_host_init(struct ata_host *, struct device *, struct ata_port_operations *);
1063 extern int ata_scsi_detect(struct scsi_host_template *sht);
1064 extern int ata_scsi_ioctl(struct scsi_device *dev, unsigned int cmd,
1065                           void __user *arg);
1066 #ifdef CONFIG_COMPAT
1067 #define ATA_SCSI_COMPAT_IOCTL .compat_ioctl = ata_scsi_ioctl,
1068 #else
1069 #define ATA_SCSI_COMPAT_IOCTL /* empty */
1070 #endif
1071 extern int ata_scsi_queuecmd(struct Scsi_Host *h, struct scsi_cmnd *cmd);
1072 #if IS_REACHABLE(CONFIG_ATA)
1073 bool ata_scsi_dma_need_drain(struct request *rq);
1074 #else
1075 #define ata_scsi_dma_need_drain NULL
1076 #endif
1077 extern int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *dev,
1078                             unsigned int cmd, void __user *arg);
1079 extern bool ata_link_online(struct ata_link *link);
1080 extern bool ata_link_offline(struct ata_link *link);
1081 #ifdef CONFIG_PM
1082 extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
1083 extern void ata_host_resume(struct ata_host *host);
1084 extern void ata_sas_port_suspend(struct ata_port *ap);
1085 extern void ata_sas_port_resume(struct ata_port *ap);
1086 #else
1087 static inline void ata_sas_port_suspend(struct ata_port *ap)
1088 {
1089 }
1090 static inline void ata_sas_port_resume(struct ata_port *ap)
1091 {
1092 }
1093 #endif
1094 extern int ata_ratelimit(void);
1095 extern void ata_msleep(struct ata_port *ap, unsigned int msecs);
1096 extern u32 ata_wait_register(struct ata_port *ap, void __iomem *reg, u32 mask,
1097                         u32 val, unsigned long interval, unsigned long timeout);
1098 extern int atapi_cmd_type(u8 opcode);
1099 extern unsigned long ata_pack_xfermask(unsigned long pio_mask,
1100                         unsigned long mwdma_mask, unsigned long udma_mask);
1101 extern void ata_unpack_xfermask(unsigned long xfer_mask,
1102                         unsigned long *pio_mask, unsigned long *mwdma_mask,
1103                         unsigned long *udma_mask);
1104 extern u8 ata_xfer_mask2mode(unsigned long xfer_mask);
1105 extern unsigned long ata_xfer_mode2mask(u8 xfer_mode);
1106 extern int ata_xfer_mode2shift(unsigned long xfer_mode);
1107 extern const char *ata_mode_string(unsigned long xfer_mask);
1108 extern unsigned long ata_id_xfermask(const u16 *id);
1109 extern int ata_std_qc_defer(struct ata_queued_cmd *qc);
1110 extern enum ata_completion_errors ata_noop_qc_prep(struct ata_queued_cmd *qc);
1111 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
1112                  unsigned int n_elem);
1113 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
1114 extern unsigned int ata_port_classify(struct ata_port *ap,
1115                                       const struct ata_taskfile *tf);
1116 extern void ata_dev_disable(struct ata_device *adev);
1117 extern void ata_id_string(const u16 *id, unsigned char *s,
1118                           unsigned int ofs, unsigned int len);
1119 extern void ata_id_c_string(const u16 *id, unsigned char *s,
1120                             unsigned int ofs, unsigned int len);
1121 extern unsigned int ata_do_dev_read_id(struct ata_device *dev,
1122                                         struct ata_taskfile *tf, u16 *id);
1123 extern void ata_qc_complete(struct ata_queued_cmd *qc);
1124 extern u64 ata_qc_get_active(struct ata_port *ap);
1125 extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd);
1126 extern int ata_std_bios_param(struct scsi_device *sdev,
1127                               struct block_device *bdev,
1128                               sector_t capacity, int geom[]);
1129 extern void ata_scsi_unlock_native_capacity(struct scsi_device *sdev);
1130 extern int ata_scsi_slave_config(struct scsi_device *sdev);
1131 extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
1132 extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
1133                                        int queue_depth);
1134 extern int __ata_change_queue_depth(struct ata_port *ap, struct scsi_device *sdev,
1135                                     int queue_depth);
1136 extern struct ata_device *ata_dev_pair(struct ata_device *adev);
1137 extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
1138 extern void ata_scsi_port_error_handler(struct Scsi_Host *host, struct ata_port *ap);
1139 extern void ata_scsi_cmd_error_handler(struct Scsi_Host *host, struct ata_port *ap, struct list_head *eh_q);
1140
1141 /*
1142  * SATA specific code - drivers/ata/libata-sata.c
1143  */
1144 #ifdef CONFIG_SATA_HOST
1145 extern const unsigned long sata_deb_timing_normal[];
1146 extern const unsigned long sata_deb_timing_hotplug[];
1147 extern const unsigned long sata_deb_timing_long[];
1148
1149 static inline const unsigned long *
1150 sata_ehc_deb_timing(struct ata_eh_context *ehc)
1151 {
1152         if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
1153                 return sata_deb_timing_hotplug;
1154         else
1155                 return sata_deb_timing_normal;
1156 }
1157
1158 extern int sata_scr_valid(struct ata_link *link);
1159 extern int sata_scr_read(struct ata_link *link, int reg, u32 *val);
1160 extern int sata_scr_write(struct ata_link *link, int reg, u32 val);
1161 extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val);
1162 extern int sata_set_spd(struct ata_link *link);
1163 extern int sata_link_hardreset(struct ata_link *link,
1164                         const unsigned long *timing, unsigned long deadline,
1165                         bool *online, int (*check_ready)(struct ata_link *));
1166 extern int sata_link_resume(struct ata_link *link, const unsigned long *params,
1167                             unsigned long deadline);
1168 extern void ata_eh_analyze_ncq_error(struct ata_link *link);
1169 #else
1170 static inline const unsigned long *
1171 sata_ehc_deb_timing(struct ata_eh_context *ehc)
1172 {
1173         return NULL;
1174 }
1175 static inline int sata_scr_valid(struct ata_link *link) { return 0; }
1176 static inline int sata_scr_read(struct ata_link *link, int reg, u32 *val)
1177 {
1178         return -EOPNOTSUPP;
1179 }
1180 static inline int sata_scr_write(struct ata_link *link, int reg, u32 val)
1181 {
1182         return -EOPNOTSUPP;
1183 }
1184 static inline int sata_scr_write_flush(struct ata_link *link, int reg, u32 val)
1185 {
1186         return -EOPNOTSUPP;
1187 }
1188 static inline int sata_set_spd(struct ata_link *link) { return -EOPNOTSUPP; }
1189 static inline int sata_link_hardreset(struct ata_link *link,
1190                                       const unsigned long *timing,
1191                                       unsigned long deadline,
1192                                       bool *online,
1193                                       int (*check_ready)(struct ata_link *))
1194 {
1195         if (online)
1196                 *online = false;
1197         return -EOPNOTSUPP;
1198 }
1199 static inline int sata_link_resume(struct ata_link *link,
1200                                    const unsigned long *params,
1201                                    unsigned long deadline)
1202 {
1203         return -EOPNOTSUPP;
1204 }
1205 static inline void ata_eh_analyze_ncq_error(struct ata_link *link) { }
1206 #endif
1207 extern int sata_link_debounce(struct ata_link *link,
1208                         const unsigned long *params, unsigned long deadline);
1209 extern int sata_link_scr_lpm(struct ata_link *link, enum ata_lpm_policy policy,
1210                              bool spm_wakeup);
1211 extern int ata_slave_link_init(struct ata_port *ap);
1212 extern void ata_sas_port_destroy(struct ata_port *);
1213 extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
1214                                            struct ata_port_info *, struct Scsi_Host *);
1215 extern void ata_sas_async_probe(struct ata_port *ap);
1216 extern int ata_sas_sync_probe(struct ata_port *ap);
1217 extern int ata_sas_port_init(struct ata_port *);
1218 extern int ata_sas_port_start(struct ata_port *ap);
1219 extern int ata_sas_tport_add(struct device *parent, struct ata_port *ap);
1220 extern void ata_sas_tport_delete(struct ata_port *ap);
1221 extern void ata_sas_port_stop(struct ata_port *ap);
1222 extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
1223 extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, struct ata_port *ap);
1224 extern void ata_tf_to_fis(const struct ata_taskfile *tf,
1225                           u8 pmp, int is_cmd, u8 *fis);
1226 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
1227 extern int ata_qc_complete_multiple(struct ata_port *ap, u64 qc_active);
1228 extern bool sata_lpm_ignore_phy_events(struct ata_link *link);
1229 extern int sata_async_notification(struct ata_port *ap);
1230
1231 extern int ata_cable_40wire(struct ata_port *ap);
1232 extern int ata_cable_80wire(struct ata_port *ap);
1233 extern int ata_cable_sata(struct ata_port *ap);
1234 extern int ata_cable_ignore(struct ata_port *ap);
1235 extern int ata_cable_unknown(struct ata_port *ap);
1236
1237 /* Timing helpers */
1238 extern unsigned int ata_pio_need_iordy(const struct ata_device *);
1239 extern u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle);
1240
1241 /* PCI */
1242 #ifdef CONFIG_PCI
1243 struct pci_dev;
1244
1245 struct pci_bits {
1246         unsigned int            reg;    /* PCI config register to read */
1247         unsigned int            width;  /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
1248         unsigned long           mask;
1249         unsigned long           val;
1250 };
1251
1252 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
1253 extern void ata_pci_shutdown_one(struct pci_dev *pdev);
1254 extern void ata_pci_remove_one(struct pci_dev *pdev);
1255
1256 #ifdef CONFIG_PM
1257 extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
1258 extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
1259 extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
1260 extern int ata_pci_device_resume(struct pci_dev *pdev);
1261 #endif /* CONFIG_PM */
1262 #endif /* CONFIG_PCI */
1263
1264 struct platform_device;
1265
1266 extern int ata_platform_remove_one(struct platform_device *pdev);
1267
1268 /*
1269  * ACPI - drivers/ata/libata-acpi.c
1270  */
1271 #ifdef CONFIG_ATA_ACPI
1272 static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1273 {
1274         if (ap->pflags & ATA_PFLAG_INIT_GTM_VALID)
1275                 return &ap->__acpi_init_gtm;
1276         return NULL;
1277 }
1278 int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm);
1279 int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *stm);
1280 unsigned long ata_acpi_gtm_xfermask(struct ata_device *dev,
1281                                     const struct ata_acpi_gtm *gtm);
1282 int ata_acpi_cbl_80wire(struct ata_port *ap, const struct ata_acpi_gtm *gtm);
1283 #else
1284 static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1285 {
1286         return NULL;
1287 }
1288
1289 static inline int ata_acpi_stm(const struct ata_port *ap,
1290                                struct ata_acpi_gtm *stm)
1291 {
1292         return -ENOSYS;
1293 }
1294
1295 static inline int ata_acpi_gtm(const struct ata_port *ap,
1296                                struct ata_acpi_gtm *stm)
1297 {
1298         return -ENOSYS;
1299 }
1300
1301 static inline unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev,
1302                                         const struct ata_acpi_gtm *gtm)
1303 {
1304         return 0;
1305 }
1306
1307 static inline int ata_acpi_cbl_80wire(struct ata_port *ap,
1308                                       const struct ata_acpi_gtm *gtm)
1309 {
1310         return 0;
1311 }
1312 #endif
1313
1314 /*
1315  * EH - drivers/ata/libata-eh.c
1316  */
1317 extern void ata_port_schedule_eh(struct ata_port *ap);
1318 extern void ata_port_wait_eh(struct ata_port *ap);
1319 extern int ata_link_abort(struct ata_link *link);
1320 extern int ata_port_abort(struct ata_port *ap);
1321 extern int ata_port_freeze(struct ata_port *ap);
1322
1323 extern void ata_eh_freeze_port(struct ata_port *ap);
1324 extern void ata_eh_thaw_port(struct ata_port *ap);
1325
1326 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
1327 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
1328
1329 extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
1330                       ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
1331                       ata_postreset_fn_t postreset);
1332 extern void ata_std_error_handler(struct ata_port *ap);
1333 extern void ata_std_sched_eh(struct ata_port *ap);
1334 extern void ata_std_end_eh(struct ata_port *ap);
1335 extern int ata_link_nr_enabled(struct ata_link *link);
1336
1337 /*
1338  * Base operations to inherit from and initializers for sht
1339  *
1340  * Operations
1341  *
1342  * base  : Common to all libata drivers.
1343  * sata  : SATA controllers w/ native interface.
1344  * pmp   : SATA controllers w/ PMP support.
1345  * sff   : SFF ATA controllers w/o BMDMA support.
1346  * bmdma : SFF ATA controllers w/ BMDMA support.
1347  *
1348  * sht initializers
1349  *
1350  * BASE  : Common to all libata drivers.  The user must set
1351  *         sg_tablesize and dma_boundary.
1352  * PIO   : SFF ATA controllers w/ only PIO support.
1353  * BMDMA : SFF ATA controllers w/ BMDMA support.  sg_tablesize and
1354  *         dma_boundary are set to BMDMA limits.
1355  * NCQ   : SATA controllers supporting NCQ.  The user must set
1356  *         sg_tablesize, dma_boundary and can_queue.
1357  */
1358 extern const struct ata_port_operations ata_base_port_ops;
1359 extern const struct ata_port_operations sata_port_ops;
1360 extern const struct attribute_group *ata_common_sdev_groups[];
1361
1362 /*
1363  * All sht initializers (BASE, PIO, BMDMA, NCQ) must be instantiated
1364  * by the edge drivers.  Because the 'module' field of sht must be the
1365  * edge driver's module reference, otherwise the driver can be unloaded
1366  * even if the scsi_device is being accessed.
1367  */
1368 #define __ATA_BASE_SHT(drv_name)                                \
1369         .module                 = THIS_MODULE,                  \
1370         .name                   = drv_name,                     \
1371         .ioctl                  = ata_scsi_ioctl,               \
1372         ATA_SCSI_COMPAT_IOCTL                                   \
1373         .queuecommand           = ata_scsi_queuecmd,            \
1374         .dma_need_drain         = ata_scsi_dma_need_drain,      \
1375         .this_id                = ATA_SHT_THIS_ID,              \
1376         .emulated               = ATA_SHT_EMULATED,             \
1377         .proc_name              = drv_name,                     \
1378         .slave_destroy          = ata_scsi_slave_destroy,       \
1379         .bios_param             = ata_std_bios_param,           \
1380         .unlock_native_capacity = ata_scsi_unlock_native_capacity
1381
1382 #define ATA_SUBBASE_SHT(drv_name)                               \
1383         __ATA_BASE_SHT(drv_name),                               \
1384         .can_queue              = ATA_DEF_QUEUE,                \
1385         .tag_alloc_policy       = BLK_TAG_ALLOC_RR,             \
1386         .slave_configure        = ata_scsi_slave_config
1387
1388 #define ATA_BASE_SHT(drv_name)                                  \
1389         ATA_SUBBASE_SHT(drv_name),                              \
1390         .sdev_groups            = ata_common_sdev_groups
1391
1392 #ifdef CONFIG_SATA_HOST
1393 extern const struct attribute_group *ata_ncq_sdev_groups[];
1394
1395 #define ATA_NCQ_SHT(drv_name)                                   \
1396         ATA_SUBBASE_SHT(drv_name),                              \
1397         .sdev_groups            = ata_ncq_sdev_groups,          \
1398         .change_queue_depth     = ata_scsi_change_queue_depth
1399 #endif
1400
1401 /*
1402  * PMP helpers
1403  */
1404 #ifdef CONFIG_SATA_PMP
1405 static inline bool sata_pmp_supported(struct ata_port *ap)
1406 {
1407         return ap->flags & ATA_FLAG_PMP;
1408 }
1409
1410 static inline bool sata_pmp_attached(struct ata_port *ap)
1411 {
1412         return ap->nr_pmp_links != 0;
1413 }
1414
1415 static inline bool ata_is_host_link(const struct ata_link *link)
1416 {
1417         return link == &link->ap->link || link == link->ap->slave_link;
1418 }
1419 #else /* CONFIG_SATA_PMP */
1420 static inline bool sata_pmp_supported(struct ata_port *ap)
1421 {
1422         return false;
1423 }
1424
1425 static inline bool sata_pmp_attached(struct ata_port *ap)
1426 {
1427         return false;
1428 }
1429
1430 static inline bool ata_is_host_link(const struct ata_link *link)
1431 {
1432         return true;
1433 }
1434 #endif /* CONFIG_SATA_PMP */
1435
1436 static inline int sata_srst_pmp(struct ata_link *link)
1437 {
1438         if (sata_pmp_supported(link->ap) && ata_is_host_link(link))
1439                 return SATA_PMP_CTRL_PORT;
1440         return link->pmp;
1441 }
1442
1443 #define ata_port_printk(level, ap, fmt, ...)                    \
1444         pr_ ## level ("ata%u: " fmt, (ap)->print_id, ##__VA_ARGS__)
1445
1446 #define ata_port_err(ap, fmt, ...)                              \
1447         ata_port_printk(err, ap, fmt, ##__VA_ARGS__)
1448 #define ata_port_warn(ap, fmt, ...)                             \
1449         ata_port_printk(warn, ap, fmt, ##__VA_ARGS__)
1450 #define ata_port_notice(ap, fmt, ...)                           \
1451         ata_port_printk(notice, ap, fmt, ##__VA_ARGS__)
1452 #define ata_port_info(ap, fmt, ...)                             \
1453         ata_port_printk(info, ap, fmt, ##__VA_ARGS__)
1454 #define ata_port_dbg(ap, fmt, ...)                              \
1455         ata_port_printk(debug, ap, fmt, ##__VA_ARGS__)
1456
1457 #define ata_link_printk(level, link, fmt, ...)                  \
1458 do {                                                            \
1459         if (sata_pmp_attached((link)->ap) ||                    \
1460             (link)->ap->slave_link)                             \
1461                 pr_ ## level ("ata%u.%02u: " fmt,               \
1462                               (link)->ap->print_id,             \
1463                               (link)->pmp,                      \
1464                               ##__VA_ARGS__);                   \
1465         else                                                    \
1466                 pr_ ## level ("ata%u: " fmt,                    \
1467                               (link)->ap->print_id,             \
1468                               ##__VA_ARGS__);                   \
1469 } while (0)
1470
1471 #define ata_link_err(link, fmt, ...)                            \
1472         ata_link_printk(err, link, fmt, ##__VA_ARGS__)
1473 #define ata_link_warn(link, fmt, ...)                           \
1474         ata_link_printk(warn, link, fmt, ##__VA_ARGS__)
1475 #define ata_link_notice(link, fmt, ...)                         \
1476         ata_link_printk(notice, link, fmt, ##__VA_ARGS__)
1477 #define ata_link_info(link, fmt, ...)                           \
1478         ata_link_printk(info, link, fmt, ##__VA_ARGS__)
1479 #define ata_link_dbg(link, fmt, ...)                            \
1480         ata_link_printk(debug, link, fmt, ##__VA_ARGS__)
1481
1482 #define ata_dev_printk(level, dev, fmt, ...)                    \
1483         pr_ ## level("ata%u.%02u: " fmt,                        \
1484                (dev)->link->ap->print_id,                       \
1485                (dev)->link->pmp + (dev)->devno,                 \
1486                ##__VA_ARGS__)
1487
1488 #define ata_dev_err(dev, fmt, ...)                              \
1489         ata_dev_printk(err, dev, fmt, ##__VA_ARGS__)
1490 #define ata_dev_warn(dev, fmt, ...)                             \
1491         ata_dev_printk(warn, dev, fmt, ##__VA_ARGS__)
1492 #define ata_dev_notice(dev, fmt, ...)                           \
1493         ata_dev_printk(notice, dev, fmt, ##__VA_ARGS__)
1494 #define ata_dev_info(dev, fmt, ...)                             \
1495         ata_dev_printk(info, dev, fmt, ##__VA_ARGS__)
1496 #define ata_dev_dbg(dev, fmt, ...)                              \
1497         ata_dev_printk(debug, dev, fmt, ##__VA_ARGS__)
1498
1499 void ata_print_version(const struct device *dev, const char *version);
1500
1501 /*
1502  * ata_eh_info helpers
1503  */
1504 extern __printf(2, 3)
1505 void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
1506 extern __printf(2, 3)
1507 void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
1508 extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
1509
1510 static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
1511 {
1512         ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
1513         ehi->flags |= ATA_EHI_HOTPLUGGED;
1514         ehi->action |= ATA_EH_RESET | ATA_EH_ENABLE_LINK;
1515         ehi->err_mask |= AC_ERR_ATA_BUS;
1516 }
1517
1518 /*
1519  * port description helpers
1520  */
1521 extern __printf(2, 3)
1522 void ata_port_desc(struct ata_port *ap, const char *fmt, ...);
1523 #ifdef CONFIG_PCI
1524 extern void ata_port_pbar_desc(struct ata_port *ap, int bar, ssize_t offset,
1525                                const char *name);
1526 #endif
1527
1528 static inline bool ata_tag_internal(unsigned int tag)
1529 {
1530         return tag == ATA_TAG_INTERNAL;
1531 }
1532
1533 static inline bool ata_tag_valid(unsigned int tag)
1534 {
1535         return tag < ATA_MAX_QUEUE || ata_tag_internal(tag);
1536 }
1537
1538 #define __ata_qc_for_each(ap, qc, tag, max_tag, fn)             \
1539         for ((tag) = 0; (tag) < (max_tag) &&                    \
1540              ({ qc = fn((ap), (tag)); 1; }); (tag)++)           \
1541
1542 /*
1543  * Internal use only, iterate commands ignoring error handling and
1544  * status of 'qc'.
1545  */
1546 #define ata_qc_for_each_raw(ap, qc, tag)                                        \
1547         __ata_qc_for_each(ap, qc, tag, ATA_MAX_QUEUE, __ata_qc_from_tag)
1548
1549 /*
1550  * Iterate all potential commands that can be queued
1551  */
1552 #define ata_qc_for_each(ap, qc, tag)                                    \
1553         __ata_qc_for_each(ap, qc, tag, ATA_MAX_QUEUE, ata_qc_from_tag)
1554
1555 /*
1556  * Like ata_qc_for_each, but with the internal tag included
1557  */
1558 #define ata_qc_for_each_with_internal(ap, qc, tag)                      \
1559         __ata_qc_for_each(ap, qc, tag, ATA_MAX_QUEUE + 1, ata_qc_from_tag)
1560
1561 /*
1562  * device helpers
1563  */
1564 static inline unsigned int ata_class_enabled(unsigned int class)
1565 {
1566         return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI ||
1567                 class == ATA_DEV_PMP || class == ATA_DEV_SEMB ||
1568                 class == ATA_DEV_ZAC;
1569 }
1570
1571 static inline unsigned int ata_class_disabled(unsigned int class)
1572 {
1573         return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP ||
1574                 class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP ||
1575                 class == ATA_DEV_ZAC_UNSUP;
1576 }
1577
1578 static inline unsigned int ata_class_absent(unsigned int class)
1579 {
1580         return !ata_class_enabled(class) && !ata_class_disabled(class);
1581 }
1582
1583 static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1584 {
1585         return ata_class_enabled(dev->class);
1586 }
1587
1588 static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1589 {
1590         return ata_class_disabled(dev->class);
1591 }
1592
1593 static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1594 {
1595         return ata_class_absent(dev->class);
1596 }
1597
1598 /*
1599  * link helpers
1600  */
1601 static inline int ata_link_max_devices(const struct ata_link *link)
1602 {
1603         if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS)
1604                 return 2;
1605         return 1;
1606 }
1607
1608 static inline int ata_link_active(struct ata_link *link)
1609 {
1610         return ata_tag_valid(link->active_tag) || link->sactive;
1611 }
1612
1613 /*
1614  * Iterators
1615  *
1616  * ATA_LITER_* constants are used to select link iteration mode and
1617  * ATA_DITER_* device iteration mode.
1618  *
1619  * For a custom iteration directly using ata_{link|dev}_next(), if
1620  * @link or @dev, respectively, is NULL, the first element is
1621  * returned.  @dev and @link can be any valid device or link and the
1622  * next element according to the iteration mode will be returned.
1623  * After the last element, NULL is returned.
1624  */
1625 enum ata_link_iter_mode {
1626         ATA_LITER_EDGE,         /* if present, PMP links only; otherwise,
1627                                  * host link.  no slave link */
1628         ATA_LITER_HOST_FIRST,   /* host link followed by PMP or slave links */
1629         ATA_LITER_PMP_FIRST,    /* PMP links followed by host link,
1630                                  * slave link still comes after host link */
1631 };
1632
1633 enum ata_dev_iter_mode {
1634         ATA_DITER_ENABLED,
1635         ATA_DITER_ENABLED_REVERSE,
1636         ATA_DITER_ALL,
1637         ATA_DITER_ALL_REVERSE,
1638 };
1639
1640 extern struct ata_link *ata_link_next(struct ata_link *link,
1641                                       struct ata_port *ap,
1642                                       enum ata_link_iter_mode mode);
1643
1644 extern struct ata_device *ata_dev_next(struct ata_device *dev,
1645                                        struct ata_link *link,
1646                                        enum ata_dev_iter_mode mode);
1647
1648 /*
1649  * Shortcut notation for iterations
1650  *
1651  * ata_for_each_link() iterates over each link of @ap according to
1652  * @mode.  @link points to the current link in the loop.  @link is
1653  * NULL after loop termination.  ata_for_each_dev() works the same way
1654  * except that it iterates over each device of @link.
1655  *
1656  * Note that the mode prefixes ATA_{L|D}ITER_ shouldn't need to be
1657  * specified when using the following shorthand notations.  Only the
1658  * mode itself (EDGE, HOST_FIRST, ENABLED, etc...) should be
1659  * specified.  This not only increases brevity but also makes it
1660  * impossible to use ATA_LITER_* for device iteration or vice-versa.
1661  */
1662 #define ata_for_each_link(link, ap, mode) \
1663         for ((link) = ata_link_next(NULL, (ap), ATA_LITER_##mode); (link); \
1664              (link) = ata_link_next((link), (ap), ATA_LITER_##mode))
1665
1666 #define ata_for_each_dev(dev, link, mode) \
1667         for ((dev) = ata_dev_next(NULL, (link), ATA_DITER_##mode); (dev); \
1668              (dev) = ata_dev_next((dev), (link), ATA_DITER_##mode))
1669
1670 /**
1671  *      ata_ncq_enabled - Test whether NCQ is enabled
1672  *      @dev: ATA device to test for
1673  *
1674  *      LOCKING:
1675  *      spin_lock_irqsave(host lock)
1676  *
1677  *      RETURNS:
1678  *      1 if NCQ is enabled for @dev, 0 otherwise.
1679  */
1680 static inline int ata_ncq_enabled(struct ata_device *dev)
1681 {
1682         if (!IS_ENABLED(CONFIG_SATA_HOST))
1683                 return 0;
1684         return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1685                               ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1686 }
1687
1688 static inline bool ata_fpdma_dsm_supported(struct ata_device *dev)
1689 {
1690         return (dev->flags & ATA_DFLAG_NCQ_SEND_RECV) &&
1691                 (dev->ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_DSM_OFFSET] &
1692                  ATA_LOG_NCQ_SEND_RECV_DSM_TRIM);
1693 }
1694
1695 static inline bool ata_fpdma_read_log_supported(struct ata_device *dev)
1696 {
1697         return (dev->flags & ATA_DFLAG_NCQ_SEND_RECV) &&
1698                 (dev->ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_RD_LOG_OFFSET] &
1699                  ATA_LOG_NCQ_SEND_RECV_RD_LOG_SUPPORTED);
1700 }
1701
1702 static inline bool ata_fpdma_zac_mgmt_in_supported(struct ata_device *dev)
1703 {
1704         return (dev->flags & ATA_DFLAG_NCQ_SEND_RECV) &&
1705                 (dev->ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_ZAC_MGMT_OFFSET] &
1706                 ATA_LOG_NCQ_SEND_RECV_ZAC_MGMT_IN_SUPPORTED);
1707 }
1708
1709 static inline bool ata_fpdma_zac_mgmt_out_supported(struct ata_device *dev)
1710 {
1711         return (dev->ncq_non_data_cmds[ATA_LOG_NCQ_NON_DATA_ZAC_MGMT_OFFSET] &
1712                 ATA_LOG_NCQ_NON_DATA_ZAC_MGMT_OUT);
1713 }
1714
1715 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1716 {
1717         qc->tf.ctl |= ATA_NIEN;
1718 }
1719
1720 static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1721                                                        unsigned int tag)
1722 {
1723         if (ata_tag_valid(tag))
1724                 return &ap->qcmd[tag];
1725         return NULL;
1726 }
1727
1728 static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1729                                                      unsigned int tag)
1730 {
1731         struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1732
1733         if (unlikely(!qc) || !ap->ops->error_handler)
1734                 return qc;
1735
1736         if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1737                           ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1738                 return qc;
1739
1740         return NULL;
1741 }
1742
1743 static inline unsigned int ata_qc_raw_nbytes(struct ata_queued_cmd *qc)
1744 {
1745         return qc->nbytes - min(qc->extrabytes, qc->nbytes);
1746 }
1747
1748 static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1749 {
1750         memset(tf, 0, sizeof(*tf));
1751
1752 #ifdef CONFIG_ATA_SFF
1753         tf->ctl = dev->link->ap->ctl;
1754 #else
1755         tf->ctl = ATA_DEVCTL_OBS;
1756 #endif
1757         if (dev->devno == 0)
1758                 tf->device = ATA_DEVICE_OBS;
1759         else
1760                 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1761 }
1762
1763 static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1764 {
1765         qc->dma_dir = DMA_NONE;
1766         qc->sg = NULL;
1767         qc->flags = 0;
1768         qc->cursg = NULL;
1769         qc->cursg_ofs = 0;
1770         qc->nbytes = qc->extrabytes = qc->curbytes = 0;
1771         qc->n_elem = 0;
1772         qc->err_mask = 0;
1773         qc->sect_size = ATA_SECT_SIZE;
1774
1775         ata_tf_init(qc->dev, &qc->tf);
1776
1777         /* init result_tf such that it indicates normal completion */
1778         qc->result_tf.command = ATA_DRDY;
1779         qc->result_tf.feature = 0;
1780 }
1781
1782 static inline int ata_try_flush_cache(const struct ata_device *dev)
1783 {
1784         return ata_id_wcache_enabled(dev->id) ||
1785                ata_id_has_flush(dev->id) ||
1786                ata_id_has_flush_ext(dev->id);
1787 }
1788
1789 static inline unsigned int ac_err_mask(u8 status)
1790 {
1791         if (status & (ATA_BUSY | ATA_DRQ))
1792                 return AC_ERR_HSM;
1793         if (status & (ATA_ERR | ATA_DF))
1794                 return AC_ERR_DEV;
1795         return 0;
1796 }
1797
1798 static inline unsigned int __ac_err_mask(u8 status)
1799 {
1800         unsigned int mask = ac_err_mask(status);
1801         if (mask == 0)
1802                 return AC_ERR_OTHER;
1803         return mask;
1804 }
1805
1806 static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1807 {
1808         return *(struct ata_port **)&host->hostdata[0];
1809 }
1810
1811 static inline int ata_check_ready(u8 status)
1812 {
1813         if (!(status & ATA_BUSY))
1814                 return 1;
1815
1816         /* 0xff indicates either no device or device not ready */
1817         if (status == 0xff)
1818                 return -ENODEV;
1819
1820         return 0;
1821 }
1822
1823 static inline unsigned long ata_deadline(unsigned long from_jiffies,
1824                                          unsigned long timeout_msecs)
1825 {
1826         return from_jiffies + msecs_to_jiffies(timeout_msecs);
1827 }
1828
1829 /* Don't open code these in drivers as there are traps. Firstly the range may
1830    change in future hardware and specs, secondly 0xFF means 'no DMA' but is
1831    > UDMA_0. Dyma ddreigiau */
1832
1833 static inline int ata_using_mwdma(struct ata_device *adev)
1834 {
1835         if (adev->dma_mode >= XFER_MW_DMA_0 && adev->dma_mode <= XFER_MW_DMA_4)
1836                 return 1;
1837         return 0;
1838 }
1839
1840 static inline int ata_using_udma(struct ata_device *adev)
1841 {
1842         if (adev->dma_mode >= XFER_UDMA_0 && adev->dma_mode <= XFER_UDMA_7)
1843                 return 1;
1844         return 0;
1845 }
1846
1847 static inline int ata_dma_enabled(struct ata_device *adev)
1848 {
1849         return (adev->dma_mode == 0xFF ? 0 : 1);
1850 }
1851
1852 /**************************************************************************
1853  * PATA timings - drivers/ata/libata-pata-timings.c
1854  */
1855 extern const struct ata_timing *ata_timing_find_mode(u8 xfer_mode);
1856 extern int ata_timing_compute(struct ata_device *, unsigned short,
1857                               struct ata_timing *, int, int);
1858 extern void ata_timing_merge(const struct ata_timing *,
1859                              const struct ata_timing *, struct ata_timing *,
1860                              unsigned int);
1861
1862 /**************************************************************************
1863  * PMP - drivers/ata/libata-pmp.c
1864  */
1865 #ifdef CONFIG_SATA_PMP
1866
1867 extern const struct ata_port_operations sata_pmp_port_ops;
1868
1869 extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc);
1870 extern void sata_pmp_error_handler(struct ata_port *ap);
1871
1872 #else /* CONFIG_SATA_PMP */
1873
1874 #define sata_pmp_port_ops               sata_port_ops
1875 #define sata_pmp_qc_defer_cmd_switch    ata_std_qc_defer
1876 #define sata_pmp_error_handler          ata_std_error_handler
1877
1878 #endif /* CONFIG_SATA_PMP */
1879
1880
1881 /**************************************************************************
1882  * SFF - drivers/ata/libata-sff.c
1883  */
1884 #ifdef CONFIG_ATA_SFF
1885
1886 extern const struct ata_port_operations ata_sff_port_ops;
1887 extern const struct ata_port_operations ata_bmdma32_port_ops;
1888
1889 /* PIO only, sg_tablesize and dma_boundary limits can be removed */
1890 #define ATA_PIO_SHT(drv_name)                                   \
1891         ATA_BASE_SHT(drv_name),                                 \
1892         .sg_tablesize           = LIBATA_MAX_PRD,               \
1893         .dma_boundary           = ATA_DMA_BOUNDARY
1894
1895 extern void ata_sff_dev_select(struct ata_port *ap, unsigned int device);
1896 extern u8 ata_sff_check_status(struct ata_port *ap);
1897 extern void ata_sff_pause(struct ata_port *ap);
1898 extern void ata_sff_dma_pause(struct ata_port *ap);
1899 extern int ata_sff_busy_sleep(struct ata_port *ap,
1900                               unsigned long timeout_pat, unsigned long timeout);
1901 extern int ata_sff_wait_ready(struct ata_link *link, unsigned long deadline);
1902 extern void ata_sff_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
1903 extern void ata_sff_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
1904 extern void ata_sff_exec_command(struct ata_port *ap,
1905                                  const struct ata_taskfile *tf);
1906 extern unsigned int ata_sff_data_xfer(struct ata_queued_cmd *qc,
1907                         unsigned char *buf, unsigned int buflen, int rw);
1908 extern unsigned int ata_sff_data_xfer32(struct ata_queued_cmd *qc,
1909                         unsigned char *buf, unsigned int buflen, int rw);
1910 extern void ata_sff_irq_on(struct ata_port *ap);
1911 extern void ata_sff_irq_clear(struct ata_port *ap);
1912 extern int ata_sff_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
1913                             u8 status, int in_wq);
1914 extern void ata_sff_queue_work(struct work_struct *work);
1915 extern void ata_sff_queue_delayed_work(struct delayed_work *dwork,
1916                 unsigned long delay);
1917 extern void ata_sff_queue_pio_task(struct ata_link *link, unsigned long delay);
1918 extern unsigned int ata_sff_qc_issue(struct ata_queued_cmd *qc);
1919 extern bool ata_sff_qc_fill_rtf(struct ata_queued_cmd *qc);
1920 extern unsigned int ata_sff_port_intr(struct ata_port *ap,
1921                                       struct ata_queued_cmd *qc);
1922 extern irqreturn_t ata_sff_interrupt(int irq, void *dev_instance);
1923 extern void ata_sff_lost_interrupt(struct ata_port *ap);
1924 extern void ata_sff_freeze(struct ata_port *ap);
1925 extern void ata_sff_thaw(struct ata_port *ap);
1926 extern int ata_sff_prereset(struct ata_link *link, unsigned long deadline);
1927 extern unsigned int ata_sff_dev_classify(struct ata_device *dev, int present,
1928                                           u8 *r_err);
1929 extern int ata_sff_wait_after_reset(struct ata_link *link, unsigned int devmask,
1930                                     unsigned long deadline);
1931 extern int ata_sff_softreset(struct ata_link *link, unsigned int *classes,
1932                              unsigned long deadline);
1933 extern int sata_sff_hardreset(struct ata_link *link, unsigned int *class,
1934                                unsigned long deadline);
1935 extern void ata_sff_postreset(struct ata_link *link, unsigned int *classes);
1936 extern void ata_sff_drain_fifo(struct ata_queued_cmd *qc);
1937 extern void ata_sff_error_handler(struct ata_port *ap);
1938 extern void ata_sff_std_ports(struct ata_ioports *ioaddr);
1939 #ifdef CONFIG_PCI
1940 extern int ata_pci_sff_init_host(struct ata_host *host);
1941 extern int ata_pci_sff_prepare_host(struct pci_dev *pdev,
1942                                     const struct ata_port_info * const * ppi,
1943                                     struct ata_host **r_host);
1944 extern int ata_pci_sff_activate_host(struct ata_host *host,
1945                                      irq_handler_t irq_handler,
1946                                      struct scsi_host_template *sht);
1947 extern int ata_pci_sff_init_one(struct pci_dev *pdev,
1948                 const struct ata_port_info * const * ppi,
1949                 struct scsi_host_template *sht, void *host_priv, int hflags);
1950 #endif /* CONFIG_PCI */
1951
1952 #ifdef CONFIG_ATA_BMDMA
1953
1954 extern const struct ata_port_operations ata_bmdma_port_ops;
1955
1956 #define ATA_BMDMA_SHT(drv_name)                                 \
1957         ATA_BASE_SHT(drv_name),                                 \
1958         .sg_tablesize           = LIBATA_MAX_PRD,               \
1959         .dma_boundary           = ATA_DMA_BOUNDARY
1960
1961 extern enum ata_completion_errors ata_bmdma_qc_prep(struct ata_queued_cmd *qc);
1962 extern unsigned int ata_bmdma_qc_issue(struct ata_queued_cmd *qc);
1963 extern enum ata_completion_errors ata_bmdma_dumb_qc_prep(struct ata_queued_cmd *qc);
1964 extern unsigned int ata_bmdma_port_intr(struct ata_port *ap,
1965                                       struct ata_queued_cmd *qc);
1966 extern irqreturn_t ata_bmdma_interrupt(int irq, void *dev_instance);
1967 extern void ata_bmdma_error_handler(struct ata_port *ap);
1968 extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
1969 extern void ata_bmdma_irq_clear(struct ata_port *ap);
1970 extern void ata_bmdma_setup(struct ata_queued_cmd *qc);
1971 extern void ata_bmdma_start(struct ata_queued_cmd *qc);
1972 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
1973 extern u8 ata_bmdma_status(struct ata_port *ap);
1974 extern int ata_bmdma_port_start(struct ata_port *ap);
1975 extern int ata_bmdma_port_start32(struct ata_port *ap);
1976
1977 #ifdef CONFIG_PCI
1978 extern int ata_pci_bmdma_clear_simplex(struct pci_dev *pdev);
1979 extern void ata_pci_bmdma_init(struct ata_host *host);
1980 extern int ata_pci_bmdma_prepare_host(struct pci_dev *pdev,
1981                                       const struct ata_port_info * const * ppi,
1982                                       struct ata_host **r_host);
1983 extern int ata_pci_bmdma_init_one(struct pci_dev *pdev,
1984                                   const struct ata_port_info * const * ppi,
1985                                   struct scsi_host_template *sht,
1986                                   void *host_priv, int hflags);
1987 #endif /* CONFIG_PCI */
1988 #endif /* CONFIG_ATA_BMDMA */
1989
1990 /**
1991  *      ata_sff_busy_wait - Wait for a port status register
1992  *      @ap: Port to wait for.
1993  *      @bits: bits that must be clear
1994  *      @max: number of 10uS waits to perform
1995  *
1996  *      Waits up to max*10 microseconds for the selected bits in the port's
1997  *      status register to be cleared.
1998  *      Returns final value of status register.
1999  *
2000  *      LOCKING:
2001  *      Inherited from caller.
2002  */
2003 static inline u8 ata_sff_busy_wait(struct ata_port *ap, unsigned int bits,
2004                                    unsigned int max)
2005 {
2006         u8 status;
2007
2008         do {
2009                 udelay(10);
2010                 status = ap->ops->sff_check_status(ap);
2011                 max--;
2012         } while (status != 0xff && (status & bits) && (max > 0));
2013
2014         return status;
2015 }
2016
2017 /**
2018  *      ata_wait_idle - Wait for a port to be idle.
2019  *      @ap: Port to wait for.
2020  *
2021  *      Waits up to 10ms for port's BUSY and DRQ signals to clear.
2022  *      Returns final value of status register.
2023  *
2024  *      LOCKING:
2025  *      Inherited from caller.
2026  */
2027 static inline u8 ata_wait_idle(struct ata_port *ap)
2028 {
2029         u8 status = ata_sff_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
2030
2031         if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
2032                 ata_port_dbg(ap, "abnormal Status 0x%X\n", status);
2033
2034         return status;
2035 }
2036 #endif /* CONFIG_ATA_SFF */
2037
2038 #endif /* __LINUX_LIBATA_H__ */