ide.h 41.2 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
#ifndef _IDE_H
#define _IDE_H
/*
 *  linux/include/linux/ide.h
 *
 *  Copyright (C) 1994-2002  Linus Torvalds & authors
 */

#include <linux/init.h>
#include <linux/ioport.h>
#include <linux/hdreg.h>
#include <linux/blkdev.h>
#include <linux/proc_fs.h>
#include <linux/interrupt.h>
#include <linux/bitops.h>
#include <linux/bio.h>
#include <linux/device.h>
#include <linux/pci.h>
19
#include <linux/completion.h>
H
Hannes Reinecke 已提交
20 21 22
#ifdef CONFIG_BLK_DEV_IDEACPI
#include <acpi/acpi.h>
#endif
L
Linus Torvalds 已提交
23 24 25
#include <asm/byteorder.h>
#include <asm/system.h>
#include <asm/io.h>
26
#include <asm/mutex.h>
L
Linus Torvalds 已提交
27

28
#if defined(CONFIG_CRIS) || defined(CONFIG_FRV)
29 30 31
# define SUPPORT_VLB_SYNC 0
#else
# define SUPPORT_VLB_SYNC 1
L
Linus Torvalds 已提交
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63
#endif

/*
 * Used to indicate "no IRQ", should be a value that cannot be an IRQ
 * number.
 */
 
#define IDE_NO_IRQ		(-1)

typedef unsigned char	byte;	/* used everywhere */

/*
 * Probably not wise to fiddle with these
 */
#define ERROR_MAX	8	/* Max read/write errors per sector */
#define ERROR_RESET	3	/* Reset controller every 4th retry */
#define ERROR_RECAL	1	/* Recalibrate every 2nd retry */

/*
 * state flags
 */

#define DMA_PIO_RETRY	1	/* retrying in PIO */

#define HWIF(drive)		((ide_hwif_t *)((drive)->hwif))
#define HWGROUP(drive)		((ide_hwgroup_t *)(HWIF(drive)->hwgroup))

/*
 * Definitions for accessing IDE controller registers
 */
#define IDE_NR_PORTS		(10)

64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
struct ide_io_ports {
	unsigned long	data_addr;

	union {
		unsigned long error_addr;	/*   read:  error */
		unsigned long feature_addr;	/*  write: feature */
	};

	unsigned long	nsect_addr;
	unsigned long	lbal_addr;
	unsigned long	lbam_addr;
	unsigned long	lbah_addr;

	unsigned long	device_addr;

	union {
		unsigned long status_addr;	/*  read: status  */
		unsigned long command_addr;	/* write: command */
	};

	unsigned long	ctl_addr;

	unsigned long	irq_addr;
};
L
Linus Torvalds 已提交
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150

#define OK_STAT(stat,good,bad)	(((stat)&((good)|(bad)))==(good))
#define BAD_R_STAT		(BUSY_STAT   | ERR_STAT)
#define BAD_W_STAT		(BAD_R_STAT  | WRERR_STAT)
#define BAD_STAT		(BAD_R_STAT  | DRQ_STAT)
#define DRIVE_READY		(READY_STAT  | SEEK_STAT)

#define BAD_CRC			(ABRT_ERR    | ICRC_ERR)

#define SATA_NR_PORTS		(3)	/* 16 possible ?? */

#define SATA_STATUS_OFFSET	(0)
#define SATA_ERROR_OFFSET	(1)
#define SATA_CONTROL_OFFSET	(2)

/*
 * Our Physical Region Descriptor (PRD) table should be large enough
 * to handle the biggest I/O request we are likely to see.  Since requests
 * can have no more than 256 sectors, and since the typical blocksize is
 * two or more sectors, we could get by with a limit of 128 entries here for
 * the usual worst case.  Most requests seem to include some contiguous blocks,
 * further reducing the number of table entries required.
 *
 * The driver reverts to PIO mode for individual requests that exceed
 * this limit (possible with 512 byte blocksizes, eg. MSDOS f/s), so handling
 * 100% of all crazy scenarios here is not necessary.
 *
 * As it turns out though, we must allocate a full 4KB page for this,
 * so the two PRD tables (ide0 & ide1) will each get half of that,
 * allowing each to have about 256 entries (8 bytes each) from this.
 */
#define PRD_BYTES       8
#define PRD_ENTRIES	256

/*
 * Some more useful definitions
 */
#define PARTN_BITS	6	/* number of minor dev bits for partitions */
#define MAX_DRIVES	2	/* per interface; 2 assumed by lots of code */
#define SECTOR_SIZE	512
#define SECTOR_WORDS	(SECTOR_SIZE / 4)	/* number of 32bit words per sector */
#define IDE_LARGE_SEEK(b1,b2,t)	(((b1) > (b2) + (t)) || ((b2) > (b1) + (t)))

/*
 * Timeouts for various operations:
 */
#define WAIT_DRQ	(HZ/10)		/* 100msec - spec allows up to 20ms */
#define WAIT_READY	(5*HZ)		/* 5sec - some laptops are very slow */
#define WAIT_PIDENTIFY	(10*HZ)	/* 10sec  - should be less than 3ms (?), if all ATAPI CD is closed at boot */
#define WAIT_WORSTCASE	(30*HZ)	/* 30sec  - worst case when spinning up */
#define WAIT_CMD	(10*HZ)	/* 10sec  - maximum wait for an IRQ to happen */
#define WAIT_MIN_SLEEP	(2*HZ/100)	/* 20msec - minimum sleep time */

/*
 * Check for an interrupt and acknowledge the interrupt status
 */
struct hwif_s;
typedef int (ide_ack_intr_t)(struct hwif_s *);

/*
 * hwif_chipset_t is used to keep track of the specific hardware
 * chipset used by each IDE interface, if known.
 */
151
enum {		ide_unknown,	ide_generic,	ide_pci,
L
Linus Torvalds 已提交
152 153 154 155 156
		ide_cmd640,	ide_dtc2278,	ide_ali14xx,
		ide_qd65xx,	ide_umc8672,	ide_ht6560b,
		ide_rz1000,	ide_trm290,
		ide_cmd646,	ide_cy82c693,	ide_4drives,
		ide_pmac,	ide_etrax100,	ide_acorn,
157
		ide_au1xxx,	ide_palm3710
158 159 160
};

typedef u8 hwif_chipset_t;
L
Linus Torvalds 已提交
161 162 163 164 165

/*
 * Structure to hold all information about the location of this port
 */
typedef struct hw_regs_s {
166 167 168 169 170
	union {
		struct ide_io_ports	io_ports;
		unsigned long		io_ports_array[IDE_NR_PORTS];
	};

L
Linus Torvalds 已提交
171 172 173
	int		irq;			/* our irq number */
	ide_ack_intr_t	*ack_intr;		/* acknowledge interrupt */
	hwif_chipset_t  chipset;
174
	struct device	*dev;
L
Linus Torvalds 已提交
175 176
} hw_regs_t;

177
void ide_init_port_data(struct hwif_s *, unsigned int);
178
void ide_init_port_hw(struct hwif_s *, hw_regs_t *);
179

L
Linus Torvalds 已提交
180 181 182 183 184 185
static inline void ide_std_init_ports(hw_regs_t *hw,
				      unsigned long io_addr,
				      unsigned long ctl_addr)
{
	unsigned int i;

186 187
	for (i = 0; i <= 7; i++)
		hw->io_ports_array[i] = io_addr++;
L
Linus Torvalds 已提交
188

189
	hw->io_ports.ctl_addr = ctl_addr;
L
Linus Torvalds 已提交
190 191 192 193
}

#include <asm/ide.h>

194 195
#if !defined(MAX_HWIFS) || defined(CONFIG_EMBEDDED)
#undef MAX_HWIFS
196 197 198
#define MAX_HWIFS	CONFIG_IDE_MAX_HWIFS
#endif

L
Linus Torvalds 已提交
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
/* Currently only m68k, apus and m8xx need it */
#ifndef IDE_ARCH_ACK_INTR
# define ide_ack_intr(hwif) (1)
#endif

