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