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