/* Currently only Atari needs it */
#ifndef IDE_ARCH_LOCK
# define ide_release_lock()			do {} while (0)
# define ide_get_lock(hdlr, data)		do {} while (0)
#endif /* IDE_ARCH_LOCK */

/*
 * Now for the data we need to maintain per-drive:  ide_drive_t
 */

#define ide_scsi	0x21
#define ide_disk	0x20
#define ide_optical	0x7
#define ide_cdrom	0x5
#define ide_tape	0x1
#define ide_floppy	0x0

/*
 * Special Driver Flags
 *
 * set_geometry	: respecify drive geometry
 * recalibrate	: seek to cyl 0
 * set_multmode	: set multmode count
 * set_tune	: tune interface for drive
 * serviced	: service command
 * reserved	: unused
 */
typedef union {
	unsigned all			: 8;
	struct {
		unsigned set_geometry	: 1;
		unsigned recalibrate	: 1;
		unsigned set_multmode	: 1;
		unsigned set_tune	: 1;
		unsigned serviced	: 1;
		unsigned reserved	: 3;
	} b;
} special_t;

/*
 * ATA-IDE Select Register, aka Device-Head
 *
 * head		: always zeros here
 * unit		: drive select number: 0/1
 * bit5		: always 1
 * lba		: using LBA instead of CHS
 * bit7		: always 1
 */
typedef union {
	unsigned all			: 8;
	struct {
#if defined(__LITTLE_ENDIAN_BITFIELD)
		unsigned head		: 4;
		unsigned unit		: 1;
		unsigned bit5		: 1;
		unsigned lba		: 1;
		unsigned bit7		: 1;
#elif defined(__BIG_ENDIAN_BITFIELD)
		unsigned bit7		: 1;
		unsigned lba		: 1;
		unsigned bit5		: 1;
		unsigned unit		: 1;
		unsigned head		: 4;
#else
#error "Please fix <asm/byteorder.h>"
#endif
	} b;
} select_t, ata_select_t;

/*
 * Status returned from various ide_ functions
 */
typedef enum {
	ide_stopped,	/* no drive operation was started */
	ide_started,	/* a drive operation was started, handler was set */
} ide_startstop_t;

struct ide_driver_s;
struct ide_settings_s;

H
Hannes Reinecke 已提交
284 285 286 287 288
#ifdef CONFIG_BLK_DEV_IDEACPI
struct ide_acpi_drive_link;
struct ide_acpi_hwif_link;
#endif

L
Linus Torvalds 已提交
289 290 291 292
typedef struct ide_drive_s {
	char		name[4];	/* drive name, such as "hda" */
        char            driver_req[10];	/* requests specific driver */

293
	struct request_queue	*queue;	/* request queue */
L
Linus Torvalds 已提交
294 295 296 297 298

	struct request		*rq;	/* current request */
	struct ide_drive_s 	*next;	/* circular list of hwgroup drives */
	void		*driver_data;	/* extra driver data */
	struct hd_driveid	*id;	/* drive model identification info */
299
#ifdef CONFIG_IDE_PROC_FS
L
Linus Torvalds 已提交
300 301
	struct proc_dir_entry *proc;	/* /proc/ide/ directory entry */
	struct ide_settings_s *settings;/* /proc/ide/ drive settings */
302
#endif
L
Linus Torvalds 已提交
303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
	struct hwif_s		*hwif;	/* actually (ide_hwif_t *) */

	unsigned long sleep;		/* sleep until this time */
	unsigned long service_start;	/* time we started last request */
	unsigned long service_time;	/* service time of last request */
	unsigned long timeout;		/* max time to wait for irq */

	special_t	special;	/* special action flags */
	select_t	select;		/* basic drive/head select reg value */

	u8	keep_settings;		/* restore settings after drive reset */
	u8	using_dma;		/* disk is using dma for read/write */
	u8	retry_pio;		/* retrying dma capable host in pio */
	u8	state;			/* retry state */
	u8	waiting_for_dma;	/* dma currently in progress */
	u8	unmask;			/* okay to unmask other irqs */
319
	u8	noflush;		/* don't attempt flushes */
L
Linus Torvalds 已提交
320 321 322 323 324 325 326 327 328 329 330 331 332 333
	u8	dsc_overlap;		/* DSC overlap */
	u8	nice1;			/* give potential excess bandwidth */

	unsigned present	: 1;	/* drive is physically present */
	unsigned dead		: 1;	/* device ejected hint */
	unsigned id_read	: 1;	/* 1=id read from disk 0 = synthetic */
	unsigned noprobe 	: 1;	/* from:  hdx=noprobe */
	unsigned removable	: 1;	/* 1 if need to do check_media_change */
	unsigned attach		: 1;	/* needed for removable devices */
	unsigned forced_geom	: 1;	/* 1 if hdx=c,h,s was given at boot */
	unsigned no_unmask	: 1;	/* disallow setting unmask bit */
	unsigned no_io_32bit	: 1;	/* disallow enabling 32bit I/O */
	unsigned atapi_overlap	: 1;	/* ATAPI overlap (not supported) */
	unsigned doorlocking	: 1;	/* for removable only: door lock/unlock works */
334
	unsigned nodma		: 1;	/* disallow DMA */
L
Linus Torvalds 已提交
335 336 337 338 339 340
	unsigned remap_0_to_1	: 1;	/* 0=noremap, 1=remap 0->1 (for EZDrive) */
	unsigned blocked        : 1;	/* 1=powermanagment told us not to do anything, so sleep nicely */
	unsigned vdma		: 1;	/* 1=doing PIO over DMA 0=doing normal DMA */
	unsigned scsi		: 1;	/* 0=default, 1=ide-scsi emulation */
	unsigned sleeping	: 1;	/* 1=sleeping & sleep field valid */
	unsigned post_reset	: 1;
341
	unsigned udma33_warned	: 1;
L
Linus Torvalds 已提交
342

343
	u8	addressing;	/* 0=28-bit, 1=48-bit, 2=48-bit doing 28-bit */
L
Linus Torvalds 已提交
344 345 346
        u8	quirk_list;	/* considered quirky, set for a specific host */
        u8	init_speed;	/* transfer rate set at boot */
        u8	current_speed;	/* current transfer rate set */
347
	u8	desired_speed;	/* desired transfer rate set */
L
Linus Torvalds 已提交
348 349 350 351
        u8	dn;		/* now wide spread use */
        u8	wcache;		/* status of write cache */
	u8	acoustic;	/* acoustic management */
	u8	media;		/* disk, cdrom, tape, floppy, ... */
352
	u8	ctl;		/* "normal" value for Control register */
L
Linus Torvalds 已提交
353 354 355 356 357 358 359 360 361 362 363 364 365 366 367
	u8	ready_stat;	/* min status value for drive ready */
	u8	mult_count;	/* current multiple sector setting */
	u8	mult_req;	/* requested multiple sector setting */
	u8	tune_req;	/* requested drive tuning setting */
	u8	io_32bit;	/* 0=16-bit, 1=32-bit, 2/3=32bit+sync */
	u8	bad_wstat;	/* used for ignoring WRERR_STAT */
	u8	nowerr;		/* used for ignoring WRERR_STAT */
	u8	sect0;		/* offset of first sector for DM6:DDO */
	u8	head;		/* "real" number of heads */
	u8	sect;		/* "real" sectors per track */
	u8	bios_head;	/* BIOS/fdisk/LILO number of heads */
	u8	bios_sect;	/* BIOS/fdisk/LILO sectors per track */

	unsigned int	bios_cyl;	/* BIOS/fdisk/LILO number of cyls */
	unsigned int	cyl;		/* "real" number of cyls */
368
	unsigned int	drive_data;	/* used by set_pio_mode/selectproc */
L
Linus Torvalds 已提交
369 370
	unsigned int	failures;	/* current failure count */
	unsigned int	max_failures;	/* maximum allowed failure count */
A
Alan Cox 已提交
371
	u64		probed_capacity;/* initial reported media capacity (ide-cd only currently) */
L
Linus Torvalds 已提交
372 373 374 375 376

	u64		capacity64;	/* total number of sectors */

	int		lun;		/* logical unit */
	int		crc_count;	/* crc counter to reduce drive speed */
H
Hannes Reinecke 已提交
377 378 379
#ifdef CONFIG_BLK_DEV_IDEACPI
	struct ide_acpi_drive_link *acpidata;
#endif
L
Linus Torvalds 已提交
380 381
	struct list_head list;
	struct device	gendev;
382
	struct completion gendev_rel_comp;	/* to deal with device release() */
L
Linus Torvalds 已提交
383 384
} ide_drive_t;

