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