ide.h
上传用户:lgb322
上传日期:2013-02-24
资源大小:30529k
文件大小:34k
源码类别:

嵌入式Linux

开发平台:

Unix_Linux

  1. #ifndef _IDE_H
  2. #define _IDE_H
  3. /*
  4.  *  linux/include/linux/ide.h
  5.  *
  6.  *  Copyright (C) 1994-1998  Linus Torvalds & authors
  7.  */
  8. #include <linux/config.h>
  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/devfs_fs_kernel.h>
  16. #include <asm/hdreg.h>
  17. /*
  18.  * This is the multiple IDE interface driver, as evolved from hd.c.
  19.  * It supports up to four IDE interfaces, on one or more IRQs (usually 14 & 15).
  20.  * There can be up to two drives per interface, as per the ATA-2 spec.
  21.  *
  22.  * Primary i/f:    ide0: major=3;  (hda)         minor=0; (hdb)         minor=64
  23.  * Secondary i/f:  ide1: major=22; (hdc or hd1a) minor=0; (hdd or hd1b) minor=64
  24.  * Tertiary i/f:   ide2: major=33; (hde)         minor=0; (hdf)         minor=64
  25.  * Quaternary i/f: ide3: major=34; (hdg)         minor=0; (hdh)         minor=64
  26.  */
  27. /******************************************************************************
  28.  * IDE driver configuration options (play with these as desired):
  29.  *
  30.  * REALLY_SLOW_IO can be defined in ide.c and ide-cd.c, if necessary
  31.  */
  32. #undef REALLY_FAST_IO /* define if ide ports are perfect */
  33. #define INITIAL_MULT_COUNT 0 /* off=0; on=2,4,8,16,32, etc.. */
  34. #ifndef SUPPORT_SLOW_DATA_PORTS /* 1 to support slow data ports */
  35. #define SUPPORT_SLOW_DATA_PORTS 1 /* 0 to reduce kernel size */
  36. #endif
  37. #ifndef SUPPORT_VLB_SYNC /* 1 to support weird 32-bit chips */
  38. #define SUPPORT_VLB_SYNC 1 /* 0 to reduce kernel size */
  39. #endif
  40. #ifndef DISK_RECOVERY_TIME /* off=0; on=access_delay_time */
  41. #define DISK_RECOVERY_TIME 0 /*  for hardware that needs it */
  42. #endif
  43. #ifndef OK_TO_RESET_CONTROLLER /* 1 needed for good error recovery */
  44. #define OK_TO_RESET_CONTROLLER 1 /* 0 for use with AH2372A/B interface */
  45. #endif
  46. #ifndef FANCY_STATUS_DUMPS /* 1 for human-readable drive errors */
  47. #define FANCY_STATUS_DUMPS 1 /* 0 to reduce kernel size */
  48. #endif
  49. #ifdef CONFIG_BLK_DEV_CMD640
  50. #if 0 /* change to 1 when debugging cmd640 problems */
  51. void cmd640_dump_regs (void);
  52. #define CMD640_DUMP_REGS cmd640_dump_regs() /* for debugging cmd640 chipset */
  53. #endif
  54. #endif  /* CONFIG_BLK_DEV_CMD640 */
  55. #ifndef DISABLE_IRQ_NOSYNC
  56. #define DISABLE_IRQ_NOSYNC 0
  57. #endif
  58. /*
  59.  * IDE_DRIVE_CMD is used to implement many features of the hdparm utility
  60.  */
  61. #define IDE_DRIVE_CMD 99 /* (magic) undef to reduce kernel size*/
  62. /*
  63.  * IDE_DRIVE_TASK is used to implement many features needed for raw tasks
  64.  */
  65. #define IDE_DRIVE_TASK 98
  66. #define IDE_DRIVE_CMD_AEB 98
  67. /*
  68.  *  "No user-serviceable parts" beyond this point  :)
  69.  *****************************************************************************/
  70. typedef unsigned char byte; /* used everywhere */
  71. /*
  72.  * Probably not wise to fiddle with these
  73.  */
  74. #define ERROR_MAX 8 /* Max read/write errors per sector */
  75. #define ERROR_RESET 3 /* Reset controller every 4th retry */
  76. #define ERROR_RECAL 1 /* Recalibrate every 2nd retry */
  77. /*
  78.  * state flags
  79.  */
  80. #define DMA_PIO_RETRY 1 /* retrying in PIO */
  81. /*
  82.  * Ensure that various configuration flags have compatible settings
  83.  */
  84. #ifdef REALLY_SLOW_IO
  85. #undef REALLY_FAST_IO
  86. #endif
  87. #define HWIF(drive) ((ide_hwif_t *)((drive)->hwif))
  88. #define HWGROUP(drive) ((ide_hwgroup_t *)(HWIF(drive)->hwgroup))
  89. /*
  90.  * Definitions for accessing IDE controller registers
  91.  */
  92. #define IDE_NR_PORTS (10)
  93. #define IDE_DATA_OFFSET (0)
  94. #define IDE_ERROR_OFFSET (1)
  95. #define IDE_NSECTOR_OFFSET (2)
  96. #define IDE_SECTOR_OFFSET (3)
  97. #define IDE_LCYL_OFFSET (4)
  98. #define IDE_HCYL_OFFSET (5)
  99. #define IDE_SELECT_OFFSET (6)
  100. #define IDE_STATUS_OFFSET (7)
  101. #define IDE_CONTROL_OFFSET (8)
  102. #define IDE_IRQ_OFFSET (9)
  103. #define IDE_FEATURE_OFFSET IDE_ERROR_OFFSET
  104. #define IDE_COMMAND_OFFSET IDE_STATUS_OFFSET
  105. #define IDE_DATA_REG (HWIF(drive)->io_ports[IDE_DATA_OFFSET])
  106. #define IDE_ERROR_REG (HWIF(drive)->io_ports[IDE_ERROR_OFFSET])
  107. #define IDE_NSECTOR_REG (HWIF(drive)->io_ports[IDE_NSECTOR_OFFSET])
  108. #define IDE_SECTOR_REG (HWIF(drive)->io_ports[IDE_SECTOR_OFFSET])
  109. #define IDE_LCYL_REG (HWIF(drive)->io_ports[IDE_LCYL_OFFSET])
  110. #define IDE_HCYL_REG (HWIF(drive)->io_ports[IDE_HCYL_OFFSET])
  111. #define IDE_SELECT_REG (HWIF(drive)->io_ports[IDE_SELECT_OFFSET])
  112. #define IDE_STATUS_REG (HWIF(drive)->io_ports[IDE_STATUS_OFFSET])
  113. #define IDE_CONTROL_REG (HWIF(drive)->io_ports[IDE_CONTROL_OFFSET])
  114. #define IDE_IRQ_REG (HWIF(drive)->io_ports[IDE_IRQ_OFFSET])
  115. #define IDE_FEATURE_REG IDE_ERROR_REG
  116. #define IDE_COMMAND_REG IDE_STATUS_REG
  117. #define IDE_ALTSTATUS_REG IDE_CONTROL_REG
  118. #define IDE_IREASON_REG IDE_NSECTOR_REG
  119. #define IDE_BCOUNTL_REG IDE_LCYL_REG
  120. #define IDE_BCOUNTH_REG IDE_HCYL_REG
  121. #define GET_ERR() IN_BYTE(IDE_ERROR_REG)
  122. #define GET_STAT() IN_BYTE(IDE_STATUS_REG)
  123. #define GET_ALTSTAT() IN_BYTE(IDE_CONTROL_REG)
  124. #define OK_STAT(stat,good,bad) (((stat)&((good)|(bad)))==(good))
  125. #define BAD_R_STAT (BUSY_STAT   | ERR_STAT)
  126. #define BAD_W_STAT (BAD_R_STAT  | WRERR_STAT)
  127. #define BAD_STAT (BAD_R_STAT  | DRQ_STAT)
  128. #define DRIVE_READY (READY_STAT  | SEEK_STAT)
  129. #define DATA_READY (DRQ_STAT)
  130. /*
  131.  * Some more useful definitions
  132.  */
  133. #define IDE_MAJOR_NAME "hd" /* the same for all i/f; see also genhd.c */
  134. #define MAJOR_NAME IDE_MAJOR_NAME
  135. #define PARTN_BITS 6 /* number of minor dev bits for partitions */
  136. #define PARTN_MASK ((1<<PARTN_BITS)-1) /* a useful bit mask */
  137. #define MAX_DRIVES 2 /* per interface; 2 assumed by lots of code */
  138. #define SECTOR_WORDS (512 / 4) /* number of 32bit words per sector */
  139. #define IDE_LARGE_SEEK(b1,b2,t) (((b1) > (b2) + (t)) || ((b2) > (b1) + (t)))
  140. #define IDE_MIN(a,b) ((a)<(b) ? (a):(b))
  141. #define IDE_MAX(a,b) ((a)>(b) ? (a):(b))
  142. /*
  143.  * Timeouts for various operations:
  144.  */
  145. #define WAIT_DRQ (5*HZ/100) /* 50msec - spec allows up to 20ms */
  146. #if defined(CONFIG_APM) || defined(CONFIG_APM_MODULE)
  147. #define WAIT_READY (5*HZ) /* 5sec - some laptops are very slow */
  148. #else
  149. #define WAIT_READY (3*HZ/100) /* 30msec - should be instantaneous */
  150. #endif /* CONFIG_APM || CONFIG_APM_MODULE */
  151. #define WAIT_PIDENTIFY (10*HZ) /* 10sec  - should be less than 3ms (?)
  152.             if all ATAPI CD is closed at boot */
  153. #define WAIT_WORSTCASE (30*HZ) /* 30sec  - worst case when spinning up */
  154. #define WAIT_CMD (10*HZ) /* 10sec  - maximum wait for an IRQ to happen */
  155. #define WAIT_MIN_SLEEP (2*HZ/100) /* 20msec - minimum sleep time */
  156. #define SELECT_DRIVE(hwif,drive)
  157. {
  158. if (hwif->selectproc)
  159. hwif->selectproc(drive);
  160. OUT_BYTE((drive)->select.all, hwif->io_ports[IDE_SELECT_OFFSET]); 
  161. }
  162. #define SELECT_INTERRUPT(hwif,drive)
  163. {
  164. if (hwif->intrproc)
  165. hwif->intrproc(drive);
  166. else
  167. OUT_BYTE((drive)->ctl|2, hwif->io_ports[IDE_CONTROL_OFFSET]);
  168. }
  169. #define SELECT_MASK(hwif,drive,mask)
  170. {
  171. if (hwif->maskproc)
  172. hwif->maskproc(drive,mask);
  173. }
  174. #define SELECT_READ_WRITE(hwif,drive,func)
  175. {
  176. if (hwif->rwproc)
  177. hwif->rwproc(drive,func);
  178. }
  179. #define QUIRK_LIST(hwif,drive)
  180. {
  181. if (hwif->quirkproc)
  182. (drive)->quirk_list = hwif->quirkproc(drive);
  183. }
  184. #define IDE_DEBUG(lineno) 
  185. printk("%s,%s,line=%dn", __FILE__, __FUNCTION__, (lineno))
  186. /*
  187.  * Check for an interrupt and acknowledge the interrupt status
  188.  */
  189. struct hwif_s;
  190. struct ide_drive_s;
  191. typedef int (ide_ack_intr_t)(struct hwif_s *);
  192. typedef void (ide_xfer_data_t)(struct ide_drive_s *, void *, unsigned int);
  193. #ifndef NO_DMA
  194. #define NO_DMA  255
  195. #endif
  196. /*
  197.  * Structure to hold all information about the location of this port
  198.  */
  199. typedef struct hw_regs_s {
  200. ide_ioreg_t io_ports[IDE_NR_PORTS]; /* task file registers */
  201. int irq; /* our irq number */
  202. int dma; /* our dma number */
  203. ide_ack_intr_t *ack_intr; /* acknowledge interrupt */
  204. ide_xfer_data_t *ide_output_data; /* write data to i/face */
  205. ide_xfer_data_t *ide_input_data; /* read data from i/face */
  206. ide_xfer_data_t *atapi_output_bytes; /* write bytes to i/face */
  207. ide_xfer_data_t *atapi_input_bytes; /* read bytes from i/face */
  208. void *priv; /* interface specific data */
  209. } hw_regs_t;
  210. /*
  211.  * Register new hardware with ide
  212.  */
  213. int ide_register_hw(hw_regs_t *hw, struct hwif_s **hwifp);
  214. /*
  215.  * Set up hw_regs_t structure before calling ide_register_hw (optional)
  216.  */
  217. void ide_setup_ports( hw_regs_t *hw,
  218. ide_ioreg_t base,
  219. int *offsets,
  220. ide_ioreg_t ctrl,
  221. ide_ioreg_t intr,
  222. ide_ack_intr_t *ack_intr,
  223. int irq);
  224. #include <asm/ide.h>
  225. /*
  226.  * If the arch-dependant ide.h did not declare/define any OUT_BYTE
  227.  * or IN_BYTE functions, we make some defaults here.
  228.  */
  229. #ifndef HAVE_ARCH_OUT_BYTE
  230. #ifdef REALLY_FAST_IO
  231. #define OUT_BYTE(b,p)          outb((b),(p))
  232. #else
  233. #define OUT_BYTE(b,p)          outb_p((b),(p))
  234. #endif
  235. #endif
  236. #ifndef HAVE_ARCH_IN_BYTE
  237. #ifdef REALLY_FAST_IO
  238. #define IN_BYTE(p)             (byte)inb_p(p)
  239. #else
  240. #define IN_BYTE(p)             (byte)inb(p)
  241. #endif
  242. #endif
  243. /*
  244.  * Now for the data we need to maintain per-drive:  ide_drive_t
  245.  */
  246. #define ide_scsi 0x21
  247. #define ide_disk 0x20
  248. #define ide_optical 0x7
  249. #define ide_cdrom 0x5
  250. #define ide_tape 0x1
  251. #define ide_floppy 0x0
  252. typedef union {
  253. unsigned all : 8; /* all of the bits together */
  254. struct {
  255. unsigned set_geometry : 1; /* respecify drive geometry */
  256. unsigned recalibrate : 1; /* seek to cyl 0      */
  257. unsigned set_multmode : 1; /* set multmode count */
  258. unsigned set_tune : 1; /* tune interface for drive */
  259. unsigned reserved : 4; /* unused */
  260. } b;
  261. } special_t;
  262. typedef struct ide_drive_s {
  263. request_queue_t  queue; /* request queue */
  264. struct ide_drive_s  *next; /* circular list of hwgroup drives */
  265. unsigned long sleep; /* sleep until this time */
  266. unsigned long service_start; /* time we started last request */
  267. unsigned long service_time; /* service time of last request */
  268. unsigned long timeout; /* max time to wait for irq */
  269. special_t special; /* special action flags */
  270. byte     keep_settings; /* restore settings after drive reset */
  271. byte     using_dma; /* disk is using dma for read/write */
  272. byte  retry_pio; /* retrying dma capable host in pio */
  273. byte  state; /* retry state */
  274. byte     waiting_for_dma; /* dma currently in progress */
  275. byte     unmask; /* flag: okay to unmask other irqs */
  276. byte     slow; /* flag: slow data port */
  277. byte     bswap; /* flag: byte swap data */
  278. byte     dsc_overlap; /* flag: DSC overlap */
  279. byte     nice1; /* flag: give potential excess bandwidth */
  280. unsigned present : 1; /* drive is physically present */
  281. unsigned noprobe  : 1; /* from:  hdx=noprobe */
  282. unsigned busy : 1; /* currently doing revalidate_disk() */
  283. unsigned removable : 1; /* 1 if need to do check_media_change */
  284. unsigned forced_geom : 1; /* 1 if hdx=c,h,s was given at boot */
  285. unsigned no_unmask : 1; /* disallow setting unmask bit */
  286. unsigned no_io_32bit : 1; /* disallow enabling 32bit I/O */
  287. unsigned nobios : 1; /* flag: do not probe bios for drive */
  288. unsigned revalidate : 1; /* request revalidation */
  289. unsigned atapi_overlap : 1; /* flag: ATAPI overlap (not supported) */
  290. unsigned nice0 : 1; /* flag: give obvious excess bandwidth */
  291. unsigned nice2 : 1; /* flag: give a share in our own bandwidth */
  292. unsigned doorlocking : 1; /* flag: for removable only: door lock/unlock works */
  293. unsigned autotune : 2; /* 1=autotune, 2=noautotune, 0=default */
  294. unsigned remap_0_to_1 : 2; /* 0=remap if ezdrive, 1=remap, 2=noremap */
  295. unsigned ata_flash : 1; /* 1=present, 0=default */
  296. byte scsi; /* 0=default, 1=skip current ide-subdriver for ide-scsi emulation */
  297. byte media; /* disk, cdrom, tape, floppy, ... */
  298. select_t select; /* basic drive/head select reg value */
  299. byte ctl; /* "normal" value for IDE_CONTROL_REG */
  300. byte ready_stat; /* min status value for drive ready */
  301. byte mult_count; /* current multiple sector setting */
  302. byte  mult_req; /* requested multiple sector setting */
  303. byte  tune_req; /* requested drive tuning setting */
  304. byte io_32bit; /* 0=16-bit, 1=32-bit, 2/3=32bit+sync */
  305. byte bad_wstat; /* used for ignoring WRERR_STAT */
  306. byte nowerr; /* used for ignoring WRERR_STAT */
  307. byte sect0; /* offset of first sector for DM6:DDO */
  308. byte  usage; /* current "open()" count for drive */
  309. byte  head; /* "real" number of heads */
  310. byte sect; /* "real" sectors per track */
  311. byte bios_head; /* BIOS/fdisk/LILO number of heads */
  312. byte bios_sect; /* BIOS/fdisk/LILO sectors per track */
  313. unsigned int bios_cyl; /* BIOS/fdisk/LILO number of cyls */
  314. unsigned int cyl; /* "real" number of cyls */
  315. unsigned long capacity; /* total number of sectors */
  316. unsigned int drive_data; /* for use by tuneproc/selectproc as needed */
  317. void   *hwif; /* actually (ide_hwif_t *) */
  318. wait_queue_head_t wqueue; /* used to wait for drive in open() */
  319. struct hd_driveid *id; /* drive model identification info */
  320. struct hd_struct  *part; /* drive partition table */
  321. char name[4]; /* drive name, such as "hda" */
  322. void  *driver; /* (ide_driver_t *) */
  323. void *driver_data; /* extra driver data */
  324. devfs_handle_t de; /* directory for device */
  325. struct proc_dir_entry *proc; /* /proc/ide/ directory entry */
  326. void *settings; /* /proc/ide/ drive settings */
  327. char driver_req[10]; /* requests specific driver */
  328. int last_lun; /* last logical unit */
  329. int forced_lun; /* if hdxlun was given at boot */
  330. int lun; /* logical unit */
  331. int crc_count; /* crc counter to reduce drive speed */
  332. byte quirk_list; /* drive is considered quirky if set for a specific host */
  333. byte suspend_reset; /* drive suspend mode flag, soft-reset recovers */
  334. byte init_speed; /* transfer rate set at boot */
  335. byte current_speed; /* current transfer rate set */
  336. byte dn; /* now wide spread use */
  337. unsigned int failures; /* current failure count */
  338. unsigned int max_failures; /* maximum allowed failure count */
  339. } ide_drive_t;
  340. /*
  341.  * An ide_dmaproc_t() initiates/aborts DMA read/write operations on a drive.
  342.  *
  343.  * The caller is assumed to have selected the drive and programmed the drive's
  344.  * sector address using CHS or LBA.  All that remains is to prepare for DMA
  345.  * and then issue the actual read/write DMA/PIO command to the drive.
  346.  *
  347.  * Returns 0 if all went well.
  348.  * Returns 1 if DMA read/write could not be started, in which case the caller
  349.  * should either try again later, or revert to PIO for the current request.
  350.  */
  351. typedef enum { ide_dma_read, ide_dma_write, ide_dma_begin,
  352. ide_dma_end, ide_dma_check, ide_dma_on,
  353. ide_dma_off, ide_dma_off_quietly, ide_dma_test_irq,
  354. ide_dma_bad_drive, ide_dma_good_drive,
  355. ide_dma_verbose, ide_dma_retune,
  356. ide_dma_lostirq, ide_dma_timeout
  357. } ide_dma_action_t;
  358. typedef int (ide_dmaproc_t)(ide_dma_action_t, ide_drive_t *);
  359. /*
  360.  * An ide_ideproc_t() performs CPU-polled transfers to/from a drive.
  361.  * Arguments are: the drive, the buffer pointer, and the length (in bytes or
  362.  * words depending on if it's an IDE or ATAPI call).
  363.  *
  364.  * If it is not defined for a controller, standard-code is used from ide.c.
  365.  *
  366.  * Controllers which are not memory-mapped in the standard way need to 
  367.  * override that mechanism using this function to work.
  368.  *
  369.  */
  370. typedef enum { ideproc_ide_input_data,    ideproc_ide_output_data,
  371.        ideproc_atapi_input_bytes, ideproc_atapi_output_bytes
  372. } ide_ide_action_t;
  373. typedef void (ide_ideproc_t)(ide_ide_action_t, ide_drive_t *, void *, unsigned int);
  374. /*
  375.  * An ide_tuneproc_t() is used to set the speed of an IDE interface
  376.  * to a particular PIO mode.  The "byte" parameter is used
  377.  * to select the PIO mode by number (0,1,2,3,4,5), and a value of 255
  378.  * indicates that the interface driver should "auto-tune" the PIO mode
  379.  * according to the drive capabilities in drive->id;
  380.  *
  381.  * Not all interface types support tuning, and not all of those
  382.  * support all possible PIO settings.  They may silently ignore
  383.  * or round values as they see fit.
  384.  */
  385. typedef void (ide_tuneproc_t) (ide_drive_t *, byte);
  386. typedef int (ide_speedproc_t) (ide_drive_t *, byte);
  387. /*
  388.  * This is used to provide support for strange interfaces
  389.  */
  390. typedef void (ide_selectproc_t) (ide_drive_t *);
  391. typedef void (ide_resetproc_t) (ide_drive_t *);
  392. typedef int (ide_quirkproc_t) (ide_drive_t *);
  393. typedef void (ide_intrproc_t) (ide_drive_t *);
  394. typedef void (ide_maskproc_t) (ide_drive_t *, int);
  395. typedef void (ide_rw_proc_t) (ide_drive_t *, ide_dma_action_t);
  396. /*
  397.  * ide soft-power support
  398.  */
  399. typedef int (ide_busproc_t) (struct hwif_s *, int);
  400. /*
  401.  * hwif_chipset_t is used to keep track of the specific hardware
  402.  * chipset used by each IDE interface, if known.
  403.  */
  404. typedef enum { ide_unknown, ide_generic, ide_pci,
  405. ide_cmd640, ide_dtc2278, ide_ali14xx,
  406. ide_qd65xx, ide_umc8672, ide_ht6560b,
  407. ide_pdc4030, ide_rz1000, ide_trm290,
  408. ide_cmd646, ide_cy82c693, ide_4drives,
  409. ide_pmac,       ide_etrax100, ide_acorn
  410. } hwif_chipset_t;
  411. #define IDE_CHIPSET_PCI_MASK
  412.     ((1<<ide_pci)|(1<<ide_cmd646)|(1<<ide_ali14xx))
  413. #define IDE_CHIPSET_IS_PCI(c) ((IDE_CHIPSET_PCI_MASK >> (c)) & 1)
  414. #ifdef CONFIG_BLK_DEV_IDEPCI
  415. typedef struct ide_pci_devid_s {
  416. unsigned short vid;
  417. unsigned short did;
  418. } ide_pci_devid_t;
  419. #define IDE_PCI_DEVID_NULL ((ide_pci_devid_t){0,0})
  420. #define IDE_PCI_DEVID_EQ(a,b) (a.vid == b.vid && a.did == b.did)
  421. #endif /* CONFIG_BLK_DEV_IDEPCI */
  422. typedef struct hwif_s {
  423. struct hwif_s *next; /* for linked-list in ide_hwgroup_t */
  424. void *hwgroup; /* actually (ide_hwgroup_t *) */
  425. ide_ioreg_t io_ports[IDE_NR_PORTS]; /* task file registers */
  426. hw_regs_t hw; /* Hardware info */
  427. ide_drive_t drives[MAX_DRIVES]; /* drive info */
  428. struct gendisk *gd; /* gendisk structure */
  429. ide_tuneproc_t *tuneproc; /* routine to tune PIO mode for drives */
  430. ide_speedproc_t *speedproc; /* routine to retune DMA modes for drives */
  431. ide_selectproc_t *selectproc; /* tweaks hardware to select drive */
  432. ide_resetproc_t *resetproc; /* routine to reset controller after a disk reset */
  433. ide_intrproc_t *intrproc; /* special interrupt handling for shared pci interrupts */
  434. ide_maskproc_t *maskproc; /* special host masking for drive selection */
  435. ide_quirkproc_t *quirkproc; /* check host's drive quirk list */
  436. ide_rw_proc_t *rwproc; /* adjust timing based upon rq->cmd direction */
  437. ide_ideproc_t   *ideproc;       /* CPU-polled transfer routine */
  438. ide_dmaproc_t *dmaproc; /* dma read/write/abort routine */
  439. unsigned int *dmatable_cpu; /* dma physical region descriptor table (cpu view) */
  440. dma_addr_t dmatable_dma; /* dma physical region descriptor table (dma view) */
  441. struct scatterlist *sg_table; /* Scatter-gather list used to build the above */
  442. int sg_nents; /* Current number of entries in it */
  443. int sg_dma_direction; /* dma transfer direction */
  444. int sg_dma_active; /* is it in use */
  445. struct hwif_s *mate; /* other hwif from same PCI chip */
  446. unsigned long dma_base; /* base addr for dma ports */
  447. unsigned dma_extra; /* extra addr for dma ports */
  448. unsigned long config_data; /* for use by chipset-specific code */
  449. unsigned long select_data; /* for use by chipset-specific code */
  450. struct proc_dir_entry *proc; /* /proc/ide/ directory entry */
  451. int irq; /* our irq number */
  452. byte major; /* our major number */
  453. char  name[6]; /* name of interface, eg. "ide0" */
  454. byte index; /* 0 for ide0; 1 for ide1; ... */
  455. hwif_chipset_t chipset; /* sub-module for tuning.. */
  456. unsigned noprobe    : 1; /* don't probe for this interface */
  457. unsigned present    : 1; /* this interface exists */
  458. unsigned serialized : 1; /* serialized operation with mate hwif */
  459. unsigned sharing_irq: 1; /* 1 = sharing irq with another hwif */
  460. unsigned reset      : 1; /* reset after probe */
  461. unsigned autodma    : 1; /* automatically try to enable DMA at boot */
  462. unsigned udma_four  : 1; /* 1=ATA-66 capable, 0=default */
  463. byte channel; /* for dual-port chips: 0=primary, 1=secondary */
  464. #ifdef CONFIG_BLK_DEV_IDEPCI
  465. struct pci_dev *pci_dev; /* for pci chipsets */
  466. ide_pci_devid_t pci_devid; /* for pci chipsets: {VID,DID} */
  467. #endif /* CONFIG_BLK_DEV_IDEPCI */
  468. #if (DISK_RECOVERY_TIME > 0)
  469. unsigned long last_time; /* time when previous rq was done */
  470. #endif
  471. byte straight8; /* Alan's straight 8 check */
  472. void *hwif_data; /* extra hwif data */
  473. ide_busproc_t *busproc; /* driver soft-power interface */
  474. byte bus_state; /* power state of the IDE bus */
  475. } ide_hwif_t;
  476. /*
  477.  * Status returned from various ide_ functions
  478.  */
  479. typedef enum {
  480. ide_stopped, /* no drive operation was started */
  481. ide_started /* a drive operation was started, and a handler was set */
  482. } ide_startstop_t;
  483. /*
  484.  *  internal ide interrupt handler type
  485.  */
  486. typedef ide_startstop_t (ide_handler_t)(ide_drive_t *);
  487. /*
  488.  * when ide_timer_expiry fires, invoke a handler of this type
  489.  * to decide what to do.
  490.  */
  491. typedef int (ide_expiry_t)(ide_drive_t *);
  492. typedef struct hwgroup_s {
  493. ide_handler_t *handler;/* irq handler, if active */
  494. volatile int busy; /* BOOL: protects all fields below */
  495. int sleeping; /* BOOL: wake us up on timer expiry */
  496. ide_drive_t *drive; /* current drive */
  497. ide_hwif_t *hwif; /* ptr to current hwif in linked-list */
  498. struct request *rq; /* current request */
  499. struct timer_list timer; /* failsafe timer */
  500. struct request wrq; /* local copy of current write rq */
  501. unsigned long poll_timeout; /* timeout value during long polls */
  502. ide_expiry_t *expiry; /* queried upon timeouts */
  503. } ide_hwgroup_t;
  504. /*
  505.  * configurable drive settings
  506.  */
  507. #define TYPE_INT 0
  508. #define TYPE_INTA 1
  509. #define TYPE_BYTE 2
  510. #define TYPE_SHORT 3
  511. #define SETTING_READ (1 << 0)
  512. #define SETTING_WRITE (1 << 1)
  513. #define SETTING_RW (SETTING_READ | SETTING_WRITE)
  514. typedef int (ide_procset_t)(ide_drive_t *, int);
  515. typedef struct ide_settings_s {
  516. char *name;
  517. int rw;
  518. int read_ioctl;
  519. int write_ioctl;
  520. int data_type;
  521. int min;
  522. int max;
  523. int mul_factor;
  524. int div_factor;
  525. void *data;
  526. ide_procset_t *set;
  527. int auto_remove;
  528. struct ide_settings_s *next;
  529. } ide_settings_t;
  530. void 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);
  531. void ide_remove_setting(ide_drive_t *drive, char *name);
  532. ide_settings_t *ide_find_setting_by_name(ide_drive_t *drive, char *name);
  533. int ide_read_setting(ide_drive_t *t, ide_settings_t *setting);
  534. int ide_write_setting(ide_drive_t *drive, ide_settings_t *setting, int val);
  535. void ide_add_generic_settings(ide_drive_t *drive);
  536. /*
  537.  * /proc/ide interface
  538.  */
  539. typedef struct {
  540. const char *name;
  541. mode_t mode;
  542. read_proc_t *read_proc;
  543. write_proc_t *write_proc;
  544. } ide_proc_entry_t;
  545. #ifdef CONFIG_PROC_FS
  546. void proc_ide_create(void);
  547. void proc_ide_destroy(void);
  548. void destroy_proc_ide_drives(ide_hwif_t *);
  549. void create_proc_ide_interfaces(void);
  550. void ide_add_proc_entries(struct proc_dir_entry *dir, ide_proc_entry_t *p, void *data);
  551. void ide_remove_proc_entries(struct proc_dir_entry *dir, ide_proc_entry_t *p);
  552. read_proc_t proc_ide_read_capacity;
  553. read_proc_t proc_ide_read_geometry;
  554. /*
  555.  * Standard exit stuff:
  556.  */
  557. #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) 
  558. {
  559. len -= off;
  560. if (len < count) {
  561. *eof = 1;
  562. if (len <= 0)
  563. return 0;
  564. } else
  565. len = count;
  566. *start = page + off;
  567. return len;
  568. }
  569. #else
  570. #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) return 0;
  571. #endif
  572. /*
  573.  * Subdrivers support.
  574.  */
  575. #define IDE_SUBDRIVER_VERSION 1
  576. typedef int (ide_cleanup_proc)(ide_drive_t *);
  577. typedef ide_startstop_t (ide_do_request_proc)(ide_drive_t *, struct request *, unsigned long);
  578. typedef void (ide_end_request_proc)(byte, ide_hwgroup_t *);
  579. typedef int (ide_ioctl_proc)(ide_drive_t *, struct inode *, struct file *, unsigned int, unsigned long);
  580. typedef int (ide_open_proc)(struct inode *, struct file *, ide_drive_t *);
  581. typedef void (ide_release_proc)(struct inode *, struct file *, ide_drive_t *);
  582. typedef int (ide_check_media_change_proc)(ide_drive_t *);
  583. typedef void (ide_revalidate_proc)(ide_drive_t *);
  584. typedef void (ide_pre_reset_proc)(ide_drive_t *);
  585. typedef unsigned long (ide_capacity_proc)(ide_drive_t *);
  586. typedef ide_startstop_t (ide_special_proc)(ide_drive_t *);
  587. typedef void (ide_setting_proc)(ide_drive_t *);
  588. typedef int (ide_driver_reinit_proc)(ide_drive_t *);
  589. typedef struct ide_driver_s {
  590. const char *name;
  591. const char *version;
  592. byte media;
  593. unsigned busy : 1;
  594. unsigned supports_dma : 1;
  595. unsigned supports_dsc_overlap : 1;
  596. ide_cleanup_proc *cleanup;
  597. ide_do_request_proc *do_request;
  598. ide_end_request_proc *end_request;
  599. ide_ioctl_proc *ioctl;
  600. ide_open_proc *open;
  601. ide_release_proc *release;
  602. ide_check_media_change_proc *media_change;
  603. ide_revalidate_proc *revalidate;
  604. ide_pre_reset_proc *pre_reset;
  605. ide_capacity_proc *capacity;
  606. ide_special_proc *special;
  607. ide_proc_entry_t *proc;
  608. ide_driver_reinit_proc *driver_reinit;
  609. } ide_driver_t;
  610. #define DRIVER(drive) ((ide_driver_t *)((drive)->driver))
  611. /*
  612.  * IDE modules.
  613.  */
  614. #define IDE_CHIPSET_MODULE 0 /* not supported yet */
  615. #define IDE_PROBE_MODULE 1
  616. #define IDE_DRIVER_MODULE 2
  617. typedef int (ide_module_init_proc)(void);
  618. typedef struct ide_module_s {
  619. int type;
  620. ide_module_init_proc *init;
  621. void *info;
  622. struct ide_module_s *next;
  623. } ide_module_t;
  624. /*
  625.  * ide_hwifs[] is the master data structure used to keep track
  626.  * of just about everything in ide.c.  Whenever possible, routines
  627.  * should be using pointers to a drive (ide_drive_t *) or
  628.  * pointers to a hwif (ide_hwif_t *), rather than indexing this
  629.  * structure directly (the allocation/layout may change!).
  630.  *
  631.  */
  632. #ifndef _IDE_C
  633. extern ide_hwif_t ide_hwifs[]; /* master data repository */
  634. extern ide_module_t *ide_modules;
  635. extern ide_module_t *ide_probe;
  636. #endif
  637. extern int noautodma;
  638. /*
  639.  * We need blk.h, but we replace its end_request by our own version.
  640.  */
  641. #define IDE_DRIVER /* Toggle some magic bits in blk.h */
  642. #define LOCAL_END_REQUEST /* Don't generate end_request in blk.h */
  643. #include <linux/blk.h>
  644. void ide_end_request(byte uptodate, ide_hwgroup_t *hwgroup);
  645. /*
  646.  * This is used for (nearly) all data transfers from/to the IDE interface
  647.  * FIXME for 2.5, to a pointer pass verses memcpy........
  648.  */
  649. void ide_input_data (ide_drive_t *drive, void *buffer, unsigned int wcount);
  650. void ide_output_data (ide_drive_t *drive, void *buffer, unsigned int wcount);
  651. /*
  652.  * This is used for (nearly) all ATAPI data transfers from/to the IDE interface
  653.  * FIXME for 2.5, to a pointer pass verses memcpy........
  654.  */
  655. void atapi_input_bytes (ide_drive_t *drive, void *buffer, unsigned int bytecount);
  656. void atapi_output_bytes (ide_drive_t *drive, void *buffer, unsigned int bytecount);
  657. /*
  658.  * This is used on exit from the driver, to designate the next irq handler
  659.  * and also to start the safety timer.
  660.  */
  661. void ide_set_handler (ide_drive_t *drive, ide_handler_t *handler, unsigned int timeout, ide_expiry_t *expiry);
  662. /*
  663.  * Error reporting, in human readable form (luxurious, but a memory hog).
  664.  */
  665. byte ide_dump_status (ide_drive_t *drive, const char *msg, byte stat);
  666. /*
  667.  * ide_error() takes action based on the error returned by the controller.
  668.  * The caller should return immediately after invoking this.
  669.  */
  670. ide_startstop_t ide_error (ide_drive_t *drive, const char *msg, byte stat);
  671. /*
  672.  * Issue a simple drive command
  673.  * The drive must be selected beforehand.
  674.  */
  675. void ide_cmd(ide_drive_t *drive, byte cmd, byte nsect, ide_handler_t *handler);
  676. /*
  677.  * ide_fixstring() cleans up and (optionally) byte-swaps a text string,
  678.  * removing leading/trailing blanks and compressing internal blanks.
  679.  * It is primarily used to tidy up the model name/number fields as
  680.  * returned by the WIN_[P]IDENTIFY commands.
  681.  */
  682. void ide_fixstring (byte *s, const int bytecount, const int byteswap);
  683. /*
  684.  * This routine busy-waits for the drive status to be not "busy".
  685.  * It then checks the status for all of the "good" bits and none
  686.  * of the "bad" bits, and if all is okay it returns 0.  All other
  687.  * cases return 1 after doing "*startstop = ide_error()", and the
  688.  * caller should return the updated value of "startstop" in this case.
  689.  * "startstop" is unchanged when the function returns 0;
  690.  */
  691. int ide_wait_stat (ide_startstop_t *startstop, ide_drive_t *drive, byte good, byte bad, unsigned long timeout);
  692. int ide_wait_noerr (ide_drive_t *drive, byte good, byte bad, unsigned long timeout);
  693. /*
  694.  * This routine is called from the partition-table code in genhd.c
  695.  * to "convert" a drive to a logical geometry with fewer than 1024 cyls.
  696.  */
  697. int ide_xlate_1024 (kdev_t, int, int, const char *);
  698. /*
  699.  * Convert kdev_t structure into ide_drive_t * one.
  700.  */
  701. ide_drive_t *get_info_ptr (kdev_t i_rdev);
  702. /*
  703.  * Return the current idea about the total capacity of this drive.
  704.  */
  705. unsigned long current_capacity (ide_drive_t *drive);
  706. /*
  707.  * Start a reset operation for an IDE interface.
  708.  * The caller should return immediately after invoking this.
  709.  */
  710. ide_startstop_t ide_do_reset (ide_drive_t *);
  711. /*
  712.  * Re-Start an operation for an IDE interface.
  713.  * The caller should return immediately after invoking this.
  714.  */
  715. ide_startstop_t restart_request (ide_drive_t *);
  716. /*
  717.  * This function is intended to be used prior to invoking ide_do_drive_cmd().
  718.  */
  719. void ide_init_drive_cmd (struct request *rq);
  720. /*
  721.  * "action" parameter type for ide_do_drive_cmd() below.
  722.  */
  723. typedef enum {
  724. ide_wait, /* insert rq at end of list, and wait for it */
  725. ide_next, /* insert rq immediately after current request */
  726. ide_preempt, /* insert rq in front of current request */
  727. ide_end /* insert rq at end of list, but don't wait for it */
  728. } ide_action_t;
  729. /*
  730.  * This function issues a special IDE device request
  731.  * onto the request queue.
  732.  *
  733.  * If action is ide_wait, then the rq is queued at the end of the
  734.  * request queue, and the function sleeps until it has been processed.
  735.  * This is for use when invoked from an ioctl handler.
  736.  *
  737.  * If action is ide_preempt, then the rq is queued at the head of
  738.  * the request queue, displacing the currently-being-processed
  739.  * request and this function returns immediately without waiting
  740.  * for the new rq to be completed.  This is VERY DANGEROUS, and is
  741.  * intended for careful use by the ATAPI tape/cdrom driver code.
  742.  *
  743.  * If action is ide_next, then the rq is queued immediately after
  744.  * the currently-being-processed-request (if any), and the function
  745.  * returns without waiting for the new rq to be completed.  As above,
  746.  * This is VERY DANGEROUS, and is intended for careful use by the
  747.  * ATAPI tape/cdrom driver code.
  748.  *
  749.  * If action is ide_end, then the rq is queued at the end of the
  750.  * request queue, and the function returns immediately without waiting
  751.  * for the new rq to be completed. This is again intended for careful
  752.  * use by the ATAPI tape/cdrom driver code.
  753.  */
  754. int ide_do_drive_cmd (ide_drive_t *drive, struct request *rq, ide_action_t action);
  755. /*
  756.  * Clean up after success/failure of an explicit drive cmd.
  757.  * stat/err are used only when (HWGROUP(drive)->rq->cmd == IDE_DRIVE_CMD).
  758.  */
  759. void ide_end_drive_cmd (ide_drive_t *drive, byte stat, byte err);
  760. /*
  761.  * Issue ATA command and wait for completion.
  762.  */
  763. int ide_wait_cmd (ide_drive_t *drive, int cmd, int nsect, int feature, int sectors, byte *buf);
  764. int ide_wait_cmd_task (ide_drive_t *drive, byte *buf);
  765. void ide_delay_50ms (void);
  766. int system_bus_clock(void);
  767. byte ide_auto_reduce_xfer (ide_drive_t *drive);
  768. int ide_driveid_update (ide_drive_t *drive);
  769. int ide_ata66_check (ide_drive_t *drive, byte cmd, byte nsect, byte feature);
  770. int ide_config_drive_speed (ide_drive_t *drive, byte speed);
  771. byte eighty_ninty_three (ide_drive_t *drive);
  772. int set_transfer (ide_drive_t *drive, byte cmd, byte nsect, byte feature);
  773. /*
  774.  * ide_system_bus_speed() returns what we think is the system VESA/PCI
  775.  * bus speed (in MHz).  This is used for calculating interface PIO timings.
  776.  * The default is 40 for known PCI systems, 50 otherwise.
  777.  * The "idebus=xx" parameter can be used to override this value.
  778.  */
  779. int ide_system_bus_speed (void);
  780. /*
  781.  * ide_multwrite() transfers a block of up to mcount sectors of data
  782.  * to a drive as part of a disk multwrite operation.
  783.  */
  784. int ide_multwrite (ide_drive_t *drive, unsigned int mcount);
  785. /*
  786.  * ide_stall_queue() can be used by a drive to give excess bandwidth back
  787.  * to the hwgroup by sleeping for timeout jiffies.
  788.  */
  789. void ide_stall_queue (ide_drive_t *drive, unsigned long timeout);
  790. /*
  791.  * ide_get_queue() returns the queue which corresponds to a given device.
  792.  */
  793. request_queue_t *ide_get_queue (kdev_t dev);
  794. /*
  795.  * CompactFlash cards and their brethern pretend to be removable hard disks,
  796.  * but they never have a slave unit, and they don't have doorlock mechanisms.
  797.  * This test catches them, and is invoked elsewhere when setting appropriate config bits.
  798.  */
  799. int drive_is_flashcard (ide_drive_t *drive);
  800. int ide_spin_wait_hwgroup (ide_drive_t *drive);
  801. void ide_timer_expiry (unsigned long data);
  802. void ide_intr (int irq, void *dev_id, struct pt_regs *regs);
  803. void do_ide_request (request_queue_t * q);
  804. void ide_init_subdrivers (void);
  805. #ifndef _IDE_C
  806. extern struct block_device_operations ide_fops[];
  807. extern ide_proc_entry_t generic_subdriver_entries[];
  808. #endif
  809. #ifdef _IDE_C
  810. #ifdef CONFIG_BLK_DEV_IDE
  811. int ideprobe_init (void);
  812. #endif /* CONFIG_BLK_DEV_IDE */
  813. #ifdef CONFIG_BLK_DEV_IDEDISK
  814. int idedisk_init (void);
  815. #endif /* CONFIG_BLK_DEV_IDEDISK */
  816. #ifdef CONFIG_BLK_DEV_IDECD
  817. int ide_cdrom_init (void);
  818. #endif /* CONFIG_BLK_DEV_IDECD */
  819. #ifdef CONFIG_BLK_DEV_IDETAPE
  820. int idetape_init (void);
  821. #endif /* CONFIG_BLK_DEV_IDETAPE */
  822. #ifdef CONFIG_BLK_DEV_IDEFLOPPY
  823. int idefloppy_init (void);
  824. #endif /* CONFIG_BLK_DEV_IDEFLOPPY */
  825. #ifdef CONFIG_BLK_DEV_IDESCSI
  826. int idescsi_init (void);
  827. #endif /* CONFIG_BLK_DEV_IDESCSI */
  828. #endif /* _IDE_C */
  829. int ide_register_module (ide_module_t *module);
  830. void ide_unregister_module (ide_module_t *module);
  831. ide_drive_t *ide_scan_devices (byte media, const char *name, ide_driver_t *driver, int n);
  832. int ide_register_subdriver (ide_drive_t *drive, ide_driver_t *driver, int version);
  833. int ide_unregister_subdriver (ide_drive_t *drive);
  834. int ide_replace_subdriver(ide_drive_t *drive, const char *driver);
  835. #ifdef CONFIG_BLK_DEV_IDEPCI
  836. #define ON_BOARD 1
  837. #define NEVER_BOARD 0
  838. #ifdef CONFIG_BLK_DEV_OFFBOARD
  839. #  define OFF_BOARD ON_BOARD
  840. #else /* CONFIG_BLK_DEV_OFFBOARD */
  841. #  define OFF_BOARD NEVER_BOARD
  842. #endif /* CONFIG_BLK_DEV_OFFBOARD */
  843. unsigned long ide_find_free_region (unsigned short size) __init;
  844. void ide_scan_pcibus (int scan_direction) __init;
  845. #endif
  846. #ifdef CONFIG_BLK_DEV_IDEDMA
  847. #define BAD_DMA_DRIVE 0
  848. #define GOOD_DMA_DRIVE 1
  849. int ide_build_dmatable (ide_drive_t *drive, ide_dma_action_t func);
  850. void ide_destroy_dmatable (ide_drive_t *drive);
  851. ide_startstop_t ide_dma_intr (ide_drive_t *drive);
  852. int check_drive_lists (ide_drive_t *drive, int good_bad);
  853. int report_drive_dmaing (ide_drive_t *drive);
  854. int ide_dmaproc (ide_dma_action_t func, ide_drive_t *drive);
  855. int ide_release_dma (ide_hwif_t *hwif);
  856. void ide_setup_dma (ide_hwif_t *hwif, unsigned long dmabase, unsigned int num_ports) __init;
  857. unsigned long ide_get_or_set_dma_base (ide_hwif_t *hwif, int extra, const char *name) __init;
  858. #endif
  859. void hwif_unregister (ide_hwif_t *hwif);
  860. #endif /* _IDE_H */