xref: /linux/include/linux/libata.h (revision 2c75a8d92cf173113d1e43a41cb472cd93561bf8)
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3  *  Copyright 2003-2005 Red Hat, Inc.  All rights reserved.
4  *  Copyright 2003-2005 Jeff Garzik
5  *
6  *  libata documentation is available via 'make {ps|pdf}docs',
7  *  as Documentation/driver-api/libata.rst
8  */
9 
10 #ifndef __LINUX_LIBATA_H__
11 #define __LINUX_LIBATA_H__
12 
13 #include <linux/delay.h>
14 #include <linux/jiffies.h>
15 #include <linux/interrupt.h>
16 #include <linux/dma-mapping.h>
17 #include <linux/scatterlist.h>
18 #include <linux/io.h>
19 #include <linux/ata.h>
20 #include <linux/workqueue.h>
21 #include <scsi/scsi_host.h>
22 #include <linux/acpi.h>
23 #include <linux/cdrom.h>
24 #include <linux/sched.h>
25 #include <linux/async.h>
26 
27 /*
28  * Define if arch has non-standard setup.  This is a _PCI_ standard
29  * not a legacy or ISA standard.
30  */
31 #ifdef CONFIG_ATA_NONSTANDARD
32 #include <asm/libata-portmap.h>
33 #else
34 #define ATA_PRIMARY_IRQ(dev)	14
35 #define ATA_SECONDARY_IRQ(dev)	15
36 #endif
37 
38 /*
39  * compile-time options: to be removed as soon as all the drivers are
40  * converted to the new debugging mechanism
41  */
42 #undef ATA_IRQ_TRAP		/* define to ack screaming irqs */
43 
44 /* defines only for the constants which don't work well as enums */
45 #define ATA_TAG_POISON		0xfafbfcfdU
46 
47 /*
48  * Quirk flags bits.
49  * ata_device->quirks is an u64, so __ATA_QUIRK_MAX must not exceed 64.
50  */
51 enum ata_quirks {
52 	__ATA_QUIRK_DIAGNOSTIC,		/* Failed boot diag */
53 	__ATA_QUIRK_NODMA,		/* DMA problems */
54 	__ATA_QUIRK_NONCQ,		/* Don't use NCQ */
55 	__ATA_QUIRK_BROKEN_HPA,		/* Broken HPA */
56 	__ATA_QUIRK_DISABLE,		/* Disable it */
57 	__ATA_QUIRK_HPA_SIZE,		/* Native size off by one */
58 	__ATA_QUIRK_IVB,		/* cbl det validity bit bugs */
59 	__ATA_QUIRK_STUCK_ERR,		/* Stuck ERR on next PACKET */
60 	__ATA_QUIRK_BRIDGE_OK,		/* No bridge limits */
61 	__ATA_QUIRK_ATAPI_MOD16_DMA,	/* Use ATAPI DMA for commands that */
62 					/* are not a multiple of 16 bytes */
63 	__ATA_QUIRK_FIRMWARE_WARN,	/* Firmware update warning */
64 	__ATA_QUIRK_1_5_GBPS,		/* Force 1.5 Gbps */
65 	__ATA_QUIRK_NOSETXFER,		/* Skip SETXFER, SATA only */
66 	__ATA_QUIRK_BROKEN_FPDMA_AA,	/* Skip AA */
67 	__ATA_QUIRK_DUMP_ID,		/* Dump IDENTIFY data */
68 	__ATA_QUIRK_MAX_SEC_LBA48,	/* Set max sects to 65535 */
69 	__ATA_QUIRK_ATAPI_DMADIR,	/* Device requires dmadir */
70 	__ATA_QUIRK_NO_NCQ_TRIM,	/* Do not use queued TRIM */
71 	__ATA_QUIRK_NOLPM,		/* Do not use LPM */
72 	__ATA_QUIRK_WD_BROKEN_LPM,	/* Some WDs have broken LPM */
73 	__ATA_QUIRK_ZERO_AFTER_TRIM,	/* Guarantees zero after trim */
74 	__ATA_QUIRK_NO_DMA_LOG,		/* Do not use DMA for log read */
75 	__ATA_QUIRK_NOTRIM,		/* Do not use TRIM */
76 	__ATA_QUIRK_MAX_SEC,		/* Limit max sectors */
77 	__ATA_QUIRK_MAX_TRIM_128M,	/* Limit max trim size to 128M */
78 	__ATA_QUIRK_NO_NCQ_ON_ATI,	/* Disable NCQ on ATI chipset */
79 	__ATA_QUIRK_NO_LPM_ON_ATI,	/* Disable LPM on ATI chipset */
80 	__ATA_QUIRK_NO_ID_DEV_LOG,	/* Identify device log missing */
81 	__ATA_QUIRK_NO_LOG_DIR,		/* Do not read log directory */
82 	__ATA_QUIRK_NO_FUA,		/* Do not use FUA */
83 
84 	__ATA_QUIRK_MAX,
85 };
86 
87 /*
88  * Quirk flags: may be set by libata or controller drivers on drives.
89  * Some quirks may be drive/controller pair dependent.
90  */
91 enum {
92 	ATA_QUIRK_DIAGNOSTIC		= BIT_ULL(__ATA_QUIRK_DIAGNOSTIC),
93 	ATA_QUIRK_NODMA			= BIT_ULL(__ATA_QUIRK_NODMA),
94 	ATA_QUIRK_NONCQ			= BIT_ULL(__ATA_QUIRK_NONCQ),
95 	ATA_QUIRK_BROKEN_HPA		= BIT_ULL(__ATA_QUIRK_BROKEN_HPA),
96 	ATA_QUIRK_DISABLE		= BIT_ULL(__ATA_QUIRK_DISABLE),
97 	ATA_QUIRK_HPA_SIZE		= BIT_ULL(__ATA_QUIRK_HPA_SIZE),
98 	ATA_QUIRK_IVB			= BIT_ULL(__ATA_QUIRK_IVB),
99 	ATA_QUIRK_STUCK_ERR		= BIT_ULL(__ATA_QUIRK_STUCK_ERR),
100 	ATA_QUIRK_BRIDGE_OK		= BIT_ULL(__ATA_QUIRK_BRIDGE_OK),
101 	ATA_QUIRK_ATAPI_MOD16_DMA	= BIT_ULL(__ATA_QUIRK_ATAPI_MOD16_DMA),
102 	ATA_QUIRK_FIRMWARE_WARN		= BIT_ULL(__ATA_QUIRK_FIRMWARE_WARN),
103 	ATA_QUIRK_1_5_GBPS		= BIT_ULL(__ATA_QUIRK_1_5_GBPS),
104 	ATA_QUIRK_NOSETXFER		= BIT_ULL(__ATA_QUIRK_NOSETXFER),
105 	ATA_QUIRK_BROKEN_FPDMA_AA	= BIT_ULL(__ATA_QUIRK_BROKEN_FPDMA_AA),
106 	ATA_QUIRK_DUMP_ID		= BIT_ULL(__ATA_QUIRK_DUMP_ID),
107 	ATA_QUIRK_MAX_SEC_LBA48		= BIT_ULL(__ATA_QUIRK_MAX_SEC_LBA48),
108 	ATA_QUIRK_ATAPI_DMADIR		= BIT_ULL(__ATA_QUIRK_ATAPI_DMADIR),
109 	ATA_QUIRK_NO_NCQ_TRIM		= BIT_ULL(__ATA_QUIRK_NO_NCQ_TRIM),
110 	ATA_QUIRK_NOLPM			= BIT_ULL(__ATA_QUIRK_NOLPM),
111 	ATA_QUIRK_WD_BROKEN_LPM		= BIT_ULL(__ATA_QUIRK_WD_BROKEN_LPM),
112 	ATA_QUIRK_ZERO_AFTER_TRIM	= BIT_ULL(__ATA_QUIRK_ZERO_AFTER_TRIM),
113 	ATA_QUIRK_NO_DMA_LOG		= BIT_ULL(__ATA_QUIRK_NO_DMA_LOG),
114 	ATA_QUIRK_NOTRIM		= BIT_ULL(__ATA_QUIRK_NOTRIM),
115 	ATA_QUIRK_MAX_SEC		= BIT_ULL(__ATA_QUIRK_MAX_SEC),
116 	ATA_QUIRK_MAX_TRIM_128M		= BIT_ULL(__ATA_QUIRK_MAX_TRIM_128M),
117 	ATA_QUIRK_NO_NCQ_ON_ATI		= BIT_ULL(__ATA_QUIRK_NO_NCQ_ON_ATI),
118 	ATA_QUIRK_NO_LPM_ON_ATI		= BIT_ULL(__ATA_QUIRK_NO_LPM_ON_ATI),
119 	ATA_QUIRK_NO_ID_DEV_LOG		= BIT_ULL(__ATA_QUIRK_NO_ID_DEV_LOG),
120 	ATA_QUIRK_NO_LOG_DIR		= BIT_ULL(__ATA_QUIRK_NO_LOG_DIR),
121 	ATA_QUIRK_NO_FUA		= BIT_ULL(__ATA_QUIRK_NO_FUA),
122 };
123 
124 enum {
125 	/* various global constants */
126 	LIBATA_MAX_PRD		= ATA_MAX_PRD / 2,
127 	LIBATA_DUMB_MAX_PRD	= ATA_MAX_PRD / 4,	/* Worst case */
128 	ATA_DEF_QUEUE		= 1,
129 	ATA_MAX_QUEUE		= 32,
130 	ATA_TAG_INTERNAL	= ATA_MAX_QUEUE,
131 	ATA_SHORT_PAUSE		= 16,
132 
133 	ATAPI_MAX_DRAIN		= 16 << 10,
134 
135 	ATA_ALL_DEVICES		= (1 << ATA_MAX_DEVICES) - 1,
136 
137 	ATA_SHT_EMULATED	= 1,
138 	ATA_SHT_THIS_ID		= -1,
139 
140 	/* struct ata_taskfile flags */
141 	ATA_TFLAG_LBA48		= (1 << 0), /* enable 48-bit LBA and "HOB" */
142 	ATA_TFLAG_ISADDR	= (1 << 1), /* enable r/w to nsect/lba regs */
143 	ATA_TFLAG_DEVICE	= (1 << 2), /* enable r/w to device reg */
144 	ATA_TFLAG_WRITE		= (1 << 3), /* data dir: host->dev==1 (write) */
145 	ATA_TFLAG_LBA		= (1 << 4), /* enable LBA */
146 	ATA_TFLAG_FUA		= (1 << 5), /* enable FUA */
147 	ATA_TFLAG_POLLING	= (1 << 6), /* set nIEN to 1 and use polling */
148 
149 	/* struct ata_device stuff */
150 	ATA_DFLAG_LBA		= (1 << 0), /* device supports LBA */
151 	ATA_DFLAG_LBA48		= (1 << 1), /* device supports LBA48 */
152 	ATA_DFLAG_CDB_INTR	= (1 << 2), /* device asserts INTRQ when ready for CDB */
153 	ATA_DFLAG_NCQ		= (1 << 3), /* device supports NCQ */
154 	ATA_DFLAG_FLUSH_EXT	= (1 << 4), /* do FLUSH_EXT instead of FLUSH */
155 	ATA_DFLAG_ACPI_PENDING	= (1 << 5), /* ACPI resume action pending */
156 	ATA_DFLAG_ACPI_FAILED	= (1 << 6), /* ACPI on devcfg has failed */
157 	ATA_DFLAG_AN		= (1 << 7), /* AN configured */
158 	ATA_DFLAG_TRUSTED	= (1 << 8), /* device supports trusted send/recv */
159 	ATA_DFLAG_FUA		= (1 << 9), /* device supports FUA */
160 	ATA_DFLAG_DMADIR	= (1 << 10), /* device requires DMADIR */
161 	ATA_DFLAG_NCQ_SEND_RECV = (1 << 11), /* device supports NCQ SEND and RECV */
162 	ATA_DFLAG_NCQ_PRIO	= (1 << 12), /* device supports NCQ priority */
163 	ATA_DFLAG_CDL		= (1 << 13), /* supports cmd duration limits */
164 	ATA_DFLAG_CFG_MASK	= (1 << 14) - 1,
165 
166 	ATA_DFLAG_PIO		= (1 << 14), /* device limited to PIO mode */
167 	ATA_DFLAG_NCQ_OFF	= (1 << 15), /* device limited to non-NCQ mode */
168 	ATA_DFLAG_SLEEPING	= (1 << 16), /* device is sleeping */
169 	ATA_DFLAG_DUBIOUS_XFER	= (1 << 17), /* data transfer not verified */
170 	ATA_DFLAG_NO_UNLOAD	= (1 << 18), /* device doesn't support unload */
171 	ATA_DFLAG_UNLOCK_HPA	= (1 << 19), /* unlock HPA */
172 	ATA_DFLAG_INIT_MASK	= (1 << 20) - 1,
173 
174 	ATA_DFLAG_NCQ_PRIO_ENABLED = (1 << 20), /* Priority cmds sent to dev */
175 	ATA_DFLAG_CDL_ENABLED	= (1 << 21), /* cmd duration limits is enabled */
176 	ATA_DFLAG_RESUMING	= (1 << 22),  /* Device is resuming */
177 	ATA_DFLAG_DETACH	= (1 << 24),
178 	ATA_DFLAG_DETACHED	= (1 << 25),
179 	ATA_DFLAG_DA		= (1 << 26), /* device supports Device Attention */
180 	ATA_DFLAG_DEVSLP	= (1 << 27), /* device supports Device Sleep */
181 	ATA_DFLAG_ACPI_DISABLED = (1 << 28), /* ACPI for the device is disabled */
182 	ATA_DFLAG_D_SENSE	= (1 << 29), /* Descriptor sense requested */
183 
184 	ATA_DFLAG_FEATURES_MASK	= (ATA_DFLAG_TRUSTED | ATA_DFLAG_DA |	\
185 				   ATA_DFLAG_DEVSLP | ATA_DFLAG_NCQ_SEND_RECV | \
186 				   ATA_DFLAG_NCQ_PRIO | ATA_DFLAG_FUA | \
187 				   ATA_DFLAG_CDL),
188 
189 	ATA_DEV_UNKNOWN		= 0,	/* unknown device */
190 	ATA_DEV_ATA		= 1,	/* ATA device */
191 	ATA_DEV_ATA_UNSUP	= 2,	/* ATA device (unsupported) */
192 	ATA_DEV_ATAPI		= 3,	/* ATAPI device */
193 	ATA_DEV_ATAPI_UNSUP	= 4,	/* ATAPI device (unsupported) */
194 	ATA_DEV_PMP		= 5,	/* SATA port multiplier */
195 	ATA_DEV_PMP_UNSUP	= 6,	/* SATA port multiplier (unsupported) */
196 	ATA_DEV_SEMB		= 7,	/* SEMB */
197 	ATA_DEV_SEMB_UNSUP	= 8,	/* SEMB (unsupported) */
198 	ATA_DEV_ZAC		= 9,	/* ZAC device */
199 	ATA_DEV_ZAC_UNSUP	= 10,	/* ZAC device (unsupported) */
200 	ATA_DEV_NONE		= 11,	/* no device */
201 
202 	/* struct ata_link flags */
203 	/* NOTE: struct ata_force_param currently stores lflags in u16 */
204 	ATA_LFLAG_NO_HRST	= (1 << 1), /* avoid hardreset */
205 	ATA_LFLAG_NO_SRST	= (1 << 2), /* avoid softreset */
206 	ATA_LFLAG_ASSUME_ATA	= (1 << 3), /* assume ATA class */
207 	ATA_LFLAG_ASSUME_SEMB	= (1 << 4), /* assume SEMB class */
208 	ATA_LFLAG_ASSUME_CLASS	= ATA_LFLAG_ASSUME_ATA | ATA_LFLAG_ASSUME_SEMB,
209 	ATA_LFLAG_NO_RETRY	= (1 << 5), /* don't retry this link */
210 	ATA_LFLAG_DISABLED	= (1 << 6), /* link is disabled */
211 	ATA_LFLAG_SW_ACTIVITY	= (1 << 7), /* keep activity stats */
212 	ATA_LFLAG_NO_LPM	= (1 << 8), /* disable LPM on this link */
213 	ATA_LFLAG_RST_ONCE	= (1 << 9), /* limit recovery to one reset */
214 	ATA_LFLAG_CHANGED	= (1 << 10), /* LPM state changed on this link */
215 	ATA_LFLAG_NO_DEBOUNCE_DELAY = (1 << 11), /* no debounce delay on link resume */
216 
217 	/* struct ata_port flags */
218 	ATA_FLAG_SLAVE_POSS	= (1 << 0), /* host supports slave dev */
219 					    /* (doesn't imply presence) */
220 	ATA_FLAG_SATA		= (1 << 1),
221 	ATA_FLAG_NO_LPM		= (1 << 2), /* host not happy with LPM */
222 	ATA_FLAG_NO_LOG_PAGE	= (1 << 5), /* do not issue log page read */
223 	ATA_FLAG_NO_ATAPI	= (1 << 6), /* No ATAPI support */
224 	ATA_FLAG_PIO_DMA	= (1 << 7), /* PIO cmds via DMA */
225 	ATA_FLAG_PIO_LBA48	= (1 << 8), /* Host DMA engine is LBA28 only */
226 	ATA_FLAG_PIO_POLLING	= (1 << 9), /* use polling PIO if LLD
227 					     * doesn't handle PIO interrupts */
228 	ATA_FLAG_NCQ		= (1 << 10), /* host supports NCQ */
229 	ATA_FLAG_NO_POWEROFF_SPINDOWN = (1 << 11), /* don't spindown before poweroff */
230 	ATA_FLAG_NO_HIBERNATE_SPINDOWN = (1 << 12), /* don't spindown before hibernation */
231 	ATA_FLAG_DEBUGMSG	= (1 << 13),
232 	ATA_FLAG_FPDMA_AA		= (1 << 14), /* driver supports Auto-Activate */
233 	ATA_FLAG_IGN_SIMPLEX	= (1 << 15), /* ignore SIMPLEX */
234 	ATA_FLAG_NO_IORDY	= (1 << 16), /* controller lacks iordy */
235 	ATA_FLAG_ACPI_SATA	= (1 << 17), /* need native SATA ACPI layout */
236 	ATA_FLAG_AN		= (1 << 18), /* controller supports AN */
237 	ATA_FLAG_PMP		= (1 << 19), /* controller supports PMP */
238 	ATA_FLAG_FPDMA_AUX	= (1 << 20), /* controller supports H2DFIS aux field */
239 	ATA_FLAG_EM		= (1 << 21), /* driver supports enclosure
240 					      * management */
241 	ATA_FLAG_SW_ACTIVITY	= (1 << 22), /* driver supports sw activity
242 					      * led */
243 	ATA_FLAG_NO_DIPM	= (1 << 23), /* host not happy with DIPM */
244 	ATA_FLAG_SAS_HOST	= (1 << 24), /* SAS host */
245 
246 	/* bits 24:31 of ap->flags are reserved for LLD specific flags */
247 
248 
249 	/* struct ata_port pflags */
250 	ATA_PFLAG_EH_PENDING	= (1 << 0), /* EH pending */
251 	ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */
252 	ATA_PFLAG_FROZEN	= (1 << 2), /* port is frozen */
253 	ATA_PFLAG_RECOVERED	= (1 << 3), /* recovery action performed */
254 	ATA_PFLAG_LOADING	= (1 << 4), /* boot/loading probe */
255 	ATA_PFLAG_SCSI_HOTPLUG	= (1 << 6), /* SCSI hotplug scheduled */
256 	ATA_PFLAG_INITIALIZING	= (1 << 7), /* being initialized, don't touch */
257 	ATA_PFLAG_RESETTING	= (1 << 8), /* reset in progress */
258 	ATA_PFLAG_UNLOADING	= (1 << 9), /* driver is being unloaded */
259 	ATA_PFLAG_UNLOADED	= (1 << 10), /* driver is unloaded */
260 
261 	ATA_PFLAG_RESUMING	= (1 << 16),  /* port is being resumed */
262 	ATA_PFLAG_SUSPENDED	= (1 << 17), /* port is suspended (power) */
263 	ATA_PFLAG_PM_PENDING	= (1 << 18), /* PM operation pending */
264 	ATA_PFLAG_INIT_GTM_VALID = (1 << 19), /* initial gtm data valid */
265 
266 	ATA_PFLAG_PIO32		= (1 << 20),  /* 32bit PIO */
267 	ATA_PFLAG_PIO32CHANGE	= (1 << 21),  /* 32bit PIO can be turned on/off */
268 	ATA_PFLAG_EXTERNAL	= (1 << 22),  /* eSATA/external port */
269 
270 	/* struct ata_queued_cmd flags */
271 	ATA_QCFLAG_ACTIVE	= (1 << 0), /* cmd not yet ack'd to scsi lyer */
272 	ATA_QCFLAG_DMAMAP	= (1 << 1), /* SG table is DMA mapped */
273 	ATA_QCFLAG_RTF_FILLED	= (1 << 2), /* result TF has been filled */
274 	ATA_QCFLAG_IO		= (1 << 3), /* standard IO command */
275 	ATA_QCFLAG_RESULT_TF	= (1 << 4), /* result TF requested */
276 	ATA_QCFLAG_CLEAR_EXCL	= (1 << 5), /* clear excl_link on completion */
277 	ATA_QCFLAG_QUIET	= (1 << 6), /* don't report device error */
278 	ATA_QCFLAG_RETRY	= (1 << 7), /* retry after failure */
279 	ATA_QCFLAG_HAS_CDL	= (1 << 8), /* qc has CDL a descriptor set */
280 
281 	ATA_QCFLAG_EH		= (1 << 16), /* cmd aborted and owned by EH */
282 	ATA_QCFLAG_SENSE_VALID	= (1 << 17), /* sense data valid */
283 	ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
284 	ATA_QCFLAG_EH_SUCCESS_CMD = (1 << 19), /* EH should fetch sense for this successful cmd */
285 
286 	/* host set flags */
287 	ATA_HOST_SIMPLEX	= (1 << 0),	/* Host is simplex, one DMA channel per host only */
288 	ATA_HOST_STARTED	= (1 << 1),	/* Host started */
289 	ATA_HOST_PARALLEL_SCAN	= (1 << 2),	/* Ports on this host can be scanned in parallel */
290 	ATA_HOST_IGNORE_ATA	= (1 << 3),	/* Ignore ATA devices on this host. */
291 
292 	ATA_HOST_NO_PART	= (1 << 4), /* Host does not support partial */
293 	ATA_HOST_NO_SSC		= (1 << 5), /* Host does not support slumber */
294 	ATA_HOST_NO_DEVSLP	= (1 << 6), /* Host does not support devslp */
295 
296 	/* bits 24:31 of host->flags are reserved for LLD specific flags */
297 
298 	/* Various lengths of time */
299 	ATA_TMOUT_INTERNAL_QUICK = 5000,
300 	ATA_TMOUT_MAX_PARK	= 30000,
301 
302 	/*
303 	 * GoVault needs 2s and iVDR disk HHD424020F7SV00 800ms.  2s
304 	 * is too much without parallel probing.  Use 2s if parallel
305 	 * probing is available, 800ms otherwise.
306 	 */
307 	ATA_TMOUT_FF_WAIT_LONG	=  2000,
308 	ATA_TMOUT_FF_WAIT	=   800,
309 
310 	/* Spec mandates to wait for ">= 2ms" before checking status
311 	 * after reset.  We wait 150ms, because that was the magic
312 	 * delay used for ATAPI devices in Hale Landis's ATADRVR, for
313 	 * the period of time between when the ATA command register is
314 	 * written, and then status is checked.  Because waiting for
315 	 * "a while" before checking status is fine, post SRST, we
316 	 * perform this magic delay here as well.
317 	 *
318 	 * Old drivers/ide uses the 2mS rule and then waits for ready.
319 	 */
320 	ATA_WAIT_AFTER_RESET	=  150,
321 
322 	/* If PMP is supported, we have to do follow-up SRST.  As some
323 	 * PMPs don't send D2H Reg FIS after hardreset, LLDs are
324 	 * advised to wait only for the following duration before
325 	 * doing SRST.
326 	 */
327 	ATA_TMOUT_PMP_SRST_WAIT	= 10000,
328 
329 	/* When the LPM policy is set to ATA_LPM_MAX_POWER, there might
330 	 * be a spurious PHY event, so ignore the first PHY event that
331 	 * occurs within 10s after the policy change.
332 	 */
333 	ATA_TMOUT_SPURIOUS_PHY	= 10000,
334 
335 	/* ATA bus states */
336 	BUS_UNKNOWN		= 0,
337 	BUS_DMA			= 1,
338 	BUS_IDLE		= 2,
339 	BUS_NOINTR		= 3,
340 	BUS_NODATA		= 4,
341 	BUS_TIMER		= 5,
342 	BUS_PIO			= 6,
343 	BUS_EDD			= 7,
344 	BUS_IDENTIFY		= 8,
345 	BUS_PACKET		= 9,
346 
347 	/* SATA port states */
348 	PORT_UNKNOWN		= 0,
349 	PORT_ENABLED		= 1,
350 	PORT_DISABLED		= 2,
351 
352 	/* encoding various smaller bitmaps into a single
353 	 * unsigned int bitmap
354 	 */
355 	ATA_NR_PIO_MODES	= 7,
356 	ATA_NR_MWDMA_MODES	= 5,
357 	ATA_NR_UDMA_MODES	= 8,
358 
359 	ATA_SHIFT_PIO		= 0,
360 	ATA_SHIFT_MWDMA		= ATA_SHIFT_PIO + ATA_NR_PIO_MODES,
361 	ATA_SHIFT_UDMA		= ATA_SHIFT_MWDMA + ATA_NR_MWDMA_MODES,
362 	ATA_SHIFT_PRIO		= 6,
363 
364 	ATA_PRIO_HIGH		= 2,
365 	/* size of buffer to pad xfers ending on unaligned boundaries */
366 	ATA_DMA_PAD_SZ		= 4,
367 
368 	/* ering size */
369 	ATA_ERING_SIZE		= 32,
370 
371 	/* return values for ->qc_defer */
372 	ATA_DEFER_LINK		= 1,
373 	ATA_DEFER_PORT		= 2,
374 
375 	/* desc_len for ata_eh_info and context */
376 	ATA_EH_DESC_LEN		= 80,
377 
378 	/* reset / recovery action types */
379 	ATA_EH_REVALIDATE	= (1 << 0),
380 	ATA_EH_SOFTRESET	= (1 << 1), /* meaningful only in ->prereset */
381 	ATA_EH_HARDRESET	= (1 << 2), /* meaningful only in ->prereset */
382 	ATA_EH_RESET		= ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
383 	ATA_EH_ENABLE_LINK	= (1 << 3),
384 	ATA_EH_PARK		= (1 << 5), /* unload heads and stop I/O */
385 	ATA_EH_GET_SUCCESS_SENSE = (1 << 6), /* Get sense data for successful cmd */
386 	ATA_EH_SET_ACTIVE	= (1 << 7), /* Set a device to active power mode */
387 
388 	ATA_EH_PERDEV_MASK	= ATA_EH_REVALIDATE | ATA_EH_PARK |
389 				  ATA_EH_GET_SUCCESS_SENSE | ATA_EH_SET_ACTIVE,
390 	ATA_EH_ALL_ACTIONS	= ATA_EH_REVALIDATE | ATA_EH_RESET |
391 				  ATA_EH_ENABLE_LINK,
392 
393 	/* ata_eh_info->flags */
394 	ATA_EHI_HOTPLUGGED	= (1 << 0),  /* could have been hotplugged */
395 	ATA_EHI_NO_AUTOPSY	= (1 << 2),  /* no autopsy */
396 	ATA_EHI_QUIET		= (1 << 3),  /* be quiet */
397 	ATA_EHI_NO_RECOVERY	= (1 << 4),  /* no recovery */
398 
399 	ATA_EHI_DID_SOFTRESET	= (1 << 16), /* already soft-reset this port */
400 	ATA_EHI_DID_HARDRESET	= (1 << 17), /* already soft-reset this port */
401 	ATA_EHI_PRINTINFO	= (1 << 18), /* print configuration info */
402 	ATA_EHI_SETMODE		= (1 << 19), /* configure transfer mode */
403 	ATA_EHI_POST_SETMODE	= (1 << 20), /* revalidating after setmode */
404 	ATA_EHI_DID_PRINT_QUIRKS = (1 << 21), /* already printed quirks info */
405 
406 	ATA_EHI_DID_RESET	= ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
407 
408 	/* mask of flags to transfer *to* the slave link */
409 	ATA_EHI_TO_SLAVE_MASK	= ATA_EHI_NO_AUTOPSY | ATA_EHI_QUIET,
410 
411 	/* max tries if error condition is still set after ->error_handler */
412 	ATA_EH_MAX_TRIES	= 5,
413 
414 	/* sometimes resuming a link requires several retries */
415 	ATA_LINK_RESUME_TRIES	= 5,
416 
417 	/* how hard are we gonna try to probe/recover devices */
418 	ATA_EH_DEV_TRIES	= 3,
419 	ATA_EH_PMP_TRIES	= 5,
420 	ATA_EH_PMP_LINK_TRIES	= 3,
421 
422 	SATA_PMP_RW_TIMEOUT	= 3000,		/* PMP read/write timeout */
423 
424 	/* This should match the actual table size of
425 	 * ata_eh_cmd_timeout_table in libata-eh.c.
426 	 */
427 	ATA_EH_CMD_TIMEOUT_TABLE_SIZE = 8,
428 
429 	/* User visible DMA mask for DMA control. DO NOT renumber. */
430 	ATA_DMA_MASK_ATA	= (1 << 0),	/* DMA on ATA Disk */
431 	ATA_DMA_MASK_ATAPI	= (1 << 1),	/* DMA on ATAPI */
432 	ATA_DMA_MASK_CFA	= (1 << 2),	/* DMA on CF Card */
433 
434 	/* ATAPI command types */
435 	ATAPI_READ		= 0,		/* READs */
436 	ATAPI_WRITE		= 1,		/* WRITEs */
437 	ATAPI_READ_CD		= 2,		/* READ CD [MSF] */
438 	ATAPI_PASS_THRU		= 3,		/* SAT pass-thru */
439 	ATAPI_MISC		= 4,		/* the rest */
440 
441 	/* Timing constants */
442 	ATA_TIMING_SETUP	= (1 << 0),
443 	ATA_TIMING_ACT8B	= (1 << 1),
444 	ATA_TIMING_REC8B	= (1 << 2),
445 	ATA_TIMING_CYC8B	= (1 << 3),
446 	ATA_TIMING_8BIT		= ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
447 				  ATA_TIMING_CYC8B,
448 	ATA_TIMING_ACTIVE	= (1 << 4),
449 	ATA_TIMING_RECOVER	= (1 << 5),
450 	ATA_TIMING_DMACK_HOLD	= (1 << 6),
451 	ATA_TIMING_CYCLE	= (1 << 7),
452 	ATA_TIMING_UDMA		= (1 << 8),
453 	ATA_TIMING_ALL		= ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
454 				  ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
455 				  ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
456 				  ATA_TIMING_DMACK_HOLD | ATA_TIMING_CYCLE |
457 				  ATA_TIMING_UDMA,
458 
459 	/* ACPI constants */
460 	ATA_ACPI_FILTER_SETXFER	= 1 << 0,
461 	ATA_ACPI_FILTER_LOCK	= 1 << 1,
462 	ATA_ACPI_FILTER_DIPM	= 1 << 2,
463 	ATA_ACPI_FILTER_FPDMA_OFFSET = 1 << 3,	/* FPDMA non-zero offset */
464 	ATA_ACPI_FILTER_FPDMA_AA = 1 << 4,	/* FPDMA auto activate */
465 
466 	ATA_ACPI_FILTER_DEFAULT	= ATA_ACPI_FILTER_SETXFER |
467 				  ATA_ACPI_FILTER_LOCK |
468 				  ATA_ACPI_FILTER_DIPM,
469 };
470 
471 enum ata_xfer_mask {
472 	ATA_MASK_PIO		= ((1U << ATA_NR_PIO_MODES) - 1) << ATA_SHIFT_PIO,
473 	ATA_MASK_MWDMA		= ((1U << ATA_NR_MWDMA_MODES) - 1) << ATA_SHIFT_MWDMA,
474 	ATA_MASK_UDMA		= ((1U << ATA_NR_UDMA_MODES) - 1) << ATA_SHIFT_UDMA,
475 };
476 
477 enum hsm_task_states {
478 	HSM_ST_IDLE,		/* no command on going */
479 	HSM_ST_FIRST,		/* (waiting the device to)
480 				   write CDB or first data block */
481 	HSM_ST,			/* (waiting the device to) transfer data */
482 	HSM_ST_LAST,		/* (waiting the device to) complete command */
483 	HSM_ST_ERR,		/* error */
484 };
485 
486 enum ata_completion_errors {
487 	AC_ERR_OK		= 0,	    /* no error */
488 	AC_ERR_DEV		= (1 << 0), /* device reported error */
489 	AC_ERR_HSM		= (1 << 1), /* host state machine violation */
490 	AC_ERR_TIMEOUT		= (1 << 2), /* timeout */
491 	AC_ERR_MEDIA		= (1 << 3), /* media error */
492 	AC_ERR_ATA_BUS		= (1 << 4), /* ATA bus error */
493 	AC_ERR_HOST_BUS		= (1 << 5), /* host bus error */
494 	AC_ERR_SYSTEM		= (1 << 6), /* system error */
495 	AC_ERR_INVALID		= (1 << 7), /* invalid argument */
496 	AC_ERR_OTHER		= (1 << 8), /* unknown */
497 	AC_ERR_NODEV_HINT	= (1 << 9), /* polling device detection hint */
498 	AC_ERR_NCQ		= (1 << 10), /* marker for offending NCQ qc */
499 };
500 
501 /*
502  * Link Power Management (LPM) policies.
503  *
504  * The default LPM policy to use for a device link is defined using these values
505  * with the CONFIG_SATA_MOBILE_LPM_POLICY config option and applied through the
506  * target_lpm_policy field of struct ata_port.
507  *
508  * If you alter this, you also need to alter the policy names used with the
509  * sysfs attribute link_power_management_policy defined in libata-sata.c.
510  */
511 enum ata_lpm_policy {
512 	/* Keep firmware settings */
513 	ATA_LPM_UNKNOWN,
514 	/* No power savings (maximum performance) */
515 	ATA_LPM_MAX_POWER,
516 	/* HIPM (Partial) */
517 	ATA_LPM_MED_POWER,
518 	/* HIPM (Partial) and DIPM (Partial and Slumber) */
519 	ATA_LPM_MED_POWER_WITH_DIPM,
520 	/* HIPM (Partial and DevSleep) and DIPM (Partial and Slumber) */
521 	ATA_LPM_MIN_POWER_WITH_PARTIAL,
522 	/* HIPM (Slumber and DevSleep) and DIPM (Partial and Slumber) */
523 	ATA_LPM_MIN_POWER,
524 };
525 
526 enum ata_lpm_hints {
527 	ATA_LPM_EMPTY		= (1 << 0), /* port empty/probing */
528 	ATA_LPM_HIPM		= (1 << 1), /* may use HIPM */
529 	ATA_LPM_WAKE_ONLY	= (1 << 2), /* only wake up link */
530 };
531 
532 /* forward declarations */
533 struct scsi_device;
534 struct ata_port_operations;
535 struct ata_port;
536 struct ata_link;
537 struct ata_queued_cmd;
538 
539 /* typedefs */
540 typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
541 typedef int (*ata_prereset_fn_t)(struct ata_link *link, unsigned long deadline);
542 typedef int (*ata_reset_fn_t)(struct ata_link *link, unsigned int *classes,
543 			      unsigned long deadline);
544 typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes);
545 
546 extern struct device_attribute dev_attr_unload_heads;
547 #ifdef CONFIG_SATA_HOST
548 extern struct device_attribute dev_attr_link_power_management_supported;
549 extern struct device_attribute dev_attr_link_power_management_policy;
550 extern struct device_attribute dev_attr_ncq_prio_supported;
551 extern struct device_attribute dev_attr_ncq_prio_enable;
552 extern struct device_attribute dev_attr_em_message_type;
553 extern struct device_attribute dev_attr_em_message;
554 extern struct device_attribute dev_attr_sw_activity;
555 #endif
556 
557 enum sw_activity {
558 	OFF,
559 	BLINK_ON,
560 	BLINK_OFF,
561 };
562 
563 struct ata_taskfile {
564 	unsigned long		flags;		/* ATA_TFLAG_xxx */
565 	u8			protocol;	/* ATA_PROT_xxx */
566 
567 	u8			ctl;		/* control reg */
568 
569 	u8			hob_feature;	/* additional data */
570 	u8			hob_nsect;	/* to support LBA48 */
571 	u8			hob_lbal;
572 	u8			hob_lbam;
573 	u8			hob_lbah;
574 
575 	union {
576 		u8		error;
577 		u8		feature;
578 	};
579 	u8			nsect;
580 	u8			lbal;
581 	u8			lbam;
582 	u8			lbah;
583 
584 	u8			device;
585 
586 	union {
587 		u8		status;
588 		u8		command;
589 	};
590 
591 	u32			auxiliary;	/* auxiliary field */
592 						/* from SATA 3.1 and */
593 						/* ATA-8 ACS-3 */
594 };
595 
596 #ifdef CONFIG_ATA_SFF
597 struct ata_ioports {
598 	void __iomem		*cmd_addr;
599 	void __iomem		*data_addr;
600 	void __iomem		*error_addr;
601 	void __iomem		*feature_addr;
602 	void __iomem		*nsect_addr;
603 	void __iomem		*lbal_addr;
604 	void __iomem		*lbam_addr;
605 	void __iomem		*lbah_addr;
606 	void __iomem		*device_addr;
607 	void __iomem		*status_addr;
608 	void __iomem		*command_addr;
609 	void __iomem		*altstatus_addr;
610 	void __iomem		*ctl_addr;
611 #ifdef CONFIG_ATA_BMDMA
612 	void __iomem		*bmdma_addr;
613 #endif /* CONFIG_ATA_BMDMA */
614 	void __iomem		*scr_addr;
615 };
616 #endif /* CONFIG_ATA_SFF */
617 
618 struct ata_host {
619 	spinlock_t		lock;
620 	struct device 		*dev;
621 	void __iomem * const	*iomap;
622 	unsigned int		n_ports;
623 	unsigned int		n_tags;			/* nr of NCQ tags */
624 	void			*private_data;
625 	struct ata_port_operations *ops;
626 	unsigned long		flags;
627 	struct kref		kref;
628 
629 	struct mutex		eh_mutex;
630 	struct task_struct	*eh_owner;
631 
632 	struct ata_port		*simplex_claimed;	/* channel owning the DMA */
633 	struct ata_port		*ports[];
634 };
635 
636 struct ata_queued_cmd {
637 	struct ata_port		*ap;
638 	struct ata_device	*dev;
639 
640 	struct scsi_cmnd	*scsicmd;
641 	void			(*scsidone)(struct scsi_cmnd *);
642 
643 	struct ata_taskfile	tf;
644 	u8			cdb[ATAPI_CDB_LEN];
645 
646 	unsigned long		flags;		/* ATA_QCFLAG_xxx */
647 	unsigned int		tag;		/* libata core tag */
648 	unsigned int		hw_tag;		/* driver tag */
649 	unsigned int		n_elem;
650 	unsigned int		orig_n_elem;
651 
652 	int			dma_dir;
653 
654 	unsigned int		sect_size;
655 
656 	unsigned int		nbytes;
657 	unsigned int		extrabytes;
658 	unsigned int		curbytes;
659 
660 	struct scatterlist	sgent;
661 
662 	struct scatterlist	*sg;
663 
664 	struct scatterlist	*cursg;
665 	unsigned int		cursg_ofs;
666 
667 	unsigned int		err_mask;
668 	struct ata_taskfile	result_tf;
669 	ata_qc_cb_t		complete_fn;
670 
671 	void			*private_data;
672 	void			*lldd_task;
673 };
674 
675 struct ata_port_stats {
676 	unsigned long		unhandled_irq;
677 	unsigned long		idle_irq;
678 	unsigned long		rw_reqbuf;
679 };
680 
681 struct ata_ering_entry {
682 	unsigned int		eflags;
683 	unsigned int		err_mask;
684 	u64			timestamp;
685 };
686 
687 struct ata_ering {
688 	int			cursor;
689 	struct ata_ering_entry	ring[ATA_ERING_SIZE];
690 };
691 
692 struct ata_cpr {
693 	u8			num;
694 	u8			num_storage_elements;
695 	u64			start_lba;
696 	u64			num_lbas;
697 };
698 
699 struct ata_cpr_log {
700 	u8			nr_cpr;
701 	struct ata_cpr		cpr[] __counted_by(nr_cpr);
702 };
703 
704 struct ata_cdl {
705 	/*
706 	 * Buffer to cache the CDL log page 18h (command duration descriptors)
707 	 * for SCSI-ATA translation.
708 	 */
709 	u8			desc_log_buf[ATA_LOG_CDL_SIZE];
710 
711 	/*
712 	 * Buffer to handle reading the sense data for successful NCQ Commands
713 	 * log page for commands using a CDL with one of the limits policy set
714 	 * to 0xD (successful completion with sense data available bit set).
715 	 */
716 	u8			ncq_sense_log_buf[ATA_LOG_SENSE_NCQ_SIZE];
717 };
718 
719 struct ata_device {
720 	struct ata_link		*link;
721 	unsigned int		devno;		/* 0 or 1 */
722 	u64			quirks;		/* List of broken features */
723 	unsigned long		flags;		/* ATA_DFLAG_xxx */
724 	struct scsi_device	*sdev;		/* attached SCSI device */
725 	void			*private_data;
726 #ifdef CONFIG_ATA_ACPI
727 	union acpi_object	*gtf_cache;
728 	unsigned int		gtf_filter;
729 #endif
730 #ifdef CONFIG_SATA_ZPODD
731 	void			*zpodd;
732 #endif
733 	struct device		tdev;
734 	/* n_sector is CLEAR_BEGIN, read comment above CLEAR_BEGIN */
735 	u64			n_sectors;	/* size of device, if ATA */
736 	u64			n_native_sectors; /* native size, if ATA */
737 	unsigned int		class;		/* ATA_DEV_xxx */
738 	unsigned long		unpark_deadline;
739 
740 	u8			pio_mode;
741 	u8			dma_mode;
742 	u8			xfer_mode;
743 	unsigned int		xfer_shift;	/* ATA_SHIFT_xxx */
744 
745 	unsigned int		multi_count;	/* sectors count for
746 						   READ/WRITE MULTIPLE */
747 	unsigned int		max_sectors;	/* per-device max sectors */
748 	unsigned int		cdb_len;
749 
750 	/* per-dev xfer mask */
751 	unsigned int		pio_mask;
752 	unsigned int		mwdma_mask;
753 	unsigned int		udma_mask;
754 
755 	/* for CHS addressing */
756 	u16			cylinders;	/* Number of cylinders */
757 	u16			heads;		/* Number of heads */
758 	u16			sectors;	/* Number of sectors per track */
759 
760 	union {
761 		u16		id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
762 		u32		gscr[SATA_PMP_GSCR_DWORDS]; /* PMP GSCR block */
763 	} ____cacheline_aligned;
764 
765 	/* General Purpose Log Directory log page */
766 	u8			gp_log_dir[ATA_SECT_SIZE] ____cacheline_aligned;
767 
768 	/* DEVSLP Timing Variables from Identify Device Data Log */
769 	u8			devslp_timing[ATA_LOG_DEVSLP_SIZE];
770 
771 	/* NCQ send and receive log subcommand support */
772 	u8			ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_SIZE];
773 	u8			ncq_non_data_cmds[ATA_LOG_NCQ_NON_DATA_SIZE];
774 
775 	/* ZAC zone configuration */
776 	u32			zac_zoned_cap;
777 	u32			zac_zones_optimal_open;
778 	u32			zac_zones_optimal_nonseq;
779 	u32			zac_zones_max_open;
780 
781 	/* Concurrent positioning ranges */
782 	struct ata_cpr_log	*cpr_log;
783 
784 	/* Command Duration Limits support */
785 	struct ata_cdl		*cdl;
786 
787 	/* error history */
788 	int			spdn_cnt;
789 	/* ering is CLEAR_END, read comment above CLEAR_END */
790 	struct ata_ering	ering;
791 
792 	/* For EH */
793 	u8			sector_buf[ATA_SECT_SIZE] ____cacheline_aligned;
794 };
795 
796 /* Fields between ATA_DEVICE_CLEAR_BEGIN and ATA_DEVICE_CLEAR_END are
797  * cleared to zero on ata_dev_init().
798  */
799 #define ATA_DEVICE_CLEAR_BEGIN		offsetof(struct ata_device, n_sectors)
800 #define ATA_DEVICE_CLEAR_END		offsetof(struct ata_device, ering)
801 
802 struct ata_eh_info {
803 	struct ata_device	*dev;		/* offending device */
804 	u32			serror;		/* SError from LLDD */
805 	unsigned int		err_mask;	/* port-wide err_mask */
806 	unsigned int		action;		/* ATA_EH_* action mask */
807 	unsigned int		dev_action[ATA_MAX_DEVICES]; /* dev EH action */
808 	unsigned int		flags;		/* ATA_EHI_* flags */
809 
810 	unsigned int		probe_mask;
811 
812 	char			desc[ATA_EH_DESC_LEN];
813 	int			desc_len;
814 };
815 
816 struct ata_eh_context {
817 	struct ata_eh_info	i;
818 	int			tries[ATA_MAX_DEVICES];
819 	int			cmd_timeout_idx[ATA_MAX_DEVICES]
820 					       [ATA_EH_CMD_TIMEOUT_TABLE_SIZE];
821 	unsigned int		classes[ATA_MAX_DEVICES];
822 	unsigned int		did_probe_mask;
823 	unsigned int		unloaded_mask;
824 	unsigned int		saved_ncq_enabled;
825 	u8			saved_xfer_mode[ATA_MAX_DEVICES];
826 	/* timestamp for the last reset attempt or success */
827 	unsigned long		last_reset;
828 };
829 
830 struct ata_acpi_drive
831 {
832 	u32 pio;
833 	u32 dma;
834 } __packed;
835 
836 struct ata_acpi_gtm {
837 	struct ata_acpi_drive drive[2];
838 	u32 flags;
839 } __packed;
840 
841 struct ata_link {
842 	struct ata_port		*ap;
843 	int			pmp;		/* port multiplier port # */
844 
845 	struct device		tdev;
846 	unsigned int		active_tag;	/* active tag on this link */
847 	u32			sactive;	/* active NCQ commands */
848 
849 	unsigned int		flags;		/* ATA_LFLAG_xxx */
850 
851 	u32			saved_scontrol;	/* SControl on probe */
852 	unsigned int		hw_sata_spd_limit;
853 	unsigned int		sata_spd_limit;
854 	unsigned int		sata_spd;	/* current SATA PHY speed */
855 	enum ata_lpm_policy	lpm_policy;
856 
857 	/* record runtime error info, protected by host_set lock */
858 	struct ata_eh_info	eh_info;
859 	/* EH context */
860 	struct ata_eh_context	eh_context;
861 
862 	struct ata_device	device[ATA_MAX_DEVICES];
863 
864 	unsigned long		last_lpm_change; /* when last LPM change happened */
865 };
866 #define ATA_LINK_CLEAR_BEGIN		offsetof(struct ata_link, active_tag)
867 #define ATA_LINK_CLEAR_END		offsetof(struct ata_link, device[0])
868 
869 struct ata_port {
870 	struct Scsi_Host	*scsi_host; /* our co-allocated scsi host */
871 	struct ata_port_operations *ops;
872 	spinlock_t		*lock;
873 	/* Flags owned by the EH context. Only EH should touch these once the
874 	   port is active */
875 	unsigned long		flags;	/* ATA_FLAG_xxx */
876 	/* Flags that change dynamically, protected by ap->lock */
877 	unsigned int		pflags; /* ATA_PFLAG_xxx */
878 	unsigned int		print_id; /* user visible unique port ID */
879 	unsigned int		port_no; /* 0 based port no. inside the host */
880 
881 #ifdef CONFIG_ATA_SFF
882 	struct ata_ioports	ioaddr;	/* ATA cmd/ctl/dma register blocks */
883 	u8			ctl;	/* cache of ATA control register */
884 	u8			last_ctl;	/* Cache last written value */
885 	struct ata_link*	sff_pio_task_link; /* link currently used */
886 	struct delayed_work	sff_pio_task;
887 #ifdef CONFIG_ATA_BMDMA
888 	struct ata_bmdma_prd	*bmdma_prd;	/* BMDMA SG list */
889 	dma_addr_t		bmdma_prd_dma;	/* and its DMA mapping */
890 #endif /* CONFIG_ATA_BMDMA */
891 #endif /* CONFIG_ATA_SFF */
892 
893 	unsigned int		pio_mask;
894 	unsigned int		mwdma_mask;
895 	unsigned int		udma_mask;
896 	unsigned int		cbl;	/* cable type; ATA_CBL_xxx */
897 
898 	struct ata_queued_cmd	qcmd[ATA_MAX_QUEUE + 1];
899 	u64			qc_active;
900 	int			nr_active_links; /* #links with active qcs */
901 
902 	struct work_struct	deferred_qc_work;
903 	struct ata_queued_cmd	*deferred_qc;
904 
905 	struct ata_link		link;		/* host default link */
906 	struct ata_link		*slave_link;	/* see ata_slave_link_init() */
907 
908 	int			nr_pmp_links;	/* nr of available PMP links */
909 	struct ata_link		*pmp_link;	/* array of PMP links */
910 	struct ata_link		*excl_link;	/* for PMP qc exclusion */
911 
912 	struct ata_port_stats	stats;
913 	struct ata_host		*host;
914 	struct device 		*dev;
915 	struct device		tdev;
916 
917 	struct mutex		scsi_scan_mutex;
918 	struct delayed_work	hotplug_task;
919 	struct delayed_work	scsi_rescan_task;
920 
921 	unsigned int		hsm_task_state;
922 
923 	struct list_head	eh_done_q;
924 	wait_queue_head_t	eh_wait_q;
925 	int			eh_tries;
926 	struct completion	park_req_pending;
927 
928 	pm_message_t		pm_mesg;
929 	enum ata_lpm_policy	target_lpm_policy;
930 
931 	struct timer_list	fastdrain_timer;
932 	unsigned int		fastdrain_cnt;
933 
934 	async_cookie_t		cookie;
935 
936 	int			em_message_type;
937 	void			*private_data;
938 
939 #ifdef CONFIG_ATA_ACPI
940 	struct ata_acpi_gtm	__acpi_init_gtm; /* use ata_acpi_init_gtm() */
941 #endif
942 };
943 
944 /* The following initializer overrides a method to NULL whether one of
945  * its parent has the method defined or not.  This is equivalent to
946  * ERR_PTR(-ENOENT).  Unfortunately, ERR_PTR doesn't render a constant
947  * expression and thus can't be used as an initializer.
948  */
949 #define ATA_OP_NULL		(void *)(unsigned long)(-ENOENT)
950 
951 struct ata_reset_operations {
952 	ata_prereset_fn_t	prereset;
953 	ata_reset_fn_t		softreset;
954 	ata_reset_fn_t		hardreset;
955 	ata_postreset_fn_t	postreset;
956 };
957 
958 struct ata_port_operations {
959 	/*
960 	 * Command execution
961 	 */
962 	int (*qc_defer)(struct ata_queued_cmd *qc);
963 	int (*check_atapi_dma)(struct ata_queued_cmd *qc);
964 	enum ata_completion_errors (*qc_prep)(struct ata_queued_cmd *qc);
965 	unsigned int (*qc_issue)(struct ata_queued_cmd *qc);
966 	void (*qc_fill_rtf)(struct ata_queued_cmd *qc);
967 	void (*qc_ncq_fill_rtf)(struct ata_port *ap, u64 done_mask);
968 
969 	/*
970 	 * Configuration and exception handling
971 	 */
972 	int  (*cable_detect)(struct ata_port *ap);
973 	unsigned int (*mode_filter)(struct ata_device *dev, unsigned int xfer_mask);
974 	void (*set_piomode)(struct ata_port *ap, struct ata_device *dev);
975 	void (*set_dmamode)(struct ata_port *ap, struct ata_device *dev);
976 	int  (*set_mode)(struct ata_link *link, struct ata_device **r_failed_dev);
977 	unsigned int (*read_id)(struct ata_device *dev, struct ata_taskfile *tf,
978 				__le16 *id);
979 
980 	void (*dev_config)(struct ata_device *dev);
981 
982 	void (*freeze)(struct ata_port *ap);
983 	void (*thaw)(struct ata_port *ap);
984 	struct ata_reset_operations reset;
985 	struct ata_reset_operations pmp_reset;
986 	void (*error_handler)(struct ata_port *ap);
987 	void (*lost_interrupt)(struct ata_port *ap);
988 	void (*post_internal_cmd)(struct ata_queued_cmd *qc);
989 	void (*sched_eh)(struct ata_port *ap);
990 	void (*end_eh)(struct ata_port *ap);
991 
992 	/*
993 	 * Optional features
994 	 */
995 	int  (*scr_read)(struct ata_link *link, unsigned int sc_reg, u32 *val);
996 	int  (*scr_write)(struct ata_link *link, unsigned int sc_reg, u32 val);
997 	void (*pmp_attach)(struct ata_port *ap);
998 	void (*pmp_detach)(struct ata_port *ap);
999 	int  (*set_lpm)(struct ata_link *link, enum ata_lpm_policy policy,
1000 			unsigned hints);
1001 
1002 	/*
1003 	 * Start, stop, suspend and resume
1004 	 */
1005 	int  (*port_suspend)(struct ata_port *ap, pm_message_t mesg);
1006 	int  (*port_resume)(struct ata_port *ap);
1007 	int  (*port_start)(struct ata_port *ap);
1008 	void (*port_stop)(struct ata_port *ap);
1009 	void (*host_stop)(struct ata_host *host);
1010 
1011 #ifdef CONFIG_ATA_SFF
1012 	/*
1013 	 * SFF / taskfile oriented ops
1014 	 */
1015 	void (*sff_dev_select)(struct ata_port *ap, unsigned int device);
1016 	void (*sff_set_devctl)(struct ata_port *ap, u8 ctl);
1017 	u8   (*sff_check_status)(struct ata_port *ap);
1018 	u8   (*sff_check_altstatus)(struct ata_port *ap);
1019 	void (*sff_tf_load)(struct ata_port *ap, const struct ata_taskfile *tf);
1020 	void (*sff_tf_read)(struct ata_port *ap, struct ata_taskfile *tf);
1021 	void (*sff_exec_command)(struct ata_port *ap,
1022 				 const struct ata_taskfile *tf);
1023 	unsigned int (*sff_data_xfer)(struct ata_queued_cmd *qc,
1024 			unsigned char *buf, unsigned int buflen, int rw);
1025 	void (*sff_irq_on)(struct ata_port *);
1026 	bool (*sff_irq_check)(struct ata_port *);
1027 	void (*sff_irq_clear)(struct ata_port *);
1028 	void (*sff_drain_fifo)(struct ata_queued_cmd *qc);
1029 
1030 #ifdef CONFIG_ATA_BMDMA
1031 	void (*bmdma_setup)(struct ata_queued_cmd *qc);
1032 	void (*bmdma_start)(struct ata_queued_cmd *qc);
1033 	void (*bmdma_stop)(struct ata_queued_cmd *qc);
1034 	u8   (*bmdma_status)(struct ata_port *ap);
1035 #endif /* CONFIG_ATA_BMDMA */
1036 #endif /* CONFIG_ATA_SFF */
1037 
1038 	ssize_t (*em_show)(struct ata_port *ap, char *buf);
1039 	ssize_t (*em_store)(struct ata_port *ap, const char *message,
1040 			    size_t size);
1041 	ssize_t (*sw_activity_show)(struct ata_device *dev, char *buf);
1042 	ssize_t (*sw_activity_store)(struct ata_device *dev,
1043 				     enum sw_activity val);
1044 	ssize_t (*transmit_led_message)(struct ata_port *ap, u32 state,
1045 					ssize_t size);
1046 
1047 	/*
1048 	 * ->inherits must be the last field and all the preceding
1049 	 * fields must be pointers.
1050 	 */
1051 	const struct ata_port_operations	*inherits;
1052 };
1053 
1054 struct ata_port_info {
1055 	unsigned long		flags;
1056 	unsigned long		link_flags;
1057 	unsigned int		pio_mask;
1058 	unsigned int		mwdma_mask;
1059 	unsigned int		udma_mask;
1060 	struct ata_port_operations *port_ops;
1061 	void 			*private_data;
1062 };
1063 
1064 struct ata_timing {
1065 	unsigned short mode;		/* ATA mode */
1066 	unsigned short setup;		/* t1 */
1067 	unsigned short act8b;		/* t2 for 8-bit I/O */
1068 	unsigned short rec8b;		/* t2i for 8-bit I/O */
1069 	unsigned short cyc8b;		/* t0 for 8-bit I/O */
1070 	unsigned short active;		/* t2 or tD */
1071 	unsigned short recover;		/* t2i or tK */
1072 	unsigned short dmack_hold;	/* tj */
1073 	unsigned short cycle;		/* t0 */
1074 	unsigned short udma;		/* t2CYCTYP/2 */
1075 };
1076 
1077 /*
1078  * Core layer - drivers/ata/libata-core.c
1079  */
1080 extern struct ata_port_operations ata_dummy_port_ops;
1081 extern const struct ata_port_info ata_dummy_port_info;
1082 
1083 static inline bool ata_is_atapi(u8 prot)
1084 {
1085 	return prot & ATA_PROT_FLAG_ATAPI;
1086 }
1087 
1088 static inline bool ata_is_pio(u8 prot)
1089 {
1090 	return prot & ATA_PROT_FLAG_PIO;
1091 }
1092 
1093 static inline bool ata_is_dma(u8 prot)
1094 {
1095 	return prot & ATA_PROT_FLAG_DMA;
1096 }
1097 
1098 static inline bool ata_is_ncq(u8 prot)
1099 {
1100 	return prot & ATA_PROT_FLAG_NCQ;
1101 }
1102 
1103 static inline bool ata_is_data(u8 prot)
1104 {
1105 	return prot & (ATA_PROT_FLAG_PIO | ATA_PROT_FLAG_DMA);
1106 }
1107 
1108 static inline int is_multi_taskfile(struct ata_taskfile *tf)
1109 {
1110 	return (tf->command == ATA_CMD_READ_MULTI) ||
1111 	       (tf->command == ATA_CMD_WRITE_MULTI) ||
1112 	       (tf->command == ATA_CMD_READ_MULTI_EXT) ||
1113 	       (tf->command == ATA_CMD_WRITE_MULTI_EXT) ||
1114 	       (tf->command == ATA_CMD_WRITE_MULTI_FUA_EXT);
1115 }
1116 
1117 static inline int ata_port_is_dummy(struct ata_port *ap)
1118 {
1119 	return ap->ops == &ata_dummy_port_ops;
1120 }
1121 
1122 static inline bool ata_port_is_frozen(const struct ata_port *ap)
1123 {
1124 	return ap->pflags & ATA_PFLAG_FROZEN;
1125 }
1126 
1127 extern int ata_std_prereset(struct ata_link *link, unsigned long deadline);
1128 extern int ata_wait_after_reset(struct ata_link *link, unsigned long deadline,
1129 				int (*check_ready)(struct ata_link *link));
1130 extern void ata_std_postreset(struct ata_link *link, unsigned int *classes);
1131 
1132 extern struct ata_host *ata_host_alloc(struct device *dev, int n_ports);
1133 extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
1134 			const struct ata_port_info * const * ppi, int n_ports);
1135 extern void ata_host_get(struct ata_host *host);
1136 extern void ata_host_put(struct ata_host *host);
1137 extern int ata_host_start(struct ata_host *host);
1138 extern int ata_host_register(struct ata_host *host,
1139 			     const struct scsi_host_template *sht);
1140 extern int ata_host_activate(struct ata_host *host, int irq,
1141 			     irq_handler_t irq_handler, unsigned long irq_flags,
1142 			     const struct scsi_host_template *sht);
1143 extern void ata_host_detach(struct ata_host *host);
1144 extern void ata_host_init(struct ata_host *, struct device *, struct ata_port_operations *);
1145 extern int ata_scsi_ioctl(struct scsi_device *dev, unsigned int cmd,
1146 			  void __user *arg);
1147 #ifdef CONFIG_COMPAT
1148 #define ATA_SCSI_COMPAT_IOCTL .compat_ioctl = ata_scsi_ioctl,
1149 #else
1150 #define ATA_SCSI_COMPAT_IOCTL /* empty */
1151 #endif
1152 extern enum scsi_qc_status ata_scsi_queuecmd(struct Scsi_Host *h,
1153 					     struct scsi_cmnd *cmd);
1154 #if IS_REACHABLE(CONFIG_ATA)
1155 bool ata_scsi_dma_need_drain(struct request *rq);
1156 #else
1157 #define ata_scsi_dma_need_drain NULL
1158 #endif
1159 extern int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *dev,
1160 			    unsigned int cmd, void __user *arg);
1161 extern bool ata_link_online(struct ata_link *link);
1162 extern bool ata_link_offline(struct ata_link *link);
1163 #ifdef CONFIG_PM
1164 extern void ata_host_suspend(struct ata_host *host, pm_message_t mesg);
1165 extern void ata_host_resume(struct ata_host *host);
1166 extern void ata_sas_port_suspend(struct ata_port *ap);
1167 extern void ata_sas_port_resume(struct ata_port *ap);
1168 #else
1169 static inline void ata_sas_port_suspend(struct ata_port *ap)
1170 {
1171 }
1172 static inline void ata_sas_port_resume(struct ata_port *ap)
1173 {
1174 }
1175 #endif
1176 extern int ata_ratelimit(void);
1177 extern void ata_msleep(struct ata_port *ap, unsigned int msecs);
1178 extern u32 ata_wait_register(struct ata_port *ap, void __iomem *reg, u32 mask,
1179 			     u32 val, unsigned int interval, unsigned int timeout);
1180 extern int atapi_cmd_type(u8 opcode);
1181 extern unsigned int ata_pack_xfermask(unsigned int pio_mask,
1182 				      unsigned int mwdma_mask,
1183 				      unsigned int udma_mask);
1184 extern void ata_unpack_xfermask(unsigned int xfer_mask,
1185 				unsigned int *pio_mask,
1186 				unsigned int *mwdma_mask,
1187 				unsigned int *udma_mask);
1188 extern u8 ata_xfer_mask2mode(unsigned int xfer_mask);
1189 extern unsigned int ata_xfer_mode2mask(u8 xfer_mode);
1190 extern int ata_xfer_mode2shift(u8 xfer_mode);
1191 extern const char *ata_mode_string(unsigned int xfer_mask);
1192 extern unsigned int ata_id_xfermask(const u16 *id);
1193 extern int ata_std_qc_defer(struct ata_queued_cmd *qc);
1194 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
1195 		 unsigned int n_elem);
1196 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
1197 extern unsigned int ata_port_classify(struct ata_port *ap,
1198 				      const struct ata_taskfile *tf);
1199 extern void ata_dev_disable(struct ata_device *adev);
1200 extern void ata_id_string(const u16 *id, unsigned char *s,
1201 			  unsigned int ofs, unsigned int len);
1202 extern void ata_id_c_string(const u16 *id, unsigned char *s,
1203 			    unsigned int ofs, unsigned int len);
1204 extern unsigned int ata_do_dev_read_id(struct ata_device *dev,
1205 				       struct ata_taskfile *tf, __le16 *id);
1206 extern void ata_qc_complete(struct ata_queued_cmd *qc);
1207 extern u64 ata_qc_get_active(struct ata_port *ap);
1208 extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd);
1209 extern int ata_std_bios_param(struct scsi_device *sdev,
1210 			      struct gendisk *unused,
1211 			      sector_t capacity, int geom[]);
1212 extern void ata_scsi_unlock_native_capacity(struct scsi_device *sdev);
1213 extern int ata_scsi_sdev_init(struct scsi_device *sdev);
1214 int ata_scsi_sdev_configure(struct scsi_device *sdev, struct queue_limits *lim);
1215 extern void ata_scsi_sdev_destroy(struct scsi_device *sdev);
1216 extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
1217 				       int queue_depth);
1218 extern int ata_change_queue_depth(struct ata_port *ap, struct scsi_device *sdev,
1219 				  int queue_depth);
1220 extern int ata_ncq_prio_supported(struct ata_port *ap, struct scsi_device *sdev,
1221 				  bool *supported);
1222 extern int ata_ncq_prio_enabled(struct ata_port *ap, struct scsi_device *sdev,
1223 				bool *enabled);
1224 extern int ata_ncq_prio_enable(struct ata_port *ap, struct scsi_device *sdev,
1225 			       bool enable);
1226 extern struct ata_device *ata_dev_pair(struct ata_device *adev);
1227 int ata_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
1228 extern void ata_scsi_port_error_handler(struct Scsi_Host *host, struct ata_port *ap);
1229 extern void ata_scsi_cmd_error_handler(struct Scsi_Host *host, struct ata_port *ap, struct list_head *eh_q);
1230 
1231 /*
1232  * SATA specific code - drivers/ata/libata-sata.c
1233  */
1234 #ifdef CONFIG_SATA_HOST
1235 extern const unsigned int sata_deb_timing_normal[];
1236 extern const unsigned int sata_deb_timing_hotplug[];
1237 extern const unsigned int sata_deb_timing_long[];
1238 
1239 static inline const unsigned int *
1240 sata_ehc_deb_timing(struct ata_eh_context *ehc)
1241 {
1242 	if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
1243 		return sata_deb_timing_hotplug;
1244 	else
1245 		return sata_deb_timing_normal;
1246 }
1247 
1248 extern int sata_scr_valid(struct ata_link *link);
1249 extern int sata_scr_read(struct ata_link *link, int reg, u32 *val);
1250 extern int sata_scr_write(struct ata_link *link, int reg, u32 val);
1251 extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val);
1252 extern int sata_set_spd(struct ata_link *link);
1253 int sata_std_hardreset(struct ata_link *link, unsigned int *class,
1254 		       unsigned long deadline);
1255 extern int sata_link_hardreset(struct ata_link *link,
1256 			const unsigned int *timing, unsigned long deadline,
1257 			bool *online, int (*check_ready)(struct ata_link *));
1258 extern int sata_link_resume(struct ata_link *link, const unsigned int *params,
1259 			    unsigned long deadline);
1260 extern void ata_eh_analyze_ncq_error(struct ata_link *link);
1261 #else
1262 static inline const unsigned int *
1263 sata_ehc_deb_timing(struct ata_eh_context *ehc)
1264 {
1265 	return NULL;
1266 }
1267 static inline int sata_scr_valid(struct ata_link *link) { return 0; }
1268 static inline int sata_scr_read(struct ata_link *link, int reg, u32 *val)
1269 {
1270 	return -EOPNOTSUPP;
1271 }
1272 static inline int sata_scr_write(struct ata_link *link, int reg, u32 val)
1273 {
1274 	return -EOPNOTSUPP;
1275 }
1276 static inline int sata_scr_write_flush(struct ata_link *link, int reg, u32 val)
1277 {
1278 	return -EOPNOTSUPP;
1279 }
1280 static inline int sata_set_spd(struct ata_link *link) { return -EOPNOTSUPP; }
1281 static inline int sata_std_hardreset(struct ata_link *link, unsigned int *class,
1282 				     unsigned long deadline)
1283 {
1284 	return -EOPNOTSUPP;
1285 }
1286 static inline int sata_link_hardreset(struct ata_link *link,
1287 				      const unsigned int *timing,
1288 				      unsigned long deadline,
1289 				      bool *online,
1290 				      int (*check_ready)(struct ata_link *))
1291 {
1292 	if (online)
1293 		*online = false;
1294 	return -EOPNOTSUPP;
1295 }
1296 static inline int sata_link_resume(struct ata_link *link,
1297 				   const unsigned int *params,
1298 				   unsigned long deadline)
1299 {
1300 	return -EOPNOTSUPP;
1301 }
1302 static inline void ata_eh_analyze_ncq_error(struct ata_link *link) { }
1303 #endif
1304 extern int sata_link_debounce(struct ata_link *link,
1305 			      const unsigned int *params, unsigned long deadline);
1306 extern int sata_link_scr_lpm(struct ata_link *link, enum ata_lpm_policy policy,
1307 			     bool spm_wakeup);
1308 extern int ata_slave_link_init(struct ata_port *ap);
1309 extern void ata_port_probe(struct ata_port *ap);
1310 extern struct ata_port *ata_port_alloc(struct ata_host *host);
1311 extern void ata_port_free(struct ata_port *ap);
1312 extern int ata_tport_add(struct device *parent, struct ata_port *ap);
1313 extern void ata_tport_delete(struct ata_port *ap);
1314 int ata_sas_sdev_configure(struct scsi_device *sdev, struct queue_limits *lim,
1315 			   struct ata_port *ap);
1316 extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, struct ata_port *ap);
1317 extern void ata_tf_to_fis(const struct ata_taskfile *tf,
1318 			  u8 pmp, int is_cmd, u8 *fis);
1319 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
1320 extern int ata_qc_complete_multiple(struct ata_port *ap, u64 qc_active);
1321 extern bool sata_lpm_ignore_phy_events(struct ata_link *link);
1322 extern int sata_async_notification(struct ata_port *ap);
1323 
1324 extern int ata_cable_40wire(struct ata_port *ap);
1325 extern int ata_cable_80wire(struct ata_port *ap);
1326 extern int ata_cable_sata(struct ata_port *ap);
1327 extern int ata_cable_ignore(struct ata_port *ap);
1328 extern int ata_cable_unknown(struct ata_port *ap);
1329 
1330 /* Timing helpers */
1331 extern unsigned int ata_pio_need_iordy(const struct ata_device *);
1332 extern u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle);
1333 
1334 /* PCI */
1335 #ifdef CONFIG_PCI
1336 struct pci_dev;
1337 
1338 struct pci_bits {
1339 	unsigned int		reg;	/* PCI config register to read */
1340 	unsigned int		width;	/* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
1341 	unsigned long		mask;
1342 	unsigned long		val;
1343 };
1344 
1345 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
1346 extern void ata_pci_shutdown_one(struct pci_dev *pdev);
1347 extern void ata_pci_remove_one(struct pci_dev *pdev);
1348 
1349 #ifdef CONFIG_PM
1350 extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
1351 extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
1352 extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
1353 extern int ata_pci_device_resume(struct pci_dev *pdev);
1354 #endif /* CONFIG_PM */
1355 #endif /* CONFIG_PCI */
1356 
1357 struct platform_device;
1358 
1359 extern void ata_platform_remove_one(struct platform_device *pdev);
1360 
1361 /*
1362  * ACPI - drivers/ata/libata-acpi.c
1363  */
1364 #ifdef CONFIG_ATA_ACPI
1365 static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1366 {
1367 	if (ap->pflags & ATA_PFLAG_INIT_GTM_VALID)
1368 		return &ap->__acpi_init_gtm;
1369 	return NULL;
1370 }
1371 int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm);
1372 int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *stm);
1373 unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev,
1374 				   const struct ata_acpi_gtm *gtm);
1375 int ata_acpi_cbl_pata_type(struct ata_port *ap);
1376 #else
1377 static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1378 {
1379 	return NULL;
1380 }
1381 
1382 static inline int ata_acpi_stm(const struct ata_port *ap,
1383 			       struct ata_acpi_gtm *stm)
1384 {
1385 	return -ENOSYS;
1386 }
1387 
1388 static inline int ata_acpi_gtm(const struct ata_port *ap,
1389 			       struct ata_acpi_gtm *stm)
1390 {
1391 	return -ENOSYS;
1392 }
1393 
1394 static inline unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev,
1395 					const struct ata_acpi_gtm *gtm)
1396 {
1397 	return 0;
1398 }
1399 
1400 static inline int ata_acpi_cbl_pata_type(struct ata_port *ap)
1401 {
1402 	return ATA_CBL_PATA40;
1403 }
1404 #endif
1405 
1406 /*
1407  * EH - drivers/ata/libata-eh.c
1408  */
1409 extern void ata_port_schedule_eh(struct ata_port *ap);
1410 extern void ata_port_wait_eh(struct ata_port *ap);
1411 extern int ata_link_abort(struct ata_link *link);
1412 extern int ata_port_abort(struct ata_port *ap);
1413 extern int ata_port_freeze(struct ata_port *ap);
1414 
1415 extern void ata_eh_freeze_port(struct ata_port *ap);
1416 extern void ata_eh_thaw_port(struct ata_port *ap);
1417 
1418 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
1419 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
1420 
1421 extern void ata_std_error_handler(struct ata_port *ap);
1422 extern void ata_std_sched_eh(struct ata_port *ap);
1423 extern void ata_std_end_eh(struct ata_port *ap);
1424 extern int ata_link_nr_enabled(struct ata_link *link);
1425 
1426 /*
1427  * Base operations to inherit from and initializers for sht
1428  *
1429  * Operations
1430  *
1431  * base  : Common to all libata drivers.
1432  * sata  : SATA controllers w/ native interface.
1433  * pmp   : SATA controllers w/ PMP support.
1434  * sff   : SFF ATA controllers w/o BMDMA support.
1435  * bmdma : SFF ATA controllers w/ BMDMA support.
1436  *
1437  * sht initializers
1438  *
1439  * BASE  : Common to all libata drivers.  The user must set
1440  *	   sg_tablesize and dma_boundary.
1441  * PIO   : SFF ATA controllers w/ only PIO support.
1442  * BMDMA : SFF ATA controllers w/ BMDMA support.  sg_tablesize and
1443  *	   dma_boundary are set to BMDMA limits.
1444  * NCQ   : SATA controllers supporting NCQ.  The user must set
1445  *	   sg_tablesize, dma_boundary and can_queue.
1446  */
1447 extern const struct ata_port_operations ata_base_port_ops;
1448 extern const struct ata_port_operations sata_port_ops;
1449 extern const struct attribute_group *ata_common_sdev_groups[];
1450 
1451 /*
1452  * All sht initializers (BASE, PIO, BMDMA, NCQ) must be instantiated
1453  * by the edge drivers.  Because the 'module' field of sht must be the
1454  * edge driver's module reference, otherwise the driver can be unloaded
1455  * even if the scsi_device is being accessed.
1456  */
1457 #define __ATA_BASE_SHT(drv_name)				\
1458 	.module			= THIS_MODULE,			\
1459 	.name			= drv_name,			\
1460 	.ioctl			= ata_scsi_ioctl,		\
1461 	ATA_SCSI_COMPAT_IOCTL					\
1462 	.queuecommand		= ata_scsi_queuecmd,		\
1463 	.dma_need_drain		= ata_scsi_dma_need_drain,	\
1464 	.this_id		= ATA_SHT_THIS_ID,		\
1465 	.emulated		= ATA_SHT_EMULATED,		\
1466 	.proc_name		= drv_name,			\
1467 	.sdev_init		= ata_scsi_sdev_init,		\
1468 	.sdev_destroy		= ata_scsi_sdev_destroy,	\
1469 	.bios_param		= ata_std_bios_param,		\
1470 	.unlock_native_capacity	= ata_scsi_unlock_native_capacity,\
1471 	.max_sectors		= ATA_MAX_SECTORS_LBA48
1472 
1473 #define ATA_SUBBASE_SHT(drv_name)				\
1474 	__ATA_BASE_SHT(drv_name),				\
1475 	.can_queue		= ATA_DEF_QUEUE,		\
1476 	.tag_alloc_policy_rr	= true,				\
1477 	.sdev_configure		= ata_scsi_sdev_configure
1478 
1479 #define ATA_SUBBASE_SHT_QD(drv_name, drv_qd)			\
1480 	__ATA_BASE_SHT(drv_name),				\
1481 	.can_queue		= drv_qd,			\
1482 	.tag_alloc_policy_rr	= true,				\
1483 	.sdev_configure		= ata_scsi_sdev_configure
1484 
1485 #define ATA_BASE_SHT(drv_name)					\
1486 	ATA_SUBBASE_SHT(drv_name),				\
1487 	.sdev_groups		= ata_common_sdev_groups
1488 
1489 #ifdef CONFIG_SATA_HOST
1490 extern const struct attribute_group *ata_ncq_sdev_groups[];
1491 
1492 #define ATA_NCQ_SHT(drv_name)					\
1493 	ATA_SUBBASE_SHT(drv_name),				\
1494 	.sdev_groups		= ata_ncq_sdev_groups,		\
1495 	.change_queue_depth	= ata_scsi_change_queue_depth
1496 
1497 #define ATA_NCQ_SHT_QD(drv_name, drv_qd)			\
1498 	ATA_SUBBASE_SHT_QD(drv_name, drv_qd),			\
1499 	.sdev_groups		= ata_ncq_sdev_groups,		\
1500 	.change_queue_depth	= ata_scsi_change_queue_depth
1501 #endif
1502 
1503 /*
1504  * PMP helpers
1505  */
1506 #ifdef CONFIG_SATA_PMP
1507 static inline bool sata_pmp_supported(struct ata_port *ap)
1508 {
1509 	return ap->flags & ATA_FLAG_PMP;
1510 }
1511 
1512 static inline bool sata_pmp_attached(struct ata_port *ap)
1513 {
1514 	return ap->nr_pmp_links != 0;
1515 }
1516 
1517 static inline bool ata_is_host_link(const struct ata_link *link)
1518 {
1519 	return link == &link->ap->link || link == link->ap->slave_link;
1520 }
1521 #else /* CONFIG_SATA_PMP */
1522 static inline bool sata_pmp_supported(struct ata_port *ap)
1523 {
1524 	return false;
1525 }
1526 
1527 static inline bool sata_pmp_attached(struct ata_port *ap)
1528 {
1529 	return false;
1530 }
1531 
1532 static inline bool ata_is_host_link(const struct ata_link *link)
1533 {
1534 	return true;
1535 }
1536 #endif /* CONFIG_SATA_PMP */
1537 
1538 static inline int sata_srst_pmp(struct ata_link *link)
1539 {
1540 	if (sata_pmp_supported(link->ap) && ata_is_host_link(link))
1541 		return SATA_PMP_CTRL_PORT;
1542 	return link->pmp;
1543 }
1544 
1545 #define ata_port_printk(level, ap, fmt, ...)			\
1546 	pr_ ## level ("ata%u: " fmt, (ap)->print_id, ##__VA_ARGS__)
1547 
1548 #define ata_port_err(ap, fmt, ...)				\
1549 	ata_port_printk(err, ap, fmt, ##__VA_ARGS__)
1550 #define ata_port_warn(ap, fmt, ...)				\
1551 	ata_port_printk(warn, ap, fmt, ##__VA_ARGS__)
1552 #define ata_port_notice(ap, fmt, ...)				\
1553 	ata_port_printk(notice, ap, fmt, ##__VA_ARGS__)
1554 #define ata_port_info(ap, fmt, ...)				\
1555 	ata_port_printk(info, ap, fmt, ##__VA_ARGS__)
1556 #define ata_port_dbg(ap, fmt, ...)				\
1557 	ata_port_printk(debug, ap, fmt, ##__VA_ARGS__)
1558 
1559 #define ata_link_printk(level, link, fmt, ...)			\
1560 do {								\
1561 	if (sata_pmp_attached((link)->ap) ||			\
1562 	    (link)->ap->slave_link)				\
1563 		pr_ ## level ("ata%u.%02u: " fmt,		\
1564 			      (link)->ap->print_id,		\
1565 			      (link)->pmp,			\
1566 			      ##__VA_ARGS__);			\
1567         else							\
1568 		pr_ ## level ("ata%u: " fmt,			\
1569 			      (link)->ap->print_id,		\
1570 			      ##__VA_ARGS__);			\
1571 } while (0)
1572 
1573 #define ata_link_err(link, fmt, ...)				\
1574 	ata_link_printk(err, link, fmt, ##__VA_ARGS__)
1575 #define ata_link_warn(link, fmt, ...)				\
1576 	ata_link_printk(warn, link, fmt, ##__VA_ARGS__)
1577 #define ata_link_notice(link, fmt, ...)				\
1578 	ata_link_printk(notice, link, fmt, ##__VA_ARGS__)
1579 #define ata_link_info(link, fmt, ...)				\
1580 	ata_link_printk(info, link, fmt, ##__VA_ARGS__)
1581 #define ata_link_dbg(link, fmt, ...)				\
1582 	ata_link_printk(debug, link, fmt, ##__VA_ARGS__)
1583 
1584 #define ata_dev_printk(level, dev, fmt, ...)			\
1585         pr_ ## level("ata%u.%02u: " fmt,			\
1586                (dev)->link->ap->print_id,			\
1587 	       (dev)->link->pmp + (dev)->devno,			\
1588 	       ##__VA_ARGS__)
1589 
1590 #define ata_dev_err(dev, fmt, ...)				\
1591 	ata_dev_printk(err, dev, fmt, ##__VA_ARGS__)
1592 #define ata_dev_warn(dev, fmt, ...)				\
1593 	ata_dev_printk(warn, dev, fmt, ##__VA_ARGS__)
1594 #define ata_dev_notice(dev, fmt, ...)				\
1595 	ata_dev_printk(notice, dev, fmt, ##__VA_ARGS__)
1596 #define ata_dev_info(dev, fmt, ...)				\
1597 	ata_dev_printk(info, dev, fmt, ##__VA_ARGS__)
1598 #define ata_dev_dbg(dev, fmt, ...)				\
1599 	ata_dev_printk(debug, dev, fmt, ##__VA_ARGS__)
1600 
1601 #define ata_dev_warn_once(dev, fmt, ...)			\
1602 	pr_warn_once("ata%u.%02u: " fmt,			\
1603 		     (dev)->link->ap->print_id,			\
1604 		     (dev)->link->pmp + (dev)->devno,		\
1605 		     ##__VA_ARGS__)
1606 
1607 static inline void ata_print_version_once(const struct device *dev,
1608 					  const char *version)
1609 {
1610 	dev_dbg_once(dev, "version %s\n", version);
1611 }
1612 
1613 /*
1614  * ata_eh_info helpers
1615  */
1616 extern __printf(2, 3)
1617 void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
1618 extern __printf(2, 3)
1619 void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
1620 extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
1621 
1622 static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
1623 {
1624 	ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
1625 	ehi->flags |= ATA_EHI_HOTPLUGGED;
1626 	ehi->action |= ATA_EH_RESET | ATA_EH_ENABLE_LINK;
1627 	ehi->err_mask |= AC_ERR_ATA_BUS;
1628 }
1629 
1630 /*
1631  * port description helpers
1632  */
1633 extern __printf(2, 3)
1634 void ata_port_desc(struct ata_port *ap, const char *fmt, ...);
1635 #ifdef CONFIG_PCI
1636 extern void ata_port_pbar_desc(struct ata_port *ap, int bar, ssize_t offset,
1637 			       const char *name);
1638 #endif
1639 static inline void ata_port_desc_misc(struct ata_port *ap, int irq)
1640 {
1641 	ata_port_desc(ap, "irq %d", irq);
1642 	ata_port_desc(ap, "lpm-pol %d", ap->target_lpm_policy);
1643 	if (ap->pflags & ATA_PFLAG_EXTERNAL)
1644 		ata_port_desc(ap, "ext");
1645 }
1646 
1647 static inline bool ata_tag_internal(unsigned int tag)
1648 {
1649 	return tag == ATA_TAG_INTERNAL;
1650 }
1651 
1652 static inline bool ata_tag_valid(unsigned int tag)
1653 {
1654 	return tag < ATA_MAX_QUEUE || ata_tag_internal(tag);
1655 }
1656 
1657 #define __ata_qc_for_each(ap, qc, tag, max_tag, fn)		\
1658 	for ((tag) = 0; (tag) < (max_tag) &&			\
1659 	     ({ qc = fn((ap), (tag)); 1; }); (tag)++)		\
1660 
1661 /*
1662  * Internal use only, iterate commands ignoring error handling and
1663  * status of 'qc'.
1664  */
1665 #define ata_qc_for_each_raw(ap, qc, tag)					\
1666 	__ata_qc_for_each(ap, qc, tag, ATA_MAX_QUEUE, __ata_qc_from_tag)
1667 
1668 /*
1669  * Iterate all potential commands that can be queued
1670  */
1671 #define ata_qc_for_each(ap, qc, tag)					\
1672 	__ata_qc_for_each(ap, qc, tag, ATA_MAX_QUEUE, ata_qc_from_tag)
1673 
1674 /*
1675  * Like ata_qc_for_each, but with the internal tag included
1676  */
1677 #define ata_qc_for_each_with_internal(ap, qc, tag)			\
1678 	__ata_qc_for_each(ap, qc, tag, ATA_MAX_QUEUE + 1, ata_qc_from_tag)
1679 
1680 /*
1681  * device helpers
1682  */
1683 static inline unsigned int ata_class_enabled(unsigned int class)
1684 {
1685 	return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI ||
1686 		class == ATA_DEV_PMP || class == ATA_DEV_SEMB ||
1687 		class == ATA_DEV_ZAC;
1688 }
1689 
1690 static inline unsigned int ata_class_disabled(unsigned int class)
1691 {
1692 	return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP ||
1693 		class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP ||
1694 		class == ATA_DEV_ZAC_UNSUP;
1695 }
1696 
1697 static inline unsigned int ata_class_absent(unsigned int class)
1698 {
1699 	return !ata_class_enabled(class) && !ata_class_disabled(class);
1700 }
1701 
1702 static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1703 {
1704 	return ata_class_enabled(dev->class);
1705 }
1706 
1707 static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1708 {
1709 	return ata_class_disabled(dev->class);
1710 }
1711 
1712 static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1713 {
1714 	return ata_class_absent(dev->class);
1715 }
1716 
1717 /*
1718  * link helpers
1719  */
1720 static inline int ata_link_max_devices(const struct ata_link *link)
1721 {
1722 	if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS)
1723 		return 2;
1724 	return 1;
1725 }
1726 
1727 static inline int ata_link_active(struct ata_link *link)
1728 {
1729 	return ata_tag_valid(link->active_tag) || link->sactive;
1730 }
1731 
1732 /*
1733  * Iterators
1734  *
1735  * ATA_LITER_* constants are used to select link iteration mode and
1736  * ATA_DITER_* device iteration mode.
1737  *
1738  * For a custom iteration directly using ata_{link|dev}_next(), if
1739  * @link or @dev, respectively, is NULL, the first element is
1740  * returned.  @dev and @link can be any valid device or link and the
1741  * next element according to the iteration mode will be returned.
1742  * After the last element, NULL is returned.
1743  */
1744 enum ata_link_iter_mode {
1745 	ATA_LITER_EDGE,		/* if present, PMP links only; otherwise,
1746 				 * host link.  no slave link */
1747 	ATA_LITER_HOST_FIRST,	/* host link followed by PMP or slave links */
1748 	ATA_LITER_PMP_FIRST,	/* PMP links followed by host link,
1749 				 * slave link still comes after host link */
1750 };
1751 
1752 enum ata_dev_iter_mode {
1753 	ATA_DITER_ENABLED,
1754 	ATA_DITER_ENABLED_REVERSE,
1755 	ATA_DITER_ALL,
1756 	ATA_DITER_ALL_REVERSE,
1757 };
1758 
1759 extern struct ata_link *ata_link_next(struct ata_link *link,
1760 				      struct ata_port *ap,
1761 				      enum ata_link_iter_mode mode);
1762 
1763 extern struct ata_device *ata_dev_next(struct ata_device *dev,
1764 				       struct ata_link *link,
1765 				       enum ata_dev_iter_mode mode);
1766 
1767 /*
1768  * Shortcut notation for iterations
1769  *
1770  * ata_for_each_link() iterates over each link of @ap according to
1771  * @mode.  @link points to the current link in the loop.  @link is
1772  * NULL after loop termination.  ata_for_each_dev() works the same way
1773  * except that it iterates over each device of @link.
1774  *
1775  * Note that the mode prefixes ATA_{L|D}ITER_ shouldn't need to be
1776  * specified when using the following shorthand notations.  Only the
1777  * mode itself (EDGE, HOST_FIRST, ENABLED, etc...) should be
1778  * specified.  This not only increases brevity but also makes it
1779  * impossible to use ATA_LITER_* for device iteration or vice-versa.
1780  */
1781 #define ata_for_each_link(link, ap, mode) \
1782 	for ((link) = ata_link_next(NULL, (ap), ATA_LITER_##mode); (link); \
1783 	     (link) = ata_link_next((link), (ap), ATA_LITER_##mode))
1784 
1785 #define ata_for_each_dev(dev, link, mode) \
1786 	for ((dev) = ata_dev_next(NULL, (link), ATA_DITER_##mode); (dev); \
1787 	     (dev) = ata_dev_next((dev), (link), ATA_DITER_##mode))
1788 
1789 /**
1790  *	ata_ncq_supported - Test whether NCQ is supported
1791  *	@dev: ATA device to test
1792  *
1793  *	LOCKING:
1794  *	spin_lock_irqsave(host lock)
1795  *
1796  *	RETURNS:
1797  *	true if @dev supports NCQ, false otherwise.
1798  */
1799 static inline bool ata_ncq_supported(struct ata_device *dev)
1800 {
1801 	if (!IS_ENABLED(CONFIG_SATA_HOST))
1802 		return false;
1803 	return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1804 }
1805 
1806 /**
1807  *	ata_ncq_enabled - Test whether NCQ is enabled
1808  *	@dev: ATA device to test
1809  *
1810  *	LOCKING:
1811  *	spin_lock_irqsave(host lock)
1812  *
1813  *	RETURNS:
1814  *	true if NCQ is enabled for @dev, false otherwise.
1815  */
1816 static inline bool ata_ncq_enabled(struct ata_device *dev)
1817 {
1818 	return ata_ncq_supported(dev) && !(dev->flags & ATA_DFLAG_NCQ_OFF);
1819 }
1820 
1821 static inline bool ata_fpdma_dsm_supported(struct ata_device *dev)
1822 {
1823 	return (dev->flags & ATA_DFLAG_NCQ_SEND_RECV) &&
1824 		(dev->ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_DSM_OFFSET] &
1825 		 ATA_LOG_NCQ_SEND_RECV_DSM_TRIM);
1826 }
1827 
1828 static inline bool ata_fpdma_read_log_supported(struct ata_device *dev)
1829 {
1830 	return (dev->flags & ATA_DFLAG_NCQ_SEND_RECV) &&
1831 		(dev->ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_RD_LOG_OFFSET] &
1832 		 ATA_LOG_NCQ_SEND_RECV_RD_LOG_SUPPORTED);
1833 }
1834 
1835 static inline bool ata_fpdma_zac_mgmt_in_supported(struct ata_device *dev)
1836 {
1837 	return (dev->flags & ATA_DFLAG_NCQ_SEND_RECV) &&
1838 		(dev->ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_ZAC_MGMT_OFFSET] &
1839 		ATA_LOG_NCQ_SEND_RECV_ZAC_MGMT_IN_SUPPORTED);
1840 }
1841 
1842 static inline bool ata_fpdma_zac_mgmt_out_supported(struct ata_device *dev)
1843 {
1844 	return (dev->ncq_non_data_cmds[ATA_LOG_NCQ_NON_DATA_ZAC_MGMT_OFFSET] &
1845 		ATA_LOG_NCQ_NON_DATA_ZAC_MGMT_OUT);
1846 }
1847 
1848 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1849 {
1850 	qc->tf.ctl |= ATA_NIEN;
1851 }
1852 
1853 static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1854 						       unsigned int tag)
1855 {
1856 	if (ata_tag_valid(tag))
1857 		return &ap->qcmd[tag];
1858 	return NULL;
1859 }
1860 
1861 static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1862 						     unsigned int tag)
1863 {
1864 	struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1865 
1866 	if (unlikely(!qc))
1867 		return qc;
1868 
1869 	if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1870 			  ATA_QCFLAG_EH)) == ATA_QCFLAG_ACTIVE)
1871 		return qc;
1872 
1873 	return NULL;
1874 }
1875 
1876 static inline unsigned int ata_qc_raw_nbytes(struct ata_queued_cmd *qc)
1877 {
1878 	return qc->nbytes - min(qc->extrabytes, qc->nbytes);
1879 }
1880 
1881 static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1882 {
1883 	memset(tf, 0, sizeof(*tf));
1884 
1885 #ifdef CONFIG_ATA_SFF
1886 	tf->ctl = dev->link->ap->ctl;
1887 #else
1888 	tf->ctl = ATA_DEVCTL_OBS;
1889 #endif
1890 	if (dev->devno == 0)
1891 		tf->device = ATA_DEVICE_OBS;
1892 	else
1893 		tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1894 }
1895 
1896 static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1897 {
1898 	qc->dma_dir = DMA_NONE;
1899 	qc->sg = NULL;
1900 	qc->flags = 0;
1901 	qc->cursg = NULL;
1902 	qc->cursg_ofs = 0;
1903 	qc->nbytes = qc->extrabytes = qc->curbytes = 0;
1904 	qc->n_elem = 0;
1905 	qc->err_mask = 0;
1906 	qc->sect_size = ATA_SECT_SIZE;
1907 
1908 	ata_tf_init(qc->dev, &qc->tf);
1909 
1910 	/* init result_tf such that it indicates normal completion */
1911 	qc->result_tf.command = ATA_DRDY;
1912 	qc->result_tf.feature = 0;
1913 }
1914 
1915 static inline int ata_try_flush_cache(const struct ata_device *dev)
1916 {
1917 	return ata_id_wcache_enabled(dev->id) ||
1918 	       ata_id_has_flush(dev->id) ||
1919 	       ata_id_has_flush_ext(dev->id);
1920 }
1921 
1922 static inline unsigned int ac_err_mask(u8 status)
1923 {
1924 	if (status & (ATA_BUSY | ATA_DRQ))
1925 		return AC_ERR_HSM;
1926 	if (status & (ATA_ERR | ATA_DF))
1927 		return AC_ERR_DEV;
1928 	return 0;
1929 }
1930 
1931 static inline unsigned int __ac_err_mask(u8 status)
1932 {
1933 	unsigned int mask = ac_err_mask(status);
1934 	if (mask == 0)
1935 		return AC_ERR_OTHER;
1936 	return mask;
1937 }
1938 
1939 static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1940 {
1941 	return *(struct ata_port **)&host->hostdata[0];
1942 }
1943 
1944 static inline int ata_check_ready(u8 status)
1945 {
1946 	if (!(status & ATA_BUSY))
1947 		return 1;
1948 
1949 	/* 0xff indicates either no device or device not ready */
1950 	if (status == 0xff)
1951 		return -ENODEV;
1952 
1953 	return 0;
1954 }
1955 
1956 static inline unsigned long ata_deadline(unsigned long from_jiffies,
1957 					 unsigned int timeout_msecs)
1958 {
1959 	return from_jiffies + msecs_to_jiffies(timeout_msecs);
1960 }
1961 
1962 /* Don't open code these in drivers as there are traps. Firstly the range may
1963    change in future hardware and specs, secondly 0xFF means 'no DMA' but is
1964    > UDMA_0. Dyma ddreigiau */
1965 
1966 static inline bool ata_using_mwdma(struct ata_device *adev)
1967 {
1968 	return adev->dma_mode >= XFER_MW_DMA_0 &&
1969 		adev->dma_mode <= XFER_MW_DMA_4;
1970 }
1971 
1972 static inline bool ata_using_udma(struct ata_device *adev)
1973 {
1974 	return adev->dma_mode >= XFER_UDMA_0 &&
1975 		adev->dma_mode <= XFER_UDMA_7;
1976 }
1977 
1978 static inline bool ata_dma_enabled(struct ata_device *adev)
1979 {
1980 	return adev->dma_mode != 0xFF;
1981 }
1982 
1983 /**************************************************************************
1984  * PATA timings - drivers/ata/libata-pata-timings.c
1985  */
1986 extern const struct ata_timing *ata_timing_find_mode(u8 xfer_mode);
1987 extern int ata_timing_compute(struct ata_device *, unsigned short,
1988 			      struct ata_timing *, int, int);
1989 extern void ata_timing_merge(const struct ata_timing *,
1990 			     const struct ata_timing *, struct ata_timing *,
1991 			     unsigned int);
1992 
1993 /**************************************************************************
1994  * PMP - drivers/ata/libata-pmp.c
1995  */
1996 #ifdef CONFIG_SATA_PMP
1997 
1998 extern const struct ata_port_operations sata_pmp_port_ops;
1999 
2000 extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc);
2001 extern void sata_pmp_error_handler(struct ata_port *ap);
2002 
2003 #else /* CONFIG_SATA_PMP */
2004 
2005 #define sata_pmp_port_ops		sata_port_ops
2006 #define sata_pmp_qc_defer_cmd_switch	ata_std_qc_defer
2007 #define sata_pmp_error_handler		ata_std_error_handler
2008 
2009 #endif /* CONFIG_SATA_PMP */
2010 
2011 
2012 /**************************************************************************
2013  * SFF - drivers/ata/libata-sff.c
2014  */
2015 #ifdef CONFIG_ATA_SFF
2016 
2017 extern const struct ata_port_operations ata_sff_port_ops;
2018 extern const struct ata_port_operations ata_bmdma32_port_ops;
2019 
2020 /* PIO only, sg_tablesize and dma_boundary limits can be removed */
2021 #define ATA_PIO_SHT(drv_name)					\
2022 	ATA_BASE_SHT(drv_name),					\
2023 	.sg_tablesize		= LIBATA_MAX_PRD,		\
2024 	.dma_boundary		= ATA_DMA_BOUNDARY
2025 
2026 extern void ata_sff_dev_select(struct ata_port *ap, unsigned int device);
2027 extern u8 ata_sff_check_status(struct ata_port *ap);
2028 extern void ata_sff_pause(struct ata_port *ap);
2029 extern void ata_sff_dma_pause(struct ata_port *ap);
2030 extern int ata_sff_wait_ready(struct ata_link *link, unsigned long deadline);
2031 extern void ata_sff_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
2032 extern void ata_sff_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
2033 extern void ata_sff_exec_command(struct ata_port *ap,
2034 				 const struct ata_taskfile *tf);
2035 extern unsigned int ata_sff_data_xfer(struct ata_queued_cmd *qc,
2036 			unsigned char *buf, unsigned int buflen, int rw);
2037 extern unsigned int ata_sff_data_xfer32(struct ata_queued_cmd *qc,
2038 			unsigned char *buf, unsigned int buflen, int rw);
2039 extern void ata_sff_irq_on(struct ata_port *ap);
2040 extern int ata_sff_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
2041 			    u8 status, int in_wq);
2042 extern void ata_sff_queue_work(struct work_struct *work);
2043 extern void ata_sff_queue_delayed_work(struct delayed_work *dwork,
2044 		unsigned long delay);
2045 extern void ata_sff_queue_pio_task(struct ata_link *link, unsigned long delay);
2046 extern unsigned int ata_sff_qc_issue(struct ata_queued_cmd *qc);
2047 extern void ata_sff_qc_fill_rtf(struct ata_queued_cmd *qc);
2048 extern unsigned int ata_sff_port_intr(struct ata_port *ap,
2049 				      struct ata_queued_cmd *qc);
2050 extern irqreturn_t ata_sff_interrupt(int irq, void *dev_instance);
2051 extern void ata_sff_lost_interrupt(struct ata_port *ap);
2052 extern void ata_sff_freeze(struct ata_port *ap);
2053 extern void ata_sff_thaw(struct ata_port *ap);
2054 extern int ata_sff_prereset(struct ata_link *link, unsigned long deadline);
2055 extern unsigned int ata_sff_dev_classify(struct ata_device *dev, int present,
2056 					  u8 *r_err);
2057 extern int ata_sff_wait_after_reset(struct ata_link *link, unsigned int devmask,
2058 				    unsigned long deadline);
2059 extern int ata_sff_softreset(struct ata_link *link, unsigned int *classes,
2060 			     unsigned long deadline);
2061 extern int sata_sff_hardreset(struct ata_link *link, unsigned int *class,
2062 			       unsigned long deadline);
2063 extern void ata_sff_postreset(struct ata_link *link, unsigned int *classes);
2064 extern void ata_sff_drain_fifo(struct ata_queued_cmd *qc);
2065 extern void ata_sff_error_handler(struct ata_port *ap);
2066 extern void ata_sff_std_ports(struct ata_ioports *ioaddr);
2067 #ifdef CONFIG_PCI
2068 extern int ata_pci_sff_init_host(struct ata_host *host);
2069 extern int ata_pci_sff_prepare_host(struct pci_dev *pdev,
2070 				    const struct ata_port_info * const * ppi,
2071 				    struct ata_host **r_host);
2072 extern int ata_pci_sff_activate_host(struct ata_host *host,
2073 				     irq_handler_t irq_handler,
2074 				     const struct scsi_host_template *sht);
2075 extern int ata_pci_sff_init_one(struct pci_dev *pdev,
2076 		const struct ata_port_info * const * ppi,
2077 		const struct scsi_host_template *sht, void *host_priv, int hflags);
2078 #endif /* CONFIG_PCI */
2079 
2080 #ifdef CONFIG_ATA_BMDMA
2081 
2082 extern const struct ata_port_operations ata_bmdma_port_ops;
2083 
2084 #define ATA_BMDMA_SHT(drv_name)					\
2085 	ATA_BASE_SHT(drv_name),					\
2086 	.sg_tablesize		= LIBATA_MAX_PRD,		\
2087 	.dma_boundary		= ATA_DMA_BOUNDARY
2088 
2089 extern enum ata_completion_errors ata_bmdma_qc_prep(struct ata_queued_cmd *qc);
2090 extern unsigned int ata_bmdma_qc_issue(struct ata_queued_cmd *qc);
2091 extern enum ata_completion_errors ata_bmdma_dumb_qc_prep(struct ata_queued_cmd *qc);
2092 extern unsigned int ata_bmdma_port_intr(struct ata_port *ap,
2093 				      struct ata_queued_cmd *qc);
2094 extern irqreturn_t ata_bmdma_interrupt(int irq, void *dev_instance);
2095 extern void ata_bmdma_error_handler(struct ata_port *ap);
2096 extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
2097 extern void ata_bmdma_irq_clear(struct ata_port *ap);
2098 extern void ata_bmdma_setup(struct ata_queued_cmd *qc);
2099 extern void ata_bmdma_start(struct ata_queued_cmd *qc);
2100 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
2101 extern u8 ata_bmdma_status(struct ata_port *ap);
2102 extern int ata_bmdma_port_start(struct ata_port *ap);
2103 extern int ata_bmdma_port_start32(struct ata_port *ap);
2104 
2105 #ifdef CONFIG_PCI
2106 extern int ata_pci_bmdma_clear_simplex(struct pci_dev *pdev);
2107 extern void ata_pci_bmdma_init(struct ata_host *host);
2108 extern int ata_pci_bmdma_prepare_host(struct pci_dev *pdev,
2109 				      const struct ata_port_info * const * ppi,
2110 				      struct ata_host **r_host);
2111 extern int ata_pci_bmdma_init_one(struct pci_dev *pdev,
2112 				  const struct ata_port_info * const * ppi,
2113 				  const struct scsi_host_template *sht,
2114 				  void *host_priv, int hflags);
2115 #endif /* CONFIG_PCI */
2116 #endif /* CONFIG_ATA_BMDMA */
2117 
2118 /**
2119  *	ata_sff_busy_wait - Wait for a port status register
2120  *	@ap: Port to wait for.
2121  *	@bits: bits that must be clear
2122  *	@max: number of 10uS waits to perform
2123  *
2124  *	Waits up to max*10 microseconds for the selected bits in the port's
2125  *	status register to be cleared.
2126  *	Returns final value of status register.
2127  *
2128  *	LOCKING:
2129  *	Inherited from caller.
2130  */
2131 static inline u8 ata_sff_busy_wait(struct ata_port *ap, unsigned int bits,
2132 				   unsigned int max)
2133 {
2134 	u8 status;
2135 
2136 	do {
2137 		udelay(10);
2138 		status = ap->ops->sff_check_status(ap);
2139 		max--;
2140 	} while (status != 0xff && (status & bits) && (max > 0));
2141 
2142 	return status;
2143 }
2144 
2145 /**
2146  *	ata_wait_idle - Wait for a port to be idle.
2147  *	@ap: Port to wait for.
2148  *
2149  *	Waits up to 10ms for port's BUSY and DRQ signals to clear.
2150  *	Returns final value of status register.
2151  *
2152  *	LOCKING:
2153  *	Inherited from caller.
2154  */
2155 static inline u8 ata_wait_idle(struct ata_port *ap)
2156 {
2157 	u8 status = ata_sff_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
2158 
2159 	if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
2160 		ata_port_dbg(ap, "abnormal Status 0x%X\n", status);
2161 
2162 	return status;
2163 }
2164 #else /* CONFIG_ATA_SFF */
2165 static inline int sata_sff_hardreset(struct ata_link *link, unsigned int *class,
2166 				     unsigned long deadline)
2167 {
2168 	return -EOPNOTSUPP;
2169 }
2170 #endif /* CONFIG_ATA_SFF */
2171 
2172 #endif /* __LINUX_LIBATA_H__ */
2173