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