4cd7157a403f2d6993ebbc22162c96d7a03fdcaa
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / include / linux / ide.h
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/init.h>
10 #include <linux/ioport.h>
11 #include <linux/ata.h>
12 #include <linux/blkdev.h>
13 #include <linux/proc_fs.h>
14 #include <linux/interrupt.h>
15 #include <linux/bitops.h>
16 #include <linux/bio.h>
17 #include <linux/device.h>
18 #include <linux/pci.h>
19 #include <linux/completion.h>
20 #include <linux/pm.h>
21 #ifdef CONFIG_BLK_DEV_IDEACPI
22 #include <acpi/acpi.h>
23 #endif
24 #include <asm/byteorder.h>
25 #include <asm/system.h>
26 #include <asm/io.h>
27 #include <asm/mutex.h>
28
29 /* for request_sense */
30 #include <linux/cdrom.h>
31
32 #if defined(CONFIG_CRIS) || defined(CONFIG_FRV) || defined(CONFIG_MN10300)
33 # define SUPPORT_VLB_SYNC 0
34 #else
35 # define SUPPORT_VLB_SYNC 1
36 #endif
37
38 /*
39 * Probably not wise to fiddle with these
40 */
41 #define IDE_DEFAULT_MAX_FAILURES 1
42 #define ERROR_MAX 8 /* Max read/write errors per sector */
43 #define ERROR_RESET 3 /* Reset controller every 4th retry */
44 #define ERROR_RECAL 1 /* Recalibrate every 2nd retry */
45
46 /* Error codes returned in rq->errors to the higher part of the driver. */
47 enum {
48 IDE_DRV_ERROR_GENERAL = 101,
49 IDE_DRV_ERROR_FILEMARK = 102,
50 IDE_DRV_ERROR_EOD = 103,
51 };
52
53 /*
54 * Definitions for accessing IDE controller registers
55 */
56 #define IDE_NR_PORTS (10)
57
58 struct ide_io_ports {
59 unsigned long data_addr;
60
61 union {
62 unsigned long error_addr; /* read: error */
63 unsigned long feature_addr; /* write: feature */
64 };
65
66 unsigned long nsect_addr;
67 unsigned long lbal_addr;
68 unsigned long lbam_addr;
69 unsigned long lbah_addr;
70
71 unsigned long device_addr;
72
73 union {
74 unsigned long status_addr; /*  read: status  */
75 unsigned long command_addr; /* write: command */
76 };
77
78 unsigned long ctl_addr;
79
80 unsigned long irq_addr;
81 };
82
83 #define OK_STAT(stat,good,bad) (((stat)&((good)|(bad)))==(good))
84
85 #define BAD_R_STAT (ATA_BUSY | ATA_ERR)
86 #define BAD_W_STAT (BAD_R_STAT | ATA_DF)
87 #define BAD_STAT (BAD_R_STAT | ATA_DRQ)
88 #define DRIVE_READY (ATA_DRDY | ATA_DSC)
89
90 #define BAD_CRC (ATA_ABORTED | ATA_ICRC)
91
92 #define SATA_NR_PORTS (3) /* 16 possible ?? */
93
94 #define SATA_STATUS_OFFSET (0)
95 #define SATA_ERROR_OFFSET (1)
96 #define SATA_CONTROL_OFFSET (2)
97
98 /*
99 * Our Physical Region Descriptor (PRD) table should be large enough
100 * to handle the biggest I/O request we are likely to see. Since requests
101 * can have no more than 256 sectors, and since the typical blocksize is
102 * two or more sectors, we could get by with a limit of 128 entries here for
103 * the usual worst case. Most requests seem to include some contiguous blocks,
104 * further reducing the number of table entries required.
105 *
106 * The driver reverts to PIO mode for individual requests that exceed
107 * this limit (possible with 512 byte blocksizes, eg. MSDOS f/s), so handling
108 * 100% of all crazy scenarios here is not necessary.
109 *
110 * As it turns out though, we must allocate a full 4KB page for this,
111 * so the two PRD tables (ide0 & ide1) will each get half of that,
112 * allowing each to have about 256 entries (8 bytes each) from this.
113 */
114 #define PRD_BYTES 8
115 #define PRD_ENTRIES 256
116
117 /*
118 * Some more useful definitions
119 */
120 #define PARTN_BITS 6 /* number of minor dev bits for partitions */
121 #define MAX_DRIVES 2 /* per interface; 2 assumed by lots of code */
122 #define SECTOR_SIZE 512
123
124 /*
125 * Timeouts for various operations:
126 */
127 enum {
128 /* spec allows up to 20ms */
129 WAIT_DRQ = HZ / 10, /* 100ms */
130 /* some laptops are very slow */
131 WAIT_READY = 5 * HZ, /* 5s */
132 /* should be less than 3ms (?), if all ATAPI CD is closed at boot */
133 WAIT_PIDENTIFY = 10 * HZ, /* 10s */
134 /* worst case when spinning up */
135 WAIT_WORSTCASE = 30 * HZ, /* 30s */
136 /* maximum wait for an IRQ to happen */
137 WAIT_CMD = 10 * HZ, /* 10s */
138 /* Some drives require a longer IRQ timeout. */
139 WAIT_FLOPPY_CMD = 50 * HZ, /* 50s */
140 /*
141 * Some drives (for example, Seagate STT3401A Travan) require a very
142 * long timeout, because they don't return an interrupt or clear their
143 * BSY bit until after the command completes (even retension commands).
144 */
145 WAIT_TAPE_CMD = 900 * HZ, /* 900s */
146 /* minimum sleep time */
147 WAIT_MIN_SLEEP = HZ / 50, /* 20ms */
148 };
149
150 /*
151 * Op codes for special requests to be handled by ide_special_rq().
152 * Values should be in the range of 0x20 to 0x3f.
153 */
154 #define REQ_DRIVE_RESET 0x20
155 #define REQ_DEVSET_EXEC 0x21
156 #define REQ_PARK_HEADS 0x22
157 #define REQ_UNPARK_HEADS 0x23
158
159 /*
160 * Check for an interrupt and acknowledge the interrupt status
161 */
162 struct hwif_s;
163 typedef int (ide_ack_intr_t)(struct hwif_s *);
164
165 /*
166 * hwif_chipset_t is used to keep track of the specific hardware
167 * chipset used by each IDE interface, if known.
168 */
169 enum { ide_unknown, ide_generic, ide_pci,
170 ide_cmd640, ide_dtc2278, ide_ali14xx,
171 ide_qd65xx, ide_umc8672, ide_ht6560b,
172 ide_4drives, ide_pmac, ide_acorn,
173 ide_au1xxx, ide_palm3710
174 };
175
176 typedef u8 hwif_chipset_t;
177
178 /*
179 * Structure to hold all information about the location of this port
180 */
181 typedef struct hw_regs_s {
182 union {
183 struct ide_io_ports io_ports;
184 unsigned long io_ports_array[IDE_NR_PORTS];
185 };
186
187 int irq; /* our irq number */
188 ide_ack_intr_t *ack_intr; /* acknowledge interrupt */
189 hwif_chipset_t chipset;
190 struct device *dev, *parent;
191 unsigned long config;
192 } hw_regs_t;
193
194 static inline void ide_std_init_ports(hw_regs_t *hw,
195 unsigned long io_addr,
196 unsigned long ctl_addr)
197 {
198 unsigned int i;
199
200 for (i = 0; i <= 7; i++)
201 hw->io_ports_array[i] = io_addr++;
202
203 hw->io_ports.ctl_addr = ctl_addr;
204 }
205
206 #define MAX_HWIFS 10
207
208 /*
209 * Now for the data we need to maintain per-drive: ide_drive_t
210 */
211
212 #define ide_scsi 0x21
213 #define ide_disk 0x20
214 #define ide_optical 0x7
215 #define ide_cdrom 0x5
216 #define ide_tape 0x1
217 #define ide_floppy 0x0
218
219 /*
220 * Special Driver Flags
221 *
222 * set_geometry : respecify drive geometry
223 * recalibrate : seek to cyl 0
224 * set_multmode : set multmode count
225 * reserved : unused
226 */
227 typedef union {
228 unsigned all : 8;
229 struct {
230 unsigned set_geometry : 1;
231 unsigned recalibrate : 1;
232 unsigned set_multmode : 1;
233 unsigned reserved : 5;
234 } b;
235 } special_t;
236
237 /*
238 * Status returned from various ide_ functions
239 */
240 typedef enum {
241 ide_stopped, /* no drive operation was started */
242 ide_started, /* a drive operation was started, handler was set */
243 } ide_startstop_t;
244
245 enum {
246 IDE_VALID_ERROR = (1 << 1),
247 IDE_VALID_FEATURE = IDE_VALID_ERROR,
248 IDE_VALID_NSECT = (1 << 2),
249 IDE_VALID_LBAL = (1 << 3),
250 IDE_VALID_LBAM = (1 << 4),
251 IDE_VALID_LBAH = (1 << 5),
252 IDE_VALID_DEVICE = (1 << 6),
253 IDE_VALID_LBA = IDE_VALID_LBAL |
254 IDE_VALID_LBAM |
255 IDE_VALID_LBAH,
256 IDE_VALID_OUT_TF = IDE_VALID_FEATURE |
257 IDE_VALID_NSECT |
258 IDE_VALID_LBA,
259 IDE_VALID_IN_TF = IDE_VALID_NSECT |
260 IDE_VALID_LBA,
261 IDE_VALID_OUT_HOB = IDE_VALID_OUT_TF,
262 IDE_VALID_IN_HOB = IDE_VALID_ERROR |
263 IDE_VALID_NSECT |
264 IDE_VALID_LBA,
265 };
266
267 enum {
268 IDE_TFLAG_LBA48 = (1 << 0),
269 IDE_TFLAG_WRITE = (1 << 1),
270 IDE_TFLAG_CUSTOM_HANDLER = (1 << 2),
271 IDE_TFLAG_DMA_PIO_FALLBACK = (1 << 3),
272 /* force 16-bit I/O operations */
273 IDE_TFLAG_IO_16BIT = (1 << 4),
274 /* struct ide_cmd was allocated using kmalloc() */
275 IDE_TFLAG_DYN = (1 << 5),
276 IDE_TFLAG_FS = (1 << 6),
277 IDE_TFLAG_MULTI_PIO = (1 << 7),
278 };
279
280 enum {
281 IDE_FTFLAG_FLAGGED = (1 << 0),
282 IDE_FTFLAG_SET_IN_FLAGS = (1 << 1),
283 IDE_FTFLAG_OUT_DATA = (1 << 2),
284 IDE_FTFLAG_IN_DATA = (1 << 3),
285 };
286
287 struct ide_taskfile {
288 u8 data; /* 0: data byte (for TASKFILE ioctl) */
289 union { /* 1: */
290 u8 error; /* read: error */
291 u8 feature; /* write: feature */
292 };
293 u8 nsect; /* 2: number of sectors */
294 u8 lbal; /* 3: LBA low */
295 u8 lbam; /* 4: LBA mid */
296 u8 lbah; /* 5: LBA high */
297 u8 device; /* 6: device select */
298 union { /* 7: */
299 u8 status; /* read: status */
300 u8 command; /* write: command */
301 };
302 };
303
304 struct ide_cmd {
305 struct ide_taskfile tf;
306 struct ide_taskfile hob;
307 struct {
308 struct {
309 u8 tf;
310 u8 hob;
311 } out, in;
312 } valid;
313
314 u8 tf_flags;
315 u8 ftf_flags; /* for TASKFILE ioctl */
316 int protocol;
317
318 int sg_nents; /* number of sg entries */
319 int orig_sg_nents;
320 int sg_dma_direction; /* DMA transfer direction */
321
322 unsigned int nbytes;
323 unsigned int nleft;
324 unsigned int last_xfer_len;
325
326 struct scatterlist *cursg;
327 unsigned int cursg_ofs;
328
329 struct request *rq; /* copy of request */
330 };
331
332 /* ATAPI packet command flags */
333 enum {
334 /* set when an error is considered normal - no retry (ide-tape) */
335 PC_FLAG_ABORT = (1 << 0),
336 PC_FLAG_SUPPRESS_ERROR = (1 << 1),
337 PC_FLAG_WAIT_FOR_DSC = (1 << 2),
338 PC_FLAG_DMA_OK = (1 << 3),
339 PC_FLAG_DMA_IN_PROGRESS = (1 << 4),
340 PC_FLAG_DMA_ERROR = (1 << 5),
341 PC_FLAG_WRITING = (1 << 6),
342 };
343
344 /*
345 * With each packet command, we allocate a buffer of IDE_PC_BUFFER_SIZE bytes.
346 * This is used for several packet commands (not for READ/WRITE commands).
347 */
348 #define IDE_PC_BUFFER_SIZE 64
349 #define ATAPI_WAIT_PC (60 * HZ)
350
351 struct ide_atapi_pc {
352 /* actual packet bytes */
353 u8 c[12];
354 /* incremented on each retry */
355 int retries;
356 int error;
357
358 /* bytes to transfer */
359 int req_xfer;
360
361 /* data buffer */
362 u8 *buf;
363 int buf_size;
364
365 /* the corresponding request */
366 struct request *rq;
367
368 unsigned long flags;
369
370 /*
371 * those are more or less driver-specific and some of them are subject
372 * to change/removal later.
373 */
374 u8 pc_buf[IDE_PC_BUFFER_SIZE];
375
376 unsigned long timeout;
377 };
378
379 struct ide_devset;
380 struct ide_driver;
381
382 #ifdef CONFIG_BLK_DEV_IDEACPI
383 struct ide_acpi_drive_link;
384 struct ide_acpi_hwif_link;
385 #endif
386
387 struct ide_drive_s;
388
389 struct ide_disk_ops {
390 int (*check)(struct ide_drive_s *, const char *);
391 int (*get_capacity)(struct ide_drive_s *);
392 void (*setup)(struct ide_drive_s *);
393 void (*flush)(struct ide_drive_s *);
394 int (*init_media)(struct ide_drive_s *, struct gendisk *);
395 int (*set_doorlock)(struct ide_drive_s *, struct gendisk *,
396 int);
397 ide_startstop_t (*do_request)(struct ide_drive_s *, struct request *,
398 sector_t);
399 int (*ioctl)(struct ide_drive_s *, struct block_device *,
400 fmode_t, unsigned int, unsigned long);
401 };
402
403 /* ATAPI device flags */
404 enum {
405 IDE_AFLAG_DRQ_INTERRUPT = (1 << 0),
406
407 /* ide-cd */
408 /* Drive cannot eject the disc. */
409 IDE_AFLAG_NO_EJECT = (1 << 1),
410 /* Drive is a pre ATAPI 1.2 drive. */
411 IDE_AFLAG_PRE_ATAPI12 = (1 << 2),
412 /* TOC addresses are in BCD. */
413 IDE_AFLAG_TOCADDR_AS_BCD = (1 << 3),
414 /* TOC track numbers are in BCD. */
415 IDE_AFLAG_TOCTRACKS_AS_BCD = (1 << 4),
416 /* Saved TOC information is current. */
417 IDE_AFLAG_TOC_VALID = (1 << 6),
418 /* We think that the drive door is locked. */
419 IDE_AFLAG_DOOR_LOCKED = (1 << 7),
420 /* SET_CD_SPEED command is unsupported. */
421 IDE_AFLAG_NO_SPEED_SELECT = (1 << 8),
422 IDE_AFLAG_VERTOS_300_SSD = (1 << 9),
423 IDE_AFLAG_VERTOS_600_ESD = (1 << 10),
424 IDE_AFLAG_SANYO_3CD = (1 << 11),
425 IDE_AFLAG_FULL_CAPS_PAGE = (1 << 12),
426 IDE_AFLAG_PLAY_AUDIO_OK = (1 << 13),
427 IDE_AFLAG_LE_SPEED_FIELDS = (1 << 14),
428
429 /* ide-floppy */
430 /* Avoid commands not supported in Clik drive */
431 IDE_AFLAG_CLIK_DRIVE = (1 << 15),
432 /* Requires BH algorithm for packets */
433 IDE_AFLAG_ZIP_DRIVE = (1 << 16),
434 /* Supports format progress report */
435 IDE_AFLAG_SRFP = (1 << 17),
436
437 /* ide-tape */
438 IDE_AFLAG_IGNORE_DSC = (1 << 18),
439 /* 0 When the tape position is unknown */
440 IDE_AFLAG_ADDRESS_VALID = (1 << 19),
441 /* Device already opened */
442 IDE_AFLAG_BUSY = (1 << 20),
443 /* Attempt to auto-detect the current user block size */
444 IDE_AFLAG_DETECT_BS = (1 << 21),
445 /* Currently on a filemark */
446 IDE_AFLAG_FILEMARK = (1 << 22),
447 /* 0 = no tape is loaded, so we don't rewind after ejecting */
448 IDE_AFLAG_MEDIUM_PRESENT = (1 << 23),
449
450 IDE_AFLAG_NO_AUTOCLOSE = (1 << 24),
451 };
452
453 /* device flags */
454 enum {
455 /* restore settings after device reset */
456 IDE_DFLAG_KEEP_SETTINGS = (1 << 0),
457 /* device is using DMA for read/write */
458 IDE_DFLAG_USING_DMA = (1 << 1),
459 /* okay to unmask other IRQs */
460 IDE_DFLAG_UNMASK = (1 << 2),
461 /* don't attempt flushes */
462 IDE_DFLAG_NOFLUSH = (1 << 3),
463 /* DSC overlap */
464 IDE_DFLAG_DSC_OVERLAP = (1 << 4),
465 /* give potential excess bandwidth */
466 IDE_DFLAG_NICE1 = (1 << 5),
467 /* device is physically present */
468 IDE_DFLAG_PRESENT = (1 << 6),
469 /* id read from device (synthetic if not set) */
470 IDE_DFLAG_ID_READ = (1 << 8),
471 IDE_DFLAG_NOPROBE = (1 << 9),
472 /* need to do check_media_change() */
473 IDE_DFLAG_REMOVABLE = (1 << 10),
474 /* needed for removable devices */
475 IDE_DFLAG_ATTACH = (1 << 11),
476 IDE_DFLAG_FORCED_GEOM = (1 << 12),
477 /* disallow setting unmask bit */
478 IDE_DFLAG_NO_UNMASK = (1 << 13),
479 /* disallow enabling 32-bit I/O */
480 IDE_DFLAG_NO_IO_32BIT = (1 << 14),
481 /* for removable only: door lock/unlock works */
482 IDE_DFLAG_DOORLOCKING = (1 << 15),
483 /* disallow DMA */
484 IDE_DFLAG_NODMA = (1 << 16),
485 /* powermanagment told us not to do anything, so sleep nicely */
486 IDE_DFLAG_BLOCKED = (1 << 17),
487 /* sleeping & sleep field valid */
488 IDE_DFLAG_SLEEPING = (1 << 18),
489 IDE_DFLAG_POST_RESET = (1 << 19),
490 IDE_DFLAG_UDMA33_WARNED = (1 << 20),
491 IDE_DFLAG_LBA48 = (1 << 21),
492 /* status of write cache */
493 IDE_DFLAG_WCACHE = (1 << 22),
494 /* used for ignoring ATA_DF */
495 IDE_DFLAG_NOWERR = (1 << 23),
496 /* retrying in PIO */
497 IDE_DFLAG_DMA_PIO_RETRY = (1 << 24),
498 IDE_DFLAG_LBA = (1 << 25),
499 /* don't unload heads */
500 IDE_DFLAG_NO_UNLOAD = (1 << 26),
501 /* heads unloaded, please don't reset port */
502 IDE_DFLAG_PARKED = (1 << 27),
503 IDE_DFLAG_MEDIA_CHANGED = (1 << 28),
504 /* write protect */
505 IDE_DFLAG_WP = (1 << 29),
506 IDE_DFLAG_FORMAT_IN_PROGRESS = (1 << 30),
507 };
508
509 struct ide_drive_s {
510 char name[4]; /* drive name, such as "hda" */
511 char driver_req[10]; /* requests specific driver */
512
513 struct request_queue *queue; /* request queue */
514
515 struct request *rq; /* current request */
516 void *driver_data; /* extra driver data */
517 u16 *id; /* identification info */
518 #ifdef CONFIG_IDE_PROC_FS
519 struct proc_dir_entry *proc; /* /proc/ide/ directory entry */
520 const struct ide_proc_devset *settings; /* /proc/ide/ drive settings */
521 #endif
522 struct hwif_s *hwif; /* actually (ide_hwif_t *) */
523
524 const struct ide_disk_ops *disk_ops;
525
526 unsigned long dev_flags;
527
528 unsigned long sleep; /* sleep until this time */
529 unsigned long timeout; /* max time to wait for irq */
530
531 special_t special; /* special action flags */
532
533 u8 select; /* basic drive/head select reg value */
534 u8 retry_pio; /* retrying dma capable host in pio */
535 u8 waiting_for_dma; /* dma currently in progress */
536 u8 dma; /* atapi dma flag */
537
538 u8 quirk_list; /* considered quirky, set for a specific host */
539 u8 init_speed; /* transfer rate set at boot */
540 u8 current_speed; /* current transfer rate set */
541 u8 desired_speed; /* desired transfer rate set */
542 u8 dn; /* now wide spread use */
543 u8 acoustic; /* acoustic management */
544 u8 media; /* disk, cdrom, tape, floppy, ... */
545 u8 ready_stat; /* min status value for drive ready */
546 u8 mult_count; /* current multiple sector setting */
547 u8 mult_req; /* requested multiple sector setting */
548 u8 io_32bit; /* 0=16-bit, 1=32-bit, 2/3=32bit+sync */
549 u8 bad_wstat; /* used for ignoring ATA_DF */
550 u8 head; /* "real" number of heads */
551 u8 sect; /* "real" sectors per track */
552 u8 bios_head; /* BIOS/fdisk/LILO number of heads */
553 u8 bios_sect; /* BIOS/fdisk/LILO sectors per track */
554
555 /* delay this long before sending packet command */
556 u8 pc_delay;
557
558 unsigned int bios_cyl; /* BIOS/fdisk/LILO number of cyls */
559 unsigned int cyl; /* "real" number of cyls */
560 unsigned int drive_data; /* used by set_pio_mode/dev_select() */
561 unsigned int failures; /* current failure count */
562 unsigned int max_failures; /* maximum allowed failure count */
563 u64 probed_capacity;/* initial reported media capacity (ide-cd only currently) */
564
565 u64 capacity64; /* total number of sectors */
566
567 int lun; /* logical unit */
568 int crc_count; /* crc counter to reduce drive speed */
569
570 unsigned long debug_mask; /* debugging levels switch */
571
572 #ifdef CONFIG_BLK_DEV_IDEACPI
573 struct ide_acpi_drive_link *acpidata;
574 #endif
575 struct list_head list;
576 struct device gendev;
577 struct completion gendev_rel_comp; /* to deal with device release() */
578
579 /* current packet command */
580 struct ide_atapi_pc *pc;
581
582 /* last failed packet command */
583 struct ide_atapi_pc *failed_pc;
584
585 /* callback for packet commands */
586 int (*pc_callback)(struct ide_drive_s *, int);
587
588 ide_startstop_t (*irq_handler)(struct ide_drive_s *);
589
590 unsigned long atapi_flags;
591
592 struct ide_atapi_pc request_sense_pc;
593
594 /* current sense rq and buffer */
595 bool sense_rq_armed;
596 struct request sense_rq;
597 struct request_sense sense_data;
598 };
599
600 typedef struct ide_drive_s ide_drive_t;
601
602 #define to_ide_device(dev) container_of(dev, ide_drive_t, gendev)
603
604 #define to_ide_drv(obj, cont_type) \
605 container_of(obj, struct cont_type, dev)
606
607 #define ide_drv_g(disk, cont_type) \
608 container_of((disk)->private_data, struct cont_type, driver)
609
610 struct ide_port_info;
611
612 struct ide_tp_ops {
613 void (*exec_command)(struct hwif_s *, u8);
614 u8 (*read_status)(struct hwif_s *);
615 u8 (*read_altstatus)(struct hwif_s *);
616 void (*write_devctl)(struct hwif_s *, u8);
617
618 void (*dev_select)(ide_drive_t *);
619 void (*tf_load)(ide_drive_t *, struct ide_taskfile *, u8);
620 void (*tf_read)(ide_drive_t *, struct ide_taskfile *, u8);
621
622 void (*input_data)(ide_drive_t *, struct ide_cmd *,
623 void *, unsigned int);
624 void (*output_data)(ide_drive_t *, struct ide_cmd *,
625 void *, unsigned int);
626 };
627
628 extern const struct ide_tp_ops default_tp_ops;
629
630 /**
631 * struct ide_port_ops - IDE port operations
632 *
633 * @init_dev: host specific initialization of a device
634 * @set_pio_mode: routine to program host for PIO mode
635 * @set_dma_mode: routine to program host for DMA mode
636 * @reset_poll: chipset polling based on hba specifics
637 * @pre_reset: chipset specific changes to default for device-hba resets
638 * @resetproc: routine to reset controller after a disk reset
639 * @maskproc: special host masking for drive selection
640 * @quirkproc: check host's drive quirk list
641 * @clear_irq: clear IRQ
642 *
643 * @mdma_filter: filter MDMA modes
644 * @udma_filter: filter UDMA modes
645 *
646 * @cable_detect: detect cable type
647 */
648 struct ide_port_ops {
649 void (*init_dev)(ide_drive_t *);
650 void (*set_pio_mode)(ide_drive_t *, const u8);
651 void (*set_dma_mode)(ide_drive_t *, const u8);
652 int (*reset_poll)(ide_drive_t *);
653 void (*pre_reset)(ide_drive_t *);
654 void (*resetproc)(ide_drive_t *);
655 void (*maskproc)(ide_drive_t *, int);
656 void (*quirkproc)(ide_drive_t *);
657 void (*clear_irq)(ide_drive_t *);
658
659 u8 (*mdma_filter)(ide_drive_t *);
660 u8 (*udma_filter)(ide_drive_t *);
661
662 u8 (*cable_detect)(struct hwif_s *);
663 };
664
665 struct ide_dma_ops {
666 void (*dma_host_set)(struct ide_drive_s *, int);
667 int (*dma_setup)(struct ide_drive_s *, struct ide_cmd *);
668 void (*dma_start)(struct ide_drive_s *);
669 int (*dma_end)(struct ide_drive_s *);
670 int (*dma_test_irq)(struct ide_drive_s *);
671 void (*dma_lost_irq)(struct ide_drive_s *);
672 /* below ones are optional */
673 int (*dma_check)(struct ide_drive_s *, struct ide_cmd *);
674 int (*dma_timer_expiry)(struct ide_drive_s *);
675 void (*dma_clear)(struct ide_drive_s *);
676 /*
677 * The following method is optional and only required to be
678 * implemented for the SFF-8038i compatible controllers.
679 */
680 u8 (*dma_sff_read_status)(struct hwif_s *);
681 };
682
683 struct ide_host;
684
685 typedef struct hwif_s {
686 struct hwif_s *mate; /* other hwif from same PCI chip */
687 struct proc_dir_entry *proc; /* /proc/ide/ directory entry */
688
689 struct ide_host *host;
690
691 char name[6]; /* name of interface, eg. "ide0" */
692
693 struct ide_io_ports io_ports;
694
695 unsigned long sata_scr[SATA_NR_PORTS];
696
697 ide_drive_t *devices[MAX_DRIVES + 1];
698
699 u8 major; /* our major number */
700 u8 index; /* 0 for ide0; 1 for ide1; ... */
701 u8 channel; /* for dual-port chips: 0=primary, 1=secondary */
702
703 u32 host_flags;
704
705 u8 pio_mask;
706
707 u8 ultra_mask;
708 u8 mwdma_mask;
709 u8 swdma_mask;
710
711 u8 cbl; /* cable type */
712
713 hwif_chipset_t chipset; /* sub-module for tuning.. */
714
715 struct device *dev;
716
717 ide_ack_intr_t *ack_intr;
718
719 void (*rw_disk)(ide_drive_t *, struct request *);
720
721 const struct ide_tp_ops *tp_ops;
722 const struct ide_port_ops *port_ops;
723 const struct ide_dma_ops *dma_ops;
724
725 /* dma physical region descriptor table (cpu view) */
726 unsigned int *dmatable_cpu;
727 /* dma physical region descriptor table (dma view) */
728 dma_addr_t dmatable_dma;
729
730 /* maximum number of PRD table entries */
731 int prd_max_nents;
732 /* PRD entry size in bytes */
733 int prd_ent_size;
734
735 /* Scatter-gather list used to build the above */
736 struct scatterlist *sg_table;
737 int sg_max_nents; /* Maximum number of entries in it */
738
739 struct ide_cmd cmd; /* current command */
740
741 int rqsize; /* max sectors per request */
742 int irq; /* our irq number */
743
744 unsigned long dma_base; /* base addr for dma ports */
745
746 unsigned long config_data; /* for use by chipset-specific code */
747 unsigned long select_data; /* for use by chipset-specific code */
748
749 unsigned long extra_base; /* extra addr for dma ports */
750 unsigned extra_ports; /* number of extra dma ports */
751
752 unsigned present : 1; /* this interface exists */
753 unsigned busy : 1; /* serializes devices on a port */
754
755 struct device gendev;
756 struct device *portdev;
757
758 struct completion gendev_rel_comp; /* To deal with device release() */
759
760 void *hwif_data; /* extra hwif data */
761
762 #ifdef CONFIG_BLK_DEV_IDEACPI
763 struct ide_acpi_hwif_link *acpidata;
764 #endif
765
766 /* IRQ handler, if active */
767 ide_startstop_t (*handler)(ide_drive_t *);
768
769 /* BOOL: polling active & poll_timeout field valid */
770 unsigned int polling : 1;
771
772 /* current drive */
773 ide_drive_t *cur_dev;
774
775 /* current request */
776 struct request *rq;
777
778 /* failsafe timer */
779 struct timer_list timer;
780 /* timeout value during long polls */
781 unsigned long poll_timeout;
782 /* queried upon timeouts */
783 int (*expiry)(ide_drive_t *);
784
785 int req_gen;
786 int req_gen_timer;
787
788 spinlock_t lock;
789 } ____cacheline_internodealigned_in_smp ide_hwif_t;
790
791 #define MAX_HOST_PORTS 4
792
793 struct ide_host {
794 ide_hwif_t *ports[MAX_HOST_PORTS + 1];
795 unsigned int n_ports;
796 struct device *dev[2];
797
798 int (*init_chipset)(struct pci_dev *);
799
800 void (*get_lock)(irq_handler_t, void *);
801 void (*release_lock)(void);
802
803 irq_handler_t irq_handler;
804
805 unsigned long host_flags;
806
807 int irq_flags;
808
809 void *host_priv;
810 ide_hwif_t *cur_port; /* for hosts requiring serialization */
811
812 /* used for hosts requiring serialization */
813 volatile unsigned long host_busy;
814 };
815
816 #define IDE_HOST_BUSY 0
817
818 /*
819 * internal ide interrupt handler type
820 */
821 typedef ide_startstop_t (ide_handler_t)(ide_drive_t *);
822 typedef int (ide_expiry_t)(ide_drive_t *);
823
824 /* used by ide-cd, ide-floppy, etc. */
825 typedef void (xfer_func_t)(ide_drive_t *, struct ide_cmd *, void *, unsigned);
826
827 extern struct mutex ide_setting_mtx;
828
829 /*
830 * configurable drive settings
831 */
832
833 #define DS_SYNC (1 << 0)
834
835 struct ide_devset {
836 int (*get)(ide_drive_t *);
837 int (*set)(ide_drive_t *, int);
838 unsigned int flags;
839 };
840
841 #define __DEVSET(_flags, _get, _set) { \
842 .flags = _flags, \
843 .get = _get, \
844 .set = _set, \
845 }
846
847 #define ide_devset_get(name, field) \
848 static int get_##name(ide_drive_t *drive) \
849 { \
850 return drive->field; \
851 }
852
853 #define ide_devset_set(name, field) \
854 static int set_##name(ide_drive_t *drive, int arg) \
855 { \
856 drive->field = arg; \
857 return 0; \
858 }
859
860 #define ide_devset_get_flag(name, flag) \
861 static int get_##name(ide_drive_t *drive) \
862 { \
863 return !!(drive->dev_flags & flag); \
864 }
865
866 #define ide_devset_set_flag(name, flag) \
867 static int set_##name(ide_drive_t *drive, int arg) \
868 { \
869 if (arg) \
870 drive->dev_flags |= flag; \
871 else \
872 drive->dev_flags &= ~flag; \
873 return 0; \
874 }
875
876 #define __IDE_DEVSET(_name, _flags, _get, _set) \
877 const struct ide_devset ide_devset_##_name = \
878 __DEVSET(_flags, _get, _set)
879
880 #define IDE_DEVSET(_name, _flags, _get, _set) \
881 static __IDE_DEVSET(_name, _flags, _get, _set)
882
883 #define ide_devset_rw(_name, _func) \
884 IDE_DEVSET(_name, 0, get_##_func, set_##_func)
885
886 #define ide_devset_w(_name, _func) \
887 IDE_DEVSET(_name, 0, NULL, set_##_func)
888
889 #define ide_ext_devset_rw(_name, _func) \
890 __IDE_DEVSET(_name, 0, get_##_func, set_##_func)
891
892 #define ide_ext_devset_rw_sync(_name, _func) \
893 __IDE_DEVSET(_name, DS_SYNC, get_##_func, set_##_func)
894
895 #define ide_decl_devset(_name) \
896 extern const struct ide_devset ide_devset_##_name
897
898 ide_decl_devset(io_32bit);
899 ide_decl_devset(keepsettings);
900 ide_decl_devset(pio_mode);
901 ide_decl_devset(unmaskirq);
902 ide_decl_devset(using_dma);
903
904 #ifdef CONFIG_IDE_PROC_FS
905 /*
906 * /proc/ide interface
907 */
908
909 #define ide_devset_rw_field(_name, _field) \
910 ide_devset_get(_name, _field); \
911 ide_devset_set(_name, _field); \
912 IDE_DEVSET(_name, DS_SYNC, get_##_name, set_##_name)
913
914 #define ide_devset_rw_flag(_name, _field) \
915 ide_devset_get_flag(_name, _field); \
916 ide_devset_set_flag(_name, _field); \
917 IDE_DEVSET(_name, DS_SYNC, get_##_name, set_##_name)
918
919 struct ide_proc_devset {
920 const char *name;
921 const struct ide_devset *setting;
922 int min, max;
923 int (*mulf)(ide_drive_t *);
924 int (*divf)(ide_drive_t *);
925 };
926
927 #define __IDE_PROC_DEVSET(_name, _min, _max, _mulf, _divf) { \
928 .name = __stringify(_name), \
929 .setting = &ide_devset_##_name, \
930 .min = _min, \
931 .max = _max, \
932 .mulf = _mulf, \
933 .divf = _divf, \
934 }
935
936 #define IDE_PROC_DEVSET(_name, _min, _max) \
937 __IDE_PROC_DEVSET(_name, _min, _max, NULL, NULL)
938
939 typedef struct {
940 const char *name;
941 mode_t mode;
942 read_proc_t *read_proc;
943 write_proc_t *write_proc;
944 } ide_proc_entry_t;
945
946 void proc_ide_create(void);
947 void proc_ide_destroy(void);
948 void ide_proc_register_port(ide_hwif_t *);
949 void ide_proc_port_register_devices(ide_hwif_t *);
950 void ide_proc_unregister_device(ide_drive_t *);
951 void ide_proc_unregister_port(ide_hwif_t *);
952 void ide_proc_register_driver(ide_drive_t *, struct ide_driver *);
953 void ide_proc_unregister_driver(ide_drive_t *, struct ide_driver *);
954
955 read_proc_t proc_ide_read_capacity;
956 read_proc_t proc_ide_read_geometry;
957
958 /*
959 * Standard exit stuff:
960 */
961 #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) \
962 { \
963 len -= off; \
964 if (len < count) { \
965 *eof = 1; \
966 if (len <= 0) \
967 return 0; \
968 } else \
969 len = count; \
970 *start = page + off; \
971 return len; \
972 }
973 #else
974 static inline void proc_ide_create(void) { ; }
975 static inline void proc_ide_destroy(void) { ; }
976 static inline void ide_proc_register_port(ide_hwif_t *hwif) { ; }
977 static inline void ide_proc_port_register_devices(ide_hwif_t *hwif) { ; }
978 static inline void ide_proc_unregister_device(ide_drive_t *drive) { ; }
979 static inline void ide_proc_unregister_port(ide_hwif_t *hwif) { ; }
980 static inline void ide_proc_register_driver(ide_drive_t *drive,
981 struct ide_driver *driver) { ; }
982 static inline void ide_proc_unregister_driver(ide_drive_t *drive,
983 struct ide_driver *driver) { ; }
984 #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) return 0;
985 #endif
986
987 enum {
988 /* enter/exit functions */
989 IDE_DBG_FUNC = (1 << 0),
990 /* sense key/asc handling */
991 IDE_DBG_SENSE = (1 << 1),
992 /* packet commands handling */
993 IDE_DBG_PC = (1 << 2),
994 /* request handling */
995 IDE_DBG_RQ = (1 << 3),
996 /* driver probing/setup */
997 IDE_DBG_PROBE = (1 << 4),
998 };
999
1000 /* DRV_NAME has to be defined in the driver before using the macro below */
1001 #define __ide_debug_log(lvl, fmt, args...) \
1002 { \
1003 if (unlikely(drive->debug_mask & lvl)) \
1004 printk(KERN_INFO DRV_NAME ": %s: " fmt "\n", \
1005 __func__, ## args); \
1006 }
1007
1008 /*
1009 * Power Management state machine (rq->pm->pm_step).
1010 *
1011 * For each step, the core calls ide_start_power_step() first.
1012 * This can return:
1013 * - ide_stopped : In this case, the core calls us back again unless
1014 * step have been set to ide_power_state_completed.
1015 * - ide_started : In this case, the channel is left busy until an
1016 * async event (interrupt) occurs.
1017 * Typically, ide_start_power_step() will issue a taskfile request with
1018 * do_rw_taskfile().
1019 *
1020 * Upon reception of the interrupt, the core will call ide_complete_power_step()
1021 * with the error code if any. This routine should update the step value
1022 * and return. It should not start a new request. The core will call
1023 * ide_start_power_step() for the new step value, unless step have been
1024 * set to IDE_PM_COMPLETED.
1025 */
1026 enum {
1027 IDE_PM_START_SUSPEND,
1028 IDE_PM_FLUSH_CACHE = IDE_PM_START_SUSPEND,
1029 IDE_PM_STANDBY,
1030
1031 IDE_PM_START_RESUME,
1032 IDE_PM_RESTORE_PIO = IDE_PM_START_RESUME,
1033 IDE_PM_IDLE,
1034 IDE_PM_RESTORE_DMA,
1035
1036 IDE_PM_COMPLETED,
1037 };
1038
1039 int generic_ide_suspend(struct device *, pm_message_t);
1040 int generic_ide_resume(struct device *);
1041
1042 void ide_complete_power_step(ide_drive_t *, struct request *);
1043 ide_startstop_t ide_start_power_step(ide_drive_t *, struct request *);
1044 void ide_complete_pm_rq(ide_drive_t *, struct request *);
1045 void ide_check_pm_state(ide_drive_t *, struct request *);
1046
1047 /*
1048 * Subdrivers support.
1049 *
1050 * The gendriver.owner field should be set to the module owner of this driver.
1051 * The gendriver.name field should be set to the name of this driver
1052 */
1053 struct ide_driver {
1054 const char *version;
1055 ide_startstop_t (*do_request)(ide_drive_t *, struct request *, sector_t);
1056 struct device_driver gen_driver;
1057 int (*probe)(ide_drive_t *);
1058 void (*remove)(ide_drive_t *);
1059 void (*resume)(ide_drive_t *);
1060 void (*shutdown)(ide_drive_t *);
1061 #ifdef CONFIG_IDE_PROC_FS
1062 ide_proc_entry_t * (*proc_entries)(ide_drive_t *);
1063 const struct ide_proc_devset * (*proc_devsets)(ide_drive_t *);
1064 #endif
1065 };
1066
1067 #define to_ide_driver(drv) container_of(drv, struct ide_driver, gen_driver)
1068
1069 int ide_device_get(ide_drive_t *);
1070 void ide_device_put(ide_drive_t *);
1071
1072 struct ide_ioctl_devset {
1073 unsigned int get_ioctl;
1074 unsigned int set_ioctl;
1075 const struct ide_devset *setting;
1076 };
1077
1078 int ide_setting_ioctl(ide_drive_t *, struct block_device *, unsigned int,
1079 unsigned long, const struct ide_ioctl_devset *);
1080
1081 int generic_ide_ioctl(ide_drive_t *, struct block_device *, unsigned, unsigned long);
1082
1083 extern int ide_vlb_clk;
1084 extern int ide_pci_clk;
1085
1086 unsigned int ide_rq_bytes(struct request *);
1087 int ide_end_rq(ide_drive_t *, struct request *, int, unsigned int);
1088 void ide_kill_rq(ide_drive_t *, struct request *);
1089
1090 void __ide_set_handler(ide_drive_t *, ide_handler_t *, unsigned int);
1091 void ide_set_handler(ide_drive_t *, ide_handler_t *, unsigned int);
1092
1093 void ide_execute_command(ide_drive_t *, struct ide_cmd *, ide_handler_t *,
1094 unsigned int);
1095
1096 void ide_pad_transfer(ide_drive_t *, int, int);
1097
1098 ide_startstop_t ide_error(ide_drive_t *, const char *, u8);
1099
1100 void ide_fix_driveid(u16 *);
1101
1102 extern void ide_fixstring(u8 *, const int, const int);
1103
1104 int ide_busy_sleep(ide_hwif_t *, unsigned long, int);
1105
1106 int ide_wait_stat(ide_startstop_t *, ide_drive_t *, u8, u8, unsigned long);
1107
1108 ide_startstop_t ide_do_park_unpark(ide_drive_t *, struct request *);
1109 ide_startstop_t ide_do_devset(ide_drive_t *, struct request *);
1110
1111 extern ide_startstop_t ide_do_reset (ide_drive_t *);
1112
1113 extern int ide_devset_execute(ide_drive_t *drive,
1114 const struct ide_devset *setting, int arg);
1115
1116 void ide_complete_cmd(ide_drive_t *, struct ide_cmd *, u8, u8);
1117 int ide_complete_rq(ide_drive_t *, int, unsigned int);
1118
1119 void ide_tf_readback(ide_drive_t *drive, struct ide_cmd *cmd);
1120 void ide_tf_dump(const char *, struct ide_cmd *);
1121
1122 void ide_exec_command(ide_hwif_t *, u8);
1123 u8 ide_read_status(ide_hwif_t *);
1124 u8 ide_read_altstatus(ide_hwif_t *);
1125 void ide_write_devctl(ide_hwif_t *, u8);
1126
1127 void ide_dev_select(ide_drive_t *);
1128 void ide_tf_load(ide_drive_t *, struct ide_taskfile *, u8);
1129 void ide_tf_read(ide_drive_t *, struct ide_taskfile *, u8);
1130
1131 void ide_input_data(ide_drive_t *, struct ide_cmd *, void *, unsigned int);
1132 void ide_output_data(ide_drive_t *, struct ide_cmd *, void *, unsigned int);
1133
1134 void SELECT_MASK(ide_drive_t *, int);
1135
1136 u8 ide_read_error(ide_drive_t *);
1137 void ide_read_bcount_and_ireason(ide_drive_t *, u16 *, u8 *);
1138
1139 int ide_check_atapi_device(ide_drive_t *, const char *);
1140
1141 void ide_init_pc(struct ide_atapi_pc *);
1142
1143 /* Disk head parking */
1144 extern wait_queue_head_t ide_park_wq;
1145 ssize_t ide_park_show(struct device *dev, struct device_attribute *attr,
1146 char *buf);
1147 ssize_t ide_park_store(struct device *dev, struct device_attribute *attr,
1148 const char *buf, size_t len);
1149
1150 /*
1151 * Special requests for ide-tape block device strategy routine.
1152 *
1153 * In order to service a character device command, we add special requests to
1154 * the tail of our block device request queue and wait for their completion.
1155 */
1156 enum {
1157 REQ_IDETAPE_PC1 = (1 << 0), /* packet command (first stage) */
1158 REQ_IDETAPE_PC2 = (1 << 1), /* packet command (second stage) */
1159 REQ_IDETAPE_READ = (1 << 2),
1160 REQ_IDETAPE_WRITE = (1 << 3),
1161 };
1162
1163 int ide_queue_pc_tail(ide_drive_t *, struct gendisk *, struct ide_atapi_pc *,
1164 void *, unsigned int);
1165
1166 int ide_do_test_unit_ready(ide_drive_t *, struct gendisk *);
1167 int ide_do_start_stop(ide_drive_t *, struct gendisk *, int);
1168 int ide_set_media_lock(ide_drive_t *, struct gendisk *, int);
1169 void ide_create_request_sense_cmd(ide_drive_t *, struct ide_atapi_pc *);
1170 void ide_retry_pc(ide_drive_t *drive);
1171
1172 void ide_prep_sense(ide_drive_t *drive, struct request *rq);
1173 int ide_queue_sense_rq(ide_drive_t *drive, void *special);
1174
1175 int ide_cd_expiry(ide_drive_t *);
1176
1177 int ide_cd_get_xferlen(struct request *);
1178
1179 ide_startstop_t ide_issue_pc(ide_drive_t *, struct ide_cmd *);
1180
1181 ide_startstop_t do_rw_taskfile(ide_drive_t *, struct ide_cmd *);
1182
1183 void ide_pio_bytes(ide_drive_t *, struct ide_cmd *, unsigned int, unsigned int);
1184
1185 void ide_finish_cmd(ide_drive_t *, struct ide_cmd *, u8);
1186
1187 int ide_raw_taskfile(ide_drive_t *, struct ide_cmd *, u8 *, u16);
1188 int ide_no_data_taskfile(ide_drive_t *, struct ide_cmd *);
1189
1190 int ide_taskfile_ioctl(ide_drive_t *, unsigned long);
1191
1192 int ide_dev_read_id(ide_drive_t *, u8, u16 *);
1193
1194 extern int ide_driveid_update(ide_drive_t *);
1195 extern int ide_config_drive_speed(ide_drive_t *, u8);
1196 extern u8 eighty_ninty_three (ide_drive_t *);
1197 extern int taskfile_lib_get_identify(ide_drive_t *drive, u8 *);
1198
1199 extern int ide_wait_not_busy(ide_hwif_t *hwif, unsigned long timeout);
1200
1201 extern void ide_stall_queue(ide_drive_t *drive, unsigned long timeout);
1202
1203 extern void ide_timer_expiry(unsigned long);
1204 extern irqreturn_t ide_intr(int irq, void *dev_id);
1205 extern void do_ide_request(struct request_queue *);
1206
1207 void ide_init_disk(struct gendisk *, ide_drive_t *);
1208
1209 #ifdef CONFIG_IDEPCI_PCIBUS_ORDER
1210 extern int __ide_pci_register_driver(struct pci_driver *driver, struct module *owner, const char *mod_name);
1211 #define ide_pci_register_driver(d) __ide_pci_register_driver(d, THIS_MODULE, KBUILD_MODNAME)
1212 #else
1213 #define ide_pci_register_driver(d) pci_register_driver(d)
1214 #endif
1215
1216 static inline int ide_pci_is_in_compatibility_mode(struct pci_dev *dev)
1217 {
1218 if ((dev->class >> 8) == PCI_CLASS_STORAGE_IDE && (dev->class & 5) != 5)
1219 return 1;
1220 return 0;
1221 }
1222
1223 void ide_pci_setup_ports(struct pci_dev *, const struct ide_port_info *,
1224 hw_regs_t *, hw_regs_t **);
1225 void ide_setup_pci_noise(struct pci_dev *, const struct ide_port_info *);
1226
1227 #ifdef CONFIG_BLK_DEV_IDEDMA_PCI
1228 int ide_pci_set_master(struct pci_dev *, const char *);
1229 unsigned long ide_pci_dma_base(ide_hwif_t *, const struct ide_port_info *);
1230 int ide_pci_check_simplex(ide_hwif_t *, const struct ide_port_info *);
1231 int ide_hwif_setup_dma(ide_hwif_t *, const struct ide_port_info *);
1232 #else
1233 static inline int ide_hwif_setup_dma(ide_hwif_t *hwif,
1234 const struct ide_port_info *d)
1235 {
1236 return -EINVAL;
1237 }
1238 #endif
1239
1240 struct ide_pci_enablebit {
1241 u8 reg; /* byte pci reg holding the enable-bit */
1242 u8 mask; /* mask to isolate the enable-bit */
1243 u8 val; /* value of masked reg when "enabled" */
1244 };
1245
1246 enum {
1247 /* Uses ISA control ports not PCI ones. */
1248 IDE_HFLAG_ISA_PORTS = (1 << 0),
1249 /* single port device */
1250 IDE_HFLAG_SINGLE = (1 << 1),
1251 /* don't use legacy PIO blacklist */
1252 IDE_HFLAG_PIO_NO_BLACKLIST = (1 << 2),
1253 /* set for the second port of QD65xx */
1254 IDE_HFLAG_QD_2ND_PORT = (1 << 3),
1255 /* use PIO8/9 for prefetch off/on */
1256 IDE_HFLAG_ABUSE_PREFETCH = (1 << 4),
1257 /* use PIO6/7 for fast-devsel off/on */
1258 IDE_HFLAG_ABUSE_FAST_DEVSEL = (1 << 5),
1259 /* use 100-102 and 200-202 PIO values to set DMA modes */
1260 IDE_HFLAG_ABUSE_DMA_MODES = (1 << 6),
1261 /*
1262 * keep DMA setting when programming PIO mode, may be used only
1263 * for hosts which have separate PIO and DMA timings (ie. PMAC)
1264 */
1265 IDE_HFLAG_SET_PIO_MODE_KEEP_DMA = (1 << 7),
1266 /* program host for the transfer mode after programming device */
1267 IDE_HFLAG_POST_SET_MODE = (1 << 8),
1268 /* don't program host/device for the transfer mode ("smart" hosts) */
1269 IDE_HFLAG_NO_SET_MODE = (1 << 9),
1270 /* trust BIOS for programming chipset/device for DMA */
1271 IDE_HFLAG_TRUST_BIOS_FOR_DMA = (1 << 10),
1272 /* host is CS5510/CS5520 */
1273 IDE_HFLAG_CS5520 = (1 << 11),
1274 /* ATAPI DMA is unsupported */
1275 IDE_HFLAG_NO_ATAPI_DMA = (1 << 12),
1276 /* set if host is a "non-bootable" controller */
1277 IDE_HFLAG_NON_BOOTABLE = (1 << 13),
1278 /* host doesn't support DMA */
1279 IDE_HFLAG_NO_DMA = (1 << 14),
1280 /* check if host is PCI IDE device before allowing DMA */
1281 IDE_HFLAG_NO_AUTODMA = (1 << 15),
1282 /* host uses MMIO */
1283 IDE_HFLAG_MMIO = (1 << 16),
1284 /* no LBA48 */
1285 IDE_HFLAG_NO_LBA48 = (1 << 17),
1286 /* no LBA48 DMA */
1287 IDE_HFLAG_NO_LBA48_DMA = (1 << 18),
1288 /* data FIFO is cleared by an error */
1289 IDE_HFLAG_ERROR_STOPS_FIFO = (1 << 19),
1290 /* serialize ports */
1291 IDE_HFLAG_SERIALIZE = (1 << 20),
1292 /* host is DTC2278 */
1293 IDE_HFLAG_DTC2278 = (1 << 21),
1294 /* 4 devices on a single set of I/O ports */
1295 IDE_HFLAG_4DRIVES = (1 << 22),
1296 /* host is TRM290 */
1297 IDE_HFLAG_TRM290 = (1 << 23),
1298 /* use 32-bit I/O ops */
1299 IDE_HFLAG_IO_32BIT = (1 << 24),
1300 /* unmask IRQs */
1301 IDE_HFLAG_UNMASK_IRQS = (1 << 25),
1302 IDE_HFLAG_BROKEN_ALTSTATUS = (1 << 26),
1303 /* serialize ports if DMA is possible (for sl82c105) */
1304 IDE_HFLAG_SERIALIZE_DMA = (1 << 27),
1305 /* force host out of "simplex" mode */
1306 IDE_HFLAG_CLEAR_SIMPLEX = (1 << 28),
1307 /* DSC overlap is unsupported */
1308 IDE_HFLAG_NO_DSC = (1 << 29),
1309 /* never use 32-bit I/O ops */
1310 IDE_HFLAG_NO_IO_32BIT = (1 << 30),
1311 /* never unmask IRQs */
1312 IDE_HFLAG_NO_UNMASK_IRQS = (1 << 31),
1313 };
1314
1315 #ifdef CONFIG_BLK_DEV_OFFBOARD
1316 # define IDE_HFLAG_OFF_BOARD 0
1317 #else
1318 # define IDE_HFLAG_OFF_BOARD IDE_HFLAG_NON_BOOTABLE
1319 #endif
1320
1321 struct ide_port_info {
1322 char *name;
1323
1324 int (*init_chipset)(struct pci_dev *);
1325
1326 void (*get_lock)(irq_handler_t, void *);
1327 void (*release_lock)(void);
1328
1329 void (*init_iops)(ide_hwif_t *);
1330 void (*init_hwif)(ide_hwif_t *);
1331 int (*init_dma)(ide_hwif_t *,
1332 const struct ide_port_info *);
1333
1334 const struct ide_tp_ops *tp_ops;
1335 const struct ide_port_ops *port_ops;
1336 const struct ide_dma_ops *dma_ops;
1337
1338 struct ide_pci_enablebit enablebits[2];
1339
1340 hwif_chipset_t chipset;
1341
1342 u16 max_sectors; /* if < than the default one */
1343
1344 u32 host_flags;
1345
1346 int irq_flags;
1347
1348 u8 pio_mask;
1349 u8 swdma_mask;
1350 u8 mwdma_mask;
1351 u8 udma_mask;
1352 };
1353
1354 int ide_pci_init_one(struct pci_dev *, const struct ide_port_info *, void *);
1355 int ide_pci_init_two(struct pci_dev *, struct pci_dev *,
1356 const struct ide_port_info *, void *);
1357 void ide_pci_remove(struct pci_dev *);
1358
1359 #ifdef CONFIG_PM
1360 int ide_pci_suspend(struct pci_dev *, pm_message_t);
1361 int ide_pci_resume(struct pci_dev *);
1362 #else
1363 #define ide_pci_suspend NULL
1364 #define ide_pci_resume NULL
1365 #endif
1366
1367 void ide_map_sg(ide_drive_t *, struct ide_cmd *);
1368 void ide_init_sg_cmd(struct ide_cmd *, unsigned int);
1369
1370 #define BAD_DMA_DRIVE 0
1371 #define GOOD_DMA_DRIVE 1
1372
1373 struct drive_list_entry {
1374 const char *id_model;
1375 const char *id_firmware;
1376 };
1377
1378 int ide_in_drive_list(u16 *, const struct drive_list_entry *);
1379
1380 #ifdef CONFIG_BLK_DEV_IDEDMA
1381 int ide_dma_good_drive(ide_drive_t *);
1382 int __ide_dma_bad_drive(ide_drive_t *);
1383 int ide_id_dma_bug(ide_drive_t *);
1384
1385 u8 ide_find_dma_mode(ide_drive_t *, u8);
1386
1387 static inline u8 ide_max_dma_mode(ide_drive_t *drive)
1388 {
1389 return ide_find_dma_mode(drive, XFER_UDMA_6);
1390 }
1391
1392 void ide_dma_off_quietly(ide_drive_t *);
1393 void ide_dma_off(ide_drive_t *);
1394 void ide_dma_on(ide_drive_t *);
1395 int ide_set_dma(ide_drive_t *);
1396 void ide_check_dma_crc(ide_drive_t *);
1397 ide_startstop_t ide_dma_intr(ide_drive_t *);
1398
1399 int ide_allocate_dma_engine(ide_hwif_t *);
1400 void ide_release_dma_engine(ide_hwif_t *);
1401
1402 int ide_dma_prepare(ide_drive_t *, struct ide_cmd *);
1403 void ide_dma_unmap_sg(ide_drive_t *, struct ide_cmd *);
1404
1405 #ifdef CONFIG_BLK_DEV_IDEDMA_SFF
1406 int config_drive_for_dma(ide_drive_t *);
1407 int ide_build_dmatable(ide_drive_t *, struct ide_cmd *);
1408 void ide_dma_host_set(ide_drive_t *, int);
1409 int ide_dma_setup(ide_drive_t *, struct ide_cmd *);
1410 extern void ide_dma_start(ide_drive_t *);
1411 int ide_dma_end(ide_drive_t *);
1412 int ide_dma_test_irq(ide_drive_t *);
1413 int ide_dma_sff_timer_expiry(ide_drive_t *);
1414 u8 ide_dma_sff_read_status(ide_hwif_t *);
1415 extern const struct ide_dma_ops sff_dma_ops;
1416 #else
1417 static inline int config_drive_for_dma(ide_drive_t *drive) { return 0; }
1418 #endif /* CONFIG_BLK_DEV_IDEDMA_SFF */
1419
1420 void ide_dma_lost_irq(ide_drive_t *);
1421 ide_startstop_t ide_dma_timeout_retry(ide_drive_t *, int);
1422
1423 #else
1424 static inline int ide_id_dma_bug(ide_drive_t *drive) { return 0; }
1425 static inline u8 ide_find_dma_mode(ide_drive_t *drive, u8 speed) { return 0; }
1426 static inline u8 ide_max_dma_mode(ide_drive_t *drive) { return 0; }
1427 static inline void ide_dma_off_quietly(ide_drive_t *drive) { ; }
1428 static inline void ide_dma_off(ide_drive_t *drive) { ; }
1429 static inline void ide_dma_on(ide_drive_t *drive) { ; }
1430 static inline void ide_dma_verbose(ide_drive_t *drive) { ; }
1431 static inline int ide_set_dma(ide_drive_t *drive) { return 1; }
1432 static inline void ide_check_dma_crc(ide_drive_t *drive) { ; }
1433 static inline ide_startstop_t ide_dma_intr(ide_drive_t *drive) { return ide_stopped; }
1434 static inline ide_startstop_t ide_dma_timeout_retry(ide_drive_t *drive, int error) { return ide_stopped; }
1435 static inline void ide_release_dma_engine(ide_hwif_t *hwif) { ; }
1436 static inline int ide_dma_prepare(ide_drive_t *drive,
1437 struct ide_cmd *cmd) { return 1; }
1438 static inline void ide_dma_unmap_sg(ide_drive_t *drive,
1439 struct ide_cmd *cmd) { ; }
1440 #endif /* CONFIG_BLK_DEV_IDEDMA */
1441
1442 #ifdef CONFIG_BLK_DEV_IDEACPI
1443 int ide_acpi_init(void);
1444 extern int ide_acpi_exec_tfs(ide_drive_t *drive);
1445 extern void ide_acpi_get_timing(ide_hwif_t *hwif);
1446 extern void ide_acpi_push_timing(ide_hwif_t *hwif);
1447 void ide_acpi_init_port(ide_hwif_t *);
1448 void ide_acpi_port_init_devices(ide_hwif_t *);
1449 extern void ide_acpi_set_state(ide_hwif_t *hwif, int on);
1450 #else
1451 static inline int ide_acpi_init(void) { return 0; }
1452 static inline int ide_acpi_exec_tfs(ide_drive_t *drive) { return 0; }
1453 static inline void ide_acpi_get_timing(ide_hwif_t *hwif) { ; }
1454 static inline void ide_acpi_push_timing(ide_hwif_t *hwif) { ; }
1455 static inline void ide_acpi_init_port(ide_hwif_t *hwif) { ; }
1456 static inline void ide_acpi_port_init_devices(ide_hwif_t *hwif) { ; }
1457 static inline void ide_acpi_set_state(ide_hwif_t *hwif, int on) {}
1458 #endif
1459
1460 void ide_register_region(struct gendisk *);
1461 void ide_unregister_region(struct gendisk *);
1462
1463 void ide_undecoded_slave(ide_drive_t *);
1464
1465 void ide_port_apply_params(ide_hwif_t *);
1466 int ide_sysfs_register_port(ide_hwif_t *);
1467
1468 struct ide_host *ide_host_alloc(const struct ide_port_info *, hw_regs_t **);
1469 void ide_host_free(struct ide_host *);
1470 int ide_host_register(struct ide_host *, const struct ide_port_info *,
1471 hw_regs_t **);
1472 int ide_host_add(const struct ide_port_info *, hw_regs_t **,
1473 struct ide_host **);
1474 void ide_host_remove(struct ide_host *);
1475 int ide_legacy_device_add(const struct ide_port_info *, unsigned long);
1476 void ide_port_unregister_devices(ide_hwif_t *);
1477 void ide_port_scan(ide_hwif_t *);
1478
1479 static inline void *ide_get_hwifdata (ide_hwif_t * hwif)
1480 {
1481 return hwif->hwif_data;
1482 }
1483
1484 static inline void ide_set_hwifdata (ide_hwif_t * hwif, void *data)
1485 {
1486 hwif->hwif_data = data;
1487 }
1488
1489 extern void ide_toggle_bounce(ide_drive_t *drive, int on);
1490
1491 u64 ide_get_lba_addr(struct ide_cmd *, int);
1492 u8 ide_dump_status(ide_drive_t *, const char *, u8);
1493
1494 struct ide_timing {
1495 u8 mode;
1496 u8 setup; /* t1 */
1497 u16 act8b; /* t2 for 8-bit io */
1498 u16 rec8b; /* t2i for 8-bit io */
1499 u16 cyc8b; /* t0 for 8-bit io */
1500 u16 active; /* t2 or tD */
1501 u16 recover; /* t2i or tK */
1502 u16 cycle; /* t0 */
1503 u16 udma; /* t2CYCTYP/2 */
1504 };
1505
1506 enum {
1507 IDE_TIMING_SETUP = (1 << 0),
1508 IDE_TIMING_ACT8B = (1 << 1),
1509 IDE_TIMING_REC8B = (1 << 2),
1510 IDE_TIMING_CYC8B = (1 << 3),
1511 IDE_TIMING_8BIT = IDE_TIMING_ACT8B | IDE_TIMING_REC8B |
1512 IDE_TIMING_CYC8B,
1513 IDE_TIMING_ACTIVE = (1 << 4),
1514 IDE_TIMING_RECOVER = (1 << 5),
1515 IDE_TIMING_CYCLE = (1 << 6),
1516 IDE_TIMING_UDMA = (1 << 7),
1517 IDE_TIMING_ALL = IDE_TIMING_SETUP | IDE_TIMING_8BIT |
1518 IDE_TIMING_ACTIVE | IDE_TIMING_RECOVER |
1519 IDE_TIMING_CYCLE | IDE_TIMING_UDMA,
1520 };
1521
1522 struct ide_timing *ide_timing_find_mode(u8);
1523 u16 ide_pio_cycle_time(ide_drive_t *, u8);
1524 void ide_timing_merge(struct ide_timing *, struct ide_timing *,
1525 struct ide_timing *, unsigned int);
1526 int ide_timing_compute(ide_drive_t *, u8, struct ide_timing *, int, int);
1527
1528 #ifdef CONFIG_IDE_XFER_MODE
1529 int ide_scan_pio_blacklist(char *);
1530 const char *ide_xfer_verbose(u8);
1531 u8 ide_get_best_pio_mode(ide_drive_t *, u8, u8);
1532 int ide_set_pio_mode(ide_drive_t *, u8);
1533 int ide_set_dma_mode(ide_drive_t *, u8);
1534 void ide_set_pio(ide_drive_t *, u8);
1535 int ide_set_xfer_rate(ide_drive_t *, u8);
1536 #else
1537 static inline void ide_set_pio(ide_drive_t *drive, u8 pio) { ; }
1538 static inline int ide_set_xfer_rate(ide_drive_t *drive, u8 rate) { return -1; }
1539 #endif
1540
1541 static inline void ide_set_max_pio(ide_drive_t *drive)
1542 {
1543 ide_set_pio(drive, 255);
1544 }
1545
1546 char *ide_media_string(ide_drive_t *);
1547
1548 extern struct device_attribute ide_dev_attrs[];
1549 extern struct bus_type ide_bus_type;
1550 extern struct class *ide_port_class;
1551
1552 static inline void ide_dump_identify(u8 *id)
1553 {
1554 print_hex_dump(KERN_INFO, "", DUMP_PREFIX_NONE, 16, 2, id, 512, 0);
1555 }
1556
1557 static inline int hwif_to_node(ide_hwif_t *hwif)
1558 {
1559 return hwif->dev ? dev_to_node(hwif->dev) : -1;
1560 }
1561
1562 static inline ide_drive_t *ide_get_pair_dev(ide_drive_t *drive)
1563 {
1564 ide_drive_t *peer = drive->hwif->devices[(drive->dn ^ 1) & 1];
1565
1566 return (peer->dev_flags & IDE_DFLAG_PRESENT) ? peer : NULL;
1567 }
1568
1569 #define ide_port_for_each_dev(i, dev, port) \
1570 for ((i) = 0; ((dev) = (port)->devices[i]) || (i) < MAX_DRIVES; (i)++)
1571
1572 #define ide_port_for_each_present_dev(i, dev, port) \
1573 for ((i) = 0; ((dev) = (port)->devices[i]) || (i) < MAX_DRIVES; (i)++) \
1574 if ((dev)->dev_flags & IDE_DFLAG_PRESENT)
1575
1576 #define ide_host_for_each_port(i, port, host) \
1577 for ((i) = 0; ((port) = (host)->ports[i]) || (i) < MAX_HOST_PORTS; (i)++)
1578
1579 #endif /* _IDE_H */