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