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 = 1000,
 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
 384          /* DMA mask for user DMA control: User visible values; DO NOT
 385             renumber */
 386         ATA_DMA_MASK_ATA        = (1 << 0),     /* DMA on ATA Disk */
 387         ATA_DMA_MASK_ATAPI      = (1 << 1),     /* DMA on ATAPI */
 388         ATA_DMA_MASK_CFA        = (1 << 2),     /* DMA on CF Card */
 389
 390         /* ATAPI command types */
 391         ATAPI_READ              = 0,            /* READs */
 392         ATAPI_WRITE             = 1,            /* WRITEs */
 393         ATAPI_READ_CD           = 2,            /* READ CD [MSF] */
 394         ATAPI_PASS_THRU         = 3,            /* SAT pass-thru */
 395         ATAPI_MISC              = 4,            /* the rest */
 396
 397         /* Timing constants */
 398         ATA_TIMING_SETUP        = (1 << 0),
 399         ATA_TIMING_ACT8B        = (1 << 1),
 400         ATA_TIMING_REC8B        = (1 << 2),
 401         ATA_TIMING_CYC8B        = (1 << 3),
 402         ATA_TIMING_8BIT         = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
 403                                   ATA_TIMING_CYC8B,
 404         ATA_TIMING_ACTIVE       = (1 << 4),
 405         ATA_TIMING_RECOVER      = (1 << 5),
 406         ATA_TIMING_DMACK_HOLD   = (1 << 6),
 407         ATA_TIMING_CYCLE        = (1 << 7),
 408         ATA_TIMING_UDMA         = (1 << 8),
 409         ATA_TIMING_ALL          = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
 410                                   ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
 411                                   ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
 412                                   ATA_TIMING_DMACK_HOLD | ATA_TIMING_CYCLE |
 413                                   ATA_TIMING_UDMA,
 414 };
 415
 416 enum ata_xfer_mask {
 417         ATA_MASK_PIO            = ((1LU << ATA_NR_PIO_MODES) - 1)
 418                                         << ATA_SHIFT_PIO,
 419         ATA_MASK_MWDMA          = ((1LU << ATA_NR_MWDMA_MODES) - 1)
 420                                         << ATA_SHIFT_MWDMA,
 421         ATA_MASK_UDMA           = ((1LU << ATA_NR_UDMA_MODES) - 1)
 422                                         << ATA_SHIFT_UDMA,
 423 };
 424
 425 enum hsm_task_states {
 426         HSM_ST_IDLE,            /* no command on going */
 427         HSM_ST_FIRST,           /* (waiting the device to)
 428                                    write CDB or first data block */
 429         HSM_ST,                 /* (waiting the device to) transfer data */
 430         HSM_ST_LAST,            /* (waiting the device to) complete command */
 431         HSM_ST_ERR,             /* error */
 432 };
 433
 434 enum ata_completion_errors {
 435         AC_ERR_DEV              = (1 << 0), /* device reported error */
 436         AC_ERR_HSM              = (1 << 1), /* host state machine violation */
 437         AC_ERR_TIMEOUT          = (1 << 2), /* timeout */
 438         AC_ERR_MEDIA            = (1 << 3), /* media error */
 439         AC_ERR_ATA_BUS          = (1 << 4), /* ATA bus error */
 440         AC_ERR_HOST_BUS         = (1 << 5), /* host bus error */
 441         AC_ERR_SYSTEM           = (1 << 6), /* system error */
 442         AC_ERR_INVALID          = (1 << 7), /* invalid argument */
 443         AC_ERR_OTHER            = (1 << 8), /* unknown */
 444         AC_ERR_NODEV_HINT       = (1 << 9), /* polling device detection hint */
 445         AC_ERR_NCQ              = (1 << 10), /* marker for offending NCQ qc */
 446 };
 447
 448 /* forward declarations */
 449 struct scsi_device;
 450 struct ata_port_operations;
 451 struct ata_port;
 452 struct ata_link;
 453 struct ata_queued_cmd;
 454
 455 /* typedefs */
 456 typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
 457 typedef int (*ata_prereset_fn_t)(struct ata_link *link, unsigned long deadline);
 458 typedef int (*ata_reset_fn_t)(struct ata_link *link, unsigned int *classes,
 459                               unsigned long deadline);
 460 typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes);
 461
 462 /*
 463  * host pm policy: If you alter this, you also need to alter libata-scsi.c
 464  * (for the ascii descriptions)
 465  */
 466 enum link_pm {
 467         NOT_AVAILABLE,
 468         MIN_POWER,
 469         MAX_PERFORMANCE,
 470         MEDIUM_POWER,
 471 };
 472 extern struct device_attribute dev_attr_link_power_management_policy;
 473 extern struct device_attribute dev_attr_unload_heads;
 474 extern struct device_attribute dev_attr_em_message_type;
 475 extern struct device_attribute dev_attr_em_message;
 476 extern struct device_attribute dev_attr_sw_activity;
 477
 478 enum sw_activity {
 479         OFF,
 480         BLINK_ON,
 481         BLINK_OFF,
 482 };
 483
 484 #ifdef CONFIG_ATA_SFF
 485 struct ata_ioports {
 486         void __iomem            *cmd_addr;
 487         void __iomem            *data_addr;
 488         void __iomem            *error_addr;
 489         void __iomem            *feature_addr;
 490         void __iomem            *nsect_addr;
 491         void __iomem            *lbal_addr;
 492         void __iomem            *lbam_addr;
 493         void __iomem            *lbah_addr;
 494         void __iomem            *device_addr;
 495         void __iomem            *status_addr;
 496         void __iomem            *command_addr;
 497         void __iomem            *altstatus_addr;
 498         void __iomem            *ctl_addr;
 499         void __iomem            *bmdma_addr;
 500         void __iomem            *scr_addr;
 501 };
 502 #endif /* CONFIG_ATA_SFF */
 503
 504 struct ata_host {
 505         spinlock_t              lock;
 506         struct device           *dev;
 507         void __iomem * const    *iomap;
 508         unsigned int            n_ports;
 509         void                    *private_data;
 510         struct ata_port_operations *ops;
 511         unsigned long           flags;
 512 #ifdef CONFIG_ATA_ACPI
 513         acpi_handle             acpi_handle;
 514 #endif
 515         struct ata_port         *simplex_claimed;       /* channel owning the DMA */
 516         struct ata_port         *ports[0];
 517 };
 518
 519 struct ata_queued_cmd {
 520         struct ata_port         *ap;
 521         struct ata_device       *dev;
 522
 523         struct scsi_cmnd        *scsicmd;
 524         void                    (*scsidone)(struct scsi_cmnd *);
 525
 526         struct ata_taskfile     tf;
 527         u8                      cdb[ATAPI_CDB_LEN];
 528
 529         unsigned long           flags;          /* ATA_QCFLAG_xxx */
 530         unsigned int            tag;
 531         unsigned int            n_elem;
 532
 533         int                     dma_dir;
 534
 535         unsigned int            sect_size;
 536
 537         unsigned int            nbytes;
 538         unsigned int            extrabytes;
 539         unsigned int            curbytes;
 540
 541         struct scatterlist      *cursg;
 542         unsigned int            cursg_ofs;
 543
 544         struct scatterlist      sgent;
 545
 546         struct scatterlist      *sg;
 547
 548         unsigned int            err_mask;
 549         struct ata_taskfile     result_tf;
 550         ata_qc_cb_t             complete_fn;
 551
 552         void                    *private_data;
 553         void                    *lldd_task;
 554 };
 555
 556 struct ata_port_stats {
 557         unsigned long           unhandled_irq;
 558         unsigned long           idle_irq;
 559         unsigned long           rw_reqbuf;
 560 };
 561
 562 struct ata_ering_entry {
 563         unsigned int            eflags;
 564         unsigned int            err_mask;
 565         u64                     timestamp;
 566 };
 567
 568 struct ata_ering {
 569         int                     cursor;
 570         struct ata_ering_entry  ring[ATA_ERING_SIZE];
 571 };
 572
 573 struct ata_device {
 574         struct ata_link         *link;
 575         unsigned int            devno;          /* 0 or 1 */
 576         unsigned int            horkage;        /* List of broken features */
 577         unsigned long           flags;          /* ATA_DFLAG_xxx */
 578         struct scsi_device      *sdev;          /* attached SCSI device */
 579 #ifdef CONFIG_ATA_ACPI
 580         acpi_handle             acpi_handle;
 581         union acpi_object       *gtf_cache;
 582 #endif
 583         /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */
 584         u64                     n_sectors;      /* size of device, if ATA */
 585         unsigned int            class;          /* ATA_DEV_xxx */
 586         unsigned long           unpark_deadline;
 587
 588         u8                      pio_mode;
 589         u8                      dma_mode;
 590         u8                      xfer_mode;
 591         unsigned int            xfer_shift;     /* ATA_SHIFT_xxx */
 592
 593         unsigned int            multi_count;    /* sectors count for
 594                                                    READ/WRITE MULTIPLE */
 595         unsigned int            max_sectors;    /* per-device max sectors */
 596         unsigned int            cdb_len;
 597
 598         /* per-dev xfer mask */
 599         unsigned long           pio_mask;
 600         unsigned long           mwdma_mask;
 601         unsigned long           udma_mask;
 602
 603         /* for CHS addressing */
 604         u16                     cylinders;      /* Number of cylinders */
 605         u16                     heads;          /* Number of heads */
 606         u16                     sectors;        /* Number of sectors per track */
 607
 608         /* error history */
 609         int                     spdn_cnt;
 610         struct ata_ering        ering;
 611
 612         union {
 613                 u16             id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
 614                 u32             gscr[SATA_PMP_GSCR_DWORDS]; /* PMP GSCR block */
 615         };
 616 };
 617
 618 /* Offset into struct ata_device.  Fields above it are maintained
 619  * acress device init.  Fields below are zeroed.
 620  */
 621 #define ATA_DEVICE_CLEAR_OFFSET         offsetof(struct ata_device, n_sectors)
 622
 623 struct ata_eh_info {
 624         struct ata_device       *dev;           /* offending device */
 625         u32                     serror;         /* SError from LLDD */
 626         unsigned int            err_mask;       /* port-wide err_mask */
 627         unsigned int            action;         /* ATA_EH_* action mask */
 628         unsigned int            dev_action[ATA_MAX_DEVICES]; /* dev EH action */
 629         unsigned int            flags;          /* ATA_EHI_* flags */
 630
 631         unsigned int            probe_mask;
 632
 633         char                    desc[ATA_EH_DESC_LEN];
 634         int                     desc_len;
 635 };
 636
 637 struct ata_eh_context {
 638         struct ata_eh_info      i;
 639         int                     tries[ATA_MAX_DEVICES];
 640         int                     cmd_timeout_idx[ATA_MAX_DEVICES]
 641                                                [ATA_EH_CMD_TIMEOUT_TABLE_SIZE];
 642         unsigned int            classes[ATA_MAX_DEVICES];
 643         unsigned int            did_probe_mask;
 644         unsigned int            unloaded_mask;
 645         unsigned int            saved_ncq_enabled;
 646         u8                      saved_xfer_mode[ATA_MAX_DEVICES];
 647         /* timestamp for the last reset attempt or success */
 648         unsigned long           last_reset;
 649 };
 650
 651 struct ata_acpi_drive
 652 {
 653         u32 pio;
 654         u32 dma;
 655 } __packed;
 656
 657 struct ata_acpi_gtm {
 658         struct ata_acpi_drive drive[2];
 659         u32 flags;
 660 } __packed;
 661
 662 struct ata_link {
 663         struct ata_port         *ap;
 664         int                     pmp;            /* port multiplier port # */
 665
 666         unsigned int            active_tag;     /* active tag on this link */
 667         u32                     sactive;        /* active NCQ commands */
 668
 669         unsigned int            flags;          /* ATA_LFLAG_xxx */
 670
 671         u32                     saved_scontrol; /* SControl on probe */
 672         unsigned int            hw_sata_spd_limit;
 673         unsigned int            sata_spd_limit;
 674         unsigned int            sata_spd;       /* current SATA PHY speed */
 675
 676         /* record runtime error info, protected by host_set lock */
 677         struct ata_eh_info      eh_info;
 678         /* EH context */
 679         struct ata_eh_context   eh_context;
 680
 681         struct ata_device       device[ATA_MAX_DEVICES];
 682 };
 683
 684 struct ata_port {
 685         struct Scsi_Host        *scsi_host; /* our co-allocated scsi host */
 686         struct ata_port_operations *ops;
 687         spinlock_t              *lock;
 688         unsigned long           flags;  /* ATA_FLAG_xxx */
 689         unsigned int            pflags; /* ATA_PFLAG_xxx */
 690         unsigned int            print_id; /* user visible unique port ID */
 691         unsigned int            port_no; /* 0 based port no. inside the host */
 692
 693         struct ata_prd          *prd;    /* our SG list */
 694         dma_addr_t              prd_dma; /* and its DMA mapping */
 695
 696 #ifdef CONFIG_ATA_SFF
 697         struct ata_ioports      ioaddr; /* ATA cmd/ctl/dma register blocks */
 698 #endif /* CONFIG_ATA_SFF */
 699
 700         u8                      ctl;    /* cache of ATA control register */
 701         u8                      last_ctl;       /* Cache last written value */
 702         unsigned int            pio_mask;
 703         unsigned int            mwdma_mask;
 704         unsigned int            udma_mask;
 705         unsigned int            cbl;    /* cable type; ATA_CBL_xxx */
 706
 707         struct ata_queued_cmd   qcmd[ATA_MAX_QUEUE];
 708         unsigned long           qc_allocated;
 709         unsigned int            qc_active;
 710         int                     nr_active_links; /* #links with active qcs */
 711
 712         struct ata_link         link;           /* host default link */
 713         struct ata_link         *slave_link;    /* see ata_slave_link_init() */
 714
 715         int                     nr_pmp_links;   /* nr of available PMP links */
 716         struct ata_link         *pmp_link;      /* array of PMP links */
 717         struct ata_link         *excl_link;     /* for PMP qc exclusion */
 718
 719         struct ata_port_stats   stats;
 720         struct ata_host         *host;
 721         struct device           *dev;
 722
 723         void                    *port_task_data;
 724         struct delayed_work     port_task;
 725         struct delayed_work     hotplug_task;
 726         struct work_struct      scsi_rescan_task;
 727
 728         unsigned int            hsm_task_state;
 729
 730         u32                     msg_enable;
 731         struct list_head        eh_done_q;
 732         wait_queue_head_t       eh_wait_q;
 733         int                     eh_tries;
 734         struct completion       park_req_pending;
 735
 736         pm_message_t            pm_mesg;
 737         int                     *pm_result;
 738         enum link_pm            pm_policy;
 739
 740         struct timer_list       fastdrain_timer;
 741         unsigned long           fastdrain_cnt;
 742
 743         int                     em_message_type;
 744         void                    *private_data;
 745
 746 #ifdef CONFIG_ATA_ACPI
 747         acpi_handle             acpi_handle;
 748         struct ata_acpi_gtm     __acpi_init_gtm; /* use ata_acpi_init_gtm() */
 749 #endif
 750         u8                      sector_buf[ATA_SECT_SIZE]; /* owned by EH */
 751 };
 752
 753 /* The following initializer overrides a method to NULL whether one of
 754  * its parent has the method defined or not.  This is equivalent to
 755  * ERR_PTR(-ENOENT).  Unfortunately, ERR_PTR doesn't render a constant
 756  * expression and thus can't be used as an initializer.
 757  */
 758 #define ATA_OP_NULL             (void *)(unsigned long)(-ENOENT)
 759
 760 struct ata_port_operations {
 761         /*
 762          * Command execution
 763          */
 764         int  (*qc_defer)(struct ata_queued_cmd *qc);
 765         int  (*check_atapi_dma)(struct ata_queued_cmd *qc);
 766         void (*qc_prep)(struct ata_queued_cmd *qc);
 767         unsigned int (*qc_issue)(struct ata_queued_cmd *qc);
 768         bool (*qc_fill_rtf)(struct ata_queued_cmd *qc);
 769
 770         /*
 771          * Configuration and exception handling
 772          */
 773         int  (*cable_detect)(struct ata_port *ap);
 774         unsigned long (*mode_filter)(struct ata_device *dev, unsigned long xfer_mask);
 775         void (*set_piomode)(struct ata_port *ap, struct ata_device *dev);
 776         void (*set_dmamode)(struct ata_port *ap, struct ata_device *dev);
 777         int  (*set_mode)(struct ata_link *link, struct ata_device **r_failed_dev);
 778         unsigned int (*read_id)(struct ata_device *dev, struct ata_taskfile *tf, u16 *id);
 779
 780         void (*dev_config)(struct ata_device *dev);
 781
 782         void (*freeze)(struct ata_port *ap);
 783         void (*thaw)(struct ata_port *ap);
 784         ata_prereset_fn_t       prereset;
 785         ata_reset_fn_t          softreset;
 786         ata_reset_fn_t          hardreset;
 787         ata_postreset_fn_t      postreset;
 788         ata_prereset_fn_t       pmp_prereset;
 789         ata_reset_fn_t          pmp_softreset;
 790         ata_reset_fn_t          pmp_hardreset;
 791         ata_postreset_fn_t      pmp_postreset;
 792         void (*error_handler)(struct ata_port *ap);
 793         void (*post_internal_cmd)(struct ata_queued_cmd *qc);
 794
 795         /*
 796          * Optional features
 797          */
 798         int  (*scr_read)(struct ata_link *link, unsigned int sc_reg, u32 *val);
 799         int  (*scr_write)(struct ata_link *link, unsigned int sc_reg, u32 val);
 800         void (*pmp_attach)(struct ata_port *ap);
 801         void (*pmp_detach)(struct ata_port *ap);
 802         int  (*enable_pm)(struct ata_port *ap, enum link_pm policy);
 803         void (*disable_pm)(struct ata_port *ap);
 804
 805         /*
 806          * Start, stop, suspend and resume
 807          */
 808         int  (*port_suspend)(struct ata_port *ap, pm_message_t mesg);
 809         int  (*port_resume)(struct ata_port *ap);
 810         int  (*port_start)(struct ata_port *ap);
 811         void (*port_stop)(struct ata_port *ap);
 812         void (*host_stop)(struct ata_host *host);
 813
 814 #ifdef CONFIG_ATA_SFF
 815         /*
 816          * SFF / taskfile oriented ops
 817          */
 818         void (*sff_dev_select)(struct ata_port *ap, unsigned int device);
 819         u8   (*sff_check_status)(struct ata_port *ap);
 820         u8   (*sff_check_altstatus)(struct ata_port *ap);
 821         void (*sff_tf_load)(struct ata_port *ap, const struct ata_taskfile *tf);
 822         void (*sff_tf_read)(struct ata_port *ap, struct ata_taskfile *tf);
 823         void (*sff_exec_command)(struct ata_port *ap,
 824                                  const struct ata_taskfile *tf);
 825         unsigned int (*sff_data_xfer)(struct ata_device *dev,
 826                         unsigned char *buf, unsigned int buflen, int rw);
 827         u8   (*sff_irq_on)(struct ata_port *);
 828         void (*sff_irq_clear)(struct ata_port *);
 829
 830         void (*bmdma_setup)(struct ata_queued_cmd *qc);
 831         void (*bmdma_start)(struct ata_queued_cmd *qc);
 832         void (*bmdma_stop)(struct ata_queued_cmd *qc);
 833         u8   (*bmdma_status)(struct ata_port *ap);
 834 #endif /* CONFIG_ATA_SFF */
 835
 836         ssize_t (*em_show)(struct ata_port *ap, char *buf);
 837         ssize_t (*em_store)(struct ata_port *ap, const char *message,
 838                             size_t size);
 839         ssize_t (*sw_activity_show)(struct ata_device *dev, char *buf);
 840         ssize_t (*sw_activity_store)(struct ata_device *dev,
 841                                      enum sw_activity val);
 842         /*
 843          * Obsolete
 844          */
 845         void (*phy_reset)(struct ata_port *ap);
 846         void (*eng_timeout)(struct ata_port *ap);
 847
 848         /*
 849          * ->inherits must be the last field and all the preceding
 850          * fields must be pointers.
 851          */
 852         const struct ata_port_operations        *inherits;
 853 };
 854
 855 struct ata_port_info {
 856         unsigned long           flags;
 857         unsigned long           link_flags;
 858         unsigned long           pio_mask;
 859         unsigned long           mwdma_mask;
 860         unsigned long           udma_mask;
 861         struct ata_port_operations *port_ops;
 862         void                    *private_data;
 863 };
 864
 865 struct ata_timing {
 866         unsigned short mode;            /* ATA mode */
 867         unsigned short setup;           /* t1 */
 868         unsigned short act8b;           /* t2 for 8-bit I/O */
 869         unsigned short rec8b;           /* t2i for 8-bit I/O */
 870         unsigned short cyc8b;           /* t0 for 8-bit I/O */
 871         unsigned short active;          /* t2 or tD */
 872         unsigned short recover;         /* t2i or tK */
 873         unsigned short dmack_hold;      /* tj */
 874         unsigned short cycle;           /* t0 */
 875         unsigned short udma;            /* t2CYCTYP/2 */
 876 };
 877
 878 /*
 879  * Core layer - drivers/ata/libata-core.c
 880  */
 881 extern const unsigned long sata_deb_timing_normal[];
 882 extern const unsigned long sata_deb_timing_hotplug[];
 883 extern const unsigned long sata_deb_timing_long[];
 884
 885 extern struct ata_port_operations ata_dummy_port_ops;
 886 extern const struct ata_port_info ata_dummy_port_info;
 887
 888 static inline const unsigned long *
 889 sata_ehc_deb_timing(struct ata_eh_context *ehc)
 890 {
 891         if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
 892                 return sata_deb_timing_hotplug;
 893         else
 894                 return sata_deb_timing_normal;
 895 }
 896
 897 static inline int ata_port_is_dummy(struct ata_port *ap)
 898 {
 899         return ap->ops == &ata_dummy_port_ops;
 900 }
 901
 902 extern void ata_port_probe(struct ata_port *);
 903 extern int sata_set_spd(struct ata_link *link);
 904 extern int ata_std_prereset(struct ata_link *link, unsigned long deadline);
 905 extern int ata_wait_after_reset(struct ata_link *link, unsigned long deadline,
 906                                 int (*check_ready)(struct ata_link *link));
 907 extern int sata_link_debounce(struct ata_link *link,
 908                         const unsigned long *params, unsigned long deadline);
 909 extern int sata_link_resume(struct ata_link *link, const unsigned long *params,
 910                             unsigned long deadline);
 911 extern int sata_link_hardreset(struct ata_link *link,
 912                         const unsigned long *timing, unsigned long deadline,
 913                         bool *online, int (*check_ready)(struct ata_link *));
 914 extern int sata_std_hardreset(struct ata_link *link, unsigned int *class,
 915                               unsigned long deadline);
 916 extern void ata_std_postreset(struct ata_link *link, unsigned int *classes);
 917 extern void ata_port_disable(struct ata_port *);
 918
 919 extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
 920 extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
 921                         const struct ata_port_info * const * ppi, int n_ports);
 922 extern int ata_slave_link_init(struct ata_port *ap);
 923 extern int ata_host_start(struct ata_host *host);
 924 extern int ata_host_register(struct ata_host *host,
 925                              struct scsi_host_template *sht);
 926 extern int ata_host_activate(struct ata_host *host, int irq,
 927                              irq_handler_t irq_handler, unsigned long irq_flags,
 928                              struct scsi_host_template *sht);
 929 extern void ata_host_detach(struct ata_host *host);
 930 extern void ata_host_init(struct ata_host *, struct device *,
 931                           unsigned long, struct ata_port_operations *);
 932 extern int ata_scsi_detect(struct scsi_host_template *sht);
 933 extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
 934 extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
 935 extern int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *dev,
 936                             int cmd, void __user *arg);
 937 extern void ata_sas_port_destroy(struct ata_port *);
 938 extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
 939                                            struct ata_port_info *, struct Scsi_Host *);
 940 extern int ata_sas_port_init(struct ata_port *);
 941 extern int ata_sas_port_start(struct ata_port *ap);
 942 extern void ata_sas_port_stop(struct ata_port *ap);
 943 extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
 944 extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
 945                             struct ata_port *ap);
 946 extern int sata_scr_valid(struct ata_link *link);
 947 extern int sata_scr_read(struct ata_link *link, int reg, u32 *val);
 948 extern int sata_scr_write(struct ata_link *link, int reg, u32 val);
 949 extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val);
 950 extern bool ata_link_online(struct ata_link *link);
 951 extern bool ata_link_offline(struct ata_link *link);
 952 #ifdef CONFIG_PM
 953 extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
 954 extern void ata_host_resume(struct ata_host *host);
 955 #endif
 956 extern int ata_ratelimit(void);
 957 extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
 958                              unsigned long interval, unsigned long timeout);
 959 extern int atapi_cmd_type(u8 opcode);
 960 extern void ata_tf_to_fis(const struct ata_taskfile *tf,
 961                           u8 pmp, int is_cmd, u8 *fis);
 962 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
 963 extern unsigned long ata_pack_xfermask(unsigned long pio_mask,
 964                         unsigned long mwdma_mask, unsigned long udma_mask);
 965 extern void ata_unpack_xfermask(unsigned long xfer_mask,
 966                         unsigned long *pio_mask, unsigned long *mwdma_mask,
 967                         unsigned long *udma_mask);
 968 extern u8 ata_xfer_mask2mode(unsigned long xfer_mask);
 969 extern unsigned long ata_xfer_mode2mask(u8 xfer_mode);
 970 extern int ata_xfer_mode2shift(unsigned long xfer_mode);
 971 extern const char *ata_mode_string(unsigned long xfer_mask);
 972 extern unsigned long ata_id_xfermask(const u16 *id);
 973 extern int ata_port_start(struct ata_port *ap);
 974 extern int ata_std_qc_defer(struct ata_queued_cmd *qc);
 975 extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
 976 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
 977                  unsigned int n_elem);
 978 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
 979 extern void ata_dev_disable(struct ata_device *adev);
 980 extern void ata_id_string(const u16 *id, unsigned char *s,
 981                           unsigned int ofs, unsigned int len);
 982 extern void ata_id_c_string(const u16 *id, unsigned char *s,
 983                             unsigned int ofs, unsigned int len);
 984 extern unsigned int ata_do_dev_read_id(struct ata_device *dev,
 985                                         struct ata_taskfile *tf, u16 *id);
 986 extern void ata_qc_complete(struct ata_queued_cmd *qc);
 987 extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active);
 988 extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
 989                               void (*done)(struct scsi_cmnd *));
 990 extern int ata_std_bios_param(struct scsi_device *sdev,
 991                               struct block_device *bdev,
 992                               sector_t capacity, int geom[]);
 993 extern int ata_scsi_slave_config(struct scsi_device *sdev);
 994 extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
 995 extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
 996                                        int queue_depth);
 997 extern struct ata_device *ata_dev_pair(struct ata_device *adev);
 998 extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
 999
