1/*
2 * Copyright 2003-2005 Red Hat, Inc. All rights reserved.
3 * Copyright 2003-2005 Jeff Garzik
4 *
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2, or (at your option)
9 * any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; see the file COPYING. If not, write to
18 * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
19 *
20 *
21 * libata documentation is available via 'make {ps|pdf}docs',
22 * as Documentation/driver-api/libata.rst
23 *
24 */
25
26#ifndef __LINUX_LIBATA_H__
27#define __LINUX_LIBATA_H__
28
29#include <linux/delay.h>
30#include <linux/jiffies.h>
31#include <linux/interrupt.h>
32#include <linux/dma-mapping.h>
33#include <linux/scatterlist.h>
34#include <linux/io.h>
35#include <linux/ata.h>
36#include <linux/workqueue.h>
37#include <scsi/scsi_host.h>
38#include <linux/acpi.h>
39#include <linux/cdrom.h>
40#include <linux/sched.h>
41
42/*
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
47#include <asm/libata-portmap.h>
48#else
49#define ATA_PRIMARY_IRQ(dev) 14
50#define ATA_SECONDARY_IRQ(dev) 15
51#endif
52
53/*
54 * compile-time options: to be removed as soon as all the drivers are
55 * converted to the new debugging mechanism
56 */
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 */
61
62
63/* note: prints function name for you */
64#ifdef ATA_DEBUG
65#define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __func__, ## args)
66#ifdef ATA_VERBOSE_DEBUG
67#define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __func__, ## args)
68#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
76#define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __func__, ## args)
77
78#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
88/* 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
120/* defines only for the constants which don't work well as enums */
121#define ATA_TAG_POISON 0xfafbfcfdU
122
123enum {
124 /* various global constants */
125 LIBATA_MAX_PRD = ATA_MAX_PRD / 2,
126 LIBATA_DUMB_MAX_PRD = ATA_MAX_PRD / 4, /* Worst case */
127 ATA_DEF_QUEUE = 1,
128 ATA_MAX_QUEUE = 32,
129 ATA_TAG_INTERNAL = ATA_MAX_QUEUE,
130 ATA_SHORT_PAUSE = 16,
131
132 ATAPI_MAX_DRAIN = 16 << 10,
133
134 ATA_ALL_DEVICES = (1 << ATA_MAX_DEVICES) - 1,
135
136 ATA_SHT_EMULATED = 1,
137 ATA_SHT_THIS_ID = -1,
138
139 /* struct ata_taskfile flags */
140 ATA_TFLAG_LBA48 = (1 << 0), /* enable 48-bit LBA and "HOB" */
141 ATA_TFLAG_ISADDR = (1 << 1), /* enable r/w to nsect/lba regs */
142 ATA_TFLAG_DEVICE = (1 << 2), /* enable r/w to device reg */
143 ATA_TFLAG_WRITE = (1 << 3), /* data dir: host->dev==1 (write) */
144 ATA_TFLAG_LBA = (1 << 4), /* enable LBA */
145 ATA_TFLAG_FUA = (1 << 5), /* enable FUA */
146 ATA_TFLAG_POLLING = (1 << 6), /* set nIEN to 1 and use polling */
147
148 /* struct ata_device stuff */
149 ATA_DFLAG_LBA = (1 << 0), /* device supports LBA */
150 ATA_DFLAG_LBA48 = (1 << 1), /* device supports LBA48 */
151 ATA_DFLAG_CDB_INTR = (1 << 2), /* device asserts INTRQ when ready for CDB */
152 ATA_DFLAG_NCQ = (1 << 3), /* device supports NCQ */
153 ATA_DFLAG_FLUSH_EXT = (1 << 4), /* do FLUSH_EXT instead of FLUSH */
154 ATA_DFLAG_ACPI_PENDING = (1 << 5), /* ACPI resume action pending */
155 ATA_DFLAG_ACPI_FAILED = (1 << 6), /* ACPI on devcfg has failed */
156 ATA_DFLAG_AN = (1 << 7), /* AN configured */
157 ATA_DFLAG_TRUSTED = (1 << 8), /* device supports trusted send/recv */
158 ATA_DFLAG_DMADIR = (1 << 10), /* device requires DMADIR */
159 ATA_DFLAG_CFG_MASK = (1 << 12) - 1,
160
161 ATA_DFLAG_PIO = (1 << 12), /* device limited to PIO mode */
162 ATA_DFLAG_NCQ_OFF = (1 << 13), /* device limited to non-NCQ mode */
163 ATA_DFLAG_SLEEPING = (1 << 15), /* device is sleeping */
164 ATA_DFLAG_DUBIOUS_XFER = (1 << 16), /* data transfer not verified */
165 ATA_DFLAG_NO_UNLOAD = (1 << 17), /* device doesn't support unload */
166 ATA_DFLAG_UNLOCK_HPA = (1 << 18), /* unlock HPA */
167 ATA_DFLAG_NCQ_SEND_RECV = (1 << 19), /* device supports NCQ SEND and RECV */
168 ATA_DFLAG_NCQ_PRIO = (1 << 20), /* device supports NCQ priority */
169 ATA_DFLAG_NCQ_PRIO_ENABLE = (1 << 21), /* Priority cmds sent to dev */
170 ATA_DFLAG_INIT_MASK = (1 << 24) - 1,
171
172 ATA_DFLAG_DETACH = (1 << 24),
173 ATA_DFLAG_DETACHED = (1 << 25),
174
175 ATA_DFLAG_DA = (1 << 26), /* device supports Device Attention */
176 ATA_DFLAG_DEVSLP = (1 << 27), /* device supports Device Sleep */
177 ATA_DFLAG_ACPI_DISABLED = (1 << 28), /* ACPI for the device is disabled */
178 ATA_DFLAG_D_SENSE = (1 << 29), /* Descriptor sense requested */
179 ATA_DFLAG_ZAC = (1 << 30), /* ZAC device */
180
181 ATA_DEV_UNKNOWN = 0, /* unknown device */
182 ATA_DEV_ATA = 1, /* ATA device */
183 ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */
184 ATA_DEV_ATAPI = 3, /* ATAPI device */
185 ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */
186 ATA_DEV_PMP = 5, /* SATA port multiplier */
187 ATA_DEV_PMP_UNSUP = 6, /* SATA port multiplier (unsupported) */
188 ATA_DEV_SEMB = 7, /* SEMB */
189 ATA_DEV_SEMB_UNSUP = 8, /* SEMB (unsupported) */
190 ATA_DEV_ZAC = 9, /* ZAC device */
191 ATA_DEV_ZAC_UNSUP = 10, /* ZAC device (unsupported) */
192 ATA_DEV_NONE = 11, /* no device */
193
194 /* struct ata_link flags */
195 ATA_LFLAG_NO_HRST = (1 << 1), /* avoid hardreset */
196 ATA_LFLAG_NO_SRST = (1 << 2), /* avoid softreset */
197 ATA_LFLAG_ASSUME_ATA = (1 << 3), /* assume ATA class */
198 ATA_LFLAG_ASSUME_SEMB = (1 << 4), /* assume SEMB class */
199 ATA_LFLAG_ASSUME_CLASS = ATA_LFLAG_ASSUME_ATA | ATA_LFLAG_ASSUME_SEMB,
200 ATA_LFLAG_NO_RETRY = (1 << 5), /* don't retry this link */
201 ATA_LFLAG_DISABLED = (1 << 6), /* link is disabled */
202 ATA_LFLAG_SW_ACTIVITY = (1 << 7), /* keep activity stats */
203 ATA_LFLAG_NO_LPM = (1 << 8), /* disable LPM on this link */
204 ATA_LFLAG_RST_ONCE = (1 << 9), /* limit recovery to one reset */
205 ATA_LFLAG_CHANGED = (1 << 10), /* LPM state changed on this link */
206 ATA_LFLAG_NO_DB_DELAY = (1 << 11), /* no debounce delay on link resume */
207
208 /* struct ata_port flags */
209 ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */
210 /* (doesn't imply presence) */
211 ATA_FLAG_SATA = (1 << 1),
212 ATA_FLAG_NO_LPM = (1 << 2), /* host not happy with LPM */
213 ATA_FLAG_NO_LOG_PAGE = (1 << 5), /* do not issue log page read */
214 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 */
217 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 */
220 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 */
222 ATA_FLAG_DEBUGMSG = (1 << 13),
223 ATA_FLAG_FPDMA_AA = (1 << 14), /* driver supports Auto-Activate */
224 ATA_FLAG_IGN_SIMPLEX = (1 << 15), /* ignore SIMPLEX */
225 ATA_FLAG_NO_IORDY = (1 << 16), /* controller lacks iordy */
226 ATA_FLAG_ACPI_SATA = (1 << 17), /* need native SATA ACPI layout */
227 ATA_FLAG_AN = (1 << 18), /* controller supports AN */
228 ATA_FLAG_PMP = (1 << 19), /* controller supports PMP */
229 ATA_FLAG_FPDMA_AUX = (1 << 20), /* controller supports H2DFIS aux field */
230 ATA_FLAG_EM = (1 << 21), /* driver supports enclosure
231 * management */
232 ATA_FLAG_SW_ACTIVITY = (1 << 22), /* driver supports sw activity
233 * led */
234 ATA_FLAG_NO_DIPM = (1 << 23), /* host not happy with DIPM */
235 ATA_FLAG_SAS_HOST = (1 << 24), /* SAS host */
236
237 /* bits 24:31 of ap->flags are reserved for LLD specific flags */
238
239
240 /* 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 */
246 ATA_PFLAG_SCSI_HOTPLUG = (1 << 6), /* SCSI hotplug scheduled */
247 ATA_PFLAG_INITIALIZING = (1 << 7), /* being initialized, don't touch */
248 ATA_PFLAG_RESETTING = (1 << 8), /* reset in progress */
249 ATA_PFLAG_UNLOADING = (1 << 9), /* driver is being unloaded */
250 ATA_PFLAG_UNLOADED = (1 << 10), /* driver is unloaded */
251
252 ATA_PFLAG_SUSPENDED = (1 << 17), /* port is suspended (power) */
253 ATA_PFLAG_PM_PENDING = (1 << 18), /* PM operation pending */
254 ATA_PFLAG_INIT_GTM_VALID = (1 << 19), /* initial gtm data valid */
255
256 ATA_PFLAG_PIO32 = (1 << 20), /* 32bit PIO */
257 ATA_PFLAG_PIO32CHANGE = (1 << 21), /* 32bit PIO can be turned on/off */
258 ATA_PFLAG_EXTERNAL = (1 << 22), /* eSATA/external port */
259
260 /* struct ata_queued_cmd flags */
261 ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */
262 ATA_QCFLAG_DMAMAP = (1 << 1), /* SG table is DMA mapped */
263 ATA_QCFLAG_IO = (1 << 3), /* standard IO command */
264 ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */
265 ATA_QCFLAG_CLEAR_EXCL = (1 << 5), /* clear excl_link on completion */
266 ATA_QCFLAG_QUIET = (1 << 6), /* don't report device error */
267 ATA_QCFLAG_RETRY = (1 << 7), /* retry after failure */
268
269 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) */
272
273 /* host set flags */
274 ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host only */
275 ATA_HOST_STARTED = (1 << 1), /* Host started */
276 ATA_HOST_PARALLEL_SCAN = (1 << 2), /* Ports on this host can be scanned in parallel */
277 ATA_HOST_IGNORE_ATA = (1 << 3), /* Ignore ATA devices on this host. */
278
279 /* bits 24:31 of host->flags are reserved for LLD specific flags */
280
281 /* various lengths of time */
282 ATA_TMOUT_BOOT = 30000, /* heuristic */
283 ATA_TMOUT_BOOT_QUICK = 7000, /* heuristic */
284 ATA_TMOUT_INTERNAL_QUICK = 5000,
285 ATA_TMOUT_MAX_PARK = 30000,
286
287 /*
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.
291 */
292 ATA_TMOUT_FF_WAIT_LONG = 2000,
293 ATA_TMOUT_FF_WAIT = 800,
294
295 /* 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 */
305 ATA_WAIT_AFTER_RESET = 150,
306
307 /* 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 */
312 ATA_TMOUT_PMP_SRST_WAIT = 5000,
313
314 /* 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
320 /* 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
338 * unsigned long bitmap
339 */
340 ATA_NR_PIO_MODES = 7,
341 ATA_NR_MWDMA_MODES = 5,
342 ATA_NR_UDMA_MODES = 8,
343
344 ATA_SHIFT_PIO = 0,
345 ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_NR_PIO_MODES,
346 ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_NR_MWDMA_MODES,
347 ATA_SHIFT_PRIO = 6,
348
349 ATA_PRIO_HIGH = 2,
350 /* size of buffer to pad xfers ending on unaligned boundaries */
351 ATA_DMA_PAD_SZ = 4,
352
353 /* ering size */
354 ATA_ERING_SIZE = 32,
355
356 /* return values for ->qc_defer */
357 ATA_DEFER_LINK = 1,
358 ATA_DEFER_PORT = 2,
359
360 /* desc_len for ata_eh_info and context */
361 ATA_EH_DESC_LEN = 80,
362
363 /* reset / recovery action types */
364 ATA_EH_REVALIDATE = (1 << 0),
365 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,
368 ATA_EH_ENABLE_LINK = (1 << 3),
369 ATA_EH_PARK = (1 << 5), /* unload heads and stop I/O */
370
371 ATA_EH_PERDEV_MASK = ATA_EH_REVALIDATE | ATA_EH_PARK,
372 ATA_EH_ALL_ACTIONS = ATA_EH_REVALIDATE | ATA_EH_RESET |
373 ATA_EH_ENABLE_LINK,
374
375 /* ata_eh_info->flags */
376 ATA_EHI_HOTPLUGGED = (1 << 0), /* could have been hotplugged */
377 ATA_EHI_NO_AUTOPSY = (1 << 2), /* no autopsy */
378 ATA_EHI_QUIET = (1 << 3), /* be quiet */
379 ATA_EHI_NO_RECOVERY = (1 << 4), /* no recovery */
380
381 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 */
385 ATA_EHI_POST_SETMODE = (1 << 20), /* revalidating after setmode */
386
387 ATA_EHI_DID_RESET = ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
388
389 /* mask of flags to transfer *to* the slave link */
390 ATA_EHI_TO_SLAVE_MASK = ATA_EHI_NO_AUTOPSY | ATA_EHI_QUIET,
391
392 /* max tries if error condition is still set after ->error_handler */
393 ATA_EH_MAX_TRIES = 5,
394
395 /* sometimes resuming a link requires several retries */
396 ATA_LINK_RESUME_TRIES = 5,
397
398 /* how hard are we gonna try to probe/recover devices */
399 ATA_PROBE_MAX_TRIES = 3,
400 ATA_EH_DEV_TRIES = 3,
401 ATA_EH_PMP_TRIES = 5,
402 ATA_EH_PMP_LINK_TRIES = 3,
403
404 SATA_PMP_RW_TIMEOUT = 3000, /* PMP read/write timeout */
405
406 /* This should match the actual table size of
407 * ata_eh_cmd_timeout_table in libata-eh.c.
408 */
409 ATA_EH_CMD_TIMEOUT_TABLE_SIZE = 6,
410
411 /* Horkage types. May be set by libata or controller on drives
412 (some horkage may be drive/controller pair dependent */
413
414 ATA_HORKAGE_DIAGNOSTIC = (1 << 0), /* Failed boot diag */
415 ATA_HORKAGE_NODMA = (1 << 1), /* DMA problems */
416 ATA_HORKAGE_NONCQ = (1 << 2), /* Don't use NCQ */
417 ATA_HORKAGE_MAX_SEC_128 = (1 << 3), /* Limit max sects to 128 */
418 ATA_HORKAGE_BROKEN_HPA = (1 << 4), /* Broken HPA */
419 ATA_HORKAGE_DISABLE = (1 << 5), /* Disable it */
420 ATA_HORKAGE_HPA_SIZE = (1 << 6), /* native size off by one */
421 ATA_HORKAGE_IVB = (1 << 8), /* cbl det validity bit bugs */
422 ATA_HORKAGE_STUCK_ERR = (1 << 9), /* stuck ERR on next PACKET */
423 ATA_HORKAGE_BRIDGE_OK = (1 << 10), /* no bridge limits */
424 ATA_HORKAGE_ATAPI_MOD16_DMA = (1 << 11), /* use ATAPI DMA for commands
425 not multiple of 16 bytes */
426 ATA_HORKAGE_FIRMWARE_WARN = (1 << 12), /* firmware update warning */
427 ATA_HORKAGE_1_5_GBPS = (1 << 13), /* force 1.5 Gbps */
428 ATA_HORKAGE_NOSETXFER = (1 << 14), /* skip SETXFER, SATA only */
429 ATA_HORKAGE_BROKEN_FPDMA_AA = (1 << 15), /* skip AA */
430 ATA_HORKAGE_DUMP_ID = (1 << 16), /* dump IDENTIFY data */
431 ATA_HORKAGE_MAX_SEC_LBA48 = (1 << 17), /* Set max sects to 65535 */
432 ATA_HORKAGE_ATAPI_DMADIR = (1 << 18), /* device requires dmadir */
433 ATA_HORKAGE_NO_NCQ_TRIM = (1 << 19), /* don't use queued TRIM */
434 ATA_HORKAGE_NOLPM = (1 << 20), /* don't use LPM */
435 ATA_HORKAGE_WD_BROKEN_LPM = (1 << 21), /* some WDs have broken LPM */
436 ATA_HORKAGE_ZERO_AFTER_TRIM = (1 << 22),/* guarantees zero after trim */
437 ATA_HORKAGE_NO_DMA_LOG = (1 << 23), /* don't use DMA for log read */
438 ATA_HORKAGE_NOTRIM = (1 << 24), /* don't use TRIM */
439 ATA_HORKAGE_MAX_SEC_1024 = (1 << 25), /* Limit max sects to 1024 */
440
441 /* DMA mask for user DMA control: User visible values; DO NOT
442 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 */
446
447 /* ATAPI command types */
448 ATAPI_READ = 0, /* READs */
449 ATAPI_WRITE = 1, /* WRITEs */
450 ATAPI_READ_CD = 2, /* READ CD [MSF] */
451 ATAPI_PASS_THRU = 3, /* SAT pass-thru */
452 ATAPI_MISC = 4, /* the rest */
453
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),
463 ATA_TIMING_DMACK_HOLD = (1 << 6),
464 ATA_TIMING_CYCLE = (1 << 7),
465 ATA_TIMING_UDMA = (1 << 8),
466 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
467 ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
468 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
469 ATA_TIMING_DMACK_HOLD | ATA_TIMING_CYCLE |
470 ATA_TIMING_UDMA,
471
472 /* ACPI constants */
473 ATA_ACPI_FILTER_SETXFER = 1 << 0,
474 ATA_ACPI_FILTER_LOCK = 1 << 1,
475 ATA_ACPI_FILTER_DIPM = 1 << 2,
476 ATA_ACPI_FILTER_FPDMA_OFFSET = 1 << 3, /* FPDMA non-zero offset */
477 ATA_ACPI_FILTER_FPDMA_AA = 1 << 4, /* FPDMA auto activate */
478
479 ATA_ACPI_FILTER_DEFAULT = ATA_ACPI_FILTER_SETXFER |
480 ATA_ACPI_FILTER_LOCK |
481 ATA_ACPI_FILTER_DIPM,
482};
483
484enum 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
493enum hsm_task_states {
494 HSM_ST_IDLE, /* no command on going */
495 HSM_ST_FIRST, /* (waiting the device to)
496 write CDB or first data block */
497 HSM_ST, /* (waiting the device to) transfer data */
498 HSM_ST_LAST, /* (waiting the device to) complete command */
499 HSM_ST_ERR, /* error */
500};
501
502enum ata_completion_errors {
503 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 */
512 AC_ERR_NODEV_HINT = (1 << 9), /* polling device detection hint */
513 AC_ERR_NCQ = (1 << 10), /* marker for offending NCQ qc */
514};
515
516/*
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_MED_POWER_WITH_DIPM, /* Med power + DIPM as win IRST does */
525 ATA_LPM_MIN_POWER_WITH_PARTIAL, /* Min Power + partial and slumber */
526 ATA_LPM_MIN_POWER, /* Min power + no partial (slumber only) */
527};
528
529enum ata_lpm_hints {
530 ATA_LPM_EMPTY = (1 << 0), /* port empty/probing */
531 ATA_LPM_HIPM = (1 << 1), /* may use HIPM */
532 ATA_LPM_WAKE_ONLY = (1 << 2), /* only wake up link */
533};
534
535/* forward declarations */
536struct scsi_device;
537struct ata_port_operations;
538struct ata_port;
539struct ata_link;
540struct ata_queued_cmd;
541
542/* typedefs */
543typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
544typedef int (*ata_prereset_fn_t)(struct ata_link *link, unsigned long deadline);
545typedef int (*ata_reset_fn_t)(struct ata_link *link, unsigned int *classes,
546 unsigned long deadline);
547typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes);
548
549extern struct device_attribute dev_attr_link_power_management_policy;
550extern struct device_attribute dev_attr_unload_heads;
551extern struct device_attribute dev_attr_ncq_prio_enable;
552extern struct device_attribute dev_attr_em_message_type;
553extern struct device_attribute dev_attr_em_message;
554extern struct device_attribute dev_attr_sw_activity;
555
556enum sw_activity {
557 OFF,
558 BLINK_ON,
559 BLINK_OFF,
560};
561
562struct ata_taskfile {
563 unsigned long flags; /* ATA_TFLAG_xxx */
564 u8 protocol; /* ATA_PROT_xxx */
565
566 u8 ctl; /* control reg */
567
568 u8 hob_feature; /* additional data */
569 u8 hob_nsect; /* to support LBA48 */
570 u8 hob_lbal;
571 u8 hob_lbam;
572 u8 hob_lbah;
573
574 u8 feature;
575 u8 nsect;
576 u8 lbal;
577 u8 lbam;
578 u8 lbah;
579
580 u8 device;
581
582 u8 command; /* IO operation */
583
584 u32 auxiliary; /* auxiliary field */
585 /* from SATA 3.1 and */
586 /* ATA-8 ACS-3 */
587};
588
589#ifdef CONFIG_ATA_SFF
590struct ata_ioports {
591 void __iomem *cmd_addr;
592 void __iomem *data_addr;
593 void __iomem *error_addr;
594 void __iomem *feature_addr;
595 void __iomem *nsect_addr;
596 void __iomem *lbal_addr;
597 void __iomem *lbam_addr;
598 void __iomem *lbah_addr;
599 void __iomem *device_addr;
600 void __iomem *status_addr;
601 void __iomem *command_addr;
602 void __iomem *altstatus_addr;
603 void __iomem *ctl_addr;
604#ifdef CONFIG_ATA_BMDMA
605 void __iomem *bmdma_addr;
606#endif /* CONFIG_ATA_BMDMA */
607 void __iomem *scr_addr;
608};
609#endif /* CONFIG_ATA_SFF */
610
611struct ata_host {
612 spinlock_t lock;
613 struct device *dev;
614 void __iomem * const *iomap;
615 unsigned int n_ports;
616 unsigned int n_tags; /* nr of NCQ tags */
617 void *private_data;
618 struct ata_port_operations *ops;
619 unsigned long flags;
620 struct kref kref;
621
622 struct mutex eh_mutex;
623 struct task_struct *eh_owner;
624
625 struct ata_port *simplex_claimed; /* channel owning the DMA */
626 struct ata_port *ports[0];
627};
628
629struct ata_queued_cmd {
630 struct ata_port *ap;
631 struct ata_device *dev;
632
633 struct scsi_cmnd *scsicmd;
634 void (*scsidone)(struct scsi_cmnd *);
635
636 struct ata_taskfile tf;
637 u8 cdb[ATAPI_CDB_LEN];
638
639 unsigned long flags; /* ATA_QCFLAG_xxx */
640 unsigned int tag; /* libata core tag */
641 unsigned int hw_tag; /* driver tag */
642 unsigned int n_elem;
643 unsigned int orig_n_elem;
644
645 int dma_dir;
646
647 unsigned int sect_size;
648
649 unsigned int nbytes;
650 unsigned int extrabytes;
651 unsigned int curbytes;
652
653 struct scatterlist sgent;
654
655 struct scatterlist *sg;
656
657 struct scatterlist *cursg;
658 unsigned int cursg_ofs;
659
660 unsigned int err_mask;
661 struct ata_taskfile result_tf;
662 ata_qc_cb_t complete_fn;
663
664 void *private_data;
665 void *lldd_task;
666};
667
668struct ata_port_stats {
669 unsigned long unhandled_irq;
670 unsigned long idle_irq;
671 unsigned long rw_reqbuf;
672};
673
674struct ata_ering_entry {
675 unsigned int eflags;
676 unsigned int err_mask;
677 u64 timestamp;
678};
679
680struct ata_ering {
681 int cursor;
682 struct ata_ering_entry ring[ATA_ERING_SIZE];
683};
684
685struct ata_device {
686 struct ata_link *link;
687 unsigned int devno; /* 0 or 1 */
688 unsigned int horkage; /* List of broken features */
689 unsigned long flags; /* ATA_DFLAG_xxx */
690 struct scsi_device *sdev; /* attached SCSI device */
691 void *private_data;
692#ifdef CONFIG_ATA_ACPI
693 union acpi_object *gtf_cache;
694 unsigned int gtf_filter;
695#endif
696#ifdef CONFIG_SATA_ZPODD
697 void *zpodd;
698#endif
699 struct device tdev;
700 /* n_sector is CLEAR_BEGIN, read comment above CLEAR_BEGIN */
701 u64 n_sectors; /* size of device, if ATA */
702 u64 n_native_sectors; /* native size, if ATA */
703 unsigned int class; /* ATA_DEV_xxx */
704 unsigned long unpark_deadline;
705
706 u8 pio_mode;
707 u8 dma_mode;
708 u8 xfer_mode;
709 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
710
711 unsigned int multi_count; /* sectors count for
712 READ/WRITE MULTIPLE */
713 unsigned int max_sectors; /* per-device max sectors */
714 unsigned int cdb_len;
715
716 /* per-dev xfer mask */
717 unsigned long pio_mask;
718 unsigned long mwdma_mask;
719 unsigned long udma_mask;
720
721 /* for CHS addressing */
722 u16 cylinders; /* Number of cylinders */
723 u16 heads; /* Number of heads */
724 u16 sectors; /* Number of sectors per track */
725
726 union {
727 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
728 u32 gscr[SATA_PMP_GSCR_DWORDS]; /* PMP GSCR block */
729 } ____cacheline_aligned;
730
731 /* DEVSLP Timing Variables from Identify Device Data Log */
732 u8 devslp_timing[ATA_LOG_DEVSLP_SIZE];
733
734 /* NCQ send and receive log subcommand support */
735 u8 ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_SIZE];
736 u8 ncq_non_data_cmds[ATA_LOG_NCQ_NON_DATA_SIZE];
737
738 /* ZAC zone configuration */
739 u32 zac_zoned_cap;
740 u32 zac_zones_optimal_open;
741 u32 zac_zones_optimal_nonseq;
742 u32 zac_zones_max_open;
743
744 /* error history */
745 int spdn_cnt;
746 /* ering is CLEAR_END, read comment above CLEAR_END */
747 struct ata_ering ering;
748};
749
750/* Fields between ATA_DEVICE_CLEAR_BEGIN and ATA_DEVICE_CLEAR_END are
751 * cleared to zero on ata_dev_init().
752 */
753#define ATA_DEVICE_CLEAR_BEGIN offsetof(struct ata_device, n_sectors)
754#define ATA_DEVICE_CLEAR_END offsetof(struct ata_device, ering)
755
756struct ata_eh_info {
757 struct ata_device *dev; /* offending device */
758 u32 serror; /* SError from LLDD */
759 unsigned int err_mask; /* port-wide err_mask */
760 unsigned int action; /* ATA_EH_* action mask */
761 unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */
762 unsigned int flags; /* ATA_EHI_* flags */
763
764 unsigned int probe_mask;
765
766 char desc[ATA_EH_DESC_LEN];
767 int desc_len;
768};
769
770struct ata_eh_context {
771 struct ata_eh_info i;
772 int tries[ATA_MAX_DEVICES];
773 int cmd_timeout_idx[ATA_MAX_DEVICES]
774 [ATA_EH_CMD_TIMEOUT_TABLE_SIZE];
775 unsigned int classes[ATA_MAX_DEVICES];
776 unsigned int did_probe_mask;
777 unsigned int unloaded_mask;
778 unsigned int saved_ncq_enabled;
779 u8 saved_xfer_mode[ATA_MAX_DEVICES];
780 /* timestamp for the last reset attempt or success */
781 unsigned long last_reset;
782};
783
784struct ata_acpi_drive
785{
786 u32 pio;
787 u32 dma;
788} __packed;
789
790struct ata_acpi_gtm {
791 struct ata_acpi_drive drive[2];
792 u32 flags;
793} __packed;
794
795struct ata_link {
796 struct ata_port *ap;
797 int pmp; /* port multiplier port # */
798
799 struct device tdev;
800 unsigned int active_tag; /* active tag on this link */
801 u32 sactive; /* active NCQ commands */
802
803 unsigned int flags; /* ATA_LFLAG_xxx */
804
805 u32 saved_scontrol; /* SControl on probe */
806 unsigned int hw_sata_spd_limit;
807 unsigned int sata_spd_limit;
808 unsigned int sata_spd; /* current SATA PHY speed */
809 enum ata_lpm_policy lpm_policy;
810
811 /* record runtime error info, protected by host_set lock */
812 struct ata_eh_info eh_info;
813 /* EH context */
814 struct ata_eh_context eh_context;
815
816 struct ata_device device[ATA_MAX_DEVICES];
817
818 unsigned long last_lpm_change; /* when last LPM change happened */
819};
820#define ATA_LINK_CLEAR_BEGIN offsetof(struct ata_link, active_tag)
821#define ATA_LINK_CLEAR_END offsetof(struct ata_link, device[0])
822
823struct ata_port {
824 struct Scsi_Host *scsi_host; /* our co-allocated scsi host */
825 struct ata_port_operations *ops;
826 spinlock_t *lock;
827 /* Flags owned by the EH context. Only EH should touch these once the
828 port is active */
829 unsigned long flags; /* ATA_FLAG_xxx */
830 /* Flags that change dynamically, protected by ap->lock */
831 unsigned int pflags; /* ATA_PFLAG_xxx */
832 unsigned int print_id; /* user visible unique port ID */
833 unsigned int local_port_no; /* host local port num */
834 unsigned int port_no; /* 0 based port no. inside the host */
835
836#ifdef CONFIG_ATA_SFF
837 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
838 u8 ctl; /* cache of ATA control register */
839 u8 last_ctl; /* Cache last written value */
840 struct ata_link* sff_pio_task_link; /* link currently used */
841 struct delayed_work sff_pio_task;
842#ifdef CONFIG_ATA_BMDMA
843 struct ata_bmdma_prd *bmdma_prd; /* BMDMA SG list */
844 dma_addr_t bmdma_prd_dma; /* and its DMA mapping */
845#endif /* CONFIG_ATA_BMDMA */
846#endif /* CONFIG_ATA_SFF */
847
848 unsigned int pio_mask;
849 unsigned int mwdma_mask;
850 unsigned int udma_mask;
851 unsigned int cbl; /* cable type; ATA_CBL_xxx */
852
853 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE + 1];
854 unsigned long sas_tag_allocated; /* for sas tag allocation only */
855 u64 qc_active;
856 int nr_active_links; /* #links with active qcs */
857 unsigned int sas_last_tag; /* track next tag hw expects */
858
859 struct ata_link link; /* host default link */
860 struct ata_link *slave_link; /* see ata_slave_link_init() */
861
862 int nr_pmp_links; /* nr of available PMP links */
863 struct ata_link *pmp_link; /* array of PMP links */
864 struct ata_link *excl_link; /* for PMP qc exclusion */
865
866 struct ata_port_stats stats;
867 struct ata_host *host;
868 struct device *dev;
869 struct device tdev;
870
871 struct mutex scsi_scan_mutex;
872 struct delayed_work hotplug_task;
873 struct work_struct scsi_rescan_task;
874
875 unsigned int hsm_task_state;
876
877 u32 msg_enable;
878 struct list_head eh_done_q;
879 wait_queue_head_t eh_wait_q;
880 int eh_tries;
881 struct completion park_req_pending;
882
883 pm_message_t pm_mesg;
884 enum ata_lpm_policy target_lpm_policy;
885
886 struct timer_list fastdrain_timer;
887 unsigned long fastdrain_cnt;
888
889 int em_message_type;
890 void *private_data;
891
892#ifdef CONFIG_ATA_ACPI
893 struct ata_acpi_gtm __acpi_init_gtm; /* use ata_acpi_init_gtm() */
894#endif
895 /* owned by EH */
896 u8 sector_buf[ATA_SECT_SIZE] ____cacheline_aligned;
897};
898
899/* The following initializer overrides a method to NULL whether one of
900 * its parent has the method defined or not. This is equivalent to
901 * ERR_PTR(-ENOENT). Unfortunately, ERR_PTR doesn't render a constant
902 * expression and thus can't be used as an initializer.
903 */
904#define ATA_OP_NULL (void *)(unsigned long)(-ENOENT)
905
906struct ata_port_operations {
907 /*
908 * Command execution
909 */
910 int (*qc_defer)(struct ata_queued_cmd *qc);
911 int (*check_atapi_dma)(struct ata_queued_cmd *qc);
912 void (*qc_prep)(struct ata_queued_cmd *qc);
913 unsigned int (*qc_issue)(struct ata_queued_cmd *qc);
914 bool (*qc_fill_rtf)(struct ata_queued_cmd *qc);
915
916 /*
917 * Configuration and exception handling
918 */
919 int (*cable_detect)(struct ata_port *ap);
920 unsigned long (*mode_filter)(struct ata_device *dev, unsigned long xfer_mask);
921 void (*set_piomode)(struct ata_port *ap, struct ata_device *dev);
922 void (*set_dmamode)(struct ata_port *ap, struct ata_device *dev);
923 int (*set_mode)(struct ata_link *link, struct ata_device **r_failed_dev);
924 unsigned int (*read_id)(struct ata_device *dev, struct ata_taskfile *tf, u16 *id);
925
926 void (*dev_config)(struct ata_device *dev);
927
928 void (*freeze)(struct ata_port *ap);
929 void (*thaw)(struct ata_port *ap);
930 ata_prereset_fn_t prereset;
931 ata_reset_fn_t softreset;
932 ata_reset_fn_t hardreset;
933 ata_postreset_fn_t postreset;
934 ata_prereset_fn_t pmp_prereset;
935 ata_reset_fn_t pmp_softreset;
936 ata_reset_fn_t pmp_hardreset;
937 ata_postreset_fn_t pmp_postreset;
938 void (*error_handler)(struct ata_port *ap);
939 void (*lost_interrupt)(struct ata_port *ap);
940 void (*post_internal_cmd)(struct ata_queued_cmd *qc);
941 void (*sched_eh)(struct ata_port *ap);
942 void (*end_eh)(struct ata_port *ap);
943
944 /*
945 * Optional features
946 */
947 int (*scr_read)(struct ata_link *link, unsigned int sc_reg, u32 *val);
948 int (*scr_write)(struct ata_link *link, unsigned int sc_reg, u32 val);
949 void (*pmp_attach)(struct ata_port *ap);
950 void (*pmp_detach)(struct ata_port *ap);
951 int (*set_lpm)(struct ata_link *link, enum ata_lpm_policy policy,
952 unsigned hints);
953
954 /*
955 * Start, stop, suspend and resume
956 */
957 int (*port_suspend)(struct ata_port *ap, pm_message_t mesg);
958 int (*port_resume)(struct ata_port *ap);
959 int (*port_start)(struct ata_port *ap);
960 void (*port_stop)(struct ata_port *ap);
961 void (*host_stop)(struct ata_host *host);
962
963#ifdef CONFIG_ATA_SFF
964 /*
965 * SFF / taskfile oriented ops
966 */
967 void (*sff_dev_select)(struct ata_port *ap, unsigned int device);
968 void (*sff_set_devctl)(struct ata_port *ap, u8 ctl);
969 u8 (*sff_check_status)(struct ata_port *ap);
970 u8 (*sff_check_altstatus)(struct ata_port *ap);
971 void (*sff_tf_load)(struct ata_port *ap, const struct ata_taskfile *tf);
972 void (*sff_tf_read)(struct ata_port *ap, struct ata_taskfile *tf);
973 void (*sff_exec_command)(struct ata_port *ap,
974 const struct ata_taskfile *tf);
975 unsigned int (*sff_data_xfer)(struct ata_queued_cmd *qc,
976 unsigned char *buf, unsigned int buflen, int rw);
977 void (*sff_irq_on)(struct ata_port *);
978 bool (*sff_irq_check)(struct ata_port *);
979 void (*sff_irq_clear)(struct ata_port *);
980 void (*sff_drain_fifo)(struct ata_queued_cmd *qc);
981
982#ifdef CONFIG_ATA_BMDMA
983 void (*bmdma_setup)(struct ata_queued_cmd *qc);
984 void (*bmdma_start)(struct ata_queued_cmd *qc);
985 void (*bmdma_stop)(struct ata_queued_cmd *qc);
986 u8 (*bmdma_status)(struct ata_port *ap);
987#endif /* CONFIG_ATA_BMDMA */
988#endif /* CONFIG_ATA_SFF */
989
990 ssize_t (*em_show)(struct ata_port *ap, char *buf);
991 ssize_t (*em_store)(struct ata_port *ap, const char *message,
992 size_t size);
993 ssize_t (*sw_activity_show)(struct ata_device *dev, char *buf);
994 ssize_t (*sw_activity_store)(struct ata_device *dev,
995 enum sw_activity val);
996 ssize_t (*transmit_led_message)(struct ata_port *ap, u32 state,
997 ssize_t size);
998
999 /*
1000 * Obsolete
1001 */
1002 void (*phy_reset)(struct ata_port *ap);
1003 void (*eng_timeout)(struct ata_port *ap);
1004
1005 /*
1006 * ->inherits must be the last field and all the preceding
1007 * fields must be pointers.
1008 */
1009 const struct ata_port_operations *inherits;
1010};
1011
1012struct ata_port_info {
1013 unsigned long flags;
1014 unsigned long link_flags;
1015 unsigned long pio_mask;
1016 unsigned long mwdma_mask;
1017 unsigned long udma_mask;
1018 struct ata_port_operations *port_ops;
1019 void *private_data;
1020};
1021
1022struct ata_timing {
1023 unsigned short mode; /* ATA mode */
1024 unsigned short setup; /* t1 */
1025 unsigned short act8b; /* t2 for 8-bit I/O */
1026 unsigned short rec8b; /* t2i for 8-bit I/O */
1027 unsigned short cyc8b; /* t0 for 8-bit I/O */
1028 unsigned short active; /* t2 or tD */
1029 unsigned short recover; /* t2i or tK */
1030 unsigned short dmack_hold; /* tj */
1031 unsigned short cycle; /* t0 */
1032 unsigned short udma; /* t2CYCTYP/2 */
1033};
1034
1035/*
1036 * Core layer - drivers/ata/libata-core.c
1037 */
1038extern const unsigned long sata_deb_timing_normal[];
1039extern const unsigned long sata_deb_timing_hotplug[];
1040extern const unsigned long sata_deb_timing_long[];
1041
1042extern struct ata_port_operations ata_dummy_port_ops;
1043extern const struct ata_port_info ata_dummy_port_info;
1044
1045static inline bool ata_is_atapi(u8 prot)
1046{
1047 return prot & ATA_PROT_FLAG_ATAPI;
1048}
1049
1050static inline bool ata_is_pio(u8 prot)
1051{
1052 return prot & ATA_PROT_FLAG_PIO;
1053}
1054
1055static inline bool ata_is_dma(u8 prot)
1056{
1057 return prot & ATA_PROT_FLAG_DMA;
1058}
1059
1060static inline bool ata_is_ncq(u8 prot)
1061{
1062 return prot & ATA_PROT_FLAG_NCQ;
1063}
1064
1065static inline bool ata_is_data(u8 prot)
1066{
1067 return prot & (ATA_PROT_FLAG_PIO | ATA_PROT_FLAG_DMA);
1068}
1069
1070static inline int is_multi_taskfile(struct ata_taskfile *tf)
1071{
1072 return (tf->command == ATA_CMD_READ_MULTI) ||
1073 (tf->command == ATA_CMD_WRITE_MULTI) ||
1074 (tf->command == ATA_CMD_READ_MULTI_EXT) ||
1075 (tf->command == ATA_CMD_WRITE_MULTI_EXT) ||
1076 (tf->command == ATA_CMD_WRITE_MULTI_FUA_EXT);
1077}
1078
1079static inline const unsigned long *
1080sata_ehc_deb_timing(struct ata_eh_context *ehc)
1081{
1082 if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
1083 return sata_deb_timing_hotplug;
1084 else
1085 return sata_deb_timing_normal;
1086}
1087
1088static inline int ata_port_is_dummy(struct ata_port *ap)
1089{
1090 return ap->ops == &ata_dummy_port_ops;
1091}
1092
1093extern int sata_set_spd(struct ata_link *link);
1094extern int ata_std_prereset(struct ata_link *link, unsigned long deadline);
1095extern int ata_wait_after_reset(struct ata_link *link, unsigned long deadline,
1096 int (*check_ready)(struct ata_link *link));
1097extern int sata_link_debounce(struct ata_link *link,
1098 const unsigned long *params, unsigned long deadline);
1099extern int sata_link_resume(struct ata_link *link, const unsigned long *params,
1100 unsigned long deadline);
1101extern int sata_link_scr_lpm(struct ata_link *link, enum ata_lpm_policy policy,
1102 bool spm_wakeup);
1103extern int sata_link_hardreset(struct ata_link *link,
1104 const unsigned long *timing, unsigned long deadline,
1105 bool *online, int (*check_ready)(struct ata_link *));
1106extern int sata_std_hardreset(struct ata_link *link, unsigned int *class,
1107 unsigned long deadline);
1108extern void ata_std_postreset(struct ata_link *link, unsigned int *classes);
1109
1110extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
1111extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
1112 const struct ata_port_info * const * ppi, int n_ports);
1113extern int ata_slave_link_init(struct ata_port *ap);
1114extern void ata_host_get(struct ata_host *host);
1115extern void ata_host_put(struct ata_host *host);
1116extern int ata_host_start(struct ata_host *host);
1117extern int ata_host_register(struct ata_host *host,
1118 struct scsi_host_template *sht);
1119extern int ata_host_activate(struct ata_host *host, int irq,
1120 irq_handler_t irq_handler, unsigned long irq_flags,
1121 struct scsi_host_template *sht);
1122extern void ata_host_detach(struct ata_host *host);
1123extern void ata_host_init(struct ata_host *, struct device *, struct ata_port_operations *);
1124extern int ata_scsi_detect(struct scsi_host_template *sht);
1125extern int ata_scsi_ioctl(struct scsi_device *dev, unsigned int cmd,
1126 void __user *arg);
1127extern int ata_scsi_queuecmd(struct Scsi_Host *h, struct scsi_cmnd *cmd);
1128extern int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *dev,
1129 unsigned int cmd, void __user *arg);
1130extern void ata_sas_port_destroy(struct ata_port *);
1131extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
1132 struct ata_port_info *, struct Scsi_Host *);
1133extern void ata_sas_async_probe(struct ata_port *ap);
1134extern int ata_sas_sync_probe(struct ata_port *ap);
1135extern int ata_sas_port_init(struct ata_port *);
1136extern int ata_sas_port_start(struct ata_port *ap);
1137extern int ata_sas_tport_add(struct device *parent, struct ata_port *ap);
1138extern void ata_sas_tport_delete(struct ata_port *ap);
1139extern void ata_sas_port_stop(struct ata_port *ap);
1140extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
1141extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, struct ata_port *ap);
1142extern int sata_scr_valid(struct ata_link *link);
1143extern int sata_scr_read(struct ata_link *link, int reg, u32 *val);
1144extern int sata_scr_write(struct ata_link *link, int reg, u32 val);
1145extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val);
1146extern bool ata_link_online(struct ata_link *link);
1147extern bool ata_link_offline(struct ata_link *link);
1148#ifdef CONFIG_PM
1149extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
1150extern void ata_host_resume(struct ata_host *host);
1151extern void ata_sas_port_suspend(struct ata_port *ap);
1152extern void ata_sas_port_resume(struct ata_port *ap);
1153#else
1154static inline void ata_sas_port_suspend(struct ata_port *ap)
1155{
1156}
1157static inline void ata_sas_port_resume(struct ata_port *ap)
1158{
1159}
1160#endif
1161extern int ata_ratelimit(void);
1162extern void ata_msleep(struct ata_port *ap, unsigned int msecs);
1163extern u32 ata_wait_register(struct ata_port *ap, void __iomem *reg, u32 mask,
1164 u32 val, unsigned long interval, unsigned long timeout);
1165extern int atapi_cmd_type(u8 opcode);
1166extern void ata_tf_to_fis(const struct ata_taskfile *tf,
1167 u8 pmp, int is_cmd, u8 *fis);
1168extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
1169extern unsigned long ata_pack_xfermask(unsigned long pio_mask,
1170 unsigned long mwdma_mask, unsigned long udma_mask);
1171extern void ata_unpack_xfermask(unsigned long xfer_mask,
1172 unsigned long *pio_mask, unsigned long *mwdma_mask,
1173 unsigned long *udma_mask);
1174extern u8 ata_xfer_mask2mode(unsigned long xfer_mask);
1175extern unsigned long ata_xfer_mode2mask(u8 xfer_mode);
1176extern int ata_xfer_mode2shift(unsigned long xfer_mode);
1177extern const char *ata_mode_string(unsigned long xfer_mask);
1178extern unsigned long ata_id_xfermask(const u16 *id);
1179extern int ata_std_qc_defer(struct ata_queued_cmd *qc);
1180extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
1181extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
1182 unsigned int n_elem);
1183extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
1184extern void ata_dev_disable(struct ata_device *adev);
1185extern void ata_id_string(const u16 *id, unsigned char *s,
1186 unsigned int ofs, unsigned int len);
1187extern void ata_id_c_string(const u16 *id, unsigned char *s,
1188 unsigned int ofs, unsigned int len);
1189extern unsigned int ata_do_dev_read_id(struct ata_device *dev,
1190 struct ata_taskfile *tf, u16 *id);
1191extern void ata_qc_complete(struct ata_queued_cmd *qc);
1192extern int ata_qc_complete_multiple(struct ata_port *ap, u64 qc_active);
1193extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd);
1194extern int ata_std_bios_param(struct scsi_device *sdev,
1195 struct block_device *bdev,
1196 sector_t capacity, int geom[]);
1197extern void ata_scsi_unlock_native_capacity(struct scsi_device *sdev);
1198extern int ata_scsi_slave_config(struct scsi_device *sdev);
1199extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
1200extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
1201 int queue_depth);
1202extern int __ata_change_queue_depth(struct ata_port *ap, struct scsi_device *sdev,
1203 int queue_depth);
1204extern struct ata_device *ata_dev_pair(struct ata_device *adev);
1205extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
1206extern void ata_scsi_port_error_handler(struct Scsi_Host *host, struct ata_port *ap);
1207extern void ata_scsi_cmd_error_handler(struct Scsi_Host *host, struct ata_port *ap, struct list_head *eh_q);
1208extern bool sata_lpm_ignore_phy_events(struct ata_link *link);
1209
1210extern int ata_cable_40wire(struct ata_port *ap);
1211extern int ata_cable_80wire(struct ata_port *ap);
1212extern int ata_cable_sata(struct ata_port *ap);
1213extern int ata_cable_ignore(struct ata_port *ap);
1214extern int ata_cable_unknown(struct ata_port *ap);
1215
1216/* Timing helpers */
1217extern unsigned int ata_pio_need_iordy(const struct ata_device *);
1218extern const struct ata_timing *ata_timing_find_mode(u8 xfer_mode);
1219extern int ata_timing_compute(struct ata_device *, unsigned short,
1220 struct ata_timing *, int, int);
1221extern void ata_timing_merge(const struct ata_timing *,
1222 const struct ata_timing *, struct ata_timing *,
1223 unsigned int);
1224extern u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle);
1225
1226/* PCI */
1227#ifdef CONFIG_PCI
1228struct pci_dev;
1229
1230struct pci_bits {
1231 unsigned int reg; /* PCI config register to read */
1232 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
1233 unsigned long mask;
1234 unsigned long val;
1235};
1236
1237extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
1238extern void ata_pci_remove_one(struct pci_dev *pdev);
1239
1240#ifdef CONFIG_PM
1241extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
1242extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
1243extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
1244extern int ata_pci_device_resume(struct pci_dev *pdev);
1245#endif /* CONFIG_PM */
1246#endif /* CONFIG_PCI */
1247
1248struct platform_device;
1249
1250extern int ata_platform_remove_one(struct platform_device *pdev);
1251
1252/*
1253 * ACPI - drivers/ata/libata-acpi.c
1254 */
1255#ifdef CONFIG_ATA_ACPI
1256static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1257{
1258 if (ap->pflags & ATA_PFLAG_INIT_GTM_VALID)
1259 return &ap->__acpi_init_gtm;
1260 return NULL;
1261}
1262int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm);
1263int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *stm);
1264unsigned long ata_acpi_gtm_xfermask(struct ata_device *dev,
1265 const struct ata_acpi_gtm *gtm);
1266int ata_acpi_cbl_80wire(struct ata_port *ap, const struct ata_acpi_gtm *gtm);
1267#else
1268static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1269{
1270 return NULL;
1271}
1272
1273static inline int ata_acpi_stm(const struct ata_port *ap,
1274 struct ata_acpi_gtm *stm)
1275{
1276 return -ENOSYS;
1277}
1278
1279static inline int ata_acpi_gtm(const struct ata_port *ap,
1280 struct ata_acpi_gtm *stm)
1281{
1282 return -ENOSYS;
1283}
1284
1285static inline unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev,
1286 const struct ata_acpi_gtm *gtm)
1287{
1288 return 0;
1289}
1290
1291static inline int ata_acpi_cbl_80wire(struct ata_port *ap,
1292 const struct ata_acpi_gtm *gtm)
1293{
1294 return 0;
1295}
1296#endif
1297
1298/*
1299 * EH - drivers/ata/libata-eh.c
1300 */
1301extern void ata_port_schedule_eh(struct ata_port *ap);
1302extern void ata_port_wait_eh(struct ata_port *ap);
1303extern int ata_link_abort(struct ata_link *link);
1304extern int ata_port_abort(struct ata_port *ap);
1305extern int ata_port_freeze(struct ata_port *ap);
1306extern int sata_async_notification(struct ata_port *ap);
1307
1308extern void ata_eh_freeze_port(struct ata_port *ap);
1309extern void ata_eh_thaw_port(struct ata_port *ap);
1310
1311extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
1312extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
1313extern void ata_eh_analyze_ncq_error(struct ata_link *link);
1314
1315extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
1316 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
1317 ata_postreset_fn_t postreset);
1318extern void ata_std_error_handler(struct ata_port *ap);
1319extern void ata_std_sched_eh(struct ata_port *ap);
1320extern void ata_std_end_eh(struct ata_port *ap);
1321extern int ata_link_nr_enabled(struct ata_link *link);
1322
1323/*
1324 * Base operations to inherit from and initializers for sht
1325 *
1326 * Operations
1327 *
1328 * base : Common to all libata drivers.
1329 * sata : SATA controllers w/ native interface.
1330 * pmp : SATA controllers w/ PMP support.
1331 * sff : SFF ATA controllers w/o BMDMA support.
1332 * bmdma : SFF ATA controllers w/ BMDMA support.
1333 *
1334 * sht initializers
1335 *
1336 * BASE : Common to all libata drivers. The user must set
1337 * sg_tablesize and dma_boundary.
1338 * PIO : SFF ATA controllers w/ only PIO support.
1339 * BMDMA : SFF ATA controllers w/ BMDMA support. sg_tablesize and
1340 * dma_boundary are set to BMDMA limits.
1341 * NCQ : SATA controllers supporting NCQ. The user must set
1342 * sg_tablesize, dma_boundary and can_queue.
1343 */
1344extern const struct ata_port_operations ata_base_port_ops;
1345extern const struct ata_port_operations sata_port_ops;
1346extern struct device_attribute *ata_common_sdev_attrs[];
1347
1348/*
1349 * All sht initializers (BASE, PIO, BMDMA, NCQ) must be instantiated
1350 * by the edge drivers. Because the 'module' field of sht must be the
1351 * edge driver's module reference, otherwise the driver can be unloaded
1352 * even if the scsi_device is being accessed.
1353 */
1354#define ATA_BASE_SHT(drv_name) \
1355 .module = THIS_MODULE, \
1356 .name = drv_name, \
1357 .ioctl = ata_scsi_ioctl, \
1358 .queuecommand = ata_scsi_queuecmd, \
1359 .can_queue = ATA_DEF_QUEUE, \
1360 .tag_alloc_policy = BLK_TAG_ALLOC_RR, \
1361 .this_id = ATA_SHT_THIS_ID, \
1362 .emulated = ATA_SHT_EMULATED, \
1363 .proc_name = drv_name, \
1364 .slave_configure = ata_scsi_slave_config, \
1365 .slave_destroy = ata_scsi_slave_destroy, \
1366 .bios_param = ata_std_bios_param, \
1367 .unlock_native_capacity = ata_scsi_unlock_native_capacity, \
1368 .sdev_attrs = ata_common_sdev_attrs
1369
1370#define ATA_NCQ_SHT(drv_name) \
1371 ATA_BASE_SHT(drv_name), \
1372 .change_queue_depth = ata_scsi_change_queue_depth
1373
1374/*
1375 * PMP helpers
1376 */
1377#ifdef CONFIG_SATA_PMP
1378static inline bool sata_pmp_supported(struct ata_port *ap)
1379{
1380 return ap->flags & ATA_FLAG_PMP;
1381}
1382
1383static inline bool sata_pmp_attached(struct ata_port *ap)
1384{
1385 return ap->nr_pmp_links != 0;
1386}
1387
1388static inline bool ata_is_host_link(const struct ata_link *link)
1389{
1390 return link == &link->ap->link || link == link->ap->slave_link;
1391}
1392#else /* CONFIG_SATA_PMP */
1393static inline bool sata_pmp_supported(struct ata_port *ap)
1394{
1395 return false;
1396}
1397
1398static inline bool sata_pmp_attached(struct ata_port *ap)
1399{
1400 return false;
1401}
1402
1403static inline bool ata_is_host_link(const struct ata_link *link)
1404{
1405 return 1;
1406}
1407#endif /* CONFIG_SATA_PMP */
1408
1409static inline int sata_srst_pmp(struct ata_link *link)
1410{
1411 if (sata_pmp_supported(link->ap) && ata_is_host_link(link))
1412 return SATA_PMP_CTRL_PORT;
1413 return link->pmp;
1414}
1415
1416/*
1417 * printk helpers
1418 */
1419__printf(3, 4)
1420void ata_port_printk(const struct ata_port *ap, const char *level,
1421 const char *fmt, ...);
1422__printf(3, 4)
1423void ata_link_printk(const struct ata_link *link, const char *level,
1424 const char *fmt, ...);
1425__printf(3, 4)
1426void ata_dev_printk(const struct ata_device *dev, const char *level,
1427 const char *fmt, ...);
1428
1429#define ata_port_err(ap, fmt, ...) \
1430 ata_port_printk(ap, KERN_ERR, fmt, ##__VA_ARGS__)
1431#define ata_port_warn(ap, fmt, ...) \
1432 ata_port_printk(ap, KERN_WARNING, fmt, ##__VA_ARGS__)
1433#define ata_port_notice(ap, fmt, ...) \
1434 ata_port_printk(ap, KERN_NOTICE, fmt, ##__VA_ARGS__)
1435#define ata_port_info(ap, fmt, ...) \
1436 ata_port_printk(ap, KERN_INFO, fmt, ##__VA_ARGS__)
1437#define ata_port_dbg(ap, fmt, ...) \
1438 ata_port_printk(ap, KERN_DEBUG, fmt, ##__VA_ARGS__)
1439
1440#define ata_link_err(link, fmt, ...) \
1441 ata_link_printk(link, KERN_ERR, fmt, ##__VA_ARGS__)
1442#define ata_link_warn(link, fmt, ...) \
1443 ata_link_printk(link, KERN_WARNING, fmt, ##__VA_ARGS__)
1444#define ata_link_notice(link, fmt, ...) \
1445 ata_link_printk(link, KERN_NOTICE, fmt, ##__VA_ARGS__)
1446#define ata_link_info(link, fmt, ...) \
1447 ata_link_printk(link, KERN_INFO, fmt, ##__VA_ARGS__)
1448#define ata_link_dbg(link, fmt, ...) \
1449 ata_link_printk(link, KERN_DEBUG, fmt, ##__VA_ARGS__)
1450
1451#define ata_dev_err(dev, fmt, ...) \
1452 ata_dev_printk(dev, KERN_ERR, fmt, ##__VA_ARGS__)
1453#define ata_dev_warn(dev, fmt, ...) \
1454 ata_dev_printk(dev, KERN_WARNING, fmt, ##__VA_ARGS__)
1455#define ata_dev_notice(dev, fmt, ...) \
1456 ata_dev_printk(dev, KERN_NOTICE, fmt, ##__VA_ARGS__)
1457#define ata_dev_info(dev, fmt, ...) \
1458 ata_dev_printk(dev, KERN_INFO, fmt, ##__VA_ARGS__)
1459#define ata_dev_dbg(dev, fmt, ...) \
1460 ata_dev_printk(dev, KERN_DEBUG, fmt, ##__VA_ARGS__)
1461
1462void ata_print_version(const struct device *dev, const char *version);
1463
1464/*
1465 * ata_eh_info helpers
1466 */
1467extern __printf(2, 3)
1468void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
1469extern __printf(2, 3)
1470void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
1471extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
1472
1473static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
1474{
1475 ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
1476 ehi->flags |= ATA_EHI_HOTPLUGGED;
1477 ehi->action |= ATA_EH_RESET | ATA_EH_ENABLE_LINK;
1478 ehi->err_mask |= AC_ERR_ATA_BUS;
1479}
1480
1481/*
1482 * port description helpers
1483 */
1484extern __printf(2, 3)
1485void ata_port_desc(struct ata_port *ap, const char *fmt, ...);
1486#ifdef CONFIG_PCI
1487extern void ata_port_pbar_desc(struct ata_port *ap, int bar, ssize_t offset,
1488 const char *name);
1489#endif
1490
1491static inline bool ata_tag_internal(unsigned int tag)
1492{
1493 return tag == ATA_TAG_INTERNAL;
1494}
1495
1496static inline bool ata_tag_valid(unsigned int tag)
1497{
1498 return tag < ATA_MAX_QUEUE || ata_tag_internal(tag);
1499}
1500
1501#define __ata_qc_for_each(ap, qc, tag, max_tag, fn) \
1502 for ((tag) = 0; (tag) < (max_tag) && \
1503 ({ qc = fn((ap), (tag)); 1; }); (tag)++) \
1504
1505/*
1506 * Internal use only, iterate commands ignoring error handling and
1507 * status of 'qc'.
1508 */
1509#define ata_qc_for_each_raw(ap, qc, tag) \
1510 __ata_qc_for_each(ap, qc, tag, ATA_MAX_QUEUE, __ata_qc_from_tag)
1511
1512/*
1513 * Iterate all potential commands that can be queued
1514 */
1515#define ata_qc_for_each(ap, qc, tag) \
1516 __ata_qc_for_each(ap, qc, tag, ATA_MAX_QUEUE, ata_qc_from_tag)
1517
1518/*
1519 * Like ata_qc_for_each, but with the internal tag included
1520 */
1521#define ata_qc_for_each_with_internal(ap, qc, tag) \
1522 __ata_qc_for_each(ap, qc, tag, ATA_MAX_QUEUE + 1, ata_qc_from_tag)
1523
1524/*
1525 * device helpers
1526 */
1527static inline unsigned int ata_class_enabled(unsigned int class)
1528{
1529 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI ||
1530 class == ATA_DEV_PMP || class == ATA_DEV_SEMB ||
1531 class == ATA_DEV_ZAC;
1532}
1533
1534static inline unsigned int ata_class_disabled(unsigned int class)
1535{
1536 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP ||
1537 class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP ||
1538 class == ATA_DEV_ZAC_UNSUP;
1539}
1540
1541static inline unsigned int ata_class_absent(unsigned int class)
1542{
1543 return !ata_class_enabled(class) && !ata_class_disabled(class);
1544}
1545
1546static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1547{
1548 return ata_class_enabled(dev->class);
1549}
1550
1551static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1552{
1553 return ata_class_disabled(dev->class);
1554}
1555
1556static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1557{
1558 return ata_class_absent(dev->class);
1559}
1560
1561/*
1562 * link helpers
1563 */
1564static inline int ata_link_max_devices(const struct ata_link *link)
1565{
1566 if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS)
1567 return 2;
1568 return 1;
1569}
1570
1571static inline int ata_link_active(struct ata_link *link)
1572{
1573 return ata_tag_valid(link->active_tag) || link->sactive;
1574}
1575
1576/*
1577 * Iterators
1578 *
1579 * ATA_LITER_* constants are used to select link iteration mode and
1580 * ATA_DITER_* device iteration mode.
1581 *
1582 * For a custom iteration directly using ata_{link|dev}_next(), if
1583 * @link or @dev, respectively, is NULL, the first element is
1584 * returned. @dev and @link can be any valid device or link and the
1585 * next element according to the iteration mode will be returned.
1586 * After the last element, NULL is returned.
1587 */
1588enum ata_link_iter_mode {
1589 ATA_LITER_EDGE, /* if present, PMP links only; otherwise,
1590 * host link. no slave link */
1591 ATA_LITER_HOST_FIRST, /* host link followed by PMP or slave links */
1592 ATA_LITER_PMP_FIRST, /* PMP links followed by host link,
1593 * slave link still comes after host link */
1594};
1595
1596enum ata_dev_iter_mode {
1597 ATA_DITER_ENABLED,
1598 ATA_DITER_ENABLED_REVERSE,
1599 ATA_DITER_ALL,
1600 ATA_DITER_ALL_REVERSE,
1601};
1602
1603extern struct ata_link *ata_link_next(struct ata_link *link,
1604 struct ata_port *ap,
1605 enum ata_link_iter_mode mode);
1606
1607extern struct ata_device *ata_dev_next(struct ata_device *dev,
1608 struct ata_link *link,
1609 enum ata_dev_iter_mode mode);
1610
1611/*
1612 * Shortcut notation for iterations
1613 *
1614 * ata_for_each_link() iterates over each link of @ap according to
1615 * @mode. @link points to the current link in the loop. @link is
1616 * NULL after loop termination. ata_for_each_dev() works the same way
1617 * except that it iterates over each device of @link.
1618 *
1619 * Note that the mode prefixes ATA_{L|D}ITER_ shouldn't need to be
1620 * specified when using the following shorthand notations. Only the
1621 * mode itself (EDGE, HOST_FIRST, ENABLED, etc...) should be
1622 * specified. This not only increases brevity but also makes it
1623 * impossible to use ATA_LITER_* for device iteration or vice-versa.
1624 */
1625#define ata_for_each_link(link, ap, mode) \
1626 for ((link) = ata_link_next(NULL, (ap), ATA_LITER_##mode); (link); \
1627 (link) = ata_link_next((link), (ap), ATA_LITER_##mode))
1628
1629#define ata_for_each_dev(dev, link, mode) \
1630 for ((dev) = ata_dev_next(NULL, (link), ATA_DITER_##mode); (dev); \
1631 (dev) = ata_dev_next((dev), (link), ATA_DITER_##mode))
1632
1633/**
1634 * ata_ncq_enabled - Test whether NCQ is enabled
1635 * @dev: ATA device to test for
1636 *
1637 * LOCKING:
1638 * spin_lock_irqsave(host lock)
1639 *
1640 * RETURNS:
1641 * 1 if NCQ is enabled for @dev, 0 otherwise.
1642 */
1643static inline int ata_ncq_enabled(struct ata_device *dev)
1644{
1645 return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1646 ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1647}
1648
1649static inline bool ata_fpdma_dsm_supported(struct ata_device *dev)
1650{
1651 return (dev->flags & ATA_DFLAG_NCQ_SEND_RECV) &&
1652 (dev->ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_DSM_OFFSET] &
1653 ATA_LOG_NCQ_SEND_RECV_DSM_TRIM);
1654}
1655
1656static inline bool ata_fpdma_read_log_supported(struct ata_device *dev)
1657{
1658 return (dev->flags & ATA_DFLAG_NCQ_SEND_RECV) &&
1659 (dev->ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_RD_LOG_OFFSET] &
1660 ATA_LOG_NCQ_SEND_RECV_RD_LOG_SUPPORTED);
1661}
1662
1663static inline bool ata_fpdma_zac_mgmt_in_supported(struct ata_device *dev)
1664{
1665 return (dev->flags & ATA_DFLAG_NCQ_SEND_RECV) &&
1666 (dev->ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_ZAC_MGMT_OFFSET] &
1667 ATA_LOG_NCQ_SEND_RECV_ZAC_MGMT_IN_SUPPORTED);
1668}
1669
1670static inline bool ata_fpdma_zac_mgmt_out_supported(struct ata_device *dev)
1671{
1672 return (dev->ncq_non_data_cmds[ATA_LOG_NCQ_NON_DATA_ZAC_MGMT_OFFSET] &
1673 ATA_LOG_NCQ_NON_DATA_ZAC_MGMT_OUT);
1674}
1675
1676static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1677{
1678 qc->tf.ctl |= ATA_NIEN;
1679}
1680
1681static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1682 unsigned int tag)
1683{
1684 if (ata_tag_valid(tag))
1685 return &ap->qcmd[tag];
1686 return NULL;
1687}
1688
1689static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1690 unsigned int tag)
1691{
1692 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1693
1694 if (unlikely(!qc) || !ap->ops->error_handler)
1695 return qc;
1696
1697 if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1698 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1699 return qc;
1700
1701 return NULL;
1702}
1703
1704static inline unsigned int ata_qc_raw_nbytes(struct ata_queued_cmd *qc)
1705{
1706 return qc->nbytes - min(qc->extrabytes, qc->nbytes);
1707}
1708
1709static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1710{
1711 memset(tf, 0, sizeof(*tf));
1712
1713#ifdef CONFIG_ATA_SFF
1714 tf->ctl = dev->link->ap->ctl;
1715#else
1716 tf->ctl = ATA_DEVCTL_OBS;
1717#endif
1718 if (dev->devno == 0)
1719 tf->device = ATA_DEVICE_OBS;
1720 else
1721 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1722}
1723
1724static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1725{
1726 qc->dma_dir = DMA_NONE;
1727 qc->sg = NULL;
1728 qc->flags = 0;
1729 qc->cursg = NULL;
1730 qc->cursg_ofs = 0;
1731 qc->nbytes = qc->extrabytes = qc->curbytes = 0;
1732 qc->n_elem = 0;
1733 qc->err_mask = 0;
1734 qc->sect_size = ATA_SECT_SIZE;
1735
1736 ata_tf_init(qc->dev, &qc->tf);
1737
1738 /* init result_tf such that it indicates normal completion */
1739 qc->result_tf.command = ATA_DRDY;
1740 qc->result_tf.feature = 0;
1741}
1742
1743static inline int ata_try_flush_cache(const struct ata_device *dev)
1744{
1745 return ata_id_wcache_enabled(dev->id) ||
1746 ata_id_has_flush(dev->id) ||
1747 ata_id_has_flush_ext(dev->id);
1748}
1749
1750static inline unsigned int ac_err_mask(u8 status)
1751{
1752 if (status & (ATA_BUSY | ATA_DRQ))
1753 return AC_ERR_HSM;
1754 if (status & (ATA_ERR | ATA_DF))
1755 return AC_ERR_DEV;
1756 return 0;
1757}
1758
1759static inline unsigned int __ac_err_mask(u8 status)
1760{
1761 unsigned int mask = ac_err_mask(status);
1762 if (mask == 0)
1763 return AC_ERR_OTHER;
1764 return mask;
1765}
1766
1767static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1768{
1769 return *(struct ata_port **)&host->hostdata[0];
1770}
1771
1772static inline int ata_check_ready(u8 status)
1773{
1774 if (!(status & ATA_BUSY))
1775 return 1;
1776
1777 /* 0xff indicates either no device or device not ready */
1778 if (status == 0xff)
1779 return -ENODEV;
1780
1781 return 0;
1782}
1783
1784static inline unsigned long ata_deadline(unsigned long from_jiffies,
1785 unsigned long timeout_msecs)
1786{
1787 return from_jiffies + msecs_to_jiffies(timeout_msecs);
1788}
1789
1790/* Don't open code these in drivers as there are traps. Firstly the range may
1791 change in future hardware and specs, secondly 0xFF means 'no DMA' but is
1792 > UDMA_0. Dyma ddreigiau */
1793
1794static inline int ata_using_mwdma(struct ata_device *adev)
1795{
1796 if (adev->dma_mode >= XFER_MW_DMA_0 && adev->dma_mode <= XFER_MW_DMA_4)
1797 return 1;
1798 return 0;
1799}
1800
1801static inline int ata_using_udma(struct ata_device *adev)
1802{
1803 if (adev->dma_mode >= XFER_UDMA_0 && adev->dma_mode <= XFER_UDMA_7)
1804 return 1;
1805 return 0;
1806}
1807
1808static inline int ata_dma_enabled(struct ata_device *adev)
1809{
1810 return (adev->dma_mode == 0xFF ? 0 : 1);
1811}
1812
1813/**************************************************************************
1814 * PMP - drivers/ata/libata-pmp.c
1815 */
1816#ifdef CONFIG_SATA_PMP
1817
1818extern const struct ata_port_operations sata_pmp_port_ops;
1819
1820extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc);
1821extern void sata_pmp_error_handler(struct ata_port *ap);
1822
1823#else /* CONFIG_SATA_PMP */
1824
1825#define sata_pmp_port_ops sata_port_ops
1826#define sata_pmp_qc_defer_cmd_switch ata_std_qc_defer
1827#define sata_pmp_error_handler ata_std_error_handler
1828
1829#endif /* CONFIG_SATA_PMP */
1830
1831
1832/**************************************************************************
1833 * SFF - drivers/ata/libata-sff.c
1834 */
1835#ifdef CONFIG_ATA_SFF
1836
1837extern const struct ata_port_operations ata_sff_port_ops;
1838extern const struct ata_port_operations ata_bmdma32_port_ops;
1839
1840/* PIO only, sg_tablesize and dma_boundary limits can be removed */
1841#define ATA_PIO_SHT(drv_name) \
1842 ATA_BASE_SHT(drv_name), \
1843 .sg_tablesize = LIBATA_MAX_PRD, \
1844 .dma_boundary = ATA_DMA_BOUNDARY
1845
1846extern void ata_sff_dev_select(struct ata_port *ap, unsigned int device);
1847extern u8 ata_sff_check_status(struct ata_port *ap);
1848extern void ata_sff_pause(struct ata_port *ap);
1849extern void ata_sff_dma_pause(struct ata_port *ap);
1850extern int ata_sff_busy_sleep(struct ata_port *ap,
1851 unsigned long timeout_pat, unsigned long timeout);
1852extern int ata_sff_wait_ready(struct ata_link *link, unsigned long deadline);
1853extern void ata_sff_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
1854extern void ata_sff_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
1855extern void ata_sff_exec_command(struct ata_port *ap,
1856 const struct ata_taskfile *tf);
1857extern unsigned int ata_sff_data_xfer(struct ata_queued_cmd *qc,
1858 unsigned char *buf, unsigned int buflen, int rw);
1859extern unsigned int ata_sff_data_xfer32(struct ata_queued_cmd *qc,
1860 unsigned char *buf, unsigned int buflen, int rw);
1861extern void ata_sff_irq_on(struct ata_port *ap);
1862extern void ata_sff_irq_clear(struct ata_port *ap);
1863extern int ata_sff_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
1864 u8 status, int in_wq);
1865extern void ata_sff_queue_work(struct work_struct *work);
1866extern void ata_sff_queue_delayed_work(struct delayed_work *dwork,
1867 unsigned long delay);
1868extern void ata_sff_queue_pio_task(struct ata_link *link, unsigned long delay);
1869extern unsigned int ata_sff_qc_issue(struct ata_queued_cmd *qc);
1870extern bool ata_sff_qc_fill_rtf(struct ata_queued_cmd *qc);
1871extern unsigned int ata_sff_port_intr(struct ata_port *ap,
1872 struct ata_queued_cmd *qc);
1873extern irqreturn_t ata_sff_interrupt(int irq, void *dev_instance);
1874extern void ata_sff_lost_interrupt(struct ata_port *ap);
1875extern void ata_sff_freeze(struct ata_port *ap);
1876extern void ata_sff_thaw(struct ata_port *ap);
1877extern int ata_sff_prereset(struct ata_link *link, unsigned long deadline);
1878extern unsigned int ata_sff_dev_classify(struct ata_device *dev, int present,
1879 u8 *r_err);
1880extern int ata_sff_wait_after_reset(struct ata_link *link, unsigned int devmask,
1881 unsigned long deadline);
1882extern int ata_sff_softreset(struct ata_link *link, unsigned int *classes,
1883 unsigned long deadline);
1884extern int sata_sff_hardreset(struct ata_link *link, unsigned int *class,
1885 unsigned long deadline);
1886extern void ata_sff_postreset(struct ata_link *link, unsigned int *classes);
1887extern void ata_sff_drain_fifo(struct ata_queued_cmd *qc);
1888extern void ata_sff_error_handler(struct ata_port *ap);
1889extern void ata_sff_std_ports(struct ata_ioports *ioaddr);
1890#ifdef CONFIG_PCI
1891extern int ata_pci_sff_init_host(struct ata_host *host);
1892extern int ata_pci_sff_prepare_host(struct pci_dev *pdev,
1893 const struct ata_port_info * const * ppi,
1894 struct ata_host **r_host);
1895extern int ata_pci_sff_activate_host(struct ata_host *host,
1896 irq_handler_t irq_handler,
1897 struct scsi_host_template *sht);
1898extern int ata_pci_sff_init_one(struct pci_dev *pdev,
1899 const struct ata_port_info * const * ppi,
1900 struct scsi_host_template *sht, void *host_priv, int hflags);
1901#endif /* CONFIG_PCI */
1902
1903#ifdef CONFIG_ATA_BMDMA
1904
1905extern const struct ata_port_operations ata_bmdma_port_ops;
1906
1907#define ATA_BMDMA_SHT(drv_name) \
1908 ATA_BASE_SHT(drv_name), \
1909 .sg_tablesize = LIBATA_MAX_PRD, \
1910 .dma_boundary = ATA_DMA_BOUNDARY
1911
1912extern void ata_bmdma_qc_prep(struct ata_queued_cmd *qc);
1913extern unsigned int ata_bmdma_qc_issue(struct ata_queued_cmd *qc);
1914extern void ata_bmdma_dumb_qc_prep(struct ata_queued_cmd *qc);
1915extern unsigned int ata_bmdma_port_intr(struct ata_port *ap,
1916 struct ata_queued_cmd *qc);
1917extern irqreturn_t ata_bmdma_interrupt(int irq, void *dev_instance);
1918extern void ata_bmdma_error_handler(struct ata_port *ap);
1919extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
1920extern void ata_bmdma_irq_clear(struct ata_port *ap);
1921extern void ata_bmdma_setup(struct ata_queued_cmd *qc);
1922extern void ata_bmdma_start(struct ata_queued_cmd *qc);
1923extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
1924extern u8 ata_bmdma_status(struct ata_port *ap);
1925extern int ata_bmdma_port_start(struct ata_port *ap);
1926extern int ata_bmdma_port_start32(struct ata_port *ap);
1927
1928#ifdef CONFIG_PCI
1929extern int ata_pci_bmdma_clear_simplex(struct pci_dev *pdev);
1930extern void ata_pci_bmdma_init(struct ata_host *host);
1931extern int ata_pci_bmdma_prepare_host(struct pci_dev *pdev,
1932 const struct ata_port_info * const * ppi,
1933 struct ata_host **r_host);
1934extern int ata_pci_bmdma_init_one(struct pci_dev *pdev,
1935 const struct ata_port_info * const * ppi,
1936 struct scsi_host_template *sht,
1937 void *host_priv, int hflags);
1938#endif /* CONFIG_PCI */
1939#endif /* CONFIG_ATA_BMDMA */
1940
1941/**
1942 * ata_sff_busy_wait - Wait for a port status register
1943 * @ap: Port to wait for.
1944 * @bits: bits that must be clear
1945 * @max: number of 10uS waits to perform
1946 *
1947 * Waits up to max*10 microseconds for the selected bits in the port's
1948 * status register to be cleared.
1949 * Returns final value of status register.
1950 *
1951 * LOCKING:
1952 * Inherited from caller.
1953 */
1954static inline u8 ata_sff_busy_wait(struct ata_port *ap, unsigned int bits,
1955 unsigned int max)
1956{
1957 u8 status;
1958
1959 do {
1960 udelay(10);
1961 status = ap->ops->sff_check_status(ap);
1962 max--;
1963 } while (status != 0xff && (status & bits) && (max > 0));
1964
1965 return status;
1966}
1967
1968/**
1969 * ata_wait_idle - Wait for a port to be idle.
1970 * @ap: Port to wait for.
1971 *
1972 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
1973 * Returns final value of status register.
1974 *
1975 * LOCKING:
1976 * Inherited from caller.
1977 */
1978static inline u8 ata_wait_idle(struct ata_port *ap)
1979{
1980 u8 status = ata_sff_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1981
1982#ifdef ATA_DEBUG
1983 if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
1984 ata_port_printk(ap, KERN_DEBUG, "abnormal Status 0x%X\n",
1985 status);
1986#endif
1987
1988 return status;
1989}
1990#endif /* CONFIG_ATA_SFF */
1991
1992#endif /* __LINUX_LIBATA_H__ */
1993