![[bottom]](../icons/bottom.png){kind=icon}
![[previous]](../icons/n_left.png){kind=icon}
![[next]](../icons/n_right.png){kind=icon}
![[first]](../icons/n_first.png){kind=icon}
![[last]](../icons/n_last.png){kind=icon}
![[top]](../icons/n_top.png){kind=icon}
![[index]](../icons/index.png){kind=icon}
![[help]](../icons/help.png){kind=icon}
*/
1 /*
2 * linux/drivers/block/ide.h
3 *
4 * Copyright (C) 1994, 1995 Linus Torvalds & authors
5 */
6
7 /*
8 * This is the multiple IDE interface driver, as evolved from hd.c.
9 * It supports up to four IDE interfaces, on one or more IRQs (usually 14 & 15).
10 * There can be up to two drives per interface, as per the ATA-2 spec.
11 *
12 * Primary i/f: ide0: major=3; (hda) minor=0; (hdb) minor=64
13 * Secondary i/f: ide1: major=22; (hdc or hd1a) minor=0; (hdd or hd1b) minor=64
14 * Tertiary i/f: ide2: major=33; (hde) minor=0; (hdf) minor=64
15 * Quaternary i/f: ide3: major=34; (hdg) minor=0; (hdh) minor=64
16 */
17
18 /******************************************************************************
19 * IDE driver configuration options (play with these as desired):
20 *
21 * REALLY_SLOW_IO can be defined in ide.c and ide-cd.c, if necessary
22 */
23 #define REALLY_FAST_IO /* define if ide ports are perfect */
24 #define INITIAL_MULT_COUNT 0 /* off=0; on=2,4,8,16,32, etc.. */
25
26 #ifndef DISK_RECOVERY_TIME /* off=0; on=access_delay_time */
27 #define DISK_RECOVERY_TIME 0 /* for hardware that needs it */
28 #endif
29 #ifndef OK_TO_RESET_CONTROLLER /* 1 needed for good error recovery */
30 #define OK_TO_RESET_CONTROLLER 1 /* 0 for use with AH2372A/B interface */
31 #endif
32 #ifndef SUPPORT_RZ1000 /* 1 to support RZ1000 chipset */
33 #define SUPPORT_RZ1000 1 /* 0 to reduce kernel size */
34 #endif
35 #ifndef SUPPORT_CMD640 /* 1 to support CMD640 chipset */
36 #define SUPPORT_CMD640 1 /* 0 to reduce kernel size */
37 #endif
38 #ifndef SUPPORT_HT6560B /* 1 to support HT6560B chipset */
39 #define SUPPORT_HT6560B 1 /* 0 to reduce kernel size */
40 #endif
41 #ifndef SUPPORT_DTC2278 /* 1 to support DTC2278 chipset */
42 #define SUPPORT_DTC2278 1 /* 0 to reduce kernel size */
43 #ifndef SET_DTC2278_MODE4
44 #define SET_DTC2278_MODE4 0 /* 1 to init primary i/f for PIO mode4 */
45 #endif
46 #endif
47 #ifndef FANCY_STATUS_DUMPS /* 1 for human-readable drive errors */
48 #define FANCY_STATUS_DUMPS 1 /* 0 to reduce kernel size */
49 #endif
50
51 /*
52 * IDE_DRIVE_CMD is used to implement many features of the hdparm utility
53 */
54 #define IDE_DRIVE_CMD 99 /* (magic) undef to reduce kernel size*/
55
56 /*
57 * "No user-serviceable parts" beyond this point :)
58 *****************************************************************************/
59
60 typedef unsigned char byte; /* used everywhere */
61
62 /*
63 * Probably not wise to fiddle with these
64 */
65 #define ERROR_MAX 8 /* Max read/write errors per sector */
66 #define ERROR_RESET 3 /* Reset controller every 4th retry */
67 #define ERROR_RECAL 1 /* Recalibrate every 2nd retry */
68
69 /*
70 * Ensure that various configuration flags have compatible settings
71 */
72 #ifdef REALLY_SLOW_IO
73 #undef REALLY_FAST_IO
74 #endif
75
76 /*
77 * Definitions for accessing IDE controller registers
78 */
79
80 #define HWIF(drive) ((ide_hwif_t *)drive->hwif)
81 #define HWGROUP(drive) ((ide_hwgroup_t *)(HWIF(drive)->hwgroup))
82
83 #define IDE_DATA_OFFSET (0)
84 #define IDE_ERROR_OFFSET (1)
85 #define IDE_NSECTOR_OFFSET (2)
86 #define IDE_SECTOR_OFFSET (3)
87 #define IDE_LCYL_OFFSET (4)
88 #define IDE_HCYL_OFFSET (5)
89 #define IDE_SELECT_OFFSET (6)
90 #define IDE_STATUS_OFFSET (7)
91 #define IDE_FEATURE_OFFSET IDE_ERROR_OFFSET
92 #define IDE_COMMAND_OFFSET IDE_STATUS_OFFSET
93
94 #define IDE_DATA_REG (HWIF(drive)->io_base+IDE_DATA_OFFSET)
95 #define IDE_ERROR_REG (HWIF(drive)->io_base+IDE_ERROR_OFFSET)
96 #define IDE_NSECTOR_REG (HWIF(drive)->io_base+IDE_NSECTOR_OFFSET)
97 #define IDE_SECTOR_REG (HWIF(drive)->io_base+IDE_SECTOR_OFFSET)
98 #define IDE_LCYL_REG (HWIF(drive)->io_base+IDE_LCYL_OFFSET)
99 #define IDE_HCYL_REG (HWIF(drive)->io_base+IDE_HCYL_OFFSET)
100 #define IDE_SELECT_REG (HWIF(drive)->io_base+IDE_SELECT_OFFSET)
101 #define IDE_STATUS_REG (HWIF(drive)->io_base+IDE_STATUS_OFFSET)
102 #define IDE_CONTROL_REG (HWIF(drive)->ctl_port)
103 #define IDE_FEATURE_REG IDE_ERROR_REG
104 #define IDE_COMMAND_REG IDE_STATUS_REG
105 #define IDE_ALTSTATUS_REG IDE_CONTROL_REG
106
107 #ifdef REALLY_FAST_IO
108 #define OUT_BYTE(b,p) outb((b),p)
109 #define IN_BYTE(p) (byte)inb(p)
110 #else
111 #define OUT_BYTE(b,p) outb_p((b),p)
112 #define IN_BYTE(p) (byte)inb_p(p)
113 #endif /* REALLY_FAST_IO */
114
115 #define GET_ERR() IN_BYTE(IDE_ERROR_REG)
116 #define GET_STAT() IN_BYTE(IDE_STATUS_REG)
117 #define OK_STAT(stat,good,bad) (((stat)&((good)|(bad)))==(good))
118 #define BAD_R_STAT (BUSY_STAT | ERR_STAT)
119 #define BAD_W_STAT (BAD_R_STAT | WRERR_STAT)
120 #define BAD_STAT (BAD_R_STAT | DRQ_STAT)
121 #define DRIVE_READY (READY_STAT | SEEK_STAT)
122 #define DATA_READY (DRIVE_READY | DRQ_STAT)
123
124 /*
125 * Some more useful definitions
126 */
127 #define IDE_MAJOR_NAME "ide" /* the same for all i/f; see also genhd.c */
128 #define MAJOR_NAME IDE_MAJOR_NAME
129 #define PARTN_BITS 6 /* number of minor dev bits for partitions */
130 #define PARTN_MASK ((1<<PARTN_BITS)-1) /* a useful bit mask */
131 #define MAX_DRIVES 2 /* per interface; 2 assumed by lots of code */
132 #define MAX_HWIFS 4 /* an arbitrary, but realistic limit */
133 #define SECTOR_WORDS (512 / 4) /* number of 32bit words per sector */
134
135 /*
136 * Timeouts for various operations:
137 */
138 #define WAIT_DRQ (5*HZ/100) /* 50msec - spec allows up to 20ms */
139 #define WAIT_READY (3*HZ/100) /* 30msec - should be instantaneous */
140 #define WAIT_PIDENTIFY (1*HZ) /* 1sec - should be less than 3ms (?) */
141 #define WAIT_WORSTCASE (30*HZ) /* 30sec - worst case when spinning up */
142 #define WAIT_CMD (10*HZ) /* 10sec - maximum wait for an IRQ to happen */
143
144 #ifdef CONFIG_BLK_DEV_IDECD
145
146 struct atapi_request_sense {
147 unsigned char error_code : 7;
148 unsigned char valid : 1;
149 byte reserved1;
150 unsigned char sense_key : 4;
151 unsigned char reserved2 : 1;
152 unsigned char ili : 1;
153 unsigned char reserved3 : 2;
154 byte info[4];
155 byte sense_len;
156 byte command_info[4];
157 byte asc;
158 byte ascq;
159 byte fru;
160 byte sense_key_specific[3];
161 };
162
163 struct packet_command {
164 char *buffer;
165 int buflen;
166 int stat;
167 struct atapi_request_sense *sense_data;
168 unsigned char c[12];
169 };
170
171 /* Space to hold the disk TOC. */
172
173 #define MAX_TRACKS 99
174 struct atapi_toc_header {
175 unsigned short toc_length;
176 byte first_track;
177 byte last_track;
178 };
179
180 struct atapi_toc_entry {
181 byte reserved1;
182 unsigned control : 4;
183 unsigned adr : 4;
184 byte track;
185 byte reserved2;
186 unsigned lba;
187 };
188
189 struct atapi_toc {
190 int last_session_lba;
191 int xa_flag;
192 unsigned capacity;
193 struct atapi_toc_header hdr;
194 struct atapi_toc_entry ent[MAX_TRACKS+1]; /* One extra for the leadout. */
195 };
196
197 /* Extra per-device info for cdrom drives. */
198 struct cdrom_info {
199
200 /* Buffer for table of contents. NULL if we haven't allocated
201 a TOC buffer for this device yet. */
202
203 struct atapi_toc *toc;
204
205 /* Sector buffer. If a read request wants only the first part of a cdrom
206 block, we cache the rest of the block here, in the expectation that that
207 data is going to be wanted soon. SECTOR_BUFFERED is the number of the
208 first buffered sector, and NSECTORS_BUFFERED is the number of sectors
209 in the buffer. Before the buffer is allocated, we should have
210 SECTOR_BUFFER == NULL and NSECTORS_BUFFERED == 0. */
211
212 unsigned long sector_buffered;
213 unsigned long nsectors_buffered;
214 char *sector_buffer;
215
216 /* The result of the last successful request sense command
217 on this device. */
218 struct atapi_request_sense sense_data;
219 };
220
221 #endif /* CONFIG_BLK_DEV_IDECD */
222
223 /*
224 * Now for the data we need to maintain per-drive: ide_drive_t
225 */
226 typedef enum {disk, cdrom} media_t;
227
228 typedef union {
229 unsigned all : 8; /* all of the bits together */
230 struct {
231 unsigned set_geometry : 1; /* respecify drive geometry */
232 unsigned recalibrate : 1; /* seek to cyl 0 */
233 unsigned set_multmode : 1; /* set multmode count */
234 unsigned reserved : 5; /* unused */
235 } b;
236 } special_t;
237
238 typedef union {
239 unsigned all : 8; /* all of the bits together */
240 struct {
241 unsigned head : 4; /* always zeros here */
242 unsigned unit : 1; /* drive select number, 0 or 1 */
243 unsigned bit5 : 1; /* always 1 */
244 unsigned lba : 1; /* using LBA instead of CHS */
245 unsigned bit7 : 1; /* always 1 */
246 } b;
247 } select_t;
248
249 typedef struct ide_drive_s {
250 special_t special; /* special action flags */
251 unsigned present : 1; /* drive is physically present */
252 unsigned noprobe : 1; /* from: hdx=noprobe */
253 unsigned keep_settings : 1; /* restore settings after drive reset */
254 unsigned busy : 1; /* currently doing revalidate_disk() */
255 unsigned vlb_32bit : 1; /* use 32bit in/out for data */
256 unsigned vlb_sync : 1; /* needed for some 32bit chip sets */
257 unsigned removeable : 1; /* 1 if need to do check_media_change */
258 unsigned using_dma : 1; /* disk is using dma for read/write */
259 unsigned unmask : 1; /* flag: okay to unmask other irqs */
260 media_t media; /* disk, cdrom, tape */
261 select_t select; /* basic drive/head select reg value */
262 void *hwif; /* actually (ide_hwif_t *) */
263 byte ctl; /* "normal" value for IDE_CONTROL_REG */
264 byte ready_stat; /* min status value for drive ready */
265 byte mult_count; /* current multiple sector setting */
266 byte mult_req; /* requested multiple sector setting */
267 byte chipset; /* interface chipset access method */
268 byte bad_wstat; /* used for ignoring WRERR_STAT */
269 byte sect0; /* offset of first sector for DM6:DDO */
270 byte usage; /* current "open()" count for drive */
271 byte head; /* "real" number of heads */
272 byte sect; /* "real" sectors per track */
273 byte bios_head; /* BIOS/fdisk/LILO number of heads */
274 byte bios_sect; /* BIOS/fdisk/LILO sectors per track */
275 unsigned short bios_cyl; /* BIOS/fdisk/LILO number of cyls */
276 unsigned short cyl; /* "real" number of cyls */
277 struct wait_queue *wqueue; /* used to wait for drive in open() */
278 struct hd_driveid *id; /* drive model identification info */
279 struct hd_struct *part; /* drive partition table */
280 char name[4]; /* drive name, such as "hda" */
281 #ifdef CONFIG_BLK_DEV_IDECD
282 struct cdrom_info cdrom_info; /* from ide-cd.c */
283 #endif /* CONFIG_BLK_DEV_IDECD */
284 } ide_drive_t;
285
286 /*
287 * An ide_dmaproc_t() initiates/aborts DMA read/write operations on a drive.
288 *
289 * The caller is assumed to have selected the drive and programmed the drive's
290 * sector address using CHS or LBA. All that remains is to prepare for DMA
291 * and then issue the actual read/write DMA/PIO command to the drive.
292 *
293 * Returns 0 if all went well.
294 * Returns 1 if DMA read/write could not be started, in which case the caller
295 * should either try again later, or revert to PIO for the current request.
296 */
297 typedef enum {ide_dma_read = 0, ide_dma_write = 1, ide_dma_abort = 2, ide_dma_check = 3} ide_dma_action_t;
298 typedef int (ide_dmaproc_t)(ide_dma_action_t, ide_drive_t *);
299
300 typedef struct hwif_s {
301 struct hwif_s *next; /* for linked-list in ide_hwgroup_t */
302 void *hwgroup; /* actually (ide_hwgroup_t *) */
303 unsigned short io_base; /* base io port addr */
304 unsigned short ctl_port; /* usually io_base+0x206 */
305 ide_drive_t drives[MAX_DRIVES]; /* drive info */
306 struct gendisk *gd; /* gendisk structure */
307 ide_dmaproc_t *dmaproc; /* dma read/write/abort routine */
308 unsigned long *dmatable; /* dma physical region descriptor table */
309 unsigned short dma_base; /* base addr for dma ports (triton) */
310 byte irq; /* our irq number */
311 byte major; /* our major number */
312 byte select; /* pri/sec hwif select for ht6560b */
313 char name[5]; /* name of interface, eg. "ide0" */
314 unsigned noprobe : 1; /* don't probe for this interface */
315 unsigned present : 1; /* this interface exists */
316 #if (DISK_RECOVERY_TIME > 0)
317 unsigned long last_time; /* time when previous rq was done */
318 #endif
319 #ifdef CONFIG_BLK_DEV_IDECD
320 struct request request_sense_request; /* from ide-cd.c */
321 struct packet_command request_sense_pc; /* from ide-cd.c */
322 #endif /* CONFIG_BLK_DEV_IDECD */
323 } ide_hwif_t;
324
325 /*
326 * internal ide interrupt handler type
327 */
328 typedef void (ide_handler_t)(ide_drive_t *);
329
330 typedef struct hwgroup_s {
331 ide_handler_t *handler;/* irq handler, if active */
332 ide_drive_t *drive; /* current drive */
333 ide_hwif_t *hwif; /* ptr to current hwif in linked-list */
334 struct request *rq; /* current request */
335 struct timer_list timer; /* failsafe timer */
336 struct request wrq; /* local copy of current write rq */
337 unsigned long reset_timeout; /* timeout value during ide resets */
338 #ifdef CONFIG_BLK_DEV_IDECD
339 int doing_atapi_reset;
340 #endif /* CONFIG_BLK_DEV_IDECD */
341 } ide_hwgroup_t;
342
343 /*
344 * One final include file, which references some of the data/defns from above
345 */
346 #define IDE_DRIVER /* "parameter" for blk.h */
347 #include "blk.h"
348
349 #if (DISK_RECOVERY_TIME > 0)
350 void ide_set_recovery_timer (ide_hwif_t *);
351 #define SET_RECOVERY_TIMER(drive) ide_set_recovery_timer (drive)
352 #else
353 #define SET_RECOVERY_TIMER(drive)
354 #endif
355
356 /*
357 * The main (re-)entry point for handling a new request is IDE_DO_REQUEST.
358 * Note that IDE_DO_REQUEST should *only* ever be invoked from an interrupt
359 * handler. All others, such as a timer expiry handler, should call
360 * do_hwgroup_request() instead (currently local to ide.c).
361 */
362 void ide_do_request (ide_hwgroup_t *);
363 #define IDE_DO_REQUEST { SET_RECOVERY_TIMER(HWIF(drive)); ide_do_request(HWGROUP(drive)); }
364
365
366 /*
367 * This is used for (nearly) all data transfers from the IDE interface
368 */
369 void ide_input_data (ide_drive_t *drive, void *buffer, unsigned int wcount);
370
371 /*
372 * This is used for (nearly) all data transfers to the IDE interface
373 */
374 void ide_output_data (ide_drive_t *drive, void *buffer, unsigned int wcount);
375
376 /*
377 * This is used on exit from the driver, to designate the next irq handler
378 * and also to start the safety timer.
379 */
380 void ide_set_handler (ide_drive_t *drive, ide_handler_t *handler);
381
382 /*
383 * Error reporting, in human readable form (luxurious, but a memory hog).
384 */
385 byte ide_dump_status (ide_drive_t *drive, const char *msg, byte stat);
386
387 /*
388 * ide_error() takes action based on the error returned by the controller.
389 *
390 * Returns 1 if an ide reset operation has been initiated, in which case
391 * the caller MUST simply return from the driver (through however many levels).
392 * Returns 0 otherwise.
393 */
394 int ide_error (ide_drive_t *drive, const char *msg, byte stat);
395
396 /*
397 * This routine busy-waits for the drive status to be not "busy".
398 * It then checks the status for all of the "good" bits and none
399 * of the "bad" bits, and if all is okay it returns 0. All other
400 * cases return 1 after invoking ide_error()
401 *
402 */
403 int ide_wait_stat (ide_drive_t *drive, byte good, byte bad, unsigned long timeout);
404
405 /*
406 * This is called from genhd.c to correct DiskManager/EZ-Drive geometries
407 */
408 int ide_xlate_1024(dev_t, int, const char *);
409
410 /*
411 * Start a reset operation for an IDE interface.
412 * Returns 0 if the reset operation is still in progress,
413 * in which case the drive MUST return, to await completion.
414 * Returns 1 if the reset is complete (success or failure).
415 */
416 int ide_do_reset (ide_drive_t *);
417
418 /*
419 * ide_alloc(): memory allocation for use *only* during driver initialization.
420 * If "within_area" is non-zero, the memory will be allocated such that
421 * it lies entirely within a "within_area" sized area (eg. 4096). This is
422 * needed for DMA stuff. "within_area" must be a power of two (not validated).
423 * All allocations are longword aligned.
424 */
425 void *ide_alloc (unsigned long bytecount, unsigned long within_area);
426
427 /*
428 * This function issues a specific IDE drive command onto the
429 * tail of the request queue, and waits for it to be completed.
430 * If arg is NULL, it goes through all the motions,
431 * but without actually sending a command to the drive.
432 *
433 * The value of arg is passed to the internal handler as rq->buffer.
434 */
435 int ide_do_drive_cmd(int rdev, char *args);
436
437
438 #ifdef CONFIG_BLK_DEV_IDECD
439 /*
440 * These are routines in ide-cd.c invoked from ide.c
441 */
442 void ide_do_rw_cdrom (ide_drive_t *, unsigned long);
443 int ide_cdrom_ioctl (ide_drive_t *, struct inode *, struct file *, unsigned int, unsigned long);
444 int ide_cdrom_check_media_change (ide_drive_t *);
445 int ide_cdrom_open (struct inode *, struct file *, ide_drive_t *);
446 void ide_cdrom_release (struct inode *, struct file *, ide_drive_t *);
447 void ide_cdrom_setup (ide_drive_t *);
448 #endif /* CONFIG_BLK_DEV_IDECD */
449
450 #ifdef CONFIG_BLK_DEV_TRITON
451 void ide_init_triton (byte, byte);
452 #endif /* CONFIG_BLK_DEV_TRITON */
453
![[top]](../icons/top.png){kind=icon}
![[bottom]](../icons/n_bottom.png){kind=icon}
*/