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