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