385 386
#define to_ide_device(dev)container_of(dev, ide_drive_t, gendev)

L
Linus Torvalds 已提交
387 388 389 390
#define IDE_CHIPSET_PCI_MASK	\
    ((1<<ide_pci)|(1<<ide_cmd646)|(1<<ide_ali14xx))
#define IDE_CHIPSET_IS_PCI(c)	((IDE_CHIPSET_PCI_MASK >> (c)) & 1)

391
struct ide_port_info;
L
Linus Torvalds 已提交
392

393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418
struct ide_port_ops {
	/* host specific initialization of devices on a port */
	void	(*port_init_devs)(struct hwif_s *);
	/* routine to program host for PIO mode */
	void	(*set_pio_mode)(ide_drive_t *, const u8);
	/* routine to program host for DMA mode */
	void	(*set_dma_mode)(ide_drive_t *, const u8);
	/* tweaks hardware to select drive */
	void	(*selectproc)(ide_drive_t *);
	/* chipset polling based on hba specifics */
	int	(*reset_poll)(ide_drive_t *);
	/* chipset specific changes to default for device-hba resets */
	void	(*pre_reset)(ide_drive_t *);
	/* routine to reset controller after a disk reset */
	void	(*resetproc)(ide_drive_t *);
	/* special host masking for drive selection */
	void	(*maskproc)(ide_drive_t *, int);
	/* check host's drive quirk list */
	void	(*quirkproc)(ide_drive_t *);

	u8	(*mdma_filter)(ide_drive_t *);
	u8	(*udma_filter)(ide_drive_t *);

	u8	(*cable_detect)(struct hwif_s *);
};

419 420 421 422 423 424 425 426 427 428 429
struct ide_dma_ops {
	void	(*dma_host_set)(struct ide_drive_s *, int);
	int	(*dma_setup)(struct ide_drive_s *);
	void	(*dma_exec_cmd)(struct ide_drive_s *, u8);
	void	(*dma_start)(struct ide_drive_s *);
	int	(*dma_end)(struct ide_drive_s *);
	int	(*dma_test_irq)(struct ide_drive_s *);
	void	(*dma_lost_irq)(struct ide_drive_s *);
	void	(*dma_timeout)(struct ide_drive_s *);
};

L
Linus Torvalds 已提交
430 431 432 433 434 435 436 437
typedef struct hwif_s {
	struct hwif_s *next;		/* for linked-list in ide_hwgroup_t */
	struct hwif_s *mate;		/* other hwif from same PCI chip */
	struct hwgroup_s *hwgroup;	/* actually (ide_hwgroup_t *) */
	struct proc_dir_entry *proc;	/* /proc/ide/ directory entry */

	char name[6];			/* name of interface, eg. "ide0" */

438 439
	struct ide_io_ports	io_ports;

L
Linus Torvalds 已提交
440 441 442 443 444 445 446 447 448
	unsigned long	sata_scr[SATA_NR_PORTS];

	ide_drive_t	drives[MAX_DRIVES];	/* drive info */

	u8 major;	/* our major number */
	u8 index;	/* 0 for ide0; 1 for ide1; ... */
	u8 channel;	/* for dual-port chips: 0=primary, 1=secondary */
	u8 bus_state;	/* power state of the IDE bus */

449
	u32 host_flags;
450

B
Bartlomiej Zolnierkiewicz 已提交
451 452
	u8 pio_mask;

L
Linus Torvalds 已提交
453 454 455 456
	u8 ultra_mask;
	u8 mwdma_mask;
	u8 swdma_mask;

457 458
	u8 cbl;		/* cable type */

L
Linus Torvalds 已提交
459 460
	hwif_chipset_t chipset;	/* sub-module for tuning.. */

461 462
	struct device *dev;

463 464
	ide_ack_intr_t *ack_intr;

L
Linus Torvalds 已提交
465 466
	void (*rw_disk)(ide_drive_t *, struct request *);

467
	const struct ide_port_ops	*port_ops;
468
	const struct ide_dma_ops	*dma_ops;
469

470 471
	void (*input_data)(ide_drive_t *, struct request *, void *, unsigned);
	void (*output_data)(ide_drive_t *, struct request *, void *, unsigned);
L
Linus Torvalds 已提交
472

473
	void (*ide_dma_clear_irq)(ide_drive_t *drive);
L
Linus Torvalds 已提交
474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496

	void (*OUTB)(u8 addr, unsigned long port);
	void (*OUTBSYNC)(ide_drive_t *drive, u8 addr, unsigned long port);
	void (*OUTW)(u16 addr, unsigned long port);

	u8  (*INB)(unsigned long port);
	u16 (*INW)(unsigned long port);

	/* dma physical region descriptor table (cpu view) */
	unsigned int	*dmatable_cpu;
	/* dma physical region descriptor table (dma view) */
	dma_addr_t	dmatable_dma;
	/* Scatter-gather list used to build the above */
	struct scatterlist *sg_table;
	int sg_max_nents;		/* Maximum number of entries in it */
	int sg_nents;			/* Current number of entries in it */
	int sg_dma_direction;		/* dma transfer direction */

	/* data phase of the active command (currently only valid for PIO/DMA) */
	int		data_phase;

	unsigned int nsect;
	unsigned int nleft;
J
Jens Axboe 已提交
497
	struct scatterlist *cursg;
L
Linus Torvalds 已提交
498 499 500 501 502 503 504 505 506 507 508 509 510 511 512
	unsigned int cursg_ofs;

	int		rqsize;		/* max sectors per request */
	int		irq;		/* our irq number */

	unsigned long	dma_base;	/* base addr for dma ports */
	unsigned long	dma_command;	/* dma command register */
	unsigned long	dma_vendor1;	/* dma vendor 1 register */
	unsigned long	dma_status;	/* dma status register */
	unsigned long	dma_vendor3;	/* dma vendor 3 register */
	unsigned long	dma_prdtable;	/* actual prd table address */

	unsigned long	config_data;	/* for use by chipset-specific code */
	unsigned long	select_data;	/* for use by chipset-specific code */

513 514 515
	unsigned long	extra_base;	/* extra addr for dma ports */
	unsigned	extra_ports;	/* number of extra dma ports */

L
Linus Torvalds 已提交
516 517 518 519
	unsigned	present    : 1;	/* this interface exists */
	unsigned	serialized : 1;	/* serialized all channel operation */
	unsigned	sharing_irq: 1;	/* 1 = sharing irq with another hwif */
	unsigned	sg_mapped  : 1;	/* sg_table and sg_nents are ready */
520
	unsigned	mmio       : 1; /* host uses MMIO */
L
Linus Torvalds 已提交
521

522 523 524
	struct device		gendev;
	struct device		*portdev;

525
	struct completion gendev_rel_comp; /* To deal with device release() */
L
Linus Torvalds 已提交
526 527 528 529

	void		*hwif_data;	/* extra hwif data */

	unsigned dma;
H
Hannes Reinecke 已提交
530 531 532 533

#ifdef CONFIG_BLK_DEV_IDEACPI
	struct ide_acpi_hwif_link *acpidata;
#endif
534
} ____cacheline_internodealigned_in_smp ide_hwif_t;
L
Linus Torvalds 已提交
535 536 537 538 539 540 541

/*
 *  internal ide interrupt handler type
 */
typedef ide_startstop_t (ide_handler_t)(ide_drive_t *);
typedef int (ide_expiry_t)(ide_drive_t *);

542
/* used by ide-cd, ide-floppy, etc. */
543
typedef void (xfer_func_t)(ide_drive_t *, struct request *rq, void *, unsigned);
544

