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