libata.h 39.5 KB
Newer Older
L
Linus Torvalds 已提交
1
/*
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
 *  Copyright 2003-2005 Red Hat, Inc.  All rights reserved.
 *  Copyright 2003-2005 Jeff Garzik
 *
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2, or (at your option)
 *  any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; see the file COPYING.  If not, write to
 *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 *
 *  libata documentation is available via 'make {ps|pdf}docs',
 *  as Documentation/DocBook/libata.*
 *
L
Linus Torvalds 已提交
24 25 26 27 28 29 30 31
 */

#ifndef __LINUX_LIBATA_H__
#define __LINUX_LIBATA_H__

#include <linux/delay.h>
#include <linux/interrupt.h>
#include <linux/pci.h>
32
#include <linux/dma-mapping.h>
33
#include <asm/scatterlist.h>
34
#include <linux/io.h>
L
Linus Torvalds 已提交
35 36
#include <linux/ata.h>
#include <linux/workqueue.h>
37
#include <scsi/scsi_host.h>
38
#include <linux/acpi.h>
L
Linus Torvalds 已提交
39

40 41 42 43 44
/*
 * Define if arch has non-standard setup.  This is a _PCI_ standard
 * not a legacy or ISA standard.
 */
#ifdef CONFIG_ATA_NONSTANDARD
45
#include <asm/libata-portmap.h>
46 47 48
#else
#include <asm-generic/libata-portmap.h>
#endif
49

L
Linus Torvalds 已提交
50
/*
51 52
 * compile-time options: to be removed as soon as all the drivers are
 * converted to the new debugging mechanism
L
Linus Torvalds 已提交
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
 */
#undef ATA_DEBUG		/* debugging output */
#undef ATA_VERBOSE_DEBUG	/* yet more debugging output */
#undef ATA_IRQ_TRAP		/* define to ack screaming irqs */
#undef ATA_NDEBUG		/* define to disable quick runtime checks */


/* note: prints function name for you */
#ifdef ATA_DEBUG
#define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
#ifdef ATA_VERBOSE_DEBUG
#define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
#else
#define VPRINTK(fmt, args...)
#endif	/* ATA_VERBOSE_DEBUG */
#else
#define DPRINTK(fmt, args...)
#define VPRINTK(fmt, args...)
#endif	/* ATA_DEBUG */

J
Jeff Garzik 已提交
73 74
#define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)

75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
/* NEW: debug levels */
#define HAVE_LIBATA_MSG 1

enum {
	ATA_MSG_DRV	= 0x0001,
	ATA_MSG_INFO	= 0x0002,
	ATA_MSG_PROBE	= 0x0004,
	ATA_MSG_WARN	= 0x0008,
	ATA_MSG_MALLOC	= 0x0010,
	ATA_MSG_CTL	= 0x0020,
	ATA_MSG_INTR	= 0x0040,
	ATA_MSG_ERR	= 0x0080,
};

#define ata_msg_drv(p)    ((p)->msg_enable & ATA_MSG_DRV)
#define ata_msg_info(p)   ((p)->msg_enable & ATA_MSG_INFO)
#define ata_msg_probe(p)  ((p)->msg_enable & ATA_MSG_PROBE)
#define ata_msg_warn(p)   ((p)->msg_enable & ATA_MSG_WARN)
#define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC)
#define ata_msg_ctl(p)    ((p)->msg_enable & ATA_MSG_CTL)
#define ata_msg_intr(p)   ((p)->msg_enable & ATA_MSG_INTR)
#define ata_msg_err(p)    ((p)->msg_enable & ATA_MSG_ERR)

static inline u32 ata_msg_init(int dval, int default_msg_enable_bits)
{
	if (dval < 0 || dval >= (sizeof(u32) * 8))
		return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */
	if (!dval)
		return 0;
	return (1 << dval) - 1;
}

L
Linus Torvalds 已提交
107 108 109 110 111 112 113 114 115 116 117 118
/* defines only for the constants which don't work well as enums */
#define ATA_TAG_POISON		0xfafbfcfdU

/* move to PCI layer? */
static inline struct device *pci_dev_to_dev(struct pci_dev *pdev)
{
	return &pdev->dev;
}

