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