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