libata.h 42.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), /* AN configured */
143
	ATA_DFLAG_CFG_MASK	= (1 << 12) - 1,
T
Tejun Heo 已提交
144

145 146 147
	ATA_DFLAG_PIO		= (1 << 12), /* device limited to PIO mode */
	ATA_DFLAG_NCQ_OFF	= (1 << 13), /* device limited to non-NCQ mode */
	ATA_DFLAG_SPUNDOWN	= (1 << 14), /* 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
	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) */
158 159 160 161 162
	ATA_DEV_PMP		= 5,	/* SATA port multiplier */
	ATA_DEV_PMP_UNSUP	= 6,	/* SATA port multiplier (unsupported) */
	ATA_DEV_SEMB		= 7,	/* SEMB */
	ATA_DEV_SEMB_UNSUP	= 8,	/* SEMB (unsupported) */
	ATA_DEV_NONE		= 9,	/* no device */
L
Linus Torvalds 已提交
163

164 165 166 167
	/* 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 */
168 169 170 171
	ATA_LFLAG_NO_SRST	= (1 << 2), /* avoid softreset */
	ATA_LFLAG_ASSUME_ATA	= (1 << 3), /* assume ATA class */
	ATA_LFLAG_ASSUME_SEMB	= (1 << 4), /* assume SEMB class */
	ATA_LFLAG_ASSUME_CLASS	= ATA_LFLAG_ASSUME_ATA | ATA_LFLAG_ASSUME_SEMB,
172
	ATA_LFLAG_NO_RETRY	= (1 << 5), /* don't retry this link */
173
	ATA_LFLAG_DISABLED	= (1 << 6), /* link is disabled */
174

L
Linus Torvalds 已提交
175
	/* struct ata_port flags */
T
Tejun Heo 已提交
176
	ATA_FLAG_SLAVE_POSS	= (1 << 0), /* host supports slave dev */
L
Linus Torvalds 已提交
177
					    /* (doesn't imply presence) */
T
Tejun Heo 已提交
178 179 180 181 182 183 184 185
	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 */
186 187 188 189
	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),
190
	ATA_FLAG_IGN_SIMPLEX	= (1 << 15), /* ignore SIMPLEX */
191
	ATA_FLAG_NO_IORDY	= (1 << 16), /* controller lacks iordy */
192
	ATA_FLAG_ACPI_SATA	= (1 << 17), /* need native SATA ACPI layout */
193
	ATA_FLAG_AN		= (1 << 18), /* controller supports AN */
194
	ATA_FLAG_PMP		= (1 << 19), /* controller supports PMP */
T
Tejun Heo 已提交
195

196 197 198 199 200 201 202
	/* 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 */
203

204 205 206 207 208 209 210 211
	/* 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 */
212
	ATA_PFLAG_INITIALIZING	= (1 << 7), /* being initialized, don't touch */
T
Tejun Heo 已提交
213

214
	ATA_PFLAG_SUSPENDED	= (1 << 17), /* port is suspended (power) */
215
	ATA_PFLAG_PM_PENDING	= (1 << 18), /* PM operation pending */
216
	ATA_PFLAG_GTM_VALID	= (1 << 19), /* acpi_gtm data valid */
T
Tejun Heo 已提交
217 218 219 220 221

	/* 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 已提交
222
	ATA_QCFLAG_DMAMAP	= ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE,
T
Tejun Heo 已提交
223
	ATA_QCFLAG_IO		= (1 << 3), /* standard IO command */
224
	ATA_QCFLAG_RESULT_TF	= (1 << 4), /* result TF requested */
225
	ATA_QCFLAG_CLEAR_EXCL	= (1 << 5), /* clear excl_link on completion */
226

227 228 229
	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 已提交
230

231
	/* host set flags */
J
Jeff Garzik 已提交
232
	ATA_HOST_SIMPLEX	= (1 << 0),	/* Host is simplex, one DMA channel per host only */
233
	ATA_HOST_STARTED	= (1 << 1),	/* Host started */
J
Jeff Garzik 已提交
234

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

L
Linus Torvalds 已提交
237
	/* various lengths of time */
238 239
	ATA_TMOUT_BOOT		= 30 * HZ,	/* heuristic */
	ATA_TMOUT_BOOT_QUICK	= 7 * HZ,	/* heuristic */
240 241
	ATA_TMOUT_INTERNAL	= 30 * HZ,
	ATA_TMOUT_INTERNAL_QUICK = 5 * HZ,
L
Linus Torvalds 已提交
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260

	/* 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
261
	 * unsigned int bitmap
L
Linus Torvalds 已提交
262
	 */
