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