libata.h 55.7 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
 */

#ifndef __LINUX_LIBATA_H__
#define __LINUX_LIBATA_H__

#include <linux/delay.h>
30
#include <linux/jiffies.h>
L
Linus Torvalds 已提交
31
#include <linux/interrupt.h>
32
#include <linux/dma-mapping.h>
J
Jens Axboe 已提交
33
#include <linux/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>
39
#include <linux/cdrom.h>
L
Linus Torvalds 已提交
40

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

L
Linus Torvalds 已提交
51
/*
52 53
 * compile-time options: to be removed as soon as all the drivers are
 * converted to the new debugging mechanism
L
Linus Torvalds 已提交
54 55 56 57 58 59 60 61 62
 */
#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
63
#define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __func__, ## args)
L
Linus Torvalds 已提交
64
#ifdef ATA_VERBOSE_DEBUG
65
#define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __func__, ## args)
L
Linus Torvalds 已提交
66 67 68 69 70 71 72 73
#else
#define VPRINTK(fmt, args...)
#endif	/* ATA_VERBOSE_DEBUG */
#else
#define DPRINTK(fmt, args...)
#define VPRINTK(fmt, args...)
#endif	/* ATA_DEBUG */

74
#define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __func__, ## args)
J
Jeff Garzik 已提交
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 107
/* 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 已提交
108 109 110 111 112 113
/* defines only for the constants which don't work well as enums */
#define ATA_TAG_POISON		0xfafbfcfdU

enum {
	/* various global constants */
	LIBATA_MAX_PRD		= ATA_MAX_PRD / 2,
114
	LIBATA_DUMB_MAX_PRD	= ATA_MAX_PRD / 4,	/* Worst case */
L
Linus Torvalds 已提交
115
	ATA_DEF_QUEUE		= 1,
116
	/* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
117
	ATA_MAX_QUEUE		= 32,
118
	ATA_TAG_INTERNAL	= ATA_MAX_QUEUE - 1,
119
	ATA_SHORT_PAUSE		= 16,
L
Linus Torvalds 已提交
120

T
Tejun Heo 已提交
121 122
	ATAPI_MAX_DRAIN		= 16 << 10,

123 124
	ATA_ALL_DEVICES		= (1 << ATA_MAX_DEVICES) - 1,

L
Linus Torvalds 已提交
125 126 127
	ATA_SHT_EMULATED	= 1,
	ATA_SHT_CMD_PER_LUN	= 1,
	ATA_SHT_THIS_ID		= -1,
128
	ATA_SHT_USE_CLUSTERING	= 1,
L
Linus Torvalds 已提交
129 130

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

144 145
	ATA_DFLAG_PIO		= (1 << 12), /* device limited to PIO mode */
	ATA_DFLAG_NCQ_OFF	= (1 << 13), /* device limited to non-NCQ mode */
146
	ATA_DFLAG_SLEEPING	= (1 << 15), /* device is sleeping */
147
	ATA_DFLAG_DUBIOUS_XFER	= (1 << 16), /* data transfer not verified */
148
	ATA_DFLAG_NO_UNLOAD	= (1 << 17), /* device doesn't support unload */
T
Tejun Heo 已提交
149
	ATA_DFLAG_UNLOCK_HPA	= (1 << 18), /* unlock HPA */
T
Tejun Heo 已提交
150
	ATA_DFLAG_INIT_MASK	= (1 << 24) - 1,
L
Linus Torvalds 已提交
151

T
Tejun Heo 已提交
152 153
	ATA_DFLAG_DETACH	= (1 << 24),
	ATA_DFLAG_DETACHED	= (1 << 25),
154

L
Linus Torvalds 已提交
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) */
160 161 162 163 164
	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 已提交
165

166
	/* struct ata_link flags */
167
	ATA_LFLAG_NO_HRST	= (1 << 1), /* avoid hardreset */
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
	ATA_LFLAG_SW_ACTIVITY	= (1 << 7), /* keep activity stats */
175

L
Linus Torvalds 已提交
176
	/* struct ata_port flags */
T
Tejun Heo 已提交
177
	ATA_FLAG_SLAVE_POSS	= (1 << 0), /* host supports slave dev */
L
Linus Torvalds 已提交
178
					    /* (doesn't imply presence) */
T
Tejun Heo 已提交
179 180 181 182 183 184 185 186
	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 */
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 */
190 191
	ATA_FLAG_NO_POWEROFF_SPINDOWN = (1 << 11), /* don't spindown before poweroff */
	ATA_FLAG_NO_HIBERNATE_SPINDOWN = (1 << 12), /* don't spindown before hibernation */
192
	ATA_FLAG_DEBUGMSG	= (1 << 13),
193
	ATA_FLAG_FPDMA_AA		= (1 << 14), /* driver supports Auto-Activate */
194
	ATA_FLAG_IGN_SIMPLEX	= (1 << 15), /* ignore SIMPLEX */
195
	ATA_FLAG_NO_IORDY	= (1 << 16), /* controller lacks iordy */
196
	ATA_FLAG_ACPI_SATA	= (1 << 17), /* need native SATA ACPI layout */
197
	ATA_FLAG_AN		= (1 << 18), /* controller supports AN */
198
	ATA_FLAG_PMP		= (1 << 19), /* controller supports PMP */
199
	ATA_FLAG_IPM		= (1 << 20), /* driver can handle IPM */
200 201 202 203
	ATA_FLAG_EM		= (1 << 21), /* driver supports enclosure
					      * management */
	ATA_FLAG_SW_ACTIVITY	= (1 << 22), /* driver supports sw activity
					      * led */
T
Tejun Heo 已提交
204

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

207

208 209 210 211 212 213 214
	/* 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_SCSI_HOTPLUG	= (1 << 6), /* SCSI hotplug scheduled */
215
	ATA_PFLAG_INITIALIZING	= (1 << 7), /* being initialized, don't touch */
T
Tejun Heo 已提交
216
	ATA_PFLAG_RESETTING	= (1 << 8), /* reset in progress */
T
Tejun Heo 已提交
217 218
	ATA_PFLAG_UNLOADING	= (1 << 9), /* driver is being unloaded */
	ATA_PFLAG_UNLOADED	= (1 << 10), /* driver is unloaded */
T
Tejun Heo 已提交
219

220
	ATA_PFLAG_SUSPENDED	= (1 << 17), /* port is suspended (power) */
221
	ATA_PFLAG_PM_PENDING	= (1 << 18), /* PM operation pending */
222
	ATA_PFLAG_INIT_GTM_VALID = (1 << 19), /* initial gtm data valid */
T
Tejun Heo 已提交
223

224 225 226
	ATA_PFLAG_PIO32		= (1 << 20),  /* 32bit PIO */
	ATA_PFLAG_PIO32CHANGE	= (1 << 21),  /* 32bit PIO can be turned on/off */

T
Tejun Heo 已提交
227 228
	/* struct ata_queued_cmd flags */
	ATA_QCFLAG_ACTIVE	= (1 << 0), /* cmd not yet ack'd to scsi lyer */
T
Tejun Heo 已提交
229
	ATA_QCFLAG_DMAMAP	= (1 << 1), /* SG table is DMA mapped */
T
Tejun Heo 已提交
230
	ATA_QCFLAG_IO		= (1 << 3), /* standard IO command */
231
	ATA_QCFLAG_RESULT_TF	= (1 << 4), /* result TF requested */
232
	ATA_QCFLAG_CLEAR_EXCL	= (1 << 5), /* clear excl_link on completion */
233
	ATA_QCFLAG_QUIET	= (1 << 6), /* don't report device error */
T
Tejun Heo 已提交
234
	ATA_QCFLAG_RETRY	= (1 << 7), /* retry after failure */
235

236 237 238
	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 已提交
239

240
	/* host set flags */
J
Jeff Garzik 已提交
241
	ATA_HOST_SIMPLEX	= (1 << 0),	/* Host is simplex, one DMA channel per host only */
242
	ATA_HOST_STARTED	= (1 << 1),	/* Host started */
243
	ATA_HOST_PARALLEL_SCAN	= (1 << 2),	/* Ports on this host can be scanned in parallel */
J
Jeff Garzik 已提交
244

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

L
Linus Torvalds 已提交
247
	/* various lengths of time */
248 249 250
	ATA_TMOUT_BOOT		= 30000,	/* heuristic */
	ATA_TMOUT_BOOT_QUICK	=  7000,	/* heuristic */
	ATA_TMOUT_INTERNAL_QUICK = 5000,
251
	ATA_TMOUT_MAX_PARK	= 30000,
L
Linus Torvalds 已提交
252

253 254 255 256
	/*
	 * GoVault needs 2s and iVDR disk HHD424020F7SV00 800ms.  2s
	 * is too much without parallel probing.  Use 2s if parallel
	 * probing is available, 800ms otherwise.
257
	 */
