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