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