include/linux/libata.h

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