258 259
	ATA_TMOUT_FF_WAIT_LONG	=  2000,
	ATA_TMOUT_FF_WAIT	=   800,
260

261 262 263 264 265 266 267 268 269 270
	/* Spec mandates to wait for ">= 2ms" before checking status
	 * after reset.  We wait 150ms, because that was the magic
	 * delay used for ATAPI devices in Hale Landis's ATADRVR, for
	 * the period of time between when the ATA command register is
	 * written, and then status is checked.  Because waiting for
	 * "a while" before checking status is fine, post SRST, we
	 * perform this magic delay here as well.
	 *
	 * Old drivers/ide uses the 2mS rule and then waits for ready.
	 */
271
	ATA_WAIT_AFTER_RESET	=  150,
272

273 274 275 276 277
	/* If PMP is supported, we have to do follow-up SRST.  As some
	 * PMPs don't send D2H Reg FIS after hardreset, LLDs are
	 * advised to wait only for the following duration before
	 * doing SRST.
	 */
278
	ATA_TMOUT_PMP_SRST_WAIT	= 5000,
279

L
Linus Torvalds 已提交
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
	/* 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
298
	 * unsigned long bitmap
L
Linus Torvalds 已提交
299
	 */
300 301 302
	ATA_NR_PIO_MODES	= 7,
	ATA_NR_MWDMA_MODES	= 5,
	ATA_NR_UDMA_MODES	= 8,
303 304

	ATA_SHIFT_PIO		= 0,
305 306 307
	ATA_SHIFT_MWDMA		= ATA_SHIFT_PIO + ATA_NR_PIO_MODES,
	ATA_SHIFT_UDMA		= ATA_SHIFT_MWDMA + ATA_NR_MWDMA_MODES,

308 309
	/* size of buffer to pad xfers ending on unaligned boundaries */
	ATA_DMA_PAD_SZ		= 4,
T
Tejun Heo 已提交
310

311 312 313
	/* ering size */
	ATA_ERING_SIZE		= 32,

314 315 316 317
	/* return values for ->qc_defer */
	ATA_DEFER_LINK		= 1,
	ATA_DEFER_PORT		= 2,

318 319 320
	/* desc_len for ata_eh_info and context */
	ATA_EH_DESC_LEN		= 80,

321 322
	/* reset / recovery action types */
	ATA_EH_REVALIDATE	= (1 << 0),
T
Tejun Heo 已提交
323 324 325
	ATA_EH_SOFTRESET	= (1 << 1), /* meaningful only in ->prereset */
	ATA_EH_HARDRESET	= (1 << 2), /* meaningful only in ->prereset */
	ATA_EH_RESET		= ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
326
	ATA_EH_ENABLE_LINK	= (1 << 3),
327
	ATA_EH_LPM		= (1 << 4),  /* link power management action */
328
	ATA_EH_PARK		= (1 << 5), /* unload heads and stop I/O */
329

330
	ATA_EH_PERDEV_MASK	= ATA_EH_REVALIDATE | ATA_EH_PARK,
331 332
	ATA_EH_ALL_ACTIONS	= ATA_EH_REVALIDATE | ATA_EH_RESET |
				  ATA_EH_ENABLE_LINK | ATA_EH_LPM,
333

334
	/* ata_eh_info->flags */
335
	ATA_EHI_HOTPLUGGED	= (1 << 0),  /* could have been hotplugged */
336 337
	ATA_EHI_NO_AUTOPSY	= (1 << 2),  /* no autopsy */
	ATA_EHI_QUIET		= (1 << 3),  /* be quiet */
338

339 340 341 342 343
	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 */
344

345
	ATA_EHI_DID_RESET	= ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
346

347 348 349
	/* mask of flags to transfer *to* the slave link */
	ATA_EHI_TO_SLAVE_MASK	= ATA_EHI_NO_AUTOPSY | ATA_EHI_QUIET,

350 351
	/* max tries if error condition is still set after ->error_handler */
	ATA_EH_MAX_TRIES	= 5,
352

353 354 355
	/* sometimes resuming a link requires several retries */
	ATA_LINK_RESUME_TRIES	= 5,

356 357
	/* how hard are we gonna try to probe/recover devices */
	ATA_PROBE_MAX_TRIES	= 3,
T
Tejun Heo 已提交
358
	ATA_EH_DEV_TRIES	= 3,
359 360 361
	ATA_EH_PMP_TRIES	= 5,
	ATA_EH_PMP_LINK_TRIES	= 3,

362
	SATA_PMP_RW_TIMEOUT	= 3000,		/* PMP read/write timeout */
363

364 365 366
	/* This should match the actual table size of
	 * ata_eh_cmd_timeout_table in libata-eh.c.
	 */
367
	ATA_EH_CMD_TIMEOUT_TABLE_SIZE = 6,
368

369 370 371 372
	/* 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 */
373 374
	ATA_HORKAGE_NODMA	= (1 << 1),	/* DMA problems */
	ATA_HORKAGE_NONCQ	= (1 << 2),	/* Don't use NCQ */
375
	ATA_HORKAGE_MAX_SEC_128	= (1 << 3),	/* Limit max sects to 128 */
376
	ATA_HORKAGE_BROKEN_HPA	= (1 << 4),	/* Broken HPA */
377
	ATA_HORKAGE_DISABLE	= (1 << 5),	/* Disable it */
378
	ATA_HORKAGE_HPA_SIZE	= (1 << 6),	/* native size off by one */
379
	ATA_HORKAGE_IPM		= (1 << 7),	/* Link PM problems */
A
Alan Cox 已提交
380
	ATA_HORKAGE_IVB		= (1 << 8),	/* cbl det validity bit bugs */
381
	ATA_HORKAGE_STUCK_ERR	= (1 << 9),	/* stuck ERR on next PACKET */
382
	ATA_HORKAGE_BRIDGE_OK	= (1 << 10),	/* no bridge limits */
383 384
	ATA_HORKAGE_ATAPI_MOD16_DMA = (1 << 11), /* use ATAPI DMA for commands
						    not multiple of 16 bytes */
385
	ATA_HORKAGE_FIRMWARE_WARN = (1 << 12),	/* firmware update warning */
386
	ATA_HORKAGE_1_5_GBPS	= (1 << 13),	/* force 1.5 Gbps */
387
	ATA_HORKAGE_NOSETXFER	= (1 << 14),	/* skip SETXFER, SATA only */
388
	ATA_HORKAGE_BROKEN_FPDMA_AA	= (1 << 15),	/* skip AA */
389
	ATA_HORKAGE_DUMP_ID	= (1 << 16),	/* dump IDENTIFY data */
390

391
	 /* DMA mask for user DMA control: User visible values; DO NOT
392 393 394 395
	    renumber */
	ATA_DMA_MASK_ATA	= (1 << 0),	/* DMA on ATA Disk */
	ATA_DMA_MASK_ATAPI	= (1 << 1),	/* DMA on ATAPI */
	ATA_DMA_MASK_CFA	= (1 << 2),	/* DMA on CF Card */
396 397 398 399 400

	/* ATAPI command types */
	ATAPI_READ		= 0,		/* READs */
	ATAPI_WRITE		= 1,		/* WRITEs */
	ATAPI_READ_CD		= 2,		/* READ CD [MSF] */
401 402
	ATAPI_PASS_THRU		= 3,		/* SAT pass-thru */
	ATAPI_MISC		= 4,		/* the rest */
T
Tejun Heo 已提交
403 404 405 406 407 408 409 410 411 412

	/* Timing constants */
	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),
413 414 415
	ATA_TIMING_DMACK_HOLD	= (1 << 6),
	ATA_TIMING_CYCLE	= (1 << 7),
	ATA_TIMING_UDMA		= (1 << 8),
T
Tejun Heo 已提交
416 417 418
	ATA_TIMING_ALL		= ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
				  ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
				  ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
419 420
				  ATA_TIMING_DMACK_HOLD | ATA_TIMING_CYCLE |
				  ATA_TIMING_UDMA,
T
Tejun Heo 已提交
421 422 423 424 425

	/* ACPI constants */
	ATA_ACPI_FILTER_SETXFER	= 1 << 0,
	ATA_ACPI_FILTER_LOCK	= 1 << 1,
	ATA_ACPI_FILTER_DIPM	= 1 << 2,
426 427
	ATA_ACPI_FILTER_FPDMA_OFFSET = 1 << 3,	/* FPDMA non-zero offset */
	ATA_ACPI_FILTER_FPDMA_AA = 1 << 4,	/* FPDMA auto activate */
T
Tejun Heo 已提交
428 429 430 431

	ATA_ACPI_FILTER_DEFAULT	= ATA_ACPI_FILTER_SETXFER |
				  ATA_ACPI_FILTER_LOCK |
				  ATA_ACPI_FILTER_DIPM,
