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