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