263 264
	ATA_BITS_PIO		= 7,
	ATA_BITS_MWDMA		= 5,
265 266 267 268 269 270 271 272 273
	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,
274 275 276 277

	/* 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 已提交
278

279 280 281
	/* ering size */
	ATA_ERING_SIZE		= 32,

282 283 284 285
	/* return values for ->qc_defer */
	ATA_DEFER_LINK		= 1,
	ATA_DEFER_PORT		= 2,

286 287 288
	/* desc_len for ata_eh_info and context */
	ATA_EH_DESC_LEN		= 80,

289 290 291 292
	/* reset / recovery action types */
	ATA_EH_REVALIDATE	= (1 << 0),
	ATA_EH_SOFTRESET	= (1 << 1),
	ATA_EH_HARDRESET	= (1 << 2),
293
	ATA_EH_ENABLE_LINK	= (1 << 3),
294 295

	ATA_EH_RESET_MASK	= ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
296
	ATA_EH_PERDEV_MASK	= ATA_EH_REVALIDATE,
297

298
	/* ata_eh_info->flags */
299
	ATA_EHI_HOTPLUGGED	= (1 << 0),  /* could have been hotplugged */
300
	ATA_EHI_RESUME_LINK	= (1 << 1),  /* resume link (reset modifier) */
301 302
	ATA_EHI_NO_AUTOPSY	= (1 << 2),  /* no autopsy */
	ATA_EHI_QUIET		= (1 << 3),  /* be quiet */
303

304 305 306 307 308
	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 */
309

310
	ATA_EHI_DID_RESET	= ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
311 312
	ATA_EHI_RESET_MODIFIER_MASK = ATA_EHI_RESUME_LINK,

313 314
	/* max tries if error condition is still set after ->error_handler */
	ATA_EH_MAX_TRIES	= 5,
315

316 317
	/* how hard are we gonna try to probe/recover devices */
	ATA_PROBE_MAX_TRIES	= 3,
T
Tejun Heo 已提交
318
	ATA_EH_DEV_TRIES	= 3,
319 320 321 322
	ATA_EH_PMP_TRIES	= 5,
	ATA_EH_PMP_LINK_TRIES	= 3,

	SATA_PMP_SCR_TIMEOUT	= 250,
323

324 325 326 327
	/* 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 */
328 329
	ATA_HORKAGE_NODMA	= (1 << 1),	/* DMA problems */
	ATA_HORKAGE_NONCQ	= (1 << 2),	/* Don't use NCQ */
330
	ATA_HORKAGE_MAX_SEC_128	= (1 << 3),	/* Limit max sects to 128 */
331
	ATA_HORKAGE_BROKEN_HPA	= (1 << 4),	/* Broken HPA */
332
	ATA_HORKAGE_SKIP_PM	= (1 << 5),	/* Skip PM operations */
333
	ATA_HORKAGE_HPA_SIZE	= (1 << 6),	/* native size off by one */
L
Linus Torvalds 已提交
334 335
};

A
Albert Lee 已提交
336
enum hsm_task_states {
337
	HSM_ST_IDLE,		/* no command on going */
338 339
	HSM_ST_FIRST,		/* (waiting the device to)
				   write CDB or first data block */
340 341 342
	HSM_ST,			/* (waiting the device to) transfer data */
	HSM_ST_LAST,		/* (waiting the device to) complete command */
	HSM_ST_ERR,		/* error */
L
Linus Torvalds 已提交
343 344
};

345
enum ata_completion_errors {
346 347 348 349 350 351 352 353 354
	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 */
355
	AC_ERR_NODEV_HINT	= (1 << 9), /* polling device detection hint */
T
Tejun Heo 已提交
356
	AC_ERR_NCQ		= (1 << 10), /* marker for offending NCQ qc */
357 358
};

L
Linus Torvalds 已提交
359 360 361 362
/* forward declarations */
struct scsi_device;
struct ata_port_operations;
struct ata_port;
T
Tejun Heo 已提交
363
struct ata_link;
L
Linus Torvalds 已提交
364 365 366
struct ata_queued_cmd;

/* typedefs */
367
typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
T
Tejun Heo 已提交
368 369
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,
370
			      unsigned long deadline);
T
Tejun Heo 已提交
371
typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes);
L
Linus Torvalds 已提交
372 373

struct ata_ioports {
T
Tejun Heo 已提交
374 375 376 377 378 379 380 381 382 383 384 385 386 387 388
	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 已提交
389 390
};

