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/config.h>
  10 #include <linux/init.h>
  11 #include <linux/ioport.h>
  12 #include <linux/hdreg.h>
  13 #include <linux/hdsmart.h>
  14 #include <linux/blkdev.h>
  15 #include <linux/proc_fs.h>
  16 #include <linux/interrupt.h>
  17 #include <linux/bitops.h>
  18 #include <linux/bio.h>
  19 #include <linux/device.h>
  20 #include <linux/pci.h>
  21 #include <asm/byteorder.h>
  22 #include <asm/system.h>
  23 #include <asm/io.h>
  24 #include <asm/semaphore.h>
  25
  26 /*
  27  * This is the multiple IDE interface driver, as evolved from hd.c.
  28  * It supports up to four IDE interfaces, on one or more IRQs (usually 14 & 15).
  29  * There can be up to two drives per interface, as per the ATA-2 spec.
  30  *
  31  * Primary i/f:    ide0: major=3;  (hda)         minor=0; (hdb)         minor=64
  32  * Secondary i/f:  ide1: major=22; (hdc or hd1a) minor=0; (hdd or hd1b) minor=64
  33  * Tertiary i/f:   ide2: major=33; (hde)         minor=0; (hdf)         minor=64
  34  * Quaternary i/f: ide3: major=34; (hdg)         minor=0; (hdh)         minor=64
  35  */
  36
  37 /******************************************************************************
  38  * IDE driver configuration options (play with these as desired):
  39  *
  40  * REALLY_SLOW_IO can be defined in ide.c and ide-cd.c, if necessary
  41  */
  42 #define INITIAL_MULT_COUNT      0       /* off=0; on=2,4,8,16,32, etc.. */
  43
  44 #ifndef SUPPORT_SLOW_DATA_PORTS         /* 1 to support slow data ports */
  45 #define SUPPORT_SLOW_DATA_PORTS 1       /* 0 to reduce kernel size */
  46 #endif
  47 #ifndef SUPPORT_VLB_SYNC                /* 1 to support weird 32-bit chips */
  48 #define SUPPORT_VLB_SYNC        1       /* 0 to reduce kernel size */
  49 #endif
  50 #ifndef OK_TO_RESET_CONTROLLER          /* 1 needed for good error recovery */
  51 #define OK_TO_RESET_CONTROLLER  1       /* 0 for use with AH2372A/B interface */
  52 #endif
  53
  54 #ifndef DISABLE_IRQ_NOSYNC
  55 #define DISABLE_IRQ_NOSYNC      0
  56 #endif
  57
  58 /*
  59  * Used to indicate "no IRQ", should be a value that cannot be an IRQ
  60  * number.
  61  */
  62
  63 #define IDE_NO_IRQ              (-1)
  64
  65 /*
  66  *  "No user-serviceable parts" beyond this point  :)
  67  *****************************************************************************/
  68
  69 typedef unsigned char   byte;   /* used everywhere */
  70
  71 /*
  72  * Probably not wise to fiddle with these
  73  */
  74 #define ERROR_MAX       8       /* Max read/write errors per sector */
  75 #define ERROR_RESET     3       /* Reset controller every 4th retry */
  76 #define ERROR_RECAL     1       /* Recalibrate every 2nd retry */
  77
  78 /*
  79  * Tune flags
  80  */
  81 #define IDE_TUNE_NOAUTO         2
  82 #define IDE_TUNE_AUTO           1
  83 #define IDE_TUNE_DEFAULT        0
  84
  85 /*
  86  * state flags
  87  */
  88
  89 #define DMA_PIO_RETRY   1       /* retrying in PIO */
  90
  91 #define HWIF(drive)             ((ide_hwif_t *)((drive)->hwif))
  92 #define HWGROUP(drive)          ((ide_hwgroup_t *)(HWIF(drive)->hwgroup))
  93
  94 /*
  95  * Definitions for accessing IDE controller registers
  96  */
  97 #define IDE_NR_PORTS            (10)
  98
  99 #define IDE_DATA_OFFSET         (0)
 100 #define IDE_ERROR_OFFSET        (1)
 101 #define IDE_NSECTOR_OFFSET      (2)
 102 #define IDE_SECTOR_OFFSET       (3)
 103 #define IDE_LCYL_OFFSET         (4)
 104 #define IDE_HCYL_OFFSET         (5)
 105 #define IDE_SELECT_OFFSET       (6)
 106 #define IDE_STATUS_OFFSET       (7)
 107 #define IDE_CONTROL_OFFSET      (8)
 108 #define IDE_IRQ_OFFSET          (9)
 109
 110 #define IDE_FEATURE_OFFSET      IDE_ERROR_OFFSET
 111 #define IDE_COMMAND_OFFSET      IDE_STATUS_OFFSET
 112
 113 #define IDE_CONTROL_OFFSET_HOB  (7)
 114
 115 #define IDE_DATA_REG            (HWIF(drive)->io_ports[IDE_DATA_OFFSET])
 116 #define IDE_ERROR_REG           (HWIF(drive)->io_ports[IDE_ERROR_OFFSET])
 117 #define IDE_NSECTOR_REG         (HWIF(drive)->io_ports[IDE_NSECTOR_OFFSET])
 118 #define IDE_SECTOR_REG          (HWIF(drive)->io_ports[IDE_SECTOR_OFFSET])
 119 #define IDE_LCYL_REG            (HWIF(drive)->io_ports[IDE_LCYL_OFFSET])
 120 #define IDE_HCYL_REG            (HWIF(drive)->io_ports[IDE_HCYL_OFFSET])
 121 #define IDE_SELECT_REG          (HWIF(drive)->io_ports[IDE_SELECT_OFFSET])
 122 #define IDE_STATUS_REG          (HWIF(drive)->io_ports[IDE_STATUS_OFFSET])
 123 #define IDE_CONTROL_REG         (HWIF(drive)->io_ports[IDE_CONTROL_OFFSET])
 124 #define IDE_IRQ_REG             (HWIF(drive)->io_ports[IDE_IRQ_OFFSET])
 125
 126 #define IDE_FEATURE_REG         IDE_ERROR_REG
 127 #define IDE_COMMAND_REG         IDE_STATUS_REG
 128 #define IDE_ALTSTATUS_REG       IDE_CONTROL_REG
 129 #define IDE_IREASON_REG         IDE_NSECTOR_REG
 130 #define IDE_BCOUNTL_REG         IDE_LCYL_REG
 131 #define IDE_BCOUNTH_REG         IDE_HCYL_REG
 132
 133 #define OK_STAT(stat,good,bad)  (((stat)&((good)|(bad)))==(good))
 134 #define BAD_R_STAT              (BUSY_STAT   | ERR_STAT)
 135 #define BAD_W_STAT              (BAD_R_STAT  | WRERR_STAT)
 136 #define BAD_STAT                (BAD_R_STAT  | DRQ_STAT)
 137 #define DRIVE_READY             (READY_STAT  | SEEK_STAT)
 138 #define DATA_READY              (DRQ_STAT)
 139
 140 #define BAD_CRC                 (ABRT_ERR    | ICRC_ERR)
 141
 142 #define SATA_NR_PORTS           (3)     /* 16 possible ?? */
 143
 144 #define SATA_STATUS_OFFSET      (0)
 145 #define SATA_STATUS_REG         (HWIF(drive)->sata_scr[SATA_STATUS_OFFSET])
 146 #define SATA_ERROR_OFFSET       (1)
 147 #define SATA_ERROR_REG          (HWIF(drive)->sata_scr[SATA_ERROR_OFFSET])
 148 #define SATA_CONTROL_OFFSET     (2)
 149 #define SATA_CONTROL_REG        (HWIF(drive)->sata_scr[SATA_CONTROL_OFFSET])
 150
 151 #define SATA_MISC_OFFSET        (0)
 152 #define SATA_MISC_REG           (HWIF(drive)->sata_misc[SATA_MISC_OFFSET])
 153 #define SATA_PHY_OFFSET         (1)
 154 #define SATA_PHY_REG            (HWIF(drive)->sata_misc[SATA_PHY_OFFSET])
 155 #define SATA_IEN_OFFSET         (2)
 156 #define SATA_IEN_REG            (HWIF(drive)->sata_misc[SATA_IEN_OFFSET])
 157
 158 /*
 159  * Our Physical Region Descriptor (PRD) table should be large enough
 160  * to handle the biggest I/O request we are likely to see.  Since requests
 161  * can have no more than 256 sectors, and since the typical blocksize is
 162  * two or more sectors, we could get by with a limit of 128 entries here for
 163  * the usual worst case.  Most requests seem to include some contiguous blocks,
 164  * further reducing the number of table entries required.
 165  *
 166  * The driver reverts to PIO mode for individual requests that exceed
 167  * this limit (possible with 512 byte blocksizes, eg. MSDOS f/s), so handling
 168  * 100% of all crazy scenarios here is not necessary.
 169  *
 170  * As it turns out though, we must allocate a full 4KB page for this,
 171  * so the two PRD tables (ide0 & ide1) will each get half of that,
 172  * allowing each to have about 256 entries (8 bytes each) from this.
 173  */
 174 #define PRD_BYTES       8
 175 #define PRD_ENTRIES     256
 176
 177 /*
 178  * Some more useful definitions
 179  */
 180 #define PARTN_BITS      6       /* number of minor dev bits for partitions */
 181 #define MAX_DRIVES      2       /* per interface; 2 assumed by lots of code */
 182 #define SECTOR_SIZE     512
 183 #define SECTOR_WORDS    (SECTOR_SIZE / 4)       /* number of 32bit words per sector */
 184 #define IDE_LARGE_SEEK(b1,b2,t) (((b1) > (b2) + (t)) || ((b2) > (b1) + (t)))
 185
 186 /*
 187  * Timeouts for various operations:
 188  */
 189 #define WAIT_DRQ        (HZ/10)         /* 100msec - spec allows up to 20ms */
 190 #if defined(CONFIG_APM) || defined(CONFIG_APM_MODULE)
 191 #define WAIT_READY      (5*HZ)          /* 5sec - some laptops are very slow */
 192 #else
 193 #define WAIT_READY      (HZ/10)         /* 100msec - should be instantaneous */
 194 #endif /* CONFIG_APM || CONFIG_APM_MODULE */
 195 #define WAIT_PIDENTIFY  (10*HZ) /* 10sec  - should be less than 3ms (?), if all ATAPI CD is closed at boot */
 196 #define WAIT_WORSTCASE  (30*HZ) /* 30sec  - worst case when spinning up */
 197 #define WAIT_CMD        (10*HZ) /* 10sec  - maximum wait for an IRQ to happen */
 198 #define WAIT_MIN_SLEEP  (2*HZ/100)      /* 20msec - minimum sleep time */
 199
 200 #define HOST(hwif,chipset)                                      \
 201 {                                                               \
 202         return ((hwif)->chipset == chipset) ? 1 : 0;            \
 203 }
 204
 205 /*
 206  * Check for an interrupt and acknowledge the interrupt status
 207  */
 208 struct hwif_s;
 209 typedef int (ide_ack_intr_t)(struct hwif_s *);
 210
 211 #ifndef NO_DMA
 212 #define NO_DMA  255
 213 #endif
 214
 215 /*
 216  * hwif_chipset_t is used to keep track of the specific hardware
 217  * chipset used by each IDE interface, if known.
 218  */
 219 typedef enum {  ide_unknown,    ide_generic,    ide_pci,
 220                 ide_cmd640,     ide_dtc2278,    ide_ali14xx,
 221                 ide_qd65xx,     ide_umc8672,    ide_ht6560b,
 222                 ide_rz1000,     ide_trm290,
 223                 ide_cmd646,     ide_cy82c693,   ide_4drives,
 224                 ide_pmac,       ide_etrax100,   ide_acorn,
 225                 ide_forced
 226 } hwif_chipset_t;
 227
 228 /*
 229  * Structure to hold all information about the location of this port
 230  */
 231 typedef struct hw_regs_s {
 232         unsigned long   io_ports[IDE_NR_PORTS]; /* task file registers */
 233         int             irq;                    /* our irq number */
 234         int             dma;                    /* our dma entry */
 235         ide_ack_intr_t  *ack_intr;              /* acknowledge interrupt */
 236         hwif_chipset_t  chipset;
 237 } hw_regs_t;
 238
 239 /*
 240  * Register new hardware with ide
 241  */
 242 int ide_register_hw(hw_regs_t *hw, struct hwif_s **hwifp);
 243 int ide_register_hw_with_fixup(hw_regs_t *, struct hwif_s **, void (*)(struct hwif_s *));
 244
 245 /*
 246  * Set up hw_regs_t structure before calling ide_register_hw (optional)
 247  */
 248 void ide_setup_ports(   hw_regs_t *hw,
 249                         unsigned long base,
 250                         int *offsets,
 251                         unsigned long ctrl,
 252                         unsigned long intr,
 253                         ide_ack_intr_t *ack_intr,
 254 #if 0
 255                         ide_io_ops_t *iops,
 256 #endif
 257                         int irq);
 258
 259 static inline void ide_std_init_ports(hw_regs_t *hw,
 260                                       unsigned long io_addr,
 261                                       unsigned long ctl_addr)
 262 {
 263         unsigned int i;
 264
 265         for (i = IDE_DATA_OFFSET; i <= IDE_STATUS_OFFSET; i++)
 266                 hw->io_ports[i] = io_addr++;
 267
 268         hw->io_ports[IDE_CONTROL_OFFSET] = ctl_addr;
 269 }
 270
 271 #include <asm/ide.h>
 272
 273 /* needed on alpha, x86/x86_64, ia64, mips, ppc32 and sh */
 274 #ifndef IDE_ARCH_OBSOLETE_DEFAULTS
 275 # define ide_default_io_base(index)     (0)
 276 # define ide_default_irq(base)          (0)
 277 # define ide_init_default_irq(base)     (0)
 278 #endif
 279
 280 /*
 281  * ide_init_hwif_ports() is OBSOLETE and will be removed in 2.7 series.
 282  * New ports shouldn't define IDE_ARCH_OBSOLETE_INIT in <asm/ide.h>.
 283  */
 284 #ifdef IDE_ARCH_OBSOLETE_INIT
 285 static inline void ide_init_hwif_ports(hw_regs_t *hw,
 286                                        unsigned long io_addr,
 287                                        unsigned long ctl_addr,
 288                                        int *irq)
 289 {
 290         if (!ctl_addr)
 291                 ide_std_init_ports(hw, io_addr, ide_default_io_ctl(io_addr));
 292         else
 293                 ide_std_init_ports(hw, io_addr, ctl_addr);
 294
 295         if (irq)
 296                 *irq = 0;
 297
 298         hw->io_ports[IDE_IRQ_OFFSET] = 0;
 299
 300 #ifdef CONFIG_PPC32
 301         if (ppc_ide_md.ide_init_hwif)
 302                 ppc_ide_md.ide_init_hwif(hw, io_addr, ctl_addr, irq);
 303 #endif
 304 }
 305 #else
 306 static inline void ide_init_hwif_ports(hw_regs_t *hw,
 307                                        unsigned long io_addr,
 308                                        unsigned long ctl_addr,
 309                                        int *irq)
 310 {
 311         if (io_addr || ctl_addr)
 312                 printk(KERN_WARNING "%s: must not be called\n", __FUNCTION__);
 313 }
 314 #endif /* IDE_ARCH_OBSOLETE_INIT */
 315
 316 /* Currently only m68k, apus and m8xx need it */
 317 #ifndef IDE_ARCH_ACK_INTR
 318 # define ide_ack_intr(hwif) (1)
 319 #endif
 320
 321 /* Currently only Atari needs it */
 322 #ifndef IDE_ARCH_LOCK
 323 # define ide_release_lock()                     do {} while (0)
 324 # define ide_get_lock(hdlr, data)               do {} while (0)
 325 #endif /* IDE_ARCH_LOCK */
 326
 327 /*
 328  * Now for the data we need to maintain per-drive:  ide_drive_t
 329  */
 330
 331 #define ide_scsi        0x21
 332 #define ide_disk        0x20
 333 #define ide_optical     0x7
 334 #define ide_cdrom       0x5
 335 #define ide_tape        0x1
 336 #define ide_floppy      0x0
 337
 338 /*
 339  * Special Driver Flags
 340  *
 341  * set_geometry : respecify drive geometry
 342  * recalibrate  : seek to cyl 0
 343  * set_multmode : set multmode count
 344  * set_tune     : tune interface for drive
 345  * serviced     : service command
 346  * reserved     : unused
 347  */
 348 typedef union {
 349         unsigned all                    : 8;
 350         struct {
 351 #if defined(__LITTLE_ENDIAN_BITFIELD)
 352                 unsigned set_geometry   : 1;
 353                 unsigned recalibrate    : 1;
 354                 unsigned set_multmode   : 1;
 355                 unsigned set_tune       : 1;
 356                 unsigned serviced       : 1;
 357                 unsigned reserved       : 3;
 358 #elif defined(__BIG_ENDIAN_BITFIELD)
 359                 unsigned reserved       : 3;
 360                 unsigned serviced       : 1;
 361                 unsigned set_tune       : 1;
 362                 unsigned set_multmode   : 1;
 363                 unsigned recalibrate    : 1;
 364                 unsigned set_geometry   : 1;
 365 #else
 366 #error "Please fix <asm/byteorder.h>"
 367 #endif
 368         } b;
 369 } special_t;
 370
 371 /*
 372  * ATA DATA Register Special.
 373  * ATA NSECTOR Count Register().
 374  * ATAPI Byte Count Register.
 375  * Channel index ordering pairs.
 376  */
 377 typedef union {
 378         unsigned all                    :16;
 379         struct {
 380 #if defined(__LITTLE_ENDIAN_BITFIELD)
 381                 unsigned low            :8;     /* LSB */
 382                 unsigned high           :8;     /* MSB */
 383 #elif defined(__BIG_ENDIAN_BITFIELD)
 384                 unsigned high           :8;     /* MSB */
 385                 unsigned low            :8;     /* LSB */
 386 #else
 387 #error "Please fix <asm/byteorder.h>"
 388 #endif
 389         } b;
 390 } ata_nsector_t, ata_data_t, atapi_bcount_t, ata_index_t;
 391
 392 /*
 393  * ATA-IDE Error Register
 394  *
 395  * mark         : Bad address mark
 396  * tzero        : Couldn't find track 0
 397  * abrt         : Aborted Command
 398  * mcr          : Media Change Request
 399  * id           : ID field not found
 400  * mce          : Media Change Event
 401  * ecc          : Uncorrectable ECC error
 402  * bdd          : dual meaing
 403  */
 404 typedef union {
 405         unsigned all                    :8;
 406         struct {
 407 #if defined(__LITTLE_ENDIAN_BITFIELD)
 408                 unsigned mark           :1;
 409                 unsigned tzero          :1;
 410                 unsigned abrt           :1;
 411                 unsigned mcr            :1;
 412                 unsigned id             :1;
 413                 unsigned mce            :1;
 414                 unsigned ecc            :1;
 415                 unsigned bdd            :1;
 416 #elif defined(__BIG_ENDIAN_BITFIELD)
 417                 unsigned bdd            :1;
 418                 unsigned ecc            :1;
 419                 unsigned mce            :1;
 420                 unsigned id             :1;
 421                 unsigned mcr            :1;
 422                 unsigned abrt           :1;
 423                 unsigned tzero          :1;
 424                 unsigned mark           :1;
 425 #else
 426 #error "Please fix <asm/byteorder.h>"
 427 #endif
 428         } b;
 429 } ata_error_t;
 430
 431 /*
 432  * ATA-IDE Select Register, aka Device-Head
 433  *
 434  * head         : always zeros here
 435  * unit         : drive select number: 0/1
 436  * bit5         : always 1
 437  * lba          : using LBA instead of CHS
 438  * bit7         : always 1
 439  */
 440 typedef union {
 441         unsigned all                    : 8;
 442         struct {
 443 #if defined(__LITTLE_ENDIAN_BITFIELD)
 444                 unsigned head           : 4;
 445                 unsigned unit           : 1;
 446                 unsigned bit5           : 1;
 447                 unsigned lba            : 1;
 448                 unsigned bit7           : 1;
 449 #elif defined(__BIG_ENDIAN_BITFIELD)
 450                 unsigned bit7           : 1;
 451                 unsigned lba            : 1;
 452                 unsigned bit5           : 1;
 453                 unsigned unit           : 1;
 454                 unsigned head           : 4;
 455 #else
 456 #error "Please fix <asm/byteorder.h>"
 457 #endif
 458         } b;
 459 } select_t, ata_select_t;
 460
 461 /*
 462  * The ATA-IDE Status Register.
 463  * The ATAPI Status Register.
 464  *
 465  * check        : Error occurred
 466  * idx          : Index Error
 467  * corr         : Correctable error occurred
 468  * drq          : Data is request by the device
 469  * dsc          : Disk Seek Complete                    : ata
 470  *              : Media access command finished         : atapi
 471  * df           : Device Fault                          : ata
 472  *              : Reserved                              : atapi
 473  * drdy         : Ready, Command Mode Capable           : ata
 474  *              : Ignored for ATAPI commands            : atapi
 475  * bsy          : Disk is Busy
 476  *              : The device has access to the command block
 477  */
 478 typedef union {
 479         unsigned all                    :8;
 480         struct {
 481 #if defined(__LITTLE_ENDIAN_BITFIELD)
 482                 unsigned check          :1;
 483                 unsigned idx            :1;
 484                 unsigned corr           :1;
 485                 unsigned drq            :1;
 486                 unsigned dsc            :1;
 487                 unsigned df             :1;
 488                 unsigned drdy           :1;
 489                 unsigned bsy            :1;
 490 #elif defined(__BIG_ENDIAN_BITFIELD)
 491                 unsigned bsy            :1;
 492                 unsigned drdy           :1;
 493                 unsigned df             :1;
 494                 unsigned dsc            :1;
 495                 unsigned drq            :1;
 496                 unsigned corr           :1;
 497                 unsigned idx            :1;
 498                 unsigned check          :1;
 499 #else
 500 #error "Please fix <asm/byteorder.h>"
 501 #endif
 502         } b;
 503 } ata_status_t, atapi_status_t;
 504
 505 /*
 506  * ATA-IDE Control Register
 507  *
 508  * bit0         : Should be set to zero
 509  * nIEN         : device INTRQ to host
 510  * SRST         : host soft reset bit
 511  * bit3         : ATA-2 thingy, Should be set to 1
 512  * reserved456  : Reserved
 513  * HOB          : 48-bit address ordering, High Ordered Bit
 514  */
 515 typedef union {
 516         unsigned all                    : 8;
 517         struct {
 518 #if defined(__LITTLE_ENDIAN_BITFIELD)
 519                 unsigned bit0           : 1;
 520                 unsigned nIEN           : 1;
 521                 unsigned SRST           : 1;
 522                 unsigned bit3           : 1;
 523                 unsigned reserved456    : 3;
 524                 unsigned HOB            : 1;
 525 #elif defined(__BIG_ENDIAN_BITFIELD)
 526                 unsigned HOB            : 1;
 527                 unsigned reserved456    : 3;
 528                 unsigned bit3           : 1;
 529                 unsigned SRST           : 1;
 530                 unsigned nIEN           : 1;
 531                 unsigned bit0           : 1;
 532 #else
 533 #error "Please fix <asm/byteorder.h>"
 534 #endif
 535         } b;
 536 } ata_control_t;
 537
 538 /*
 539  * ATAPI Feature Register
 540  *
 541  * dma          : Using DMA or PIO
 542  * reserved321  : Reserved
 543  * reserved654  : Reserved (Tag Type)
 544  * reserved7    : Reserved
 545  */
 546 typedef union {
 547         unsigned all                    :8;
 548         struct {
 549 #if defined(__LITTLE_ENDIAN_BITFIELD)
 550                 unsigned dma            :1;
 551                 unsigned reserved321    :3;
 552                 unsigned reserved654    :3;
 553                 unsigned reserved7      :1;
 554 #elif defined(__BIG_ENDIAN_BITFIELD)
 555                 unsigned reserved7      :1;
 556                 unsigned reserved654    :3;
 557                 unsigned reserved321    :3;
 558                 unsigned dma            :1;
 559 #else
 560 #error "Please fix <asm/byteorder.h>"
 561 #endif
 562         } b;
 563 } atapi_feature_t;
 564
 565 /*
 566  * ATAPI Interrupt Reason Register.
 567  *
 568  * cod          : Information transferred is command (1) or data (0)
 569  * io           : The device requests us to read (1) or write (0)
 570  * reserved     : Reserved
 571  */
 572 typedef union {
 573         unsigned all                    :8;
 574         struct {
 575 #if defined(__LITTLE_ENDIAN_BITFIELD)
 576                 unsigned cod            :1;
 577                 unsigned io             :1;
 578                 unsigned reserved       :6;
 579 #elif defined(__BIG_ENDIAN_BITFIELD)
 580                 unsigned reserved       :6;
 581                 unsigned io             :1;
 582                 unsigned cod            :1;
 583 #else
 584 #error "Please fix <asm/byteorder.h>"
 585 #endif
 586         } b;
 587 } atapi_ireason_t;
 588
 589 /*
 590  * The ATAPI error register.
 591  *
 592  * ili          : Illegal Length Indication
 593  * eom          : End Of Media Detected
 594  * abrt         : Aborted command - As defined by ATA
 595  * mcr          : Media Change Requested - As defined by ATA
 596  * sense_key    : Sense key of the last failed packet command
 597  */
 598 typedef union {
 599         unsigned all                    :8;
 600         struct {
 601 #if defined(__LITTLE_ENDIAN_BITFIELD)
 602                 unsigned ili            :1;
 603                 unsigned eom            :1;
 604                 unsigned abrt           :1;
 605                 unsigned mcr            :1;
 606                 unsigned sense_key      :4;
 607 #elif defined(__BIG_ENDIAN_BITFIELD)
 608                 unsigned sense_key      :4;
 609                 unsigned mcr            :1;
 610                 unsigned abrt           :1;
 611                 unsigned eom            :1;
 612                 unsigned ili            :1;
 613 #else
 614 #error "Please fix <asm/byteorder.h>"
 615 #endif
 616         } b;
 617 } atapi_error_t;
 618
 619 /*
 620  * ATAPI floppy Drive Select Register
 621  *
 622  * sam_lun      : Logical unit number
 623  * reserved3    : Reserved
 624  * drv          : The responding drive will be drive 0 (0) or drive 1 (1)
 625  * one5         : Should be set to 1
 626  * reserved6    : Reserved
 627  * one7         : Should be set to 1
 628  */
 629 typedef union {
 630         unsigned all                    :8;
 631         struct {
 632 #if defined(__LITTLE_ENDIAN_BITFIELD)
 633                 unsigned sam_lun        :3;
 634                 unsigned reserved3      :1;
 635                 unsigned drv            :1;
 636                 unsigned one5           :1;
 637                 unsigned reserved6      :1;
 638                 unsigned one7           :1;
 639 #elif defined(__BIG_ENDIAN_BITFIELD)
 640                 unsigned one7           :1;
 641                 unsigned reserved6      :1;
 642                 unsigned one5           :1;
 643                 unsigned drv            :1;
 644                 unsigned reserved3      :1;
 645                 unsigned sam_lun        :3;
 646 #else
 647 #error "Please fix <asm/byteorder.h>"
 648 #endif
 649         } b;
 650 } atapi_select_t;
 651
 652 /*
 653  * Status returned from various ide_ functions
 654  */
 655 typedef enum {
 656         ide_stopped,    /* no drive operation was started */
 657         ide_started,    /* a drive operation was started, handler was set */
 658 } ide_startstop_t;
 659
 660 struct ide_driver_s;
 661 struct ide_settings_s;
 662
 663 typedef struct ide_drive_s {
 664         char            name[4];        /* drive name, such as "hda" */
 665         char            driver_req[10]; /* requests specific driver */
 666
 667         request_queue_t         *queue; /* request queue */
 668
 669         struct request          *rq;    /* current request */
 670         struct ide_drive_s      *next;  /* circular list of hwgroup drives */
 671         struct ide_driver_s     *driver;/* (ide_driver_t *) */
 672         void            *driver_data;   /* extra driver data */
 673         struct hd_driveid       *id;    /* drive model identification info */
 674         struct proc_dir_entry *proc;    /* /proc/ide/ directory entry */
 675         struct ide_settings_s *settings;/* /proc/ide/ drive settings */
 676         char            devfs_name[64]; /* devfs crap */
 677
 678         struct hwif_s           *hwif;  /* actually (ide_hwif_t *) */
 679
 680         unsigned long sleep;            /* sleep until this time */
 681         unsigned long service_start;    /* time we started last request */
 682         unsigned long service_time;     /* service time of last request */
 683         unsigned long timeout;          /* max time to wait for irq */
 684
 685         special_t       special;        /* special action flags */
 686         select_t        select;         /* basic drive/head select reg value */
 687
 688         u8      keep_settings;          /* restore settings after drive reset */
 689         u8      autodma;                /* device can safely use dma on host */
 690         u8      using_dma;              /* disk is using dma for read/write */
 691         u8      retry_pio;              /* retrying dma capable host in pio */
 692         u8      state;                  /* retry state */
 693         u8      waiting_for_dma;        /* dma currently in progress */
 694         u8      unmask;                 /* okay to unmask other irqs */
 695         u8      bswap;                  /* byte swap data */
 696         u8      dsc_overlap;            /* DSC overlap */
 697         u8      nice1;                  /* give potential excess bandwidth */
 698
 699         unsigned present        : 1;    /* drive is physically present */
 700         unsigned dead           : 1;    /* device ejected hint */
 701         unsigned id_read        : 1;    /* 1=id read from disk 0 = synthetic */
 702         unsigned noprobe        : 1;    /* from:  hdx=noprobe */
 703         unsigned removable      : 1;    /* 1 if need to do check_media_change */
 704         unsigned attach         : 1;    /* needed for removable devices */
 705         unsigned is_flash       : 1;    /* 1 if probed as flash */
 706         unsigned forced_geom    : 1;    /* 1 if hdx=c,h,s was given at boot */
 707         unsigned no_unmask      : 1;    /* disallow setting unmask bit */
 708         unsigned no_io_32bit    : 1;    /* disallow enabling 32bit I/O */
 709         unsigned atapi_overlap  : 1;    /* ATAPI overlap (not supported) */
 710         unsigned nice0          : 1;    /* give obvious excess bandwidth */
 711         unsigned nice2          : 1;    /* give a share in our own bandwidth */
 712         unsigned doorlocking    : 1;    /* for removable only: door lock/unlock works */
 713         unsigned autotune       : 2;    /* 0=default, 1=autotune, 2=noautotune */
 714         unsigned remap_0_to_1   : 1;    /* 0=noremap, 1=remap 0->1 (for EZDrive) */
 715         unsigned blocked        : 1;    /* 1=powermanagment told us not to do anything, so sleep nicely */
 716         unsigned vdma           : 1;    /* 1=doing PIO over DMA 0=doing normal DMA */
 717         unsigned addressing;            /*      : 3;
 718                                          *  0=28-bit
 719                                          *  1=48-bit
 720                                          *  2=48-bit doing 28-bit
 721                                          *  3=64-bit
 722                                          */
 723         unsigned scsi           : 1;    /* 0=default, 1=ide-scsi emulation */
 724
 725         u8      quirk_list;     /* considered quirky, set for a specific host */
 726         u8      init_speed;     /* transfer rate set at boot */
 727         u8      pio_speed;      /* unused by core, used by some drivers for fallback from DMA */
 728         u8      current_speed;  /* current transfer rate set */
 729         u8      dn;             /* now wide spread use */
 730         u8      wcache;         /* status of write cache */
 731         u8      acoustic;       /* acoustic management */
 732         u8      media;          /* disk, cdrom, tape, floppy, ... */
 733         u8      ctl;            /* "normal" value for IDE_CONTROL_REG */
 734         u8      ready_stat;     /* min status value for drive ready */
 735         u8      mult_count;     /* current multiple sector setting */
 736         u8      mult_req;       /* requested multiple sector setting */
 737         u8      tune_req;       /* requested drive tuning setting */
 738         u8      io_32bit;       /* 0=16-bit, 1=32-bit, 2/3=32bit+sync */
 739         u8      bad_wstat;      /* used for ignoring WRERR_STAT */
 740         u8      nowerr;         /* used for ignoring WRERR_STAT */
 741         u8      sect0;          /* offset of first sector for DM6:DDO */
 742         u8      head;           /* "real" number of heads */
 743         u8      sect;           /* "real" sectors per track */
 744         u8      bios_head;      /* BIOS/fdisk/LILO number of heads */
 745         u8      bios_sect;      /* BIOS/fdisk/LILO sectors per track */
 746         u8      doing_barrier;  /* state, 1=currently doing flush */
 747
 748         unsigned int    bios_cyl;       /* BIOS/fdisk/LILO number of cyls */
 749         unsigned int    cyl;            /* "real" number of cyls */
 750         unsigned int    drive_data;     /* use by tuneproc/selectproc */
 751         unsigned int    usage;          /* current "open()" count for drive */
 752         unsigned int    failures;       /* current failure count */
 753         unsigned int    max_failures;   /* maximum allowed failure count */
 754
 755         u64             capacity64;     /* total number of sectors */
 756
 757         int             lun;            /* logical unit */
 758         int             crc_count;      /* crc counter to reduce drive speed */
 759         struct list_head list;
 760         struct device   gendev;
 761         struct semaphore gendev_rel_sem;        /* to deal with device release() */
 762         struct gendisk *disk;
 763 } ide_drive_t;
 764
 765 #define IDE_CHIPSET_PCI_MASK    \
 766     ((1<<ide_pci)|(1<<ide_cmd646)|(1<<ide_ali14xx))
 767 #define IDE_CHIPSET_IS_PCI(c)   ((IDE_CHIPSET_PCI_MASK >> (c)) & 1)
 768
 769 struct ide_pci_device_s;
 770
 771 typedef struct hwif_s {
 772         struct hwif_s *next;            /* for linked-list in ide_hwgroup_t */
 773         struct hwif_s *mate;            /* other hwif from same PCI chip */
 774         struct hwgroup_s *hwgroup;      /* actually (ide_hwgroup_t *) */
 775         struct proc_dir_entry *proc;    /* /proc/ide/ directory entry */
 776
 777         char name[6];                   /* name of interface, eg. "ide0" */
 778
 779                 /* task file registers for pata and sata */
 780         unsigned long   io_ports[IDE_NR_PORTS];
 781         unsigned long   sata_scr[SATA_NR_PORTS];
 782         unsigned long   sata_misc[SATA_NR_PORTS];
 783
 784         hw_regs_t       hw;             /* Hardware info */
 785         ide_drive_t     drives[MAX_DRIVES];     /* drive info */
 786
 787         u8 major;       /* our major number */
 788         u8 index;       /* 0 for ide0; 1 for ide1; ... */
 789         u8 channel;     /* for dual-port chips: 0=primary, 1=secondary */
 790         u8 straight8;   /* Alan's straight 8 check */
 791         u8 bus_state;   /* power state of the IDE bus */
 792
 793         u8 atapi_dma;   /* host supports atapi_dma */
 794         u8 ultra_mask;
 795         u8 mwdma_mask;
 796         u8 swdma_mask;
 797
 798         hwif_chipset_t chipset; /* sub-module for tuning.. */
 799
 800         struct pci_dev  *pci_dev;       /* for pci chipsets */
 801         struct ide_pci_device_s *cds;   /* chipset device struct */
 802
 803         ide_startstop_t (*rw_disk)(ide_drive_t *, struct request *, sector_t);
 804
 805 #if 0
 806         ide_hwif_ops_t  *hwifops;
 807 #else
 808         /* routine to tune PIO mode for drives */
 809         void    (*tuneproc)(ide_drive_t *, u8);
 810         /* routine to retune DMA modes for drives */
 811         int     (*speedproc)(ide_drive_t *, u8);
 812         /* tweaks hardware to select drive */
 813         void    (*selectproc)(ide_drive_t *);
 814         /* chipset polling based on hba specifics */
 815         int     (*reset_poll)(ide_drive_t *);
 816         /* chipset specific changes to default for device-hba resets */
 817         void    (*pre_reset)(ide_drive_t *);
 818         /* routine to reset controller after a disk reset */
 819         void    (*resetproc)(ide_drive_t *);
 820         /* special interrupt handling for shared pci interrupts */
 821         void    (*intrproc)(ide_drive_t *);
 822         /* special host masking for drive selection */
 823         void    (*maskproc)(ide_drive_t *, int);
 824         /* check host's drive quirk list */
 825         int     (*quirkproc)(ide_drive_t *);
 826         /* driver soft-power interface */
 827         int     (*busproc)(ide_drive_t *, int);
 828 //      /* host rate limiter */
 829 //      u8      (*ratemask)(ide_drive_t *);
 830 //      /* device rate limiter */
 831 //      u8      (*ratefilter)(ide_drive_t *, u8);
 832 #endif
 833
 834         void (*ata_input_data)(ide_drive_t *, void *, u32);
 835         void (*ata_output_data)(ide_drive_t *, void *, u32);
 836
 837         void (*atapi_input_bytes)(ide_drive_t *, void *, u32);
 838         void (*atapi_output_bytes)(ide_drive_t *, void *, u32);
 839
 840         int (*dma_setup)(ide_drive_t *);
 841         void (*dma_exec_cmd)(ide_drive_t *, u8);
 842         void (*dma_start)(ide_drive_t *);
 843         int (*ide_dma_end)(ide_drive_t *drive);
 844         int (*ide_dma_check)(ide_drive_t *drive);
 845         int (*ide_dma_on)(ide_drive_t *drive);
 846         int (*ide_dma_off_quietly)(ide_drive_t *drive);
 847         int (*ide_dma_test_irq)(ide_drive_t *drive);
 848         int (*ide_dma_host_on)(ide_drive_t *drive);
 849         int (*ide_dma_host_off)(ide_drive_t *drive);
 850         int (*ide_dma_lostirq)(ide_drive_t *drive);
 851         int (*ide_dma_timeout)(ide_drive_t *drive);
 852
 853         void (*OUTB)(u8 addr, unsigned long port);
 854         void (*OUTBSYNC)(ide_drive_t *drive, u8 addr, unsigned long port);
 855         void (*OUTW)(u16 addr, unsigned long port);
 856         void (*OUTL)(u32 addr, unsigned long port);
 857         void (*OUTSW)(unsigned long port, void *addr, u32 count);
 858         void (*OUTSL)(unsigned long port, void *addr, u32 count);
 859
 860         u8  (*INB)(unsigned long port);
 861         u16 (*INW)(unsigned long port);
 862         u32 (*INL)(unsigned long port);
 863         void (*INSW)(unsigned long port, void *addr, u32 count);
 864         void (*INSL)(unsigned long port, void *addr, u32 count);
 865
 866         /* dma physical region descriptor table (cpu view) */
 867         unsigned int    *dmatable_cpu;
 868         /* dma physical region descriptor table (dma view) */
 869         dma_addr_t      dmatable_dma;
 870         /* Scatter-gather list used to build the above */
 871         struct scatterlist *sg_table;
 872         int sg_max_nents;               /* Maximum number of entries in it */
 873         int sg_nents;                   /* Current number of entries in it */
 874         int sg_dma_direction;           /* dma transfer direction */
 875
 876         /* data phase of the active command (currently only valid for PIO/DMA) */
 877         int             data_phase;
 878
 879         unsigned int nsect;
 880         unsigned int nleft;
 881         unsigned int cursg;
 882         unsigned int cursg_ofs;
 883
 884         int             mmio;           /* hosts iomio (0) or custom (2) select */
 885         int             rqsize;         /* max sectors per request */
 886         int             irq;            /* our irq number */
 887
 888         unsigned long   dma_master;     /* reference base addr dmabase */
 889         unsigned long   dma_base;       /* base addr for dma ports */
 890         unsigned long   dma_command;    /* dma command register */
 891         unsigned long   dma_vendor1;    /* dma vendor 1 register */
 892         unsigned long   dma_status;     /* dma status register */
 893         unsigned long   dma_vendor3;    /* dma vendor 3 register */
 894         unsigned long   dma_prdtable;   /* actual prd table address */
 895         unsigned long   dma_base2;      /* extended base addr for dma ports */
 896
 897         unsigned        dma_extra;      /* extra addr for dma ports */
 898         unsigned long   config_data;    /* for use by chipset-specific code */
 899         unsigned long   select_data;    /* for use by chipset-specific code */
 900
 901         unsigned        noprobe    : 1; /* don't probe for this interface */
 902         unsigned        present    : 1; /* this interface exists */
 903         unsigned        hold       : 1; /* this interface is always present */
 904         unsigned        serialized : 1; /* serialized all channel operation */
 905         unsigned        sharing_irq: 1; /* 1 = sharing irq with another hwif */
 906         unsigned        reset      : 1; /* reset after probe */
 907         unsigned        autodma    : 1; /* auto-attempt using DMA at boot */
 908         unsigned        udma_four  : 1; /* 1=ATA-66 capable, 0=default */
 909         unsigned        no_lba48   : 1; /* 1 = cannot do LBA48 */
 910         unsigned        no_lba48_dma : 1; /* 1 = cannot do LBA48 DMA */
 911         unsigned        no_dsc     : 1; /* 0 default, 1 dsc_overlap disabled */
 912         unsigned        auto_poll  : 1; /* supports nop auto-poll */
 913         unsigned        sg_mapped  : 1; /* sg_table and sg_nents are ready */
 914
 915         struct device   gendev;
 916         struct semaphore gendev_rel_sem; /* To deal with device release() */
 917
 918         void            *hwif_data;     /* extra hwif data */
 919
 920         unsigned dma;
 921
 922         void (*led_act)(void *data, int rw);
 923 } ide_hwif_t;
 924
 925 /*
 926  *  internal ide interrupt handler type
 927  */
 928 typedef ide_startstop_t (ide_pre_handler_t)(ide_drive_t *, struct request *);
 929 typedef ide_startstop_t (ide_handler_t)(ide_drive_t *);
 930 typedef int (ide_expiry_t)(ide_drive_t *);
 931
 932 typedef struct hwgroup_s {
 933                 /* irq handler, if active */
 934         ide_startstop_t (*handler)(ide_drive_t *);
 935                 /* irq handler, suspended if active */
 936         ide_startstop_t (*handler_save)(ide_drive_t *);
 937                 /* BOOL: protects all fields below */
 938         volatile int busy;
 939                 /* BOOL: wake us up on timer expiry */
 940         int sleeping;
 941                 /* current drive */
 942         ide_drive_t *drive;
 943                 /* ptr to current hwif in linked-list */
 944         ide_hwif_t *hwif;
 945
 946                 /* for pci chipsets */
 947         struct pci_dev *pci_dev;
 948                 /* chipset device struct */
 949         struct ide_pci_device_s *cds;
 950
 951                 /* current request */
 952         struct request *rq;
 953                 /* failsafe timer */
 954         struct timer_list timer;
 955                 /* local copy of current write rq */
 956         struct request wrq;
 957                 /* timeout value during long polls */
 958         unsigned long poll_timeout;
 959                 /* queried upon timeouts */
 960         int (*expiry)(ide_drive_t *);
 961                 /* ide_system_bus_speed */
 962         int pio_clock;
 963
 964         unsigned char cmd_buf[4];
 965 } ide_hwgroup_t;
 966
 967 /* structure attached to the request for IDE_TASK_CMDS */
 968
 969 /*
 970  * configurable drive settings
 971  */
 972
 973 #define TYPE_INT        0
 974 #define TYPE_INTA       1
 975 #define TYPE_BYTE       2
 976 #define TYPE_SHORT      3
 977
 978 #define SETTING_READ    (1 << 0)
 979 #define SETTING_WRITE   (1 << 1)
 980 #define SETTING_RW      (SETTING_READ | SETTING_WRITE)
 981
 982 typedef int (ide_procset_t)(ide_drive_t *, int);
 983 typedef struct ide_settings_s {
 984         char                    *name;
 985         int                     rw;
 986         int                     read_ioctl;
 987         int                     write_ioctl;
 988         int                     data_type;
 989         int                     min;
 990         int                     max;
 991         int                     mul_factor;
 992         int                     div_factor;
 993         void                    *data;
 994         ide_procset_t           *set;
 995         int                     auto_remove;
 996         struct ide_settings_s   *next;
 997 } ide_settings_t;
 998
 999 extern struct semaphore ide_setting_sem;
