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