enum {
	/* various global constants */
	LIBATA_MAX_PRD		= ATA_MAX_PRD / 2,
119
	LIBATA_DUMB_MAX_PRD	= ATA_MAX_PRD / 4,	/* Worst case */
L
Linus Torvalds 已提交
120 121
	ATA_MAX_PORTS		= 8,
	ATA_DEF_QUEUE		= 1,
122
	/* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
123
	ATA_MAX_QUEUE		= 32,
124
	ATA_TAG_INTERNAL	= ATA_MAX_QUEUE - 1,
L
Linus Torvalds 已提交
125 126 127 128 129 130 131
	ATA_MAX_BUS		= 2,
	ATA_DEF_BUSY_WAIT	= 10000,
	ATA_SHORT_PAUSE		= (HZ >> 6) + 1,

	ATA_SHT_EMULATED	= 1,
	ATA_SHT_CMD_PER_LUN	= 1,
	ATA_SHT_THIS_ID		= -1,
132
	ATA_SHT_USE_CLUSTERING	= 1,
L
Linus Torvalds 已提交
133 134

	/* struct ata_device stuff */
T
Tejun Heo 已提交
135 136
	ATA_DFLAG_LBA		= (1 << 0), /* device supports LBA */
	ATA_DFLAG_LBA48		= (1 << 1), /* device supports LBA48 */
J
Jeff Garzik 已提交
137
	ATA_DFLAG_CDB_INTR	= (1 << 2), /* device asserts INTRQ when ready for CDB */
138
	ATA_DFLAG_NCQ		= (1 << 3), /* device supports NCQ */
139
	ATA_DFLAG_FLUSH_EXT	= (1 << 4), /* do FLUSH_EXT instead of FLUSH */
T
Tejun Heo 已提交
140 141
	ATA_DFLAG_ACPI_PENDING	= (1 << 5), /* ACPI resume action pending */
	ATA_DFLAG_ACPI_FAILED	= (1 << 6), /* ACPI on devcfg has failed */
142
	ATA_DFLAG_AN		= (1 << 7), /* device supports AN */
143
	ATA_DFLAG_CFG_MASK	= (1 << 8) - 1,
T
Tejun Heo 已提交
144

145
	ATA_DFLAG_PIO		= (1 << 8), /* device limited to PIO mode */
T
Tejun Heo 已提交
146
	ATA_DFLAG_NCQ_OFF	= (1 << 9), /* device limited to non-NCQ mode */
147
	ATA_DFLAG_SPUNDOWN	= (1 << 10), /* XXX: for spindown_compat */
148
	ATA_DFLAG_INIT_MASK	= (1 << 16) - 1,
L
Linus Torvalds 已提交
149

150 151 152
	ATA_DFLAG_DETACH	= (1 << 16),
	ATA_DFLAG_DETACHED	= (1 << 17),

L
Linus Torvalds 已提交
153 154 155 156 157 158 159
	ATA_DEV_UNKNOWN		= 0,	/* unknown device */
	ATA_DEV_ATA		= 1,	/* ATA device */
	ATA_DEV_ATA_UNSUP	= 2,	/* ATA device (unsupported) */
	ATA_DEV_ATAPI		= 3,	/* ATAPI device */
	ATA_DEV_ATAPI_UNSUP	= 4,	/* ATAPI device (unsupported) */
	ATA_DEV_NONE		= 5,	/* no device */

160 161 162 163 164
	/* struct ata_link flags */
	ATA_LFLAG_HRST_TO_RESUME = (1 << 0), /* hardreset to resume link */
	ATA_LFLAG_SKIP_D2H_BSY	= (1 << 1), /* can't wait for the first D2H
					     * Register FIS clearing BSY */

L
Linus Torvalds 已提交
165
	/* struct ata_port flags */
T
Tejun Heo 已提交
166
	ATA_FLAG_SLAVE_POSS	= (1 << 0), /* host supports slave dev */
L
Linus Torvalds 已提交
167
					    /* (doesn't imply presence) */
T
Tejun Heo 已提交
168 169 170 171 172 173 174 175
	ATA_FLAG_SATA		= (1 << 1),
	ATA_FLAG_NO_LEGACY	= (1 << 2), /* no legacy mode check */
	ATA_FLAG_MMIO		= (1 << 3), /* use MMIO, not PIO */
	ATA_FLAG_SRST		= (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */
	ATA_FLAG_SATA_RESET	= (1 << 5), /* (obsolete) use COMRESET */
	ATA_FLAG_NO_ATAPI	= (1 << 6), /* No ATAPI support */
	ATA_FLAG_PIO_DMA	= (1 << 7), /* PIO cmds via DMA */
	ATA_FLAG_PIO_LBA48	= (1 << 8), /* Host DMA engine is LBA28 only */
176 177 178 179
	ATA_FLAG_PIO_POLLING	= (1 << 9), /* use polling PIO if LLD
					     * doesn't handle PIO interrupts */
	ATA_FLAG_NCQ		= (1 << 10), /* host supports NCQ */
	ATA_FLAG_DEBUGMSG	= (1 << 13),
180
	ATA_FLAG_IGN_SIMPLEX	= (1 << 15), /* ignore SIMPLEX */
181
	ATA_FLAG_NO_IORDY	= (1 << 16), /* controller lacks iordy */
182
	ATA_FLAG_ACPI_SATA	= (1 << 17), /* need native SATA ACPI layout */
183
	ATA_FLAG_AN		= (1 << 18), /* controller supports AN */
T
Tejun Heo 已提交
184

185 186 187 188 189 190 191
	/* The following flag belongs to ap->pflags but is kept in
	 * ap->flags because it's referenced in many LLDs and will be
	 * removed in not-too-distant future.
	 */
	ATA_FLAG_DISABLED	= (1 << 23), /* port is disabled, ignore it */

	/* bits 24:31 of ap->flags are reserved for LLD specific flags */
192

193 194 195 196 197 198 199 200
	/* struct ata_port pflags */
	ATA_PFLAG_EH_PENDING	= (1 << 0), /* EH pending */
	ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */
	ATA_PFLAG_FROZEN	= (1 << 2), /* port is frozen */
	ATA_PFLAG_RECOVERED	= (1 << 3), /* recovery action performed */
	ATA_PFLAG_LOADING	= (1 << 4), /* boot/loading probe */
	ATA_PFLAG_UNLOADING	= (1 << 5), /* module is unloading */
	ATA_PFLAG_SCSI_HOTPLUG	= (1 << 6), /* SCSI hotplug scheduled */
201
	ATA_PFLAG_INITIALIZING	= (1 << 7), /* being initialized, don't touch */
T
Tejun Heo 已提交
202

203
	ATA_PFLAG_SUSPENDED	= (1 << 17), /* port is suspended (power) */
204
	ATA_PFLAG_PM_PENDING	= (1 << 18), /* PM operation pending */
205
	ATA_PFLAG_GTM_VALID	= (1 << 19), /* acpi_gtm data valid */
T
Tejun Heo 已提交
206 207 208 209 210

	/* struct ata_queued_cmd flags */
	ATA_QCFLAG_ACTIVE	= (1 << 0), /* cmd not yet ack'd to scsi lyer */
	ATA_QCFLAG_SG		= (1 << 1), /* have s/g table? */
	ATA_QCFLAG_SINGLE	= (1 << 2), /* no s/g, just a single buffer */
L
Linus Torvalds 已提交
211
	ATA_QCFLAG_DMAMAP	= ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE,
T
Tejun Heo 已提交
212
	ATA_QCFLAG_IO		= (1 << 3), /* standard IO command */
213 214
	ATA_QCFLAG_RESULT_TF	= (1 << 4), /* result TF requested */

215 216 217
	ATA_QCFLAG_FAILED	= (1 << 16), /* cmd failed and is owned by EH */
	ATA_QCFLAG_SENSE_VALID	= (1 << 17), /* sense data valid */
	ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
L
Linus Torvalds 已提交
218

219
	/* host set flags */
J
Jeff Garzik 已提交
220
	ATA_HOST_SIMPLEX	= (1 << 0),	/* Host is simplex, one DMA channel per host only */
221
	ATA_HOST_STARTED	= (1 << 1),	/* Host started */
J
Jeff Garzik 已提交
222

223 224
	/* bits 24:31 of host->flags are reserved for LLD specific flags */

L
Linus Torvalds 已提交
225
	/* various lengths of time */
226 227
	ATA_TMOUT_BOOT		= 30 * HZ,	/* heuristic */
	ATA_TMOUT_BOOT_QUICK	= 7 * HZ,	/* heuristic */
228 229
	ATA_TMOUT_INTERNAL	= 30 * HZ,
	ATA_TMOUT_INTERNAL_QUICK = 5 * HZ,
L
Linus Torvalds 已提交
230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248

	/* ATA bus states */
	BUS_UNKNOWN		= 0,
	BUS_DMA			= 1,
	BUS_IDLE		= 2,
	BUS_NOINTR		= 3,
	BUS_NODATA		= 4,
	BUS_TIMER		= 5,
	BUS_PIO			= 6,
	BUS_EDD			= 7,
	BUS_IDENTIFY		= 8,
	BUS_PACKET		= 9,

	/* SATA port states */
	PORT_UNKNOWN		= 0,
	PORT_ENABLED		= 1,
	PORT_DISABLED		= 2,

	/* encoding various smaller bitmaps into a single
249
	 * unsigned int bitmap
L
Linus Torvalds 已提交
250
	 */
251 252
	ATA_BITS_PIO		= 7,
	ATA_BITS_MWDMA		= 5,
253 254 255 256 257 258 259 260 261
	ATA_BITS_UDMA		= 8,

	ATA_SHIFT_PIO		= 0,
	ATA_SHIFT_MWDMA		= ATA_SHIFT_PIO + ATA_BITS_PIO,
	ATA_SHIFT_UDMA		= ATA_SHIFT_MWDMA + ATA_BITS_MWDMA,

	ATA_MASK_PIO		= ((1 << ATA_BITS_PIO) - 1) << ATA_SHIFT_PIO,
	ATA_MASK_MWDMA		= ((1 << ATA_BITS_MWDMA) - 1) << ATA_SHIFT_MWDMA,
	ATA_MASK_UDMA		= ((1 << ATA_BITS_UDMA) - 1) << ATA_SHIFT_UDMA,
262 263 264 265

	/* size of buffer to pad xfers ending on unaligned boundaries */
	ATA_DMA_PAD_SZ		= 4,
	ATA_DMA_PAD_BUF_SZ	= ATA_DMA_PAD_SZ * ATA_MAX_QUEUE,
T
Tejun Heo 已提交
266

267 268 269
	/* ering size */
	ATA_ERING_SIZE		= 32,

270 271 272
	/* desc_len for ata_eh_info and context */
	ATA_EH_DESC_LEN		= 80,

273 274 275 276 277 278
	/* reset / recovery action types */
	ATA_EH_REVALIDATE	= (1 << 0),
	ATA_EH_SOFTRESET	= (1 << 1),
	ATA_EH_HARDRESET	= (1 << 2),

	ATA_EH_RESET_MASK	= ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
279
	ATA_EH_PERDEV_MASK	= ATA_EH_REVALIDATE,
280

281
	/* ata_eh_info->flags */
282
	ATA_EHI_HOTPLUGGED	= (1 << 0),  /* could have been hotplugged */
283
	ATA_EHI_RESUME_LINK	= (1 << 1),  /* resume link (reset modifier) */
284 285
	ATA_EHI_NO_AUTOPSY	= (1 << 2),  /* no autopsy */
	ATA_EHI_QUIET		= (1 << 3),  /* be quiet */
286

287 288 289 290 291
	ATA_EHI_DID_SOFTRESET	= (1 << 16), /* already soft-reset this port */
	ATA_EHI_DID_HARDRESET	= (1 << 17), /* already soft-reset this port */
	ATA_EHI_PRINTINFO	= (1 << 18), /* print configuration info */
	ATA_EHI_SETMODE		= (1 << 19), /* configure transfer mode */
	ATA_EHI_POST_SETMODE	= (1 << 20), /* revaildating after setmode */
292

293
	ATA_EHI_DID_RESET	= ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
294 295
	ATA_EHI_RESET_MODIFIER_MASK = ATA_EHI_RESUME_LINK,

296 297 298
	/* max repeat if error condition is still set after ->error_handler */
	ATA_EH_MAX_REPEAT	= 5,

299 300
	/* how hard are we gonna try to probe/recover devices */
	ATA_PROBE_MAX_TRIES	= 3,
T
Tejun Heo 已提交
301
	ATA_EH_DEV_TRIES	= 3,
302

303 304 305 306
	/* Horkage types. May be set by libata or controller on drives
	   (some horkage may be drive/controller pair dependant */

	ATA_HORKAGE_DIAGNOSTIC	= (1 << 0),	/* Failed boot diag */
307 308
	ATA_HORKAGE_NODMA	= (1 << 1),	/* DMA problems */
	ATA_HORKAGE_NONCQ	= (1 << 2),	/* Don't use NCQ */
309
	ATA_HORKAGE_MAX_SEC_128	= (1 << 3),	/* Limit max sects to 128 */
310
	ATA_HORKAGE_BROKEN_HPA	= (1 << 4),	/* Broken HPA */
L
Linus Torvalds 已提交
311 312
};

A
Albert Lee 已提交
313
enum hsm_task_states {
314
	HSM_ST_IDLE,		/* no command on going */
315 316
	HSM_ST_FIRST,		/* (waiting the device to)
				   write CDB or first data block */
317 318 319
	HSM_ST,			/* (waiting the device to) transfer data */
	HSM_ST_LAST,		/* (waiting the device to) complete command */
	HSM_ST_ERR,		/* error */
L
Linus Torvalds 已提交
320 321
};

322
enum ata_completion_errors {
323 324 325 326 327 328 329 330 331
	AC_ERR_DEV		= (1 << 0), /* device reported error */
	AC_ERR_HSM		= (1 << 1), /* host state machine violation */
	AC_ERR_TIMEOUT		= (1 << 2), /* timeout */
	AC_ERR_MEDIA		= (1 << 3), /* media error */
	AC_ERR_ATA_BUS		= (1 << 4), /* ATA bus error */
	AC_ERR_HOST_BUS		= (1 << 5), /* host bus error */
	AC_ERR_SYSTEM		= (1 << 6), /* system error */
	AC_ERR_INVALID		= (1 << 7), /* invalid argument */
	AC_ERR_OTHER		= (1 << 8), /* unknown */
332
	AC_ERR_NODEV_HINT	= (1 << 9), /* polling device detection hint */
T
Tejun Heo 已提交
333
	AC_ERR_NCQ		= (1 << 10), /* marker for offending NCQ qc */
334 335
};

L
Linus Torvalds 已提交
336 337 338 339
/* forward declarations */
struct scsi_device;
struct ata_port_operations;
struct ata_port;
T
Tejun Heo 已提交
340
struct ata_link;
L
Linus Torvalds 已提交
341 342 343
struct ata_queued_cmd;

/* typedefs */
344
typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
T
Tejun Heo 已提交
345 346
typedef int (*ata_prereset_fn_t)(struct ata_link *link, unsigned long deadline);
typedef int (*ata_reset_fn_t)(struct ata_link *link, unsigned int *classes,
347
			      unsigned long deadline);
T
Tejun Heo 已提交
348
typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes);
L
Linus Torvalds 已提交
349 350

