SAFE public projects git trees. - safe/jmp/linux-2.6/blob - include/linux/libata.h

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