L
Linus Torvalds 已提交
545 546 547
typedef struct hwgroup_s {
		/* irq handler, if active */
	ide_startstop_t	(*handler)(ide_drive_t *);
548

L
Linus Torvalds 已提交
549 550 551 552 553 554
		/* BOOL: protects all fields below */
	volatile int busy;
		/* BOOL: wake us up on timer expiry */
	unsigned int sleeping	: 1;
		/* BOOL: polling active & poll_timeout field valid */
	unsigned int polling	: 1;
555 556 557
	 	/* BOOL: in a polling reset situation. Must not trigger another reset yet */
	unsigned int resetting  : 1;

L
Linus Torvalds 已提交
558 559 560 561 562 563 564
		/* current drive */
	ide_drive_t *drive;
		/* ptr to current hwif in linked-list */
	ide_hwif_t *hwif;

		/* current request */
	struct request *rq;
565

L
Linus Torvalds 已提交
566 567 568 569 570 571
		/* failsafe timer */
	struct timer_list timer;
		/* timeout value during long polls */
	unsigned long poll_timeout;
		/* queried upon timeouts */
	int (*expiry)(ide_drive_t *);
572

573 574
	int req_gen;
	int req_gen_timer;
L
Linus Torvalds 已提交
575 576
} ide_hwgroup_t;

577 578
typedef struct ide_driver_s ide_driver_t;

579
extern struct mutex ide_setting_mtx;
L
Linus Torvalds 已提交
580

581 582 583 584
int set_io_32bit(ide_drive_t *, int);
int set_pio_mode(ide_drive_t *, int);
int set_using_dma(ide_drive_t *, int);

585 586 587 588 589 590 591 592 593 594 595 596 597 598 599
/* ATAPI packet command flags */
enum {
	/* set when an error is considered normal - no retry (ide-tape) */
	PC_FLAG_ABORT			= (1 << 0),
	PC_FLAG_SUPPRESS_ERROR		= (1 << 1),
	PC_FLAG_WAIT_FOR_DSC		= (1 << 2),
	PC_FLAG_DMA_OK			= (1 << 3),
	PC_FLAG_DMA_RECOMMENDED		= (1 << 4),
	PC_FLAG_DMA_IN_PROGRESS		= (1 << 5),
	PC_FLAG_DMA_ERROR		= (1 << 6),
	PC_FLAG_WRITING			= (1 << 7),
	/* command timed out */
	PC_FLAG_TIMEDOUT		= (1 << 8),
};

600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646
struct ide_atapi_pc {
	/* actual packet bytes */
	u8 c[12];
	/* incremented on each retry */
	int retries;
	int error;

	/* bytes to transfer */
	int req_xfer;
	/* bytes actually transferred */
	int xferred;

	/* data buffer */
	u8 *buf;
	/* current buffer position */
	u8 *cur_pos;
	int buf_size;
	/* missing/available data on the current buffer */
	int b_count;

	/* the corresponding request */
	struct request *rq;

	unsigned long flags;

	/*
	 * those are more or less driver-specific and some of them are subject
	 * to change/removal later.
	 */
	u8 pc_buf[256];
	void (*idefloppy_callback) (ide_drive_t *);
	ide_startstop_t (*idetape_callback) (ide_drive_t *);

	/* idetape only */
	struct idetape_bh *bh;
	char *b_data;

	/* idescsi only for now */
	struct scatterlist *sg;
	unsigned int sg_cnt;

	struct scsi_cmnd *scsi_cmd;
	void (*done) (struct scsi_cmnd *);

	unsigned long timeout;
};

647
#ifdef CONFIG_IDE_PROC_FS
L
Linus Torvalds 已提交
648 649 650 651 652
/*
 * configurable drive settings
 */

#define TYPE_INT	0
653 654
#define TYPE_BYTE	1
#define TYPE_SHORT	2
L
Linus Torvalds 已提交
655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674

#define SETTING_READ	(1 << 0)
#define SETTING_WRITE	(1 << 1)
#define SETTING_RW	(SETTING_READ | SETTING_WRITE)

typedef int (ide_procset_t)(ide_drive_t *, int);
typedef struct ide_settings_s {
	char			*name;
	int			rw;
	int			data_type;
	int			min;
	int			max;
	int			mul_factor;
	int			div_factor;
	void			*data;
	ide_procset_t		*set;
	int			auto_remove;
	struct ide_settings_s	*next;
} ide_settings_t;

675
int ide_add_setting(ide_drive_t *, const char *, int, int, int, int, int, int, void *, ide_procset_t *set);
L
Linus Torvalds 已提交
676 677 678 679 680 681 682 683 684 685 686

/*
 * /proc/ide interface
 */
typedef struct {
	const char	*name;
	mode_t		mode;
	read_proc_t	*read_proc;
	write_proc_t	*write_proc;
} ide_proc_entry_t;

687 688
void proc_ide_create(void);
void proc_ide_destroy(void);
689
void ide_proc_register_port(ide_hwif_t *);
690
void ide_proc_port_register_devices(ide_hwif_t *);
691
void ide_proc_unregister_device(ide_drive_t *);
692
void ide_proc_unregister_port(ide_hwif_t *);
693 694 695 696 697
void ide_proc_register_driver(ide_drive_t *, ide_driver_t *);
void ide_proc_unregister_driver(ide_drive_t *, ide_driver_t *);

void ide_add_generic_settings(ide_drive_t *);

L
Linus Torvalds 已提交
698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716
read_proc_t proc_ide_read_capacity;
read_proc_t proc_ide_read_geometry;

/*
 * Standard exit stuff:
 */
#define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) \
{					\
	len -= off;			\
	if (len < count) {		\
		*eof = 1;		\
		if (len <= 0)		\
			return 0;	\
	} else				\
		len = count;		\
	*start = page + off;		\
	return len;			\
}
#else
717 718
static inline void proc_ide_create(void) { ; }
static inline void proc_ide_destroy(void) { ; }
719
static inline void ide_proc_register_port(ide_hwif_t *hwif) { ; }
720
static inline void ide_proc_port_register_devices(ide_hwif_t *hwif) { ; }
721
static inline void ide_proc_unregister_device(ide_drive_t *drive) { ; }
722
static inline void ide_proc_unregister_port(ide_hwif_t *hwif) { ; }
723 724 725
static inline void ide_proc_register_driver(ide_drive_t *drive, ide_driver_t *driver) { ; }
static inline void ide_proc_unregister_driver(ide_drive_t *drive, ide_driver_t *driver) { ; }
static inline void ide_add_generic_settings(ide_drive_t *drive) { ; }
L
Linus Torvalds 已提交
726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763
#define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) return 0;
#endif

/*
 * Power Management step value (rq->pm->pm_step).
 *
 * The step value starts at 0 (ide_pm_state_start_suspend) for a
 * suspend operation or 1000 (ide_pm_state_start_resume) for a
 * resume operation.
 *
 * For each step, the core calls the subdriver start_power_step() first.
 * This can return:
 *	- ide_stopped :	In this case, the core calls us back again unless
 *			step have been set to ide_power_state_completed.
 *	- ide_started :	In this case, the channel is left busy until an
 *			async event (interrupt) occurs.
 * Typically, start_power_step() will issue a taskfile request with
 * do_rw_taskfile().
 *
 * Upon reception of the interrupt, the core will call complete_power_step()
 * with the error code if any. This routine should update the step value
 * and return. It should not start a new request. The core will call
 * start_power_step for the new step value, unless step have been set to
 * ide_power_state_completed.
 *
 * Subdrivers are expected to define their own additional power
 * steps from 1..999 for suspend and from 1001..1999 for resume,
 * other values are reserved for future use.
 */

enum {
	ide_pm_state_completed		= -1,
	ide_pm_state_start_suspend	= 0,
	ide_pm_state_start_resume	= 1000,
};

/*
 * Subdrivers support.
764 765 766
 *
 * The gendriver.owner field should be set to the module owner of this driver.
 * The gendriver.name field should be set to the name of this driver
L
Linus Torvalds 已提交
767
 */