struct ata_ioports {
T
Tejun Heo 已提交
351 352 353 354 355 356 357 358 359 360 361 362 363 364 365
	void __iomem		*cmd_addr;
	void __iomem		*data_addr;
	void __iomem		*error_addr;
	void __iomem		*feature_addr;
	void __iomem		*nsect_addr;
	void __iomem		*lbal_addr;
	void __iomem		*lbam_addr;
	void __iomem		*lbah_addr;
	void __iomem		*device_addr;
	void __iomem		*status_addr;
	void __iomem		*command_addr;
	void __iomem		*altstatus_addr;
	void __iomem		*ctl_addr;
	void __iomem		*bmdma_addr;
	void __iomem		*scr_addr;
L
Linus Torvalds 已提交
366 367
};

J
Jeff Garzik 已提交
368
struct ata_host {
L
Linus Torvalds 已提交
369 370 371
	spinlock_t		lock;
	struct device 		*dev;
	unsigned long		irq;
372
	unsigned long		irq2;
T
Tejun Heo 已提交
373
	void __iomem * const	*iomap;
L
Linus Torvalds 已提交
374 375
	unsigned int		n_ports;
	void			*private_data;
J
Jeff Garzik 已提交
376
	const struct ata_port_operations *ops;
377
	unsigned long		flags;
378 379 380
#ifdef CONFIG_ATA_ACPI
	acpi_handle		acpi_handle;
#endif
A
Alan 已提交
381
	struct ata_port		*simplex_claimed;	/* channel owning the DMA */
382
	struct ata_port		*ports[0];
L
Linus Torvalds 已提交
383 384 385 386 387 388 389 390 391 392 393 394 395 396 397
};

struct ata_queued_cmd {
	struct ata_port		*ap;
	struct ata_device	*dev;

	struct scsi_cmnd	*scsicmd;
	void			(*scsidone)(struct scsi_cmnd *);

	struct ata_taskfile	tf;
	u8			cdb[ATAPI_CDB_LEN];

	unsigned long		flags;		/* ATA_QCFLAG_xxx */
	unsigned int		tag;
	unsigned int		n_elem;
398
	unsigned int		orig_n_elem;
L
Linus Torvalds 已提交
399 400 401

	int			dma_dir;

402
	unsigned int		pad_len;
403
	unsigned int		sect_size;
404

L
Linus Torvalds 已提交
405 406 407 408 409 410 411
	unsigned int		nbytes;
	unsigned int		curbytes;

	unsigned int		cursg;
	unsigned int		cursg_ofs;

