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