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