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