L
Linus Torvalds 已提交
432 433
};

434 435 436 437 438 439 440 441 442
enum ata_xfer_mask {
	ATA_MASK_PIO		= ((1LU << ATA_NR_PIO_MODES) - 1)
					<< ATA_SHIFT_PIO,
	ATA_MASK_MWDMA		= ((1LU << ATA_NR_MWDMA_MODES) - 1)
					<< ATA_SHIFT_MWDMA,
	ATA_MASK_UDMA		= ((1LU << ATA_NR_UDMA_MODES) - 1)
					<< ATA_SHIFT_UDMA,
};

A
Albert Lee 已提交
443
enum hsm_task_states {
444
	HSM_ST_IDLE,		/* no command on going */
445 446
	HSM_ST_FIRST,		/* (waiting the device to)
				   write CDB or first data block */
447 448 449
	HSM_ST,			/* (waiting the device to) transfer data */
	HSM_ST_LAST,		/* (waiting the device to) complete command */
	HSM_ST_ERR,		/* error */
L
Linus Torvalds 已提交
450 451
};

452
enum ata_completion_errors {
453 454 455 456 457 458 459 460 461
	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 */
462
	AC_ERR_NODEV_HINT	= (1 << 9), /* polling device detection hint */
T
Tejun Heo 已提交
463
	AC_ERR_NCQ		= (1 << 10), /* marker for offending NCQ qc */
464 465
};

L
Linus Torvalds 已提交
466 467 468 469
/* forward declarations */
struct scsi_device;
struct ata_port_operations;
struct ata_port;
T
Tejun Heo 已提交
470
struct ata_link;
L
Linus Torvalds 已提交
471 472 473
struct ata_queued_cmd;

/* typedefs */
474
typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
T
Tejun Heo 已提交
475 476
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,
477
			      unsigned long deadline);
T
Tejun Heo 已提交
478
typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes);
L
Linus Torvalds 已提交
479

480 481 482 483 484 485 486 487 488 489
/*
 * host pm policy: If you alter this, you also need to alter libata-scsi.c
 * (for the ascii descriptions)
 */
enum link_pm {
	NOT_AVAILABLE,
	MIN_POWER,
	MAX_PERFORMANCE,
	MEDIUM_POWER,
};
490
extern struct device_attribute dev_attr_link_power_management_policy;
491
extern struct device_attribute dev_attr_unload_heads;
492 493 494 495 496 497 498 499 500
extern struct device_attribute dev_attr_em_message_type;
extern struct device_attribute dev_attr_em_message;
extern struct device_attribute dev_attr_sw_activity;

enum sw_activity {
	OFF,
	BLINK_ON,
	BLINK_OFF,
};
501

T
Tejun Heo 已提交
502
#ifdef CONFIG_ATA_SFF
L
Linus Torvalds 已提交
503
struct ata_ioports {
T
Tejun Heo 已提交
504 505 506 507 508 509 510 511 512 513 514 515 516
	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;
T
Tejun Heo 已提交
517
#ifdef CONFIG_ATA_BMDMA
T
Tejun Heo 已提交
518
	void __iomem		*bmdma_addr;
T
Tejun Heo 已提交
519
#endif /* CONFIG_ATA_BMDMA */
T
Tejun Heo 已提交
520
	void __iomem		*scr_addr;
L
Linus Torvalds 已提交
521
};
T
Tejun Heo 已提交
522
#endif /* CONFIG_ATA_SFF */
L
Linus Torvalds 已提交
523

J
Jeff Garzik 已提交
524
struct ata_host {
L
Linus Torvalds 已提交
525 526
	spinlock_t		lock;
	struct device 		*dev;
T
Tejun Heo 已提交
527
	void __iomem * const	*iomap;
L
Linus Torvalds 已提交
528 529
	unsigned int		n_ports;
	void			*private_data;
530
	struct ata_port_operations *ops;
531
	unsigned long		flags;
532 533 534
#ifdef CONFIG_ATA_ACPI
	acpi_handle		acpi_handle;
#endif
A
Alan 已提交
535
	struct ata_port		*simplex_claimed;	/* channel owning the DMA */
536
	struct ata_port		*ports[0];
L
Linus Torvalds 已提交
537 538 539 540 541 542 543 544 545 546 547 548 549 550 551
};

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;
552
	unsigned int		orig_n_elem;
L
Linus Torvalds 已提交
553 554 555

	int			dma_dir;

556
	unsigned int		sect_size;
557

L
Linus Torvalds 已提交
558
	unsigned int		nbytes;
559
	unsigned int		extrabytes;
L
Linus Torvalds 已提交
560 561
	unsigned int		curbytes;

J
Jens Axboe 已提交
562
	struct scatterlist	*cursg;
L
Linus Torvalds 已提交
563 564 565 566
	unsigned int		cursg_ofs;

	struct scatterlist	sgent;

T
Tejun Heo 已提交
567
	struct scatterlist	*sg;
L
Linus Torvalds 已提交
568

569
	unsigned int		err_mask;
570
	struct ata_taskfile	result_tf;
L
Linus Torvalds 已提交
571 572 573
	ata_qc_cb_t		complete_fn;

	void			*private_data;
574
	void			*lldd_task;
L
Linus Torvalds 已提交
575 576
};

J
Jeff Garzik 已提交
577
struct ata_port_stats {
L
Linus Torvalds 已提交
578 579 580 581 582
	unsigned long		unhandled_irq;
	unsigned long		idle_irq;
	unsigned long		rw_reqbuf;
};

583
struct ata_ering_entry {
584
	unsigned int		eflags;
585 586 587 588 589 590 591 592 593
	unsigned int		err_mask;
	u64			timestamp;
};

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

L
Linus Torvalds 已提交
594
struct ata_device {
T
Tejun Heo 已提交
595
	struct ata_link		*link;
596
	unsigned int		devno;		/* 0 or 1 */
T
Tejun Heo 已提交
597
	unsigned int		horkage;	/* List of broken features */
598
	unsigned long		flags;		/* ATA_DFLAG_xxx */
599
	struct scsi_device	*sdev;		/* attached SCSI device */
600
	void			*private_data;
601 602
#ifdef CONFIG_ATA_ACPI
	acpi_handle		acpi_handle;
603
	union acpi_object	*gtf_cache;
T
Tejun Heo 已提交
604
	unsigned int		gtf_filter;
605
#endif
606
	/* n_sector is CLEAR_BEGIN, read comment above CLEAR_BEGIN */
607
	u64			n_sectors;	/* size of device, if ATA */
T
Tejun Heo 已提交
608
	u64			n_native_sectors; /* native size, if ATA */
L
Linus Torvalds 已提交
609
	unsigned int		class;		/* ATA_DEV_xxx */
610
	unsigned long		unpark_deadline;
611

L
Linus Torvalds 已提交
612 613 614 615 616
	u8			pio_mode;
	u8			dma_mode;
	u8			xfer_mode;
	unsigned int		xfer_shift;	/* ATA_SHIFT_xxx */

617 618
	unsigned int		multi_count;	/* sectors count for
						   READ/WRITE MULTIPLE */
619
	unsigned int		max_sectors;	/* per-device max sectors */
620
	unsigned int		cdb_len;
621

622
	/* per-dev xfer mask */
623 624 625
	unsigned long		pio_mask;
	unsigned long		mwdma_mask;
	unsigned long		udma_mask;
626

627 628 629 630
	/* for CHS addressing */
	u16			cylinders;	/* Number of cylinders */
	u16			heads;		/* Number of heads */
	u16			sectors;	/* Number of sectors per track */
631

632 633 634 635
	union {
		u16		id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
		u32		gscr[SATA_PMP_GSCR_DWORDS]; /* PMP GSCR block */
	};
636 637 638 639 640

	/* error history */
	int			spdn_cnt;
	/* ering is CLEAR_END, read comment above CLEAR_END */
	struct ata_ering	ering;
L
Linus Torvalds 已提交
641 642
};

643 644
/* Fields between ATA_DEVICE_CLEAR_BEGIN and ATA_DEVICE_CLEAR_END are
 * cleared to zero on ata_dev_init().
645
 */
646 647
#define ATA_DEVICE_CLEAR_BEGIN		offsetof(struct ata_device, n_sectors)
#define ATA_DEVICE_CLEAR_END		offsetof(struct ata_device, ering)
648

649 650 651 652 653
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 */
654
	unsigned int		dev_action[ATA_MAX_DEVICES]; /* dev EH action */
655
	unsigned int		flags;		/* ATA_EHI_* flags */
656 657 658

	unsigned int		probe_mask;

659 660 661 662 663 664 665
	char			desc[ATA_EH_DESC_LEN];
	int			desc_len;
};

