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