768
struct ide_driver_s {
L
Linus Torvalds 已提交
769 770 771 772 773 774 775 776
	const char			*version;
	u8				media;
	unsigned supports_dsc_overlap	: 1;
	ide_startstop_t	(*do_request)(ide_drive_t *, struct request *, sector_t);
	int		(*end_request)(ide_drive_t *, int, int);
	ide_startstop_t	(*error)(ide_drive_t *, struct request *rq, u8, u8);
	ide_startstop_t	(*abort)(ide_drive_t *, struct request *rq);
	struct device_driver	gen_driver;
777 778
	int		(*probe)(ide_drive_t *);
	void		(*remove)(ide_drive_t *);
L
Lee Trager 已提交
779
	void		(*resume)(ide_drive_t *);
780
	void		(*shutdown)(ide_drive_t *);
781 782 783 784
#ifdef CONFIG_IDE_PROC_FS
	ide_proc_entry_t	*proc;
#endif
};
L
Linus Torvalds 已提交
785

786 787
#define to_ide_driver(drv) container_of(drv, ide_driver_t, gen_driver)

L
Linus Torvalds 已提交
788 789 790 791 792 793 794 795 796 797 798 799 800
int generic_ide_ioctl(ide_drive_t *, struct file *, struct block_device *, unsigned, unsigned long);

/*
 * ide_hwifs[] is the master data structure used to keep track
 * of just about everything in ide.c.  Whenever possible, routines
 * should be using pointers to a drive (ide_drive_t *) or
 * pointers to a hwif (ide_hwif_t *), rather than indexing this
 * structure directly (the allocation/layout may change!).
 *
 */
#ifndef _IDE_C
extern	ide_hwif_t	ide_hwifs[];		/* master data repository */
#endif
801 802 803
extern int ide_noacpi;
extern int ide_acpigtf;
extern int ide_acpionboot;
L
Linus Torvalds 已提交
804 805
extern int noautodma;

806 807 808
extern int ide_vlb_clk;
extern int ide_pci_clk;

809 810 811 812 813 814 815
ide_hwif_t *ide_find_port_slot(const struct ide_port_info *);

static inline ide_hwif_t *ide_find_port(void)
{
	return ide_find_port_slot(NULL);
}

L
Linus Torvalds 已提交
816
extern int ide_end_request (ide_drive_t *drive, int uptodate, int nrsecs);
A
Alan Cox 已提交
817 818
int ide_end_dequeued_request(ide_drive_t *drive, struct request *rq,
			     int uptodate, int nr_sectors);
L
Linus Torvalds 已提交
819 820 821

extern void ide_set_handler (ide_drive_t *drive, ide_handler_t *handler, unsigned int timeout, ide_expiry_t *expiry);

822 823
void ide_execute_command(ide_drive_t *, u8, ide_handler_t *, unsigned int,
			 ide_expiry_t *);
L
Linus Torvalds 已提交
824

825 826
void ide_execute_pkt_cmd(ide_drive_t *);

L
Linus Torvalds 已提交
827 828 829 830 831 832 833 834 835
ide_startstop_t __ide_error(ide_drive_t *, struct request *, u8, u8);

ide_startstop_t ide_error (ide_drive_t *drive, const char *msg, byte stat);

ide_startstop_t __ide_abort(ide_drive_t *, struct request *);

extern ide_startstop_t ide_abort(ide_drive_t *, const char *);

extern void ide_fix_driveid(struct hd_driveid *);
836

L
Linus Torvalds 已提交
837 838
extern void ide_fixstring(u8 *, const int, const int);

839
int ide_wait_stat(ide_startstop_t *, ide_drive_t *, u8, u8, unsigned long);
L
Linus Torvalds 已提交
840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858

extern ide_startstop_t ide_do_reset (ide_drive_t *);

extern void ide_init_drive_cmd (struct request *rq);

/*
 * "action" parameter type for ide_do_drive_cmd() below.
 */
typedef enum {
	ide_wait,	/* insert rq at end of list, and wait for it */
	ide_preempt,	/* insert rq in front of current request */
	ide_head_wait,	/* insert rq in front of current request and wait for it */
	ide_end		/* insert rq at end of list, but don't wait for it */
} ide_action_t;

extern int ide_do_drive_cmd(ide_drive_t *, struct request *, ide_action_t);

extern void ide_end_drive_cmd(ide_drive_t *, u8, u8);

859 860 861
enum {
	IDE_TFLAG_LBA48			= (1 << 0),
	IDE_TFLAG_NO_SELECT_MASK	= (1 << 1),
862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883
	IDE_TFLAG_FLAGGED		= (1 << 2),
	IDE_TFLAG_OUT_DATA		= (1 << 3),
	IDE_TFLAG_OUT_HOB_FEATURE	= (1 << 4),
	IDE_TFLAG_OUT_HOB_NSECT		= (1 << 5),
	IDE_TFLAG_OUT_HOB_LBAL		= (1 << 6),
	IDE_TFLAG_OUT_HOB_LBAM		= (1 << 7),
	IDE_TFLAG_OUT_HOB_LBAH		= (1 << 8),
	IDE_TFLAG_OUT_HOB		= IDE_TFLAG_OUT_HOB_FEATURE |
					  IDE_TFLAG_OUT_HOB_NSECT |
					  IDE_TFLAG_OUT_HOB_LBAL |
					  IDE_TFLAG_OUT_HOB_LBAM |
					  IDE_TFLAG_OUT_HOB_LBAH,
	IDE_TFLAG_OUT_FEATURE		= (1 << 9),
	IDE_TFLAG_OUT_NSECT		= (1 << 10),
	IDE_TFLAG_OUT_LBAL		= (1 << 11),
	IDE_TFLAG_OUT_LBAM		= (1 << 12),
	IDE_TFLAG_OUT_LBAH		= (1 << 13),
	IDE_TFLAG_OUT_TF		= IDE_TFLAG_OUT_FEATURE |
					  IDE_TFLAG_OUT_NSECT |
					  IDE_TFLAG_OUT_LBAL |
					  IDE_TFLAG_OUT_LBAM |
					  IDE_TFLAG_OUT_LBAH,
884
	IDE_TFLAG_OUT_DEVICE		= (1 << 14),
885
	IDE_TFLAG_WRITE			= (1 << 15),
886 887
	IDE_TFLAG_FLAGGED_SET_IN_FLAGS	= (1 << 16),
	IDE_TFLAG_IN_DATA		= (1 << 17),
888
	IDE_TFLAG_CUSTOM_HANDLER	= (1 << 18),
889
	IDE_TFLAG_DMA_PIO_FALLBACK	= (1 << 19),
890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910
	IDE_TFLAG_IN_HOB_FEATURE	= (1 << 20),
	IDE_TFLAG_IN_HOB_NSECT		= (1 << 21),
	IDE_TFLAG_IN_HOB_LBAL		= (1 << 22),
	IDE_TFLAG_IN_HOB_LBAM		= (1 << 23),
	IDE_TFLAG_IN_HOB_LBAH		= (1 << 24),
	IDE_TFLAG_IN_HOB_LBA		= IDE_TFLAG_IN_HOB_LBAL |
					  IDE_TFLAG_IN_HOB_LBAM |
					  IDE_TFLAG_IN_HOB_LBAH,
	IDE_TFLAG_IN_HOB		= IDE_TFLAG_IN_HOB_FEATURE |
					  IDE_TFLAG_IN_HOB_NSECT |
					  IDE_TFLAG_IN_HOB_LBA,
	IDE_TFLAG_IN_NSECT		= (1 << 25),
	IDE_TFLAG_IN_LBAL		= (1 << 26),
	IDE_TFLAG_IN_LBAM		= (1 << 27),
	IDE_TFLAG_IN_LBAH		= (1 << 28),
	IDE_TFLAG_IN_LBA		= IDE_TFLAG_IN_LBAL |
					  IDE_TFLAG_IN_LBAM |
					  IDE_TFLAG_IN_LBAH,
	IDE_TFLAG_IN_TF			= IDE_TFLAG_IN_NSECT |
					  IDE_TFLAG_IN_LBA,
	IDE_TFLAG_IN_DEVICE		= (1 << 29),
911 912 913 914 915 916
	IDE_TFLAG_HOB			= IDE_TFLAG_OUT_HOB |
					  IDE_TFLAG_IN_HOB,
	IDE_TFLAG_TF			= IDE_TFLAG_OUT_TF |
					  IDE_TFLAG_IN_TF,
	IDE_TFLAG_DEVICE		= IDE_TFLAG_OUT_DEVICE |
					  IDE_TFLAG_IN_DEVICE,
917 918
	/* force 16-bit I/O operations */
	IDE_TFLAG_IO_16BIT		= (1 << 30),
919 920
	/* ide_task_t was allocated using kmalloc() */
	IDE_TFLAG_DYN			= (1 << 31),
921 922
};