struct ata_eh_context {
	struct ata_eh_info	i;
	int			tries[ATA_MAX_DEVICES];
666 667
	int			cmd_timeout_idx[ATA_MAX_DEVICES]
					       [ATA_EH_CMD_TIMEOUT_TABLE_SIZE];
668 669
	unsigned int		classes[ATA_MAX_DEVICES];
	unsigned int		did_probe_mask;
670
	unsigned int		unloaded_mask;
671 672
	unsigned int		saved_ncq_enabled;
	u8			saved_xfer_mode[ATA_MAX_DEVICES];
673 674
	/* timestamp for the last reset attempt or success */
	unsigned long		last_reset;
675 676
};

677 678 679 680 681 682 683 684 685 686 687
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 已提交
688 689
struct ata_link {
	struct ata_port		*ap;
T
Tejun Heo 已提交
690
	int			pmp;		/* port multiplier port # */
T
Tejun Heo 已提交
691 692 693 694

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

695 696
	unsigned int		flags;		/* ATA_LFLAG_xxx */

T
Tejun Heo 已提交
697
	u32			saved_scontrol;	/* SControl on probe */
T
Tejun Heo 已提交
698 699 700 701 702 703 704 705 706 707 708 709
	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 已提交
710
struct ata_port {
J
Jeff Garzik 已提交
711
	struct Scsi_Host	*scsi_host; /* our co-allocated scsi host */
712
	struct ata_port_operations *ops;
713
	spinlock_t		*lock;
714 715
	/* Flags owned by the EH context. Only EH should touch these once the
	   port is active */
L
Linus Torvalds 已提交
716
	unsigned long		flags;	/* ATA_FLAG_xxx */
717
	/* Flags that change dynamically, protected by ap->lock */
718
	unsigned int		pflags; /* ATA_PFLAG_xxx */
T
Tejun Heo 已提交
719 720
	unsigned int		print_id; /* user visible unique port ID */
	unsigned int		port_no; /* 0 based port no. inside the host */
L
Linus Torvalds 已提交
721

T
Tejun Heo 已提交
722
#ifdef CONFIG_ATA_SFF
L
Linus Torvalds 已提交
723 724 725
	struct ata_ioports	ioaddr;	/* ATA cmd/ctl/dma register blocks */
	u8			ctl;	/* cache of ATA control register */
	u8			last_ctl;	/* Cache last written value */
726
	struct delayed_work	sff_pio_task;
T
Tejun Heo 已提交
727
#ifdef CONFIG_ATA_BMDMA
T
Tejun Heo 已提交
728 729
	struct ata_bmdma_prd	*bmdma_prd;	/* BMDMA SG list */
	dma_addr_t		bmdma_prd_dma;	/* and its DMA mapping */
T
Tejun Heo 已提交
730
#endif /* CONFIG_ATA_BMDMA */
731 732
#endif /* CONFIG_ATA_SFF */

L
Linus Torvalds 已提交
733 734 735 736 737 738
	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];
739
	unsigned long		qc_allocated;
740
	unsigned int		qc_active;
741
	int			nr_active_links; /* #links with active qcs */
742

T
Tejun Heo 已提交
743 744
	struct ata_link		link;		/* host default link */
	struct ata_link		*slave_link;	/* see ata_slave_link_init() */
L
Linus Torvalds 已提交
745

T
Tejun Heo 已提交
746 747
	int			nr_pmp_links;	/* nr of available PMP links */
	struct ata_link		*pmp_link;	/* array of PMP links */
748
	struct ata_link		*excl_link;	/* for PMP qc exclusion */
T
Tejun Heo 已提交
749

J
Jeff Garzik 已提交
750 751
	struct ata_port_stats	stats;
	struct ata_host		*host;
752
	struct device 		*dev;
L
Linus Torvalds 已提交
753

754
	struct mutex		scsi_scan_mutex;
755
	struct delayed_work	hotplug_task;
756
	struct work_struct	scsi_rescan_task;
T
Tejun Heo 已提交
757

A
Albert Lee 已提交
758
	unsigned int		hsm_task_state;
L
Linus Torvalds 已提交
759

760
	u32			msg_enable;
761
	struct list_head	eh_done_q;
762
	wait_queue_head_t	eh_wait_q;
763
	int			eh_tries;
764
	struct completion	park_req_pending;
765

766 767
	pm_message_t		pm_mesg;
	int			*pm_result;
768
	enum link_pm		pm_policy;
769

T
Tejun Heo 已提交
770 771 772
	struct timer_list	fastdrain_timer;
	unsigned long		fastdrain_cnt;

773
	int			em_message_type;
L
Linus Torvalds 已提交
774
	void			*private_data;
775

776 777
#ifdef CONFIG_ATA_ACPI
	acpi_handle		acpi_handle;
778
	struct ata_acpi_gtm	__acpi_init_gtm; /* use ata_acpi_init_gtm() */
779
#endif
T
Tejun Heo 已提交
780 781
	/* owned by EH */
	u8			sector_buf[ATA_SECT_SIZE] ____cacheline_aligned;
L
Linus Torvalds 已提交
782 783
};

784 785 786 787 788 789 790
/* The following initializer overrides a method to NULL whether one of
 * its parent has the method defined or not.  This is equivalent to
 * ERR_PTR(-ENOENT).  Unfortunately, ERR_PTR doesn't render a constant
 * expression and thus can't be used as an initializer.
 */
#define ATA_OP_NULL		(void *)(unsigned long)(-ENOENT)

L
Linus Torvalds 已提交
791
struct ata_port_operations {
792 793 794 795 796 797 798
	/*
	 * Command execution
	 */
	int  (*qc_defer)(struct ata_queued_cmd *qc);
	int  (*check_atapi_dma)(struct ata_queued_cmd *qc);
	void (*qc_prep)(struct ata_queued_cmd *qc);
	unsigned int (*qc_issue)(struct ata_queued_cmd *qc);
799
	bool (*qc_fill_rtf)(struct ata_queued_cmd *qc);
L
Linus Torvalds 已提交
800

801 802 803 804 805 806 807 808
	/*
	 * Configuration and exception handling
	 */
	int  (*cable_detect)(struct ata_port *ap);
	unsigned long (*mode_filter)(struct ata_device *dev, unsigned long xfer_mask);
	void (*set_piomode)(struct ata_port *ap, struct ata_device *dev);
	void (*set_dmamode)(struct ata_port *ap, struct ata_device *dev);
	int  (*set_mode)(struct ata_link *link, struct ata_device **r_failed_dev);
809
	unsigned int (*read_id)(struct ata_device *dev, struct ata_taskfile *tf, u16 *id);
L
Linus Torvalds 已提交
810

811
	void (*dev_config)(struct ata_device *dev);
L
Linus Torvalds 已提交
812

813 814
	void (*freeze)(struct ata_port *ap);
	void (*thaw)(struct ata_port *ap);
815 816 817 818 819 820 821 822
	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;
823
	void (*error_handler)(struct ata_port *ap);
A
Alan Cox 已提交
824
	void (*lost_interrupt)(struct ata_port *ap);
825 826 827 828 829
	void (*post_internal_cmd)(struct ata_queued_cmd *qc);

	/*
	 * Optional features
	 */
T
Tejun Heo 已提交
830 831
	int  (*scr_read)(struct ata_link *link, unsigned int sc_reg, u32 *val);
	int  (*scr_write)(struct ata_link *link, unsigned int sc_reg, u32 val);
832 833 834 835 836 837 838 839 840 841 842 843 844 845
	void (*pmp_attach)(struct ata_port *ap);
	void (*pmp_detach)(struct ata_port *ap);
	int  (*enable_pm)(struct ata_port *ap, enum link_pm policy);
	void (*disable_pm)(struct ata_port *ap);

