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