923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951
struct ide_taskfile {
	u8	hob_data;	/*  0: high data byte (for TASKFILE IOCTL) */

	u8	hob_feature;	/*  1-5: additional data to support LBA48 */
	u8	hob_nsect;
	u8	hob_lbal;
	u8	hob_lbam;
	u8	hob_lbah;

	u8	data;		/*  6: low data byte (for TASKFILE IOCTL) */

	union {			/*  7: */
		u8 error;	/*   read:  error */
		u8 feature;	/*  write: feature */
	};

	u8	nsect;		/*  8: number of sectors */
	u8	lbal;		/*  9: LBA low */
	u8	lbam;		/* 10: LBA mid */
	u8	lbah;		/* 11: LBA high */

	u8	device;		/* 12: device select */

	union {			/* 13: */
		u8 status;	/*  read: status  */
		u8 command;	/* write: command */
	};
};

L
Linus Torvalds 已提交
952
typedef struct ide_task_s {
953 954 955 956
	union {
		struct ide_taskfile	tf;
		u8			tf_array[14];
	};
957
	u32			tf_flags;
L
Linus Torvalds 已提交
958 959 960 961 962
	int			data_phase;
	struct request		*rq;		/* copy of request */
	void			*special;	/* valid_t generally */
} ide_task_t;

963 964
void ide_tf_dump(const char *, struct ide_taskfile *);

965
void ide_tf_load(ide_drive_t *, ide_task_t *);
966
void ide_tf_read(ide_drive_t *, ide_task_t *);
L
Linus Torvalds 已提交
967 968 969 970 971 972

extern void SELECT_DRIVE(ide_drive_t *);
extern void SELECT_MASK(ide_drive_t *, int);

extern int drive_is_ready(ide_drive_t *);

973 974
void ide_pktcmd_tf_load(ide_drive_t *, u32, u16, u8);

975
ide_startstop_t do_rw_taskfile(ide_drive_t *, ide_task_t *);
L
Linus Torvalds 已提交
976

T
Tejun Heo 已提交
977 978
void task_end_request(ide_drive_t *, struct request *, u8);

979
int ide_raw_taskfile(ide_drive_t *, ide_task_t *, u8 *, u16);
980 981
int ide_no_data_taskfile(ide_drive_t *, ide_task_t *);

L
Linus Torvalds 已提交
982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998
int ide_taskfile_ioctl(ide_drive_t *, unsigned int, unsigned long);
int ide_cmd_ioctl(ide_drive_t *, unsigned int, unsigned long);
int ide_task_ioctl(ide_drive_t *, unsigned int, unsigned long);

extern int system_bus_clock(void);

extern int ide_driveid_update(ide_drive_t *);
extern int ide_config_drive_speed(ide_drive_t *, u8);
extern u8 eighty_ninty_three (ide_drive_t *);
extern int taskfile_lib_get_identify(ide_drive_t *drive, u8 *);

extern int ide_wait_not_busy(ide_hwif_t *hwif, unsigned long timeout);

extern void ide_stall_queue(ide_drive_t *drive, unsigned long timeout);

extern int ide_spin_wait_hwgroup(ide_drive_t *);
extern void ide_timer_expiry(unsigned long);
999
extern irqreturn_t ide_intr(int irq, void *dev_id);
1000
extern void do_ide_request(struct request_queue *);
L
Linus Torvalds 已提交
1001 1002 1003

void ide_init_disk(struct gendisk *, ide_drive_t *);

1004
#ifdef CONFIG_IDEPCI_PCIBUS_ORDER
1005 1006
extern int __ide_pci_register_driver(struct pci_driver *driver, struct module *owner, const char *mod_name);
#define ide_pci_register_driver(d) __ide_pci_register_driver(d, THIS_MODULE, KBUILD_MODNAME)
1007 1008 1009 1010
#else
#define ide_pci_register_driver(d) pci_register_driver(d)
#endif

1011 1012
void ide_pci_setup_ports(struct pci_dev *, const struct ide_port_info *, int, u8 *);
void ide_setup_pci_noise(struct pci_dev *, const struct ide_port_info *);
L
Linus Torvalds 已提交
1013

1014
#ifdef CONFIG_BLK_DEV_IDEDMA_PCI
1015 1016 1017
int ide_pci_set_master(struct pci_dev *, const char *);
unsigned long ide_pci_dma_base(ide_hwif_t *, const struct ide_port_info *);
int ide_hwif_setup_dma(ide_hwif_t *, const struct ide_port_info *);
1018
#else
1019 1020 1021 1022 1023
static inline int ide_hwif_setup_dma(ide_hwif_t *hwif,
				     const struct ide_port_info *d)
{
	return -EINVAL;
}
1024 1025
#endif

L
Linus Torvalds 已提交
1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037
extern void default_hwif_iops(ide_hwif_t *);
extern void default_hwif_mmiops(ide_hwif_t *);
extern void default_hwif_transport(ide_hwif_t *);

typedef struct ide_pci_enablebit_s {
	u8	reg;	/* byte pci reg holding the enable-bit */
	u8	mask;	/* mask to isolate the enable-bit */
	u8	val;	/* value of masked reg when "enabled" */
} ide_pci_enablebit_t;

enum {
	/* Uses ISA control ports not PCI ones. */
1038
	IDE_HFLAG_ISA_PORTS		= (1 << 0),
1039
	/* single port device */
1040
	IDE_HFLAG_SINGLE		= (1 << 1),
1041 1042
	/* don't use legacy PIO blacklist */
	IDE_HFLAG_PIO_NO_BLACKLIST	= (1 << 2),
1043 1044
	/* set for the second port of QD65xx */
	IDE_HFLAG_QD_2ND_PORT		= (1 << 3),
1045 1046 1047 1048 1049 1050
	/* use PIO8/9 for prefetch off/on */
	IDE_HFLAG_ABUSE_PREFETCH	= (1 << 4),
	/* use PIO6/7 for fast-devsel off/on */
	IDE_HFLAG_ABUSE_FAST_DEVSEL	= (1 << 5),
	/* use 100-102 and 200-202 PIO values to set DMA modes */
	IDE_HFLAG_ABUSE_DMA_MODES	= (1 << 6),
1051 1052 1053 1054 1055
	/*
	 * keep DMA setting when programming PIO mode, may be used only
	 * for hosts which have separate PIO and DMA timings (ie. PMAC)
	 */
	IDE_HFLAG_SET_PIO_MODE_KEEP_DMA	= (1 << 7),
1056 1057 1058 1059
	/* program host for the transfer mode after programming device */
	IDE_HFLAG_POST_SET_MODE		= (1 << 8),
	/* don't program host/device for the transfer mode ("smart" hosts) */
	IDE_HFLAG_NO_SET_MODE		= (1 << 9),
1060 1061
	/* trust BIOS for programming chipset/device for DMA */
	IDE_HFLAG_TRUST_BIOS_FOR_DMA	= (1 << 10),
1062
	/* host uses VDMA (tied with IDE_HFLAG_CS5520 for now) */
1063
	IDE_HFLAG_VDMA			= (1 << 11),
1064 1065
	/* ATAPI DMA is unsupported */
	IDE_HFLAG_NO_ATAPI_DMA		= (1 << 12),
1066 1067
	/* set if host is a "non-bootable" controller */
	IDE_HFLAG_NON_BOOTABLE		= (1 << 13),
1068 1069 1070 1071
	/* host doesn't support DMA */
	IDE_HFLAG_NO_DMA		= (1 << 14),
	/* check if host is PCI IDE device before allowing DMA */
	IDE_HFLAG_NO_AUTODMA		= (1 << 15),
1072 1073
	/* host uses MMIO */
	IDE_HFLAG_MMIO			= (1 << 16),
1074
	/* host is CS5510/CS5520 */
1075
	IDE_HFLAG_CS5520		= IDE_HFLAG_VDMA,
1076 1077 1078 1079
	/* no LBA48 */
	IDE_HFLAG_NO_LBA48		= (1 << 17),
	/* no LBA48 DMA */
	IDE_HFLAG_NO_LBA48_DMA		= (1 << 18),
1080 1081
	/* data FIFO is cleared by an error */
	IDE_HFLAG_ERROR_STOPS_FIFO	= (1 << 19),
1082 1083
	/* serialize ports */
	IDE_HFLAG_SERIALIZE		= (1 << 20),
1084 1085
	/* use legacy IRQs */
	IDE_HFLAG_LEGACY_IRQS		= (1 << 21),
1086 1087
	/* force use of legacy IRQs */
	IDE_HFLAG_FORCE_LEGACY_IRQS	= (1 << 22),
1088 1089
	/* limit LBA48 requests to 256 sectors */
	IDE_HFLAG_RQSIZE_256		= (1 << 23),
1090 1091 1092 1093
	/* use 32-bit I/O ops */
	IDE_HFLAG_IO_32BIT		= (1 << 24),
	/* unmask IRQs */
	IDE_HFLAG_UNMASK_IRQS		= (1 << 25),
1094
	IDE_HFLAG_ABUSE_SET_DMA_MODE	= (1 << 26),
1095 1096
	/* serialize ports if DMA is possible (for sl82c105) */
	IDE_HFLAG_SERIALIZE_DMA		= (1 << 27),
1097 1098
	/* force host out of "simplex" mode */
	IDE_HFLAG_CLEAR_SIMPLEX		= (1 << 28),
1099 1100
	/* DSC overlap is unsupported */
	IDE_HFLAG_NO_DSC		= (1 << 29),
1101 1102 1103 1104
	/* never use 32-bit I/O ops */
	IDE_HFLAG_NO_IO_32BIT		= (1 << 30),
	/* never unmask IRQs */
	IDE_HFLAG_NO_UNMASK_IRQS	= (1 << 31),
L
Linus Torvalds 已提交
1105 1106
};

