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