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