home *** CD-ROM | disk | FTP | other *** search
/ PC Welt 2006 November (DVD) / PCWELT_11_2006.ISO / casper / filesystem.squashfs / usr / src / linux-headers-2.6.17-6 / include / linux / ide.h < prev    next >
Encoding:
C/C++ Source or Header  |  2006-08-11  |  43.5 KB  |  1,403 lines

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