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