J
Jeff Garzik 已提交
391
struct ata_host {
L
Linus Torvalds 已提交
392 393
	spinlock_t		lock;
	struct device 		*dev;
T
Tejun Heo 已提交
394
	void __iomem * const	*iomap;
L
Linus Torvalds 已提交
395 396
	unsigned int		n_ports;
	void			*private_data;
J
Jeff Garzik 已提交
397
	const struct ata_port_operations *ops;
398
	unsigned long		flags;
399 400 401
#ifdef CONFIG_ATA_ACPI
	acpi_handle		acpi_handle;
#endif
A
Alan 已提交
402
	struct ata_port		*simplex_claimed;	/* channel owning the DMA */
403
	struct ata_port		*ports[0];
L
Linus Torvalds 已提交
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418
};

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;
419
	unsigned int		orig_n_elem;
L
Linus Torvalds 已提交
420 421 422

	int			dma_dir;

423
	unsigned int		pad_len;
424
	unsigned int		sect_size;
425

L
Linus Torvalds 已提交
426 427 428 429 430 431 432
	unsigned int		nbytes;
	unsigned int		curbytes;

	unsigned int		cursg;
	unsigned int		cursg_ofs;

	struct scatterlist	sgent;
433
	struct scatterlist	pad_sgent;
L
Linus Torvalds 已提交
434 435
	void			*buf_virt;

436 437
	/* DO NOT iterate over __sg manually, use ata_for_each_sg() */
	struct scatterlist	*__sg;
L
Linus Torvalds 已提交
438

439
	unsigned int		err_mask;
440
	struct ata_taskfile	result_tf;
L
Linus Torvalds 已提交
441 442 443
	ata_qc_cb_t		complete_fn;

	void			*private_data;
444
	void			*lldd_task;
L
Linus Torvalds 已提交
445 446
};

J
Jeff Garzik 已提交
447
struct ata_port_stats {
L
Linus Torvalds 已提交
448 449 450 451 452
	unsigned long		unhandled_irq;
	unsigned long		idle_irq;
	unsigned long		rw_reqbuf;
};

453 454 455 456 457 458 459 460 461 462 463
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 已提交
464
struct ata_device {
T
Tejun Heo 已提交
465
	struct ata_link		*link;
466
	unsigned int		devno;		/* 0 or 1 */
L
Linus Torvalds 已提交
467
	unsigned long		flags;		/* ATA_DFLAG_xxx */
T
Tejun Heo 已提交
468
	unsigned int		horkage;	/* List of broken features */
469
	struct scsi_device	*sdev;		/* attached SCSI device */
470 471 472
#ifdef CONFIG_ATA_ACPI
	acpi_handle		acpi_handle;
#endif
473 474
	/* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */
	u64			n_sectors;	/* size of device, if ATA */
L
Linus Torvalds 已提交
475
	unsigned int		class;		/* ATA_DEV_xxx */
476 477 478 479 480 481

	union {
		u16		id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
		u32		gscr[SATA_PMP_GSCR_DWORDS]; /* PMP GSCR block */
	};

L
Linus Torvalds 已提交
482 483 484 485 486
	u8			pio_mode;
	u8			dma_mode;
	u8			xfer_mode;
	unsigned int		xfer_shift;	/* ATA_SHIFT_xxx */

487 488
	unsigned int		multi_count;	/* sectors count for
						   READ/WRITE MULTIPLE */
489
	unsigned int		max_sectors;	/* per-device max sectors */
490
	unsigned int		cdb_len;
491

492 493 494 495 496
	/* per-dev xfer mask */
	unsigned int		pio_mask;
	unsigned int		mwdma_mask;
	unsigned int		udma_mask;

497 498 499 500
	/* for CHS addressing */
	u16			cylinders;	/* Number of cylinders */
	u16			heads;		/* Number of heads */
	u16			sectors;	/* Number of sectors per track */
501 502 503

	/* error history */
	struct ata_ering	ering;
504
	int			spdn_cnt;
L
Linus Torvalds 已提交
505 506
};

507 508 509 510 511
/* 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)

512 513 514 515 516
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 */
517
	unsigned int		dev_action[ATA_MAX_DEVICES]; /* dev EH action */
518
	unsigned int		flags;		/* ATA_EHI_* flags */
519 520 521

	unsigned int		probe_mask;

522 523 524 525 526 527 528
	char			desc[ATA_EH_DESC_LEN];
	int			desc_len;
};

struct ata_eh_context {
	struct ata_eh_info	i;
	int			tries[ATA_MAX_DEVICES];
529 530
	unsigned int		classes[ATA_MAX_DEVICES];
	unsigned int		did_probe_mask;
531 532
};

