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

   1 #ifndef _IDE_H
   2 #define _IDE_H
   3 /*
   4  *  linux/include/linux/ide.h
   5  *
   6  *  Copyright (C) 1994-2002  Linus Torvalds & authors
   7  */
   8
   9 #include <linux/init.h>
  10 #include <linux/ioport.h>
  11 #include <linux/ata.h>
  12 #include <linux/blkdev.h>
  13 #include <linux/proc_fs.h>
  14 #include <linux/interrupt.h>
  15 #include <linux/bitops.h>
  16 #include <linux/bio.h>
  17 #include <linux/device.h>
  18 #include <linux/pci.h>
  19 #include <linux/completion.h>
  20 #include <linux/pm.h>
  21 #ifdef CONFIG_BLK_DEV_IDEACPI
  22 #include <acpi/acpi.h>
  23 #endif
  24 #include <asm/byteorder.h>
  25 #include <asm/system.h>
  26 #include <asm/io.h>
  27 #include <asm/mutex.h>
  28
  29 /* for request_sense */
  30 #include <linux/cdrom.h>
  31
  32 #if defined(CONFIG_CRIS) || defined(CONFIG_FRV) || defined(CONFIG_MN10300)
  33 # define SUPPORT_VLB_SYNC 0
  34 #else
  35 # define SUPPORT_VLB_SYNC 1
  36 #endif
  37
  38 /*
  39  * Probably not wise to fiddle with these
  40  */
  41 #define IDE_DEFAULT_MAX_FAILURES        1
  42 #define ERROR_MAX       8       /* Max read/write errors per sector */
  43 #define ERROR_RESET     3       /* Reset controller every 4th retry */
  44 #define ERROR_RECAL     1       /* Recalibrate every 2nd retry */
  45
  46 /* Error codes returned in rq->errors to the higher part of the driver. */
  47 enum {
  48         IDE_DRV_ERROR_GENERAL   = 101,
  49         IDE_DRV_ERROR_FILEMARK  = 102,
  50         IDE_DRV_ERROR_EOD       = 103,
  51 };
  52
  53 /*
  54  * Definitions for accessing IDE controller registers
  55  */
  56 #define IDE_NR_PORTS            (10)
  57
  58 struct ide_io_ports {
  59         unsigned long   data_addr;
  60
  61         union {
  62                 unsigned long error_addr;       /*   read:  error */
  63                 unsigned long feature_addr;     /*  write: feature */
  64         };
  65
  66         unsigned long   nsect_addr;
  67         unsigned long   lbal_addr;
  68         unsigned long   lbam_addr;
  69         unsigned long   lbah_addr;
  70
  71         unsigned long   device_addr;
  72
  73         union {
  74                 unsigned long status_addr;      /*  read: status  */
  75                 unsigned long command_addr;     /* write: command */
  76         };
  77
  78         unsigned long   ctl_addr;
  79
  80         unsigned long   irq_addr;
  81 };
  82
  83 #define OK_STAT(stat,good,bad)  (((stat)&((good)|(bad)))==(good))
  84
  85 #define BAD_R_STAT      (ATA_BUSY | ATA_ERR)
  86 #define BAD_W_STAT      (BAD_R_STAT | ATA_DF)
  87 #define BAD_STAT        (BAD_R_STAT | ATA_DRQ)
  88 #define DRIVE_READY     (ATA_DRDY | ATA_DSC)
  89
  90 #define BAD_CRC         (ATA_ABORTED | ATA_ICRC)
  91
  92 #define SATA_NR_PORTS           (3)     /* 16 possible ?? */
  93
  94 #define SATA_STATUS_OFFSET      (0)
  95 #define SATA_ERROR_OFFSET       (1)
  96 #define SATA_CONTROL_OFFSET     (2)
  97
  98 /*
  99  * Our Physical Region Descriptor (PRD) table should be large enough
 100  * to handle the biggest I/O request we are likely to see.  Since requests
 101  * can have no more than 256 sectors, and since the typical blocksize is
 102  * two or more sectors, we could get by with a limit of 128 entries here for
 103  * the usual worst case.  Most requests seem to include some contiguous blocks,
 104  * further reducing the number of table entries required.
 105  *
 106  * The driver reverts to PIO mode for individual requests that exceed
 107  * this limit (possible with 512 byte blocksizes, eg. MSDOS f/s), so handling
 108  * 100% of all crazy scenarios here is not necessary.
 109  *
 110  * As it turns out though, we must allocate a full 4KB page for this,
 111  * so the two PRD tables (ide0 & ide1) will each get half of that,
 112  * allowing each to have about 256 entries (8 bytes each) from this.
 113  */
 114 #define PRD_BYTES       8
 115 #define PRD_ENTRIES     256
 116
 117 /*
 118  * Some more useful definitions
 119  */
 120 #define PARTN_BITS      6       /* number of minor dev bits for partitions */
 121 #define MAX_DRIVES      2       /* per interface; 2 assumed by lots of code */
 122 #define SECTOR_SIZE     512
 123
 124 /*
 125  * Timeouts for various operations:
 126  */
 127 enum {
 128         /* spec allows up to 20ms */
 129         WAIT_DRQ        = HZ / 10,      /* 100ms */
 130         /* some laptops are very slow */
 131         WAIT_READY      = 5 * HZ,       /* 5s */
 132         /* should be less than 3ms (?), if all ATAPI CD is closed at boot */
 133         WAIT_PIDENTIFY  = 10 * HZ,      /* 10s */
 134         /* worst case when spinning up */
 135         WAIT_WORSTCASE  = 30 * HZ,      /* 30s */
 136         /* maximum wait for an IRQ to happen */
 137         WAIT_CMD        = 10 * HZ,      /* 10s */
 138         /* Some drives require a longer IRQ timeout. */
 139         WAIT_FLOPPY_CMD = 50 * HZ,      /* 50s */
 140         /*
 141          * Some drives (for example, Seagate STT3401A Travan) require a very
 142          * long timeout, because they don't return an interrupt or clear their
 143          * BSY bit until after the command completes (even retension commands).
 144          */
 145         WAIT_TAPE_CMD   = 900 * HZ,     /* 900s */
 146         /* minimum sleep time */
 147         WAIT_MIN_SLEEP  = HZ / 50,      /* 20ms */
 148 };
 149
 150 /*
 151  * Op codes for special requests to be handled by ide_special_rq().
 152  * Values should be in the range of 0x20 to 0x3f.
 153  */
 154 #define REQ_DRIVE_RESET         0x20
 155 #define REQ_DEVSET_EXEC         0x21
 156 #define REQ_PARK_HEADS          0x22
 157 #define REQ_UNPARK_HEADS        0x23
 158
 159 /*
 160  * hwif_chipset_t is used to keep track of the specific hardware
 161  * chipset used by each IDE interface, if known.
 162  */
 163 enum {          ide_unknown,    ide_generic,    ide_pci,
 164                 ide_cmd640,     ide_dtc2278,    ide_ali14xx,
 165                 ide_qd65xx,     ide_umc8672,    ide_ht6560b,
 166                 ide_4drives,    ide_pmac,       ide_acorn,
 167                 ide_au1xxx,     ide_palm3710
 168 };
 169
 170 typedef u8 hwif_chipset_t;
 171
 172 /*
 173  * Structure to hold all information about the location of this port
 174  */
 175 struct ide_hw {
 176         union {
 177                 struct ide_io_ports     io_ports;
 178                 unsigned long           io_ports_array[IDE_NR_PORTS];
 179         };
 180
 181         int             irq;                    /* our irq number */
 182         struct device   *dev, *parent;
 183         unsigned long   config;
 184 };
 185
 186 static inline void ide_std_init_ports(struct ide_hw *hw,
 187                                       unsigned long io_addr,
 188                                       unsigned long ctl_addr)
 189 {
 190         unsigned int i;
 191
 192         for (i = 0; i <= 7; i++)
 193                 hw->io_ports_array[i] = io_addr++;
 194
 195         hw->io_ports.ctl_addr = ctl_addr;
 196 }
 197
 198 #define MAX_HWIFS       10
 199
 200 /*
 201  * Now for the data we need to maintain per-drive:  ide_drive_t
 202  */
 203
 204 #define ide_scsi        0x21
 205 #define ide_disk        0x20
 206 #define ide_optical     0x7
 207 #define ide_cdrom       0x5
 208 #define ide_tape        0x1
 209 #define ide_floppy      0x0
 210
 211 /*
 212  * Special Driver Flags
 213  */
 214 enum {
 215         IDE_SFLAG_SET_GEOMETRY          = (1 << 0),
 216         IDE_SFLAG_RECALIBRATE           = (1 << 1),
 217         IDE_SFLAG_SET_MULTMODE          = (1 << 2),
 218 };
 219
 220 /*
 221  * Status returned from various ide_ functions
 222  */
 223 typedef enum {
 224         ide_stopped,    /* no drive operation was started */
 225         ide_started,    /* a drive operation was started, handler was set */
 226 } ide_startstop_t;
 227
 228 enum {
 229         IDE_VALID_ERROR                 = (1 << 1),
 230         IDE_VALID_FEATURE               = IDE_VALID_ERROR,
 231         IDE_VALID_NSECT                 = (1 << 2),
 232         IDE_VALID_LBAL                  = (1 << 3),
 233         IDE_VALID_LBAM                  = (1 << 4),
 234         IDE_VALID_LBAH                  = (1 << 5),
 235         IDE_VALID_DEVICE                = (1 << 6),
 236         IDE_VALID_LBA                   = IDE_VALID_LBAL |
 237                                           IDE_VALID_LBAM |
 238                                           IDE_VALID_LBAH,
 239         IDE_VALID_OUT_TF                = IDE_VALID_FEATURE |
 240                                           IDE_VALID_NSECT |
 241                                           IDE_VALID_LBA,
 242         IDE_VALID_IN_TF                 = IDE_VALID_NSECT |
 243                                           IDE_VALID_LBA,
 244         IDE_VALID_OUT_HOB               = IDE_VALID_OUT_TF,
 245         IDE_VALID_IN_HOB                = IDE_VALID_ERROR |
 246                                           IDE_VALID_NSECT |
 247                                           IDE_VALID_LBA,
 248 };
 249
 250 enum {
 251         IDE_TFLAG_LBA48                 = (1 << 0),
 252         IDE_TFLAG_WRITE                 = (1 << 1),
 253         IDE_TFLAG_CUSTOM_HANDLER        = (1 << 2),
 254         IDE_TFLAG_DMA_PIO_FALLBACK      = (1 << 3),
 255         /* force 16-bit I/O operations */
 256         IDE_TFLAG_IO_16BIT              = (1 << 4),
 257         /* struct ide_cmd was allocated using kmalloc() */
 258         IDE_TFLAG_DYN                   = (1 << 5),
 259         IDE_TFLAG_FS                    = (1 << 6),
 260         IDE_TFLAG_MULTI_PIO             = (1 << 7),
 261 };
 262
 263 enum {
 264         IDE_FTFLAG_FLAGGED              = (1 << 0),
 265         IDE_FTFLAG_SET_IN_FLAGS         = (1 << 1),
 266         IDE_FTFLAG_OUT_DATA             = (1 << 2),
 267         IDE_FTFLAG_IN_DATA              = (1 << 3),
 268 };
 269
 270 struct ide_taskfile {
 271         u8      data;           /* 0: data byte (for TASKFILE ioctl) */
 272         union {                 /* 1: */
 273                 u8 error;       /*  read: error */
 274                 u8 feature;     /* write: feature */
 275         };
 276         u8      nsect;          /* 2: number of sectors */
 277         u8      lbal;           /* 3: LBA low */
 278         u8      lbam;           /* 4: LBA mid */
 279         u8      lbah;           /* 5: LBA high */
 280         u8      device;         /* 6: device select */
 281         union {                 /* 7: */
 282                 u8 status;      /*  read: status */
 283                 u8 command;     /* write: command */
 284         };
 285 };
 286
 287 struct ide_cmd {
 288         struct ide_taskfile     tf;
 289         struct ide_taskfile     hob;
 290         struct {
 291                 struct {
 292                         u8              tf;
 293                         u8              hob;
 294                 } out, in;
 295         } valid;
 296
 297         u8                      tf_flags;
 298         u8                      ftf_flags;      /* for TASKFILE ioctl */
 299         int                     protocol;
 300
 301         int                     sg_nents;         /* number of sg entries */
 302         int                     orig_sg_nents;
 303         int                     sg_dma_direction; /* DMA transfer direction */
 304
 305         unsigned int            nbytes;
 306         unsigned int            nleft;
 307         unsigned int            last_xfer_len;
 308
 309         struct scatterlist      *cursg;
 310         unsigned int            cursg_ofs;
 311
 312         struct request          *rq;            /* copy of request */
 313 };
 314
 315 /* ATAPI packet command flags */
 316 enum {
 317         /* set when an error is considered normal - no retry (ide-tape) */
 318         PC_FLAG_ABORT                   = (1 << 0),
 319         PC_FLAG_SUPPRESS_ERROR          = (1 << 1),
 320         PC_FLAG_WAIT_FOR_DSC            = (1 << 2),
 321         PC_FLAG_DMA_OK                  = (1 << 3),
 322         PC_FLAG_DMA_IN_PROGRESS         = (1 << 4),
 323         PC_FLAG_DMA_ERROR               = (1 << 5),
 324         PC_FLAG_WRITING                 = (1 << 6),
 325 };
 326
 327 #define ATAPI_WAIT_PC           (60 * HZ)
 328
 329 struct ide_atapi_pc {
 330         /* actual packet bytes */
 331         u8 c[12];
 332         /* incremented on each retry */
 333         int retries;
 334         int error;
 335
 336         /* bytes to transfer */
 337         int req_xfer;
 338
 339         /* the corresponding request */
 340         struct request *rq;
 341
 342         unsigned long flags;
 343
 344         /*
 345          * those are more or less driver-specific and some of them are subject
 346          * to change/removal later.
 347          */
 348         unsigned long timeout;
 349 };
 350
 351 struct ide_devset;
 352 struct ide_driver;
 353
 354 #ifdef CONFIG_BLK_DEV_IDEACPI
 355 struct ide_acpi_drive_link;
 356 struct ide_acpi_hwif_link;
 357 #endif
 358
 359 struct ide_drive_s;
 360
 361 struct ide_disk_ops {
 362         int             (*check)(struct ide_drive_s *, const char *);
 363         int             (*get_capacity)(struct ide_drive_s *);
 364         u64             (*set_capacity)(struct ide_drive_s *, u64);
 365         void            (*setup)(struct ide_drive_s *);
 366         void            (*flush)(struct ide_drive_s *);
 367         int             (*init_media)(struct ide_drive_s *, struct gendisk *);
 368         int             (*set_doorlock)(struct ide_drive_s *, struct gendisk *,
 369                                         int);
 370         ide_startstop_t (*do_request)(struct ide_drive_s *, struct request *,
 371                                       sector_t);
 372         int             (*ioctl)(struct ide_drive_s *, struct block_device *,
 373                                  fmode_t, unsigned int, unsigned long);
 374 };
 375
 376 /* ATAPI device flags */
 377 enum {
 378         IDE_AFLAG_DRQ_INTERRUPT         = (1 << 0),
 379
 380         /* ide-cd */
 381         /* Drive cannot eject the disc. */
 382         IDE_AFLAG_NO_EJECT              = (1 << 1),
 383         /* Drive is a pre ATAPI 1.2 drive. */
 384         IDE_AFLAG_PRE_ATAPI12           = (1 << 2),
 385         /* TOC addresses are in BCD. */
 386         IDE_AFLAG_TOCADDR_AS_BCD        = (1 << 3),
 387         /* TOC track numbers are in BCD. */
 388         IDE_AFLAG_TOCTRACKS_AS_BCD      = (1 << 4),
 389         /* Saved TOC information is current. */
 390         IDE_AFLAG_TOC_VALID             = (1 << 6),
 391         /* We think that the drive door is locked. */
 392         IDE_AFLAG_DOOR_LOCKED           = (1 << 7),
 393         /* SET_CD_SPEED command is unsupported. */
 394         IDE_AFLAG_NO_SPEED_SELECT       = (1 << 8),
 395         IDE_AFLAG_VERTOS_300_SSD        = (1 << 9),
 396         IDE_AFLAG_VERTOS_600_ESD        = (1 << 10),
 397         IDE_AFLAG_SANYO_3CD             = (1 << 11),
 398         IDE_AFLAG_FULL_CAPS_PAGE        = (1 << 12),
 399         IDE_AFLAG_PLAY_AUDIO_OK         = (1 << 13),
 400         IDE_AFLAG_LE_SPEED_FIELDS       = (1 << 14),
 401
 402         /* ide-floppy */
 403         /* Avoid commands not supported in Clik drive */
 404         IDE_AFLAG_CLIK_DRIVE            = (1 << 15),
 405         /* Requires BH algorithm for packets */
 406         IDE_AFLAG_ZIP_DRIVE             = (1 << 16),
 407         /* Supports format progress report */
 408         IDE_AFLAG_SRFP                  = (1 << 17),
 409
 410         /* ide-tape */
 411         IDE_AFLAG_IGNORE_DSC            = (1 << 18),
 412         /* 0 When the tape position is unknown */
 413         IDE_AFLAG_ADDRESS_VALID         = (1 << 19),
 414         /* Device already opened */
 415         IDE_AFLAG_BUSY                  = (1 << 20),
 416         /* Attempt to auto-detect the current user block size */
 417         IDE_AFLAG_DETECT_BS             = (1 << 21),
 418         /* Currently on a filemark */
 419         IDE_AFLAG_FILEMARK              = (1 << 22),
 420         /* 0 = no tape is loaded, so we don't rewind after ejecting */
 421         IDE_AFLAG_MEDIUM_PRESENT        = (1 << 23),
 422
 423         IDE_AFLAG_NO_AUTOCLOSE          = (1 << 24),
 424 };
 425
 426 /* device flags */
 427 enum {
 428         /* restore settings after device reset */
 429         IDE_DFLAG_KEEP_SETTINGS         = (1 << 0),
 430         /* device is using DMA for read/write */
 431         IDE_DFLAG_USING_DMA             = (1 << 1),
 432         /* okay to unmask other IRQs */
 433         IDE_DFLAG_UNMASK                = (1 << 2),
 434         /* don't attempt flushes */
 435         IDE_DFLAG_NOFLUSH               = (1 << 3),
 436         /* DSC overlap */
 437         IDE_DFLAG_DSC_OVERLAP           = (1 << 4),
 438         /* give potential excess bandwidth */
 439         IDE_DFLAG_NICE1                 = (1 << 5),
 440         /* device is physically present */
 441         IDE_DFLAG_PRESENT               = (1 << 6),
 442         /* disable Host Protected Area */
 443         IDE_DFLAG_NOHPA                 = (1 << 7),
 444         /* id read from device (synthetic if not set) */
 445         IDE_DFLAG_ID_READ               = (1 << 8),
 446         IDE_DFLAG_NOPROBE               = (1 << 9),
 447         /* need to do check_media_change() */
 448         IDE_DFLAG_REMOVABLE             = (1 << 10),
 449         /* needed for removable devices */
 450         IDE_DFLAG_ATTACH                = (1 << 11),
 451         IDE_DFLAG_FORCED_GEOM           = (1 << 12),
 452         /* disallow setting unmask bit */
 453         IDE_DFLAG_NO_UNMASK             = (1 << 13),
 454         /* disallow enabling 32-bit I/O */
 455         IDE_DFLAG_NO_IO_32BIT           = (1 << 14),
 456         /* for removable only: door lock/unlock works */
 457         IDE_DFLAG_DOORLOCKING           = (1 << 15),
 458         /* disallow DMA */
 459         IDE_DFLAG_NODMA                 = (1 << 16),
 460         /* powermanagment told us not to do anything, so sleep nicely */
 461         IDE_DFLAG_BLOCKED               = (1 << 17),
 462         /* sleeping & sleep field valid */
 463         IDE_DFLAG_SLEEPING              = (1 << 18),
 464         IDE_DFLAG_POST_RESET            = (1 << 19),
 465         IDE_DFLAG_UDMA33_WARNED         = (1 << 20),
 466         IDE_DFLAG_LBA48                 = (1 << 21),
 467         /* status of write cache */
 468         IDE_DFLAG_WCACHE                = (1 << 22),
 469         /* used for ignoring ATA_DF */
 470         IDE_DFLAG_NOWERR                = (1 << 23),
 471         /* retrying in PIO */
 472         IDE_DFLAG_DMA_PIO_RETRY         = (1 << 24),
 473         IDE_DFLAG_LBA                   = (1 << 25),
 474         /* don't unload heads */
 475         IDE_DFLAG_NO_UNLOAD             = (1 << 26),
 476         /* heads unloaded, please don't reset port */
 477         IDE_DFLAG_PARKED                = (1 << 27),
 478         IDE_DFLAG_MEDIA_CHANGED         = (1 << 28),
 479         /* write protect */
 480         IDE_DFLAG_WP                    = (1 << 29),
 481         IDE_DFLAG_FORMAT_IN_PROGRESS    = (1 << 30),
 482         IDE_DFLAG_NIEN_QUIRK            = (1 << 31),
 483 };
 484
 485 struct ide_drive_s {
 486         char            name[4];        /* drive name, such as "hda" */
 487         char            driver_req[10]; /* requests specific driver */
 488
 489         struct request_queue    *queue; /* request queue */
 490
 491         struct request          *rq;    /* current request */
 492         void            *driver_data;   /* extra driver data */
 493         u16                     *id;    /* identification info */
 494 #ifdef CONFIG_IDE_PROC_FS
 495         struct proc_dir_entry *proc;    /* /proc/ide/ directory entry */
 496         const struct ide_proc_devset *settings; /* /proc/ide/ drive settings */
 497 #endif
 498         struct hwif_s           *hwif;  /* actually (ide_hwif_t *) */
 499
 500         const struct ide_disk_ops *disk_ops;
 501
 502         unsigned long dev_flags;
 503
 504         unsigned long sleep;            /* sleep until this time */
 505         unsigned long timeout;          /* max time to wait for irq */
 506
 507         u8      special_flags;          /* special action flags */
 508
 509         u8      select;                 /* basic drive/head select reg value */
 510         u8      retry_pio;              /* retrying dma capable host in pio */
 511         u8      waiting_for_dma;        /* dma currently in progress */
 512         u8      dma;                    /* atapi dma flag */
 513
 514         u8      init_speed;     /* transfer rate set at boot */
 515         u8      current_speed;  /* current transfer rate set */
 516         u8      desired_speed;  /* desired transfer rate set */
 517         u8      dn;             /* now wide spread use */
 518         u8      acoustic;       /* acoustic management */
 519         u8      media;          /* disk, cdrom, tape, floppy, ... */
 520         u8      ready_stat;     /* min status value for drive ready */
 521         u8      mult_count;     /* current multiple sector setting */
 522         u8      mult_req;       /* requested multiple sector setting */
 523         u8      io_32bit;       /* 0=16-bit, 1=32-bit, 2/3=32bit+sync */
 524         u8      bad_wstat;      /* used for ignoring ATA_DF */
 525         u8      head;           /* "real" number of heads */
 526         u8      sect;           /* "real" sectors per track */
 527         u8      bios_head;      /* BIOS/fdisk/LILO number of heads */
 528         u8      bios_sect;      /* BIOS/fdisk/LILO sectors per track */
 529
 530         /* delay this long before sending packet command */
 531         u8 pc_delay;
 532
 533         unsigned int    bios_cyl;       /* BIOS/fdisk/LILO number of cyls */
 534         unsigned int    cyl;            /* "real" number of cyls */
 535         void            *drive_data;    /* used by set_pio_mode/dev_select() */
 536         unsigned int    failures;       /* current failure count */
 537         unsigned int    max_failures;   /* maximum allowed failure count */
 538         u64             probed_capacity;/* initial/native media capacity */
 539         u64             capacity64;     /* total number of sectors */
 540
 541         int             lun;            /* logical unit */
 542         int             crc_count;      /* crc counter to reduce drive speed */
 543
 544         unsigned long   debug_mask;     /* debugging levels switch */
 545
 546 #ifdef CONFIG_BLK_DEV_IDEACPI
 547         struct ide_acpi_drive_link *acpidata;
 548 #endif
 549         struct list_head list;
 550         struct device   gendev;
 551         struct completion gendev_rel_comp;      /* to deal with device release() */
 552
 553         /* current packet command */
 554         struct ide_atapi_pc *pc;
 555
 556         /* last failed packet command */
 557         struct ide_atapi_pc *failed_pc;
 558
 559         /* callback for packet commands */
 560         int  (*pc_callback)(struct ide_drive_s *, int);
 561
 562         ide_startstop_t (*irq_handler)(struct ide_drive_s *);
 563
 564         unsigned long atapi_flags;
 565
 566         struct ide_atapi_pc request_sense_pc;
 567
 568         /* current sense rq and buffer */
 569         bool sense_rq_armed;
 570         struct request sense_rq;
 571         struct request_sense sense_data;
 572 };
 573
 574 typedef struct ide_drive_s ide_drive_t;
 575
 576 #define to_ide_device(dev)              container_of(dev, ide_drive_t, gendev)
 577
 578 #define to_ide_drv(obj, cont_type)      \
 579         container_of(obj, struct cont_type, dev)
 580
 581 #define ide_drv_g(disk, cont_type)      \
 582         container_of((disk)->private_data, struct cont_type, driver)
 583
 584 struct ide_port_info;
 585
 586 struct ide_tp_ops {
 587         void    (*exec_command)(struct hwif_s *, u8);
 588         u8      (*read_status)(struct hwif_s *);
 589         u8      (*read_altstatus)(struct hwif_s *);
 590         void    (*write_devctl)(struct hwif_s *, u8);
 591
 592         void    (*dev_select)(ide_drive_t *);
 593         void    (*tf_load)(ide_drive_t *, struct ide_taskfile *, u8);
 594         void    (*tf_read)(ide_drive_t *, struct ide_taskfile *, u8);
 595
 596         void    (*input_data)(ide_drive_t *, struct ide_cmd *,
 597                               void *, unsigned int);
 598         void    (*output_data)(ide_drive_t *, struct ide_cmd *,
 599                                void *, unsigned int);
 600 };
 601
 602 extern const struct ide_tp_ops default_tp_ops;
 603
 604 /**
 605  * struct ide_port_ops - IDE port operations
 606  *
 607  * @init_dev:           host specific initialization of a device
 608  * @set_pio_mode:       routine to program host for PIO mode
 609  * @set_dma_mode:       routine to program host for DMA mode
 610  * @reset_poll:         chipset polling based on hba specifics
 611  * @pre_reset:          chipset specific changes to default for device-hba resets
 612  * @resetproc:          routine to reset controller after a disk reset
 613  * @maskproc:           special host masking for drive selection
 614  * @quirkproc:          check host's drive quirk list
 615  * @clear_irq:          clear IRQ
 616  *
 617  * @mdma_filter:        filter MDMA modes
 618  * @udma_filter:        filter UDMA modes
 619  *
 620  * @cable_detect:       detect cable type
 621  */
 622 struct ide_port_ops {
 623         void    (*init_dev)(ide_drive_t *);
 624         void    (*set_pio_mode)(ide_drive_t *, const u8);
 625         void    (*set_dma_mode)(ide_drive_t *, const u8);
 626         int     (*reset_poll)(ide_drive_t *);
 627         void    (*pre_reset)(ide_drive_t *);
 628         void    (*resetproc)(ide_drive_t *);
 629         void    (*maskproc)(ide_drive_t *, int);
 630         void    (*quirkproc)(ide_drive_t *);
 631         void    (*clear_irq)(ide_drive_t *);
 632         int     (*test_irq)(struct hwif_s *);
 633
 634         u8      (*mdma_filter)(ide_drive_t *);
 635         u8      (*udma_filter)(ide_drive_t *);
 636
 637         u8      (*cable_detect)(struct hwif_s *);
 638 };
 639
 640 struct ide_dma_ops {
 641         void    (*dma_host_set)(struct ide_drive_s *, int);
 642         int     (*dma_setup)(struct ide_drive_s *, struct ide_cmd *);
 643         void    (*dma_start)(struct ide_drive_s *);
 644         int     (*dma_end)(struct ide_drive_s *);
 645         int     (*dma_test_irq)(struct ide_drive_s *);
 646         void    (*dma_lost_irq)(struct ide_drive_s *);
 647         /* below ones are optional */
 648         int     (*dma_check)(struct ide_drive_s *, struct ide_cmd *);
 649         int     (*dma_timer_expiry)(struct ide_drive_s *);
 650         void    (*dma_clear)(struct ide_drive_s *);
 651         /*
 652          * The following method is optional and only required to be
 653          * implemented for the SFF-8038i compatible controllers.
 654          */
 655         u8      (*dma_sff_read_status)(struct hwif_s *);
 656 };
 657
 658 enum {
 659         IDE_PFLAG_PROBING               = (1 << 0),
 660 };
 661
 662 struct ide_host;
 663
 664 typedef struct hwif_s {
 665         struct hwif_s *mate;            /* other hwif from same PCI chip */
 666         struct proc_dir_entry *proc;    /* /proc/ide/ directory entry */
 667
 668         struct ide_host *host;
 669
 670         char name[6];                   /* name of interface, eg. "ide0" */
 671
 672         struct ide_io_ports     io_ports;
 673
 674         unsigned long   sata_scr[SATA_NR_PORTS];
 675
 676         ide_drive_t     *devices[MAX_DRIVES + 1];
 677
 678         unsigned long   port_flags;
 679
 680         u8 major;       /* our major number */
 681         u8 index;       /* 0 for ide0; 1 for ide1; ... */
 682         u8 channel;     /* for dual-port chips: 0=primary, 1=secondary */
 683
 684         u32 host_flags;
 685
 686         u8 pio_mask;
 687
 688         u8 ultra_mask;
 689         u8 mwdma_mask;
 690         u8 swdma_mask;
 691
 692         u8 cbl;         /* cable type */
 693
 694         hwif_chipset_t chipset; /* sub-module for tuning.. */
 695
 696         struct device *dev;
 697
 698         void (*rw_disk)(ide_drive_t *, struct request *);
 699
 700         const struct ide_tp_ops         *tp_ops;
 701         const struct ide_port_ops       *port_ops;
 702         const struct ide_dma_ops        *dma_ops;
 703
 704         /* dma physical region descriptor table (cpu view) */
 705         unsigned int    *dmatable_cpu;
 706         /* dma physical region descriptor table (dma view) */
 707         dma_addr_t      dmatable_dma;
 708
 709         /* maximum number of PRD table entries */
 710         int prd_max_nents;
 711         /* PRD entry size in bytes */
 712         int prd_ent_size;
 713
 714         /* Scatter-gather list used to build the above */
 715         struct scatterlist *sg_table;
 716         int sg_max_nents;               /* Maximum number of entries in it */
 717
 718         struct ide_cmd cmd;             /* current command */
 719
 720         int             rqsize;         /* max sectors per request */
 721         int             irq;            /* our irq number */
 722
 723         unsigned long   dma_base;       /* base addr for dma ports */
 724
 725         unsigned long   config_data;    /* for use by chipset-specific code */
 726         unsigned long   select_data;    /* for use by chipset-specific code */
 727
 728         unsigned long   extra_base;     /* extra addr for dma ports */
 729         unsigned        extra_ports;    /* number of extra dma ports */
 730
 731         unsigned        present    : 1; /* this interface exists */
 732         unsigned        busy       : 1; /* serializes devices on a port */
 733
 734         struct device           gendev;
 735         struct device           *portdev;
 736
 737         struct completion gendev_rel_comp; /* To deal with device release() */
 738
 739         void            *hwif_data;     /* extra hwif data */
 740
 741 #ifdef CONFIG_BLK_DEV_IDEACPI
 742         struct ide_acpi_hwif_link *acpidata;
 743 #endif
 744
 745         /* IRQ handler, if active */
 746         ide_startstop_t (*handler)(ide_drive_t *);
 747
 748         /* BOOL: polling active & poll_timeout field valid */
 749         unsigned int polling : 1;
 750
 751         /* current drive */
 752         ide_drive_t *cur_dev;
 753
 754         /* current request */
 755         struct request *rq;
 756
 757         /* failsafe timer */
 758         struct timer_list timer;
 759         /* timeout value during long polls */
 760         unsigned long poll_timeout;
 761         /* queried upon timeouts */
 762         int (*expiry)(ide_drive_t *);
 763
 764         int req_gen;
 765         int req_gen_timer;
 766
 767         spinlock_t lock;
 768 } ____cacheline_internodealigned_in_smp ide_hwif_t;
 769
 770 #define MAX_HOST_PORTS 4
 771
 772 struct ide_host {
 773         ide_hwif_t      *ports[MAX_HOST_PORTS + 1];
 774         unsigned int    n_ports;
 775         struct device   *dev[2];
 776
 777         int             (*init_chipset)(struct pci_dev *);
 778
 779         void            (*get_lock)(irq_handler_t, void *);
 780         void            (*release_lock)(void);
 781
 782         irq_handler_t   irq_handler;
 783
 784         unsigned long   host_flags;
 785
 786         int             irq_flags;
 787
 788         void            *host_priv;
 789         ide_hwif_t      *cur_port;      /* for hosts requiring serialization */
 790
 791         /* used for hosts requiring serialization */
 792         volatile unsigned long  host_busy;
 793 };
 794
 795 #define IDE_HOST_BUSY 0
 796
 797 /*
 798  *  internal ide interrupt handler type
 799  */
 800 typedef ide_startstop_t (ide_handler_t)(ide_drive_t *);
 801 typedef int (ide_expiry_t)(ide_drive_t *);
 802
 803 /* used by ide-cd, ide-floppy, etc. */
 804 typedef void (xfer_func_t)(ide_drive_t *, struct ide_cmd *, void *, unsigned);
 805
 806 extern struct mutex ide_setting_mtx;
 807
 808 /*
 809  * configurable drive settings
 810  */
 811
 812 #define DS_SYNC (1 << 0)
 813
 814 struct ide_devset {
 815         int             (*get)(ide_drive_t *);
 816         int             (*set)(ide_drive_t *, int);
 817         unsigned int    flags;
 818 };
 819
 820 #define __DEVSET(_flags, _get, _set) { \
 821         .flags  = _flags, \
 822         .get    = _get, \
 823         .set    = _set, \
 824 }
 825
 826 #define ide_devset_get(name, field) \
 827 static int get_##name(ide_drive_t *drive) \
 828 { \
 829         return drive->field; \
 830 }
 831
 832 #define ide_devset_set(name, field) \
 833 static int set_##name(ide_drive_t *drive, int arg) \
 834 { \
 835         drive->field = arg; \
 836         return 0; \
 837 }
 838
 839 #define ide_devset_get_flag(name, flag) \
 840 static int get_##name(ide_drive_t *drive) \
 841 { \
 842         return !!(drive->dev_flags & flag); \
 843 }
 844
 845 #define ide_devset_set_flag(name, flag) \
 846 static int set_##name(ide_drive_t *drive, int arg) \
 847 { \
 848         if (arg) \
 849                 drive->dev_flags |= flag; \
 850         else \
 851                 drive->dev_flags &= ~flag; \
 852         return 0; \
 853 }
 854
 855 #define __IDE_DEVSET(_name, _flags, _get, _set) \
 856 const struct ide_devset ide_devset_##_name = \
 857         __DEVSET(_flags, _get, _set)
 858
 859 #define IDE_DEVSET(_name, _flags, _get, _set) \
 860 static __IDE_DEVSET(_name, _flags, _get, _set)
 861
 862 #define ide_devset_rw(_name, _func) \
 863 IDE_DEVSET(_name, 0, get_##_func, set_##_func)
 864
 865 #define ide_devset_w(_name, _func) \
 866 IDE_DEVSET(_name, 0, NULL, set_##_func)
 867
 868 #define ide_ext_devset_rw(_name, _func) \
 869 __IDE_DEVSET(_name, 0, get_##_func, set_##_func)
 870
 871 #define ide_ext_devset_rw_sync(_name, _func) \
 872 __IDE_DEVSET(_name, DS_SYNC, get_##_func, set_##_func)
 873
 874 #define ide_decl_devset(_name) \
 875 extern const struct ide_devset ide_devset_##_name
 876
 877 ide_decl_devset(io_32bit);
 878 ide_decl_devset(keepsettings);
 879 ide_decl_devset(pio_mode);
 880 ide_decl_devset(unmaskirq);
 881 ide_decl_devset(using_dma);
 882
 883 #ifdef CONFIG_IDE_PROC_FS
 884 /*
 885  * /proc/ide interface
 886  */
 887
 888 #define ide_devset_rw_field(_name, _field) \
 889 ide_devset_get(_name, _field); \
 890 ide_devset_set(_name, _field); \
 891 IDE_DEVSET(_name, DS_SYNC, get_##_name, set_##_name)
 892
 893 #define ide_devset_rw_flag(_name, _field) \
 894 ide_devset_get_flag(_name, _field); \
 895 ide_devset_set_flag(_name, _field); \
 896 IDE_DEVSET(_name, DS_SYNC, get_##_name, set_##_name)
 897
 898 struct ide_proc_devset {
 899         const char              *name;
 900         const struct ide_devset *setting;
 901         int                     min, max;
 902         int                     (*mulf)(ide_drive_t *);
 903         int                     (*divf)(ide_drive_t *);
 904 };
 905
 906 #define __IDE_PROC_DEVSET(_name, _min, _max, _mulf, _divf) { \
 907         .name = __stringify(_name), \
 908         .setting = &ide_devset_##_name, \
 909         .min = _min, \
 910         .max = _max, \
 911         .mulf = _mulf, \
 912         .divf = _divf, \
 913 }
 914
 915 #define IDE_PROC_DEVSET(_name, _min, _max) \
 916 __IDE_PROC_DEVSET(_name, _min, _max, NULL, NULL)
 917
 918 typedef struct {
 919         const char      *name;
 920         mode_t          mode;
 921         read_proc_t     *read_proc;
 922         write_proc_t    *write_proc;
 923 } ide_proc_entry_t;
 924
 925 void proc_ide_create(void);
 926 void proc_ide_destroy(void);
 927 void ide_proc_register_port(ide_hwif_t *);
 928 void ide_proc_port_register_devices(ide_hwif_t *);
 929 void ide_proc_unregister_device(ide_drive_t *);
 930 void ide_proc_unregister_port(ide_hwif_t *);
 931 void ide_proc_register_driver(ide_drive_t *, struct ide_driver *);
 932 void ide_proc_unregister_driver(ide_drive_t *, struct ide_driver *);
 933
 934 read_proc_t proc_ide_read_capacity;
 935 read_proc_t proc_ide_read_geometry;
 936
 937 /*
 938  * Standard exit stuff:
 939  */
 940 #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) \
 941 {                                       \
 942         len -= off;                     \
 943         if (len < count) {              \
 944                 *eof = 1;               \
 945                 if (len <= 0)           \
 946                         return 0;       \
 947         } else                          \
 948                 len = count;            \
 949         *start = page + off;            \
 950         return len;                     \
 951 }
 952 #else
 953 static inline void proc_ide_create(void) { ; }
 954 static inline void proc_ide_destroy(void) { ; }
 955 static inline void ide_proc_register_port(ide_hwif_t *hwif) { ; }
 956 static inline void ide_proc_port_register_devices(ide_hwif_t *hwif) { ; }
 957 static inline void ide_proc_unregister_device(ide_drive_t *drive) { ; }
 958 static inline void ide_proc_unregister_port(ide_hwif_t *hwif) { ; }
 959 static inline void ide_proc_register_driver(ide_drive_t *drive,
 960                                             struct ide_driver *driver) { ; }
 961 static inline void ide_proc_unregister_driver(ide_drive_t *drive,
 962                                               struct ide_driver *driver) { ; }
 963 #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) return 0;
 964 #endif
 965
 966 enum {
 967         /* enter/exit functions */
 968         IDE_DBG_FUNC =                  (1 << 0),
 969         /* sense key/asc handling */
 970         IDE_DBG_SENSE =                 (1 << 1),
 971         /* packet commands handling */
 972         IDE_DBG_PC =                    (1 << 2),
 973         /* request handling */
 974         IDE_DBG_RQ =                    (1 << 3),
 975         /* driver probing/setup */
 976         IDE_DBG_PROBE =                 (1 << 4),
 977 };
 978
 979 /* DRV_NAME has to be defined in the driver before using the macro below */
 980 #define __ide_debug_log(lvl, fmt, args...)                              \
 981 {                                                                       \
 982         if (unlikely(drive->debug_mask & lvl))                          \
 983                 printk(KERN_INFO DRV_NAME ": %s: " fmt "\n",            \
 984                                           __func__, ## args);           \
 985 }
 986
 987 /*
 988  * Power Management state machine (rq->pm->pm_step).
 989  *
 990  * For each step, the core calls ide_start_power_step() first.
 991  * This can return:
 992  *      - ide_stopped : In this case, the core calls us back again unless
 993  *                      step have been set to ide_power_state_completed.
 994  *      - ide_started : In this case, the channel is left busy until an
 995  *                      async event (interrupt) occurs.
 996  * Typically, ide_start_power_step() will issue a taskfile request with
 997  * do_rw_taskfile().
 998  *
 999  * Upon reception of the interrupt, the core will call ide_complete_power_step()
1000  * with the error code if any. This routine should update the step value
1001  * and return. It should not start a new request. The core will call
1002  * ide_start_power_step() for the new step value, unless step have been
1003  * set to IDE_PM_COMPLETED.
1004  */
1005 enum {
1006         IDE_PM_START_SUSPEND,
1007         IDE_PM_FLUSH_CACHE      = IDE_PM_START_SUSPEND,
1008         IDE_PM_STANDBY,
1009
1010         IDE_PM_START_RESUME,
1011         IDE_PM_RESTORE_PIO      = IDE_PM_START_RESUME,
1012         IDE_PM_IDLE,
1013         IDE_PM_RESTORE_DMA,
1014
1015         IDE_PM_COMPLETED,
1016 };
1017
1018 int generic_ide_suspend(struct device *, pm_message_t);
1019 int generic_ide_resume(struct device *);
1020
1021 void ide_complete_power_step(ide_drive_t *, struct request *);
1022 ide_startstop_t ide_start_power_step(ide_drive_t *, struct request *);
1023 void ide_complete_pm_rq(ide_drive_t *, struct request *);
1024 void ide_check_pm_state(ide_drive_t *, struct request *);
1025
1026 /*
1027  * Subdrivers support.
1028  *
1029  * The gendriver.owner field should be set to the module owner of this driver.
1030  * The gendriver.name field should be set to the name of this driver
1031  */
1032 struct ide_driver {
1033         const char                      *version;
1034         ide_startstop_t (*do_request)(ide_drive_t *, struct request *, sector_t);
1035         struct device_driver    gen_driver;
1036         int             (*probe)(ide_drive_t *);
1037         void            (*remove)(ide_drive_t *);
1038         void            (*resume)(ide_drive_t *);
1039         void            (*shutdown)(ide_drive_t *);
1040 #ifdef CONFIG_IDE_PROC_FS
1041         ide_proc_entry_t *              (*proc_entries)(ide_drive_t *);
1042         const struct ide_proc_devset *  (*proc_devsets)(ide_drive_t *);
1043 #endif
1044 };
1045
1046 #define to_ide_driver(drv) container_of(drv, struct ide_driver, gen_driver)
1047
1048 int ide_device_get(ide_drive_t *);
1049 void ide_device_put(ide_drive_t *);
1050
1051 struct ide_ioctl_devset {
1052         unsigned int    get_ioctl;
1053         unsigned int    set_ioctl;
1054         const struct ide_devset *setting;
1055 };
1056
1057 int ide_setting_ioctl(ide_drive_t *, struct block_device *, unsigned int,
1058                       unsigned long, const struct ide_ioctl_devset *);
1059
1060 int generic_ide_ioctl(ide_drive_t *, struct block_device *, unsigned, unsigned long);
1061
1062 extern int ide_vlb_clk;
1063 extern int ide_pci_clk;
1064
1065 int ide_end_rq(ide_drive_t *, struct request *, int, unsigned int);
1066 void ide_kill_rq(ide_drive_t *, struct request *);
1067
1068 void __ide_set_handler(ide_drive_t *, ide_handler_t *, unsigned int);
1069 void ide_set_handler(ide_drive_t *, ide_handler_t *, unsigned int);
1070
1071 void ide_execute_command(ide_drive_t *, struct ide_cmd *, ide_handler_t *,
1072                          unsigned int);
1073
1074 void ide_pad_transfer(ide_drive_t *, int, int);
1075
1076 ide_startstop_t ide_error(ide_drive_t *, const char *, u8);
1077
1078 void ide_fix_driveid(u16 *);
1079
1080 extern void ide_fixstring(u8 *, const int, const int);
1081
1082 int ide_busy_sleep(ide_drive_t *, unsigned long, int);
1083
1084 int ide_wait_stat(ide_startstop_t *, ide_drive_t *, u8, u8, unsigned long);
1085
1086 ide_startstop_t ide_do_park_unpark(ide_drive_t *, struct request *);
1087 ide_startstop_t ide_do_devset(ide_drive_t *, struct request *);
1088
1089 extern ide_startstop_t ide_do_reset (ide_drive_t *);
1090
1091 extern int ide_devset_execute(ide_drive_t *drive,
1092                               const struct ide_devset *setting, int arg);
1093
1094 void ide_complete_cmd(ide_drive_t *, struct ide_cmd *, u8, u8);
1095 int ide_complete_rq(ide_drive_t *, int, unsigned int);
1096
1097 void ide_tf_readback(ide_drive_t *drive, struct ide_cmd *cmd);
1098 void ide_tf_dump(const char *, struct ide_cmd *);
1099
1100 void ide_exec_command(ide_hwif_t *, u8);
1101 u8 ide_read_status(ide_hwif_t *);
1102 u8 ide_read_altstatus(ide_hwif_t *);
1103 void ide_write_devctl(ide_hwif_t *, u8);
1104
1105 void ide_dev_select(ide_drive_t *);
1106 void ide_tf_load(ide_drive_t *, struct ide_taskfile *, u8);
1107 void ide_tf_read(ide_drive_t *, struct ide_taskfile *, u8);
1108
1109 void ide_input_data(ide_drive_t *, struct ide_cmd *, void *, unsigned int);
1110 void ide_output_data(ide_drive_t *, struct ide_cmd *, void *, unsigned int);
1111
1112 void SELECT_MASK(ide_drive_t *, int);
1113
1114 u8 ide_read_error(ide_drive_t *);
1115 void ide_read_bcount_and_ireason(ide_drive_t *, u16 *, u8 *);
1116
1117 int ide_check_ireason(ide_drive_t *, struct request *, int, int, int);
1118
1119 int ide_check_atapi_device(ide_drive_t *, const char *);
1120
1121 void ide_init_pc(struct ide_atapi_pc *);
1122
1123 /* Disk head parking */
1124 extern wait_queue_head_t ide_park_wq;
1125 ssize_t ide_park_show(struct device *dev, struct device_attribute *attr,
1126                       char *buf);
1127 ssize_t ide_park_store(struct device *dev, struct device_attribute *attr,
1128                        const char *buf, size_t len);
1129
1130 /*
1131  * Special requests for ide-tape block device strategy routine.
1132  *
1133  * In order to service a character device command, we add special requests to
1134  * the tail of our block device request queue and wait for their completion.
1135  */
1136 enum {
1137         REQ_IDETAPE_PC1         = (1 << 0), /* packet command (first stage) */
1138         REQ_IDETAPE_PC2         = (1 << 1), /* packet command (second stage) */
1139         REQ_IDETAPE_READ        = (1 << 2),
1140         REQ_IDETAPE_WRITE       = (1 << 3),
1141 };
1142
1143 int ide_queue_pc_tail(ide_drive_t *, struct gendisk *, struct ide_atapi_pc *,
1144                       void *, unsigned int);
1145
1146 int ide_do_test_unit_ready(ide_drive_t *, struct gendisk *);
1147 int ide_do_start_stop(ide_drive_t *, struct gendisk *, int);
1148 int ide_set_media_lock(ide_drive_t *, struct gendisk *, int);
1149 void ide_create_request_sense_cmd(ide_drive_t *, struct ide_atapi_pc *);
1150 void ide_retry_pc(ide_drive_t *drive);
1151
1152 void ide_prep_sense(ide_drive_t *drive, struct request *rq);
1153 int ide_queue_sense_rq(ide_drive_t *drive, void *special);
1154
1155 int ide_cd_expiry(ide_drive_t *);
1156
1157 int ide_cd_get_xferlen(struct request *);
1158
1159 ide_startstop_t ide_issue_pc(ide_drive_t *, struct ide_cmd *);
1160
1161 ide_startstop_t do_rw_taskfile(ide_drive_t *, struct ide_cmd *);
1162
1163 void ide_pio_bytes(ide_drive_t *, struct ide_cmd *, unsigned int, unsigned int);
1164
1165 void ide_finish_cmd(ide_drive_t *, struct ide_cmd *, u8);
1166
1167 int ide_raw_taskfile(ide_drive_t *, struct ide_cmd *, u8 *, u16);
1168 int ide_no_data_taskfile(ide_drive_t *, struct ide_cmd *);
1169
1170 int ide_taskfile_ioctl(ide_drive_t *, unsigned long);
1171
1172 int ide_dev_read_id(ide_drive_t *, u8, u16 *);
1173
1174 extern int ide_driveid_update(ide_drive_t *);
1175 extern int ide_config_drive_speed(ide_drive_t *, u8);
1176 extern u8 eighty_ninty_three (ide_drive_t *);
1177 extern int taskfile_lib_get_identify(ide_drive_t *drive, u8 *);
1178
1179 extern int ide_wait_not_busy(ide_hwif_t *hwif, unsigned long timeout);
1180
1181 extern void ide_stall_queue(ide_drive_t *drive, unsigned long timeout);
1182
1183 extern void ide_timer_expiry(unsigned long);
1184 extern irqreturn_t ide_intr(int irq, void *dev_id);
1185 extern void do_ide_request(struct request_queue *);
1186
1187 void ide_init_disk(struct gendisk *, ide_drive_t *);
1188
1189 #ifdef CONFIG_IDEPCI_PCIBUS_ORDER
1190 extern int __ide_pci_register_driver(struct pci_driver *driver, struct module *owner, const char *mod_name);
1191 #define ide_pci_register_driver(d) __ide_pci_register_driver(d, THIS_MODULE, KBUILD_MODNAME)
1192 #else
1193 #define ide_pci_register_driver(d) pci_register_driver(d)
1194 #endif
1195
1196 static inline int ide_pci_is_in_compatibility_mode(struct pci_dev *dev)
1197 {
1198         if ((dev->class >> 8) == PCI_CLASS_STORAGE_IDE && (dev->class & 5) != 5)
1199                 return 1;
1200         return 0;
1201 }
1202
1203 void ide_pci_setup_ports(struct pci_dev *, const struct ide_port_info *,
1204                          struct ide_hw *, struct ide_hw **);
1205 void ide_setup_pci_noise(struct pci_dev *, const struct ide_port_info *);
1206
1207 #ifdef CONFIG_BLK_DEV_IDEDMA_PCI
1208 int ide_pci_set_master(struct pci_dev *, const char *);
1209 unsigned long ide_pci_dma_base(ide_hwif_t *, const struct ide_port_info *);
1210 int ide_pci_check_simplex(ide_hwif_t *, const struct ide_port_info *);
1211 int ide_hwif_setup_dma(ide_hwif_t *, const struct ide_port_info *);
1212 #else
1213 static inline int ide_hwif_setup_dma(ide_hwif_t *hwif,
1214                                      const struct ide_port_info *d)
1215 {
1216         return -EINVAL;
1217 }
1218 #endif
1219
1220 struct ide_pci_enablebit {
1221         u8      reg;    /* byte pci reg holding the enable-bit */
1222         u8      mask;   /* mask to isolate the enable-bit */
1223         u8      val;    /* value of masked reg when "enabled" */
1224 };
1225
1226 enum {
1227         /* Uses ISA control ports not PCI ones. */
1228         IDE_HFLAG_ISA_PORTS             = (1 << 0),
1229         /* single port device */
1230         IDE_HFLAG_SINGLE                = (1 << 1),
1231         /* don't use legacy PIO blacklist */
1232         IDE_HFLAG_PIO_NO_BLACKLIST      = (1 << 2),
1233         /* set for the second port of QD65xx */
1234         IDE_HFLAG_QD_2ND_PORT           = (1 << 3),
1235         /* use PIO8/9 for prefetch off/on */
1236         IDE_HFLAG_ABUSE_PREFETCH        = (1 << 4),
1237         /* use PIO6/7 for fast-devsel off/on */
1238         IDE_HFLAG_ABUSE_FAST_DEVSEL     = (1 << 5),
1239         /* use 100-102 and 200-202 PIO values to set DMA modes */
1240         IDE_HFLAG_ABUSE_DMA_MODES       = (1 << 6),
1241         /*
1242          * keep DMA setting when programming PIO mode, may be used only
1243          * for hosts which have separate PIO and DMA timings (ie. PMAC)
1244          */
1245         IDE_HFLAG_SET_PIO_MODE_KEEP_DMA = (1 << 7),
1246         /* program host for the transfer mode after programming device */
1247         IDE_HFLAG_POST_SET_MODE         = (1 << 8),
1248         /* don't program host/device for the transfer mode ("smart" hosts) */
1249         IDE_HFLAG_NO_SET_MODE           = (1 << 9),
1250         /* trust BIOS for programming chipset/device for DMA */
1251         IDE_HFLAG_TRUST_BIOS_FOR_DMA    = (1 << 10),
1252         /* host is CS5510/CS5520 */
1253         IDE_HFLAG_CS5520                = (1 << 11),
1254         /* ATAPI DMA is unsupported */
1255         IDE_HFLAG_NO_ATAPI_DMA          = (1 << 12),
1256         /* set if host is a "non-bootable" controller */
1257         IDE_HFLAG_NON_BOOTABLE          = (1 << 13),
1258         /* host doesn't support DMA */
1259         IDE_HFLAG_NO_DMA                = (1 << 14),
1260         /* check if host is PCI IDE device before allowing DMA */
1261         IDE_HFLAG_NO_AUTODMA            = (1 << 15),
1262         /* host uses MMIO */
1263         IDE_HFLAG_MMIO                  = (1 << 16),
1264         /* no LBA48 */
1265         IDE_HFLAG_NO_LBA48              = (1 << 17),
1266         /* no LBA48 DMA */
1267         IDE_HFLAG_NO_LBA48_DMA          = (1 << 18),
1268         /* data FIFO is cleared by an error */
1269         IDE_HFLAG_ERROR_STOPS_FIFO      = (1 << 19),
1270         /* serialize ports */
1271         IDE_HFLAG_SERIALIZE             = (1 << 20),
1272         /* host is DTC2278 */
1273         IDE_HFLAG_DTC2278               = (1 << 21),
1274         /* 4 devices on a single set of I/O ports */
1275         IDE_HFLAG_4DRIVES               = (1 << 22),
1276         /* host is TRM290 */
1277         IDE_HFLAG_TRM290                = (1 << 23),
1278         /* use 32-bit I/O ops */
1279         IDE_HFLAG_IO_32BIT              = (1 << 24),
1280         /* unmask IRQs */
1281         IDE_HFLAG_UNMASK_IRQS           = (1 << 25),
1282         IDE_HFLAG_BROKEN_ALTSTATUS      = (1 << 26),
1283         /* serialize ports if DMA is possible (for sl82c105) */
1284         IDE_HFLAG_SERIALIZE_DMA         = (1 << 27),
1285         /* force host out of "simplex" mode */
1286         IDE_HFLAG_CLEAR_SIMPLEX         = (1 << 28),
1287         /* DSC overlap is unsupported */
1288         IDE_HFLAG_NO_DSC                = (1 << 29),
1289         /* never use 32-bit I/O ops */
1290         IDE_HFLAG_NO_IO_32BIT           = (1 << 30),
1291         /* never unmask IRQs */
1292         IDE_HFLAG_NO_UNMASK_IRQS        = (1 << 31),
1293 };
1294
1295 #ifdef CONFIG_BLK_DEV_OFFBOARD
1296 # define IDE_HFLAG_OFF_BOARD    0
1297 #else
1298 # define IDE_HFLAG_OFF_BOARD    IDE_HFLAG_NON_BOOTABLE
1299 #endif
1300
1301 struct ide_port_info {
1302         char                    *name;
1303
1304         int                     (*init_chipset)(struct pci_dev *);
1305
1306         void                    (*get_lock)(irq_handler_t, void *);
1307         void                    (*release_lock)(void);
1308
1309         void                    (*init_iops)(ide_hwif_t *);
1310         void                    (*init_hwif)(ide_hwif_t *);
1311         int                     (*init_dma)(ide_hwif_t *,
1312                                             const struct ide_port_info *);
1313
1314         const struct ide_tp_ops         *tp_ops;
1315         const struct ide_port_ops       *port_ops;
1316         const struct ide_dma_ops        *dma_ops;
1317
1318         struct ide_pci_enablebit        enablebits[2];
1319
1320         hwif_chipset_t          chipset;
1321
1322         u16                     max_sectors;    /* if < than the default one */
1323
1324         u32                     host_flags;
1325
1326         int                     irq_flags;
1327
1328         u8                      pio_mask;
1329         u8                      swdma_mask;
1330         u8                      mwdma_mask;
1331         u8                      udma_mask;
1332 };
1333
1334 int ide_pci_init_one(struct pci_dev *, const struct ide_port_info *, void *);
1335 int ide_pci_init_two(struct pci_dev *, struct pci_dev *,
1336                      const struct ide_port_info *, void *);
1337 void ide_pci_remove(struct pci_dev *);
1338
1339 #ifdef CONFIG_PM
1340 int ide_pci_suspend(struct pci_dev *, pm_message_t);
1341 int ide_pci_resume(struct pci_dev *);
1342 #else
1343 #define ide_pci_suspend NULL
1344 #define ide_pci_resume NULL
1345 #endif
1346
1347 void ide_map_sg(ide_drive_t *, struct ide_cmd *);
1348 void ide_init_sg_cmd(struct ide_cmd *, unsigned int);
1349
1350 #define BAD_DMA_DRIVE           0
1351 #define GOOD_DMA_DRIVE          1
1352
1353 struct drive_list_entry {
1354         const char *id_model;
1355         const char *id_firmware;
1356 };
1357
1358 int ide_in_drive_list(u16 *, const struct drive_list_entry *);
1359
1360 #ifdef CONFIG_BLK_DEV_IDEDMA
1361 int ide_dma_good_drive(ide_drive_t *);
1362 int __ide_dma_bad_drive(ide_drive_t *);
1363
1364 u8 ide_find_dma_mode(ide_drive_t *, u8);
1365
1366 static inline u8 ide_max_dma_mode(ide_drive_t *drive)
1367 {
1368         return ide_find_dma_mode(drive, XFER_UDMA_6);
1369 }
1370
1371 void ide_dma_off_quietly(ide_drive_t *);
1372 void ide_dma_off(ide_drive_t *);
1373 void ide_dma_on(ide_drive_t *);
1374 int ide_set_dma(ide_drive_t *);
1375 void ide_check_dma_crc(ide_drive_t *);
1376 ide_startstop_t ide_dma_intr(ide_drive_t *);
1377
1378 int ide_allocate_dma_engine(ide_hwif_t *);
1379 void ide_release_dma_engine(ide_hwif_t *);
1380
1381 int ide_dma_prepare(ide_drive_t *, struct ide_cmd *);
1382 void ide_dma_unmap_sg(ide_drive_t *, struct ide_cmd *);
1383
1384 #ifdef CONFIG_BLK_DEV_IDEDMA_SFF
1385 int config_drive_for_dma(ide_drive_t *);
1386 int ide_build_dmatable(ide_drive_t *, struct ide_cmd *);
1387 void ide_dma_host_set(ide_drive_t *, int);
1388 int ide_dma_setup(ide_drive_t *, struct ide_cmd *);
1389 extern void ide_dma_start(ide_drive_t *);
1390 int ide_dma_end(ide_drive_t *);
1391 int ide_dma_test_irq(ide_drive_t *);
1392 int ide_dma_sff_timer_expiry(ide_drive_t *);
1393 u8 ide_dma_sff_read_status(ide_hwif_t *);
1394 extern const struct ide_dma_ops sff_dma_ops;
1395 #else
1396 static inline int config_drive_for_dma(ide_drive_t *drive) { return 0; }
1397 #endif /* CONFIG_BLK_DEV_IDEDMA_SFF */
1398
1399 void ide_dma_lost_irq(ide_drive_t *);
1400 ide_startstop_t ide_dma_timeout_retry(ide_drive_t *, int);
1401
1402 #else
1403 static inline u8 ide_find_dma_mode(ide_drive_t *drive, u8 speed) { return 0; }
1404 static inline u8 ide_max_dma_mode(ide_drive_t *drive) { return 0; }
1405 static inline void ide_dma_off_quietly(ide_drive_t *drive) { ; }
1406 static inline void ide_dma_off(ide_drive_t *drive) { ; }
1407 static inline void ide_dma_on(ide_drive_t *drive) { ; }
1408 static inline void ide_dma_verbose(ide_drive_t *drive) { ; }
1409 static inline int ide_set_dma(ide_drive_t *drive) { return 1; }
1410 static inline void ide_check_dma_crc(ide_drive_t *drive) { ; }
1411 static inline ide_startstop_t ide_dma_intr(ide_drive_t *drive) { return ide_stopped; }
1412 static inline ide_startstop_t ide_dma_timeout_retry(ide_drive_t *drive, int error) { return ide_stopped; }
1413 static inline void ide_release_dma_engine(ide_hwif_t *hwif) { ; }
1414 static inline int ide_dma_prepare(ide_drive_t *drive,
1415                                   struct ide_cmd *cmd) { return 1; }
1416 static inline void ide_dma_unmap_sg(ide_drive_t *drive,
1417                                     struct ide_cmd *cmd) { ; }
1418 #endif /* CONFIG_BLK_DEV_IDEDMA */
1419
1420 #ifdef CONFIG_BLK_DEV_IDEACPI
1421 int ide_acpi_init(void);
1422 bool ide_port_acpi(ide_hwif_t *hwif);
1423 extern int ide_acpi_exec_tfs(ide_drive_t *drive);
1424 extern void ide_acpi_get_timing(ide_hwif_t *hwif);
1425 extern void ide_acpi_push_timing(ide_hwif_t *hwif);
1426 void ide_acpi_init_port(ide_hwif_t *);
1427 void ide_acpi_port_init_devices(ide_hwif_t *);
1428 extern void ide_acpi_set_state(ide_hwif_t *hwif, int on);
1429 #else
1430 static inline int ide_acpi_init(void) { return 0; }
1431 static inline bool ide_port_acpi(ide_hwif_t *hwif) { return 0; }
1432 static inline int ide_acpi_exec_tfs(ide_drive_t *drive) { return 0; }
1433 static inline void ide_acpi_get_timing(ide_hwif_t *hwif) { ; }
1434 static inline void ide_acpi_push_timing(ide_hwif_t *hwif) { ; }
1435 static inline void ide_acpi_init_port(ide_hwif_t *hwif) { ; }
1436 static inline void ide_acpi_port_init_devices(ide_hwif_t *hwif) { ; }
1437 static inline void ide_acpi_set_state(ide_hwif_t *hwif, int on) {}
1438 #endif
1439
1440 void ide_register_region(struct gendisk *);
1441 void ide_unregister_region(struct gendisk *);
1442
1443 void ide_check_nien_quirk_list(ide_drive_t *);
1444 void ide_undecoded_slave(ide_drive_t *);
1445
1446 void ide_port_apply_params(ide_hwif_t *);
1447 int ide_sysfs_register_port(ide_hwif_t *);
1448
1449 struct ide_host *ide_host_alloc(const struct ide_port_info *, struct ide_hw **,
1450                                 unsigned int);
1451 void ide_host_free(struct ide_host *);
1452 int ide_host_register(struct ide_host *, const struct ide_port_info *,
1453                       struct ide_hw **);
1454 int ide_host_add(const struct ide_port_info *, struct ide_hw **, unsigned int,
1455                  struct ide_host **);
1456 void ide_host_remove(struct ide_host *);
1457 int ide_legacy_device_add(const struct ide_port_info *, unsigned long);
1458 void ide_port_unregister_devices(ide_hwif_t *);
1459 void ide_port_scan(ide_hwif_t *);
1460
1461 static inline void *ide_get_hwifdata (ide_hwif_t * hwif)
1462 {
1463         return hwif->hwif_data;
1464 }
1465
1466 static inline void ide_set_hwifdata (ide_hwif_t * hwif, void *data)
1467 {
1468         hwif->hwif_data = data;
1469 }
1470
1471 extern void ide_toggle_bounce(ide_drive_t *drive, int on);
1472
1473 u64 ide_get_lba_addr(struct ide_cmd *, int);
1474 u8 ide_dump_status(ide_drive_t *, const char *, u8);
1475
1476 struct ide_timing {
1477         u8  mode;
1478         u8  setup;      /* t1 */
1479         u16 act8b;      /* t2 for 8-bit io */
1480         u16 rec8b;      /* t2i for 8-bit io */
1481         u16 cyc8b;      /* t0 for 8-bit io */
1482         u16 active;     /* t2 or tD */
1483         u16 recover;    /* t2i or tK */
1484         u16 cycle;      /* t0 */
1485         u16 udma;       /* t2CYCTYP/2 */
1486 };
1487
1488 enum {
1489         IDE_TIMING_SETUP        = (1 << 0),
1490         IDE_TIMING_ACT8B        = (1 << 1),
1491         IDE_TIMING_REC8B        = (1 << 2),
1492         IDE_TIMING_CYC8B        = (1 << 3),
1493         IDE_TIMING_8BIT         = IDE_TIMING_ACT8B | IDE_TIMING_REC8B |
1494                                   IDE_TIMING_CYC8B,
1495         IDE_TIMING_ACTIVE       = (1 << 4),
1496         IDE_TIMING_RECOVER      = (1 << 5),
1497         IDE_TIMING_CYCLE        = (1 << 6),
1498         IDE_TIMING_UDMA         = (1 << 7),
1499         IDE_TIMING_ALL          = IDE_TIMING_SETUP | IDE_TIMING_8BIT |
1500                                   IDE_TIMING_ACTIVE | IDE_TIMING_RECOVER |
1501                                   IDE_TIMING_CYCLE | IDE_TIMING_UDMA,
1502 };
1503
1504 struct ide_timing *ide_timing_find_mode(u8);
1505 u16 ide_pio_cycle_time(ide_drive_t *, u8);
1506 void ide_timing_merge(struct ide_timing *, struct ide_timing *,
1507                       struct ide_timing *, unsigned int);
1508 int ide_timing_compute(ide_drive_t *, u8, struct ide_timing *, int, int);
1509
1510 #ifdef CONFIG_IDE_XFER_MODE
1511 int ide_scan_pio_blacklist(char *);
1512 const char *ide_xfer_verbose(u8);
1513 u8 ide_get_best_pio_mode(ide_drive_t *, u8, u8);
1514 int ide_pio_need_iordy(ide_drive_t *, const u8);
1515 int ide_set_pio_mode(ide_drive_t *, u8);
1516 int ide_set_dma_mode(ide_drive_t *, u8);
1517 void ide_set_pio(ide_drive_t *, u8);
1518 int ide_set_xfer_rate(ide_drive_t *, u8);
1519 #else
1520 static inline void ide_set_pio(ide_drive_t *drive, u8 pio) { ; }
1521 static inline int ide_set_xfer_rate(ide_drive_t *drive, u8 rate) { return -1; }
1522 #endif
1523
1524 static inline void ide_set_max_pio(ide_drive_t *drive)
1525 {
1526         ide_set_pio(drive, 255);
1527 }
1528
1529 char *ide_media_string(ide_drive_t *);
1530
1531 extern struct device_attribute ide_dev_attrs[];
1532 extern struct bus_type ide_bus_type;
1533 extern struct class *ide_port_class;
1534
1535 static inline void ide_dump_identify(u8 *id)
1536 {
1537         print_hex_dump(KERN_INFO, "", DUMP_PREFIX_NONE, 16, 2, id, 512, 0);
1538 }
1539
1540 static inline int hwif_to_node(ide_hwif_t *hwif)
1541 {
1542         return hwif->dev ? dev_to_node(hwif->dev) : -1;
1543 }
1544
1545 static inline ide_drive_t *ide_get_pair_dev(ide_drive_t *drive)
1546 {
1547         ide_drive_t *peer = drive->hwif->devices[(drive->dn ^ 1) & 1];
1548
1549         return (peer->dev_flags & IDE_DFLAG_PRESENT) ? peer : NULL;
1550 }
1551
1552 static inline void *ide_get_drivedata(ide_drive_t *drive)
1553 {
1554         return drive->drive_data;
1555 }
1556
1557 static inline void ide_set_drivedata(ide_drive_t *drive, void *data)
1558 {
1559         drive->drive_data = data;
1560 }
1561
1562 #define ide_port_for_each_dev(i, dev, port) \
1563         for ((i) = 0; ((dev) = (port)->devices[i]) || (i) < MAX_DRIVES; (i)++)
1564
1565 #define ide_port_for_each_present_dev(i, dev, port) \
1566         for ((i) = 0; ((dev) = (port)->devices[i]) || (i) < MAX_DRIVES; (i)++) \
1567                 if ((dev)->dev_flags & IDE_DFLAG_PRESENT)
1568
1569 #define ide_host_for_each_port(i, port, host) \
1570         for ((i) = 0; ((port) = (host)->ports[i]) || (i) < MAX_HOST_PORTS; (i)++)
1571
1572 #endif /* _IDE_H */