include/linux/libata.h

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