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