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