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