blob: bec6dbe939a0267def1f73864d07c5025cb687f1 [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
Sergei Shtylyovdc34e7e2013-07-01 00:01:32 +0400141 /* struct ata_taskfile flags */
142 ATA_TFLAG_LBA48 = (1 << 0), /* enable 48-bit LBA and "HOB" */
143 ATA_TFLAG_ISADDR = (1 << 1), /* enable r/w to nsect/lba regs */
144 ATA_TFLAG_DEVICE = (1 << 2), /* enable r/w to device reg */
145 ATA_TFLAG_WRITE = (1 << 3), /* data dir: host->dev==1 (write) */
146 ATA_TFLAG_LBA = (1 << 4), /* enable LBA */
147 ATA_TFLAG_FUA = (1 << 5), /* enable FUA */
148 ATA_TFLAG_POLLING = (1 << 6), /* set nIEN to 1 and use polling */
149
150 /* protocol flags */
151 ATA_PROT_FLAG_PIO = (1 << 0), /* is PIO */
152 ATA_PROT_FLAG_DMA = (1 << 1), /* is DMA */
153 ATA_PROT_FLAG_DATA = ATA_PROT_FLAG_PIO | ATA_PROT_FLAG_DMA,
154 ATA_PROT_FLAG_NCQ = (1 << 2), /* is NCQ */
155 ATA_PROT_FLAG_ATAPI = (1 << 3), /* is ATAPI */
156
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157 /* struct ata_device stuff */
Tejun Heo949b38a2006-04-02 18:51:52 +0900158 ATA_DFLAG_LBA = (1 << 0), /* device supports LBA */
159 ATA_DFLAG_LBA48 = (1 << 1), /* device supports LBA48 */
Jeff Garzik029f5462006-04-02 10:30:40 -0400160 ATA_DFLAG_CDB_INTR = (1 << 2), /* device asserts INTRQ when ready for CDB */
Tejun Heo88e49032006-05-15 21:03:38 +0900161 ATA_DFLAG_NCQ = (1 << 3), /* device supports NCQ */
Tejun Heo6fc49ad2006-11-11 20:10:45 +0900162 ATA_DFLAG_FLUSH_EXT = (1 << 4), /* do FLUSH_EXT instead of FLUSH */
Tejun Heo67465442007-05-15 03:28:16 +0900163 ATA_DFLAG_ACPI_PENDING = (1 << 5), /* ACPI resume action pending */
164 ATA_DFLAG_ACPI_FAILED = (1 << 6), /* ACPI on devcfg has failed */
Tejun Heo7d77b242007-09-23 13:14:13 +0900165 ATA_DFLAG_AN = (1 << 7), /* AN configured */
Tejun Heo91163002008-02-21 13:25:50 +0900166 ATA_DFLAG_DMADIR = (1 << 10), /* device requires DMADIR */
Kristen Carlson Accardi25571642007-09-11 11:41:59 -0700167 ATA_DFLAG_CFG_MASK = (1 << 12) - 1,
Tejun Heo949b38a2006-04-02 18:51:52 +0900168
Kristen Carlson Accardi25571642007-09-11 11:41:59 -0700169 ATA_DFLAG_PIO = (1 << 12), /* device limited to PIO mode */
170 ATA_DFLAG_NCQ_OFF = (1 << 13), /* device limited to non-NCQ mode */
Tejun Heo054a5fb2007-10-25 18:30:36 +0900171 ATA_DFLAG_SLEEPING = (1 << 15), /* device is sleeping */
Tejun Heo00115e02007-11-27 19:28:58 +0900172 ATA_DFLAG_DUBIOUS_XFER = (1 << 16), /* data transfer not verified */
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200173 ATA_DFLAG_NO_UNLOAD = (1 << 17), /* device doesn't support unload */
Tejun Heo445d2112010-04-05 10:33:13 +0900174 ATA_DFLAG_UNLOCK_HPA = (1 << 18), /* unlock HPA */
Marc Carinoed369112013-08-24 23:22:50 -0700175 ATA_DFLAG_NCQ_SEND_RECV = (1 << 19), /* device supports NCQ SEND and RECV */
Tejun Heof20ded32007-11-27 19:28:52 +0900176 ATA_DFLAG_INIT_MASK = (1 << 24) - 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177
Tejun Heof20ded32007-11-27 19:28:52 +0900178 ATA_DFLAG_DETACH = (1 << 24),
179 ATA_DFLAG_DETACHED = (1 << 25),
Tejun Heoabdda732006-05-31 18:27:29 +0900180
Lin Mingb1354cb2012-06-25 16:13:08 +0800181 ATA_DFLAG_DA = (1 << 26), /* device supports Device Attention */
Shane Huang65fe1f02012-09-07 22:40:01 +0800182 ATA_DFLAG_DEVSLP = (1 << 27), /* device supports Device Sleep */
Aaron Lu0d0cdb02012-11-26 13:55:25 +0800183 ATA_DFLAG_ACPI_DISABLED = (1 << 28), /* ACPI for the device is disabled */
Lin Mingb1354cb2012-06-25 16:13:08 +0800184
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185 ATA_DEV_UNKNOWN = 0, /* unknown device */
186 ATA_DEV_ATA = 1, /* ATA device */
187 ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */
188 ATA_DEV_ATAPI = 3, /* ATAPI device */
189 ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */
Tejun Heoe0a71752007-09-23 13:14:12 +0900190 ATA_DEV_PMP = 5, /* SATA port multiplier */
191 ATA_DEV_PMP_UNSUP = 6, /* SATA port multiplier (unsupported) */
192 ATA_DEV_SEMB = 7, /* SEMB */
193 ATA_DEV_SEMB_UNSUP = 8, /* SEMB (unsupported) */
194 ATA_DEV_NONE = 9, /* no device */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195
Tejun Heo0c887582007-08-06 18:36:23 +0900196 /* struct ata_link flags */
Tejun Heo05944bd2008-08-13 20:19:09 +0900197 ATA_LFLAG_NO_HRST = (1 << 1), /* avoid hardreset */
Tejun Heoae791c02007-09-23 13:14:12 +0900198 ATA_LFLAG_NO_SRST = (1 << 2), /* avoid softreset */
199 ATA_LFLAG_ASSUME_ATA = (1 << 3), /* assume ATA class */
200 ATA_LFLAG_ASSUME_SEMB = (1 << 4), /* assume SEMB class */
201 ATA_LFLAG_ASSUME_CLASS = ATA_LFLAG_ASSUME_ATA | ATA_LFLAG_ASSUME_SEMB,
Tejun Heofd995f72007-09-23 13:14:12 +0900202 ATA_LFLAG_NO_RETRY = (1 << 5), /* don't retry this link */
Tejun Heof9df58c2007-09-23 13:14:13 +0900203 ATA_LFLAG_DISABLED = (1 << 6), /* link is disabled */
Kristen Carlson Accardi18f7ba42008-06-03 10:33:55 -0700204 ATA_LFLAG_SW_ACTIVITY = (1 << 7), /* keep activity stats */
Tejun Heo6b7ae952010-09-01 17:50:06 +0200205 ATA_LFLAG_NO_LPM = (1 << 8), /* disable LPM on this link */
Dan Williamsca6d43b2012-06-21 23:41:41 -0700206 ATA_LFLAG_RST_ONCE = (1 << 9), /* limit recovery to one reset */
Tejun Heo0c887582007-08-06 18:36:23 +0900207
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208 /* struct ata_port flags */
Tejun Heo949b38a2006-04-02 18:51:52 +0900209 ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210 /* (doesn't imply presence) */
Tejun Heo949b38a2006-04-02 18:51:52 +0900211 ATA_FLAG_SATA = (1 << 1),
Tejun Heo949b38a2006-04-02 18:51:52 +0900212 ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */
213 ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */
214 ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */
Tejun Heo7395acb2006-05-31 18:27:25 +0900215 ATA_FLAG_PIO_POLLING = (1 << 9), /* use polling PIO if LLD
216 * doesn't handle PIO interrupts */
217 ATA_FLAG_NCQ = (1 << 10), /* host supports NCQ */
Rafael J. Wysocki2a6e58d2009-01-19 20:56:43 +0100218 ATA_FLAG_NO_POWEROFF_SPINDOWN = (1 << 11), /* don't spindown before poweroff */
219 ATA_FLAG_NO_HIBERNATE_SPINDOWN = (1 << 12), /* don't spindown before hibernation */
Tejun Heo7395acb2006-05-31 18:27:25 +0900220 ATA_FLAG_DEBUGMSG = (1 << 13),
Shaohua Li388539f2009-07-27 09:24:35 +0800221 ATA_FLAG_FPDMA_AA = (1 << 14), /* driver supports Auto-Activate */
Tejun Heob2a8bbe2007-01-25 19:40:05 +0900222 ATA_FLAG_IGN_SIMPLEX = (1 << 15), /* ignore SIMPLEX */
Alan Coxf834e492007-02-07 13:46:00 -0800223 ATA_FLAG_NO_IORDY = (1 << 16), /* controller lacks iordy */
Tejun Heo3cadbcc2007-05-15 03:28:15 +0900224 ATA_FLAG_ACPI_SATA = (1 << 17), /* need native SATA ACPI layout */
Kristen Carlson Accardi9f45cbd2007-08-15 03:57:11 -0400225 ATA_FLAG_AN = (1 << 18), /* controller supports AN */
Tejun Heoe0a71752007-09-23 13:14:12 +0900226 ATA_FLAG_PMP = (1 << 19), /* controller supports PMP */
Marc Carino40fb59e2013-08-24 23:22:49 -0700227 ATA_FLAG_FPDMA_AUX = (1 << 20), /* controller supports H2DFIS aux field */
Kristen Carlson Accardi18f7ba42008-06-03 10:33:55 -0700228 ATA_FLAG_EM = (1 << 21), /* driver supports enclosure
229 * management */
230 ATA_FLAG_SW_ACTIVITY = (1 << 22), /* driver supports sw activity
231 * led */
Tejun Heoae01b242011-03-16 11:14:55 +0100232 ATA_FLAG_NO_DIPM = (1 << 23), /* host not happy with DIPM */
Jens Axboe9b847542006-01-06 09:28:07 +0100233
Tejun Heob51e9e52006-06-29 01:29:30 +0900234 /* bits 24:31 of ap->flags are reserved for LLD specific flags */
Alan Cox8d238e02006-01-17 20:50:31 +0000235
Alan Coxe3cf95d2009-04-09 17:31:17 +0100236
Tejun Heob51e9e52006-06-29 01:29:30 +0900237 /* struct ata_port pflags */
238 ATA_PFLAG_EH_PENDING = (1 << 0), /* EH pending */
239 ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */
240 ATA_PFLAG_FROZEN = (1 << 2), /* port is frozen */
241 ATA_PFLAG_RECOVERED = (1 << 3), /* recovery action performed */
242 ATA_PFLAG_LOADING = (1 << 4), /* boot/loading probe */
Tejun Heob51e9e52006-06-29 01:29:30 +0900243 ATA_PFLAG_SCSI_HOTPLUG = (1 << 6), /* SCSI hotplug scheduled */
Tejun Heof4d6d002007-05-01 11:50:15 +0200244 ATA_PFLAG_INITIALIZING = (1 << 7), /* being initialized, don't touch */
Tejun Heoafaa5c32007-10-09 15:06:10 +0900245 ATA_PFLAG_RESETTING = (1 << 8), /* reset in progress */
Tejun Heoece180d2008-11-03 20:04:37 +0900246 ATA_PFLAG_UNLOADING = (1 << 9), /* driver is being unloaded */
247 ATA_PFLAG_UNLOADED = (1 << 10), /* driver is unloaded */
Tejun Heob51e9e52006-06-29 01:29:30 +0900248
Tejun Heob51e9e52006-06-29 01:29:30 +0900249 ATA_PFLAG_SUSPENDED = (1 << 17), /* port is suspended (power) */
Tejun Heo500530f2006-07-03 16:07:27 +0900250 ATA_PFLAG_PM_PENDING = (1 << 18), /* PM operation pending */
Tejun Heoc05e6ff2007-12-15 15:05:02 +0900251 ATA_PFLAG_INIT_GTM_VALID = (1 << 19), /* initial gtm data valid */
Tejun Heodde44582006-02-02 00:56:10 +0900252
Alan Coxe3cf95d2009-04-09 17:31:17 +0100253 ATA_PFLAG_PIO32 = (1 << 20), /* 32bit PIO */
254 ATA_PFLAG_PIO32CHANGE = (1 << 21), /* 32bit PIO can be turned on/off */
255
Tejun Heo949b38a2006-04-02 18:51:52 +0900256 /* struct ata_queued_cmd flags */
257 ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */
Tejun Heo001102d2007-12-05 16:43:09 +0900258 ATA_QCFLAG_DMAMAP = (1 << 1), /* SG table is DMA mapped */
Tejun Heo27197362006-04-02 18:51:53 +0900259 ATA_QCFLAG_IO = (1 << 3), /* standard IO command */
Tejun Heoe61e0672006-05-15 20:57:40 +0900260 ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */
Tejun Heoda917d62007-09-23 13:14:12 +0900261 ATA_QCFLAG_CLEAR_EXCL = (1 << 5), /* clear excl_link on completion */
Tejun Heoe027bd32007-10-26 16:19:26 +0900262 ATA_QCFLAG_QUIET = (1 << 6), /* don't report device error */
Tejun Heo03faab72008-03-27 19:14:24 +0900263 ATA_QCFLAG_RETRY = (1 << 7), /* retry after failure */
Tejun Heoe61e0672006-05-15 20:57:40 +0900264
Tejun Heo9ec957f2006-05-15 20:57:58 +0900265 ATA_QCFLAG_FAILED = (1 << 16), /* cmd failed and is owned by EH */
266 ATA_QCFLAG_SENSE_VALID = (1 << 17), /* sense data valid */
267 ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268
Alan Cox4e5ec5d2006-03-27 18:42:40 +0100269 /* host set flags */
Jeff Garzikcca39742006-08-24 03:19:22 -0400270 ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host only */
Tejun Heoecef7252007-04-17 23:44:06 +0900271 ATA_HOST_STARTED = (1 << 1), /* Host started */
Arjan van de Ven886ad092009-01-09 15:54:07 -0800272 ATA_HOST_PARALLEL_SCAN = (1 << 2), /* Ports on this host can be scanned in parallel */
Andy Whitcroftdb63a4c2012-05-04 22:15:10 +0100273 ATA_HOST_IGNORE_ATA = (1 << 3), /* Ignore ATA devices on this host. */
Jeff Garzik9bec2e32006-08-31 00:02:15 -0400274
Tejun Heob8b275e2007-07-10 15:55:43 +0900275 /* bits 24:31 of host->flags are reserved for LLD specific flags */
276
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277 /* various lengths of time */
Tejun Heo341c2c92008-05-20 02:17:51 +0900278 ATA_TMOUT_BOOT = 30000, /* heuristic */
279 ATA_TMOUT_BOOT_QUICK = 7000, /* heuristic */
Tejun Heo341c2c92008-05-20 02:17:51 +0900280 ATA_TMOUT_INTERNAL_QUICK = 5000,
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200281 ATA_TMOUT_MAX_PARK = 30000,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282
Tejun Heob48d58f2010-04-09 19:46:38 +0900283 /*
284 * GoVault needs 2s and iVDR disk HHD424020F7SV00 800ms. 2s
285 * is too much without parallel probing. Use 2s if parallel
286 * probing is available, 800ms otherwise.
Tejun Heo88ff6ea2007-10-16 14:21:24 -0700287 */
Tejun Heob48d58f2010-04-09 19:46:38 +0900288 ATA_TMOUT_FF_WAIT_LONG = 2000,
289 ATA_TMOUT_FF_WAIT = 800,
Tejun Heo88ff6ea2007-10-16 14:21:24 -0700290
Tejun Heo705e76b2008-04-07 22:47:19 +0900291 /* Spec mandates to wait for ">= 2ms" before checking status
292 * after reset. We wait 150ms, because that was the magic
293 * delay used for ATAPI devices in Hale Landis's ATADRVR, for
294 * the period of time between when the ATA command register is
295 * written, and then status is checked. Because waiting for
296 * "a while" before checking status is fine, post SRST, we
297 * perform this magic delay here as well.
298 *
299 * Old drivers/ide uses the 2mS rule and then waits for ready.
300 */
Tejun Heo341c2c92008-05-20 02:17:51 +0900301 ATA_WAIT_AFTER_RESET = 150,
Tejun Heo705e76b2008-04-07 22:47:19 +0900302
Tejun Heo9dadd452008-04-07 22:47:19 +0900303 /* If PMP is supported, we have to do follow-up SRST. As some
304 * PMPs don't send D2H Reg FIS after hardreset, LLDs are
305 * advised to wait only for the following duration before
306 * doing SRST.
307 */
Stuart Hayese7d3ef12009-03-04 11:59:46 -0800308 ATA_TMOUT_PMP_SRST_WAIT = 5000,
Tejun Heo9dadd452008-04-07 22:47:19 +0900309
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310 /* ATA bus states */
311 BUS_UNKNOWN = 0,
312 BUS_DMA = 1,
313 BUS_IDLE = 2,
314 BUS_NOINTR = 3,
315 BUS_NODATA = 4,
316 BUS_TIMER = 5,
317 BUS_PIO = 6,
318 BUS_EDD = 7,
319 BUS_IDENTIFY = 8,
320 BUS_PACKET = 9,
321
322 /* SATA port states */
323 PORT_UNKNOWN = 0,
324 PORT_ENABLED = 1,
325 PORT_DISABLED = 2,
326
327 /* encoding various smaller bitmaps into a single
Tejun Heo7dc951a2007-11-27 19:43:42 +0900328 * unsigned long bitmap
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329 */
Tejun Heo70cd0712007-11-27 19:43:40 +0900330 ATA_NR_PIO_MODES = 7,
331 ATA_NR_MWDMA_MODES = 5,
332 ATA_NR_UDMA_MODES = 8,
Tejun Heo1da7b0d2006-03-06 04:31:56 +0900333
334 ATA_SHIFT_PIO = 0,
Tejun Heo70cd0712007-11-27 19:43:40 +0900335 ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_NR_PIO_MODES,
336 ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_NR_MWDMA_MODES,
Tejun Heo1da7b0d2006-03-06 04:31:56 +0900337
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400338 /* size of buffer to pad xfers ending on unaligned boundaries */
339 ATA_DMA_PAD_SZ = 4,
Tejun Heo949b38a2006-04-02 18:51:52 +0900340
Tejun Heo0c247c52006-05-15 20:58:19 +0900341 /* ering size */
342 ATA_ERING_SIZE = 32,
343
Tejun Heo31cc23b2007-09-23 13:14:12 +0900344 /* return values for ->qc_defer */
345 ATA_DEFER_LINK = 1,
346 ATA_DEFER_PORT = 2,
347
Tejun Heof3e81b12006-05-15 20:58:21 +0900348 /* desc_len for ata_eh_info and context */
349 ATA_EH_DESC_LEN = 80,
350
Tejun Heo9be1e972006-05-15 20:58:17 +0900351 /* reset / recovery action types */
352 ATA_EH_REVALIDATE = (1 << 0),
Tejun Heocf480622008-01-24 00:05:14 +0900353 ATA_EH_SOFTRESET = (1 << 1), /* meaningful only in ->prereset */
354 ATA_EH_HARDRESET = (1 << 2), /* meaningful only in ->prereset */
355 ATA_EH_RESET = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
Tejun Heof9df58c2007-09-23 13:14:13 +0900356 ATA_EH_ENABLE_LINK = (1 << 3),
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200357 ATA_EH_PARK = (1 << 5), /* unload heads and stop I/O */
Tejun Heo9be1e972006-05-15 20:58:17 +0900358
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200359 ATA_EH_PERDEV_MASK = ATA_EH_REVALIDATE | ATA_EH_PARK,
Tejun Heob5b3fa32008-07-31 17:02:42 +0900360 ATA_EH_ALL_ACTIONS = ATA_EH_REVALIDATE | ATA_EH_RESET |
Tejun Heo6b7ae952010-09-01 17:50:06 +0200361 ATA_EH_ENABLE_LINK,
Tejun Heo9be1e972006-05-15 20:58:17 +0900362
Tejun Heof3e81b12006-05-15 20:58:21 +0900363 /* ata_eh_info->flags */
Tejun Heoabdda732006-05-31 18:27:29 +0900364 ATA_EHI_HOTPLUGGED = (1 << 0), /* could have been hotplugged */
Tejun Heo1cdaf532006-07-03 16:07:26 +0900365 ATA_EHI_NO_AUTOPSY = (1 << 2), /* no autopsy */
366 ATA_EHI_QUIET = (1 << 3), /* be quiet */
Tejun Heoe2f3d752010-09-07 14:05:31 +0200367 ATA_EHI_NO_RECOVERY = (1 << 4), /* no recovery */
Tejun Heoabdda732006-05-31 18:27:29 +0900368
Tejun Heo0d64a232007-04-23 02:41:05 +0900369 ATA_EHI_DID_SOFTRESET = (1 << 16), /* already soft-reset this port */
370 ATA_EHI_DID_HARDRESET = (1 << 17), /* already soft-reset this port */
371 ATA_EHI_PRINTINFO = (1 << 18), /* print configuration info */
372 ATA_EHI_SETMODE = (1 << 19), /* configure transfer mode */
Andrea Gelmini89692c02010-10-16 15:19:18 +0200373 ATA_EHI_POST_SETMODE = (1 << 20), /* revalidating after setmode */
Tejun Heof3e81b12006-05-15 20:58:21 +0900374
Tejun Heo0d64a232007-04-23 02:41:05 +0900375 ATA_EHI_DID_RESET = ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
Tejun Heo13abf502006-07-10 23:18:46 +0900376
Tejun Heo848e4c62008-10-21 14:26:39 +0900377 /* mask of flags to transfer *to* the slave link */
378 ATA_EHI_TO_SLAVE_MASK = ATA_EHI_NO_AUTOPSY | ATA_EHI_QUIET,
379
Tejun Heoa1e10f72007-08-18 13:28:49 +0900380 /* max tries if error condition is still set after ->error_handler */
381 ATA_EH_MAX_TRIES = 5,
Tejun Heoad9e2762006-05-15 20:58:12 +0900382
Tejun Heo5040ab62010-01-11 11:14:44 +0900383 /* sometimes resuming a link requires several retries */
384 ATA_LINK_RESUME_TRIES = 5,
385
Tejun Heo14d2bac2006-04-02 17:54:46 +0900386 /* how hard are we gonna try to probe/recover devices */
387 ATA_PROBE_MAX_TRIES = 3,
Tejun Heo022bdb02006-05-15 20:58:22 +0900388 ATA_EH_DEV_TRIES = 3,
Tejun Heoe0a71752007-09-23 13:14:12 +0900389 ATA_EH_PMP_TRIES = 5,
390 ATA_EH_PMP_LINK_TRIES = 3,
391
Tejun Heobf1bff62008-05-19 01:15:10 +0900392 SATA_PMP_RW_TIMEOUT = 3000, /* PMP read/write timeout */
Tejun Heof5914a42006-05-31 18:27:48 +0900393
Tejun Heo87fbc5a2008-05-20 02:17:54 +0900394 /* This should match the actual table size of
395 * ata_eh_cmd_timeout_table in libata-eh.c.
396 */
Tejun Heo6013efd2009-11-19 15:36:45 +0900397 ATA_EH_CMD_TIMEOUT_TABLE_SIZE = 6,
Tejun Heo87fbc5a2008-05-20 02:17:54 +0900398
Alan Cox93590852006-09-12 16:55:12 +0100399 /* Horkage types. May be set by libata or controller on drives
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300400 (some horkage may be drive/controller pair dependent */
Alan Cox93590852006-09-12 16:55:12 +0100401
402 ATA_HORKAGE_DIAGNOSTIC = (1 << 0), /* Failed boot diag */
Alan Cox6919a0a2006-10-27 19:08:46 -0700403 ATA_HORKAGE_NODMA = (1 << 1), /* DMA problems */
404 ATA_HORKAGE_NONCQ = (1 << 2), /* Don't use NCQ */
Albert Lee18d6e9d2007-04-02 11:34:15 +0800405 ATA_HORKAGE_MAX_SEC_128 = (1 << 3), /* Limit max sects to 128 */
Tejun Heo16c55b02007-08-29 11:58:33 +0900406 ATA_HORKAGE_BROKEN_HPA = (1 << 4), /* Broken HPA */
Tejun Heo50af2fa2008-05-19 01:15:14 +0900407 ATA_HORKAGE_DISABLE = (1 << 5), /* Disable it */
Alan Cox93328e12007-09-29 04:06:48 -0400408 ATA_HORKAGE_HPA_SIZE = (1 << 6), /* native size off by one */
Alan Cox6bbfd532007-11-05 22:58:58 +0000409 ATA_HORKAGE_IVB = (1 << 8), /* cbl det validity bit bugs */
Albert Lee2d3b8ee2007-11-15 10:35:46 +0900410 ATA_HORKAGE_STUCK_ERR = (1 << 9), /* stuck ERR on next PACKET */
Jens Axboe9ce8e302008-08-27 15:23:18 +0200411 ATA_HORKAGE_BRIDGE_OK = (1 << 10), /* no bridge limits */
Tejun Heo6a87e422008-11-03 19:01:09 +0900412 ATA_HORKAGE_ATAPI_MOD16_DMA = (1 << 11), /* use ATAPI DMA for commands
413 not multiple of 16 bytes */
Nick Andrew877d0312009-01-26 11:06:57 +0100414 ATA_HORKAGE_FIRMWARE_WARN = (1 << 12), /* firmware update warning */
Tejun Heo90627122009-01-29 20:31:36 +0900415 ATA_HORKAGE_1_5_GBPS = (1 << 13), /* force 1.5 Gbps */
Tejun Heod0cb43b2009-07-09 09:27:50 +0900416 ATA_HORKAGE_NOSETXFER = (1 << 14), /* skip SETXFER, SATA only */
Shaohua Li388539f2009-07-27 09:24:35 +0800417 ATA_HORKAGE_BROKEN_FPDMA_AA = (1 << 15), /* skip AA */
Tejun Heo43c9c592010-05-23 12:59:11 +0200418 ATA_HORKAGE_DUMP_ID = (1 << 16), /* dump IDENTIFY data */
Shan Haia32450e2013-03-18 10:30:44 +0800419 ATA_HORKAGE_MAX_SEC_LBA48 = (1 << 17), /* Set max sects to 65535 */
Vincent Pelletier966fbe12013-05-21 22:30:58 +0200420 ATA_HORKAGE_ATAPI_DMADIR = (1 << 18), /* device requires dmadir */
Marc Carinof78dea02013-12-16 18:15:53 -0800421 ATA_HORKAGE_NO_NCQ_TRIM = (1 << 19), /* don't use queued TRIM */
Tejun Heoecd75ad2014-01-16 09:47:17 -0500422 ATA_HORKAGE_NOLPM = (1 << 20), /* don't use LPM */
423 ATA_HORKAGE_WD_BROKEN_LPM = (1 << 21), /* some WDs have broken LPM */
Alan Coxb3a70602007-10-02 12:38:26 -0400424
Jeff Garzik2dcb4072007-10-19 06:42:56 -0400425 /* DMA mask for user DMA control: User visible values; DO NOT
Alan Coxb3a70602007-10-02 12:38:26 -0400426 renumber */
427 ATA_DMA_MASK_ATA = (1 << 0), /* DMA on ATA Disk */
428 ATA_DMA_MASK_ATAPI = (1 << 1), /* DMA on ATAPI */
429 ATA_DMA_MASK_CFA = (1 << 2), /* DMA on CF Card */
Tejun Heoceb0c642007-12-05 16:43:06 +0900430
431 /* ATAPI command types */
432 ATAPI_READ = 0, /* READs */
433 ATAPI_WRITE = 1, /* WRITEs */
434 ATAPI_READ_CD = 2, /* READ CD [MSF] */
Tejun Heoe52dcc42008-04-02 17:35:19 +0900435 ATAPI_PASS_THRU = 3, /* SAT pass-thru */
436 ATAPI_MISC = 4, /* the rest */
Tejun Heo624d5c52008-03-25 22:16:41 +0900437
438 /* Timing constants */
439 ATA_TIMING_SETUP = (1 << 0),
440 ATA_TIMING_ACT8B = (1 << 1),
441 ATA_TIMING_REC8B = (1 << 2),
442 ATA_TIMING_CYC8B = (1 << 3),
443 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
444 ATA_TIMING_CYC8B,
445 ATA_TIMING_ACTIVE = (1 << 4),
446 ATA_TIMING_RECOVER = (1 << 5),
David Daney3ada9c12009-01-15 17:45:31 -0800447 ATA_TIMING_DMACK_HOLD = (1 << 6),
448 ATA_TIMING_CYCLE = (1 << 7),
449 ATA_TIMING_UDMA = (1 << 8),
Tejun Heo624d5c52008-03-25 22:16:41 +0900450 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
451 ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
452 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
David Daney3ada9c12009-01-15 17:45:31 -0800453 ATA_TIMING_DMACK_HOLD | ATA_TIMING_CYCLE |
454 ATA_TIMING_UDMA,
Tejun Heof1bce7f2009-09-16 04:16:04 +0900455
456 /* ACPI constants */
457 ATA_ACPI_FILTER_SETXFER = 1 << 0,
458 ATA_ACPI_FILTER_LOCK = 1 << 1,
459 ATA_ACPI_FILTER_DIPM = 1 << 2,
Tejun Heofa5b5612009-09-16 04:17:02 +0900460 ATA_ACPI_FILTER_FPDMA_OFFSET = 1 << 3, /* FPDMA non-zero offset */
461 ATA_ACPI_FILTER_FPDMA_AA = 1 << 4, /* FPDMA auto activate */
Tejun Heof1bce7f2009-09-16 04:16:04 +0900462
463 ATA_ACPI_FILTER_DEFAULT = ATA_ACPI_FILTER_SETXFER |
464 ATA_ACPI_FILTER_LOCK |
465 ATA_ACPI_FILTER_DIPM,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466};
467
Tejun Heo7dc951a2007-11-27 19:43:42 +0900468enum ata_xfer_mask {
469 ATA_MASK_PIO = ((1LU << ATA_NR_PIO_MODES) - 1)
470 << ATA_SHIFT_PIO,
471 ATA_MASK_MWDMA = ((1LU << ATA_NR_MWDMA_MODES) - 1)
472 << ATA_SHIFT_MWDMA,
473 ATA_MASK_UDMA = ((1LU << ATA_NR_UDMA_MODES) - 1)
474 << ATA_SHIFT_UDMA,
475};
476
Albert Lee14be71f2005-09-27 17:36:35 +0800477enum hsm_task_states {
Albert Leec56b14d22005-09-30 19:07:39 +0800478 HSM_ST_IDLE, /* no command on going */
Albert Lee71527642007-04-02 11:28:52 +0800479 HSM_ST_FIRST, /* (waiting the device to)
480 write CDB or first data block */
Albert Leec56b14d22005-09-30 19:07:39 +0800481 HSM_ST, /* (waiting the device to) transfer data */
482 HSM_ST_LAST, /* (waiting the device to) complete command */
Albert Leec56b14d22005-09-30 19:07:39 +0800483 HSM_ST_ERR, /* error */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484};
485
Jeff Garzika7dac442005-10-30 04:44:42 -0500486enum ata_completion_errors {
Tejun Heo11a56d22006-01-23 13:09:36 +0900487 AC_ERR_DEV = (1 << 0), /* device reported error */
488 AC_ERR_HSM = (1 << 1), /* host state machine violation */
489 AC_ERR_TIMEOUT = (1 << 2), /* timeout */
490 AC_ERR_MEDIA = (1 << 3), /* media error */
491 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
492 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
493 AC_ERR_SYSTEM = (1 << 6), /* system error */
494 AC_ERR_INVALID = (1 << 7), /* invalid argument */
495 AC_ERR_OTHER = (1 << 8), /* unknown */
Tejun Heo55a8e2c2006-11-10 18:08:10 +0900496 AC_ERR_NODEV_HINT = (1 << 9), /* polling device detection hint */
Tejun Heo5335b722007-07-16 14:29:40 +0900497 AC_ERR_NCQ = (1 << 10), /* marker for offending NCQ qc */
Jeff Garzika7dac442005-10-30 04:44:42 -0500498};
499
Tejun Heoc93b2632010-09-01 17:50:04 +0200500/*
501 * Link power management policy: If you alter this, you also need to
502 * alter libata-scsi.c (for the ascii descriptions)
503 */
504enum ata_lpm_policy {
505 ATA_LPM_UNKNOWN,
506 ATA_LPM_MAX_POWER,
507 ATA_LPM_MED_POWER,
508 ATA_LPM_MIN_POWER,
509};
510
Tejun Heo6b7ae952010-09-01 17:50:06 +0200511enum ata_lpm_hints {
512 ATA_LPM_EMPTY = (1 << 0), /* port empty/probing */
513 ATA_LPM_HIPM = (1 << 1), /* may use HIPM */
514};
515
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516/* forward declarations */
517struct scsi_device;
518struct ata_port_operations;
519struct ata_port;
Tejun Heocc0680a2007-08-06 18:36:23 +0900520struct ata_link;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521struct ata_queued_cmd;
522
523/* typedefs */
Tejun Heo77853bf2006-01-23 13:09:36 +0900524typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
Tejun Heocc0680a2007-08-06 18:36:23 +0900525typedef int (*ata_prereset_fn_t)(struct ata_link *link, unsigned long deadline);
526typedef int (*ata_reset_fn_t)(struct ata_link *link, unsigned int *classes,
Tejun Heod4b2bab2007-02-02 16:50:52 +0900527 unsigned long deadline);
Tejun Heocc0680a2007-08-06 18:36:23 +0900528typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529
Tony Jonesee959b02008-02-22 00:13:36 +0100530extern struct device_attribute dev_attr_link_power_management_policy;
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200531extern struct device_attribute dev_attr_unload_heads;
Kristen Carlson Accardi18f7ba42008-06-03 10:33:55 -0700532extern struct device_attribute dev_attr_em_message_type;
533extern struct device_attribute dev_attr_em_message;
534extern struct device_attribute dev_attr_sw_activity;
535
536enum sw_activity {
537 OFF,
538 BLINK_ON,
539 BLINK_OFF,
540};
Kristen Carlson Accardica773292007-10-25 00:58:59 -0400541
Sergei Shtylyovdc34e7e2013-07-01 00:01:32 +0400542struct ata_taskfile {
543 unsigned long flags; /* ATA_TFLAG_xxx */
544 u8 protocol; /* ATA_PROT_xxx */
545
546 u8 ctl; /* control reg */
547
548 u8 hob_feature; /* additional data */
549 u8 hob_nsect; /* to support LBA48 */
550 u8 hob_lbal;
551 u8 hob_lbam;
552 u8 hob_lbah;
553
554 u8 feature;
555 u8 nsect;
556 u8 lbal;
557 u8 lbam;
558 u8 lbah;
559
560 u8 device;
561
562 u8 command; /* IO operation */
Marc Carino8be5ad92013-08-24 23:22:48 -0700563
564 u32 auxiliary; /* auxiliary field */
565 /* from SATA 3.1 and */
566 /* ATA-8 ACS-3 */
Sergei Shtylyovdc34e7e2013-07-01 00:01:32 +0400567};
568
Tejun Heo127102a2008-04-07 22:47:21 +0900569#ifdef CONFIG_ATA_SFF
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570struct ata_ioports {
Tejun Heo0d5ff562007-02-01 15:06:36 +0900571 void __iomem *cmd_addr;
572 void __iomem *data_addr;
573 void __iomem *error_addr;
574 void __iomem *feature_addr;
575 void __iomem *nsect_addr;
576 void __iomem *lbal_addr;
577 void __iomem *lbam_addr;
578 void __iomem *lbah_addr;
579 void __iomem *device_addr;
580 void __iomem *status_addr;
581 void __iomem *command_addr;
582 void __iomem *altstatus_addr;
583 void __iomem *ctl_addr;
Tejun Heo9a7780c2010-05-19 22:10:24 +0200584#ifdef CONFIG_ATA_BMDMA
Tejun Heo0d5ff562007-02-01 15:06:36 +0900585 void __iomem *bmdma_addr;
Tejun Heo9a7780c2010-05-19 22:10:24 +0200586#endif /* CONFIG_ATA_BMDMA */
Tejun Heo0d5ff562007-02-01 15:06:36 +0900587 void __iomem *scr_addr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588};
Tejun Heo127102a2008-04-07 22:47:21 +0900589#endif /* CONFIG_ATA_SFF */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590
Jeff Garzikcca39742006-08-24 03:19:22 -0400591struct ata_host {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592 spinlock_t lock;
593 struct device *dev;
Tejun Heo0d5ff562007-02-01 15:06:36 +0900594 void __iomem * const *iomap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595 unsigned int n_ports;
596 void *private_data;
Tejun Heo029cfd62008-03-25 12:22:49 +0900597 struct ata_port_operations *ops;
Alan Cox5444a6f2006-03-27 18:58:20 +0100598 unsigned long flags;
Tejun Heoc0c362b2010-09-06 17:57:14 +0200599
600 struct mutex eh_mutex;
601 struct task_struct *eh_owner;
602
Alan032af1c2007-03-01 17:36:46 +0000603 struct ata_port *simplex_claimed; /* channel owning the DMA */
Tejun Heof0eb62b2006-06-12 23:05:38 +0900604 struct ata_port *ports[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605};
606
607struct ata_queued_cmd {
608 struct ata_port *ap;
609 struct ata_device *dev;
610
611 struct scsi_cmnd *scsicmd;
612 void (*scsidone)(struct scsi_cmnd *);
613
614 struct ata_taskfile tf;
615 u8 cdb[ATAPI_CDB_LEN];
616
617 unsigned long flags; /* ATA_QCFLAG_xxx */
618 unsigned int tag;
619 unsigned int n_elem;
FUJITA Tomonori58256272009-02-27 17:35:43 +0900620 unsigned int orig_n_elem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621
622 int dma_dir;
623
Mark Lord5a5dbd12007-03-16 10:22:26 -0400624 unsigned int sect_size;
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400625
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626 unsigned int nbytes;
Tejun Heoaacda372008-03-18 17:47:43 +0900627 unsigned int extrabytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628 unsigned int curbytes;
629
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630 struct scatterlist sgent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631
Tejun Heoff2aeb12007-12-05 16:43:11 +0900632 struct scatterlist *sg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633
Richard Kennedyb34e9042010-09-10 12:19:43 +0100634 struct scatterlist *cursg;
635 unsigned int cursg_ofs;
636
Albert Leea22e2eb2005-12-05 15:38:02 +0800637 unsigned int err_mask;
Tejun Heoe61e0672006-05-15 20:57:40 +0900638 struct ata_taskfile result_tf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639 ata_qc_cb_t complete_fn;
640
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641 void *private_data;
Darrick J. Wong1c50dc82007-01-30 01:18:41 -0800642 void *lldd_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643};
644
Jeff Garzikcca39742006-08-24 03:19:22 -0400645struct ata_port_stats {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646 unsigned long unhandled_irq;
647 unsigned long idle_irq;
648 unsigned long rw_reqbuf;
649};
650
Tejun Heo0c247c52006-05-15 20:58:19 +0900651struct ata_ering_entry {
Tejun Heo3884f7b2007-11-27 19:28:56 +0900652 unsigned int eflags;
Tejun Heo0c247c52006-05-15 20:58:19 +0900653 unsigned int err_mask;
654 u64 timestamp;
655};
656
657struct ata_ering {
658 int cursor;
659 struct ata_ering_entry ring[ATA_ERING_SIZE];
660};
661
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662struct ata_device {
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900663 struct ata_link *link;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664 unsigned int devno; /* 0 or 1 */
Tejun Heo75683fe2007-07-05 13:31:27 +0900665 unsigned int horkage; /* List of broken features */
Richard Kennedy6866e7b2008-09-22 14:47:13 -0700666 unsigned long flags; /* ATA_DFLAG_xxx */
Tejun Heo3edebac2006-05-31 18:27:40 +0900667 struct scsi_device *sdev; /* attached SCSI device */
Bartlomiej Zolnierkiewicz95514fd2009-11-25 18:12:48 +0100668 void *private_data;
Tejun Heofafbae82007-05-15 03:28:16 +0900669#ifdef CONFIG_ATA_ACPI
Tejun Heo398e0782007-12-15 15:05:03 +0900670 union acpi_object *gtf_cache;
Tejun Heo110f66d2009-09-16 04:17:28 +0900671 unsigned int gtf_filter;
Tejun Heofafbae82007-05-15 03:28:16 +0900672#endif
Aaron Luafe75952013-01-15 17:20:58 +0800673#ifdef CONFIG_SATA_ZPODD
674 void *zpodd;
675#endif
Gwendal Grignoud9027472010-05-25 12:31:38 -0700676 struct device tdev;
Tejun Heo99cf6102009-01-29 20:31:32 +0900677 /* n_sector is CLEAR_BEGIN, read comment above CLEAR_BEGIN */
Tejun Heo72fa4b72006-05-31 18:27:32 +0900678 u64 n_sectors; /* size of device, if ATA */
Tejun Heo5920dad2009-07-15 17:11:41 +0900679 u64 n_native_sectors; /* native size, if ATA */
Tejun Heo72fa4b72006-05-31 18:27:32 +0900680 unsigned int class; /* ATA_DEV_xxx */
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200681 unsigned long unpark_deadline;
Tejun Heoe0a71752007-09-23 13:14:12 +0900682
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683 u8 pio_mode;
684 u8 dma_mode;
685 u8 xfer_mode;
686 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
687
Albert Lee8cbd6df2005-10-12 15:06:27 +0800688 unsigned int multi_count; /* sectors count for
689 READ/WRITE MULTIPLE */
Tejun Heob00eec12006-02-12 23:32:59 +0900690 unsigned int max_sectors; /* per-device max sectors */
Tejun Heo6e7846e2006-02-12 23:32:58 +0900691 unsigned int cdb_len;
Albert Lee8bf62ece2005-05-12 15:29:42 -0400692
Tejun Heoacf356b2006-03-24 14:07:50 +0900693 /* per-dev xfer mask */
Tejun Heo7dc951a2007-11-27 19:43:42 +0900694 unsigned long pio_mask;
695 unsigned long mwdma_mask;
696 unsigned long udma_mask;
Tejun Heoacf356b2006-03-24 14:07:50 +0900697
Albert Lee8bf62ece2005-05-12 15:29:42 -0400698 /* for CHS addressing */
699 u16 cylinders; /* Number of cylinders */
700 u16 heads; /* Number of heads */
701 u16 sectors; /* Number of sectors per track */
Tejun Heo0c247c52006-05-15 20:58:19 +0900702
Jeff Garzikf7e98932008-04-29 17:47:34 -0400703 union {
704 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
705 u32 gscr[SATA_PMP_GSCR_DWORDS]; /* PMP GSCR block */
706 };
Tejun Heo99cf6102009-01-29 20:31:32 +0900707
Shane Huang803739d2012-12-17 23:18:59 +0800708 /* DEVSLP Timing Variables from Identify Device Data Log */
709 u8 devslp_timing[ATA_LOG_DEVSLP_SIZE];
Shane Huang65fe1f02012-09-07 22:40:01 +0800710
Marc Carinoed369112013-08-24 23:22:50 -0700711 /* NCQ send and receive log subcommand support */
712 u8 ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_SIZE];
713
Tejun Heo99cf6102009-01-29 20:31:32 +0900714 /* error history */
715 int spdn_cnt;
716 /* ering is CLEAR_END, read comment above CLEAR_END */
717 struct ata_ering ering;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718};
719
Tejun Heo99cf6102009-01-29 20:31:32 +0900720/* Fields between ATA_DEVICE_CLEAR_BEGIN and ATA_DEVICE_CLEAR_END are
721 * cleared to zero on ata_dev_init().
Tejun Heo72fa4b72006-05-31 18:27:32 +0900722 */
Tejun Heo99cf6102009-01-29 20:31:32 +0900723#define ATA_DEVICE_CLEAR_BEGIN offsetof(struct ata_device, n_sectors)
724#define ATA_DEVICE_CLEAR_END offsetof(struct ata_device, ering)
Tejun Heo72fa4b72006-05-31 18:27:32 +0900725
Tejun Heof3e81b12006-05-15 20:58:21 +0900726struct ata_eh_info {
727 struct ata_device *dev; /* offending device */
728 u32 serror; /* SError from LLDD */
729 unsigned int err_mask; /* port-wide err_mask */
730 unsigned int action; /* ATA_EH_* action mask */
Tejun Heo47005f22006-06-19 18:27:23 +0900731 unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */
Tejun Heof3e81b12006-05-15 20:58:21 +0900732 unsigned int flags; /* ATA_EHI_* flags */
Tejun Heoabdda732006-05-31 18:27:29 +0900733
Tejun Heoabdda732006-05-31 18:27:29 +0900734 unsigned int probe_mask;
735
Tejun Heof3e81b12006-05-15 20:58:21 +0900736 char desc[ATA_EH_DESC_LEN];
737 int desc_len;
738};
739
740struct ata_eh_context {
741 struct ata_eh_info i;
742 int tries[ATA_MAX_DEVICES];
Tejun Heo87fbc5a2008-05-20 02:17:54 +0900743 int cmd_timeout_idx[ATA_MAX_DEVICES]
744 [ATA_EH_CMD_TIMEOUT_TABLE_SIZE];
Tejun Heoabdda732006-05-31 18:27:29 +0900745 unsigned int classes[ATA_MAX_DEVICES];
746 unsigned int did_probe_mask;
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200747 unsigned int unloaded_mask;
Tejun Heo00115e02007-11-27 19:28:58 +0900748 unsigned int saved_ncq_enabled;
749 u8 saved_xfer_mode[ATA_MAX_DEVICES];
Tejun Heo0a2c0f52008-05-20 02:17:52 +0900750 /* timestamp for the last reset attempt or success */
751 unsigned long last_reset;
Tejun Heof3e81b12006-05-15 20:58:21 +0900752};
753
Tejun Heo64578a32007-05-15 03:28:16 +0900754struct ata_acpi_drive
755{
756 u32 pio;
757 u32 dma;
758} __packed;
759
760struct ata_acpi_gtm {
761 struct ata_acpi_drive drive[2];
762 u32 flags;
763} __packed;
764
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900765struct ata_link {
766 struct ata_port *ap;
Tejun Heo89898052007-08-06 18:36:23 +0900767 int pmp; /* port multiplier port # */
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900768
Gwendal Grignoud9027472010-05-25 12:31:38 -0700769 struct device tdev;
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900770 unsigned int active_tag; /* active tag on this link */
771 u32 sactive; /* active NCQ commands */
772
Tejun Heo0c887582007-08-06 18:36:23 +0900773 unsigned int flags; /* ATA_LFLAG_xxx */
774
Tejun Heod127ea72008-07-31 16:09:34 +0900775 u32 saved_scontrol; /* SControl on probe */
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900776 unsigned int hw_sata_spd_limit;
777 unsigned int sata_spd_limit;
778 unsigned int sata_spd; /* current SATA PHY speed */
Tejun Heo6b7ae952010-09-01 17:50:06 +0200779 enum ata_lpm_policy lpm_policy;
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900780
781 /* record runtime error info, protected by host_set lock */
782 struct ata_eh_info eh_info;
783 /* EH context */
784 struct ata_eh_context eh_context;
785
786 struct ata_device device[ATA_MAX_DEVICES];
787};
Gwendal Grignoud9027472010-05-25 12:31:38 -0700788#define ATA_LINK_CLEAR_BEGIN offsetof(struct ata_link, active_tag)
789#define ATA_LINK_CLEAR_END offsetof(struct ata_link, device[0])
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900790
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791struct ata_port {
Jeff Garzikcca39742006-08-24 03:19:22 -0400792 struct Scsi_Host *scsi_host; /* our co-allocated scsi host */
Tejun Heo029cfd62008-03-25 12:22:49 +0900793 struct ata_port_operations *ops;
Jeff Garzikba6a1302006-06-22 23:46:10 -0400794 spinlock_t *lock;
Alan Coxe3cf95d2009-04-09 17:31:17 +0100795 /* Flags owned by the EH context. Only EH should touch these once the
796 port is active */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797 unsigned long flags; /* ATA_FLAG_xxx */
Alan Coxe3cf95d2009-04-09 17:31:17 +0100798 /* Flags that change dynamically, protected by ap->lock */
Tejun Heob51e9e52006-06-29 01:29:30 +0900799 unsigned int pflags; /* ATA_PFLAG_xxx */
Tejun Heo44877b42007-02-21 01:06:51 +0900800 unsigned int print_id; /* user visible unique port ID */
David Milburne628dc92013-05-14 13:48:40 -0500801 unsigned int local_port_no; /* host local port num */
Tejun Heo44877b42007-02-21 01:06:51 +0900802 unsigned int port_no; /* 0 based port no. inside the host */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803
Tejun Heo127102a2008-04-07 22:47:21 +0900804#ifdef CONFIG_ATA_SFF
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806 u8 ctl; /* cache of ATA control register */
807 u8 last_ctl; /* Cache last written value */
Gwendal Grignouea3c6452010-08-31 16:20:36 -0700808 struct ata_link* sff_pio_task_link; /* link currently used */
Tejun Heoc4291372010-05-10 21:41:38 +0200809 struct delayed_work sff_pio_task;
Tejun Heo9a7780c2010-05-19 22:10:24 +0200810#ifdef CONFIG_ATA_BMDMA
Tejun Heof60d7012010-05-10 21:41:41 +0200811 struct ata_bmdma_prd *bmdma_prd; /* BMDMA SG list */
812 dma_addr_t bmdma_prd_dma; /* and its DMA mapping */
Tejun Heo9a7780c2010-05-19 22:10:24 +0200813#endif /* CONFIG_ATA_BMDMA */
Tejun Heo5fe74542010-05-10 21:41:37 +0200814#endif /* CONFIG_ATA_SFF */
815
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816 unsigned int pio_mask;
817 unsigned int mwdma_mask;
818 unsigned int udma_mask;
819 unsigned int cbl; /* cable type; ATA_CBL_xxx */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820
821 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
Tejun Heo8a8bc222008-11-10 14:48:21 +0900822 unsigned long qc_allocated;
Tejun Heodedaf2b2006-05-15 21:03:43 +0900823 unsigned int qc_active;
Tejun Heoda917d62007-09-23 13:14:12 +0900824 int nr_active_links; /* #links with active qcs */
Tejun Heodedaf2b2006-05-15 21:03:43 +0900825
Tejun Heob1c72912008-07-31 17:02:43 +0900826 struct ata_link link; /* host default link */
827 struct ata_link *slave_link; /* see ata_slave_link_init() */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828
Tejun Heo89898052007-08-06 18:36:23 +0900829 int nr_pmp_links; /* nr of available PMP links */
830 struct ata_link *pmp_link; /* array of PMP links */
Tejun Heoda917d62007-09-23 13:14:12 +0900831 struct ata_link *excl_link; /* for PMP qc exclusion */
Tejun Heo89898052007-08-06 18:36:23 +0900832
Jeff Garzikcca39742006-08-24 03:19:22 -0400833 struct ata_port_stats stats;
834 struct ata_host *host;
Brian King2f1f6102006-03-23 17:30:15 -0600835 struct device *dev;
Gwendal Grignoud9027472010-05-25 12:31:38 -0700836 struct device tdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837
Tejun Heoad72cf92010-07-02 10:03:52 +0200838 struct mutex scsi_scan_mutex;
David Howells52bad642006-11-22 14:54:01 +0000839 struct delayed_work hotplug_task;
Jeff Garzik3b01b8a2006-06-12 00:22:04 -0400840 struct work_struct scsi_rescan_task;
Tejun Heo86e45b62006-03-05 15:29:09 +0900841
Albert Lee14be71f2005-09-27 17:36:35 +0800842 unsigned int hsm_task_state;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843
Randy Dunlapbfd60572006-01-17 19:34:42 -0500844 u32 msg_enable;
Tejun Heoa72ec4c2006-01-23 13:09:37 +0900845 struct list_head eh_done_q;
Tejun Heoc6cf9e92006-05-31 18:27:27 +0900846 wait_queue_head_t eh_wait_q;
Tejun Heoa1e10f72007-08-18 13:28:49 +0900847 int eh_tries;
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200848 struct completion park_req_pending;
Randy Dunlapbfd60572006-01-17 19:34:42 -0500849
Tejun Heo500530f2006-07-03 16:07:27 +0900850 pm_message_t pm_mesg;
851 int *pm_result;
Tejun Heo6b7ae952010-09-01 17:50:06 +0200852 enum ata_lpm_policy target_lpm_policy;
Tejun Heo500530f2006-07-03 16:07:27 +0900853
Tejun Heo5ddf24c2007-07-16 14:29:41 +0900854 struct timer_list fastdrain_timer;
855 unsigned long fastdrain_cnt;
856
Kristen Carlson Accardi18f7ba42008-06-03 10:33:55 -0700857 int em_message_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858 void *private_data;
Tejun Heofe635c72006-05-15 20:57:35 +0900859
Tejun Heofafbae82007-05-15 03:28:16 +0900860#ifdef CONFIG_ATA_ACPI
Tejun Heoc05e6ff2007-12-15 15:05:02 +0900861 struct ata_acpi_gtm __acpi_init_gtm; /* use ata_acpi_init_gtm() */
Tejun Heofafbae82007-05-15 03:28:16 +0900862#endif
Tejun Heo84bda122009-03-02 18:53:26 +0900863 /* owned by EH */
864 u8 sector_buf[ATA_SECT_SIZE] ____cacheline_aligned;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865};
866
Tejun Heo029cfd62008-03-25 12:22:49 +0900867/* The following initializer overrides a method to NULL whether one of
868 * its parent has the method defined or not. This is equivalent to
869 * ERR_PTR(-ENOENT). Unfortunately, ERR_PTR doesn't render a constant
870 * expression and thus can't be used as an initializer.
871 */
872#define ATA_OP_NULL (void *)(unsigned long)(-ENOENT)
873
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874struct ata_port_operations {
Tejun Heoc1bc8992008-03-25 12:22:47 +0900875 /*
876 * Command execution
877 */
878 int (*qc_defer)(struct ata_queued_cmd *qc);
879 int (*check_atapi_dma)(struct ata_queued_cmd *qc);
880 void (*qc_prep)(struct ata_queued_cmd *qc);
881 unsigned int (*qc_issue)(struct ata_queued_cmd *qc);
Tejun Heo22183bf2008-04-07 22:47:20 +0900882 bool (*qc_fill_rtf)(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883
Tejun Heoc1bc8992008-03-25 12:22:47 +0900884 /*
885 * Configuration and exception handling
886 */
887 int (*cable_detect)(struct ata_port *ap);
888 unsigned long (*mode_filter)(struct ata_device *dev, unsigned long xfer_mask);
889 void (*set_piomode)(struct ata_port *ap, struct ata_device *dev);
890 void (*set_dmamode)(struct ata_port *ap, struct ata_device *dev);
891 int (*set_mode)(struct ata_link *link, struct ata_device **r_failed_dev);
Alan Cox963e4972008-07-24 17:16:06 +0100892 unsigned int (*read_id)(struct ata_device *dev, struct ata_taskfile *tf, u16 *id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893
Tejun Heoc1bc8992008-03-25 12:22:47 +0900894 void (*dev_config)(struct ata_device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895
Tejun Heoc1bc8992008-03-25 12:22:47 +0900896 void (*freeze)(struct ata_port *ap);
897 void (*thaw)(struct ata_port *ap);
Tejun Heoa1efdab2008-03-25 12:22:50 +0900898 ata_prereset_fn_t prereset;
899 ata_reset_fn_t softreset;
900 ata_reset_fn_t hardreset;
901 ata_postreset_fn_t postreset;
902 ata_prereset_fn_t pmp_prereset;
903 ata_reset_fn_t pmp_softreset;
904 ata_reset_fn_t pmp_hardreset;
905 ata_postreset_fn_t pmp_postreset;
Tejun Heoc1bc8992008-03-25 12:22:47 +0900906 void (*error_handler)(struct ata_port *ap);
Alan Coxc96f1732009-03-24 10:23:46 +0000907 void (*lost_interrupt)(struct ata_port *ap);
Tejun Heoc1bc8992008-03-25 12:22:47 +0900908 void (*post_internal_cmd)(struct ata_queued_cmd *qc);
Dan Williamse4a9c372012-06-21 23:25:27 -0700909 void (*sched_eh)(struct ata_port *ap);
910 void (*end_eh)(struct ata_port *ap);
Tejun Heoc1bc8992008-03-25 12:22:47 +0900911
912 /*
913 * Optional features
914 */
Tejun Heo82ef04f2008-07-31 17:02:40 +0900915 int (*scr_read)(struct ata_link *link, unsigned int sc_reg, u32 *val);
916 int (*scr_write)(struct ata_link *link, unsigned int sc_reg, u32 val);
Tejun Heoc1bc8992008-03-25 12:22:47 +0900917 void (*pmp_attach)(struct ata_port *ap);
918 void (*pmp_detach)(struct ata_port *ap);
Tejun Heo6b7ae952010-09-01 17:50:06 +0200919 int (*set_lpm)(struct ata_link *link, enum ata_lpm_policy policy,
920 unsigned hints);
Tejun Heoc1bc8992008-03-25 12:22:47 +0900921
922 /*
923 * Start, stop, suspend and resume
924 */
925 int (*port_suspend)(struct ata_port *ap, pm_message_t mesg);
926 int (*port_resume)(struct ata_port *ap);
927 int (*port_start)(struct ata_port *ap);
928 void (*port_stop)(struct ata_port *ap);
929 void (*host_stop)(struct ata_host *host);
930
Tejun Heo127102a2008-04-07 22:47:21 +0900931#ifdef CONFIG_ATA_SFF
Tejun Heoc1bc8992008-03-25 12:22:47 +0900932 /*
933 * SFF / taskfile oriented ops
934 */
Tejun Heo5682ed32008-04-07 22:47:16 +0900935 void (*sff_dev_select)(struct ata_port *ap, unsigned int device);
Sergei Shtylyov41dec292010-05-07 22:47:50 +0400936 void (*sff_set_devctl)(struct ata_port *ap, u8 ctl);
Tejun Heo5682ed32008-04-07 22:47:16 +0900937 u8 (*sff_check_status)(struct ata_port *ap);
938 u8 (*sff_check_altstatus)(struct ata_port *ap);
939 void (*sff_tf_load)(struct ata_port *ap, const struct ata_taskfile *tf);
940 void (*sff_tf_read)(struct ata_port *ap, struct ata_taskfile *tf);
941 void (*sff_exec_command)(struct ata_port *ap,
942 const struct ata_taskfile *tf);
943 unsigned int (*sff_data_xfer)(struct ata_device *dev,
944 unsigned char *buf, unsigned int buflen, int rw);
Sergei Shtylyove42a5422010-05-07 22:49:02 +0400945 void (*sff_irq_on)(struct ata_port *);
Tejun Heo27943622010-01-19 10:49:19 +0900946 bool (*sff_irq_check)(struct ata_port *);
Tejun Heo5682ed32008-04-07 22:47:16 +0900947 void (*sff_irq_clear)(struct ata_port *);
Tejun Heo8244cd02010-05-10 21:41:36 +0200948 void (*sff_drain_fifo)(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949
Tejun Heo9a7780c2010-05-19 22:10:24 +0200950#ifdef CONFIG_ATA_BMDMA
Tejun Heoc1bc8992008-03-25 12:22:47 +0900951 void (*bmdma_setup)(struct ata_queued_cmd *qc);
952 void (*bmdma_start)(struct ata_queued_cmd *qc);
953 void (*bmdma_stop)(struct ata_queued_cmd *qc);
954 u8 (*bmdma_status)(struct ata_port *ap);
Tejun Heo9a7780c2010-05-19 22:10:24 +0200955#endif /* CONFIG_ATA_BMDMA */
Tejun Heo127102a2008-04-07 22:47:21 +0900956#endif /* CONFIG_ATA_SFF */
Tejun Heoc19ba8a2006-01-24 17:05:22 +0900957
Kristen Carlson Accardi18f7ba42008-06-03 10:33:55 -0700958 ssize_t (*em_show)(struct ata_port *ap, char *buf);
959 ssize_t (*em_store)(struct ata_port *ap, const char *message,
960 size_t size);
961 ssize_t (*sw_activity_show)(struct ata_device *dev, char *buf);
962 ssize_t (*sw_activity_store)(struct ata_device *dev,
963 enum sw_activity val);
Mark Langsdorf439d7a32013-05-30 15:17:30 -0500964 ssize_t (*transmit_led_message)(struct ata_port *ap, u32 state,
965 ssize_t size);
966
Tejun Heoc1bc8992008-03-25 12:22:47 +0900967 /*
968 * Obsolete
Tejun Heo9ec957f2006-05-15 20:57:58 +0900969 */
Tejun Heoc1bc8992008-03-25 12:22:47 +0900970 void (*phy_reset)(struct ata_port *ap);
971 void (*eng_timeout)(struct ata_port *ap);
Tejun Heo029cfd62008-03-25 12:22:49 +0900972
973 /*
974 * ->inherits must be the last field and all the preceding
975 * fields must be pointers.
976 */
977 const struct ata_port_operations *inherits;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978};
979
980struct ata_port_info {
Jeff Garzikcca39742006-08-24 03:19:22 -0400981 unsigned long flags;
Tejun Heo0c887582007-08-06 18:36:23 +0900982 unsigned long link_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983 unsigned long pio_mask;
984 unsigned long mwdma_mask;
985 unsigned long udma_mask;
Tejun Heo029cfd62008-03-25 12:22:49 +0900986 struct ata_port_operations *port_ops;
Alan Coxe99f8b52005-11-08 14:09:44 +0000987 void *private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988};
989
Alan Cox452503f2005-10-21 19:01:32 -0400990struct ata_timing {
991 unsigned short mode; /* ATA mode */
992 unsigned short setup; /* t1 */
993 unsigned short act8b; /* t2 for 8-bit I/O */
994 unsigned short rec8b; /* t2i for 8-bit I/O */
995 unsigned short cyc8b; /* t0 for 8-bit I/O */
996 unsigned short active; /* t2 or tD */
997 unsigned short recover; /* t2i or tK */
David Daney3ada9c12009-01-15 17:45:31 -0800998 unsigned short dmack_hold; /* tj */
Alan Cox452503f2005-10-21 19:01:32 -0400999 unsigned short cycle; /* t0 */
1000 unsigned short udma; /* t2CYCTYP/2 */
1001};
1002
Tejun Heo624d5c52008-03-25 22:16:41 +09001003/*
1004 * Core layer - drivers/ata/libata-core.c
1005 */
Tejun Heoe9c83912006-07-03 16:07:26 +09001006extern const unsigned long sata_deb_timing_normal[];
1007extern const unsigned long sata_deb_timing_hotplug[];
1008extern const unsigned long sata_deb_timing_long[];
1009
Tejun Heo029cfd62008-03-25 12:22:49 +09001010extern struct ata_port_operations ata_dummy_port_ops;
Tejun Heo21b0ad42007-04-17 23:44:07 +09001011extern const struct ata_port_info ata_dummy_port_info;
Tejun Heodd5b06c2006-08-10 16:59:12 +09001012
Sergei Shtylyovdc34e7e2013-07-01 00:01:32 +04001013/*
1014 * protocol tests
1015 */
1016static inline unsigned int ata_prot_flags(u8 prot)
1017{
1018 switch (prot) {
1019 case ATA_PROT_NODATA:
1020 return 0;
1021 case ATA_PROT_PIO:
1022 return ATA_PROT_FLAG_PIO;
1023 case ATA_PROT_DMA:
1024 return ATA_PROT_FLAG_DMA;
1025 case ATA_PROT_NCQ:
1026 return ATA_PROT_FLAG_DMA | ATA_PROT_FLAG_NCQ;
1027 case ATAPI_PROT_NODATA:
1028 return ATA_PROT_FLAG_ATAPI;
1029 case ATAPI_PROT_PIO:
1030 return ATA_PROT_FLAG_ATAPI | ATA_PROT_FLAG_PIO;
1031 case ATAPI_PROT_DMA:
1032 return ATA_PROT_FLAG_ATAPI | ATA_PROT_FLAG_DMA;
1033 }
1034 return 0;
1035}
1036
1037static inline int ata_is_atapi(u8 prot)
1038{
1039 return ata_prot_flags(prot) & ATA_PROT_FLAG_ATAPI;
1040}
1041
1042static inline int ata_is_nodata(u8 prot)
1043{
1044 return !(ata_prot_flags(prot) & ATA_PROT_FLAG_DATA);
1045}
1046
1047static inline int ata_is_pio(u8 prot)
1048{
1049 return ata_prot_flags(prot) & ATA_PROT_FLAG_PIO;
1050}
1051
1052static inline int ata_is_dma(u8 prot)
1053{
1054 return ata_prot_flags(prot) & ATA_PROT_FLAG_DMA;
1055}
1056
1057static inline int ata_is_ncq(u8 prot)
1058{
1059 return ata_prot_flags(prot) & ATA_PROT_FLAG_NCQ;
1060}
1061
1062static inline int ata_is_data(u8 prot)
1063{
1064 return ata_prot_flags(prot) & ATA_PROT_FLAG_DATA;
1065}
1066
1067static inline int is_multi_taskfile(struct ata_taskfile *tf)
1068{
1069 return (tf->command == ATA_CMD_READ_MULTI) ||
1070 (tf->command == ATA_CMD_WRITE_MULTI) ||
1071 (tf->command == ATA_CMD_READ_MULTI_EXT) ||
1072 (tf->command == ATA_CMD_WRITE_MULTI_EXT) ||
1073 (tf->command == ATA_CMD_WRITE_MULTI_FUA_EXT);
1074}
1075
Tejun Heoe9c83912006-07-03 16:07:26 +09001076static inline const unsigned long *
1077sata_ehc_deb_timing(struct ata_eh_context *ehc)
1078{
1079 if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
1080 return sata_deb_timing_hotplug;
1081 else
1082 return sata_deb_timing_normal;
1083}
Tejun Heod7bb4cc2006-05-31 18:27:46 +09001084
Tejun Heodd5b06c2006-08-10 16:59:12 +09001085static inline int ata_port_is_dummy(struct ata_port *ap)
1086{
1087 return ap->ops == &ata_dummy_port_ops;
1088}
1089
Tejun Heo936fd732007-08-06 18:36:23 +09001090extern int sata_set_spd(struct ata_link *link);
Tejun Heo0aa11132008-04-07 22:47:18 +09001091extern int ata_std_prereset(struct ata_link *link, unsigned long deadline);
Tejun Heoaa2731a2008-04-07 22:47:19 +09001092extern int ata_wait_after_reset(struct ata_link *link, unsigned long deadline,
1093 int (*check_ready)(struct ata_link *link));
Tejun Heo936fd732007-08-06 18:36:23 +09001094extern int sata_link_debounce(struct ata_link *link,
1095 const unsigned long *params, unsigned long deadline);
1096extern int sata_link_resume(struct ata_link *link, const unsigned long *params,
1097 unsigned long deadline);
Tejun Heo1152b262010-09-01 17:50:05 +02001098extern int sata_link_scr_lpm(struct ata_link *link, enum ata_lpm_policy policy,
1099 bool spm_wakeup);
Tejun Heocc0680a2007-08-06 18:36:23 +09001100extern int sata_link_hardreset(struct ata_link *link,
Tejun Heo9dadd452008-04-07 22:47:19 +09001101 const unsigned long *timing, unsigned long deadline,
1102 bool *online, int (*check_ready)(struct ata_link *));
Tejun Heo57c9efd2008-04-07 22:47:19 +09001103extern int sata_std_hardreset(struct ata_link *link, unsigned int *class,
1104 unsigned long deadline);
Tejun Heo203c75b2008-04-07 22:47:18 +09001105extern void ata_std_postreset(struct ata_link *link, unsigned int *classes);
Jeff Garzik28555682007-10-11 17:12:35 -04001106
Tejun Heof3187192007-04-17 23:44:07 +09001107extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
Tejun Heof5cda252007-04-17 23:44:07 +09001108extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
1109 const struct ata_port_info * const * ppi, int n_ports);
Tejun Heob1c72912008-07-31 17:02:43 +09001110extern int ata_slave_link_init(struct ata_port *ap);
Tejun Heoecef7252007-04-17 23:44:06 +09001111extern int ata_host_start(struct ata_host *host);
Tejun Heof3187192007-04-17 23:44:07 +09001112extern int ata_host_register(struct ata_host *host,
1113 struct scsi_host_template *sht);
Tejun Heof5cda252007-04-17 23:44:07 +09001114extern int ata_host_activate(struct ata_host *host, int irq,
1115 irq_handler_t irq_handler, unsigned long irq_flags,
1116 struct scsi_host_template *sht);
Tejun Heo0529c152007-01-20 16:00:26 +09001117extern void ata_host_detach(struct ata_host *host);
Dan Williams8d8e7d132012-07-09 21:06:08 -07001118extern void ata_host_init(struct ata_host *, struct device *, struct ata_port_operations *);
Jeff Garzik193515d2005-11-07 00:59:37 -05001119extern int ata_scsi_detect(struct scsi_host_template *sht);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
Jeff Garzikf2812332010-11-16 02:10:29 -05001121extern int ata_scsi_queuecmd(struct Scsi_Host *h, struct scsi_cmnd *cmd);
Jeff Garzik94be9a52009-01-16 10:17:09 -05001122extern int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *dev,
1123 int cmd, void __user *arg);
Brian King80289162006-08-07 14:27:31 -05001124extern void ata_sas_port_destroy(struct ata_port *);
Jeff Garzikcca39742006-08-24 03:19:22 -04001125extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
Brian King80289162006-08-07 14:27:31 -05001126 struct ata_port_info *, struct Scsi_Host *);
Dan Williamsb2024452012-03-21 21:09:07 -07001127extern void ata_sas_async_probe(struct ata_port *ap);
1128extern int ata_sas_sync_probe(struct ata_port *ap);
Brian King80289162006-08-07 14:27:31 -05001129extern int ata_sas_port_init(struct ata_port *);
1130extern int ata_sas_port_start(struct ata_port *ap);
1131extern void ata_sas_port_stop(struct ata_port *ap);
1132extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
Jeff Garzikb27dcfb2010-11-17 22:56:48 -05001133extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, struct ata_port *ap);
Tejun Heo936fd732007-08-06 18:36:23 +09001134extern int sata_scr_valid(struct ata_link *link);
1135extern int sata_scr_read(struct ata_link *link, int reg, u32 *val);
1136extern int sata_scr_write(struct ata_link *link, int reg, u32 val);
1137extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val);
Tejun Heob5b3fa32008-07-31 17:02:42 +09001138extern bool ata_link_online(struct ata_link *link);
1139extern bool ata_link_offline(struct ata_link *link);
Tejun Heo6ffa01d2007-03-02 17:32:47 +09001140#ifdef CONFIG_PM
Jeff Garzikcca39742006-08-24 03:19:22 -04001141extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
1142extern void ata_host_resume(struct ata_host *host);
Dan Williams2fcbdcb2012-06-21 23:41:46 -07001143extern int ata_sas_port_async_suspend(struct ata_port *ap, int *async);
1144extern int ata_sas_port_async_resume(struct ata_port *ap, int *async);
1145#else
1146static inline int ata_sas_port_async_suspend(struct ata_port *ap, int *async)
1147{
1148 return 0;
1149}
1150static inline int ata_sas_port_async_resume(struct ata_port *ap, int *async)
1151{
1152 return 0;
1153}
Tejun Heo6ffa01d2007-03-02 17:32:47 +09001154#endif
Jeff Garzik67846b32005-10-05 02:58:32 -04001155extern int ata_ratelimit(void);
Tejun Heo97750ce2010-09-06 17:56:29 +02001156extern void ata_msleep(struct ata_port *ap, unsigned int msecs);
1157extern u32 ata_wait_register(struct ata_port *ap, void __iomem *reg, u32 mask,
1158 u32 val, unsigned long interval, unsigned long timeout);
Tejun Heo436d34b2008-04-02 17:28:46 +09001159extern int atapi_cmd_type(u8 opcode);
Tejun Heo99771262007-07-16 14:29:38 +09001160extern void ata_tf_to_fis(const struct ata_taskfile *tf,
1161 u8 pmp, int is_cmd, u8 *fis);
Jeff Garzik057ace52005-10-22 14:27:05 -04001162extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
Tejun Heo7dc951a2007-11-27 19:43:42 +09001163extern unsigned long ata_pack_xfermask(unsigned long pio_mask,
1164 unsigned long mwdma_mask, unsigned long udma_mask);
1165extern void ata_unpack_xfermask(unsigned long xfer_mask,
1166 unsigned long *pio_mask, unsigned long *mwdma_mask,
1167 unsigned long *udma_mask);
1168extern u8 ata_xfer_mask2mode(unsigned long xfer_mask);
1169extern unsigned long ata_xfer_mode2mask(u8 xfer_mode);
1170extern int ata_xfer_mode2shift(unsigned long xfer_mode);
1171extern const char *ata_mode_string(unsigned long xfer_mask);
1172extern unsigned long ata_id_xfermask(const u16 *id);
Tejun Heo31cc23b2007-09-23 13:14:12 +09001173extern int ata_std_qc_defer(struct ata_queued_cmd *qc);
Brian Kinge46834c2006-03-17 17:04:03 -06001174extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001175extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
1176 unsigned int n_elem);
Jeff Garzik057ace52005-10-22 14:27:05 -04001177extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
Alan10305f02007-02-20 18:01:59 +00001178extern void ata_dev_disable(struct ata_device *adev);
Tejun Heo6a62a042006-02-13 10:02:46 +09001179extern void ata_id_string(const u16 *id, unsigned char *s,
1180 unsigned int ofs, unsigned int len);
1181extern void ata_id_c_string(const u16 *id, unsigned char *s,
1182 unsigned int ofs, unsigned int len);
Alan Cox963e4972008-07-24 17:16:06 +01001183extern unsigned int ata_do_dev_read_id(struct ata_device *dev,
1184 struct ata_taskfile *tf, u16 *id);
Tejun Heof686bcb2006-05-15 20:58:05 +09001185extern void ata_qc_complete(struct ata_queued_cmd *qc);
Tejun Heo79f97da2008-04-07 22:47:20 +09001186extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active);
Jeff Garzikb27dcfb2010-11-17 22:56:48 -05001187extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001188extern int ata_std_bios_param(struct scsi_device *sdev,
1189 struct block_device *bdev,
1190 sector_t capacity, int geom[]);
Tejun Heod8d91292010-05-15 20:09:34 +02001191extern void ata_scsi_unlock_native_capacity(struct scsi_device *sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001192extern int ata_scsi_slave_config(struct scsi_device *sdev);
Tejun Heo83c47bc2006-05-31 18:28:07 +09001193extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
Tejun Heoa6e6ce82006-05-15 21:03:48 +09001194extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
Mike Christiee881a172009-10-15 17:46:39 -07001195 int queue_depth, int reason);
Dan Williamsf6e67032011-09-20 15:10:33 -07001196extern int __ata_change_queue_depth(struct ata_port *ap, struct scsi_device *sdev,
1197 int queue_depth, int reason);
Tejun Heo3373efd2006-05-15 20:57:53 +09001198extern struct ata_device *ata_dev_pair(struct ata_device *adev);
Tejun Heo02607312007-08-06 18:36:23 +09001199extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
James Bottomley0e0b494c2011-01-23 09:42:50 -06001200extern void ata_scsi_port_error_handler(struct Scsi_Host *host, struct ata_port *ap);
1201extern void ata_scsi_cmd_error_handler(struct Scsi_Host *host, struct ata_port *ap, struct list_head *eh_q);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202
Alan Coxbe0d18d2007-03-06 02:37:56 -08001203extern int ata_cable_40wire(struct ata_port *ap);
1204extern int ata_cable_80wire(struct ata_port *ap);
1205extern int ata_cable_sata(struct ata_port *ap);
Tejun Heoc88f90c2007-11-27 19:43:48 +09001206extern int ata_cable_ignore(struct ata_port *ap);
Alan Coxbe0d18d2007-03-06 02:37:56 -08001207extern int ata_cable_unknown(struct ata_port *ap);
1208
Tejun Heo624d5c52008-03-25 22:16:41 +09001209/* Timing helpers */
Alan Cox1bc4ccf2006-01-09 17:18:14 +00001210extern unsigned int ata_pio_need_iordy(const struct ata_device *);
Tejun Heo63573572007-11-27 19:43:39 +09001211extern const struct ata_timing *ata_timing_find_mode(u8 xfer_mode);
Alan Cox452503f2005-10-21 19:01:32 -04001212extern int ata_timing_compute(struct ata_device *, unsigned short,
1213 struct ata_timing *, int, int);
1214extern void ata_timing_merge(const struct ata_timing *,
1215 const struct ata_timing *, struct ata_timing *,
1216 unsigned int);
Tejun Heoa0f79b92007-12-18 16:33:05 +09001217extern u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle);
Alan Cox452503f2005-10-21 19:01:32 -04001218
Tejun Heo624d5c52008-03-25 22:16:41 +09001219/* PCI */
1220#ifdef CONFIG_PCI
1221struct pci_dev;
1222
1223struct pci_bits {
1224 unsigned int reg; /* PCI config register to read */
1225 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
1226 unsigned long mask;
1227 unsigned long val;
Alan Cox452503f2005-10-21 19:01:32 -04001228};
1229
Tejun Heo624d5c52008-03-25 22:16:41 +09001230extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
1231extern void ata_pci_remove_one(struct pci_dev *pdev);
1232
1233#ifdef CONFIG_PM
1234extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
1235extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
1236extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
1237extern int ata_pci_device_resume(struct pci_dev *pdev);
1238#endif /* CONFIG_PM */
1239#endif /* CONFIG_PCI */
1240
Brian Norrisb7db04d2012-11-02 12:29:32 -07001241struct platform_device;
1242
1243extern int ata_platform_remove_one(struct platform_device *pdev);
1244
Tejun Heo624d5c52008-03-25 22:16:41 +09001245/*
1246 * ACPI - drivers/ata/libata-acpi.c
1247 */
Alan Coxe1ddb4b2007-08-16 02:33:36 -04001248#ifdef CONFIG_ATA_ACPI
Tejun Heoc05e6ff2007-12-15 15:05:02 +09001249static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1250{
1251 if (ap->pflags & ATA_PFLAG_INIT_GTM_VALID)
1252 return &ap->__acpi_init_gtm;
1253 return NULL;
1254}
Tejun Heo0d02f0b2007-12-15 15:04:57 +09001255int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm);
1256int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *stm);
Tejun Heo7c77fa42007-12-18 16:33:03 +09001257unsigned long ata_acpi_gtm_xfermask(struct ata_device *dev,
1258 const struct ata_acpi_gtm *gtm);
Tejun Heo021ee9a2007-12-18 16:33:06 +09001259int ata_acpi_cbl_80wire(struct ata_port *ap, const struct ata_acpi_gtm *gtm);
Alan Coxe1ddb4b2007-08-16 02:33:36 -04001260#else
Tejun Heoc05e6ff2007-12-15 15:05:02 +09001261static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1262{
1263 return NULL;
1264}
Tejun Heo7c77fa42007-12-18 16:33:03 +09001265
1266static inline int ata_acpi_stm(const struct ata_port *ap,
1267 struct ata_acpi_gtm *stm)
1268{
1269 return -ENOSYS;
1270}
1271
1272static inline int ata_acpi_gtm(const struct ata_port *ap,
1273 struct ata_acpi_gtm *stm)
1274{
1275 return -ENOSYS;
1276}
1277
1278static inline unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev,
1279 const struct ata_acpi_gtm *gtm)
1280{
1281 return 0;
1282}
Tejun Heo021ee9a2007-12-18 16:33:06 +09001283
1284static inline int ata_acpi_cbl_80wire(struct ata_port *ap,
1285 const struct ata_acpi_gtm *gtm)
1286{
1287 return 0;
1288}
Alan Coxe1ddb4b2007-08-16 02:33:36 -04001289#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001290
Tejun Heoece1d632006-04-02 18:51:53 +09001291/*
Tejun Heo624d5c52008-03-25 22:16:41 +09001292 * EH - drivers/ata/libata-eh.c
Tejun Heoece1d632006-04-02 18:51:53 +09001293 */
Tejun Heo7b70fc02006-05-15 20:58:07 +09001294extern void ata_port_schedule_eh(struct ata_port *ap);
Dan Williams81c757b2011-12-02 16:07:01 -08001295extern void ata_port_wait_eh(struct ata_port *ap);
Tejun Heodbd82612007-08-06 18:36:23 +09001296extern int ata_link_abort(struct ata_link *link);
Tejun Heo7b70fc02006-05-15 20:58:07 +09001297extern int ata_port_abort(struct ata_port *ap);
Tejun Heoe3180492006-05-15 20:58:09 +09001298extern int ata_port_freeze(struct ata_port *ap);
Tejun Heo7d77b242007-09-23 13:14:13 +09001299extern int sata_async_notification(struct ata_port *ap);
Tejun Heoe3180492006-05-15 20:58:09 +09001300
1301extern void ata_eh_freeze_port(struct ata_port *ap);
1302extern void ata_eh_thaw_port(struct ata_port *ap);
Tejun Heo7b70fc02006-05-15 20:58:07 +09001303
Tejun Heoece1d632006-04-02 18:51:53 +09001304extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
1305extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
Mark Lord10acf3b2008-05-02 02:14:53 -04001306extern void ata_eh_analyze_ncq_error(struct ata_link *link);
Tejun Heoece1d632006-04-02 18:51:53 +09001307
Tejun Heof5914a42006-05-31 18:27:48 +09001308extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
1309 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
1310 ata_postreset_fn_t postreset);
Tejun Heoa1efdab2008-03-25 12:22:50 +09001311extern void ata_std_error_handler(struct ata_port *ap);
Dan Williamse4a9c372012-06-21 23:25:27 -07001312extern void ata_std_sched_eh(struct ata_port *ap);
1313extern void ata_std_end_eh(struct ata_port *ap);
Kristen Carlson Accardi8a745f12011-03-04 10:24:11 -08001314extern int ata_link_nr_enabled(struct ata_link *link);
Tejun Heo022bdb02006-05-15 20:58:22 +09001315
Tejun Heo61440db2006-05-15 20:57:55 +09001316/*
Tejun Heo68d1d072008-03-25 12:22:49 +09001317 * Base operations to inherit from and initializers for sht
1318 *
1319 * Operations
1320 *
1321 * base : Common to all libata drivers.
1322 * sata : SATA controllers w/ native interface.
1323 * pmp : SATA controllers w/ PMP support.
1324 * sff : SFF ATA controllers w/o BMDMA support.
1325 * bmdma : SFF ATA controllers w/ BMDMA support.
1326 *
1327 * sht initializers
1328 *
1329 * BASE : Common to all libata drivers. The user must set
1330 * sg_tablesize and dma_boundary.
1331 * PIO : SFF ATA controllers w/ only PIO support.
1332 * BMDMA : SFF ATA controllers w/ BMDMA support. sg_tablesize and
1333 * dma_boundary are set to BMDMA limits.
1334 * NCQ : SATA controllers supporting NCQ. The user must set
1335 * sg_tablesize, dma_boundary and can_queue.
1336 */
1337extern const struct ata_port_operations ata_base_port_ops;
1338extern const struct ata_port_operations sata_port_ops;
Elias Oltmanns45fabbb2008-09-21 11:54:08 +02001339extern struct device_attribute *ata_common_sdev_attrs[];
Tejun Heo68d1d072008-03-25 12:22:49 +09001340
1341#define ATA_BASE_SHT(drv_name) \
1342 .module = THIS_MODULE, \
1343 .name = drv_name, \
1344 .ioctl = ata_scsi_ioctl, \
1345 .queuecommand = ata_scsi_queuecmd, \
1346 .can_queue = ATA_DEF_QUEUE, \
1347 .this_id = ATA_SHT_THIS_ID, \
1348 .cmd_per_lun = ATA_SHT_CMD_PER_LUN, \
1349 .emulated = ATA_SHT_EMULATED, \
1350 .use_clustering = ATA_SHT_USE_CLUSTERING, \
1351 .proc_name = drv_name, \
1352 .slave_configure = ata_scsi_slave_config, \
1353 .slave_destroy = ata_scsi_slave_destroy, \
Elias Oltmanns45fabbb2008-09-21 11:54:08 +02001354 .bios_param = ata_std_bios_param, \
Tejun Heod8d91292010-05-15 20:09:34 +02001355 .unlock_native_capacity = ata_scsi_unlock_native_capacity, \
Elias Oltmanns45fabbb2008-09-21 11:54:08 +02001356 .sdev_attrs = ata_common_sdev_attrs
Tejun Heo68d1d072008-03-25 12:22:49 +09001357
Tejun Heo68d1d072008-03-25 12:22:49 +09001358#define ATA_NCQ_SHT(drv_name) \
1359 ATA_BASE_SHT(drv_name), \
1360 .change_queue_depth = ata_scsi_change_queue_depth
1361
1362/*
Tejun Heo071f44b2008-04-07 22:47:22 +09001363 * PMP helpers
1364 */
Tejun Heo88fcd562008-04-07 22:47:22 +09001365#ifdef CONFIG_SATA_PMP
Tejun Heo071f44b2008-04-07 22:47:22 +09001366static inline bool sata_pmp_supported(struct ata_port *ap)
1367{
1368 return ap->flags & ATA_FLAG_PMP;
1369}
1370
1371static inline bool sata_pmp_attached(struct ata_port *ap)
1372{
1373 return ap->nr_pmp_links != 0;
1374}
1375
1376static inline int ata_is_host_link(const struct ata_link *link)
1377{
Tejun Heob1c72912008-07-31 17:02:43 +09001378 return link == &link->ap->link || link == link->ap->slave_link;
Tejun Heo071f44b2008-04-07 22:47:22 +09001379}
Tejun Heo88fcd562008-04-07 22:47:22 +09001380#else /* CONFIG_SATA_PMP */
1381static inline bool sata_pmp_supported(struct ata_port *ap)
1382{
1383 return false;
1384}
1385
1386static inline bool sata_pmp_attached(struct ata_port *ap)
1387{
1388 return false;
1389}
1390
1391static inline int ata_is_host_link(const struct ata_link *link)
1392{
1393 return 1;
1394}
1395#endif /* CONFIG_SATA_PMP */
Tejun Heo071f44b2008-04-07 22:47:22 +09001396
1397static inline int sata_srst_pmp(struct ata_link *link)
1398{
1399 if (sata_pmp_supported(link->ap) && ata_is_host_link(link))
1400 return SATA_PMP_CTRL_PORT;
1401 return link->pmp;
1402}
1403
1404/*
Tejun Heo61440db2006-05-15 20:57:55 +09001405 * printk helpers
1406 */
Joe Perchesb9075fa2011-10-31 17:11:33 -07001407__printf(3, 4)
Joe Perchesa9a79df2011-04-15 15:51:59 -07001408int ata_port_printk(const struct ata_port *ap, const char *level,
1409 const char *fmt, ...);
Joe Perchesb9075fa2011-10-31 17:11:33 -07001410__printf(3, 4)
Joe Perchesa9a79df2011-04-15 15:51:59 -07001411int ata_link_printk(const struct ata_link *link, const char *level,
1412 const char *fmt, ...);
Joe Perchesb9075fa2011-10-31 17:11:33 -07001413__printf(3, 4)
Joe Perchesa9a79df2011-04-15 15:51:59 -07001414int ata_dev_printk(const struct ata_device *dev, const char *level,
1415 const char *fmt, ...);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416
Joe Perchesa9a79df2011-04-15 15:51:59 -07001417#define ata_port_err(ap, fmt, ...) \
1418 ata_port_printk(ap, KERN_ERR, fmt, ##__VA_ARGS__)
1419#define ata_port_warn(ap, fmt, ...) \
1420 ata_port_printk(ap, KERN_WARNING, fmt, ##__VA_ARGS__)
1421#define ata_port_notice(ap, fmt, ...) \
1422 ata_port_printk(ap, KERN_NOTICE, fmt, ##__VA_ARGS__)
1423#define ata_port_info(ap, fmt, ...) \
1424 ata_port_printk(ap, KERN_INFO, fmt, ##__VA_ARGS__)
1425#define ata_port_dbg(ap, fmt, ...) \
1426 ata_port_printk(ap, KERN_DEBUG, fmt, ##__VA_ARGS__)
Tejun Heo9af5c9c2007-08-06 18:36:22 +09001427
Joe Perchesa9a79df2011-04-15 15:51:59 -07001428#define ata_link_err(link, fmt, ...) \
1429 ata_link_printk(link, KERN_ERR, fmt, ##__VA_ARGS__)
1430#define ata_link_warn(link, fmt, ...) \
1431 ata_link_printk(link, KERN_WARNING, fmt, ##__VA_ARGS__)
1432#define ata_link_notice(link, fmt, ...) \
1433 ata_link_printk(link, KERN_NOTICE, fmt, ##__VA_ARGS__)
1434#define ata_link_info(link, fmt, ...) \
1435 ata_link_printk(link, KERN_INFO, fmt, ##__VA_ARGS__)
1436#define ata_link_dbg(link, fmt, ...) \
1437 ata_link_printk(link, KERN_DEBUG, fmt, ##__VA_ARGS__)
1438
1439#define ata_dev_err(dev, fmt, ...) \
1440 ata_dev_printk(dev, KERN_ERR, fmt, ##__VA_ARGS__)
1441#define ata_dev_warn(dev, fmt, ...) \
1442 ata_dev_printk(dev, KERN_WARNING, fmt, ##__VA_ARGS__)
1443#define ata_dev_notice(dev, fmt, ...) \
1444 ata_dev_printk(dev, KERN_NOTICE, fmt, ##__VA_ARGS__)
1445#define ata_dev_info(dev, fmt, ...) \
1446 ata_dev_printk(dev, KERN_INFO, fmt, ##__VA_ARGS__)
1447#define ata_dev_dbg(dev, fmt, ...) \
1448 ata_dev_printk(dev, KERN_DEBUG, fmt, ##__VA_ARGS__)
Tejun Heo61440db2006-05-15 20:57:55 +09001449
Joe Perches06296a12011-04-15 15:52:00 -07001450void ata_print_version(const struct device *dev, const char *version);
1451
Tejun Heo61440db2006-05-15 20:57:55 +09001452/*
Tejun Heof3e81b12006-05-15 20:58:21 +09001453 * ata_eh_info helpers
1454 */
Joe Perchesb9075fa2011-10-31 17:11:33 -07001455extern __printf(2, 3)
1456void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
1457extern __printf(2, 3)
1458void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
Tejun Heob64bbc32007-07-16 14:29:39 +09001459extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
Tejun Heof3e81b12006-05-15 20:58:21 +09001460
Tejun Heoc0b6c032006-07-03 16:07:26 +09001461static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
1462{
Tejun Heob558edd2008-01-24 00:05:14 +09001463 ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
Tejun Heof8f1e1c2007-07-16 14:29:40 +09001464 ehi->flags |= ATA_EHI_HOTPLUGGED;
Tejun Heob558edd2008-01-24 00:05:14 +09001465 ehi->action |= ATA_EH_RESET | ATA_EH_ENABLE_LINK;
Tejun Heoc0b6c032006-07-03 16:07:26 +09001466 ehi->err_mask |= AC_ERR_ATA_BUS;
1467}
1468
Tejun Heof3e81b12006-05-15 20:58:21 +09001469/*
Tejun Heocbcdd872007-08-18 13:14:55 +09001470 * port description helpers
1471 */
Joe Perchesb9075fa2011-10-31 17:11:33 -07001472extern __printf(2, 3)
1473void ata_port_desc(struct ata_port *ap, const char *fmt, ...);
Tejun Heocbcdd872007-08-18 13:14:55 +09001474#ifdef CONFIG_PCI
1475extern void ata_port_pbar_desc(struct ata_port *ap, int bar, ssize_t offset,
1476 const char *name);
1477#endif
1478
Linus Torvalds1da177e2005-04-16 15:20:36 -07001479static inline unsigned int ata_tag_valid(unsigned int tag)
1480{
1481 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
1482}
1483
Tejun Heo2ab7db12006-05-15 20:58:02 +09001484static inline unsigned int ata_tag_internal(unsigned int tag)
1485{
Yoichi Yuasa83c063d2008-02-28 21:43:13 +09001486 return tag == ATA_TAG_INTERNAL;
Tejun Heo2ab7db12006-05-15 20:58:02 +09001487}
1488
Tejun Heo5806db22006-06-24 20:30:19 +09001489/*
1490 * device helpers
1491 */
Tejun Heoe1211e32006-04-01 01:38:18 +09001492static inline unsigned int ata_class_enabled(unsigned int class)
Tejun Heo597afd22006-03-01 01:25:38 +09001493{
Tejun Heoe0a71752007-09-23 13:14:12 +09001494 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI ||
1495 class == ATA_DEV_PMP || class == ATA_DEV_SEMB;
Tejun Heo597afd22006-03-01 01:25:38 +09001496}
1497
Tejun Heoe1211e32006-04-01 01:38:18 +09001498static inline unsigned int ata_class_disabled(unsigned int class)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001499{
Tejun Heoe0a71752007-09-23 13:14:12 +09001500 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP ||
1501 class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP;
Tejun Heoe1211e32006-04-01 01:38:18 +09001502}
1503
Tejun Heo002c8052006-04-02 17:54:46 +09001504static inline unsigned int ata_class_absent(unsigned int class)
1505{
1506 return !ata_class_enabled(class) && !ata_class_disabled(class);
1507}
1508
Tejun Heoe1211e32006-04-01 01:38:18 +09001509static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1510{
1511 return ata_class_enabled(dev->class);
1512}
1513
1514static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1515{
1516 return ata_class_disabled(dev->class);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001517}
1518
Tejun Heo002c8052006-04-02 17:54:46 +09001519static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1520{
1521 return ata_class_absent(dev->class);
1522}
1523
Tejun Heo5806db22006-06-24 20:30:19 +09001524/*
Tejun Heof58229f2007-08-06 18:36:23 +09001525 * link helpers
Tejun Heo5806db22006-06-24 20:30:19 +09001526 */
Tejun Heof58229f2007-08-06 18:36:23 +09001527static inline int ata_link_max_devices(const struct ata_link *link)
Tejun Heo5806db22006-06-24 20:30:19 +09001528{
Tejun Heo89898052007-08-06 18:36:23 +09001529 if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS)
Tejun Heo5806db22006-06-24 20:30:19 +09001530 return 2;
1531 return 1;
1532}
1533
Tejun Heoda917d62007-09-23 13:14:12 +09001534static inline int ata_link_active(struct ata_link *link)
1535{
1536 return ata_tag_valid(link->active_tag) || link->sactive;
1537}
1538
Tejun Heo1eca4362008-11-03 20:03:17 +09001539/*
1540 * Iterators
1541 *
1542 * ATA_LITER_* constants are used to select link iteration mode and
1543 * ATA_DITER_* device iteration mode.
1544 *
1545 * For a custom iteration directly using ata_{link|dev}_next(), if
1546 * @link or @dev, respectively, is NULL, the first element is
1547 * returned. @dev and @link can be any valid device or link and the
1548 * next element according to the iteration mode will be returned.
1549 * After the last element, NULL is returned.
1550 */
1551enum ata_link_iter_mode {
1552 ATA_LITER_EDGE, /* if present, PMP links only; otherwise,
1553 * host link. no slave link */
1554 ATA_LITER_HOST_FIRST, /* host link followed by PMP or slave links */
1555 ATA_LITER_PMP_FIRST, /* PMP links followed by host link,
1556 * slave link still comes after host link */
1557};
Tejun Heo89898052007-08-06 18:36:23 +09001558
Tejun Heo1eca4362008-11-03 20:03:17 +09001559enum ata_dev_iter_mode {
1560 ATA_DITER_ENABLED,
1561 ATA_DITER_ENABLED_REVERSE,
1562 ATA_DITER_ALL,
1563 ATA_DITER_ALL_REVERSE,
1564};
Tejun Heo89898052007-08-06 18:36:23 +09001565
Tejun Heo1eca4362008-11-03 20:03:17 +09001566extern struct ata_link *ata_link_next(struct ata_link *link,
1567 struct ata_port *ap,
1568 enum ata_link_iter_mode mode);
Tejun Heof58229f2007-08-06 18:36:23 +09001569
Tejun Heo1eca4362008-11-03 20:03:17 +09001570extern struct ata_device *ata_dev_next(struct ata_device *dev,
1571 struct ata_link *link,
1572 enum ata_dev_iter_mode mode);
Tejun Heof58229f2007-08-06 18:36:23 +09001573
Tejun Heo1eca4362008-11-03 20:03:17 +09001574/*
1575 * Shortcut notation for iterations
1576 *
1577 * ata_for_each_link() iterates over each link of @ap according to
1578 * @mode. @link points to the current link in the loop. @link is
1579 * NULL after loop termination. ata_for_each_dev() works the same way
1580 * except that it iterates over each device of @link.
1581 *
1582 * Note that the mode prefixes ATA_{L|D}ITER_ shouldn't need to be
1583 * specified when using the following shorthand notations. Only the
1584 * mode itself (EDGE, HOST_FIRST, ENABLED, etc...) should be
1585 * specified. This not only increases brevity but also makes it
1586 * impossible to use ATA_LITER_* for device iteration or vice-versa.
1587 */
1588#define ata_for_each_link(link, ap, mode) \
1589 for ((link) = ata_link_next(NULL, (ap), ATA_LITER_##mode); (link); \
1590 (link) = ata_link_next((link), (ap), ATA_LITER_##mode))
1591
1592#define ata_for_each_dev(dev, link, mode) \
1593 for ((dev) = ata_dev_next(NULL, (link), ATA_DITER_##mode); (dev); \
1594 (dev) = ata_dev_next((dev), (link), ATA_DITER_##mode))
Tejun Heo5806db22006-06-24 20:30:19 +09001595
Tejun Heo6d1245b2007-02-20 23:20:27 +09001596/**
1597 * ata_ncq_enabled - Test whether NCQ is enabled
1598 * @dev: ATA device to test for
1599 *
1600 * LOCKING:
1601 * spin_lock_irqsave(host lock)
1602 *
1603 * RETURNS:
1604 * 1 if NCQ is enabled for @dev, 0 otherwise.
1605 */
1606static inline int ata_ncq_enabled(struct ata_device *dev)
1607{
1608 return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1609 ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1610}
Edward Falk0baab862005-06-02 18:17:13 -04001611
Marc Carino87fb6c32013-08-24 23:22:51 -07001612static inline bool ata_fpdma_dsm_supported(struct ata_device *dev)
1613{
1614 return (dev->flags & ATA_DFLAG_NCQ_SEND_RECV) &&
1615 (dev->ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_DSM_OFFSET] &
1616 ATA_LOG_NCQ_SEND_RECV_DSM_TRIM);
1617}
1618
Linus Torvalds1da177e2005-04-16 15:20:36 -07001619static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1620{
1621 qc->tf.ctl |= ATA_NIEN;
1622}
1623
Tejun Heof69499f2006-05-15 20:58:03 +09001624static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1625 unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626{
1627 if (likely(ata_tag_valid(tag)))
1628 return &ap->qcmd[tag];
1629 return NULL;
1630}
1631
Tejun Heof69499f2006-05-15 20:58:03 +09001632static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1633 unsigned int tag)
1634{
1635 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1636
1637 if (unlikely(!qc) || !ap->ops->error_handler)
1638 return qc;
1639
1640 if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1641 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1642 return qc;
1643
1644 return NULL;
1645}
1646
Tejun Heoaacda372008-03-18 17:47:43 +09001647static inline unsigned int ata_qc_raw_nbytes(struct ata_queued_cmd *qc)
1648{
1649 return qc->nbytes - min(qc->extrabytes, qc->nbytes);
1650}
1651
Tejun Heo3373efd2006-05-15 20:57:53 +09001652static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001653{
1654 memset(tf, 0, sizeof(*tf));
1655
Tejun Heo5fe74542010-05-10 21:41:37 +02001656#ifdef CONFIG_ATA_SFF
Tejun Heo9af5c9c2007-08-06 18:36:22 +09001657 tf->ctl = dev->link->ap->ctl;
Tejun Heo5fe74542010-05-10 21:41:37 +02001658#else
1659 tf->ctl = ATA_DEVCTL_OBS;
1660#endif
Tejun Heo3373efd2006-05-15 20:57:53 +09001661 if (dev->devno == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001662 tf->device = ATA_DEVICE_OBS;
1663 else
1664 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1665}
1666
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001667static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1668{
Tejun Heo501e0c502007-01-17 11:34:02 +09001669 qc->dma_dir = DMA_NONE;
Tejun Heoff2aeb12007-12-05 16:43:11 +09001670 qc->sg = NULL;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001671 qc->flags = 0;
Jens Axboe87260212007-10-16 11:14:12 +02001672 qc->cursg = NULL;
1673 qc->cursg_ofs = 0;
Tejun Heoaacda372008-03-18 17:47:43 +09001674 qc->nbytes = qc->extrabytes = qc->curbytes = 0;
Brian King7a801182007-01-17 12:32:12 -06001675 qc->n_elem = 0;
Albert Leea22e2eb2005-12-05 15:38:02 +08001676 qc->err_mask = 0;
Mark Lord5a5dbd12007-03-16 10:22:26 -04001677 qc->sect_size = ATA_SECT_SIZE;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001678
Tejun Heo3373efd2006-05-15 20:57:53 +09001679 ata_tf_init(qc->dev, &qc->tf);
Tejun Heoe61e0672006-05-15 20:57:40 +09001680
1681 /* init result_tf such that it indicates normal completion */
1682 qc->result_tf.command = ATA_DRDY;
1683 qc->result_tf.feature = 0;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001684}
1685
Jeff Garzik057ace52005-10-22 14:27:05 -04001686static inline int ata_try_flush_cache(const struct ata_device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001687{
1688 return ata_id_wcache_enabled(dev->id) ||
1689 ata_id_has_flush(dev->id) ||
1690 ata_id_has_flush_ext(dev->id);
1691}
1692
Jeff Garzika7dac442005-10-30 04:44:42 -05001693static inline unsigned int ac_err_mask(u8 status)
1694{
Albert Lee3655d1d2006-05-19 11:43:04 +08001695 if (status & (ATA_BUSY | ATA_DRQ))
Tejun Heo11a56d22006-01-23 13:09:36 +09001696 return AC_ERR_HSM;
Jeff Garzika7dac442005-10-30 04:44:42 -05001697 if (status & (ATA_ERR | ATA_DF))
1698 return AC_ERR_DEV;
1699 return 0;
1700}
1701
1702static inline unsigned int __ac_err_mask(u8 status)
1703{
1704 unsigned int mask = ac_err_mask(status);
1705 if (mask == 0)
1706 return AC_ERR_OTHER;
1707 return mask;
1708}
1709
Jeff Garzik35bb94b2006-04-11 13:12:34 -04001710static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1711{
Tejun Heo49114872007-04-17 23:44:06 +09001712 return *(struct ata_port **)&host->hostdata[0];
Jeff Garzik35bb94b2006-04-11 13:12:34 -04001713}
1714
Tejun Heo78ab88f2008-05-01 23:41:41 +09001715static inline int ata_check_ready(u8 status)
1716{
Jeff Garzik005b1f72008-05-09 15:00:55 -04001717 if (!(status & ATA_BUSY))
1718 return 1;
Tejun Heo78ab88f2008-05-01 23:41:41 +09001719
1720 /* 0xff indicates either no device or device not ready */
1721 if (status == 0xff)
1722 return -ENODEV;
1723
Jeff Garzik005b1f72008-05-09 15:00:55 -04001724 return 0;
Tejun Heo78ab88f2008-05-01 23:41:41 +09001725}
1726
Tejun Heo341c2c92008-05-20 02:17:51 +09001727static inline unsigned long ata_deadline(unsigned long from_jiffies,
1728 unsigned long timeout_msecs)
1729{
1730 return from_jiffies + msecs_to_jiffies(timeout_msecs);
1731}
1732
Alan Coxb15b3eb2008-08-01 09:18:34 +01001733/* Don't open code these in drivers as there are traps. Firstly the range may
1734 change in future hardware and specs, secondly 0xFF means 'no DMA' but is
1735 > UDMA_0. Dyma ddreigiau */
1736
1737static inline int ata_using_mwdma(struct ata_device *adev)
1738{
1739 if (adev->dma_mode >= XFER_MW_DMA_0 && adev->dma_mode <= XFER_MW_DMA_4)
1740 return 1;
1741 return 0;
1742}
1743
1744static inline int ata_using_udma(struct ata_device *adev)
1745{
1746 if (adev->dma_mode >= XFER_UDMA_0 && adev->dma_mode <= XFER_UDMA_7)
1747 return 1;
1748 return 0;
1749}
1750
1751static inline int ata_dma_enabled(struct ata_device *adev)
1752{
1753 return (adev->dma_mode == 0xFF ? 0 : 1);
1754}
Tejun Heo48515f62008-04-07 22:47:21 +09001755
1756/**************************************************************************
1757 * PMP - drivers/ata/libata-pmp.c
1758 */
Tejun Heo88fcd562008-04-07 22:47:22 +09001759#ifdef CONFIG_SATA_PMP
1760
Tejun Heo48515f62008-04-07 22:47:21 +09001761extern const struct ata_port_operations sata_pmp_port_ops;
1762
1763extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc);
1764extern void sata_pmp_error_handler(struct ata_port *ap);
1765
Tejun Heo88fcd562008-04-07 22:47:22 +09001766#else /* CONFIG_SATA_PMP */
1767
1768#define sata_pmp_port_ops sata_port_ops
1769#define sata_pmp_qc_defer_cmd_switch ata_std_qc_defer
1770#define sata_pmp_error_handler ata_std_error_handler
1771
1772#endif /* CONFIG_SATA_PMP */
1773
Tejun Heo48515f62008-04-07 22:47:21 +09001774
Tejun Heo624d5c52008-03-25 22:16:41 +09001775/**************************************************************************
1776 * SFF - drivers/ata/libata-sff.c
1777 */
Tejun Heo127102a2008-04-07 22:47:21 +09001778#ifdef CONFIG_ATA_SFF
1779
Tejun Heo624d5c52008-03-25 22:16:41 +09001780extern const struct ata_port_operations ata_sff_port_ops;
Alan Cox871af122009-01-05 14:16:39 +00001781extern const struct ata_port_operations ata_bmdma32_port_ops;
Tejun Heo624d5c52008-03-25 22:16:41 +09001782
1783/* PIO only, sg_tablesize and dma_boundary limits can be removed */
1784#define ATA_PIO_SHT(drv_name) \
1785 ATA_BASE_SHT(drv_name), \
1786 .sg_tablesize = LIBATA_MAX_PRD, \
1787 .dma_boundary = ATA_DMA_BOUNDARY
1788
Tejun Heo9363c382008-04-07 22:47:16 +09001789extern void ata_sff_dev_select(struct ata_port *ap, unsigned int device);
1790extern u8 ata_sff_check_status(struct ata_port *ap);
Alan Coxa57c1ba2008-05-29 22:10:58 +01001791extern void ata_sff_pause(struct ata_port *ap);
1792extern void ata_sff_dma_pause(struct ata_port *ap);
Tejun Heo9363c382008-04-07 22:47:16 +09001793extern int ata_sff_busy_sleep(struct ata_port *ap,
1794 unsigned long timeout_pat, unsigned long timeout);
Tejun Heo705e76b2008-04-07 22:47:19 +09001795extern int ata_sff_wait_ready(struct ata_link *link, unsigned long deadline);
Tejun Heo9363c382008-04-07 22:47:16 +09001796extern void ata_sff_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
1797extern void ata_sff_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
1798extern void ata_sff_exec_command(struct ata_port *ap,
1799 const struct ata_taskfile *tf);
1800extern unsigned int ata_sff_data_xfer(struct ata_device *dev,
Tejun Heo624d5c52008-03-25 22:16:41 +09001801 unsigned char *buf, unsigned int buflen, int rw);
Alan Cox871af122009-01-05 14:16:39 +00001802extern unsigned int ata_sff_data_xfer32(struct ata_device *dev,
1803 unsigned char *buf, unsigned int buflen, int rw);
Tejun Heo9363c382008-04-07 22:47:16 +09001804extern unsigned int ata_sff_data_xfer_noirq(struct ata_device *dev,
Tejun Heo624d5c52008-03-25 22:16:41 +09001805 unsigned char *buf, unsigned int buflen, int rw);
Sergei Shtylyove42a5422010-05-07 22:49:02 +04001806extern void ata_sff_irq_on(struct ata_port *ap);
Tejun Heo9363c382008-04-07 22:47:16 +09001807extern void ata_sff_irq_clear(struct ata_port *ap);
1808extern int ata_sff_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
1809 u8 status, int in_wq);
Viresh Kumar64b97592011-02-22 14:32:38 +05301810extern void ata_sff_queue_work(struct work_struct *work);
1811extern void ata_sff_queue_delayed_work(struct delayed_work *dwork,
1812 unsigned long delay);
Gwendal Grignouea3c6452010-08-31 16:20:36 -07001813extern void ata_sff_queue_pio_task(struct ata_link *link, unsigned long delay);
Tejun Heo9363c382008-04-07 22:47:16 +09001814extern unsigned int ata_sff_qc_issue(struct ata_queued_cmd *qc);
Tejun Heo22183bf2008-04-07 22:47:20 +09001815extern bool ata_sff_qc_fill_rtf(struct ata_queued_cmd *qc);
Tejun Heoc3b28892010-05-19 22:10:21 +02001816extern unsigned int ata_sff_port_intr(struct ata_port *ap,
Tejun Heo9363c382008-04-07 22:47:16 +09001817 struct ata_queued_cmd *qc);
1818extern irqreturn_t ata_sff_interrupt(int irq, void *dev_instance);
Alan Coxc96f1732009-03-24 10:23:46 +00001819extern void ata_sff_lost_interrupt(struct ata_port *ap);
Tejun Heo9363c382008-04-07 22:47:16 +09001820extern void ata_sff_freeze(struct ata_port *ap);
1821extern void ata_sff_thaw(struct ata_port *ap);
1822extern int ata_sff_prereset(struct ata_link *link, unsigned long deadline);
1823extern unsigned int ata_sff_dev_classify(struct ata_device *dev, int present,
1824 u8 *r_err);
Tejun Heo705e76b2008-04-07 22:47:19 +09001825extern int ata_sff_wait_after_reset(struct ata_link *link, unsigned int devmask,
1826 unsigned long deadline);
Tejun Heo9363c382008-04-07 22:47:16 +09001827extern int ata_sff_softreset(struct ata_link *link, unsigned int *classes,
Tejun Heo624d5c52008-03-25 22:16:41 +09001828 unsigned long deadline);
Tejun Heo9363c382008-04-07 22:47:16 +09001829extern int sata_sff_hardreset(struct ata_link *link, unsigned int *class,
1830 unsigned long deadline);
1831extern void ata_sff_postreset(struct ata_link *link, unsigned int *classes);
Alan Cox3d47aa82009-03-24 10:23:19 +00001832extern void ata_sff_drain_fifo(struct ata_queued_cmd *qc);
Tejun Heo9363c382008-04-07 22:47:16 +09001833extern void ata_sff_error_handler(struct ata_port *ap);
Tejun Heo9363c382008-04-07 22:47:16 +09001834extern void ata_sff_std_ports(struct ata_ioports *ioaddr);
Tejun Heo624d5c52008-03-25 22:16:41 +09001835#ifdef CONFIG_PCI
Tejun Heo9363c382008-04-07 22:47:16 +09001836extern int ata_pci_sff_init_host(struct ata_host *host);
1837extern int ata_pci_sff_prepare_host(struct pci_dev *pdev,
Tejun Heo624d5c52008-03-25 22:16:41 +09001838 const struct ata_port_info * const * ppi,
1839 struct ata_host **r_host);
Tejun Heo9363c382008-04-07 22:47:16 +09001840extern int ata_pci_sff_activate_host(struct ata_host *host,
Tejun Heo624d5c52008-03-25 22:16:41 +09001841 irq_handler_t irq_handler,
1842 struct scsi_host_template *sht);
Tejun Heo9363c382008-04-07 22:47:16 +09001843extern int ata_pci_sff_init_one(struct pci_dev *pdev,
Alan Cox16ea0fc2010-02-23 02:26:06 -05001844 const struct ata_port_info * const * ppi,
1845 struct scsi_host_template *sht, void *host_priv, int hflags);
Tejun Heo624d5c52008-03-25 22:16:41 +09001846#endif /* CONFIG_PCI */
1847
Tejun Heo9a7780c2010-05-19 22:10:24 +02001848#ifdef CONFIG_ATA_BMDMA
1849
1850extern const struct ata_port_operations ata_bmdma_port_ops;
1851
1852#define ATA_BMDMA_SHT(drv_name) \
1853 ATA_BASE_SHT(drv_name), \
1854 .sg_tablesize = LIBATA_MAX_PRD, \
1855 .dma_boundary = ATA_DMA_BOUNDARY
1856
Tejun Heof47451c2010-05-10 21:41:40 +02001857extern void ata_bmdma_qc_prep(struct ata_queued_cmd *qc);
Tejun Heo360ff782010-05-10 21:41:42 +02001858extern unsigned int ata_bmdma_qc_issue(struct ata_queued_cmd *qc);
Tejun Heof47451c2010-05-10 21:41:40 +02001859extern void ata_bmdma_dumb_qc_prep(struct ata_queued_cmd *qc);
Tejun Heoc3b28892010-05-19 22:10:21 +02001860extern unsigned int ata_bmdma_port_intr(struct ata_port *ap,
1861 struct ata_queued_cmd *qc);
1862extern irqreturn_t ata_bmdma_interrupt(int irq, void *dev_instance);
Tejun Heofe06e5f2010-05-10 21:41:39 +02001863extern void ata_bmdma_error_handler(struct ata_port *ap);
1864extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
Tejun Heo37f65b82010-05-19 22:10:20 +02001865extern void ata_bmdma_irq_clear(struct ata_port *ap);
Tejun Heo9f2f7212010-05-10 21:41:32 +02001866extern void ata_bmdma_setup(struct ata_queued_cmd *qc);
1867extern void ata_bmdma_start(struct ata_queued_cmd *qc);
1868extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
1869extern u8 ata_bmdma_status(struct ata_port *ap);
Tejun Heoc7087652010-05-10 21:41:34 +02001870extern int ata_bmdma_port_start(struct ata_port *ap);
1871extern int ata_bmdma_port_start32(struct ata_port *ap);
Tejun Heo9f2f7212010-05-10 21:41:32 +02001872
1873#ifdef CONFIG_PCI
1874extern int ata_pci_bmdma_clear_simplex(struct pci_dev *pdev);
Tejun Heoc7087652010-05-10 21:41:34 +02001875extern void ata_pci_bmdma_init(struct ata_host *host);
Tejun Heo1c5afdf2010-05-19 22:10:22 +02001876extern int ata_pci_bmdma_prepare_host(struct pci_dev *pdev,
1877 const struct ata_port_info * const * ppi,
1878 struct ata_host **r_host);
1879extern int ata_pci_bmdma_init_one(struct pci_dev *pdev,
1880 const struct ata_port_info * const * ppi,
1881 struct scsi_host_template *sht,
1882 void *host_priv, int hflags);
Tejun Heo9f2f7212010-05-10 21:41:32 +02001883#endif /* CONFIG_PCI */
Tejun Heo9a7780c2010-05-19 22:10:24 +02001884#endif /* CONFIG_ATA_BMDMA */
Tejun Heo9f2f7212010-05-10 21:41:32 +02001885
Tejun Heo624d5c52008-03-25 22:16:41 +09001886/**
Tejun Heo9363c382008-04-07 22:47:16 +09001887 * ata_sff_busy_wait - Wait for a port status register
Tejun Heo624d5c52008-03-25 22:16:41 +09001888 * @ap: Port to wait for.
1889 * @bits: bits that must be clear
1890 * @max: number of 10uS waits to perform
1891 *
1892 * Waits up to max*10 microseconds for the selected bits in the port's
1893 * status register to be cleared.
1894 * Returns final value of status register.
1895 *
1896 * LOCKING:
1897 * Inherited from caller.
1898 */
Tejun Heo9363c382008-04-07 22:47:16 +09001899static inline u8 ata_sff_busy_wait(struct ata_port *ap, unsigned int bits,
1900 unsigned int max)
Tejun Heo624d5c52008-03-25 22:16:41 +09001901{
1902 u8 status;
1903
1904 do {
1905 udelay(10);
Tejun Heo5682ed32008-04-07 22:47:16 +09001906 status = ap->ops->sff_check_status(ap);
Tejun Heo624d5c52008-03-25 22:16:41 +09001907 max--;
1908 } while (status != 0xff && (status & bits) && (max > 0));
1909
1910 return status;
1911}
1912
1913/**
1914 * ata_wait_idle - Wait for a port to be idle.
1915 * @ap: Port to wait for.
1916 *
1917 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
1918 * Returns final value of status register.
1919 *
1920 * LOCKING:
1921 * Inherited from caller.
1922 */
1923static inline u8 ata_wait_idle(struct ata_port *ap)
1924{
Tejun Heo9363c382008-04-07 22:47:16 +09001925 u8 status = ata_sff_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
Tejun Heo624d5c52008-03-25 22:16:41 +09001926
1927#ifdef ATA_DEBUG
1928 if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
1929 ata_port_printk(ap, KERN_DEBUG, "abnormal Status 0x%X\n",
1930 status);
1931#endif
1932
1933 return status;
1934}
Tejun Heo127102a2008-04-07 22:47:21 +09001935#endif /* CONFIG_ATA_SFF */
Tejun Heo624d5c52008-03-25 22:16:41 +09001936
Linus Torvalds1da177e2005-04-16 15:20:36 -07001937#endif /* __LINUX_LIBATA_H__ */