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