533 534 535 536 537 538 539 540 541 542 543
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 已提交
544 545
struct ata_link {
	struct ata_port		*ap;
T
Tejun Heo 已提交
546
	int			pmp;		/* port multiplier port # */
T
Tejun Heo 已提交
547 548 549 550

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

551 552
	unsigned int		flags;		/* ATA_LFLAG_xxx */

T
Tejun Heo 已提交
553 554 555 556 557 558 559 560 561 562 563 564
	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 已提交
565
struct ata_port {
J
Jeff Garzik 已提交
566
	struct Scsi_Host	*scsi_host; /* our co-allocated scsi host */
J
Jeff Garzik 已提交
567
	const struct ata_port_operations *ops;
568
	spinlock_t		*lock;
L
Linus Torvalds 已提交
569
	unsigned long		flags;	/* ATA_FLAG_xxx */
570
	unsigned int		pflags; /* ATA_PFLAG_xxx */
T
Tejun Heo 已提交
571 572
	unsigned int		print_id; /* user visible unique port ID */
	unsigned int		port_no; /* 0 based port no. inside the host */
L
Linus Torvalds 已提交
573 574 575 576

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

577 578 579
	void			*pad;	/* array of DMA pad buffers */
	dma_addr_t		pad_dma;

L
Linus Torvalds 已提交
580 581 582 583 584 585 586 587 588 589
	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];
590
	unsigned long		qc_allocated;
591
	unsigned int		qc_active;
592
	int			nr_active_links; /* #links with active qcs */
593

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

T
Tejun Heo 已提交
596 597
	int			nr_pmp_links;	/* nr of available PMP links */
	struct ata_link		*pmp_link;	/* array of PMP links */
598
	struct ata_link		*excl_link;	/* for PMP qc exclusion */
T
Tejun Heo 已提交
599

J
Jeff Garzik 已提交
600 601
	struct ata_port_stats	stats;
	struct ata_host		*host;
602
	struct device 		*dev;
L
Linus Torvalds 已提交
603

604
	void			*port_task_data;
605 606
	struct delayed_work	port_task;
	struct delayed_work	hotplug_task;
607
	struct work_struct	scsi_rescan_task;
T
Tejun Heo 已提交
608

A
Albert Lee 已提交
609
	unsigned int		hsm_task_state;
L
Linus Torvalds 已提交
610

611
	u32			msg_enable;
612
	struct list_head	eh_done_q;
613
	wait_queue_head_t	eh_wait_q;
614
	int			eh_tries;
615

616 617 618
	pm_message_t		pm_mesg;
	int			*pm_result;

T
Tejun Heo 已提交
619 620 621
	struct timer_list	fastdrain_timer;
	unsigned long		fastdrain_cnt;

L
Linus Torvalds 已提交
622
	void			*private_data;
623

624 625
#ifdef CONFIG_ATA_ACPI
	acpi_handle		acpi_handle;
626
	struct ata_acpi_gtm	acpi_gtm;
627
#endif
628
	u8			sector_buf[ATA_SECT_SIZE]; /* owned by EH */
L
Linus Torvalds 已提交
629 630 631
};

struct ata_port_operations {
632
	void (*dev_config) (struct ata_device *);
L
Linus Torvalds 已提交
633 634 635

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

J
Jeff Garzik 已提交
638
	void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
L
Linus Torvalds 已提交
639 640
	void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);

J
Jeff Garzik 已提交
641
	void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
L
Linus Torvalds 已提交
642 643 644 645
	u8   (*check_status)(struct ata_port *ap);
	u8   (*check_altstatus)(struct ata_port *ap);
	void (*dev_select)(struct ata_port *ap, unsigned int device);

646
	void (*phy_reset) (struct ata_port *ap); /* obsolete */
647
	int  (*set_mode) (struct ata_link *link, struct ata_device **r_failed_dev);
648

A
Alan Cox 已提交
649 650
	int (*cable_detect) (struct ata_port *ap);

A
Alan 已提交
651
	int  (*check_atapi_dma) (struct ata_queued_cmd *qc);
L
Linus Torvalds 已提交
652 653 654 655

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

656 657
	void (*data_xfer) (struct ata_device *, unsigned char *, unsigned int, int);

658
	int (*qc_defer) (struct ata_queued_cmd *qc);
L
Linus Torvalds 已提交
659
	void (*qc_prep) (struct ata_queued_cmd *qc);
660
	unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
L
Linus Torvalds 已提交
661

662 663 664 665 666 667
	/* port multiplier */
	void (*pmp_attach) (struct ata_port *ap);
	void (*pmp_detach) (struct ata_port *ap);
	int (*pmp_read) (struct ata_device *dev, int pmp, int reg, u32 *r_val);
	int (*pmp_write) (struct ata_device *dev, int pmp, int reg, u32 val);

