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