libata.h 57.8 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>
40
#include <linux/sched.h>
L
Linus Torvalds 已提交
41

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

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

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

77 78 79 80 81 82 83 84 85 86
#define ata_print_version_once(dev, version)			\
({								\
	static bool __print_once;				\
								\
	if (!__print_once) {					\
		__print_once = true;				\
		ata_print_version(dev, version);		\
	}							\
})

87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
/* 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 已提交
119 120 121 122 123 124
/* 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,
125
	LIBATA_DUMB_MAX_PRD	= ATA_MAX_PRD / 4,	/* Worst case */
L
Linus Torvalds 已提交
126
	ATA_DEF_QUEUE		= 1,
127
	/* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
128
	ATA_MAX_QUEUE		= 32,
129
	ATA_TAG_INTERNAL	= ATA_MAX_QUEUE - 1,
130
	ATA_SHORT_PAUSE		= 16,
L
Linus Torvalds 已提交
131

T
Tejun Heo 已提交
132 133
	ATAPI_MAX_DRAIN		= 16 << 10,

134 135
	ATA_ALL_DEVICES		= (1 << ATA_MAX_DEVICES) - 1,

L
Linus Torvalds 已提交
136 137 138
	ATA_SHT_EMULATED	= 1,
	ATA_SHT_CMD_PER_LUN	= 1,
	ATA_SHT_THIS_ID		= -1,
139
	ATA_SHT_USE_CLUSTERING	= 1,
L
Linus Torvalds 已提交
140 141

	/* struct ata_device stuff */
T
Tejun Heo 已提交
142 143
	ATA_DFLAG_LBA		= (1 << 0), /* device supports LBA */
	ATA_DFLAG_LBA48		= (1 << 1), /* device supports LBA48 */
J
Jeff Garzik 已提交
144
	ATA_DFLAG_CDB_INTR	= (1 << 2), /* device asserts INTRQ when ready for CDB */
145
	ATA_DFLAG_NCQ		= (1 << 3), /* device supports NCQ */
146
	ATA_DFLAG_FLUSH_EXT	= (1 << 4), /* do FLUSH_EXT instead of FLUSH */
T
Tejun Heo 已提交
147 148
	ATA_DFLAG_ACPI_PENDING	= (1 << 5), /* ACPI resume action pending */
	ATA_DFLAG_ACPI_FAILED	= (1 << 6), /* ACPI on devcfg has failed */
149
	ATA_DFLAG_AN		= (1 << 7), /* AN configured */
150
	ATA_DFLAG_DMADIR	= (1 << 10), /* device requires DMADIR */
151
	ATA_DFLAG_CFG_MASK	= (1 << 12) - 1,
T
Tejun Heo 已提交
152

153 154
	ATA_DFLAG_PIO		= (1 << 12), /* device limited to PIO mode */
	ATA_DFLAG_NCQ_OFF	= (1 << 13), /* device limited to non-NCQ mode */
155
	ATA_DFLAG_SLEEPING	= (1 << 15), /* device is sleeping */
156
	ATA_DFLAG_DUBIOUS_XFER	= (1 << 16), /* data transfer not verified */
157
	ATA_DFLAG_NO_UNLOAD	= (1 << 17), /* device doesn't support unload */
T
Tejun Heo 已提交
158
	ATA_DFLAG_UNLOCK_HPA	= (1 << 18), /* unlock HPA */
T
Tejun Heo 已提交
159
	ATA_DFLAG_INIT_MASK	= (1 << 24) - 1,
L
Linus Torvalds 已提交
160

T
Tejun Heo 已提交
161 162
	ATA_DFLAG_DETACH	= (1 << 24),
	ATA_DFLAG_DETACHED	= (1 << 25),
163

L
Linus Torvalds 已提交
164 165 166 167 168
	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) */
169 170 171 172 173
	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 已提交
174

175
	/* struct ata_link flags */
176
	ATA_LFLAG_NO_HRST	= (1 << 1), /* avoid hardreset */
177 178 179 180
	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,
181
	ATA_LFLAG_NO_RETRY	= (1 << 5), /* don't retry this link */
182
	ATA_LFLAG_DISABLED	= (1 << 6), /* link is disabled */
183
	ATA_LFLAG_SW_ACTIVITY	= (1 << 7), /* keep activity stats */
184
	ATA_LFLAG_NO_LPM	= (1 << 8), /* disable LPM on this link */
185

L
Linus Torvalds 已提交
186
	/* struct ata_port flags */
T
Tejun Heo 已提交
187
	ATA_FLAG_SLAVE_POSS	= (1 << 0), /* host supports slave dev */
L
Linus Torvalds 已提交
188
					    /* (doesn't imply presence) */
T
Tejun Heo 已提交
189 190 191 192
	ATA_FLAG_SATA		= (1 << 1),
	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 */
193 194 195
	ATA_FLAG_PIO_POLLING	= (1 << 9), /* use polling PIO if LLD
					     * doesn't handle PIO interrupts */
	ATA_FLAG_NCQ		= (1 << 10), /* host supports NCQ */
196 197
	ATA_FLAG_NO_POWEROFF_SPINDOWN = (1 << 11), /* don't spindown before poweroff */
	ATA_FLAG_NO_HIBERNATE_SPINDOWN = (1 << 12), /* don't spindown before hibernation */
198
	ATA_FLAG_DEBUGMSG	= (1 << 13),
199
	ATA_FLAG_FPDMA_AA		= (1 << 14), /* driver supports Auto-Activate */
200
	ATA_FLAG_IGN_SIMPLEX	= (1 << 15), /* ignore SIMPLEX */
201
	ATA_FLAG_NO_IORDY	= (1 << 16), /* controller lacks iordy */
202
	ATA_FLAG_ACPI_SATA	= (1 << 17), /* need native SATA ACPI layout */
203
	ATA_FLAG_AN		= (1 << 18), /* controller supports AN */
204
	ATA_FLAG_PMP		= (1 << 19), /* controller supports PMP */
205 206 207 208
	ATA_FLAG_EM		= (1 << 21), /* driver supports enclosure
					      * management */
	ATA_FLAG_SW_ACTIVITY	= (1 << 22), /* driver supports sw activity
					      * led */
209
	ATA_FLAG_NO_DIPM	= (1 << 23), /* host not happy with DIPM */
T
Tejun Heo 已提交
210

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

213

214 215 216 217 218 219 220
	/* 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 */
221
	ATA_PFLAG_INITIALIZING	= (1 << 7), /* being initialized, don't touch */
T
Tejun Heo 已提交
222
	ATA_PFLAG_RESETTING	= (1 << 8), /* reset in progress */
T
Tejun Heo 已提交
223 224
	ATA_PFLAG_UNLOADING	= (1 << 9), /* driver is being unloaded */
	ATA_PFLAG_UNLOADED	= (1 << 10), /* driver is unloaded */
T
Tejun Heo 已提交
225

226
	ATA_PFLAG_SUSPENDED	= (1 << 17), /* port is suspended (power) */
227
	ATA_PFLAG_PM_PENDING	= (1 << 18), /* PM operation pending */
228
	ATA_PFLAG_INIT_GTM_VALID = (1 << 19), /* initial gtm data valid */