668 669 670 671 672 673 674 675 676
	/* 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 已提交
677

678
	irq_handler_t irq_handler;
L
Linus Torvalds 已提交
679
	void (*irq_clear) (struct ata_port *);
680
	u8 (*irq_on) (struct ata_port *);
L
Linus Torvalds 已提交
681

682 683
	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 已提交
684

685 686 687
	int (*port_suspend) (struct ata_port *ap, pm_message_t mesg);
	int (*port_resume) (struct ata_port *ap);

L
Linus Torvalds 已提交
688 689 690
	int (*port_start) (struct ata_port *ap);
	void (*port_stop) (struct ata_port *ap);

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

693
	void (*bmdma_stop) (struct ata_queued_cmd *qc);
L
Linus Torvalds 已提交
694 695 696 697
	u8   (*bmdma_status) (struct ata_port *ap);
};

struct ata_port_info {
698
	struct scsi_host_template	*sht;
J
Jeff Garzik 已提交
699
	unsigned long		flags;
700
	unsigned long		link_flags;
L
Linus Torvalds 已提交
701 702 703
	unsigned long		pio_mask;
	unsigned long		mwdma_mask;
	unsigned long		udma_mask;
J
Jeff Garzik 已提交
704
	const struct ata_port_operations *port_ops;
705
	irq_handler_t		irq_handler;
706
	void 			*private_data;
L
Linus Torvalds 已提交
707 708
};

A
Alan Cox 已提交
709 710 711 712 713 714 715 716 717 718 719 720 721
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 已提交
722

723 724 725 726
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 已提交
727
extern const struct ata_port_operations ata_dummy_port_ops;
728
extern const struct ata_port_info ata_dummy_port_info;
T
Tejun Heo 已提交
729

730 731 732 733 734 735 736 737
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;
}
738

T
Tejun Heo 已提交
739 740 741 742 743
static inline int ata_port_is_dummy(struct ata_port *ap)
{
	return ap->ops == &ata_dummy_port_ops;
}

744
extern void sata_print_link_status(struct ata_link *link);
L
Linus Torvalds 已提交
745 746 747 748
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);
749 750 751 752 753
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 已提交
754 755
extern int ata_std_prereset(struct ata_link *link, unsigned long deadline);
extern int ata_std_softreset(struct ata_link *link, unsigned int *classes,
756
			     unsigned long deadline);
T
Tejun Heo 已提交
757 758 759
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,
760
			      unsigned long deadline);
T
Tejun Heo 已提交
761
extern void ata_std_postreset(struct ata_link *link, unsigned int *classes);
L
Linus Torvalds 已提交
762 763 764
extern void ata_port_disable(struct ata_port *);
extern void ata_std_ports(struct ata_ioports *ioaddr);
#ifdef CONFIG_PCI
T
Tejun Heo 已提交
765 766
extern int ata_pci_init_one (struct pci_dev *pdev,
			     const struct ata_port_info * const * ppi);
L
Linus Torvalds 已提交
767
extern void ata_pci_remove_one (struct pci_dev *pdev);
768
#ifdef CONFIG_PM
769
extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
770
extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
771
extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
J
Jens Axboe 已提交
772
extern int ata_pci_device_resume(struct pci_dev *pdev);
773
#endif
774
extern int ata_pci_clear_simplex(struct pci_dev *pdev);
L
Linus Torvalds 已提交
775
#endif /* CONFIG_PCI */
776
extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
777 778
extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
			const struct ata_port_info * const * ppi, int n_ports);
779
extern int ata_host_start(struct ata_host *host);
780 781
extern int ata_host_register(struct ata_host *host,
			     struct scsi_host_template *sht);
782 783 784
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 已提交
785
extern void ata_host_detach(struct ata_host *host);
J
Jeff Garzik 已提交
786 787
extern void ata_host_init(struct ata_host *, struct device *,
			  unsigned long, const struct ata_port_operations *);
788
extern int ata_scsi_detect(struct scsi_host_template *sht);
L
Linus Torvalds 已提交
789 790
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 *));
791
extern void ata_sas_port_destroy(struct ata_port *);
J
Jeff Garzik 已提交
792
extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
793 794 795 796 797 798 799
					   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 已提交
800
extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
801 802 803 804 805 806
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);
807
#ifdef CONFIG_PM
J
Jeff Garzik 已提交
808 809
extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
extern void ata_host_resume(struct ata_host *host);
810
#endif
811
extern int ata_ratelimit(void);
812 813
extern int ata_busy_sleep(struct ata_port *ap,
			  unsigned long timeout_pat, unsigned long timeout);
