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