1107 1108
#ifdef CONFIG_BLK_DEV_OFFBOARD
# define IDE_HFLAG_OFF_BOARD	0
1109 1110
#else
# define IDE_HFLAG_OFF_BOARD	IDE_HFLAG_NON_BOOTABLE
1111 1112
#endif

1113
struct ide_port_info {
L
Linus Torvalds 已提交
1114 1115 1116 1117
	char			*name;
	unsigned int		(*init_chipset)(struct pci_dev *, const char *);
	void			(*init_iops)(ide_hwif_t *);
	void                    (*init_hwif)(ide_hwif_t *);
1118 1119
	int			(*init_dma)(ide_hwif_t *,
					    const struct ide_port_info *);
1120 1121

	const struct ide_port_ops	*port_ops;
1122
	const struct ide_dma_ops	*dma_ops;
1123

L
Linus Torvalds 已提交
1124
	ide_pci_enablebit_t	enablebits[2];
1125
	hwif_chipset_t		chipset;
1126
	u32			host_flags;
B
Bartlomiej Zolnierkiewicz 已提交
1127
	u8			pio_mask;
1128 1129
	u8			swdma_mask;
	u8			mwdma_mask;
1130
	u8			udma_mask;
1131
};
L
Linus Torvalds 已提交
1132

1133 1134
int ide_setup_pci_device(struct pci_dev *, const struct ide_port_info *);
int ide_setup_pci_devices(struct pci_dev *, struct pci_dev *, const struct ide_port_info *);
L
Linus Torvalds 已提交
1135 1136 1137 1138 1139 1140 1141

void ide_map_sg(ide_drive_t *, struct request *);
void ide_init_sg_cmd(ide_drive_t *, struct request *);

#define BAD_DMA_DRIVE		0
#define GOOD_DMA_DRIVE		1

1142 1143 1144 1145 1146 1147
struct drive_list_entry {
	const char *id_model;
	const char *id_firmware;
};

int ide_in_drive_list(struct hd_driveid *, const struct drive_list_entry *);
1148 1149

#ifdef CONFIG_BLK_DEV_IDEDMA
L
Linus Torvalds 已提交
1150
int __ide_dma_bad_drive(ide_drive_t *);
1151
int ide_id_dma_bug(ide_drive_t *);
1152 1153 1154 1155 1156 1157 1158 1159

u8 ide_find_dma_mode(ide_drive_t *, u8);

static inline u8 ide_max_dma_mode(ide_drive_t *drive)
{
	return ide_find_dma_mode(drive, XFER_UDMA_6);
}

1160
void ide_dma_off_quietly(ide_drive_t *);
1161
void ide_dma_off(ide_drive_t *);
1162
void ide_dma_on(ide_drive_t *);
1163
int ide_set_dma(ide_drive_t *);
1164
void ide_check_dma_crc(ide_drive_t *);
L
Linus Torvalds 已提交
1165 1166
ide_startstop_t ide_dma_intr(ide_drive_t *);

1167 1168 1169
int ide_build_sglist(ide_drive_t *, struct request *);
void ide_destroy_dmatable(ide_drive_t *);

1170
#ifdef CONFIG_BLK_DEV_IDEDMA_SFF
L
Linus Torvalds 已提交
1171
extern int ide_build_dmatable(ide_drive_t *, struct request *);
1172 1173
int ide_allocate_dma_engine(ide_hwif_t *);
void ide_release_dma_engine(ide_hwif_t *);
1174
void ide_setup_dma(ide_hwif_t *, unsigned long);
L
Linus Torvalds 已提交
1175

1176
void ide_dma_host_set(ide_drive_t *, int);
L
Linus Torvalds 已提交
1177
extern int ide_dma_setup(ide_drive_t *);
1178
void ide_dma_exec_cmd(ide_drive_t *, u8);
L
Linus Torvalds 已提交
1179 1180
extern void ide_dma_start(ide_drive_t *);
extern int __ide_dma_end(ide_drive_t *);
1181
int ide_dma_test_irq(ide_drive_t *);
1182
extern void ide_dma_lost_irq(ide_drive_t *);
1183
extern void ide_dma_timeout(ide_drive_t *);
1184
#endif /* CONFIG_BLK_DEV_IDEDMA_SFF */
L
Linus Torvalds 已提交
1185 1186

#else
1187
static inline int ide_id_dma_bug(ide_drive_t *drive) { return 0; }
1188
static inline u8 ide_find_dma_mode(ide_drive_t *drive, u8 speed) { return 0; }
1189
static inline u8 ide_max_dma_mode(ide_drive_t *drive) { return 0; }
1190
static inline void ide_dma_off_quietly(ide_drive_t *drive) { ; }
1191
static inline void ide_dma_off(ide_drive_t *drive) { ; }
1192
static inline void ide_dma_on(ide_drive_t *drive) { ; }
L
Linus Torvalds 已提交
1193
static inline void ide_dma_verbose(ide_drive_t *drive) { ; }
1194
static inline int ide_set_dma(ide_drive_t *drive) { return 1; }
1195
static inline void ide_check_dma_crc(ide_drive_t *drive) { ; }
L
Linus Torvalds 已提交
1196 1197
#endif /* CONFIG_BLK_DEV_IDEDMA */

1198
#ifndef CONFIG_BLK_DEV_IDEDMA_SFF
1199
static inline void ide_release_dma_engine(ide_hwif_t *hwif) { ; }
L
Linus Torvalds 已提交
1200 1201
#endif

