blob: bec2abbd7ab28485cbf32bfefa7430b6a47c81e4 [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 Heo140b5e592007-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,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137 ATA_SHT_THIS_ID = -1,
Jeff Garzikcf482932005-10-22 00:19:33 -0400138 ATA_SHT_USE_CLUSTERING = 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139
Sergei Shtylyovdc34e7e2013-07-01 00:01:32 +0400140 /* struct ata_taskfile flags */
141 ATA_TFLAG_LBA48 = (1 << 0), /* enable 48-bit LBA and "HOB" */
142 ATA_TFLAG_ISADDR = (1 << 1), /* enable r/w to nsect/lba regs */
143 ATA_TFLAG_DEVICE = (1 << 2), /* enable r/w to device reg */
144 ATA_TFLAG_WRITE = (1 << 3), /* data dir: host->dev==1 (write) */
145 ATA_TFLAG_LBA = (1 << 4), /* enable LBA */
146 ATA_TFLAG_FUA = (1 << 5), /* enable FUA */
147 ATA_TFLAG_POLLING = (1 << 6), /* set nIEN to 1 and use polling */
148
149 /* protocol flags */
150 ATA_PROT_FLAG_PIO = (1 << 0), /* is PIO */
151 ATA_PROT_FLAG_DMA = (1 << 1), /* is DMA */
152 ATA_PROT_FLAG_DATA = ATA_PROT_FLAG_PIO | ATA_PROT_FLAG_DMA,
153 ATA_PROT_FLAG_NCQ = (1 << 2), /* is NCQ */
154 ATA_PROT_FLAG_ATAPI = (1 << 3), /* is ATAPI */
155
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 /* struct ata_device stuff */
Tejun Heo949b38a2006-04-02 18:51:52 +0900157 ATA_DFLAG_LBA = (1 << 0), /* device supports LBA */
158 ATA_DFLAG_LBA48 = (1 << 1), /* device supports LBA48 */
Jeff Garzik029f5462006-04-02 10:30:40 -0400159 ATA_DFLAG_CDB_INTR = (1 << 2), /* device asserts INTRQ when ready for CDB */
Tejun Heo88e49032006-05-15 21:03:38 +0900160 ATA_DFLAG_NCQ = (1 << 3), /* device supports NCQ */
Tejun Heo6fc49ad2006-11-11 20:10:45 +0900161 ATA_DFLAG_FLUSH_EXT = (1 << 4), /* do FLUSH_EXT instead of FLUSH */
Tejun Heo67465442007-05-15 03:28:16 +0900162 ATA_DFLAG_ACPI_PENDING = (1 << 5), /* ACPI resume action pending */
163 ATA_DFLAG_ACPI_FAILED = (1 << 6), /* ACPI on devcfg has failed */
Tejun Heo7d77b242007-09-23 13:14:13 +0900164 ATA_DFLAG_AN = (1 << 7), /* AN configured */
Tejun Heo91163002008-02-21 13:25:50 +0900165 ATA_DFLAG_DMADIR = (1 << 10), /* device requires DMADIR */
Kristen Carlson Accardi25571642007-09-11 11:41:59 -0700166 ATA_DFLAG_CFG_MASK = (1 << 12) - 1,
Tejun Heo949b38a2006-04-02 18:51:52 +0900167
Kristen Carlson Accardi25571642007-09-11 11:41:59 -0700168 ATA_DFLAG_PIO = (1 << 12), /* device limited to PIO mode */
169 ATA_DFLAG_NCQ_OFF = (1 << 13), /* device limited to non-NCQ mode */
Tejun Heo054a5fb2007-10-25 18:30:36 +0900170 ATA_DFLAG_SLEEPING = (1 << 15), /* device is sleeping */
Tejun Heo00115e02007-11-27 19:28:58 +0900171 ATA_DFLAG_DUBIOUS_XFER = (1 << 16), /* data transfer not verified */
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200172 ATA_DFLAG_NO_UNLOAD = (1 << 17), /* device doesn't support unload */
Tejun Heo445d2112010-04-05 10:33:13 +0900173 ATA_DFLAG_UNLOCK_HPA = (1 << 18), /* unlock HPA */
Marc Carinoed369112013-08-24 23:22:50 -0700174 ATA_DFLAG_NCQ_SEND_RECV = (1 << 19), /* device supports NCQ SEND and RECV */
Tejun Heof20ded32007-11-27 19:28:52 +0900175 ATA_DFLAG_INIT_MASK = (1 << 24) - 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176
Tejun Heof20ded32007-11-27 19:28:52 +0900177 ATA_DFLAG_DETACH = (1 << 24),
178 ATA_DFLAG_DETACHED = (1 << 25),
Tejun Heoabdda732006-05-31 18:27:29 +0900179
Lin Mingb1354cb2012-06-25 16:13:08 +0800180 ATA_DFLAG_DA = (1 << 26), /* device supports Device Attention */
Shane Huang65fe1f02012-09-07 22:40:01 +0800181 ATA_DFLAG_DEVSLP = (1 << 27), /* device supports Device Sleep */
Aaron Lu0d0cdb02012-11-26 13:55:25 +0800182 ATA_DFLAG_ACPI_DISABLED = (1 << 28), /* ACPI for the device is disabled */
Lin Mingb1354cb2012-06-25 16:13:08 +0800183
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184 ATA_DEV_UNKNOWN = 0, /* unknown device */
185 ATA_DEV_ATA = 1, /* ATA device */
186 ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */
187 ATA_DEV_ATAPI = 3, /* ATAPI device */
188 ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */
Tejun Heoe0a71752007-09-23 13:14:12 +0900189 ATA_DEV_PMP = 5, /* SATA port multiplier */
190 ATA_DEV_PMP_UNSUP = 6, /* SATA port multiplier (unsupported) */
191 ATA_DEV_SEMB = 7, /* SEMB */
192 ATA_DEV_SEMB_UNSUP = 8, /* SEMB (unsupported) */
Hannes Reinecke9162c652014-11-05 13:08:21 +0100193 ATA_DEV_ZAC = 9, /* ZAC device */
194 ATA_DEV_NONE = 10, /* 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 */
Gabriele Mazzotta09c5b482015-04-25 19:52:37 +0200207 ATA_LFLAG_CHANGED = (1 << 10), /* LPM state changed on this link */
Danesh Petigarae39b2bb2016-01-07 16:03:33 -0800208 ATA_LFLAG_NO_DB_DELAY = (1 << 11), /* no debounce delay on link resume */
Tejun Heo0c887582007-08-06 18:36:23 +0900209
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210 /* struct ata_port flags */
Tejun Heo949b38a2006-04-02 18:51:52 +0900211 ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212 /* (doesn't imply presence) */
Tejun Heo949b38a2006-04-02 18:51:52 +0900213 ATA_FLAG_SATA = (1 << 1),
Andreas Wernerea013a92015-12-04 18:12:49 +0100214 ATA_FLAG_NO_LOG_PAGE = (1 << 5), /* do not issue log page read */
Tejun Heo949b38a2006-04-02 18:51:52 +0900215 ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */
216 ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */
217 ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */
Tejun Heo7395acb2006-05-31 18:27:25 +0900218 ATA_FLAG_PIO_POLLING = (1 << 9), /* use polling PIO if LLD
219 * doesn't handle PIO interrupts */
220 ATA_FLAG_NCQ = (1 << 10), /* host supports NCQ */
Rafael J. Wysocki2a6e58d2009-01-19 20:56:43 +0100221 ATA_FLAG_NO_POWEROFF_SPINDOWN = (1 << 11), /* don't spindown before poweroff */
222 ATA_FLAG_NO_HIBERNATE_SPINDOWN = (1 << 12), /* don't spindown before hibernation */
Tejun Heo7395acb2006-05-31 18:27:25 +0900223 ATA_FLAG_DEBUGMSG = (1 << 13),
Shaohua Li388539f2009-07-27 09:24:35 +0800224 ATA_FLAG_FPDMA_AA = (1 << 14), /* driver supports Auto-Activate */
Tejun Heob2a8bbe2007-01-25 19:40:05 +0900225 ATA_FLAG_IGN_SIMPLEX = (1 << 15), /* ignore SIMPLEX */
Alan Coxf834e492007-02-07 13:46:00 -0800226 ATA_FLAG_NO_IORDY = (1 << 16), /* controller lacks iordy */
Tejun Heo3cadbcc2007-05-15 03:28:15 +0900227 ATA_FLAG_ACPI_SATA = (1 << 17), /* need native SATA ACPI layout */
Kristen Carlson Accardi9f45cbd2007-08-15 03:57:11 -0400228 ATA_FLAG_AN = (1 << 18), /* controller supports AN */
Tejun Heoe0a71752007-09-23 13:14:12 +0900229 ATA_FLAG_PMP = (1 << 19), /* controller supports PMP */
Marc Carino40fb59e2013-08-24 23:22:49 -0700230 ATA_FLAG_FPDMA_AUX = (1 << 20), /* controller supports H2DFIS aux field */
Kristen Carlson Accardi18f7ba42008-06-03 10:33:55 -0700231 ATA_FLAG_EM = (1 << 21), /* driver supports enclosure
232 * management */
233 ATA_FLAG_SW_ACTIVITY = (1 << 22), /* driver supports sw activity
234 * led */
Tejun Heoae01b242011-03-16 11:14:55 +0100235 ATA_FLAG_NO_DIPM = (1 << 23), /* host not happy with DIPM */
Linus Torvaldsa1480a12015-04-13 16:42:16 -0700236 ATA_FLAG_SAS_HOST = (1 << 24), /* SAS host */
Jens Axboe9b847542006-01-06 09:28:07 +0100237
Tejun Heob51e9e52006-06-29 01:29:30 +0900238 /* bits 24:31 of ap->flags are reserved for LLD specific flags */
Alan Cox8d238e02006-01-17 20:50:31 +0000239
Alan Coxe3cf95d2009-04-09 17:31:17 +0100240
Tejun Heob51e9e52006-06-29 01:29:30 +0900241 /* struct ata_port pflags */
242 ATA_PFLAG_EH_PENDING = (1 << 0), /* EH pending */
243 ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */
244 ATA_PFLAG_FROZEN = (1 << 2), /* port is frozen */
245 ATA_PFLAG_RECOVERED = (1 << 3), /* recovery action performed */
246 ATA_PFLAG_LOADING = (1 << 4), /* boot/loading probe */
Tejun Heob51e9e52006-06-29 01:29:30 +0900247 ATA_PFLAG_SCSI_HOTPLUG = (1 << 6), /* SCSI hotplug scheduled */
Tejun Heof4d6d002007-05-01 11:50:15 +0200248 ATA_PFLAG_INITIALIZING = (1 << 7), /* being initialized, don't touch */
Tejun Heoafaa5c32007-10-09 15:06:10 +0900249 ATA_PFLAG_RESETTING = (1 << 8), /* reset in progress */
Tejun Heoece180d2008-11-03 20:04:37 +0900250 ATA_PFLAG_UNLOADING = (1 << 9), /* driver is being unloaded */
251 ATA_PFLAG_UNLOADED = (1 << 10), /* driver is unloaded */
Tejun Heob51e9e52006-06-29 01:29:30 +0900252
Tejun Heob51e9e52006-06-29 01:29:30 +0900253 ATA_PFLAG_SUSPENDED = (1 << 17), /* port is suspended (power) */
Tejun Heo500530f2006-07-03 16:07:27 +0900254 ATA_PFLAG_PM_PENDING = (1 << 18), /* PM operation pending */
Tejun Heoc05e6ff2007-12-15 15:05:02 +0900255 ATA_PFLAG_INIT_GTM_VALID = (1 << 19), /* initial gtm data valid */
Tejun Heodde44582006-02-02 00:56:10 +0900256
Alan Coxe3cf95d2009-04-09 17:31:17 +0100257 ATA_PFLAG_PIO32 = (1 << 20), /* 32bit PIO */
258 ATA_PFLAG_PIO32CHANGE = (1 << 21), /* 32bit PIO can be turned on/off */
Manuel Lauss8a3e33c2015-09-30 21:10:25 +0200259 ATA_PFLAG_EXTERNAL = (1 << 22), /* eSATA/external port */
Alan Coxe3cf95d2009-04-09 17:31:17 +0100260
Tejun Heo949b38a2006-04-02 18:51:52 +0900261 /* struct ata_queued_cmd flags */
262 ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */
Tejun Heo001102d2007-12-05 16:43:09 +0900263 ATA_QCFLAG_DMAMAP = (1 << 1), /* SG table is DMA mapped */
Tejun Heo27197362006-04-02 18:51:53 +0900264 ATA_QCFLAG_IO = (1 << 3), /* standard IO command */
Tejun Heoe61e0672006-05-15 20:57:40 +0900265 ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */
Tejun Heoda917d62007-09-23 13:14:12 +0900266 ATA_QCFLAG_CLEAR_EXCL = (1 << 5), /* clear excl_link on completion */
Tejun Heoe027bd32007-10-26 16:19:26 +0900267 ATA_QCFLAG_QUIET = (1 << 6), /* don't report device error */
Tejun Heo03faab72008-03-27 19:14:24 +0900268 ATA_QCFLAG_RETRY = (1 << 7), /* retry after failure */
Tejun Heoe61e0672006-05-15 20:57:40 +0900269
Tejun Heo9ec957f2006-05-15 20:57:58 +0900270 ATA_QCFLAG_FAILED = (1 << 16), /* cmd failed and is owned by EH */
271 ATA_QCFLAG_SENSE_VALID = (1 << 17), /* sense data valid */
272 ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273
Alan Cox4e5ec5d2006-03-27 18:42:40 +0100274 /* host set flags */
Jeff Garzikcca39742006-08-24 03:19:22 -0400275 ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host only */
Tejun Heoecef7252007-04-17 23:44:06 +0900276 ATA_HOST_STARTED = (1 << 1), /* Host started */
Arjan van de Ven886ad092009-01-09 15:54:07 -0800277 ATA_HOST_PARALLEL_SCAN = (1 << 2), /* Ports on this host can be scanned in parallel */
Andy Whitcroftdb63a4c2012-05-04 22:15:10 +0100278 ATA_HOST_IGNORE_ATA = (1 << 3), /* Ignore ATA devices on this host. */
Jeff Garzik9bec2e32006-08-31 00:02:15 -0400279
Tejun Heob8b275e2007-07-10 15:55:43 +0900280 /* bits 24:31 of host->flags are reserved for LLD specific flags */
281
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282 /* various lengths of time */
Tejun Heo341c2c92008-05-20 02:17:51 +0900283 ATA_TMOUT_BOOT = 30000, /* heuristic */
284 ATA_TMOUT_BOOT_QUICK = 7000, /* heuristic */
Tejun Heo341c2c92008-05-20 02:17:51 +0900285 ATA_TMOUT_INTERNAL_QUICK = 5000,
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200286 ATA_TMOUT_MAX_PARK = 30000,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287
Tejun Heob48d58f2010-04-09 19:46:38 +0900288 /*
289 * GoVault needs 2s and iVDR disk HHD424020F7SV00 800ms. 2s
290 * is too much without parallel probing. Use 2s if parallel
291 * probing is available, 800ms otherwise.
Tejun Heo88ff6ea2007-10-16 14:21:24 -0700292 */
Tejun Heob48d58f2010-04-09 19:46:38 +0900293 ATA_TMOUT_FF_WAIT_LONG = 2000,
294 ATA_TMOUT_FF_WAIT = 800,
Tejun Heo88ff6ea2007-10-16 14:21:24 -0700295
Tejun Heo705e76b2008-04-07 22:47:19 +0900296 /* Spec mandates to wait for ">= 2ms" before checking status
297 * after reset. We wait 150ms, because that was the magic
298 * delay used for ATAPI devices in Hale Landis's ATADRVR, for
299 * the period of time between when the ATA command register is
300 * written, and then status is checked. Because waiting for
301 * "a while" before checking status is fine, post SRST, we
302 * perform this magic delay here as well.
303 *
304 * Old drivers/ide uses the 2mS rule and then waits for ready.
305 */
Tejun Heo341c2c92008-05-20 02:17:51 +0900306 ATA_WAIT_AFTER_RESET = 150,
Tejun Heo705e76b2008-04-07 22:47:19 +0900307
Tejun Heo9dadd452008-04-07 22:47:19 +0900308 /* If PMP is supported, we have to do follow-up SRST. As some
309 * PMPs don't send D2H Reg FIS after hardreset, LLDs are
310 * advised to wait only for the following duration before
311 * doing SRST.
312 */
Stuart Hayese7d3ef12009-03-04 11:59:46 -0800313 ATA_TMOUT_PMP_SRST_WAIT = 5000,
Tejun Heo9dadd452008-04-07 22:47:19 +0900314
Gabriele Mazzotta09c5b482015-04-25 19:52:37 +0200315 /* When the LPM policy is set to ATA_LPM_MAX_POWER, there might
316 * be a spurious PHY event, so ignore the first PHY event that
317 * occurs within 10s after the policy change.
318 */
319 ATA_TMOUT_SPURIOUS_PHY = 10000,
320
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321 /* ATA bus states */
322 BUS_UNKNOWN = 0,
323 BUS_DMA = 1,
324 BUS_IDLE = 2,
325 BUS_NOINTR = 3,
326 BUS_NODATA = 4,
327 BUS_TIMER = 5,
328 BUS_PIO = 6,
329 BUS_EDD = 7,
330 BUS_IDENTIFY = 8,
331 BUS_PACKET = 9,
332
333 /* SATA port states */
334 PORT_UNKNOWN = 0,
335 PORT_ENABLED = 1,
336 PORT_DISABLED = 2,
337
338 /* encoding various smaller bitmaps into a single
Tejun Heo7dc951a2007-11-27 19:43:42 +0900339 * unsigned long bitmap
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340 */
Tejun Heo70cd0712007-11-27 19:43:40 +0900341 ATA_NR_PIO_MODES = 7,
342 ATA_NR_MWDMA_MODES = 5,
343 ATA_NR_UDMA_MODES = 8,
Tejun Heo1da7b0d2006-03-06 04:31:56 +0900344
345 ATA_SHIFT_PIO = 0,
Tejun Heo70cd0712007-11-27 19:43:40 +0900346 ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_NR_PIO_MODES,
347 ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_NR_MWDMA_MODES,
Tejun Heo1da7b0d2006-03-06 04:31:56 +0900348
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400349 /* size of buffer to pad xfers ending on unaligned boundaries */
350 ATA_DMA_PAD_SZ = 4,
Tejun Heo949b38a2006-04-02 18:51:52 +0900351
Tejun Heo0c247c52006-05-15 20:58:19 +0900352 /* ering size */
353 ATA_ERING_SIZE = 32,
354
Tejun Heo31cc23b2007-09-23 13:14:12 +0900355 /* return values for ->qc_defer */
356 ATA_DEFER_LINK = 1,
357 ATA_DEFER_PORT = 2,
358
Tejun Heof3e81b12006-05-15 20:58:21 +0900359 /* desc_len for ata_eh_info and context */
360 ATA_EH_DESC_LEN = 80,
361
Tejun Heo9be1e972006-05-15 20:58:17 +0900362 /* reset / recovery action types */
363 ATA_EH_REVALIDATE = (1 << 0),
Tejun Heocf480622008-01-24 00:05:14 +0900364 ATA_EH_SOFTRESET = (1 << 1), /* meaningful only in ->prereset */
365 ATA_EH_HARDRESET = (1 << 2), /* meaningful only in ->prereset */
366 ATA_EH_RESET = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
Tejun Heof9df58c2007-09-23 13:14:13 +0900367 ATA_EH_ENABLE_LINK = (1 << 3),
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200368 ATA_EH_PARK = (1 << 5), /* unload heads and stop I/O */
Tejun Heo9be1e972006-05-15 20:58:17 +0900369
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200370 ATA_EH_PERDEV_MASK = ATA_EH_REVALIDATE | ATA_EH_PARK,
Tejun Heob5b3fa32008-07-31 17:02:42 +0900371 ATA_EH_ALL_ACTIONS = ATA_EH_REVALIDATE | ATA_EH_RESET |
Tejun Heo6b7ae952010-09-01 17:50:06 +0200372 ATA_EH_ENABLE_LINK,
Tejun Heo9be1e972006-05-15 20:58:17 +0900373
Tejun Heof3e81b12006-05-15 20:58:21 +0900374 /* ata_eh_info->flags */
Tejun Heoabdda732006-05-31 18:27:29 +0900375 ATA_EHI_HOTPLUGGED = (1 << 0), /* could have been hotplugged */
Tejun Heo1cdaf532006-07-03 16:07:26 +0900376 ATA_EHI_NO_AUTOPSY = (1 << 2), /* no autopsy */
377 ATA_EHI_QUIET = (1 << 3), /* be quiet */
Tejun Heoe2f3d752010-09-07 14:05:31 +0200378 ATA_EHI_NO_RECOVERY = (1 << 4), /* no recovery */
Tejun Heoabdda732006-05-31 18:27:29 +0900379
Tejun Heo0d64a232007-04-23 02:41:05 +0900380 ATA_EHI_DID_SOFTRESET = (1 << 16), /* already soft-reset this port */
381 ATA_EHI_DID_HARDRESET = (1 << 17), /* already soft-reset this port */
382 ATA_EHI_PRINTINFO = (1 << 18), /* print configuration info */
383 ATA_EHI_SETMODE = (1 << 19), /* configure transfer mode */
Andrea Gelmini89692c02010-10-16 15:19:18 +0200384 ATA_EHI_POST_SETMODE = (1 << 20), /* revalidating after setmode */
Tejun Heof3e81b12006-05-15 20:58:21 +0900385
Tejun Heo0d64a232007-04-23 02:41:05 +0900386 ATA_EHI_DID_RESET = ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
Tejun Heo13abf502006-07-10 23:18:46 +0900387
Tejun Heo848e4c62008-10-21 14:26:39 +0900388 /* mask of flags to transfer *to* the slave link */
389 ATA_EHI_TO_SLAVE_MASK = ATA_EHI_NO_AUTOPSY | ATA_EHI_QUIET,
390
Tejun Heoa1e10f72007-08-18 13:28:49 +0900391 /* max tries if error condition is still set after ->error_handler */
392 ATA_EH_MAX_TRIES = 5,
Tejun Heoad9e2762006-05-15 20:58:12 +0900393
Tejun Heo5040ab62010-01-11 11:14:44 +0900394 /* sometimes resuming a link requires several retries */
395 ATA_LINK_RESUME_TRIES = 5,
396
Tejun Heo14d2bac2006-04-02 17:54:46 +0900397 /* how hard are we gonna try to probe/recover devices */
398 ATA_PROBE_MAX_TRIES = 3,
Tejun Heo022bdb02006-05-15 20:58:22 +0900399 ATA_EH_DEV_TRIES = 3,
Tejun Heoe0a71752007-09-23 13:14:12 +0900400 ATA_EH_PMP_TRIES = 5,
401 ATA_EH_PMP_LINK_TRIES = 3,
402
Tejun Heobf1bff62008-05-19 01:15:10 +0900403 SATA_PMP_RW_TIMEOUT = 3000, /* PMP read/write timeout */
Tejun Heof5914a42006-05-31 18:27:48 +0900404
Tejun Heo87fbc5a2008-05-20 02:17:54 +0900405 /* This should match the actual table size of
406 * ata_eh_cmd_timeout_table in libata-eh.c.
407 */
Tejun Heo6013efd2009-11-19 15:36:45 +0900408 ATA_EH_CMD_TIMEOUT_TABLE_SIZE = 6,
Tejun Heo87fbc5a2008-05-20 02:17:54 +0900409
Alan Cox93590852006-09-12 16:55:12 +0100410 /* Horkage types. May be set by libata or controller on drives
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300411 (some horkage may be drive/controller pair dependent */
Alan Cox93590852006-09-12 16:55:12 +0100412
413 ATA_HORKAGE_DIAGNOSTIC = (1 << 0), /* Failed boot diag */
Alan Cox6919a0a2006-10-27 19:08:46 -0700414 ATA_HORKAGE_NODMA = (1 << 1), /* DMA problems */
415 ATA_HORKAGE_NONCQ = (1 << 2), /* Don't use NCQ */
Albert Lee18d6e9d2007-04-02 11:34:15 +0800416 ATA_HORKAGE_MAX_SEC_128 = (1 << 3), /* Limit max sects to 128 */
Tejun Heo16c55b02007-08-29 11:58:33 +0900417 ATA_HORKAGE_BROKEN_HPA = (1 << 4), /* Broken HPA */
Tejun Heo50af2fa2008-05-19 01:15:14 +0900418 ATA_HORKAGE_DISABLE = (1 << 5), /* Disable it */
Alan Cox93328e12007-09-29 04:06:48 -0400419 ATA_HORKAGE_HPA_SIZE = (1 << 6), /* native size off by one */
Alan Cox6bbfd532007-11-05 22:58:58 +0000420 ATA_HORKAGE_IVB = (1 << 8), /* cbl det validity bit bugs */
Albert Lee2d3b8ee2007-11-15 10:35:46 +0900421 ATA_HORKAGE_STUCK_ERR = (1 << 9), /* stuck ERR on next PACKET */
Jens Axboe9ce8e302008-08-27 15:23:18 +0200422 ATA_HORKAGE_BRIDGE_OK = (1 << 10), /* no bridge limits */
Tejun Heo6a87e422008-11-03 19:01:09 +0900423 ATA_HORKAGE_ATAPI_MOD16_DMA = (1 << 11), /* use ATAPI DMA for commands
424 not multiple of 16 bytes */
Nick Andrew877d0312009-01-26 11:06:57 +0100425 ATA_HORKAGE_FIRMWARE_WARN = (1 << 12), /* firmware update warning */
Tejun Heo90627122009-01-29 20:31:36 +0900426 ATA_HORKAGE_1_5_GBPS = (1 << 13), /* force 1.5 Gbps */
Tejun Heod0cb43b2009-07-09 09:27:50 +0900427 ATA_HORKAGE_NOSETXFER = (1 << 14), /* skip SETXFER, SATA only */
Shaohua Li388539f2009-07-27 09:24:35 +0800428 ATA_HORKAGE_BROKEN_FPDMA_AA = (1 << 15), /* skip AA */
Tejun Heo43c9c592010-05-23 12:59:11 +0200429 ATA_HORKAGE_DUMP_ID = (1 << 16), /* dump IDENTIFY data */
Shan Haia32450e2013-03-18 10:30:44 +0800430 ATA_HORKAGE_MAX_SEC_LBA48 = (1 << 17), /* Set max sects to 65535 */
Vincent Pelletier966fbe12013-05-21 22:30:58 +0200431 ATA_HORKAGE_ATAPI_DMADIR = (1 << 18), /* device requires dmadir */
Marc Carinof78dea02013-12-16 18:15:53 -0800432 ATA_HORKAGE_NO_NCQ_TRIM = (1 << 19), /* don't use queued TRIM */
Tejun Heoecd75ad2014-01-16 09:47:17 -0500433 ATA_HORKAGE_NOLPM = (1 << 20), /* don't use LPM */
434 ATA_HORKAGE_WD_BROKEN_LPM = (1 << 21), /* some WDs have broken LPM */
Martin K. Petersene61f7d12015-01-08 10:34:27 -0500435 ATA_HORKAGE_ZERO_AFTER_TRIM = (1 << 22),/* guarantees zero after trim */
Martin K. Petersen5d3abf82015-05-04 21:54:21 -0400436 ATA_HORKAGE_NO_NCQ_LOG = (1 << 23), /* don't use NCQ for log read */
Arne Fitzenreiter71d126f2015-07-15 13:54:36 +0200437 ATA_HORKAGE_NOTRIM = (1 << 24), /* don't use TRIM */
David Milburnaf34d632015-07-13 11:48:23 -0500438 ATA_HORKAGE_MAX_SEC_1024 = (1 << 25), /* Limit max sects to 1024 */
Alan Coxb3a70602007-10-02 12:38:26 -0400439
Jeff Garzik2dcb4072007-10-19 06:42:56 -0400440 /* DMA mask for user DMA control: User visible values; DO NOT
Alan Coxb3a70602007-10-02 12:38:26 -0400441 renumber */
442 ATA_DMA_MASK_ATA = (1 << 0), /* DMA on ATA Disk */
443 ATA_DMA_MASK_ATAPI = (1 << 1), /* DMA on ATAPI */
444 ATA_DMA_MASK_CFA = (1 << 2), /* DMA on CF Card */
Tejun Heoceb0c642007-12-05 16:43:06 +0900445
446 /* ATAPI command types */
447 ATAPI_READ = 0, /* READs */
448 ATAPI_WRITE = 1, /* WRITEs */
449 ATAPI_READ_CD = 2, /* READ CD [MSF] */
Tejun Heoe52dcc42008-04-02 17:35:19 +0900450 ATAPI_PASS_THRU = 3, /* SAT pass-thru */
451 ATAPI_MISC = 4, /* the rest */
Tejun Heo624d5c52008-03-25 22:16:41 +0900452
453 /* Timing constants */
454 ATA_TIMING_SETUP = (1 << 0),
455 ATA_TIMING_ACT8B = (1 << 1),
456 ATA_TIMING_REC8B = (1 << 2),
457 ATA_TIMING_CYC8B = (1 << 3),
458 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
459 ATA_TIMING_CYC8B,
460 ATA_TIMING_ACTIVE = (1 << 4),
461 ATA_TIMING_RECOVER = (1 << 5),
David Daney3ada9c12009-01-15 17:45:31 -0800462 ATA_TIMING_DMACK_HOLD = (1 << 6),
463 ATA_TIMING_CYCLE = (1 << 7),
464 ATA_TIMING_UDMA = (1 << 8),
Tejun Heo624d5c52008-03-25 22:16:41 +0900465 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
466 ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
467 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
David Daney3ada9c12009-01-15 17:45:31 -0800468 ATA_TIMING_DMACK_HOLD | ATA_TIMING_CYCLE |
469 ATA_TIMING_UDMA,
Tejun Heof1bce7f2009-09-16 04:16:04 +0900470
471 /* ACPI constants */
472 ATA_ACPI_FILTER_SETXFER = 1 << 0,
473 ATA_ACPI_FILTER_LOCK = 1 << 1,
474 ATA_ACPI_FILTER_DIPM = 1 << 2,
Tejun Heofa5b5612009-09-16 04:17:02 +0900475 ATA_ACPI_FILTER_FPDMA_OFFSET = 1 << 3, /* FPDMA non-zero offset */
476 ATA_ACPI_FILTER_FPDMA_AA = 1 << 4, /* FPDMA auto activate */
Tejun Heof1bce7f2009-09-16 04:16:04 +0900477
478 ATA_ACPI_FILTER_DEFAULT = ATA_ACPI_FILTER_SETXFER |
479 ATA_ACPI_FILTER_LOCK |
480 ATA_ACPI_FILTER_DIPM,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481};
482
Tejun Heo7dc951a2007-11-27 19:43:42 +0900483enum ata_xfer_mask {
484 ATA_MASK_PIO = ((1LU << ATA_NR_PIO_MODES) - 1)
485 << ATA_SHIFT_PIO,
486 ATA_MASK_MWDMA = ((1LU << ATA_NR_MWDMA_MODES) - 1)
487 << ATA_SHIFT_MWDMA,
488 ATA_MASK_UDMA = ((1LU << ATA_NR_UDMA_MODES) - 1)
489 << ATA_SHIFT_UDMA,
490};
491
Albert Lee14be71f2005-09-27 17:36:35 +0800492enum hsm_task_states {
Albert Leec56b14d22005-09-30 19:07:39 +0800493 HSM_ST_IDLE, /* no command on going */
Albert Lee71527642007-04-02 11:28:52 +0800494 HSM_ST_FIRST, /* (waiting the device to)
495 write CDB or first data block */
Albert Leec56b14d22005-09-30 19:07:39 +0800496 HSM_ST, /* (waiting the device to) transfer data */
497 HSM_ST_LAST, /* (waiting the device to) complete command */
Albert Leec56b14d22005-09-30 19:07:39 +0800498 HSM_ST_ERR, /* error */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499};
500
Jeff Garzika7dac442005-10-30 04:44:42 -0500501enum ata_completion_errors {
Tejun Heo11a56d22006-01-23 13:09:36 +0900502 AC_ERR_DEV = (1 << 0), /* device reported error */
503 AC_ERR_HSM = (1 << 1), /* host state machine violation */
504 AC_ERR_TIMEOUT = (1 << 2), /* timeout */
505 AC_ERR_MEDIA = (1 << 3), /* media error */
506 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
507 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
508 AC_ERR_SYSTEM = (1 << 6), /* system error */
509 AC_ERR_INVALID = (1 << 7), /* invalid argument */
510 AC_ERR_OTHER = (1 << 8), /* unknown */
Tejun Heo55a8e2c2006-11-10 18:08:10 +0900511 AC_ERR_NODEV_HINT = (1 << 9), /* polling device detection hint */
Tejun Heo5335b722007-07-16 14:29:40 +0900512 AC_ERR_NCQ = (1 << 10), /* marker for offending NCQ qc */
Jeff Garzika7dac442005-10-30 04:44:42 -0500513};
514
Tejun Heoc93b2632010-09-01 17:50:04 +0200515/*
516 * Link power management policy: If you alter this, you also need to
517 * alter libata-scsi.c (for the ascii descriptions)
518 */
519enum ata_lpm_policy {
520 ATA_LPM_UNKNOWN,
521 ATA_LPM_MAX_POWER,
522 ATA_LPM_MED_POWER,
523 ATA_LPM_MIN_POWER,
524};
525
Tejun Heo6b7ae952010-09-01 17:50:06 +0200526enum ata_lpm_hints {
527 ATA_LPM_EMPTY = (1 << 0), /* port empty/probing */
528 ATA_LPM_HIPM = (1 << 1), /* may use HIPM */
Danesh Petigarafb329632016-01-11 13:22:26 -0800529 ATA_LPM_WAKE_ONLY = (1 << 2), /* only wake up link */
Tejun Heo6b7ae952010-09-01 17:50:06 +0200530};
531
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532/* forward declarations */
533struct scsi_device;
534struct ata_port_operations;
535struct ata_port;
Tejun Heocc0680a2007-08-06 18:36:23 +0900536struct ata_link;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537struct ata_queued_cmd;
538
539/* typedefs */
Tejun Heo77853bf2006-01-23 13:09:36 +0900540typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
Tejun Heocc0680a2007-08-06 18:36:23 +0900541typedef int (*ata_prereset_fn_t)(struct ata_link *link, unsigned long deadline);
542typedef int (*ata_reset_fn_t)(struct ata_link *link, unsigned int *classes,
Tejun Heod4b2bab2007-02-02 16:50:52 +0900543 unsigned long deadline);
Tejun Heocc0680a2007-08-06 18:36:23 +0900544typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545
Tony Jonesee959b02008-02-22 00:13:36 +0100546extern struct device_attribute dev_attr_link_power_management_policy;
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200547extern struct device_attribute dev_attr_unload_heads;
Kristen Carlson Accardi18f7ba42008-06-03 10:33:55 -0700548extern struct device_attribute dev_attr_em_message_type;
549extern struct device_attribute dev_attr_em_message;
550extern struct device_attribute dev_attr_sw_activity;
551
552enum sw_activity {
553 OFF,
554 BLINK_ON,
555 BLINK_OFF,
556};
Kristen Carlson Accardica773292007-10-25 00:58:59 -0400557
Sergei Shtylyovdc34e7e2013-07-01 00:01:32 +0400558struct ata_taskfile {
559 unsigned long flags; /* ATA_TFLAG_xxx */
560 u8 protocol; /* ATA_PROT_xxx */
561
562 u8 ctl; /* control reg */
563
564 u8 hob_feature; /* additional data */
565 u8 hob_nsect; /* to support LBA48 */
566 u8 hob_lbal;
567 u8 hob_lbam;
568 u8 hob_lbah;
569
570 u8 feature;
571 u8 nsect;
572 u8 lbal;
573 u8 lbam;
574 u8 lbah;
575
576 u8 device;
577
578 u8 command; /* IO operation */
Marc Carino8be5ad92013-08-24 23:22:48 -0700579
580 u32 auxiliary; /* auxiliary field */
581 /* from SATA 3.1 and */
582 /* ATA-8 ACS-3 */
Sergei Shtylyovdc34e7e2013-07-01 00:01:32 +0400583};
584
Tejun Heo127102a2008-04-07 22:47:21 +0900585#ifdef CONFIG_ATA_SFF
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586struct ata_ioports {
Tejun Heo0d5ff562007-02-01 15:06:36 +0900587 void __iomem *cmd_addr;
588 void __iomem *data_addr;
589 void __iomem *error_addr;
590 void __iomem *feature_addr;
591 void __iomem *nsect_addr;
592 void __iomem *lbal_addr;
593 void __iomem *lbam_addr;
594 void __iomem *lbah_addr;
595 void __iomem *device_addr;
596 void __iomem *status_addr;
597 void __iomem *command_addr;
598 void __iomem *altstatus_addr;
599 void __iomem *ctl_addr;
Tejun Heo9a7780c2010-05-19 22:10:24 +0200600#ifdef CONFIG_ATA_BMDMA
Tejun Heo0d5ff562007-02-01 15:06:36 +0900601 void __iomem *bmdma_addr;
Tejun Heo9a7780c2010-05-19 22:10:24 +0200602#endif /* CONFIG_ATA_BMDMA */
Tejun Heo0d5ff562007-02-01 15:06:36 +0900603 void __iomem *scr_addr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604};
Tejun Heo127102a2008-04-07 22:47:21 +0900605#endif /* CONFIG_ATA_SFF */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606
Jeff Garzikcca39742006-08-24 03:19:22 -0400607struct ata_host {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608 spinlock_t lock;
609 struct device *dev;
Tejun Heo0d5ff562007-02-01 15:06:36 +0900610 void __iomem * const *iomap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611 unsigned int n_ports;
Tejun Heo1a112d12014-07-23 09:05:27 -0400612 unsigned int n_tags; /* nr of NCQ tags */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613 void *private_data;
Tejun Heo029cfd62008-03-25 12:22:49 +0900614 struct ata_port_operations *ops;
Alan Cox5444a6f2006-03-27 18:58:20 +0100615 unsigned long flags;
Tejun Heoc0c362b2010-09-06 17:57:14 +0200616
617 struct mutex eh_mutex;
618 struct task_struct *eh_owner;
619
Alan032af1c2007-03-01 17:36:46 +0000620 struct ata_port *simplex_claimed; /* channel owning the DMA */
Tejun Heof0eb62b2006-06-12 23:05:38 +0900621 struct ata_port *ports[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622};
623
624struct ata_queued_cmd {
625 struct ata_port *ap;
626 struct ata_device *dev;
627
628 struct scsi_cmnd *scsicmd;
629 void (*scsidone)(struct scsi_cmnd *);
630
631 struct ata_taskfile tf;
632 u8 cdb[ATAPI_CDB_LEN];
633
634 unsigned long flags; /* ATA_QCFLAG_xxx */
635 unsigned int tag;
636 unsigned int n_elem;
FUJITA Tomonori58256272009-02-27 17:35:43 +0900637 unsigned int orig_n_elem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638
639 int dma_dir;
640
Mark Lord5a5dbd12007-03-16 10:22:26 -0400641 unsigned int sect_size;
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400642
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643 unsigned int nbytes;
Tejun Heoaacda372008-03-18 17:47:43 +0900644 unsigned int extrabytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645 unsigned int curbytes;
646
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647 struct scatterlist sgent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648
Tejun Heoff2aeb12007-12-05 16:43:11 +0900649 struct scatterlist *sg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650
Richard Kennedyb34e9042010-09-10 12:19:43 +0100651 struct scatterlist *cursg;
652 unsigned int cursg_ofs;
653
Albert Leea22e2eb2005-12-05 15:38:02 +0800654 unsigned int err_mask;
Tejun Heoe61e0672006-05-15 20:57:40 +0900655 struct ata_taskfile result_tf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656 ata_qc_cb_t complete_fn;
657
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658 void *private_data;
Darrick J. Wong1c50dc82007-01-30 01:18:41 -0800659 void *lldd_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660};
661
Jeff Garzikcca39742006-08-24 03:19:22 -0400662struct ata_port_stats {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 unsigned long unhandled_irq;
664 unsigned long idle_irq;
665 unsigned long rw_reqbuf;
666};
667
Tejun Heo0c247c52006-05-15 20:58:19 +0900668struct ata_ering_entry {
Tejun Heo3884f7b2007-11-27 19:28:56 +0900669 unsigned int eflags;
Tejun Heo0c247c52006-05-15 20:58:19 +0900670 unsigned int err_mask;
671 u64 timestamp;
672};
673
674struct ata_ering {
675 int cursor;
676 struct ata_ering_entry ring[ATA_ERING_SIZE];
677};
678
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679struct ata_device {
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900680 struct ata_link *link;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681 unsigned int devno; /* 0 or 1 */
Tejun Heo75683fe2007-07-05 13:31:27 +0900682 unsigned int horkage; /* List of broken features */
Richard Kennedy6866e7b2008-09-22 14:47:13 -0700683 unsigned long flags; /* ATA_DFLAG_xxx */
Tejun Heo3edebac2006-05-31 18:27:40 +0900684 struct scsi_device *sdev; /* attached SCSI device */
Bartlomiej Zolnierkiewicz95514fd2009-11-25 18:12:48 +0100685 void *private_data;
Tejun Heofafbae82007-05-15 03:28:16 +0900686#ifdef CONFIG_ATA_ACPI
Tejun Heo398e0782007-12-15 15:05:03 +0900687 union acpi_object *gtf_cache;
Tejun Heo110f66d2009-09-16 04:17:28 +0900688 unsigned int gtf_filter;
Tejun Heofafbae82007-05-15 03:28:16 +0900689#endif
Aaron Luafe75952013-01-15 17:20:58 +0800690#ifdef CONFIG_SATA_ZPODD
691 void *zpodd;
692#endif
Gwendal Grignoud9027472010-05-25 12:31:38 -0700693 struct device tdev;
Tejun Heo99cf6102009-01-29 20:31:32 +0900694 /* n_sector is CLEAR_BEGIN, read comment above CLEAR_BEGIN */
Tejun Heo72fa4b72006-05-31 18:27:32 +0900695 u64 n_sectors; /* size of device, if ATA */
Tejun Heo5920dad2009-07-15 17:11:41 +0900696 u64 n_native_sectors; /* native size, if ATA */
Tejun Heo72fa4b72006-05-31 18:27:32 +0900697 unsigned int class; /* ATA_DEV_xxx */
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200698 unsigned long unpark_deadline;
Tejun Heoe0a71752007-09-23 13:14:12 +0900699
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700 u8 pio_mode;
701 u8 dma_mode;
702 u8 xfer_mode;
703 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
704
Albert Lee8cbd6df2005-10-12 15:06:27 +0800705 unsigned int multi_count; /* sectors count for
706 READ/WRITE MULTIPLE */
Tejun Heob00eec12006-02-12 23:32:59 +0900707 unsigned int max_sectors; /* per-device max sectors */
Tejun Heo6e7846e2006-02-12 23:32:58 +0900708 unsigned int cdb_len;
Albert Lee8bf62ece2005-05-12 15:29:42 -0400709
Tejun Heoacf356b2006-03-24 14:07:50 +0900710 /* per-dev xfer mask */
Tejun Heo7dc951a2007-11-27 19:43:42 +0900711 unsigned long pio_mask;
712 unsigned long mwdma_mask;
713 unsigned long udma_mask;
Tejun Heoacf356b2006-03-24 14:07:50 +0900714
Albert Lee8bf62ece2005-05-12 15:29:42 -0400715 /* for CHS addressing */
716 u16 cylinders; /* Number of cylinders */
717 u16 heads; /* Number of heads */
718 u16 sectors; /* Number of sectors per track */
Tejun Heo0c247c52006-05-15 20:58:19 +0900719
Jeff Garzikf7e98932008-04-29 17:47:34 -0400720 union {
721 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
722 u32 gscr[SATA_PMP_GSCR_DWORDS]; /* PMP GSCR block */
723 };
Tejun Heo99cf6102009-01-29 20:31:32 +0900724
Shane Huang803739d2012-12-17 23:18:59 +0800725 /* DEVSLP Timing Variables from Identify Device Data Log */
726 u8 devslp_timing[ATA_LOG_DEVSLP_SIZE];
Shane Huang65fe1f02012-09-07 22:40:01 +0800727
Marc Carinoed369112013-08-24 23:22:50 -0700728 /* NCQ send and receive log subcommand support */
729 u8 ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_SIZE];
730
Tejun Heo99cf6102009-01-29 20:31:32 +0900731 /* error history */
732 int spdn_cnt;
733 /* ering is CLEAR_END, read comment above CLEAR_END */
734 struct ata_ering ering;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735};
736
Tejun Heo99cf6102009-01-29 20:31:32 +0900737/* Fields between ATA_DEVICE_CLEAR_BEGIN and ATA_DEVICE_CLEAR_END are
738 * cleared to zero on ata_dev_init().
Tejun Heo72fa4b72006-05-31 18:27:32 +0900739 */
Tejun Heo99cf6102009-01-29 20:31:32 +0900740#define ATA_DEVICE_CLEAR_BEGIN offsetof(struct ata_device, n_sectors)
741#define ATA_DEVICE_CLEAR_END offsetof(struct ata_device, ering)
Tejun Heo72fa4b72006-05-31 18:27:32 +0900742
Tejun Heof3e81b12006-05-15 20:58:21 +0900743struct ata_eh_info {
744 struct ata_device *dev; /* offending device */
745 u32 serror; /* SError from LLDD */
746 unsigned int err_mask; /* port-wide err_mask */
747 unsigned int action; /* ATA_EH_* action mask */
Tejun Heo47005f22006-06-19 18:27:23 +0900748 unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */
Tejun Heof3e81b12006-05-15 20:58:21 +0900749 unsigned int flags; /* ATA_EHI_* flags */
Tejun Heoabdda732006-05-31 18:27:29 +0900750
Tejun Heoabdda732006-05-31 18:27:29 +0900751 unsigned int probe_mask;
752
Tejun Heof3e81b12006-05-15 20:58:21 +0900753 char desc[ATA_EH_DESC_LEN];
754 int desc_len;
755};
756
757struct ata_eh_context {
758 struct ata_eh_info i;
759 int tries[ATA_MAX_DEVICES];
Tejun Heo87fbc5a2008-05-20 02:17:54 +0900760 int cmd_timeout_idx[ATA_MAX_DEVICES]
761 [ATA_EH_CMD_TIMEOUT_TABLE_SIZE];
Tejun Heoabdda732006-05-31 18:27:29 +0900762 unsigned int classes[ATA_MAX_DEVICES];
763 unsigned int did_probe_mask;
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200764 unsigned int unloaded_mask;
Tejun Heo00115e02007-11-27 19:28:58 +0900765 unsigned int saved_ncq_enabled;
766 u8 saved_xfer_mode[ATA_MAX_DEVICES];
Tejun Heo0a2c0f52008-05-20 02:17:52 +0900767 /* timestamp for the last reset attempt or success */
768 unsigned long last_reset;
Tejun Heof3e81b12006-05-15 20:58:21 +0900769};
770
Tejun Heo64578a32007-05-15 03:28:16 +0900771struct ata_acpi_drive
772{
773 u32 pio;
774 u32 dma;
775} __packed;
776
777struct ata_acpi_gtm {
778 struct ata_acpi_drive drive[2];
779 u32 flags;
780} __packed;
781
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900782struct ata_link {
783 struct ata_port *ap;
Tejun Heo89898052007-08-06 18:36:23 +0900784 int pmp; /* port multiplier port # */
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900785
Gwendal Grignoud9027472010-05-25 12:31:38 -0700786 struct device tdev;
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900787 unsigned int active_tag; /* active tag on this link */
788 u32 sactive; /* active NCQ commands */
789
Tejun Heo0c887582007-08-06 18:36:23 +0900790 unsigned int flags; /* ATA_LFLAG_xxx */
791
Tejun Heod127ea72008-07-31 16:09:34 +0900792 u32 saved_scontrol; /* SControl on probe */
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900793 unsigned int hw_sata_spd_limit;
794 unsigned int sata_spd_limit;
795 unsigned int sata_spd; /* current SATA PHY speed */
Tejun Heo6b7ae952010-09-01 17:50:06 +0200796 enum ata_lpm_policy lpm_policy;
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900797
798 /* record runtime error info, protected by host_set lock */
799 struct ata_eh_info eh_info;
800 /* EH context */
801 struct ata_eh_context eh_context;
802
803 struct ata_device device[ATA_MAX_DEVICES];
Gabriele Mazzotta09c5b482015-04-25 19:52:37 +0200804
805 unsigned long last_lpm_change; /* when last LPM change happened */
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900806};
Gwendal Grignoud9027472010-05-25 12:31:38 -0700807#define ATA_LINK_CLEAR_BEGIN offsetof(struct ata_link, active_tag)
808#define ATA_LINK_CLEAR_END offsetof(struct ata_link, device[0])
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900809
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810struct ata_port {
Jeff Garzikcca39742006-08-24 03:19:22 -0400811 struct Scsi_Host *scsi_host; /* our co-allocated scsi host */
Tejun Heo029cfd62008-03-25 12:22:49 +0900812 struct ata_port_operations *ops;
Jeff Garzikba6a1302006-06-22 23:46:10 -0400813 spinlock_t *lock;
Alan Coxe3cf95d2009-04-09 17:31:17 +0100814 /* Flags owned by the EH context. Only EH should touch these once the
815 port is active */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816 unsigned long flags; /* ATA_FLAG_xxx */
Alan Coxe3cf95d2009-04-09 17:31:17 +0100817 /* Flags that change dynamically, protected by ap->lock */
Tejun Heob51e9e52006-06-29 01:29:30 +0900818 unsigned int pflags; /* ATA_PFLAG_xxx */
Tejun Heo44877b42007-02-21 01:06:51 +0900819 unsigned int print_id; /* user visible unique port ID */
David Milburne628dc92013-05-14 13:48:40 -0500820 unsigned int local_port_no; /* host local port num */
Tejun Heo44877b42007-02-21 01:06:51 +0900821 unsigned int port_no; /* 0 based port no. inside the host */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822
Tejun Heo127102a2008-04-07 22:47:21 +0900823#ifdef CONFIG_ATA_SFF
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825 u8 ctl; /* cache of ATA control register */
826 u8 last_ctl; /* Cache last written value */
Gwendal Grignouea3c6452010-08-31 16:20:36 -0700827 struct ata_link* sff_pio_task_link; /* link currently used */
Tejun Heoc4291372010-05-10 21:41:38 +0200828 struct delayed_work sff_pio_task;
Tejun Heo9a7780c2010-05-19 22:10:24 +0200829#ifdef CONFIG_ATA_BMDMA
Tejun Heof60d7012010-05-10 21:41:41 +0200830 struct ata_bmdma_prd *bmdma_prd; /* BMDMA SG list */
831 dma_addr_t bmdma_prd_dma; /* and its DMA mapping */
Tejun Heo9a7780c2010-05-19 22:10:24 +0200832#endif /* CONFIG_ATA_BMDMA */
Tejun Heo5fe74542010-05-10 21:41:37 +0200833#endif /* CONFIG_ATA_SFF */
834
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835 unsigned int pio_mask;
836 unsigned int mwdma_mask;
837 unsigned int udma_mask;
838 unsigned int cbl; /* cable type; ATA_CBL_xxx */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839
840 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
Shaohua Li12cb5ce2015-01-15 17:32:27 -0800841 unsigned long sas_tag_allocated; /* for sas tag allocation only */
Tejun Heodedaf2b2006-05-15 21:03:43 +0900842 unsigned int qc_active;
Tejun Heoda917d62007-09-23 13:14:12 +0900843 int nr_active_links; /* #links with active qcs */
Shaohua Li12cb5ce2015-01-15 17:32:27 -0800844 unsigned int sas_last_tag; /* track next tag hw expects */
Tejun Heodedaf2b2006-05-15 21:03:43 +0900845
Tejun Heob1c72912008-07-31 17:02:43 +0900846 struct ata_link link; /* host default link */
847 struct ata_link *slave_link; /* see ata_slave_link_init() */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848
Tejun Heo89898052007-08-06 18:36:23 +0900849 int nr_pmp_links; /* nr of available PMP links */
850 struct ata_link *pmp_link; /* array of PMP links */
Tejun Heoda917d62007-09-23 13:14:12 +0900851 struct ata_link *excl_link; /* for PMP qc exclusion */
Tejun Heo89898052007-08-06 18:36:23 +0900852
Jeff Garzikcca39742006-08-24 03:19:22 -0400853 struct ata_port_stats stats;
854 struct ata_host *host;
Brian King2f1f6102006-03-23 17:30:15 -0600855 struct device *dev;
Gwendal Grignoud9027472010-05-25 12:31:38 -0700856 struct device tdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857
Tejun Heoad72cf92010-07-02 10:03:52 +0200858 struct mutex scsi_scan_mutex;
David Howells52bad642006-11-22 14:54:01 +0000859 struct delayed_work hotplug_task;
Jeff Garzik3b01b8a2006-06-12 00:22:04 -0400860 struct work_struct scsi_rescan_task;
Tejun Heo86e45b62006-03-05 15:29:09 +0900861
Albert Lee14be71f2005-09-27 17:36:35 +0800862 unsigned int hsm_task_state;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863
Randy Dunlapbfd60572006-01-17 19:34:42 -0500864 u32 msg_enable;
Tejun Heoa72ec4c2006-01-23 13:09:37 +0900865 struct list_head eh_done_q;
Tejun Heoc6cf9e92006-05-31 18:27:27 +0900866 wait_queue_head_t eh_wait_q;
Tejun Heoa1e10f72007-08-18 13:28:49 +0900867 int eh_tries;
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200868 struct completion park_req_pending;
Randy Dunlapbfd60572006-01-17 19:34:42 -0500869
Tejun Heo500530f2006-07-03 16:07:27 +0900870 pm_message_t pm_mesg;
Tejun Heo6b7ae952010-09-01 17:50:06 +0200871 enum ata_lpm_policy target_lpm_policy;
Tejun Heo500530f2006-07-03 16:07:27 +0900872
Tejun Heo5ddf24c2007-07-16 14:29:41 +0900873 struct timer_list fastdrain_timer;
874 unsigned long fastdrain_cnt;
875
Kristen Carlson Accardi18f7ba42008-06-03 10:33:55 -0700876 int em_message_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700877 void *private_data;
Tejun Heofe635c72006-05-15 20:57:35 +0900878
Tejun Heofafbae82007-05-15 03:28:16 +0900879#ifdef CONFIG_ATA_ACPI
Tejun Heoc05e6ff2007-12-15 15:05:02 +0900880 struct ata_acpi_gtm __acpi_init_gtm; /* use ata_acpi_init_gtm() */
Tejun Heofafbae82007-05-15 03:28:16 +0900881#endif
Tejun Heo84bda122009-03-02 18:53:26 +0900882 /* owned by EH */
883 u8 sector_buf[ATA_SECT_SIZE] ____cacheline_aligned;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884};
885
Tejun Heo029cfd62008-03-25 12:22:49 +0900886/* The following initializer overrides a method to NULL whether one of
887 * its parent has the method defined or not. This is equivalent to
888 * ERR_PTR(-ENOENT). Unfortunately, ERR_PTR doesn't render a constant
889 * expression and thus can't be used as an initializer.
890 */
891#define ATA_OP_NULL (void *)(unsigned long)(-ENOENT)
892
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893struct ata_port_operations {
Tejun Heoc1bc8992008-03-25 12:22:47 +0900894 /*
895 * Command execution
896 */
897 int (*qc_defer)(struct ata_queued_cmd *qc);
898 int (*check_atapi_dma)(struct ata_queued_cmd *qc);
899 void (*qc_prep)(struct ata_queued_cmd *qc);
900 unsigned int (*qc_issue)(struct ata_queued_cmd *qc);
Tejun Heo22183bf2008-04-07 22:47:20 +0900901 bool (*qc_fill_rtf)(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902
Tejun Heoc1bc8992008-03-25 12:22:47 +0900903 /*
904 * Configuration and exception handling
905 */
906 int (*cable_detect)(struct ata_port *ap);
907 unsigned long (*mode_filter)(struct ata_device *dev, unsigned long xfer_mask);
908 void (*set_piomode)(struct ata_port *ap, struct ata_device *dev);
909 void (*set_dmamode)(struct ata_port *ap, struct ata_device *dev);
910 int (*set_mode)(struct ata_link *link, struct ata_device **r_failed_dev);
Alan Cox963e4972008-07-24 17:16:06 +0100911 unsigned int (*read_id)(struct ata_device *dev, struct ata_taskfile *tf, u16 *id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912
Tejun Heoc1bc8992008-03-25 12:22:47 +0900913 void (*dev_config)(struct ata_device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700914
Tejun Heoc1bc8992008-03-25 12:22:47 +0900915 void (*freeze)(struct ata_port *ap);
916 void (*thaw)(struct ata_port *ap);
Tejun Heoa1efdab2008-03-25 12:22:50 +0900917 ata_prereset_fn_t prereset;
918 ata_reset_fn_t softreset;
919 ata_reset_fn_t hardreset;
920 ata_postreset_fn_t postreset;
921 ata_prereset_fn_t pmp_prereset;
922 ata_reset_fn_t pmp_softreset;
923 ata_reset_fn_t pmp_hardreset;
924 ata_postreset_fn_t pmp_postreset;
Tejun Heoc1bc8992008-03-25 12:22:47 +0900925 void (*error_handler)(struct ata_port *ap);
Alan Coxc96f1732009-03-24 10:23:46 +0000926 void (*lost_interrupt)(struct ata_port *ap);
Tejun Heoc1bc8992008-03-25 12:22:47 +0900927 void (*post_internal_cmd)(struct ata_queued_cmd *qc);
Dan Williamse4a9c372012-06-21 23:25:27 -0700928 void (*sched_eh)(struct ata_port *ap);
929 void (*end_eh)(struct ata_port *ap);
Tejun Heoc1bc8992008-03-25 12:22:47 +0900930
931 /*
932 * Optional features
933 */
Tejun Heo82ef04f2008-07-31 17:02:40 +0900934 int (*scr_read)(struct ata_link *link, unsigned int sc_reg, u32 *val);
935 int (*scr_write)(struct ata_link *link, unsigned int sc_reg, u32 val);
Tejun Heoc1bc8992008-03-25 12:22:47 +0900936 void (*pmp_attach)(struct ata_port *ap);
937 void (*pmp_detach)(struct ata_port *ap);
Tejun Heo6b7ae952010-09-01 17:50:06 +0200938 int (*set_lpm)(struct ata_link *link, enum ata_lpm_policy policy,
939 unsigned hints);
Tejun Heoc1bc8992008-03-25 12:22:47 +0900940
941 /*
942 * Start, stop, suspend and resume
943 */
944 int (*port_suspend)(struct ata_port *ap, pm_message_t mesg);
945 int (*port_resume)(struct ata_port *ap);
946 int (*port_start)(struct ata_port *ap);
947 void (*port_stop)(struct ata_port *ap);
948 void (*host_stop)(struct ata_host *host);
949
Tejun Heo127102a2008-04-07 22:47:21 +0900950#ifdef CONFIG_ATA_SFF
Tejun Heoc1bc8992008-03-25 12:22:47 +0900951 /*
952 * SFF / taskfile oriented ops
953 */
Tejun Heo5682ed32008-04-07 22:47:16 +0900954 void (*sff_dev_select)(struct ata_port *ap, unsigned int device);
Sergei Shtylyov41dec292010-05-07 22:47:50 +0400955 void (*sff_set_devctl)(struct ata_port *ap, u8 ctl);
Tejun Heo5682ed32008-04-07 22:47:16 +0900956 u8 (*sff_check_status)(struct ata_port *ap);
957 u8 (*sff_check_altstatus)(struct ata_port *ap);
958 void (*sff_tf_load)(struct ata_port *ap, const struct ata_taskfile *tf);
959 void (*sff_tf_read)(struct ata_port *ap, struct ata_taskfile *tf);
960 void (*sff_exec_command)(struct ata_port *ap,
961 const struct ata_taskfile *tf);
962 unsigned int (*sff_data_xfer)(struct ata_device *dev,
963 unsigned char *buf, unsigned int buflen, int rw);
Sergei Shtylyove42a5422010-05-07 22:49:02 +0400964 void (*sff_irq_on)(struct ata_port *);
Tejun Heo27943622010-01-19 10:49:19 +0900965 bool (*sff_irq_check)(struct ata_port *);
Tejun Heo5682ed32008-04-07 22:47:16 +0900966 void (*sff_irq_clear)(struct ata_port *);
Tejun Heo8244cd02010-05-10 21:41:36 +0200967 void (*sff_drain_fifo)(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968
Tejun Heo9a7780c2010-05-19 22:10:24 +0200969#ifdef CONFIG_ATA_BMDMA
Tejun Heoc1bc8992008-03-25 12:22:47 +0900970 void (*bmdma_setup)(struct ata_queued_cmd *qc);
971 void (*bmdma_start)(struct ata_queued_cmd *qc);
972 void (*bmdma_stop)(struct ata_queued_cmd *qc);
973 u8 (*bmdma_status)(struct ata_port *ap);
Tejun Heo9a7780c2010-05-19 22:10:24 +0200974#endif /* CONFIG_ATA_BMDMA */
Tejun Heo127102a2008-04-07 22:47:21 +0900975#endif /* CONFIG_ATA_SFF */
Tejun Heoc19ba8a2006-01-24 17:05:22 +0900976
Kristen Carlson Accardi18f7ba42008-06-03 10:33:55 -0700977 ssize_t (*em_show)(struct ata_port *ap, char *buf);
978 ssize_t (*em_store)(struct ata_port *ap, const char *message,
979 size_t size);
980 ssize_t (*sw_activity_show)(struct ata_device *dev, char *buf);
981 ssize_t (*sw_activity_store)(struct ata_device *dev,
982 enum sw_activity val);
Mark Langsdorf439d7a32013-05-30 15:17:30 -0500983 ssize_t (*transmit_led_message)(struct ata_port *ap, u32 state,
984 ssize_t size);
985
Tejun Heoc1bc8992008-03-25 12:22:47 +0900986 /*
987 * Obsolete
Tejun Heo9ec957f2006-05-15 20:57:58 +0900988 */
Tejun Heoc1bc8992008-03-25 12:22:47 +0900989 void (*phy_reset)(struct ata_port *ap);
990 void (*eng_timeout)(struct ata_port *ap);
Tejun Heo029cfd62008-03-25 12:22:49 +0900991
992 /*
993 * ->inherits must be the last field and all the preceding
994 * fields must be pointers.
995 */
996 const struct ata_port_operations *inherits;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997};
998
999struct ata_port_info {
Jeff Garzikcca39742006-08-24 03:19:22 -04001000 unsigned long flags;
Tejun Heo0c887582007-08-06 18:36:23 +09001001 unsigned long link_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002 unsigned long pio_mask;
1003 unsigned long mwdma_mask;
1004 unsigned long udma_mask;
Tejun Heo029cfd62008-03-25 12:22:49 +09001005 struct ata_port_operations *port_ops;
Alan Coxe99f8b52005-11-08 14:09:44 +00001006 void *private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007};
1008
Alan Cox452503f2005-10-21 19:01:32 -04001009struct ata_timing {
1010 unsigned short mode; /* ATA mode */
1011 unsigned short setup; /* t1 */
1012 unsigned short act8b; /* t2 for 8-bit I/O */
1013 unsigned short rec8b; /* t2i for 8-bit I/O */
1014 unsigned short cyc8b; /* t0 for 8-bit I/O */
1015 unsigned short active; /* t2 or tD */
1016 unsigned short recover; /* t2i or tK */
David Daney3ada9c12009-01-15 17:45:31 -08001017 unsigned short dmack_hold; /* tj */
Alan Cox452503f2005-10-21 19:01:32 -04001018 unsigned short cycle; /* t0 */
1019 unsigned short udma; /* t2CYCTYP/2 */
1020};
1021
Tejun Heo624d5c52008-03-25 22:16:41 +09001022/*
1023 * Core layer - drivers/ata/libata-core.c
1024 */
Tejun Heoe9c83912006-07-03 16:07:26 +09001025extern const unsigned long sata_deb_timing_normal[];
1026extern const unsigned long sata_deb_timing_hotplug[];
1027extern const unsigned long sata_deb_timing_long[];
1028
Tejun Heo029cfd62008-03-25 12:22:49 +09001029extern struct ata_port_operations ata_dummy_port_ops;
Tejun Heo21b0ad42007-04-17 23:44:07 +09001030extern const struct ata_port_info ata_dummy_port_info;
Tejun Heodd5b06c2006-08-10 16:59:12 +09001031
Sergei Shtylyovdc34e7e2013-07-01 00:01:32 +04001032/*
1033 * protocol tests
1034 */
1035static inline unsigned int ata_prot_flags(u8 prot)
1036{
1037 switch (prot) {
1038 case ATA_PROT_NODATA:
1039 return 0;
1040 case ATA_PROT_PIO:
1041 return ATA_PROT_FLAG_PIO;
1042 case ATA_PROT_DMA:
1043 return ATA_PROT_FLAG_DMA;
1044 case ATA_PROT_NCQ:
1045 return ATA_PROT_FLAG_DMA | ATA_PROT_FLAG_NCQ;
1046 case ATAPI_PROT_NODATA:
1047 return ATA_PROT_FLAG_ATAPI;
1048 case ATAPI_PROT_PIO:
1049 return ATA_PROT_FLAG_ATAPI | ATA_PROT_FLAG_PIO;
1050 case ATAPI_PROT_DMA:
1051 return ATA_PROT_FLAG_ATAPI | ATA_PROT_FLAG_DMA;
1052 }
1053 return 0;
1054}
1055
1056static inline int ata_is_atapi(u8 prot)
1057{
1058 return ata_prot_flags(prot) & ATA_PROT_FLAG_ATAPI;
1059}
1060
1061static inline int ata_is_nodata(u8 prot)
1062{
1063 return !(ata_prot_flags(prot) & ATA_PROT_FLAG_DATA);
1064}
1065
1066static inline int ata_is_pio(u8 prot)
1067{
1068 return ata_prot_flags(prot) & ATA_PROT_FLAG_PIO;
1069}
1070
1071static inline int ata_is_dma(u8 prot)
1072{
1073 return ata_prot_flags(prot) & ATA_PROT_FLAG_DMA;
1074}
1075
1076static inline int ata_is_ncq(u8 prot)
1077{
1078 return ata_prot_flags(prot) & ATA_PROT_FLAG_NCQ;
1079}
1080
1081static inline int ata_is_data(u8 prot)
1082{
1083 return ata_prot_flags(prot) & ATA_PROT_FLAG_DATA;
1084}
1085
1086static inline int is_multi_taskfile(struct ata_taskfile *tf)
1087{
1088 return (tf->command == ATA_CMD_READ_MULTI) ||
1089 (tf->command == ATA_CMD_WRITE_MULTI) ||
1090 (tf->command == ATA_CMD_READ_MULTI_EXT) ||
1091 (tf->command == ATA_CMD_WRITE_MULTI_EXT) ||
1092 (tf->command == ATA_CMD_WRITE_MULTI_FUA_EXT);
1093}
1094
Tejun Heoe9c83912006-07-03 16:07:26 +09001095static inline const unsigned long *
1096sata_ehc_deb_timing(struct ata_eh_context *ehc)
1097{
1098 if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
1099 return sata_deb_timing_hotplug;
1100 else
1101 return sata_deb_timing_normal;
1102}
Tejun Heod7bb4cc2006-05-31 18:27:46 +09001103
Tejun Heodd5b06c2006-08-10 16:59:12 +09001104static inline int ata_port_is_dummy(struct ata_port *ap)
1105{
1106 return ap->ops == &ata_dummy_port_ops;
1107}
1108
Tejun Heo936fd732007-08-06 18:36:23 +09001109extern int sata_set_spd(struct ata_link *link);
Tejun Heo0aa11132008-04-07 22:47:18 +09001110extern int ata_std_prereset(struct ata_link *link, unsigned long deadline);
Tejun Heoaa2731a2008-04-07 22:47:19 +09001111extern int ata_wait_after_reset(struct ata_link *link, unsigned long deadline,
1112 int (*check_ready)(struct ata_link *link));
Tejun Heo936fd732007-08-06 18:36:23 +09001113extern int sata_link_debounce(struct ata_link *link,
1114 const unsigned long *params, unsigned long deadline);
1115extern int sata_link_resume(struct ata_link *link, const unsigned long *params,
1116 unsigned long deadline);
Tejun Heo1152b262010-09-01 17:50:05 +02001117extern int sata_link_scr_lpm(struct ata_link *link, enum ata_lpm_policy policy,
1118 bool spm_wakeup);
Tejun Heocc0680a2007-08-06 18:36:23 +09001119extern int sata_link_hardreset(struct ata_link *link,
Tejun Heo9dadd452008-04-07 22:47:19 +09001120 const unsigned long *timing, unsigned long deadline,
1121 bool *online, int (*check_ready)(struct ata_link *));
Tejun Heo57c9efd2008-04-07 22:47:19 +09001122extern int sata_std_hardreset(struct ata_link *link, unsigned int *class,
1123 unsigned long deadline);
Tejun Heo203c75b2008-04-07 22:47:18 +09001124extern void ata_std_postreset(struct ata_link *link, unsigned int *classes);
Jeff Garzik28555682007-10-11 17:12:35 -04001125
Tejun Heof3187192007-04-17 23:44:07 +09001126extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
Tejun Heof5cda252007-04-17 23:44:07 +09001127extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
1128 const struct ata_port_info * const * ppi, int n_ports);
Tejun Heob1c72912008-07-31 17:02:43 +09001129extern int ata_slave_link_init(struct ata_port *ap);
Tejun Heoecef7252007-04-17 23:44:06 +09001130extern int ata_host_start(struct ata_host *host);
Tejun Heof3187192007-04-17 23:44:07 +09001131extern int ata_host_register(struct ata_host *host,
1132 struct scsi_host_template *sht);
Tejun Heof5cda252007-04-17 23:44:07 +09001133extern int ata_host_activate(struct ata_host *host, int irq,
1134 irq_handler_t irq_handler, unsigned long irq_flags,
1135 struct scsi_host_template *sht);
Tejun Heo0529c1592007-01-20 16:00:26 +09001136extern void ata_host_detach(struct ata_host *host);
Dan Williams8d8e7d12012-07-09 21:06:08 -07001137extern void ata_host_init(struct ata_host *, struct device *, struct ata_port_operations *);
Jeff Garzik193515d2005-11-07 00:59:37 -05001138extern int ata_scsi_detect(struct scsi_host_template *sht);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
Jeff Garzikf2812332010-11-16 02:10:29 -05001140extern int ata_scsi_queuecmd(struct Scsi_Host *h, struct scsi_cmnd *cmd);
Jeff Garzik94be9a52009-01-16 10:17:09 -05001141extern int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *dev,
1142 int cmd, void __user *arg);
Brian King80289162006-08-07 14:27:31 -05001143extern void ata_sas_port_destroy(struct ata_port *);
Jeff Garzikcca39742006-08-24 03:19:22 -04001144extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
Brian King80289162006-08-07 14:27:31 -05001145 struct ata_port_info *, struct Scsi_Host *);
Dan Williamsb2024452012-03-21 21:09:07 -07001146extern void ata_sas_async_probe(struct ata_port *ap);
1147extern int ata_sas_sync_probe(struct ata_port *ap);
Brian King80289162006-08-07 14:27:31 -05001148extern int ata_sas_port_init(struct ata_port *);
1149extern int ata_sas_port_start(struct ata_port *ap);
1150extern void ata_sas_port_stop(struct ata_port *ap);
1151extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
Jeff Garzikb27dcfb2010-11-17 22:56:48 -05001152extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, struct ata_port *ap);
Tejun Heo936fd732007-08-06 18:36:23 +09001153extern int sata_scr_valid(struct ata_link *link);
1154extern int sata_scr_read(struct ata_link *link, int reg, u32 *val);
1155extern int sata_scr_write(struct ata_link *link, int reg, u32 val);
1156extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val);
Tejun Heob5b3fa32008-07-31 17:02:42 +09001157extern bool ata_link_online(struct ata_link *link);
1158extern bool ata_link_offline(struct ata_link *link);
Tejun Heo6ffa01d2007-03-02 17:32:47 +09001159#ifdef CONFIG_PM
Jeff Garzikcca39742006-08-24 03:19:22 -04001160extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
1161extern void ata_host_resume(struct ata_host *host);
Dan Williamsbc6e7c42014-03-14 13:52:48 -07001162extern void ata_sas_port_suspend(struct ata_port *ap);
1163extern void ata_sas_port_resume(struct ata_port *ap);
Dan Williams2fcbdcb2012-06-21 23:41:46 -07001164#else
Dan Williamsbc6e7c42014-03-14 13:52:48 -07001165static inline void ata_sas_port_suspend(struct ata_port *ap)
Dan Williams2fcbdcb2012-06-21 23:41:46 -07001166{
Dan Williams2fcbdcb2012-06-21 23:41:46 -07001167}
Randy Dunlapa5a65692014-03-19 10:46:25 -07001168static inline void ata_sas_port_resume(struct ata_port *ap)
1169{
1170}
Tejun Heo6ffa01d2007-03-02 17:32:47 +09001171#endif
Jeff Garzik67846b32005-10-05 02:58:32 -04001172extern int ata_ratelimit(void);
Tejun Heo97750ce2010-09-06 17:56:29 +02001173extern void ata_msleep(struct ata_port *ap, unsigned int msecs);
1174extern u32 ata_wait_register(struct ata_port *ap, void __iomem *reg, u32 mask,
1175 u32 val, unsigned long interval, unsigned long timeout);
Tejun Heo436d34b2008-04-02 17:28:46 +09001176extern int atapi_cmd_type(u8 opcode);
Tejun Heo99771262007-07-16 14:29:38 +09001177extern void ata_tf_to_fis(const struct ata_taskfile *tf,
1178 u8 pmp, int is_cmd, u8 *fis);
Jeff Garzik057ace52005-10-22 14:27:05 -04001179extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
Tejun Heo7dc951a2007-11-27 19:43:42 +09001180extern unsigned long ata_pack_xfermask(unsigned long pio_mask,
1181 unsigned long mwdma_mask, unsigned long udma_mask);
1182extern void ata_unpack_xfermask(unsigned long xfer_mask,
1183 unsigned long *pio_mask, unsigned long *mwdma_mask,
1184 unsigned long *udma_mask);
1185extern u8 ata_xfer_mask2mode(unsigned long xfer_mask);
1186extern unsigned long ata_xfer_mode2mask(u8 xfer_mode);
1187extern int ata_xfer_mode2shift(unsigned long xfer_mode);
1188extern const char *ata_mode_string(unsigned long xfer_mask);
1189extern unsigned long ata_id_xfermask(const u16 *id);
Tejun Heo31cc23b2007-09-23 13:14:12 +09001190extern int ata_std_qc_defer(struct ata_queued_cmd *qc);
Brian Kinge46834c2006-03-17 17:04:03 -06001191extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001192extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
1193 unsigned int n_elem);
Jeff Garzik057ace52005-10-22 14:27:05 -04001194extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
Alan10305f02007-02-20 18:01:59 +00001195extern void ata_dev_disable(struct ata_device *adev);
Tejun Heo6a62a042006-02-13 10:02:46 +09001196extern void ata_id_string(const u16 *id, unsigned char *s,
1197 unsigned int ofs, unsigned int len);
1198extern void ata_id_c_string(const u16 *id, unsigned char *s,
1199 unsigned int ofs, unsigned int len);
Alan Cox963e4972008-07-24 17:16:06 +01001200extern unsigned int ata_do_dev_read_id(struct ata_device *dev,
1201 struct ata_taskfile *tf, u16 *id);
Tejun Heof686bcb2006-05-15 20:58:05 +09001202extern void ata_qc_complete(struct ata_queued_cmd *qc);
Tejun Heo79f97da2008-04-07 22:47:20 +09001203extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active);
Jeff Garzikb27dcfb2010-11-17 22:56:48 -05001204extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205extern int ata_std_bios_param(struct scsi_device *sdev,
1206 struct block_device *bdev,
1207 sector_t capacity, int geom[]);
Tejun Heod8d91292010-05-15 20:09:34 +02001208extern void ata_scsi_unlock_native_capacity(struct scsi_device *sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209extern int ata_scsi_slave_config(struct scsi_device *sdev);
Tejun Heo83c47bc2006-05-31 18:28:07 +09001210extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
Tejun Heoa6e6ce82006-05-15 21:03:48 +09001211extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
Christoph Hellwigdb5ed4d2014-11-13 15:08:42 +01001212 int queue_depth);
Dan Williamsf6e67032011-09-20 15:10:33 -07001213extern int __ata_change_queue_depth(struct ata_port *ap, struct scsi_device *sdev,
Christoph Hellwigdb5ed4d2014-11-13 15:08:42 +01001214 int queue_depth);
Tejun Heo3373efd2006-05-15 20:57:53 +09001215extern struct ata_device *ata_dev_pair(struct ata_device *adev);
Tejun Heo02607312007-08-06 18:36:23 +09001216extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
James Bottomley0e0b494c2011-01-23 09:42:50 -06001217extern void ata_scsi_port_error_handler(struct Scsi_Host *host, struct ata_port *ap);
1218extern void ata_scsi_cmd_error_handler(struct Scsi_Host *host, struct ata_port *ap, struct list_head *eh_q);
Gabriele Mazzotta8393b812015-04-25 19:52:36 +02001219extern bool sata_lpm_ignore_phy_events(struct ata_link *link);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220
Alan Coxbe0d18d2007-03-06 02:37:56 -08001221extern int ata_cable_40wire(struct ata_port *ap);
1222extern int ata_cable_80wire(struct ata_port *ap);
1223extern int ata_cable_sata(struct ata_port *ap);
Tejun Heoc88f90c2007-11-27 19:43:48 +09001224extern int ata_cable_ignore(struct ata_port *ap);
Alan Coxbe0d18d2007-03-06 02:37:56 -08001225extern int ata_cable_unknown(struct ata_port *ap);
1226
Tejun Heo624d5c52008-03-25 22:16:41 +09001227/* Timing helpers */
Alan Cox1bc4ccf2006-01-09 17:18:14 +00001228extern unsigned int ata_pio_need_iordy(const struct ata_device *);
Tejun Heo63573572007-11-27 19:43:39 +09001229extern const struct ata_timing *ata_timing_find_mode(u8 xfer_mode);
Alan Cox452503f2005-10-21 19:01:32 -04001230extern int ata_timing_compute(struct ata_device *, unsigned short,
1231 struct ata_timing *, int, int);
1232extern void ata_timing_merge(const struct ata_timing *,
1233 const struct ata_timing *, struct ata_timing *,
1234 unsigned int);
Tejun Heoa0f79b92007-12-18 16:33:05 +09001235extern u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle);
Alan Cox452503f2005-10-21 19:01:32 -04001236
Tejun Heo624d5c52008-03-25 22:16:41 +09001237/* PCI */
1238#ifdef CONFIG_PCI
1239struct pci_dev;
1240
1241struct pci_bits {
1242 unsigned int reg; /* PCI config register to read */
1243 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
1244 unsigned long mask;
1245 unsigned long val;
Alan Cox452503f2005-10-21 19:01:32 -04001246};
1247
Tejun Heo624d5c52008-03-25 22:16:41 +09001248extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
1249extern void ata_pci_remove_one(struct pci_dev *pdev);
1250
1251#ifdef CONFIG_PM
1252extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
1253extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
1254extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
1255extern int ata_pci_device_resume(struct pci_dev *pdev);
1256#endif /* CONFIG_PM */
1257#endif /* CONFIG_PCI */
1258
Brian Norrisb7db04d2012-11-02 12:29:32 -07001259struct platform_device;
1260
1261extern int ata_platform_remove_one(struct platform_device *pdev);
1262
Tejun Heo624d5c52008-03-25 22:16:41 +09001263/*
1264 * ACPI - drivers/ata/libata-acpi.c
1265 */
Alan Coxe1ddb4b2007-08-16 02:33:36 -04001266#ifdef CONFIG_ATA_ACPI
Tejun Heoc05e6ff2007-12-15 15:05:02 +09001267static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1268{
1269 if (ap->pflags & ATA_PFLAG_INIT_GTM_VALID)
1270 return &ap->__acpi_init_gtm;
1271 return NULL;
1272}
Tejun Heo0d02f0b2007-12-15 15:04:57 +09001273int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm);
1274int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *stm);
Tejun Heo7c77fa42007-12-18 16:33:03 +09001275unsigned long ata_acpi_gtm_xfermask(struct ata_device *dev,
1276 const struct ata_acpi_gtm *gtm);
Tejun Heo021ee9a2007-12-18 16:33:06 +09001277int ata_acpi_cbl_80wire(struct ata_port *ap, const struct ata_acpi_gtm *gtm);
Alan Coxe1ddb4b2007-08-16 02:33:36 -04001278#else
Tejun Heoc05e6ff2007-12-15 15:05:02 +09001279static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1280{
1281 return NULL;
1282}
Tejun Heo7c77fa42007-12-18 16:33:03 +09001283
1284static inline int ata_acpi_stm(const struct ata_port *ap,
1285 struct ata_acpi_gtm *stm)
1286{
1287 return -ENOSYS;
1288}
1289
1290static inline int ata_acpi_gtm(const struct ata_port *ap,
1291 struct ata_acpi_gtm *stm)
1292{
1293 return -ENOSYS;
1294}
1295
1296static inline unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev,
1297 const struct ata_acpi_gtm *gtm)
1298{
1299 return 0;
1300}
Tejun Heo021ee9a2007-12-18 16:33:06 +09001301
1302static inline int ata_acpi_cbl_80wire(struct ata_port *ap,
1303 const struct ata_acpi_gtm *gtm)
1304{
1305 return 0;
1306}
Alan Coxe1ddb4b2007-08-16 02:33:36 -04001307#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001308
Tejun Heoece1d632006-04-02 18:51:53 +09001309/*
Tejun Heo624d5c52008-03-25 22:16:41 +09001310 * EH - drivers/ata/libata-eh.c
Tejun Heoece1d632006-04-02 18:51:53 +09001311 */
Tejun Heo7b70fc02006-05-15 20:58:07 +09001312extern void ata_port_schedule_eh(struct ata_port *ap);
Dan Williams81c757b2011-12-02 16:07:01 -08001313extern void ata_port_wait_eh(struct ata_port *ap);
Tejun Heodbd82612007-08-06 18:36:23 +09001314extern int ata_link_abort(struct ata_link *link);
Tejun Heo7b70fc02006-05-15 20:58:07 +09001315extern int ata_port_abort(struct ata_port *ap);
Tejun Heoe3180492006-05-15 20:58:09 +09001316extern int ata_port_freeze(struct ata_port *ap);
Tejun Heo7d77b242007-09-23 13:14:13 +09001317extern int sata_async_notification(struct ata_port *ap);
Tejun Heoe3180492006-05-15 20:58:09 +09001318
1319extern void ata_eh_freeze_port(struct ata_port *ap);
1320extern void ata_eh_thaw_port(struct ata_port *ap);
Tejun Heo7b70fc02006-05-15 20:58:07 +09001321
Tejun Heoece1d632006-04-02 18:51:53 +09001322extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
1323extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
Mark Lord10acf3b2008-05-02 02:14:53 -04001324extern void ata_eh_analyze_ncq_error(struct ata_link *link);
Tejun Heoece1d632006-04-02 18:51:53 +09001325
Tejun Heof5914a42006-05-31 18:27:48 +09001326extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
1327 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
1328 ata_postreset_fn_t postreset);
Tejun Heoa1efdab2008-03-25 12:22:50 +09001329extern void ata_std_error_handler(struct ata_port *ap);
Dan Williamse4a9c372012-06-21 23:25:27 -07001330extern void ata_std_sched_eh(struct ata_port *ap);
1331extern void ata_std_end_eh(struct ata_port *ap);
Kristen Carlson Accardi8a745f12011-03-04 10:24:11 -08001332extern int ata_link_nr_enabled(struct ata_link *link);
Tejun Heo022bdb02006-05-15 20:58:22 +09001333
Tejun Heo61440db2006-05-15 20:57:55 +09001334/*
Tejun Heo68d1d072008-03-25 12:22:49 +09001335 * Base operations to inherit from and initializers for sht
1336 *
1337 * Operations
1338 *
1339 * base : Common to all libata drivers.
1340 * sata : SATA controllers w/ native interface.
1341 * pmp : SATA controllers w/ PMP support.
1342 * sff : SFF ATA controllers w/o BMDMA support.
1343 * bmdma : SFF ATA controllers w/ BMDMA support.
1344 *
1345 * sht initializers
1346 *
1347 * BASE : Common to all libata drivers. The user must set
1348 * sg_tablesize and dma_boundary.
1349 * PIO : SFF ATA controllers w/ only PIO support.
1350 * BMDMA : SFF ATA controllers w/ BMDMA support. sg_tablesize and
1351 * dma_boundary are set to BMDMA limits.
1352 * NCQ : SATA controllers supporting NCQ. The user must set
1353 * sg_tablesize, dma_boundary and can_queue.
1354 */
1355extern const struct ata_port_operations ata_base_port_ops;
1356extern const struct ata_port_operations sata_port_ops;
Elias Oltmanns45fabbb2008-09-21 11:54:08 +02001357extern struct device_attribute *ata_common_sdev_attrs[];
Tejun Heo68d1d072008-03-25 12:22:49 +09001358
Akinobu Mita018d5ef2015-01-29 08:30:29 +09001359/*
1360 * All sht initializers (BASE, PIO, BMDMA, NCQ) must be instantiated
1361 * by the edge drivers. Because the 'module' field of sht must be the
1362 * edge driver's module reference, otherwise the driver can be unloaded
1363 * even if the scsi_device is being accessed.
1364 */
Tejun Heo68d1d072008-03-25 12:22:49 +09001365#define ATA_BASE_SHT(drv_name) \
1366 .module = THIS_MODULE, \
1367 .name = drv_name, \
1368 .ioctl = ata_scsi_ioctl, \
1369 .queuecommand = ata_scsi_queuecmd, \
1370 .can_queue = ATA_DEF_QUEUE, \
Shaohua Li12cb5ce2015-01-15 17:32:27 -08001371 .tag_alloc_policy = BLK_TAG_ALLOC_RR, \
Tejun Heo68d1d072008-03-25 12:22:49 +09001372 .this_id = ATA_SHT_THIS_ID, \
Tejun Heo68d1d072008-03-25 12:22:49 +09001373 .emulated = ATA_SHT_EMULATED, \
1374 .use_clustering = ATA_SHT_USE_CLUSTERING, \
1375 .proc_name = drv_name, \
1376 .slave_configure = ata_scsi_slave_config, \
1377 .slave_destroy = ata_scsi_slave_destroy, \
Elias Oltmanns45fabbb2008-09-21 11:54:08 +02001378 .bios_param = ata_std_bios_param, \
Tejun Heod8d91292010-05-15 20:09:34 +02001379 .unlock_native_capacity = ata_scsi_unlock_native_capacity, \
Elias Oltmanns45fabbb2008-09-21 11:54:08 +02001380 .sdev_attrs = ata_common_sdev_attrs
Tejun Heo68d1d072008-03-25 12:22:49 +09001381
Tejun Heo68d1d072008-03-25 12:22:49 +09001382#define ATA_NCQ_SHT(drv_name) \
1383 ATA_BASE_SHT(drv_name), \
1384 .change_queue_depth = ata_scsi_change_queue_depth
1385
1386/*
Tejun Heo071f44b2008-04-07 22:47:22 +09001387 * PMP helpers
1388 */
Tejun Heo88fcd562008-04-07 22:47:22 +09001389#ifdef CONFIG_SATA_PMP
Tejun Heo071f44b2008-04-07 22:47:22 +09001390static inline bool sata_pmp_supported(struct ata_port *ap)
1391{
1392 return ap->flags & ATA_FLAG_PMP;
1393}
1394
1395static inline bool sata_pmp_attached(struct ata_port *ap)
1396{
1397 return ap->nr_pmp_links != 0;
1398}
1399
1400static inline int ata_is_host_link(const struct ata_link *link)
1401{
Tejun Heob1c72912008-07-31 17:02:43 +09001402 return link == &link->ap->link || link == link->ap->slave_link;
Tejun Heo071f44b2008-04-07 22:47:22 +09001403}
Tejun Heo88fcd562008-04-07 22:47:22 +09001404#else /* CONFIG_SATA_PMP */
1405static inline bool sata_pmp_supported(struct ata_port *ap)
1406{
1407 return false;
1408}
1409
1410static inline bool sata_pmp_attached(struct ata_port *ap)
1411{
1412 return false;
1413}
1414
1415static inline int ata_is_host_link(const struct ata_link *link)
1416{
1417 return 1;
1418}
1419#endif /* CONFIG_SATA_PMP */
Tejun Heo071f44b2008-04-07 22:47:22 +09001420
1421static inline int sata_srst_pmp(struct ata_link *link)
1422{
1423 if (sata_pmp_supported(link->ap) && ata_is_host_link(link))
1424 return SATA_PMP_CTRL_PORT;
1425 return link->pmp;
1426}
1427
1428/*
Tejun Heo61440db2006-05-15 20:57:55 +09001429 * printk helpers
1430 */
Joe Perchesb9075fa2011-10-31 17:11:33 -07001431__printf(3, 4)
Joe Perchesd7bead12014-09-22 09:52:18 -07001432void ata_port_printk(const struct ata_port *ap, const char *level,
1433 const char *fmt, ...);
Joe Perchesb9075fa2011-10-31 17:11:33 -07001434__printf(3, 4)
Joe Perchesd7bead12014-09-22 09:52:18 -07001435void ata_link_printk(const struct ata_link *link, const char *level,
1436 const char *fmt, ...);
Joe Perchesb9075fa2011-10-31 17:11:33 -07001437__printf(3, 4)
Joe Perchesd7bead12014-09-22 09:52:18 -07001438void ata_dev_printk(const struct ata_device *dev, const char *level,
1439 const char *fmt, ...);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440
Joe Perchesa9a79df2011-04-15 15:51:59 -07001441#define ata_port_err(ap, fmt, ...) \
1442 ata_port_printk(ap, KERN_ERR, fmt, ##__VA_ARGS__)
1443#define ata_port_warn(ap, fmt, ...) \
1444 ata_port_printk(ap, KERN_WARNING, fmt, ##__VA_ARGS__)
1445#define ata_port_notice(ap, fmt, ...) \
1446 ata_port_printk(ap, KERN_NOTICE, fmt, ##__VA_ARGS__)
1447#define ata_port_info(ap, fmt, ...) \
1448 ata_port_printk(ap, KERN_INFO, fmt, ##__VA_ARGS__)
1449#define ata_port_dbg(ap, fmt, ...) \
1450 ata_port_printk(ap, KERN_DEBUG, fmt, ##__VA_ARGS__)
Tejun Heo9af5c9c2007-08-06 18:36:22 +09001451
Joe Perchesa9a79df2011-04-15 15:51:59 -07001452#define ata_link_err(link, fmt, ...) \
1453 ata_link_printk(link, KERN_ERR, fmt, ##__VA_ARGS__)
1454#define ata_link_warn(link, fmt, ...) \
1455 ata_link_printk(link, KERN_WARNING, fmt, ##__VA_ARGS__)
1456#define ata_link_notice(link, fmt, ...) \
1457 ata_link_printk(link, KERN_NOTICE, fmt, ##__VA_ARGS__)
1458#define ata_link_info(link, fmt, ...) \
1459 ata_link_printk(link, KERN_INFO, fmt, ##__VA_ARGS__)
1460#define ata_link_dbg(link, fmt, ...) \
1461 ata_link_printk(link, KERN_DEBUG, fmt, ##__VA_ARGS__)
1462
1463#define ata_dev_err(dev, fmt, ...) \
1464 ata_dev_printk(dev, KERN_ERR, fmt, ##__VA_ARGS__)
1465#define ata_dev_warn(dev, fmt, ...) \
1466 ata_dev_printk(dev, KERN_WARNING, fmt, ##__VA_ARGS__)
1467#define ata_dev_notice(dev, fmt, ...) \
1468 ata_dev_printk(dev, KERN_NOTICE, fmt, ##__VA_ARGS__)
1469#define ata_dev_info(dev, fmt, ...) \
1470 ata_dev_printk(dev, KERN_INFO, fmt, ##__VA_ARGS__)
1471#define ata_dev_dbg(dev, fmt, ...) \
1472 ata_dev_printk(dev, KERN_DEBUG, fmt, ##__VA_ARGS__)
Tejun Heo61440db2006-05-15 20:57:55 +09001473
Joe Perches06296a12011-04-15 15:52:00 -07001474void ata_print_version(const struct device *dev, const char *version);
1475
Tejun Heo61440db2006-05-15 20:57:55 +09001476/*
Tejun Heof3e81b12006-05-15 20:58:21 +09001477 * ata_eh_info helpers
1478 */
Joe Perchesb9075fa2011-10-31 17:11:33 -07001479extern __printf(2, 3)
1480void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
1481extern __printf(2, 3)
1482void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
Tejun Heob64bbc32007-07-16 14:29:39 +09001483extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
Tejun Heof3e81b12006-05-15 20:58:21 +09001484
Tejun Heoc0b6c032006-07-03 16:07:26 +09001485static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
1486{
Tejun Heob558edd2008-01-24 00:05:14 +09001487 ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
Tejun Heof8f1e1c2007-07-16 14:29:40 +09001488 ehi->flags |= ATA_EHI_HOTPLUGGED;
Tejun Heob558edd2008-01-24 00:05:14 +09001489 ehi->action |= ATA_EH_RESET | ATA_EH_ENABLE_LINK;
Tejun Heoc0b6c032006-07-03 16:07:26 +09001490 ehi->err_mask |= AC_ERR_ATA_BUS;
1491}
1492
Tejun Heof3e81b12006-05-15 20:58:21 +09001493/*
Tejun Heocbcdd872007-08-18 13:14:55 +09001494 * port description helpers
1495 */
Joe Perchesb9075fa2011-10-31 17:11:33 -07001496extern __printf(2, 3)
1497void ata_port_desc(struct ata_port *ap, const char *fmt, ...);
Tejun Heocbcdd872007-08-18 13:14:55 +09001498#ifdef CONFIG_PCI
1499extern void ata_port_pbar_desc(struct ata_port *ap, int bar, ssize_t offset,
1500 const char *name);
1501#endif
1502
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503static inline unsigned int ata_tag_valid(unsigned int tag)
1504{
1505 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
1506}
1507
Tejun Heo2ab7db12006-05-15 20:58:02 +09001508static inline unsigned int ata_tag_internal(unsigned int tag)
1509{
Yoichi Yuasa83c063d2008-02-28 21:43:13 +09001510 return tag == ATA_TAG_INTERNAL;
Tejun Heo2ab7db12006-05-15 20:58:02 +09001511}
1512
Tejun Heo5806db22006-06-24 20:30:19 +09001513/*
1514 * device helpers
1515 */
Tejun Heoe1211e32006-04-01 01:38:18 +09001516static inline unsigned int ata_class_enabled(unsigned int class)
Tejun Heo597afd22006-03-01 01:25:38 +09001517{
Tejun Heoe0a71752007-09-23 13:14:12 +09001518 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI ||
Hannes Reinecke9162c652014-11-05 13:08:21 +01001519 class == ATA_DEV_PMP || class == ATA_DEV_SEMB ||
1520 class == ATA_DEV_ZAC;
Tejun Heo597afd22006-03-01 01:25:38 +09001521}
1522
Tejun Heoe1211e32006-04-01 01:38:18 +09001523static inline unsigned int ata_class_disabled(unsigned int class)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524{
Tejun Heoe0a71752007-09-23 13:14:12 +09001525 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP ||
1526 class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP;
Tejun Heoe1211e32006-04-01 01:38:18 +09001527}
1528
Tejun Heo002c8052006-04-02 17:54:46 +09001529static inline unsigned int ata_class_absent(unsigned int class)
1530{
1531 return !ata_class_enabled(class) && !ata_class_disabled(class);
1532}
1533
Tejun Heoe1211e32006-04-01 01:38:18 +09001534static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1535{
1536 return ata_class_enabled(dev->class);
1537}
1538
1539static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1540{
1541 return ata_class_disabled(dev->class);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001542}
1543
Tejun Heo002c8052006-04-02 17:54:46 +09001544static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1545{
1546 return ata_class_absent(dev->class);
1547}
1548
Tejun Heo5806db22006-06-24 20:30:19 +09001549/*
Tejun Heof58229f2007-08-06 18:36:23 +09001550 * link helpers
Tejun Heo5806db22006-06-24 20:30:19 +09001551 */
Tejun Heof58229f2007-08-06 18:36:23 +09001552static inline int ata_link_max_devices(const struct ata_link *link)
Tejun Heo5806db22006-06-24 20:30:19 +09001553{
Tejun Heo89898052007-08-06 18:36:23 +09001554 if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS)
Tejun Heo5806db22006-06-24 20:30:19 +09001555 return 2;
1556 return 1;
1557}
1558
Tejun Heoda917d62007-09-23 13:14:12 +09001559static inline int ata_link_active(struct ata_link *link)
1560{
1561 return ata_tag_valid(link->active_tag) || link->sactive;
1562}
1563
Tejun Heo1eca4362008-11-03 20:03:17 +09001564/*
1565 * Iterators
1566 *
1567 * ATA_LITER_* constants are used to select link iteration mode and
1568 * ATA_DITER_* device iteration mode.
1569 *
1570 * For a custom iteration directly using ata_{link|dev}_next(), if
1571 * @link or @dev, respectively, is NULL, the first element is
1572 * returned. @dev and @link can be any valid device or link and the
1573 * next element according to the iteration mode will be returned.
1574 * After the last element, NULL is returned.
1575 */
1576enum ata_link_iter_mode {
1577 ATA_LITER_EDGE, /* if present, PMP links only; otherwise,
1578 * host link. no slave link */
1579 ATA_LITER_HOST_FIRST, /* host link followed by PMP or slave links */
1580 ATA_LITER_PMP_FIRST, /* PMP links followed by host link,
1581 * slave link still comes after host link */
1582};
Tejun Heo89898052007-08-06 18:36:23 +09001583
Tejun Heo1eca4362008-11-03 20:03:17 +09001584enum ata_dev_iter_mode {
1585 ATA_DITER_ENABLED,
1586 ATA_DITER_ENABLED_REVERSE,
1587 ATA_DITER_ALL,
1588 ATA_DITER_ALL_REVERSE,
1589};
Tejun Heo89898052007-08-06 18:36:23 +09001590
Tejun Heo1eca4362008-11-03 20:03:17 +09001591extern struct ata_link *ata_link_next(struct ata_link *link,
1592 struct ata_port *ap,
1593 enum ata_link_iter_mode mode);
Tejun Heof58229f2007-08-06 18:36:23 +09001594
Tejun Heo1eca4362008-11-03 20:03:17 +09001595extern struct ata_device *ata_dev_next(struct ata_device *dev,
1596 struct ata_link *link,
1597 enum ata_dev_iter_mode mode);
Tejun Heof58229f2007-08-06 18:36:23 +09001598
Tejun Heo1eca4362008-11-03 20:03:17 +09001599/*
1600 * Shortcut notation for iterations
1601 *
1602 * ata_for_each_link() iterates over each link of @ap according to
1603 * @mode. @link points to the current link in the loop. @link is
1604 * NULL after loop termination. ata_for_each_dev() works the same way
1605 * except that it iterates over each device of @link.
1606 *
1607 * Note that the mode prefixes ATA_{L|D}ITER_ shouldn't need to be
1608 * specified when using the following shorthand notations. Only the
1609 * mode itself (EDGE, HOST_FIRST, ENABLED, etc...) should be
1610 * specified. This not only increases brevity but also makes it
1611 * impossible to use ATA_LITER_* for device iteration or vice-versa.
1612 */
1613#define ata_for_each_link(link, ap, mode) \
1614 for ((link) = ata_link_next(NULL, (ap), ATA_LITER_##mode); (link); \
1615 (link) = ata_link_next((link), (ap), ATA_LITER_##mode))
1616
1617#define ata_for_each_dev(dev, link, mode) \
1618 for ((dev) = ata_dev_next(NULL, (link), ATA_DITER_##mode); (dev); \
1619 (dev) = ata_dev_next((dev), (link), ATA_DITER_##mode))
Tejun Heo5806db22006-06-24 20:30:19 +09001620
Tejun Heo6d1245b2007-02-20 23:20:27 +09001621/**
1622 * ata_ncq_enabled - Test whether NCQ is enabled
1623 * @dev: ATA device to test for
1624 *
1625 * LOCKING:
1626 * spin_lock_irqsave(host lock)
1627 *
1628 * RETURNS:
1629 * 1 if NCQ is enabled for @dev, 0 otherwise.
1630 */
1631static inline int ata_ncq_enabled(struct ata_device *dev)
1632{
1633 return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1634 ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1635}
Edward Falk0baab862005-06-02 18:17:13 -04001636
Marc Carino87fb6c32013-08-24 23:22:51 -07001637static inline bool ata_fpdma_dsm_supported(struct ata_device *dev)
1638{
1639 return (dev->flags & ATA_DFLAG_NCQ_SEND_RECV) &&
1640 (dev->ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_DSM_OFFSET] &
1641 ATA_LOG_NCQ_SEND_RECV_DSM_TRIM);
1642}
1643
Linus Torvalds1da177e2005-04-16 15:20:36 -07001644static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1645{
1646 qc->tf.ctl |= ATA_NIEN;
1647}
1648
Tejun Heof69499f2006-05-15 20:58:03 +09001649static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1650 unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001651{
1652 if (likely(ata_tag_valid(tag)))
1653 return &ap->qcmd[tag];
1654 return NULL;
1655}
1656
Tejun Heof69499f2006-05-15 20:58:03 +09001657static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1658 unsigned int tag)
1659{
1660 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1661
1662 if (unlikely(!qc) || !ap->ops->error_handler)
1663 return qc;
1664
1665 if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1666 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1667 return qc;
1668
1669 return NULL;
1670}
1671
Tejun Heoaacda372008-03-18 17:47:43 +09001672static inline unsigned int ata_qc_raw_nbytes(struct ata_queued_cmd *qc)
1673{
1674 return qc->nbytes - min(qc->extrabytes, qc->nbytes);
1675}
1676
Tejun Heo3373efd2006-05-15 20:57:53 +09001677static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678{
1679 memset(tf, 0, sizeof(*tf));
1680
Tejun Heo5fe74542010-05-10 21:41:37 +02001681#ifdef CONFIG_ATA_SFF
Tejun Heo9af5c9c2007-08-06 18:36:22 +09001682 tf->ctl = dev->link->ap->ctl;
Tejun Heo5fe74542010-05-10 21:41:37 +02001683#else
1684 tf->ctl = ATA_DEVCTL_OBS;
1685#endif
Tejun Heo3373efd2006-05-15 20:57:53 +09001686 if (dev->devno == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001687 tf->device = ATA_DEVICE_OBS;
1688 else
1689 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1690}
1691
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001692static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1693{
Tejun Heo501e0c502007-01-17 11:34:02 +09001694 qc->dma_dir = DMA_NONE;
Tejun Heoff2aeb12007-12-05 16:43:11 +09001695 qc->sg = NULL;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001696 qc->flags = 0;
Jens Axboe87260212007-10-16 11:14:12 +02001697 qc->cursg = NULL;
1698 qc->cursg_ofs = 0;
Tejun Heoaacda372008-03-18 17:47:43 +09001699 qc->nbytes = qc->extrabytes = qc->curbytes = 0;
Brian King7a801182007-01-17 12:32:12 -06001700 qc->n_elem = 0;
Albert Leea22e2eb2005-12-05 15:38:02 +08001701 qc->err_mask = 0;
Mark Lord5a5dbd12007-03-16 10:22:26 -04001702 qc->sect_size = ATA_SECT_SIZE;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001703
Tejun Heo3373efd2006-05-15 20:57:53 +09001704 ata_tf_init(qc->dev, &qc->tf);
Tejun Heoe61e0672006-05-15 20:57:40 +09001705
1706 /* init result_tf such that it indicates normal completion */
1707 qc->result_tf.command = ATA_DRDY;
1708 qc->result_tf.feature = 0;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001709}
1710
Jeff Garzik057ace52005-10-22 14:27:05 -04001711static inline int ata_try_flush_cache(const struct ata_device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001712{
1713 return ata_id_wcache_enabled(dev->id) ||
1714 ata_id_has_flush(dev->id) ||
1715 ata_id_has_flush_ext(dev->id);
1716}
1717
Jeff Garzika7dac442005-10-30 04:44:42 -05001718static inline unsigned int ac_err_mask(u8 status)
1719{
Albert Lee3655d1d2006-05-19 11:43:04 +08001720 if (status & (ATA_BUSY | ATA_DRQ))
Tejun Heo11a56d22006-01-23 13:09:36 +09001721 return AC_ERR_HSM;
Jeff Garzika7dac442005-10-30 04:44:42 -05001722 if (status & (ATA_ERR | ATA_DF))
1723 return AC_ERR_DEV;
1724 return 0;
1725}
1726
1727static inline unsigned int __ac_err_mask(u8 status)
1728{
1729 unsigned int mask = ac_err_mask(status);
1730 if (mask == 0)
1731 return AC_ERR_OTHER;
1732 return mask;
1733}
1734
Jeff Garzik35bb94b2006-04-11 13:12:34 -04001735static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1736{
Tejun Heo49114872007-04-17 23:44:06 +09001737 return *(struct ata_port **)&host->hostdata[0];
Jeff Garzik35bb94b2006-04-11 13:12:34 -04001738}
1739
Tejun Heo78ab88f2008-05-01 23:41:41 +09001740static inline int ata_check_ready(u8 status)
1741{
Jeff Garzik005b1f72008-05-09 15:00:55 -04001742 if (!(status & ATA_BUSY))
1743 return 1;
Tejun Heo78ab88f2008-05-01 23:41:41 +09001744
1745 /* 0xff indicates either no device or device not ready */
1746 if (status == 0xff)
1747 return -ENODEV;
1748
Jeff Garzik005b1f72008-05-09 15:00:55 -04001749 return 0;
Tejun Heo78ab88f2008-05-01 23:41:41 +09001750}
1751
Tejun Heo341c2c92008-05-20 02:17:51 +09001752static inline unsigned long ata_deadline(unsigned long from_jiffies,
1753 unsigned long timeout_msecs)
1754{
1755 return from_jiffies + msecs_to_jiffies(timeout_msecs);
1756}
1757
Alan Coxb15b3eb2008-08-01 09:18:34 +01001758/* Don't open code these in drivers as there are traps. Firstly the range may
1759 change in future hardware and specs, secondly 0xFF means 'no DMA' but is
1760 > UDMA_0. Dyma ddreigiau */
1761
1762static inline int ata_using_mwdma(struct ata_device *adev)
1763{
1764 if (adev->dma_mode >= XFER_MW_DMA_0 && adev->dma_mode <= XFER_MW_DMA_4)
1765 return 1;
1766 return 0;
1767}
1768
1769static inline int ata_using_udma(struct ata_device *adev)
1770{
1771 if (adev->dma_mode >= XFER_UDMA_0 && adev->dma_mode <= XFER_UDMA_7)
1772 return 1;
1773 return 0;
1774}
1775
1776static inline int ata_dma_enabled(struct ata_device *adev)
1777{
1778 return (adev->dma_mode == 0xFF ? 0 : 1);
1779}
Tejun Heo48515f62008-04-07 22:47:21 +09001780
1781/**************************************************************************
1782 * PMP - drivers/ata/libata-pmp.c
1783 */
Tejun Heo88fcd562008-04-07 22:47:22 +09001784#ifdef CONFIG_SATA_PMP
1785
Tejun Heo48515f62008-04-07 22:47:21 +09001786extern const struct ata_port_operations sata_pmp_port_ops;
1787
1788extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc);
1789extern void sata_pmp_error_handler(struct ata_port *ap);
1790
Tejun Heo88fcd562008-04-07 22:47:22 +09001791#else /* CONFIG_SATA_PMP */
1792
1793#define sata_pmp_port_ops sata_port_ops
1794#define sata_pmp_qc_defer_cmd_switch ata_std_qc_defer
1795#define sata_pmp_error_handler ata_std_error_handler
1796
1797#endif /* CONFIG_SATA_PMP */
1798
Tejun Heo48515f62008-04-07 22:47:21 +09001799
Tejun Heo624d5c52008-03-25 22:16:41 +09001800/**************************************************************************
1801 * SFF - drivers/ata/libata-sff.c
1802 */
Tejun Heo127102a2008-04-07 22:47:21 +09001803#ifdef CONFIG_ATA_SFF
1804
Tejun Heo624d5c52008-03-25 22:16:41 +09001805extern const struct ata_port_operations ata_sff_port_ops;
Alan Cox871af122009-01-05 14:16:39 +00001806extern const struct ata_port_operations ata_bmdma32_port_ops;
Tejun Heo624d5c52008-03-25 22:16:41 +09001807
1808/* PIO only, sg_tablesize and dma_boundary limits can be removed */
1809#define ATA_PIO_SHT(drv_name) \
1810 ATA_BASE_SHT(drv_name), \
1811 .sg_tablesize = LIBATA_MAX_PRD, \
1812 .dma_boundary = ATA_DMA_BOUNDARY
1813
Tejun Heo9363c382008-04-07 22:47:16 +09001814extern void ata_sff_dev_select(struct ata_port *ap, unsigned int device);
1815extern u8 ata_sff_check_status(struct ata_port *ap);
Alan Coxa57c1ba2008-05-29 22:10:58 +01001816extern void ata_sff_pause(struct ata_port *ap);
1817extern void ata_sff_dma_pause(struct ata_port *ap);
Tejun Heo9363c382008-04-07 22:47:16 +09001818extern int ata_sff_busy_sleep(struct ata_port *ap,
1819 unsigned long timeout_pat, unsigned long timeout);
Tejun Heo705e76b2008-04-07 22:47:19 +09001820extern int ata_sff_wait_ready(struct ata_link *link, unsigned long deadline);
Tejun Heo9363c382008-04-07 22:47:16 +09001821extern void ata_sff_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
1822extern void ata_sff_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
1823extern void ata_sff_exec_command(struct ata_port *ap,
1824 const struct ata_taskfile *tf);
1825extern unsigned int ata_sff_data_xfer(struct ata_device *dev,
Tejun Heo624d5c52008-03-25 22:16:41 +09001826 unsigned char *buf, unsigned int buflen, int rw);
Alan Cox871af122009-01-05 14:16:39 +00001827extern unsigned int ata_sff_data_xfer32(struct ata_device *dev,
1828 unsigned char *buf, unsigned int buflen, int rw);
Tejun Heo9363c382008-04-07 22:47:16 +09001829extern unsigned int ata_sff_data_xfer_noirq(struct ata_device *dev,
Tejun Heo624d5c52008-03-25 22:16:41 +09001830 unsigned char *buf, unsigned int buflen, int rw);
Sergei Shtylyove42a5422010-05-07 22:49:02 +04001831extern void ata_sff_irq_on(struct ata_port *ap);
Tejun Heo9363c382008-04-07 22:47:16 +09001832extern void ata_sff_irq_clear(struct ata_port *ap);
1833extern int ata_sff_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
1834 u8 status, int in_wq);
Viresh Kumar64b97592011-02-22 14:32:38 +05301835extern void ata_sff_queue_work(struct work_struct *work);
1836extern void ata_sff_queue_delayed_work(struct delayed_work *dwork,
1837 unsigned long delay);
Gwendal Grignouea3c6452010-08-31 16:20:36 -07001838extern void ata_sff_queue_pio_task(struct ata_link *link, unsigned long delay);
Tejun Heo9363c382008-04-07 22:47:16 +09001839extern unsigned int ata_sff_qc_issue(struct ata_queued_cmd *qc);
Tejun Heo22183bf2008-04-07 22:47:20 +09001840extern bool ata_sff_qc_fill_rtf(struct ata_queued_cmd *qc);
Tejun Heoc3b28892010-05-19 22:10:21 +02001841extern unsigned int ata_sff_port_intr(struct ata_port *ap,
Tejun Heo9363c382008-04-07 22:47:16 +09001842 struct ata_queued_cmd *qc);
1843extern irqreturn_t ata_sff_interrupt(int irq, void *dev_instance);
Alan Coxc96f1732009-03-24 10:23:46 +00001844extern void ata_sff_lost_interrupt(struct ata_port *ap);
Tejun Heo9363c382008-04-07 22:47:16 +09001845extern void ata_sff_freeze(struct ata_port *ap);
1846extern void ata_sff_thaw(struct ata_port *ap);
1847extern int ata_sff_prereset(struct ata_link *link, unsigned long deadline);
1848extern unsigned int ata_sff_dev_classify(struct ata_device *dev, int present,
1849 u8 *r_err);
Tejun Heo705e76b2008-04-07 22:47:19 +09001850extern int ata_sff_wait_after_reset(struct ata_link *link, unsigned int devmask,
1851 unsigned long deadline);
Tejun Heo9363c382008-04-07 22:47:16 +09001852extern int ata_sff_softreset(struct ata_link *link, unsigned int *classes,
Tejun Heo624d5c52008-03-25 22:16:41 +09001853 unsigned long deadline);
Tejun Heo9363c382008-04-07 22:47:16 +09001854extern int sata_sff_hardreset(struct ata_link *link, unsigned int *class,
1855 unsigned long deadline);
1856extern void ata_sff_postreset(struct ata_link *link, unsigned int *classes);
Alan Cox3d47aa82009-03-24 10:23:19 +00001857extern void ata_sff_drain_fifo(struct ata_queued_cmd *qc);
Tejun Heo9363c382008-04-07 22:47:16 +09001858extern void ata_sff_error_handler(struct ata_port *ap);
Tejun Heo9363c382008-04-07 22:47:16 +09001859extern void ata_sff_std_ports(struct ata_ioports *ioaddr);
Tejun Heo624d5c52008-03-25 22:16:41 +09001860#ifdef CONFIG_PCI
Tejun Heo9363c382008-04-07 22:47:16 +09001861extern int ata_pci_sff_init_host(struct ata_host *host);
1862extern int ata_pci_sff_prepare_host(struct pci_dev *pdev,
Tejun Heo624d5c52008-03-25 22:16:41 +09001863 const struct ata_port_info * const * ppi,
1864 struct ata_host **r_host);
Tejun Heo9363c382008-04-07 22:47:16 +09001865extern int ata_pci_sff_activate_host(struct ata_host *host,
Tejun Heo624d5c52008-03-25 22:16:41 +09001866 irq_handler_t irq_handler,
1867 struct scsi_host_template *sht);
Tejun Heo9363c382008-04-07 22:47:16 +09001868extern int ata_pci_sff_init_one(struct pci_dev *pdev,
Alan Cox16ea0fc2010-02-23 02:26:06 -05001869 const struct ata_port_info * const * ppi,
1870 struct scsi_host_template *sht, void *host_priv, int hflags);
Tejun Heo624d5c52008-03-25 22:16:41 +09001871#endif /* CONFIG_PCI */
1872
Tejun Heo9a7780c2010-05-19 22:10:24 +02001873#ifdef CONFIG_ATA_BMDMA
1874
1875extern const struct ata_port_operations ata_bmdma_port_ops;
1876
1877#define ATA_BMDMA_SHT(drv_name) \
1878 ATA_BASE_SHT(drv_name), \
1879 .sg_tablesize = LIBATA_MAX_PRD, \
1880 .dma_boundary = ATA_DMA_BOUNDARY
1881
Tejun Heof47451c2010-05-10 21:41:40 +02001882extern void ata_bmdma_qc_prep(struct ata_queued_cmd *qc);
Tejun Heo360ff782010-05-10 21:41:42 +02001883extern unsigned int ata_bmdma_qc_issue(struct ata_queued_cmd *qc);
Tejun Heof47451c2010-05-10 21:41:40 +02001884extern void ata_bmdma_dumb_qc_prep(struct ata_queued_cmd *qc);
Tejun Heoc3b28892010-05-19 22:10:21 +02001885extern unsigned int ata_bmdma_port_intr(struct ata_port *ap,
1886 struct ata_queued_cmd *qc);
1887extern irqreturn_t ata_bmdma_interrupt(int irq, void *dev_instance);
Tejun Heofe06e5f2010-05-10 21:41:39 +02001888extern void ata_bmdma_error_handler(struct ata_port *ap);
1889extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
Tejun Heo37f65b82010-05-19 22:10:20 +02001890extern void ata_bmdma_irq_clear(struct ata_port *ap);
Tejun Heo9f2f7212010-05-10 21:41:32 +02001891extern void ata_bmdma_setup(struct ata_queued_cmd *qc);
1892extern void ata_bmdma_start(struct ata_queued_cmd *qc);
1893extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
1894extern u8 ata_bmdma_status(struct ata_port *ap);
Tejun Heoc7087652010-05-10 21:41:34 +02001895extern int ata_bmdma_port_start(struct ata_port *ap);
1896extern int ata_bmdma_port_start32(struct ata_port *ap);
Tejun Heo9f2f7212010-05-10 21:41:32 +02001897
1898#ifdef CONFIG_PCI
1899extern int ata_pci_bmdma_clear_simplex(struct pci_dev *pdev);
Tejun Heoc7087652010-05-10 21:41:34 +02001900extern void ata_pci_bmdma_init(struct ata_host *host);
Tejun Heo1c5afdf2010-05-19 22:10:22 +02001901extern int ata_pci_bmdma_prepare_host(struct pci_dev *pdev,
1902 const struct ata_port_info * const * ppi,
1903 struct ata_host **r_host);
1904extern int ata_pci_bmdma_init_one(struct pci_dev *pdev,
1905 const struct ata_port_info * const * ppi,
1906 struct scsi_host_template *sht,
1907 void *host_priv, int hflags);
Tejun Heo9f2f7212010-05-10 21:41:32 +02001908#endif /* CONFIG_PCI */
Tejun Heo9a7780c2010-05-19 22:10:24 +02001909#endif /* CONFIG_ATA_BMDMA */
Tejun Heo9f2f7212010-05-10 21:41:32 +02001910
Tejun Heo624d5c52008-03-25 22:16:41 +09001911/**
Tejun Heo9363c382008-04-07 22:47:16 +09001912 * ata_sff_busy_wait - Wait for a port status register
Tejun Heo624d5c52008-03-25 22:16:41 +09001913 * @ap: Port to wait for.
1914 * @bits: bits that must be clear
1915 * @max: number of 10uS waits to perform
1916 *
1917 * Waits up to max*10 microseconds for the selected bits in the port's
1918 * status register to be cleared.
1919 * Returns final value of status register.
1920 *
1921 * LOCKING:
1922 * Inherited from caller.
1923 */
Tejun Heo9363c382008-04-07 22:47:16 +09001924static inline u8 ata_sff_busy_wait(struct ata_port *ap, unsigned int bits,
1925 unsigned int max)
Tejun Heo624d5c52008-03-25 22:16:41 +09001926{
1927 u8 status;
1928
1929 do {
1930 udelay(10);
Tejun Heo5682ed32008-04-07 22:47:16 +09001931 status = ap->ops->sff_check_status(ap);
Tejun Heo624d5c52008-03-25 22:16:41 +09001932 max--;
1933 } while (status != 0xff && (status & bits) && (max > 0));
1934
1935 return status;
1936}
1937
1938/**
1939 * ata_wait_idle - Wait for a port to be idle.
1940 * @ap: Port to wait for.
1941 *
1942 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
1943 * Returns final value of status register.
1944 *
1945 * LOCKING:
1946 * Inherited from caller.
1947 */
1948static inline u8 ata_wait_idle(struct ata_port *ap)
1949{
Tejun Heo9363c382008-04-07 22:47:16 +09001950 u8 status = ata_sff_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
Tejun Heo624d5c52008-03-25 22:16:41 +09001951
1952#ifdef ATA_DEBUG
1953 if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
1954 ata_port_printk(ap, KERN_DEBUG, "abnormal Status 0x%X\n",
1955 status);
1956#endif
1957
1958 return status;
1959}
Tejun Heo127102a2008-04-07 22:47:21 +09001960#endif /* CONFIG_ATA_SFF */
Tejun Heo624d5c52008-03-25 22:16:41 +09001961
Linus Torvalds1da177e2005-04-16 15:20:36 -07001962#endif /* __LINUX_LIBATA_H__ */