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