814
extern int ata_wait_ready(struct ata_port *ap, unsigned long deadline);
815
extern void ata_port_queue_task(struct ata_port *ap, work_func_t fn,
T
Tejun Heo 已提交
816
				void *data, unsigned long delay);
817 818 819
extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
			     unsigned long interval_msec,
			     unsigned long timeout_msec);
820 821
extern unsigned int ata_dev_try_classify(struct ata_device *dev, int present,
					 u8 *r_err);
822

L
Linus Torvalds 已提交
823 824 825
/*
 * Default driver ops implementations
 */
J
Jeff Garzik 已提交
826
extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
L
Linus Torvalds 已提交
827
extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
828 829
extern void ata_tf_to_fis(const struct ata_taskfile *tf,
			  u8 pmp, int is_cmd, u8 *fis);
J
Jeff Garzik 已提交
830
extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
L
Linus Torvalds 已提交
831 832 833 834
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 已提交
835
extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
L
Linus Torvalds 已提交
836
extern int ata_port_start (struct ata_port *ap);
837
extern int ata_sff_port_start (struct ata_port *ap);
838
extern irqreturn_t ata_interrupt (int irq, void *dev_instance);
T
Tejun Heo 已提交
839 840 841 842
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);
843
extern int ata_std_qc_defer(struct ata_queued_cmd *qc);
844
extern void ata_dumb_qc_prep(struct ata_queued_cmd *qc);
L
Linus Torvalds 已提交
845
extern void ata_qc_prep(struct ata_queued_cmd *qc);
846
extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
847
extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
L
Linus Torvalds 已提交
848 849 850 851
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 已提交
852
extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
853
extern void ata_dev_disable(struct ata_device *adev);
854 855 856 857
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);
858
extern void ata_id_to_dma_mode(struct ata_device *dev, u8 unknown);
L
Linus Torvalds 已提交
859 860
extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
extern void ata_bmdma_start (struct ata_queued_cmd *qc);
861
extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
L
Linus Torvalds 已提交
862 863
extern u8   ata_bmdma_status(struct ata_port *ap);
extern void ata_bmdma_irq_clear(struct ata_port *ap);
864 865
extern void ata_bmdma_freeze(struct ata_port *ap);
extern void ata_bmdma_thaw(struct ata_port *ap);
866
extern void ata_bmdma_drive_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
867 868 869 870 871
			       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);
872 873
extern int ata_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
			u8 status, int in_wq);
874
extern void ata_qc_complete(struct ata_queued_cmd *qc);
875 876
extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active,
				    void (*finish_qc)(struct ata_queued_cmd *));
T
Tejun Heo 已提交
877
extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
L
Linus Torvalds 已提交
878 879 880 881 882
			      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);
883
extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
884 885
extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
				       int queue_depth);
T
Tejun Heo 已提交
886
extern struct ata_device *ata_dev_pair(struct ata_device *adev);
887
extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
888
extern u8 ata_irq_on(struct ata_port *ap);
L
Linus Torvalds 已提交
889

A
Alan Cox 已提交
890 891 892 893 894
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 已提交
895 896 897
/*
 * Timing helpers
 */
898 899

extern unsigned int ata_pio_need_iordy(const struct ata_device *);
A
Alan Cox 已提交
900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922
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,
};

A
Alan Cox 已提交
923 924 925 926 927 928
/* libata-acpi.c */
#ifdef CONFIG_ATA_ACPI
extern int ata_acpi_cbl_80wire(struct ata_port *ap);
#else
static inline int ata_acpi_cbl_80wire(struct ata_port *ap) { return 0; }
#endif
L
Linus Torvalds 已提交
929 930 931 932 933 934 935 936 937

#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;
};

938
extern int ata_pci_init_sff_host(struct ata_host *host);
T
Tejun Heo 已提交
939
extern int ata_pci_init_bmdma(struct ata_host *host);
940 941 942
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 已提交
943
extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
944
extern unsigned long ata_pci_default_filter(struct ata_device *, unsigned long);
L
Linus Torvalds 已提交
945 946
#endif /* CONFIG_PCI */

947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965
/*
 * PMP
 */
extern void sata_pmp_read_init_tf(struct ata_taskfile *tf,
				  struct ata_device *dev, int pmp, int reg);
extern u32 sata_pmp_read_val(const struct ata_taskfile *tf);
extern void sata_pmp_write_init_tf(struct ata_taskfile *tf,
				   struct ata_device *dev,
				   int pmp, int reg, u32 val);
extern int sata_pmp_std_prereset(struct ata_link *link, unsigned long deadline);
extern int sata_pmp_std_hardreset(struct ata_link *link, unsigned int *class,
				  unsigned long deadline);
