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