	struct scatterlist	sgent;
412
	struct scatterlist	pad_sgent;
L
Linus Torvalds 已提交
413 414
	void			*buf_virt;

415 416
	/* DO NOT iterate over __sg manually, use ata_for_each_sg() */
	struct scatterlist	*__sg;
L
Linus Torvalds 已提交
417

418
	unsigned int		err_mask;
419
	struct ata_taskfile	result_tf;
L
Linus Torvalds 已提交
420 421 422
	ata_qc_cb_t		complete_fn;

	void			*private_data;
423
	void			*lldd_task;
L
Linus Torvalds 已提交
424 425
};

J
Jeff Garzik 已提交
426
struct ata_port_stats {
L
Linus Torvalds 已提交
427 428 429 430 431
	unsigned long		unhandled_irq;
	unsigned long		idle_irq;
	unsigned long		rw_reqbuf;
};

432 433 434 435 436 437 438 439 440 441 442
struct ata_ering_entry {
	int			is_io;
	unsigned int		err_mask;
	u64			timestamp;
};

struct ata_ering {
	int			cursor;
	struct ata_ering_entry	ring[ATA_ERING_SIZE];
};

L
Linus Torvalds 已提交
443
struct ata_device {
T
Tejun Heo 已提交
444
	struct ata_link		*link;
445
	unsigned int		devno;		/* 0 or 1 */
L
Linus Torvalds 已提交
446
	unsigned long		flags;		/* ATA_DFLAG_xxx */
T
Tejun Heo 已提交
447
	unsigned int		horkage;	/* List of broken features */
448
	struct scsi_device	*sdev;		/* attached SCSI device */
449 450 451
#ifdef CONFIG_ATA_ACPI
	acpi_handle		acpi_handle;
#endif
452 453
	/* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */
	u64			n_sectors;	/* size of device, if ATA */
L
Linus Torvalds 已提交
454
	unsigned int		class;		/* ATA_DEV_xxx */
455
	u16			id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
L
Linus Torvalds 已提交
456 457 458 459 460
	u8			pio_mode;
	u8			dma_mode;
	u8			xfer_mode;
	unsigned int		xfer_shift;	/* ATA_SHIFT_xxx */

461 462
	unsigned int		multi_count;	/* sectors count for
						   READ/WRITE MULTIPLE */
463
	unsigned int		max_sectors;	/* per-device max sectors */
464
	unsigned int		cdb_len;
465

466 467 468 469 470
	/* per-dev xfer mask */
	unsigned int		pio_mask;
	unsigned int		mwdma_mask;
	unsigned int		udma_mask;

471 472 473 474
	/* for CHS addressing */
	u16			cylinders;	/* Number of cylinders */
	u16			heads;		/* Number of heads */
	u16			sectors;	/* Number of sectors per track */
475 476 477

	/* error history */
	struct ata_ering	ering;
478
	int			spdn_cnt;
L
Linus Torvalds 已提交
479 480
};

481 482 483 484 485
/* Offset into struct ata_device.  Fields above it are maintained
 * acress device init.  Fields below are zeroed.
 */
#define ATA_DEVICE_CLEAR_OFFSET		offsetof(struct ata_device, n_sectors)

486 487 488 489 490
struct ata_eh_info {
	struct ata_device	*dev;		/* offending device */
	u32			serror;		/* SError from LLDD */
	unsigned int		err_mask;	/* port-wide err_mask */
	unsigned int		action;		/* ATA_EH_* action mask */
491
	unsigned int		dev_action[ATA_MAX_DEVICES]; /* dev EH action */
492
	unsigned int		flags;		/* ATA_EHI_* flags */
493 494 495

	unsigned int		probe_mask;

496 497 498 499 500 501 502
	char			desc[ATA_EH_DESC_LEN];
	int			desc_len;
};

struct ata_eh_context {
	struct ata_eh_info	i;
	int			tries[ATA_MAX_DEVICES];
503 504
	unsigned int		classes[ATA_MAX_DEVICES];
	unsigned int		did_probe_mask;
505 506
};

507 508 509 510 511 512 513 514 515 516 517
struct ata_acpi_drive
{
	u32 pio;
	u32 dma;
} __packed;

struct ata_acpi_gtm {
	struct ata_acpi_drive drive[2];
	u32 flags;
} __packed;

T
Tejun Heo 已提交
518 519
struct ata_link {
	struct ata_port		*ap;
T
Tejun Heo 已提交
520
	int			pmp;		/* port multiplier port # */
T
Tejun Heo 已提交
521 522 523 524

	unsigned int		active_tag;	/* active tag on this link */
	u32			sactive;	/* active NCQ commands */

525 526
	unsigned int		flags;		/* ATA_LFLAG_xxx */

T
Tejun Heo 已提交
527 528 529 530 531 532 533 534 535 536 537 538
	unsigned int		hw_sata_spd_limit;
	unsigned int		sata_spd_limit;
	unsigned int		sata_spd;	/* current SATA PHY speed */

	/* record runtime error info, protected by host_set lock */
	struct ata_eh_info	eh_info;
	/* EH context */
	struct ata_eh_context	eh_context;

	struct ata_device	device[ATA_MAX_DEVICES];
};

L
Linus Torvalds 已提交
539
struct ata_port {
J
Jeff Garzik 已提交
540
	struct Scsi_Host	*scsi_host; /* our co-allocated scsi host */
J
Jeff Garzik 已提交
541
	const struct ata_port_operations *ops;
542
	spinlock_t		*lock;
L
Linus Torvalds 已提交
543
	unsigned long		flags;	/* ATA_FLAG_xxx */
544
	unsigned int		pflags; /* ATA_PFLAG_xxx */
T
Tejun Heo 已提交
545 546
	unsigned int		print_id; /* user visible unique port ID */
	unsigned int		port_no; /* 0 based port no. inside the host */
L
Linus Torvalds 已提交
547 548 549 550

	struct ata_prd		*prd;	 /* our SG list */
	dma_addr_t		prd_dma; /* and its DMA mapping */

551 552 553
	void			*pad;	/* array of DMA pad buffers */
	dma_addr_t		pad_dma;

L
Linus Torvalds 已提交
554 555 556 557 558 559 560 561 562 563
	struct ata_ioports	ioaddr;	/* ATA cmd/ctl/dma register blocks */

	u8			ctl;	/* cache of ATA control register */
	u8			last_ctl;	/* Cache last written value */
	unsigned int		pio_mask;
	unsigned int		mwdma_mask;
	unsigned int		udma_mask;
	unsigned int		cbl;	/* cable type; ATA_CBL_xxx */

	struct ata_queued_cmd	qcmd[ATA_MAX_QUEUE];
564
	unsigned long		qc_allocated;
565 566
	unsigned int		qc_active;

T
Tejun Heo 已提交
567
	struct ata_link		link;	/* host default link */
L
Linus Torvalds 已提交
568

T
Tejun Heo 已提交
569 570 571
	int			nr_pmp_links;	/* nr of available PMP links */
	struct ata_link		*pmp_link;	/* array of PMP links */

J
Jeff Garzik 已提交
572 573
	struct ata_port_stats	stats;
	struct ata_host		*host;
574
	struct device 		*dev;
L
Linus Torvalds 已提交
575

576
	void			*port_task_data;
577 578
	struct delayed_work	port_task;
	struct delayed_work	hotplug_task;
579
	struct work_struct	scsi_rescan_task;
T
Tejun Heo 已提交
580

A
Albert Lee 已提交
581
	unsigned int		hsm_task_state;
L
Linus Torvalds 已提交
582

583
	u32			msg_enable;
584
	struct list_head	eh_done_q;
585
	wait_queue_head_t	eh_wait_q;
586

587 588 589
	pm_message_t		pm_mesg;
	int			*pm_result;

T
Tejun Heo 已提交
590 591 592
	struct timer_list	fastdrain_timer;
	unsigned long		fastdrain_cnt;

L
Linus Torvalds 已提交
593
	void			*private_data;
594

595 596
#ifdef CONFIG_ATA_ACPI
	acpi_handle		acpi_handle;
597
	struct ata_acpi_gtm	acpi_gtm;
598
#endif
599
	u8			sector_buf[ATA_SECT_SIZE]; /* owned by EH */
L
Linus Torvalds 已提交
600 601 602 603 604
};

