blob: c170be548b7f1626c7c3a3eb27acd083ee54a5e7 [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
Christoph Hellwigdcd3ea82016-09-22 07:49:50 -070049#define ATA_PRIMARY_IRQ(dev) 14
50#define ATA_SECONDARY_IRQ(dev) 15
Jeff Garzika6d967a2006-09-25 15:33:09 -040051#endif
Alan Cox2ec7df02006-08-10 16:59:10 +090052
Linus Torvalds1da177e2005-04-16 15:20:36 -070053/*
Randy Dunlapbfd60572006-01-17 19:34:42 -050054 * compile-time options: to be removed as soon as all the drivers are
55 * converted to the new debugging mechanism
Linus Torvalds1da177e2005-04-16 15:20:36 -070056 */
57#undef ATA_DEBUG /* debugging output */
58#undef ATA_VERBOSE_DEBUG /* yet more debugging output */
59#undef ATA_IRQ_TRAP /* define to ack screaming irqs */
60#undef ATA_NDEBUG /* define to disable quick runtime checks */
Linus Torvalds1da177e2005-04-16 15:20:36 -070061
62
63/* note: prints function name for you */
64#ifdef ATA_DEBUG
Alexander Beregalov1f938d02008-07-21 00:06:19 +040065#define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __func__, ## args)
Linus Torvalds1da177e2005-04-16 15:20:36 -070066#ifdef ATA_VERBOSE_DEBUG
Alexander Beregalov1f938d02008-07-21 00:06:19 +040067#define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __func__, ## args)
Linus Torvalds1da177e2005-04-16 15:20:36 -070068#else
69#define VPRINTK(fmt, args...)
70#endif /* ATA_VERBOSE_DEBUG */
71#else
72#define DPRINTK(fmt, args...)
73#define VPRINTK(fmt, args...)
74#endif /* ATA_DEBUG */
75
Alexander Beregalov1f938d02008-07-21 00:06:19 +040076#define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __func__, ## args)
Jeff Garzik2c13b7c2005-11-14 14:14:16 -050077
Joe Perches06296a12011-04-15 15:52:00 -070078#define ata_print_version_once(dev, version) \
79({ \
80 static bool __print_once; \
81 \
82 if (!__print_once) { \
83 __print_once = true; \
84 ata_print_version(dev, version); \
85 } \
86})
87
Randy Dunlapbfd60572006-01-17 19:34:42 -050088/* NEW: debug levels */
89#define HAVE_LIBATA_MSG 1
90
91enum {
92 ATA_MSG_DRV = 0x0001,
93 ATA_MSG_INFO = 0x0002,
94 ATA_MSG_PROBE = 0x0004,
95 ATA_MSG_WARN = 0x0008,
96 ATA_MSG_MALLOC = 0x0010,
97 ATA_MSG_CTL = 0x0020,
98 ATA_MSG_INTR = 0x0040,
99 ATA_MSG_ERR = 0x0080,
100};
101
102#define ata_msg_drv(p) ((p)->msg_enable & ATA_MSG_DRV)
103#define ata_msg_info(p) ((p)->msg_enable & ATA_MSG_INFO)
104#define ata_msg_probe(p) ((p)->msg_enable & ATA_MSG_PROBE)
105#define ata_msg_warn(p) ((p)->msg_enable & ATA_MSG_WARN)
106#define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC)
107#define ata_msg_ctl(p) ((p)->msg_enable & ATA_MSG_CTL)
108#define ata_msg_intr(p) ((p)->msg_enable & ATA_MSG_INTR)
109#define ata_msg_err(p) ((p)->msg_enable & ATA_MSG_ERR)
110
111static inline u32 ata_msg_init(int dval, int default_msg_enable_bits)
112{
113 if (dval < 0 || dval >= (sizeof(u32) * 8))
114 return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */
115 if (!dval)
116 return 0;
117 return (1 << dval) - 1;
118}
119
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120/* defines only for the constants which don't work well as enums */
121#define ATA_TAG_POISON 0xfafbfcfdU
122
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123enum {
124 /* various global constants */
125 LIBATA_MAX_PRD = ATA_MAX_PRD / 2,
Alan Coxd26fc952007-07-06 19:13:52 -0400126 LIBATA_DUMB_MAX_PRD = ATA_MAX_PRD / 4, /* Worst case */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127 ATA_DEF_QUEUE = 1,
Tejun Heo2ab7db12006-05-15 20:58:02 +0900128 /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
Tejun Heoa6e6ce82006-05-15 21:03:48 +0900129 ATA_MAX_QUEUE = 32,
Tejun Heo2ab7db12006-05-15 20:58:02 +0900130 ATA_TAG_INTERNAL = ATA_MAX_QUEUE - 1,
Tejun Heo341c2c92008-05-20 02:17:51 +0900131 ATA_SHORT_PAUSE = 16,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132
Tejun Heo140b5e592007-12-12 12:21:52 +0900133 ATAPI_MAX_DRAIN = 16 << 10,
134
Tejun Heob558edd2008-01-24 00:05:14 +0900135 ATA_ALL_DEVICES = (1 << ATA_MAX_DEVICES) - 1,
136
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137 ATA_SHT_EMULATED = 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138 ATA_SHT_THIS_ID = -1,
Jeff Garzikcf482932005-10-22 00:19:33 -0400139 ATA_SHT_USE_CLUSTERING = 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140
Sergei Shtylyovdc34e7e2013-07-01 00:01:32 +0400141 /* struct ata_taskfile flags */
142 ATA_TFLAG_LBA48 = (1 << 0), /* enable 48-bit LBA and "HOB" */
143 ATA_TFLAG_ISADDR = (1 << 1), /* enable r/w to nsect/lba regs */
144 ATA_TFLAG_DEVICE = (1 << 2), /* enable r/w to device reg */
145 ATA_TFLAG_WRITE = (1 << 3), /* data dir: host->dev==1 (write) */
146 ATA_TFLAG_LBA = (1 << 4), /* enable LBA */
147 ATA_TFLAG_FUA = (1 << 5), /* enable FUA */
148 ATA_TFLAG_POLLING = (1 << 6), /* set nIEN to 1 and use polling */
149
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150 /* struct ata_device stuff */
Tejun Heo949b38a2006-04-02 18:51:52 +0900151 ATA_DFLAG_LBA = (1 << 0), /* device supports LBA */
152 ATA_DFLAG_LBA48 = (1 << 1), /* device supports LBA48 */
Jeff Garzik029f5462006-04-02 10:30:40 -0400153 ATA_DFLAG_CDB_INTR = (1 << 2), /* device asserts INTRQ when ready for CDB */
Tejun Heo88e49032006-05-15 21:03:38 +0900154 ATA_DFLAG_NCQ = (1 << 3), /* device supports NCQ */
Tejun Heo6fc49ad2006-11-11 20:10:45 +0900155 ATA_DFLAG_FLUSH_EXT = (1 << 4), /* do FLUSH_EXT instead of FLUSH */
Tejun Heo67465442007-05-15 03:28:16 +0900156 ATA_DFLAG_ACPI_PENDING = (1 << 5), /* ACPI resume action pending */
157 ATA_DFLAG_ACPI_FAILED = (1 << 6), /* ACPI on devcfg has failed */
Tejun Heo7d77b242007-09-23 13:14:13 +0900158 ATA_DFLAG_AN = (1 << 7), /* AN configured */
Tejun Heo91163002008-02-21 13:25:50 +0900159 ATA_DFLAG_DMADIR = (1 << 10), /* device requires DMADIR */
Kristen Carlson Accardi25571642007-09-11 11:41:59 -0700160 ATA_DFLAG_CFG_MASK = (1 << 12) - 1,
Tejun Heo949b38a2006-04-02 18:51:52 +0900161
Kristen Carlson Accardi25571642007-09-11 11:41:59 -0700162 ATA_DFLAG_PIO = (1 << 12), /* device limited to PIO mode */
163 ATA_DFLAG_NCQ_OFF = (1 << 13), /* device limited to non-NCQ mode */
Tejun Heo054a5fb2007-10-25 18:30:36 +0900164 ATA_DFLAG_SLEEPING = (1 << 15), /* device is sleeping */
Tejun Heo00115e02007-11-27 19:28:58 +0900165 ATA_DFLAG_DUBIOUS_XFER = (1 << 16), /* data transfer not verified */
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200166 ATA_DFLAG_NO_UNLOAD = (1 << 17), /* device doesn't support unload */
Tejun Heo445d2112010-04-05 10:33:13 +0900167 ATA_DFLAG_UNLOCK_HPA = (1 << 18), /* unlock HPA */
Marc Carinoed369112013-08-24 23:22:50 -0700168 ATA_DFLAG_NCQ_SEND_RECV = (1 << 19), /* device supports NCQ SEND and RECV */
Adam Manzanares8e061782016-10-17 11:27:29 -0700169 ATA_DFLAG_NCQ_PRIO = (1 << 20), /* device supports NCQ priority */
Adam Manzanares84f95242016-10-17 11:27:30 -0700170 ATA_DFLAG_NCQ_PRIO_ENABLE = (1 << 21), /* Priority cmds sent to dev */
Tejun Heof20ded32007-11-27 19:28:52 +0900171 ATA_DFLAG_INIT_MASK = (1 << 24) - 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172
Tejun Heof20ded32007-11-27 19:28:52 +0900173 ATA_DFLAG_DETACH = (1 << 24),
174 ATA_DFLAG_DETACHED = (1 << 25),
Tejun Heoabdda732006-05-31 18:27:29 +0900175
Lin Mingb1354cb2012-06-25 16:13:08 +0800176 ATA_DFLAG_DA = (1 << 26), /* device supports Device Attention */
Shane Huang65fe1f02012-09-07 22:40:01 +0800177 ATA_DFLAG_DEVSLP = (1 << 27), /* device supports Device Sleep */
Aaron Lu0d0cdb02012-11-26 13:55:25 +0800178 ATA_DFLAG_ACPI_DISABLED = (1 << 28), /* ACPI for the device is disabled */
Hannes Reinecke06dbde52016-04-04 11:44:03 +0200179 ATA_DFLAG_D_SENSE = (1 << 29), /* Descriptor sense requested */
Hannes Reinecke6d1003a2016-04-25 12:45:56 +0200180 ATA_DFLAG_ZAC = (1 << 30), /* ZAC device */
Lin Mingb1354cb2012-06-25 16:13:08 +0800181
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182 ATA_DEV_UNKNOWN = 0, /* unknown device */
183 ATA_DEV_ATA = 1, /* ATA device */
184 ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */
185 ATA_DEV_ATAPI = 3, /* ATAPI device */
186 ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */
Tejun Heoe0a71752007-09-23 13:14:12 +0900187 ATA_DEV_PMP = 5, /* SATA port multiplier */
188 ATA_DEV_PMP_UNSUP = 6, /* SATA port multiplier (unsupported) */
189 ATA_DEV_SEMB = 7, /* SEMB */
190 ATA_DEV_SEMB_UNSUP = 8, /* SEMB (unsupported) */
Hannes Reinecke9162c652014-11-05 13:08:21 +0100191 ATA_DEV_ZAC = 9, /* ZAC device */
Hannes Reinecke3a929452016-04-25 12:45:51 +0200192 ATA_DEV_ZAC_UNSUP = 10, /* ZAC device (unsupported) */
193 ATA_DEV_NONE = 11, /* no device */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194
Tejun Heo0c887582007-08-06 18:36:23 +0900195 /* struct ata_link flags */
Tejun Heo05944bd2008-08-13 20:19:09 +0900196 ATA_LFLAG_NO_HRST = (1 << 1), /* avoid hardreset */
Tejun Heoae791c02007-09-23 13:14:12 +0900197 ATA_LFLAG_NO_SRST = (1 << 2), /* avoid softreset */
198 ATA_LFLAG_ASSUME_ATA = (1 << 3), /* assume ATA class */
199 ATA_LFLAG_ASSUME_SEMB = (1 << 4), /* assume SEMB class */
200 ATA_LFLAG_ASSUME_CLASS = ATA_LFLAG_ASSUME_ATA | ATA_LFLAG_ASSUME_SEMB,
Tejun Heofd995f72007-09-23 13:14:12 +0900201 ATA_LFLAG_NO_RETRY = (1 << 5), /* don't retry this link */
Tejun Heof9df58c2007-09-23 13:14:13 +0900202 ATA_LFLAG_DISABLED = (1 << 6), /* link is disabled */
Kristen Carlson Accardi18f7ba42008-06-03 10:33:55 -0700203 ATA_LFLAG_SW_ACTIVITY = (1 << 7), /* keep activity stats */
Tejun Heo6b7ae952010-09-01 17:50:06 +0200204 ATA_LFLAG_NO_LPM = (1 << 8), /* disable LPM on this link */
Dan Williamsca6d43b2012-06-21 23:41:41 -0700205 ATA_LFLAG_RST_ONCE = (1 << 9), /* limit recovery to one reset */
Gabriele Mazzotta09c5b482015-04-25 19:52:37 +0200206 ATA_LFLAG_CHANGED = (1 << 10), /* LPM state changed on this link */
Danesh Petigarae39b2bb2016-01-07 16:03:33 -0800207 ATA_LFLAG_NO_DB_DELAY = (1 << 11), /* no debounce delay on link resume */
Tejun Heo0c887582007-08-06 18:36:23 +0900208
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209 /* struct ata_port flags */
Tejun Heo949b38a2006-04-02 18:51:52 +0900210 ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211 /* (doesn't imply presence) */
Tejun Heo949b38a2006-04-02 18:51:52 +0900212 ATA_FLAG_SATA = (1 << 1),
Andreas Wernerea013a92015-12-04 18:12:49 +0100213 ATA_FLAG_NO_LOG_PAGE = (1 << 5), /* do not issue log page read */
Tejun Heo949b38a2006-04-02 18:51:52 +0900214 ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */
215 ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */
216 ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */
Tejun Heo7395acb2006-05-31 18:27:25 +0900217 ATA_FLAG_PIO_POLLING = (1 << 9), /* use polling PIO if LLD
218 * doesn't handle PIO interrupts */
219 ATA_FLAG_NCQ = (1 << 10), /* host supports NCQ */
Rafael J. Wysocki2a6e58d2009-01-19 20:56:43 +0100220 ATA_FLAG_NO_POWEROFF_SPINDOWN = (1 << 11), /* don't spindown before poweroff */
221 ATA_FLAG_NO_HIBERNATE_SPINDOWN = (1 << 12), /* don't spindown before hibernation */
Tejun Heo7395acb2006-05-31 18:27:25 +0900222 ATA_FLAG_DEBUGMSG = (1 << 13),
Shaohua Li388539f2009-07-27 09:24:35 +0800223 ATA_FLAG_FPDMA_AA = (1 << 14), /* driver supports Auto-Activate */
Tejun Heob2a8bbe2007-01-25 19:40:05 +0900224 ATA_FLAG_IGN_SIMPLEX = (1 << 15), /* ignore SIMPLEX */
Alan Coxf834e492007-02-07 13:46:00 -0800225 ATA_FLAG_NO_IORDY = (1 << 16), /* controller lacks iordy */
Tejun Heo3cadbcc2007-05-15 03:28:15 +0900226 ATA_FLAG_ACPI_SATA = (1 << 17), /* need native SATA ACPI layout */
Kristen Carlson Accardi9f45cbd2007-08-15 03:57:11 -0400227 ATA_FLAG_AN = (1 << 18), /* controller supports AN */
Tejun Heoe0a71752007-09-23 13:14:12 +0900228 ATA_FLAG_PMP = (1 << 19), /* controller supports PMP */
Marc Carino40fb59e2013-08-24 23:22:49 -0700229 ATA_FLAG_FPDMA_AUX = (1 << 20), /* controller supports H2DFIS aux field */
Kristen Carlson Accardi18f7ba42008-06-03 10:33:55 -0700230 ATA_FLAG_EM = (1 << 21), /* driver supports enclosure
231 * management */
232 ATA_FLAG_SW_ACTIVITY = (1 << 22), /* driver supports sw activity
233 * led */
Tejun Heoae01b242011-03-16 11:14:55 +0100234 ATA_FLAG_NO_DIPM = (1 << 23), /* host not happy with DIPM */
Linus Torvaldsa1480a12015-04-13 16:42:16 -0700235 ATA_FLAG_SAS_HOST = (1 << 24), /* SAS host */
Jens Axboe9b847542006-01-06 09:28:07 +0100236
Tejun Heob51e9e52006-06-29 01:29:30 +0900237 /* bits 24:31 of ap->flags are reserved for LLD specific flags */
Alan Cox8d238e02006-01-17 20:50:31 +0000238
Alan Coxe3cf95d2009-04-09 17:31:17 +0100239
Tejun Heob51e9e52006-06-29 01:29:30 +0900240 /* struct ata_port pflags */
241 ATA_PFLAG_EH_PENDING = (1 << 0), /* EH pending */
242 ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */
243 ATA_PFLAG_FROZEN = (1 << 2), /* port is frozen */
244 ATA_PFLAG_RECOVERED = (1 << 3), /* recovery action performed */
245 ATA_PFLAG_LOADING = (1 << 4), /* boot/loading probe */
Tejun Heob51e9e52006-06-29 01:29:30 +0900246 ATA_PFLAG_SCSI_HOTPLUG = (1 << 6), /* SCSI hotplug scheduled */
Tejun Heof4d6d002007-05-01 11:50:15 +0200247 ATA_PFLAG_INITIALIZING = (1 << 7), /* being initialized, don't touch */
Tejun Heoafaa5c32007-10-09 15:06:10 +0900248 ATA_PFLAG_RESETTING = (1 << 8), /* reset in progress */
Tejun Heoece180d2008-11-03 20:04:37 +0900249 ATA_PFLAG_UNLOADING = (1 << 9), /* driver is being unloaded */
250 ATA_PFLAG_UNLOADED = (1 << 10), /* driver is unloaded */
Tejun Heob51e9e52006-06-29 01:29:30 +0900251
Tejun Heob51e9e52006-06-29 01:29:30 +0900252 ATA_PFLAG_SUSPENDED = (1 << 17), /* port is suspended (power) */
Tejun Heo500530f2006-07-03 16:07:27 +0900253 ATA_PFLAG_PM_PENDING = (1 << 18), /* PM operation pending */
Tejun Heoc05e6ff2007-12-15 15:05:02 +0900254 ATA_PFLAG_INIT_GTM_VALID = (1 << 19), /* initial gtm data valid */
Tejun Heodde44582006-02-02 00:56:10 +0900255
Alan Coxe3cf95d2009-04-09 17:31:17 +0100256 ATA_PFLAG_PIO32 = (1 << 20), /* 32bit PIO */
257 ATA_PFLAG_PIO32CHANGE = (1 << 21), /* 32bit PIO can be turned on/off */
Manuel Lauss8a3e33c2015-09-30 21:10:25 +0200258 ATA_PFLAG_EXTERNAL = (1 << 22), /* eSATA/external port */
Alan Coxe3cf95d2009-04-09 17:31:17 +0100259
Tejun Heo949b38a2006-04-02 18:51:52 +0900260 /* struct ata_queued_cmd flags */
261 ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */
Tejun Heo001102d2007-12-05 16:43:09 +0900262 ATA_QCFLAG_DMAMAP = (1 << 1), /* SG table is DMA mapped */
Tejun Heo27197362006-04-02 18:51:53 +0900263 ATA_QCFLAG_IO = (1 << 3), /* standard IO command */
Tejun Heoe61e0672006-05-15 20:57:40 +0900264 ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */
Tejun Heoda917d62007-09-23 13:14:12 +0900265 ATA_QCFLAG_CLEAR_EXCL = (1 << 5), /* clear excl_link on completion */
Tejun Heoe027bd32007-10-26 16:19:26 +0900266 ATA_QCFLAG_QUIET = (1 << 6), /* don't report device error */
Tejun Heo03faab72008-03-27 19:14:24 +0900267 ATA_QCFLAG_RETRY = (1 << 7), /* retry after failure */
Tejun Heoe61e0672006-05-15 20:57:40 +0900268
Tejun Heo9ec957f2006-05-15 20:57:58 +0900269 ATA_QCFLAG_FAILED = (1 << 16), /* cmd failed and is owned by EH */
270 ATA_QCFLAG_SENSE_VALID = (1 << 17), /* sense data valid */
271 ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272
Alan Cox4e5ec5d2006-03-27 18:42:40 +0100273 /* host set flags */
Jeff Garzikcca39742006-08-24 03:19:22 -0400274 ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host only */
Tejun Heoecef7252007-04-17 23:44:06 +0900275 ATA_HOST_STARTED = (1 << 1), /* Host started */
Arjan van de Ven886ad092009-01-09 15:54:07 -0800276 ATA_HOST_PARALLEL_SCAN = (1 << 2), /* Ports on this host can be scanned in parallel */
Andy Whitcroftdb63a4c2012-05-04 22:15:10 +0100277 ATA_HOST_IGNORE_ATA = (1 << 3), /* Ignore ATA devices on this host. */
Jeff Garzik9bec2e32006-08-31 00:02:15 -0400278
Tejun Heob8b275e2007-07-10 15:55:43 +0900279 /* bits 24:31 of host->flags are reserved for LLD specific flags */
280
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281 /* various lengths of time */
Tejun Heo341c2c92008-05-20 02:17:51 +0900282 ATA_TMOUT_BOOT = 30000, /* heuristic */
283 ATA_TMOUT_BOOT_QUICK = 7000, /* heuristic */
Tejun Heo341c2c92008-05-20 02:17:51 +0900284 ATA_TMOUT_INTERNAL_QUICK = 5000,
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200285 ATA_TMOUT_MAX_PARK = 30000,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286
Tejun Heob48d58f2010-04-09 19:46:38 +0900287 /*
288 * GoVault needs 2s and iVDR disk HHD424020F7SV00 800ms. 2s
289 * is too much without parallel probing. Use 2s if parallel
290 * probing is available, 800ms otherwise.
Tejun Heo88ff6ea2007-10-16 14:21:24 -0700291 */
Tejun Heob48d58f2010-04-09 19:46:38 +0900292 ATA_TMOUT_FF_WAIT_LONG = 2000,
293 ATA_TMOUT_FF_WAIT = 800,
Tejun Heo88ff6ea2007-10-16 14:21:24 -0700294
Tejun Heo705e76b2008-04-07 22:47:19 +0900295 /* Spec mandates to wait for ">= 2ms" before checking status
296 * after reset. We wait 150ms, because that was the magic
297 * delay used for ATAPI devices in Hale Landis's ATADRVR, for
298 * the period of time between when the ATA command register is
299 * written, and then status is checked. Because waiting for
300 * "a while" before checking status is fine, post SRST, we
301 * perform this magic delay here as well.
302 *
303 * Old drivers/ide uses the 2mS rule and then waits for ready.
304 */
Tejun Heo341c2c92008-05-20 02:17:51 +0900305 ATA_WAIT_AFTER_RESET = 150,
Tejun Heo705e76b2008-04-07 22:47:19 +0900306
Tejun Heo9dadd452008-04-07 22:47:19 +0900307 /* If PMP is supported, we have to do follow-up SRST. As some
308 * PMPs don't send D2H Reg FIS after hardreset, LLDs are
309 * advised to wait only for the following duration before
310 * doing SRST.
311 */
Stuart Hayese7d3ef12009-03-04 11:59:46 -0800312 ATA_TMOUT_PMP_SRST_WAIT = 5000,
Tejun Heo9dadd452008-04-07 22:47:19 +0900313
Gabriele Mazzotta09c5b482015-04-25 19:52:37 +0200314 /* When the LPM policy is set to ATA_LPM_MAX_POWER, there might
315 * be a spurious PHY event, so ignore the first PHY event that
316 * occurs within 10s after the policy change.
317 */
318 ATA_TMOUT_SPURIOUS_PHY = 10000,
319
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320 /* ATA bus states */
321 BUS_UNKNOWN = 0,
322 BUS_DMA = 1,
323 BUS_IDLE = 2,
324 BUS_NOINTR = 3,
325 BUS_NODATA = 4,
326 BUS_TIMER = 5,
327 BUS_PIO = 6,
328 BUS_EDD = 7,
329 BUS_IDENTIFY = 8,
330 BUS_PACKET = 9,
331
332 /* SATA port states */
333 PORT_UNKNOWN = 0,
334 PORT_ENABLED = 1,
335 PORT_DISABLED = 2,
336
337 /* encoding various smaller bitmaps into a single
Tejun Heo7dc951a2007-11-27 19:43:42 +0900338 * unsigned long bitmap
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339 */
Tejun Heo70cd0712007-11-27 19:43:40 +0900340 ATA_NR_PIO_MODES = 7,
341 ATA_NR_MWDMA_MODES = 5,
342 ATA_NR_UDMA_MODES = 8,
Tejun Heo1da7b0d2006-03-06 04:31:56 +0900343
344 ATA_SHIFT_PIO = 0,
Tejun Heo70cd0712007-11-27 19:43:40 +0900345 ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_NR_PIO_MODES,
346 ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_NR_MWDMA_MODES,
Adam Manzanares8e061782016-10-17 11:27:29 -0700347 ATA_SHIFT_PRIO = 6,
Tejun Heo1da7b0d2006-03-06 04:31:56 +0900348
Adam Manzanares8e061782016-10-17 11:27:29 -0700349 ATA_PRIO_HIGH = 2,
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400350 /* size of buffer to pad xfers ending on unaligned boundaries */
351 ATA_DMA_PAD_SZ = 4,
Tejun Heo949b38a2006-04-02 18:51:52 +0900352
Tejun Heo0c247c52006-05-15 20:58:19 +0900353 /* ering size */
354 ATA_ERING_SIZE = 32,
355
Tejun Heo31cc23b2007-09-23 13:14:12 +0900356 /* return values for ->qc_defer */
357 ATA_DEFER_LINK = 1,
358 ATA_DEFER_PORT = 2,
359
Tejun Heof3e81b12006-05-15 20:58:21 +0900360 /* desc_len for ata_eh_info and context */
361 ATA_EH_DESC_LEN = 80,
362
Tejun Heo9be1e972006-05-15 20:58:17 +0900363 /* reset / recovery action types */
364 ATA_EH_REVALIDATE = (1 << 0),
Tejun Heocf480622008-01-24 00:05:14 +0900365 ATA_EH_SOFTRESET = (1 << 1), /* meaningful only in ->prereset */
366 ATA_EH_HARDRESET = (1 << 2), /* meaningful only in ->prereset */
367 ATA_EH_RESET = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
Tejun Heof9df58c2007-09-23 13:14:13 +0900368 ATA_EH_ENABLE_LINK = (1 << 3),
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200369 ATA_EH_PARK = (1 << 5), /* unload heads and stop I/O */
Tejun Heo9be1e972006-05-15 20:58:17 +0900370
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200371 ATA_EH_PERDEV_MASK = ATA_EH_REVALIDATE | ATA_EH_PARK,
Tejun Heob5b3fa32008-07-31 17:02:42 +0900372 ATA_EH_ALL_ACTIONS = ATA_EH_REVALIDATE | ATA_EH_RESET |
Tejun Heo6b7ae952010-09-01 17:50:06 +0200373 ATA_EH_ENABLE_LINK,
Tejun Heo9be1e972006-05-15 20:58:17 +0900374
Tejun Heof3e81b12006-05-15 20:58:21 +0900375 /* ata_eh_info->flags */
Tejun Heoabdda732006-05-31 18:27:29 +0900376 ATA_EHI_HOTPLUGGED = (1 << 0), /* could have been hotplugged */
Tejun Heo1cdaf532006-07-03 16:07:26 +0900377 ATA_EHI_NO_AUTOPSY = (1 << 2), /* no autopsy */
378 ATA_EHI_QUIET = (1 << 3), /* be quiet */
Tejun Heoe2f3d752010-09-07 14:05:31 +0200379 ATA_EHI_NO_RECOVERY = (1 << 4), /* no recovery */
Tejun Heoabdda732006-05-31 18:27:29 +0900380
Tejun Heo0d64a232007-04-23 02:41:05 +0900381 ATA_EHI_DID_SOFTRESET = (1 << 16), /* already soft-reset this port */
382 ATA_EHI_DID_HARDRESET = (1 << 17), /* already soft-reset this port */
383 ATA_EHI_PRINTINFO = (1 << 18), /* print configuration info */
384 ATA_EHI_SETMODE = (1 << 19), /* configure transfer mode */
Andrea Gelmini89692c02010-10-16 15:19:18 +0200385 ATA_EHI_POST_SETMODE = (1 << 20), /* revalidating after setmode */
Tejun Heof3e81b12006-05-15 20:58:21 +0900386
Tejun Heo0d64a232007-04-23 02:41:05 +0900387 ATA_EHI_DID_RESET = ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
Tejun Heo13abf502006-07-10 23:18:46 +0900388
Tejun Heo848e4c62008-10-21 14:26:39 +0900389 /* mask of flags to transfer *to* the slave link */
390 ATA_EHI_TO_SLAVE_MASK = ATA_EHI_NO_AUTOPSY | ATA_EHI_QUIET,
391
Tejun Heoa1e10f72007-08-18 13:28:49 +0900392 /* max tries if error condition is still set after ->error_handler */
393 ATA_EH_MAX_TRIES = 5,
Tejun Heoad9e2762006-05-15 20:58:12 +0900394
Tejun Heo5040ab62010-01-11 11:14:44 +0900395 /* sometimes resuming a link requires several retries */
396 ATA_LINK_RESUME_TRIES = 5,
397
Tejun Heo14d2bac2006-04-02 17:54:46 +0900398 /* how hard are we gonna try to probe/recover devices */
399 ATA_PROBE_MAX_TRIES = 3,
Tejun Heo022bdb02006-05-15 20:58:22 +0900400 ATA_EH_DEV_TRIES = 3,
Tejun Heoe0a71752007-09-23 13:14:12 +0900401 ATA_EH_PMP_TRIES = 5,
402 ATA_EH_PMP_LINK_TRIES = 3,
403
Tejun Heobf1bff62008-05-19 01:15:10 +0900404 SATA_PMP_RW_TIMEOUT = 3000, /* PMP read/write timeout */
Tejun Heof5914a42006-05-31 18:27:48 +0900405
Tejun Heo87fbc5a2008-05-20 02:17:54 +0900406 /* This should match the actual table size of
407 * ata_eh_cmd_timeout_table in libata-eh.c.
408 */
Tejun Heo6013efd2009-11-19 15:36:45 +0900409 ATA_EH_CMD_TIMEOUT_TABLE_SIZE = 6,
Tejun Heo87fbc5a2008-05-20 02:17:54 +0900410
Alan Cox93590852006-09-12 16:55:12 +0100411 /* Horkage types. May be set by libata or controller on drives
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300412 (some horkage may be drive/controller pair dependent */
Alan Cox93590852006-09-12 16:55:12 +0100413
414 ATA_HORKAGE_DIAGNOSTIC = (1 << 0), /* Failed boot diag */
Alan Cox6919a0a2006-10-27 19:08:46 -0700415 ATA_HORKAGE_NODMA = (1 << 1), /* DMA problems */
416 ATA_HORKAGE_NONCQ = (1 << 2), /* Don't use NCQ */
Albert Lee18d6e9d2007-04-02 11:34:15 +0800417 ATA_HORKAGE_MAX_SEC_128 = (1 << 3), /* Limit max sects to 128 */
Tejun Heo16c55b02007-08-29 11:58:33 +0900418 ATA_HORKAGE_BROKEN_HPA = (1 << 4), /* Broken HPA */
Tejun Heo50af2fa2008-05-19 01:15:14 +0900419 ATA_HORKAGE_DISABLE = (1 << 5), /* Disable it */
Alan Cox93328e12007-09-29 04:06:48 -0400420 ATA_HORKAGE_HPA_SIZE = (1 << 6), /* native size off by one */
Alan Cox6bbfd532007-11-05 22:58:58 +0000421 ATA_HORKAGE_IVB = (1 << 8), /* cbl det validity bit bugs */
Albert Lee2d3b8ee2007-11-15 10:35:46 +0900422 ATA_HORKAGE_STUCK_ERR = (1 << 9), /* stuck ERR on next PACKET */
Jens Axboe9ce8e302008-08-27 15:23:18 +0200423 ATA_HORKAGE_BRIDGE_OK = (1 << 10), /* no bridge limits */
Tejun Heo6a87e422008-11-03 19:01:09 +0900424 ATA_HORKAGE_ATAPI_MOD16_DMA = (1 << 11), /* use ATAPI DMA for commands
425 not multiple of 16 bytes */
Nick Andrew877d0312009-01-26 11:06:57 +0100426 ATA_HORKAGE_FIRMWARE_WARN = (1 << 12), /* firmware update warning */
Tejun Heo90627122009-01-29 20:31:36 +0900427 ATA_HORKAGE_1_5_GBPS = (1 << 13), /* force 1.5 Gbps */
Tejun Heod0cb43b2009-07-09 09:27:50 +0900428 ATA_HORKAGE_NOSETXFER = (1 << 14), /* skip SETXFER, SATA only */
Shaohua Li388539f2009-07-27 09:24:35 +0800429 ATA_HORKAGE_BROKEN_FPDMA_AA = (1 << 15), /* skip AA */
Tejun Heo43c9c592010-05-23 12:59:11 +0200430 ATA_HORKAGE_DUMP_ID = (1 << 16), /* dump IDENTIFY data */
Shan Haia32450e2013-03-18 10:30:44 +0800431 ATA_HORKAGE_MAX_SEC_LBA48 = (1 << 17), /* Set max sects to 65535 */
Vincent Pelletier966fbe12013-05-21 22:30:58 +0200432 ATA_HORKAGE_ATAPI_DMADIR = (1 << 18), /* device requires dmadir */
Marc Carinof78dea02013-12-16 18:15:53 -0800433 ATA_HORKAGE_NO_NCQ_TRIM = (1 << 19), /* don't use queued TRIM */
Tejun Heoecd75ad2014-01-16 09:47:17 -0500434 ATA_HORKAGE_NOLPM = (1 << 20), /* don't use LPM */
435 ATA_HORKAGE_WD_BROKEN_LPM = (1 << 21), /* some WDs have broken LPM */
Martin K. Petersene61f7d12015-01-08 10:34:27 -0500436 ATA_HORKAGE_ZERO_AFTER_TRIM = (1 << 22),/* guarantees zero after trim */
Martin K. Petersen5d3abf82015-05-04 21:54:21 -0400437 ATA_HORKAGE_NO_NCQ_LOG = (1 << 23), /* don't use NCQ for log read */
Arne Fitzenreiter71d126f2015-07-15 13:54:36 +0200438 ATA_HORKAGE_NOTRIM = (1 << 24), /* don't use TRIM */
David Milburnaf34d632015-07-13 11:48:23 -0500439 ATA_HORKAGE_MAX_SEC_1024 = (1 << 25), /* Limit max sects to 1024 */
Alan Coxb3a70602007-10-02 12:38:26 -0400440
Jeff Garzik2dcb4072007-10-19 06:42:56 -0400441 /* DMA mask for user DMA control: User visible values; DO NOT
Alan Coxb3a70602007-10-02 12:38:26 -0400442 renumber */
443 ATA_DMA_MASK_ATA = (1 << 0), /* DMA on ATA Disk */
444 ATA_DMA_MASK_ATAPI = (1 << 1), /* DMA on ATAPI */
445 ATA_DMA_MASK_CFA = (1 << 2), /* DMA on CF Card */
Tejun Heoceb0c642007-12-05 16:43:06 +0900446
447 /* ATAPI command types */
448 ATAPI_READ = 0, /* READs */
449 ATAPI_WRITE = 1, /* WRITEs */
450 ATAPI_READ_CD = 2, /* READ CD [MSF] */
Tejun Heoe52dcc42008-04-02 17:35:19 +0900451 ATAPI_PASS_THRU = 3, /* SAT pass-thru */
452 ATAPI_MISC = 4, /* the rest */
Tejun Heo624d5c52008-03-25 22:16:41 +0900453
454 /* Timing constants */
455 ATA_TIMING_SETUP = (1 << 0),
456 ATA_TIMING_ACT8B = (1 << 1),
457 ATA_TIMING_REC8B = (1 << 2),
458 ATA_TIMING_CYC8B = (1 << 3),
459 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
460 ATA_TIMING_CYC8B,
461 ATA_TIMING_ACTIVE = (1 << 4),
462 ATA_TIMING_RECOVER = (1 << 5),
David Daney3ada9c12009-01-15 17:45:31 -0800463 ATA_TIMING_DMACK_HOLD = (1 << 6),
464 ATA_TIMING_CYCLE = (1 << 7),
465 ATA_TIMING_UDMA = (1 << 8),
Tejun Heo624d5c52008-03-25 22:16:41 +0900466 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
467 ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
468 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
David Daney3ada9c12009-01-15 17:45:31 -0800469 ATA_TIMING_DMACK_HOLD | ATA_TIMING_CYCLE |
470 ATA_TIMING_UDMA,
Tejun Heof1bce7f2009-09-16 04:16:04 +0900471
472 /* ACPI constants */
473 ATA_ACPI_FILTER_SETXFER = 1 << 0,
474 ATA_ACPI_FILTER_LOCK = 1 << 1,
475 ATA_ACPI_FILTER_DIPM = 1 << 2,
Tejun Heofa5b5612009-09-16 04:17:02 +0900476 ATA_ACPI_FILTER_FPDMA_OFFSET = 1 << 3, /* FPDMA non-zero offset */
477 ATA_ACPI_FILTER_FPDMA_AA = 1 << 4, /* FPDMA auto activate */
Tejun Heof1bce7f2009-09-16 04:16:04 +0900478
479 ATA_ACPI_FILTER_DEFAULT = ATA_ACPI_FILTER_SETXFER |
480 ATA_ACPI_FILTER_LOCK |
481 ATA_ACPI_FILTER_DIPM,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482};
483
Tejun Heo7dc951a2007-11-27 19:43:42 +0900484enum ata_xfer_mask {
485 ATA_MASK_PIO = ((1LU << ATA_NR_PIO_MODES) - 1)
486 << ATA_SHIFT_PIO,
487 ATA_MASK_MWDMA = ((1LU << ATA_NR_MWDMA_MODES) - 1)
488 << ATA_SHIFT_MWDMA,
489 ATA_MASK_UDMA = ((1LU << ATA_NR_UDMA_MODES) - 1)
490 << ATA_SHIFT_UDMA,
491};
492
Albert Lee14be71f2005-09-27 17:36:35 +0800493enum hsm_task_states {
Albert Leec56b14d22005-09-30 19:07:39 +0800494 HSM_ST_IDLE, /* no command on going */
Albert Lee71527642007-04-02 11:28:52 +0800495 HSM_ST_FIRST, /* (waiting the device to)
496 write CDB or first data block */
Albert Leec56b14d22005-09-30 19:07:39 +0800497 HSM_ST, /* (waiting the device to) transfer data */
498 HSM_ST_LAST, /* (waiting the device to) complete command */
Albert Leec56b14d22005-09-30 19:07:39 +0800499 HSM_ST_ERR, /* error */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500};
501
Jeff Garzika7dac442005-10-30 04:44:42 -0500502enum ata_completion_errors {
Tejun Heo11a56d22006-01-23 13:09:36 +0900503 AC_ERR_DEV = (1 << 0), /* device reported error */
504 AC_ERR_HSM = (1 << 1), /* host state machine violation */
505 AC_ERR_TIMEOUT = (1 << 2), /* timeout */
506 AC_ERR_MEDIA = (1 << 3), /* media error */
507 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
508 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
509 AC_ERR_SYSTEM = (1 << 6), /* system error */
510 AC_ERR_INVALID = (1 << 7), /* invalid argument */
511 AC_ERR_OTHER = (1 << 8), /* unknown */
Tejun Heo55a8e2c2006-11-10 18:08:10 +0900512 AC_ERR_NODEV_HINT = (1 << 9), /* polling device detection hint */
Tejun Heo5335b722007-07-16 14:29:40 +0900513 AC_ERR_NCQ = (1 << 10), /* marker for offending NCQ qc */
Jeff Garzika7dac442005-10-30 04:44:42 -0500514};
515
Tejun Heoc93b2632010-09-01 17:50:04 +0200516/*
517 * Link power management policy: If you alter this, you also need to
518 * alter libata-scsi.c (for the ascii descriptions)
519 */
520enum ata_lpm_policy {
521 ATA_LPM_UNKNOWN,
522 ATA_LPM_MAX_POWER,
523 ATA_LPM_MED_POWER,
524 ATA_LPM_MIN_POWER,
525};
526
Tejun Heo6b7ae952010-09-01 17:50:06 +0200527enum ata_lpm_hints {
528 ATA_LPM_EMPTY = (1 << 0), /* port empty/probing */
529 ATA_LPM_HIPM = (1 << 1), /* may use HIPM */
Danesh Petigarafb329632016-01-11 13:22:26 -0800530 ATA_LPM_WAKE_ONLY = (1 << 2), /* only wake up link */
Tejun Heo6b7ae952010-09-01 17:50:06 +0200531};
532
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533/* forward declarations */
534struct scsi_device;
535struct ata_port_operations;
536struct ata_port;
Tejun Heocc0680a2007-08-06 18:36:23 +0900537struct ata_link;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538struct ata_queued_cmd;
539
540/* typedefs */
Tejun Heo77853bf2006-01-23 13:09:36 +0900541typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
Tejun Heocc0680a2007-08-06 18:36:23 +0900542typedef int (*ata_prereset_fn_t)(struct ata_link *link, unsigned long deadline);
543typedef int (*ata_reset_fn_t)(struct ata_link *link, unsigned int *classes,
Tejun Heod4b2bab2007-02-02 16:50:52 +0900544 unsigned long deadline);
Tejun Heocc0680a2007-08-06 18:36:23 +0900545typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546
Tony Jonesee959b02008-02-22 00:13:36 +0100547extern struct device_attribute dev_attr_link_power_management_policy;
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200548extern struct device_attribute dev_attr_unload_heads;
Adam Manzanares84f95242016-10-17 11:27:30 -0700549extern struct device_attribute dev_attr_ncq_prio_enable;
Kristen Carlson Accardi18f7ba42008-06-03 10:33:55 -0700550extern struct device_attribute dev_attr_em_message_type;
551extern struct device_attribute dev_attr_em_message;
552extern struct device_attribute dev_attr_sw_activity;
553
554enum sw_activity {
555 OFF,
556 BLINK_ON,
557 BLINK_OFF,
558};
Kristen Carlson Accardica773292007-10-25 00:58:59 -0400559
Sergei Shtylyovdc34e7e2013-07-01 00:01:32 +0400560struct ata_taskfile {
561 unsigned long flags; /* ATA_TFLAG_xxx */
562 u8 protocol; /* ATA_PROT_xxx */
563
564 u8 ctl; /* control reg */
565
566 u8 hob_feature; /* additional data */
567 u8 hob_nsect; /* to support LBA48 */
568 u8 hob_lbal;
569 u8 hob_lbam;
570 u8 hob_lbah;
571
572 u8 feature;
573 u8 nsect;
574 u8 lbal;
575 u8 lbam;
576 u8 lbah;
577
578 u8 device;
579
580 u8 command; /* IO operation */
Marc Carino8be5ad92013-08-24 23:22:48 -0700581
582 u32 auxiliary; /* auxiliary field */
583 /* from SATA 3.1 and */
584 /* ATA-8 ACS-3 */
Sergei Shtylyovdc34e7e2013-07-01 00:01:32 +0400585};
586
Tejun Heo127102a2008-04-07 22:47:21 +0900587#ifdef CONFIG_ATA_SFF
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588struct ata_ioports {
Tejun Heo0d5ff562007-02-01 15:06:36 +0900589 void __iomem *cmd_addr;
590 void __iomem *data_addr;
591 void __iomem *error_addr;
592 void __iomem *feature_addr;
593 void __iomem *nsect_addr;
594 void __iomem *lbal_addr;
595 void __iomem *lbam_addr;
596 void __iomem *lbah_addr;
597 void __iomem *device_addr;
598 void __iomem *status_addr;
599 void __iomem *command_addr;
600 void __iomem *altstatus_addr;
601 void __iomem *ctl_addr;
Tejun Heo9a7780c2010-05-19 22:10:24 +0200602#ifdef CONFIG_ATA_BMDMA
Tejun Heo0d5ff562007-02-01 15:06:36 +0900603 void __iomem *bmdma_addr;
Tejun Heo9a7780c2010-05-19 22:10:24 +0200604#endif /* CONFIG_ATA_BMDMA */
Tejun Heo0d5ff562007-02-01 15:06:36 +0900605 void __iomem *scr_addr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606};
Tejun Heo127102a2008-04-07 22:47:21 +0900607#endif /* CONFIG_ATA_SFF */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608
Jeff Garzikcca39742006-08-24 03:19:22 -0400609struct ata_host {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610 spinlock_t lock;
611 struct device *dev;
Tejun Heo0d5ff562007-02-01 15:06:36 +0900612 void __iomem * const *iomap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613 unsigned int n_ports;
Tejun Heo1a112d12014-07-23 09:05:27 -0400614 unsigned int n_tags; /* nr of NCQ tags */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615 void *private_data;
Tejun Heo029cfd62008-03-25 12:22:49 +0900616 struct ata_port_operations *ops;
Alan Cox5444a6f2006-03-27 18:58:20 +0100617 unsigned long flags;
Tejun Heoc0c362b2010-09-06 17:57:14 +0200618
619 struct mutex eh_mutex;
620 struct task_struct *eh_owner;
621
Alan032af1c2007-03-01 17:36:46 +0000622 struct ata_port *simplex_claimed; /* channel owning the DMA */
Tejun Heof0eb62b2006-06-12 23:05:38 +0900623 struct ata_port *ports[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624};
625
626struct ata_queued_cmd {
627 struct ata_port *ap;
628 struct ata_device *dev;
629
630 struct scsi_cmnd *scsicmd;
631 void (*scsidone)(struct scsi_cmnd *);
632
633 struct ata_taskfile tf;
634 u8 cdb[ATAPI_CDB_LEN];
635
636 unsigned long flags; /* ATA_QCFLAG_xxx */
637 unsigned int tag;
638 unsigned int n_elem;
FUJITA Tomonori58256272009-02-27 17:35:43 +0900639 unsigned int orig_n_elem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640
641 int dma_dir;
642
Mark Lord5a5dbd12007-03-16 10:22:26 -0400643 unsigned int sect_size;
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400644
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645 unsigned int nbytes;
Tejun Heoaacda372008-03-18 17:47:43 +0900646 unsigned int extrabytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647 unsigned int curbytes;
648
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649 struct scatterlist sgent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650
Tejun Heoff2aeb12007-12-05 16:43:11 +0900651 struct scatterlist *sg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652
Richard Kennedyb34e9042010-09-10 12:19:43 +0100653 struct scatterlist *cursg;
654 unsigned int cursg_ofs;
655
Albert Leea22e2eb2005-12-05 15:38:02 +0800656 unsigned int err_mask;
Tejun Heoe61e0672006-05-15 20:57:40 +0900657 struct ata_taskfile result_tf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658 ata_qc_cb_t complete_fn;
659
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660 void *private_data;
Darrick J. Wong1c50dc82007-01-30 01:18:41 -0800661 void *lldd_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662};
663
Jeff Garzikcca39742006-08-24 03:19:22 -0400664struct ata_port_stats {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665 unsigned long unhandled_irq;
666 unsigned long idle_irq;
667 unsigned long rw_reqbuf;
668};
669
Tejun Heo0c247c52006-05-15 20:58:19 +0900670struct ata_ering_entry {
Tejun Heo3884f7b2007-11-27 19:28:56 +0900671 unsigned int eflags;
Tejun Heo0c247c52006-05-15 20:58:19 +0900672 unsigned int err_mask;
673 u64 timestamp;
674};
675
676struct ata_ering {
677 int cursor;
678 struct ata_ering_entry ring[ATA_ERING_SIZE];
679};
680
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681struct ata_device {
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900682 struct ata_link *link;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683 unsigned int devno; /* 0 or 1 */
Tejun Heo75683fe2007-07-05 13:31:27 +0900684 unsigned int horkage; /* List of broken features */
Richard Kennedy6866e7b2008-09-22 14:47:13 -0700685 unsigned long flags; /* ATA_DFLAG_xxx */
Tejun Heo3edebac2006-05-31 18:27:40 +0900686 struct scsi_device *sdev; /* attached SCSI device */
Bartlomiej Zolnierkiewicz95514fd2009-11-25 18:12:48 +0100687 void *private_data;
Tejun Heofafbae82007-05-15 03:28:16 +0900688#ifdef CONFIG_ATA_ACPI
Tejun Heo398e0782007-12-15 15:05:03 +0900689 union acpi_object *gtf_cache;
Tejun Heo110f66d2009-09-16 04:17:28 +0900690 unsigned int gtf_filter;
Tejun Heofafbae82007-05-15 03:28:16 +0900691#endif
Aaron Luafe75952013-01-15 17:20:58 +0800692#ifdef CONFIG_SATA_ZPODD
693 void *zpodd;
694#endif
Gwendal Grignoud9027472010-05-25 12:31:38 -0700695 struct device tdev;
Tejun Heo99cf6102009-01-29 20:31:32 +0900696 /* n_sector is CLEAR_BEGIN, read comment above CLEAR_BEGIN */
Tejun Heo72fa4b72006-05-31 18:27:32 +0900697 u64 n_sectors; /* size of device, if ATA */
Tejun Heo5920dad2009-07-15 17:11:41 +0900698 u64 n_native_sectors; /* native size, if ATA */
Tejun Heo72fa4b72006-05-31 18:27:32 +0900699 unsigned int class; /* ATA_DEV_xxx */
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200700 unsigned long unpark_deadline;
Tejun Heoe0a71752007-09-23 13:14:12 +0900701
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702 u8 pio_mode;
703 u8 dma_mode;
704 u8 xfer_mode;
705 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
706
Albert Lee8cbd6df2005-10-12 15:06:27 +0800707 unsigned int multi_count; /* sectors count for
708 READ/WRITE MULTIPLE */
Tejun Heob00eec12006-02-12 23:32:59 +0900709 unsigned int max_sectors; /* per-device max sectors */
Tejun Heo6e7846e2006-02-12 23:32:58 +0900710 unsigned int cdb_len;
Albert Lee8bf62ece2005-05-12 15:29:42 -0400711
Tejun Heoacf356b2006-03-24 14:07:50 +0900712 /* per-dev xfer mask */
Tejun Heo7dc951a2007-11-27 19:43:42 +0900713 unsigned long pio_mask;
714 unsigned long mwdma_mask;
715 unsigned long udma_mask;
Tejun Heoacf356b2006-03-24 14:07:50 +0900716
Albert Lee8bf62ece2005-05-12 15:29:42 -0400717 /* for CHS addressing */
718 u16 cylinders; /* Number of cylinders */
719 u16 heads; /* Number of heads */
720 u16 sectors; /* Number of sectors per track */
Tejun Heo0c247c52006-05-15 20:58:19 +0900721
Jeff Garzikf7e98932008-04-29 17:47:34 -0400722 union {
723 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
724 u32 gscr[SATA_PMP_GSCR_DWORDS]; /* PMP GSCR block */
Harvey Hunt4ee34ea2016-02-24 15:16:43 +0000725 } ____cacheline_aligned;
Tejun Heo99cf6102009-01-29 20:31:32 +0900726
Shane Huang803739d2012-12-17 23:18:59 +0800727 /* DEVSLP Timing Variables from Identify Device Data Log */
728 u8 devslp_timing[ATA_LOG_DEVSLP_SIZE];
Shane Huang65fe1f02012-09-07 22:40:01 +0800729
Marc Carinoed369112013-08-24 23:22:50 -0700730 /* NCQ send and receive log subcommand support */
731 u8 ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_SIZE];
Hannes Reinecke284b3b72016-04-25 12:45:54 +0200732 u8 ncq_non_data_cmds[ATA_LOG_NCQ_NON_DATA_SIZE];
Marc Carinoed369112013-08-24 23:22:50 -0700733
Hannes Reinecke6d1003a2016-04-25 12:45:56 +0200734 /* ZAC zone configuration */
735 u32 zac_zoned_cap;
736 u32 zac_zones_optimal_open;
737 u32 zac_zones_optimal_nonseq;
738 u32 zac_zones_max_open;
739
Tejun Heo99cf6102009-01-29 20:31:32 +0900740 /* error history */
741 int spdn_cnt;
742 /* ering is CLEAR_END, read comment above CLEAR_END */
743 struct ata_ering ering;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744};
745
Tejun Heo99cf6102009-01-29 20:31:32 +0900746/* Fields between ATA_DEVICE_CLEAR_BEGIN and ATA_DEVICE_CLEAR_END are
747 * cleared to zero on ata_dev_init().
Tejun Heo72fa4b72006-05-31 18:27:32 +0900748 */
Tejun Heo99cf6102009-01-29 20:31:32 +0900749#define ATA_DEVICE_CLEAR_BEGIN offsetof(struct ata_device, n_sectors)
750#define ATA_DEVICE_CLEAR_END offsetof(struct ata_device, ering)
Tejun Heo72fa4b72006-05-31 18:27:32 +0900751
Tejun Heof3e81b12006-05-15 20:58:21 +0900752struct ata_eh_info {
753 struct ata_device *dev; /* offending device */
754 u32 serror; /* SError from LLDD */
755 unsigned int err_mask; /* port-wide err_mask */
756 unsigned int action; /* ATA_EH_* action mask */
Tejun Heo47005f22006-06-19 18:27:23 +0900757 unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */
Tejun Heof3e81b12006-05-15 20:58:21 +0900758 unsigned int flags; /* ATA_EHI_* flags */
Tejun Heoabdda732006-05-31 18:27:29 +0900759
Tejun Heoabdda732006-05-31 18:27:29 +0900760 unsigned int probe_mask;
761
Tejun Heof3e81b12006-05-15 20:58:21 +0900762 char desc[ATA_EH_DESC_LEN];
763 int desc_len;
764};
765
766struct ata_eh_context {
767 struct ata_eh_info i;
768 int tries[ATA_MAX_DEVICES];
Tejun Heo87fbc5a2008-05-20 02:17:54 +0900769 int cmd_timeout_idx[ATA_MAX_DEVICES]
770 [ATA_EH_CMD_TIMEOUT_TABLE_SIZE];
Tejun Heoabdda732006-05-31 18:27:29 +0900771 unsigned int classes[ATA_MAX_DEVICES];
772 unsigned int did_probe_mask;
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200773 unsigned int unloaded_mask;
Tejun Heo00115e02007-11-27 19:28:58 +0900774 unsigned int saved_ncq_enabled;
775 u8 saved_xfer_mode[ATA_MAX_DEVICES];
Tejun Heo0a2c0f52008-05-20 02:17:52 +0900776 /* timestamp for the last reset attempt or success */
777 unsigned long last_reset;
Tejun Heof3e81b12006-05-15 20:58:21 +0900778};
779
Tejun Heo64578a32007-05-15 03:28:16 +0900780struct ata_acpi_drive
781{
782 u32 pio;
783 u32 dma;
784} __packed;
785
786struct ata_acpi_gtm {
787 struct ata_acpi_drive drive[2];
788 u32 flags;
789} __packed;
790
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900791struct ata_link {
792 struct ata_port *ap;
Tejun Heo89898052007-08-06 18:36:23 +0900793 int pmp; /* port multiplier port # */
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900794
Gwendal Grignoud9027472010-05-25 12:31:38 -0700795 struct device tdev;
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900796 unsigned int active_tag; /* active tag on this link */
797 u32 sactive; /* active NCQ commands */
798
Tejun Heo0c887582007-08-06 18:36:23 +0900799 unsigned int flags; /* ATA_LFLAG_xxx */
800
Tejun Heod127ea72008-07-31 16:09:34 +0900801 u32 saved_scontrol; /* SControl on probe */
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900802 unsigned int hw_sata_spd_limit;
803 unsigned int sata_spd_limit;
804 unsigned int sata_spd; /* current SATA PHY speed */
Tejun Heo6b7ae952010-09-01 17:50:06 +0200805 enum ata_lpm_policy lpm_policy;
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900806
807 /* record runtime error info, protected by host_set lock */
808 struct ata_eh_info eh_info;
809 /* EH context */
810 struct ata_eh_context eh_context;
811
812 struct ata_device device[ATA_MAX_DEVICES];
Gabriele Mazzotta09c5b482015-04-25 19:52:37 +0200813
814 unsigned long last_lpm_change; /* when last LPM change happened */
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900815};
Gwendal Grignoud9027472010-05-25 12:31:38 -0700816#define ATA_LINK_CLEAR_BEGIN offsetof(struct ata_link, active_tag)
817#define ATA_LINK_CLEAR_END offsetof(struct ata_link, device[0])
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900818
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819struct ata_port {
Jeff Garzikcca39742006-08-24 03:19:22 -0400820 struct Scsi_Host *scsi_host; /* our co-allocated scsi host */
Tejun Heo029cfd62008-03-25 12:22:49 +0900821 struct ata_port_operations *ops;
Jeff Garzikba6a1302006-06-22 23:46:10 -0400822 spinlock_t *lock;
Alan Coxe3cf95d2009-04-09 17:31:17 +0100823 /* Flags owned by the EH context. Only EH should touch these once the
824 port is active */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825 unsigned long flags; /* ATA_FLAG_xxx */
Alan Coxe3cf95d2009-04-09 17:31:17 +0100826 /* Flags that change dynamically, protected by ap->lock */
Tejun Heob51e9e52006-06-29 01:29:30 +0900827 unsigned int pflags; /* ATA_PFLAG_xxx */
Tejun Heo44877b42007-02-21 01:06:51 +0900828 unsigned int print_id; /* user visible unique port ID */
David Milburne628dc92013-05-14 13:48:40 -0500829 unsigned int local_port_no; /* host local port num */
Tejun Heo44877b42007-02-21 01:06:51 +0900830 unsigned int port_no; /* 0 based port no. inside the host */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831
Tejun Heo127102a2008-04-07 22:47:21 +0900832#ifdef CONFIG_ATA_SFF
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834 u8 ctl; /* cache of ATA control register */
835 u8 last_ctl; /* Cache last written value */
Gwendal Grignouea3c6452010-08-31 16:20:36 -0700836 struct ata_link* sff_pio_task_link; /* link currently used */
Tejun Heoc4291372010-05-10 21:41:38 +0200837 struct delayed_work sff_pio_task;
Tejun Heo9a7780c2010-05-19 22:10:24 +0200838#ifdef CONFIG_ATA_BMDMA
Tejun Heof60d7012010-05-10 21:41:41 +0200839 struct ata_bmdma_prd *bmdma_prd; /* BMDMA SG list */
840 dma_addr_t bmdma_prd_dma; /* and its DMA mapping */
Tejun Heo9a7780c2010-05-19 22:10:24 +0200841#endif /* CONFIG_ATA_BMDMA */
Tejun Heo5fe74542010-05-10 21:41:37 +0200842#endif /* CONFIG_ATA_SFF */
843
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844 unsigned int pio_mask;
845 unsigned int mwdma_mask;
846 unsigned int udma_mask;
847 unsigned int cbl; /* cable type; ATA_CBL_xxx */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848
849 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
Shaohua Li12cb5ce2015-01-15 17:32:27 -0800850 unsigned long sas_tag_allocated; /* for sas tag allocation only */
Tejun Heodedaf2b2006-05-15 21:03:43 +0900851 unsigned int qc_active;
Tejun Heoda917d62007-09-23 13:14:12 +0900852 int nr_active_links; /* #links with active qcs */
Shaohua Li12cb5ce2015-01-15 17:32:27 -0800853 unsigned int sas_last_tag; /* track next tag hw expects */
Tejun Heodedaf2b2006-05-15 21:03:43 +0900854
Tejun Heob1c72912008-07-31 17:02:43 +0900855 struct ata_link link; /* host default link */
856 struct ata_link *slave_link; /* see ata_slave_link_init() */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857
Tejun Heo89898052007-08-06 18:36:23 +0900858 int nr_pmp_links; /* nr of available PMP links */
859 struct ata_link *pmp_link; /* array of PMP links */
Tejun Heoda917d62007-09-23 13:14:12 +0900860 struct ata_link *excl_link; /* for PMP qc exclusion */
Tejun Heo89898052007-08-06 18:36:23 +0900861
Jeff Garzikcca39742006-08-24 03:19:22 -0400862 struct ata_port_stats stats;
863 struct ata_host *host;
Brian King2f1f6102006-03-23 17:30:15 -0600864 struct device *dev;
Gwendal Grignoud9027472010-05-25 12:31:38 -0700865 struct device tdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866
Tejun Heoad72cf92010-07-02 10:03:52 +0200867 struct mutex scsi_scan_mutex;
David Howells52bad642006-11-22 14:54:01 +0000868 struct delayed_work hotplug_task;
Jeff Garzik3b01b8a2006-06-12 00:22:04 -0400869 struct work_struct scsi_rescan_task;
Tejun Heo86e45b62006-03-05 15:29:09 +0900870
Albert Lee14be71f2005-09-27 17:36:35 +0800871 unsigned int hsm_task_state;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872
Randy Dunlapbfd60572006-01-17 19:34:42 -0500873 u32 msg_enable;
Tejun Heoa72ec4c2006-01-23 13:09:37 +0900874 struct list_head eh_done_q;
Tejun Heoc6cf9e92006-05-31 18:27:27 +0900875 wait_queue_head_t eh_wait_q;
Tejun Heoa1e10f72007-08-18 13:28:49 +0900876 int eh_tries;
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200877 struct completion park_req_pending;
Randy Dunlapbfd60572006-01-17 19:34:42 -0500878
Tejun Heo500530f2006-07-03 16:07:27 +0900879 pm_message_t pm_mesg;
Tejun Heo6b7ae952010-09-01 17:50:06 +0200880 enum ata_lpm_policy target_lpm_policy;
Tejun Heo500530f2006-07-03 16:07:27 +0900881
Tejun Heo5ddf24c2007-07-16 14:29:41 +0900882 struct timer_list fastdrain_timer;
883 unsigned long fastdrain_cnt;
884
Kristen Carlson Accardi18f7ba42008-06-03 10:33:55 -0700885 int em_message_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886 void *private_data;
Tejun Heofe635c72006-05-15 20:57:35 +0900887
Tejun Heofafbae82007-05-15 03:28:16 +0900888#ifdef CONFIG_ATA_ACPI
Tejun Heoc05e6ff2007-12-15 15:05:02 +0900889 struct ata_acpi_gtm __acpi_init_gtm; /* use ata_acpi_init_gtm() */
Tejun Heofafbae82007-05-15 03:28:16 +0900890#endif
Tejun Heo84bda122009-03-02 18:53:26 +0900891 /* owned by EH */
892 u8 sector_buf[ATA_SECT_SIZE] ____cacheline_aligned;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893};
894
Tejun Heo029cfd62008-03-25 12:22:49 +0900895/* The following initializer overrides a method to NULL whether one of
896 * its parent has the method defined or not. This is equivalent to
897 * ERR_PTR(-ENOENT). Unfortunately, ERR_PTR doesn't render a constant
898 * expression and thus can't be used as an initializer.
899 */
900#define ATA_OP_NULL (void *)(unsigned long)(-ENOENT)
901
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902struct ata_port_operations {
Tejun Heoc1bc8992008-03-25 12:22:47 +0900903 /*
904 * Command execution
905 */
906 int (*qc_defer)(struct ata_queued_cmd *qc);
907 int (*check_atapi_dma)(struct ata_queued_cmd *qc);
908 void (*qc_prep)(struct ata_queued_cmd *qc);
909 unsigned int (*qc_issue)(struct ata_queued_cmd *qc);
Tejun Heo22183bf2008-04-07 22:47:20 +0900910 bool (*qc_fill_rtf)(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911
Tejun Heoc1bc8992008-03-25 12:22:47 +0900912 /*
913 * Configuration and exception handling
914 */
915 int (*cable_detect)(struct ata_port *ap);
916 unsigned long (*mode_filter)(struct ata_device *dev, unsigned long xfer_mask);
917 void (*set_piomode)(struct ata_port *ap, struct ata_device *dev);
918 void (*set_dmamode)(struct ata_port *ap, struct ata_device *dev);
919 int (*set_mode)(struct ata_link *link, struct ata_device **r_failed_dev);
Alan Cox963e4972008-07-24 17:16:06 +0100920 unsigned int (*read_id)(struct ata_device *dev, struct ata_taskfile *tf, u16 *id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921
Tejun Heoc1bc8992008-03-25 12:22:47 +0900922 void (*dev_config)(struct ata_device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700923
Tejun Heoc1bc8992008-03-25 12:22:47 +0900924 void (*freeze)(struct ata_port *ap);
925 void (*thaw)(struct ata_port *ap);
Tejun Heoa1efdab2008-03-25 12:22:50 +0900926 ata_prereset_fn_t prereset;
927 ata_reset_fn_t softreset;
928 ata_reset_fn_t hardreset;
929 ata_postreset_fn_t postreset;
930 ata_prereset_fn_t pmp_prereset;
931 ata_reset_fn_t pmp_softreset;
932 ata_reset_fn_t pmp_hardreset;
933 ata_postreset_fn_t pmp_postreset;
Tejun Heoc1bc8992008-03-25 12:22:47 +0900934 void (*error_handler)(struct ata_port *ap);
Alan Coxc96f1732009-03-24 10:23:46 +0000935 void (*lost_interrupt)(struct ata_port *ap);
Tejun Heoc1bc8992008-03-25 12:22:47 +0900936 void (*post_internal_cmd)(struct ata_queued_cmd *qc);
Dan Williamse4a9c372012-06-21 23:25:27 -0700937 void (*sched_eh)(struct ata_port *ap);
938 void (*end_eh)(struct ata_port *ap);
Tejun Heoc1bc8992008-03-25 12:22:47 +0900939
940 /*
941 * Optional features
942 */
Tejun Heo82ef04f2008-07-31 17:02:40 +0900943 int (*scr_read)(struct ata_link *link, unsigned int sc_reg, u32 *val);
944 int (*scr_write)(struct ata_link *link, unsigned int sc_reg, u32 val);
Tejun Heoc1bc8992008-03-25 12:22:47 +0900945 void (*pmp_attach)(struct ata_port *ap);
946 void (*pmp_detach)(struct ata_port *ap);
Tejun Heo6b7ae952010-09-01 17:50:06 +0200947 int (*set_lpm)(struct ata_link *link, enum ata_lpm_policy policy,
948 unsigned hints);
Tejun Heoc1bc8992008-03-25 12:22:47 +0900949
950 /*
951 * Start, stop, suspend and resume
952 */
953 int (*port_suspend)(struct ata_port *ap, pm_message_t mesg);
954 int (*port_resume)(struct ata_port *ap);
955 int (*port_start)(struct ata_port *ap);
956 void (*port_stop)(struct ata_port *ap);
957 void (*host_stop)(struct ata_host *host);
958
Tejun Heo127102a2008-04-07 22:47:21 +0900959#ifdef CONFIG_ATA_SFF
Tejun Heoc1bc8992008-03-25 12:22:47 +0900960 /*
961 * SFF / taskfile oriented ops
962 */
Tejun Heo5682ed32008-04-07 22:47:16 +0900963 void (*sff_dev_select)(struct ata_port *ap, unsigned int device);
Sergei Shtylyov41dec292010-05-07 22:47:50 +0400964 void (*sff_set_devctl)(struct ata_port *ap, u8 ctl);
Tejun Heo5682ed32008-04-07 22:47:16 +0900965 u8 (*sff_check_status)(struct ata_port *ap);
966 u8 (*sff_check_altstatus)(struct ata_port *ap);
967 void (*sff_tf_load)(struct ata_port *ap, const struct ata_taskfile *tf);
968 void (*sff_tf_read)(struct ata_port *ap, struct ata_taskfile *tf);
969 void (*sff_exec_command)(struct ata_port *ap,
970 const struct ata_taskfile *tf);
971 unsigned int (*sff_data_xfer)(struct ata_device *dev,
972 unsigned char *buf, unsigned int buflen, int rw);
Sergei Shtylyove42a5422010-05-07 22:49:02 +0400973 void (*sff_irq_on)(struct ata_port *);
Tejun Heo27943622010-01-19 10:49:19 +0900974 bool (*sff_irq_check)(struct ata_port *);
Tejun Heo5682ed32008-04-07 22:47:16 +0900975 void (*sff_irq_clear)(struct ata_port *);
Tejun Heo8244cd02010-05-10 21:41:36 +0200976 void (*sff_drain_fifo)(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977
Tejun Heo9a7780c2010-05-19 22:10:24 +0200978#ifdef CONFIG_ATA_BMDMA
Tejun Heoc1bc8992008-03-25 12:22:47 +0900979 void (*bmdma_setup)(struct ata_queued_cmd *qc);
980 void (*bmdma_start)(struct ata_queued_cmd *qc);
981 void (*bmdma_stop)(struct ata_queued_cmd *qc);
982 u8 (*bmdma_status)(struct ata_port *ap);
Tejun Heo9a7780c2010-05-19 22:10:24 +0200983#endif /* CONFIG_ATA_BMDMA */
Tejun Heo127102a2008-04-07 22:47:21 +0900984#endif /* CONFIG_ATA_SFF */
Tejun Heoc19ba8a2006-01-24 17:05:22 +0900985
Kristen Carlson Accardi18f7ba42008-06-03 10:33:55 -0700986 ssize_t (*em_show)(struct ata_port *ap, char *buf);
987 ssize_t (*em_store)(struct ata_port *ap, const char *message,
988 size_t size);
989 ssize_t (*sw_activity_show)(struct ata_device *dev, char *buf);
990 ssize_t (*sw_activity_store)(struct ata_device *dev,
991 enum sw_activity val);
Mark Langsdorf439d7a32013-05-30 15:17:30 -0500992 ssize_t (*transmit_led_message)(struct ata_port *ap, u32 state,
993 ssize_t size);
994
Tejun Heoc1bc8992008-03-25 12:22:47 +0900995 /*
996 * Obsolete
Tejun Heo9ec957f2006-05-15 20:57:58 +0900997 */
Tejun Heoc1bc8992008-03-25 12:22:47 +0900998 void (*phy_reset)(struct ata_port *ap);
999 void (*eng_timeout)(struct ata_port *ap);
Tejun Heo029cfd62008-03-25 12:22:49 +09001000
1001 /*
1002 * ->inherits must be the last field and all the preceding
1003 * fields must be pointers.
1004 */
1005 const struct ata_port_operations *inherits;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006};
1007
1008struct ata_port_info {
Jeff Garzikcca39742006-08-24 03:19:22 -04001009 unsigned long flags;
Tejun Heo0c887582007-08-06 18:36:23 +09001010 unsigned long link_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011 unsigned long pio_mask;
1012 unsigned long mwdma_mask;
1013 unsigned long udma_mask;
Tejun Heo029cfd62008-03-25 12:22:49 +09001014 struct ata_port_operations *port_ops;
Alan Coxe99f8b52005-11-08 14:09:44 +00001015 void *private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016};
1017
Alan Cox452503f2005-10-21 19:01:32 -04001018struct ata_timing {
1019 unsigned short mode; /* ATA mode */
1020 unsigned short setup; /* t1 */
1021 unsigned short act8b; /* t2 for 8-bit I/O */
1022 unsigned short rec8b; /* t2i for 8-bit I/O */
1023 unsigned short cyc8b; /* t0 for 8-bit I/O */
1024 unsigned short active; /* t2 or tD */
1025 unsigned short recover; /* t2i or tK */
David Daney3ada9c12009-01-15 17:45:31 -08001026 unsigned short dmack_hold; /* tj */
Alan Cox452503f2005-10-21 19:01:32 -04001027 unsigned short cycle; /* t0 */
1028 unsigned short udma; /* t2CYCTYP/2 */
1029};
1030
Tejun Heo624d5c52008-03-25 22:16:41 +09001031/*
1032 * Core layer - drivers/ata/libata-core.c
1033 */
Tejun Heoe9c83912006-07-03 16:07:26 +09001034extern const unsigned long sata_deb_timing_normal[];
1035extern const unsigned long sata_deb_timing_hotplug[];
1036extern const unsigned long sata_deb_timing_long[];
1037
Tejun Heo029cfd62008-03-25 12:22:49 +09001038extern struct ata_port_operations ata_dummy_port_ops;
Tejun Heo21b0ad42007-04-17 23:44:07 +09001039extern const struct ata_port_info ata_dummy_port_info;
Tejun Heodd5b06c2006-08-10 16:59:12 +09001040
Christoph Hellwigb1c04e82016-07-14 09:05:42 +09001041static inline bool ata_is_atapi(u8 prot)
Sergei Shtylyovdc34e7e2013-07-01 00:01:32 +04001042{
Christoph Hellwig37f92d72016-07-16 22:16:43 +09001043 return prot & ATA_PROT_FLAG_ATAPI;
Sergei Shtylyovdc34e7e2013-07-01 00:01:32 +04001044}
1045
Christoph Hellwigb1c04e82016-07-14 09:05:42 +09001046static inline bool ata_is_pio(u8 prot)
Sergei Shtylyovdc34e7e2013-07-01 00:01:32 +04001047{
Christoph Hellwig37f92d72016-07-16 22:16:43 +09001048 return prot & ATA_PROT_FLAG_PIO;
Sergei Shtylyovdc34e7e2013-07-01 00:01:32 +04001049}
1050
Christoph Hellwigb1c04e82016-07-14 09:05:42 +09001051static inline bool ata_is_dma(u8 prot)
Sergei Shtylyovdc34e7e2013-07-01 00:01:32 +04001052{
Christoph Hellwig37f92d72016-07-16 22:16:43 +09001053 return prot & ATA_PROT_FLAG_DMA;
Sergei Shtylyovdc34e7e2013-07-01 00:01:32 +04001054}
1055
Christoph Hellwigb1c04e82016-07-14 09:05:42 +09001056static inline bool ata_is_ncq(u8 prot)
Sergei Shtylyovdc34e7e2013-07-01 00:01:32 +04001057{
Christoph Hellwig37f92d72016-07-16 22:16:43 +09001058 return prot & ATA_PROT_FLAG_NCQ;
Sergei Shtylyovdc34e7e2013-07-01 00:01:32 +04001059}
1060
Christoph Hellwigb1c04e82016-07-14 09:05:42 +09001061static inline bool ata_is_data(u8 prot)
Sergei Shtylyovdc34e7e2013-07-01 00:01:32 +04001062{
Christoph Hellwig37f92d72016-07-16 22:16:43 +09001063 return prot & (ATA_PROT_FLAG_PIO | ATA_PROT_FLAG_DMA);
Sergei Shtylyovdc34e7e2013-07-01 00:01:32 +04001064}
1065
1066static inline int is_multi_taskfile(struct ata_taskfile *tf)
1067{
1068 return (tf->command == ATA_CMD_READ_MULTI) ||
1069 (tf->command == ATA_CMD_WRITE_MULTI) ||
1070 (tf->command == ATA_CMD_READ_MULTI_EXT) ||
1071 (tf->command == ATA_CMD_WRITE_MULTI_EXT) ||
1072 (tf->command == ATA_CMD_WRITE_MULTI_FUA_EXT);
1073}
1074
Tejun Heoe9c83912006-07-03 16:07:26 +09001075static inline const unsigned long *
1076sata_ehc_deb_timing(struct ata_eh_context *ehc)
1077{
1078 if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
1079 return sata_deb_timing_hotplug;
1080 else
1081 return sata_deb_timing_normal;
1082}
Tejun Heod7bb4cc2006-05-31 18:27:46 +09001083
Tejun Heodd5b06c2006-08-10 16:59:12 +09001084static inline int ata_port_is_dummy(struct ata_port *ap)
1085{
1086 return ap->ops == &ata_dummy_port_ops;
1087}
1088
Tejun Heo936fd732007-08-06 18:36:23 +09001089extern int sata_set_spd(struct ata_link *link);
Tejun Heo0aa11132008-04-07 22:47:18 +09001090extern int ata_std_prereset(struct ata_link *link, unsigned long deadline);
Tejun Heoaa2731a2008-04-07 22:47:19 +09001091extern int ata_wait_after_reset(struct ata_link *link, unsigned long deadline,
1092 int (*check_ready)(struct ata_link *link));
Tejun Heo936fd732007-08-06 18:36:23 +09001093extern int sata_link_debounce(struct ata_link *link,
1094 const unsigned long *params, unsigned long deadline);
1095extern int sata_link_resume(struct ata_link *link, const unsigned long *params,
1096 unsigned long deadline);
Tejun Heo1152b262010-09-01 17:50:05 +02001097extern int sata_link_scr_lpm(struct ata_link *link, enum ata_lpm_policy policy,
1098 bool spm_wakeup);
Tejun Heocc0680a2007-08-06 18:36:23 +09001099extern int sata_link_hardreset(struct ata_link *link,
Tejun Heo9dadd452008-04-07 22:47:19 +09001100 const unsigned long *timing, unsigned long deadline,
1101 bool *online, int (*check_ready)(struct ata_link *));
Tejun Heo57c9efd2008-04-07 22:47:19 +09001102extern int sata_std_hardreset(struct ata_link *link, unsigned int *class,
1103 unsigned long deadline);
Tejun Heo203c75b2008-04-07 22:47:18 +09001104extern void ata_std_postreset(struct ata_link *link, unsigned int *classes);
Jeff Garzik28555682007-10-11 17:12:35 -04001105
Tejun Heof3187192007-04-17 23:44:07 +09001106extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
Tejun Heof5cda252007-04-17 23:44:07 +09001107extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
1108 const struct ata_port_info * const * ppi, int n_ports);
Tejun Heob1c72912008-07-31 17:02:43 +09001109extern int ata_slave_link_init(struct ata_port *ap);
Tejun Heoecef7252007-04-17 23:44:06 +09001110extern int ata_host_start(struct ata_host *host);
Tejun Heof3187192007-04-17 23:44:07 +09001111extern int ata_host_register(struct ata_host *host,
1112 struct scsi_host_template *sht);
Tejun Heof5cda252007-04-17 23:44:07 +09001113extern int ata_host_activate(struct ata_host *host, int irq,
1114 irq_handler_t irq_handler, unsigned long irq_flags,
1115 struct scsi_host_template *sht);
Tejun Heo0529c1592007-01-20 16:00:26 +09001116extern void ata_host_detach(struct ata_host *host);
Dan Williams8d8e7d12012-07-09 21:06:08 -07001117extern void ata_host_init(struct ata_host *, struct device *, struct ata_port_operations *);
Jeff Garzik193515d2005-11-07 00:59:37 -05001118extern int ata_scsi_detect(struct scsi_host_template *sht);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001119extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
Jeff Garzikf2812332010-11-16 02:10:29 -05001120extern int ata_scsi_queuecmd(struct Scsi_Host *h, struct scsi_cmnd *cmd);
Jeff Garzik94be9a52009-01-16 10:17:09 -05001121extern int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *dev,
1122 int cmd, void __user *arg);
Brian King80289162006-08-07 14:27:31 -05001123extern void ata_sas_port_destroy(struct ata_port *);
Jeff Garzikcca39742006-08-24 03:19:22 -04001124extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
Brian King80289162006-08-07 14:27:31 -05001125 struct ata_port_info *, struct Scsi_Host *);
Dan Williamsb2024452012-03-21 21:09:07 -07001126extern void ata_sas_async_probe(struct ata_port *ap);
1127extern int ata_sas_sync_probe(struct ata_port *ap);
Brian King80289162006-08-07 14:27:31 -05001128extern int ata_sas_port_init(struct ata_port *);
1129extern int ata_sas_port_start(struct ata_port *ap);
1130extern void ata_sas_port_stop(struct ata_port *ap);
1131extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
Jeff Garzikb27dcfb2010-11-17 22:56:48 -05001132extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, struct ata_port *ap);
Tejun Heo936fd732007-08-06 18:36:23 +09001133extern int sata_scr_valid(struct ata_link *link);
1134extern int sata_scr_read(struct ata_link *link, int reg, u32 *val);
1135extern int sata_scr_write(struct ata_link *link, int reg, u32 val);
1136extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val);
Tejun Heob5b3fa32008-07-31 17:02:42 +09001137extern bool ata_link_online(struct ata_link *link);
1138extern bool ata_link_offline(struct ata_link *link);
Tejun Heo6ffa01d2007-03-02 17:32:47 +09001139#ifdef CONFIG_PM
Jeff Garzikcca39742006-08-24 03:19:22 -04001140extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
1141extern void ata_host_resume(struct ata_host *host);
Dan Williamsbc6e7c42014-03-14 13:52:48 -07001142extern void ata_sas_port_suspend(struct ata_port *ap);
1143extern void ata_sas_port_resume(struct ata_port *ap);
Dan Williams2fcbdcb2012-06-21 23:41:46 -07001144#else
Dan Williamsbc6e7c42014-03-14 13:52:48 -07001145static inline void ata_sas_port_suspend(struct ata_port *ap)
Dan Williams2fcbdcb2012-06-21 23:41:46 -07001146{
Dan Williams2fcbdcb2012-06-21 23:41:46 -07001147}
Randy Dunlapa5a65692014-03-19 10:46:25 -07001148static inline void ata_sas_port_resume(struct ata_port *ap)
1149{
1150}
Tejun Heo6ffa01d2007-03-02 17:32:47 +09001151#endif
Jeff Garzik67846b32005-10-05 02:58:32 -04001152extern int ata_ratelimit(void);
Tejun Heo97750ce2010-09-06 17:56:29 +02001153extern void ata_msleep(struct ata_port *ap, unsigned int msecs);
1154extern u32 ata_wait_register(struct ata_port *ap, void __iomem *reg, u32 mask,
1155 u32 val, unsigned long interval, unsigned long timeout);
Tejun Heo436d34b2008-04-02 17:28:46 +09001156extern int atapi_cmd_type(u8 opcode);
Tejun Heo99771262007-07-16 14:29:38 +09001157extern void ata_tf_to_fis(const struct ata_taskfile *tf,
1158 u8 pmp, int is_cmd, u8 *fis);
Jeff Garzik057ace52005-10-22 14:27:05 -04001159extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
Tejun Heo7dc951a2007-11-27 19:43:42 +09001160extern unsigned long ata_pack_xfermask(unsigned long pio_mask,
1161 unsigned long mwdma_mask, unsigned long udma_mask);
1162extern void ata_unpack_xfermask(unsigned long xfer_mask,
1163 unsigned long *pio_mask, unsigned long *mwdma_mask,
1164 unsigned long *udma_mask);
1165extern u8 ata_xfer_mask2mode(unsigned long xfer_mask);
1166extern unsigned long ata_xfer_mode2mask(u8 xfer_mode);
1167extern int ata_xfer_mode2shift(unsigned long xfer_mode);
1168extern const char *ata_mode_string(unsigned long xfer_mask);
1169extern unsigned long ata_id_xfermask(const u16 *id);
Tejun Heo31cc23b2007-09-23 13:14:12 +09001170extern int ata_std_qc_defer(struct ata_queued_cmd *qc);
Brian Kinge46834c2006-03-17 17:04:03 -06001171extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001172extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
1173 unsigned int n_elem);
Jeff Garzik057ace52005-10-22 14:27:05 -04001174extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
Alan10305f02007-02-20 18:01:59 +00001175extern void ata_dev_disable(struct ata_device *adev);
Tejun Heo6a62a042006-02-13 10:02:46 +09001176extern void ata_id_string(const u16 *id, unsigned char *s,
1177 unsigned int ofs, unsigned int len);
1178extern void ata_id_c_string(const u16 *id, unsigned char *s,
1179 unsigned int ofs, unsigned int len);
Alan Cox963e4972008-07-24 17:16:06 +01001180extern unsigned int ata_do_dev_read_id(struct ata_device *dev,
1181 struct ata_taskfile *tf, u16 *id);
Tejun Heof686bcb2006-05-15 20:58:05 +09001182extern void ata_qc_complete(struct ata_queued_cmd *qc);
Tejun Heo79f97da2008-04-07 22:47:20 +09001183extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active);
Jeff Garzikb27dcfb2010-11-17 22:56:48 -05001184extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001185extern int ata_std_bios_param(struct scsi_device *sdev,
1186 struct block_device *bdev,
1187 sector_t capacity, int geom[]);
Tejun Heod8d91292010-05-15 20:09:34 +02001188extern void ata_scsi_unlock_native_capacity(struct scsi_device *sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001189extern int ata_scsi_slave_config(struct scsi_device *sdev);
Tejun Heo83c47bc2006-05-31 18:28:07 +09001190extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
Tejun Heoa6e6ce82006-05-15 21:03:48 +09001191extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
Christoph Hellwigdb5ed4d2014-11-13 15:08:42 +01001192 int queue_depth);
Dan Williamsf6e67032011-09-20 15:10:33 -07001193extern int __ata_change_queue_depth(struct ata_port *ap, struct scsi_device *sdev,
Christoph Hellwigdb5ed4d2014-11-13 15:08:42 +01001194 int queue_depth);
Tejun Heo3373efd2006-05-15 20:57:53 +09001195extern struct ata_device *ata_dev_pair(struct ata_device *adev);
Tejun Heo02607312007-08-06 18:36:23 +09001196extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
James Bottomley0e0b494c2011-01-23 09:42:50 -06001197extern void ata_scsi_port_error_handler(struct Scsi_Host *host, struct ata_port *ap);
1198extern 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 +02001199extern bool sata_lpm_ignore_phy_events(struct ata_link *link);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200
Alan Coxbe0d18d2007-03-06 02:37:56 -08001201extern int ata_cable_40wire(struct ata_port *ap);
1202extern int ata_cable_80wire(struct ata_port *ap);
1203extern int ata_cable_sata(struct ata_port *ap);
Tejun Heoc88f90c2007-11-27 19:43:48 +09001204extern int ata_cable_ignore(struct ata_port *ap);
Alan Coxbe0d18d2007-03-06 02:37:56 -08001205extern int ata_cable_unknown(struct ata_port *ap);
1206
Tejun Heo624d5c52008-03-25 22:16:41 +09001207/* Timing helpers */
Alan Cox1bc4ccf2006-01-09 17:18:14 +00001208extern unsigned int ata_pio_need_iordy(const struct ata_device *);
Tejun Heo63573572007-11-27 19:43:39 +09001209extern const struct ata_timing *ata_timing_find_mode(u8 xfer_mode);
Alan Cox452503f2005-10-21 19:01:32 -04001210extern int ata_timing_compute(struct ata_device *, unsigned short,
1211 struct ata_timing *, int, int);
1212extern void ata_timing_merge(const struct ata_timing *,
1213 const struct ata_timing *, struct ata_timing *,
1214 unsigned int);
Tejun Heoa0f79b92007-12-18 16:33:05 +09001215extern u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle);
Alan Cox452503f2005-10-21 19:01:32 -04001216
Tejun Heo624d5c52008-03-25 22:16:41 +09001217/* PCI */
1218#ifdef CONFIG_PCI
1219struct pci_dev;
1220
1221struct pci_bits {
1222 unsigned int reg; /* PCI config register to read */
1223 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
1224 unsigned long mask;
1225 unsigned long val;
Alan Cox452503f2005-10-21 19:01:32 -04001226};
1227
Tejun Heo624d5c52008-03-25 22:16:41 +09001228extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
1229extern void ata_pci_remove_one(struct pci_dev *pdev);
1230
1231#ifdef CONFIG_PM
1232extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
1233extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
1234extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
1235extern int ata_pci_device_resume(struct pci_dev *pdev);
1236#endif /* CONFIG_PM */
1237#endif /* CONFIG_PCI */
1238
Brian Norrisb7db04d2012-11-02 12:29:32 -07001239struct platform_device;
1240
1241extern int ata_platform_remove_one(struct platform_device *pdev);
1242
Tejun Heo624d5c52008-03-25 22:16:41 +09001243/*
1244 * ACPI - drivers/ata/libata-acpi.c
1245 */
Alan Coxe1ddb4b2007-08-16 02:33:36 -04001246#ifdef CONFIG_ATA_ACPI
Tejun Heoc05e6ff2007-12-15 15:05:02 +09001247static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1248{
1249 if (ap->pflags & ATA_PFLAG_INIT_GTM_VALID)
1250 return &ap->__acpi_init_gtm;
1251 return NULL;
1252}
Tejun Heo0d02f0b2007-12-15 15:04:57 +09001253int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm);
1254int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *stm);
Tejun Heo7c77fa42007-12-18 16:33:03 +09001255unsigned long ata_acpi_gtm_xfermask(struct ata_device *dev,
1256 const struct ata_acpi_gtm *gtm);
Tejun Heo021ee9a2007-12-18 16:33:06 +09001257int ata_acpi_cbl_80wire(struct ata_port *ap, const struct ata_acpi_gtm *gtm);
Alan Coxe1ddb4b2007-08-16 02:33:36 -04001258#else
Tejun Heoc05e6ff2007-12-15 15:05:02 +09001259static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1260{
1261 return NULL;
1262}
Tejun Heo7c77fa42007-12-18 16:33:03 +09001263
1264static inline int ata_acpi_stm(const struct ata_port *ap,
1265 struct ata_acpi_gtm *stm)
1266{
1267 return -ENOSYS;
1268}
1269
1270static inline int ata_acpi_gtm(const struct ata_port *ap,
1271 struct ata_acpi_gtm *stm)
1272{
1273 return -ENOSYS;
1274}
1275
1276static inline unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev,
1277 const struct ata_acpi_gtm *gtm)
1278{
1279 return 0;
1280}
Tejun Heo021ee9a2007-12-18 16:33:06 +09001281
1282static inline int ata_acpi_cbl_80wire(struct ata_port *ap,
1283 const struct ata_acpi_gtm *gtm)
1284{
1285 return 0;
1286}
Alan Coxe1ddb4b2007-08-16 02:33:36 -04001287#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288
Tejun Heoece1d632006-04-02 18:51:53 +09001289/*
Tejun Heo624d5c52008-03-25 22:16:41 +09001290 * EH - drivers/ata/libata-eh.c
Tejun Heoece1d632006-04-02 18:51:53 +09001291 */
Tejun Heo7b70fc02006-05-15 20:58:07 +09001292extern void ata_port_schedule_eh(struct ata_port *ap);
Dan Williams81c757b2011-12-02 16:07:01 -08001293extern void ata_port_wait_eh(struct ata_port *ap);
Tejun Heodbd82612007-08-06 18:36:23 +09001294extern int ata_link_abort(struct ata_link *link);
Tejun Heo7b70fc02006-05-15 20:58:07 +09001295extern int ata_port_abort(struct ata_port *ap);
Tejun Heoe3180492006-05-15 20:58:09 +09001296extern int ata_port_freeze(struct ata_port *ap);
Tejun Heo7d77b242007-09-23 13:14:13 +09001297extern int sata_async_notification(struct ata_port *ap);
Tejun Heoe3180492006-05-15 20:58:09 +09001298
1299extern void ata_eh_freeze_port(struct ata_port *ap);
1300extern void ata_eh_thaw_port(struct ata_port *ap);
Tejun Heo7b70fc02006-05-15 20:58:07 +09001301
Tejun Heoece1d632006-04-02 18:51:53 +09001302extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
1303extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
Mark Lord10acf3b2008-05-02 02:14:53 -04001304extern void ata_eh_analyze_ncq_error(struct ata_link *link);
Tejun Heoece1d632006-04-02 18:51:53 +09001305
Tejun Heof5914a42006-05-31 18:27:48 +09001306extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
1307 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
1308 ata_postreset_fn_t postreset);
Tejun Heoa1efdab2008-03-25 12:22:50 +09001309extern void ata_std_error_handler(struct ata_port *ap);
Dan Williamse4a9c372012-06-21 23:25:27 -07001310extern void ata_std_sched_eh(struct ata_port *ap);
1311extern void ata_std_end_eh(struct ata_port *ap);
Kristen Carlson Accardi8a745f12011-03-04 10:24:11 -08001312extern int ata_link_nr_enabled(struct ata_link *link);
Tejun Heo022bdb02006-05-15 20:58:22 +09001313
Tejun Heo61440db2006-05-15 20:57:55 +09001314/*
Tejun Heo68d1d072008-03-25 12:22:49 +09001315 * Base operations to inherit from and initializers for sht
1316 *
1317 * Operations
1318 *
1319 * base : Common to all libata drivers.
1320 * sata : SATA controllers w/ native interface.
1321 * pmp : SATA controllers w/ PMP support.
1322 * sff : SFF ATA controllers w/o BMDMA support.
1323 * bmdma : SFF ATA controllers w/ BMDMA support.
1324 *
1325 * sht initializers
1326 *
1327 * BASE : Common to all libata drivers. The user must set
1328 * sg_tablesize and dma_boundary.
1329 * PIO : SFF ATA controllers w/ only PIO support.
1330 * BMDMA : SFF ATA controllers w/ BMDMA support. sg_tablesize and
1331 * dma_boundary are set to BMDMA limits.
1332 * NCQ : SATA controllers supporting NCQ. The user must set
1333 * sg_tablesize, dma_boundary and can_queue.
1334 */
1335extern const struct ata_port_operations ata_base_port_ops;
1336extern const struct ata_port_operations sata_port_ops;
Elias Oltmanns45fabbb2008-09-21 11:54:08 +02001337extern struct device_attribute *ata_common_sdev_attrs[];
Tejun Heo68d1d072008-03-25 12:22:49 +09001338
Akinobu Mita018d5ef2015-01-29 08:30:29 +09001339/*
1340 * All sht initializers (BASE, PIO, BMDMA, NCQ) must be instantiated
1341 * by the edge drivers. Because the 'module' field of sht must be the
1342 * edge driver's module reference, otherwise the driver can be unloaded
1343 * even if the scsi_device is being accessed.
1344 */
Tejun Heo68d1d072008-03-25 12:22:49 +09001345#define ATA_BASE_SHT(drv_name) \
1346 .module = THIS_MODULE, \
1347 .name = drv_name, \
1348 .ioctl = ata_scsi_ioctl, \
1349 .queuecommand = ata_scsi_queuecmd, \
1350 .can_queue = ATA_DEF_QUEUE, \
Shaohua Li12cb5ce2015-01-15 17:32:27 -08001351 .tag_alloc_policy = BLK_TAG_ALLOC_RR, \
Tejun Heo68d1d072008-03-25 12:22:49 +09001352 .this_id = ATA_SHT_THIS_ID, \
Tejun Heo68d1d072008-03-25 12:22:49 +09001353 .emulated = ATA_SHT_EMULATED, \
1354 .use_clustering = ATA_SHT_USE_CLUSTERING, \
1355 .proc_name = drv_name, \
1356 .slave_configure = ata_scsi_slave_config, \
1357 .slave_destroy = ata_scsi_slave_destroy, \
Elias Oltmanns45fabbb2008-09-21 11:54:08 +02001358 .bios_param = ata_std_bios_param, \
Tejun Heod8d91292010-05-15 20:09:34 +02001359 .unlock_native_capacity = ata_scsi_unlock_native_capacity, \
Elias Oltmanns45fabbb2008-09-21 11:54:08 +02001360 .sdev_attrs = ata_common_sdev_attrs
Tejun Heo68d1d072008-03-25 12:22:49 +09001361
Tejun Heo68d1d072008-03-25 12:22:49 +09001362#define ATA_NCQ_SHT(drv_name) \
1363 ATA_BASE_SHT(drv_name), \
1364 .change_queue_depth = ata_scsi_change_queue_depth
1365
1366/*
Tejun Heo071f44b2008-04-07 22:47:22 +09001367 * PMP helpers
1368 */
Tejun Heo88fcd562008-04-07 22:47:22 +09001369#ifdef CONFIG_SATA_PMP
Tejun Heo071f44b2008-04-07 22:47:22 +09001370static inline bool sata_pmp_supported(struct ata_port *ap)
1371{
1372 return ap->flags & ATA_FLAG_PMP;
1373}
1374
1375static inline bool sata_pmp_attached(struct ata_port *ap)
1376{
1377 return ap->nr_pmp_links != 0;
1378}
1379
Christoph Hellwigb1c04e82016-07-14 09:05:42 +09001380static inline bool ata_is_host_link(const struct ata_link *link)
Tejun Heo071f44b2008-04-07 22:47:22 +09001381{
Tejun Heob1c72912008-07-31 17:02:43 +09001382 return link == &link->ap->link || link == link->ap->slave_link;
Tejun Heo071f44b2008-04-07 22:47:22 +09001383}
Tejun Heo88fcd562008-04-07 22:47:22 +09001384#else /* CONFIG_SATA_PMP */
1385static inline bool sata_pmp_supported(struct ata_port *ap)
1386{
1387 return false;
1388}
1389
1390static inline bool sata_pmp_attached(struct ata_port *ap)
1391{
1392 return false;
1393}
1394
Christoph Hellwigb1c04e82016-07-14 09:05:42 +09001395static inline bool ata_is_host_link(const struct ata_link *link)
Tejun Heo88fcd562008-04-07 22:47:22 +09001396{
1397 return 1;
1398}
1399#endif /* CONFIG_SATA_PMP */
Tejun Heo071f44b2008-04-07 22:47:22 +09001400
1401static inline int sata_srst_pmp(struct ata_link *link)
1402{
1403 if (sata_pmp_supported(link->ap) && ata_is_host_link(link))
1404 return SATA_PMP_CTRL_PORT;
1405 return link->pmp;
1406}
1407
1408/*
Tejun Heo61440db2006-05-15 20:57:55 +09001409 * printk helpers
1410 */
Joe Perchesb9075fa2011-10-31 17:11:33 -07001411__printf(3, 4)
Joe Perchesd7bead12014-09-22 09:52:18 -07001412void ata_port_printk(const struct ata_port *ap, const char *level,
1413 const char *fmt, ...);
Joe Perchesb9075fa2011-10-31 17:11:33 -07001414__printf(3, 4)
Joe Perchesd7bead12014-09-22 09:52:18 -07001415void ata_link_printk(const struct ata_link *link, const char *level,
1416 const char *fmt, ...);
Joe Perchesb9075fa2011-10-31 17:11:33 -07001417__printf(3, 4)
Joe Perchesd7bead12014-09-22 09:52:18 -07001418void ata_dev_printk(const struct ata_device *dev, const char *level,
1419 const char *fmt, ...);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001420
Joe Perchesa9a79df2011-04-15 15:51:59 -07001421#define ata_port_err(ap, fmt, ...) \
1422 ata_port_printk(ap, KERN_ERR, fmt, ##__VA_ARGS__)
1423#define ata_port_warn(ap, fmt, ...) \
1424 ata_port_printk(ap, KERN_WARNING, fmt, ##__VA_ARGS__)
1425#define ata_port_notice(ap, fmt, ...) \
1426 ata_port_printk(ap, KERN_NOTICE, fmt, ##__VA_ARGS__)
1427#define ata_port_info(ap, fmt, ...) \
1428 ata_port_printk(ap, KERN_INFO, fmt, ##__VA_ARGS__)
1429#define ata_port_dbg(ap, fmt, ...) \
1430 ata_port_printk(ap, KERN_DEBUG, fmt, ##__VA_ARGS__)
Tejun Heo9af5c9c2007-08-06 18:36:22 +09001431
Joe Perchesa9a79df2011-04-15 15:51:59 -07001432#define ata_link_err(link, fmt, ...) \
1433 ata_link_printk(link, KERN_ERR, fmt, ##__VA_ARGS__)
1434#define ata_link_warn(link, fmt, ...) \
1435 ata_link_printk(link, KERN_WARNING, fmt, ##__VA_ARGS__)
1436#define ata_link_notice(link, fmt, ...) \
1437 ata_link_printk(link, KERN_NOTICE, fmt, ##__VA_ARGS__)
1438#define ata_link_info(link, fmt, ...) \
1439 ata_link_printk(link, KERN_INFO, fmt, ##__VA_ARGS__)
1440#define ata_link_dbg(link, fmt, ...) \
1441 ata_link_printk(link, KERN_DEBUG, fmt, ##__VA_ARGS__)
1442
1443#define ata_dev_err(dev, fmt, ...) \
1444 ata_dev_printk(dev, KERN_ERR, fmt, ##__VA_ARGS__)
1445#define ata_dev_warn(dev, fmt, ...) \
1446 ata_dev_printk(dev, KERN_WARNING, fmt, ##__VA_ARGS__)
1447#define ata_dev_notice(dev, fmt, ...) \
1448 ata_dev_printk(dev, KERN_NOTICE, fmt, ##__VA_ARGS__)
1449#define ata_dev_info(dev, fmt, ...) \
1450 ata_dev_printk(dev, KERN_INFO, fmt, ##__VA_ARGS__)
1451#define ata_dev_dbg(dev, fmt, ...) \
1452 ata_dev_printk(dev, KERN_DEBUG, fmt, ##__VA_ARGS__)
Tejun Heo61440db2006-05-15 20:57:55 +09001453
Joe Perches06296a12011-04-15 15:52:00 -07001454void ata_print_version(const struct device *dev, const char *version);
1455
Tejun Heo61440db2006-05-15 20:57:55 +09001456/*
Tejun Heof3e81b12006-05-15 20:58:21 +09001457 * ata_eh_info helpers
1458 */
Joe Perchesb9075fa2011-10-31 17:11:33 -07001459extern __printf(2, 3)
1460void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
1461extern __printf(2, 3)
1462void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
Tejun Heob64bbc32007-07-16 14:29:39 +09001463extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
Tejun Heof3e81b12006-05-15 20:58:21 +09001464
Tejun Heoc0b6c032006-07-03 16:07:26 +09001465static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
1466{
Tejun Heob558edd2008-01-24 00:05:14 +09001467 ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
Tejun Heof8f1e1c2007-07-16 14:29:40 +09001468 ehi->flags |= ATA_EHI_HOTPLUGGED;
Tejun Heob558edd2008-01-24 00:05:14 +09001469 ehi->action |= ATA_EH_RESET | ATA_EH_ENABLE_LINK;
Tejun Heoc0b6c032006-07-03 16:07:26 +09001470 ehi->err_mask |= AC_ERR_ATA_BUS;
1471}
1472
Tejun Heof3e81b12006-05-15 20:58:21 +09001473/*
Tejun Heocbcdd872007-08-18 13:14:55 +09001474 * port description helpers
1475 */
Joe Perchesb9075fa2011-10-31 17:11:33 -07001476extern __printf(2, 3)
1477void ata_port_desc(struct ata_port *ap, const char *fmt, ...);
Tejun Heocbcdd872007-08-18 13:14:55 +09001478#ifdef CONFIG_PCI
1479extern void ata_port_pbar_desc(struct ata_port *ap, int bar, ssize_t offset,
1480 const char *name);
1481#endif
1482
Linus Torvalds1da177e2005-04-16 15:20:36 -07001483static inline unsigned int ata_tag_valid(unsigned int tag)
1484{
1485 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
1486}
1487
Tejun Heo2ab7db12006-05-15 20:58:02 +09001488static inline unsigned int ata_tag_internal(unsigned int tag)
1489{
Yoichi Yuasa83c063d2008-02-28 21:43:13 +09001490 return tag == ATA_TAG_INTERNAL;
Tejun Heo2ab7db12006-05-15 20:58:02 +09001491}
1492
Tejun Heo5806db22006-06-24 20:30:19 +09001493/*
1494 * device helpers
1495 */
Tejun Heoe1211e32006-04-01 01:38:18 +09001496static inline unsigned int ata_class_enabled(unsigned int class)
Tejun Heo597afd22006-03-01 01:25:38 +09001497{
Tejun Heoe0a71752007-09-23 13:14:12 +09001498 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI ||
Hannes Reinecke9162c652014-11-05 13:08:21 +01001499 class == ATA_DEV_PMP || class == ATA_DEV_SEMB ||
1500 class == ATA_DEV_ZAC;
Tejun Heo597afd22006-03-01 01:25:38 +09001501}
1502
Tejun Heoe1211e32006-04-01 01:38:18 +09001503static inline unsigned int ata_class_disabled(unsigned int class)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504{
Tejun Heoe0a71752007-09-23 13:14:12 +09001505 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP ||
Hannes Reinecke3a929452016-04-25 12:45:51 +02001506 class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP ||
1507 class == ATA_DEV_ZAC_UNSUP;
Tejun Heoe1211e32006-04-01 01:38:18 +09001508}
1509
Tejun Heo002c8052006-04-02 17:54:46 +09001510static inline unsigned int ata_class_absent(unsigned int class)
1511{
1512 return !ata_class_enabled(class) && !ata_class_disabled(class);
1513}
1514
Tejun Heoe1211e32006-04-01 01:38:18 +09001515static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1516{
1517 return ata_class_enabled(dev->class);
1518}
1519
1520static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1521{
1522 return ata_class_disabled(dev->class);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001523}
1524
Tejun Heo002c8052006-04-02 17:54:46 +09001525static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1526{
1527 return ata_class_absent(dev->class);
1528}
1529
Tejun Heo5806db22006-06-24 20:30:19 +09001530/*
Tejun Heof58229f2007-08-06 18:36:23 +09001531 * link helpers
Tejun Heo5806db22006-06-24 20:30:19 +09001532 */
Tejun Heof58229f2007-08-06 18:36:23 +09001533static inline int ata_link_max_devices(const struct ata_link *link)
Tejun Heo5806db22006-06-24 20:30:19 +09001534{
Tejun Heo89898052007-08-06 18:36:23 +09001535 if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS)
Tejun Heo5806db22006-06-24 20:30:19 +09001536 return 2;
1537 return 1;
1538}
1539
Tejun Heoda917d62007-09-23 13:14:12 +09001540static inline int ata_link_active(struct ata_link *link)
1541{
1542 return ata_tag_valid(link->active_tag) || link->sactive;
1543}
1544
Tejun Heo1eca4362008-11-03 20:03:17 +09001545/*
1546 * Iterators
1547 *
1548 * ATA_LITER_* constants are used to select link iteration mode and
1549 * ATA_DITER_* device iteration mode.
1550 *
1551 * For a custom iteration directly using ata_{link|dev}_next(), if
1552 * @link or @dev, respectively, is NULL, the first element is
1553 * returned. @dev and @link can be any valid device or link and the
1554 * next element according to the iteration mode will be returned.
1555 * After the last element, NULL is returned.
1556 */
1557enum ata_link_iter_mode {
1558 ATA_LITER_EDGE, /* if present, PMP links only; otherwise,
1559 * host link. no slave link */
1560 ATA_LITER_HOST_FIRST, /* host link followed by PMP or slave links */
1561 ATA_LITER_PMP_FIRST, /* PMP links followed by host link,
1562 * slave link still comes after host link */
1563};
Tejun Heo89898052007-08-06 18:36:23 +09001564
Tejun Heo1eca4362008-11-03 20:03:17 +09001565enum ata_dev_iter_mode {
1566 ATA_DITER_ENABLED,
1567 ATA_DITER_ENABLED_REVERSE,
1568 ATA_DITER_ALL,
1569 ATA_DITER_ALL_REVERSE,
1570};
Tejun Heo89898052007-08-06 18:36:23 +09001571
Tejun Heo1eca4362008-11-03 20:03:17 +09001572extern struct ata_link *ata_link_next(struct ata_link *link,
1573 struct ata_port *ap,
1574 enum ata_link_iter_mode mode);
Tejun Heof58229f2007-08-06 18:36:23 +09001575
Tejun Heo1eca4362008-11-03 20:03:17 +09001576extern struct ata_device *ata_dev_next(struct ata_device *dev,
1577 struct ata_link *link,
1578 enum ata_dev_iter_mode mode);
Tejun Heof58229f2007-08-06 18:36:23 +09001579
Tejun Heo1eca4362008-11-03 20:03:17 +09001580/*
1581 * Shortcut notation for iterations
1582 *
1583 * ata_for_each_link() iterates over each link of @ap according to
1584 * @mode. @link points to the current link in the loop. @link is
1585 * NULL after loop termination. ata_for_each_dev() works the same way
1586 * except that it iterates over each device of @link.
1587 *
1588 * Note that the mode prefixes ATA_{L|D}ITER_ shouldn't need to be
1589 * specified when using the following shorthand notations. Only the
1590 * mode itself (EDGE, HOST_FIRST, ENABLED, etc...) should be
1591 * specified. This not only increases brevity but also makes it
1592 * impossible to use ATA_LITER_* for device iteration or vice-versa.
1593 */
1594#define ata_for_each_link(link, ap, mode) \
1595 for ((link) = ata_link_next(NULL, (ap), ATA_LITER_##mode); (link); \
1596 (link) = ata_link_next((link), (ap), ATA_LITER_##mode))
1597
1598#define ata_for_each_dev(dev, link, mode) \
1599 for ((dev) = ata_dev_next(NULL, (link), ATA_DITER_##mode); (dev); \
1600 (dev) = ata_dev_next((dev), (link), ATA_DITER_##mode))
Tejun Heo5806db22006-06-24 20:30:19 +09001601
Tejun Heo6d1245b2007-02-20 23:20:27 +09001602/**
1603 * ata_ncq_enabled - Test whether NCQ is enabled
1604 * @dev: ATA device to test for
1605 *
1606 * LOCKING:
1607 * spin_lock_irqsave(host lock)
1608 *
1609 * RETURNS:
1610 * 1 if NCQ is enabled for @dev, 0 otherwise.
1611 */
1612static inline int ata_ncq_enabled(struct ata_device *dev)
1613{
1614 return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1615 ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1616}
Edward Falk0baab862005-06-02 18:17:13 -04001617
Marc Carino87fb6c32013-08-24 23:22:51 -07001618static inline bool ata_fpdma_dsm_supported(struct ata_device *dev)
1619{
1620 return (dev->flags & ATA_DFLAG_NCQ_SEND_RECV) &&
1621 (dev->ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_DSM_OFFSET] &
1622 ATA_LOG_NCQ_SEND_RECV_DSM_TRIM);
1623}
1624
Hannes Reinecke5c65d8b2016-04-25 12:45:47 +02001625static inline bool ata_fpdma_read_log_supported(struct ata_device *dev)
1626{
1627 return (dev->flags & ATA_DFLAG_NCQ_SEND_RECV) &&
1628 (dev->ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_RD_LOG_OFFSET] &
1629 ATA_LOG_NCQ_SEND_RECV_RD_LOG_SUPPORTED);
1630}
1631
Hannes Reinecke28a3fc22016-04-25 12:45:52 +02001632static inline bool ata_fpdma_zac_mgmt_in_supported(struct ata_device *dev)
1633{
1634 return (dev->flags & ATA_DFLAG_NCQ_SEND_RECV) &&
1635 (dev->ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_ZAC_MGMT_OFFSET] &
1636 ATA_LOG_NCQ_SEND_RECV_ZAC_MGMT_IN_SUPPORTED);
1637}
1638
Hannes Reinecke284b3b72016-04-25 12:45:54 +02001639static inline bool ata_fpdma_zac_mgmt_out_supported(struct ata_device *dev)
1640{
1641 return (dev->ncq_non_data_cmds[ATA_LOG_NCQ_NON_DATA_ZAC_MGMT_OFFSET] &
1642 ATA_LOG_NCQ_NON_DATA_ZAC_MGMT_OUT);
1643}
1644
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1646{
1647 qc->tf.ctl |= ATA_NIEN;
1648}
1649
Tejun Heof69499f2006-05-15 20:58:03 +09001650static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1651 unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001652{
1653 if (likely(ata_tag_valid(tag)))
1654 return &ap->qcmd[tag];
1655 return NULL;
1656}
1657
Tejun Heof69499f2006-05-15 20:58:03 +09001658static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1659 unsigned int tag)
1660{
1661 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1662
1663 if (unlikely(!qc) || !ap->ops->error_handler)
1664 return qc;
1665
1666 if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1667 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1668 return qc;
1669
1670 return NULL;
1671}
1672
Tejun Heoaacda372008-03-18 17:47:43 +09001673static inline unsigned int ata_qc_raw_nbytes(struct ata_queued_cmd *qc)
1674{
1675 return qc->nbytes - min(qc->extrabytes, qc->nbytes);
1676}
1677
Tejun Heo3373efd2006-05-15 20:57:53 +09001678static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001679{
1680 memset(tf, 0, sizeof(*tf));
1681
Tejun Heo5fe74542010-05-10 21:41:37 +02001682#ifdef CONFIG_ATA_SFF
Tejun Heo9af5c9c2007-08-06 18:36:22 +09001683 tf->ctl = dev->link->ap->ctl;
Tejun Heo5fe74542010-05-10 21:41:37 +02001684#else
1685 tf->ctl = ATA_DEVCTL_OBS;
1686#endif
Tejun Heo3373efd2006-05-15 20:57:53 +09001687 if (dev->devno == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001688 tf->device = ATA_DEVICE_OBS;
1689 else
1690 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1691}
1692
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001693static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1694{
Tejun Heo501e0c502007-01-17 11:34:02 +09001695 qc->dma_dir = DMA_NONE;
Tejun Heoff2aeb12007-12-05 16:43:11 +09001696 qc->sg = NULL;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001697 qc->flags = 0;
Jens Axboe87260212007-10-16 11:14:12 +02001698 qc->cursg = NULL;
1699 qc->cursg_ofs = 0;
Tejun Heoaacda372008-03-18 17:47:43 +09001700 qc->nbytes = qc->extrabytes = qc->curbytes = 0;
Brian King7a801182007-01-17 12:32:12 -06001701 qc->n_elem = 0;
Albert Leea22e2eb2005-12-05 15:38:02 +08001702 qc->err_mask = 0;
Mark Lord5a5dbd12007-03-16 10:22:26 -04001703 qc->sect_size = ATA_SECT_SIZE;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001704
Tejun Heo3373efd2006-05-15 20:57:53 +09001705 ata_tf_init(qc->dev, &qc->tf);
Tejun Heoe61e0672006-05-15 20:57:40 +09001706
1707 /* init result_tf such that it indicates normal completion */
1708 qc->result_tf.command = ATA_DRDY;
1709 qc->result_tf.feature = 0;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001710}
1711
Jeff Garzik057ace52005-10-22 14:27:05 -04001712static inline int ata_try_flush_cache(const struct ata_device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001713{
1714 return ata_id_wcache_enabled(dev->id) ||
1715 ata_id_has_flush(dev->id) ||
1716 ata_id_has_flush_ext(dev->id);
1717}
1718
Jeff Garzika7dac442005-10-30 04:44:42 -05001719static inline unsigned int ac_err_mask(u8 status)
1720{
Albert Lee3655d1d2006-05-19 11:43:04 +08001721 if (status & (ATA_BUSY | ATA_DRQ))
Tejun Heo11a56d22006-01-23 13:09:36 +09001722 return AC_ERR_HSM;
Jeff Garzika7dac442005-10-30 04:44:42 -05001723 if (status & (ATA_ERR | ATA_DF))
1724 return AC_ERR_DEV;
1725 return 0;
1726}
1727
1728static inline unsigned int __ac_err_mask(u8 status)
1729{
1730 unsigned int mask = ac_err_mask(status);
1731 if (mask == 0)
1732 return AC_ERR_OTHER;
1733 return mask;
1734}
1735
Jeff Garzik35bb94b2006-04-11 13:12:34 -04001736static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1737{
Tejun Heo49114872007-04-17 23:44:06 +09001738 return *(struct ata_port **)&host->hostdata[0];
Jeff Garzik35bb94b2006-04-11 13:12:34 -04001739}
1740
Tejun Heo78ab88f2008-05-01 23:41:41 +09001741static inline int ata_check_ready(u8 status)
1742{
Jeff Garzik005b1f72008-05-09 15:00:55 -04001743 if (!(status & ATA_BUSY))
1744 return 1;
Tejun Heo78ab88f2008-05-01 23:41:41 +09001745
1746 /* 0xff indicates either no device or device not ready */
1747 if (status == 0xff)
1748 return -ENODEV;
1749
Jeff Garzik005b1f72008-05-09 15:00:55 -04001750 return 0;
Tejun Heo78ab88f2008-05-01 23:41:41 +09001751}
1752
Tejun Heo341c2c92008-05-20 02:17:51 +09001753static inline unsigned long ata_deadline(unsigned long from_jiffies,
1754 unsigned long timeout_msecs)
1755{
1756 return from_jiffies + msecs_to_jiffies(timeout_msecs);
1757}
1758
Alan Coxb15b3eb2008-08-01 09:18:34 +01001759/* Don't open code these in drivers as there are traps. Firstly the range may
1760 change in future hardware and specs, secondly 0xFF means 'no DMA' but is
1761 > UDMA_0. Dyma ddreigiau */
1762
1763static inline int ata_using_mwdma(struct ata_device *adev)
1764{
1765 if (adev->dma_mode >= XFER_MW_DMA_0 && adev->dma_mode <= XFER_MW_DMA_4)
1766 return 1;
1767 return 0;
1768}
1769
1770static inline int ata_using_udma(struct ata_device *adev)
1771{
1772 if (adev->dma_mode >= XFER_UDMA_0 && adev->dma_mode <= XFER_UDMA_7)
1773 return 1;
1774 return 0;
1775}
1776
1777static inline int ata_dma_enabled(struct ata_device *adev)
1778{
1779 return (adev->dma_mode == 0xFF ? 0 : 1);
1780}
Tejun Heo48515f62008-04-07 22:47:21 +09001781
1782/**************************************************************************
1783 * PMP - drivers/ata/libata-pmp.c
1784 */
Tejun Heo88fcd562008-04-07 22:47:22 +09001785#ifdef CONFIG_SATA_PMP
1786
Tejun Heo48515f62008-04-07 22:47:21 +09001787extern const struct ata_port_operations sata_pmp_port_ops;
1788
1789extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc);
1790extern void sata_pmp_error_handler(struct ata_port *ap);
1791
Tejun Heo88fcd562008-04-07 22:47:22 +09001792#else /* CONFIG_SATA_PMP */
1793
1794#define sata_pmp_port_ops sata_port_ops
1795#define sata_pmp_qc_defer_cmd_switch ata_std_qc_defer
1796#define sata_pmp_error_handler ata_std_error_handler
1797
1798#endif /* CONFIG_SATA_PMP */
1799
Tejun Heo48515f62008-04-07 22:47:21 +09001800
Tejun Heo624d5c52008-03-25 22:16:41 +09001801/**************************************************************************
1802 * SFF - drivers/ata/libata-sff.c
1803 */
Tejun Heo127102a2008-04-07 22:47:21 +09001804#ifdef CONFIG_ATA_SFF
1805
Tejun Heo624d5c52008-03-25 22:16:41 +09001806extern const struct ata_port_operations ata_sff_port_ops;
Alan Cox871af122009-01-05 14:16:39 +00001807extern const struct ata_port_operations ata_bmdma32_port_ops;
Tejun Heo624d5c52008-03-25 22:16:41 +09001808
1809/* PIO only, sg_tablesize and dma_boundary limits can be removed */
1810#define ATA_PIO_SHT(drv_name) \
1811 ATA_BASE_SHT(drv_name), \
1812 .sg_tablesize = LIBATA_MAX_PRD, \
1813 .dma_boundary = ATA_DMA_BOUNDARY
1814
Tejun Heo9363c382008-04-07 22:47:16 +09001815extern void ata_sff_dev_select(struct ata_port *ap, unsigned int device);
1816extern u8 ata_sff_check_status(struct ata_port *ap);
Alan Coxa57c1ba2008-05-29 22:10:58 +01001817extern void ata_sff_pause(struct ata_port *ap);
1818extern void ata_sff_dma_pause(struct ata_port *ap);
Tejun Heo9363c382008-04-07 22:47:16 +09001819extern int ata_sff_busy_sleep(struct ata_port *ap,
1820 unsigned long timeout_pat, unsigned long timeout);
Tejun Heo705e76b2008-04-07 22:47:19 +09001821extern int ata_sff_wait_ready(struct ata_link *link, unsigned long deadline);
Tejun Heo9363c382008-04-07 22:47:16 +09001822extern void ata_sff_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
1823extern void ata_sff_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
1824extern void ata_sff_exec_command(struct ata_port *ap,
1825 const struct ata_taskfile *tf);
1826extern unsigned int ata_sff_data_xfer(struct ata_device *dev,
Tejun Heo624d5c52008-03-25 22:16:41 +09001827 unsigned char *buf, unsigned int buflen, int rw);
Alan Cox871af122009-01-05 14:16:39 +00001828extern unsigned int ata_sff_data_xfer32(struct ata_device *dev,
1829 unsigned char *buf, unsigned int buflen, int rw);
Tejun Heo9363c382008-04-07 22:47:16 +09001830extern unsigned int ata_sff_data_xfer_noirq(struct ata_device *dev,
Tejun Heo624d5c52008-03-25 22:16:41 +09001831 unsigned char *buf, unsigned int buflen, int rw);
Sergei Shtylyove42a5422010-05-07 22:49:02 +04001832extern void ata_sff_irq_on(struct ata_port *ap);
Tejun Heo9363c382008-04-07 22:47:16 +09001833extern void ata_sff_irq_clear(struct ata_port *ap);
1834extern int ata_sff_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
1835 u8 status, int in_wq);
Viresh Kumar64b97592011-02-22 14:32:38 +05301836extern void ata_sff_queue_work(struct work_struct *work);
1837extern void ata_sff_queue_delayed_work(struct delayed_work *dwork,
1838 unsigned long delay);
Gwendal Grignouea3c6452010-08-31 16:20:36 -07001839extern void ata_sff_queue_pio_task(struct ata_link *link, unsigned long delay);
Tejun Heo9363c382008-04-07 22:47:16 +09001840extern unsigned int ata_sff_qc_issue(struct ata_queued_cmd *qc);
Tejun Heo22183bf2008-04-07 22:47:20 +09001841extern bool ata_sff_qc_fill_rtf(struct ata_queued_cmd *qc);
Tejun Heoc3b28892010-05-19 22:10:21 +02001842extern unsigned int ata_sff_port_intr(struct ata_port *ap,
Tejun Heo9363c382008-04-07 22:47:16 +09001843 struct ata_queued_cmd *qc);
1844extern irqreturn_t ata_sff_interrupt(int irq, void *dev_instance);
Alan Coxc96f1732009-03-24 10:23:46 +00001845extern void ata_sff_lost_interrupt(struct ata_port *ap);
Tejun Heo9363c382008-04-07 22:47:16 +09001846extern void ata_sff_freeze(struct ata_port *ap);
1847extern void ata_sff_thaw(struct ata_port *ap);
1848extern int ata_sff_prereset(struct ata_link *link, unsigned long deadline);
1849extern unsigned int ata_sff_dev_classify(struct ata_device *dev, int present,
1850 u8 *r_err);
Tejun Heo705e76b2008-04-07 22:47:19 +09001851extern int ata_sff_wait_after_reset(struct ata_link *link, unsigned int devmask,
1852 unsigned long deadline);
Tejun Heo9363c382008-04-07 22:47:16 +09001853extern int ata_sff_softreset(struct ata_link *link, unsigned int *classes,
Tejun Heo624d5c52008-03-25 22:16:41 +09001854 unsigned long deadline);
Tejun Heo9363c382008-04-07 22:47:16 +09001855extern int sata_sff_hardreset(struct ata_link *link, unsigned int *class,
1856 unsigned long deadline);
1857extern void ata_sff_postreset(struct ata_link *link, unsigned int *classes);
Alan Cox3d47aa82009-03-24 10:23:19 +00001858extern void ata_sff_drain_fifo(struct ata_queued_cmd *qc);
Tejun Heo9363c382008-04-07 22:47:16 +09001859extern void ata_sff_error_handler(struct ata_port *ap);
Tejun Heo9363c382008-04-07 22:47:16 +09001860extern void ata_sff_std_ports(struct ata_ioports *ioaddr);
Tejun Heo624d5c52008-03-25 22:16:41 +09001861#ifdef CONFIG_PCI
Tejun Heo9363c382008-04-07 22:47:16 +09001862extern int ata_pci_sff_init_host(struct ata_host *host);
1863extern int ata_pci_sff_prepare_host(struct pci_dev *pdev,
Tejun Heo624d5c52008-03-25 22:16:41 +09001864 const struct ata_port_info * const * ppi,
1865 struct ata_host **r_host);
Tejun Heo9363c382008-04-07 22:47:16 +09001866extern int ata_pci_sff_activate_host(struct ata_host *host,
Tejun Heo624d5c52008-03-25 22:16:41 +09001867 irq_handler_t irq_handler,
1868 struct scsi_host_template *sht);
Tejun Heo9363c382008-04-07 22:47:16 +09001869extern int ata_pci_sff_init_one(struct pci_dev *pdev,
Alan Cox16ea0fc2010-02-23 02:26:06 -05001870 const struct ata_port_info * const * ppi,
1871 struct scsi_host_template *sht, void *host_priv, int hflags);
Tejun Heo624d5c52008-03-25 22:16:41 +09001872#endif /* CONFIG_PCI */
1873
Tejun Heo9a7780c2010-05-19 22:10:24 +02001874#ifdef CONFIG_ATA_BMDMA
1875
1876extern const struct ata_port_operations ata_bmdma_port_ops;
1877
1878#define ATA_BMDMA_SHT(drv_name) \
1879 ATA_BASE_SHT(drv_name), \
1880 .sg_tablesize = LIBATA_MAX_PRD, \
1881 .dma_boundary = ATA_DMA_BOUNDARY
1882
Tejun Heof47451c2010-05-10 21:41:40 +02001883extern void ata_bmdma_qc_prep(struct ata_queued_cmd *qc);
Tejun Heo360ff782010-05-10 21:41:42 +02001884extern unsigned int ata_bmdma_qc_issue(struct ata_queued_cmd *qc);
Tejun Heof47451c2010-05-10 21:41:40 +02001885extern void ata_bmdma_dumb_qc_prep(struct ata_queued_cmd *qc);
Tejun Heoc3b28892010-05-19 22:10:21 +02001886extern unsigned int ata_bmdma_port_intr(struct ata_port *ap,
1887 struct ata_queued_cmd *qc);
1888extern irqreturn_t ata_bmdma_interrupt(int irq, void *dev_instance);
Tejun Heofe06e5f2010-05-10 21:41:39 +02001889extern void ata_bmdma_error_handler(struct ata_port *ap);
1890extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
Tejun Heo37f65b82010-05-19 22:10:20 +02001891extern void ata_bmdma_irq_clear(struct ata_port *ap);
Tejun Heo9f2f7212010-05-10 21:41:32 +02001892extern void ata_bmdma_setup(struct ata_queued_cmd *qc);
1893extern void ata_bmdma_start(struct ata_queued_cmd *qc);
1894extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
1895extern u8 ata_bmdma_status(struct ata_port *ap);
Tejun Heoc7087652010-05-10 21:41:34 +02001896extern int ata_bmdma_port_start(struct ata_port *ap);
1897extern int ata_bmdma_port_start32(struct ata_port *ap);
Tejun Heo9f2f7212010-05-10 21:41:32 +02001898
1899#ifdef CONFIG_PCI
1900extern int ata_pci_bmdma_clear_simplex(struct pci_dev *pdev);
Tejun Heoc7087652010-05-10 21:41:34 +02001901extern void ata_pci_bmdma_init(struct ata_host *host);
Tejun Heo1c5afdf2010-05-19 22:10:22 +02001902extern int ata_pci_bmdma_prepare_host(struct pci_dev *pdev,
1903 const struct ata_port_info * const * ppi,
1904 struct ata_host **r_host);
1905extern int ata_pci_bmdma_init_one(struct pci_dev *pdev,
1906 const struct ata_port_info * const * ppi,
1907 struct scsi_host_template *sht,
1908 void *host_priv, int hflags);
Tejun Heo9f2f7212010-05-10 21:41:32 +02001909#endif /* CONFIG_PCI */
Tejun Heo9a7780c2010-05-19 22:10:24 +02001910#endif /* CONFIG_ATA_BMDMA */
Tejun Heo9f2f7212010-05-10 21:41:32 +02001911
Tejun Heo624d5c52008-03-25 22:16:41 +09001912/**
Tejun Heo9363c382008-04-07 22:47:16 +09001913 * ata_sff_busy_wait - Wait for a port status register
Tejun Heo624d5c52008-03-25 22:16:41 +09001914 * @ap: Port to wait for.
1915 * @bits: bits that must be clear
1916 * @max: number of 10uS waits to perform
1917 *
1918 * Waits up to max*10 microseconds for the selected bits in the port's
1919 * status register to be cleared.
1920 * Returns final value of status register.
1921 *
1922 * LOCKING:
1923 * Inherited from caller.
1924 */
Tejun Heo9363c382008-04-07 22:47:16 +09001925static inline u8 ata_sff_busy_wait(struct ata_port *ap, unsigned int bits,
1926 unsigned int max)
Tejun Heo624d5c52008-03-25 22:16:41 +09001927{
1928 u8 status;
1929
1930 do {
1931 udelay(10);
Tejun Heo5682ed32008-04-07 22:47:16 +09001932 status = ap->ops->sff_check_status(ap);
Tejun Heo624d5c52008-03-25 22:16:41 +09001933 max--;
1934 } while (status != 0xff && (status & bits) && (max > 0));
1935
1936 return status;
1937}
1938
1939/**
1940 * ata_wait_idle - Wait for a port to be idle.
1941 * @ap: Port to wait for.
1942 *
1943 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
1944 * Returns final value of status register.
1945 *
1946 * LOCKING:
1947 * Inherited from caller.
1948 */
1949static inline u8 ata_wait_idle(struct ata_port *ap)
1950{
Tejun Heo9363c382008-04-07 22:47:16 +09001951 u8 status = ata_sff_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
Tejun Heo624d5c52008-03-25 22:16:41 +09001952
1953#ifdef ATA_DEBUG
1954 if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
1955 ata_port_printk(ap, KERN_DEBUG, "abnormal Status 0x%X\n",
1956 status);
1957#endif
1958
1959 return status;
1960}
Tejun Heo127102a2008-04-07 22:47:21 +09001961#endif /* CONFIG_ATA_SFF */
Tejun Heo624d5c52008-03-25 22:16:41 +09001962
Linus Torvalds1da177e2005-04-16 15:20:36 -07001963#endif /* __LINUX_LIBATA_H__ */