T
Tejun Heo 已提交
229

230 231 232
	ATA_PFLAG_PIO32		= (1 << 20),  /* 32bit PIO */
	ATA_PFLAG_PIO32CHANGE	= (1 << 21),  /* 32bit PIO can be turned on/off */

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

242 243 244
	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 已提交
245

246
	/* host set flags */
J
Jeff Garzik 已提交
247
	ATA_HOST_SIMPLEX	= (1 << 0),	/* Host is simplex, one DMA channel per host only */
248
	ATA_HOST_STARTED	= (1 << 1),	/* Host started */
249
	ATA_HOST_PARALLEL_SCAN	= (1 << 2),	/* Ports on this host can be scanned in parallel */
J
Jeff Garzik 已提交
250

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

L
Linus Torvalds 已提交
253
	/* various lengths of time */
254 255 256
	ATA_TMOUT_BOOT		= 30000,	/* heuristic */
	ATA_TMOUT_BOOT_QUICK	=  7000,	/* heuristic */
	ATA_TMOUT_INTERNAL_QUICK = 5000,
257
	ATA_TMOUT_MAX_PARK	= 30000,
L
Linus Torvalds 已提交
258

259 260 261 262
	/*
	 * GoVault needs 2s and iVDR disk HHD424020F7SV00 800ms.  2s
	 * is too much without parallel probing.  Use 2s if parallel
	 * probing is available, 800ms otherwise.
263
	 */
264 265
	ATA_TMOUT_FF_WAIT_LONG	=  2000,
	ATA_TMOUT_FF_WAIT	=   800,
266

267 268 269 270 271 272 273 274 275 276
	/* 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.
	 */
277
	ATA_WAIT_AFTER_RESET	=  150,
278

279 280 281 282 283
	/* 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.
	 */
284
	ATA_TMOUT_PMP_SRST_WAIT	= 5000,
285

L
Linus Torvalds 已提交
286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303
	/* 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
304
	 * unsigned long bitmap
L
Linus Torvalds 已提交
305
	 */
306 307 308
	ATA_NR_PIO_MODES	= 7,
	ATA_NR_MWDMA_MODES	= 5,
	ATA_NR_UDMA_MODES	= 8,
309 310

	ATA_SHIFT_PIO		= 0,
311 312 313
	ATA_SHIFT_MWDMA		= ATA_SHIFT_PIO + ATA_NR_PIO_MODES,
	ATA_SHIFT_UDMA		= ATA_SHIFT_MWDMA + ATA_NR_MWDMA_MODES,

314 315
	/* size of buffer to pad xfers ending on unaligned boundaries */
	ATA_DMA_PAD_SZ		= 4,
T
Tejun Heo 已提交
316

317 318 319
	/* ering size */
	ATA_ERING_SIZE		= 32,

320 321 322 323
	/* return values for ->qc_defer */
	ATA_DEFER_LINK		= 1,
	ATA_DEFER_PORT		= 2,

324 325 326
	/* desc_len for ata_eh_info and context */
	ATA_EH_DESC_LEN		= 80,

327 328
	/* reset / recovery action types */
	ATA_EH_REVALIDATE	= (1 << 0),
T
Tejun Heo 已提交
329 330 331
	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,
332
	ATA_EH_ENABLE_LINK	= (1 << 3),
333
	ATA_EH_PARK		= (1 << 5), /* unload heads and stop I/O */
334

335
	ATA_EH_PERDEV_MASK	= ATA_EH_REVALIDATE | ATA_EH_PARK,
336
	ATA_EH_ALL_ACTIONS	= ATA_EH_REVALIDATE | ATA_EH_RESET |
337
				  ATA_EH_ENABLE_LINK,
338

339
	/* ata_eh_info->flags */
340
	ATA_EHI_HOTPLUGGED	= (1 << 0),  /* could have been hotplugged */
341 342
	ATA_EHI_NO_AUTOPSY	= (1 << 2),  /* no autopsy */
	ATA_EHI_QUIET		= (1 << 3),  /* be quiet */
343
	ATA_EHI_NO_RECOVERY	= (1 << 4),  /* no recovery */
344

345 346 347 348
	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 */
A
Andrea Gelmini 已提交
349
	ATA_EHI_POST_SETMODE	= (1 << 20), /* revalidating after setmode */
350

351
	ATA_EHI_DID_RESET	= ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
352

353 354 355
	/* mask of flags to transfer *to* the slave link */
	ATA_EHI_TO_SLAVE_MASK	= ATA_EHI_NO_AUTOPSY | ATA_EHI_QUIET,

356 357
	/* max tries if error condition is still set after ->error_handler */
	ATA_EH_MAX_TRIES	= 5,
358

359 360 361
	/* sometimes resuming a link requires several retries */
	ATA_LINK_RESUME_TRIES	= 5,

362 363
	/* how hard are we gonna try to probe/recover devices */
	ATA_PROBE_MAX_TRIES	= 3,
T
Tejun Heo 已提交
364
	ATA_EH_DEV_TRIES	= 3,
365 366 367
	ATA_EH_PMP_TRIES	= 5,
	ATA_EH_PMP_LINK_TRIES	= 3,

368
	SATA_PMP_RW_TIMEOUT	= 3000,		/* PMP read/write timeout */
369

370 371 372
	/* This should match the actual table size of
	 * ata_eh_cmd_timeout_table in libata-eh.c.
	 */
373
	ATA_EH_CMD_TIMEOUT_TABLE_SIZE = 6,
374

375
	/* Horkage types. May be set by libata or controller on drives
L
Lucas De Marchi 已提交
376
	   (some horkage may be drive/controller pair dependent */
377 378

	ATA_HORKAGE_DIAGNOSTIC	= (1 << 0),	/* Failed boot diag */
379 380
	ATA_HORKAGE_NODMA	= (1 << 1),	/* DMA problems */
	ATA_HORKAGE_NONCQ	= (1 << 2),	/* Don't use NCQ */
381
	ATA_HORKAGE_MAX_SEC_128	= (1 << 3),	/* Limit max sects to 128 */
382
	ATA_HORKAGE_BROKEN_HPA	= (1 << 4),	/* Broken HPA */
383
	ATA_HORKAGE_DISABLE	= (1 << 5),	/* Disable it */
384
	ATA_HORKAGE_HPA_SIZE	= (1 << 6),	/* native size off by one */
A
Alan Cox 已提交
385
	ATA_HORKAGE_IVB		= (1 << 8),	/* cbl det validity bit bugs */
386
	ATA_HORKAGE_STUCK_ERR	= (1 << 9),	/* stuck ERR on next PACKET */
387
	ATA_HORKAGE_BRIDGE_OK	= (1 << 10),	/* no bridge limits */
388 389
	ATA_HORKAGE_ATAPI_MOD16_DMA = (1 << 11), /* use ATAPI DMA for commands
						    not multiple of 16 bytes */
390
	ATA_HORKAGE_FIRMWARE_WARN = (1 << 12),	/* firmware update warning */
391
	ATA_HORKAGE_1_5_GBPS	= (1 << 13),	/* force 1.5 Gbps */
