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