include/linux/libata.h

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