392
	ATA_HORKAGE_NOSETXFER	= (1 << 14),	/* skip SETXFER, SATA only */
393
	ATA_HORKAGE_BROKEN_FPDMA_AA	= (1 << 15),	/* skip AA */
394
	ATA_HORKAGE_DUMP_ID	= (1 << 16),	/* dump IDENTIFY data */
395

396
	 /* DMA mask for user DMA control: User visible values; DO NOT
397 398 399 400
	    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 */
401 402 403 404 405

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

	/* 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),
418 419 420
	ATA_TIMING_DMACK_HOLD	= (1 << 6),
	ATA_TIMING_CYCLE	= (1 << 7),
	ATA_TIMING_UDMA		= (1 << 8),
T
Tejun Heo 已提交
421 422 423
	ATA_TIMING_ALL		= ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
				  ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
				  ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
424 425
				  ATA_TIMING_DMACK_HOLD | ATA_TIMING_CYCLE |
				  ATA_TIMING_UDMA,
T
Tejun Heo 已提交
426 427 428 429 430

	/* ACPI constants */
	ATA_ACPI_FILTER_SETXFER	= 1 << 0,
	ATA_ACPI_FILTER_LOCK	= 1 << 1,
	ATA_ACPI_FILTER_DIPM	= 1 << 2,
431 432
	ATA_ACPI_FILTER_FPDMA_OFFSET = 1 << 3,	/* FPDMA non-zero offset */
	ATA_ACPI_FILTER_FPDMA_AA = 1 << 4,	/* FPDMA auto activate */
T
Tejun Heo 已提交
433 434 435 436

	ATA_ACPI_FILTER_DEFAULT	= ATA_ACPI_FILTER_SETXFER |
				  ATA_ACPI_FILTER_LOCK |
				  ATA_ACPI_FILTER_DIPM,
L
Linus Torvalds 已提交
437 438
};

439 440 441 442 443 444 445 446 447
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 已提交
448
enum hsm_task_states {
449
	HSM_ST_IDLE,		/* no command on going */
450 451
	HSM_ST_FIRST,		/* (waiting the device to)
				   write CDB or first data block */
452 453 454
	HSM_ST,			/* (waiting the device to) transfer data */
	HSM_ST_LAST,		/* (waiting the device to) complete command */
	HSM_ST_ERR,		/* error */
L
Linus Torvalds 已提交
455 456
};

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

471 472 473 474 475 476 477 478 479 480 481
/*
 * Link power management policy: If you alter this, you also need to
 * alter libata-scsi.c (for the ascii descriptions)
 */
enum ata_lpm_policy {
	ATA_LPM_UNKNOWN,
	ATA_LPM_MAX_POWER,
	ATA_LPM_MED_POWER,
	ATA_LPM_MIN_POWER,
};

482 483 484 485 486
enum ata_lpm_hints {
	ATA_LPM_EMPTY		= (1 << 0), /* port empty/probing */
	ATA_LPM_HIPM		= (1 << 1), /* may use HIPM */
};

L
Linus Torvalds 已提交
487 488 489 490
/* forward declarations */
struct scsi_device;
struct ata_port_operations;
struct ata_port;
T
Tejun Heo 已提交
491
struct ata_link;
L
Linus Torvalds 已提交
492 493 494
struct ata_queued_cmd;

/* typedefs */
495
typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
T
Tejun Heo 已提交
496 497
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,
498
			      unsigned long deadline);
T
Tejun Heo 已提交
499
typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes);
L
Linus Torvalds 已提交
500

501
extern struct device_attribute dev_attr_link_power_management_policy;
502
extern struct device_attribute dev_attr_unload_heads;
503 504 505 506 507 508 509 510 511
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,
};
512

T
Tejun Heo 已提交
513
#ifdef CONFIG_ATA_SFF
L
Linus Torvalds 已提交
514
struct ata_ioports {
T
Tejun Heo 已提交
515 516 517 518 519 520 521 522 523 524 525 526 527
	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 已提交
528
#ifdef CONFIG_ATA_BMDMA
T
Tejun Heo 已提交
529
	void __iomem		*bmdma_addr;
T
Tejun Heo 已提交
530
#endif /* CONFIG_ATA_BMDMA */
T
Tejun Heo 已提交
531
	void __iomem		*scr_addr;
L
Linus Torvalds 已提交
532
};
T
Tejun Heo 已提交
533
#endif /* CONFIG_ATA_SFF */
L
Linus Torvalds 已提交
534

J
Jeff Garzik 已提交
535
struct ata_host {
L
Linus Torvalds 已提交
536 537
	spinlock_t		lock;
	struct device 		*dev;
T
Tejun Heo 已提交
538
	void __iomem * const	*iomap;
L
Linus Torvalds 已提交
539 540
	unsigned int		n_ports;
	void			*private_data;
541
	struct ata_port_operations *ops;
542
	unsigned long		flags;
543 544 545 546

	struct mutex		eh_mutex;
	struct task_struct	*eh_owner;

547 548 549
#ifdef CONFIG_ATA_ACPI
	acpi_handle		acpi_handle;
#endif
A
Alan 已提交
550
	struct ata_port		*simplex_claimed;	/* channel owning the DMA */
551
	struct ata_port		*ports[0];
L
Linus Torvalds 已提交
552 553 554 555 556 557 558 559 560 561 562 563 564 565 566
};

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;
567
	unsigned int		orig_n_elem;
L
Linus Torvalds 已提交
568 569 570

	int			dma_dir;

571
	unsigned int		sect_size;
572

L
Linus Torvalds 已提交
573
	unsigned int		nbytes;
574
	unsigned int		extrabytes;
L
Linus Torvalds 已提交
575 576 577 578
	unsigned int		curbytes;

	struct scatterlist	sgent;

T
Tejun Heo 已提交
579
	struct scatterlist	*sg;
L
Linus Torvalds 已提交
580

581 582 583
	struct scatterlist	*cursg;
	unsigned int		cursg_ofs;

584
	unsigned int		err_mask;
585
	struct ata_taskfile	result_tf;
L
Linus Torvalds 已提交
586 587 588
	ata_qc_cb_t		complete_fn;

	void			*private_data;
589
	void			*lldd_task;
L
Linus Torvalds 已提交
590 591
};

J
Jeff Garzik 已提交
592
struct ata_port_stats {
L
Linus Torvalds 已提交
593 594 595 596 597
	unsigned long		unhandled_irq;
	unsigned long		idle_irq;
	unsigned long		rw_reqbuf;
};

598
struct ata_ering_entry {
599
	unsigned int		eflags;
600 601 602 603 604 605 606 607 608
	unsigned int		err_mask;
	u64			timestamp;
};

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

