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