H
Hannes Reinecke 已提交
1202 1203 1204 1205 1206
#ifdef CONFIG_BLK_DEV_IDEACPI
extern int ide_acpi_exec_tfs(ide_drive_t *drive);
extern void ide_acpi_get_timing(ide_hwif_t *hwif);
extern void ide_acpi_push_timing(ide_hwif_t *hwif);
extern void ide_acpi_init(ide_hwif_t *hwif);
1207
void ide_acpi_port_init_devices(ide_hwif_t *);
1208
extern void ide_acpi_set_state(ide_hwif_t *hwif, int on);
H
Hannes Reinecke 已提交
1209 1210 1211 1212 1213
#else
static inline int ide_acpi_exec_tfs(ide_drive_t *drive) { return 0; }
static inline void ide_acpi_get_timing(ide_hwif_t *hwif) { ; }
static inline void ide_acpi_push_timing(ide_hwif_t *hwif) { ; }
static inline void ide_acpi_init(ide_hwif_t *hwif) { ; }
1214
static inline void ide_acpi_port_init_devices(ide_hwif_t *hwif) { ; }
1215
static inline void ide_acpi_set_state(ide_hwif_t *hwif, int on) {}
H
Hannes Reinecke 已提交
1216 1217
#endif

1218
void ide_remove_port_from_hwgroup(ide_hwif_t *);
1219
void ide_unregister(ide_hwif_t *);
L
Linus Torvalds 已提交
1220 1221 1222 1223

void ide_register_region(struct gendisk *);
void ide_unregister_region(struct gendisk *);

1224
void ide_undecoded_slave(ide_drive_t *);
L
Linus Torvalds 已提交
1225

1226 1227
void ide_port_apply_params(ide_hwif_t *);

1228 1229
int ide_device_add_all(u8 *idx, const struct ide_port_info *);
int ide_device_add(u8 idx[4], const struct ide_port_info *);
1230
int ide_legacy_device_add(const struct ide_port_info *, unsigned long);
1231 1232
void ide_port_unregister_devices(ide_hwif_t *);
void ide_port_scan(ide_hwif_t *);
L
Linus Torvalds 已提交
1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243

static inline void *ide_get_hwifdata (ide_hwif_t * hwif)
{
	return hwif->hwif_data;
}

static inline void ide_set_hwifdata (ide_hwif_t * hwif, void *data)
{
	hwif->hwif_data = data;
}

1244
const char *ide_xfer_verbose(u8 mode);
L
Linus Torvalds 已提交
1245 1246 1247
extern void ide_toggle_bounce(ide_drive_t *drive, int on);
extern int ide_set_xfer_rate(ide_drive_t *drive, u8 rate);

1248 1249 1250 1251 1252
static inline int ide_dev_has_iordy(struct hd_driveid *id)
{
	return ((id->field_valid & 2) && (id->capability & 8)) ? 1 : 0;
}

1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265
static inline int ide_dev_is_sata(struct hd_driveid *id)
{
	/*
	 * See if word 93 is 0 AND drive is at least ATA-5 compatible
	 * verifying that word 80 by casting it to a signed type --
	 * this trick allows us to filter out the reserved values of
	 * 0x0000 and 0xffff along with the earlier ATA revisions...
	 */
	if (id->hw_config == 0 && (short)id->major_rev_num >= 0x0020)
		return 1;
	return 0;
}

1266
u64 ide_get_lba_addr(struct ide_taskfile *, int);
L
Linus Torvalds 已提交
1267 1268 1269 1270 1271
u8 ide_dump_status(ide_drive_t *, const char *, u8);

typedef struct ide_pio_timings_s {
	int	setup_time;	/* Address setup (ns) minimum */
	int	active_time;	/* Active pulse (ns) minimum */
1272 1273
	int	cycle_time;	/* Cycle time (ns) minimum = */
				/* active + recovery (+ setup for some chips) */
L
Linus Torvalds 已提交
1274 1275
} ide_pio_timings_t;

1276
unsigned int ide_pio_cycle_time(ide_drive_t *, u8);
1277
u8 ide_get_best_pio_mode(ide_drive_t *, u8, u8);
L
Linus Torvalds 已提交
1278 1279
extern const ide_pio_timings_t ide_pio_timings[6];

1280 1281 1282
int ide_set_pio_mode(ide_drive_t *, u8);
int ide_set_dma_mode(ide_drive_t *, u8);

1283 1284 1285 1286 1287 1288
void ide_set_pio(ide_drive_t *, u8);

static inline void ide_set_max_pio(ide_drive_t *drive)
{
	ide_set_pio(drive, 255);
}
L
Linus Torvalds 已提交
1289 1290

extern spinlock_t ide_lock;
1291
extern struct mutex ide_cfg_mtx;
L
Linus Torvalds 已提交
1292 1293 1294
/*
 * Structure locking:
 *
1295
 * ide_cfg_mtx and ide_lock together protect changes to
L
Linus Torvalds 已提交
1296 1297 1298 1299 1300 1301 1302 1303 1304
 * ide_hwif_t->{next,hwgroup}
 * ide_drive_t->next
 *
 * ide_hwgroup_t->busy: ide_lock
 * ide_hwgroup_t->hwif: ide_lock
 * ide_hwif_t->mate: constant, no locking
 * ide_drive_t->hwif: constant, no locking
 */

1305
#define local_irq_set(flags)	do { local_save_flags((flags)); local_irq_enable_in_hardirq(); } while (0)
L
Linus Torvalds 已提交
1306 1307

extern struct bus_type ide_bus_type;
1308
extern struct class *ide_port_class;
L
Linus Torvalds 已提交
1309 1310 1311 1312 1313 1314 1315 1316

/* check if CACHE FLUSH (EXT) command is supported (bits defined in ATA-6) */
#define ide_id_has_flush_cache(id)	((id)->cfs_enable_2 & 0x3000)

/* some Maxtor disks have bit 13 defined incorrectly so check bit 10 too */
#define ide_id_has_flush_cache_ext(id)	\
	(((id)->cfs_enable_2 & 0x2400) == 0x2400)

1317 1318 1319 1320 1321
static inline void ide_dump_identify(u8 *id)
{
	print_hex_dump(KERN_INFO, "", DUMP_PREFIX_NONE, 16, 2, id, 512, 0);
}

1322 1323
static inline int hwif_to_node(ide_hwif_t *hwif)
{
1324
	struct pci_dev *dev = to_pci_dev(hwif->dev);
A
Andi Kleen 已提交
1325
	return hwif->dev ? pcibus_to_node(dev->bus) : -1;
1326 1327
}

1328 1329 1330 1331 1332 1333 1334
static inline ide_drive_t *ide_get_paired_drive(ide_drive_t *drive)
{
	ide_hwif_t *hwif	= HWIF(drive);

	return &hwif->drives[(drive->dn ^ 1) & 1];
}

1335 1336
static inline void ide_set_irq(ide_drive_t *drive, int on)
{
1337 1338
	ide_hwif_t *hwif = drive->hwif;

1339
	hwif->OUTB(drive->ctl | (on ? 0 : 2), hwif->io_ports.ctl_addr);
1340 1341
}

1342 1343 1344 1345
static inline u8 ide_read_status(ide_drive_t *drive)
{
	ide_hwif_t *hwif = drive->hwif;

1346
	return hwif->INB(hwif->io_ports.status_addr);
1347 1348 1349 1350 1351 1352
}

static inline u8 ide_read_altstatus(ide_drive_t *drive)
{
	ide_hwif_t *hwif = drive->hwif;

1353
	return hwif->INB(hwif->io_ports.ctl_addr);
1354 1355
}

1356 1357 1358 1359
static inline u8 ide_read_error(ide_drive_t *drive)
{
	ide_hwif_t *hwif = drive->hwif;

1360
	return hwif->INB(hwif->io_ports.error_addr);
1361 1362
}

1363 1364 1365 1366 1367 1368 1369 1370
/*
 * Too bad. The drive wants to send us data which we are not ready to accept.
 * Just throw it away.
 */
static inline void ide_atapi_discard_data(ide_drive_t *drive, unsigned bcount)
{
	ide_hwif_t *hwif = drive->hwif;

1371
	/* FIXME: use ->input_data */
1372
	while (bcount--)
1373
		(void)hwif->INB(hwif->io_ports.data_addr);
1374 1375 1376 1377 1378 1379
}

static inline void ide_atapi_write_zeros(ide_drive_t *drive, unsigned bcount)
{
	ide_hwif_t *hwif = drive->hwif;

1380
	/* FIXME: use ->output_data */
1381
	while (bcount--)
1382
		hwif->OUTB(0, hwif->io_ports.data_addr);
1383 1384
}

L
Linus Torvalds 已提交
1385
#endif /* _IDE_H */