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