L
Linus Torvalds 已提交
609
struct ata_device {
T
Tejun Heo 已提交
610
	struct ata_link		*link;
611
	unsigned int		devno;		/* 0 or 1 */
T
Tejun Heo 已提交
612
	unsigned int		horkage;	/* List of broken features */
613
	unsigned long		flags;		/* ATA_DFLAG_xxx */
614
	struct scsi_device	*sdev;		/* attached SCSI device */
615
	void			*private_data;
616 617
#ifdef CONFIG_ATA_ACPI
	acpi_handle		acpi_handle;
618
	union acpi_object	*gtf_cache;
T
Tejun Heo 已提交
619
	unsigned int		gtf_filter;
620
#endif
G
Gwendal Grignou 已提交
621
	struct device		tdev;
622
	/* n_sector is CLEAR_BEGIN, read comment above CLEAR_BEGIN */
623
	u64			n_sectors;	/* size of device, if ATA */
T
Tejun Heo 已提交
624
	u64			n_native_sectors; /* native size, if ATA */
L
Linus Torvalds 已提交
625
	unsigned int		class;		/* ATA_DEV_xxx */
626
	unsigned long		unpark_deadline;
627

L
Linus Torvalds 已提交
628 629 630 631 632
	u8			pio_mode;
	u8			dma_mode;
	u8			xfer_mode;
	unsigned int		xfer_shift;	/* ATA_SHIFT_xxx */

633 634
	unsigned int		multi_count;	/* sectors count for
						   READ/WRITE MULTIPLE */
635
	unsigned int		max_sectors;	/* per-device max sectors */
636
	unsigned int		cdb_len;
637

638
	/* per-dev xfer mask */
639 640 641
	unsigned long		pio_mask;
	unsigned long		mwdma_mask;
	unsigned long		udma_mask;
642

643 644 645 646
	/* for CHS addressing */
	u16			cylinders;	/* Number of cylinders */
	u16			heads;		/* Number of heads */
	u16			sectors;	/* Number of sectors per track */
647

648 649 650 651
	union {
		u16		id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
		u32		gscr[SATA_PMP_GSCR_DWORDS]; /* PMP GSCR block */
	};
652 653 654 655 656

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

659 660
/* Fields between ATA_DEVICE_CLEAR_BEGIN and ATA_DEVICE_CLEAR_END are
 * cleared to zero on ata_dev_init().
661
 */
662 663
#define ATA_DEVICE_CLEAR_BEGIN		offsetof(struct ata_device, n_sectors)
#define ATA_DEVICE_CLEAR_END		offsetof(struct ata_device, ering)
664

665 666 667 668 669
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 */
670
	unsigned int		dev_action[ATA_MAX_DEVICES]; /* dev EH action */
671
	unsigned int		flags;		/* ATA_EHI_* flags */
672 673 674

	unsigned int		probe_mask;

675 676 677 678 679 680 681
	char			desc[ATA_EH_DESC_LEN];
	int			desc_len;
};

struct ata_eh_context {
	struct ata_eh_info	i;
	int			tries[ATA_MAX_DEVICES];
682 683
	int			cmd_timeout_idx[ATA_MAX_DEVICES]
					       [ATA_EH_CMD_TIMEOUT_TABLE_SIZE];
684 685
	unsigned int		classes[ATA_MAX_DEVICES];
	unsigned int		did_probe_mask;
686
	unsigned int		unloaded_mask;
687 688
	unsigned int		saved_ncq_enabled;
	u8			saved_xfer_mode[ATA_MAX_DEVICES];
689 690
	/* timestamp for the last reset attempt or success */
	unsigned long		last_reset;
691 692
};

693 694 695 696 697 698 699 700 701 702 703
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 已提交
704 705
struct ata_link {
	struct ata_port		*ap;
T
Tejun Heo 已提交
706
	int			pmp;		/* port multiplier port # */
T
Tejun Heo 已提交
707

G
Gwendal Grignou 已提交
708
	struct device		tdev;
T
Tejun Heo 已提交
709 710 711
	unsigned int		active_tag;	/* active tag on this link */
	u32			sactive;	/* active NCQ commands */

712 713
	unsigned int		flags;		/* ATA_LFLAG_xxx */

T
Tejun Heo 已提交
714
	u32			saved_scontrol;	/* SControl on probe */
T
Tejun Heo 已提交
715 716 717
	unsigned int		hw_sata_spd_limit;
	unsigned int		sata_spd_limit;
	unsigned int		sata_spd;	/* current SATA PHY speed */
718
	enum ata_lpm_policy	lpm_policy;
T
Tejun Heo 已提交
719 720 721 722 723 724 725 726

	/* 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];
};
G
Gwendal Grignou 已提交
727 728
#define ATA_LINK_CLEAR_BEGIN		offsetof(struct ata_link, active_tag)
#define ATA_LINK_CLEAR_END		offsetof(struct ata_link, device[0])
T
Tejun Heo 已提交
729

L
Linus Torvalds 已提交
730
struct ata_port {
J
Jeff Garzik 已提交
731
	struct Scsi_Host	*scsi_host; /* our co-allocated scsi host */
732
	struct ata_port_operations *ops;
733
	spinlock_t		*lock;
734 735
	/* Flags owned by the EH context. Only EH should touch these once the
	   port is active */
L
Linus Torvalds 已提交
736
	unsigned long		flags;	/* ATA_FLAG_xxx */
737
	/* Flags that change dynamically, protected by ap->lock */
738
	unsigned int		pflags; /* ATA_PFLAG_xxx */
T
Tejun Heo 已提交
739 740
	unsigned int		print_id; /* user visible unique port ID */
	unsigned int		port_no; /* 0 based port no. inside the host */
L
Linus Torvalds 已提交
741

T
Tejun Heo 已提交
742
#ifdef CONFIG_ATA_SFF
L
Linus Torvalds 已提交
743 744 745
	struct ata_ioports	ioaddr;	/* ATA cmd/ctl/dma register blocks */
	u8			ctl;	/* cache of ATA control register */
	u8			last_ctl;	/* Cache last written value */
746
	struct ata_link*	sff_pio_task_link; /* link currently used */
747
	struct delayed_work	sff_pio_task;
T
Tejun Heo 已提交
748
#ifdef CONFIG_ATA_BMDMA
T
Tejun Heo 已提交
749 750
	struct ata_bmdma_prd	*bmdma_prd;	/* BMDMA SG list */
	dma_addr_t		bmdma_prd_dma;	/* and its DMA mapping */
T
Tejun Heo 已提交
751
#endif /* CONFIG_ATA_BMDMA */
752 753
#endif /* CONFIG_ATA_SFF */

L
Linus Torvalds 已提交
754 755 756 757 758 759
	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];
760
	unsigned long		qc_allocated;
761
	unsigned int		qc_active;
762
	int			nr_active_links; /* #links with active qcs */
763

T
Tejun Heo 已提交
764 765
	struct ata_link		link;		/* host default link */
	struct ata_link		*slave_link;	/* see ata_slave_link_init() */
L
Linus Torvalds 已提交
766

T
Tejun Heo 已提交
767 768
	int			nr_pmp_links;	/* nr of available PMP links */
	struct ata_link		*pmp_link;	/* array of PMP links */
769
	struct ata_link		*excl_link;	/* for PMP qc exclusion */
T
Tejun Heo 已提交
770

J
Jeff Garzik 已提交
771 772
	struct ata_port_stats	stats;
	struct ata_host		*host;
773
	struct device 		*dev;
G
Gwendal Grignou 已提交
774
	struct device		tdev;
L
Linus Torvalds 已提交
775

