include/linux/libata.h

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