struct ata_port_operations {
	void (*port_disable) (struct ata_port *);

605
	void (*dev_config) (struct ata_device *);
L
Linus Torvalds 已提交
606 607 608

	void (*set_piomode) (struct ata_port *, struct ata_device *);
	void (*set_dmamode) (struct ata_port *, struct ata_device *);
609
	unsigned long (*mode_filter) (struct ata_device *, unsigned long);
L
Linus Torvalds 已提交
610

J
Jeff Garzik 已提交
611
	void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
L
Linus Torvalds 已提交
612 613
	void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);

J
Jeff Garzik 已提交
614
	void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
L
Linus Torvalds 已提交
615 616 617 618
	u8   (*check_status)(struct ata_port *ap);
	u8   (*check_altstatus)(struct ata_port *ap);
	void (*dev_select)(struct ata_port *ap, unsigned int device);

619
	void (*phy_reset) (struct ata_port *ap); /* obsolete */
620
	int  (*set_mode) (struct ata_link *link, struct ata_device **r_failed_dev);
621

A
Alan Cox 已提交
622 623
	int (*cable_detect) (struct ata_port *ap);

A
Alan 已提交
624
	int  (*check_atapi_dma) (struct ata_queued_cmd *qc);
L
Linus Torvalds 已提交
625 626 627 628

	void (*bmdma_setup) (struct ata_queued_cmd *qc);
	void (*bmdma_start) (struct ata_queued_cmd *qc);

629 630
	void (*data_xfer) (struct ata_device *, unsigned char *, unsigned int, int);

L
Linus Torvalds 已提交
631
	void (*qc_prep) (struct ata_queued_cmd *qc);
632
	unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
L
Linus Torvalds 已提交
633

634 635 636 637 638 639 640 641 642
	/* Error handlers.  ->error_handler overrides ->eng_timeout and
	 * indicates that new-style EH is in place.
	 */
	void (*eng_timeout) (struct ata_port *ap); /* obsolete */

	void (*freeze) (struct ata_port *ap);
	void (*thaw) (struct ata_port *ap);
	void (*error_handler) (struct ata_port *ap);
	void (*post_internal_cmd) (struct ata_queued_cmd *qc);
L
Linus Torvalds 已提交
643

644
	irq_handler_t irq_handler;
L
Linus Torvalds 已提交
645
	void (*irq_clear) (struct ata_port *);
646
	u8 (*irq_on) (struct ata_port *);
L
Linus Torvalds 已提交
647

648 649
	int (*scr_read) (struct ata_port *ap, unsigned int sc_reg, u32 *val);
	int (*scr_write) (struct ata_port *ap, unsigned int sc_reg, u32 val);
L
Linus Torvalds 已提交
650

651 652 653
	int (*port_suspend) (struct ata_port *ap, pm_message_t mesg);
	int (*port_resume) (struct ata_port *ap);

L
Linus Torvalds 已提交
654 655 656
	int (*port_start) (struct ata_port *ap);
	void (*port_stop) (struct ata_port *ap);

J
Jeff Garzik 已提交
657
	void (*host_stop) (struct ata_host *host);
L
Linus Torvalds 已提交
658

659
	void (*bmdma_stop) (struct ata_queued_cmd *qc);
L
Linus Torvalds 已提交
660 661 662 663
	u8   (*bmdma_status) (struct ata_port *ap);
};

struct ata_port_info {
664
	struct scsi_host_template	*sht;
J
Jeff Garzik 已提交
665
	unsigned long		flags;
666
	unsigned long		link_flags;
L
Linus Torvalds 已提交
667 668 669
	unsigned long		pio_mask;
	unsigned long		mwdma_mask;
	unsigned long		udma_mask;
J
Jeff Garzik 已提交
670
	const struct ata_port_operations *port_ops;
671
	irq_handler_t		irq_handler;
672
	void 			*private_data;
L
Linus Torvalds 已提交
673 674
};

A
Alan Cox 已提交
675 676 677 678 679 680 681 682 683 684 685 686 687
struct ata_timing {
	unsigned short mode;		/* ATA mode */
	unsigned short setup;		/* t1 */
	unsigned short act8b;		/* t2 for 8-bit I/O */
	unsigned short rec8b;		/* t2i for 8-bit I/O */
	unsigned short cyc8b;		/* t0 for 8-bit I/O */
	unsigned short active;		/* t2 or tD */
	unsigned short recover;		/* t2i or tK */
	unsigned short cycle;		/* t0 */
	unsigned short udma;		/* t2CYCTYP/2 */
};

#define FIT(v,vmin,vmax)	max_t(short,min_t(short,v,vmax),vmin)
L
Linus Torvalds 已提交
688

689 690 691 692
extern const unsigned long sata_deb_timing_normal[];
extern const unsigned long sata_deb_timing_hotplug[];
extern const unsigned long sata_deb_timing_long[];

T
Tejun Heo 已提交
693
extern const struct ata_port_operations ata_dummy_port_ops;
694
extern const struct ata_port_info ata_dummy_port_info;
T
Tejun Heo 已提交
695

696 697 698 699 700 701 702 703
static inline const unsigned long *
sata_ehc_deb_timing(struct ata_eh_context *ehc)
{
	if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
		return sata_deb_timing_hotplug;
	else
		return sata_deb_timing_normal;
}
704

T
Tejun Heo 已提交
705 706 707 708 709
static inline int ata_port_is_dummy(struct ata_port *ap)
{
	return ap->ops == &ata_dummy_port_ops;
}

710
extern void sata_print_link_status(struct ata_link *link);
L
Linus Torvalds 已提交
711 712 713 714
extern void ata_port_probe(struct ata_port *);
extern void __sata_phy_reset(struct ata_port *ap);
extern void sata_phy_reset(struct ata_port *ap);
extern void ata_bus_reset(struct ata_port *ap);
715 716 717 718 719
extern int sata_set_spd(struct ata_link *link);
extern int sata_link_debounce(struct ata_link *link,
			const unsigned long *params, unsigned long deadline);
extern int sata_link_resume(struct ata_link *link, const unsigned long *params,
			    unsigned long deadline);
T
Tejun Heo 已提交
720 721
extern int ata_std_prereset(struct ata_link *link, unsigned long deadline);
extern int ata_std_softreset(struct ata_link *link, unsigned int *classes,
722
			     unsigned long deadline);
T
Tejun Heo 已提交
723 724 725
extern int sata_link_hardreset(struct ata_link *link,
			const unsigned long *timing, unsigned long deadline);
extern int sata_std_hardreset(struct ata_link *link, unsigned int *class,
726
			      unsigned long deadline);