776
	struct mutex		scsi_scan_mutex;
777
	struct delayed_work	hotplug_task;
778
	struct work_struct	scsi_rescan_task;
T
Tejun Heo 已提交
779

A
Albert Lee 已提交
780
	unsigned int		hsm_task_state;
L
Linus Torvalds 已提交
781

782
	u32			msg_enable;
783
	struct list_head	eh_done_q;
784
	wait_queue_head_t	eh_wait_q;
785
	int			eh_tries;
786
	struct completion	park_req_pending;
787

788 789
	pm_message_t		pm_mesg;
	int			*pm_result;
790
	enum ata_lpm_policy	target_lpm_policy;
791

T
Tejun Heo 已提交
792 793 794
	struct timer_list	fastdrain_timer;
	unsigned long		fastdrain_cnt;

795
	int			em_message_type;
L
Linus Torvalds 已提交
796
	void			*private_data;
797

798 799
#ifdef CONFIG_ATA_ACPI
	acpi_handle		acpi_handle;
800
	struct ata_acpi_gtm	__acpi_init_gtm; /* use ata_acpi_init_gtm() */
801
#endif
T
Tejun Heo 已提交
802 803
	/* owned by EH */
	u8			sector_buf[ATA_SECT_SIZE] ____cacheline_aligned;
L
Linus Torvalds 已提交
804 805
};

806 807 808 809 810 811 812
/* 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 已提交
813
struct ata_port_operations {
814 815 816 817 818 819 820
	/*
	 * 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);
821
	bool (*qc_fill_rtf)(struct ata_queued_cmd *qc);
L
Linus Torvalds 已提交
822

823 824 825 826 827 828 829 830
	/*
	 * 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);
831
	unsigned int (*read_id)(struct ata_device *dev, struct ata_taskfile *tf, u16 *id);
L
Linus Torvalds 已提交
832

833
	void (*dev_config)(struct ata_device *dev);
L
Linus Torvalds 已提交
834

835 836
	void (*freeze)(struct ata_port *ap);
	void (*thaw)(struct ata_port *ap);
837 838 839 840 841 842 843 844
	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;
845
	void (*error_handler)(struct ata_port *ap);
A
Alan Cox 已提交
846
	void (*lost_interrupt)(struct ata_port *ap);
847 848 849 850 851
	void (*post_internal_cmd)(struct ata_queued_cmd *qc);

	/*
	 * Optional features
	 */
T
Tejun Heo 已提交
852 853
	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);
854 855
	void (*pmp_attach)(struct ata_port *ap);
	void (*pmp_detach)(struct ata_port *ap);
856 857
	int  (*set_lpm)(struct ata_link *link, enum ata_lpm_policy policy,
			unsigned hints);
858 859 860 861 862 863 864 865 866 867

	/*
	 * 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 已提交
868
#ifdef CONFIG_ATA_SFF
869 870 871
	/*
	 * SFF / taskfile oriented ops
	 */
T
Tejun Heo 已提交
872
	void (*sff_dev_select)(struct ata_port *ap, unsigned int device);
873
	void (*sff_set_devctl)(struct ata_port *ap, u8 ctl);
T
Tejun Heo 已提交
874 875 876 877 878 879 880 881
	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);
882
	void (*sff_irq_on)(struct ata_port *);
883
	bool (*sff_irq_check)(struct ata_port *);
T
Tejun Heo 已提交
884
	void (*sff_irq_clear)(struct ata_port *);
885
	void (*sff_drain_fifo)(struct ata_queued_cmd *qc);
T
Tejun Heo 已提交
886

T
Tejun Heo 已提交
887
#ifdef CONFIG_ATA_BMDMA
888 889 890 891
	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 已提交
892
#endif /* CONFIG_ATA_BMDMA */
T
Tejun Heo 已提交
893
#endif /* CONFIG_ATA_SFF */
894

895 896 897 898 899 900
	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);
901 902
	/*
	 * Obsolete
903
	 */
904 905
	void (*phy_reset)(struct ata_port *ap);
	void (*eng_timeout)(struct ata_port *ap);
906 907 908 909 910 911

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

struct ata_port_info {
J
Jeff Garzik 已提交
915
	unsigned long		flags;
916
	unsigned long		link_flags;
L
Linus Torvalds 已提交
917 918 919
	unsigned long		pio_mask;
	unsigned long		mwdma_mask;
	unsigned long		udma_mask;
920
	struct ata_port_operations *port_ops;
921
	void 			*private_data;
L
Linus Torvalds 已提交
922 923
};

A
Alan Cox 已提交
924 925 926 927 928 929 930 931
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 */
932
	unsigned short dmack_hold;	/* tj */
A
Alan Cox 已提交
933 934 935 936
	unsigned short cycle;		/* t0 */
	unsigned short udma;		/* t2CYCTYP/2 */
};

T
Tejun Heo 已提交
937 938 939
/*
 * Core layer - drivers/ata/libata-core.c
 */
940 941 942 943
extern const unsigned long sata_deb_timing_normal[];
extern const unsigned long sata_deb_timing_hotplug[];
extern const unsigned long sata_deb_timing_long[];

944
extern struct ata_port_operations ata_dummy_port_ops;
945
extern const struct ata_port_info ata_dummy_port_info;
T
Tejun Heo 已提交
946

947 948 949 950 951 952 953 954
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;
}
955

T
Tejun Heo 已提交
956 957 958 959 960
static inline int ata_port_is_dummy(struct ata_port *ap)
{
	return ap->ops == &ata_dummy_port_ops;
}

961
extern int sata_set_spd(struct ata_link *link);
962
extern int ata_std_prereset(struct ata_link *link, unsigned long deadline);
963 964
extern int ata_wait_after_reset(struct ata_link *link, unsigned long deadline,
				int (*check_ready)(struct ata_link *link));
965 966 967 968
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);
969 970
extern int sata_link_scr_lpm(struct ata_link *link, enum ata_lpm_policy policy,
			     bool spm_wakeup);
T
Tejun Heo 已提交
971
extern int sata_link_hardreset(struct ata_link *link,
972 973
			const unsigned long *timing, unsigned long deadline,
			bool *online, int (*check_ready)(struct ata_link *));
974 975
extern int sata_std_hardreset(struct ata_link *link, unsigned int *class,
			      unsigned long deadline);
976
extern void ata_std_postreset(struct ata_link *link, unsigned int *classes);
977

978
extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
979 980
extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
			const struct ata_port_info * const * ppi, int n_ports);
T
Tejun Heo 已提交
981
extern int ata_slave_link_init(struct ata_port *ap);
982
extern int ata_host_start(struct ata_host *host);
983 984
extern int ata_host_register(struct ata_host *host,
			     struct scsi_host_template *sht);
985 986 987
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 已提交
988
extern void ata_host_detach(struct ata_host *host);
J
Jeff Garzik 已提交
989
extern void ata_host_init(struct ata_host *, struct device *,
990
			  unsigned long, struct ata_port_operations *);
991
extern int ata_scsi_detect(struct scsi_host_template *sht);
L
Linus Torvalds 已提交
992
extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
J
Jeff Garzik 已提交
993
extern int ata_scsi_queuecmd(struct Scsi_Host *h, struct scsi_cmnd *cmd);
994 995
extern int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *dev,
			    int cmd, void __user *arg);