extern void sata_pmp_std_postreset(struct ata_link *link, unsigned int *class);
extern void sata_pmp_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,
		ata_prereset_fn_t pmp_prereset, ata_reset_fn_t pmp_softreset,
		ata_reset_fn_t pmp_hardreset, ata_postreset_fn_t pmp_postreset);

966 967 968 969
/*
 * EH
 */
extern void ata_eng_timeout(struct ata_port *ap);
970 971

extern void ata_port_schedule_eh(struct ata_port *ap);
972
extern int ata_link_abort(struct ata_link *link);
973
extern int ata_port_abort(struct ata_port *ap);
974
extern int ata_port_freeze(struct ata_port *ap);
975
extern int sata_async_notification(struct ata_port *ap);
976 977 978

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

980 981 982
extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);

983 984 985
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 已提交
986

987 988 989 990
/*
 * printk helpers
 */
#define ata_port_printk(ap, lv, fmt, args...) \
T
Tejun Heo 已提交
991
	printk(lv"ata%u: "fmt, (ap)->print_id , ##args)
992

T
Tejun Heo 已提交
993 994 995 996 997 998 999
#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 已提交
1000

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

1005 1006 1007
/*
 * ata_eh_info helpers
 */
1008 1009 1010 1011
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 已提交
1012
extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
1013

1014
static inline void ata_ehi_schedule_probe(struct ata_eh_info *ehi)
T
Tejun Heo 已提交
1015
{
1016
	ehi->flags |= ATA_EHI_RESUME_LINK;
T
Tejun Heo 已提交
1017 1018 1019 1020
	ehi->action |= ATA_EH_SOFTRESET;
	ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
}

1021 1022
static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
{
1023 1024
	ata_ehi_schedule_probe(ehi);
	ehi->flags |= ATA_EHI_HOTPLUGGED;
1025
	ehi->action |= ATA_EH_ENABLE_LINK;
1026 1027 1028
	ehi->err_mask |= AC_ERR_ATA_BUS;
}

1029 1030 1031 1032 1033 1034 1035 1036 1037 1038
/*
 * port description helpers
 */
extern void ata_port_desc(struct ata_port *ap, const char *fmt, ...)
	__attribute__ ((format (printf, 2, 3)));
#ifdef CONFIG_PCI
extern void ata_port_pbar_desc(struct ata_port *ap, int bar, ssize_t offset,
			       const char *name);
#endif

1039 1040 1041
/*
 * qc helpers
 */
1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053
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;
}

1054 1055 1056 1057 1058 1059 1060 1061 1062 1063
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;
}

1064 1065 1066 1067 1068 1069 1070
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;
1071 1072 1073
	if (qc->pad_len)
		return &qc->pad_sgent;
	return NULL;
1074 1075 1076
}

#define ata_for_each_sg(sg, qc) \
1077
	for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
1078

L
Linus Torvalds 已提交
1079 1080 1081 1082 1083
static inline unsigned int ata_tag_valid(unsigned int tag)
{
	return (tag < ATA_MAX_QUEUE) ? 1 : 0;
}

1084 1085 1086 1087 1088
static inline unsigned int ata_tag_internal(unsigned int tag)
{
	return tag == ATA_MAX_QUEUE - 1;
}

1089 1090 1091
/*
 * device helpers
 */
1092
static inline unsigned int ata_class_enabled(unsigned int class)
1093
{
1094 1095
	return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI ||
		class == ATA_DEV_PMP || class == ATA_DEV_SEMB;
1096 1097
}

1098
static inline unsigned int ata_class_disabled(unsigned int class)
L
Linus Torvalds 已提交
1099
{
1100 1101
	return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP ||
		class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP;
1102 1103
}

1104 1105 1106 1107 1108
static inline unsigned int ata_class_absent(unsigned int class)
{
	return !ata_class_enabled(class) && !ata_class_disabled(class);
}

1109 1110 1111 1112 1113 1114 1115 1116
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 已提交
1117 1118
}

1119 1120 1121 1122 1123
static inline unsigned int ata_dev_absent(const struct ata_device *dev)
{
	return ata_class_absent(dev->class);
}

1124
/*
1125
 * link helpers
1126
 */
T
Tejun Heo 已提交
1127 1128 1129 1130 1131
static inline int ata_is_host_link(const struct ata_link *link)
{
	return link == &link->ap->link;
}

1132
static inline int ata_link_max_devices(const struct ata_link *link)
1133
{
T
Tejun Heo 已提交
1134
	if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS)
1135 1136 1137 1138
		return 2;
	return 1;
}