T
Tejun Heo 已提交
727
extern void ata_std_postreset(struct ata_link *link, unsigned int *classes);
L
Linus Torvalds 已提交
728 729 730
extern void ata_port_disable(struct ata_port *);
extern void ata_std_ports(struct ata_ioports *ioaddr);
#ifdef CONFIG_PCI
T
Tejun Heo 已提交
731 732
extern int ata_pci_init_one (struct pci_dev *pdev,
			     const struct ata_port_info * const * ppi);
L
Linus Torvalds 已提交
733
extern void ata_pci_remove_one (struct pci_dev *pdev);
734
#ifdef CONFIG_PM
735
extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
736
extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
737
extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
J
Jens Axboe 已提交
738
extern int ata_pci_device_resume(struct pci_dev *pdev);
739
#endif
740
extern int ata_pci_clear_simplex(struct pci_dev *pdev);
L
Linus Torvalds 已提交
741
#endif /* CONFIG_PCI */
742
extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
743 744
extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
			const struct ata_port_info * const * ppi, int n_ports);
745
extern int ata_host_start(struct ata_host *host);
746 747
extern int ata_host_register(struct ata_host *host,
			     struct scsi_host_template *sht);
748 749 750
extern int ata_host_activate(struct ata_host *host, int irq,
			     irq_handler_t irq_handler, unsigned long irq_flags,
			     struct scsi_host_template *sht);
T
Tejun Heo 已提交
751
extern void ata_host_detach(struct ata_host *host);
J
Jeff Garzik 已提交
752 753
extern void ata_host_init(struct ata_host *, struct device *,
			  unsigned long, const struct ata_port_operations *);
754
extern int ata_scsi_detect(struct scsi_host_template *sht);
L
Linus Torvalds 已提交
755 756
extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
757
extern void ata_scsi_media_change_notify(struct ata_device *atadev);
758
extern void ata_sas_port_destroy(struct ata_port *);
J
Jeff Garzik 已提交
759
extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
760 761 762 763 764 765 766
					   struct ata_port_info *, struct Scsi_Host *);
extern int ata_sas_port_init(struct ata_port *);
extern int ata_sas_port_start(struct ata_port *ap);
extern void ata_sas_port_stop(struct ata_port *ap);
extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
			    struct ata_port *ap);
L
Linus Torvalds 已提交
767
extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
768 769 770 771 772 773
extern int sata_scr_valid(struct ata_link *link);
extern int sata_scr_read(struct ata_link *link, int reg, u32 *val);
extern int sata_scr_write(struct ata_link *link, int reg, u32 val);
extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val);
extern int ata_link_online(struct ata_link *link);
extern int ata_link_offline(struct ata_link *link);
774
#ifdef CONFIG_PM
J
Jeff Garzik 已提交
775 776
extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
extern void ata_host_resume(struct ata_host *host);
777
#endif
778
extern int ata_ratelimit(void);
779 780
extern int ata_busy_sleep(struct ata_port *ap,
			  unsigned long timeout_pat, unsigned long timeout);
781
extern int ata_wait_ready(struct ata_port *ap, unsigned long deadline);
782
extern void ata_port_queue_task(struct ata_port *ap, work_func_t fn,
T
Tejun Heo 已提交
783
				void *data, unsigned long delay);
784 785 786
extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
			     unsigned long interval_msec,
			     unsigned long timeout_msec);
A
Akira Iguchi 已提交
787
extern unsigned int ata_dev_try_classify(struct ata_port *, unsigned int, u8 *);
788

L
Linus Torvalds 已提交
789 790 791
/*
 * Default driver ops implementations
 */
J
Jeff Garzik 已提交
792
extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
L
Linus Torvalds 已提交
793
extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
794 795
extern void ata_tf_to_fis(const struct ata_taskfile *tf,
			  u8 pmp, int is_cmd, u8 *fis);
J
Jeff Garzik 已提交
796
extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
L
Linus Torvalds 已提交
797 798 799 800
extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
extern u8 ata_check_status(struct ata_port *ap);
extern u8 ata_altstatus(struct ata_port *ap);
J
Jeff Garzik 已提交
801
extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
L
Linus Torvalds 已提交
802
extern int ata_port_start (struct ata_port *ap);
803
extern int ata_sff_port_start (struct ata_port *ap);
804
extern irqreturn_t ata_interrupt (int irq, void *dev_instance);
T
Tejun Heo 已提交
805 806 807 808
extern void ata_data_xfer(struct ata_device *adev, unsigned char *buf,
			  unsigned int buflen, int write_data);
extern void ata_data_xfer_noirq(struct ata_device *adev, unsigned char *buf,
				unsigned int buflen, int write_data);
809
extern void ata_dumb_qc_prep(struct ata_queued_cmd *qc);
L
Linus Torvalds 已提交
810
extern void ata_qc_prep(struct ata_queued_cmd *qc);
811
extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
812
extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
L
Linus Torvalds 已提交
813 814 815 816
extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
		unsigned int buflen);
extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
		 unsigned int n_elem);
J
Jeff Garzik 已提交
817
extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
818
extern void ata_dev_disable(struct ata_device *adev);
819 820 821 822
extern void ata_id_string(const u16 *id, unsigned char *s,
			  unsigned int ofs, unsigned int len);
extern void ata_id_c_string(const u16 *id, unsigned char *s,
			    unsigned int ofs, unsigned int len);
823
extern void ata_id_to_dma_mode(struct ata_device *dev, u8 unknown);
L
Linus Torvalds 已提交
824 825
extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
extern void ata_bmdma_start (struct ata_queued_cmd *qc);
826
extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
L
Linus Torvalds 已提交
827 828
extern u8   ata_bmdma_status(struct ata_port *ap);
extern void ata_bmdma_irq_clear(struct ata_port *ap);
829 830
extern void ata_bmdma_freeze(struct ata_port *ap);
extern void ata_bmdma_thaw(struct ata_port *ap);
831
extern void ata_bmdma_drive_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
832 833 834 835 836
			       ata_reset_fn_t softreset,
			       ata_reset_fn_t hardreset,
			       ata_postreset_fn_t postreset);
extern void ata_bmdma_error_handler(struct ata_port *ap);
extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
837 838
extern int ata_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
			u8 status, int in_wq);
839
extern void ata_qc_complete(struct ata_queued_cmd *qc);
840 841
extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active,
				    void (*finish_qc)(struct ata_queued_cmd *));
T
Tejun Heo 已提交
842
extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
L
Linus Torvalds 已提交
843 844 845 846 847
			      void (*done)(struct scsi_cmnd *));
extern int ata_std_bios_param(struct scsi_device *sdev,
			      struct block_device *bdev,
			      sector_t capacity, int geom[]);
extern int ata_scsi_slave_config(struct scsi_device *sdev);
848
extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
849 850
extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
				       int queue_depth);
T
Tejun Heo 已提交
851
extern struct ata_device *ata_dev_pair(struct ata_device *adev);
852
extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
853
extern u8 ata_irq_on(struct ata_port *ap);
L
Linus Torvalds 已提交
854

A
Alan Cox 已提交
855 856 857 858 859
extern int ata_cable_40wire(struct ata_port *ap);
extern int ata_cable_80wire(struct ata_port *ap);
extern int ata_cable_sata(struct ata_port *ap);
extern int ata_cable_unknown(struct ata_port *ap);

A
Alan Cox 已提交
860 861 862
/*
 * Timing helpers
 */
863 864

