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