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