extern unsigned int ata_pio_need_iordy(const struct ata_device *);
A
Alan Cox 已提交
865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887
extern int ata_timing_compute(struct ata_device *, unsigned short,
			      struct ata_timing *, int, int);
extern void ata_timing_merge(const struct ata_timing *,
			     const struct ata_timing *, struct ata_timing *,
			     unsigned int);

enum {
	ATA_TIMING_SETUP	= (1 << 0),
	ATA_TIMING_ACT8B	= (1 << 1),
	ATA_TIMING_REC8B	= (1 << 2),
	ATA_TIMING_CYC8B	= (1 << 3),
	ATA_TIMING_8BIT		= ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
				  ATA_TIMING_CYC8B,
	ATA_TIMING_ACTIVE	= (1 << 4),
	ATA_TIMING_RECOVER	= (1 << 5),
	ATA_TIMING_CYCLE	= (1 << 6),
	ATA_TIMING_UDMA		= (1 << 7),
	ATA_TIMING_ALL		= ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
				  ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
				  ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
				  ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
};

L
Linus Torvalds 已提交
888 889 890 891 892 893 894 895 896

#ifdef CONFIG_PCI
struct pci_bits {
	unsigned int		reg;	/* PCI config register to read */
	unsigned int		width;	/* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
	unsigned long		mask;
	unsigned long		val;
};

897
extern int ata_pci_init_sff_host(struct ata_host *host);
T
Tejun Heo 已提交
898
extern int ata_pci_init_bmdma(struct ata_host *host);
899 900 901
extern int ata_pci_prepare_sff_host(struct pci_dev *pdev,
				    const struct ata_port_info * const * ppi,
				    struct ata_host **r_host);
J
Jeff Garzik 已提交
902
extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
903
extern unsigned long ata_pci_default_filter(struct ata_device *, unsigned long);
L
Linus Torvalds 已提交
904 905
#endif /* CONFIG_PCI */

906 907 908 909
/*
 * EH
 */
extern void ata_eng_timeout(struct ata_port *ap);
910 911

extern void ata_port_schedule_eh(struct ata_port *ap);
912
extern int ata_link_abort(struct ata_link *link);
913
extern int ata_port_abort(struct ata_port *ap);
914 915 916 917
extern int ata_port_freeze(struct ata_port *ap);

extern void ata_eh_freeze_port(struct ata_port *ap);
extern void ata_eh_thaw_port(struct ata_port *ap);
918

919 920 921
extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);

922 923 924
extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
		      ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
		      ata_postreset_fn_t postreset);
T
Tejun Heo 已提交
925

926 927 928 929
/*
 * printk helpers
 */
#define ata_port_printk(ap, lv, fmt, args...) \
T
Tejun Heo 已提交
930
	printk(lv"ata%u: "fmt, (ap)->print_id , ##args)
931

T
Tejun Heo 已提交
932 933 934 935 936 937 938
#define ata_link_printk(link, lv, fmt, args...) do { \
	if ((link)->ap->nr_pmp_links) \
		printk(lv"ata%u.%02u: "fmt, (link)->ap->print_id, \
		       (link)->pmp , ##args); \
	else \
		printk(lv"ata%u: "fmt, (link)->ap->print_id , ##args); \
	} while(0)
T
Tejun Heo 已提交
939

940
#define ata_dev_printk(dev, lv, fmt, args...) \
T
Tejun Heo 已提交
941 942
	printk(lv"ata%u.%02u: "fmt, (dev)->link->ap->print_id, \
	       (dev)->link->pmp + (dev)->devno , ##args)
L
Linus Torvalds 已提交
943

944 945 946
/*
 * ata_eh_info helpers
 */
947 948 949 950
extern void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...)
	__attribute__ ((format (printf, 2, 3)));
extern void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...)
	__attribute__ ((format (printf, 2, 3)));
T
Tejun Heo 已提交
951
extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
952

953
static inline void ata_ehi_schedule_probe(struct ata_eh_info *ehi)
T
Tejun Heo 已提交
954
{
955
	ehi->flags |= ATA_EHI_RESUME_LINK;
T
Tejun Heo 已提交
956 957 958 959
	ehi->action |= ATA_EH_SOFTRESET;
	ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
}

960 961
static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
{
962 963
	ata_ehi_schedule_probe(ehi);
	ehi->flags |= ATA_EHI_HOTPLUGGED;
964 965 966
	ehi->err_mask |= AC_ERR_ATA_BUS;
}

967 968 969
/*
 * qc helpers
 */
970 971 972 973 974 975 976 977 978 979 980 981
static inline int
ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
{
	if (sg == &qc->pad_sgent)
		return 1;
	if (qc->pad_len)
		return 0;
	if (((sg - qc->__sg) + 1) == qc->n_elem)
		return 1;
	return 0;
}

982 983 984 985 986 987 988 989 990 991
static inline struct scatterlist *
ata_qc_first_sg(struct ata_queued_cmd *qc)
{
	if (qc->n_elem)
		return qc->__sg;
	if (qc->pad_len)
		return &qc->pad_sgent;
	return NULL;
}

992 993 994 995 996 997 998
static inline struct scatterlist *
ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
{
	if (sg == &qc->pad_sgent)
		return NULL;
	if (++sg - qc->__sg < qc->n_elem)
		return sg;
999 1000 1001
	if (qc->pad_len)
		return &qc->pad_sgent;
	return NULL;
1002 1003 1004
}

#define ata_for_each_sg(sg, qc) \
1005
	for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
1006

L
Linus Torvalds 已提交
1007 1008 1009 1010 1011
static inline unsigned int ata_tag_valid(unsigned int tag)
{
	return (tag < ATA_MAX_QUEUE) ? 1 : 0;
}

1012 1013 1014 1015 1016
static inline unsigned int ata_tag_internal(unsigned int tag)
{
	return tag == ATA_MAX_QUEUE - 1;
}

1017 1018 1019
/*
 * device helpers
 */
1020
static inline unsigned int ata_class_enabled(unsigned int class)
1021 1022 1023 1024
{
	return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI;
}

1025
static inline unsigned int ata_class_disabled(unsigned int class)
L
Linus Torvalds 已提交
1026
{
1027 1028 1029
	return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP;
}

1030 1031 1032 1033 1034
static inline unsigned int ata_class_absent(unsigned int class)
{
	return !ata_class_enabled(class) && !ata_class_disabled(class);
}

1035 1036 1037 1038 1039 1040 1041 1042
static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
{
	return ata_class_enabled(dev->class);
}

static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
{
	return ata_class_disabled(dev->class);
L
Linus Torvalds 已提交
1043 1044
}

1045 1046 1047 1048 1049
static inline unsigned int ata_dev_absent(const struct ata_device *dev)
{
	return ata_class_absent(dev->class);
}

1050
/*
1051
 * link helpers
1052
 */
T
Tejun Heo 已提交
1053 1054 1055 1056 1057
static inline int ata_is_host_link(const struct ata_link *link)
{
	return link == &link->ap->link;
}

1058
static inline int ata_link_max_devices(const struct ata_link *link)
1059
{
T
Tejun Heo 已提交
1060
	if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS)
1061 1062 1063 1064
		return 2;
	return 1;
}

T
Tejun Heo 已提交
1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092
static inline struct ata_link *ata_port_first_link(struct ata_port *ap)
{
	if (ap->nr_pmp_links)
		return ap->pmp_link;
	return &ap->link;
}

