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