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