1000 extern int ata_cable_40wire(struct ata_port *ap);
1001 extern int ata_cable_80wire(struct ata_port *ap);
1002 extern int ata_cable_sata(struct ata_port *ap);
1003 extern int ata_cable_ignore(struct ata_port *ap);
1004 extern int ata_cable_unknown(struct ata_port *ap);
1005
1006 /* Timing helpers */
1007 extern unsigned int ata_pio_need_iordy(const struct ata_device *);
1008 extern const struct ata_timing *ata_timing_find_mode(u8 xfer_mode);
1009 extern int ata_timing_compute(struct ata_device *, unsigned short,
1010                               struct ata_timing *, int, int);
1011 extern void ata_timing_merge(const struct ata_timing *,
1012                              const struct ata_timing *, struct ata_timing *,
1013                              unsigned int);
1014 extern u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle);
1015
1016 /* PCI */
1017 #ifdef CONFIG_PCI
1018 struct pci_dev;
1019
1020 struct pci_bits {
1021         unsigned int            reg;    /* PCI config register to read */
1022         unsigned int            width;  /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
1023         unsigned long           mask;
1024         unsigned long           val;
1025 };
1026
1027 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
1028 extern void ata_pci_remove_one(struct pci_dev *pdev);
1029
1030 #ifdef CONFIG_PM
1031 extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
1032 extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
1033 extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
1034 extern int ata_pci_device_resume(struct pci_dev *pdev);
1035 #endif /* CONFIG_PM */
1036 #endif /* CONFIG_PCI */
1037
1038 /*
1039  * ACPI - drivers/ata/libata-acpi.c
1040  */
1041 #ifdef CONFIG_ATA_ACPI
1042 static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1043 {
1044         if (ap->pflags & ATA_PFLAG_INIT_GTM_VALID)
1045                 return &ap->__acpi_init_gtm;
1046         return NULL;
1047 }
1048 int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm);
1049 int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *stm);
1050 unsigned long ata_acpi_gtm_xfermask(struct ata_device *dev,
1051                                     const struct ata_acpi_gtm *gtm);
1052 int ata_acpi_cbl_80wire(struct ata_port *ap, const struct ata_acpi_gtm *gtm);
1053 #else
1054 static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1055 {
1056         return NULL;
1057 }
1058
1059 static inline int ata_acpi_stm(const struct ata_port *ap,
1060                                struct ata_acpi_gtm *stm)
1061 {
1062         return -ENOSYS;
1063 }
1064
1065 static inline int ata_acpi_gtm(const struct ata_port *ap,
1066                                struct ata_acpi_gtm *stm)
1067 {
1068         return -ENOSYS;
1069 }
1070
1071 static inline unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev,
1072                                         const struct ata_acpi_gtm *gtm)
1073 {
1074         return 0;
1075 }
1076
1077 static inline int ata_acpi_cbl_80wire(struct ata_port *ap,
1078                                       const struct ata_acpi_gtm *gtm)
1079 {
1080         return 0;
1081 }
1082 #endif
1083
1084 /*
1085  * EH - drivers/ata/libata-eh.c
1086  */
1087 extern void ata_port_schedule_eh(struct ata_port *ap);
1088 extern int ata_link_abort(struct ata_link *link);
1089 extern int ata_port_abort(struct ata_port *ap);
1090 extern int ata_port_freeze(struct ata_port *ap);
1091 extern int sata_async_notification(struct ata_port *ap);
1092
1093 extern void ata_eh_freeze_port(struct ata_port *ap);
1094 extern void ata_eh_thaw_port(struct ata_port *ap);
1095
1096 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
1097 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
1098 extern void ata_eh_analyze_ncq_error(struct ata_link *link);
1099
1100 extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
1101                       ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
1102                       ata_postreset_fn_t postreset);
1103 extern void ata_std_error_handler(struct ata_port *ap);
1104
1105 /*
1106  * Base operations to inherit from and initializers for sht
1107  *
1108  * Operations
1109  *
1110  * base  : Common to all libata drivers.
1111  * sata  : SATA controllers w/ native interface.
1112  * pmp   : SATA controllers w/ PMP support.
1113  * sff   : SFF ATA controllers w/o BMDMA support.
1114  * bmdma : SFF ATA controllers w/ BMDMA support.
1115  *
1116  * sht initializers
1117  *
1118  * BASE  : Common to all libata drivers.  The user must set
1119  *         sg_tablesize and dma_boundary.
1120  * PIO   : SFF ATA controllers w/ only PIO support.
1121  * BMDMA : SFF ATA controllers w/ BMDMA support.  sg_tablesize and
1122  *         dma_boundary are set to BMDMA limits.
1123  * NCQ   : SATA controllers supporting NCQ.  The user must set
1124  *         sg_tablesize, dma_boundary and can_queue.
1125  */
1126 extern const struct ata_port_operations ata_base_port_ops;
1127 extern const struct ata_port_operations sata_port_ops;
1128 extern struct device_attribute *ata_common_sdev_attrs[];
1129
1130 #define ATA_BASE_SHT(drv_name)                                  \
1131         .module                 = THIS_MODULE,                  \
1132         .name                   = drv_name,                     \
1133         .ioctl                  = ata_scsi_ioctl,               \
1134         .queuecommand           = ata_scsi_queuecmd,            \
1135         .can_queue              = ATA_DEF_QUEUE,                \
1136         .this_id                = ATA_SHT_THIS_ID,              \
1137         .cmd_per_lun            = ATA_SHT_CMD_PER_LUN,          \
1138         .emulated               = ATA_SHT_EMULATED,             \
1139         .use_clustering         = ATA_SHT_USE_CLUSTERING,       \
1140         .proc_name              = drv_name,                     \
1141         .slave_configure        = ata_scsi_slave_config,        \
1142         .slave_destroy          = ata_scsi_slave_destroy,       \
1143         .bios_param             = ata_std_bios_param,           \
1144         .sdev_attrs             = ata_common_sdev_attrs
1145
1146 #define ATA_NCQ_SHT(drv_name)                                   \
1147         ATA_BASE_SHT(drv_name),                                 \
1148         .change_queue_depth     = ata_scsi_change_queue_depth
1149
1150 /*
1151  * PMP helpers
1152  */
1153 #ifdef CONFIG_SATA_PMP
1154 static inline bool sata_pmp_supported(struct ata_port *ap)
1155 {
1156         return ap->flags & ATA_FLAG_PMP;
1157 }
1158
1159 static inline bool sata_pmp_attached(struct ata_port *ap)
1160 {
1161         return ap->nr_pmp_links != 0;
1162 }
1163
1164 static inline int ata_is_host_link(const struct ata_link *link)
1165 {
1166         return link == &link->ap->link || link == link->ap->slave_link;
1167 }
1168 #else /* CONFIG_SATA_PMP */
1169 static inline bool sata_pmp_supported(struct ata_port *ap)
1170 {
1171         return false;
1172 }
1173
1174 static inline bool sata_pmp_attached(struct ata_port *ap)
1175 {
1176         return false;
1177 }
1178
1179 static inline int ata_is_host_link(const struct ata_link *link)
1180 {
1181         return 1;
1182 }
1183 #endif /* CONFIG_SATA_PMP */
1184
1185 static inline int sata_srst_pmp(struct ata_link *link)
1186 {
1187         if (sata_pmp_supported(link->ap) && ata_is_host_link(link))
1188                 return SATA_PMP_CTRL_PORT;
1189         return link->pmp;
1190 }
1191
1192 /*
1193  * printk helpers
1194  */
1195 #define ata_port_printk(ap, lv, fmt, args...) \
1196         printk("%sata%u: "fmt, lv, (ap)->print_id , ##args)
1197
1198 #define ata_link_printk(link, lv, fmt, args...) do { \
1199         if (sata_pmp_attached((link)->ap) || (link)->ap->slave_link)    \
1200                 printk("%sata%u.%02u: "fmt, lv, (link)->ap->print_id,   \
1201                        (link)->pmp , ##args); \
1202         else \
1203                 printk("%sata%u: "fmt, lv, (link)->ap->print_id , ##args); \
1204         } while(0)
1205
1206 #define ata_dev_printk(dev, lv, fmt, args...) \
1207         printk("%sata%u.%02u: "fmt, lv, (dev)->link->ap->print_id,      \
1208                (dev)->link->pmp + (dev)->devno , ##args)
1209
1210 /*
1211  * ata_eh_info helpers
1212  */
1213 extern void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...)
1214         __attribute__ ((format (printf, 2, 3)));
1215 extern void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...)
1216         __attribute__ ((format (printf, 2, 3)));
1217 extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
1218
1219 static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
1220 {
1221         ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
1222         ehi->flags |= ATA_EHI_HOTPLUGGED;
1223         ehi->action |= ATA_EH_RESET | ATA_EH_ENABLE_LINK;
1224         ehi->err_mask |= AC_ERR_ATA_BUS;
1225 }
1226
1227 /*
1228  * port description helpers
1229  */
1230 extern void ata_port_desc(struct ata_port *ap, const char *fmt, ...)
1231         __attribute__ ((format (printf, 2, 3)));
1232 #ifdef CONFIG_PCI
1233 extern void ata_port_pbar_desc(struct ata_port *ap, int bar, ssize_t offset,
1234                                const char *name);
1235 #endif
1236
1237 static inline unsigned int ata_tag_valid(unsigned int tag)
1238 {
1239         return (tag < ATA_MAX_QUEUE) ? 1 : 0;
1240 }
1241
1242 static inline unsigned int ata_tag_internal(unsigned int tag)
1243 {
1244         return tag == ATA_TAG_INTERNAL;
1245 }
1246
1247 /*
1248  * device helpers
1249  */
1250 static inline unsigned int ata_class_enabled(unsigned int class)
1251 {
1252         return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI ||
1253                 class == ATA_DEV_PMP || class == ATA_DEV_SEMB;
1254 }
1255
1256 static inline unsigned int ata_class_disabled(unsigned int class)
1257 {
1258         return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP ||
1259                 class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP;
1260 }
1261
1262 static inline unsigned int ata_class_absent(unsigned int class)
1263 {
1264         return !ata_class_enabled(class) && !ata_class_disabled(class);
1265 }
1266
1267 static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1268 {
1269         return ata_class_enabled(dev->class);
1270 }
1271
1272 static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1273 {
1274         return ata_class_disabled(dev->class);
1275 }
1276
1277 static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1278 {
1279         return ata_class_absent(dev->class);
1280 }
1281
1282 /*
1283  * link helpers
1284  */
1285 static inline int ata_link_max_devices(const struct ata_link *link)
1286 {
1287         if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS)
1288                 return 2;
1289         return 1;
1290 }
1291
1292 static inline int ata_link_active(struct ata_link *link)
1293 {
1294         return ata_tag_valid(link->active_tag) || link->sactive;
1295 }
1296
1297 /*
1298  * Iterators
1299  *
1300  * ATA_LITER_* constants are used to select link iteration mode and
1301  * ATA_DITER_* device iteration mode.
1302  *
1303  * For a custom iteration directly using ata_{link|dev}_next(), if
1304  * @link or @dev, respectively, is NULL, the first element is
1305  * returned.  @dev and @link can be any valid device or link and the
1306  * next element according to the iteration mode will be returned.
1307  * After the last element, NULL is returned.
1308  */
1309 enum ata_link_iter_mode {
1310         ATA_LITER_EDGE,         /* if present, PMP links only; otherwise,
1311                                  * host link.  no slave link */
1312         ATA_LITER_HOST_FIRST,   /* host link followed by PMP or slave links */
1313         ATA_LITER_PMP_FIRST,    /* PMP links followed by host link,
1314                                  * slave link still comes after host link */
1315 };
1316
1317 enum ata_dev_iter_mode {
1318         ATA_DITER_ENABLED,
1319         ATA_DITER_ENABLED_REVERSE,
1320         ATA_DITER_ALL,
1321         ATA_DITER_ALL_REVERSE,
1322 };
1323
1324 extern struct ata_link *ata_link_next(struct ata_link *link,
1325                                       struct ata_port *ap,
1326                                       enum ata_link_iter_mode mode);
1327
1328 extern struct ata_device *ata_dev_next(struct ata_device *dev,
1329                                        struct ata_link *link,
1330                                        enum ata_dev_iter_mode mode);
1331
1332 /*
1333  * Shortcut notation for iterations
1334  *
1335  * ata_for_each_link() iterates over each link of @ap according to
1336  * @mode.  @link points to the current link in the loop.  @link is
1337  * NULL after loop termination.  ata_for_each_dev() works the same way
1338  * except that it iterates over each device of @link.
1339  *
1340  * Note that the mode prefixes ATA_{L|D}ITER_ shouldn't need to be
1341  * specified when using the following shorthand notations.  Only the
1342  * mode itself (EDGE, HOST_FIRST, ENABLED, etc...) should be
1343  * specified.  This not only increases brevity but also makes it
1344  * impossible to use ATA_LITER_* for device iteration or vice-versa.
1345  */
1346 #define ata_for_each_link(link, ap, mode) \
1347         for ((link) = ata_link_next(NULL, (ap), ATA_LITER_##mode); (link); \
1348              (link) = ata_link_next((link), (ap), ATA_LITER_##mode))
1349
1350 #define ata_for_each_dev(dev, link, mode) \
1351         for ((dev) = ata_dev_next(NULL, (link), ATA_DITER_##mode); (dev); \
1352              (dev) = ata_dev_next((dev), (link), ATA_DITER_##mode))
1353
1354 /**
1355  *      ata_ncq_enabled - Test whether NCQ is enabled
1356  *      @dev: ATA device to test for
1357  *
1358  *      LOCKING:
1359  *      spin_lock_irqsave(host lock)
1360  *
1361  *      RETURNS:
1362  *      1 if NCQ is enabled for @dev, 0 otherwise.
1363  */
1364 static inline int ata_ncq_enabled(struct ata_device *dev)
1365 {
1366         return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1367                               ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1368 }
1369
1370 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1371 {
1372         qc->tf.ctl |= ATA_NIEN;
1373 }
1374
1375 static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1376                                                        unsigned int tag)
1377 {
1378         if (likely(ata_tag_valid(tag)))
1379                 return &ap->qcmd[tag];
1380         return NULL;
1381 }
1382
1383 static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1384                                                      unsigned int tag)
1385 {
1386         struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1387
1388         if (unlikely(!qc) || !ap->ops->error_handler)
1389                 return qc;
1390
1391         if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1392                           ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1393                 return qc;
1394
1395         return NULL;
1396 }
1397
1398 static inline unsigned int ata_qc_raw_nbytes(struct ata_queued_cmd *qc)
1399 {
1400         return qc->nbytes - min(qc->extrabytes, qc->nbytes);
1401 }
1402
1403 static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1404 {
1405         memset(tf, 0, sizeof(*tf));
1406
1407         tf->ctl = dev->link->ap->ctl;
1408         if (dev->devno == 0)
1409                 tf->device = ATA_DEVICE_OBS;
1410         else
1411                 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1412 }
1413
1414 static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1415 {
1416         qc->dma_dir = DMA_NONE;
1417         qc->sg = NULL;
1418         qc->flags = 0;
1419         qc->cursg = NULL;
1420         qc->cursg_ofs = 0;
1421         qc->nbytes = qc->extrabytes = qc->curbytes = 0;
1422         qc->n_elem = 0;
1423         qc->err_mask = 0;
1424         qc->sect_size = ATA_SECT_SIZE;
1425
1426         ata_tf_init(qc->dev, &qc->tf);
1427
1428         /* init result_tf such that it indicates normal completion */
1429         qc->result_tf.command = ATA_DRDY;
1430         qc->result_tf.feature = 0;
1431 }
1432
1433 static inline int ata_try_flush_cache(const struct ata_device *dev)
1434 {
1435         return ata_id_wcache_enabled(dev->id) ||
1436                ata_id_has_flush(dev->id) ||
1437                ata_id_has_flush_ext(dev->id);
1438 }
1439
1440 static inline unsigned int ac_err_mask(u8 status)
1441 {
1442         if (status & (ATA_BUSY | ATA_DRQ))
1443                 return AC_ERR_HSM;
1444         if (status & (ATA_ERR | ATA_DF))
1445                 return AC_ERR_DEV;
1446         return 0;
1447 }
1448
1449 static inline unsigned int __ac_err_mask(u8 status)
1450 {
1451         unsigned int mask = ac_err_mask(status);
1452         if (mask == 0)
1453                 return AC_ERR_OTHER;
1454         return mask;
1455 }
1456
1457 static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1458 {
1459         return *(struct ata_port **)&host->hostdata[0];
1460 }
1461
1462 static inline int ata_check_ready(u8 status)
1463 {
1464         if (!(status & ATA_BUSY))
1465                 return 1;
1466
1467         /* 0xff indicates either no device or device not ready */
1468         if (status == 0xff)
1469                 return -ENODEV;
1470
1471         return 0;
1472 }
1473
1474 static inline unsigned long ata_deadline(unsigned long from_jiffies,
1475                                          unsigned long timeout_msecs)
1476 {
1477         return from_jiffies + msecs_to_jiffies(timeout_msecs);
1478 }
1479
1480 /* Don't open code these in drivers as there are traps. Firstly the range may
1481    change in future hardware and specs, secondly 0xFF means 'no DMA' but is
1482    > UDMA_0. Dyma ddreigiau */
1483
1484 static inline int ata_using_mwdma(struct ata_device *adev)
1485 {
1486         if (adev->dma_mode >= XFER_MW_DMA_0 && adev->dma_mode <= XFER_MW_DMA_4)
1487                 return 1;
1488         return 0;
1489 }
1490
1491 static inline int ata_using_udma(struct ata_device *adev)
1492 {
1493         if (adev->dma_mode >= XFER_UDMA_0 && adev->dma_mode <= XFER_UDMA_7)
1494                 return 1;
1495         return 0;
1496 }
1497
1498 static inline int ata_dma_enabled(struct ata_device *adev)
1499 {
1500         return (adev->dma_mode == 0xFF ? 0 : 1);
1501 }
1502
1503 /**************************************************************************
1504  * PMP - drivers/ata/libata-pmp.c
1505  */
1506 #ifdef CONFIG_SATA_PMP
1507
1508 extern const struct ata_port_operations sata_pmp_port_ops;
1509
1510 extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc);
1511 extern void sata_pmp_error_handler(struct ata_port *ap);
1512
1513 #else /* CONFIG_SATA_PMP */
1514
1515 #define sata_pmp_port_ops               sata_port_ops
1516 #define sata_pmp_qc_defer_cmd_switch    ata_std_qc_defer
1517 #define sata_pmp_error_handler          ata_std_error_handler
1518
1519 #endif /* CONFIG_SATA_PMP */
1520
1521
1522 /**************************************************************************
1523  * SFF - drivers/ata/libata-sff.c
1524  */
1525 #ifdef CONFIG_ATA_SFF
1526
1527 extern const struct ata_port_operations ata_sff_port_ops;
1528 extern const struct ata_port_operations ata_bmdma_port_ops;
1529 extern const struct ata_port_operations ata_bmdma32_port_ops;
1530
1531 /* PIO only, sg_tablesize and dma_boundary limits can be removed */
1532 #define ATA_PIO_SHT(drv_name)                                   \
1533         ATA_BASE_SHT(drv_name),                                 \
1534         .sg_tablesize           = LIBATA_MAX_PRD,               \
1535         .dma_boundary           = ATA_DMA_BOUNDARY
1536
1537 #define ATA_BMDMA_SHT(drv_name)                                 \
1538         ATA_BASE_SHT(drv_name),                                 \
1539         .sg_tablesize           = LIBATA_MAX_PRD,               \
1540         .dma_boundary           = ATA_DMA_BOUNDARY
1541
1542 extern void ata_sff_qc_prep(struct ata_queued_cmd *qc);
1543 extern void ata_sff_dumb_qc_prep(struct ata_queued_cmd *qc);
1544 extern void ata_sff_dev_select(struct ata_port *ap, unsigned int device);
1545 extern u8 ata_sff_check_status(struct ata_port *ap);
1546 extern void ata_sff_pause(struct ata_port *ap);
1547 extern void ata_sff_dma_pause(struct ata_port *ap);
1548 extern int ata_sff_busy_sleep(struct ata_port *ap,
1549                               unsigned long timeout_pat, unsigned long timeout);
1550 extern int ata_sff_wait_ready(struct ata_link *link, unsigned long deadline);
1551 extern void ata_sff_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
1552 extern void ata_sff_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
1553 extern void ata_sff_exec_command(struct ata_port *ap,
1554                                  const struct ata_taskfile *tf);
1555 extern unsigned int ata_sff_data_xfer(struct ata_device *dev,
1556                         unsigned char *buf, unsigned int buflen, int rw);
1557 extern unsigned int ata_sff_data_xfer32(struct ata_device *dev,
1558                         unsigned char *buf, unsigned int buflen, int rw);
1559 extern unsigned int ata_sff_data_xfer_noirq(struct ata_device *dev,
1560                         unsigned char *buf, unsigned int buflen, int rw);
1561 extern u8 ata_sff_irq_on(struct ata_port *ap);
1562 extern void ata_sff_irq_clear(struct ata_port *ap);
1563 extern int ata_sff_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
1564                             u8 status, int in_wq);
1565 extern unsigned int ata_sff_qc_issue(struct ata_queued_cmd *qc);
1566 extern bool ata_sff_qc_fill_rtf(struct ata_queued_cmd *qc);
1567 extern unsigned int ata_sff_host_intr(struct ata_port *ap,
1568                                       struct ata_queued_cmd *qc);
1569 extern irqreturn_t ata_sff_interrupt(int irq, void *dev_instance);
1570 extern void ata_sff_freeze(struct ata_port *ap);
1571 extern void ata_sff_thaw(struct ata_port *ap);
1572 extern int ata_sff_prereset(struct ata_link *link, unsigned long deadline);
1573 extern unsigned int ata_sff_dev_classify(struct ata_device *dev, int present,
1574                                           u8 *r_err);
1575 extern int ata_sff_wait_after_reset(struct ata_link *link, unsigned int devmask,
1576                                     unsigned long deadline);
1577 extern int ata_sff_softreset(struct ata_link *link, unsigned int *classes,
1578                              unsigned long deadline);
1579 extern int sata_sff_hardreset(struct ata_link *link, unsigned int *class,
1580                                unsigned long deadline);
1581 extern void ata_sff_postreset(struct ata_link *link, unsigned int *classes);
1582 extern void ata_sff_error_handler(struct ata_port *ap);
1583 extern void ata_sff_post_internal_cmd(struct ata_queued_cmd *qc);
1584 extern int ata_sff_port_start(struct ata_port *ap);
1585 extern void ata_sff_std_ports(struct ata_ioports *ioaddr);
1586 extern unsigned long ata_bmdma_mode_filter(struct ata_device *dev,
1587                                            unsigned long xfer_mask);
1588 extern void ata_bmdma_setup(struct ata_queued_cmd *qc);
1589 extern void ata_bmdma_start(struct ata_queued_cmd *qc);
1590 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
1591 extern u8 ata_bmdma_status(struct ata_port *ap);
1592 extern void ata_bus_reset(struct ata_port *ap);
1593
1594 #ifdef CONFIG_PCI
1595 extern int ata_pci_bmdma_clear_simplex(struct pci_dev *pdev);
1596 extern int ata_pci_bmdma_init(struct ata_host *host);
1597 extern int ata_pci_sff_init_host(struct ata_host *host);
1598 extern int ata_pci_sff_prepare_host(struct pci_dev *pdev,
1599                                     const struct ata_port_info * const * ppi,
1600                                     struct ata_host **r_host);
1601 extern int ata_pci_sff_activate_host(struct ata_host *host,
1602                                      irq_handler_t irq_handler,
1603                                      struct scsi_host_template *sht);
1604 extern int ata_pci_sff_init_one(struct pci_dev *pdev,
1605                                 const struct ata_port_info * const * ppi,
1606                                 struct scsi_host_template *sht, void *host_priv);
1607 #endif /* CONFIG_PCI */
1608
1609 /**
1610  *      ata_sff_busy_wait - Wait for a port status register
1611  *      @ap: Port to wait for.
1612  *      @bits: bits that must be clear
1613  *      @max: number of 10uS waits to perform
1614  *
1615  *      Waits up to max*10 microseconds for the selected bits in the port's
1616  *      status register to be cleared.
1617  *      Returns final value of status register.
1618  *
1619  *      LOCKING:
1620  *      Inherited from caller.
1621  */
1622 static inline u8 ata_sff_busy_wait(struct ata_port *ap, unsigned int bits,
1623                                    unsigned int max)
1624 {
1625         u8 status;
1626
1627         do {
1628                 udelay(10);
1629                 status = ap->ops->sff_check_status(ap);
1630                 max--;
1631         } while (status != 0xff && (status & bits) && (max > 0));
1632
1633         return status;
1634 }
1635
1636 /**
1637  *      ata_wait_idle - Wait for a port to be idle.
1638  *      @ap: Port to wait for.
1639  *
1640  *      Waits up to 10ms for port's BUSY and DRQ signals to clear.
1641  *      Returns final value of status register.
1642  *
1643  *      LOCKING:
1644  *      Inherited from caller.
1645  */
1646 static inline u8 ata_wait_idle(struct ata_port *ap)
1647 {
1648         u8 status = ata_sff_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1649
1650 #ifdef ATA_DEBUG
1651         if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
1652                 ata_port_printk(ap, KERN_DEBUG, "abnormal Status 0x%X\n",
1653                                 status);
1654 #endif
1655
1656         return status;
1657 }
1658 #endif /* CONFIG_ATA_SFF */
1659
1660 #endif /* __LINUX_LIBATA_H__ */