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