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