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