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