git.oblomov.eu Git - linux-2.6/blob - include/linux/libata.h

   1 /*
   2  *  Copyright 2003-2005 Red Hat, Inc.  All rights reserved.
   3  *  Copyright 2003-2005 Jeff Garzik
   4  *
   5  *
   6  *  This program is free software; you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation; either version 2, or (at your option)
   9  *  any later version.
  10  *
  11  *  This program is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with this program; see the file COPYING.  If not, write to
  18  *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  19  *
  20  *
  21  *  libata documentation is available via 'make {ps|pdf}docs',
  22  *  as Documentation/DocBook/libata.*
  23  *
  24  */
  25
  26 #ifndef __LINUX_LIBATA_H__
  27 #define __LINUX_LIBATA_H__
  28
  29 #include <linux/delay.h>
  30 #include <linux/interrupt.h>
  31 #include <linux/pci.h>
  32 #include <linux/dma-mapping.h>
  33 #include <asm/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         ATA_MAX_QUEUE           = 1,
 112         ATA_MAX_SECTORS         = 200,  /* FIXME */
 113         ATA_MAX_BUS             = 2,
 114         ATA_DEF_BUSY_WAIT       = 10000,
 115         ATA_SHORT_PAUSE         = (HZ >> 6) + 1,
 116
 117         ATA_SHT_EMULATED        = 1,
 118         ATA_SHT_CMD_PER_LUN     = 1,
 119         ATA_SHT_THIS_ID         = -1,
 120         ATA_SHT_USE_CLUSTERING  = 1,
 121
 122         /* struct ata_device stuff */
 123         ATA_DFLAG_LBA           = (1 << 0), /* device supports LBA */
 124         ATA_DFLAG_LBA48         = (1 << 1), /* device supports LBA48 */
 125         ATA_DFLAG_CFG_MASK      = (1 << 8) - 1,
 126
 127         ATA_DFLAG_PIO           = (1 << 8), /* device currently in PIO mode */
 128
 129         ATA_DEV_UNKNOWN         = 0,    /* unknown device */
 130         ATA_DEV_ATA             = 1,    /* ATA device */
 131         ATA_DEV_ATA_UNSUP       = 2,    /* ATA device (unsupported) */
 132         ATA_DEV_ATAPI           = 3,    /* ATAPI device */
 133         ATA_DEV_ATAPI_UNSUP     = 4,    /* ATAPI device (unsupported) */
 134         ATA_DEV_NONE            = 5,    /* no device */
 135
 136         /* struct ata_port flags */
 137         ATA_FLAG_SLAVE_POSS     = (1 << 0), /* host supports slave dev */
 138                                             /* (doesn't imply presence) */
 139         ATA_FLAG_SATA           = (1 << 1),
 140         ATA_FLAG_NO_LEGACY      = (1 << 2), /* no legacy mode check */
 141         ATA_FLAG_MMIO           = (1 << 3), /* use MMIO, not PIO */
 142         ATA_FLAG_SRST           = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */
 143         ATA_FLAG_SATA_RESET     = (1 << 5), /* (obsolete) use COMRESET */
 144         ATA_FLAG_NO_ATAPI       = (1 << 6), /* No ATAPI support */
 145         ATA_FLAG_PIO_DMA        = (1 << 7), /* PIO cmds via DMA */
 146         ATA_FLAG_PIO_LBA48      = (1 << 8), /* Host DMA engine is LBA28 only */
 147         ATA_FLAG_IRQ_MASK       = (1 << 9), /* Mask IRQ in PIO xfers */
 148
 149         ATA_FLAG_NOINTR         = (1 << 16), /* FIXME: Remove this once
 150                                               * proper HSM is in place. */
 151         ATA_FLAG_DEBUGMSG       = (1 << 17),
 152         ATA_FLAG_FLUSH_PORT_TASK = (1 << 18), /* flush port task */
 153
 154         ATA_FLAG_DISABLED       = (1 << 19), /* port is disabled, ignore it */
 155         ATA_FLAG_SUSPENDED      = (1 << 20), /* port is suspended */
 156
 157         /* bits 24:31 of ap->flags are reserved for LLDD specific flags */
 158
 159         /* struct ata_queued_cmd flags */
 160         ATA_QCFLAG_ACTIVE       = (1 << 0), /* cmd not yet ack'd to scsi lyer */
 161         ATA_QCFLAG_SG           = (1 << 1), /* have s/g table? */
 162         ATA_QCFLAG_SINGLE       = (1 << 2), /* no s/g, just a single buffer */
 163         ATA_QCFLAG_DMAMAP       = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE,
 164         ATA_QCFLAG_IO           = (1 << 3), /* standard IO command */
 165         ATA_QCFLAG_RESULT_TF    = (1 << 4), /* result TF requested */
 166
 167         ATA_QCFLAG_EH_SCHEDULED = (1 << 16), /* EH scheduled */
 168
 169         /* host set flags */
 170         ATA_HOST_SIMPLEX        = (1 << 0),     /* Host is simplex, one DMA channel per host_set only */
 171
 172         /* various lengths of time */
 173         ATA_TMOUT_PIO           = 30 * HZ,
 174         ATA_TMOUT_BOOT          = 30 * HZ,      /* heuristic */
 175         ATA_TMOUT_BOOT_QUICK    = 7 * HZ,       /* heuristic */
 176         ATA_TMOUT_CDB           = 30 * HZ,
 177         ATA_TMOUT_CDB_QUICK     = 5 * HZ,
 178         ATA_TMOUT_INTERNAL      = 30 * HZ,
 179         ATA_TMOUT_INTERNAL_QUICK = 5 * HZ,
 180
 181         /* ATA bus states */
 182         BUS_UNKNOWN             = 0,
 183         BUS_DMA                 = 1,
 184         BUS_IDLE                = 2,
 185         BUS_NOINTR              = 3,
 186         BUS_NODATA              = 4,
 187         BUS_TIMER               = 5,
 188         BUS_PIO                 = 6,
 189         BUS_EDD                 = 7,
 190         BUS_IDENTIFY            = 8,
 191         BUS_PACKET              = 9,
 192
 193         /* SATA port states */
 194         PORT_UNKNOWN            = 0,
 195         PORT_ENABLED            = 1,
 196         PORT_DISABLED           = 2,
 197
 198         /* encoding various smaller bitmaps into a single
 199          * unsigned int bitmap
 200          */
 201         ATA_BITS_PIO            = 5,
 202         ATA_BITS_MWDMA          = 3,
 203         ATA_BITS_UDMA           = 8,
 204
 205         ATA_SHIFT_PIO           = 0,
 206         ATA_SHIFT_MWDMA         = ATA_SHIFT_PIO + ATA_BITS_PIO,
 207         ATA_SHIFT_UDMA          = ATA_SHIFT_MWDMA + ATA_BITS_MWDMA,
 208
 209         ATA_MASK_PIO            = ((1 << ATA_BITS_PIO) - 1) << ATA_SHIFT_PIO,
 210         ATA_MASK_MWDMA          = ((1 << ATA_BITS_MWDMA) - 1) << ATA_SHIFT_MWDMA,
 211         ATA_MASK_UDMA           = ((1 << ATA_BITS_UDMA) - 1) << ATA_SHIFT_UDMA,
 212
 213         /* size of buffer to pad xfers ending on unaligned boundaries */
 214         ATA_DMA_PAD_SZ          = 4,
 215         ATA_DMA_PAD_BUF_SZ      = ATA_DMA_PAD_SZ * ATA_MAX_QUEUE,
 216
 217         /* masks for port functions */
 218         ATA_PORT_PRIMARY        = (1 << 0),
 219         ATA_PORT_SECONDARY      = (1 << 1),
 220
 221         /* how hard are we gonna try to probe/recover devices */
 222         ATA_PROBE_MAX_TRIES     = 3,
 223 };
 224
 225 enum hsm_task_states {
 226         HSM_ST_UNKNOWN,
 227         HSM_ST_IDLE,
 228         HSM_ST_POLL,
 229         HSM_ST_TMOUT,
 230         HSM_ST,
 231         HSM_ST_LAST,
 232         HSM_ST_LAST_POLL,
 233         HSM_ST_ERR,
 234 };
 235
 236 enum ata_completion_errors {
 237         AC_ERR_DEV              = (1 << 0), /* device reported error */
 238         AC_ERR_HSM              = (1 << 1), /* host state machine violation */
 239         AC_ERR_TIMEOUT          = (1 << 2), /* timeout */
 240         AC_ERR_MEDIA            = (1 << 3), /* media error */
 241         AC_ERR_ATA_BUS          = (1 << 4), /* ATA bus error */
 242         AC_ERR_HOST_BUS         = (1 << 5), /* host bus error */
 243         AC_ERR_SYSTEM           = (1 << 6), /* system error */
 244         AC_ERR_INVALID          = (1 << 7), /* invalid argument */
 245         AC_ERR_OTHER            = (1 << 8), /* unknown */
 246 };
 247
 248 /* forward declarations */
 249 struct scsi_device;
 250 struct ata_port_operations;
 251 struct ata_port;
 252 struct ata_queued_cmd;
 253
 254 /* typedefs */
 255 typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
 256 typedef void (*ata_probeinit_fn_t)(struct ata_port *);
 257 typedef int (*ata_reset_fn_t)(struct ata_port *, unsigned int *);
 258 typedef void (*ata_postreset_fn_t)(struct ata_port *ap, unsigned int *);
 259
 260 struct ata_ioports {
 261         unsigned long           cmd_addr;
 262         unsigned long           data_addr;
 263         unsigned long           error_addr;
 264         unsigned long           feature_addr;
 265         unsigned long           nsect_addr;
 266         unsigned long           lbal_addr;
 267         unsigned long           lbam_addr;
 268         unsigned long           lbah_addr;
 269         unsigned long           device_addr;
 270         unsigned long           status_addr;
 271         unsigned long           command_addr;
 272         unsigned long           altstatus_addr;
 273         unsigned long           ctl_addr;
 274         unsigned long           bmdma_addr;
 275         unsigned long           scr_addr;
 276 };
 277
 278 struct ata_probe_ent {
 279         struct list_head        node;
 280         struct device           *dev;
 281         const struct ata_port_operations *port_ops;
 282         struct scsi_host_template *sht;
 283         struct ata_ioports      port[ATA_MAX_PORTS];
 284         unsigned int            n_ports;
 285         unsigned int            hard_port_no;
 286         unsigned int            pio_mask;
 287         unsigned int            mwdma_mask;
 288         unsigned int            udma_mask;
 289         unsigned int            legacy_mode;
 290         unsigned long           irq;
 291         unsigned int            irq_flags;
 292         unsigned long           host_flags;
 293         unsigned long           host_set_flags;
 294         void __iomem            *mmio_base;
 295         void                    *private_data;
 296 };
 297
 298 struct ata_host_set {
 299         spinlock_t              lock;
 300         struct device           *dev;
 301         unsigned long           irq;
 302         void __iomem            *mmio_base;
 303         unsigned int            n_ports;
 304         void                    *private_data;
 305         const struct ata_port_operations *ops;
 306         unsigned long           flags;
 307         int                     simplex_claimed;        /* Keep seperate in case we
 308                                                            ever need to do this locked */
 309         struct ata_port *       ports[0];
 310 };
 311
 312 struct ata_queued_cmd {
 313         struct ata_port         *ap;
 314         struct ata_device       *dev;
 315
 316         struct scsi_cmnd        *scsicmd;
 317         void                    (*scsidone)(struct scsi_cmnd *);
 318
 319         struct ata_taskfile     tf;
 320         u8                      cdb[ATAPI_CDB_LEN];
 321
 322         unsigned long           flags;          /* ATA_QCFLAG_xxx */
 323         unsigned int            tag;
 324         unsigned int            n_elem;
 325         unsigned int            orig_n_elem;
 326
 327         int                     dma_dir;
 328
 329         unsigned int            pad_len;
 330
 331         unsigned int            nsect;
 332         unsigned int            cursect;
 333
 334         unsigned int            nbytes;
 335         unsigned int            curbytes;
 336
 337         unsigned int            cursg;
 338         unsigned int            cursg_ofs;
 339
 340         struct scatterlist      sgent;
 341         struct scatterlist      pad_sgent;
 342         void                    *buf_virt;
 343
 344         /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
 345         struct scatterlist      *__sg;
 346
 347         unsigned int            err_mask;
 348         struct ata_taskfile     result_tf;
 349         ata_qc_cb_t             complete_fn;
 350
 351         void                    *private_data;
 352 };
 353
 354 struct ata_host_stats {
 355         unsigned long           unhandled_irq;
 356         unsigned long           idle_irq;
 357         unsigned long           rw_reqbuf;
 358 };
 359
 360 struct ata_device {
 361         struct ata_port         *ap;
 362         u64                     n_sectors;      /* size of device, if ATA */
 363         unsigned long           flags;          /* ATA_DFLAG_xxx */
 364         unsigned int            class;          /* ATA_DEV_xxx */
 365         unsigned int            devno;          /* 0 or 1 */
 366         u16                     id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
 367         u8                      pio_mode;
 368         u8                      dma_mode;
 369         u8                      xfer_mode;
 370         unsigned int            xfer_shift;     /* ATA_SHIFT_xxx */
 371
 372         unsigned int            multi_count;    /* sectors count for
 373                                                    READ/WRITE MULTIPLE */
 374         unsigned int            max_sectors;    /* per-device max sectors */
 375         unsigned int            cdb_len;
 376
 377         /* per-dev xfer mask */
 378         unsigned int            pio_mask;
 379         unsigned int            mwdma_mask;
 380         unsigned int            udma_mask;
 381
 382         /* for CHS addressing */
 383         u16                     cylinders;      /* Number of cylinders */
 384         u16                     heads;          /* Number of heads */
 385         u16                     sectors;        /* Number of sectors per track */
 386 };
 387
 388 struct ata_port {
 389         struct Scsi_Host        *host;  /* our co-allocated scsi host */
 390         const struct ata_port_operations *ops;
 391         unsigned long           flags;  /* ATA_FLAG_xxx */
 392         unsigned int            id;     /* unique id req'd by scsi midlyr */
 393         unsigned int            port_no; /* unique port #; from zero */
 394         unsigned int            hard_port_no;   /* hardware port #; from zero */
 395
 396         struct ata_prd          *prd;    /* our SG list */
 397         dma_addr_t              prd_dma; /* and its DMA mapping */
 398
 399         void                    *pad;   /* array of DMA pad buffers */
 400         dma_addr_t              pad_dma;
 401
 402         struct ata_ioports      ioaddr; /* ATA cmd/ctl/dma register blocks */
 403
 404         u8                      ctl;    /* cache of ATA control register */
 405         u8                      last_ctl;       /* Cache last written value */
 406         unsigned int            pio_mask;
 407         unsigned int            mwdma_mask;
 408         unsigned int            udma_mask;
 409         unsigned int            cbl;    /* cable type; ATA_CBL_xxx */
 410         unsigned int            sata_spd_limit; /* SATA PHY speed limit */
 411
 412         struct ata_device       device[ATA_MAX_DEVICES];
 413
 414         struct ata_queued_cmd   qcmd[ATA_MAX_QUEUE];
 415         unsigned long           qactive;
 416         unsigned int            active_tag;
 417
 418         struct ata_host_stats   stats;
 419         struct ata_host_set     *host_set;
 420         struct device           *dev;
 421
 422         struct work_struct      port_task;
 423
 424         unsigned int            hsm_task_state;
 425         unsigned long           pio_task_timeout;
 426
 427         u32                     msg_enable;
 428         struct list_head        eh_done_q;
 429
 430         void                    *private_data;
 431
 432         u8                      sector_buf[ATA_SECT_SIZE]; /* owned by EH */
 433 };
 434
 435 struct ata_port_operations {
 436         void (*port_disable) (struct ata_port *);
 437
 438         void (*dev_config) (struct ata_port *, struct ata_device *);
 439
 440         void (*set_piomode) (struct ata_port *, struct ata_device *);
 441         void (*set_dmamode) (struct ata_port *, struct ata_device *);
 442         unsigned long (*mode_filter) (const struct ata_port *, struct ata_device *, unsigned long);
 443
 444         void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
 445         void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
 446
 447         void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
 448         u8   (*check_status)(struct ata_port *ap);
 449         u8   (*check_altstatus)(struct ata_port *ap);
 450         void (*dev_select)(struct ata_port *ap, unsigned int device);
 451
 452         void (*phy_reset) (struct ata_port *ap); /* obsolete */
 453         void (*set_mode) (struct ata_port *ap);
 454         int (*probe_reset) (struct ata_port *ap, unsigned int *classes);
 455
 456         void (*post_set_mode) (struct ata_port *ap);
 457
 458         int (*check_atapi_dma) (struct ata_queued_cmd *qc);
 459
 460         void (*bmdma_setup) (struct ata_queued_cmd *qc);
 461         void (*bmdma_start) (struct ata_queued_cmd *qc);
 462
 463         void (*qc_prep) (struct ata_queued_cmd *qc);
 464         unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
 465
 466         void (*eng_timeout) (struct ata_port *ap);
 467
 468         irqreturn_t (*irq_handler)(int, void *, struct pt_regs *);
 469         void (*irq_clear) (struct ata_port *);
 470
 471         u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg);
 472         void (*scr_write) (struct ata_port *ap, unsigned int sc_reg,
 473                            u32 val);
 474
 475         int (*port_start) (struct ata_port *ap);
 476         void (*port_stop) (struct ata_port *ap);
 477
 478         void (*host_stop) (struct ata_host_set *host_set);
 479
 480         void (*bmdma_stop) (struct ata_queued_cmd *qc);
 481         u8   (*bmdma_status) (struct ata_port *ap);
 482 };
 483
 484 struct ata_port_info {
 485         struct scsi_host_template       *sht;
 486         unsigned long           host_flags;
 487         unsigned long           pio_mask;
 488         unsigned long           mwdma_mask;
 489         unsigned long           udma_mask;
 490         const struct ata_port_operations *port_ops;
 491         void                    *private_data;
 492 };
 493
 494 struct ata_timing {
 495         unsigned short mode;            /* ATA mode */
 496         unsigned short setup;           /* t1 */
 497         unsigned short act8b;           /* t2 for 8-bit I/O */
 498         unsigned short rec8b;           /* t2i for 8-bit I/O */
 499         unsigned short cyc8b;           /* t0 for 8-bit I/O */
 500         unsigned short active;          /* t2 or tD */
 501         unsigned short recover;         /* t2i or tK */
 502         unsigned short cycle;           /* t0 */
 503         unsigned short udma;            /* t2CYCTYP/2 */
 504 };
 505
 506 #define FIT(v,vmin,vmax)        max_t(short,min_t(short,v,vmax),vmin)
 507
 508 extern void ata_port_probe(struct ata_port *);
 509 extern void __sata_phy_reset(struct ata_port *ap);
 510 extern void sata_phy_reset(struct ata_port *ap);
 511 extern void ata_bus_reset(struct ata_port *ap);
 512 extern int sata_set_spd(struct ata_port *ap);
 513 extern int ata_drive_probe_reset(struct ata_port *ap,
 514                         ata_probeinit_fn_t probeinit,
 515                         ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
 516                         ata_postreset_fn_t postreset, unsigned int *classes);
 517 extern void ata_std_probeinit(struct ata_port *ap);
 518 extern int ata_std_softreset(struct ata_port *ap, unsigned int *classes);
 519 extern int sata_std_hardreset(struct ata_port *ap, unsigned int *class);
 520 extern void ata_std_postreset(struct ata_port *ap, unsigned int *classes);
 521 extern int ata_dev_revalidate(struct ata_device *dev, int post_reset);
 522 extern void ata_port_disable(struct ata_port *);
 523 extern void ata_std_ports(struct ata_ioports *ioaddr);
 524 #ifdef CONFIG_PCI
 525 extern int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info,
 526                              unsigned int n_ports);
 527 extern void ata_pci_remove_one (struct pci_dev *pdev);
 528 extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t state);
 529 extern int ata_pci_device_resume(struct pci_dev *pdev);
 530 extern int ata_pci_clear_simplex(struct pci_dev *pdev);
 531 #endif /* CONFIG_PCI */
 532 extern int ata_device_add(const struct ata_probe_ent *ent);
 533 extern void ata_host_set_remove(struct ata_host_set *host_set);
 534 extern int ata_scsi_detect(struct scsi_host_template *sht);
 535 extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
 536 extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
 537 extern int ata_scsi_release(struct Scsi_Host *host);
 538 extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
 539 extern int sata_scr_valid(struct ata_port *ap);
 540 extern int sata_scr_read(struct ata_port *ap, int reg, u32 *val);
 541 extern int sata_scr_write(struct ata_port *ap, int reg, u32 val);
 542 extern int sata_scr_write_flush(struct ata_port *ap, int reg, u32 val);
 543 extern int ata_port_online(struct ata_port *ap);
 544 extern int ata_port_offline(struct ata_port *ap);
 545 extern int ata_scsi_device_resume(struct scsi_device *);
 546 extern int ata_scsi_device_suspend(struct scsi_device *, pm_message_t state);
 547 extern int ata_device_resume(struct ata_device *);
 548 extern int ata_device_suspend(struct ata_device *, pm_message_t state);
 549 extern int ata_ratelimit(void);
 550 extern unsigned int ata_busy_sleep(struct ata_port *ap,
 551                                    unsigned long timeout_pat,
 552                                    unsigned long timeout);
 553 extern void ata_port_queue_task(struct ata_port *ap, void (*fn)(void *),
 554                                 void *data, unsigned long delay);
 555 extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
 556                              unsigned long interval_msec,
 557                              unsigned long timeout_msec);
 558
 559 /*
 560  * Default driver ops implementations
 561  */
 562 extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
 563 extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
 564 extern void ata_tf_to_fis(const struct ata_taskfile *tf, u8 *fis, u8 pmp);
 565 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
 566 extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
 567 extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
 568 extern u8 ata_check_status(struct ata_port *ap);
 569 extern u8 ata_altstatus(struct ata_port *ap);
 570 extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
 571 extern int ata_std_probe_reset(struct ata_port *ap, unsigned int *classes);
 572 extern int ata_port_start (struct ata_port *ap);
 573 extern void ata_port_stop (struct ata_port *ap);
 574 extern void ata_host_stop (struct ata_host_set *host_set);
 575 extern irqreturn_t ata_interrupt (int irq, void *dev_instance, struct pt_regs *regs);
 576 extern void ata_qc_prep(struct ata_queued_cmd *qc);
 577 extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
 578 extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
 579 extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
 580                 unsigned int buflen);
 581 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
 582                  unsigned int n_elem);
 583 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
 584 extern void ata_id_string(const u16 *id, unsigned char *s,
 585                           unsigned int ofs, unsigned int len);
 586 extern void ata_id_c_string(const u16 *id, unsigned char *s,
 587                             unsigned int ofs, unsigned int len);
 588 extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
 589 extern void ata_bmdma_start (struct ata_queued_cmd *qc);
 590 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
 591 extern u8   ata_bmdma_status(struct ata_port *ap);
 592 extern void ata_bmdma_irq_clear(struct ata_port *ap);
 593 extern void __ata_qc_complete(struct ata_queued_cmd *qc);
 594 extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
 595                               void (*done)(struct scsi_cmnd *));
 596 extern int ata_std_bios_param(struct scsi_device *sdev,
 597                               struct block_device *bdev,
 598                               sector_t capacity, int geom[]);
 599 extern int ata_scsi_slave_config(struct scsi_device *sdev);
 600 extern struct ata_device *ata_dev_pair(struct ata_device *adev);
 601
 602 /*
 603  * Timing helpers
 604  */
 605
 606 extern unsigned int ata_pio_need_iordy(const struct ata_device *);
 607 extern int ata_timing_compute(struct ata_device *, unsigned short,
 608                               struct ata_timing *, int, int);
 609 extern void ata_timing_merge(const struct ata_timing *,
 610                              const struct ata_timing *, struct ata_timing *,
 611                              unsigned int);
 612
 613 enum {
 614         ATA_TIMING_SETUP        = (1 << 0),
 615         ATA_TIMING_ACT8B        = (1 << 1),
 616         ATA_TIMING_REC8B        = (1 << 2),
 617         ATA_TIMING_CYC8B        = (1 << 3),
 618         ATA_TIMING_8BIT         = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
 619                                   ATA_TIMING_CYC8B,
 620         ATA_TIMING_ACTIVE       = (1 << 4),
 621         ATA_TIMING_RECOVER      = (1 << 5),
 622         ATA_TIMING_CYCLE        = (1 << 6),
 623         ATA_TIMING_UDMA         = (1 << 7),
 624         ATA_TIMING_ALL          = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
 625                                   ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
 626                                   ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
 627                                   ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
 628 };
 629
 630
 631 #ifdef CONFIG_PCI
 632 struct pci_bits {
 633         unsigned int            reg;    /* PCI config register to read */
 634         unsigned int            width;  /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
 635         unsigned long           mask;
 636         unsigned long           val;
 637 };
 638
 639 extern void ata_pci_host_stop (struct ata_host_set *host_set);
 640 extern struct ata_probe_ent *
 641 ata_pci_init_native_mode(struct pci_dev *pdev, struct ata_port_info **port, int portmask);
 642 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
 643 extern unsigned long ata_pci_default_filter(const struct ata_port *, struct ata_device *, unsigned long);
 644 #endif /* CONFIG_PCI */
 645
 646 /*
 647  * EH
 648  */
 649 extern void ata_eng_timeout(struct ata_port *ap);
 650 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
 651 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
 652
 653 /*
 654  * printk helpers
 655  */
 656 #define ata_port_printk(ap, lv, fmt, args...) \
 657         printk(lv"ata%u: "fmt, (ap)->id , ##args)
 658
 659 #define ata_dev_printk(dev, lv, fmt, args...) \
 660         printk(lv"ata%u.%02u: "fmt, (dev)->ap->id, (dev)->devno , ##args)
 661
 662 /*
 663  * qc helpers
 664  */
 665 static inline int
 666 ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
 667 {
 668         if (sg == &qc->pad_sgent)
 669                 return 1;
 670         if (qc->pad_len)
 671                 return 0;
 672         if (((sg - qc->__sg) + 1) == qc->n_elem)
 673                 return 1;
 674         return 0;
 675 }
 676
 677 static inline struct scatterlist *
 678 ata_qc_first_sg(struct ata_queued_cmd *qc)
 679 {
 680         if (qc->n_elem)
 681                 return qc->__sg;
 682         if (qc->pad_len)
 683                 return &qc->pad_sgent;
 684         return NULL;
 685 }
 686
 687 static inline struct scatterlist *
 688 ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
 689 {
 690         if (sg == &qc->pad_sgent)
 691                 return NULL;
 692         if (++sg - qc->__sg < qc->n_elem)
 693                 return sg;
 694         if (qc->pad_len)
 695                 return &qc->pad_sgent;
 696         return NULL;
 697 }
 698
 699 #define ata_for_each_sg(sg, qc) \
 700         for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
 701
 702 static inline unsigned int ata_tag_valid(unsigned int tag)
 703 {
 704         return (tag < ATA_MAX_QUEUE) ? 1 : 0;
 705 }
 706
 707 static inline unsigned int ata_class_enabled(unsigned int class)
 708 {
 709         return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI;
 710 }
 711
 712 static inline unsigned int ata_class_disabled(unsigned int class)
 713 {
 714         return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP;
 715 }
 716
 717 static inline unsigned int ata_class_absent(unsigned int class)
 718 {
 719         return !ata_class_enabled(class) && !ata_class_disabled(class);
 720 }
 721
 722 static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
 723 {
 724         return ata_class_enabled(dev->class);
 725 }
 726
 727 static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
 728 {
 729         return ata_class_disabled(dev->class);
 730 }
 731
 732 static inline unsigned int ata_dev_absent(const struct ata_device *dev)
 733 {
 734         return ata_class_absent(dev->class);
 735 }
 736
 737 static inline u8 ata_chk_status(struct ata_port *ap)
 738 {
 739         return ap->ops->check_status(ap);
 740 }
 741
 742
 743 /**
 744  *      ata_pause - Flush writes and pause 400 nanoseconds.
 745  *      @ap: Port to wait for.
 746  *
 747  *      LOCKING:
 748  *      Inherited from caller.
 749  */
 750
 751 static inline void ata_pause(struct ata_port *ap)
 752 {
 753         ata_altstatus(ap);
 754         ndelay(400);
 755 }
 756
 757
 758 /**
 759  *      ata_busy_wait - Wait for a port status register
 760  *      @ap: Port to wait for.
 761  *
 762  *      Waits up to max*10 microseconds for the selected bits in the port's
 763  *      status register to be cleared.
 764  *      Returns final value of status register.
 765  *
 766  *      LOCKING:
 767  *      Inherited from caller.
 768  */
 769
 770 static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
 771                                unsigned int max)
 772 {
 773         u8 status;
 774
 775         do {
 776                 udelay(10);
 777                 status = ata_chk_status(ap);
 778                 max--;
 779         } while ((status & bits) && (max > 0));
 780
 781         return status;
 782 }
 783
 784
 785 /**
 786  *      ata_wait_idle - Wait for a port to be idle.
 787  *      @ap: Port to wait for.
 788  *
 789  *      Waits up to 10ms for port's BUSY and DRQ signals to clear.
 790  *      Returns final value of status register.
 791  *
 792  *      LOCKING:
 793  *      Inherited from caller.
 794  */
 795
 796 static inline u8 ata_wait_idle(struct ata_port *ap)
 797 {
 798         u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
 799
 800         if (status & (ATA_BUSY | ATA_DRQ)) {
 801                 unsigned long l = ap->ioaddr.status_addr;
 802                 if (ata_msg_warn(ap))
 803                         printk(KERN_WARNING "ATA: abnormal status 0x%X on port 0x%lX\n",
 804                                 status, l);
 805         }
 806
 807         return status;
 808 }
 809
 810 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
 811 {
 812         qc->tf.ctl |= ATA_NIEN;
 813 }
 814
 815 static inline struct ata_queued_cmd *ata_qc_from_tag (struct ata_port *ap,
 816                                                       unsigned int tag)
 817 {
 818         if (likely(ata_tag_valid(tag)))
 819                 return &ap->qcmd[tag];
 820         return NULL;
 821 }
 822
 823 static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
 824 {
 825         memset(tf, 0, sizeof(*tf));
 826
 827         tf->ctl = dev->ap->ctl;
 828         if (dev->devno == 0)
 829                 tf->device = ATA_DEVICE_OBS;
 830         else
 831                 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
 832 }
 833
 834 static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
 835 {
 836         qc->__sg = NULL;
 837         qc->flags = 0;
 838         qc->cursect = qc->cursg = qc->cursg_ofs = 0;
 839         qc->nsect = 0;
 840         qc->nbytes = qc->curbytes = 0;
 841         qc->err_mask = 0;
 842
 843         ata_tf_init(qc->dev, &qc->tf);
 844
 845         /* init result_tf such that it indicates normal completion */
 846         qc->result_tf.command = ATA_DRDY;
 847         qc->result_tf.feature = 0;
 848 }
 849
 850 /**
 851  *      ata_qc_complete - Complete an active ATA command
 852  *      @qc: Command to complete
 853  *      @err_mask: ATA Status register contents
 854  *
 855  *      Indicate to the mid and upper layers that an ATA
 856  *      command has completed, with either an ok or not-ok status.
 857  *
 858  *      LOCKING:
 859  *      spin_lock_irqsave(host_set lock)
 860  */
 861 static inline void ata_qc_complete(struct ata_queued_cmd *qc)
 862 {
 863         struct ata_port *ap = qc->ap;
 864
 865         if (unlikely(qc->flags & ATA_QCFLAG_EH_SCHEDULED))
 866                 return;
 867
 868         /* read result TF if failed or requested */
 869         if (qc->err_mask || qc->flags & ATA_QCFLAG_RESULT_TF)
 870                 ap->ops->tf_read(ap, &qc->result_tf);
 871
 872         __ata_qc_complete(qc);
 873 }
 874
 875 /**
 876  *      ata_irq_on - Enable interrupts on a port.
 877  *      @ap: Port on which interrupts are enabled.
 878  *
 879  *      Enable interrupts on a legacy IDE device using MMIO or PIO,
 880  *      wait for idle, clear any pending interrupts.
 881  *
 882  *      LOCKING:
 883  *      Inherited from caller.
 884  */
 885
 886 static inline u8 ata_irq_on(struct ata_port *ap)
 887 {
 888         struct ata_ioports *ioaddr = &ap->ioaddr;
 889         u8 tmp;
 890
 891         ap->ctl &= ~ATA_NIEN;
 892         ap->last_ctl = ap->ctl;
 893
 894         if (ap->flags & ATA_FLAG_MMIO)
 895                 writeb(ap->ctl, (void __iomem *) ioaddr->ctl_addr);
 896         else
 897                 outb(ap->ctl, ioaddr->ctl_addr);
 898         tmp = ata_wait_idle(ap);
 899
 900         ap->ops->irq_clear(ap);
 901
 902         return tmp;
 903 }
 904
 905
 906 /**
 907  *      ata_irq_ack - Acknowledge a device interrupt.
 908  *      @ap: Port on which interrupts are enabled.
 909  *
 910  *      Wait up to 10 ms for legacy IDE device to become idle (BUSY
 911  *      or BUSY+DRQ clear).  Obtain dma status and port status from
 912  *      device.  Clear the interrupt.  Return port status.
 913  *
 914  *      LOCKING:
 915  */
 916
 917 static inline u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq)
 918 {
 919         unsigned int bits = chk_drq ? ATA_BUSY | ATA_DRQ : ATA_BUSY;
 920         u8 host_stat, post_stat, status;
 921
 922         status = ata_busy_wait(ap, bits, 1000);
 923         if (status & bits)
 924                 if (ata_msg_err(ap))
 925                         printk(KERN_ERR "abnormal status 0x%X\n", status);
 926
 927         /* get controller status; clear intr, err bits */
 928         if (ap->flags & ATA_FLAG_MMIO) {
 929                 void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr;
 930                 host_stat = readb(mmio + ATA_DMA_STATUS);
 931                 writeb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
 932                        mmio + ATA_DMA_STATUS);
 933
 934                 post_stat = readb(mmio + ATA_DMA_STATUS);
 935         } else {
 936                 host_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
 937                 outb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
 938                      ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
 939
 940                 post_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
 941         }
 942
 943         if (ata_msg_intr(ap))
 944                 printk(KERN_INFO "%s: irq ack: host_stat 0x%X, new host_stat 0x%X, drv_stat 0x%X\n",
 945                         __FUNCTION__,
 946                         host_stat, post_stat, status);
 947
 948         return status;
 949 }
 950
 951 static inline int ata_try_flush_cache(const struct ata_device *dev)
 952 {
 953         return ata_id_wcache_enabled(dev->id) ||
 954                ata_id_has_flush(dev->id) ||
 955                ata_id_has_flush_ext(dev->id);
 956 }
 957
 958 static inline unsigned int ac_err_mask(u8 status)
 959 {
 960         if (status & ATA_BUSY)
 961                 return AC_ERR_HSM;
 962         if (status & (ATA_ERR | ATA_DF))
 963                 return AC_ERR_DEV;
 964         return 0;
 965 }
 966
 967 static inline unsigned int __ac_err_mask(u8 status)
 968 {
 969         unsigned int mask = ac_err_mask(status);
 970         if (mask == 0)
 971                 return AC_ERR_OTHER;
 972         return mask;
 973 }
 974
 975 static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
 976 {
 977         ap->pad_dma = 0;
 978         ap->pad = dma_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
 979                                      &ap->pad_dma, GFP_KERNEL);
 980         return (ap->pad == NULL) ? -ENOMEM : 0;
 981 }
 982
 983 static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
 984 {
 985         dma_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
 986 }
 987
 988 static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
 989 {
 990         return (struct ata_port *) &host->hostdata[0];
 991 }
 992
 993 #endif /* __LINUX_LIBATA_H__ */