	/*
	 * Start, stop, suspend and resume
	 */
	int  (*port_suspend)(struct ata_port *ap, pm_message_t mesg);
	int  (*port_resume)(struct ata_port *ap);
	int  (*port_start)(struct ata_port *ap);
	void (*port_stop)(struct ata_port *ap);
	void (*host_stop)(struct ata_host *host);

T
Tejun Heo 已提交
846
#ifdef CONFIG_ATA_SFF
847 848 849
	/*
	 * SFF / taskfile oriented ops
	 */
T
Tejun Heo 已提交
850
	void (*sff_dev_select)(struct ata_port *ap, unsigned int device);
851
	void (*sff_set_devctl)(struct ata_port *ap, u8 ctl);
T
Tejun Heo 已提交
852 853 854 855 856 857 858 859
	u8   (*sff_check_status)(struct ata_port *ap);
	u8   (*sff_check_altstatus)(struct ata_port *ap);
	void (*sff_tf_load)(struct ata_port *ap, const struct ata_taskfile *tf);
	void (*sff_tf_read)(struct ata_port *ap, struct ata_taskfile *tf);
	void (*sff_exec_command)(struct ata_port *ap,
				 const struct ata_taskfile *tf);
	unsigned int (*sff_data_xfer)(struct ata_device *dev,
			unsigned char *buf, unsigned int buflen, int rw);
860
	void (*sff_irq_on)(struct ata_port *);
861
	bool (*sff_irq_check)(struct ata_port *);
T
Tejun Heo 已提交
862
	void (*sff_irq_clear)(struct ata_port *);
863
	void (*sff_drain_fifo)(struct ata_queued_cmd *qc);
T
Tejun Heo 已提交
864

T
Tejun Heo 已提交
865
#ifdef CONFIG_ATA_BMDMA
866 867 868 869
	void (*bmdma_setup)(struct ata_queued_cmd *qc);
	void (*bmdma_start)(struct ata_queued_cmd *qc);
	void (*bmdma_stop)(struct ata_queued_cmd *qc);
	u8   (*bmdma_status)(struct ata_port *ap);
T
Tejun Heo 已提交
870
#endif /* CONFIG_ATA_BMDMA */
T
Tejun Heo 已提交
871
#endif /* CONFIG_ATA_SFF */
872

873 874 875 876 877 878
	ssize_t (*em_show)(struct ata_port *ap, char *buf);
	ssize_t (*em_store)(struct ata_port *ap, const char *message,
			    size_t size);
	ssize_t (*sw_activity_show)(struct ata_device *dev, char *buf);
	ssize_t (*sw_activity_store)(struct ata_device *dev,
				     enum sw_activity val);
879 880
	/*
	 * Obsolete
881
	 */
882 883
	void (*phy_reset)(struct ata_port *ap);
	void (*eng_timeout)(struct ata_port *ap);
884 885 886 887 888 889

	/*
	 * ->inherits must be the last field and all the preceding
	 * fields must be pointers.
	 */
	const struct ata_port_operations	*inherits;
L
Linus Torvalds 已提交
890 891 892
};

struct ata_port_info {
J
Jeff Garzik 已提交
893
	unsigned long		flags;
894
	unsigned long		link_flags;
L
Linus Torvalds 已提交
895 896 897
	unsigned long		pio_mask;
	unsigned long		mwdma_mask;
	unsigned long		udma_mask;
898
	struct ata_port_operations *port_ops;
899
	void 			*private_data;
L
Linus Torvalds 已提交
900 901
};

A
Alan Cox 已提交
902 903 904 905 906 907 908 909
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 */
910
	unsigned short dmack_hold;	/* tj */
A
Alan Cox 已提交
911 912 913 914
	unsigned short cycle;		/* t0 */
	unsigned short udma;		/* t2CYCTYP/2 */
};

T
Tejun Heo 已提交
915 916 917
/*
 * Core layer - drivers/ata/libata-core.c
 */
918 919 920 921
extern const unsigned long sata_deb_timing_normal[];
extern const unsigned long sata_deb_timing_hotplug[];
extern const unsigned long sata_deb_timing_long[];

922
extern struct ata_port_operations ata_dummy_port_ops;
923
extern const struct ata_port_info ata_dummy_port_info;
T
Tejun Heo 已提交
924

925 926 927 928 929 930 931 932
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;
}
933

T
Tejun Heo 已提交
934 935 936 937 938
static inline int ata_port_is_dummy(struct ata_port *ap)
{
	return ap->ops == &ata_dummy_port_ops;
}

939
extern int sata_set_spd(struct ata_link *link);
940
extern int ata_std_prereset(struct ata_link *link, unsigned long deadline);
941 942
extern int ata_wait_after_reset(struct ata_link *link, unsigned long deadline,
				int (*check_ready)(struct ata_link *link));
943 944 945 946
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 已提交
947
extern int sata_link_hardreset(struct ata_link *link,
948 949
			const unsigned long *timing, unsigned long deadline,
			bool *online, int (*check_ready)(struct ata_link *));
950 951
extern int sata_std_hardreset(struct ata_link *link, unsigned int *class,
			      unsigned long deadline);
952
extern void ata_std_postreset(struct ata_link *link, unsigned int *classes);
953

954
extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
955 956
extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
			const struct ata_port_info * const * ppi, int n_ports);
T
Tejun Heo 已提交
957
extern int ata_slave_link_init(struct ata_port *ap);
958
extern int ata_host_start(struct ata_host *host);
959 960
extern int ata_host_register(struct ata_host *host,
			     struct scsi_host_template *sht);
961 962 963
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 已提交
964
extern void ata_host_detach(struct ata_host *host);
J
Jeff Garzik 已提交
965
extern void ata_host_init(struct ata_host *, struct device *,
966
			  unsigned long, struct ata_port_operations *);
967
extern int ata_scsi_detect(struct scsi_host_template *sht);
L
Linus Torvalds 已提交
968 969
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 *));
970 971
extern int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *dev,
			    int cmd, void __user *arg);
972
extern void ata_sas_port_destroy(struct ata_port *);
J
Jeff Garzik 已提交
973
extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
974 975 976 977 978 979 980
					   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);
981 982 983 984
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);
985 986
extern bool ata_link_online(struct ata_link *link);
extern bool ata_link_offline(struct ata_link *link);
987
#ifdef CONFIG_PM
J
Jeff Garzik 已提交
988 989
extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
extern void ata_host_resume(struct ata_host *host);
990
#endif
991
extern int ata_ratelimit(void);
992
extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
993
			     unsigned long interval, unsigned long timeout);
T
Tejun Heo 已提交
994
extern int atapi_cmd_type(u8 opcode);
995 996
extern void ata_tf_to_fis(const struct ata_taskfile *tf,
			  u8 pmp, int is_cmd, u8 *fis);
J
Jeff Garzik 已提交
997
extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
998 999 1000 1001 1002 1003 1004 1005 1006 1007
extern unsigned long ata_pack_xfermask(unsigned long pio_mask,
			unsigned long mwdma_mask, unsigned long udma_mask);
extern void ata_unpack_xfermask(unsigned long xfer_mask,
			unsigned long *pio_mask, unsigned long *mwdma_mask,
			unsigned long *udma_mask);
extern u8 ata_xfer_mask2mode(unsigned long xfer_mask);
extern unsigned long ata_xfer_mode2mask(u8 xfer_mode);
extern int ata_xfer_mode2shift(unsigned long xfer_mode);
extern const char *ata_mode_string(unsigned long xfer_mask);
extern unsigned long ata_id_xfermask(const u16 *id);
1008
extern int ata_std_qc_defer(struct ata_queued_cmd *qc);
1009
extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
L
Linus Torvalds 已提交
1010 1011
extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
		 unsigned int n_elem);
J
Jeff Garzik 已提交
1012
extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
1013
extern void ata_dev_disable(struct ata_device *adev);
1014 1015 1016 1017
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);
1018 1019
extern unsigned int ata_do_dev_read_id(struct ata_device *dev,
					struct ata_taskfile *tf, u16 *id);
1020
extern void ata_qc_complete(struct ata_queued_cmd *qc);
1021
extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active);
T
Tejun Heo 已提交
1022
extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
L
Linus Torvalds 已提交
1023 1024 1025 1026
			      void (*done)(struct scsi_cmnd *));
extern int ata_std_bios_param(struct scsi_device *sdev,
			      struct block_device *bdev,
			      sector_t capacity, int geom[]);
1027
extern void ata_scsi_unlock_native_capacity(struct scsi_device *sdev);
L
Linus Torvalds 已提交
1028
extern int ata_scsi_slave_config(struct scsi_device *sdev);
1029
extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
1030
extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
1031
				       int queue_depth, int reason);
T
Tejun Heo 已提交
1032
extern struct ata_device *ata_dev_pair(struct ata_device *adev);
1033
extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
L
Linus Torvalds 已提交
1034

A
Alan Cox 已提交
1035 1036 1037
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);
T
Tejun Heo 已提交
1038
extern int ata_cable_ignore(struct ata_port *ap);
A
Alan Cox 已提交
1039 1040
extern int ata_cable_unknown(struct ata_port *ap);

T
Tejun Heo 已提交
1041
/* Timing helpers */
1042
extern unsigned int ata_pio_need_iordy(const struct ata_device *);
1043
extern const struct ata_timing *ata_timing_find_mode(u8 xfer_mode);
A
Alan Cox 已提交
1044 1045 1046 1047 1048
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);
1049
extern u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle);
A
Alan Cox 已提交
1050

T
Tejun Heo 已提交
1051 1052 1053 1054 1055 1056 1057 1058 1059
/* PCI */
#ifdef CONFIG_PCI
struct pci_dev;

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;
A
Alan Cox 已提交
1060 1061
};