static inline struct ata_link *ata_port_next_link(struct ata_link *link)
{
	struct ata_port *ap = link->ap;

	if (link == &ap->link) {
		if (!ap->nr_pmp_links)
			return NULL;
		return ap->pmp_link;
	}

	if (++link - ap->pmp_link < ap->nr_pmp_links)
		return link;
	return NULL;
}

#define __ata_port_for_each_link(lk, ap) \
	for ((lk) = &(ap)->link; (lk); (lk) = ata_port_next_link(lk))

#define ata_port_for_each_link(link, ap) \
	for ((link) = ata_port_first_link(ap); (link); \
	     (link) = ata_port_next_link(link))
1093 1094 1095 1096 1097 1098 1099 1100 1101

#define ata_link_for_each_dev(dev, link) \
	for ((dev) = (link)->device; \
	     (dev) < (link)->device + ata_link_max_devices(link) || ((dev) = NULL); \
	     (dev)++)

#define ata_link_for_each_dev_reverse(dev, link) \
	for ((dev) = (link)->device + ata_link_max_devices(link) - 1; \
	     (dev) >= (link)->device || ((dev) = NULL); (dev)--)
1102

L
Linus Torvalds 已提交
1103 1104 1105 1106 1107
static inline u8 ata_chk_status(struct ata_port *ap)
{
	return ap->ops->check_status(ap);
}

1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122
/**
 *	ata_ncq_enabled - Test whether NCQ is enabled
 *	@dev: ATA device to test for
 *
 *	LOCKING:
 *	spin_lock_irqsave(host lock)
 *
 *	RETURNS:
 *	1 if NCQ is enabled for @dev, 0 otherwise.
 */
static inline int ata_ncq_enabled(struct ata_device *dev)
{
	return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
			      ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
}
E
Edward Falk 已提交
1123 1124 1125 1126 1127 1128 1129 1130 1131

/**
 *	ata_pause - Flush writes and pause 400 nanoseconds.
 *	@ap: Port to wait for.
 *
 *	LOCKING:
 *	Inherited from caller.
 */

L
Linus Torvalds 已提交
1132 1133 1134 1135 1136 1137
static inline void ata_pause(struct ata_port *ap)
{
	ata_altstatus(ap);
	ndelay(400);
}

E
Edward Falk 已提交
1138 1139 1140 1141

/**
 *	ata_busy_wait - Wait for a port status register
 *	@ap: Port to wait for.
A
Alan 已提交
1142 1143
 *	@bits: bits that must be clear
 *	@max: number of 10uS waits to perform
E
Edward Falk 已提交
1144 1145 1146 1147 1148 1149 1150 1151 1152
 *
 *	Waits up to max*10 microseconds for the selected bits in the port's
 *	status register to be cleared.
 *	Returns final value of status register.
 *
 *	LOCKING:
 *	Inherited from caller.
 */

L
Linus Torvalds 已提交
1153 1154 1155 1156 1157 1158 1159 1160 1161
static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
			       unsigned int max)
{
	u8 status;

	do {
		udelay(10);
		status = ata_chk_status(ap);
		max--;
1162
	} while (status != 0xff && (status & bits) && (max > 0));
L
Linus Torvalds 已提交
1163 1164 1165 1166

	return status;
}

E
Edward Falk 已提交
1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178

/**
 *	ata_wait_idle - Wait for a port to be idle.
 *	@ap: Port to wait for.
 *
 *	Waits up to 10ms for port's BUSY and DRQ signals to clear.
 *	Returns final value of status register.
 *
 *	LOCKING:
 *	Inherited from caller.
 */

L
Linus Torvalds 已提交
1179 1180 1181 1182
static inline u8 ata_wait_idle(struct ata_port *ap)
{
	u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);

1183
#ifdef ATA_DEBUG
1184
	if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
1185 1186 1187
		ata_port_printk(ap, KERN_DEBUG, "abnormal Status 0x%X\n",
				status);
#endif
L
Linus Torvalds 已提交
1188 1189 1190 1191 1192 1193 1194 1195 1196

	return status;
}

static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
{
	qc->tf.ctl |= ATA_NIEN;
}

1197 1198
static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
						       unsigned int tag)
L
Linus Torvalds 已提交
1199 1200 1201 1202 1203 1204
{
	if (likely(ata_tag_valid(tag)))
		return &ap->qcmd[tag];
	return NULL;
}

1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219
static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
						     unsigned int tag)
{
	struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);

	if (unlikely(!qc) || !ap->ops->error_handler)
		return qc;

	if ((qc->flags & (ATA_QCFLAG_ACTIVE |
			  ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
		return qc;

	return NULL;
}

T
Tejun Heo 已提交
1220
static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
L
Linus Torvalds 已提交
1221 1222 1223
{
	memset(tf, 0, sizeof(*tf));

T
Tejun Heo 已提交
1224
	tf->ctl = dev->link->ap->ctl;
T
Tejun Heo 已提交
1225
	if (dev->devno == 0)
L
Linus Torvalds 已提交
1226 1227 1228 1229 1230
		tf->device = ATA_DEVICE_OBS;
	else
		tf->device = ATA_DEVICE_OBS | ATA_DEV1;
}

J
Jeff Garzik 已提交
1231 1232
static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
{
1233
	qc->dma_dir = DMA_NONE;
J
Jeff Garzik 已提交
1234 1235
	qc->__sg = NULL;
	qc->flags = 0;
T
Tejun Heo 已提交
1236
	qc->cursg = qc->cursg_ofs = 0;
J
Jeff Garzik 已提交
1237
	qc->nbytes = qc->curbytes = 0;
B
Brian King 已提交
1238
	qc->n_elem = 0;
1239
	qc->err_mask = 0;
B
Brian King 已提交
1240
	qc->pad_len = 0;
1241
	qc->sect_size = ATA_SECT_SIZE;
J
Jeff Garzik 已提交
1242

T
Tejun Heo 已提交
1243
	ata_tf_init(qc->dev, &qc->tf);
1244 1245 1246 1247

	/* init result_tf such that it indicates normal completion */
	qc->result_tf.command = ATA_DRDY;
	qc->result_tf.feature = 0;
J
Jeff Garzik 已提交
1248 1249
}

J
Jeff Garzik 已提交
1250
static inline int ata_try_flush_cache(const struct ata_device *dev)
L
Linus Torvalds 已提交
1251 1252 1253 1254 1255 1256
{
	return ata_id_wcache_enabled(dev->id) ||
	       ata_id_has_flush(dev->id) ||
	       ata_id_has_flush_ext(dev->id);
}

1257 1258
static inline unsigned int ac_err_mask(u8 status)
{
1259
	if (status & (ATA_BUSY | ATA_DRQ))
1260
		return AC_ERR_HSM;
1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273
	if (status & (ATA_ERR | ATA_DF))
		return AC_ERR_DEV;
	return 0;
}

static inline unsigned int __ac_err_mask(u8 status)
{
	unsigned int mask = ac_err_mask(status);
	if (mask == 0)
		return AC_ERR_OTHER;
	return mask;
}

1274 1275 1276
static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
{
	ap->pad_dma = 0;
1277 1278
	ap->pad = dmam_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
				      &ap->pad_dma, GFP_KERNEL);
1279 1280 1281 1282 1283
	return (ap->pad == NULL) ? -ENOMEM : 0;
}

static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
{
1284
	dmam_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
1285 1286
}

1287 1288
static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
{
1289
	return *(struct ata_port **)&host->hostdata[0];
1290 1291
}

L
Linus Torvalds 已提交
1292
#endif /* __LINUX_LIBATA_H__ */