]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - include/linux/libata.h
projects / mirror_ubuntu-bionic-kernel.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Merge branch 'sh/for-2.6.28' of git://git.kernel.org/pub/scm/linux/kernel/git/lethal...
[mirror_ubuntu-bionic-kernel.git] / include / linux / libata.h
CommitLineData
1da177e4 1/*
af36d7f0
JG		 2 * Copyright 2003-2005 Red Hat, Inc. All rights reserved.
3 * Copyright 2003-2005 Jeff Garzik
4 *
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2, or (at your option)
9 * any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; see the file COPYING. If not, write to
18 * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
19 *
20 *
21 * libata documentation is available via 'make {ps|pdf}docs',
22 * as Documentation/DocBook/libata.*
23 *
1da177e4
LT		 24 */
25
26#ifndef __LINUX_LIBATA_H__
27#define __LINUX_LIBATA_H__
28
29#include <linux/delay.h>
341c2c95 30#include <linux/jiffies.h>
1da177e4 31#include <linux/interrupt.h>
1c72d8d9 32#include <linux/dma-mapping.h>
87260216 33#include <linux/scatterlist.h>
f0d36efd 34#include <linux/io.h>
1da177e4
LT		 35#include <linux/ata.h>
36#include <linux/workqueue.h>
35bb94b1 37#include <scsi/scsi_host.h>
11ef697b 38#include <linux/acpi.h>
ceb0c642 39#include <linux/cdrom.h>
1da177e4 40
a6d967a4
JG		 41/*
42 * Define if arch has non-standard setup. This is a _PCI_ standard
43 * not a legacy or ISA standard.
44 */
45#ifdef CONFIG_ATA_NONSTANDARD
2ec7df04 46#include <asm/libata-portmap.h>
a6d967a4
JG		 47#else
48#include <asm-generic/libata-portmap.h>
49#endif
2ec7df04 50
1da177e4 51/*
bfd60579
RD		 52 * compile-time options: to be removed as soon as all the drivers are
53 * converted to the new debugging mechanism
1da177e4
LT		 54 */
55#undef ATA_DEBUG /* debugging output */
56#undef ATA_VERBOSE_DEBUG /* yet more debugging output */
57#undef ATA_IRQ_TRAP /* define to ack screaming irqs */
58#undef ATA_NDEBUG /* define to disable quick runtime checks */
1da177e4
LT		 59
60
61/* note: prints function name for you */
62#ifdef ATA_DEBUG
1f938d06 63#define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __func__, ## args)
1da177e4 64#ifdef ATA_VERBOSE_DEBUG
1f938d06 65#define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __func__, ## args)
1da177e4
LT		 66#else
67#define VPRINTK(fmt, args...)
68#endif /* ATA_VERBOSE_DEBUG */
69#else
70#define DPRINTK(fmt, args...)
71#define VPRINTK(fmt, args...)
72#endif /* ATA_DEBUG */
73
1f938d06 74#define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __func__, ## args)
2c13b7ce 75
bfd60579
RD		 76/* NEW: debug levels */
77#define HAVE_LIBATA_MSG 1
78
79enum {
80 ATA_MSG_DRV = 0x0001,
81 ATA_MSG_INFO = 0x0002,
82 ATA_MSG_PROBE = 0x0004,
83 ATA_MSG_WARN = 0x0008,
84 ATA_MSG_MALLOC = 0x0010,
85 ATA_MSG_CTL = 0x0020,
86 ATA_MSG_INTR = 0x0040,
87 ATA_MSG_ERR = 0x0080,
88};
89
90#define ata_msg_drv(p) ((p)->msg_enable & ATA_MSG_DRV)
91#define ata_msg_info(p) ((p)->msg_enable & ATA_MSG_INFO)
92#define ata_msg_probe(p) ((p)->msg_enable & ATA_MSG_PROBE)
93#define ata_msg_warn(p) ((p)->msg_enable & ATA_MSG_WARN)
94#define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC)
95#define ata_msg_ctl(p) ((p)->msg_enable & ATA_MSG_CTL)
96#define ata_msg_intr(p) ((p)->msg_enable & ATA_MSG_INTR)
97#define ata_msg_err(p) ((p)->msg_enable & ATA_MSG_ERR)
98
99static inline u32 ata_msg_init(int dval, int default_msg_enable_bits)
100{
101 if (dval < 0 || dval >= (sizeof(u32) * 8))
102 return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */
103 if (!dval)
104 return 0;
105 return (1 << dval) - 1;
106}
107
1da177e4
LT		 108/* defines only for the constants which don't work well as enums */
109#define ATA_TAG_POISON 0xfafbfcfdU
110
1da177e4
LT		 111enum {
112 /* various global constants */
113 LIBATA_MAX_PRD = ATA_MAX_PRD / 2,
d26fc955 114 LIBATA_DUMB_MAX_PRD = ATA_MAX_PRD / 4, /* Worst case */
1da177e4 115 ATA_DEF_QUEUE = 1,
2ab7db1f 116 /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
a6e6ce8e 117 ATA_MAX_QUEUE = 32,
2ab7db1f 118 ATA_TAG_INTERNAL = ATA_MAX_QUEUE - 1,
341c2c95 119 ATA_SHORT_PAUSE = 16,
1da177e4 120
140b5e59
TH		 121 ATAPI_MAX_DRAIN = 16 << 10,
122
b558eddd
TH		 123 ATA_ALL_DEVICES = (1 << ATA_MAX_DEVICES) - 1,
124
1da177e4
LT		 125 ATA_SHT_EMULATED = 1,
126 ATA_SHT_CMD_PER_LUN = 1,
127 ATA_SHT_THIS_ID = -1,
cf482935 128 ATA_SHT_USE_CLUSTERING = 1,
1da177e4
LT		 129
130 /* struct ata_device stuff */
949b38af
TH		 131 ATA_DFLAG_LBA = (1 << 0), /* device supports LBA */
132 ATA_DFLAG_LBA48 = (1 << 1), /* device supports LBA48 */
029f5468 133 ATA_DFLAG_CDB_INTR = (1 << 2), /* device asserts INTRQ when ready for CDB */
88e49034 134 ATA_DFLAG_NCQ = (1 << 3), /* device supports NCQ */
6fc49adb 135 ATA_DFLAG_FLUSH_EXT = (1 << 4), /* do FLUSH_EXT instead of FLUSH */
6746544c
TH		 136 ATA_DFLAG_ACPI_PENDING = (1 << 5), /* ACPI resume action pending */
137 ATA_DFLAG_ACPI_FAILED = (1 << 6), /* ACPI on devcfg has failed */
7d77b247 138 ATA_DFLAG_AN = (1 << 7), /* AN configured */
ca77329f
KCA		 139 ATA_DFLAG_HIPM = (1 << 8), /* device supports HIPM */
140 ATA_DFLAG_DIPM = (1 << 9), /* device supports DIPM */
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 */
146 ATA_DFLAG_SPUNDOWN = (1 << 14), /* XXX: for spindown_compat */
054a5fba 147 ATA_DFLAG_SLEEPING = (1 << 15), /* device is sleeping */
00115e0f 148 ATA_DFLAG_DUBIOUS_XFER = (1 << 16), /* data transfer not verified */
45fabbb7 149 ATA_DFLAG_NO_UNLOAD = (1 << 17), /* device doesn't support unload */
f20ded38 150 ATA_DFLAG_INIT_MASK = (1 << 24) - 1,
1da177e4 151
f20ded38
TH		 152 ATA_DFLAG_DETACH = (1 << 24),
153 ATA_DFLAG_DETACHED = (1 << 25),
abdda733 154
1da177e4
LT		 155 ATA_DEV_UNKNOWN = 0, /* unknown device */
156 ATA_DEV_ATA = 1, /* ATA device */
157 ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */
158 ATA_DEV_ATAPI = 3, /* ATAPI device */
159 ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */
e0a71752
TH		 160 ATA_DEV_PMP = 5, /* SATA port multiplier */
161 ATA_DEV_PMP_UNSUP = 6, /* SATA port multiplier (unsupported) */
162 ATA_DEV_SEMB = 7, /* SEMB */
163 ATA_DEV_SEMB_UNSUP = 8, /* SEMB (unsupported) */
164 ATA_DEV_NONE = 9, /* no device */
1da177e4 165
0c88758b 166 /* struct ata_link flags */
05944bdf 167 ATA_LFLAG_NO_HRST = (1 << 1), /* avoid hardreset */
ae791c05
TH		 168 ATA_LFLAG_NO_SRST = (1 << 2), /* avoid softreset */
169 ATA_LFLAG_ASSUME_ATA = (1 << 3), /* assume ATA class */
170 ATA_LFLAG_ASSUME_SEMB = (1 << 4), /* assume SEMB class */
171 ATA_LFLAG_ASSUME_CLASS = ATA_LFLAG_ASSUME_ATA | ATA_LFLAG_ASSUME_SEMB,
fd995f70 172 ATA_LFLAG_NO_RETRY = (1 << 5), /* don't retry this link */
f9df58cb 173 ATA_LFLAG_DISABLED = (1 << 6), /* link is disabled */
18f7ba4c 174 ATA_LFLAG_SW_ACTIVITY = (1 << 7), /* keep activity stats */
0c88758b 175
1da177e4 176 /* struct ata_port flags */
949b38af 177 ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */
1da177e4 178 /* (doesn't imply presence) */
949b38af
TH		 179 ATA_FLAG_SATA = (1 << 1),
180 ATA_FLAG_NO_LEGACY = (1 << 2), /* no legacy mode check */
181 ATA_FLAG_MMIO = (1 << 3), /* use MMIO, not PIO */
182 ATA_FLAG_SRST = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */
183 ATA_FLAG_SATA_RESET = (1 << 5), /* (obsolete) use COMRESET */
184 ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */
185 ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */
186 ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */
7395acb2
TH		 187 ATA_FLAG_PIO_POLLING = (1 << 9), /* use polling PIO if LLD
188 * doesn't handle PIO interrupts */
189 ATA_FLAG_NCQ = (1 << 10), /* host supports NCQ */
7395acb2 190 ATA_FLAG_DEBUGMSG = (1 << 13),
b2a8bbe6 191 ATA_FLAG_IGN_SIMPLEX = (1 << 15), /* ignore SIMPLEX */
f834e49f 192 ATA_FLAG_NO_IORDY = (1 << 16), /* controller lacks iordy */
3cadbcc0 193 ATA_FLAG_ACPI_SATA = (1 << 17), /* need native SATA ACPI layout */
9f45cbd3 194 ATA_FLAG_AN = (1 << 18), /* controller supports AN */
e0a71752 195 ATA_FLAG_PMP = (1 << 19), /* controller supports PMP */
ca77329f 196 ATA_FLAG_IPM = (1 << 20), /* driver can handle IPM */
18f7ba4c
KCA		 197 ATA_FLAG_EM = (1 << 21), /* driver supports enclosure
198 * management */
199 ATA_FLAG_SW_ACTIVITY = (1 << 22), /* driver supports sw activity
200 * led */
949b38af 201
b51e9e5d
TH		 202 /* The following flag belongs to ap->pflags but is kept in
203 * ap->flags because it's referenced in many LLDs and will be
204 * removed in not-too-distant future.
205 */
206 ATA_FLAG_DISABLED = (1 << 23), /* port is disabled, ignore it */
207
208 /* bits 24:31 of ap->flags are reserved for LLD specific flags */
9ec957f2 209
b51e9e5d
TH		 210 /* struct ata_port pflags */
211 ATA_PFLAG_EH_PENDING = (1 << 0), /* EH pending */
212 ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */
213 ATA_PFLAG_FROZEN = (1 << 2), /* port is frozen */
214 ATA_PFLAG_RECOVERED = (1 << 3), /* recovery action performed */
215 ATA_PFLAG_LOADING = (1 << 4), /* boot/loading probe */
216 ATA_PFLAG_UNLOADING = (1 << 5), /* module is unloading */
217 ATA_PFLAG_SCSI_HOTPLUG = (1 << 6), /* SCSI hotplug scheduled */
f4d6d004 218 ATA_PFLAG_INITIALIZING = (1 << 7), /* being initialized, don't touch */
afaa5c37 219 ATA_PFLAG_RESETTING = (1 << 8), /* reset in progress */
949b38af 220
b51e9e5d 221 ATA_PFLAG_SUSPENDED = (1 << 17), /* port is suspended (power) */
500530f6 222 ATA_PFLAG_PM_PENDING = (1 << 18), /* PM operation pending */
c05e6ff0 223 ATA_PFLAG_INIT_GTM_VALID = (1 << 19), /* initial gtm data valid */
949b38af
TH		 224
225 /* struct ata_queued_cmd flags */
226 ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */
001102d7 227 ATA_QCFLAG_DMAMAP = (1 << 1), /* SG table is DMA mapped */
27197367 228 ATA_QCFLAG_IO = (1 << 3), /* standard IO command */
e61e0672 229 ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */
da917d69 230 ATA_QCFLAG_CLEAR_EXCL = (1 << 5), /* clear excl_link on completion */
e027bd36 231 ATA_QCFLAG_QUIET = (1 << 6), /* don't report device error */
03faab78 232 ATA_QCFLAG_RETRY = (1 << 7), /* retry after failure */
e61e0672 233
9ec957f2
TH		 234 ATA_QCFLAG_FAILED = (1 << 16), /* cmd failed and is owned by EH */
235 ATA_QCFLAG_SENSE_VALID = (1 << 17), /* sense data valid */
236 ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
1da177e4 237
4e5ec5db 238 /* host set flags */
cca3974e 239 ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host only */
ecef7253 240 ATA_HOST_STARTED = (1 << 1), /* Host started */
9bec2e38 241
b8b275ef
TH		 242 /* bits 24:31 of host->flags are reserved for LLD specific flags */
243
1da177e4 244 /* various lengths of time */
341c2c95
TH		 245 ATA_TMOUT_BOOT = 30000, /* heuristic */
246 ATA_TMOUT_BOOT_QUICK = 7000, /* heuristic */
341c2c95 247 ATA_TMOUT_INTERNAL_QUICK = 5000,
45fabbb7 248 ATA_TMOUT_MAX_PARK = 30000,
1da177e4 249
88ff6eaf
TH		 250 /* FIXME: GoVault needs 2s but we can't afford that without
251 * parallel probing. 800ms is enough for iVDR disk
252 * HHD424020F7SV00. Increase to 2secs when parallel probing
253 * is in place.
254 */
341c2c95 255 ATA_TMOUT_FF_WAIT = 800,
88ff6eaf 256
705e76be
TH		 257 /* Spec mandates to wait for ">= 2ms" before checking status
258 * after reset. We wait 150ms, because that was the magic
259 * delay used for ATAPI devices in Hale Landis's ATADRVR, for
260 * the period of time between when the ATA command register is
261 * written, and then status is checked. Because waiting for
262 * "a while" before checking status is fine, post SRST, we
263 * perform this magic delay here as well.
264 *
265 * Old drivers/ide uses the 2mS rule and then waits for ready.
266 */
341c2c95 267 ATA_WAIT_AFTER_RESET = 150,
705e76be 268
9dadd45b
TH		 269 /* If PMP is supported, we have to do follow-up SRST. As some
270 * PMPs don't send D2H Reg FIS after hardreset, LLDs are
271 * advised to wait only for the following duration before
272 * doing SRST.
273 */
341c2c95 274 ATA_TMOUT_PMP_SRST_WAIT = 1000,
9dadd45b 275
1da177e4
LT		 276 /* ATA bus states */
277 BUS_UNKNOWN = 0,
278 BUS_DMA = 1,
279 BUS_IDLE = 2,
280 BUS_NOINTR = 3,
281 BUS_NODATA = 4,
282 BUS_TIMER = 5,
283 BUS_PIO = 6,
284 BUS_EDD = 7,
285 BUS_IDENTIFY = 8,
286 BUS_PACKET = 9,
287
288 /* SATA port states */
289 PORT_UNKNOWN = 0,
290 PORT_ENABLED = 1,
291 PORT_DISABLED = 2,
292
293 /* encoding various smaller bitmaps into a single
7dc951ae 294 * unsigned long bitmap
1da177e4 295 */
70cd071e
TH		 296 ATA_NR_PIO_MODES = 7,
297 ATA_NR_MWDMA_MODES = 5,
298 ATA_NR_UDMA_MODES = 8,
1da7b0d0
TH		 299
300 ATA_SHIFT_PIO = 0,
70cd071e
TH		 301 ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_NR_PIO_MODES,
302 ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_NR_MWDMA_MODES,
303
cedc9a47
JG		 304 /* size of buffer to pad xfers ending on unaligned boundaries */
305 ATA_DMA_PAD_SZ = 4,
949b38af 306
0c247c55
TH		 307 /* ering size */
308 ATA_ERING_SIZE = 32,
309
31cc23b3
TH		 310 /* return values for ->qc_defer */
311 ATA_DEFER_LINK = 1,
312 ATA_DEFER_PORT = 2,
313
f3e81b19
TH		 314 /* desc_len for ata_eh_info and context */
315 ATA_EH_DESC_LEN = 80,
316
9be1e979
TH		 317 /* reset / recovery action types */
318 ATA_EH_REVALIDATE = (1 << 0),
cf480626
TH		 319 ATA_EH_SOFTRESET = (1 << 1), /* meaningful only in ->prereset */
320 ATA_EH_HARDRESET = (1 << 2), /* meaningful only in ->prereset */
321 ATA_EH_RESET = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
f9df58cb 322 ATA_EH_ENABLE_LINK = (1 << 3),
3ec25ebd 323 ATA_EH_LPM = (1 << 4), /* link power management action */
45fabbb7 324 ATA_EH_PARK = (1 << 5), /* unload heads and stop I/O */
9be1e979 325
45fabbb7 326 ATA_EH_PERDEV_MASK = ATA_EH_REVALIDATE | ATA_EH_PARK,
b5b3fa38
TH		 327 ATA_EH_ALL_ACTIONS = ATA_EH_REVALIDATE | ATA_EH_RESET |
328 ATA_EH_ENABLE_LINK | ATA_EH_LPM,
9be1e979 329
f3e81b19 330 /* ata_eh_info->flags */
abdda733 331 ATA_EHI_HOTPLUGGED = (1 << 0), /* could have been hotplugged */
1cdaf534
TH		 332 ATA_EHI_NO_AUTOPSY = (1 << 2), /* no autopsy */
333 ATA_EHI_QUIET = (1 << 3), /* be quiet */
abdda733 334
0d64a233
TH		 335 ATA_EHI_DID_SOFTRESET = (1 << 16), /* already soft-reset this port */
336 ATA_EHI_DID_HARDRESET = (1 << 17), /* already soft-reset this port */
337 ATA_EHI_PRINTINFO = (1 << 18), /* print configuration info */
338 ATA_EHI_SETMODE = (1 << 19), /* configure transfer mode */
339 ATA_EHI_POST_SETMODE = (1 << 20), /* revaildating after setmode */
f3e81b19 340
0d64a233 341 ATA_EHI_DID_RESET = ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
13abf50d 342
848e4c68
TH		 343 /* mask of flags to transfer *to* the slave link */
344 ATA_EHI_TO_SLAVE_MASK = ATA_EHI_NO_AUTOPSY | ATA_EHI_QUIET,
345
a1e10f7e
TH		 346 /* max tries if error condition is still set after ->error_handler */
347 ATA_EH_MAX_TRIES = 5,
ad9e2762 348
14d2bac1
TH		 349 /* how hard are we gonna try to probe/recover devices */
350 ATA_PROBE_MAX_TRIES = 3,
022bdb07 351 ATA_EH_DEV_TRIES = 3,
e0a71752
TH		 352 ATA_EH_PMP_TRIES = 5,
353 ATA_EH_PMP_LINK_TRIES = 3,
354
bf1bff6f 355 SATA_PMP_RW_TIMEOUT = 3000, /* PMP read/write timeout */
f5914a46 356
87fbc5a0
TH		 357 /* This should match the actual table size of
358 * ata_eh_cmd_timeout_table in libata-eh.c.
359 */
360 ATA_EH_CMD_TIMEOUT_TABLE_SIZE = 5,
361
93590859
AC		 362 /* Horkage types. May be set by libata or controller on drives
363 (some horkage may be drive/controller pair dependant */
364
365 ATA_HORKAGE_DIAGNOSTIC = (1 << 0), /* Failed boot diag */
6919a0a6
AC		 366 ATA_HORKAGE_NODMA = (1 << 1), /* DMA problems */
367 ATA_HORKAGE_NONCQ = (1 << 2), /* Don't use NCQ */
18d6e9d5 368 ATA_HORKAGE_MAX_SEC_128 = (1 << 3), /* Limit max sects to 128 */
16c55b03 369 ATA_HORKAGE_BROKEN_HPA = (1 << 4), /* Broken HPA */
50af2fa1 370 ATA_HORKAGE_DISABLE = (1 << 5), /* Disable it */
93328e11 371 ATA_HORKAGE_HPA_SIZE = (1 << 6), /* native size off by one */
ca77329f 372 ATA_HORKAGE_IPM = (1 << 7), /* Link PM problems */
6bbfd53d 373 ATA_HORKAGE_IVB = (1 << 8), /* cbl det validity bit bugs */
2d3b8eea 374 ATA_HORKAGE_STUCK_ERR = (1 << 9), /* stuck ERR on next PACKET */
9ce8e307 375 ATA_HORKAGE_BRIDGE_OK = (1 << 10), /* no bridge limits */
6a87e42e
TH		 376 ATA_HORKAGE_ATAPI_MOD16_DMA = (1 << 11), /* use ATAPI DMA for commands
377 not multiple of 16 bytes */
b3a70601 378
2dcb407e 379 /* DMA mask for user DMA control: User visible values; DO NOT
b3a70601
AC		 380 renumber */
381 ATA_DMA_MASK_ATA = (1 << 0), /* DMA on ATA Disk */
382 ATA_DMA_MASK_ATAPI = (1 << 1), /* DMA on ATAPI */
383 ATA_DMA_MASK_CFA = (1 << 2), /* DMA on CF Card */
ceb0c642
TH		 384
385 /* ATAPI command types */
386 ATAPI_READ = 0, /* READs */
387 ATAPI_WRITE = 1, /* WRITEs */
388 ATAPI_READ_CD = 2, /* READ CD [MSF] */
e52dcc48
TH		 389 ATAPI_PASS_THRU = 3, /* SAT pass-thru */
390 ATAPI_MISC = 4, /* the rest */
624d5c51
TH		 391
392 /* Timing constants */
393 ATA_TIMING_SETUP = (1 << 0),
394 ATA_TIMING_ACT8B = (1 << 1),
395 ATA_TIMING_REC8B = (1 << 2),
396 ATA_TIMING_CYC8B = (1 << 3),
397 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
398 ATA_TIMING_CYC8B,
399 ATA_TIMING_ACTIVE = (1 << 4),
400 ATA_TIMING_RECOVER = (1 << 5),
401 ATA_TIMING_CYCLE = (1 << 6),
402 ATA_TIMING_UDMA = (1 << 7),
403 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
404 ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
405 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
406 ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
1da177e4
LT		 407};
408
7dc951ae
TH		 409enum ata_xfer_mask {
410 ATA_MASK_PIO = ((1LU << ATA_NR_PIO_MODES) - 1)
411 << ATA_SHIFT_PIO,
412 ATA_MASK_MWDMA = ((1LU << ATA_NR_MWDMA_MODES) - 1)
413 << ATA_SHIFT_MWDMA,
414 ATA_MASK_UDMA = ((1LU << ATA_NR_UDMA_MODES) - 1)
415 << ATA_SHIFT_UDMA,
416};
417
14be71f4 418enum hsm_task_states {
c56b14d2 419 HSM_ST_IDLE, /* no command on going */
71527647
AL		 420 HSM_ST_FIRST, /* (waiting the device to)
421 write CDB or first data block */
c56b14d2
AL		 422 HSM_ST, /* (waiting the device to) transfer data */
423 HSM_ST_LAST, /* (waiting the device to) complete command */
c56b14d2 424 HSM_ST_ERR, /* error */
1da177e4
LT		 425};
426
a7dac447 427enum ata_completion_errors {
11a56d24
TH		 428 AC_ERR_DEV = (1 << 0), /* device reported error */
429 AC_ERR_HSM = (1 << 1), /* host state machine violation */
430 AC_ERR_TIMEOUT = (1 << 2), /* timeout */
431 AC_ERR_MEDIA = (1 << 3), /* media error */
432 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
433 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
434 AC_ERR_SYSTEM = (1 << 6), /* system error */
435 AC_ERR_INVALID = (1 << 7), /* invalid argument */
436 AC_ERR_OTHER = (1 << 8), /* unknown */
55a8e2c8 437 AC_ERR_NODEV_HINT = (1 << 9), /* polling device detection hint */
5335b729 438 AC_ERR_NCQ = (1 << 10), /* marker for offending NCQ qc */
a7dac447
JG		 439};
440
1da177e4
LT		 441/* forward declarations */
442struct scsi_device;
443struct ata_port_operations;
444struct ata_port;
cc0680a5 445struct ata_link;
1da177e4
LT		 446struct ata_queued_cmd;
447
448/* typedefs */
77853bf2 449typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
cc0680a5
TH		 450typedef int (*ata_prereset_fn_t)(struct ata_link *link, unsigned long deadline);
451typedef int (*ata_reset_fn_t)(struct ata_link *link, unsigned int *classes,
d4b2bab4 452 unsigned long deadline);
cc0680a5 453typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes);
1da177e4 454
ca77329f
KCA		 455/*
456 * host pm policy: If you alter this, you also need to alter libata-scsi.c
457 * (for the ascii descriptions)
458 */
459enum link_pm {
460 NOT_AVAILABLE,
461 MIN_POWER,
462 MAX_PERFORMANCE,
463 MEDIUM_POWER,
464};
ee959b00 465extern struct device_attribute dev_attr_link_power_management_policy;
45fabbb7 466extern struct device_attribute dev_attr_unload_heads;
18f7ba4c
KCA		 467extern struct device_attribute dev_attr_em_message_type;
468extern struct device_attribute dev_attr_em_message;
469extern struct device_attribute dev_attr_sw_activity;
470
471enum sw_activity {
472 OFF,
473 BLINK_ON,
474 BLINK_OFF,
475};
ca77329f 476
127102ae 477#ifdef CONFIG_ATA_SFF
1da177e4 478struct ata_ioports {
0d5ff566
TH		 479 void __iomem *cmd_addr;
480 void __iomem *data_addr;
481 void __iomem *error_addr;
482 void __iomem *feature_addr;
483 void __iomem *nsect_addr;
484 void __iomem *lbal_addr;
485 void __iomem *lbam_addr;
486 void __iomem *lbah_addr;
487 void __iomem *device_addr;
488 void __iomem *status_addr;
489 void __iomem *command_addr;
490 void __iomem *altstatus_addr;
491 void __iomem *ctl_addr;
492 void __iomem *bmdma_addr;
493 void __iomem *scr_addr;
1da177e4 494};
127102ae 495#endif /* CONFIG_ATA_SFF */
1da177e4 496
cca3974e 497struct ata_host {
1da177e4
LT		 498 spinlock_t lock;
499 struct device *dev;
0d5ff566 500 void __iomem * const *iomap;
1da177e4
LT		 501 unsigned int n_ports;
502 void *private_data;
029cfd6b 503 struct ata_port_operations *ops;
5444a6f4 504 unsigned long flags;
fafbae87
TH		 505#ifdef CONFIG_ATA_ACPI
506 acpi_handle acpi_handle;
507#endif
032af1ce 508 struct ata_port *simplex_claimed; /* channel owning the DMA */
f0eb62b8 509 struct ata_port *ports[0];
1da177e4
LT		 510};
511
512struct ata_queued_cmd {
513 struct ata_port *ap;
514 struct ata_device *dev;
515
516 struct scsi_cmnd *scsicmd;
517 void (*scsidone)(struct scsi_cmnd *);
518
519 struct ata_taskfile tf;
520 u8 cdb[ATAPI_CDB_LEN];
521
522 unsigned long flags; /* ATA_QCFLAG_xxx */
523 unsigned int tag;
524 unsigned int n_elem;
525
526 int dma_dir;
527
5a5dbd18 528 unsigned int sect_size;
cedc9a47 529
1da177e4 530 unsigned int nbytes;
aacda375 531 unsigned int extrabytes;
1da177e4
LT		 532 unsigned int curbytes;
533
87260216 534 struct scatterlist *cursg;
1da177e4
LT		 535 unsigned int cursg_ofs;
536
537 struct scatterlist sgent;
1da177e4 538
ff2aeb1e 539 struct scatterlist *sg;
1da177e4 540
a22e2eb0 541 unsigned int err_mask;
e61e0672 542 struct ata_taskfile result_tf;
1da177e4
LT		 543 ata_qc_cb_t complete_fn;
544
1da177e4 545 void *private_data;
1c50dc83 546 void *lldd_task;
1da177e4
LT		 547};
548
cca3974e 549struct ata_port_stats {
1da177e4
LT		 550 unsigned long unhandled_irq;
551 unsigned long idle_irq;
552 unsigned long rw_reqbuf;
553};
554
0c247c55 555struct ata_ering_entry {
3884f7b0 556 unsigned int eflags;
0c247c55
TH		 557 unsigned int err_mask;
558 u64 timestamp;
559};
560
561struct ata_ering {
562 int cursor;
563 struct ata_ering_entry ring[ATA_ERING_SIZE];
564};
565
1da177e4 566struct ata_device {
9af5c9c9 567 struct ata_link *link;
72fa4b74 568 unsigned int devno; /* 0 or 1 */
75683fe7 569 unsigned int horkage; /* List of broken features */
6866e7bc 570 unsigned long flags; /* ATA_DFLAG_xxx */
3edebac4 571 struct scsi_device *sdev; /* attached SCSI device */
fafbae87
TH		 572#ifdef CONFIG_ATA_ACPI
573 acpi_handle acpi_handle;
398e0782 574 union acpi_object *gtf_cache;
fafbae87 575#endif
72fa4b74
TH		 576 /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */
577 u64 n_sectors; /* size of device, if ATA */
1da177e4 578 unsigned int class; /* ATA_DEV_xxx */
45fabbb7 579 unsigned long unpark_deadline;
e0a71752 580
1da177e4
LT		 581 u8 pio_mode;
582 u8 dma_mode;
583 u8 xfer_mode;
584 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
585
8cbd6df1
AL		 586 unsigned int multi_count; /* sectors count for
587 READ/WRITE MULTIPLE */
b00eec1d 588 unsigned int max_sectors; /* per-device max sectors */
6e7846e9 589 unsigned int cdb_len;
8bf62ece 590
acf356b1 591 /* per-dev xfer mask */
7dc951ae
TH		 592 unsigned long pio_mask;
593 unsigned long mwdma_mask;
594 unsigned long udma_mask;
acf356b1 595
8bf62ece
AL		 596 /* for CHS addressing */
597 u16 cylinders; /* Number of cylinders */
598 u16 heads; /* Number of heads */
599 u16 sectors; /* Number of sectors per track */
0c247c55
TH		 600
601 /* error history */
7d47e8d4 602 int spdn_cnt;
f7e98930
JG		 603 struct ata_ering ering;
604
605 union {
606 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
607 u32 gscr[SATA_PMP_GSCR_DWORDS]; /* PMP GSCR block */
608 };
1da177e4
LT		 609};
610
72fa4b74
TH		 611/* Offset into struct ata_device. Fields above it are maintained
612 * acress device init. Fields below are zeroed.
613 */
614#define ATA_DEVICE_CLEAR_OFFSET offsetof(struct ata_device, n_sectors)
615
f3e81b19
TH		 616struct ata_eh_info {
617 struct ata_device *dev; /* offending device */
618 u32 serror; /* SError from LLDD */
619 unsigned int err_mask; /* port-wide err_mask */
620 unsigned int action; /* ATA_EH_* action mask */
47005f25 621 unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */
f3e81b19 622 unsigned int flags; /* ATA_EHI_* flags */
abdda733 623
abdda733
TH		 624 unsigned int probe_mask;
625
f3e81b19
TH		 626 char desc[ATA_EH_DESC_LEN];
627 int desc_len;
628};
629
630struct ata_eh_context {
631 struct ata_eh_info i;
632 int tries[ATA_MAX_DEVICES];
87fbc5a0
TH		 633 int cmd_timeout_idx[ATA_MAX_DEVICES]
634 [ATA_EH_CMD_TIMEOUT_TABLE_SIZE];
abdda733
TH		 635 unsigned int classes[ATA_MAX_DEVICES];
636 unsigned int did_probe_mask;
45fabbb7 637 unsigned int unloaded_mask;
00115e0f
TH		 638 unsigned int saved_ncq_enabled;
639 u8 saved_xfer_mode[ATA_MAX_DEVICES];
0a2c0f56
TH		 640 /* timestamp for the last reset attempt or success */
641 unsigned long last_reset;
f3e81b19
TH		 642};
643
64578a3d
TH		 644struct ata_acpi_drive
645{
646 u32 pio;
647 u32 dma;
648} __packed;
649
650struct ata_acpi_gtm {
651 struct ata_acpi_drive drive[2];
652 u32 flags;
653} __packed;
654
9af5c9c9
TH		 655struct ata_link {
656 struct ata_port *ap;
8989805d 657 int pmp; /* port multiplier port # */
9af5c9c9
TH		 658
659 unsigned int active_tag; /* active tag on this link */
660 u32 sactive; /* active NCQ commands */
661
0c88758b
TH		 662 unsigned int flags; /* ATA_LFLAG_xxx */
663
d127ea7b 664 u32 saved_scontrol; /* SControl on probe */
9af5c9c9
TH		 665 unsigned int hw_sata_spd_limit;
666 unsigned int sata_spd_limit;
667 unsigned int sata_spd; /* current SATA PHY speed */
668
669 /* record runtime error info, protected by host_set lock */
670 struct ata_eh_info eh_info;
671 /* EH context */
672 struct ata_eh_context eh_context;
673
674 struct ata_device device[ATA_MAX_DEVICES];
675};
676
1da177e4 677struct ata_port {
cca3974e 678 struct Scsi_Host *scsi_host; /* our co-allocated scsi host */
029cfd6b 679 struct ata_port_operations *ops;
ba6a1308 680 spinlock_t *lock;
1da177e4 681 unsigned long flags; /* ATA_FLAG_xxx */
b51e9e5d 682 unsigned int pflags; /* ATA_PFLAG_xxx */
44877b4e
TH		 683 unsigned int print_id; /* user visible unique port ID */
684 unsigned int port_no; /* 0 based port no. inside the host */
1da177e4
LT		 685
686 struct ata_prd *prd; /* our SG list */
687 dma_addr_t prd_dma; /* and its DMA mapping */
688
127102ae 689#ifdef CONFIG_ATA_SFF
1da177e4 690 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
127102ae 691#endif /* CONFIG_ATA_SFF */
1da177e4
LT		 692
693 u8 ctl; /* cache of ATA control register */
694 u8 last_ctl; /* Cache last written value */
1da177e4
LT		 695 unsigned int pio_mask;
696 unsigned int mwdma_mask;
697 unsigned int udma_mask;
698 unsigned int cbl; /* cable type; ATA_CBL_xxx */
1da177e4
LT		 699
700 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
8a8bc223 701 unsigned long qc_allocated;
dedaf2b0 702 unsigned int qc_active;
da917d69 703 int nr_active_links; /* #links with active qcs */
dedaf2b0 704
b1c72916
TH		 705 struct ata_link link; /* host default link */
706 struct ata_link *slave_link; /* see ata_slave_link_init() */
1da177e4 707
8989805d
TH		 708 int nr_pmp_links; /* nr of available PMP links */
709 struct ata_link *pmp_link; /* array of PMP links */
da917d69 710 struct ata_link *excl_link; /* for PMP qc exclusion */
8989805d 711
cca3974e
JG		 712 struct ata_port_stats stats;
713 struct ata_host *host;
2f1f610b 714 struct device *dev;
1da177e4 715
65f27f38 716 void *port_task_data;
52bad64d
DH		 717 struct delayed_work port_task;
718 struct delayed_work hotplug_task;
3b01b8af 719 struct work_struct scsi_rescan_task;
86e45b6b 720
14be71f4 721 unsigned int hsm_task_state;
1da177e4 722
bfd60579 723 u32 msg_enable;
a72ec4ce 724 struct list_head eh_done_q;
c6cf9e99 725 wait_queue_head_t eh_wait_q;
a1e10f7e 726 int eh_tries;
45fabbb7 727 struct completion park_req_pending;
bfd60579 728
500530f6
TH		 729 pm_message_t pm_mesg;
730 int *pm_result;
ca77329f 731 enum link_pm pm_policy;
500530f6 732
5ddf24c5
TH		 733 struct timer_list fastdrain_timer;
734 unsigned long fastdrain_cnt;
735
18f7ba4c 736 int em_message_type;
1da177e4 737 void *private_data;
fe635c7e 738
fafbae87
TH		 739#ifdef CONFIG_ATA_ACPI
740 acpi_handle acpi_handle;
c05e6ff0 741 struct ata_acpi_gtm __acpi_init_gtm; /* use ata_acpi_init_gtm() */
fafbae87 742#endif
fe635c7e 743 u8 sector_buf[ATA_SECT_SIZE]; /* owned by EH */
1da177e4
LT		 744};
745
029cfd6b
TH		 746/* The following initializer overrides a method to NULL whether one of
747 * its parent has the method defined or not. This is equivalent to
748 * ERR_PTR(-ENOENT). Unfortunately, ERR_PTR doesn't render a constant
749 * expression and thus can't be used as an initializer.
750 */
751#define ATA_OP_NULL (void *)(unsigned long)(-ENOENT)
752
1da177e4 753struct ata_port_operations {
c1bc899f
TH		 754 /*
755 * Command execution
756 */
757 int (*qc_defer)(struct ata_queued_cmd *qc);
758 int (*check_atapi_dma)(struct ata_queued_cmd *qc);
759 void (*qc_prep)(struct ata_queued_cmd *qc);
760 unsigned int (*qc_issue)(struct ata_queued_cmd *qc);
22183bf5 761 bool (*qc_fill_rtf)(struct ata_queued_cmd *qc);
1da177e4 762
c1bc899f
TH		 763 /*
764 * Configuration and exception handling
765 */
766 int (*cable_detect)(struct ata_port *ap);
767 unsigned long (*mode_filter)(struct ata_device *dev, unsigned long xfer_mask);
768 void (*set_piomode)(struct ata_port *ap, struct ata_device *dev);
769 void (*set_dmamode)(struct ata_port *ap, struct ata_device *dev);
770 int (*set_mode)(struct ata_link *link, struct ata_device **r_failed_dev);
963e4975 771 unsigned int (*read_id)(struct ata_device *dev, struct ata_taskfile *tf, u16 *id);
1da177e4 772
c1bc899f 773 void (*dev_config)(struct ata_device *dev);
1da177e4 774
c1bc899f
TH		 775 void (*freeze)(struct ata_port *ap);
776 void (*thaw)(struct ata_port *ap);
a1efdaba
TH		 777 ata_prereset_fn_t prereset;
778 ata_reset_fn_t softreset;
779 ata_reset_fn_t hardreset;
780 ata_postreset_fn_t postreset;
781 ata_prereset_fn_t pmp_prereset;
782 ata_reset_fn_t pmp_softreset;
783 ata_reset_fn_t pmp_hardreset;
784 ata_postreset_fn_t pmp_postreset;
c1bc899f
TH		 785 void (*error_handler)(struct ata_port *ap);
786 void (*post_internal_cmd)(struct ata_queued_cmd *qc);
787
788 /*
789 * Optional features
790 */
82ef04fb
TH		 791 int (*scr_read)(struct ata_link *link, unsigned int sc_reg, u32 *val);
792 int (*scr_write)(struct ata_link *link, unsigned int sc_reg, u32 val);
c1bc899f
TH		 793 void (*pmp_attach)(struct ata_port *ap);
794 void (*pmp_detach)(struct ata_port *ap);
795 int (*enable_pm)(struct ata_port *ap, enum link_pm policy);
796 void (*disable_pm)(struct ata_port *ap);
797
798 /*
799 * Start, stop, suspend and resume
800 */
801 int (*port_suspend)(struct ata_port *ap, pm_message_t mesg);
802 int (*port_resume)(struct ata_port *ap);
803 int (*port_start)(struct ata_port *ap);
804 void (*port_stop)(struct ata_port *ap);
805 void (*host_stop)(struct ata_host *host);
806
127102ae 807#ifdef CONFIG_ATA_SFF
c1bc899f
TH		 808 /*
809 * SFF / taskfile oriented ops
810 */
5682ed33
TH		 811 void (*sff_dev_select)(struct ata_port *ap, unsigned int device);
812 u8 (*sff_check_status)(struct ata_port *ap);
813 u8 (*sff_check_altstatus)(struct ata_port *ap);
814 void (*sff_tf_load)(struct ata_port *ap, const struct ata_taskfile *tf);
815 void (*sff_tf_read)(struct ata_port *ap, struct ata_taskfile *tf);
816 void (*sff_exec_command)(struct ata_port *ap,
817 const struct ata_taskfile *tf);
818 unsigned int (*sff_data_xfer)(struct ata_device *dev,
819 unsigned char *buf, unsigned int buflen, int rw);
820 u8 (*sff_irq_on)(struct ata_port *);
821 void (*sff_irq_clear)(struct ata_port *);
822
c1bc899f
TH		 823 void (*bmdma_setup)(struct ata_queued_cmd *qc);
824 void (*bmdma_start)(struct ata_queued_cmd *qc);
825 void (*bmdma_stop)(struct ata_queued_cmd *qc);
826 u8 (*bmdma_status)(struct ata_port *ap);
127102ae 827#endif /* CONFIG_ATA_SFF */
c1bc899f 828
18f7ba4c
KCA		 829 ssize_t (*em_show)(struct ata_port *ap, char *buf);
830 ssize_t (*em_store)(struct ata_port *ap, const char *message,
831 size_t size);
832 ssize_t (*sw_activity_show)(struct ata_device *dev, char *buf);
833 ssize_t (*sw_activity_store)(struct ata_device *dev,
834 enum sw_activity val);
c1bc899f
TH		 835 /*
836 * Obsolete
9ec957f2 837 */
c1bc899f
TH		 838 void (*phy_reset)(struct ata_port *ap);
839 void (*eng_timeout)(struct ata_port *ap);
029cfd6b
TH		 840
841 /*
842 * ->inherits must be the last field and all the preceding
843 * fields must be pointers.
844 */
845 const struct ata_port_operations *inherits;
1da177e4
LT		 846};
847
848struct ata_port_info {
cca3974e 849 unsigned long flags;
0c88758b 850 unsigned long link_flags;
1da177e4
LT		 851 unsigned long pio_mask;
852 unsigned long mwdma_mask;
853 unsigned long udma_mask;
029cfd6b 854 struct ata_port_operations *port_ops;
e99f8b5e 855 void *private_data;
1da177e4
LT		 856};
857
452503f9
AC		 858struct ata_timing {
859 unsigned short mode; /* ATA mode */
860 unsigned short setup; /* t1 */
861 unsigned short act8b; /* t2 for 8-bit I/O */
862 unsigned short rec8b; /* t2i for 8-bit I/O */
863 unsigned short cyc8b; /* t0 for 8-bit I/O */
864 unsigned short active; /* t2 or tD */
865 unsigned short recover; /* t2i or tK */
866 unsigned short cycle; /* t0 */
867 unsigned short udma; /* t2CYCTYP/2 */
868};
869
624d5c51
TH		 870/*
871 * Core layer - drivers/ata/libata-core.c
872 */
e9c83914
TH		 873extern const unsigned long sata_deb_timing_normal[];
874extern const unsigned long sata_deb_timing_hotplug[];
875extern const unsigned long sata_deb_timing_long[];
876
029cfd6b 877extern struct ata_port_operations ata_dummy_port_ops;
21b0ad4f 878extern const struct ata_port_info ata_dummy_port_info;
dd5b06c4 879
e9c83914
TH		 880static inline const unsigned long *
881sata_ehc_deb_timing(struct ata_eh_context *ehc)
882{
883 if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
884 return sata_deb_timing_hotplug;
885 else
886 return sata_deb_timing_normal;
887}
d7bb4cc7 888
dd5b06c4
TH		 889static inline int ata_port_is_dummy(struct ata_port *ap)
890{
891 return ap->ops == &ata_dummy_port_ops;
892}
893
1da177e4 894extern void ata_port_probe(struct ata_port *);
936fd732 895extern int sata_set_spd(struct ata_link *link);
0aa1113d 896extern int ata_std_prereset(struct ata_link *link, unsigned long deadline);
aa2731ad
TH		 897extern int ata_wait_after_reset(struct ata_link *link, unsigned long deadline,
898 int (*check_ready)(struct ata_link *link));
936fd732
TH		 899extern int sata_link_debounce(struct ata_link *link,
900 const unsigned long *params, unsigned long deadline);
901extern int sata_link_resume(struct ata_link *link, const unsigned long *params,
902 unsigned long deadline);
cc0680a5 903extern int sata_link_hardreset(struct ata_link *link,
9dadd45b
TH		 904 const unsigned long *timing, unsigned long deadline,
905 bool *online, int (*check_ready)(struct ata_link *));
57c9efdf
TH		 906extern int sata_std_hardreset(struct ata_link *link, unsigned int *class,
907 unsigned long deadline);
203c75b8 908extern void ata_std_postreset(struct ata_link *link, unsigned int *classes);
1da177e4 909extern void ata_port_disable(struct ata_port *);
2855568b 910
f3187195 911extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
f5cda257
TH		 912extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
913 const struct ata_port_info * const * ppi, int n_ports);
b1c72916 914extern int ata_slave_link_init(struct ata_port *ap);
ecef7253 915extern int ata_host_start(struct ata_host *host);
f3187195
TH		 916extern int ata_host_register(struct ata_host *host,
917 struct scsi_host_template *sht);
f5cda257
TH		 918extern int ata_host_activate(struct ata_host *host, int irq,
919 irq_handler_t irq_handler, unsigned long irq_flags,
920 struct scsi_host_template *sht);
0529c159 921extern void ata_host_detach(struct ata_host *host);
cca3974e 922extern void ata_host_init(struct ata_host *, struct device *,
029cfd6b 923 unsigned long, struct ata_port_operations *);
193515d5 924extern int ata_scsi_detect(struct scsi_host_template *sht);
1da177e4
LT		 925extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
926extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
80289167 927extern void ata_sas_port_destroy(struct ata_port *);
cca3974e 928extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
80289167
BK		 929 struct ata_port_info *, struct Scsi_Host *);
930extern int ata_sas_port_init(struct ata_port *);
931extern int ata_sas_port_start(struct ata_port *ap);
932extern void ata_sas_port_stop(struct ata_port *ap);
933extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
934extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
935 struct ata_port *ap);
936fd732
TH		 936extern int sata_scr_valid(struct ata_link *link);
937extern int sata_scr_read(struct ata_link *link, int reg, u32 *val);
938extern int sata_scr_write(struct ata_link *link, int reg, u32 val);
939extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val);
b5b3fa38
TH		 940extern bool ata_link_online(struct ata_link *link);
941extern bool ata_link_offline(struct ata_link *link);
6ffa01d8 942#ifdef CONFIG_PM
cca3974e
JG		 943extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
944extern void ata_host_resume(struct ata_host *host);
6ffa01d8 945#endif
67846b30 946extern int ata_ratelimit(void);
c22daff4 947extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
341c2c95 948 unsigned long interval, unsigned long timeout);
436d34b3 949extern int atapi_cmd_type(u8 opcode);
9977126c
TH		 950extern void ata_tf_to_fis(const struct ata_taskfile *tf,
951 u8 pmp, int is_cmd, u8 *fis);
057ace5e 952extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
7dc951ae
TH		 953extern unsigned long ata_pack_xfermask(unsigned long pio_mask,
954 unsigned long mwdma_mask, unsigned long udma_mask);
955extern void ata_unpack_xfermask(unsigned long xfer_mask,
956 unsigned long *pio_mask, unsigned long *mwdma_mask,
957 unsigned long *udma_mask);
958extern u8 ata_xfer_mask2mode(unsigned long xfer_mask);
959extern unsigned long ata_xfer_mode2mask(u8 xfer_mode);
960extern int ata_xfer_mode2shift(unsigned long xfer_mode);
961extern const char *ata_mode_string(unsigned long xfer_mask);
962extern unsigned long ata_id_xfermask(const u16 *id);
2dcb407e 963extern int ata_port_start(struct ata_port *ap);
31cc23b3 964extern int ata_std_qc_defer(struct ata_queued_cmd *qc);
e46834cd 965extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
1da177e4
LT		 966extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
967 unsigned int n_elem);
057ace5e 968extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
10305f0f 969extern void ata_dev_disable(struct ata_device *adev);
6a62a04d
TH		 970extern void ata_id_string(const u16 *id, unsigned char *s,
971 unsigned int ofs, unsigned int len);
972extern void ata_id_c_string(const u16 *id, unsigned char *s,
973 unsigned int ofs, unsigned int len);
963e4975
AC		 974extern unsigned int ata_do_dev_read_id(struct ata_device *dev,
975 struct ata_taskfile *tf, u16 *id);
f686bcb8 976extern void ata_qc_complete(struct ata_queued_cmd *qc);
79f97dad 977extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active);
3373efd8 978extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
1da177e4
LT		 979 void (*done)(struct scsi_cmnd *));
980extern int ata_std_bios_param(struct scsi_device *sdev,
981 struct block_device *bdev,
982 sector_t capacity, int geom[]);
983extern int ata_scsi_slave_config(struct scsi_device *sdev);
83c47bcb 984extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
a6e6ce8e
TH		 985extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
986 int queue_depth);
3373efd8 987extern struct ata_device *ata_dev_pair(struct ata_device *adev);
0260731f 988extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
1da177e4 989
be0d18df
AC		 990extern int ata_cable_40wire(struct ata_port *ap);
991extern int ata_cable_80wire(struct ata_port *ap);
992extern int ata_cable_sata(struct ata_port *ap);
c88f90c3 993extern int ata_cable_ignore(struct ata_port *ap);
be0d18df
AC		 994extern int ata_cable_unknown(struct ata_port *ap);
995
624d5c51 996/* Timing helpers */
1bc4ccff 997extern unsigned int ata_pio_need_iordy(const struct ata_device *);
6357357c 998extern const struct ata_timing *ata_timing_find_mode(u8 xfer_mode);
452503f9
AC		 999extern int ata_timing_compute(struct ata_device *, unsigned short,
1000 struct ata_timing *, int, int);
1001extern void ata_timing_merge(const struct ata_timing *,
1002 const struct ata_timing *, struct ata_timing *,
1003 unsigned int);
a0f79b92 1004extern u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle);
452503f9 1005
624d5c51
TH		 1006/* PCI */
1007#ifdef CONFIG_PCI
1008struct pci_dev;
1009
1010struct pci_bits {
1011 unsigned int reg; /* PCI config register to read */
1012 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
1013 unsigned long mask;
1014 unsigned long val;
452503f9
AC		 1015};
1016
624d5c51
TH		 1017extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
1018extern void ata_pci_remove_one(struct pci_dev *pdev);
1019
1020#ifdef CONFIG_PM
1021extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
1022extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
1023extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
1024extern int ata_pci_device_resume(struct pci_dev *pdev);
1025#endif /* CONFIG_PM */
1026#endif /* CONFIG_PCI */
1027
1028/*
1029 * ACPI - drivers/ata/libata-acpi.c
1030 */
e1ddb4b6 1031#ifdef CONFIG_ATA_ACPI
c05e6ff0
TH		 1032static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1033{
1034 if (ap->pflags & ATA_PFLAG_INIT_GTM_VALID)
1035 return &ap->__acpi_init_gtm;
1036 return NULL;
1037}
0d02f0b2
TH		 1038int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm);
1039int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *stm);
7c77fa4d
TH		 1040unsigned long ata_acpi_gtm_xfermask(struct ata_device *dev,
1041 const struct ata_acpi_gtm *gtm);
021ee9a6 1042int ata_acpi_cbl_80wire(struct ata_port *ap, const struct ata_acpi_gtm *gtm);
e1ddb4b6 1043#else
c05e6ff0
TH		 1044static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1045{
1046 return NULL;
1047}
7c77fa4d
TH		 1048
1049static inline int ata_acpi_stm(const struct ata_port *ap,
1050 struct ata_acpi_gtm *stm)
1051{
1052 return -ENOSYS;
1053}
1054
1055static inline int ata_acpi_gtm(const struct ata_port *ap,
1056 struct ata_acpi_gtm *stm)
1057{
1058 return -ENOSYS;
1059}
1060
1061static inline unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev,
1062 const struct ata_acpi_gtm *gtm)
1063{
1064 return 0;
1065}
021ee9a6
TH		 1066
1067static inline int ata_acpi_cbl_80wire(struct ata_port *ap,
1068 const struct ata_acpi_gtm *gtm)
1069{
1070 return 0;
1071}
e1ddb4b6 1072#endif
1da177e4 1073
ece1d636 1074/*
624d5c51 1075 * EH - drivers/ata/libata-eh.c
ece1d636 1076 */
7b70fc03 1077extern void ata_port_schedule_eh(struct ata_port *ap);
dbd82616 1078extern int ata_link_abort(struct ata_link *link);
7b70fc03 1079extern int ata_port_abort(struct ata_port *ap);
e3180499 1080extern int ata_port_freeze(struct ata_port *ap);
7d77b247 1081extern int sata_async_notification(struct ata_port *ap);
e3180499
TH		 1082
1083extern void ata_eh_freeze_port(struct ata_port *ap);
1084extern void ata_eh_thaw_port(struct ata_port *ap);
7b70fc03 1085
ece1d636
TH		 1086extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
1087extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
10acf3b0 1088extern void ata_eh_analyze_ncq_error(struct ata_link *link);
ece1d636 1089
f5914a46
TH		 1090extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
1091 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
1092 ata_postreset_fn_t postreset);
a1efdaba 1093extern void ata_std_error_handler(struct ata_port *ap);
022bdb07 1094
68d1d07b
TH		 1095/*
1096 * Base operations to inherit from and initializers for sht
1097 *
1098 * Operations
1099 *
1100 * base : Common to all libata drivers.
1101 * sata : SATA controllers w/ native interface.
1102 * pmp : SATA controllers w/ PMP support.
1103 * sff : SFF ATA controllers w/o BMDMA support.
1104 * bmdma : SFF ATA controllers w/ BMDMA support.
1105 *
1106 * sht initializers
1107 *
1108 * BASE : Common to all libata drivers. The user must set
1109 * sg_tablesize and dma_boundary.
1110 * PIO : SFF ATA controllers w/ only PIO support.
1111 * BMDMA : SFF ATA controllers w/ BMDMA support. sg_tablesize and
1112 * dma_boundary are set to BMDMA limits.
1113 * NCQ : SATA controllers supporting NCQ. The user must set
1114 * sg_tablesize, dma_boundary and can_queue.
1115 */
1116extern const struct ata_port_operations ata_base_port_ops;
1117extern const struct ata_port_operations sata_port_ops;
45fabbb7 1118extern struct device_attribute *ata_common_sdev_attrs[];
68d1d07b
TH		 1119
1120#define ATA_BASE_SHT(drv_name) \
1121 .module = THIS_MODULE, \
1122 .name = drv_name, \
1123 .ioctl = ata_scsi_ioctl, \
1124 .queuecommand = ata_scsi_queuecmd, \
1125 .can_queue = ATA_DEF_QUEUE, \
1126 .this_id = ATA_SHT_THIS_ID, \
1127 .cmd_per_lun = ATA_SHT_CMD_PER_LUN, \
1128 .emulated = ATA_SHT_EMULATED, \
1129 .use_clustering = ATA_SHT_USE_CLUSTERING, \
1130 .proc_name = drv_name, \
1131 .slave_configure = ata_scsi_slave_config, \
1132 .slave_destroy = ata_scsi_slave_destroy, \
45fabbb7
EO		 1133 .bios_param = ata_std_bios_param, \
1134 .sdev_attrs = ata_common_sdev_attrs
68d1d07b 1135
68d1d07b
TH		 1136#define ATA_NCQ_SHT(drv_name) \
1137 ATA_BASE_SHT(drv_name), \
1138 .change_queue_depth = ata_scsi_change_queue_depth
1139
071f44b1
TH		 1140/*
1141 * PMP helpers
1142 */
88fcd562 1143#ifdef CONFIG_SATA_PMP
071f44b1
TH		 1144static inline bool sata_pmp_supported(struct ata_port *ap)
1145{
1146 return ap->flags & ATA_FLAG_PMP;
1147}
1148
1149static inline bool sata_pmp_attached(struct ata_port *ap)
1150{
1151 return ap->nr_pmp_links != 0;
1152}
1153
1154static inline int ata_is_host_link(const struct ata_link *link)
1155{
b1c72916 1156 return link == &link->ap->link || link == link->ap->slave_link;
071f44b1 1157}
88fcd562
TH		 1158#else /* CONFIG_SATA_PMP */
1159static inline bool sata_pmp_supported(struct ata_port *ap)
1160{
1161 return false;
1162}
1163
1164static inline bool sata_pmp_attached(struct ata_port *ap)
1165{
1166 return false;
1167}
1168
1169static inline int ata_is_host_link(const struct ata_link *link)
1170{
1171 return 1;
1172}
1173#endif /* CONFIG_SATA_PMP */
071f44b1
TH		 1174
1175static inline int sata_srst_pmp(struct ata_link *link)
1176{
1177 if (sata_pmp_supported(link->ap) && ata_is_host_link(link))
1178 return SATA_PMP_CTRL_PORT;
1179 return link->pmp;
1180}
1181
61440db6
TH		 1182/*
1183 * printk helpers
1184 */
1185#define ata_port_printk(ap, lv, fmt, args...) \
c2e366a1 1186 printk("%sata%u: "fmt, lv, (ap)->print_id , ##args)
61440db6 1187
8989805d 1188#define ata_link_printk(link, lv, fmt, args...) do { \
b1c72916 1189 if (sata_pmp_attached((link)->ap) || (link)->ap->slave_link) \
c2e366a1 1190 printk("%sata%u.%02u: "fmt, lv, (link)->ap->print_id, \
8989805d
TH		 1191 (link)->pmp , ##args); \
1192 else \
c2e366a1 1193 printk("%sata%u: "fmt, lv, (link)->ap->print_id , ##args); \
8989805d 1194 } while(0)
9af5c9c9 1195
61440db6 1196#define ata_dev_printk(dev, lv, fmt, args...) \
c2e366a1 1197 printk("%sata%u.%02u: "fmt, lv, (dev)->link->ap->print_id, \
8989805d 1198 (dev)->link->pmp + (dev)->devno , ##args)
1da177e4 1199
f3e81b19
TH		 1200/*
1201 * ata_eh_info helpers
1202 */
cb94c1cf
TH		 1203extern void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...)
1204 __attribute__ ((format (printf, 2, 3)));
1205extern void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...)
1206 __attribute__ ((format (printf, 2, 3)));
b64bbc39 1207extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
f3e81b19 1208
c0b6c037
TH		 1209static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
1210{
b558eddd 1211 ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
f8f1e1cc 1212 ehi->flags |= ATA_EHI_HOTPLUGGED;
b558eddd 1213 ehi->action |= ATA_EH_RESET | ATA_EH_ENABLE_LINK;
c0b6c037
TH		 1214 ehi->err_mask |= AC_ERR_ATA_BUS;
1215}
1216
cbcdd875
TH		 1217/*
1218 * port description helpers
1219 */
1220extern void ata_port_desc(struct ata_port *ap, const char *fmt, ...)
1221 __attribute__ ((format (printf, 2, 3)));
1222#ifdef CONFIG_PCI
1223extern void ata_port_pbar_desc(struct ata_port *ap, int bar, ssize_t offset,
1224 const char *name);
1225#endif
1226
1da177e4
LT		 1227static inline unsigned int ata_tag_valid(unsigned int tag)
1228{
1229 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
1230}
1231
2ab7db1f
TH		 1232static inline unsigned int ata_tag_internal(unsigned int tag)
1233{
83c063dd 1234 return tag == ATA_TAG_INTERNAL;
2ab7db1f
TH		 1235}
1236
5806db22
TH		 1237/*
1238 * device helpers
1239 */
e1211e3f 1240static inline unsigned int ata_class_enabled(unsigned int class)
597afd21 1241{
e0a71752
TH		 1242 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI ||
1243 class == ATA_DEV_PMP || class == ATA_DEV_SEMB;
597afd21
TH		 1244}
1245
e1211e3f 1246static inline unsigned int ata_class_disabled(unsigned int class)
1da177e4 1247{
e0a71752
TH		 1248 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP ||
1249 class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP;
e1211e3f
TH		 1250}
1251
002c8054
TH		 1252static inline unsigned int ata_class_absent(unsigned int class)
1253{
1254 return !ata_class_enabled(class) && !ata_class_disabled(class);
1255}
1256
e1211e3f
TH		 1257static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1258{
1259 return ata_class_enabled(dev->class);
1260}
1261
1262static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1263{
1264 return ata_class_disabled(dev->class);
1da177e4
LT		 1265}
1266
002c8054
TH		 1267static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1268{
1269 return ata_class_absent(dev->class);
1270}
1271
5806db22 1272/*
f58229f8 1273 * link helpers
5806db22 1274 */
f58229f8 1275static inline int ata_link_max_devices(const struct ata_link *link)
5806db22 1276{
8989805d 1277 if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS)
5806db22
TH		 1278 return 2;
1279 return 1;
1280}
1281
da917d69
TH		 1282static inline int ata_link_active(struct ata_link *link)
1283{
1284 return ata_tag_valid(link->active_tag) || link->sactive;
1285}
1286
aadffb68
TH		 1287extern struct ata_link *__ata_port_next_link(struct ata_port *ap,
1288 struct ata_link *link,
1289 bool dev_only);
8989805d 1290
aadffb68
TH		 1291#define __ata_port_for_each_link(link, ap) \
1292 for ((link) = __ata_port_next_link((ap), NULL, false); (link); \
1293 (link) = __ata_port_next_link((ap), (link), false))
8989805d
TH		 1294
1295#define ata_port_for_each_link(link, ap) \
aadffb68
TH		 1296 for ((link) = __ata_port_next_link((ap), NULL, true); (link); \
1297 (link) = __ata_port_next_link((ap), (link), true))
f58229f8
TH		 1298
1299#define ata_link_for_each_dev(dev, link) \
1300 for ((dev) = (link)->device; \
1301 (dev) < (link)->device + ata_link_max_devices(link) || ((dev) = NULL); \
1302 (dev)++)
1303
1304#define ata_link_for_each_dev_reverse(dev, link) \
1305 for ((dev) = (link)->device + ata_link_max_devices(link) - 1; \
1306 (dev) >= (link)->device || ((dev) = NULL); (dev)--)
5806db22 1307
6d1245bf
TH		 1308/**
1309 * ata_ncq_enabled - Test whether NCQ is enabled
1310 * @dev: ATA device to test for
1311 *
1312 * LOCKING:
1313 * spin_lock_irqsave(host lock)
1314 *
1315 * RETURNS:
1316 * 1 if NCQ is enabled for @dev, 0 otherwise.
1317 */
1318static inline int ata_ncq_enabled(struct ata_device *dev)
1319{
1320 return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1321 ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1322}
0baab86b 1323
1da177e4
LT		 1324static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1325{
1326 qc->tf.ctl |= ATA_NIEN;
1327}
1328
f69499f4
TH		 1329static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1330 unsigned int tag)
1da177e4
LT		 1331{
1332 if (likely(ata_tag_valid(tag)))
1333 return &ap->qcmd[tag];
1334 return NULL;
1335}
1336
f69499f4
TH		 1337static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1338 unsigned int tag)
1339{
1340 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1341
1342 if (unlikely(!qc) || !ap->ops->error_handler)
1343 return qc;
1344
1345 if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1346 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1347 return qc;
1348
1349 return NULL;
1350}
1351
aacda375
TH		 1352static inline unsigned int ata_qc_raw_nbytes(struct ata_queued_cmd *qc)
1353{
1354 return qc->nbytes - min(qc->extrabytes, qc->nbytes);
1355}
1356
3373efd8 1357static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1da177e4
LT		 1358{
1359 memset(tf, 0, sizeof(*tf));
1360
9af5c9c9 1361 tf->ctl = dev->link->ap->ctl;
3373efd8 1362 if (dev->devno == 0)
1da177e4
LT		 1363 tf->device = ATA_DEVICE_OBS;
1364 else
1365 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1366}
1367
2c13b7ce
JG		 1368static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1369{
501e0c50 1370 qc->dma_dir = DMA_NONE;
ff2aeb1e 1371 qc->sg = NULL;
2c13b7ce 1372 qc->flags = 0;
87260216
JA		 1373 qc->cursg = NULL;
1374 qc->cursg_ofs = 0;
aacda375 1375 qc->nbytes = qc->extrabytes = qc->curbytes = 0;
7a801184 1376 qc->n_elem = 0;
a22e2eb0 1377 qc->err_mask = 0;
5a5dbd18 1378 qc->sect_size = ATA_SECT_SIZE;
2c13b7ce 1379
3373efd8 1380 ata_tf_init(qc->dev, &qc->tf);
e61e0672
TH		 1381
1382 /* init result_tf such that it indicates normal completion */
1383 qc->result_tf.command = ATA_DRDY;
1384 qc->result_tf.feature = 0;
2c13b7ce
JG		 1385}
1386
057ace5e 1387static inline int ata_try_flush_cache(const struct ata_device *dev)
1da177e4
LT		 1388{
1389 return ata_id_wcache_enabled(dev->id) ||
1390 ata_id_has_flush(dev->id) ||
1391 ata_id_has_flush_ext(dev->id);
1392}
1393
a7dac447
JG		 1394static inline unsigned int ac_err_mask(u8 status)
1395{
3655d1d3 1396 if (status & (ATA_BUSY | ATA_DRQ))
11a56d24 1397 return AC_ERR_HSM;
a7dac447
JG		 1398 if (status & (ATA_ERR | ATA_DF))
1399 return AC_ERR_DEV;
1400 return 0;
1401}
1402
1403static inline unsigned int __ac_err_mask(u8 status)
1404{
1405 unsigned int mask = ac_err_mask(status);
1406 if (mask == 0)
1407 return AC_ERR_OTHER;
1408 return mask;
1409}
1410
35bb94b1
JG		 1411static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1412{
4911487a 1413 return *(struct ata_port **)&host->hostdata[0];
35bb94b1
JG		 1414}
1415
78ab88f0
TH		 1416static inline int ata_check_ready(u8 status)
1417{
005b1f74
JG		 1418 if (!(status & ATA_BUSY))
1419 return 1;
78ab88f0
TH		 1420
1421 /* 0xff indicates either no device or device not ready */
1422 if (status == 0xff)
1423 return -ENODEV;
1424
005b1f74 1425 return 0;
78ab88f0
TH		 1426}
1427
341c2c95
TH		 1428static inline unsigned long ata_deadline(unsigned long from_jiffies,
1429 unsigned long timeout_msecs)
1430{
1431 return from_jiffies + msecs_to_jiffies(timeout_msecs);
1432}
1433
b15b3eba
AC		 1434/* Don't open code these in drivers as there are traps. Firstly the range may
1435 change in future hardware and specs, secondly 0xFF means 'no DMA' but is
1436 > UDMA_0. Dyma ddreigiau */
1437
1438static inline int ata_using_mwdma(struct ata_device *adev)
1439{
1440 if (adev->dma_mode >= XFER_MW_DMA_0 && adev->dma_mode <= XFER_MW_DMA_4)
1441 return 1;
1442 return 0;
1443}
1444
1445static inline int ata_using_udma(struct ata_device *adev)
1446{
1447 if (adev->dma_mode >= XFER_UDMA_0 && adev->dma_mode <= XFER_UDMA_7)
1448 return 1;
1449 return 0;
1450}
1451
1452static inline int ata_dma_enabled(struct ata_device *adev)
1453{
1454 return (adev->dma_mode == 0xFF ? 0 : 1);
1455}
48515f6c
TH		 1456
1457/**************************************************************************
1458 * PMP - drivers/ata/libata-pmp.c
1459 */
88fcd562
TH		 1460#ifdef CONFIG_SATA_PMP
1461
48515f6c
TH		 1462extern const struct ata_port_operations sata_pmp_port_ops;
1463
1464extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc);
1465extern void sata_pmp_error_handler(struct ata_port *ap);
1466
88fcd562
TH		 1467#else /* CONFIG_SATA_PMP */
1468
1469#define sata_pmp_port_ops sata_port_ops
1470#define sata_pmp_qc_defer_cmd_switch ata_std_qc_defer
1471#define sata_pmp_error_handler ata_std_error_handler
1472
1473#endif /* CONFIG_SATA_PMP */
1474
48515f6c 1475
624d5c51
TH		 1476/**************************************************************************
1477 * SFF - drivers/ata/libata-sff.c
1478 */
127102ae
TH		 1479#ifdef CONFIG_ATA_SFF
1480
624d5c51
TH		 1481extern const struct ata_port_operations ata_sff_port_ops;
1482extern const struct ata_port_operations ata_bmdma_port_ops;
1483
1484/* PIO only, sg_tablesize and dma_boundary limits can be removed */
1485#define ATA_PIO_SHT(drv_name) \
1486 ATA_BASE_SHT(drv_name), \
1487 .sg_tablesize = LIBATA_MAX_PRD, \
1488 .dma_boundary = ATA_DMA_BOUNDARY
1489
1490#define ATA_BMDMA_SHT(drv_name) \
1491 ATA_BASE_SHT(drv_name), \
1492 .sg_tablesize = LIBATA_MAX_PRD, \
1493 .dma_boundary = ATA_DMA_BOUNDARY
1494
9363c382
TH		 1495extern void ata_sff_qc_prep(struct ata_queued_cmd *qc);
1496extern void ata_sff_dumb_qc_prep(struct ata_queued_cmd *qc);
1497extern void ata_sff_dev_select(struct ata_port *ap, unsigned int device);
1498extern u8 ata_sff_check_status(struct ata_port *ap);
a57c1bad
AC		 1499extern void ata_sff_pause(struct ata_port *ap);
1500extern void ata_sff_dma_pause(struct ata_port *ap);
9363c382
TH		 1501extern int ata_sff_busy_sleep(struct ata_port *ap,
1502 unsigned long timeout_pat, unsigned long timeout);
705e76be 1503extern int ata_sff_wait_ready(struct ata_link *link, unsigned long deadline);
9363c382
TH		 1504extern void ata_sff_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
1505extern void ata_sff_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
1506extern void ata_sff_exec_command(struct ata_port *ap,
1507 const struct ata_taskfile *tf);
1508extern unsigned int ata_sff_data_xfer(struct ata_device *dev,
624d5c51 1509 unsigned char *buf, unsigned int buflen, int rw);
9363c382 1510extern unsigned int ata_sff_data_xfer_noirq(struct ata_device *dev,
624d5c51 1511 unsigned char *buf, unsigned int buflen, int rw);
9363c382
TH		 1512extern u8 ata_sff_irq_on(struct ata_port *ap);
1513extern void ata_sff_irq_clear(struct ata_port *ap);
1514extern int ata_sff_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
1515 u8 status, int in_wq);
1516extern unsigned int ata_sff_qc_issue(struct ata_queued_cmd *qc);
22183bf5 1517extern bool ata_sff_qc_fill_rtf(struct ata_queued_cmd *qc);
9363c382
TH		 1518extern unsigned int ata_sff_host_intr(struct ata_port *ap,
1519 struct ata_queued_cmd *qc);
1520extern irqreturn_t ata_sff_interrupt(int irq, void *dev_instance);
1521extern void ata_sff_freeze(struct ata_port *ap);
1522extern void ata_sff_thaw(struct ata_port *ap);
1523extern int ata_sff_prereset(struct ata_link *link, unsigned long deadline);
1524extern unsigned int ata_sff_dev_classify(struct ata_device *dev, int present,
1525 u8 *r_err);
705e76be
TH		 1526extern int ata_sff_wait_after_reset(struct ata_link *link, unsigned int devmask,
1527 unsigned long deadline);
9363c382 1528extern int ata_sff_softreset(struct ata_link *link, unsigned int *classes,
624d5c51 1529 unsigned long deadline);
9363c382
TH		 1530extern int sata_sff_hardreset(struct ata_link *link, unsigned int *class,
1531 unsigned long deadline);
1532extern void ata_sff_postreset(struct ata_link *link, unsigned int *classes);
1533extern void ata_sff_error_handler(struct ata_port *ap);
1534extern void ata_sff_post_internal_cmd(struct ata_queued_cmd *qc);
624d5c51 1535extern int ata_sff_port_start(struct ata_port *ap);
9363c382
TH		 1536extern void ata_sff_std_ports(struct ata_ioports *ioaddr);
1537extern unsigned long ata_bmdma_mode_filter(struct ata_device *dev,
1538 unsigned long xfer_mask);
624d5c51
TH		 1539extern void ata_bmdma_setup(struct ata_queued_cmd *qc);
1540extern void ata_bmdma_start(struct ata_queued_cmd *qc);
1541extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
1542extern u8 ata_bmdma_status(struct ata_port *ap);
1543extern void ata_bus_reset(struct ata_port *ap);
1544
1545#ifdef CONFIG_PCI
9363c382
TH		 1546extern int ata_pci_bmdma_clear_simplex(struct pci_dev *pdev);
1547extern int ata_pci_bmdma_init(struct ata_host *host);
1548extern int ata_pci_sff_init_host(struct ata_host *host);
1549extern int ata_pci_sff_prepare_host(struct pci_dev *pdev,
624d5c51
TH		 1550 const struct ata_port_info * const * ppi,
1551 struct ata_host **r_host);
9363c382 1552extern int ata_pci_sff_activate_host(struct ata_host *host,
624d5c51
TH		 1553 irq_handler_t irq_handler,
1554 struct scsi_host_template *sht);
9363c382
TH		 1555extern int ata_pci_sff_init_one(struct pci_dev *pdev,
1556 const struct ata_port_info * const * ppi,
1557 struct scsi_host_template *sht, void *host_priv);
624d5c51
TH		 1558#endif /* CONFIG_PCI */
1559
624d5c51 1560/**
9363c382 1561 * ata_sff_busy_wait - Wait for a port status register
624d5c51
TH		 1562 * @ap: Port to wait for.
1563 * @bits: bits that must be clear
1564 * @max: number of 10uS waits to perform
1565 *
1566 * Waits up to max*10 microseconds for the selected bits in the port's
1567 * status register to be cleared.
1568 * Returns final value of status register.
1569 *
1570 * LOCKING:
1571 * Inherited from caller.
1572 */
9363c382
TH		 1573static inline u8 ata_sff_busy_wait(struct ata_port *ap, unsigned int bits,
1574 unsigned int max)
624d5c51
TH		 1575{
1576 u8 status;
1577
1578 do {
1579 udelay(10);
5682ed33 1580 status = ap->ops->sff_check_status(ap);
624d5c51
TH		 1581 max--;
1582 } while (status != 0xff && (status & bits) && (max > 0));
1583
1584 return status;
1585}
1586
1587/**
1588 * ata_wait_idle - Wait for a port to be idle.
1589 * @ap: Port to wait for.
1590 *
1591 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
1592 * Returns final value of status register.
1593 *
1594 * LOCKING:
1595 * Inherited from caller.
1596 */
1597static inline u8 ata_wait_idle(struct ata_port *ap)
1598{
9363c382 1599 u8 status = ata_sff_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
624d5c51
TH		 1600
1601#ifdef ATA_DEBUG
1602 if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
1603 ata_port_printk(ap, KERN_DEBUG, "abnormal Status 0x%X\n",
1604 status);
1605#endif
1606
1607 return status;
1608}
127102ae 1609#endif /* CONFIG_ATA_SFF */
624d5c51 1610
1da177e4 1611#endif /* __LINUX_LIBATA_H__ */
ubuntu-bionic-kernel mirror