T
Tejun Heo 已提交
1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075
extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
extern void ata_pci_remove_one(struct pci_dev *pdev);

#ifdef CONFIG_PM
extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
extern int ata_pci_device_resume(struct pci_dev *pdev);
#endif /* CONFIG_PM */
#endif /* CONFIG_PCI */

/*
 * ACPI - drivers/ata/libata-acpi.c
 */
A
Alan Cox 已提交
1076
#ifdef CONFIG_ATA_ACPI
1077 1078 1079 1080 1081 1082
static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
{
	if (ap->pflags & ATA_PFLAG_INIT_GTM_VALID)
		return &ap->__acpi_init_gtm;
	return NULL;
}
1083 1084
int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm);
int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *stm);
1085 1086
unsigned long ata_acpi_gtm_xfermask(struct ata_device *dev,
				    const struct ata_acpi_gtm *gtm);
1087
int ata_acpi_cbl_80wire(struct ata_port *ap, const struct ata_acpi_gtm *gtm);
A
Alan Cox 已提交
1088
#else
1089 1090 1091 1092
static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
{
	return NULL;
}
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110

static inline int ata_acpi_stm(const struct ata_port *ap,
			       struct ata_acpi_gtm *stm)
{
	return -ENOSYS;
}

static inline int ata_acpi_gtm(const struct ata_port *ap,
			       struct ata_acpi_gtm *stm)
{
	return -ENOSYS;
}

static inline unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev,
					const struct ata_acpi_gtm *gtm)
{
	return 0;
}
1111 1112 1113 1114 1115 1116

static inline int ata_acpi_cbl_80wire(struct ata_port *ap,
				      const struct ata_acpi_gtm *gtm)
{
	return 0;
}
A
Alan Cox 已提交
1117
#endif
L
Linus Torvalds 已提交
1118

1119
/*
T
Tejun Heo 已提交
1120
 * EH - drivers/ata/libata-eh.c
1121
 */
1122
extern void ata_port_schedule_eh(struct ata_port *ap);
1123
extern int ata_link_abort(struct ata_link *link);
1124
extern int ata_port_abort(struct ata_port *ap);
1125
extern int ata_port_freeze(struct ata_port *ap);
1126
extern int sata_async_notification(struct ata_port *ap);
1127 1128 1129

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

1131 1132
extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
1133
extern void ata_eh_analyze_ncq_error(struct ata_link *link);
1134

1135 1136 1137
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);
1138
extern void ata_std_error_handler(struct ata_port *ap);
T
Tejun Heo 已提交
1139

1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162
/*
 * Base operations to inherit from and initializers for sht
 *
 * Operations
 *
 * base  : Common to all libata drivers.
 * sata  : SATA controllers w/ native interface.
 * pmp   : SATA controllers w/ PMP support.
 * sff   : SFF ATA controllers w/o BMDMA support.
 * bmdma : SFF ATA controllers w/ BMDMA support.
 *
 * sht initializers
 *
 * BASE  : Common to all libata drivers.  The user must set
 *	   sg_tablesize and dma_boundary.
 * PIO   : SFF ATA controllers w/ only PIO support.
 * BMDMA : SFF ATA controllers w/ BMDMA support.  sg_tablesize and
 *	   dma_boundary are set to BMDMA limits.
 * NCQ   : SATA controllers supporting NCQ.  The user must set
 *	   sg_tablesize, dma_boundary and can_queue.
 */
extern const struct ata_port_operations ata_base_port_ops;
extern const struct ata_port_operations sata_port_ops;
1163
extern struct device_attribute *ata_common_sdev_attrs[];
1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177

#define ATA_BASE_SHT(drv_name)					\
	.module			= THIS_MODULE,			\
	.name			= drv_name,			\
	.ioctl			= ata_scsi_ioctl,		\
	.queuecommand		= ata_scsi_queuecmd,		\
	.can_queue		= ATA_DEF_QUEUE,		\
	.this_id		= ATA_SHT_THIS_ID,		\
	.cmd_per_lun		= ATA_SHT_CMD_PER_LUN,		\
	.emulated		= ATA_SHT_EMULATED,		\
	.use_clustering		= ATA_SHT_USE_CLUSTERING,	\
	.proc_name		= drv_name,			\
	.slave_configure	= ata_scsi_slave_config,	\
	.slave_destroy		= ata_scsi_slave_destroy,	\
1178
	.bios_param		= ata_std_bios_param,		\
1179
	.unlock_native_capacity	= ata_scsi_unlock_native_capacity, \
1180
	.sdev_attrs		= ata_common_sdev_attrs
1181 1182 1183 1184 1185

#define ATA_NCQ_SHT(drv_name)					\
	ATA_BASE_SHT(drv_name),					\
	.change_queue_depth	= ata_scsi_change_queue_depth

T
Tejun Heo 已提交
1186 1187 1188
/*
 * PMP helpers
 */
T
Tejun Heo 已提交
1189
#ifdef CONFIG_SATA_PMP
T
Tejun Heo 已提交
1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201
static inline bool sata_pmp_supported(struct ata_port *ap)
{
	return ap->flags & ATA_FLAG_PMP;
}

static inline bool sata_pmp_attached(struct ata_port *ap)
{
	return ap->nr_pmp_links != 0;
}

static inline int ata_is_host_link(const struct ata_link *link)
{
T
Tejun Heo 已提交
1202
	return link == &link->ap->link || link == link->ap->slave_link;
T
Tejun Heo 已提交
1203
}
T
Tejun Heo 已提交
1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219
#else /* CONFIG_SATA_PMP */
static inline bool sata_pmp_supported(struct ata_port *ap)
{
	return false;
}

static inline bool sata_pmp_attached(struct ata_port *ap)
{
	return false;
}

static inline int ata_is_host_link(const struct ata_link *link)
{
	return 1;
}
#endif /* CONFIG_SATA_PMP */
T
Tejun Heo 已提交
1220 1221 1222 1223 1224 1225 1226 1227

static inline int sata_srst_pmp(struct ata_link *link)
{
	if (sata_pmp_supported(link->ap) && ata_is_host_link(link))
		return SATA_PMP_CTRL_PORT;
	return link->pmp;
}

1228 1229 1230 1231
/*
 * printk helpers
 */
