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