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

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