#define ata_port_printk(ap, lv, fmt, args...) \
1232
	printk("%sata%u: "fmt, lv, (ap)->print_id , ##args)
1233

T
Tejun Heo 已提交
1234
#define ata_link_printk(link, lv, fmt, args...) do { \
T
Tejun Heo 已提交
1235
	if (sata_pmp_attached((link)->ap) || (link)->ap->slave_link)	\
1236
		printk("%sata%u.%02u: "fmt, lv, (link)->ap->print_id,	\
T
Tejun Heo 已提交
1237 1238
		       (link)->pmp , ##args); \
	else \
1239
		printk("%sata%u: "fmt, lv, (link)->ap->print_id , ##args); \
T
Tejun Heo 已提交
1240
	} while(0)
T
Tejun Heo 已提交
1241

1242
#define ata_dev_printk(dev, lv, fmt, args...) \
1243
	printk("%sata%u.%02u: "fmt, lv, (dev)->link->ap->print_id,	\
T
Tejun Heo 已提交
1244
	       (dev)->link->pmp + (dev)->devno , ##args)
L
Linus Torvalds 已提交
1245

1246 1247 1248
/*
 * ata_eh_info helpers
 */
1249 1250 1251 1252
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 已提交
1253
extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
1254

1255 1256
static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
{
1257
	ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
1258
	ehi->flags |= ATA_EHI_HOTPLUGGED;
1259
	ehi->action |= ATA_EH_RESET | ATA_EH_ENABLE_LINK;
1260 1261 1262
	ehi->err_mask |= AC_ERR_ATA_BUS;
}

1263 1264 1265 1266 1267 1268 1269 1270 1271 1272
/*
 * 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

L
Linus Torvalds 已提交
1273 1274 1275 1276 1277
static inline unsigned int ata_tag_valid(unsigned int tag)
{
	return (tag < ATA_MAX_QUEUE) ? 1 : 0;
}

1278 1279
static inline unsigned int ata_tag_internal(unsigned int tag)
{
1280
	return tag == ATA_TAG_INTERNAL;
1281 1282
}

1283 1284 1285
/*
 * device helpers
 */
1286
static inline unsigned int ata_class_enabled(unsigned int class)
1287
{
1288 1289
	return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI ||
		class == ATA_DEV_PMP || class == ATA_DEV_SEMB;
1290 1291
}

1292
static inline unsigned int ata_class_disabled(unsigned int class)
L
Linus Torvalds 已提交
1293
{
1294 1295
	return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP ||
		class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP;
1296 1297
}

1298 1299 1300 1301 1302
static inline unsigned int ata_class_absent(unsigned int class)
{
	return !ata_class_enabled(class) && !ata_class_disabled(class);
}

1303 1304 1305 1306 1307 1308 1309 1310
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 已提交
1311 1312
}

1313 1314 1315 1316 1317
static inline unsigned int ata_dev_absent(const struct ata_device *dev)
{
	return ata_class_absent(dev->class);
}

1318
/*
1319
 * link helpers
1320
 */
1321
static inline int ata_link_max_devices(const struct ata_link *link)
1322
{
T
Tejun Heo 已提交
1323
	if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS)
1324 1325 1326 1327
		return 2;
	return 1;
}

1328 1329 1330 1331 1332
static inline int ata_link_active(struct ata_link *link)
{
	return ata_tag_valid(link->active_tag) || link->sactive;
}

T
Tejun Heo 已提交
1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388
/*
 * Iterators
 *
 * ATA_LITER_* constants are used to select link iteration mode and
 * ATA_DITER_* device iteration mode.
 *
 * For a custom iteration directly using ata_{link|dev}_next(), if
 * @link or @dev, respectively, is NULL, the first element is
 * returned.  @dev and @link can be any valid device or link and the
 * next element according to the iteration mode will be returned.
 * After the last element, NULL is returned.
 */
enum ata_link_iter_mode {
	ATA_LITER_EDGE,		/* if present, PMP links only; otherwise,
				 * host link.  no slave link */
	ATA_LITER_HOST_FIRST,	/* host link followed by PMP or slave links */
	ATA_LITER_PMP_FIRST,	/* PMP links followed by host link,
				 * slave link still comes after host link */
};

enum ata_dev_iter_mode {
	ATA_DITER_ENABLED,
	ATA_DITER_ENABLED_REVERSE,
	ATA_DITER_ALL,
	ATA_DITER_ALL_REVERSE,
};

extern struct ata_link *ata_link_next(struct ata_link *link,
				      struct ata_port *ap,
				      enum ata_link_iter_mode mode);

extern struct ata_device *ata_dev_next(struct ata_device *dev,
				       struct ata_link *link,
				       enum ata_dev_iter_mode mode);

/*
 * Shortcut notation for iterations
 *
 * ata_for_each_link() iterates over each link of @ap according to
 * @mode.  @link points to the current link in the loop.  @link is
 * NULL after loop termination.  ata_for_each_dev() works the same way
 * except that it iterates over each device of @link.
 *
 * Note that the mode prefixes ATA_{L|D}ITER_ shouldn't need to be
 * specified when using the following shorthand notations.  Only the
 * mode itself (EDGE, HOST_FIRST, ENABLED, etc...) should be
 * specified.  This not only increases brevity but also makes it
 * impossible to use ATA_LITER_* for device iteration or vice-versa.
 */
#define ata_for_each_link(link, ap, mode) \
	for ((link) = ata_link_next(NULL, (ap), ATA_LITER_##mode); (link); \
	     (link) = ata_link_next((link), (ap), ATA_LITER_##mode))

#define ata_for_each_dev(dev, link, mode) \
	for ((dev) = ata_dev_next(NULL, (link), ATA_DITER_##mode); (dev); \
	     (dev) = ata_dev_next((dev), (link), ATA_DITER_##mode))
1389

1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404
/**
 *	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 已提交
1405

L
Linus Torvalds 已提交
1406 1407 1408 1409 1410
static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
{
	qc->tf.ctl |= ATA_NIEN;
}

1411 1412
static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
						       unsigned int tag)
L
Linus Torvalds 已提交
1413 1414 1415 1416 1417 1418
{
	if (likely(ata_tag_valid(tag)))
		return &ap->qcmd[tag];
	return NULL;
}

1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433
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;
}

1434 1435 1436 1437 1438
static inline unsigned int ata_qc_raw_nbytes(struct ata_queued_cmd *qc)
{
	return qc->nbytes - min(qc->extrabytes, qc->nbytes);
}

T
Tejun Heo 已提交
1439
static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
L
Linus Torvalds 已提交
1440 1441 1442
{
	memset(tf, 0, sizeof(*tf));

1443
#ifdef CONFIG_ATA_SFF
T
Tejun Heo 已提交
1444
	tf->ctl = dev->link->ap->ctl;
1445 1446 1447
#else
	tf->ctl = ATA_DEVCTL_OBS;
#endif
T
Tejun Heo 已提交
1448
	if (dev->devno == 0)
L
Linus Torvalds 已提交
1449 1450 1451 1452 1453
		tf->device = ATA_DEVICE_OBS;
	else
		tf->device = ATA_DEVICE_OBS | ATA_DEV1;
}

J
Jeff Garzik 已提交
1454 1455
static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
{
1456
	qc->dma_dir = DMA_NONE;
T
Tejun Heo 已提交
1457
	qc->sg = NULL;
J
Jeff Garzik 已提交
1458
	qc->flags = 0;
J
Jens Axboe 已提交
1459 1460
	qc->cursg = NULL;
	qc->cursg_ofs = 0;
1461
	qc->nbytes = qc->extrabytes = qc->curbytes = 0;
B
Brian King 已提交
1462
	qc->n_elem = 0;
1463
	qc->err_mask = 0;
1464
	qc->sect_size = ATA_SECT_SIZE;
J
Jeff Garzik 已提交
1465

T
Tejun Heo 已提交
1466
	ata_tf_init(qc->dev, &qc->tf);
1467 1468 1469 1470

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

J
Jeff Garzik 已提交
1473
static inline int ata_try_flush_cache(const struct ata_device *dev)
L
Linus Torvalds 已提交
1474 1475 1476 1477 1478 1479
{
	return ata_id_wcache_enabled(dev->id) ||
	       ata_id_has_flush(dev->id) ||
	       ata_id_has_flush_ext(dev->id);
}

1480 1481
static inline unsigned int ac_err_mask(u8 status)
{
1482
	if (status & (ATA_BUSY | ATA_DRQ))
1483
		return AC_ERR_HSM;
1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496
	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;
}

1497 1498
static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
{
1499
	return *(struct ata_port **)&host->hostdata[0];
1500 1501
}

1502 1503
static inline int ata_check_ready(u8 status)
{
1504 1505
	if (!(status & ATA_BUSY))
		return 1;
1506 1507 1508 1509 1510

	/* 0xff indicates either no device or device not ready */
	if (status == 0xff)
		return -ENODEV;

1511
	return 0;
1512 1513
}

1514 1515 1516 1517 1518 1519
static inline unsigned long ata_deadline(unsigned long from_jiffies,
					 unsigned long timeout_msecs)
{
	return from_jiffies + msecs_to_jiffies(timeout_msecs);
}

1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541
/* Don't open code these in drivers as there are traps. Firstly the range may
   change in future hardware and specs, secondly 0xFF means 'no DMA' but is
   > UDMA_0. Dyma ddreigiau */

static inline int ata_using_mwdma(struct ata_device *adev)
{
	if (adev->dma_mode >= XFER_MW_DMA_0 && adev->dma_mode <= XFER_MW_DMA_4)
		return 1;
	return 0;
}

static inline int ata_using_udma(struct ata_device *adev)
{
	if (adev->dma_mode >= XFER_UDMA_0 && adev->dma_mode <= XFER_UDMA_7)
		return 1;
	return 0;
}

static inline int ata_dma_enabled(struct ata_device *adev)
{
	return (adev->dma_mode == 0xFF ? 0 : 1);
}
1542 1543 1544 1545

/**************************************************************************
 * PMP - drivers/ata/libata-pmp.c
 */
T
Tejun Heo 已提交
1546 1547
#ifdef CONFIG_SATA_PMP

1548 1549 1550 1551 1552
extern const struct ata_port_operations sata_pmp_port_ops;

extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc);
extern void sata_pmp_error_handler(struct ata_port *ap);

T
Tejun Heo 已提交
1553 1554 1555 1556 1557 1558 1559 1560
#else /* CONFIG_SATA_PMP */

#define sata_pmp_port_ops		sata_port_ops
#define sata_pmp_qc_defer_cmd_switch	ata_std_qc_defer
#define sata_pmp_error_handler		ata_std_error_handler

#endif /* CONFIG_SATA_PMP */

1561

T
Tejun Heo 已提交
1562 1563 1564
/**************************************************************************
 * SFF - drivers/ata/libata-sff.c
 */
T
Tejun Heo 已提交
1565 1566
#ifdef CONFIG_ATA_SFF

T
Tejun Heo 已提交
1567
extern const struct ata_port_operations ata_sff_port_ops;
A
Alan Cox 已提交
1568
extern const struct ata_port_operations ata_bmdma32_port_ops;
T
Tejun Heo 已提交
1569 1570 1571 1572 1573 1574 1575

/* PIO only, sg_tablesize and dma_boundary limits can be removed */
#define ATA_PIO_SHT(drv_name)					\
	ATA_BASE_SHT(drv_name),					\
	.sg_tablesize		= LIBATA_MAX_PRD,		\
	.dma_boundary		= ATA_DMA_BOUNDARY

T
Tejun Heo 已提交
1576 1577
extern void ata_sff_dev_select(struct ata_port *ap, unsigned int device);
extern u8 ata_sff_check_status(struct ata_port *ap);
1578 1579
extern void ata_sff_pause(struct ata_port *ap);
extern void ata_sff_dma_pause(struct ata_port *ap);
T
Tejun Heo 已提交
1580 1581
extern int ata_sff_busy_sleep(struct ata_port *ap,
			      unsigned long timeout_pat, unsigned long timeout);
1582
extern int ata_sff_wait_ready(struct ata_link *link, unsigned long deadline);
T
Tejun Heo 已提交
1583 1584 1585 1586 1587
extern void ata_sff_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
extern void ata_sff_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
extern void ata_sff_exec_command(struct ata_port *ap,
				 const struct ata_taskfile *tf);
extern unsigned int ata_sff_data_xfer(struct ata_device *dev,
T
Tejun Heo 已提交
1588
			unsigned char *buf, unsigned int buflen, int rw);
A
Alan Cox 已提交
1589 1590
extern unsigned int ata_sff_data_xfer32(struct ata_device *dev,
			unsigned char *buf, unsigned int buflen, int rw);
T
Tejun Heo 已提交
1591
extern unsigned int ata_sff_data_xfer_noirq(struct ata_device *dev,
T
Tejun Heo 已提交
1592
			unsigned char *buf, unsigned int buflen, int rw);
1593
extern void ata_sff_irq_on(struct ata_port *ap);
T
Tejun Heo 已提交
1594 1595 1596
extern void ata_sff_irq_clear(struct ata_port *ap);
extern int ata_sff_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
			    u8 status, int in_wq);
1597
extern void ata_sff_queue_pio_task(struct ata_port *ap, unsigned long delay);
T
Tejun Heo 已提交
1598
extern unsigned int ata_sff_qc_issue(struct ata_queued_cmd *qc);
1599
extern bool ata_sff_qc_fill_rtf(struct ata_queued_cmd *qc);
1600
extern unsigned int ata_sff_port_intr(struct ata_port *ap,
T
Tejun Heo 已提交
1601 1602
				      struct ata_queued_cmd *qc);
extern irqreturn_t ata_sff_interrupt(int irq, void *dev_instance);
A
Alan Cox 已提交
1603
extern void ata_sff_lost_interrupt(struct ata_port *ap);
T
Tejun Heo 已提交
1604 1605 1606 1607 1608
extern void ata_sff_freeze(struct ata_port *ap);
extern void ata_sff_thaw(struct ata_port *ap);
extern int ata_sff_prereset(struct ata_link *link, unsigned long deadline);
extern unsigned int ata_sff_dev_classify(struct ata_device *dev, int present,
					  u8 *r_err);
1609 1610
extern int ata_sff_wait_after_reset(struct ata_link *link, unsigned int devmask,
				    unsigned long deadline);
T
Tejun Heo 已提交
1611
extern int ata_sff_softreset(struct ata_link *link, unsigned int *classes,
T
Tejun Heo 已提交
1612
			     unsigned long deadline);
T
Tejun Heo 已提交
1613 1614 1615
extern int sata_sff_hardreset(struct ata_link *link, unsigned int *class,
			       unsigned long deadline);
extern void ata_sff_postreset(struct ata_link *link, unsigned int *classes);
A
Alan Cox 已提交
1616
extern void ata_sff_drain_fifo(struct ata_queued_cmd *qc);
T
Tejun Heo 已提交
1617 1618
extern void ata_sff_error_handler(struct ata_port *ap);
extern void ata_sff_std_ports(struct ata_ioports *ioaddr);
T
Tejun Heo 已提交
1619
#ifdef CONFIG_PCI
T
Tejun Heo 已提交
1620 1621
extern int ata_pci_sff_init_host(struct ata_host *host);
extern int ata_pci_sff_prepare_host(struct pci_dev *pdev,
T
Tejun Heo 已提交
1622 1623
				    const struct ata_port_info * const * ppi,
				    struct ata_host **r_host);
T
Tejun Heo 已提交
1624
extern int ata_pci_sff_activate_host(struct ata_host *host,
T
Tejun Heo 已提交
1625 1626
				     irq_handler_t irq_handler,
				     struct scsi_host_template *sht);
T
Tejun Heo 已提交
1627
extern int ata_pci_sff_init_one(struct pci_dev *pdev,
1628 1629
		const struct ata_port_info * const * ppi,
		struct scsi_host_template *sht, void *host_priv, int hflags);
T
Tejun Heo 已提交
1630 1631
#endif /* CONFIG_PCI */

T
Tejun Heo 已提交
1632 1633 1634 1635 1636 1637 1638 1639 1640
#ifdef CONFIG_ATA_BMDMA

extern const struct ata_port_operations ata_bmdma_port_ops;

#define ATA_BMDMA_SHT(drv_name)					\
	ATA_BASE_SHT(drv_name),					\
	.sg_tablesize		= LIBATA_MAX_PRD,		\
	.dma_boundary		= ATA_DMA_BOUNDARY

1641
extern void ata_bmdma_qc_prep(struct ata_queued_cmd *qc);
1642
extern unsigned int ata_bmdma_qc_issue(struct ata_queued_cmd *qc);
1643
extern void ata_bmdma_dumb_qc_prep(struct ata_queued_cmd *qc);
1644 1645 1646
extern unsigned int ata_bmdma_port_intr(struct ata_port *ap,
				      struct ata_queued_cmd *qc);
extern irqreturn_t ata_bmdma_interrupt(int irq, void *dev_instance);
T
Tejun Heo 已提交
1647 1648
extern void ata_bmdma_error_handler(struct ata_port *ap);
extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
1649
extern void ata_bmdma_irq_clear(struct ata_port *ap);
1650 1651 1652 1653
extern void ata_bmdma_setup(struct ata_queued_cmd *qc);
extern void ata_bmdma_start(struct ata_queued_cmd *qc);
extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
extern u8 ata_bmdma_status(struct ata_port *ap);
1654 1655
extern int ata_bmdma_port_start(struct ata_port *ap);
extern int ata_bmdma_port_start32(struct ata_port *ap);
1656 1657 1658

#ifdef CONFIG_PCI
extern int ata_pci_bmdma_clear_simplex(struct pci_dev *pdev);
1659
extern void ata_pci_bmdma_init(struct ata_host *host);
T
Tejun Heo 已提交
1660 1661 1662 1663 1664 1665 1666
extern int ata_pci_bmdma_prepare_host(struct pci_dev *pdev,
				      const struct ata_port_info * const * ppi,
				      struct ata_host **r_host);
extern int ata_pci_bmdma_init_one(struct pci_dev *pdev,
				  const struct ata_port_info * const * ppi,
				  struct scsi_host_template *sht,
				  void *host_priv, int hflags);
1667
#endif /* CONFIG_PCI */
T
Tejun Heo 已提交
1668
#endif /* CONFIG_ATA_BMDMA */
1669

T
Tejun Heo 已提交
1670
/**
T
Tejun Heo 已提交
1671
 *	ata_sff_busy_wait - Wait for a port status register
T
Tejun Heo 已提交
1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682
 *	@ap: Port to wait for.
 *	@bits: bits that must be clear
 *	@max: number of 10uS waits to perform
 *
 *	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.
 */
T
Tejun Heo 已提交
1683 1684
static inline u8 ata_sff_busy_wait(struct ata_port *ap, unsigned int bits,
				   unsigned int max)
T
Tejun Heo 已提交
1685 1686 1687 1688 1689
{
	u8 status;

	do {
		udelay(10);
T
Tejun Heo 已提交
1690
		status = ap->ops->sff_check_status(ap);
T
Tejun Heo 已提交
1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708
		max--;
	} while (status != 0xff && (status & bits) && (max > 0));

	return status;
}

/**
 *	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.
 */
static inline u8 ata_wait_idle(struct ata_port *ap)
{
T
Tejun Heo 已提交
1709
	u8 status = ata_sff_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
T
Tejun Heo 已提交
1710 1711 1712 1713 1714 1715 1716 1717 1718

#ifdef ATA_DEBUG
	if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
		ata_port_printk(ap, KERN_DEBUG, "abnormal Status 0x%X\n",
				status);
#endif

	return status;
}
T
Tejun Heo 已提交
1719
#endif /* CONFIG_ATA_SFF */
T
Tejun Heo 已提交
1720

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