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