996
extern void ata_sas_port_destroy(struct ata_port *);
J
Jeff Garzik 已提交
997
extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
998 999 1000 1001 1002
					   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 *);
1003
extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, struct ata_port *ap);
1004 1005 1006 1007
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);
1008 1009
extern bool ata_link_online(struct ata_link *link);
extern bool ata_link_offline(struct ata_link *link);
1010
#ifdef CONFIG_PM
J
Jeff Garzik 已提交
1011 1012
extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
extern void ata_host_resume(struct ata_host *host);
1013
#endif
1014
extern int ata_ratelimit(void);
1015 1016 1017
extern void ata_msleep(struct ata_port *ap, unsigned int msecs);
extern u32 ata_wait_register(struct ata_port *ap, void __iomem *reg, u32 mask,
			u32 val, unsigned long interval, unsigned long timeout);
T
Tejun Heo 已提交
1018
extern int atapi_cmd_type(u8 opcode);
1019 1020
extern void ata_tf_to_fis(const struct ata_taskfile *tf,
			  u8 pmp, int is_cmd, u8 *fis);
J
Jeff Garzik 已提交
1021
extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
1022 1023 1024 1025 1026 1027 1028 1029 1030 1031
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);
1032
extern int ata_std_qc_defer(struct ata_queued_cmd *qc);
1033
extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
L
Linus Torvalds 已提交
1034 1035
extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
		 unsigned int n_elem);
J
Jeff Garzik 已提交
1036
extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
1037
extern void ata_dev_disable(struct ata_device *adev);
1038 1039 1040 1041
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);
1042 1043
extern unsigned int ata_do_dev_read_id(struct ata_device *dev,
					struct ata_taskfile *tf, u16 *id);
1044
extern void ata_qc_complete(struct ata_queued_cmd *qc);
1045
extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active);
1046
extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd);
L
Linus Torvalds 已提交
1047 1048 1049
extern int ata_std_bios_param(struct scsi_device *sdev,
			      struct block_device *bdev,
			      sector_t capacity, int geom[]);
1050
extern void ata_scsi_unlock_native_capacity(struct scsi_device *sdev);
L
Linus Torvalds 已提交
1051
extern int ata_scsi_slave_config(struct scsi_device *sdev);
1052
extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
1053
extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
1054
				       int queue_depth, int reason);
1055 1056
extern int __ata_change_queue_depth(struct ata_port *ap, struct scsi_device *sdev,
				    int queue_depth, int reason);
T
Tejun Heo 已提交
1057
extern struct ata_device *ata_dev_pair(struct ata_device *adev);
1058
extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
1059 1060
extern void ata_scsi_port_error_handler(struct Scsi_Host *host, struct ata_port *ap);
extern void ata_scsi_cmd_error_handler(struct Scsi_Host *host, struct ata_port *ap, struct list_head *eh_q);
L
Linus Torvalds 已提交
1061

A
Alan Cox 已提交
1062 1063 1064
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 已提交
1065
extern int ata_cable_ignore(struct ata_port *ap);
A
Alan Cox 已提交
1066 1067
extern int ata_cable_unknown(struct ata_port *ap);

T
Tejun Heo 已提交
1068
/* Timing helpers */
1069
extern unsigned int ata_pio_need_iordy(const struct ata_device *);
1070
extern const struct ata_timing *ata_timing_find_mode(u8 xfer_mode);
A
Alan Cox 已提交
1071 1072 1073 1074 1075
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);
1076
extern u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle);
A
Alan Cox 已提交
1077

T
Tejun Heo 已提交
1078 1079 1080 1081 1082 1083 1084 1085 1086
/* 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 已提交
1087 1088
};

T
Tejun Heo 已提交
1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102
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 已提交
1103
#ifdef CONFIG_ATA_ACPI
1104 1105 1106 1107 1108 1109
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;
}
1110 1111
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);
1112 1113
unsigned long ata_acpi_gtm_xfermask(struct ata_device *dev,
				    const struct ata_acpi_gtm *gtm);
1114
int ata_acpi_cbl_80wire(struct ata_port *ap, const struct ata_acpi_gtm *gtm);
A
Alan Cox 已提交
1115
#else
1116 1117 1118 1119
static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
{
	return NULL;
}
1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137

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;
}
1138 1139 1140 1141 1142 1143

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

1146
/*
T
Tejun Heo 已提交
1147
 * EH - drivers/ata/libata-eh.c
1148
 */
1149
extern void ata_port_schedule_eh(struct ata_port *ap);
1150
extern int ata_link_abort(struct ata_link *link);
1151
extern int ata_port_abort(struct ata_port *ap);
1152
extern int ata_port_freeze(struct ata_port *ap);
1153
extern int sata_async_notification(struct ata_port *ap);
1154 1155 1156

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

1158 1159
extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
1160
extern void ata_eh_analyze_ncq_error(struct ata_link *link);
1161

1162 1163 1164
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);
1165
extern void ata_std_error_handler(struct ata_port *ap);
1166
extern int ata_link_nr_enabled(struct ata_link *link);
T
Tejun Heo 已提交
1167

1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190
/*
 * 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;
1191
extern struct device_attribute *ata_common_sdev_attrs[];
1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205

#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,	\
1206
	.bios_param		= ata_std_bios_param,		\
1207
	.unlock_native_capacity	= ata_scsi_unlock_native_capacity, \
1208
	.sdev_attrs		= ata_common_sdev_attrs
1209 1210 1211 1212 1213

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

T
Tejun Heo 已提交
1214 1215 1216
/*
 * PMP helpers
 */
T
Tejun Heo 已提交
1217
#ifdef CONFIG_SATA_PMP
T
Tejun Heo 已提交
1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229
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 已提交
1230
	return link == &link->ap->link || link == link->ap->slave_link;
T
Tejun Heo 已提交
1231
}
T
Tejun Heo 已提交
1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247
#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 已提交
1248 1249 1250 1251 1252 1253 1254 1255

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

1256 1257 1258
/*
 * printk helpers
 */
1259
__printf(3, 4)
1260 1261
int ata_port_printk(const struct ata_port *ap, const char *level,
		    const char *fmt, ...);
1262
__printf(3, 4)
1263 1264
int ata_link_printk(const struct ata_link *link, const char *level,
		    const char *fmt, ...);
1265
__printf(3, 4)
1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300
int ata_dev_printk(const struct ata_device *dev, const char *level,
		   const char *fmt, ...);