1139 1140 1141 1142 1143
static inline int ata_link_active(struct ata_link *link)
{
	return ata_tag_valid(link->active_tag) || link->sactive;
}

T
Tejun Heo 已提交
1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171
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))
1172 1173 1174 1175 1176 1177 1178 1179 1180

#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)--)
1181

L
Linus Torvalds 已提交
1182 1183 1184 1185 1186
static inline u8 ata_chk_status(struct ata_port *ap)
{
	return ap->ops->check_status(ap);
}

1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201
/**
 *	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 已提交
1202 1203 1204 1205 1206 1207 1208 1209 1210

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

L
Linus Torvalds 已提交
1211 1212 1213 1214 1215 1216
static inline void ata_pause(struct ata_port *ap)
{
	ata_altstatus(ap);
	ndelay(400);
}

E
Edward Falk 已提交
1217 1218 1219 1220

/**
 *	ata_busy_wait - Wait for a port status register
 *	@ap: Port to wait for.
A
Alan 已提交
1221 1222
 *	@bits: bits that must be clear
 *	@max: number of 10uS waits to perform
E
Edward Falk 已提交
1223 1224 1225 1226 1227 1228 1229 1230 1231
 *
 *	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 已提交
1232 1233 1234 1235 1236 1237 1238 1239 1240
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--;
1241
	} while (status != 0xff && (status & bits) && (max > 0));
L
Linus Torvalds 已提交
1242 1243 1244 1245

	return status;
}

E
Edward Falk 已提交
1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257

/**
 *	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 已提交
1258 1259 1260 1261
static inline u8 ata_wait_idle(struct ata_port *ap)
{
	u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);

1262
#ifdef ATA_DEBUG
1263
	if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
1264 1265 1266
		ata_port_printk(ap, KERN_DEBUG, "abnormal Status 0x%X\n",
				status);
#endif
L
Linus Torvalds 已提交
1267 1268 1269 1270 1271 1272 1273 1274 1275

	return status;
}

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

1276 1277
static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
						       unsigned int tag)
L
Linus Torvalds 已提交
1278 1279 1280 1281 1282 1283
{
	if (likely(ata_tag_valid(tag)))
		return &ap->qcmd[tag];
	return NULL;
}

1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298
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 已提交
1299
static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
L
Linus Torvalds 已提交
1300 1301 1302
{
	memset(tf, 0, sizeof(*tf));

T
Tejun Heo 已提交
1303
	tf->ctl = dev->link->ap->ctl;
T
Tejun Heo 已提交
1304
	if (dev->devno == 0)
L
Linus Torvalds 已提交
1305 1306 1307 1308 1309
		tf->device = ATA_DEVICE_OBS;
	else
		tf->device = ATA_DEVICE_OBS | ATA_DEV1;
}

J
Jeff Garzik 已提交
1310 1311
static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
{
1312
	qc->dma_dir = DMA_NONE;
J
Jeff Garzik 已提交
1313 1314
	qc->__sg = NULL;
	qc->flags = 0;
T
Tejun Heo 已提交
1315
	qc->cursg = qc->cursg_ofs = 0;
J
Jeff Garzik 已提交
1316
	qc->nbytes = qc->curbytes = 0;
B
Brian King 已提交
1317
	qc->n_elem = 0;
1318
	qc->err_mask = 0;
B
Brian King 已提交
1319
	qc->pad_len = 0;
1320
	qc->sect_size = ATA_SECT_SIZE;
J
Jeff Garzik 已提交
1321

T
Tejun Heo 已提交
1322
	ata_tf_init(qc->dev, &qc->tf);
1323 1324 1325 1326

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

J
Jeff Garzik 已提交
1329
static inline int ata_try_flush_cache(const struct ata_device *dev)
L
Linus Torvalds 已提交
1330 1331 1332 1333 1334 1335
{
	return ata_id_wcache_enabled(dev->id) ||
	       ata_id_has_flush(dev->id) ||
	       ata_id_has_flush_ext(dev->id);
}

1336 1337
static inline unsigned int ac_err_mask(u8 status)
{
1338
	if (status & (ATA_BUSY | ATA_DRQ))
1339
		return AC_ERR_HSM;
1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352
	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;
}

1353 1354 1355
static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
{
	ap->pad_dma = 0;
1356 1357
	ap->pad = dmam_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
				      &ap->pad_dma, GFP_KERNEL);
1358 1359 1360 1361 1362
	return (ap->pad == NULL) ? -ENOMEM : 0;
}

static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
{
1363
	dmam_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
1364 1365
}

1366 1367
static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
{
1368
	return *(struct ata_port **)&host->hostdata[0];
1369 1370
}

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