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