ide: remove redundant comments from ide.h
[deliverable/linux.git] / include / linux / ide.h
CommitLineData
1da177e4
LT
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
1da177e4
LT
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>
f36d4024 20#include <linux/completion.h>
e3a59b4d
HR
21#ifdef CONFIG_BLK_DEV_IDEACPI
22#include <acpi/acpi.h>
23#endif
1da177e4
LT
24#include <asm/byteorder.h>
25#include <asm/system.h>
26#include <asm/io.h>
27#include <asm/semaphore.h>
f9383c42 28#include <asm/mutex.h>
1da177e4 29
1da177e4
LT
30/******************************************************************************
31 * IDE driver configuration options (play with these as desired):
32 *
33 * REALLY_SLOW_IO can be defined in ide.c and ide-cd.c, if necessary
34 */
35#define INITIAL_MULT_COUNT 0 /* off=0; on=2,4,8,16,32, etc.. */
36
37#ifndef SUPPORT_SLOW_DATA_PORTS /* 1 to support slow data ports */
38#define SUPPORT_SLOW_DATA_PORTS 1 /* 0 to reduce kernel size */
39#endif
40#ifndef SUPPORT_VLB_SYNC /* 1 to support weird 32-bit chips */
41#define SUPPORT_VLB_SYNC 1 /* 0 to reduce kernel size */
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
47#ifndef DISABLE_IRQ_NOSYNC
48#define DISABLE_IRQ_NOSYNC 0
49#endif
50
51/*
52 * Used to indicate "no IRQ", should be a value that cannot be an IRQ
53 * number.
54 */
55
56#define IDE_NO_IRQ (-1)
57
58/*
59 * "No user-serviceable parts" beyond this point :)
60 *****************************************************************************/
61
62typedef unsigned char byte; /* used everywhere */
63
64/*
65 * Probably not wise to fiddle with these
66 */
67#define ERROR_MAX 8 /* Max read/write errors per sector */
68#define ERROR_RESET 3 /* Reset controller every 4th retry */
69#define ERROR_RECAL 1 /* Recalibrate every 2nd retry */
70
71/*
72 * Tune flags
73 */
74#define IDE_TUNE_NOAUTO 2
75#define IDE_TUNE_AUTO 1
76#define IDE_TUNE_DEFAULT 0
77
78/*
79 * state flags
80 */
81
82#define DMA_PIO_RETRY 1 /* retrying in PIO */
83
84#define HWIF(drive) ((ide_hwif_t *)((drive)->hwif))
85#define HWGROUP(drive) ((ide_hwgroup_t *)(HWIF(drive)->hwgroup))
86
87/*
88 * Definitions for accessing IDE controller registers
89 */
90#define IDE_NR_PORTS (10)
91
92#define IDE_DATA_OFFSET (0)
93#define IDE_ERROR_OFFSET (1)
94#define IDE_NSECTOR_OFFSET (2)
95#define IDE_SECTOR_OFFSET (3)
96#define IDE_LCYL_OFFSET (4)
97#define IDE_HCYL_OFFSET (5)
98#define IDE_SELECT_OFFSET (6)
99#define IDE_STATUS_OFFSET (7)
100#define IDE_CONTROL_OFFSET (8)
101#define IDE_IRQ_OFFSET (9)
102
103#define IDE_FEATURE_OFFSET IDE_ERROR_OFFSET
104#define IDE_COMMAND_OFFSET IDE_STATUS_OFFSET
105
106#define IDE_CONTROL_OFFSET_HOB (7)
107
108#define IDE_DATA_REG (HWIF(drive)->io_ports[IDE_DATA_OFFSET])
109#define IDE_ERROR_REG (HWIF(drive)->io_ports[IDE_ERROR_OFFSET])
110#define IDE_NSECTOR_REG (HWIF(drive)->io_ports[IDE_NSECTOR_OFFSET])
111#define IDE_SECTOR_REG (HWIF(drive)->io_ports[IDE_SECTOR_OFFSET])
112#define IDE_LCYL_REG (HWIF(drive)->io_ports[IDE_LCYL_OFFSET])
113#define IDE_HCYL_REG (HWIF(drive)->io_ports[IDE_HCYL_OFFSET])
114#define IDE_SELECT_REG (HWIF(drive)->io_ports[IDE_SELECT_OFFSET])
115#define IDE_STATUS_REG (HWIF(drive)->io_ports[IDE_STATUS_OFFSET])
116#define IDE_CONTROL_REG (HWIF(drive)->io_ports[IDE_CONTROL_OFFSET])
117#define IDE_IRQ_REG (HWIF(drive)->io_ports[IDE_IRQ_OFFSET])
118
119#define IDE_FEATURE_REG IDE_ERROR_REG
120#define IDE_COMMAND_REG IDE_STATUS_REG
121#define IDE_ALTSTATUS_REG IDE_CONTROL_REG
122#define IDE_IREASON_REG IDE_NSECTOR_REG
123#define IDE_BCOUNTL_REG IDE_LCYL_REG
124#define IDE_BCOUNTH_REG IDE_HCYL_REG
125
126#define OK_STAT(stat,good,bad) (((stat)&((good)|(bad)))==(good))
127#define BAD_R_STAT (BUSY_STAT | ERR_STAT)
128#define BAD_W_STAT (BAD_R_STAT | WRERR_STAT)
129#define BAD_STAT (BAD_R_STAT | DRQ_STAT)
130#define DRIVE_READY (READY_STAT | SEEK_STAT)
131#define DATA_READY (DRQ_STAT)
132
133#define BAD_CRC (ABRT_ERR | ICRC_ERR)
134
135#define SATA_NR_PORTS (3) /* 16 possible ?? */
136
137#define SATA_STATUS_OFFSET (0)
138#define SATA_STATUS_REG (HWIF(drive)->sata_scr[SATA_STATUS_OFFSET])
139#define SATA_ERROR_OFFSET (1)
140#define SATA_ERROR_REG (HWIF(drive)->sata_scr[SATA_ERROR_OFFSET])
141#define SATA_CONTROL_OFFSET (2)
142#define SATA_CONTROL_REG (HWIF(drive)->sata_scr[SATA_CONTROL_OFFSET])
143
144#define SATA_MISC_OFFSET (0)
145#define SATA_MISC_REG (HWIF(drive)->sata_misc[SATA_MISC_OFFSET])
146#define SATA_PHY_OFFSET (1)
147#define SATA_PHY_REG (HWIF(drive)->sata_misc[SATA_PHY_OFFSET])
148#define SATA_IEN_OFFSET (2)
149#define SATA_IEN_REG (HWIF(drive)->sata_misc[SATA_IEN_OFFSET])
150
151/*
152 * Our Physical Region Descriptor (PRD) table should be large enough
153 * to handle the biggest I/O request we are likely to see. Since requests
154 * can have no more than 256 sectors, and since the typical blocksize is
155 * two or more sectors, we could get by with a limit of 128 entries here for
156 * the usual worst case. Most requests seem to include some contiguous blocks,
157 * further reducing the number of table entries required.
158 *
159 * The driver reverts to PIO mode for individual requests that exceed
160 * this limit (possible with 512 byte blocksizes, eg. MSDOS f/s), so handling
161 * 100% of all crazy scenarios here is not necessary.
162 *
163 * As it turns out though, we must allocate a full 4KB page for this,
164 * so the two PRD tables (ide0 & ide1) will each get half of that,
165 * allowing each to have about 256 entries (8 bytes each) from this.
166 */
167#define PRD_BYTES 8
168#define PRD_ENTRIES 256
169
170/*
171 * Some more useful definitions
172 */
173#define PARTN_BITS 6 /* number of minor dev bits for partitions */
174#define MAX_DRIVES 2 /* per interface; 2 assumed by lots of code */
175#define SECTOR_SIZE 512
176#define SECTOR_WORDS (SECTOR_SIZE / 4) /* number of 32bit words per sector */
177#define IDE_LARGE_SEEK(b1,b2,t) (((b1) > (b2) + (t)) || ((b2) > (b1) + (t)))
178
179/*
180 * Timeouts for various operations:
181 */
182#define WAIT_DRQ (HZ/10) /* 100msec - spec allows up to 20ms */
183#define WAIT_READY (5*HZ) /* 5sec - some laptops are very slow */
184#define WAIT_PIDENTIFY (10*HZ) /* 10sec - should be less than 3ms (?), if all ATAPI CD is closed at boot */
185#define WAIT_WORSTCASE (30*HZ) /* 30sec - worst case when spinning up */
186#define WAIT_CMD (10*HZ) /* 10sec - maximum wait for an IRQ to happen */
187#define WAIT_MIN_SLEEP (2*HZ/100) /* 20msec - minimum sleep time */
188
1da177e4
LT
189/*
190 * Check for an interrupt and acknowledge the interrupt status
191 */
192struct hwif_s;
193typedef int (ide_ack_intr_t)(struct hwif_s *);
194
195#ifndef NO_DMA
196#define NO_DMA 255
197#endif
198
199/*
200 * hwif_chipset_t is used to keep track of the specific hardware
201 * chipset used by each IDE interface, if known.
202 */
528a572d 203enum { ide_unknown, ide_generic, ide_pci,
1da177e4
LT
204 ide_cmd640, ide_dtc2278, ide_ali14xx,
205 ide_qd65xx, ide_umc8672, ide_ht6560b,
206 ide_rz1000, ide_trm290,
207 ide_cmd646, ide_cy82c693, ide_4drives,
208 ide_pmac, ide_etrax100, ide_acorn,
26a940e2 209 ide_au1xxx, ide_forced
528a572d
BZ
210};
211
212typedef u8 hwif_chipset_t;
1da177e4
LT
213
214/*
215 * Structure to hold all information about the location of this port
216 */
217typedef struct hw_regs_s {
218 unsigned long io_ports[IDE_NR_PORTS]; /* task file registers */
219 int irq; /* our irq number */
220 int dma; /* our dma entry */
221 ide_ack_intr_t *ack_intr; /* acknowledge interrupt */
222 hwif_chipset_t chipset;
4349d5cd 223 struct device *dev;
1da177e4
LT
224} hw_regs_t;
225
baa8f3e9
BZ
226struct hwif_s * ide_find_port(unsigned long);
227
fd9bb539
BZ
228int ide_register_hw(hw_regs_t *, void (*)(struct hwif_s *), int,
229 struct hwif_s **);
1da177e4 230
1da177e4
LT
231void ide_setup_ports( hw_regs_t *hw,
232 unsigned long base,
233 int *offsets,
234 unsigned long ctrl,
235 unsigned long intr,
236 ide_ack_intr_t *ack_intr,
237#if 0
238 ide_io_ops_t *iops,
239#endif
240 int irq);
241
242static inline void ide_std_init_ports(hw_regs_t *hw,
243 unsigned long io_addr,
244 unsigned long ctl_addr)
245{
246 unsigned int i;
247
248 for (i = IDE_DATA_OFFSET; i <= IDE_STATUS_OFFSET; i++)
249 hw->io_ports[i] = io_addr++;
250
251 hw->io_ports[IDE_CONTROL_OFFSET] = ctl_addr;
252}
253
254#include <asm/ide.h>
255
83d7dbc4
MM
256#if !defined(MAX_HWIFS) || defined(CONFIG_EMBEDDED)
257#undef MAX_HWIFS
83ae20c8
BH
258#define MAX_HWIFS CONFIG_IDE_MAX_HWIFS
259#endif
260
1da177e4
LT
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
273static 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
294static 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 */
336typedef 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.
1da177e4
LT
363 */
364typedef union {
365 unsigned all :16;
366 struct {
367#if defined(__LITTLE_ENDIAN_BITFIELD)
368 unsigned low :8; /* LSB */
369 unsigned high :8; /* MSB */
370#elif defined(__BIG_ENDIAN_BITFIELD)
371 unsigned high :8; /* MSB */
372 unsigned low :8; /* LSB */
373#else
374#error "Please fix <asm/byteorder.h>"
375#endif
376 } b;
8447d9d5 377} ata_nsector_t, ata_data_t, atapi_bcount_t;
1da177e4 378
1da177e4
LT
379/*
380 * ATA-IDE Select Register, aka Device-Head
381 *
382 * head : always zeros here
383 * unit : drive select number: 0/1
384 * bit5 : always 1
385 * lba : using LBA instead of CHS
386 * bit7 : always 1
387 */
388typedef union {
389 unsigned all : 8;
390 struct {
391#if defined(__LITTLE_ENDIAN_BITFIELD)
392 unsigned head : 4;
393 unsigned unit : 1;
394 unsigned bit5 : 1;
395 unsigned lba : 1;
396 unsigned bit7 : 1;
397#elif defined(__BIG_ENDIAN_BITFIELD)
398 unsigned bit7 : 1;
399 unsigned lba : 1;
400 unsigned bit5 : 1;
401 unsigned unit : 1;
402 unsigned head : 4;
403#else
404#error "Please fix <asm/byteorder.h>"
405#endif
406 } b;
407} select_t, ata_select_t;
408
409/*
410 * The ATA-IDE Status Register.
411 * The ATAPI Status Register.
412 *
413 * check : Error occurred
414 * idx : Index Error
415 * corr : Correctable error occurred
416 * drq : Data is request by the device
417 * dsc : Disk Seek Complete : ata
418 * : Media access command finished : atapi
419 * df : Device Fault : ata
420 * : Reserved : atapi
421 * drdy : Ready, Command Mode Capable : ata
422 * : Ignored for ATAPI commands : atapi
423 * bsy : Disk is Busy
424 * : The device has access to the command block
425 */
426typedef union {
427 unsigned all :8;
428 struct {
429#if defined(__LITTLE_ENDIAN_BITFIELD)
430 unsigned check :1;
431 unsigned idx :1;
432 unsigned corr :1;
433 unsigned drq :1;
434 unsigned dsc :1;
435 unsigned df :1;
436 unsigned drdy :1;
437 unsigned bsy :1;
438#elif defined(__BIG_ENDIAN_BITFIELD)
439 unsigned bsy :1;
440 unsigned drdy :1;
441 unsigned df :1;
442 unsigned dsc :1;
443 unsigned drq :1;
444 unsigned corr :1;
445 unsigned idx :1;
446 unsigned check :1;
447#else
448#error "Please fix <asm/byteorder.h>"
449#endif
450 } b;
451} ata_status_t, atapi_status_t;
452
1da177e4
LT
453/*
454 * ATAPI Feature Register
455 *
456 * dma : Using DMA or PIO
457 * reserved321 : Reserved
458 * reserved654 : Reserved (Tag Type)
459 * reserved7 : Reserved
460 */
461typedef union {
462 unsigned all :8;
463 struct {
464#if defined(__LITTLE_ENDIAN_BITFIELD)
465 unsigned dma :1;
466 unsigned reserved321 :3;
467 unsigned reserved654 :3;
468 unsigned reserved7 :1;
469#elif defined(__BIG_ENDIAN_BITFIELD)
470 unsigned reserved7 :1;
471 unsigned reserved654 :3;
472 unsigned reserved321 :3;
473 unsigned dma :1;
474#else
475#error "Please fix <asm/byteorder.h>"
476#endif
477 } b;
478} atapi_feature_t;
479
480/*
481 * ATAPI Interrupt Reason Register.
482 *
483 * cod : Information transferred is command (1) or data (0)
484 * io : The device requests us to read (1) or write (0)
485 * reserved : Reserved
486 */
487typedef union {
488 unsigned all :8;
489 struct {
490#if defined(__LITTLE_ENDIAN_BITFIELD)
491 unsigned cod :1;
492 unsigned io :1;
493 unsigned reserved :6;
494#elif defined(__BIG_ENDIAN_BITFIELD)
495 unsigned reserved :6;
496 unsigned io :1;
497 unsigned cod :1;
498#else
499#error "Please fix <asm/byteorder.h>"
500#endif
501 } b;
502} atapi_ireason_t;
503
504/*
505 * The ATAPI error register.
506 *
507 * ili : Illegal Length Indication
508 * eom : End Of Media Detected
509 * abrt : Aborted command - As defined by ATA
510 * mcr : Media Change Requested - As defined by ATA
511 * sense_key : Sense key of the last failed packet command
512 */
513typedef union {
514 unsigned all :8;
515 struct {
516#if defined(__LITTLE_ENDIAN_BITFIELD)
517 unsigned ili :1;
518 unsigned eom :1;
519 unsigned abrt :1;
520 unsigned mcr :1;
521 unsigned sense_key :4;
522#elif defined(__BIG_ENDIAN_BITFIELD)
523 unsigned sense_key :4;
524 unsigned mcr :1;
525 unsigned abrt :1;
526 unsigned eom :1;
527 unsigned ili :1;
528#else
529#error "Please fix <asm/byteorder.h>"
530#endif
531 } b;
532} atapi_error_t;
533
1da177e4
LT
534/*
535 * Status returned from various ide_ functions
536 */
537typedef enum {
538 ide_stopped, /* no drive operation was started */
539 ide_started, /* a drive operation was started, handler was set */
540} ide_startstop_t;
541
542struct ide_driver_s;
543struct ide_settings_s;
544
e3a59b4d
HR
545#ifdef CONFIG_BLK_DEV_IDEACPI
546struct ide_acpi_drive_link;
547struct ide_acpi_hwif_link;
548#endif
549
1da177e4
LT
550typedef struct ide_drive_s {
551 char name[4]; /* drive name, such as "hda" */
552 char driver_req[10]; /* requests specific driver */
553
165125e1 554 struct request_queue *queue; /* request queue */
1da177e4
LT
555
556 struct request *rq; /* current request */
557 struct ide_drive_s *next; /* circular list of hwgroup drives */
1da177e4
LT
558 void *driver_data; /* extra driver data */
559 struct hd_driveid *id; /* drive model identification info */
7662d046 560#ifdef CONFIG_IDE_PROC_FS
1da177e4
LT
561 struct proc_dir_entry *proc; /* /proc/ide/ directory entry */
562 struct ide_settings_s *settings;/* /proc/ide/ drive settings */
7662d046 563#endif
1da177e4
LT
564 struct hwif_s *hwif; /* actually (ide_hwif_t *) */
565
566 unsigned long sleep; /* sleep until this time */
567 unsigned long service_start; /* time we started last request */
568 unsigned long service_time; /* service time of last request */
569 unsigned long timeout; /* max time to wait for irq */
570
571 special_t special; /* special action flags */
572 select_t select; /* basic drive/head select reg value */
573
574 u8 keep_settings; /* restore settings after drive reset */
1da177e4
LT
575 u8 using_dma; /* disk is using dma for read/write */
576 u8 retry_pio; /* retrying dma capable host in pio */
577 u8 state; /* retry state */
578 u8 waiting_for_dma; /* dma currently in progress */
579 u8 unmask; /* okay to unmask other irqs */
580 u8 bswap; /* byte swap data */
36193484 581 u8 noflush; /* don't attempt flushes */
1da177e4
LT
582 u8 dsc_overlap; /* DSC overlap */
583 u8 nice1; /* give potential excess bandwidth */
584
585 unsigned present : 1; /* drive is physically present */
586 unsigned dead : 1; /* device ejected hint */
587 unsigned id_read : 1; /* 1=id read from disk 0 = synthetic */
588 unsigned noprobe : 1; /* from: hdx=noprobe */
589 unsigned removable : 1; /* 1 if need to do check_media_change */
590 unsigned attach : 1; /* needed for removable devices */
1da177e4
LT
591 unsigned forced_geom : 1; /* 1 if hdx=c,h,s was given at boot */
592 unsigned no_unmask : 1; /* disallow setting unmask bit */
593 unsigned no_io_32bit : 1; /* disallow enabling 32bit I/O */
594 unsigned atapi_overlap : 1; /* ATAPI overlap (not supported) */
595 unsigned nice0 : 1; /* give obvious excess bandwidth */
596 unsigned nice2 : 1; /* give a share in our own bandwidth */
597 unsigned doorlocking : 1; /* for removable only: door lock/unlock works */
c223701c 598 unsigned nodma : 1; /* disallow DMA */
1da177e4
LT
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 */
1da177e4
LT
603 unsigned scsi : 1; /* 0=default, 1=ide-scsi emulation */
604 unsigned sleeping : 1; /* 1=sleeping & sleep field valid */
605 unsigned post_reset : 1;
7f8f48af 606 unsigned udma33_warned : 1;
1da177e4 607
1497943e 608 u8 addressing; /* 0=28-bit, 1=48-bit, 2=48-bit doing 28-bit */
1da177e4
LT
609 u8 quirk_list; /* considered quirky, set for a specific host */
610 u8 init_speed; /* transfer rate set at boot */
1da177e4 611 u8 current_speed; /* current transfer rate set */
513daadd 612 u8 desired_speed; /* desired transfer rate set */
1da177e4
LT
613 u8 dn; /* now wide spread use */
614 u8 wcache; /* status of write cache */
615 u8 acoustic; /* acoustic management */
616 u8 media; /* disk, cdrom, tape, floppy, ... */
617 u8 ctl; /* "normal" value for IDE_CONTROL_REG */
618 u8 ready_stat; /* min status value for drive ready */
619 u8 mult_count; /* current multiple sector setting */
620 u8 mult_req; /* requested multiple sector setting */
621 u8 tune_req; /* requested drive tuning setting */
622 u8 io_32bit; /* 0=16-bit, 1=32-bit, 2/3=32bit+sync */
623 u8 bad_wstat; /* used for ignoring WRERR_STAT */
624 u8 nowerr; /* used for ignoring WRERR_STAT */
625 u8 sect0; /* offset of first sector for DM6:DDO */
626 u8 head; /* "real" number of heads */
627 u8 sect; /* "real" sectors per track */
628 u8 bios_head; /* BIOS/fdisk/LILO number of heads */
629 u8 bios_sect; /* BIOS/fdisk/LILO sectors per track */
630
631 unsigned int bios_cyl; /* BIOS/fdisk/LILO number of cyls */
632 unsigned int cyl; /* "real" number of cyls */
26bcb879 633 unsigned int drive_data; /* used by set_pio_mode/selectproc */
1da177e4
LT
634 unsigned int failures; /* current failure count */
635 unsigned int max_failures; /* maximum allowed failure count */
dbe217af 636 u64 probed_capacity;/* initial reported media capacity (ide-cd only currently) */
1da177e4
LT
637
638 u64 capacity64; /* total number of sectors */
639
640 int lun; /* logical unit */
641 int crc_count; /* crc counter to reduce drive speed */
e3a59b4d
HR
642#ifdef CONFIG_BLK_DEV_IDEACPI
643 struct ide_acpi_drive_link *acpidata;
644#endif
1da177e4
LT
645 struct list_head list;
646 struct device gendev;
f36d4024 647 struct completion gendev_rel_comp; /* to deal with device release() */
1da177e4
LT
648} ide_drive_t;
649
8604affd
BZ
650#define to_ide_device(dev)container_of(dev, ide_drive_t, gendev)
651
1da177e4
LT
652#define IDE_CHIPSET_PCI_MASK \
653 ((1<<ide_pci)|(1<<ide_cmd646)|(1<<ide_ali14xx))
654#define IDE_CHIPSET_IS_PCI(c) ((IDE_CHIPSET_PCI_MASK >> (c)) & 1)
655
656struct ide_pci_device_s;
657
658typedef struct hwif_s {
659 struct hwif_s *next; /* for linked-list in ide_hwgroup_t */
660 struct hwif_s *mate; /* other hwif from same PCI chip */
661 struct hwgroup_s *hwgroup; /* actually (ide_hwgroup_t *) */
662 struct proc_dir_entry *proc; /* /proc/ide/ directory entry */
663
664 char name[6]; /* name of interface, eg. "ide0" */
665
666 /* task file registers for pata and sata */
667 unsigned long io_ports[IDE_NR_PORTS];
668 unsigned long sata_scr[SATA_NR_PORTS];
669 unsigned long sata_misc[SATA_NR_PORTS];
670
671 hw_regs_t hw; /* Hardware info */
672 ide_drive_t drives[MAX_DRIVES]; /* drive info */
673
674 u8 major; /* our major number */
675 u8 index; /* 0 for ide0; 1 for ide1; ... */
676 u8 channel; /* for dual-port chips: 0=primary, 1=secondary */
677 u8 straight8; /* Alan's straight 8 check */
678 u8 bus_state; /* power state of the IDE bus */
679
88b2b32b 680 u16 host_flags;
6a824c92 681
4099d143
BZ
682 u8 pio_mask;
683
1da177e4
LT
684 u8 ultra_mask;
685 u8 mwdma_mask;
686 u8 swdma_mask;
687
49521f97
BZ
688 u8 cbl; /* cable type */
689
1da177e4
LT
690 hwif_chipset_t chipset; /* sub-module for tuning.. */
691
692 struct pci_dev *pci_dev; /* for pci chipsets */
693 struct ide_pci_device_s *cds; /* chipset device struct */
694
695 void (*rw_disk)(ide_drive_t *, struct request *);
696
697#if 0
698 ide_hwif_ops_t *hwifops;
699#else
88b2b32b 700 /* routine to program host for PIO mode */
26bcb879 701 void (*set_pio_mode)(ide_drive_t *, const u8);
88b2b32b
BZ
702 /* routine to program host for DMA mode */
703 void (*set_dma_mode)(ide_drive_t *, const u8);
1da177e4
LT
704 /* tweaks hardware to select drive */
705 void (*selectproc)(ide_drive_t *);
706 /* chipset polling based on hba specifics */
707 int (*reset_poll)(ide_drive_t *);
708 /* chipset specific changes to default for device-hba resets */
709 void (*pre_reset)(ide_drive_t *);
710 /* routine to reset controller after a disk reset */
711 void (*resetproc)(ide_drive_t *);
712 /* special interrupt handling for shared pci interrupts */
713 void (*intrproc)(ide_drive_t *);
714 /* special host masking for drive selection */
715 void (*maskproc)(ide_drive_t *, int);
716 /* check host's drive quirk list */
717 int (*quirkproc)(ide_drive_t *);
718 /* driver soft-power interface */
719 int (*busproc)(ide_drive_t *, int);
1da177e4 720#endif
b4e44369 721 u8 (*mdma_filter)(ide_drive_t *);
2d5eaa6d 722 u8 (*udma_filter)(ide_drive_t *);
1da177e4 723
fd9bb539
BZ
724 void (*fixup)(struct hwif_s *);
725
1da177e4
LT
726 void (*ata_input_data)(ide_drive_t *, void *, u32);
727 void (*ata_output_data)(ide_drive_t *, void *, u32);
728
729 void (*atapi_input_bytes)(ide_drive_t *, void *, u32);
730 void (*atapi_output_bytes)(ide_drive_t *, void *, u32);
731
732 int (*dma_setup)(ide_drive_t *);
733 void (*dma_exec_cmd)(ide_drive_t *, u8);
734 void (*dma_start)(ide_drive_t *);
735 int (*ide_dma_end)(ide_drive_t *drive);
1da177e4 736 int (*ide_dma_on)(ide_drive_t *drive);
7469aaf6 737 void (*dma_off_quietly)(ide_drive_t *drive);
1da177e4 738 int (*ide_dma_test_irq)(ide_drive_t *drive);
f0dd8712 739 void (*ide_dma_clear_irq)(ide_drive_t *drive);
ccf35289 740 void (*dma_host_on)(ide_drive_t *drive);
7469aaf6 741 void (*dma_host_off)(ide_drive_t *drive);
841d2a9b 742 void (*dma_lost_irq)(ide_drive_t *drive);
c283f5db 743 void (*dma_timeout)(ide_drive_t *drive);
1da177e4
LT
744
745 void (*OUTB)(u8 addr, unsigned long port);
746 void (*OUTBSYNC)(ide_drive_t *drive, u8 addr, unsigned long port);
747 void (*OUTW)(u16 addr, unsigned long port);
1da177e4
LT
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);
1da177e4
LT
753 void (*INSW)(unsigned long port, void *addr, u32 count);
754 void (*INSL)(unsigned long port, void *addr, u32 count);
755
756 /* dma physical region descriptor table (cpu view) */
757 unsigned int *dmatable_cpu;
758 /* dma physical region descriptor table (dma view) */
759 dma_addr_t dmatable_dma;
760 /* Scatter-gather list used to build the above */
761 struct scatterlist *sg_table;
762 int sg_max_nents; /* Maximum number of entries in it */
763 int sg_nents; /* Current number of entries in it */
764 int sg_dma_direction; /* dma transfer direction */
765
766 /* data phase of the active command (currently only valid for PIO/DMA) */
767 int data_phase;
768
769 unsigned int nsect;
770 unsigned int nleft;
55c16a70 771 struct scatterlist *cursg;
1da177e4
LT
772 unsigned int cursg_ofs;
773
1da177e4
LT
774 int rqsize; /* max sectors per request */
775 int irq; /* our irq number */
776
777 unsigned long dma_master; /* reference base addr dmabase */
778 unsigned long dma_base; /* base addr for dma ports */
779 unsigned long dma_command; /* dma command register */
780 unsigned long dma_vendor1; /* dma vendor 1 register */
781 unsigned long dma_status; /* dma status register */
782 unsigned long dma_vendor3; /* dma vendor 3 register */
783 unsigned long dma_prdtable; /* actual prd table address */
1da177e4 784
1da177e4
LT
785 unsigned long config_data; /* for use by chipset-specific code */
786 unsigned long select_data; /* for use by chipset-specific code */
787
020e322d
SS
788 unsigned long extra_base; /* extra addr for dma ports */
789 unsigned extra_ports; /* number of extra dma ports */
790
1da177e4
LT
791 unsigned noprobe : 1; /* don't probe for this interface */
792 unsigned present : 1; /* this interface exists */
793 unsigned hold : 1; /* this interface is always present */
794 unsigned serialized : 1; /* serialized all channel operation */
795 unsigned sharing_irq: 1; /* 1 = sharing irq with another hwif */
796 unsigned reset : 1; /* reset after probe */
1da177e4
LT
797 unsigned auto_poll : 1; /* supports nop auto-poll */
798 unsigned sg_mapped : 1; /* sg_table and sg_nents are ready */
208a08f7 799 unsigned no_io_32bit : 1; /* 1 = can not do 32-bit IO ops */
2ad1e558 800 unsigned mmio : 1; /* host uses MMIO */
1da177e4
LT
801
802 struct device gendev;
f36d4024 803 struct completion gendev_rel_comp; /* To deal with device release() */
1da177e4
LT
804
805 void *hwif_data; /* extra hwif data */
806
807 unsigned dma;
e3a59b4d
HR
808
809#ifdef CONFIG_BLK_DEV_IDEACPI
810 struct ide_acpi_hwif_link *acpidata;
811#endif
22fc6ecc 812} ____cacheline_internodealigned_in_smp ide_hwif_t;
1da177e4
LT
813
814/*
815 * internal ide interrupt handler type
816 */
817typedef ide_startstop_t (ide_pre_handler_t)(ide_drive_t *, struct request *);
818typedef ide_startstop_t (ide_handler_t)(ide_drive_t *);
819typedef int (ide_expiry_t)(ide_drive_t *);
820
821typedef struct hwgroup_s {
822 /* irq handler, if active */
823 ide_startstop_t (*handler)(ide_drive_t *);
824 /* irq handler, suspended if active */
825 ide_startstop_t (*handler_save)(ide_drive_t *);
826 /* BOOL: protects all fields below */
827 volatile int busy;
828 /* BOOL: wake us up on timer expiry */
829 unsigned int sleeping : 1;
830 /* BOOL: polling active & poll_timeout field valid */
831 unsigned int polling : 1;
913759ac
AC
832 /* BOOL: in a polling reset situation. Must not trigger another reset yet */
833 unsigned int resetting : 1;
834
1da177e4
LT
835 /* current drive */
836 ide_drive_t *drive;
837 /* ptr to current hwif in linked-list */
838 ide_hwif_t *hwif;
839
840 /* for pci chipsets */
841 struct pci_dev *pci_dev;
842 /* chipset device struct */
843 struct ide_pci_device_s *cds;
844
845 /* current request */
846 struct request *rq;
847 /* failsafe timer */
848 struct timer_list timer;
849 /* local copy of current write rq */
850 struct request wrq;
851 /* timeout value during long polls */
852 unsigned long poll_timeout;
853 /* queried upon timeouts */
854 int (*expiry)(ide_drive_t *);
855 /* ide_system_bus_speed */
856 int pio_clock;
23450319
SS
857 int req_gen;
858 int req_gen_timer;
1da177e4
LT
859
860 unsigned char cmd_buf[4];
861} ide_hwgroup_t;
862
7662d046
BZ
863typedef struct ide_driver_s ide_driver_t;
864
f9383c42 865extern struct mutex ide_setting_mtx;
1da177e4 866
7662d046
BZ
867int set_io_32bit(ide_drive_t *, int);
868int set_pio_mode(ide_drive_t *, int);
869int set_using_dma(ide_drive_t *, int);
870
871#ifdef CONFIG_IDE_PROC_FS
1da177e4
LT
872/*
873 * configurable drive settings
874 */
875
876#define TYPE_INT 0
1497943e
BZ
877#define TYPE_BYTE 1
878#define TYPE_SHORT 2
1da177e4
LT
879
880#define SETTING_READ (1 << 0)
881#define SETTING_WRITE (1 << 1)
882#define SETTING_RW (SETTING_READ | SETTING_WRITE)
883
884typedef int (ide_procset_t)(ide_drive_t *, int);
885typedef struct ide_settings_s {
886 char *name;
887 int rw;
1da177e4
LT
888 int data_type;
889 int min;
890 int max;
891 int mul_factor;
892 int div_factor;
893 void *data;
894 ide_procset_t *set;
895 int auto_remove;
896 struct ide_settings_s *next;
897} ide_settings_t;
898
1497943e 899int ide_add_setting(ide_drive_t *, const char *, int, int, int, int, int, int, void *, ide_procset_t *set);
1da177e4
LT
900
901/*
902 * /proc/ide interface
903 */
904typedef struct {
905 const char *name;
906 mode_t mode;
907 read_proc_t *read_proc;
908 write_proc_t *write_proc;
909} ide_proc_entry_t;
910
ecfd80e4
BZ
911void proc_ide_create(void);
912void proc_ide_destroy(void);
5cbf79cd
BZ
913void ide_proc_register_port(ide_hwif_t *);
914void ide_proc_unregister_port(ide_hwif_t *);
7662d046
BZ
915void ide_proc_register_driver(ide_drive_t *, ide_driver_t *);
916void ide_proc_unregister_driver(ide_drive_t *, ide_driver_t *);
917
918void ide_add_generic_settings(ide_drive_t *);
919
1da177e4
LT
920read_proc_t proc_ide_read_capacity;
921read_proc_t proc_ide_read_geometry;
922
923#ifdef CONFIG_BLK_DEV_IDEPCI
924void ide_pci_create_host_proc(const char *, get_info_t *);
925#endif
926
927/*
928 * Standard exit stuff:
929 */
930#define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) \
931{ \
932 len -= off; \
933 if (len < count) { \
934 *eof = 1; \
935 if (len <= 0) \
936 return 0; \
937 } else \
938 len = count; \
939 *start = page + off; \
940 return len; \
941}
942#else
ecfd80e4
BZ
943static inline void proc_ide_create(void) { ; }
944static inline void proc_ide_destroy(void) { ; }
5cbf79cd
BZ
945static inline void ide_proc_register_port(ide_hwif_t *hwif) { ; }
946static inline void ide_proc_unregister_port(ide_hwif_t *hwif) { ; }
7662d046
BZ
947static inline void ide_proc_register_driver(ide_drive_t *drive, ide_driver_t *driver) { ; }
948static inline void ide_proc_unregister_driver(ide_drive_t *drive, ide_driver_t *driver) { ; }
949static inline void ide_add_generic_settings(ide_drive_t *drive) { ; }
1da177e4
LT
950#define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) return 0;
951#endif
952
953/*
954 * Power Management step value (rq->pm->pm_step).
955 *
956 * The step value starts at 0 (ide_pm_state_start_suspend) for a
957 * suspend operation or 1000 (ide_pm_state_start_resume) for a
958 * resume operation.
959 *
960 * For each step, the core calls the subdriver start_power_step() first.
961 * This can return:
962 * - ide_stopped : In this case, the core calls us back again unless
963 * step have been set to ide_power_state_completed.
964 * - ide_started : In this case, the channel is left busy until an
965 * async event (interrupt) occurs.
966 * Typically, start_power_step() will issue a taskfile request with
967 * do_rw_taskfile().
968 *
969 * Upon reception of the interrupt, the core will call complete_power_step()
970 * with the error code if any. This routine should update the step value
971 * and return. It should not start a new request. The core will call
972 * start_power_step for the new step value, unless step have been set to
973 * ide_power_state_completed.
974 *
975 * Subdrivers are expected to define their own additional power
976 * steps from 1..999 for suspend and from 1001..1999 for resume,
977 * other values are reserved for future use.
978 */
979
980enum {
981 ide_pm_state_completed = -1,
982 ide_pm_state_start_suspend = 0,
983 ide_pm_state_start_resume = 1000,
984};
985
986/*
987 * Subdrivers support.
4ef3b8f4
LR
988 *
989 * The gendriver.owner field should be set to the module owner of this driver.
990 * The gendriver.name field should be set to the name of this driver
1da177e4 991 */
7662d046 992struct ide_driver_s {
1da177e4
LT
993 const char *version;
994 u8 media;
1da177e4 995 unsigned supports_dsc_overlap : 1;
1da177e4
LT
996 ide_startstop_t (*do_request)(ide_drive_t *, struct request *, sector_t);
997 int (*end_request)(ide_drive_t *, int, int);
998 ide_startstop_t (*error)(ide_drive_t *, struct request *rq, u8, u8);
999 ide_startstop_t (*abort)(ide_drive_t *, struct request *rq);
1da177e4 1000 struct device_driver gen_driver;
4031bbe4
RK
1001 int (*probe)(ide_drive_t *);
1002 void (*remove)(ide_drive_t *);
0d2157f7 1003 void (*resume)(ide_drive_t *);
4031bbe4 1004 void (*shutdown)(ide_drive_t *);
7662d046
BZ
1005#ifdef CONFIG_IDE_PROC_FS
1006 ide_proc_entry_t *proc;
1007#endif
1008};
1da177e4 1009
4031bbe4
RK
1010#define to_ide_driver(drv) container_of(drv, ide_driver_t, gen_driver)
1011
1da177e4
LT
1012int generic_ide_ioctl(ide_drive_t *, struct file *, struct block_device *, unsigned, unsigned long);
1013
1014/*
1015 * ide_hwifs[] is the master data structure used to keep track
1016 * of just about everything in ide.c. Whenever possible, routines
1017 * should be using pointers to a drive (ide_drive_t *) or
1018 * pointers to a hwif (ide_hwif_t *), rather than indexing this
1019 * structure directly (the allocation/layout may change!).
1020 *
1021 */
1022#ifndef _IDE_C
1023extern ide_hwif_t ide_hwifs[]; /* master data repository */
1024#endif
1025extern int noautodma;
1026
1027extern int ide_end_request (ide_drive_t *drive, int uptodate, int nrsecs);
dbe217af
AC
1028int ide_end_dequeued_request(ide_drive_t *drive, struct request *rq,
1029 int uptodate, int nr_sectors);
1da177e4 1030
1da177e4
LT
1031extern void ide_set_handler (ide_drive_t *drive, ide_handler_t *handler, unsigned int timeout, ide_expiry_t *expiry);
1032
1da177e4
LT
1033extern void ide_execute_command(ide_drive_t *, task_ioreg_t cmd, ide_handler_t *, unsigned int, ide_expiry_t *);
1034
1035ide_startstop_t __ide_error(ide_drive_t *, struct request *, u8, u8);
1036
1da177e4
LT
1037ide_startstop_t ide_error (ide_drive_t *drive, const char *msg, byte stat);
1038
1039ide_startstop_t __ide_abort(ide_drive_t *, struct request *);
1040
1da177e4
LT
1041extern ide_startstop_t ide_abort(ide_drive_t *, const char *);
1042
1043extern void ide_fix_driveid(struct hd_driveid *);
1044/*
1045 * ide_fixstring() cleans up and (optionally) byte-swaps a text string,
1046 * removing leading/trailing blanks and compressing internal blanks.
1047 * It is primarily used to tidy up the model name/number fields as
1048 * returned by the WIN_[P]IDENTIFY commands.
1049 *
1050 * (s, bytecount, byteswap)
1051 */
1052extern void ide_fixstring(u8 *, const int, const int);
1053
74af21cf 1054int ide_wait_stat(ide_startstop_t *, ide_drive_t *, u8, u8, unsigned long);
1da177e4 1055
1da177e4
LT
1056extern ide_startstop_t ide_do_reset (ide_drive_t *);
1057
1da177e4
LT
1058extern void ide_init_drive_cmd (struct request *rq);
1059
1da177e4
LT
1060/*
1061 * "action" parameter type for ide_do_drive_cmd() below.
1062 */
1063typedef enum {
1064 ide_wait, /* insert rq at end of list, and wait for it */
1da177e4
LT
1065 ide_preempt, /* insert rq in front of current request */
1066 ide_head_wait, /* insert rq in front of current request and wait for it */
1067 ide_end /* insert rq at end of list, but don't wait for it */
1068} ide_action_t;
1069
1da177e4
LT
1070extern int ide_do_drive_cmd(ide_drive_t *, struct request *, ide_action_t);
1071
1da177e4
LT
1072extern void ide_end_drive_cmd(ide_drive_t *, u8, u8);
1073
1074/*
1075 * Issue ATA command and wait for completion.
1076 * Use for implementing commands in kernel
1077 *
1078 * (ide_drive_t *drive, u8 cmd, u8 nsect, u8 feature, u8 sectors, u8 *buf)
1079 */
1080extern int ide_wait_cmd(ide_drive_t *, u8, u8, u8, u8, u8 *);
1081
1082typedef struct ide_task_s {
1083/*
1084 * struct hd_drive_task_hdr tf;
1085 * task_struct_t tf;
1086 * struct hd_drive_hob_hdr hobf;
1087 * hob_struct_t hobf;
1088 */
1089 task_ioreg_t tfRegister[8];
1090 task_ioreg_t hobRegister[8];
1091 ide_reg_valid_t tf_out_flags;
1092 ide_reg_valid_t tf_in_flags;
1093 int data_phase;
1094 int command_type;
1095 ide_pre_handler_t *prehandler;
1096 ide_handler_t *handler;
1097 struct request *rq; /* copy of request */
1098 void *special; /* valid_t generally */
1099} ide_task_t;
1100
1101extern u32 ide_read_24(ide_drive_t *);
1102
1103extern void SELECT_DRIVE(ide_drive_t *);
1104extern void SELECT_INTERRUPT(ide_drive_t *);
1105extern void SELECT_MASK(ide_drive_t *, int);
1106extern void QUIRK_LIST(ide_drive_t *);
1107
1108extern int drive_is_ready(ide_drive_t *);
1da177e4
LT
1109
1110/*
1111 * taskfile io for disks for now...and builds request from ide_ioctl
1112 */
1113extern ide_startstop_t do_rw_taskfile(ide_drive_t *, ide_task_t *);
1114
1115/*
1116 * Special Flagged Register Validation Caller
1117 */
1118extern ide_startstop_t flagged_taskfile(ide_drive_t *, ide_task_t *);
1119
1120extern ide_startstop_t set_multmode_intr(ide_drive_t *);
1121extern ide_startstop_t set_geometry_intr(ide_drive_t *);
1122extern ide_startstop_t recal_intr(ide_drive_t *);
1123extern ide_startstop_t task_no_data_intr(ide_drive_t *);
1124extern ide_startstop_t task_in_intr(ide_drive_t *);
1125extern ide_startstop_t pre_task_out_intr(ide_drive_t *, struct request *);
1126
1127extern int ide_raw_taskfile(ide_drive_t *, ide_task_t *, u8 *);
1128
1129int ide_taskfile_ioctl(ide_drive_t *, unsigned int, unsigned long);
1130int ide_cmd_ioctl(ide_drive_t *, unsigned int, unsigned long);
1131int ide_task_ioctl(ide_drive_t *, unsigned int, unsigned long);
1132
1133extern int system_bus_clock(void);
1134
1135extern int ide_driveid_update(ide_drive_t *);
1136extern int ide_ata66_check(ide_drive_t *, ide_task_t *);
1137extern int ide_config_drive_speed(ide_drive_t *, u8);
1138extern u8 eighty_ninty_three (ide_drive_t *);
1139extern int set_transfer(ide_drive_t *, ide_task_t *);
1140extern int taskfile_lib_get_identify(ide_drive_t *drive, u8 *);
1141
1142extern int ide_wait_not_busy(ide_hwif_t *hwif, unsigned long timeout);
1143
1da177e4
LT
1144extern void ide_stall_queue(ide_drive_t *drive, unsigned long timeout);
1145
1146extern int ide_spin_wait_hwgroup(ide_drive_t *);
1147extern void ide_timer_expiry(unsigned long);
7d12e780 1148extern irqreturn_t ide_intr(int irq, void *dev_id);
165125e1 1149extern void do_ide_request(struct request_queue *);
1da177e4
LT
1150
1151void ide_init_disk(struct gendisk *, ide_drive_t *);
1152
1da177e4
LT
1153extern int ideprobe_init(void);
1154
6d208b39 1155#ifdef CONFIG_IDEPCI_PCIBUS_ORDER
1da177e4 1156extern void ide_scan_pcibus(int scan_direction) __init;
725522b5
GKH
1157extern int __ide_pci_register_driver(struct pci_driver *driver, struct module *owner, const char *mod_name);
1158#define ide_pci_register_driver(d) __ide_pci_register_driver(d, THIS_MODULE, KBUILD_MODNAME)
6d208b39
BZ
1159#else
1160#define ide_pci_register_driver(d) pci_register_driver(d)
1161#endif
1162
8447d9d5 1163void ide_pci_setup_ports(struct pci_dev *, struct ide_pci_device_s *, int, u8 *);
1da177e4
LT
1164extern void ide_setup_pci_noise (struct pci_dev *dev, struct ide_pci_device_s *d);
1165
1166extern void default_hwif_iops(ide_hwif_t *);
1167extern void default_hwif_mmiops(ide_hwif_t *);
1168extern void default_hwif_transport(ide_hwif_t *);
1169
1da177e4
LT
1170typedef struct ide_pci_enablebit_s {
1171 u8 reg; /* byte pci reg holding the enable-bit */
1172 u8 mask; /* mask to isolate the enable-bit */
1173 u8 val; /* value of masked reg when "enabled" */
1174} ide_pci_enablebit_t;
1175
1176enum {
1177 /* Uses ISA control ports not PCI ones. */
a5d8c5c8 1178 IDE_HFLAG_ISA_PORTS = (1 << 0),
6a824c92 1179 /* single port device */
a5d8c5c8 1180 IDE_HFLAG_SINGLE = (1 << 1),
6a824c92
BZ
1181 /* don't use legacy PIO blacklist */
1182 IDE_HFLAG_PIO_NO_BLACKLIST = (1 << 2),
1183 /* don't use conservative PIO "downgrade" */
1184 IDE_HFLAG_PIO_NO_DOWNGRADE = (1 << 3),
26bcb879
BZ
1185 /* use PIO8/9 for prefetch off/on */
1186 IDE_HFLAG_ABUSE_PREFETCH = (1 << 4),
1187 /* use PIO6/7 for fast-devsel off/on */
1188 IDE_HFLAG_ABUSE_FAST_DEVSEL = (1 << 5),
1189 /* use 100-102 and 200-202 PIO values to set DMA modes */
1190 IDE_HFLAG_ABUSE_DMA_MODES = (1 << 6),
aedea591
BZ
1191 /*
1192 * keep DMA setting when programming PIO mode, may be used only
1193 * for hosts which have separate PIO and DMA timings (ie. PMAC)
1194 */
1195 IDE_HFLAG_SET_PIO_MODE_KEEP_DMA = (1 << 7),
88b2b32b
BZ
1196 /* program host for the transfer mode after programming device */
1197 IDE_HFLAG_POST_SET_MODE = (1 << 8),
1198 /* don't program host/device for the transfer mode ("smart" hosts) */
1199 IDE_HFLAG_NO_SET_MODE = (1 << 9),
0ae2e178
BZ
1200 /* trust BIOS for programming chipset/device for DMA */
1201 IDE_HFLAG_TRUST_BIOS_FOR_DMA = (1 << 10),
1202 /* host uses VDMA */
1203 IDE_HFLAG_VDMA = (1 << 11),
33c1002e
BZ
1204 /* ATAPI DMA is unsupported */
1205 IDE_HFLAG_NO_ATAPI_DMA = (1 << 12),
7cab14a7
BZ
1206 /* set if host is a "bootable" controller */
1207 IDE_HFLAG_BOOTABLE = (1 << 13),
47b68788
BZ
1208 /* host doesn't support DMA */
1209 IDE_HFLAG_NO_DMA = (1 << 14),
1210 /* check if host is PCI IDE device before allowing DMA */
1211 IDE_HFLAG_NO_AUTODMA = (1 << 15),
9ffcf364
BZ
1212 /* host is CS5510/CS5520 */
1213 IDE_HFLAG_CS5520 = (1 << 16),
238e4f14
BZ
1214 /* no LBA48 */
1215 IDE_HFLAG_NO_LBA48 = (1 << 17),
1216 /* no LBA48 DMA */
1217 IDE_HFLAG_NO_LBA48_DMA = (1 << 18),
ed67b923
BZ
1218 /* data FIFO is cleared by an error */
1219 IDE_HFLAG_ERROR_STOPS_FIFO = (1 << 19),
1c51361a
BZ
1220 /* serialize ports */
1221 IDE_HFLAG_SERIALIZE = (1 << 20),
3985ee3b
BZ
1222 /* use legacy IRQs */
1223 IDE_HFLAG_LEGACY_IRQS = (1 << 21),
8acf28c0
BZ
1224 /* force use of legacy IRQs */
1225 IDE_HFLAG_FORCE_LEGACY_IRQS = (1 << 22),
272a3709
BZ
1226 /* limit LBA48 requests to 256 sectors */
1227 IDE_HFLAG_RQSIZE_256 = (1 << 23),
caea7602
BZ
1228 /* use 32-bit I/O ops */
1229 IDE_HFLAG_IO_32BIT = (1 << 24),
1230 /* unmask IRQs */
1231 IDE_HFLAG_UNMASK_IRQS = (1 << 25),
1da177e4
LT
1232};
1233
7cab14a7
BZ
1234#ifdef CONFIG_BLK_DEV_OFFBOARD
1235# define IDE_HFLAG_OFF_BOARD IDE_HFLAG_BOOTABLE
1236#else
1237# define IDE_HFLAG_OFF_BOARD 0
1238#endif
1239
1da177e4
LT
1240typedef struct ide_pci_device_s {
1241 char *name;
1da177e4
LT
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 *);
1da177e4 1247 ide_pci_enablebit_t enablebits[2];
528a572d 1248 hwif_chipset_t chipset;
1da177e4 1249 unsigned int extra;
9ffcf364 1250 u32 host_flags;
4099d143 1251 u8 pio_mask;
5f8b6c34
BZ
1252 u8 swdma_mask;
1253 u8 mwdma_mask;
18137207 1254 u8 udma_mask;
1da177e4
LT
1255} ide_pci_device_t;
1256
1257extern int ide_setup_pci_device(struct pci_dev *, ide_pci_device_t *);
1258extern int ide_setup_pci_devices(struct pci_dev *, struct pci_dev *, ide_pci_device_t *);
1259
1260void ide_map_sg(ide_drive_t *, struct request *);
1261void ide_init_sg_cmd(ide_drive_t *, struct request *);
1262
1263#define BAD_DMA_DRIVE 0
1264#define GOOD_DMA_DRIVE 1
1265
65e5f2e3
JC
1266struct drive_list_entry {
1267 const char *id_model;
1268 const char *id_firmware;
1269};
1270
1271int ide_in_drive_list(struct hd_driveid *, const struct drive_list_entry *);
a5b7e70d
BZ
1272
1273#ifdef CONFIG_BLK_DEV_IDEDMA
1da177e4 1274int __ide_dma_bad_drive(ide_drive_t *);
7670df73
BZ
1275
1276u8 ide_find_dma_mode(ide_drive_t *, u8);
1277
1278static inline u8 ide_max_dma_mode(ide_drive_t *drive)
1279{
1280 return ide_find_dma_mode(drive, XFER_UDMA_6);
1281}
1282
7469aaf6 1283void ide_dma_off(ide_drive_t *);
1da177e4 1284void ide_dma_verbose(ide_drive_t *);
3608b5d7 1285int ide_set_dma(ide_drive_t *);
1da177e4
LT
1286ide_startstop_t ide_dma_intr(ide_drive_t *);
1287
1288#ifdef CONFIG_BLK_DEV_IDEDMA_PCI
1289extern int ide_build_sglist(ide_drive_t *, struct request *);
1290extern int ide_build_dmatable(ide_drive_t *, struct request *);
1291extern void ide_destroy_dmatable(ide_drive_t *);
1292extern int ide_release_dma(ide_hwif_t *);
1293extern void ide_setup_dma(ide_hwif_t *, unsigned long, unsigned int);
1294
7469aaf6
BZ
1295void ide_dma_host_off(ide_drive_t *);
1296void ide_dma_off_quietly(ide_drive_t *);
ccf35289 1297void ide_dma_host_on(ide_drive_t *);
1da177e4 1298extern int __ide_dma_on(ide_drive_t *);
1da177e4
LT
1299extern int ide_dma_setup(ide_drive_t *);
1300extern void ide_dma_start(ide_drive_t *);
1301extern int __ide_dma_end(ide_drive_t *);
841d2a9b 1302extern void ide_dma_lost_irq(ide_drive_t *);
c283f5db 1303extern void ide_dma_timeout(ide_drive_t *);
1da177e4
LT
1304#endif /* CONFIG_BLK_DEV_IDEDMA_PCI */
1305
1306#else
7670df73 1307static inline u8 ide_find_dma_mode(ide_drive_t *drive, u8 speed) { return 0; }
2d5eaa6d 1308static inline u8 ide_max_dma_mode(ide_drive_t *drive) { return 0; }
7469aaf6 1309static inline void ide_dma_off(ide_drive_t *drive) { ; }
1da177e4 1310static inline void ide_dma_verbose(ide_drive_t *drive) { ; }
3608b5d7 1311static inline int ide_set_dma(ide_drive_t *drive) { return 1; }
1da177e4
LT
1312#endif /* CONFIG_BLK_DEV_IDEDMA */
1313
1314#ifndef CONFIG_BLK_DEV_IDEDMA_PCI
1315static inline void ide_release_dma(ide_hwif_t *drive) {;}
1316#endif
1317
e3a59b4d
HR
1318#ifdef CONFIG_BLK_DEV_IDEACPI
1319extern int ide_acpi_exec_tfs(ide_drive_t *drive);
1320extern void ide_acpi_get_timing(ide_hwif_t *hwif);
1321extern void ide_acpi_push_timing(ide_hwif_t *hwif);
1322extern void ide_acpi_init(ide_hwif_t *hwif);
5e32132b 1323extern void ide_acpi_set_state(ide_hwif_t *hwif, int on);
e3a59b4d
HR
1324#else
1325static inline int ide_acpi_exec_tfs(ide_drive_t *drive) { return 0; }
1326static inline void ide_acpi_get_timing(ide_hwif_t *hwif) { ; }
1327static inline void ide_acpi_push_timing(ide_hwif_t *hwif) { ; }
1328static inline void ide_acpi_init(ide_hwif_t *hwif) { ; }
5e32132b 1329static inline void ide_acpi_set_state(ide_hwif_t *hwif, int on) {}
e3a59b4d
HR
1330#endif
1331
1da177e4
LT
1332extern int ide_hwif_request_regions(ide_hwif_t *hwif);
1333extern void ide_hwif_release_regions(ide_hwif_t* hwif);
1334extern void ide_unregister (unsigned int index);
1335
1336void ide_register_region(struct gendisk *);
1337void ide_unregister_region(struct gendisk *);
1338
1339void ide_undecoded_slave(ide_hwif_t *);
1340
8447d9d5 1341int ide_device_add(u8 idx[4]);
1da177e4
LT
1342
1343static inline void *ide_get_hwifdata (ide_hwif_t * hwif)
1344{
1345 return hwif->hwif_data;
1346}
1347
1348static inline void ide_set_hwifdata (ide_hwif_t * hwif, void *data)
1349{
1350 hwif->hwif_data = data;
1351}
1352
1353/* ide-lib.c */
1da177e4
LT
1354extern char *ide_xfer_verbose(u8 xfer_rate);
1355extern void ide_toggle_bounce(ide_drive_t *drive, int on);
1356extern int ide_set_xfer_rate(ide_drive_t *drive, u8 rate);
1357
2229833c
BZ
1358static inline int ide_dev_has_iordy(struct hd_driveid *id)
1359{
1360 return ((id->field_valid & 2) && (id->capability & 8)) ? 1 : 0;
1361}
1362
6c3c22f3
SS
1363static inline int ide_dev_is_sata(struct hd_driveid *id)
1364{
1365 /*
1366 * See if word 93 is 0 AND drive is at least ATA-5 compatible
1367 * verifying that word 80 by casting it to a signed type --
1368 * this trick allows us to filter out the reserved values of
1369 * 0x0000 and 0xffff along with the earlier ATA revisions...
1370 */
1371 if (id->hw_config == 0 && (short)id->major_rev_num >= 0x0020)
1372 return 1;
1373 return 0;
1374}
1375
1da177e4
LT
1376u8 ide_dump_status(ide_drive_t *, const char *, u8);
1377
1378typedef struct ide_pio_timings_s {
1379 int setup_time; /* Address setup (ns) minimum */
1380 int active_time; /* Active pulse (ns) minimum */
81d368e0
SS
1381 int cycle_time; /* Cycle time (ns) minimum = */
1382 /* active + recovery (+ setup for some chips) */
1da177e4
LT
1383} ide_pio_timings_t;
1384
7dd00083 1385unsigned int ide_pio_cycle_time(ide_drive_t *, u8);
2134758d 1386u8 ide_get_best_pio_mode(ide_drive_t *, u8, u8);
1da177e4
LT
1387extern const ide_pio_timings_t ide_pio_timings[6];
1388
88b2b32b
BZ
1389int ide_set_pio_mode(ide_drive_t *, u8);
1390int ide_set_dma_mode(ide_drive_t *, u8);
1391
26bcb879
BZ
1392void ide_set_pio(ide_drive_t *, u8);
1393
1394static inline void ide_set_max_pio(ide_drive_t *drive)
1395{
1396 ide_set_pio(drive, 255);
1397}
1da177e4
LT
1398
1399extern spinlock_t ide_lock;
ef29888e 1400extern struct mutex ide_cfg_mtx;
1da177e4
LT
1401/*
1402 * Structure locking:
1403 *
ef29888e 1404 * ide_cfg_mtx and ide_lock together protect changes to
1da177e4
LT
1405 * ide_hwif_t->{next,hwgroup}
1406 * ide_drive_t->next
1407 *
1408 * ide_hwgroup_t->busy: ide_lock
1409 * ide_hwgroup_t->hwif: ide_lock
1410 * ide_hwif_t->mate: constant, no locking
1411 * ide_drive_t->hwif: constant, no locking
1412 */
1413
366c7f55 1414#define local_irq_set(flags) do { local_save_flags((flags)); local_irq_enable_in_hardirq(); } while (0)
1da177e4
LT
1415
1416extern struct bus_type ide_bus_type;
1417
1418/* check if CACHE FLUSH (EXT) command is supported (bits defined in ATA-6) */
1419#define ide_id_has_flush_cache(id) ((id)->cfs_enable_2 & 0x3000)
1420
1421/* some Maxtor disks have bit 13 defined incorrectly so check bit 10 too */
1422#define ide_id_has_flush_cache_ext(id) \
1423 (((id)->cfs_enable_2 & 0x2400) == 0x2400)
1424
86b37860
CL
1425static inline int hwif_to_node(ide_hwif_t *hwif)
1426{
1427 struct pci_dev *dev = hwif->pci_dev;
1428 return dev ? pcibus_to_node(dev->bus) : -1;
1429}
1430
1b678347
BH
1431static inline ide_drive_t *ide_get_paired_drive(ide_drive_t *drive)
1432{
1433 ide_hwif_t *hwif = HWIF(drive);
1434
1435 return &hwif->drives[(drive->dn ^ 1) & 1];
1436}
1437
1da177e4 1438#endif /* _IDE_H */
This page took 0.442427 seconds and 5 git commands to generate.