include/linux/libata.h

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