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