#define ata_port_err(ap, fmt, ...)				\
	ata_port_printk(ap, KERN_ERR, fmt, ##__VA_ARGS__)
#define ata_port_warn(ap, fmt, ...)				\
	ata_port_printk(ap, KERN_WARNING, fmt, ##__VA_ARGS__)
#define ata_port_notice(ap, fmt, ...)				\
	ata_port_printk(ap, KERN_NOTICE, fmt, ##__VA_ARGS__)
#define ata_port_info(ap, fmt, ...)				\
	ata_port_printk(ap, KERN_INFO, fmt, ##__VA_ARGS__)
#define ata_port_dbg(ap, fmt, ...)				\
	ata_port_printk(ap, KERN_DEBUG, fmt, ##__VA_ARGS__)

#define ata_link_err(link, fmt, ...)				\
	ata_link_printk(link, KERN_ERR, fmt, ##__VA_ARGS__)
#define ata_link_warn(link, fmt, ...)				\
	ata_link_printk(link, KERN_WARNING, fmt, ##__VA_ARGS__)
#define ata_link_notice(link, fmt, ...)				\
	ata_link_printk(link, KERN_NOTICE, fmt, ##__VA_ARGS__)
#define ata_link_info(link, fmt, ...)				\
	ata_link_printk(link, KERN_INFO, fmt, ##__VA_ARGS__)
#define ata_link_dbg(link, fmt, ...)				\
	ata_link_printk(link, KERN_DEBUG, fmt, ##__VA_ARGS__)

#define ata_dev_err(dev, fmt, ...)				\
	ata_dev_printk(dev, KERN_ERR, fmt, ##__VA_ARGS__)
#define ata_dev_warn(dev, fmt, ...)				\
	ata_dev_printk(dev, KERN_WARNING, fmt, ##__VA_ARGS__)
#define ata_dev_notice(dev, fmt, ...)				\
	ata_dev_printk(dev, KERN_NOTICE, fmt, ##__VA_ARGS__)
#define ata_dev_info(dev, fmt, ...)				\
	ata_dev_printk(dev, KERN_INFO, fmt, ##__VA_ARGS__)
#define ata_dev_dbg(dev, fmt, ...)				\
	ata_dev_printk(dev, KERN_DEBUG, fmt, ##__VA_ARGS__)
L
Linus Torvalds 已提交
1301

1302 1303
void ata_print_version(const struct device *dev, const char *version);

1304 1305 1306
/*
 * ata_eh_info helpers
 */
1307 1308 1309 1310
extern __printf(2, 3)
void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
extern __printf(2, 3)
void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
T
Tejun Heo 已提交
1311
extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
1312

1313 1314
static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
{
1315
	ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
1316
	ehi->flags |= ATA_EHI_HOTPLUGGED;
1317
	ehi->action |= ATA_EH_RESET | ATA_EH_ENABLE_LINK;
1318 1319 1320
	ehi->err_mask |= AC_ERR_ATA_BUS;
}

1321 1322 1323
/*
 * port description helpers
 */
1324 1325
extern __printf(2, 3)
void ata_port_desc(struct ata_port *ap, const char *fmt, ...);
1326 1327 1328 1329 1330
#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 已提交
1331 1332 1333 1334 1335
static inline unsigned int ata_tag_valid(unsigned int tag)
{
	return (tag < ATA_MAX_QUEUE) ? 1 : 0;
}

1336 1337
static inline unsigned int ata_tag_internal(unsigned int tag)
{
1338
	return tag == ATA_TAG_INTERNAL;
1339 1340
}

1341 1342 1343
/*
 * device helpers
 */
1344
static inline unsigned int ata_class_enabled(unsigned int class)
1345
{
1346 1347
	return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI ||
		class == ATA_DEV_PMP || class == ATA_DEV_SEMB;
1348 1349
}

1350
static inline unsigned int ata_class_disabled(unsigned int class)
L
Linus Torvalds 已提交
1351
{
1352 1353
	return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP ||
		class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP;
1354 1355
}

1356 1357 1358 1359 1360
static inline unsigned int ata_class_absent(unsigned int class)
{
	return !ata_class_enabled(class) && !ata_class_disabled(class);
}

1361 1362 1363 1364 1365 1366 1367 1368
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 已提交
1369 1370
}

1371 1372 1373 1374 1375
static inline unsigned int ata_dev_absent(const struct ata_device *dev)
{
	return ata_class_absent(dev->class);
}

1376
/*
1377
 * link helpers
1378
 */
1379
static inline int ata_link_max_devices(const struct ata_link *link)
1380
{
T
Tejun Heo 已提交
1381
	if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS)
1382 1383 1384 1385
		return 2;
	return 1;
}

1386 1387 1388 1389 1390
static inline int ata_link_active(struct ata_link *link)
{
	return ata_tag_valid(link->active_tag) || link->sactive;
}

T
Tejun Heo 已提交
1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446
/*
 * 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))
1447

1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462
/**
 *	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 已提交
1463

L
Linus Torvalds 已提交
1464 1465 1466 1467 1468
static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
{
	qc->tf.ctl |= ATA_NIEN;
}

1469 1470
static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
						       unsigned int tag)
L
Linus Torvalds 已提交
1471 1472 1473 1474 1475 1476
{
	if (likely(ata_tag_valid(tag)))
		return &ap->qcmd[tag];
	return NULL;
}

1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491
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;
}

1492 1493 1494 1495 1496
static inline unsigned int ata_qc_raw_nbytes(struct ata_queued_cmd *qc)
{
	return qc->nbytes - min(qc->extrabytes, qc->nbytes);
}

T
Tejun Heo 已提交
1497
static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
L
Linus Torvalds 已提交
1498 1499 1500
{
	memset(tf, 0, sizeof(*tf));

1501
#ifdef CONFIG_ATA_SFF
T
Tejun Heo 已提交
1502
	tf->ctl = dev->link->ap->ctl;
1503 1504 1505
#else
	tf->ctl = ATA_DEVCTL_OBS;
#endif
T
Tejun Heo 已提交
1506
	if (dev->devno == 0)
L
Linus Torvalds 已提交
1507 1508 1509 1510 1511
		tf->device = ATA_DEVICE_OBS;
	else
		tf->device = ATA_DEVICE_OBS | ATA_DEV1;
}

J
Jeff Garzik 已提交
1512 1513
static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
{
1514
	qc->dma_dir = DMA_NONE;
T
Tejun Heo 已提交
1515
	qc->sg = NULL;
J
Jeff Garzik 已提交
1516
	qc->flags = 0;
J
Jens Axboe 已提交
1517 1518
	qc->cursg = NULL;
	qc->cursg_ofs = 0;
1519
	qc->nbytes = qc->extrabytes = qc->curbytes = 0;
B
Brian King 已提交
1520
	qc->n_elem = 0;
1521
	qc->err_mask = 0;
1522
	qc->sect_size = ATA_SECT_SIZE;
J
Jeff Garzik 已提交
1523

T
Tejun Heo 已提交
1524
	ata_tf_init(qc->dev, &qc->tf);
1525 1526 1527 1528

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

J
Jeff Garzik 已提交
1531
static inline int ata_try_flush_cache(const struct ata_device *dev)
L
Linus Torvalds 已提交
1532 1533 1534 1535 1536 1537
{
	return ata_id_wcache_enabled(dev->id) ||
	       ata_id_has_flush(dev->id) ||
	       ata_id_has_flush_ext(dev->id);
}

1538 1539
static inline unsigned int ac_err_mask(u8 status)
{
1540
	if (status & (ATA_BUSY | ATA_DRQ))
1541
		return AC_ERR_HSM;
1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554
	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;
}

1555 1556
static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
{
1557
	return *(struct ata_port **)&host->hostdata[0];
1558 1559
}

1560 1561
static inline int ata_check_ready(u8 status)
{
1562 1563
	if (!(status & ATA_BUSY))
		return 1;
1564 1565 1566 1567 1568

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

1569
	return 0;
1570 1571
}

1572 1573 1574 1575 1576 1577
static inline unsigned long ata_deadline(unsigned long from_jiffies,
					 unsigned long timeout_msecs)
{
	return from_jiffies + msecs_to_jiffies(timeout_msecs);
}

1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599
/* 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);
}
1600 1601 1602 1603

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

1606 1607 1608 1609 1610
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 已提交
1611 1612 1613 1614 1615 1616 1617 1618
#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 */

1619

T
Tejun Heo 已提交
1620 1621 1622
/**************************************************************************
 * SFF - drivers/ata/libata-sff.c
 */
T
Tejun Heo 已提交
1623 1624
#ifdef CONFIG_ATA_SFF

T
Tejun Heo 已提交
1625
extern const struct ata_port_operations ata_sff_port_ops;
A
Alan Cox 已提交
1626
extern const struct ata_port_operations ata_bmdma32_port_ops;
T
Tejun Heo 已提交
1627 1628 1629 1630 1631 1632 1633

/* 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 已提交
1634 1635
extern void ata_sff_dev_select(struct ata_port *ap, unsigned int device);
extern u8 ata_sff_check_status(struct ata_port *ap);
1636 1637
extern void ata_sff_pause(struct ata_port *ap);
extern void ata_sff_dma_pause(struct ata_port *ap);
T
Tejun Heo 已提交
1638 1639
extern int ata_sff_busy_sleep(struct ata_port *ap,
			      unsigned long timeout_pat, unsigned long timeout);
1640
extern int ata_sff_wait_ready(struct ata_link *link, unsigned long deadline);
T
Tejun Heo 已提交
1641 1642 1643 1644 1645
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 已提交
1646
			unsigned char *buf, unsigned int buflen, int rw);
A
Alan Cox 已提交
1647 1648
extern unsigned int ata_sff_data_xfer32(struct ata_device *dev,
			unsigned char *buf, unsigned int buflen, int rw);
T
Tejun Heo 已提交
1649
extern unsigned int ata_sff_data_xfer_noirq(struct ata_device *dev,
T
Tejun Heo 已提交
1650
			unsigned char *buf, unsigned int buflen, int rw);
1651
extern void ata_sff_irq_on(struct ata_port *ap);
T
Tejun Heo 已提交
1652 1653 1654
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);
1655 1656 1657
extern void ata_sff_queue_work(struct work_struct *work);
extern void ata_sff_queue_delayed_work(struct delayed_work *dwork,
		unsigned long delay);
1658
extern void ata_sff_queue_pio_task(struct ata_link *link, unsigned long delay);
T
Tejun Heo 已提交
1659
extern unsigned int ata_sff_qc_issue(struct ata_queued_cmd *qc);
1660
extern bool ata_sff_qc_fill_rtf(struct ata_queued_cmd *qc);
1661
extern unsigned int ata_sff_port_intr(struct ata_port *ap,
T
Tejun Heo 已提交
1662 1663
				      struct ata_queued_cmd *qc);
extern irqreturn_t ata_sff_interrupt(int irq, void *dev_instance);
A
Alan Cox 已提交
1664
extern void ata_sff_lost_interrupt(struct ata_port *ap);
T
Tejun Heo 已提交
1665 1666 1667 1668 1669
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);
1670 1671
extern int ata_sff_wait_after_reset(struct ata_link *link, unsigned int devmask,
				    unsigned long deadline);
T
Tejun Heo 已提交
1672
extern int ata_sff_softreset(struct ata_link *link, unsigned int *classes,
T
Tejun Heo 已提交
1673
			     unsigned long deadline);
T
Tejun Heo 已提交
1674 1675 1676
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 已提交
1677
extern void ata_sff_drain_fifo(struct ata_queued_cmd *qc);
T
Tejun Heo 已提交
1678 1679
extern void ata_sff_error_handler(struct ata_port *ap);
extern void ata_sff_std_ports(struct ata_ioports *ioaddr);
T
Tejun Heo 已提交
1680
#ifdef CONFIG_PCI
T
Tejun Heo 已提交
1681 1682
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 已提交
1683 1684
				    const struct ata_port_info * const * ppi,
				    struct ata_host **r_host);
T
Tejun Heo 已提交
1685
extern int ata_pci_sff_activate_host(struct ata_host *host,
T
Tejun Heo 已提交
1686 1687
				     irq_handler_t irq_handler,
				     struct scsi_host_template *sht);
T
Tejun Heo 已提交
1688
extern int ata_pci_sff_init_one(struct pci_dev *pdev,
1689 1690
		const struct ata_port_info * const * ppi,
		struct scsi_host_template *sht, void *host_priv, int hflags);
T
Tejun Heo 已提交
1691 1692
#endif /* CONFIG_PCI */

T
Tejun Heo 已提交
1693 1694 1695 1696 1697 1698 1699 1700 1701
#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

1702
extern void ata_bmdma_qc_prep(struct ata_queued_cmd *qc);
1703
extern unsigned int ata_bmdma_qc_issue(struct ata_queued_cmd *qc);
1704
extern void ata_bmdma_dumb_qc_prep(struct ata_queued_cmd *qc);
1705 1706 1707
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 已提交
1708 1709
extern void ata_bmdma_error_handler(struct ata_port *ap);
extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
1710
extern void ata_bmdma_irq_clear(struct ata_port *ap);
1711 1712 1713 1714
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);
1715 1716
extern int ata_bmdma_port_start(struct ata_port *ap);
extern int ata_bmdma_port_start32(struct ata_port *ap);
1717 1718 1719

#ifdef CONFIG_PCI
extern int ata_pci_bmdma_clear_simplex(struct pci_dev *pdev);
1720
extern void ata_pci_bmdma_init(struct ata_host *host);
T
Tejun Heo 已提交
1721 1722 1723 1724 1725 1726 1727
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);
1728
#endif /* CONFIG_PCI */
T
Tejun Heo 已提交
1729
#endif /* CONFIG_ATA_BMDMA */
1730

T
Tejun Heo 已提交
1731
/**
T
Tejun Heo 已提交
1732
 *	ata_sff_busy_wait - Wait for a port status register
T
Tejun Heo 已提交
1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743
 *	@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 已提交
1744 1745
static inline u8 ata_sff_busy_wait(struct ata_port *ap, unsigned int bits,
				   unsigned int max)
T
Tejun Heo 已提交
1746 1747 1748 1749 1750
{
	u8 status;

	do {
		udelay(10);
T
Tejun Heo 已提交
1751
		status = ap->ops->sff_check_status(ap);
T
Tejun Heo 已提交
1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769
		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 已提交
1770
	u8 status = ata_sff_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
T
Tejun Heo 已提交
1771 1772 1773 1774 1775 1776 1777 1778 1779

#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 已提交
1780
#endif /* CONFIG_ATA_SFF */
T
Tejun Heo 已提交
1781

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