1000 extern int ide_add_setting(ide_drive_t *drive, const char *name, int rw, int read_ioctl, int write_ioctl, int data_type, int min, int max, int mul_factor, int div_factor, void *data, ide_procset_t *set);
1001 extern ide_settings_t *ide_find_setting_by_name(ide_drive_t *drive, char *name);
1002 extern int ide_read_setting(ide_drive_t *t, ide_settings_t *setting);
1003 extern int ide_write_setting(ide_drive_t *drive, ide_settings_t *setting, int val);
1004 extern void ide_add_generic_settings(ide_drive_t *drive);
1005
1006 /*
1007  * /proc/ide interface
1008  */
1009 typedef struct {
1010         const char      *name;
1011         mode_t          mode;
1012         read_proc_t     *read_proc;
1013         write_proc_t    *write_proc;
1014 } ide_proc_entry_t;
1015
1016 #ifdef CONFIG_PROC_FS
1017 extern struct proc_dir_entry *proc_ide_root;
1018
1019 extern void proc_ide_create(void);
1020 extern void proc_ide_destroy(void);
1021 extern void create_proc_ide_interfaces(void);
1022 void destroy_proc_ide_interface(ide_hwif_t *);
1023 extern void ide_add_proc_entries(struct proc_dir_entry *, ide_proc_entry_t *, void *);
1024 extern void ide_remove_proc_entries(struct proc_dir_entry *, ide_proc_entry_t *);
1025 read_proc_t proc_ide_read_capacity;
1026 read_proc_t proc_ide_read_geometry;
1027
1028 #ifdef CONFIG_BLK_DEV_IDEPCI
1029 void ide_pci_create_host_proc(const char *, get_info_t *);
1030 #endif
1031
1032 /*
1033  * Standard exit stuff:
1034  */
1035 #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) \
1036 {                                       \
1037         len -= off;                     \
1038         if (len < count) {              \
1039                 *eof = 1;               \
1040                 if (len <= 0)           \
1041                         return 0;       \
1042         } else                          \
1043                 len = count;            \
1044         *start = page + off;            \
1045         return len;                     \
1046 }
1047 #else
1048 static inline void create_proc_ide_interfaces(void) { ; }
1049 static inline void destroy_proc_ide_interface(ide_hwif_t *hwif) { ; }
1050 #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) return 0;
1051 #endif
1052
1053 /*
1054  * Power Management step value (rq->pm->pm_step).
1055  *
1056  * The step value starts at 0 (ide_pm_state_start_suspend) for a
1057  * suspend operation or 1000 (ide_pm_state_start_resume) for a
1058  * resume operation.
1059  *
1060  * For each step, the core calls the subdriver start_power_step() first.
1061  * This can return:
1062  *      - ide_stopped : In this case, the core calls us back again unless
1063  *                      step have been set to ide_power_state_completed.
1064  *      - ide_started : In this case, the channel is left busy until an
1065  *                      async event (interrupt) occurs.
1066  * Typically, start_power_step() will issue a taskfile request with
1067  * do_rw_taskfile().
1068  *
1069  * Upon reception of the interrupt, the core will call complete_power_step()
1070  * with the error code if any. This routine should update the step value
1071  * and return. It should not start a new request. The core will call
1072  * start_power_step for the new step value, unless step have been set to
1073  * ide_power_state_completed.
1074  *
1075  * Subdrivers are expected to define their own additional power
1076  * steps from 1..999 for suspend and from 1001..1999 for resume,
1077  * other values are reserved for future use.
1078  */
1079
1080 enum {
1081         ide_pm_state_completed          = -1,
1082         ide_pm_state_start_suspend      = 0,
1083         ide_pm_state_start_resume       = 1000,
1084 };
1085
1086 /*
1087  * Subdrivers support.
1088  */
1089 typedef struct ide_driver_s {
1090         struct module                   *owner;
1091         const char                      *name;
1092         const char                      *version;
1093         u8                              media;
1094         unsigned busy                   : 1;
1095         unsigned supports_dsc_overlap   : 1;
1096         int             (*cleanup)(ide_drive_t *);
1097         ide_startstop_t (*do_request)(ide_drive_t *, struct request *, sector_t);
1098         int             (*end_request)(ide_drive_t *, int, int);
1099         ide_startstop_t (*error)(ide_drive_t *, struct request *rq, u8, u8);
1100         ide_startstop_t (*abort)(ide_drive_t *, struct request *rq);
1101         int             (*ioctl)(ide_drive_t *, struct inode *, struct file *, unsigned int, unsigned long);
1102         void            (*pre_reset)(ide_drive_t *);
1103         sector_t        (*capacity)(ide_drive_t *);
1104         ide_startstop_t (*special)(ide_drive_t *);
1105         ide_proc_entry_t        *proc;
1106         int             (*attach)(ide_drive_t *);
1107         void            (*ata_prebuilder)(ide_drive_t *);
1108         void            (*atapi_prebuilder)(ide_drive_t *);
1109         ide_startstop_t (*start_power_step)(ide_drive_t *, struct request *);
1110         void            (*complete_power_step)(ide_drive_t *, struct request *, u8, u8);
1111         struct device_driver    gen_driver;
1112         struct list_head drives;
1113         struct list_head drivers;
1114 } ide_driver_t;
1115
1116 #define DRIVER(drive)           ((drive)->driver)
1117
1118 extern int generic_ide_ioctl(struct file *, struct block_device *, unsigned, unsigned long);
1119
1120 /*
1121  * ide_hwifs[] is the master data structure used to keep track
1122  * of just about everything in ide.c.  Whenever possible, routines
1123  * should be using pointers to a drive (ide_drive_t *) or
1124  * pointers to a hwif (ide_hwif_t *), rather than indexing this
1125  * structure directly (the allocation/layout may change!).
1126  *
1127  */
1128 #ifndef _IDE_C
1129 extern  ide_hwif_t      ide_hwifs[];            /* master data repository */
1130 #endif
1131 extern int noautodma;
1132
1133 extern int ide_end_request (ide_drive_t *drive, int uptodate, int nrsecs);
1134
1135 /*
1136  * This is used on exit from the driver to designate the next irq handler
1137  * and also to start the safety timer.
1138  */
1139 extern void ide_set_handler (ide_drive_t *drive, ide_handler_t *handler, unsigned int timeout, ide_expiry_t *expiry);
1140
1141 /*
1142  * This is used on exit from the driver to designate the next irq handler
1143  * and start the safety time safely and atomically from the IRQ handler
1144  * with respect to the command issue (which it also does)
1145  */
1146 extern void ide_execute_command(ide_drive_t *, task_ioreg_t cmd, ide_handler_t *, unsigned int, ide_expiry_t *);
1147
1148 ide_startstop_t __ide_error(ide_drive_t *, struct request *, u8, u8);
1149
1150 /*
1151  * ide_error() takes action based on the error returned by the controller.
1152  * The caller should return immediately after invoking this.
1153  *
1154  * (drive, msg, status)
1155  */
1156 ide_startstop_t ide_error (ide_drive_t *drive, const char *msg, byte stat);
1157
1158 ide_startstop_t __ide_abort(ide_drive_t *, struct request *);
1159
1160 /*
1161  * Abort a running command on the controller triggering the abort
1162  * from a host side, non error situation
1163  * (drive, msg)
1164  */
1165 extern ide_startstop_t ide_abort(ide_drive_t *, const char *);
1166
1167 extern void ide_fix_driveid(struct hd_driveid *);
1168 /*
1169  * ide_fixstring() cleans up and (optionally) byte-swaps a text string,
1170  * removing leading/trailing blanks and compressing internal blanks.
1171  * It is primarily used to tidy up the model name/number fields as
1172  * returned by the WIN_[P]IDENTIFY commands.
1173  *
1174  * (s, bytecount, byteswap)
1175  */
1176 extern void ide_fixstring(u8 *, const int, const int);
1177
1178 /*
1179  * This routine busy-waits for the drive status to be not "busy".
1180  * It then checks the status for all of the "good" bits and none
1181  * of the "bad" bits, and if all is okay it returns 0.  All other
1182  * cases return 1 after doing "*startstop = ide_error()", and the
1183  * caller should return the updated value of "startstop" in this case.
1184  * "startstop" is unchanged when the function returns 0;
1185  * (startstop, drive, good, bad, timeout)
1186  */
1187 extern int ide_wait_stat(ide_startstop_t *, ide_drive_t *, u8, u8, unsigned long);
1188
1189 /*
1190  * Start a reset operation for an IDE interface.
1191  * The caller should return immediately after invoking this.
1192  */
1193 extern ide_startstop_t ide_do_reset (ide_drive_t *);
1194
1195 /*
1196  * This function is intended to be used prior to invoking ide_do_drive_cmd().
1197  */
1198 extern void ide_init_drive_cmd (struct request *rq);
1199
1200 /*
1201  * this function returns error location sector offset in case of a write error
1202  */
1203 extern u64 ide_get_error_location(ide_drive_t *, char *);
1204
1205 /*
1206  * "action" parameter type for ide_do_drive_cmd() below.
1207  */
1208 typedef enum {
1209         ide_wait,       /* insert rq at end of list, and wait for it */
1210         ide_next,       /* insert rq immediately after current request */
1211         ide_preempt,    /* insert rq in front of current request */
1212         ide_head_wait,  /* insert rq in front of current request and wait for it */
1213         ide_end         /* insert rq at end of list, but don't wait for it */
1214 } ide_action_t;
1215
1216 /*
1217  * This function issues a special IDE device request
1218  * onto the request queue.
1219  *
1220  * If action is ide_wait, then the rq is queued at the end of the
1221  * request queue, and the function sleeps until it has been processed.
1222  * This is for use when invoked from an ioctl handler.
1223  *
1224  * If action is ide_preempt, then the rq is queued at the head of
1225  * the request queue, displacing the currently-being-processed
1226  * request and this function returns immediately without waiting
1227  * for the new rq to be completed.  This is VERY DANGEROUS, and is
1228  * intended for careful use by the ATAPI tape/cdrom driver code.
1229  *
1230  * If action is ide_next, then the rq is queued immediately after
1231  * the currently-being-processed-request (if any), and the function
1232  * returns without waiting for the new rq to be completed.  As above,
1233  * This is VERY DANGEROUS, and is intended for careful use by the
1234  * ATAPI tape/cdrom driver code.
1235  *
1236  * If action is ide_end, then the rq is queued at the end of the
1237  * request queue, and the function returns immediately without waiting
1238  * for the new rq to be completed. This is again intended for careful
1239  * use by the ATAPI tape/cdrom driver code.
1240  */
1241 extern int ide_do_drive_cmd(ide_drive_t *, struct request *, ide_action_t);
1242
1243 /*
1244  * Clean up after success/failure of an explicit drive cmd.
1245  * stat/err are used only when (HWGROUP(drive)->rq->cmd == IDE_DRIVE_CMD).
1246  * stat/err are used only when (HWGROUP(drive)->rq->cmd == IDE_DRIVE_TASK_MASK).
1247  *
1248  * (ide_drive_t *drive, u8 stat, u8 err)
1249  */
1250 extern void ide_end_drive_cmd(ide_drive_t *, u8, u8);
1251
1252 /*
1253  * Issue ATA command and wait for completion.
1254  * Use for implementing commands in kernel
1255  *
1256  *  (ide_drive_t *drive, u8 cmd, u8 nsect, u8 feature, u8 sectors, u8 *buf)
1257  */
1258 extern int ide_wait_cmd(ide_drive_t *, u8, u8, u8, u8, u8 *);
1259
1260 typedef struct ide_task_s {
1261 /*
1262  *      struct hd_drive_task_hdr        tf;
1263  *      task_struct_t           tf;
1264  *      struct hd_drive_hob_hdr         hobf;
1265  *      hob_struct_t            hobf;
1266  */
1267         task_ioreg_t            tfRegister[8];
1268         task_ioreg_t            hobRegister[8];
1269         ide_reg_valid_t         tf_out_flags;
1270         ide_reg_valid_t         tf_in_flags;
1271         int                     data_phase;
1272         int                     command_type;
1273         ide_pre_handler_t       *prehandler;
1274         ide_handler_t           *handler;
1275         struct request          *rq;            /* copy of request */
1276         void                    *special;       /* valid_t generally */
1277 } ide_task_t;
1278
1279 typedef struct pkt_task_s {
1280 /*
1281  *      struct hd_drive_task_hdr        pktf;
1282  *      task_struct_t           pktf;
1283  *      u8                      pkcdb[12];
1284  */
1285         task_ioreg_t            tfRegister[8];
1286         int                     data_phase;
1287         int                     command_type;
1288         ide_handler_t           *handler;
1289         struct request          *rq;            /* copy of request */
1290         void                    *special;
1291 } pkt_task_t;
1292
1293 extern u32 ide_read_24(ide_drive_t *);
1294
1295 extern void SELECT_DRIVE(ide_drive_t *);
1296 extern void SELECT_INTERRUPT(ide_drive_t *);
1297 extern void SELECT_MASK(ide_drive_t *, int);
1298 extern void QUIRK_LIST(ide_drive_t *);
1299
1300 extern void ata_input_data(ide_drive_t *, void *, u32);
1301 extern void ata_output_data(ide_drive_t *, void *, u32);
1302 extern void atapi_input_bytes(ide_drive_t *, void *, u32);
1303 extern void atapi_output_bytes(ide_drive_t *, void *, u32);
1304
1305 extern int drive_is_ready(ide_drive_t *);
1306 extern int wait_for_ready(ide_drive_t *, int /* timeout */);
1307
1308 /*
1309  * taskfile io for disks for now...and builds request from ide_ioctl
1310  */
1311 extern ide_startstop_t do_rw_taskfile(ide_drive_t *, ide_task_t *);
1312
1313 /*
1314  * Special Flagged Register Validation Caller
1315  */
1316 extern ide_startstop_t flagged_taskfile(ide_drive_t *, ide_task_t *);
1317
1318 extern ide_startstop_t set_multmode_intr(ide_drive_t *);
1319 extern ide_startstop_t set_geometry_intr(ide_drive_t *);
1320 extern ide_startstop_t recal_intr(ide_drive_t *);
1321 extern ide_startstop_t task_no_data_intr(ide_drive_t *);
1322 extern ide_startstop_t task_in_intr(ide_drive_t *);
1323 extern ide_startstop_t pre_task_out_intr(ide_drive_t *, struct request *);
1324
1325 extern int ide_raw_taskfile(ide_drive_t *, ide_task_t *, u8 *);
1326
1327 int ide_taskfile_ioctl(ide_drive_t *, unsigned int, unsigned long);
1328 int ide_cmd_ioctl(ide_drive_t *, unsigned int, unsigned long);
1329 int ide_task_ioctl(ide_drive_t *, unsigned int, unsigned long);
1330
1331 extern int system_bus_clock(void);
1332
1333 extern int ide_driveid_update(ide_drive_t *);
1334 extern int ide_ata66_check(ide_drive_t *, ide_task_t *);
1335 extern int ide_config_drive_speed(ide_drive_t *, u8);
1336 extern u8 eighty_ninty_three (ide_drive_t *);
1337 extern int set_transfer(ide_drive_t *, ide_task_t *);
1338 extern int taskfile_lib_get_identify(ide_drive_t *drive, u8 *);
1339
1340 extern int ide_wait_not_busy(ide_hwif_t *hwif, unsigned long timeout);
1341 ide_startstop_t __ide_do_rw_disk(ide_drive_t *drive, struct request *rq, sector_t block);
1342
1343 /*
1344  * ide_system_bus_speed() returns what we think is the system VESA/PCI
1345  * bus speed (in MHz).  This is used for calculating interface PIO timings.
1346  * The default is 40 for known PCI systems, 50 otherwise.
1347  * The "idebus=xx" parameter can be used to override this value.
1348  */
1349 extern int ide_system_bus_speed(void);
1350
1351 /*
1352  * ide_stall_queue() can be used by a drive to give excess bandwidth back
1353  * to the hwgroup by sleeping for timeout jiffies.
1354  */
1355 extern void ide_stall_queue(ide_drive_t *drive, unsigned long timeout);
1356
1357 extern int ide_spin_wait_hwgroup(ide_drive_t *);
1358 extern void ide_timer_expiry(unsigned long);
1359 extern irqreturn_t ide_intr(int irq, void *dev_id, struct pt_regs *regs);
1360 extern void do_ide_request(request_queue_t *);
1361 extern void ide_init_subdrivers(void);
1362
1363 extern struct block_device_operations ide_fops[];
1364 extern ide_proc_entry_t generic_subdriver_entries[];
1365
1366 extern int ata_attach(ide_drive_t *);
1367
1368 extern int ideprobe_init(void);
1369
1370 extern void ide_scan_pcibus(int scan_direction) __init;
1371 extern int ide_pci_register_driver(struct pci_driver *driver);
1372 extern void ide_pci_unregister_driver(struct pci_driver *driver);
1373 void ide_pci_setup_ports(struct pci_dev *, struct ide_pci_device_s *, int, ata_index_t *);
1374 extern void ide_setup_pci_noise (struct pci_dev *dev, struct ide_pci_device_s *d);
1375
1376 extern void default_hwif_iops(ide_hwif_t *);
1377 extern void default_hwif_mmiops(ide_hwif_t *);
1378 extern void default_hwif_transport(ide_hwif_t *);
1379
1380 int ide_register_driver(ide_driver_t *driver);
1381 void ide_unregister_driver(ide_driver_t *driver);
1382 int ide_register_subdriver(ide_drive_t *, ide_driver_t *);
1383 int ide_unregister_subdriver (ide_drive_t *drive);
1384 int ide_replace_subdriver(ide_drive_t *drive, const char *driver);
1385
1386 #define ON_BOARD                1
1387 #define NEVER_BOARD             0
1388
1389 #ifdef CONFIG_BLK_DEV_OFFBOARD
1390 #  define OFF_BOARD             ON_BOARD
1391 #else /* CONFIG_BLK_DEV_OFFBOARD */
1392 #  define OFF_BOARD             NEVER_BOARD
1393 #endif /* CONFIG_BLK_DEV_OFFBOARD */
1394
1395 #define NODMA 0
1396 #define NOAUTODMA 1
1397 #define AUTODMA 2
1398
1399 typedef struct ide_pci_enablebit_s {
1400         u8      reg;    /* byte pci reg holding the enable-bit */
1401         u8      mask;   /* mask to isolate the enable-bit */
1402         u8      val;    /* value of masked reg when "enabled" */
1403 } ide_pci_enablebit_t;
1404
1405 enum {
1406         /* Uses ISA control ports not PCI ones. */
1407         IDEPCI_FLAG_ISA_PORTS           = (1 << 0),
1408         IDEPCI_FLAG_FORCE_PDC           = (1 << 1),
1409 };
1410
1411 typedef struct ide_pci_device_s {
1412         char                    *name;
1413         int                     (*init_setup)(struct pci_dev *, struct ide_pci_device_s *);
1414         void                    (*init_setup_dma)(struct pci_dev *, struct ide_pci_device_s *, ide_hwif_t *);
1415         unsigned int            (*init_chipset)(struct pci_dev *, const char *);
1416         void                    (*init_iops)(ide_hwif_t *);
1417         void                    (*init_hwif)(ide_hwif_t *);
1418         void                    (*init_dma)(ide_hwif_t *, unsigned long);
1419         void                    (*fixup)(ide_hwif_t *);
1420         u8                      channels;
1421         u8                      autodma;
1422         ide_pci_enablebit_t     enablebits[2];
1423         u8                      bootable;
1424         unsigned int            extra;
1425         struct ide_pci_device_s *next;
1426         u8                      flags;
1427 } ide_pci_device_t;
1428
1429 extern int ide_setup_pci_device(struct pci_dev *, ide_pci_device_t *);
1430 extern int ide_setup_pci_devices(struct pci_dev *, struct pci_dev *, ide_pci_device_t *);
1431
1432 void ide_map_sg(ide_drive_t *, struct request *);
1433 void ide_init_sg_cmd(ide_drive_t *, struct request *);
1434
1435 #define BAD_DMA_DRIVE           0
1436 #define GOOD_DMA_DRIVE          1
1437
1438 #ifdef CONFIG_BLK_DEV_IDEDMA
1439 int __ide_dma_bad_drive(ide_drive_t *);
1440 int __ide_dma_good_drive(ide_drive_t *);
1441 int ide_use_dma(ide_drive_t *);
1442 int __ide_dma_off(ide_drive_t *);
1443 void ide_dma_verbose(ide_drive_t *);
1444 ide_startstop_t ide_dma_intr(ide_drive_t *);
1445
1446 #ifdef CONFIG_BLK_DEV_IDEDMA_PCI
1447 extern int ide_build_sglist(ide_drive_t *, struct request *);
1448 extern int ide_build_dmatable(ide_drive_t *, struct request *);
1449 extern void ide_destroy_dmatable(ide_drive_t *);
1450 extern int ide_release_dma(ide_hwif_t *);
1451 extern void ide_setup_dma(ide_hwif_t *, unsigned long, unsigned int);
1452
1453 extern int __ide_dma_host_off(ide_drive_t *);
1454 extern int __ide_dma_off_quietly(ide_drive_t *);
1455 extern int __ide_dma_host_on(ide_drive_t *);
1456 extern int __ide_dma_on(ide_drive_t *);
1457 extern int __ide_dma_check(ide_drive_t *);
1458 extern int ide_dma_setup(ide_drive_t *);
1459 extern void ide_dma_start(ide_drive_t *);
1460 extern int __ide_dma_end(ide_drive_t *);
1461 extern int __ide_dma_test_irq(ide_drive_t *);
1462 extern int __ide_dma_lostirq(ide_drive_t *);
1463 extern int __ide_dma_timeout(ide_drive_t *);
1464 #endif /* CONFIG_BLK_DEV_IDEDMA_PCI */
1465
1466 #else
1467 static inline int ide_use_dma(ide_drive_t *drive) { return 0; }
1468 static inline int __ide_dma_off(ide_drive_t *drive) { return 0; }
1469 static inline void ide_dma_verbose(ide_drive_t *drive) { ; }
1470 #endif /* CONFIG_BLK_DEV_IDEDMA */
1471
1472 #ifndef CONFIG_BLK_DEV_IDEDMA_PCI
1473 static inline void ide_release_dma(ide_hwif_t *drive) {;}
1474 #endif
1475
1476 extern int ide_hwif_request_regions(ide_hwif_t *hwif);
1477 extern void ide_hwif_release_regions(ide_hwif_t* hwif);
1478 extern void ide_unregister (unsigned int index);
1479
1480 void ide_undecoded_slave(ide_hwif_t *);
1481
1482 int probe_hwif_init_with_fixup(ide_hwif_t *, void (*)(ide_hwif_t *));
1483 extern int probe_hwif_init(ide_hwif_t *);
1484
1485 static inline void *ide_get_hwifdata (ide_hwif_t * hwif)
1486 {
1487         return hwif->hwif_data;
1488 }
1489
1490 static inline void ide_set_hwifdata (ide_hwif_t * hwif, void *data)
1491 {
1492         hwif->hwif_data = data;
1493 }
1494
1495 /* ide-lib.c */
1496 extern u8 ide_dma_speed(ide_drive_t *drive, u8 mode);
1497 extern u8 ide_rate_filter(u8 mode, u8 speed);
1498 extern int ide_dma_enable(ide_drive_t *drive);
1499 extern char *ide_xfer_verbose(u8 xfer_rate);
1500 extern void ide_toggle_bounce(ide_drive_t *drive, int on);
1501 extern int ide_set_xfer_rate(ide_drive_t *drive, u8 rate);
1502
1503 u8 ide_dump_status(ide_drive_t *, const char *, u8);
1504
1505 typedef struct ide_pio_timings_s {
1506         int     setup_time;     /* Address setup (ns) minimum */
1507         int     active_time;    /* Active pulse (ns) minimum */
1508         int     cycle_time;     /* Cycle time (ns) minimum = (setup + active + recovery) */
1509 } ide_pio_timings_t;
1510
1511 typedef struct ide_pio_data_s {
1512         u8 pio_mode;
1513         u8 use_iordy;
1514         u8 overridden;
1515         u8 blacklisted;
1516         unsigned int cycle_time;
1517 } ide_pio_data_t;
1518
1519 extern u8 ide_get_best_pio_mode (ide_drive_t *drive, u8 mode_wanted, u8 max_mode, ide_pio_data_t *d);
1520 extern const ide_pio_timings_t ide_pio_timings[6];
1521
1522
1523 extern spinlock_t ide_lock;
1524 extern struct semaphore ide_cfg_sem;
1525 /*
1526  * Structure locking:
1527  *
1528  * ide_cfg_sem and ide_lock together protect changes to
1529  * ide_hwif_t->{next,hwgroup}
1530  * ide_drive_t->next
1531  *
1532  * ide_hwgroup_t->busy: ide_lock
1533  * ide_hwgroup_t->hwif: ide_lock
1534  * ide_hwif_t->mate: constant, no locking
1535  * ide_drive_t->hwif: constant, no locking
1536  */
1537
1538 #define local_irq_set(flags)    do { local_save_flags((flags)); local_irq_enable(); } while (0)
1539
1540 extern struct bus_type ide_bus_type;
1541
1542 /* check if CACHE FLUSH (EXT) command is supported (bits defined in ATA-6) */
1543 #define ide_id_has_flush_cache(id)      ((id)->cfs_enable_2 & 0x3000)
1544
1545 /* some Maxtor disks have bit 13 defined incorrectly so check bit 10 too */
1546 #define ide_id_has_flush_cache_ext(id)  \
1547         (((id)->cfs_enable_2 & 0x2400) == 0x2400)
1548
1549 #endif /* _IDE_H */