blob: 35e7f71cd8a533246be2792ac95d072eba4e7607 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Jeff Garzikaf36d7f2005-08-28 20:18:39 -04002 * 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 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070024 */
25
26#ifndef __LINUX_LIBATA_H__
27#define __LINUX_LIBATA_H__
28
29#include <linux/delay.h>
Tejun Heo341c2c92008-05-20 02:17:51 +090030#include <linux/jiffies.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070031#include <linux/interrupt.h>
Andrew Morton1c72d8d2005-11-10 16:21:38 -080032#include <linux/dma-mapping.h>
Jens Axboe87260212007-10-16 11:14:12 +020033#include <linux/scatterlist.h>
Tejun Heof0d36ef2007-01-20 16:00:28 +090034#include <linux/io.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070035#include <linux/ata.h>
36#include <linux/workqueue.h>
Jeff Garzik35bb94b2006-04-11 13:12:34 -040037#include <scsi/scsi_host.h>
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -070038#include <linux/acpi.h>
Tejun Heoceb0c642007-12-05 16:43:06 +090039#include <linux/cdrom.h>
Tejun Heoc0c362b2010-09-06 17:57:14 +020040#include <linux/sched.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
Jeff Garzika6d967a2006-09-25 15:33:09 -040042/*
43 * Define if arch has non-standard setup. This is a _PCI_ standard
44 * not a legacy or ISA standard.
45 */
46#ifdef CONFIG_ATA_NONSTANDARD
Alan Cox2ec7df02006-08-10 16:59:10 +090047#include <asm/libata-portmap.h>
Jeff Garzika6d967a2006-09-25 15:33:09 -040048#else
49#include <asm-generic/libata-portmap.h>
50#endif
Alan Cox2ec7df02006-08-10 16:59:10 +090051
Linus Torvalds1da177e2005-04-16 15:20:36 -070052/*
Randy Dunlapbfd60572006-01-17 19:34:42 -050053 * compile-time options: to be removed as soon as all the drivers are
54 * converted to the new debugging mechanism
Linus Torvalds1da177e2005-04-16 15:20:36 -070055 */
56#undef ATA_DEBUG /* debugging output */
57#undef ATA_VERBOSE_DEBUG /* yet more debugging output */
58#undef ATA_IRQ_TRAP /* define to ack screaming irqs */
59#undef ATA_NDEBUG /* define to disable quick runtime checks */
Linus Torvalds1da177e2005-04-16 15:20:36 -070060
61
62/* note: prints function name for you */
63#ifdef ATA_DEBUG
Alexander Beregalov1f938d02008-07-21 00:06:19 +040064#define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __func__, ## args)
Linus Torvalds1da177e2005-04-16 15:20:36 -070065#ifdef ATA_VERBOSE_DEBUG
Alexander Beregalov1f938d02008-07-21 00:06:19 +040066#define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __func__, ## args)
Linus Torvalds1da177e2005-04-16 15:20:36 -070067#else
68#define VPRINTK(fmt, args...)
69#endif /* ATA_VERBOSE_DEBUG */
70#else
71#define DPRINTK(fmt, args...)
72#define VPRINTK(fmt, args...)
73#endif /* ATA_DEBUG */
74
Alexander Beregalov1f938d02008-07-21 00:06:19 +040075#define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __func__, ## args)
Jeff Garzik2c13b7c2005-11-14 14:14:16 -050076
Joe Perches06296a12011-04-15 15:52:00 -070077#define ata_print_version_once(dev, version) \
78({ \
79 static bool __print_once; \
80 \
81 if (!__print_once) { \
82 __print_once = true; \
83 ata_print_version(dev, version); \
84 } \
85})
86
Randy Dunlapbfd60572006-01-17 19:34:42 -050087/* NEW: debug levels */
88#define HAVE_LIBATA_MSG 1
89
90enum {
91 ATA_MSG_DRV = 0x0001,
92 ATA_MSG_INFO = 0x0002,
93 ATA_MSG_PROBE = 0x0004,
94 ATA_MSG_WARN = 0x0008,
95 ATA_MSG_MALLOC = 0x0010,
96 ATA_MSG_CTL = 0x0020,
97 ATA_MSG_INTR = 0x0040,
98 ATA_MSG_ERR = 0x0080,
99};
100
101#define ata_msg_drv(p) ((p)->msg_enable & ATA_MSG_DRV)
102#define ata_msg_info(p) ((p)->msg_enable & ATA_MSG_INFO)
103#define ata_msg_probe(p) ((p)->msg_enable & ATA_MSG_PROBE)
104#define ata_msg_warn(p) ((p)->msg_enable & ATA_MSG_WARN)
105#define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC)
106#define ata_msg_ctl(p) ((p)->msg_enable & ATA_MSG_CTL)
107#define ata_msg_intr(p) ((p)->msg_enable & ATA_MSG_INTR)
108#define ata_msg_err(p) ((p)->msg_enable & ATA_MSG_ERR)
109
110static inline u32 ata_msg_init(int dval, int default_msg_enable_bits)
111{
112 if (dval < 0 || dval >= (sizeof(u32) * 8))
113 return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */
114 if (!dval)
115 return 0;
116 return (1 << dval) - 1;
117}
118
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119/* defines only for the constants which don't work well as enums */
120#define ATA_TAG_POISON 0xfafbfcfdU
121
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122enum {
123 /* various global constants */
124 LIBATA_MAX_PRD = ATA_MAX_PRD / 2,
Alan Coxd26fc952007-07-06 19:13:52 -0400125 LIBATA_DUMB_MAX_PRD = ATA_MAX_PRD / 4, /* Worst case */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126 ATA_DEF_QUEUE = 1,
Tejun Heo2ab7db12006-05-15 20:58:02 +0900127 /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
Tejun Heoa6e6ce82006-05-15 21:03:48 +0900128 ATA_MAX_QUEUE = 32,
Tejun Heo2ab7db12006-05-15 20:58:02 +0900129 ATA_TAG_INTERNAL = ATA_MAX_QUEUE - 1,
Tejun Heo341c2c92008-05-20 02:17:51 +0900130 ATA_SHORT_PAUSE = 16,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131
Tejun Heo140b5e52007-12-12 12:21:52 +0900132 ATAPI_MAX_DRAIN = 16 << 10,
133
Tejun Heob558edd2008-01-24 00:05:14 +0900134 ATA_ALL_DEVICES = (1 << ATA_MAX_DEVICES) - 1,
135
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136 ATA_SHT_EMULATED = 1,
137 ATA_SHT_CMD_PER_LUN = 1,
138 ATA_SHT_THIS_ID = -1,
Jeff Garzikcf482932005-10-22 00:19:33 -0400139 ATA_SHT_USE_CLUSTERING = 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140
141 /* struct ata_device stuff */
Tejun Heo949b38a2006-04-02 18:51:52 +0900142 ATA_DFLAG_LBA = (1 << 0), /* device supports LBA */
143 ATA_DFLAG_LBA48 = (1 << 1), /* device supports LBA48 */
Jeff Garzik029f5462006-04-02 10:30:40 -0400144 ATA_DFLAG_CDB_INTR = (1 << 2), /* device asserts INTRQ when ready for CDB */
Tejun Heo88e49032006-05-15 21:03:38 +0900145 ATA_DFLAG_NCQ = (1 << 3), /* device supports NCQ */
Tejun Heo6fc49ad2006-11-11 20:10:45 +0900146 ATA_DFLAG_FLUSH_EXT = (1 << 4), /* do FLUSH_EXT instead of FLUSH */
Tejun Heo67465442007-05-15 03:28:16 +0900147 ATA_DFLAG_ACPI_PENDING = (1 << 5), /* ACPI resume action pending */
148 ATA_DFLAG_ACPI_FAILED = (1 << 6), /* ACPI on devcfg has failed */
Tejun Heo7d77b242007-09-23 13:14:13 +0900149 ATA_DFLAG_AN = (1 << 7), /* AN configured */
Tejun Heo91163002008-02-21 13:25:50 +0900150 ATA_DFLAG_DMADIR = (1 << 10), /* device requires DMADIR */
Kristen Carlson Accardi25571642007-09-11 11:41:59 -0700151 ATA_DFLAG_CFG_MASK = (1 << 12) - 1,
Tejun Heo949b38a2006-04-02 18:51:52 +0900152
Kristen Carlson Accardi25571642007-09-11 11:41:59 -0700153 ATA_DFLAG_PIO = (1 << 12), /* device limited to PIO mode */
154 ATA_DFLAG_NCQ_OFF = (1 << 13), /* device limited to non-NCQ mode */
Tejun Heo054a5fb2007-10-25 18:30:36 +0900155 ATA_DFLAG_SLEEPING = (1 << 15), /* device is sleeping */
Tejun Heo00115e02007-11-27 19:28:58 +0900156 ATA_DFLAG_DUBIOUS_XFER = (1 << 16), /* data transfer not verified */
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200157 ATA_DFLAG_NO_UNLOAD = (1 << 17), /* device doesn't support unload */
Tejun Heo445d2112010-04-05 10:33:13 +0900158 ATA_DFLAG_UNLOCK_HPA = (1 << 18), /* unlock HPA */
Tejun Heof20ded32007-11-27 19:28:52 +0900159 ATA_DFLAG_INIT_MASK = (1 << 24) - 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160
Tejun Heof20ded32007-11-27 19:28:52 +0900161 ATA_DFLAG_DETACH = (1 << 24),
162 ATA_DFLAG_DETACHED = (1 << 25),
Tejun Heoabdda732006-05-31 18:27:29 +0900163
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164 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) */
Tejun Heoe0a71752007-09-23 13:14:12 +0900169 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) */
173 ATA_DEV_NONE = 9, /* no device */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174
Tejun Heo0c887582007-08-06 18:36:23 +0900175 /* struct ata_link flags */
Tejun Heo05944bd2008-08-13 20:19:09 +0900176 ATA_LFLAG_NO_HRST = (1 << 1), /* avoid hardreset */
Tejun Heoae791c02007-09-23 13:14:12 +0900177 ATA_LFLAG_NO_SRST = (1 << 2), /* avoid softreset */
178 ATA_LFLAG_ASSUME_ATA = (1 << 3), /* assume ATA class */
179 ATA_LFLAG_ASSUME_SEMB = (1 << 4), /* assume SEMB class */
180 ATA_LFLAG_ASSUME_CLASS = ATA_LFLAG_ASSUME_ATA | ATA_LFLAG_ASSUME_SEMB,
Tejun Heofd995f72007-09-23 13:14:12 +0900181 ATA_LFLAG_NO_RETRY = (1 << 5), /* don't retry this link */
Tejun Heof9df58c2007-09-23 13:14:13 +0900182 ATA_LFLAG_DISABLED = (1 << 6), /* link is disabled */
Kristen Carlson Accardi18f7ba42008-06-03 10:33:55 -0700183 ATA_LFLAG_SW_ACTIVITY = (1 << 7), /* keep activity stats */
Tejun Heo6b7ae952010-09-01 17:50:06 +0200184 ATA_LFLAG_NO_LPM = (1 << 8), /* disable LPM on this link */
José Adolfo Galdámez64c36312015-09-21 22:00:27 -0600185 ATA_LFLAG_CHANGED = (1 << 10), /* LPM state changed on this link */
Tejun Heo0c887582007-08-06 18:36:23 +0900186
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187 /* struct ata_port flags */
Tejun Heo949b38a2006-04-02 18:51:52 +0900188 ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189 /* (doesn't imply presence) */
Tejun Heo949b38a2006-04-02 18:51:52 +0900190 ATA_FLAG_SATA = (1 << 1),
Tejun Heo949b38a2006-04-02 18:51:52 +0900191 ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */
192 ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */
193 ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */
Tejun Heo7395acb2006-05-31 18:27:25 +0900194 ATA_FLAG_PIO_POLLING = (1 << 9), /* use polling PIO if LLD
195 * doesn't handle PIO interrupts */
196 ATA_FLAG_NCQ = (1 << 10), /* host supports NCQ */
Rafael J. Wysocki2a6e58d2009-01-19 20:56:43 +0100197 ATA_FLAG_NO_POWEROFF_SPINDOWN = (1 << 11), /* don't spindown before poweroff */
198 ATA_FLAG_NO_HIBERNATE_SPINDOWN = (1 << 12), /* don't spindown before hibernation */
Tejun Heo7395acb2006-05-31 18:27:25 +0900199 ATA_FLAG_DEBUGMSG = (1 << 13),
Shaohua Li388539f2009-07-27 09:24:35 +0800200 ATA_FLAG_FPDMA_AA = (1 << 14), /* driver supports Auto-Activate */
Tejun Heob2a8bbe2007-01-25 19:40:05 +0900201 ATA_FLAG_IGN_SIMPLEX = (1 << 15), /* ignore SIMPLEX */
Alan Coxf834e492007-02-07 13:46:00 -0800202 ATA_FLAG_NO_IORDY = (1 << 16), /* controller lacks iordy */
Tejun Heo3cadbcc2007-05-15 03:28:15 +0900203 ATA_FLAG_ACPI_SATA = (1 << 17), /* need native SATA ACPI layout */
Kristen Carlson Accardi9f45cbd2007-08-15 03:57:11 -0400204 ATA_FLAG_AN = (1 << 18), /* controller supports AN */
Tejun Heoe0a71752007-09-23 13:14:12 +0900205 ATA_FLAG_PMP = (1 << 19), /* controller supports PMP */
Kristen Carlson Accardi18f7ba42008-06-03 10:33:55 -0700206 ATA_FLAG_EM = (1 << 21), /* driver supports enclosure
207 * management */
208 ATA_FLAG_SW_ACTIVITY = (1 << 22), /* driver supports sw activity
209 * led */
Tejun Heoae01b242011-03-16 11:14:55 +0100210 ATA_FLAG_NO_DIPM = (1 << 23), /* host not happy with DIPM */
Dan Williams22383462015-01-16 15:13:02 -0800211 ATA_FLAG_LOWTAG = (1 << 24), /* host wants lowest available tag */
Jens Axboe9b847542006-01-06 09:28:07 +0100212
Tejun Heob51e9e52006-06-29 01:29:30 +0900213 /* bits 24:31 of ap->flags are reserved for LLD specific flags */
Alan Cox8d238e02006-01-17 20:50:31 +0000214
Alan Coxe3cf95d2009-04-09 17:31:17 +0100215
Tejun Heob51e9e52006-06-29 01:29:30 +0900216 /* struct ata_port pflags */
217 ATA_PFLAG_EH_PENDING = (1 << 0), /* EH pending */
218 ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */
219 ATA_PFLAG_FROZEN = (1 << 2), /* port is frozen */
220 ATA_PFLAG_RECOVERED = (1 << 3), /* recovery action performed */
221 ATA_PFLAG_LOADING = (1 << 4), /* boot/loading probe */
Tejun Heob51e9e52006-06-29 01:29:30 +0900222 ATA_PFLAG_SCSI_HOTPLUG = (1 << 6), /* SCSI hotplug scheduled */
Tejun Heof4d6d002007-05-01 11:50:15 +0200223 ATA_PFLAG_INITIALIZING = (1 << 7), /* being initialized, don't touch */
Tejun Heoafaa5c32007-10-09 15:06:10 +0900224 ATA_PFLAG_RESETTING = (1 << 8), /* reset in progress */
Tejun Heoece180d2008-11-03 20:04:37 +0900225 ATA_PFLAG_UNLOADING = (1 << 9), /* driver is being unloaded */
226 ATA_PFLAG_UNLOADED = (1 << 10), /* driver is unloaded */
Tejun Heob51e9e52006-06-29 01:29:30 +0900227
Tejun Heob51e9e52006-06-29 01:29:30 +0900228 ATA_PFLAG_SUSPENDED = (1 << 17), /* port is suspended (power) */
Tejun Heo500530f2006-07-03 16:07:27 +0900229 ATA_PFLAG_PM_PENDING = (1 << 18), /* PM operation pending */
Tejun Heoc05e6ff2007-12-15 15:05:02 +0900230 ATA_PFLAG_INIT_GTM_VALID = (1 << 19), /* initial gtm data valid */
Tejun Heodde44582006-02-02 00:56:10 +0900231
Alan Coxe3cf95d2009-04-09 17:31:17 +0100232 ATA_PFLAG_PIO32 = (1 << 20), /* 32bit PIO */
233 ATA_PFLAG_PIO32CHANGE = (1 << 21), /* 32bit PIO can be turned on/off */
234
Tejun Heo949b38a2006-04-02 18:51:52 +0900235 /* struct ata_queued_cmd flags */
236 ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */
Tejun Heo001102d2007-12-05 16:43:09 +0900237 ATA_QCFLAG_DMAMAP = (1 << 1), /* SG table is DMA mapped */
Tejun Heo27197362006-04-02 18:51:53 +0900238 ATA_QCFLAG_IO = (1 << 3), /* standard IO command */
Tejun Heoe61e0672006-05-15 20:57:40 +0900239 ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */
Tejun Heoda917d62007-09-23 13:14:12 +0900240 ATA_QCFLAG_CLEAR_EXCL = (1 << 5), /* clear excl_link on completion */
Tejun Heoe027bd32007-10-26 16:19:26 +0900241 ATA_QCFLAG_QUIET = (1 << 6), /* don't report device error */
Tejun Heo03faab72008-03-27 19:14:24 +0900242 ATA_QCFLAG_RETRY = (1 << 7), /* retry after failure */
Tejun Heoe61e0672006-05-15 20:57:40 +0900243
Tejun Heo9ec957f2006-05-15 20:57:58 +0900244 ATA_QCFLAG_FAILED = (1 << 16), /* cmd failed and is owned by EH */
245 ATA_QCFLAG_SENSE_VALID = (1 << 17), /* sense data valid */
246 ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247
Alan Cox4e5ec5d2006-03-27 18:42:40 +0100248 /* host set flags */
Jeff Garzikcca39742006-08-24 03:19:22 -0400249 ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host only */
Tejun Heoecef7252007-04-17 23:44:06 +0900250 ATA_HOST_STARTED = (1 << 1), /* Host started */
Arjan van de Ven886ad092009-01-09 15:54:07 -0800251 ATA_HOST_PARALLEL_SCAN = (1 << 2), /* Ports on this host can be scanned in parallel */
Andy Whitcroft54a40b22012-05-04 22:15:10 +0100252 ATA_HOST_IGNORE_ATA = (1 << 3), /* Ignore ATA devices on this host. */
Jeff Garzik9bec2e32006-08-31 00:02:15 -0400253
Tejun Heob8b275e2007-07-10 15:55:43 +0900254 /* bits 24:31 of host->flags are reserved for LLD specific flags */
255
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256 /* various lengths of time */
Tejun Heo341c2c92008-05-20 02:17:51 +0900257 ATA_TMOUT_BOOT = 30000, /* heuristic */
258 ATA_TMOUT_BOOT_QUICK = 7000, /* heuristic */
Tejun Heo341c2c92008-05-20 02:17:51 +0900259 ATA_TMOUT_INTERNAL_QUICK = 5000,
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200260 ATA_TMOUT_MAX_PARK = 30000,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261
Tejun Heob48d58f2010-04-09 19:46:38 +0900262 /*
263 * GoVault needs 2s and iVDR disk HHD424020F7SV00 800ms. 2s
264 * is too much without parallel probing. Use 2s if parallel
265 * probing is available, 800ms otherwise.
Tejun Heo88ff6ea2007-10-16 14:21:24 -0700266 */
Tejun Heob48d58f2010-04-09 19:46:38 +0900267 ATA_TMOUT_FF_WAIT_LONG = 2000,
268 ATA_TMOUT_FF_WAIT = 800,
Tejun Heo88ff6ea2007-10-16 14:21:24 -0700269
Tejun Heo705e76b2008-04-07 22:47:19 +0900270 /* Spec mandates to wait for ">= 2ms" before checking status
271 * after reset. We wait 150ms, because that was the magic
272 * delay used for ATAPI devices in Hale Landis's ATADRVR, for
273 * the period of time between when the ATA command register is
274 * written, and then status is checked. Because waiting for
275 * "a while" before checking status is fine, post SRST, we
276 * perform this magic delay here as well.
277 *
278 * Old drivers/ide uses the 2mS rule and then waits for ready.
279 */
Tejun Heo341c2c92008-05-20 02:17:51 +0900280 ATA_WAIT_AFTER_RESET = 150,
Tejun Heo705e76b2008-04-07 22:47:19 +0900281
Tejun Heo9dadd452008-04-07 22:47:19 +0900282 /* If PMP is supported, we have to do follow-up SRST. As some
283 * PMPs don't send D2H Reg FIS after hardreset, LLDs are
284 * advised to wait only for the following duration before
285 * doing SRST.
286 */
Stuart Hayese7d3ef12009-03-04 11:59:46 -0800287 ATA_TMOUT_PMP_SRST_WAIT = 5000,
Tejun Heo9dadd452008-04-07 22:47:19 +0900288
José Adolfo Galdámez64c36312015-09-21 22:00:27 -0600289 /* When the LPM policy is set to ATA_LPM_MAX_POWER, there might
290 * be a spurious PHY event, so ignore the first PHY event that
291 * occurs within 10s after the policy change.
292 */
293 ATA_TMOUT_SPURIOUS_PHY = 10000,
294
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295 /* ATA bus states */
296 BUS_UNKNOWN = 0,
297 BUS_DMA = 1,
298 BUS_IDLE = 2,
299 BUS_NOINTR = 3,
300 BUS_NODATA = 4,
301 BUS_TIMER = 5,
302 BUS_PIO = 6,
303 BUS_EDD = 7,
304 BUS_IDENTIFY = 8,
305 BUS_PACKET = 9,
306
307 /* SATA port states */
308 PORT_UNKNOWN = 0,
309 PORT_ENABLED = 1,
310 PORT_DISABLED = 2,
311
312 /* encoding various smaller bitmaps into a single
Tejun Heo7dc951a2007-11-27 19:43:42 +0900313 * unsigned long bitmap
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314 */
Tejun Heo70cd0712007-11-27 19:43:40 +0900315 ATA_NR_PIO_MODES = 7,
316 ATA_NR_MWDMA_MODES = 5,
317 ATA_NR_UDMA_MODES = 8,
Tejun Heo1da7b0d2006-03-06 04:31:56 +0900318
319 ATA_SHIFT_PIO = 0,
Tejun Heo70cd0712007-11-27 19:43:40 +0900320 ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_NR_PIO_MODES,
321 ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_NR_MWDMA_MODES,
Tejun Heo1da7b0d2006-03-06 04:31:56 +0900322
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400323 /* size of buffer to pad xfers ending on unaligned boundaries */
324 ATA_DMA_PAD_SZ = 4,
Tejun Heo949b38a2006-04-02 18:51:52 +0900325
Tejun Heo0c247c52006-05-15 20:58:19 +0900326 /* ering size */
327 ATA_ERING_SIZE = 32,
328
Tejun Heo31cc23b2007-09-23 13:14:12 +0900329 /* return values for ->qc_defer */
330 ATA_DEFER_LINK = 1,
331 ATA_DEFER_PORT = 2,
332
Tejun Heof3e81b12006-05-15 20:58:21 +0900333 /* desc_len for ata_eh_info and context */
334 ATA_EH_DESC_LEN = 80,
335
Tejun Heo9be1e972006-05-15 20:58:17 +0900336 /* reset / recovery action types */
337 ATA_EH_REVALIDATE = (1 << 0),
Tejun Heocf480622008-01-24 00:05:14 +0900338 ATA_EH_SOFTRESET = (1 << 1), /* meaningful only in ->prereset */
339 ATA_EH_HARDRESET = (1 << 2), /* meaningful only in ->prereset */
340 ATA_EH_RESET = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
Tejun Heof9df58c2007-09-23 13:14:13 +0900341 ATA_EH_ENABLE_LINK = (1 << 3),
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200342 ATA_EH_PARK = (1 << 5), /* unload heads and stop I/O */
Tejun Heo9be1e972006-05-15 20:58:17 +0900343
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200344 ATA_EH_PERDEV_MASK = ATA_EH_REVALIDATE | ATA_EH_PARK,
Tejun Heob5b3fa32008-07-31 17:02:42 +0900345 ATA_EH_ALL_ACTIONS = ATA_EH_REVALIDATE | ATA_EH_RESET |
Tejun Heo6b7ae952010-09-01 17:50:06 +0200346 ATA_EH_ENABLE_LINK,
Tejun Heo9be1e972006-05-15 20:58:17 +0900347
Tejun Heof3e81b12006-05-15 20:58:21 +0900348 /* ata_eh_info->flags */
Tejun Heoabdda732006-05-31 18:27:29 +0900349 ATA_EHI_HOTPLUGGED = (1 << 0), /* could have been hotplugged */
Tejun Heo1cdaf532006-07-03 16:07:26 +0900350 ATA_EHI_NO_AUTOPSY = (1 << 2), /* no autopsy */
351 ATA_EHI_QUIET = (1 << 3), /* be quiet */
Tejun Heoe2f3d752010-09-07 14:05:31 +0200352 ATA_EHI_NO_RECOVERY = (1 << 4), /* no recovery */
Tejun Heoabdda732006-05-31 18:27:29 +0900353
Tejun Heo0d64a232007-04-23 02:41:05 +0900354 ATA_EHI_DID_SOFTRESET = (1 << 16), /* already soft-reset this port */
355 ATA_EHI_DID_HARDRESET = (1 << 17), /* already soft-reset this port */
356 ATA_EHI_PRINTINFO = (1 << 18), /* print configuration info */
357 ATA_EHI_SETMODE = (1 << 19), /* configure transfer mode */
Andrea Gelmini89692c02010-10-16 15:19:18 +0200358 ATA_EHI_POST_SETMODE = (1 << 20), /* revalidating after setmode */
Tejun Heof3e81b12006-05-15 20:58:21 +0900359
Tejun Heo0d64a232007-04-23 02:41:05 +0900360 ATA_EHI_DID_RESET = ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
Tejun Heo13abf502006-07-10 23:18:46 +0900361
Tejun Heo848e4c62008-10-21 14:26:39 +0900362 /* mask of flags to transfer *to* the slave link */
363 ATA_EHI_TO_SLAVE_MASK = ATA_EHI_NO_AUTOPSY | ATA_EHI_QUIET,
364
Tejun Heoa1e10f72007-08-18 13:28:49 +0900365 /* max tries if error condition is still set after ->error_handler */
366 ATA_EH_MAX_TRIES = 5,
Tejun Heoad9e2762006-05-15 20:58:12 +0900367
Tejun Heo5040ab62010-01-11 11:14:44 +0900368 /* sometimes resuming a link requires several retries */
369 ATA_LINK_RESUME_TRIES = 5,
370
Tejun Heo14d2bac2006-04-02 17:54:46 +0900371 /* how hard are we gonna try to probe/recover devices */
372 ATA_PROBE_MAX_TRIES = 3,
Tejun Heo022bdb02006-05-15 20:58:22 +0900373 ATA_EH_DEV_TRIES = 3,
Tejun Heoe0a71752007-09-23 13:14:12 +0900374 ATA_EH_PMP_TRIES = 5,
375 ATA_EH_PMP_LINK_TRIES = 3,
376
Tejun Heobf1bff62008-05-19 01:15:10 +0900377 SATA_PMP_RW_TIMEOUT = 3000, /* PMP read/write timeout */
Tejun Heof5914a42006-05-31 18:27:48 +0900378
Tejun Heo87fbc5a2008-05-20 02:17:54 +0900379 /* This should match the actual table size of
380 * ata_eh_cmd_timeout_table in libata-eh.c.
381 */
Tejun Heo6013efd2009-11-19 15:36:45 +0900382 ATA_EH_CMD_TIMEOUT_TABLE_SIZE = 6,
Tejun Heo87fbc5a2008-05-20 02:17:54 +0900383
Alan Cox93590852006-09-12 16:55:12 +0100384 /* Horkage types. May be set by libata or controller on drives
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300385 (some horkage may be drive/controller pair dependent */
Alan Cox93590852006-09-12 16:55:12 +0100386
387 ATA_HORKAGE_DIAGNOSTIC = (1 << 0), /* Failed boot diag */
Alan Cox6919a0a2006-10-27 19:08:46 -0700388 ATA_HORKAGE_NODMA = (1 << 1), /* DMA problems */
389 ATA_HORKAGE_NONCQ = (1 << 2), /* Don't use NCQ */
Albert Lee18d6e9d2007-04-02 11:34:15 +0800390 ATA_HORKAGE_MAX_SEC_128 = (1 << 3), /* Limit max sects to 128 */
Tejun Heo16c55b02007-08-29 11:58:33 +0900391 ATA_HORKAGE_BROKEN_HPA = (1 << 4), /* Broken HPA */
Tejun Heo50af2fa2008-05-19 01:15:14 +0900392 ATA_HORKAGE_DISABLE = (1 << 5), /* Disable it */
Alan Cox93328e12007-09-29 04:06:48 -0400393 ATA_HORKAGE_HPA_SIZE = (1 << 6), /* native size off by one */
Alan Cox6bbfd532007-11-05 22:58:58 +0000394 ATA_HORKAGE_IVB = (1 << 8), /* cbl det validity bit bugs */
Albert Lee2d3b8ee2007-11-15 10:35:46 +0900395 ATA_HORKAGE_STUCK_ERR = (1 << 9), /* stuck ERR on next PACKET */
Jens Axboe9ce8e302008-08-27 15:23:18 +0200396 ATA_HORKAGE_BRIDGE_OK = (1 << 10), /* no bridge limits */
Tejun Heo6a87e422008-11-03 19:01:09 +0900397 ATA_HORKAGE_ATAPI_MOD16_DMA = (1 << 11), /* use ATAPI DMA for commands
398 not multiple of 16 bytes */
Nick Andrew877d0312009-01-26 11:06:57 +0100399 ATA_HORKAGE_FIRMWARE_WARN = (1 << 12), /* firmware update warning */
Tejun Heo90627122009-01-29 20:31:36 +0900400 ATA_HORKAGE_1_5_GBPS = (1 << 13), /* force 1.5 Gbps */
Tejun Heod0cb43b2009-07-09 09:27:50 +0900401 ATA_HORKAGE_NOSETXFER = (1 << 14), /* skip SETXFER, SATA only */
Shaohua Li388539f2009-07-27 09:24:35 +0800402 ATA_HORKAGE_BROKEN_FPDMA_AA = (1 << 15), /* skip AA */
Tejun Heo43c9c592010-05-23 12:59:11 +0200403 ATA_HORKAGE_DUMP_ID = (1 << 16), /* dump IDENTIFY data */
Shan Hai284aeeb2013-03-18 10:30:44 +0800404 ATA_HORKAGE_MAX_SEC_LBA48 = (1 << 17), /* Set max sects to 65535 */
Alan Coxb3a70602007-10-02 12:38:26 -0400405
Jeff Garzik2dcb4072007-10-19 06:42:56 -0400406 /* DMA mask for user DMA control: User visible values; DO NOT
Alan Coxb3a70602007-10-02 12:38:26 -0400407 renumber */
408 ATA_DMA_MASK_ATA = (1 << 0), /* DMA on ATA Disk */
409 ATA_DMA_MASK_ATAPI = (1 << 1), /* DMA on ATAPI */
410 ATA_DMA_MASK_CFA = (1 << 2), /* DMA on CF Card */
Tejun Heoceb0c642007-12-05 16:43:06 +0900411
412 /* ATAPI command types */
413 ATAPI_READ = 0, /* READs */
414 ATAPI_WRITE = 1, /* WRITEs */
415 ATAPI_READ_CD = 2, /* READ CD [MSF] */
Tejun Heoe52dcc42008-04-02 17:35:19 +0900416 ATAPI_PASS_THRU = 3, /* SAT pass-thru */
417 ATAPI_MISC = 4, /* the rest */
Tejun Heo624d5c52008-03-25 22:16:41 +0900418
419 /* Timing constants */
420 ATA_TIMING_SETUP = (1 << 0),
421 ATA_TIMING_ACT8B = (1 << 1),
422 ATA_TIMING_REC8B = (1 << 2),
423 ATA_TIMING_CYC8B = (1 << 3),
424 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
425 ATA_TIMING_CYC8B,
426 ATA_TIMING_ACTIVE = (1 << 4),
427 ATA_TIMING_RECOVER = (1 << 5),
David Daney3ada9c12009-01-15 17:45:31 -0800428 ATA_TIMING_DMACK_HOLD = (1 << 6),
429 ATA_TIMING_CYCLE = (1 << 7),
430 ATA_TIMING_UDMA = (1 << 8),
Tejun Heo624d5c52008-03-25 22:16:41 +0900431 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
432 ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
433 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
David Daney3ada9c12009-01-15 17:45:31 -0800434 ATA_TIMING_DMACK_HOLD | ATA_TIMING_CYCLE |
435 ATA_TIMING_UDMA,
Tejun Heof1bce7f2009-09-16 04:16:04 +0900436
437 /* ACPI constants */
438 ATA_ACPI_FILTER_SETXFER = 1 << 0,
439 ATA_ACPI_FILTER_LOCK = 1 << 1,
440 ATA_ACPI_FILTER_DIPM = 1 << 2,
Tejun Heofa5b5612009-09-16 04:17:02 +0900441 ATA_ACPI_FILTER_FPDMA_OFFSET = 1 << 3, /* FPDMA non-zero offset */
442 ATA_ACPI_FILTER_FPDMA_AA = 1 << 4, /* FPDMA auto activate */
Tejun Heof1bce7f2009-09-16 04:16:04 +0900443
444 ATA_ACPI_FILTER_DEFAULT = ATA_ACPI_FILTER_SETXFER |
445 ATA_ACPI_FILTER_LOCK |
446 ATA_ACPI_FILTER_DIPM,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447};
448
Tejun Heo7dc951a2007-11-27 19:43:42 +0900449enum ata_xfer_mask {
450 ATA_MASK_PIO = ((1LU << ATA_NR_PIO_MODES) - 1)
451 << ATA_SHIFT_PIO,
452 ATA_MASK_MWDMA = ((1LU << ATA_NR_MWDMA_MODES) - 1)
453 << ATA_SHIFT_MWDMA,
454 ATA_MASK_UDMA = ((1LU << ATA_NR_UDMA_MODES) - 1)
455 << ATA_SHIFT_UDMA,
456};
457
Albert Lee14be71f2005-09-27 17:36:35 +0800458enum hsm_task_states {
Albert Leec56b14d2005-09-30 19:07:39 +0800459 HSM_ST_IDLE, /* no command on going */
Albert Lee71527642007-04-02 11:28:52 +0800460 HSM_ST_FIRST, /* (waiting the device to)
461 write CDB or first data block */
Albert Leec56b14d2005-09-30 19:07:39 +0800462 HSM_ST, /* (waiting the device to) transfer data */
463 HSM_ST_LAST, /* (waiting the device to) complete command */
Albert Leec56b14d2005-09-30 19:07:39 +0800464 HSM_ST_ERR, /* error */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465};
466
Jeff Garzika7dac442005-10-30 04:44:42 -0500467enum ata_completion_errors {
Tejun Heo11a56d22006-01-23 13:09:36 +0900468 AC_ERR_DEV = (1 << 0), /* device reported error */
469 AC_ERR_HSM = (1 << 1), /* host state machine violation */
470 AC_ERR_TIMEOUT = (1 << 2), /* timeout */
471 AC_ERR_MEDIA = (1 << 3), /* media error */
472 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
473 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
474 AC_ERR_SYSTEM = (1 << 6), /* system error */
475 AC_ERR_INVALID = (1 << 7), /* invalid argument */
476 AC_ERR_OTHER = (1 << 8), /* unknown */
Tejun Heo55a8e2c2006-11-10 18:08:10 +0900477 AC_ERR_NODEV_HINT = (1 << 9), /* polling device detection hint */
Tejun Heo5335b722007-07-16 14:29:40 +0900478 AC_ERR_NCQ = (1 << 10), /* marker for offending NCQ qc */
Jeff Garzika7dac442005-10-30 04:44:42 -0500479};
480
Tejun Heoc93b2632010-09-01 17:50:04 +0200481/*
482 * Link power management policy: If you alter this, you also need to
483 * alter libata-scsi.c (for the ascii descriptions)
484 */
485enum ata_lpm_policy {
486 ATA_LPM_UNKNOWN,
487 ATA_LPM_MAX_POWER,
488 ATA_LPM_MED_POWER,
489 ATA_LPM_MIN_POWER,
490};
491
Tejun Heo6b7ae952010-09-01 17:50:06 +0200492enum ata_lpm_hints {
493 ATA_LPM_EMPTY = (1 << 0), /* port empty/probing */
494 ATA_LPM_HIPM = (1 << 1), /* may use HIPM */
495};
496
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497/* forward declarations */
498struct scsi_device;
499struct ata_port_operations;
500struct ata_port;
Tejun Heocc0680a2007-08-06 18:36:23 +0900501struct ata_link;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502struct ata_queued_cmd;
503
504/* typedefs */
Tejun Heo77853bf2006-01-23 13:09:36 +0900505typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
Tejun Heocc0680a2007-08-06 18:36:23 +0900506typedef int (*ata_prereset_fn_t)(struct ata_link *link, unsigned long deadline);
507typedef int (*ata_reset_fn_t)(struct ata_link *link, unsigned int *classes,
Tejun Heod4b2bab2007-02-02 16:50:52 +0900508 unsigned long deadline);
Tejun Heocc0680a2007-08-06 18:36:23 +0900509typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510
Tony Jonesee959b02008-02-22 00:13:36 +0100511extern struct device_attribute dev_attr_link_power_management_policy;
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200512extern struct device_attribute dev_attr_unload_heads;
Kristen Carlson Accardi18f7ba42008-06-03 10:33:55 -0700513extern struct device_attribute dev_attr_em_message_type;
514extern struct device_attribute dev_attr_em_message;
515extern struct device_attribute dev_attr_sw_activity;
516
517enum sw_activity {
518 OFF,
519 BLINK_ON,
520 BLINK_OFF,
521};
Kristen Carlson Accardica773292007-10-25 00:58:59 -0400522
Tejun Heo127102a2008-04-07 22:47:21 +0900523#ifdef CONFIG_ATA_SFF
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524struct ata_ioports {
Tejun Heo0d5ff562007-02-01 15:06:36 +0900525 void __iomem *cmd_addr;
526 void __iomem *data_addr;
527 void __iomem *error_addr;
528 void __iomem *feature_addr;
529 void __iomem *nsect_addr;
530 void __iomem *lbal_addr;
531 void __iomem *lbam_addr;
532 void __iomem *lbah_addr;
533 void __iomem *device_addr;
534 void __iomem *status_addr;
535 void __iomem *command_addr;
536 void __iomem *altstatus_addr;
537 void __iomem *ctl_addr;
Tejun Heo9a7780c2010-05-19 22:10:24 +0200538#ifdef CONFIG_ATA_BMDMA
Tejun Heo0d5ff562007-02-01 15:06:36 +0900539 void __iomem *bmdma_addr;
Tejun Heo9a7780c2010-05-19 22:10:24 +0200540#endif /* CONFIG_ATA_BMDMA */
Tejun Heo0d5ff562007-02-01 15:06:36 +0900541 void __iomem *scr_addr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542};
Tejun Heo127102a2008-04-07 22:47:21 +0900543#endif /* CONFIG_ATA_SFF */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544
Jeff Garzikcca39742006-08-24 03:19:22 -0400545struct ata_host {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546 spinlock_t lock;
547 struct device *dev;
Tejun Heo0d5ff562007-02-01 15:06:36 +0900548 void __iomem * const *iomap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549 unsigned int n_ports;
Tejun Heo80cd4922014-07-23 09:05:27 -0400550 unsigned int n_tags; /* nr of NCQ tags */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 void *private_data;
Tejun Heo029cfd62008-03-25 12:22:49 +0900552 struct ata_port_operations *ops;
Alan Cox5444a6f2006-03-27 18:58:20 +0100553 unsigned long flags;
Tejun Heoc0c362b2010-09-06 17:57:14 +0200554
555 struct mutex eh_mutex;
556 struct task_struct *eh_owner;
557
Tejun Heofafbae82007-05-15 03:28:16 +0900558#ifdef CONFIG_ATA_ACPI
559 acpi_handle acpi_handle;
560#endif
Alan032af1c2007-03-01 17:36:46 +0000561 struct ata_port *simplex_claimed; /* channel owning the DMA */
Tejun Heof0eb62b2006-06-12 23:05:38 +0900562 struct ata_port *ports[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563};
564
565struct ata_queued_cmd {
566 struct ata_port *ap;
567 struct ata_device *dev;
568
569 struct scsi_cmnd *scsicmd;
570 void (*scsidone)(struct scsi_cmnd *);
571
572 struct ata_taskfile tf;
573 u8 cdb[ATAPI_CDB_LEN];
574
575 unsigned long flags; /* ATA_QCFLAG_xxx */
576 unsigned int tag;
577 unsigned int n_elem;
FUJITA Tomonori58256272009-02-27 17:35:43 +0900578 unsigned int orig_n_elem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579
580 int dma_dir;
581
Mark Lord5a5dbd12007-03-16 10:22:26 -0400582 unsigned int sect_size;
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400583
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 unsigned int nbytes;
Tejun Heoaacda372008-03-18 17:47:43 +0900585 unsigned int extrabytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586 unsigned int curbytes;
587
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588 struct scatterlist sgent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589
Tejun Heoff2aeb12007-12-05 16:43:11 +0900590 struct scatterlist *sg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591
Richard Kennedyb34e9042010-09-10 12:19:43 +0100592 struct scatterlist *cursg;
593 unsigned int cursg_ofs;
594
Albert Leea22e2eb2005-12-05 15:38:02 +0800595 unsigned int err_mask;
Tejun Heoe61e0672006-05-15 20:57:40 +0900596 struct ata_taskfile result_tf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 ata_qc_cb_t complete_fn;
598
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599 void *private_data;
Darrick J. Wong1c50dc82007-01-30 01:18:41 -0800600 void *lldd_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601};
602
Jeff Garzikcca39742006-08-24 03:19:22 -0400603struct ata_port_stats {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604 unsigned long unhandled_irq;
605 unsigned long idle_irq;
606 unsigned long rw_reqbuf;
607};
608
Tejun Heo0c247c52006-05-15 20:58:19 +0900609struct ata_ering_entry {
Tejun Heo3884f7b2007-11-27 19:28:56 +0900610 unsigned int eflags;
Tejun Heo0c247c52006-05-15 20:58:19 +0900611 unsigned int err_mask;
612 u64 timestamp;
613};
614
615struct ata_ering {
616 int cursor;
617 struct ata_ering_entry ring[ATA_ERING_SIZE];
618};
619
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620struct ata_device {
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900621 struct ata_link *link;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622 unsigned int devno; /* 0 or 1 */
Tejun Heo75683fe2007-07-05 13:31:27 +0900623 unsigned int horkage; /* List of broken features */
Richard Kennedy6866e7b2008-09-22 14:47:13 -0700624 unsigned long flags; /* ATA_DFLAG_xxx */
Tejun Heo3edebac2006-05-31 18:27:40 +0900625 struct scsi_device *sdev; /* attached SCSI device */
Bartlomiej Zolnierkiewicz95514fd2009-11-25 18:12:48 +0100626 void *private_data;
Tejun Heofafbae82007-05-15 03:28:16 +0900627#ifdef CONFIG_ATA_ACPI
628 acpi_handle acpi_handle;
Tejun Heo398e0782007-12-15 15:05:03 +0900629 union acpi_object *gtf_cache;
Tejun Heo110f66d2009-09-16 04:17:28 +0900630 unsigned int gtf_filter;
Tejun Heofafbae82007-05-15 03:28:16 +0900631#endif
Gwendal Grignoud9027472010-05-25 12:31:38 -0700632 struct device tdev;
Tejun Heo99cf6102009-01-29 20:31:32 +0900633 /* n_sector is CLEAR_BEGIN, read comment above CLEAR_BEGIN */
Tejun Heo72fa4b72006-05-31 18:27:32 +0900634 u64 n_sectors; /* size of device, if ATA */
Tejun Heo5920dad2009-07-15 17:11:41 +0900635 u64 n_native_sectors; /* native size, if ATA */
Tejun Heo72fa4b72006-05-31 18:27:32 +0900636 unsigned int class; /* ATA_DEV_xxx */
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200637 unsigned long unpark_deadline;
Tejun Heoe0a71752007-09-23 13:14:12 +0900638
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639 u8 pio_mode;
640 u8 dma_mode;
641 u8 xfer_mode;
642 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
643
Albert Lee8cbd6df2005-10-12 15:06:27 +0800644 unsigned int multi_count; /* sectors count for
645 READ/WRITE MULTIPLE */
Tejun Heob00eec12006-02-12 23:32:59 +0900646 unsigned int max_sectors; /* per-device max sectors */
Tejun Heo6e7846e2006-02-12 23:32:58 +0900647 unsigned int cdb_len;
Albert Lee8bf62ec2005-05-12 15:29:42 -0400648
Tejun Heoacf356b2006-03-24 14:07:50 +0900649 /* per-dev xfer mask */
Tejun Heo7dc951a2007-11-27 19:43:42 +0900650 unsigned long pio_mask;
651 unsigned long mwdma_mask;
652 unsigned long udma_mask;
Tejun Heoacf356b2006-03-24 14:07:50 +0900653
Albert Lee8bf62ec2005-05-12 15:29:42 -0400654 /* for CHS addressing */
655 u16 cylinders; /* Number of cylinders */
656 u16 heads; /* Number of heads */
657 u16 sectors; /* Number of sectors per track */
Tejun Heo0c247c52006-05-15 20:58:19 +0900658
Jeff Garzikf7e98932008-04-29 17:47:34 -0400659 union {
660 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
661 u32 gscr[SATA_PMP_GSCR_DWORDS]; /* PMP GSCR block */
662 };
Tejun Heo99cf6102009-01-29 20:31:32 +0900663
664 /* error history */
665 int spdn_cnt;
666 /* ering is CLEAR_END, read comment above CLEAR_END */
667 struct ata_ering ering;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668};
669
Tejun Heo99cf6102009-01-29 20:31:32 +0900670/* Fields between ATA_DEVICE_CLEAR_BEGIN and ATA_DEVICE_CLEAR_END are
671 * cleared to zero on ata_dev_init().
Tejun Heo72fa4b72006-05-31 18:27:32 +0900672 */
Tejun Heo99cf6102009-01-29 20:31:32 +0900673#define ATA_DEVICE_CLEAR_BEGIN offsetof(struct ata_device, n_sectors)
674#define ATA_DEVICE_CLEAR_END offsetof(struct ata_device, ering)
Tejun Heo72fa4b72006-05-31 18:27:32 +0900675
Tejun Heof3e81b12006-05-15 20:58:21 +0900676struct ata_eh_info {
677 struct ata_device *dev; /* offending device */
678 u32 serror; /* SError from LLDD */
679 unsigned int err_mask; /* port-wide err_mask */
680 unsigned int action; /* ATA_EH_* action mask */
Tejun Heo47005f22006-06-19 18:27:23 +0900681 unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */
Tejun Heof3e81b12006-05-15 20:58:21 +0900682 unsigned int flags; /* ATA_EHI_* flags */
Tejun Heoabdda732006-05-31 18:27:29 +0900683
Tejun Heoabdda732006-05-31 18:27:29 +0900684 unsigned int probe_mask;
685
Tejun Heof3e81b12006-05-15 20:58:21 +0900686 char desc[ATA_EH_DESC_LEN];
687 int desc_len;
688};
689
690struct ata_eh_context {
691 struct ata_eh_info i;
692 int tries[ATA_MAX_DEVICES];
Tejun Heo87fbc5a2008-05-20 02:17:54 +0900693 int cmd_timeout_idx[ATA_MAX_DEVICES]
694 [ATA_EH_CMD_TIMEOUT_TABLE_SIZE];
Tejun Heoabdda732006-05-31 18:27:29 +0900695 unsigned int classes[ATA_MAX_DEVICES];
696 unsigned int did_probe_mask;
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200697 unsigned int unloaded_mask;
Tejun Heo00115e02007-11-27 19:28:58 +0900698 unsigned int saved_ncq_enabled;
699 u8 saved_xfer_mode[ATA_MAX_DEVICES];
Tejun Heo0a2c0f52008-05-20 02:17:52 +0900700 /* timestamp for the last reset attempt or success */
701 unsigned long last_reset;
Tejun Heof3e81b12006-05-15 20:58:21 +0900702};
703
Tejun Heo64578a32007-05-15 03:28:16 +0900704struct ata_acpi_drive
705{
706 u32 pio;
707 u32 dma;
708} __packed;
709
710struct ata_acpi_gtm {
711 struct ata_acpi_drive drive[2];
712 u32 flags;
713} __packed;
714
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900715struct ata_link {
716 struct ata_port *ap;
Tejun Heo89898052007-08-06 18:36:23 +0900717 int pmp; /* port multiplier port # */
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900718
Gwendal Grignoud9027472010-05-25 12:31:38 -0700719 struct device tdev;
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900720 unsigned int active_tag; /* active tag on this link */
721 u32 sactive; /* active NCQ commands */
722
Tejun Heo0c887582007-08-06 18:36:23 +0900723 unsigned int flags; /* ATA_LFLAG_xxx */
724
Tejun Heod127ea72008-07-31 16:09:34 +0900725 u32 saved_scontrol; /* SControl on probe */
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900726 unsigned int hw_sata_spd_limit;
727 unsigned int sata_spd_limit;
728 unsigned int sata_spd; /* current SATA PHY speed */
Tejun Heo6b7ae952010-09-01 17:50:06 +0200729 enum ata_lpm_policy lpm_policy;
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900730
731 /* record runtime error info, protected by host_set lock */
732 struct ata_eh_info eh_info;
733 /* EH context */
734 struct ata_eh_context eh_context;
735
736 struct ata_device device[ATA_MAX_DEVICES];
José Adolfo Galdámez64c36312015-09-21 22:00:27 -0600737
738 unsigned long last_lpm_change; /* when last LPM change happened */
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900739};
Gwendal Grignoud9027472010-05-25 12:31:38 -0700740#define ATA_LINK_CLEAR_BEGIN offsetof(struct ata_link, active_tag)
741#define ATA_LINK_CLEAR_END offsetof(struct ata_link, device[0])
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900742
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743struct ata_port {
Jeff Garzikcca39742006-08-24 03:19:22 -0400744 struct Scsi_Host *scsi_host; /* our co-allocated scsi host */
Tejun Heo029cfd62008-03-25 12:22:49 +0900745 struct ata_port_operations *ops;
Jeff Garzikba6a1302006-06-22 23:46:10 -0400746 spinlock_t *lock;
Alan Coxe3cf95d2009-04-09 17:31:17 +0100747 /* Flags owned by the EH context. Only EH should touch these once the
748 port is active */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749 unsigned long flags; /* ATA_FLAG_xxx */
Alan Coxe3cf95d2009-04-09 17:31:17 +0100750 /* Flags that change dynamically, protected by ap->lock */
Tejun Heob51e9e52006-06-29 01:29:30 +0900751 unsigned int pflags; /* ATA_PFLAG_xxx */
Tejun Heo44877b42007-02-21 01:06:51 +0900752 unsigned int print_id; /* user visible unique port ID */
753 unsigned int port_no; /* 0 based port no. inside the host */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754
Tejun Heo127102a2008-04-07 22:47:21 +0900755#ifdef CONFIG_ATA_SFF
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757 u8 ctl; /* cache of ATA control register */
758 u8 last_ctl; /* Cache last written value */
Gwendal Grignouea3c6452010-08-31 16:20:36 -0700759 struct ata_link* sff_pio_task_link; /* link currently used */
Tejun Heoc4291372010-05-10 21:41:38 +0200760 struct delayed_work sff_pio_task;
Tejun Heo9a7780c2010-05-19 22:10:24 +0200761#ifdef CONFIG_ATA_BMDMA
Tejun Heof60d7012010-05-10 21:41:41 +0200762 struct ata_bmdma_prd *bmdma_prd; /* BMDMA SG list */
763 dma_addr_t bmdma_prd_dma; /* and its DMA mapping */
Tejun Heo9a7780c2010-05-19 22:10:24 +0200764#endif /* CONFIG_ATA_BMDMA */
Tejun Heo5fe74542010-05-10 21:41:37 +0200765#endif /* CONFIG_ATA_SFF */
766
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767 unsigned int pio_mask;
768 unsigned int mwdma_mask;
769 unsigned int udma_mask;
770 unsigned int cbl; /* cable type; ATA_CBL_xxx */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771
772 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
Tejun Heo8a8bc222008-11-10 14:48:21 +0900773 unsigned long qc_allocated;
Tejun Heodedaf2b2006-05-15 21:03:43 +0900774 unsigned int qc_active;
Tejun Heoda917d62007-09-23 13:14:12 +0900775 int nr_active_links; /* #links with active qcs */
Dan Williamse45d91a2014-04-17 11:48:21 -0700776 unsigned int last_tag; /* track next tag hw expects */
Tejun Heodedaf2b2006-05-15 21:03:43 +0900777
Tejun Heob1c72912008-07-31 17:02:43 +0900778 struct ata_link link; /* host default link */
779 struct ata_link *slave_link; /* see ata_slave_link_init() */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780
Tejun Heo89898052007-08-06 18:36:23 +0900781 int nr_pmp_links; /* nr of available PMP links */
782 struct ata_link *pmp_link; /* array of PMP links */
Tejun Heoda917d62007-09-23 13:14:12 +0900783 struct ata_link *excl_link; /* for PMP qc exclusion */
Tejun Heo89898052007-08-06 18:36:23 +0900784
Jeff Garzikcca39742006-08-24 03:19:22 -0400785 struct ata_port_stats stats;
786 struct ata_host *host;
Brian King2f1f6102006-03-23 17:30:15 -0600787 struct device *dev;
Gwendal Grignoud9027472010-05-25 12:31:38 -0700788 struct device tdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789
Tejun Heoad72cf92010-07-02 10:03:52 +0200790 struct mutex scsi_scan_mutex;
David Howells52bad642006-11-22 14:54:01 +0000791 struct delayed_work hotplug_task;
Jeff Garzik3b01b8a2006-06-12 00:22:04 -0400792 struct work_struct scsi_rescan_task;
Tejun Heo86e45b62006-03-05 15:29:09 +0900793
Albert Lee14be71f2005-09-27 17:36:35 +0800794 unsigned int hsm_task_state;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795
Randy Dunlapbfd60572006-01-17 19:34:42 -0500796 u32 msg_enable;
Tejun Heoa72ec4c2006-01-23 13:09:37 +0900797 struct list_head eh_done_q;
Tejun Heoc6cf9e92006-05-31 18:27:27 +0900798 wait_queue_head_t eh_wait_q;
Tejun Heoa1e10f72007-08-18 13:28:49 +0900799 int eh_tries;
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200800 struct completion park_req_pending;
Randy Dunlapbfd60572006-01-17 19:34:42 -0500801
Tejun Heo500530f2006-07-03 16:07:27 +0900802 pm_message_t pm_mesg;
803 int *pm_result;
Tejun Heo6b7ae952010-09-01 17:50:06 +0200804 enum ata_lpm_policy target_lpm_policy;
Tejun Heo500530f2006-07-03 16:07:27 +0900805
Tejun Heo5ddf24c2007-07-16 14:29:41 +0900806 struct timer_list fastdrain_timer;
807 unsigned long fastdrain_cnt;
808
Kristen Carlson Accardi18f7ba42008-06-03 10:33:55 -0700809 int em_message_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810 void *private_data;
Tejun Heofe635c72006-05-15 20:57:35 +0900811
Tejun Heofafbae82007-05-15 03:28:16 +0900812#ifdef CONFIG_ATA_ACPI
813 acpi_handle acpi_handle;
Tejun Heoc05e6ff2007-12-15 15:05:02 +0900814 struct ata_acpi_gtm __acpi_init_gtm; /* use ata_acpi_init_gtm() */
Tejun Heofafbae82007-05-15 03:28:16 +0900815#endif
Tejun Heo84bda122009-03-02 18:53:26 +0900816 /* owned by EH */
817 u8 sector_buf[ATA_SECT_SIZE] ____cacheline_aligned;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818};
819
Tejun Heo029cfd62008-03-25 12:22:49 +0900820/* The following initializer overrides a method to NULL whether one of
821 * its parent has the method defined or not. This is equivalent to
822 * ERR_PTR(-ENOENT). Unfortunately, ERR_PTR doesn't render a constant
823 * expression and thus can't be used as an initializer.
824 */
825#define ATA_OP_NULL (void *)(unsigned long)(-ENOENT)
826
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827struct ata_port_operations {
Tejun Heoc1bc8992008-03-25 12:22:47 +0900828 /*
829 * Command execution
830 */
831 int (*qc_defer)(struct ata_queued_cmd *qc);
832 int (*check_atapi_dma)(struct ata_queued_cmd *qc);
833 void (*qc_prep)(struct ata_queued_cmd *qc);
834 unsigned int (*qc_issue)(struct ata_queued_cmd *qc);
Tejun Heo22183bf2008-04-07 22:47:20 +0900835 bool (*qc_fill_rtf)(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836
Tejun Heoc1bc8992008-03-25 12:22:47 +0900837 /*
838 * Configuration and exception handling
839 */
840 int (*cable_detect)(struct ata_port *ap);
841 unsigned long (*mode_filter)(struct ata_device *dev, unsigned long xfer_mask);
842 void (*set_piomode)(struct ata_port *ap, struct ata_device *dev);
843 void (*set_dmamode)(struct ata_port *ap, struct ata_device *dev);
844 int (*set_mode)(struct ata_link *link, struct ata_device **r_failed_dev);
Alan Cox963e4972008-07-24 17:16:06 +0100845 unsigned int (*read_id)(struct ata_device *dev, struct ata_taskfile *tf, u16 *id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846
Tejun Heoc1bc8992008-03-25 12:22:47 +0900847 void (*dev_config)(struct ata_device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848
Tejun Heoc1bc8992008-03-25 12:22:47 +0900849 void (*freeze)(struct ata_port *ap);
850 void (*thaw)(struct ata_port *ap);
Tejun Heoa1efdab2008-03-25 12:22:50 +0900851 ata_prereset_fn_t prereset;
852 ata_reset_fn_t softreset;
853 ata_reset_fn_t hardreset;
854 ata_postreset_fn_t postreset;
855 ata_prereset_fn_t pmp_prereset;
856 ata_reset_fn_t pmp_softreset;
857 ata_reset_fn_t pmp_hardreset;
858 ata_postreset_fn_t pmp_postreset;
Tejun Heoc1bc8992008-03-25 12:22:47 +0900859 void (*error_handler)(struct ata_port *ap);
Alan Coxc96f1732009-03-24 10:23:46 +0000860 void (*lost_interrupt)(struct ata_port *ap);
Tejun Heoc1bc8992008-03-25 12:22:47 +0900861 void (*post_internal_cmd)(struct ata_queued_cmd *qc);
862
863 /*
864 * Optional features
865 */
Tejun Heo82ef04f2008-07-31 17:02:40 +0900866 int (*scr_read)(struct ata_link *link, unsigned int sc_reg, u32 *val);
867 int (*scr_write)(struct ata_link *link, unsigned int sc_reg, u32 val);
Tejun Heoc1bc8992008-03-25 12:22:47 +0900868 void (*pmp_attach)(struct ata_port *ap);
869 void (*pmp_detach)(struct ata_port *ap);
Tejun Heo6b7ae952010-09-01 17:50:06 +0200870 int (*set_lpm)(struct ata_link *link, enum ata_lpm_policy policy,
871 unsigned hints);
Tejun Heoc1bc8992008-03-25 12:22:47 +0900872
873 /*
874 * Start, stop, suspend and resume
875 */
876 int (*port_suspend)(struct ata_port *ap, pm_message_t mesg);
877 int (*port_resume)(struct ata_port *ap);
878 int (*port_start)(struct ata_port *ap);
879 void (*port_stop)(struct ata_port *ap);
880 void (*host_stop)(struct ata_host *host);
881
Tejun Heo127102a2008-04-07 22:47:21 +0900882#ifdef CONFIG_ATA_SFF
Tejun Heoc1bc8992008-03-25 12:22:47 +0900883 /*
884 * SFF / taskfile oriented ops
885 */
Tejun Heo5682ed32008-04-07 22:47:16 +0900886 void (*sff_dev_select)(struct ata_port *ap, unsigned int device);
Sergei Shtylyov41dec292010-05-07 22:47:50 +0400887 void (*sff_set_devctl)(struct ata_port *ap, u8 ctl);
Tejun Heo5682ed32008-04-07 22:47:16 +0900888 u8 (*sff_check_status)(struct ata_port *ap);
889 u8 (*sff_check_altstatus)(struct ata_port *ap);
890 void (*sff_tf_load)(struct ata_port *ap, const struct ata_taskfile *tf);
891 void (*sff_tf_read)(struct ata_port *ap, struct ata_taskfile *tf);
892 void (*sff_exec_command)(struct ata_port *ap,
893 const struct ata_taskfile *tf);
894 unsigned int (*sff_data_xfer)(struct ata_device *dev,
895 unsigned char *buf, unsigned int buflen, int rw);
Sergei Shtylyove42a5422010-05-07 22:49:02 +0400896 void (*sff_irq_on)(struct ata_port *);
Tejun Heo27943622010-01-19 10:49:19 +0900897 bool (*sff_irq_check)(struct ata_port *);
Tejun Heo5682ed32008-04-07 22:47:16 +0900898 void (*sff_irq_clear)(struct ata_port *);
Tejun Heo8244cd02010-05-10 21:41:36 +0200899 void (*sff_drain_fifo)(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900
Tejun Heo9a7780c2010-05-19 22:10:24 +0200901#ifdef CONFIG_ATA_BMDMA
Tejun Heoc1bc8992008-03-25 12:22:47 +0900902 void (*bmdma_setup)(struct ata_queued_cmd *qc);
903 void (*bmdma_start)(struct ata_queued_cmd *qc);
904 void (*bmdma_stop)(struct ata_queued_cmd *qc);
905 u8 (*bmdma_status)(struct ata_port *ap);
Tejun Heo9a7780c2010-05-19 22:10:24 +0200906#endif /* CONFIG_ATA_BMDMA */
Tejun Heo127102a2008-04-07 22:47:21 +0900907#endif /* CONFIG_ATA_SFF */
Tejun Heoc19ba8a2006-01-24 17:05:22 +0900908
Kristen Carlson Accardi18f7ba42008-06-03 10:33:55 -0700909 ssize_t (*em_show)(struct ata_port *ap, char *buf);
910 ssize_t (*em_store)(struct ata_port *ap, const char *message,
911 size_t size);
912 ssize_t (*sw_activity_show)(struct ata_device *dev, char *buf);
913 ssize_t (*sw_activity_store)(struct ata_device *dev,
914 enum sw_activity val);
Tejun Heoc1bc8992008-03-25 12:22:47 +0900915 /*
916 * Obsolete
Tejun Heo9ec957f2006-05-15 20:57:58 +0900917 */
Tejun Heoc1bc8992008-03-25 12:22:47 +0900918 void (*phy_reset)(struct ata_port *ap);
919 void (*eng_timeout)(struct ata_port *ap);
Tejun Heo029cfd62008-03-25 12:22:49 +0900920
921 /*
922 * ->inherits must be the last field and all the preceding
923 * fields must be pointers.
924 */
925 const struct ata_port_operations *inherits;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926};
927
928struct ata_port_info {
Jeff Garzikcca39742006-08-24 03:19:22 -0400929 unsigned long flags;
Tejun Heo0c887582007-08-06 18:36:23 +0900930 unsigned long link_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931 unsigned long pio_mask;
932 unsigned long mwdma_mask;
933 unsigned long udma_mask;
Tejun Heo029cfd62008-03-25 12:22:49 +0900934 struct ata_port_operations *port_ops;
Alan Coxe99f8b52005-11-08 14:09:44 +0000935 void *private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936};
937
Alan Cox452503f2005-10-21 19:01:32 -0400938struct ata_timing {
939 unsigned short mode; /* ATA mode */
940 unsigned short setup; /* t1 */
941 unsigned short act8b; /* t2 for 8-bit I/O */
942 unsigned short rec8b; /* t2i for 8-bit I/O */
943 unsigned short cyc8b; /* t0 for 8-bit I/O */
944 unsigned short active; /* t2 or tD */
945 unsigned short recover; /* t2i or tK */
David Daney3ada9c12009-01-15 17:45:31 -0800946 unsigned short dmack_hold; /* tj */
Alan Cox452503f2005-10-21 19:01:32 -0400947 unsigned short cycle; /* t0 */
948 unsigned short udma; /* t2CYCTYP/2 */
949};
950
Tejun Heo624d5c52008-03-25 22:16:41 +0900951/*
952 * Core layer - drivers/ata/libata-core.c
953 */
Tejun Heoe9c83912006-07-03 16:07:26 +0900954extern const unsigned long sata_deb_timing_normal[];
955extern const unsigned long sata_deb_timing_hotplug[];
956extern const unsigned long sata_deb_timing_long[];
957
Tejun Heo029cfd62008-03-25 12:22:49 +0900958extern struct ata_port_operations ata_dummy_port_ops;
Tejun Heo21b0ad42007-04-17 23:44:07 +0900959extern const struct ata_port_info ata_dummy_port_info;
Tejun Heodd5b06c2006-08-10 16:59:12 +0900960
Tejun Heoe9c83912006-07-03 16:07:26 +0900961static inline const unsigned long *
962sata_ehc_deb_timing(struct ata_eh_context *ehc)
963{
964 if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
965 return sata_deb_timing_hotplug;
966 else
967 return sata_deb_timing_normal;
968}
Tejun Heod7bb4cc2006-05-31 18:27:46 +0900969
Tejun Heodd5b06c2006-08-10 16:59:12 +0900970static inline int ata_port_is_dummy(struct ata_port *ap)
971{
972 return ap->ops == &ata_dummy_port_ops;
973}
974
Tejun Heo936fd732007-08-06 18:36:23 +0900975extern int sata_set_spd(struct ata_link *link);
Tejun Heo0aa11132008-04-07 22:47:18 +0900976extern int ata_std_prereset(struct ata_link *link, unsigned long deadline);
Tejun Heoaa2731a2008-04-07 22:47:19 +0900977extern int ata_wait_after_reset(struct ata_link *link, unsigned long deadline,
978 int (*check_ready)(struct ata_link *link));
Tejun Heo936fd732007-08-06 18:36:23 +0900979extern int sata_link_debounce(struct ata_link *link,
980 const unsigned long *params, unsigned long deadline);
981extern int sata_link_resume(struct ata_link *link, const unsigned long *params,
982 unsigned long deadline);
Tejun Heo1152b262010-09-01 17:50:05 +0200983extern int sata_link_scr_lpm(struct ata_link *link, enum ata_lpm_policy policy,
984 bool spm_wakeup);
Tejun Heocc0680a2007-08-06 18:36:23 +0900985extern int sata_link_hardreset(struct ata_link *link,
Tejun Heo9dadd452008-04-07 22:47:19 +0900986 const unsigned long *timing, unsigned long deadline,
987 bool *online, int (*check_ready)(struct ata_link *));
Tejun Heo57c9efd2008-04-07 22:47:19 +0900988extern int sata_std_hardreset(struct ata_link *link, unsigned int *class,
989 unsigned long deadline);
Tejun Heo203c75b2008-04-07 22:47:18 +0900990extern void ata_std_postreset(struct ata_link *link, unsigned int *classes);
Jeff Garzik28555682007-10-11 17:12:35 -0400991
Tejun Heof3187192007-04-17 23:44:07 +0900992extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
Tejun Heof5cda252007-04-17 23:44:07 +0900993extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
994 const struct ata_port_info * const * ppi, int n_ports);
Tejun Heob1c72912008-07-31 17:02:43 +0900995extern int ata_slave_link_init(struct ata_port *ap);
Tejun Heoecef7252007-04-17 23:44:06 +0900996extern int ata_host_start(struct ata_host *host);
Tejun Heof3187192007-04-17 23:44:07 +0900997extern int ata_host_register(struct ata_host *host,
998 struct scsi_host_template *sht);
Tejun Heof5cda252007-04-17 23:44:07 +0900999extern int ata_host_activate(struct ata_host *host, int irq,
1000 irq_handler_t irq_handler, unsigned long irq_flags,
1001 struct scsi_host_template *sht);
Tejun Heo0529c152007-01-20 16:00:26 +09001002extern void ata_host_detach(struct ata_host *host);
Jeff Garzikcca39742006-08-24 03:19:22 -04001003extern void ata_host_init(struct ata_host *, struct device *,
Tejun Heo029cfd62008-03-25 12:22:49 +09001004 unsigned long, struct ata_port_operations *);
Jeff Garzik193515d2005-11-07 00:59:37 -05001005extern int ata_scsi_detect(struct scsi_host_template *sht);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
Jeff Garzikf2812332010-11-16 02:10:29 -05001007extern int ata_scsi_queuecmd(struct Scsi_Host *h, struct scsi_cmnd *cmd);
Jeff Garzik94be9a52009-01-16 10:17:09 -05001008extern int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *dev,
1009 int cmd, void __user *arg);
Brian King80289162006-08-07 14:27:31 -05001010extern void ata_sas_port_destroy(struct ata_port *);
Jeff Garzikcca39742006-08-24 03:19:22 -04001011extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
Brian King80289162006-08-07 14:27:31 -05001012 struct ata_port_info *, struct Scsi_Host *);
Dan Williamsb2024452012-03-21 21:09:07 -07001013extern void ata_sas_async_probe(struct ata_port *ap);
1014extern int ata_sas_sync_probe(struct ata_port *ap);
Brian King80289162006-08-07 14:27:31 -05001015extern int ata_sas_port_init(struct ata_port *);
1016extern int ata_sas_port_start(struct ata_port *ap);
1017extern void ata_sas_port_stop(struct ata_port *ap);
1018extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
Jeff Garzikb27dcfb2010-11-17 22:56:48 -05001019extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, struct ata_port *ap);
Tejun Heo936fd732007-08-06 18:36:23 +09001020extern int sata_scr_valid(struct ata_link *link);
1021extern int sata_scr_read(struct ata_link *link, int reg, u32 *val);
1022extern int sata_scr_write(struct ata_link *link, int reg, u32 val);
1023extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val);
Tejun Heob5b3fa32008-07-31 17:02:42 +09001024extern bool ata_link_online(struct ata_link *link);
1025extern bool ata_link_offline(struct ata_link *link);
Tejun Heo6ffa01d2007-03-02 17:32:47 +09001026#ifdef CONFIG_PM
Jeff Garzikcca39742006-08-24 03:19:22 -04001027extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
1028extern void ata_host_resume(struct ata_host *host);
Tejun Heo6ffa01d2007-03-02 17:32:47 +09001029#endif
Jeff Garzik67846b32005-10-05 02:58:32 -04001030extern int ata_ratelimit(void);
Tejun Heo97750ce2010-09-06 17:56:29 +02001031extern void ata_msleep(struct ata_port *ap, unsigned int msecs);
1032extern u32 ata_wait_register(struct ata_port *ap, void __iomem *reg, u32 mask,
1033 u32 val, unsigned long interval, unsigned long timeout);
Tejun Heo436d34b2008-04-02 17:28:46 +09001034extern int atapi_cmd_type(u8 opcode);
Tejun Heo99771262007-07-16 14:29:38 +09001035extern void ata_tf_to_fis(const struct ata_taskfile *tf,
1036 u8 pmp, int is_cmd, u8 *fis);
Jeff Garzik057ace52005-10-22 14:27:05 -04001037extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
Tejun Heo7dc951a2007-11-27 19:43:42 +09001038extern unsigned long ata_pack_xfermask(unsigned long pio_mask,
1039 unsigned long mwdma_mask, unsigned long udma_mask);
1040extern void ata_unpack_xfermask(unsigned long xfer_mask,
1041 unsigned long *pio_mask, unsigned long *mwdma_mask,
1042 unsigned long *udma_mask);
1043extern u8 ata_xfer_mask2mode(unsigned long xfer_mask);
1044extern unsigned long ata_xfer_mode2mask(u8 xfer_mode);
1045extern int ata_xfer_mode2shift(unsigned long xfer_mode);
1046extern const char *ata_mode_string(unsigned long xfer_mask);
1047extern unsigned long ata_id_xfermask(const u16 *id);
Tejun Heo31cc23b2007-09-23 13:14:12 +09001048extern int ata_std_qc_defer(struct ata_queued_cmd *qc);
Brian Kinge46834c2006-03-17 17:04:03 -06001049extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001050extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
1051 unsigned int n_elem);
Jeff Garzik057ace52005-10-22 14:27:05 -04001052extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
Alan10305f02007-02-20 18:01:59 +00001053extern void ata_dev_disable(struct ata_device *adev);
Tejun Heo6a62a042006-02-13 10:02:46 +09001054extern void ata_id_string(const u16 *id, unsigned char *s,
1055 unsigned int ofs, unsigned int len);
1056extern void ata_id_c_string(const u16 *id, unsigned char *s,
1057 unsigned int ofs, unsigned int len);
Alan Cox963e4972008-07-24 17:16:06 +01001058extern unsigned int ata_do_dev_read_id(struct ata_device *dev,
1059 struct ata_taskfile *tf, u16 *id);
Tejun Heof686bcb2006-05-15 20:58:05 +09001060extern void ata_qc_complete(struct ata_queued_cmd *qc);
Tejun Heo79f97da2008-04-07 22:47:20 +09001061extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active);
Jeff Garzikb27dcfb2010-11-17 22:56:48 -05001062extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063extern int ata_std_bios_param(struct scsi_device *sdev,
1064 struct block_device *bdev,
1065 sector_t capacity, int geom[]);
Tejun Heod8d91292010-05-15 20:09:34 +02001066extern void ata_scsi_unlock_native_capacity(struct scsi_device *sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001067extern int ata_scsi_slave_config(struct scsi_device *sdev);
Tejun Heo83c47bc2006-05-31 18:28:07 +09001068extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
Tejun Heoa6e6ce82006-05-15 21:03:48 +09001069extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
Mike Christiee881a172009-10-15 17:46:39 -07001070 int queue_depth, int reason);
Dan Williamsf6e67032011-09-20 15:10:33 -07001071extern int __ata_change_queue_depth(struct ata_port *ap, struct scsi_device *sdev,
1072 int queue_depth, int reason);
Tejun Heo3373efd2006-05-15 20:57:53 +09001073extern struct ata_device *ata_dev_pair(struct ata_device *adev);
Tejun Heo02607312007-08-06 18:36:23 +09001074extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
James Bottomley0e0b494c2011-01-23 09:42:50 -06001075extern void ata_scsi_port_error_handler(struct Scsi_Host *host, struct ata_port *ap);
1076extern void ata_scsi_cmd_error_handler(struct Scsi_Host *host, struct ata_port *ap, struct list_head *eh_q);
José Adolfo Galdámez64c36312015-09-21 22:00:27 -06001077extern bool sata_lpm_ignore_phy_events(struct ata_link *link);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001078
Alan Coxbe0d18d2007-03-06 02:37:56 -08001079extern int ata_cable_40wire(struct ata_port *ap);
1080extern int ata_cable_80wire(struct ata_port *ap);
1081extern int ata_cable_sata(struct ata_port *ap);
Tejun Heoc88f90c2007-11-27 19:43:48 +09001082extern int ata_cable_ignore(struct ata_port *ap);
Alan Coxbe0d18d2007-03-06 02:37:56 -08001083extern int ata_cable_unknown(struct ata_port *ap);
1084
Tejun Heo624d5c52008-03-25 22:16:41 +09001085/* Timing helpers */
Alan Cox1bc4ccf2006-01-09 17:18:14 +00001086extern unsigned int ata_pio_need_iordy(const struct ata_device *);
Tejun Heo63573572007-11-27 19:43:39 +09001087extern const struct ata_timing *ata_timing_find_mode(u8 xfer_mode);
Alan Cox452503f2005-10-21 19:01:32 -04001088extern int ata_timing_compute(struct ata_device *, unsigned short,
1089 struct ata_timing *, int, int);
1090extern void ata_timing_merge(const struct ata_timing *,
1091 const struct ata_timing *, struct ata_timing *,
1092 unsigned int);
Tejun Heoa0f79b92007-12-18 16:33:05 +09001093extern u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle);
Alan Cox452503f2005-10-21 19:01:32 -04001094
Tejun Heo624d5c52008-03-25 22:16:41 +09001095/* PCI */
1096#ifdef CONFIG_PCI
1097struct pci_dev;
1098
1099struct pci_bits {
1100 unsigned int reg; /* PCI config register to read */
1101 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
1102 unsigned long mask;
1103 unsigned long val;
Alan Cox452503f2005-10-21 19:01:32 -04001104};
1105
Tejun Heo624d5c52008-03-25 22:16:41 +09001106extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
1107extern void ata_pci_remove_one(struct pci_dev *pdev);
1108
1109#ifdef CONFIG_PM
1110extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
1111extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
1112extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
1113extern int ata_pci_device_resume(struct pci_dev *pdev);
1114#endif /* CONFIG_PM */
1115#endif /* CONFIG_PCI */
1116
1117/*
1118 * ACPI - drivers/ata/libata-acpi.c
1119 */
Alan Coxe1ddb4b2007-08-16 02:33:36 -04001120#ifdef CONFIG_ATA_ACPI
Tejun Heoc05e6ff2007-12-15 15:05:02 +09001121static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1122{
1123 if (ap->pflags & ATA_PFLAG_INIT_GTM_VALID)
1124 return &ap->__acpi_init_gtm;
1125 return NULL;
1126}
Tejun Heo0d02f0b2007-12-15 15:04:57 +09001127int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm);
1128int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *stm);
Tejun Heo7c77fa42007-12-18 16:33:03 +09001129unsigned long ata_acpi_gtm_xfermask(struct ata_device *dev,
1130 const struct ata_acpi_gtm *gtm);
Tejun Heo021ee9a2007-12-18 16:33:06 +09001131int ata_acpi_cbl_80wire(struct ata_port *ap, const struct ata_acpi_gtm *gtm);
Alan Coxe1ddb4b2007-08-16 02:33:36 -04001132#else
Tejun Heoc05e6ff2007-12-15 15:05:02 +09001133static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1134{
1135 return NULL;
1136}
Tejun Heo7c77fa42007-12-18 16:33:03 +09001137
1138static inline int ata_acpi_stm(const struct ata_port *ap,
1139 struct ata_acpi_gtm *stm)
1140{
1141 return -ENOSYS;
1142}
1143
1144static inline int ata_acpi_gtm(const struct ata_port *ap,
1145 struct ata_acpi_gtm *stm)
1146{
1147 return -ENOSYS;
1148}
1149
1150static inline unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev,
1151 const struct ata_acpi_gtm *gtm)
1152{
1153 return 0;
1154}
Tejun Heo021ee9a2007-12-18 16:33:06 +09001155
1156static inline int ata_acpi_cbl_80wire(struct ata_port *ap,
1157 const struct ata_acpi_gtm *gtm)
1158{
1159 return 0;
1160}
Alan Coxe1ddb4b2007-08-16 02:33:36 -04001161#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162
Tejun Heoece1d632006-04-02 18:51:53 +09001163/*
Tejun Heo624d5c52008-03-25 22:16:41 +09001164 * EH - drivers/ata/libata-eh.c
Tejun Heoece1d632006-04-02 18:51:53 +09001165 */
Tejun Heo7b70fc02006-05-15 20:58:07 +09001166extern void ata_port_schedule_eh(struct ata_port *ap);
Dan Williams81c757b2011-12-02 16:07:01 -08001167extern void ata_port_wait_eh(struct ata_port *ap);
Tejun Heodbd82612007-08-06 18:36:23 +09001168extern int ata_link_abort(struct ata_link *link);
Tejun Heo7b70fc02006-05-15 20:58:07 +09001169extern int ata_port_abort(struct ata_port *ap);
Tejun Heoe3180492006-05-15 20:58:09 +09001170extern int ata_port_freeze(struct ata_port *ap);
Tejun Heo7d77b242007-09-23 13:14:13 +09001171extern int sata_async_notification(struct ata_port *ap);
Tejun Heoe3180492006-05-15 20:58:09 +09001172
1173extern void ata_eh_freeze_port(struct ata_port *ap);
1174extern void ata_eh_thaw_port(struct ata_port *ap);
Tejun Heo7b70fc02006-05-15 20:58:07 +09001175
Tejun Heoece1d632006-04-02 18:51:53 +09001176extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
1177extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
Mark Lord10acf3b2008-05-02 02:14:53 -04001178extern void ata_eh_analyze_ncq_error(struct ata_link *link);
Tejun Heoece1d632006-04-02 18:51:53 +09001179
Tejun Heof5914a42006-05-31 18:27:48 +09001180extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
1181 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
1182 ata_postreset_fn_t postreset);
Tejun Heoa1efdab2008-03-25 12:22:50 +09001183extern void ata_std_error_handler(struct ata_port *ap);
Kristen Carlson Accardi8a745f12011-03-04 10:24:11 -08001184extern int ata_link_nr_enabled(struct ata_link *link);
Tejun Heo022bdb02006-05-15 20:58:22 +09001185
Tejun Heo61440db2006-05-15 20:57:55 +09001186/*
Tejun Heo68d1d072008-03-25 12:22:49 +09001187 * Base operations to inherit from and initializers for sht
1188 *
1189 * Operations
1190 *
1191 * base : Common to all libata drivers.
1192 * sata : SATA controllers w/ native interface.
1193 * pmp : SATA controllers w/ PMP support.
1194 * sff : SFF ATA controllers w/o BMDMA support.
1195 * bmdma : SFF ATA controllers w/ BMDMA support.
1196 *
1197 * sht initializers
1198 *
1199 * BASE : Common to all libata drivers. The user must set
1200 * sg_tablesize and dma_boundary.
1201 * PIO : SFF ATA controllers w/ only PIO support.
1202 * BMDMA : SFF ATA controllers w/ BMDMA support. sg_tablesize and
1203 * dma_boundary are set to BMDMA limits.
1204 * NCQ : SATA controllers supporting NCQ. The user must set
1205 * sg_tablesize, dma_boundary and can_queue.
1206 */
1207extern const struct ata_port_operations ata_base_port_ops;
1208extern const struct ata_port_operations sata_port_ops;
Elias Oltmanns45fabbb2008-09-21 11:54:08 +02001209extern struct device_attribute *ata_common_sdev_attrs[];
Tejun Heo68d1d072008-03-25 12:22:49 +09001210
1211#define ATA_BASE_SHT(drv_name) \
1212 .module = THIS_MODULE, \
1213 .name = drv_name, \
1214 .ioctl = ata_scsi_ioctl, \
1215 .queuecommand = ata_scsi_queuecmd, \
1216 .can_queue = ATA_DEF_QUEUE, \
1217 .this_id = ATA_SHT_THIS_ID, \
1218 .cmd_per_lun = ATA_SHT_CMD_PER_LUN, \
1219 .emulated = ATA_SHT_EMULATED, \
1220 .use_clustering = ATA_SHT_USE_CLUSTERING, \
1221 .proc_name = drv_name, \
1222 .slave_configure = ata_scsi_slave_config, \
1223 .slave_destroy = ata_scsi_slave_destroy, \
Elias Oltmanns45fabbb2008-09-21 11:54:08 +02001224 .bios_param = ata_std_bios_param, \
Tejun Heod8d91292010-05-15 20:09:34 +02001225 .unlock_native_capacity = ata_scsi_unlock_native_capacity, \
Elias Oltmanns45fabbb2008-09-21 11:54:08 +02001226 .sdev_attrs = ata_common_sdev_attrs
Tejun Heo68d1d072008-03-25 12:22:49 +09001227
Tejun Heo68d1d072008-03-25 12:22:49 +09001228#define ATA_NCQ_SHT(drv_name) \
1229 ATA_BASE_SHT(drv_name), \
1230 .change_queue_depth = ata_scsi_change_queue_depth
1231
1232/*
Tejun Heo071f44b2008-04-07 22:47:22 +09001233 * PMP helpers
1234 */
Tejun Heo88fcd562008-04-07 22:47:22 +09001235#ifdef CONFIG_SATA_PMP
Tejun Heo071f44b2008-04-07 22:47:22 +09001236static inline bool sata_pmp_supported(struct ata_port *ap)
1237{
1238 return ap->flags & ATA_FLAG_PMP;
1239}
1240
1241static inline bool sata_pmp_attached(struct ata_port *ap)
1242{
1243 return ap->nr_pmp_links != 0;
1244}
1245
1246static inline int ata_is_host_link(const struct ata_link *link)
1247{
Tejun Heob1c72912008-07-31 17:02:43 +09001248 return link == &link->ap->link || link == link->ap->slave_link;
Tejun Heo071f44b2008-04-07 22:47:22 +09001249}
Tejun Heo88fcd562008-04-07 22:47:22 +09001250#else /* CONFIG_SATA_PMP */
1251static inline bool sata_pmp_supported(struct ata_port *ap)
1252{
1253 return false;
1254}
1255
1256static inline bool sata_pmp_attached(struct ata_port *ap)
1257{
1258 return false;
1259}
1260
1261static inline int ata_is_host_link(const struct ata_link *link)
1262{
1263 return 1;
1264}
1265#endif /* CONFIG_SATA_PMP */
Tejun Heo071f44b2008-04-07 22:47:22 +09001266
1267static inline int sata_srst_pmp(struct ata_link *link)
1268{
1269 if (sata_pmp_supported(link->ap) && ata_is_host_link(link))
1270 return SATA_PMP_CTRL_PORT;
1271 return link->pmp;
1272}
1273
1274/*
Tejun Heo61440db2006-05-15 20:57:55 +09001275 * printk helpers
1276 */
Joe Perchesb9075fa2011-10-31 17:11:33 -07001277__printf(3, 4)
Joe Perchesa9a79df2011-04-15 15:51:59 -07001278int ata_port_printk(const struct ata_port *ap, const char *level,
1279 const char *fmt, ...);
Joe Perchesb9075fa2011-10-31 17:11:33 -07001280__printf(3, 4)
Joe Perchesa9a79df2011-04-15 15:51:59 -07001281int ata_link_printk(const struct ata_link *link, const char *level,
1282 const char *fmt, ...);
Joe Perchesb9075fa2011-10-31 17:11:33 -07001283__printf(3, 4)
Joe Perchesa9a79df2011-04-15 15:51:59 -07001284int ata_dev_printk(const struct ata_device *dev, const char *level,
1285 const char *fmt, ...);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001286
Joe Perchesa9a79df2011-04-15 15:51:59 -07001287#define ata_port_err(ap, fmt, ...) \
1288 ata_port_printk(ap, KERN_ERR, fmt, ##__VA_ARGS__)
1289#define ata_port_warn(ap, fmt, ...) \
1290 ata_port_printk(ap, KERN_WARNING, fmt, ##__VA_ARGS__)
1291#define ata_port_notice(ap, fmt, ...) \
1292 ata_port_printk(ap, KERN_NOTICE, fmt, ##__VA_ARGS__)
1293#define ata_port_info(ap, fmt, ...) \
1294 ata_port_printk(ap, KERN_INFO, fmt, ##__VA_ARGS__)
1295#define ata_port_dbg(ap, fmt, ...) \
1296 ata_port_printk(ap, KERN_DEBUG, fmt, ##__VA_ARGS__)
Tejun Heo9af5c9c2007-08-06 18:36:22 +09001297
Joe Perchesa9a79df2011-04-15 15:51:59 -07001298#define ata_link_err(link, fmt, ...) \
1299 ata_link_printk(link, KERN_ERR, fmt, ##__VA_ARGS__)
1300#define ata_link_warn(link, fmt, ...) \
1301 ata_link_printk(link, KERN_WARNING, fmt, ##__VA_ARGS__)
1302#define ata_link_notice(link, fmt, ...) \
1303 ata_link_printk(link, KERN_NOTICE, fmt, ##__VA_ARGS__)
1304#define ata_link_info(link, fmt, ...) \
1305 ata_link_printk(link, KERN_INFO, fmt, ##__VA_ARGS__)
1306#define ata_link_dbg(link, fmt, ...) \
1307 ata_link_printk(link, KERN_DEBUG, fmt, ##__VA_ARGS__)
1308
1309#define ata_dev_err(dev, fmt, ...) \
1310 ata_dev_printk(dev, KERN_ERR, fmt, ##__VA_ARGS__)
1311#define ata_dev_warn(dev, fmt, ...) \
1312 ata_dev_printk(dev, KERN_WARNING, fmt, ##__VA_ARGS__)
1313#define ata_dev_notice(dev, fmt, ...) \
1314 ata_dev_printk(dev, KERN_NOTICE, fmt, ##__VA_ARGS__)
1315#define ata_dev_info(dev, fmt, ...) \
1316 ata_dev_printk(dev, KERN_INFO, fmt, ##__VA_ARGS__)
1317#define ata_dev_dbg(dev, fmt, ...) \
1318 ata_dev_printk(dev, KERN_DEBUG, fmt, ##__VA_ARGS__)
Tejun Heo61440db2006-05-15 20:57:55 +09001319
Joe Perches06296a12011-04-15 15:52:00 -07001320void ata_print_version(const struct device *dev, const char *version);
1321
Tejun Heo61440db2006-05-15 20:57:55 +09001322/*
Tejun Heof3e81b12006-05-15 20:58:21 +09001323 * ata_eh_info helpers
1324 */
Joe Perchesb9075fa2011-10-31 17:11:33 -07001325extern __printf(2, 3)
1326void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
1327extern __printf(2, 3)
1328void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
Tejun Heob64bbc32007-07-16 14:29:39 +09001329extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
Tejun Heof3e81b12006-05-15 20:58:21 +09001330
Tejun Heoc0b6c032006-07-03 16:07:26 +09001331static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
1332{
Tejun Heob558edd2008-01-24 00:05:14 +09001333 ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
Tejun Heof8f1e1c2007-07-16 14:29:40 +09001334 ehi->flags |= ATA_EHI_HOTPLUGGED;
Tejun Heob558edd2008-01-24 00:05:14 +09001335 ehi->action |= ATA_EH_RESET | ATA_EH_ENABLE_LINK;
Tejun Heoc0b6c032006-07-03 16:07:26 +09001336 ehi->err_mask |= AC_ERR_ATA_BUS;
1337}
1338
Tejun Heof3e81b12006-05-15 20:58:21 +09001339/*
Tejun Heocbcdd872007-08-18 13:14:55 +09001340 * port description helpers
1341 */
Joe Perchesb9075fa2011-10-31 17:11:33 -07001342extern __printf(2, 3)
1343void ata_port_desc(struct ata_port *ap, const char *fmt, ...);
Tejun Heocbcdd872007-08-18 13:14:55 +09001344#ifdef CONFIG_PCI
1345extern void ata_port_pbar_desc(struct ata_port *ap, int bar, ssize_t offset,
1346 const char *name);
1347#endif
1348
Linus Torvalds1da177e2005-04-16 15:20:36 -07001349static inline unsigned int ata_tag_valid(unsigned int tag)
1350{
1351 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
1352}
1353
Tejun Heo2ab7db12006-05-15 20:58:02 +09001354static inline unsigned int ata_tag_internal(unsigned int tag)
1355{
Yoichi Yuasa83c063d2008-02-28 21:43:13 +09001356 return tag == ATA_TAG_INTERNAL;
Tejun Heo2ab7db12006-05-15 20:58:02 +09001357}
1358
Tejun Heo5806db22006-06-24 20:30:19 +09001359/*
1360 * device helpers
1361 */
Tejun Heoe1211e32006-04-01 01:38:18 +09001362static inline unsigned int ata_class_enabled(unsigned int class)
Tejun Heo597afd22006-03-01 01:25:38 +09001363{
Tejun Heoe0a71752007-09-23 13:14:12 +09001364 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI ||
1365 class == ATA_DEV_PMP || class == ATA_DEV_SEMB;
Tejun Heo597afd22006-03-01 01:25:38 +09001366}
1367
Tejun Heoe1211e32006-04-01 01:38:18 +09001368static inline unsigned int ata_class_disabled(unsigned int class)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369{
Tejun Heoe0a71752007-09-23 13:14:12 +09001370 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP ||
1371 class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP;
Tejun Heoe1211e32006-04-01 01:38:18 +09001372}
1373
Tejun Heo002c8052006-04-02 17:54:46 +09001374static inline unsigned int ata_class_absent(unsigned int class)
1375{
1376 return !ata_class_enabled(class) && !ata_class_disabled(class);
1377}
1378
Tejun Heoe1211e32006-04-01 01:38:18 +09001379static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1380{
1381 return ata_class_enabled(dev->class);
1382}
1383
1384static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1385{
1386 return ata_class_disabled(dev->class);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001387}
1388
Tejun Heo002c8052006-04-02 17:54:46 +09001389static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1390{
1391 return ata_class_absent(dev->class);
1392}
1393
Tejun Heo5806db22006-06-24 20:30:19 +09001394/*
Tejun Heof58229f2007-08-06 18:36:23 +09001395 * link helpers
Tejun Heo5806db22006-06-24 20:30:19 +09001396 */
Tejun Heof58229f2007-08-06 18:36:23 +09001397static inline int ata_link_max_devices(const struct ata_link *link)
Tejun Heo5806db22006-06-24 20:30:19 +09001398{
Tejun Heo89898052007-08-06 18:36:23 +09001399 if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS)
Tejun Heo5806db22006-06-24 20:30:19 +09001400 return 2;
1401 return 1;
1402}
1403
Tejun Heoda917d62007-09-23 13:14:12 +09001404static inline int ata_link_active(struct ata_link *link)
1405{
1406 return ata_tag_valid(link->active_tag) || link->sactive;
1407}
1408
Tejun Heo1eca4362008-11-03 20:03:17 +09001409/*
1410 * Iterators
1411 *
1412 * ATA_LITER_* constants are used to select link iteration mode and
1413 * ATA_DITER_* device iteration mode.
1414 *
1415 * For a custom iteration directly using ata_{link|dev}_next(), if
1416 * @link or @dev, respectively, is NULL, the first element is
1417 * returned. @dev and @link can be any valid device or link and the
1418 * next element according to the iteration mode will be returned.
1419 * After the last element, NULL is returned.
1420 */
1421enum ata_link_iter_mode {
1422 ATA_LITER_EDGE, /* if present, PMP links only; otherwise,
1423 * host link. no slave link */
1424 ATA_LITER_HOST_FIRST, /* host link followed by PMP or slave links */
1425 ATA_LITER_PMP_FIRST, /* PMP links followed by host link,
1426 * slave link still comes after host link */
1427};
Tejun Heo89898052007-08-06 18:36:23 +09001428
Tejun Heo1eca4362008-11-03 20:03:17 +09001429enum ata_dev_iter_mode {
1430 ATA_DITER_ENABLED,
1431 ATA_DITER_ENABLED_REVERSE,
1432 ATA_DITER_ALL,
1433 ATA_DITER_ALL_REVERSE,
1434};
Tejun Heo89898052007-08-06 18:36:23 +09001435
Tejun Heo1eca4362008-11-03 20:03:17 +09001436extern struct ata_link *ata_link_next(struct ata_link *link,
1437 struct ata_port *ap,
1438 enum ata_link_iter_mode mode);
Tejun Heof58229f2007-08-06 18:36:23 +09001439
Tejun Heo1eca4362008-11-03 20:03:17 +09001440extern struct ata_device *ata_dev_next(struct ata_device *dev,
1441 struct ata_link *link,
1442 enum ata_dev_iter_mode mode);
Tejun Heof58229f2007-08-06 18:36:23 +09001443
Tejun Heo1eca4362008-11-03 20:03:17 +09001444/*
1445 * Shortcut notation for iterations
1446 *
1447 * ata_for_each_link() iterates over each link of @ap according to
1448 * @mode. @link points to the current link in the loop. @link is
1449 * NULL after loop termination. ata_for_each_dev() works the same way
1450 * except that it iterates over each device of @link.
1451 *
1452 * Note that the mode prefixes ATA_{L|D}ITER_ shouldn't need to be
1453 * specified when using the following shorthand notations. Only the
1454 * mode itself (EDGE, HOST_FIRST, ENABLED, etc...) should be
1455 * specified. This not only increases brevity but also makes it
1456 * impossible to use ATA_LITER_* for device iteration or vice-versa.
1457 */
1458#define ata_for_each_link(link, ap, mode) \
1459 for ((link) = ata_link_next(NULL, (ap), ATA_LITER_##mode); (link); \
1460 (link) = ata_link_next((link), (ap), ATA_LITER_##mode))
1461
1462#define ata_for_each_dev(dev, link, mode) \
1463 for ((dev) = ata_dev_next(NULL, (link), ATA_DITER_##mode); (dev); \
1464 (dev) = ata_dev_next((dev), (link), ATA_DITER_##mode))
Tejun Heo5806db22006-06-24 20:30:19 +09001465
Tejun Heo6d1245b2007-02-20 23:20:27 +09001466/**
1467 * ata_ncq_enabled - Test whether NCQ is enabled
1468 * @dev: ATA device to test for
1469 *
1470 * LOCKING:
1471 * spin_lock_irqsave(host lock)
1472 *
1473 * RETURNS:
1474 * 1 if NCQ is enabled for @dev, 0 otherwise.
1475 */
1476static inline int ata_ncq_enabled(struct ata_device *dev)
1477{
1478 return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1479 ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1480}
Edward Falk0baab862005-06-02 18:17:13 -04001481
Linus Torvalds1da177e2005-04-16 15:20:36 -07001482static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1483{
1484 qc->tf.ctl |= ATA_NIEN;
1485}
1486
Tejun Heof69499f2006-05-15 20:58:03 +09001487static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1488 unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001489{
1490 if (likely(ata_tag_valid(tag)))
1491 return &ap->qcmd[tag];
1492 return NULL;
1493}
1494
Tejun Heof69499f2006-05-15 20:58:03 +09001495static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1496 unsigned int tag)
1497{
1498 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1499
1500 if (unlikely(!qc) || !ap->ops->error_handler)
1501 return qc;
1502
1503 if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1504 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1505 return qc;
1506
1507 return NULL;
1508}
1509
Tejun Heoaacda372008-03-18 17:47:43 +09001510static inline unsigned int ata_qc_raw_nbytes(struct ata_queued_cmd *qc)
1511{
1512 return qc->nbytes - min(qc->extrabytes, qc->nbytes);
1513}
1514
Tejun Heo3373efd2006-05-15 20:57:53 +09001515static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001516{
1517 memset(tf, 0, sizeof(*tf));
1518
Tejun Heo5fe74542010-05-10 21:41:37 +02001519#ifdef CONFIG_ATA_SFF
Tejun Heo9af5c9c2007-08-06 18:36:22 +09001520 tf->ctl = dev->link->ap->ctl;
Tejun Heo5fe74542010-05-10 21:41:37 +02001521#else
1522 tf->ctl = ATA_DEVCTL_OBS;
1523#endif
Tejun Heo3373efd2006-05-15 20:57:53 +09001524 if (dev->devno == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001525 tf->device = ATA_DEVICE_OBS;
1526 else
1527 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1528}
1529
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001530static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1531{
Tejun Heo501e0c52007-01-17 11:34:02 +09001532 qc->dma_dir = DMA_NONE;
Tejun Heoff2aeb12007-12-05 16:43:11 +09001533 qc->sg = NULL;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001534 qc->flags = 0;
Jens Axboe87260212007-10-16 11:14:12 +02001535 qc->cursg = NULL;
1536 qc->cursg_ofs = 0;
Tejun Heoaacda372008-03-18 17:47:43 +09001537 qc->nbytes = qc->extrabytes = qc->curbytes = 0;
Brian King7a801182007-01-17 12:32:12 -06001538 qc->n_elem = 0;
Albert Leea22e2eb2005-12-05 15:38:02 +08001539 qc->err_mask = 0;
Mark Lord5a5dbd12007-03-16 10:22:26 -04001540 qc->sect_size = ATA_SECT_SIZE;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001541
Tejun Heo3373efd2006-05-15 20:57:53 +09001542 ata_tf_init(qc->dev, &qc->tf);
Tejun Heoe61e0672006-05-15 20:57:40 +09001543
1544 /* init result_tf such that it indicates normal completion */
1545 qc->result_tf.command = ATA_DRDY;
1546 qc->result_tf.feature = 0;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001547}
1548
Jeff Garzik057ace52005-10-22 14:27:05 -04001549static inline int ata_try_flush_cache(const struct ata_device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001550{
1551 return ata_id_wcache_enabled(dev->id) ||
1552 ata_id_has_flush(dev->id) ||
1553 ata_id_has_flush_ext(dev->id);
1554}
1555
Jeff Garzika7dac442005-10-30 04:44:42 -05001556static inline unsigned int ac_err_mask(u8 status)
1557{
Albert Lee3655d1d2006-05-19 11:43:04 +08001558 if (status & (ATA_BUSY | ATA_DRQ))
Tejun Heo11a56d22006-01-23 13:09:36 +09001559 return AC_ERR_HSM;
Jeff Garzika7dac442005-10-30 04:44:42 -05001560 if (status & (ATA_ERR | ATA_DF))
1561 return AC_ERR_DEV;
1562 return 0;
1563}
1564
1565static inline unsigned int __ac_err_mask(u8 status)
1566{
1567 unsigned int mask = ac_err_mask(status);
1568 if (mask == 0)
1569 return AC_ERR_OTHER;
1570 return mask;
1571}
1572
Jeff Garzik35bb94b2006-04-11 13:12:34 -04001573static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1574{
Tejun Heo49114872007-04-17 23:44:06 +09001575 return *(struct ata_port **)&host->hostdata[0];
Jeff Garzik35bb94b2006-04-11 13:12:34 -04001576}
1577
Tejun Heo78ab88f2008-05-01 23:41:41 +09001578static inline int ata_check_ready(u8 status)
1579{
Jeff Garzik005b1f72008-05-09 15:00:55 -04001580 if (!(status & ATA_BUSY))
1581 return 1;
Tejun Heo78ab88f2008-05-01 23:41:41 +09001582
1583 /* 0xff indicates either no device or device not ready */
1584 if (status == 0xff)
1585 return -ENODEV;
1586
Jeff Garzik005b1f72008-05-09 15:00:55 -04001587 return 0;
Tejun Heo78ab88f2008-05-01 23:41:41 +09001588}
1589
Tejun Heo341c2c92008-05-20 02:17:51 +09001590static inline unsigned long ata_deadline(unsigned long from_jiffies,
1591 unsigned long timeout_msecs)
1592{
1593 return from_jiffies + msecs_to_jiffies(timeout_msecs);
1594}
1595
Alan Coxb15b3eb2008-08-01 09:18:34 +01001596/* Don't open code these in drivers as there are traps. Firstly the range may
1597 change in future hardware and specs, secondly 0xFF means 'no DMA' but is
1598 > UDMA_0. Dyma ddreigiau */
1599
1600static inline int ata_using_mwdma(struct ata_device *adev)
1601{
1602 if (adev->dma_mode >= XFER_MW_DMA_0 && adev->dma_mode <= XFER_MW_DMA_4)
1603 return 1;
1604 return 0;
1605}
1606
1607static inline int ata_using_udma(struct ata_device *adev)
1608{
1609 if (adev->dma_mode >= XFER_UDMA_0 && adev->dma_mode <= XFER_UDMA_7)
1610 return 1;
1611 return 0;
1612}
1613
1614static inline int ata_dma_enabled(struct ata_device *adev)
1615{
1616 return (adev->dma_mode == 0xFF ? 0 : 1);
1617}
Tejun Heo48515f62008-04-07 22:47:21 +09001618
1619/**************************************************************************
1620 * PMP - drivers/ata/libata-pmp.c
1621 */
Tejun Heo88fcd562008-04-07 22:47:22 +09001622#ifdef CONFIG_SATA_PMP
1623
Tejun Heo48515f62008-04-07 22:47:21 +09001624extern const struct ata_port_operations sata_pmp_port_ops;
1625
1626extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc);
1627extern void sata_pmp_error_handler(struct ata_port *ap);
1628
Tejun Heo88fcd562008-04-07 22:47:22 +09001629#else /* CONFIG_SATA_PMP */
1630
1631#define sata_pmp_port_ops sata_port_ops
1632#define sata_pmp_qc_defer_cmd_switch ata_std_qc_defer
1633#define sata_pmp_error_handler ata_std_error_handler
1634
1635#endif /* CONFIG_SATA_PMP */
1636
Tejun Heo48515f62008-04-07 22:47:21 +09001637
Tejun Heo624d5c52008-03-25 22:16:41 +09001638/**************************************************************************
1639 * SFF - drivers/ata/libata-sff.c
1640 */
Tejun Heo127102a2008-04-07 22:47:21 +09001641#ifdef CONFIG_ATA_SFF
1642
Tejun Heo624d5c52008-03-25 22:16:41 +09001643extern const struct ata_port_operations ata_sff_port_ops;
Alan Cox871af122009-01-05 14:16:39 +00001644extern const struct ata_port_operations ata_bmdma32_port_ops;
Tejun Heo624d5c52008-03-25 22:16:41 +09001645
1646/* PIO only, sg_tablesize and dma_boundary limits can be removed */
1647#define ATA_PIO_SHT(drv_name) \
1648 ATA_BASE_SHT(drv_name), \
1649 .sg_tablesize = LIBATA_MAX_PRD, \
1650 .dma_boundary = ATA_DMA_BOUNDARY
1651
Tejun Heo9363c382008-04-07 22:47:16 +09001652extern void ata_sff_dev_select(struct ata_port *ap, unsigned int device);
1653extern u8 ata_sff_check_status(struct ata_port *ap);
Alan Coxa57c1ba2008-05-29 22:10:58 +01001654extern void ata_sff_pause(struct ata_port *ap);
1655extern void ata_sff_dma_pause(struct ata_port *ap);
Tejun Heo9363c382008-04-07 22:47:16 +09001656extern int ata_sff_busy_sleep(struct ata_port *ap,
1657 unsigned long timeout_pat, unsigned long timeout);
Tejun Heo705e76b2008-04-07 22:47:19 +09001658extern int ata_sff_wait_ready(struct ata_link *link, unsigned long deadline);
Tejun Heo9363c382008-04-07 22:47:16 +09001659extern void ata_sff_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
1660extern void ata_sff_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
1661extern void ata_sff_exec_command(struct ata_port *ap,
1662 const struct ata_taskfile *tf);
1663extern unsigned int ata_sff_data_xfer(struct ata_device *dev,
Tejun Heo624d5c52008-03-25 22:16:41 +09001664 unsigned char *buf, unsigned int buflen, int rw);
Alan Cox871af122009-01-05 14:16:39 +00001665extern unsigned int ata_sff_data_xfer32(struct ata_device *dev,
1666 unsigned char *buf, unsigned int buflen, int rw);
Tejun Heo9363c382008-04-07 22:47:16 +09001667extern unsigned int ata_sff_data_xfer_noirq(struct ata_device *dev,
Tejun Heo624d5c52008-03-25 22:16:41 +09001668 unsigned char *buf, unsigned int buflen, int rw);
Sergei Shtylyove42a5422010-05-07 22:49:02 +04001669extern void ata_sff_irq_on(struct ata_port *ap);
Tejun Heo9363c382008-04-07 22:47:16 +09001670extern void ata_sff_irq_clear(struct ata_port *ap);
1671extern int ata_sff_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
1672 u8 status, int in_wq);
Viresh Kumar64b97592011-02-22 14:32:38 +05301673extern void ata_sff_queue_work(struct work_struct *work);
1674extern void ata_sff_queue_delayed_work(struct delayed_work *dwork,
1675 unsigned long delay);
Gwendal Grignouea3c6452010-08-31 16:20:36 -07001676extern void ata_sff_queue_pio_task(struct ata_link *link, unsigned long delay);
Tejun Heo9363c382008-04-07 22:47:16 +09001677extern unsigned int ata_sff_qc_issue(struct ata_queued_cmd *qc);
Tejun Heo22183bf2008-04-07 22:47:20 +09001678extern bool ata_sff_qc_fill_rtf(struct ata_queued_cmd *qc);
Tejun Heoc3b28892010-05-19 22:10:21 +02001679extern unsigned int ata_sff_port_intr(struct ata_port *ap,
Tejun Heo9363c382008-04-07 22:47:16 +09001680 struct ata_queued_cmd *qc);
1681extern irqreturn_t ata_sff_interrupt(int irq, void *dev_instance);
Alan Coxc96f1732009-03-24 10:23:46 +00001682extern void ata_sff_lost_interrupt(struct ata_port *ap);
Tejun Heo9363c382008-04-07 22:47:16 +09001683extern void ata_sff_freeze(struct ata_port *ap);
1684extern void ata_sff_thaw(struct ata_port *ap);
1685extern int ata_sff_prereset(struct ata_link *link, unsigned long deadline);
1686extern unsigned int ata_sff_dev_classify(struct ata_device *dev, int present,
1687 u8 *r_err);
Tejun Heo705e76b2008-04-07 22:47:19 +09001688extern int ata_sff_wait_after_reset(struct ata_link *link, unsigned int devmask,
1689 unsigned long deadline);
Tejun Heo9363c382008-04-07 22:47:16 +09001690extern int ata_sff_softreset(struct ata_link *link, unsigned int *classes,
Tejun Heo624d5c52008-03-25 22:16:41 +09001691 unsigned long deadline);
Tejun Heo9363c382008-04-07 22:47:16 +09001692extern int sata_sff_hardreset(struct ata_link *link, unsigned int *class,
1693 unsigned long deadline);
1694extern void ata_sff_postreset(struct ata_link *link, unsigned int *classes);
Alan Cox3d47aa82009-03-24 10:23:19 +00001695extern void ata_sff_drain_fifo(struct ata_queued_cmd *qc);
Tejun Heo9363c382008-04-07 22:47:16 +09001696extern void ata_sff_error_handler(struct ata_port *ap);
Tejun Heo9363c382008-04-07 22:47:16 +09001697extern void ata_sff_std_ports(struct ata_ioports *ioaddr);
Tejun Heo624d5c52008-03-25 22:16:41 +09001698#ifdef CONFIG_PCI
Tejun Heo9363c382008-04-07 22:47:16 +09001699extern int ata_pci_sff_init_host(struct ata_host *host);
1700extern int ata_pci_sff_prepare_host(struct pci_dev *pdev,
Tejun Heo624d5c52008-03-25 22:16:41 +09001701 const struct ata_port_info * const * ppi,
1702 struct ata_host **r_host);
Tejun Heo9363c382008-04-07 22:47:16 +09001703extern int ata_pci_sff_activate_host(struct ata_host *host,
Tejun Heo624d5c52008-03-25 22:16:41 +09001704 irq_handler_t irq_handler,
1705 struct scsi_host_template *sht);
Tejun Heo9363c382008-04-07 22:47:16 +09001706extern int ata_pci_sff_init_one(struct pci_dev *pdev,
Alan Cox16ea0fc2010-02-23 02:26:06 -05001707 const struct ata_port_info * const * ppi,
1708 struct scsi_host_template *sht, void *host_priv, int hflags);
Tejun Heo624d5c52008-03-25 22:16:41 +09001709#endif /* CONFIG_PCI */
1710
Tejun Heo9a7780c2010-05-19 22:10:24 +02001711#ifdef CONFIG_ATA_BMDMA
1712
1713extern const struct ata_port_operations ata_bmdma_port_ops;
1714
1715#define ATA_BMDMA_SHT(drv_name) \
1716 ATA_BASE_SHT(drv_name), \
1717 .sg_tablesize = LIBATA_MAX_PRD, \
1718 .dma_boundary = ATA_DMA_BOUNDARY
1719
Tejun Heof47451c2010-05-10 21:41:40 +02001720extern void ata_bmdma_qc_prep(struct ata_queued_cmd *qc);
Tejun Heo360ff782010-05-10 21:41:42 +02001721extern unsigned int ata_bmdma_qc_issue(struct ata_queued_cmd *qc);
Tejun Heof47451c2010-05-10 21:41:40 +02001722extern void ata_bmdma_dumb_qc_prep(struct ata_queued_cmd *qc);
Tejun Heoc3b28892010-05-19 22:10:21 +02001723extern unsigned int ata_bmdma_port_intr(struct ata_port *ap,
1724 struct ata_queued_cmd *qc);
1725extern irqreturn_t ata_bmdma_interrupt(int irq, void *dev_instance);
Tejun Heofe06e5f2010-05-10 21:41:39 +02001726extern void ata_bmdma_error_handler(struct ata_port *ap);
1727extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
Tejun Heo37f65b82010-05-19 22:10:20 +02001728extern void ata_bmdma_irq_clear(struct ata_port *ap);
Tejun Heo9f2f7212010-05-10 21:41:32 +02001729extern void ata_bmdma_setup(struct ata_queued_cmd *qc);
1730extern void ata_bmdma_start(struct ata_queued_cmd *qc);
1731extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
1732extern u8 ata_bmdma_status(struct ata_port *ap);
Tejun Heoc7087652010-05-10 21:41:34 +02001733extern int ata_bmdma_port_start(struct ata_port *ap);
1734extern int ata_bmdma_port_start32(struct ata_port *ap);
Tejun Heo9f2f7212010-05-10 21:41:32 +02001735
1736#ifdef CONFIG_PCI
1737extern int ata_pci_bmdma_clear_simplex(struct pci_dev *pdev);
Tejun Heoc7087652010-05-10 21:41:34 +02001738extern void ata_pci_bmdma_init(struct ata_host *host);
Tejun Heo1c5afdf2010-05-19 22:10:22 +02001739extern int ata_pci_bmdma_prepare_host(struct pci_dev *pdev,
1740 const struct ata_port_info * const * ppi,
1741 struct ata_host **r_host);
1742extern int ata_pci_bmdma_init_one(struct pci_dev *pdev,
1743 const struct ata_port_info * const * ppi,
1744 struct scsi_host_template *sht,
1745 void *host_priv, int hflags);
Tejun Heo9f2f7212010-05-10 21:41:32 +02001746#endif /* CONFIG_PCI */
Tejun Heo9a7780c2010-05-19 22:10:24 +02001747#endif /* CONFIG_ATA_BMDMA */
Tejun Heo9f2f7212010-05-10 21:41:32 +02001748
Tejun Heo624d5c52008-03-25 22:16:41 +09001749/**
Tejun Heo9363c382008-04-07 22:47:16 +09001750 * ata_sff_busy_wait - Wait for a port status register
Tejun Heo624d5c52008-03-25 22:16:41 +09001751 * @ap: Port to wait for.
1752 * @bits: bits that must be clear
1753 * @max: number of 10uS waits to perform
1754 *
1755 * Waits up to max*10 microseconds for the selected bits in the port's
1756 * status register to be cleared.
1757 * Returns final value of status register.
1758 *
1759 * LOCKING:
1760 * Inherited from caller.
1761 */
Tejun Heo9363c382008-04-07 22:47:16 +09001762static inline u8 ata_sff_busy_wait(struct ata_port *ap, unsigned int bits,
1763 unsigned int max)
Tejun Heo624d5c52008-03-25 22:16:41 +09001764{
1765 u8 status;
1766
1767 do {
1768 udelay(10);
Tejun Heo5682ed32008-04-07 22:47:16 +09001769 status = ap->ops->sff_check_status(ap);
Tejun Heo624d5c52008-03-25 22:16:41 +09001770 max--;
1771 } while (status != 0xff && (status & bits) && (max > 0));
1772
1773 return status;
1774}
1775
1776/**
1777 * ata_wait_idle - Wait for a port to be idle.
1778 * @ap: Port to wait for.
1779 *
1780 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
1781 * Returns final value of status register.
1782 *
1783 * LOCKING:
1784 * Inherited from caller.
1785 */
1786static inline u8 ata_wait_idle(struct ata_port *ap)
1787{
Tejun Heo9363c382008-04-07 22:47:16 +09001788 u8 status = ata_sff_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
Tejun Heo624d5c52008-03-25 22:16:41 +09001789
1790#ifdef ATA_DEBUG
1791 if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
1792 ata_port_printk(ap, KERN_DEBUG, "abnormal Status 0x%X\n",
1793 status);
1794#endif
1795
1796 return status;
1797}
Tejun Heo127102a2008-04-07 22:47:21 +09001798#endif /* CONFIG_ATA_SFF */
Tejun Heo624d5c52008-03-25 22:16:41 +09001799
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800#endif /* __LINUX_LIBATA_H__ */