libata.h revision d0cb43b35d64877b2944bd37719708be5d7bbf99
1/*
2 *  Copyright 2003-2005 Red Hat, Inc.  All rights reserved.
3 *  Copyright 2003-2005 Jeff Garzik
4 *
5 *
6 *  This program is free software; you can redistribute it and/or modify
7 *  it under the terms of the GNU General Public License as published by
8 *  the Free Software Foundation; either version 2, or (at your option)
9 *  any later version.
10 *
11 *  This program is distributed in the hope that it will be useful,
12 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 *  GNU General Public License for more details.
15 *
16 *  You should have received a copy of the GNU General Public License
17 *  along with this program; see the file COPYING.  If not, write to
18 *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
19 *
20 *
21 *  libata documentation is available via 'make {ps|pdf}docs',
22 *  as Documentation/DocBook/libata.*
23 *
24 */
25
26#ifndef __LINUX_LIBATA_H__
27#define __LINUX_LIBATA_H__
28
29#include <linux/delay.h>
30#include <linux/jiffies.h>
31#include <linux/interrupt.h>
32#include <linux/dma-mapping.h>
33#include <linux/scatterlist.h>
34#include <linux/io.h>
35#include <linux/ata.h>
36#include <linux/workqueue.h>
37#include <scsi/scsi_host.h>
38#include <linux/acpi.h>
39#include <linux/cdrom.h>
40
41/*
42 * Define if arch has non-standard setup.  This is a _PCI_ standard
43 * not a legacy or ISA standard.
44 */
45#ifdef CONFIG_ATA_NONSTANDARD
46#include <asm/libata-portmap.h>
47#else
48#include <asm-generic/libata-portmap.h>
49#endif
50
51/*
52 * compile-time options: to be removed as soon as all the drivers are
53 * converted to the new debugging mechanism
54 */
55#undef ATA_DEBUG		/* debugging output */
56#undef ATA_VERBOSE_DEBUG	/* yet more debugging output */
57#undef ATA_IRQ_TRAP		/* define to ack screaming irqs */
58#undef ATA_NDEBUG		/* define to disable quick runtime checks */
59
60
61/* note: prints function name for you */
62#ifdef ATA_DEBUG
63#define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __func__, ## args)
64#ifdef ATA_VERBOSE_DEBUG
65#define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __func__, ## args)
66#else
67#define VPRINTK(fmt, args...)
68#endif	/* ATA_VERBOSE_DEBUG */
69#else
70#define DPRINTK(fmt, args...)
71#define VPRINTK(fmt, args...)
72#endif	/* ATA_DEBUG */
73
74#define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __func__, ## args)
75
76/* NEW: debug levels */
77#define HAVE_LIBATA_MSG 1
78
79enum {
80	ATA_MSG_DRV	= 0x0001,
81	ATA_MSG_INFO	= 0x0002,
82	ATA_MSG_PROBE	= 0x0004,
83	ATA_MSG_WARN	= 0x0008,
84	ATA_MSG_MALLOC	= 0x0010,
85	ATA_MSG_CTL	= 0x0020,
86	ATA_MSG_INTR	= 0x0040,
87	ATA_MSG_ERR	= 0x0080,
88};
89
90#define ata_msg_drv(p)    ((p)->msg_enable & ATA_MSG_DRV)
91#define ata_msg_info(p)   ((p)->msg_enable & ATA_MSG_INFO)
92#define ata_msg_probe(p)  ((p)->msg_enable & ATA_MSG_PROBE)
93#define ata_msg_warn(p)   ((p)->msg_enable & ATA_MSG_WARN)
94#define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC)
95#define ata_msg_ctl(p)    ((p)->msg_enable & ATA_MSG_CTL)
96#define ata_msg_intr(p)   ((p)->msg_enable & ATA_MSG_INTR)
97#define ata_msg_err(p)    ((p)->msg_enable & ATA_MSG_ERR)
98
99static inline u32 ata_msg_init(int dval, int default_msg_enable_bits)
100{
101	if (dval < 0 || dval >= (sizeof(u32) * 8))
102		return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */
103	if (!dval)
104		return 0;
105	return (1 << dval) - 1;
106}
107
108/* defines only for the constants which don't work well as enums */
109#define ATA_TAG_POISON		0xfafbfcfdU
110
111enum {
112	/* various global constants */
113	LIBATA_MAX_PRD		= ATA_MAX_PRD / 2,
114	LIBATA_DUMB_MAX_PRD	= ATA_MAX_PRD / 4,	/* Worst case */
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,
120
121	ATAPI_MAX_DRAIN		= 16 << 10,
122
123	ATA_ALL_DEVICES		= (1 << ATA_MAX_DEVICES) - 1,
124
125	ATA_SHT_EMULATED	= 1,
126	ATA_SHT_CMD_PER_LUN	= 1,
127	ATA_SHT_THIS_ID		= -1,
128	ATA_SHT_USE_CLUSTERING	= 1,
129
130	/* struct ata_device stuff */
131	ATA_DFLAG_LBA		= (1 << 0), /* device supports LBA */
132	ATA_DFLAG_LBA48		= (1 << 1), /* device supports LBA48 */
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 */
136	ATA_DFLAG_ACPI_PENDING	= (1 << 5), /* ACPI resume action pending */
137	ATA_DFLAG_ACPI_FAILED	= (1 << 6), /* ACPI on devcfg has failed */
138	ATA_DFLAG_AN		= (1 << 7), /* AN configured */
139	ATA_DFLAG_HIPM		= (1 << 8), /* device supports HIPM */
140	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,
143
144	ATA_DFLAG_PIO		= (1 << 12), /* device limited to PIO mode */
145	ATA_DFLAG_NCQ_OFF	= (1 << 13), /* device limited to non-NCQ mode */
146	ATA_DFLAG_SPUNDOWN	= (1 << 14), /* XXX: for spindown_compat */
147	ATA_DFLAG_SLEEPING	= (1 << 15), /* device is sleeping */
148	ATA_DFLAG_DUBIOUS_XFER	= (1 << 16), /* data transfer not verified */
149	ATA_DFLAG_NO_UNLOAD	= (1 << 17), /* device doesn't support unload */
150	ATA_DFLAG_INIT_MASK	= (1 << 24) - 1,
151
152	ATA_DFLAG_DETACH	= (1 << 24),
153	ATA_DFLAG_DETACHED	= (1 << 25),
154
155	ATA_DEV_UNKNOWN		= 0,	/* unknown device */
156	ATA_DEV_ATA		= 1,	/* ATA device */
157	ATA_DEV_ATA_UNSUP	= 2,	/* ATA device (unsupported) */
158	ATA_DEV_ATAPI		= 3,	/* ATAPI device */
159	ATA_DEV_ATAPI_UNSUP	= 4,	/* ATAPI device (unsupported) */
160	ATA_DEV_PMP		= 5,	/* SATA port multiplier */
161	ATA_DEV_PMP_UNSUP	= 6,	/* SATA port multiplier (unsupported) */
162	ATA_DEV_SEMB		= 7,	/* SEMB */
163	ATA_DEV_SEMB_UNSUP	= 8,	/* SEMB (unsupported) */
164	ATA_DEV_NONE		= 9,	/* no device */
165
166	/* struct ata_link flags */
167	ATA_LFLAG_NO_HRST	= (1 << 1), /* avoid hardreset */
168	ATA_LFLAG_NO_SRST	= (1 << 2), /* avoid softreset */
169	ATA_LFLAG_ASSUME_ATA	= (1 << 3), /* assume ATA class */
170	ATA_LFLAG_ASSUME_SEMB	= (1 << 4), /* assume SEMB class */
171	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
176	/* struct ata_port flags */
177	ATA_FLAG_SLAVE_POSS	= (1 << 0), /* host supports slave dev */
178					    /* (doesn't imply presence) */
179	ATA_FLAG_SATA		= (1 << 1),
180	ATA_FLAG_NO_LEGACY	= (1 << 2), /* no legacy mode check */
181	ATA_FLAG_MMIO		= (1 << 3), /* use MMIO, not PIO */
182	ATA_FLAG_SRST		= (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */
183	ATA_FLAG_SATA_RESET	= (1 << 5), /* (obsolete) use COMRESET */
184	ATA_FLAG_NO_ATAPI	= (1 << 6), /* No ATAPI support */
185	ATA_FLAG_PIO_DMA	= (1 << 7), /* PIO cmds via DMA */
186	ATA_FLAG_PIO_LBA48	= (1 << 8), /* Host DMA engine is LBA28 only */
187	ATA_FLAG_PIO_POLLING	= (1 << 9), /* use polling PIO if LLD
188					     * doesn't handle PIO interrupts */
189	ATA_FLAG_NCQ		= (1 << 10), /* host supports NCQ */
190	ATA_FLAG_NO_POWEROFF_SPINDOWN = (1 << 11), /* don't spindown before poweroff */
191	ATA_FLAG_NO_HIBERNATE_SPINDOWN = (1 << 12), /* don't spindown before hibernation */
192	ATA_FLAG_DEBUGMSG	= (1 << 13),
193	ATA_FLAG_IGN_SIMPLEX	= (1 << 15), /* ignore SIMPLEX */
194	ATA_FLAG_NO_IORDY	= (1 << 16), /* controller lacks iordy */
195	ATA_FLAG_ACPI_SATA	= (1 << 17), /* need native SATA ACPI layout */
196	ATA_FLAG_AN		= (1 << 18), /* controller supports AN */
197	ATA_FLAG_PMP		= (1 << 19), /* controller supports PMP */
198	ATA_FLAG_IPM		= (1 << 20), /* driver can handle IPM */
199	ATA_FLAG_EM		= (1 << 21), /* driver supports enclosure
200					      * management */
201	ATA_FLAG_SW_ACTIVITY	= (1 << 22), /* driver supports sw activity
202					      * led */
203
204	/* The following flag belongs to ap->pflags but is kept in
205	 * ap->flags because it's referenced in many LLDs and will be
206	 * removed in not-too-distant future.
207	 */
208	ATA_FLAG_DISABLED	= (1 << 23), /* port is disabled, ignore it */
209
210	/* bits 24:31 of ap->flags are reserved for LLD specific flags */
211
212
213	/* struct ata_port pflags */
214	ATA_PFLAG_EH_PENDING	= (1 << 0), /* EH pending */
215	ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */
216	ATA_PFLAG_FROZEN	= (1 << 2), /* port is frozen */
217	ATA_PFLAG_RECOVERED	= (1 << 3), /* recovery action performed */
218	ATA_PFLAG_LOADING	= (1 << 4), /* boot/loading probe */
219	ATA_PFLAG_SCSI_HOTPLUG	= (1 << 6), /* SCSI hotplug scheduled */
220	ATA_PFLAG_INITIALIZING	= (1 << 7), /* being initialized, don't touch */
221	ATA_PFLAG_RESETTING	= (1 << 8), /* reset in progress */
222	ATA_PFLAG_UNLOADING	= (1 << 9), /* driver is being unloaded */
223	ATA_PFLAG_UNLOADED	= (1 << 10), /* driver is unloaded */
224
225	ATA_PFLAG_SUSPENDED	= (1 << 17), /* port is suspended (power) */
226	ATA_PFLAG_PM_PENDING	= (1 << 18), /* PM operation pending */
227	ATA_PFLAG_INIT_GTM_VALID = (1 << 19), /* initial gtm data valid */
228
229	ATA_PFLAG_PIO32		= (1 << 20),  /* 32bit PIO */
230	ATA_PFLAG_PIO32CHANGE	= (1 << 21),  /* 32bit PIO can be turned on/off */
231
232	/* struct ata_queued_cmd flags */
233	ATA_QCFLAG_ACTIVE	= (1 << 0), /* cmd not yet ack'd to scsi lyer */
234	ATA_QCFLAG_DMAMAP	= (1 << 1), /* SG table is DMA mapped */
235	ATA_QCFLAG_IO		= (1 << 3), /* standard IO command */
236	ATA_QCFLAG_RESULT_TF	= (1 << 4), /* result TF requested */
237	ATA_QCFLAG_CLEAR_EXCL	= (1 << 5), /* clear excl_link on completion */
238	ATA_QCFLAG_QUIET	= (1 << 6), /* don't report device error */
239	ATA_QCFLAG_RETRY	= (1 << 7), /* retry after failure */
240
241	ATA_QCFLAG_FAILED	= (1 << 16), /* cmd failed and is owned by EH */
242	ATA_QCFLAG_SENSE_VALID	= (1 << 17), /* sense data valid */
243	ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
244
245	/* host set flags */
246	ATA_HOST_SIMPLEX	= (1 << 0),	/* Host is simplex, one DMA channel per host only */
247	ATA_HOST_STARTED	= (1 << 1),	/* Host started */
248	ATA_HOST_PARALLEL_SCAN	= (1 << 2),	/* Ports on this host can be scanned in parallel */
249
250	/* bits 24:31 of host->flags are reserved for LLD specific flags */
251
252	/* various lengths of time */
253	ATA_TMOUT_BOOT		= 30000,	/* heuristic */
254	ATA_TMOUT_BOOT_QUICK	=  7000,	/* heuristic */
255	ATA_TMOUT_INTERNAL_QUICK = 5000,
256	ATA_TMOUT_MAX_PARK	= 30000,
257
258	/* FIXME: GoVault needs 2s but we can't afford that without
259	 * parallel probing.  800ms is enough for iVDR disk
260	 * HHD424020F7SV00.  Increase to 2secs when parallel probing
261	 * is in place.
262	 */
263	ATA_TMOUT_FF_WAIT	=  800,
264
265	/* Spec mandates to wait for ">= 2ms" before checking status
266	 * after reset.  We wait 150ms, because that was the magic
267	 * delay used for ATAPI devices in Hale Landis's ATADRVR, for
268	 * the period of time between when the ATA command register is
269	 * written, and then status is checked.  Because waiting for
270	 * "a while" before checking status is fine, post SRST, we
271	 * perform this magic delay here as well.
272	 *
273	 * Old drivers/ide uses the 2mS rule and then waits for ready.
274	 */
275	ATA_WAIT_AFTER_RESET	=  150,
276
277	/* If PMP is supported, we have to do follow-up SRST.  As some
278	 * PMPs don't send D2H Reg FIS after hardreset, LLDs are
279	 * advised to wait only for the following duration before
280	 * doing SRST.
281	 */
282	ATA_TMOUT_PMP_SRST_WAIT	= 5000,
283
284	/* ATA bus states */
285	BUS_UNKNOWN		= 0,
286	BUS_DMA			= 1,
287	BUS_IDLE		= 2,
288	BUS_NOINTR		= 3,
289	BUS_NODATA		= 4,
290	BUS_TIMER		= 5,
291	BUS_PIO			= 6,
292	BUS_EDD			= 7,
293	BUS_IDENTIFY		= 8,
294	BUS_PACKET		= 9,
295
296	/* SATA port states */
297	PORT_UNKNOWN		= 0,
298	PORT_ENABLED		= 1,
299	PORT_DISABLED		= 2,
300
301	/* encoding various smaller bitmaps into a single
302	 * unsigned long bitmap
303	 */
304	ATA_NR_PIO_MODES	= 7,
305	ATA_NR_MWDMA_MODES	= 5,
306	ATA_NR_UDMA_MODES	= 8,
307
308	ATA_SHIFT_PIO		= 0,
309	ATA_SHIFT_MWDMA		= ATA_SHIFT_PIO + ATA_NR_PIO_MODES,
310	ATA_SHIFT_UDMA		= ATA_SHIFT_MWDMA + ATA_NR_MWDMA_MODES,
311
312	/* size of buffer to pad xfers ending on unaligned boundaries */
313	ATA_DMA_PAD_SZ		= 4,
314
315	/* ering size */
316	ATA_ERING_SIZE		= 32,
317
318	/* return values for ->qc_defer */
319	ATA_DEFER_LINK		= 1,
320	ATA_DEFER_PORT		= 2,
321
322	/* desc_len for ata_eh_info and context */
323	ATA_EH_DESC_LEN		= 80,
324
325	/* reset / recovery action types */
326	ATA_EH_REVALIDATE	= (1 << 0),
327	ATA_EH_SOFTRESET	= (1 << 1), /* meaningful only in ->prereset */
328	ATA_EH_HARDRESET	= (1 << 2), /* meaningful only in ->prereset */
329	ATA_EH_RESET		= ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
330	ATA_EH_ENABLE_LINK	= (1 << 3),
331	ATA_EH_LPM		= (1 << 4),  /* link power management action */
332	ATA_EH_PARK		= (1 << 5), /* unload heads and stop I/O */
333
334	ATA_EH_PERDEV_MASK	= ATA_EH_REVALIDATE | ATA_EH_PARK,
335	ATA_EH_ALL_ACTIONS	= ATA_EH_REVALIDATE | ATA_EH_RESET |
336				  ATA_EH_ENABLE_LINK | ATA_EH_LPM,
337
338	/* ata_eh_info->flags */
339	ATA_EHI_HOTPLUGGED	= (1 << 0),  /* could have been hotplugged */
340	ATA_EHI_NO_AUTOPSY	= (1 << 2),  /* no autopsy */
341	ATA_EHI_QUIET		= (1 << 3),  /* be quiet */
342
343	ATA_EHI_DID_SOFTRESET	= (1 << 16), /* already soft-reset this port */
344	ATA_EHI_DID_HARDRESET	= (1 << 17), /* already soft-reset this port */
345	ATA_EHI_PRINTINFO	= (1 << 18), /* print configuration info */
346	ATA_EHI_SETMODE		= (1 << 19), /* configure transfer mode */
347	ATA_EHI_POST_SETMODE	= (1 << 20), /* revaildating after setmode */
348
349	ATA_EHI_DID_RESET	= ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
350
351	/* mask of flags to transfer *to* the slave link */
352	ATA_EHI_TO_SLAVE_MASK	= ATA_EHI_NO_AUTOPSY | ATA_EHI_QUIET,
353
354	/* max tries if error condition is still set after ->error_handler */
355	ATA_EH_MAX_TRIES	= 5,
356
357	/* how hard are we gonna try to probe/recover devices */
358	ATA_PROBE_MAX_TRIES	= 3,
359	ATA_EH_DEV_TRIES	= 3,
360	ATA_EH_PMP_TRIES	= 5,
361	ATA_EH_PMP_LINK_TRIES	= 3,
362
363	SATA_PMP_RW_TIMEOUT	= 3000,		/* PMP read/write timeout */
364
365	/* This should match the actual table size of
366	 * ata_eh_cmd_timeout_table in libata-eh.c.
367	 */
368	ATA_EH_CMD_TIMEOUT_TABLE_SIZE = 5,
369
370	/* Horkage types. May be set by libata or controller on drives
371	   (some horkage may be drive/controller pair dependant */
372
373	ATA_HORKAGE_DIAGNOSTIC	= (1 << 0),	/* Failed boot diag */
374	ATA_HORKAGE_NODMA	= (1 << 1),	/* DMA problems */
375	ATA_HORKAGE_NONCQ	= (1 << 2),	/* Don't use NCQ */
376	ATA_HORKAGE_MAX_SEC_128	= (1 << 3),	/* Limit max sects to 128 */
377	ATA_HORKAGE_BROKEN_HPA	= (1 << 4),	/* Broken HPA */
378	ATA_HORKAGE_DISABLE	= (1 << 5),	/* Disable it */
379	ATA_HORKAGE_HPA_SIZE	= (1 << 6),	/* native size off by one */
380	ATA_HORKAGE_IPM		= (1 << 7),	/* Link PM problems */
381	ATA_HORKAGE_IVB		= (1 << 8),	/* cbl det validity bit bugs */
382	ATA_HORKAGE_STUCK_ERR	= (1 << 9),	/* stuck ERR on next PACKET */
383	ATA_HORKAGE_BRIDGE_OK	= (1 << 10),	/* no bridge limits */
384	ATA_HORKAGE_ATAPI_MOD16_DMA = (1 << 11), /* use ATAPI DMA for commands
385						    not multiple of 16 bytes */
386	ATA_HORKAGE_FIRMWARE_WARN = (1 << 12),	/* firmware update warning */
387	ATA_HORKAGE_1_5_GBPS	= (1 << 13),	/* force 1.5 Gbps */
388	ATA_HORKAGE_NOSETXFER	= (1 << 14),	/* skip SETXFER, SATA only */
389
390	 /* DMA mask for user DMA control: User visible values; DO NOT
391	    renumber */
392	ATA_DMA_MASK_ATA	= (1 << 0),	/* DMA on ATA Disk */
393	ATA_DMA_MASK_ATAPI	= (1 << 1),	/* DMA on ATAPI */
394	ATA_DMA_MASK_CFA	= (1 << 2),	/* DMA on CF Card */
395
396	/* ATAPI command types */
397	ATAPI_READ		= 0,		/* READs */
398	ATAPI_WRITE		= 1,		/* WRITEs */
399	ATAPI_READ_CD		= 2,		/* READ CD [MSF] */
400	ATAPI_PASS_THRU		= 3,		/* SAT pass-thru */
401	ATAPI_MISC		= 4,		/* the rest */
402
403	/* Timing constants */
404	ATA_TIMING_SETUP	= (1 << 0),
405	ATA_TIMING_ACT8B	= (1 << 1),
406	ATA_TIMING_REC8B	= (1 << 2),
407	ATA_TIMING_CYC8B	= (1 << 3),
408	ATA_TIMING_8BIT		= ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
409				  ATA_TIMING_CYC8B,
410	ATA_TIMING_ACTIVE	= (1 << 4),
411	ATA_TIMING_RECOVER	= (1 << 5),
412	ATA_TIMING_DMACK_HOLD	= (1 << 6),
413	ATA_TIMING_CYCLE	= (1 << 7),
414	ATA_TIMING_UDMA		= (1 << 8),
415	ATA_TIMING_ALL		= ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
416				  ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
417				  ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
418				  ATA_TIMING_DMACK_HOLD | ATA_TIMING_CYCLE |
419				  ATA_TIMING_UDMA,
420};
421
422enum ata_xfer_mask {
423	ATA_MASK_PIO		= ((1LU << ATA_NR_PIO_MODES) - 1)
424					<< ATA_SHIFT_PIO,
425	ATA_MASK_MWDMA		= ((1LU << ATA_NR_MWDMA_MODES) - 1)
426					<< ATA_SHIFT_MWDMA,
427	ATA_MASK_UDMA		= ((1LU << ATA_NR_UDMA_MODES) - 1)
428					<< ATA_SHIFT_UDMA,
429};
430
431enum hsm_task_states {
432	HSM_ST_IDLE,		/* no command on going */
433	HSM_ST_FIRST,		/* (waiting the device to)
434				   write CDB or first data block */
435	HSM_ST,			/* (waiting the device to) transfer data */
436	HSM_ST_LAST,		/* (waiting the device to) complete command */
437	HSM_ST_ERR,		/* error */
438};
439
440enum ata_completion_errors {
441	AC_ERR_DEV		= (1 << 0), /* device reported error */
442	AC_ERR_HSM		= (1 << 1), /* host state machine violation */
443	AC_ERR_TIMEOUT		= (1 << 2), /* timeout */
444	AC_ERR_MEDIA		= (1 << 3), /* media error */
445	AC_ERR_ATA_BUS		= (1 << 4), /* ATA bus error */
446	AC_ERR_HOST_BUS		= (1 << 5), /* host bus error */
447	AC_ERR_SYSTEM		= (1 << 6), /* system error */
448	AC_ERR_INVALID		= (1 << 7), /* invalid argument */
449	AC_ERR_OTHER		= (1 << 8), /* unknown */
450	AC_ERR_NODEV_HINT	= (1 << 9), /* polling device detection hint */
451	AC_ERR_NCQ		= (1 << 10), /* marker for offending NCQ qc */
452};
453
454/* forward declarations */
455struct scsi_device;
456struct ata_port_operations;
457struct ata_port;
458struct ata_link;
459struct ata_queued_cmd;
460
461/* typedefs */
462typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
463typedef int (*ata_prereset_fn_t)(struct ata_link *link, unsigned long deadline);
464typedef int (*ata_reset_fn_t)(struct ata_link *link, unsigned int *classes,
465			      unsigned long deadline);
466typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes);
467
468/*
469 * host pm policy: If you alter this, you also need to alter libata-scsi.c
470 * (for the ascii descriptions)
471 */
472enum link_pm {
473	NOT_AVAILABLE,
474	MIN_POWER,
475	MAX_PERFORMANCE,
476	MEDIUM_POWER,
477};
478extern struct device_attribute dev_attr_link_power_management_policy;
479extern struct device_attribute dev_attr_unload_heads;
480extern struct device_attribute dev_attr_em_message_type;
481extern struct device_attribute dev_attr_em_message;
482extern struct device_attribute dev_attr_sw_activity;
483
484enum sw_activity {
485	OFF,
486	BLINK_ON,
487	BLINK_OFF,
488};
489
490#ifdef CONFIG_ATA_SFF
491struct ata_ioports {
492	void __iomem		*cmd_addr;
493	void __iomem		*data_addr;
494	void __iomem		*error_addr;
495	void __iomem		*feature_addr;
496	void __iomem		*nsect_addr;
497	void __iomem		*lbal_addr;
498	void __iomem		*lbam_addr;
499	void __iomem		*lbah_addr;
500	void __iomem		*device_addr;
501	void __iomem		*status_addr;
502	void __iomem		*command_addr;
503	void __iomem		*altstatus_addr;
504	void __iomem		*ctl_addr;
505	void __iomem		*bmdma_addr;
506	void __iomem		*scr_addr;
507};
508#endif /* CONFIG_ATA_SFF */
509
510struct ata_host {
511	spinlock_t		lock;
512	struct device 		*dev;
513	void __iomem * const	*iomap;
514	unsigned int		n_ports;
515	void			*private_data;
516	struct ata_port_operations *ops;
517	unsigned long		flags;
518#ifdef CONFIG_ATA_ACPI
519	acpi_handle		acpi_handle;
520#endif
521	struct ata_port		*simplex_claimed;	/* channel owning the DMA */
522	struct ata_port		*ports[0];
523};
524
525struct ata_queued_cmd {
526	struct ata_port		*ap;
527	struct ata_device	*dev;
528
529	struct scsi_cmnd	*scsicmd;
530	void			(*scsidone)(struct scsi_cmnd *);
531
532	struct ata_taskfile	tf;
533	u8			cdb[ATAPI_CDB_LEN];
534
535	unsigned long		flags;		/* ATA_QCFLAG_xxx */
536	unsigned int		tag;
537	unsigned int		n_elem;
538	unsigned int		orig_n_elem;
539
540	int			dma_dir;
541
542	unsigned int		sect_size;
543
544	unsigned int		nbytes;
545	unsigned int		extrabytes;
546	unsigned int		curbytes;
547
548	struct scatterlist	*cursg;
549	unsigned int		cursg_ofs;
550
551	struct scatterlist	sgent;
552
553	struct scatterlist	*sg;
554
555	unsigned int		err_mask;
556	struct ata_taskfile	result_tf;
557	ata_qc_cb_t		complete_fn;
558
559	void			*private_data;
560	void			*lldd_task;
561};
562
563struct ata_port_stats {
564	unsigned long		unhandled_irq;
565	unsigned long		idle_irq;
566	unsigned long		rw_reqbuf;
567};
568
569struct ata_ering_entry {
570	unsigned int		eflags;
571	unsigned int		err_mask;
572	u64			timestamp;
573};
574
575struct ata_ering {
576	int			cursor;
577	struct ata_ering_entry	ring[ATA_ERING_SIZE];
578};
579
580struct ata_device {
581	struct ata_link		*link;
582	unsigned int		devno;		/* 0 or 1 */
583	unsigned int		horkage;	/* List of broken features */
584	unsigned long		flags;		/* ATA_DFLAG_xxx */
585	struct scsi_device	*sdev;		/* attached SCSI device */
586#ifdef CONFIG_ATA_ACPI
587	acpi_handle		acpi_handle;
588	union acpi_object	*gtf_cache;
589#endif
590	/* n_sector is CLEAR_BEGIN, read comment above CLEAR_BEGIN */
591	u64			n_sectors;	/* size of device, if ATA */
592	unsigned int		class;		/* ATA_DEV_xxx */
593	unsigned long		unpark_deadline;
594
595	u8			pio_mode;
596	u8			dma_mode;
597	u8			xfer_mode;
598	unsigned int		xfer_shift;	/* ATA_SHIFT_xxx */
599
600	unsigned int		multi_count;	/* sectors count for
601						   READ/WRITE MULTIPLE */
602	unsigned int		max_sectors;	/* per-device max sectors */
603	unsigned int		cdb_len;
604
605	/* per-dev xfer mask */
606	unsigned long		pio_mask;
607	unsigned long		mwdma_mask;
608	unsigned long		udma_mask;
609
610	/* for CHS addressing */
611	u16			cylinders;	/* Number of cylinders */
612	u16			heads;		/* Number of heads */
613	u16			sectors;	/* Number of sectors per track */
614
615	union {
616		u16		id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
617		u32		gscr[SATA_PMP_GSCR_DWORDS]; /* PMP GSCR block */
618	};
619
620	/* error history */
621	int			spdn_cnt;
622	/* ering is CLEAR_END, read comment above CLEAR_END */
623	struct ata_ering	ering;
624};
625
626/* Fields between ATA_DEVICE_CLEAR_BEGIN and ATA_DEVICE_CLEAR_END are
627 * cleared to zero on ata_dev_init().
628 */
629#define ATA_DEVICE_CLEAR_BEGIN		offsetof(struct ata_device, n_sectors)
630#define ATA_DEVICE_CLEAR_END		offsetof(struct ata_device, ering)
631
632struct ata_eh_info {
633	struct ata_device	*dev;		/* offending device */
634	u32			serror;		/* SError from LLDD */
635	unsigned int		err_mask;	/* port-wide err_mask */
636	unsigned int		action;		/* ATA_EH_* action mask */
637	unsigned int		dev_action[ATA_MAX_DEVICES]; /* dev EH action */
638	unsigned int		flags;		/* ATA_EHI_* flags */
639
640	unsigned int		probe_mask;
641
642	char			desc[ATA_EH_DESC_LEN];
643	int			desc_len;
644};
645
646struct ata_eh_context {
647	struct ata_eh_info	i;
648	int			tries[ATA_MAX_DEVICES];
649	int			cmd_timeout_idx[ATA_MAX_DEVICES]
650					       [ATA_EH_CMD_TIMEOUT_TABLE_SIZE];
651	unsigned int		classes[ATA_MAX_DEVICES];
652	unsigned int		did_probe_mask;
653	unsigned int		unloaded_mask;
654	unsigned int		saved_ncq_enabled;
655	u8			saved_xfer_mode[ATA_MAX_DEVICES];
656	/* timestamp for the last reset attempt or success */
657	unsigned long		last_reset;
658};
659
660struct ata_acpi_drive
661{
662	u32 pio;
663	u32 dma;
664} __packed;
665
666struct ata_acpi_gtm {
667	struct ata_acpi_drive drive[2];
668	u32 flags;
669} __packed;
670
671struct ata_link {
672	struct ata_port		*ap;
673	int			pmp;		/* port multiplier port # */
674
675	unsigned int		active_tag;	/* active tag on this link */
676	u32			sactive;	/* active NCQ commands */
677
678	unsigned int		flags;		/* ATA_LFLAG_xxx */
679
680	u32			saved_scontrol;	/* SControl on probe */
681	unsigned int		hw_sata_spd_limit;
682	unsigned int		sata_spd_limit;
683	unsigned int		sata_spd;	/* current SATA PHY speed */
684
685	/* record runtime error info, protected by host_set lock */
686	struct ata_eh_info	eh_info;
687	/* EH context */
688	struct ata_eh_context	eh_context;
689
690	struct ata_device	device[ATA_MAX_DEVICES];
691};
692
693struct ata_port {
694	struct Scsi_Host	*scsi_host; /* our co-allocated scsi host */
695	struct ata_port_operations *ops;
696	spinlock_t		*lock;
697	/* Flags owned by the EH context. Only EH should touch these once the
698	   port is active */
699	unsigned long		flags;	/* ATA_FLAG_xxx */
700	/* Flags that change dynamically, protected by ap->lock */
701	unsigned int		pflags; /* ATA_PFLAG_xxx */
702	unsigned int		print_id; /* user visible unique port ID */
703	unsigned int		port_no; /* 0 based port no. inside the host */
704
705	struct ata_prd		*prd;	 /* our SG list */
706	dma_addr_t		prd_dma; /* and its DMA mapping */
707
708#ifdef CONFIG_ATA_SFF
709	struct ata_ioports	ioaddr;	/* ATA cmd/ctl/dma register blocks */
710#endif /* CONFIG_ATA_SFF */
711
712	u8			ctl;	/* cache of ATA control register */
713	u8			last_ctl;	/* Cache last written value */
714	unsigned int		pio_mask;
715	unsigned int		mwdma_mask;
716	unsigned int		udma_mask;
717	unsigned int		cbl;	/* cable type; ATA_CBL_xxx */
718
719	struct ata_queued_cmd	qcmd[ATA_MAX_QUEUE];
720	unsigned long		qc_allocated;
721	unsigned int		qc_active;
722	int			nr_active_links; /* #links with active qcs */
723
724	struct ata_link		link;		/* host default link */
725	struct ata_link		*slave_link;	/* see ata_slave_link_init() */
726
727	int			nr_pmp_links;	/* nr of available PMP links */
728	struct ata_link		*pmp_link;	/* array of PMP links */
729	struct ata_link		*excl_link;	/* for PMP qc exclusion */
730
731	struct ata_port_stats	stats;
732	struct ata_host		*host;
733	struct device 		*dev;
734
735	void			*port_task_data;
736	struct delayed_work	port_task;
737	struct delayed_work	hotplug_task;
738	struct work_struct	scsi_rescan_task;
739
740	unsigned int		hsm_task_state;
741
742	u32			msg_enable;
743	struct list_head	eh_done_q;
744	wait_queue_head_t	eh_wait_q;
745	int			eh_tries;
746	struct completion	park_req_pending;
747
748	pm_message_t		pm_mesg;
749	int			*pm_result;
750	enum link_pm		pm_policy;
751
752	struct timer_list	fastdrain_timer;
753	unsigned long		fastdrain_cnt;
754
755	int			em_message_type;
756	void			*private_data;
757
758#ifdef CONFIG_ATA_ACPI
759	acpi_handle		acpi_handle;
760	struct ata_acpi_gtm	__acpi_init_gtm; /* use ata_acpi_init_gtm() */
761#endif
762	/* owned by EH */
763	u8			sector_buf[ATA_SECT_SIZE] ____cacheline_aligned;
764};
765
766/* The following initializer overrides a method to NULL whether one of
767 * its parent has the method defined or not.  This is equivalent to
768 * ERR_PTR(-ENOENT).  Unfortunately, ERR_PTR doesn't render a constant
769 * expression and thus can't be used as an initializer.
770 */
771#define ATA_OP_NULL		(void *)(unsigned long)(-ENOENT)
772
773struct ata_port_operations {
774	/*
775	 * Command execution
776	 */
777	int  (*qc_defer)(struct ata_queued_cmd *qc);
778	int  (*check_atapi_dma)(struct ata_queued_cmd *qc);
779	void (*qc_prep)(struct ata_queued_cmd *qc);
780	unsigned int (*qc_issue)(struct ata_queued_cmd *qc);
781	bool (*qc_fill_rtf)(struct ata_queued_cmd *qc);
782
783	/*
784	 * Configuration and exception handling
785	 */
786	int  (*cable_detect)(struct ata_port *ap);
787	unsigned long (*mode_filter)(struct ata_device *dev, unsigned long xfer_mask);
788	void (*set_piomode)(struct ata_port *ap, struct ata_device *dev);
789	void (*set_dmamode)(struct ata_port *ap, struct ata_device *dev);
790	int  (*set_mode)(struct ata_link *link, struct ata_device **r_failed_dev);
791	unsigned int (*read_id)(struct ata_device *dev, struct ata_taskfile *tf, u16 *id);
792
793	void (*dev_config)(struct ata_device *dev);
794
795	void (*freeze)(struct ata_port *ap);
796	void (*thaw)(struct ata_port *ap);
797	ata_prereset_fn_t	prereset;
798	ata_reset_fn_t		softreset;
799	ata_reset_fn_t		hardreset;
800	ata_postreset_fn_t	postreset;
801	ata_prereset_fn_t	pmp_prereset;
802	ata_reset_fn_t		pmp_softreset;
803	ata_reset_fn_t		pmp_hardreset;
804	ata_postreset_fn_t	pmp_postreset;
805	void (*error_handler)(struct ata_port *ap);
806	void (*lost_interrupt)(struct ata_port *ap);
807	void (*post_internal_cmd)(struct ata_queued_cmd *qc);
808
809	/*
810	 * Optional features
811	 */
812	int  (*scr_read)(struct ata_link *link, unsigned int sc_reg, u32 *val);
813	int  (*scr_write)(struct ata_link *link, unsigned int sc_reg, u32 val);
814	void (*pmp_attach)(struct ata_port *ap);
815	void (*pmp_detach)(struct ata_port *ap);
816	int  (*enable_pm)(struct ata_port *ap, enum link_pm policy);
817	void (*disable_pm)(struct ata_port *ap);
818
819	/*
820	 * Start, stop, suspend and resume
821	 */
822	int  (*port_suspend)(struct ata_port *ap, pm_message_t mesg);
823	int  (*port_resume)(struct ata_port *ap);
824	int  (*port_start)(struct ata_port *ap);
825	void (*port_stop)(struct ata_port *ap);
826	void (*host_stop)(struct ata_host *host);
827
828#ifdef CONFIG_ATA_SFF
829	/*
830	 * SFF / taskfile oriented ops
831	 */
832	void (*sff_dev_select)(struct ata_port *ap, unsigned int device);
833	u8   (*sff_check_status)(struct ata_port *ap);
834	u8   (*sff_check_altstatus)(struct ata_port *ap);
835	void (*sff_tf_load)(struct ata_port *ap, const struct ata_taskfile *tf);
836	void (*sff_tf_read)(struct ata_port *ap, struct ata_taskfile *tf);
837	void (*sff_exec_command)(struct ata_port *ap,
838				 const struct ata_taskfile *tf);
839	unsigned int (*sff_data_xfer)(struct ata_device *dev,
840			unsigned char *buf, unsigned int buflen, int rw);
841	u8   (*sff_irq_on)(struct ata_port *);
842	void (*sff_irq_clear)(struct ata_port *);
843
844	void (*bmdma_setup)(struct ata_queued_cmd *qc);
845	void (*bmdma_start)(struct ata_queued_cmd *qc);
846	void (*bmdma_stop)(struct ata_queued_cmd *qc);
847	u8   (*bmdma_status)(struct ata_port *ap);
848
849	void (*drain_fifo)(struct ata_queued_cmd *qc);
850#endif /* CONFIG_ATA_SFF */
851
852	ssize_t (*em_show)(struct ata_port *ap, char *buf);
853	ssize_t (*em_store)(struct ata_port *ap, const char *message,
854			    size_t size);
855	ssize_t (*sw_activity_show)(struct ata_device *dev, char *buf);
856	ssize_t (*sw_activity_store)(struct ata_device *dev,
857				     enum sw_activity val);
858	/*
859	 * Obsolete
860	 */
861	void (*phy_reset)(struct ata_port *ap);
862	void (*eng_timeout)(struct ata_port *ap);
863
864	/*
865	 * ->inherits must be the last field and all the preceding
866	 * fields must be pointers.
867	 */
868	const struct ata_port_operations	*inherits;
869};
870
871struct ata_port_info {
872	unsigned long		flags;
873	unsigned long		link_flags;
874	unsigned long		pio_mask;
875	unsigned long		mwdma_mask;
876	unsigned long		udma_mask;
877	struct ata_port_operations *port_ops;
878	void 			*private_data;
879};
880
881struct ata_timing {
882	unsigned short mode;		/* ATA mode */
883	unsigned short setup;		/* t1 */
884	unsigned short act8b;		/* t2 for 8-bit I/O */
885	unsigned short rec8b;		/* t2i for 8-bit I/O */
886	unsigned short cyc8b;		/* t0 for 8-bit I/O */
887	unsigned short active;		/* t2 or tD */
888	unsigned short recover;		/* t2i or tK */
889	unsigned short dmack_hold;	/* tj */
890	unsigned short cycle;		/* t0 */
891	unsigned short udma;		/* t2CYCTYP/2 */
892};
893
894/*
895 * Core layer - drivers/ata/libata-core.c
896 */
897extern const unsigned long sata_deb_timing_normal[];
898extern const unsigned long sata_deb_timing_hotplug[];
899extern const unsigned long sata_deb_timing_long[];
900
901extern struct ata_port_operations ata_dummy_port_ops;
902extern const struct ata_port_info ata_dummy_port_info;
903
904static inline const unsigned long *
905sata_ehc_deb_timing(struct ata_eh_context *ehc)
906{
907	if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
908		return sata_deb_timing_hotplug;
909	else
910		return sata_deb_timing_normal;
911}
912
913static inline int ata_port_is_dummy(struct ata_port *ap)
914{
915	return ap->ops == &ata_dummy_port_ops;
916}
917
918extern void ata_port_probe(struct ata_port *);
919extern int sata_set_spd(struct ata_link *link);
920extern int ata_std_prereset(struct ata_link *link, unsigned long deadline);
921extern int ata_wait_after_reset(struct ata_link *link, unsigned long deadline,
922				int (*check_ready)(struct ata_link *link));
923extern int sata_link_debounce(struct ata_link *link,
924			const unsigned long *params, unsigned long deadline);
925extern int sata_link_resume(struct ata_link *link, const unsigned long *params,
926			    unsigned long deadline);
927extern int sata_link_hardreset(struct ata_link *link,
928			const unsigned long *timing, unsigned long deadline,
929			bool *online, int (*check_ready)(struct ata_link *));
930extern int sata_std_hardreset(struct ata_link *link, unsigned int *class,
931			      unsigned long deadline);
932extern void ata_std_postreset(struct ata_link *link, unsigned int *classes);
933extern void ata_port_disable(struct ata_port *);
934
935extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
936extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
937			const struct ata_port_info * const * ppi, int n_ports);
938extern int ata_slave_link_init(struct ata_port *ap);
939extern int ata_host_start(struct ata_host *host);
940extern int ata_host_register(struct ata_host *host,
941			     struct scsi_host_template *sht);
942extern int ata_host_activate(struct ata_host *host, int irq,
943			     irq_handler_t irq_handler, unsigned long irq_flags,
944			     struct scsi_host_template *sht);
945extern void ata_host_detach(struct ata_host *host);
946extern void ata_host_init(struct ata_host *, struct device *,
947			  unsigned long, struct ata_port_operations *);
948extern int ata_scsi_detect(struct scsi_host_template *sht);
949extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
950extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
951extern int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *dev,
952			    int cmd, void __user *arg);
953extern void ata_sas_port_destroy(struct ata_port *);
954extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
955					   struct ata_port_info *, struct Scsi_Host *);
956extern int ata_sas_port_init(struct ata_port *);
957extern int ata_sas_port_start(struct ata_port *ap);
958extern void ata_sas_port_stop(struct ata_port *ap);
959extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
960extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
961			    struct ata_port *ap);
962extern int sata_scr_valid(struct ata_link *link);
963extern int sata_scr_read(struct ata_link *link, int reg, u32 *val);
964extern int sata_scr_write(struct ata_link *link, int reg, u32 val);
965extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val);
966extern bool ata_link_online(struct ata_link *link);
967extern bool ata_link_offline(struct ata_link *link);
968#ifdef CONFIG_PM
969extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
970extern void ata_host_resume(struct ata_host *host);
971#endif
972extern int ata_ratelimit(void);
973extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
974			     unsigned long interval, unsigned long timeout);
975extern int atapi_cmd_type(u8 opcode);
976extern void ata_tf_to_fis(const struct ata_taskfile *tf,
977			  u8 pmp, int is_cmd, u8 *fis);
978extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
979extern unsigned long ata_pack_xfermask(unsigned long pio_mask,
980			unsigned long mwdma_mask, unsigned long udma_mask);
981extern void ata_unpack_xfermask(unsigned long xfer_mask,
982			unsigned long *pio_mask, unsigned long *mwdma_mask,
983			unsigned long *udma_mask);
984extern u8 ata_xfer_mask2mode(unsigned long xfer_mask);
985extern unsigned long ata_xfer_mode2mask(u8 xfer_mode);
986extern int ata_xfer_mode2shift(unsigned long xfer_mode);
987extern const char *ata_mode_string(unsigned long xfer_mask);
988extern unsigned long ata_id_xfermask(const u16 *id);
989extern int ata_port_start(struct ata_port *ap);
990extern int ata_std_qc_defer(struct ata_queued_cmd *qc);
991extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
992extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
993		 unsigned int n_elem);
994extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
995extern void ata_dev_disable(struct ata_device *adev);
996extern void ata_id_string(const u16 *id, unsigned char *s,
997			  unsigned int ofs, unsigned int len);
998extern void ata_id_c_string(const u16 *id, unsigned char *s,
999			    unsigned int ofs, unsigned int len);
1000extern unsigned int ata_do_dev_read_id(struct ata_device *dev,
1001					struct ata_taskfile *tf, u16 *id);
1002extern void ata_qc_complete(struct ata_queued_cmd *qc);
1003extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active);
1004extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
1005			      void (*done)(struct scsi_cmnd *));
1006extern int ata_std_bios_param(struct scsi_device *sdev,
1007			      struct block_device *bdev,
1008			      sector_t capacity, int geom[]);
1009extern int ata_scsi_slave_config(struct scsi_device *sdev);
1010extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
1011extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
1012				       int queue_depth);
1013extern struct ata_device *ata_dev_pair(struct ata_device *adev);
1014extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
1015
1016extern int ata_cable_40wire(struct ata_port *ap);
1017extern int ata_cable_80wire(struct ata_port *ap);
1018extern int ata_cable_sata(struct ata_port *ap);
1019extern int ata_cable_ignore(struct ata_port *ap);
1020extern int ata_cable_unknown(struct ata_port *ap);
1021
1022extern void ata_pio_queue_task(struct ata_port *ap, void *data,
1023			       unsigned long delay);
1024
1025/* Timing helpers */
1026extern unsigned int ata_pio_need_iordy(const struct ata_device *);
1027extern const struct ata_timing *ata_timing_find_mode(u8 xfer_mode);
1028extern int ata_timing_compute(struct ata_device *, unsigned short,
1029			      struct ata_timing *, int, int);
1030extern void ata_timing_merge(const struct ata_timing *,
1031			     const struct ata_timing *, struct ata_timing *,
1032			     unsigned int);
1033extern u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle);
1034
1035/* PCI */
1036#ifdef CONFIG_PCI
1037struct pci_dev;
1038
1039struct pci_bits {
1040	unsigned int		reg;	/* PCI config register to read */
1041	unsigned int		width;	/* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
1042	unsigned long		mask;
1043	unsigned long		val;
1044};
1045
1046extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
1047extern void ata_pci_remove_one(struct pci_dev *pdev);
1048
1049#ifdef CONFIG_PM
1050extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
1051extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
1052extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
1053extern int ata_pci_device_resume(struct pci_dev *pdev);
1054#endif /* CONFIG_PM */
1055#endif /* CONFIG_PCI */
1056
1057/*
1058 * ACPI - drivers/ata/libata-acpi.c
1059 */
1060#ifdef CONFIG_ATA_ACPI
1061static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1062{
1063	if (ap->pflags & ATA_PFLAG_INIT_GTM_VALID)
1064		return &ap->__acpi_init_gtm;
1065	return NULL;
1066}
1067int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm);
1068int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *stm);
1069unsigned long ata_acpi_gtm_xfermask(struct ata_device *dev,
1070				    const struct ata_acpi_gtm *gtm);
1071int ata_acpi_cbl_80wire(struct ata_port *ap, const struct ata_acpi_gtm *gtm);
1072#else
1073static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1074{
1075	return NULL;
1076}
1077
1078static inline int ata_acpi_stm(const struct ata_port *ap,
1079			       struct ata_acpi_gtm *stm)
1080{
1081	return -ENOSYS;
1082}
1083
1084static inline int ata_acpi_gtm(const struct ata_port *ap,
1085			       struct ata_acpi_gtm *stm)
1086{
1087	return -ENOSYS;
1088}
1089
1090static inline unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev,
1091					const struct ata_acpi_gtm *gtm)
1092{
1093	return 0;
1094}
1095
1096static inline int ata_acpi_cbl_80wire(struct ata_port *ap,
1097				      const struct ata_acpi_gtm *gtm)
1098{
1099	return 0;
1100}
1101#endif
1102
1103/*
1104 * EH - drivers/ata/libata-eh.c
1105 */
1106extern void ata_port_schedule_eh(struct ata_port *ap);
1107extern int ata_link_abort(struct ata_link *link);
1108extern int ata_port_abort(struct ata_port *ap);
1109extern int ata_port_freeze(struct ata_port *ap);
1110extern int sata_async_notification(struct ata_port *ap);
1111
1112extern void ata_eh_freeze_port(struct ata_port *ap);
1113extern void ata_eh_thaw_port(struct ata_port *ap);
1114
1115extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
1116extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
1117extern void ata_eh_analyze_ncq_error(struct ata_link *link);
1118
1119extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
1120		      ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
1121		      ata_postreset_fn_t postreset);
1122extern void ata_std_error_handler(struct ata_port *ap);
1123
1124/*
1125 * Base operations to inherit from and initializers for sht
1126 *
1127 * Operations
1128 *
1129 * base  : Common to all libata drivers.
1130 * sata  : SATA controllers w/ native interface.
1131 * pmp   : SATA controllers w/ PMP support.
1132 * sff   : SFF ATA controllers w/o BMDMA support.
1133 * bmdma : SFF ATA controllers w/ BMDMA support.
1134 *
1135 * sht initializers
1136 *
1137 * BASE  : Common to all libata drivers.  The user must set
1138 *	   sg_tablesize and dma_boundary.
1139 * PIO   : SFF ATA controllers w/ only PIO support.
1140 * BMDMA : SFF ATA controllers w/ BMDMA support.  sg_tablesize and
1141 *	   dma_boundary are set to BMDMA limits.
1142 * NCQ   : SATA controllers supporting NCQ.  The user must set
1143 *	   sg_tablesize, dma_boundary and can_queue.
1144 */
1145extern const struct ata_port_operations ata_base_port_ops;
1146extern const struct ata_port_operations sata_port_ops;
1147extern struct device_attribute *ata_common_sdev_attrs[];
1148
1149#define ATA_BASE_SHT(drv_name)					\
1150	.module			= THIS_MODULE,			\
1151	.name			= drv_name,			\
1152	.ioctl			= ata_scsi_ioctl,		\
1153	.queuecommand		= ata_scsi_queuecmd,		\
1154	.can_queue		= ATA_DEF_QUEUE,		\
1155	.this_id		= ATA_SHT_THIS_ID,		\
1156	.cmd_per_lun		= ATA_SHT_CMD_PER_LUN,		\
1157	.emulated		= ATA_SHT_EMULATED,		\
1158	.use_clustering		= ATA_SHT_USE_CLUSTERING,	\
1159	.proc_name		= drv_name,			\
1160	.slave_configure	= ata_scsi_slave_config,	\
1161	.slave_destroy		= ata_scsi_slave_destroy,	\
1162	.bios_param		= ata_std_bios_param,		\
1163	.sdev_attrs		= ata_common_sdev_attrs
1164
1165#define ATA_NCQ_SHT(drv_name)					\
1166	ATA_BASE_SHT(drv_name),					\
1167	.change_queue_depth	= ata_scsi_change_queue_depth
1168
1169/*
1170 * PMP helpers
1171 */
1172#ifdef CONFIG_SATA_PMP
1173static inline bool sata_pmp_supported(struct ata_port *ap)
1174{
1175	return ap->flags & ATA_FLAG_PMP;
1176}
1177
1178static inline bool sata_pmp_attached(struct ata_port *ap)
1179{
1180	return ap->nr_pmp_links != 0;
1181}
1182
1183static inline int ata_is_host_link(const struct ata_link *link)
1184{
1185	return link == &link->ap->link || link == link->ap->slave_link;
1186}
1187#else /* CONFIG_SATA_PMP */
1188static inline bool sata_pmp_supported(struct ata_port *ap)
1189{
1190	return false;
1191}
1192
1193static inline bool sata_pmp_attached(struct ata_port *ap)
1194{
1195	return false;
1196}
1197
1198static inline int ata_is_host_link(const struct ata_link *link)
1199{
1200	return 1;
1201}
1202#endif /* CONFIG_SATA_PMP */
1203
1204static inline int sata_srst_pmp(struct ata_link *link)
1205{
1206	if (sata_pmp_supported(link->ap) && ata_is_host_link(link))
1207		return SATA_PMP_CTRL_PORT;
1208	return link->pmp;
1209}
1210
1211/*
1212 * printk helpers
1213 */
1214#define ata_port_printk(ap, lv, fmt, args...) \
1215	printk("%sata%u: "fmt, lv, (ap)->print_id , ##args)
1216
1217#define ata_link_printk(link, lv, fmt, args...) do { \
1218	if (sata_pmp_attached((link)->ap) || (link)->ap->slave_link)	\
1219		printk("%sata%u.%02u: "fmt, lv, (link)->ap->print_id,	\
1220		       (link)->pmp , ##args); \
1221	else \
1222		printk("%sata%u: "fmt, lv, (link)->ap->print_id , ##args); \
1223	} while(0)
1224
1225#define ata_dev_printk(dev, lv, fmt, args...) \
1226	printk("%sata%u.%02u: "fmt, lv, (dev)->link->ap->print_id,	\
1227	       (dev)->link->pmp + (dev)->devno , ##args)
1228
1229/*
1230 * ata_eh_info helpers
1231 */
1232extern void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...)
1233	__attribute__ ((format (printf, 2, 3)));
1234extern void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...)
1235	__attribute__ ((format (printf, 2, 3)));
1236extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
1237
1238static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
1239{
1240	ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
1241	ehi->flags |= ATA_EHI_HOTPLUGGED;
1242	ehi->action |= ATA_EH_RESET | ATA_EH_ENABLE_LINK;
1243	ehi->err_mask |= AC_ERR_ATA_BUS;
1244}
1245
1246/*
1247 * port description helpers
1248 */
1249extern void ata_port_desc(struct ata_port *ap, const char *fmt, ...)
1250	__attribute__ ((format (printf, 2, 3)));
1251#ifdef CONFIG_PCI
1252extern void ata_port_pbar_desc(struct ata_port *ap, int bar, ssize_t offset,
1253			       const char *name);
1254#endif
1255
1256static inline unsigned int ata_tag_valid(unsigned int tag)
1257{
1258	return (tag < ATA_MAX_QUEUE) ? 1 : 0;
1259}
1260
1261static inline unsigned int ata_tag_internal(unsigned int tag)
1262{
1263	return tag == ATA_TAG_INTERNAL;
1264}
1265
1266/*
1267 * device helpers
1268 */
1269static inline unsigned int ata_class_enabled(unsigned int class)
1270{
1271	return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI ||
1272		class == ATA_DEV_PMP || class == ATA_DEV_SEMB;
1273}
1274
1275static inline unsigned int ata_class_disabled(unsigned int class)
1276{
1277	return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP ||
1278		class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP;
1279}
1280
1281static inline unsigned int ata_class_absent(unsigned int class)
1282{
1283	return !ata_class_enabled(class) && !ata_class_disabled(class);
1284}
1285
1286static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1287{
1288	return ata_class_enabled(dev->class);
1289}
1290
1291static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1292{
1293	return ata_class_disabled(dev->class);
1294}
1295
1296static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1297{
1298	return ata_class_absent(dev->class);
1299}
1300
1301/*
1302 * link helpers
1303 */
1304static inline int ata_link_max_devices(const struct ata_link *link)
1305{
1306	if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS)
1307		return 2;
1308	return 1;
1309}
1310
1311static inline int ata_link_active(struct ata_link *link)
1312{
1313	return ata_tag_valid(link->active_tag) || link->sactive;
1314}
1315
1316/*
1317 * Iterators
1318 *
1319 * ATA_LITER_* constants are used to select link iteration mode and
1320 * ATA_DITER_* device iteration mode.
1321 *
1322 * For a custom iteration directly using ata_{link|dev}_next(), if
1323 * @link or @dev, respectively, is NULL, the first element is
1324 * returned.  @dev and @link can be any valid device or link and the
1325 * next element according to the iteration mode will be returned.
1326 * After the last element, NULL is returned.
1327 */
1328enum ata_link_iter_mode {
1329	ATA_LITER_EDGE,		/* if present, PMP links only; otherwise,
1330				 * host link.  no slave link */
1331	ATA_LITER_HOST_FIRST,	/* host link followed by PMP or slave links */
1332	ATA_LITER_PMP_FIRST,	/* PMP links followed by host link,
1333				 * slave link still comes after host link */
1334};
1335
1336enum ata_dev_iter_mode {
1337	ATA_DITER_ENABLED,
1338	ATA_DITER_ENABLED_REVERSE,
1339	ATA_DITER_ALL,
1340	ATA_DITER_ALL_REVERSE,
1341};
1342
1343extern struct ata_link *ata_link_next(struct ata_link *link,
1344				      struct ata_port *ap,
1345				      enum ata_link_iter_mode mode);
1346
1347extern struct ata_device *ata_dev_next(struct ata_device *dev,
1348				       struct ata_link *link,
1349				       enum ata_dev_iter_mode mode);
1350
1351/*
1352 * Shortcut notation for iterations
1353 *
1354 * ata_for_each_link() iterates over each link of @ap according to
1355 * @mode.  @link points to the current link in the loop.  @link is
1356 * NULL after loop termination.  ata_for_each_dev() works the same way
1357 * except that it iterates over each device of @link.
1358 *
1359 * Note that the mode prefixes ATA_{L|D}ITER_ shouldn't need to be
1360 * specified when using the following shorthand notations.  Only the
1361 * mode itself (EDGE, HOST_FIRST, ENABLED, etc...) should be
1362 * specified.  This not only increases brevity but also makes it
1363 * impossible to use ATA_LITER_* for device iteration or vice-versa.
1364 */
1365#define ata_for_each_link(link, ap, mode) \
1366	for ((link) = ata_link_next(NULL, (ap), ATA_LITER_##mode); (link); \
1367	     (link) = ata_link_next((link), (ap), ATA_LITER_##mode))
1368
1369#define ata_for_each_dev(dev, link, mode) \
1370	for ((dev) = ata_dev_next(NULL, (link), ATA_DITER_##mode); (dev); \
1371	     (dev) = ata_dev_next((dev), (link), ATA_DITER_##mode))
1372
1373/**
1374 *	ata_ncq_enabled - Test whether NCQ is enabled
1375 *	@dev: ATA device to test for
1376 *
1377 *	LOCKING:
1378 *	spin_lock_irqsave(host lock)
1379 *
1380 *	RETURNS:
1381 *	1 if NCQ is enabled for @dev, 0 otherwise.
1382 */
1383static inline int ata_ncq_enabled(struct ata_device *dev)
1384{
1385	return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1386			      ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1387}
1388
1389static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1390{
1391	qc->tf.ctl |= ATA_NIEN;
1392}
1393
1394static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1395						       unsigned int tag)
1396{
1397	if (likely(ata_tag_valid(tag)))
1398		return &ap->qcmd[tag];
1399	return NULL;
1400}
1401
1402static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1403						     unsigned int tag)
1404{
1405	struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1406
1407	if (unlikely(!qc) || !ap->ops->error_handler)
1408		return qc;
1409
1410	if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1411			  ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1412		return qc;
1413
1414	return NULL;
1415}
1416
1417static inline unsigned int ata_qc_raw_nbytes(struct ata_queued_cmd *qc)
1418{
1419	return qc->nbytes - min(qc->extrabytes, qc->nbytes);
1420}
1421
1422static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1423{
1424	memset(tf, 0, sizeof(*tf));
1425
1426	tf->ctl = dev->link->ap->ctl;
1427	if (dev->devno == 0)
1428		tf->device = ATA_DEVICE_OBS;
1429	else
1430		tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1431}
1432
1433static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1434{
1435	qc->dma_dir = DMA_NONE;
1436	qc->sg = NULL;
1437	qc->flags = 0;
1438	qc->cursg = NULL;
1439	qc->cursg_ofs = 0;
1440	qc->nbytes = qc->extrabytes = qc->curbytes = 0;
1441	qc->n_elem = 0;
1442	qc->err_mask = 0;
1443	qc->sect_size = ATA_SECT_SIZE;
1444
1445	ata_tf_init(qc->dev, &qc->tf);
1446
1447	/* init result_tf such that it indicates normal completion */
1448	qc->result_tf.command = ATA_DRDY;
1449	qc->result_tf.feature = 0;
1450}
1451
1452static inline int ata_try_flush_cache(const struct ata_device *dev)
1453{
1454	return ata_id_wcache_enabled(dev->id) ||
1455	       ata_id_has_flush(dev->id) ||
1456	       ata_id_has_flush_ext(dev->id);
1457}
1458
1459static inline unsigned int ac_err_mask(u8 status)
1460{
1461	if (status & (ATA_BUSY | ATA_DRQ))
1462		return AC_ERR_HSM;
1463	if (status & (ATA_ERR | ATA_DF))
1464		return AC_ERR_DEV;
1465	return 0;
1466}
1467
1468static inline unsigned int __ac_err_mask(u8 status)
1469{
1470	unsigned int mask = ac_err_mask(status);
1471	if (mask == 0)
1472		return AC_ERR_OTHER;
1473	return mask;
1474}
1475
1476static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1477{
1478	return *(struct ata_port **)&host->hostdata[0];
1479}
1480
1481static inline int ata_check_ready(u8 status)
1482{
1483	if (!(status & ATA_BUSY))
1484		return 1;
1485
1486	/* 0xff indicates either no device or device not ready */
1487	if (status == 0xff)
1488		return -ENODEV;
1489
1490	return 0;
1491}
1492
1493static inline unsigned long ata_deadline(unsigned long from_jiffies,
1494					 unsigned long timeout_msecs)
1495{
1496	return from_jiffies + msecs_to_jiffies(timeout_msecs);
1497}
1498
1499/* Don't open code these in drivers as there are traps. Firstly the range may
1500   change in future hardware and specs, secondly 0xFF means 'no DMA' but is
1501   > UDMA_0. Dyma ddreigiau */
1502
1503static inline int ata_using_mwdma(struct ata_device *adev)
1504{
1505	if (adev->dma_mode >= XFER_MW_DMA_0 && adev->dma_mode <= XFER_MW_DMA_4)
1506		return 1;
1507	return 0;
1508}
1509
1510static inline int ata_using_udma(struct ata_device *adev)
1511{
1512	if (adev->dma_mode >= XFER_UDMA_0 && adev->dma_mode <= XFER_UDMA_7)
1513		return 1;
1514	return 0;
1515}
1516
1517static inline int ata_dma_enabled(struct ata_device *adev)
1518{
1519	return (adev->dma_mode == 0xFF ? 0 : 1);
1520}
1521
1522/**************************************************************************
1523 * PMP - drivers/ata/libata-pmp.c
1524 */
1525#ifdef CONFIG_SATA_PMP
1526
1527extern const struct ata_port_operations sata_pmp_port_ops;
1528
1529extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc);
1530extern void sata_pmp_error_handler(struct ata_port *ap);
1531
1532#else /* CONFIG_SATA_PMP */
1533
1534#define sata_pmp_port_ops		sata_port_ops
1535#define sata_pmp_qc_defer_cmd_switch	ata_std_qc_defer
1536#define sata_pmp_error_handler		ata_std_error_handler
1537
1538#endif /* CONFIG_SATA_PMP */
1539
1540
1541/**************************************************************************
1542 * SFF - drivers/ata/libata-sff.c
1543 */
1544#ifdef CONFIG_ATA_SFF
1545
1546extern const struct ata_port_operations ata_sff_port_ops;
1547extern const struct ata_port_operations ata_bmdma_port_ops;
1548extern const struct ata_port_operations ata_bmdma32_port_ops;
1549
1550/* PIO only, sg_tablesize and dma_boundary limits can be removed */
1551#define ATA_PIO_SHT(drv_name)					\
1552	ATA_BASE_SHT(drv_name),					\
1553	.sg_tablesize		= LIBATA_MAX_PRD,		\
1554	.dma_boundary		= ATA_DMA_BOUNDARY
1555
1556#define ATA_BMDMA_SHT(drv_name)					\
1557	ATA_BASE_SHT(drv_name),					\
1558	.sg_tablesize		= LIBATA_MAX_PRD,		\
1559	.dma_boundary		= ATA_DMA_BOUNDARY
1560
1561extern void ata_sff_qc_prep(struct ata_queued_cmd *qc);
1562extern void ata_sff_dumb_qc_prep(struct ata_queued_cmd *qc);
1563extern void ata_sff_dev_select(struct ata_port *ap, unsigned int device);
1564extern u8 ata_sff_check_status(struct ata_port *ap);
1565extern void ata_sff_pause(struct ata_port *ap);
1566extern void ata_sff_dma_pause(struct ata_port *ap);
1567extern int ata_sff_busy_sleep(struct ata_port *ap,
1568			      unsigned long timeout_pat, unsigned long timeout);
1569extern int ata_sff_wait_ready(struct ata_link *link, unsigned long deadline);
1570extern void ata_sff_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
1571extern void ata_sff_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
1572extern void ata_sff_exec_command(struct ata_port *ap,
1573				 const struct ata_taskfile *tf);
1574extern unsigned int ata_sff_data_xfer(struct ata_device *dev,
1575			unsigned char *buf, unsigned int buflen, int rw);
1576extern unsigned int ata_sff_data_xfer32(struct ata_device *dev,
1577			unsigned char *buf, unsigned int buflen, int rw);
1578extern unsigned int ata_sff_data_xfer_noirq(struct ata_device *dev,
1579			unsigned char *buf, unsigned int buflen, int rw);
1580extern u8 ata_sff_irq_on(struct ata_port *ap);
1581extern void ata_sff_irq_clear(struct ata_port *ap);
1582extern int ata_sff_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
1583			    u8 status, int in_wq);
1584extern unsigned int ata_sff_qc_issue(struct ata_queued_cmd *qc);
1585extern bool ata_sff_qc_fill_rtf(struct ata_queued_cmd *qc);
1586extern unsigned int ata_sff_host_intr(struct ata_port *ap,
1587				      struct ata_queued_cmd *qc);
1588extern irqreturn_t ata_sff_interrupt(int irq, void *dev_instance);
1589extern void ata_sff_lost_interrupt(struct ata_port *ap);
1590extern void ata_sff_freeze(struct ata_port *ap);
1591extern void ata_sff_thaw(struct ata_port *ap);
1592extern int ata_sff_prereset(struct ata_link *link, unsigned long deadline);
1593extern unsigned int ata_sff_dev_classify(struct ata_device *dev, int present,
1594					  u8 *r_err);
1595extern int ata_sff_wait_after_reset(struct ata_link *link, unsigned int devmask,
1596				    unsigned long deadline);
1597extern int ata_sff_softreset(struct ata_link *link, unsigned int *classes,
1598			     unsigned long deadline);
1599extern int sata_sff_hardreset(struct ata_link *link, unsigned int *class,
1600			       unsigned long deadline);
1601extern void ata_sff_postreset(struct ata_link *link, unsigned int *classes);
1602extern void ata_sff_drain_fifo(struct ata_queued_cmd *qc);
1603extern void ata_sff_error_handler(struct ata_port *ap);
1604extern void ata_sff_post_internal_cmd(struct ata_queued_cmd *qc);
1605extern int ata_sff_port_start(struct ata_port *ap);
1606extern int ata_sff_port_start32(struct ata_port *ap);
1607extern void ata_sff_std_ports(struct ata_ioports *ioaddr);
1608extern unsigned long ata_bmdma_mode_filter(struct ata_device *dev,
1609					   unsigned long xfer_mask);
1610extern void ata_bmdma_setup(struct ata_queued_cmd *qc);
1611extern void ata_bmdma_start(struct ata_queued_cmd *qc);
1612extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
1613extern u8 ata_bmdma_status(struct ata_port *ap);
1614extern void ata_bus_reset(struct ata_port *ap);
1615
1616#ifdef CONFIG_PCI
1617extern int ata_pci_bmdma_clear_simplex(struct pci_dev *pdev);
1618extern int ata_pci_bmdma_init(struct ata_host *host);
1619extern int ata_pci_sff_init_host(struct ata_host *host);
1620extern int ata_pci_sff_prepare_host(struct pci_dev *pdev,
1621				    const struct ata_port_info * const * ppi,
1622				    struct ata_host **r_host);
1623extern int ata_pci_sff_activate_host(struct ata_host *host,
1624				     irq_handler_t irq_handler,
1625				     struct scsi_host_template *sht);
1626extern int ata_pci_sff_init_one(struct pci_dev *pdev,
1627				const struct ata_port_info * const * ppi,
1628				struct scsi_host_template *sht, void *host_priv);
1629#endif /* CONFIG_PCI */
1630
1631/**
1632 *	ata_sff_busy_wait - Wait for a port status register
1633 *	@ap: Port to wait for.
1634 *	@bits: bits that must be clear
1635 *	@max: number of 10uS waits to perform
1636 *
1637 *	Waits up to max*10 microseconds for the selected bits in the port's
1638 *	status register to be cleared.
1639 *	Returns final value of status register.
1640 *
1641 *	LOCKING:
1642 *	Inherited from caller.
1643 */
1644static inline u8 ata_sff_busy_wait(struct ata_port *ap, unsigned int bits,
1645				   unsigned int max)
1646{
1647	u8 status;
1648
1649	do {
1650		udelay(10);
1651		status = ap->ops->sff_check_status(ap);
1652		max--;
1653	} while (status != 0xff && (status & bits) && (max > 0));
1654
1655	return status;
1656}
1657
1658/**
1659 *	ata_wait_idle - Wait for a port to be idle.
1660 *	@ap: Port to wait for.
1661 *
1662 *	Waits up to 10ms for port's BUSY and DRQ signals to clear.
1663 *	Returns final value of status register.
1664 *
1665 *	LOCKING:
1666 *	Inherited from caller.
1667 */
1668static inline u8 ata_wait_idle(struct ata_port *ap)
1669{
1670	u8 status = ata_sff_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1671
1672#ifdef ATA_DEBUG
1673	if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
1674		ata_port_printk(ap, KERN_DEBUG, "abnormal Status 0x%X\n",
1675				status);
1676#endif
1677
1678	return status;
1679}
1680#endif /* CONFIG_ATA_SFF */
1681
1682#endif /* __LINUX_LIBATA_H__ */
1683