1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 * Copyright 2003-2005 Red Hat, Inc. All rights reserved.
4 * Copyright 2003-2005 Jeff Garzik
6 * libata documentation is available via 'make {ps|pdf}docs',
7 * as Documentation/driver-api/libata.rst
10 #ifndef __LINUX_LIBATA_H__
11 #define __LINUX_LIBATA_H__
13 #include <linux/delay.h>
14 #include <linux/jiffies.h>
15 #include <linux/interrupt.h>
16 #include <linux/dma-mapping.h>
17 #include <linux/scatterlist.h>
19 #include <linux/ata.h>
20 #include <linux/workqueue.h>
21 #include <scsi/scsi_host.h>
22 #include <linux/acpi.h>
23 #include <linux/cdrom.h>
24 #include <linux/sched.h>
27 * Define if arch has non-standard setup. This is a _PCI_ standard
28 * not a legacy or ISA standard.
30 #ifdef CONFIG_ATA_NONSTANDARD
31 #include <asm/libata-portmap.h>
33 #define ATA_PRIMARY_IRQ(dev) 14
34 #define ATA_SECONDARY_IRQ(dev) 15
38 * compile-time options: to be removed as soon as all the drivers are
39 * converted to the new debugging mechanism
41 #undef ATA_DEBUG /* debugging output */
42 #undef ATA_VERBOSE_DEBUG /* yet more debugging output */
43 #undef ATA_IRQ_TRAP /* define to ack screaming irqs */
44 #undef ATA_NDEBUG /* define to disable quick runtime checks */
47 /* note: prints function name for you */
49 #define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __func__, ## args)
50 #ifdef ATA_VERBOSE_DEBUG
51 #define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __func__, ## args)
53 #define VPRINTK(fmt, args...)
54 #endif /* ATA_VERBOSE_DEBUG */
56 #define DPRINTK(fmt, args...)
57 #define VPRINTK(fmt, args...)
58 #endif /* ATA_DEBUG */
60 #define ata_print_version_once(dev, version) \
62 static bool __print_once; \
64 if (!__print_once) { \
65 __print_once = true; \
66 ata_print_version(dev, version); \
70 /* NEW: debug levels */
71 #define HAVE_LIBATA_MSG 1
75 ATA_MSG_INFO = 0x0002,
76 ATA_MSG_PROBE = 0x0004,
77 ATA_MSG_WARN = 0x0008,
78 ATA_MSG_MALLOC = 0x0010,
80 ATA_MSG_INTR = 0x0040,
84 #define ata_msg_drv(p) ((p)->msg_enable & ATA_MSG_DRV)
85 #define ata_msg_info(p) ((p)->msg_enable & ATA_MSG_INFO)
86 #define ata_msg_probe(p) ((p)->msg_enable & ATA_MSG_PROBE)
87 #define ata_msg_warn(p) ((p)->msg_enable & ATA_MSG_WARN)
88 #define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC)
89 #define ata_msg_ctl(p) ((p)->msg_enable & ATA_MSG_CTL)
90 #define ata_msg_intr(p) ((p)->msg_enable & ATA_MSG_INTR)
91 #define ata_msg_err(p) ((p)->msg_enable & ATA_MSG_ERR)
93 static inline u32 ata_msg_init(int dval, int default_msg_enable_bits)
95 if (dval < 0 || dval >= (sizeof(u32) * 8))
96 return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */
99 return (1 << dval) - 1;
102 /* defines only for the constants which don't work well as enums */
103 #define ATA_TAG_POISON 0xfafbfcfdU
106 /* various global constants */
107 LIBATA_MAX_PRD = ATA_MAX_PRD / 2,
108 LIBATA_DUMB_MAX_PRD = ATA_MAX_PRD / 4, /* Worst case */
111 ATA_TAG_INTERNAL = ATA_MAX_QUEUE,
112 ATA_SHORT_PAUSE = 16,
114 ATAPI_MAX_DRAIN = 16 << 10,
116 ATA_ALL_DEVICES = (1 << ATA_MAX_DEVICES) - 1,
118 ATA_SHT_EMULATED = 1,
119 ATA_SHT_THIS_ID = -1,
121 /* struct ata_taskfile flags */
122 ATA_TFLAG_LBA48 = (1 << 0), /* enable 48-bit LBA and "HOB" */
123 ATA_TFLAG_ISADDR = (1 << 1), /* enable r/w to nsect/lba regs */
124 ATA_TFLAG_DEVICE = (1 << 2), /* enable r/w to device reg */
125 ATA_TFLAG_WRITE = (1 << 3), /* data dir: host->dev==1 (write) */
126 ATA_TFLAG_LBA = (1 << 4), /* enable LBA */
127 ATA_TFLAG_FUA = (1 << 5), /* enable FUA */
128 ATA_TFLAG_POLLING = (1 << 6), /* set nIEN to 1 and use polling */
130 /* struct ata_device stuff */
131 ATA_DFLAG_LBA = (1 << 0), /* device supports LBA */
132 ATA_DFLAG_LBA48 = (1 << 1), /* device supports LBA48 */
133 ATA_DFLAG_CDB_INTR = (1 << 2), /* device asserts INTRQ when ready for CDB */
134 ATA_DFLAG_NCQ = (1 << 3), /* device supports NCQ */
135 ATA_DFLAG_FLUSH_EXT = (1 << 4), /* do FLUSH_EXT instead of FLUSH */
136 ATA_DFLAG_ACPI_PENDING = (1 << 5), /* ACPI resume action pending */
137 ATA_DFLAG_ACPI_FAILED = (1 << 6), /* ACPI on devcfg has failed */
138 ATA_DFLAG_AN = (1 << 7), /* AN configured */
139 ATA_DFLAG_TRUSTED = (1 << 8), /* device supports trusted send/recv */
140 ATA_DFLAG_DMADIR = (1 << 10), /* device requires DMADIR */
141 ATA_DFLAG_CFG_MASK = (1 << 12) - 1,
143 ATA_DFLAG_PIO = (1 << 12), /* device limited to PIO mode */
144 ATA_DFLAG_NCQ_OFF = (1 << 13), /* device limited to non-NCQ mode */
145 ATA_DFLAG_SLEEPING = (1 << 15), /* device is sleeping */
146 ATA_DFLAG_DUBIOUS_XFER = (1 << 16), /* data transfer not verified */
147 ATA_DFLAG_NO_UNLOAD = (1 << 17), /* device doesn't support unload */
148 ATA_DFLAG_UNLOCK_HPA = (1 << 18), /* unlock HPA */
149 ATA_DFLAG_NCQ_SEND_RECV = (1 << 19), /* device supports NCQ SEND and RECV */
150 ATA_DFLAG_NCQ_PRIO = (1 << 20), /* device supports NCQ priority */
151 ATA_DFLAG_NCQ_PRIO_ENABLE = (1 << 21), /* Priority cmds sent to dev */
152 ATA_DFLAG_INIT_MASK = (1 << 24) - 1,
154 ATA_DFLAG_DETACH = (1 << 24),
155 ATA_DFLAG_DETACHED = (1 << 25),
157 ATA_DFLAG_DA = (1 << 26), /* device supports Device Attention */
158 ATA_DFLAG_DEVSLP = (1 << 27), /* device supports Device Sleep */
159 ATA_DFLAG_ACPI_DISABLED = (1 << 28), /* ACPI for the device is disabled */
160 ATA_DFLAG_D_SENSE = (1 << 29), /* Descriptor sense requested */
161 ATA_DFLAG_ZAC = (1 << 30), /* ZAC device */
163 ATA_DEV_UNKNOWN = 0, /* unknown device */
164 ATA_DEV_ATA = 1, /* ATA device */
165 ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */
166 ATA_DEV_ATAPI = 3, /* ATAPI device */
167 ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */
168 ATA_DEV_PMP = 5, /* SATA port multiplier */
169 ATA_DEV_PMP_UNSUP = 6, /* SATA port multiplier (unsupported) */
170 ATA_DEV_SEMB = 7, /* SEMB */
171 ATA_DEV_SEMB_UNSUP = 8, /* SEMB (unsupported) */
172 ATA_DEV_ZAC = 9, /* ZAC device */
173 ATA_DEV_ZAC_UNSUP = 10, /* ZAC device (unsupported) */
174 ATA_DEV_NONE = 11, /* no device */
176 /* struct ata_link flags */
177 /* NOTE: struct ata_force_param currently stores lflags in u16 */
178 ATA_LFLAG_NO_HRST = (1 << 1), /* avoid hardreset */
179 ATA_LFLAG_NO_SRST = (1 << 2), /* avoid softreset */
180 ATA_LFLAG_ASSUME_ATA = (1 << 3), /* assume ATA class */
181 ATA_LFLAG_ASSUME_SEMB = (1 << 4), /* assume SEMB class */
182 ATA_LFLAG_ASSUME_CLASS = ATA_LFLAG_ASSUME_ATA | ATA_LFLAG_ASSUME_SEMB,
183 ATA_LFLAG_NO_RETRY = (1 << 5), /* don't retry this link */
184 ATA_LFLAG_DISABLED = (1 << 6), /* link is disabled */
185 ATA_LFLAG_SW_ACTIVITY = (1 << 7), /* keep activity stats */
186 ATA_LFLAG_NO_LPM = (1 << 8), /* disable LPM on this link */
187 ATA_LFLAG_RST_ONCE = (1 << 9), /* limit recovery to one reset */
188 ATA_LFLAG_CHANGED = (1 << 10), /* LPM state changed on this link */
189 ATA_LFLAG_NO_DB_DELAY = (1 << 11), /* no debounce delay on link resume */
191 /* struct ata_port flags */
192 ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */
193 /* (doesn't imply presence) */
194 ATA_FLAG_SATA = (1 << 1),
195 ATA_FLAG_NO_LPM = (1 << 2), /* host not happy with LPM */
196 ATA_FLAG_NO_LOG_PAGE = (1 << 5), /* do not issue log page read */
197 ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */
198 ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */
199 ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */
200 ATA_FLAG_PIO_POLLING = (1 << 9), /* use polling PIO if LLD
201 * doesn't handle PIO interrupts */
202 ATA_FLAG_NCQ = (1 << 10), /* host supports NCQ */
203 ATA_FLAG_NO_POWEROFF_SPINDOWN = (1 << 11), /* don't spindown before poweroff */
204 ATA_FLAG_NO_HIBERNATE_SPINDOWN = (1 << 12), /* don't spindown before hibernation */
205 ATA_FLAG_DEBUGMSG = (1 << 13),
206 ATA_FLAG_FPDMA_AA = (1 << 14), /* driver supports Auto-Activate */
207 ATA_FLAG_IGN_SIMPLEX = (1 << 15), /* ignore SIMPLEX */
208 ATA_FLAG_NO_IORDY = (1 << 16), /* controller lacks iordy */
209 ATA_FLAG_ACPI_SATA = (1 << 17), /* need native SATA ACPI layout */
210 ATA_FLAG_AN = (1 << 18), /* controller supports AN */
211 ATA_FLAG_PMP = (1 << 19), /* controller supports PMP */
212 ATA_FLAG_FPDMA_AUX = (1 << 20), /* controller supports H2DFIS aux field */
213 ATA_FLAG_EM = (1 << 21), /* driver supports enclosure
215 ATA_FLAG_SW_ACTIVITY = (1 << 22), /* driver supports sw activity
217 ATA_FLAG_NO_DIPM = (1 << 23), /* host not happy with DIPM */
218 ATA_FLAG_SAS_HOST = (1 << 24), /* SAS host */
220 /* bits 24:31 of ap->flags are reserved for LLD specific flags */
223 /* struct ata_port pflags */
224 ATA_PFLAG_EH_PENDING = (1 << 0), /* EH pending */
225 ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */
226 ATA_PFLAG_FROZEN = (1 << 2), /* port is frozen */
227 ATA_PFLAG_RECOVERED = (1 << 3), /* recovery action performed */
228 ATA_PFLAG_LOADING = (1 << 4), /* boot/loading probe */
229 ATA_PFLAG_SCSI_HOTPLUG = (1 << 6), /* SCSI hotplug scheduled */
230 ATA_PFLAG_INITIALIZING = (1 << 7), /* being initialized, don't touch */
231 ATA_PFLAG_RESETTING = (1 << 8), /* reset in progress */
232 ATA_PFLAG_UNLOADING = (1 << 9), /* driver is being unloaded */
233 ATA_PFLAG_UNLOADED = (1 << 10), /* driver is unloaded */
235 ATA_PFLAG_SUSPENDED = (1 << 17), /* port is suspended (power) */
236 ATA_PFLAG_PM_PENDING = (1 << 18), /* PM operation pending */
237 ATA_PFLAG_INIT_GTM_VALID = (1 << 19), /* initial gtm data valid */
239 ATA_PFLAG_PIO32 = (1 << 20), /* 32bit PIO */
240 ATA_PFLAG_PIO32CHANGE = (1 << 21), /* 32bit PIO can be turned on/off */
241 ATA_PFLAG_EXTERNAL = (1 << 22), /* eSATA/external port */
243 /* struct ata_queued_cmd flags */
244 ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */
245 ATA_QCFLAG_DMAMAP = (1 << 1), /* SG table is DMA mapped */
246 ATA_QCFLAG_IO = (1 << 3), /* standard IO command */
247 ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */
248 ATA_QCFLAG_CLEAR_EXCL = (1 << 5), /* clear excl_link on completion */
249 ATA_QCFLAG_QUIET = (1 << 6), /* don't report device error */
250 ATA_QCFLAG_RETRY = (1 << 7), /* retry after failure */
252 ATA_QCFLAG_FAILED = (1 << 16), /* cmd failed and is owned by EH */
253 ATA_QCFLAG_SENSE_VALID = (1 << 17), /* sense data valid */
254 ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
257 ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host only */
258 ATA_HOST_STARTED = (1 << 1), /* Host started */
259 ATA_HOST_PARALLEL_SCAN = (1 << 2), /* Ports on this host can be scanned in parallel */
260 ATA_HOST_IGNORE_ATA = (1 << 3), /* Ignore ATA devices on this host. */
262 /* bits 24:31 of host->flags are reserved for LLD specific flags */
264 /* various lengths of time */
265 ATA_TMOUT_BOOT = 30000, /* heuristic */
266 ATA_TMOUT_BOOT_QUICK = 7000, /* heuristic */
267 ATA_TMOUT_INTERNAL_QUICK = 5000,
268 ATA_TMOUT_MAX_PARK = 30000,
271 * GoVault needs 2s and iVDR disk HHD424020F7SV00 800ms. 2s
272 * is too much without parallel probing. Use 2s if parallel
273 * probing is available, 800ms otherwise.
275 ATA_TMOUT_FF_WAIT_LONG = 2000,
276 ATA_TMOUT_FF_WAIT = 800,
278 /* Spec mandates to wait for ">= 2ms" before checking status
279 * after reset. We wait 150ms, because that was the magic
280 * delay used for ATAPI devices in Hale Landis's ATADRVR, for
281 * the period of time between when the ATA command register is
282 * written, and then status is checked. Because waiting for
283 * "a while" before checking status is fine, post SRST, we
284 * perform this magic delay here as well.
286 * Old drivers/ide uses the 2mS rule and then waits for ready.
288 ATA_WAIT_AFTER_RESET = 150,
290 /* If PMP is supported, we have to do follow-up SRST. As some
291 * PMPs don't send D2H Reg FIS after hardreset, LLDs are
292 * advised to wait only for the following duration before
295 ATA_TMOUT_PMP_SRST_WAIT = 5000,
297 /* When the LPM policy is set to ATA_LPM_MAX_POWER, there might
298 * be a spurious PHY event, so ignore the first PHY event that
299 * occurs within 10s after the policy change.
301 ATA_TMOUT_SPURIOUS_PHY = 10000,
315 /* SATA port states */
320 /* encoding various smaller bitmaps into a single
321 * unsigned long bitmap
323 ATA_NR_PIO_MODES = 7,
324 ATA_NR_MWDMA_MODES = 5,
325 ATA_NR_UDMA_MODES = 8,
328 ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_NR_PIO_MODES,
329 ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_NR_MWDMA_MODES,
333 /* size of buffer to pad xfers ending on unaligned boundaries */
339 /* return values for ->qc_defer */
343 /* desc_len for ata_eh_info and context */
344 ATA_EH_DESC_LEN = 80,
346 /* reset / recovery action types */
347 ATA_EH_REVALIDATE = (1 << 0),
348 ATA_EH_SOFTRESET = (1 << 1), /* meaningful only in ->prereset */
349 ATA_EH_HARDRESET = (1 << 2), /* meaningful only in ->prereset */
350 ATA_EH_RESET = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
351 ATA_EH_ENABLE_LINK = (1 << 3),
352 ATA_EH_PARK = (1 << 5), /* unload heads and stop I/O */
354 ATA_EH_PERDEV_MASK = ATA_EH_REVALIDATE | ATA_EH_PARK,
355 ATA_EH_ALL_ACTIONS = ATA_EH_REVALIDATE | ATA_EH_RESET |
358 /* ata_eh_info->flags */
359 ATA_EHI_HOTPLUGGED = (1 << 0), /* could have been hotplugged */
360 ATA_EHI_NO_AUTOPSY = (1 << 2), /* no autopsy */
361 ATA_EHI_QUIET = (1 << 3), /* be quiet */
362 ATA_EHI_NO_RECOVERY = (1 << 4), /* no recovery */
364 ATA_EHI_DID_SOFTRESET = (1 << 16), /* already soft-reset this port */
365 ATA_EHI_DID_HARDRESET = (1 << 17), /* already soft-reset this port */
366 ATA_EHI_PRINTINFO = (1 << 18), /* print configuration info */
367 ATA_EHI_SETMODE = (1 << 19), /* configure transfer mode */
368 ATA_EHI_POST_SETMODE = (1 << 20), /* revalidating after setmode */
370 ATA_EHI_DID_RESET = ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
372 /* mask of flags to transfer *to* the slave link */
373 ATA_EHI_TO_SLAVE_MASK = ATA_EHI_NO_AUTOPSY | ATA_EHI_QUIET,
375 /* max tries if error condition is still set after ->error_handler */
376 ATA_EH_MAX_TRIES = 5,
378 /* sometimes resuming a link requires several retries */
379 ATA_LINK_RESUME_TRIES = 5,
381 /* how hard are we gonna try to probe/recover devices */
382 ATA_PROBE_MAX_TRIES = 3,
383 ATA_EH_DEV_TRIES = 3,
384 ATA_EH_PMP_TRIES = 5,
385 ATA_EH_PMP_LINK_TRIES = 3,
387 SATA_PMP_RW_TIMEOUT = 3000, /* PMP read/write timeout */
389 /* This should match the actual table size of
390 * ata_eh_cmd_timeout_table in libata-eh.c.
392 ATA_EH_CMD_TIMEOUT_TABLE_SIZE = 6,
394 /* Horkage types. May be set by libata or controller on drives
395 (some horkage may be drive/controller pair dependent */
397 ATA_HORKAGE_DIAGNOSTIC = (1 << 0), /* Failed boot diag */
398 ATA_HORKAGE_NODMA = (1 << 1), /* DMA problems */
399 ATA_HORKAGE_NONCQ = (1 << 2), /* Don't use NCQ */
400 ATA_HORKAGE_MAX_SEC_128 = (1 << 3), /* Limit max sects to 128 */
401 ATA_HORKAGE_BROKEN_HPA = (1 << 4), /* Broken HPA */
402 ATA_HORKAGE_DISABLE = (1 << 5), /* Disable it */
403 ATA_HORKAGE_HPA_SIZE = (1 << 6), /* native size off by one */
404 ATA_HORKAGE_IVB = (1 << 8), /* cbl det validity bit bugs */
405 ATA_HORKAGE_STUCK_ERR = (1 << 9), /* stuck ERR on next PACKET */
406 ATA_HORKAGE_BRIDGE_OK = (1 << 10), /* no bridge limits */
407 ATA_HORKAGE_ATAPI_MOD16_DMA = (1 << 11), /* use ATAPI DMA for commands
408 not multiple of 16 bytes */
409 ATA_HORKAGE_FIRMWARE_WARN = (1 << 12), /* firmware update warning */
410 ATA_HORKAGE_1_5_GBPS = (1 << 13), /* force 1.5 Gbps */
411 ATA_HORKAGE_NOSETXFER = (1 << 14), /* skip SETXFER, SATA only */
412 ATA_HORKAGE_BROKEN_FPDMA_AA = (1 << 15), /* skip AA */
413 ATA_HORKAGE_DUMP_ID = (1 << 16), /* dump IDENTIFY data */
414 ATA_HORKAGE_MAX_SEC_LBA48 = (1 << 17), /* Set max sects to 65535 */
415 ATA_HORKAGE_ATAPI_DMADIR = (1 << 18), /* device requires dmadir */
416 ATA_HORKAGE_NO_NCQ_TRIM = (1 << 19), /* don't use queued TRIM */
417 ATA_HORKAGE_NOLPM = (1 << 20), /* don't use LPM */
418 ATA_HORKAGE_WD_BROKEN_LPM = (1 << 21), /* some WDs have broken LPM */
419 ATA_HORKAGE_ZERO_AFTER_TRIM = (1 << 22),/* guarantees zero after trim */
420 ATA_HORKAGE_NO_DMA_LOG = (1 << 23), /* don't use DMA for log read */
421 ATA_HORKAGE_NOTRIM = (1 << 24), /* don't use TRIM */
422 ATA_HORKAGE_MAX_SEC_1024 = (1 << 25), /* Limit max sects to 1024 */
424 /* DMA mask for user DMA control: User visible values; DO NOT
426 ATA_DMA_MASK_ATA = (1 << 0), /* DMA on ATA Disk */
427 ATA_DMA_MASK_ATAPI = (1 << 1), /* DMA on ATAPI */
428 ATA_DMA_MASK_CFA = (1 << 2), /* DMA on CF Card */
430 /* ATAPI command types */
431 ATAPI_READ = 0, /* READs */
432 ATAPI_WRITE = 1, /* WRITEs */
433 ATAPI_READ_CD = 2, /* READ CD [MSF] */
434 ATAPI_PASS_THRU = 3, /* SAT pass-thru */
435 ATAPI_MISC = 4, /* the rest */
437 /* Timing constants */
438 ATA_TIMING_SETUP = (1 << 0),
439 ATA_TIMING_ACT8B = (1 << 1),
440 ATA_TIMING_REC8B = (1 << 2),
441 ATA_TIMING_CYC8B = (1 << 3),
442 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
444 ATA_TIMING_ACTIVE = (1 << 4),
445 ATA_TIMING_RECOVER = (1 << 5),
446 ATA_TIMING_DMACK_HOLD = (1 << 6),
447 ATA_TIMING_CYCLE = (1 << 7),
448 ATA_TIMING_UDMA = (1 << 8),
449 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
450 ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
451 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
452 ATA_TIMING_DMACK_HOLD | ATA_TIMING_CYCLE |
456 ATA_ACPI_FILTER_SETXFER = 1 << 0,
457 ATA_ACPI_FILTER_LOCK = 1 << 1,
458 ATA_ACPI_FILTER_DIPM = 1 << 2,
459 ATA_ACPI_FILTER_FPDMA_OFFSET = 1 << 3, /* FPDMA non-zero offset */
460 ATA_ACPI_FILTER_FPDMA_AA = 1 << 4, /* FPDMA auto activate */
462 ATA_ACPI_FILTER_DEFAULT = ATA_ACPI_FILTER_SETXFER |
463 ATA_ACPI_FILTER_LOCK |
464 ATA_ACPI_FILTER_DIPM,
468 ATA_MASK_PIO = ((1LU << ATA_NR_PIO_MODES) - 1)
470 ATA_MASK_MWDMA = ((1LU << ATA_NR_MWDMA_MODES) - 1)
472 ATA_MASK_UDMA = ((1LU << ATA_NR_UDMA_MODES) - 1)
476 enum hsm_task_states {
477 HSM_ST_IDLE, /* no command on going */
478 HSM_ST_FIRST, /* (waiting the device to)
479 write CDB or first data block */
480 HSM_ST, /* (waiting the device to) transfer data */
481 HSM_ST_LAST, /* (waiting the device to) complete command */
482 HSM_ST_ERR, /* error */
485 enum ata_completion_errors {
486 AC_ERR_OK = 0, /* no error */
487 AC_ERR_DEV = (1 << 0), /* device reported error */
488 AC_ERR_HSM = (1 << 1), /* host state machine violation */
489 AC_ERR_TIMEOUT = (1 << 2), /* timeout */
490 AC_ERR_MEDIA = (1 << 3), /* media error */
491 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
492 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
493 AC_ERR_SYSTEM = (1 << 6), /* system error */
494 AC_ERR_INVALID = (1 << 7), /* invalid argument */
495 AC_ERR_OTHER = (1 << 8), /* unknown */
496 AC_ERR_NODEV_HINT = (1 << 9), /* polling device detection hint */
497 AC_ERR_NCQ = (1 << 10), /* marker for offending NCQ qc */
501 * Link power management policy: If you alter this, you also need to
502 * alter libata-scsi.c (for the ascii descriptions)
504 enum ata_lpm_policy {
508 ATA_LPM_MED_POWER_WITH_DIPM, /* Med power + DIPM as win IRST does */
509 ATA_LPM_MIN_POWER_WITH_PARTIAL, /* Min Power + partial and slumber */
510 ATA_LPM_MIN_POWER, /* Min power + no partial (slumber only) */
514 ATA_LPM_EMPTY = (1 << 0), /* port empty/probing */
515 ATA_LPM_HIPM = (1 << 1), /* may use HIPM */
516 ATA_LPM_WAKE_ONLY = (1 << 2), /* only wake up link */
519 /* forward declarations */
521 struct ata_port_operations;
524 struct ata_queued_cmd;
527 typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
528 typedef int (*ata_prereset_fn_t)(struct ata_link *link, unsigned long deadline);
529 typedef int (*ata_reset_fn_t)(struct ata_link *link, unsigned int *classes,
530 unsigned long deadline);
531 typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes);
533 extern struct device_attribute dev_attr_link_power_management_policy;
534 extern struct device_attribute dev_attr_unload_heads;
535 extern struct device_attribute dev_attr_ncq_prio_enable;
536 extern struct device_attribute dev_attr_em_message_type;
537 extern struct device_attribute dev_attr_em_message;
538 extern struct device_attribute dev_attr_sw_activity;
546 struct ata_taskfile {
547 unsigned long flags; /* ATA_TFLAG_xxx */
548 u8 protocol; /* ATA_PROT_xxx */
550 u8 ctl; /* control reg */
552 u8 hob_feature; /* additional data */
553 u8 hob_nsect; /* to support LBA48 */
566 u8 command; /* IO operation */
568 u32 auxiliary; /* auxiliary field */
569 /* from SATA 3.1 and */
573 #ifdef CONFIG_ATA_SFF
575 void __iomem *cmd_addr;
576 void __iomem *data_addr;
577 void __iomem *error_addr;
578 void __iomem *feature_addr;
579 void __iomem *nsect_addr;
580 void __iomem *lbal_addr;
581 void __iomem *lbam_addr;
582 void __iomem *lbah_addr;
583 void __iomem *device_addr;
584 void __iomem *status_addr;
585 void __iomem *command_addr;
586 void __iomem *altstatus_addr;
587 void __iomem *ctl_addr;
588 #ifdef CONFIG_ATA_BMDMA
589 void __iomem *bmdma_addr;
590 #endif /* CONFIG_ATA_BMDMA */
591 void __iomem *scr_addr;
593 #endif /* CONFIG_ATA_SFF */
598 void __iomem * const *iomap;
599 unsigned int n_ports;
600 unsigned int n_tags; /* nr of NCQ tags */
602 struct ata_port_operations *ops;
606 struct mutex eh_mutex;
607 struct task_struct *eh_owner;
609 struct ata_port *simplex_claimed; /* channel owning the DMA */
610 struct ata_port *ports[0];
613 struct ata_queued_cmd {
615 struct ata_device *dev;
617 struct scsi_cmnd *scsicmd;
618 void (*scsidone)(struct scsi_cmnd *);
620 struct ata_taskfile tf;
621 u8 cdb[ATAPI_CDB_LEN];
623 unsigned long flags; /* ATA_QCFLAG_xxx */
624 unsigned int tag; /* libata core tag */
625 unsigned int hw_tag; /* driver tag */
627 unsigned int orig_n_elem;
631 unsigned int sect_size;
634 unsigned int extrabytes;
635 unsigned int curbytes;
637 struct scatterlist sgent;
639 struct scatterlist *sg;
641 struct scatterlist *cursg;
642 unsigned int cursg_ofs;
644 unsigned int err_mask;
645 struct ata_taskfile result_tf;
646 ata_qc_cb_t complete_fn;
652 struct ata_port_stats {
653 unsigned long unhandled_irq;
654 unsigned long idle_irq;
655 unsigned long rw_reqbuf;
658 struct ata_ering_entry {
660 unsigned int err_mask;
666 struct ata_ering_entry ring[ATA_ERING_SIZE];
670 struct ata_link *link;
671 unsigned int devno; /* 0 or 1 */
672 unsigned int horkage; /* List of broken features */
673 unsigned long flags; /* ATA_DFLAG_xxx */
674 struct scsi_device *sdev; /* attached SCSI device */
676 #ifdef CONFIG_ATA_ACPI
677 union acpi_object *gtf_cache;
678 unsigned int gtf_filter;
680 #ifdef CONFIG_SATA_ZPODD
684 /* n_sector is CLEAR_BEGIN, read comment above CLEAR_BEGIN */
685 u64 n_sectors; /* size of device, if ATA */
686 u64 n_native_sectors; /* native size, if ATA */
687 unsigned int class; /* ATA_DEV_xxx */
688 unsigned long unpark_deadline;
693 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
695 unsigned int multi_count; /* sectors count for
696 READ/WRITE MULTIPLE */
697 unsigned int max_sectors; /* per-device max sectors */
698 unsigned int cdb_len;
700 /* per-dev xfer mask */
701 unsigned long pio_mask;
702 unsigned long mwdma_mask;
703 unsigned long udma_mask;
705 /* for CHS addressing */
706 u16 cylinders; /* Number of cylinders */
707 u16 heads; /* Number of heads */
708 u16 sectors; /* Number of sectors per track */
711 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
712 u32 gscr[SATA_PMP_GSCR_DWORDS]; /* PMP GSCR block */
713 } ____cacheline_aligned;
715 /* DEVSLP Timing Variables from Identify Device Data Log */
716 u8 devslp_timing[ATA_LOG_DEVSLP_SIZE];
718 /* NCQ send and receive log subcommand support */
719 u8 ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_SIZE];
720 u8 ncq_non_data_cmds[ATA_LOG_NCQ_NON_DATA_SIZE];
722 /* ZAC zone configuration */
724 u32 zac_zones_optimal_open;
725 u32 zac_zones_optimal_nonseq;
726 u32 zac_zones_max_open;
730 /* ering is CLEAR_END, read comment above CLEAR_END */
731 struct ata_ering ering;
734 /* Fields between ATA_DEVICE_CLEAR_BEGIN and ATA_DEVICE_CLEAR_END are
735 * cleared to zero on ata_dev_init().
737 #define ATA_DEVICE_CLEAR_BEGIN offsetof(struct ata_device, n_sectors)
738 #define ATA_DEVICE_CLEAR_END offsetof(struct ata_device, ering)
741 struct ata_device *dev; /* offending device */
742 u32 serror; /* SError from LLDD */
743 unsigned int err_mask; /* port-wide err_mask */
744 unsigned int action; /* ATA_EH_* action mask */
745 unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */
746 unsigned int flags; /* ATA_EHI_* flags */
748 unsigned int probe_mask;
750 char desc[ATA_EH_DESC_LEN];
754 struct ata_eh_context {
755 struct ata_eh_info i;
756 int tries[ATA_MAX_DEVICES];
757 int cmd_timeout_idx[ATA_MAX_DEVICES]
758 [ATA_EH_CMD_TIMEOUT_TABLE_SIZE];
759 unsigned int classes[ATA_MAX_DEVICES];
760 unsigned int did_probe_mask;
761 unsigned int unloaded_mask;
762 unsigned int saved_ncq_enabled;
763 u8 saved_xfer_mode[ATA_MAX_DEVICES];
764 /* timestamp for the last reset attempt or success */
765 unsigned long last_reset;
768 struct ata_acpi_drive
774 struct ata_acpi_gtm {
775 struct ata_acpi_drive drive[2];
781 int pmp; /* port multiplier port # */
784 unsigned int active_tag; /* active tag on this link */
785 u32 sactive; /* active NCQ commands */
787 unsigned int flags; /* ATA_LFLAG_xxx */
789 u32 saved_scontrol; /* SControl on probe */
790 unsigned int hw_sata_spd_limit;
791 unsigned int sata_spd_limit;
792 unsigned int sata_spd; /* current SATA PHY speed */
793 enum ata_lpm_policy lpm_policy;
795 /* record runtime error info, protected by host_set lock */
796 struct ata_eh_info eh_info;
798 struct ata_eh_context eh_context;
800 struct ata_device device[ATA_MAX_DEVICES];
802 unsigned long last_lpm_change; /* when last LPM change happened */
804 #define ATA_LINK_CLEAR_BEGIN offsetof(struct ata_link, active_tag)
805 #define ATA_LINK_CLEAR_END offsetof(struct ata_link, device[0])
808 struct Scsi_Host *scsi_host; /* our co-allocated scsi host */
809 struct ata_port_operations *ops;
811 /* Flags owned by the EH context. Only EH should touch these once the
813 unsigned long flags; /* ATA_FLAG_xxx */
814 /* Flags that change dynamically, protected by ap->lock */
815 unsigned int pflags; /* ATA_PFLAG_xxx */
816 unsigned int print_id; /* user visible unique port ID */
817 unsigned int local_port_no; /* host local port num */
818 unsigned int port_no; /* 0 based port no. inside the host */
820 #ifdef CONFIG_ATA_SFF
821 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
822 u8 ctl; /* cache of ATA control register */
823 u8 last_ctl; /* Cache last written value */
824 struct ata_link* sff_pio_task_link; /* link currently used */
825 struct delayed_work sff_pio_task;
826 #ifdef CONFIG_ATA_BMDMA
827 struct ata_bmdma_prd *bmdma_prd; /* BMDMA SG list */
828 dma_addr_t bmdma_prd_dma; /* and its DMA mapping */
829 #endif /* CONFIG_ATA_BMDMA */
830 #endif /* CONFIG_ATA_SFF */
832 unsigned int pio_mask;
833 unsigned int mwdma_mask;
834 unsigned int udma_mask;
835 unsigned int cbl; /* cable type; ATA_CBL_xxx */
837 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE + 1];
838 unsigned long sas_tag_allocated; /* for sas tag allocation only */
840 int nr_active_links; /* #links with active qcs */
841 unsigned int sas_last_tag; /* track next tag hw expects */
843 struct ata_link link; /* host default link */
844 struct ata_link *slave_link; /* see ata_slave_link_init() */
846 int nr_pmp_links; /* nr of available PMP links */
847 struct ata_link *pmp_link; /* array of PMP links */
848 struct ata_link *excl_link; /* for PMP qc exclusion */
850 struct ata_port_stats stats;
851 struct ata_host *host;
855 struct mutex scsi_scan_mutex;
856 struct delayed_work hotplug_task;
857 struct work_struct scsi_rescan_task;
859 unsigned int hsm_task_state;
862 struct list_head eh_done_q;
863 wait_queue_head_t eh_wait_q;
865 struct completion park_req_pending;
867 pm_message_t pm_mesg;
868 enum ata_lpm_policy target_lpm_policy;
870 struct timer_list fastdrain_timer;
871 unsigned long fastdrain_cnt;
876 #ifdef CONFIG_ATA_ACPI
877 struct ata_acpi_gtm __acpi_init_gtm; /* use ata_acpi_init_gtm() */
880 u8 sector_buf[ATA_SECT_SIZE] ____cacheline_aligned;
883 /* The following initializer overrides a method to NULL whether one of
884 * its parent has the method defined or not. This is equivalent to
885 * ERR_PTR(-ENOENT). Unfortunately, ERR_PTR doesn't render a constant
886 * expression and thus can't be used as an initializer.
888 #define ATA_OP_NULL (void *)(unsigned long)(-ENOENT)
890 struct ata_port_operations {
894 int (*qc_defer)(struct ata_queued_cmd *qc);
895 int (*check_atapi_dma)(struct ata_queued_cmd *qc);
896 enum ata_completion_errors (*qc_prep)(struct ata_queued_cmd *qc);
897 unsigned int (*qc_issue)(struct ata_queued_cmd *qc);
898 bool (*qc_fill_rtf)(struct ata_queued_cmd *qc);
901 * Configuration and exception handling
903 int (*cable_detect)(struct ata_port *ap);
904 unsigned long (*mode_filter)(struct ata_device *dev, unsigned long xfer_mask);
905 void (*set_piomode)(struct ata_port *ap, struct ata_device *dev);
906 void (*set_dmamode)(struct ata_port *ap, struct ata_device *dev);
907 int (*set_mode)(struct ata_link *link, struct ata_device **r_failed_dev);
908 unsigned int (*read_id)(struct ata_device *dev, struct ata_taskfile *tf, u16 *id);
910 void (*dev_config)(struct ata_device *dev);
912 void (*freeze)(struct ata_port *ap);
913 void (*thaw)(struct ata_port *ap);
914 ata_prereset_fn_t prereset;
915 ata_reset_fn_t softreset;
916 ata_reset_fn_t hardreset;
917 ata_postreset_fn_t postreset;
918 ata_prereset_fn_t pmp_prereset;
919 ata_reset_fn_t pmp_softreset;
920 ata_reset_fn_t pmp_hardreset;
921 ata_postreset_fn_t pmp_postreset;
922 void (*error_handler)(struct ata_port *ap);
923 void (*lost_interrupt)(struct ata_port *ap);
924 void (*post_internal_cmd)(struct ata_queued_cmd *qc);
925 void (*sched_eh)(struct ata_port *ap);
926 void (*end_eh)(struct ata_port *ap);
931 int (*scr_read)(struct ata_link *link, unsigned int sc_reg, u32 *val);
932 int (*scr_write)(struct ata_link *link, unsigned int sc_reg, u32 val);
933 void (*pmp_attach)(struct ata_port *ap);
934 void (*pmp_detach)(struct ata_port *ap);
935 int (*set_lpm)(struct ata_link *link, enum ata_lpm_policy policy,
939 * Start, stop, suspend and resume
941 int (*port_suspend)(struct ata_port *ap, pm_message_t mesg);
942 int (*port_resume)(struct ata_port *ap);
943 int (*port_start)(struct ata_port *ap);
944 void (*port_stop)(struct ata_port *ap);
945 void (*host_stop)(struct ata_host *host);
947 #ifdef CONFIG_ATA_SFF
949 * SFF / taskfile oriented ops
951 void (*sff_dev_select)(struct ata_port *ap, unsigned int device);
952 void (*sff_set_devctl)(struct ata_port *ap, u8 ctl);
953 u8 (*sff_check_status)(struct ata_port *ap);
954 u8 (*sff_check_altstatus)(struct ata_port *ap);
955 void (*sff_tf_load)(struct ata_port *ap, const struct ata_taskfile *tf);
956 void (*sff_tf_read)(struct ata_port *ap, struct ata_taskfile *tf);
957 void (*sff_exec_command)(struct ata_port *ap,
958 const struct ata_taskfile *tf);
959 unsigned int (*sff_data_xfer)(struct ata_queued_cmd *qc,
960 unsigned char *buf, unsigned int buflen, int rw);
961 void (*sff_irq_on)(struct ata_port *);
962 bool (*sff_irq_check)(struct ata_port *);
963 void (*sff_irq_clear)(struct ata_port *);
964 void (*sff_drain_fifo)(struct ata_queued_cmd *qc);
966 #ifdef CONFIG_ATA_BMDMA
967 void (*bmdma_setup)(struct ata_queued_cmd *qc);
968 void (*bmdma_start)(struct ata_queued_cmd *qc);
969 void (*bmdma_stop)(struct ata_queued_cmd *qc);
970 u8 (*bmdma_status)(struct ata_port *ap);
971 #endif /* CONFIG_ATA_BMDMA */
972 #endif /* CONFIG_ATA_SFF */
974 ssize_t (*em_show)(struct ata_port *ap, char *buf);
975 ssize_t (*em_store)(struct ata_port *ap, const char *message,
977 ssize_t (*sw_activity_show)(struct ata_device *dev, char *buf);
978 ssize_t (*sw_activity_store)(struct ata_device *dev,
979 enum sw_activity val);
980 ssize_t (*transmit_led_message)(struct ata_port *ap, u32 state,
986 void (*phy_reset)(struct ata_port *ap);
987 void (*eng_timeout)(struct ata_port *ap);
990 * ->inherits must be the last field and all the preceding
991 * fields must be pointers.
993 const struct ata_port_operations *inherits;
996 struct ata_port_info {
998 unsigned long link_flags;
999 unsigned long pio_mask;
1000 unsigned long mwdma_mask;
1001 unsigned long udma_mask;
1002 struct ata_port_operations *port_ops;
1007 unsigned short mode; /* ATA mode */
1008 unsigned short setup; /* t1 */
1009 unsigned short act8b; /* t2 for 8-bit I/O */
1010 unsigned short rec8b; /* t2i for 8-bit I/O */
1011 unsigned short cyc8b; /* t0 for 8-bit I/O */
1012 unsigned short active; /* t2 or tD */
1013 unsigned short recover; /* t2i or tK */
1014 unsigned short dmack_hold; /* tj */
1015 unsigned short cycle; /* t0 */
1016 unsigned short udma; /* t2CYCTYP/2 */
1020 * Core layer - drivers/ata/libata-core.c
1022 extern const unsigned long sata_deb_timing_normal[];
1023 extern const unsigned long sata_deb_timing_hotplug[];
1024 extern const unsigned long sata_deb_timing_long[];
1026 extern struct ata_port_operations ata_dummy_port_ops;
1027 extern const struct ata_port_info ata_dummy_port_info;
1029 static inline bool ata_is_atapi(u8 prot)
1031 return prot & ATA_PROT_FLAG_ATAPI;
1034 static inline bool ata_is_pio(u8 prot)
1036 return prot & ATA_PROT_FLAG_PIO;
1039 static inline bool ata_is_dma(u8 prot)
1041 return prot & ATA_PROT_FLAG_DMA;
1044 static inline bool ata_is_ncq(u8 prot)
1046 return prot & ATA_PROT_FLAG_NCQ;
1049 static inline bool ata_is_data(u8 prot)
1051 return prot & (ATA_PROT_FLAG_PIO | ATA_PROT_FLAG_DMA);
1054 static inline int is_multi_taskfile(struct ata_taskfile *tf)
1056 return (tf->command == ATA_CMD_READ_MULTI) ||
1057 (tf->command == ATA_CMD_WRITE_MULTI) ||
1058 (tf->command == ATA_CMD_READ_MULTI_EXT) ||
1059 (tf->command == ATA_CMD_WRITE_MULTI_EXT) ||
1060 (tf->command == ATA_CMD_WRITE_MULTI_FUA_EXT);
1063 static inline const unsigned long *
1064 sata_ehc_deb_timing(struct ata_eh_context *ehc)
1066 if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
1067 return sata_deb_timing_hotplug;
1069 return sata_deb_timing_normal;
1072 static inline int ata_port_is_dummy(struct ata_port *ap)
1074 return ap->ops == &ata_dummy_port_ops;
1077 extern int sata_set_spd(struct ata_link *link);
1078 extern int ata_std_prereset(struct ata_link *link, unsigned long deadline);
1079 extern int ata_wait_after_reset(struct ata_link *link, unsigned long deadline,
1080 int (*check_ready)(struct ata_link *link));
1081 extern int sata_link_debounce(struct ata_link *link,
1082 const unsigned long *params, unsigned long deadline);
1083 extern int sata_link_resume(struct ata_link *link, const unsigned long *params,
1084 unsigned long deadline);
1085 extern int sata_link_hardreset(struct ata_link *link,
1086 const unsigned long *timing, unsigned long deadline,
1087 bool *online, int (*check_ready)(struct ata_link *));
1088 extern int sata_std_hardreset(struct ata_link *link, unsigned int *class,
1089 unsigned long deadline);
1090 extern void ata_std_postreset(struct ata_link *link, unsigned int *classes);
1092 extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
1093 extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
1094 const struct ata_port_info * const * ppi, int n_ports);
1095 extern void ata_host_get(struct ata_host *host);
1096 extern void ata_host_put(struct ata_host *host);
1097 extern int ata_host_start(struct ata_host *host);
1098 extern int ata_host_register(struct ata_host *host,
1099 struct scsi_host_template *sht);
1100 extern int ata_host_activate(struct ata_host *host, int irq,
1101 irq_handler_t irq_handler, unsigned long irq_flags,
1102 struct scsi_host_template *sht);
1103 extern void ata_host_detach(struct ata_host *host);
1104 extern void ata_host_init(struct ata_host *, struct device *, struct ata_port_operations *);
1105 extern int ata_scsi_detect(struct scsi_host_template *sht);
1106 extern int ata_scsi_ioctl(struct scsi_device *dev, unsigned int cmd,
1108 #ifdef CONFIG_COMPAT
1109 #define ATA_SCSI_COMPAT_IOCTL .compat_ioctl = ata_scsi_ioctl,
1111 #define ATA_SCSI_COMPAT_IOCTL /* empty */
1113 extern int ata_scsi_queuecmd(struct Scsi_Host *h, struct scsi_cmnd *cmd);
1114 extern int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *dev,
1115 unsigned int cmd, void __user *arg);
1116 extern void ata_sas_port_destroy(struct ata_port *);
1117 extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
1118 struct ata_port_info *, struct Scsi_Host *);
1119 extern void ata_sas_async_probe(struct ata_port *ap);
1120 extern int ata_sas_sync_probe(struct ata_port *ap);
1121 extern int ata_sas_port_init(struct ata_port *);
1122 extern int ata_sas_port_start(struct ata_port *ap);
1123 extern int ata_sas_tport_add(struct device *parent, struct ata_port *ap);
1124 extern void ata_sas_tport_delete(struct ata_port *ap);
1125 extern void ata_sas_port_stop(struct ata_port *ap);
1126 extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
1127 extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, struct ata_port *ap);
1128 extern bool ata_link_online(struct ata_link *link);
1129 extern bool ata_link_offline(struct ata_link *link);
1131 extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
1132 extern void ata_host_resume(struct ata_host *host);
1133 extern void ata_sas_port_suspend(struct ata_port *ap);
1134 extern void ata_sas_port_resume(struct ata_port *ap);
1136 static inline void ata_sas_port_suspend(struct ata_port *ap)
1139 static inline void ata_sas_port_resume(struct ata_port *ap)
1143 extern int ata_ratelimit(void);
1144 extern void ata_msleep(struct ata_port *ap, unsigned int msecs);
1145 extern u32 ata_wait_register(struct ata_port *ap, void __iomem *reg, u32 mask,
1146 u32 val, unsigned long interval, unsigned long timeout);
1147 extern int atapi_cmd_type(u8 opcode);
1148 extern unsigned long ata_pack_xfermask(unsigned long pio_mask,
1149 unsigned long mwdma_mask, unsigned long udma_mask);
1150 extern void ata_unpack_xfermask(unsigned long xfer_mask,
1151 unsigned long *pio_mask, unsigned long *mwdma_mask,
1152 unsigned long *udma_mask);
1153 extern u8 ata_xfer_mask2mode(unsigned long xfer_mask);
1154 extern unsigned long ata_xfer_mode2mask(u8 xfer_mode);
1155 extern int ata_xfer_mode2shift(unsigned long xfer_mode);
1156 extern const char *ata_mode_string(unsigned long xfer_mask);
1157 extern unsigned long ata_id_xfermask(const u16 *id);
1158 extern int ata_std_qc_defer(struct ata_queued_cmd *qc);
1159 extern enum ata_completion_errors ata_noop_qc_prep(struct ata_queued_cmd *qc);
1160 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
1161 unsigned int n_elem);
1162 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
1163 extern void ata_dev_disable(struct ata_device *adev);
1164 extern void ata_id_string(const u16 *id, unsigned char *s,
1165 unsigned int ofs, unsigned int len);
1166 extern void ata_id_c_string(const u16 *id, unsigned char *s,
1167 unsigned int ofs, unsigned int len);
1168 extern unsigned int ata_do_dev_read_id(struct ata_device *dev,
1169 struct ata_taskfile *tf, u16 *id);
1170 extern void ata_qc_complete(struct ata_queued_cmd *qc);
1171 extern int ata_qc_complete_multiple(struct ata_port *ap, u64 qc_active);
1172 extern u64 ata_qc_get_active(struct ata_port *ap);
1173 extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd);
1174 extern int ata_std_bios_param(struct scsi_device *sdev,
1175 struct block_device *bdev,
1176 sector_t capacity, int geom[]);
1177 extern void ata_scsi_unlock_native_capacity(struct scsi_device *sdev);
1178 extern int ata_scsi_slave_config(struct scsi_device *sdev);
1179 extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
1180 extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
1182 extern int __ata_change_queue_depth(struct ata_port *ap, struct scsi_device *sdev,
1184 extern struct ata_device *ata_dev_pair(struct ata_device *adev);
1185 extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
1186 extern void ata_scsi_port_error_handler(struct Scsi_Host *host, struct ata_port *ap);
1187 extern void ata_scsi_cmd_error_handler(struct Scsi_Host *host, struct ata_port *ap, struct list_head *eh_q);
1190 * SATA specific code - drivers/ata/libata-sata.c
1192 #ifdef CONFIG_SATA_HOST
1193 extern int sata_scr_valid(struct ata_link *link);
1194 extern int sata_scr_read(struct ata_link *link, int reg, u32 *val);
1195 extern int sata_scr_write(struct ata_link *link, int reg, u32 val);
1196 extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val);
1198 static inline int sata_scr_valid(struct ata_link *link) { return 0; }
1199 static inline int sata_scr_read(struct ata_link *link, int reg, u32 *val)
1203 static inline int sata_scr_write(struct ata_link *link, int reg, u32 val)
1207 static inline int sata_scr_write_flush(struct ata_link *link, int reg, u32 val)
1212 extern int sata_link_scr_lpm(struct ata_link *link, enum ata_lpm_policy policy,
1214 extern int ata_slave_link_init(struct ata_port *ap);
1215 extern void ata_tf_to_fis(const struct ata_taskfile *tf,
1216 u8 pmp, int is_cmd, u8 *fis);
1217 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
1218 extern bool sata_lpm_ignore_phy_events(struct ata_link *link);
1220 extern int ata_cable_40wire(struct ata_port *ap);
1221 extern int ata_cable_80wire(struct ata_port *ap);
1222 extern int ata_cable_sata(struct ata_port *ap);
1223 extern int ata_cable_ignore(struct ata_port *ap);
1224 extern int ata_cable_unknown(struct ata_port *ap);
1226 /* Timing helpers */
1227 extern unsigned int ata_pio_need_iordy(const struct ata_device *);
1228 extern u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle);
1235 unsigned int reg; /* PCI config register to read */
1236 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
1241 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
1242 extern void ata_pci_shutdown_one(struct pci_dev *pdev);
1243 extern void ata_pci_remove_one(struct pci_dev *pdev);
1246 extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
1247 extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
1248 extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
1249 extern int ata_pci_device_resume(struct pci_dev *pdev);
1250 #endif /* CONFIG_PM */
1251 #endif /* CONFIG_PCI */
1253 struct platform_device;
1255 extern int ata_platform_remove_one(struct platform_device *pdev);
1258 * ACPI - drivers/ata/libata-acpi.c
1260 #ifdef CONFIG_ATA_ACPI
1261 static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1263 if (ap->pflags & ATA_PFLAG_INIT_GTM_VALID)
1264 return &ap->__acpi_init_gtm;
1267 int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm);
1268 int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *stm);
1269 unsigned long ata_acpi_gtm_xfermask(struct ata_device *dev,
1270 const struct ata_acpi_gtm *gtm);
1271 int ata_acpi_cbl_80wire(struct ata_port *ap, const struct ata_acpi_gtm *gtm);
1273 static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1278 static inline int ata_acpi_stm(const struct ata_port *ap,
1279 struct ata_acpi_gtm *stm)
1284 static inline int ata_acpi_gtm(const struct ata_port *ap,
1285 struct ata_acpi_gtm *stm)
1290 static inline unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev,
1291 const struct ata_acpi_gtm *gtm)
1296 static inline int ata_acpi_cbl_80wire(struct ata_port *ap,
1297 const struct ata_acpi_gtm *gtm)
1304 * EH - drivers/ata/libata-eh.c
1306 extern void ata_port_schedule_eh(struct ata_port *ap);
1307 extern void ata_port_wait_eh(struct ata_port *ap);
1308 extern int ata_link_abort(struct ata_link *link);
1309 extern int ata_port_abort(struct ata_port *ap);
1310 extern int ata_port_freeze(struct ata_port *ap);
1311 extern int sata_async_notification(struct ata_port *ap);
1313 extern void ata_eh_freeze_port(struct ata_port *ap);
1314 extern void ata_eh_thaw_port(struct ata_port *ap);
1316 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
1317 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
1318 extern void ata_eh_analyze_ncq_error(struct ata_link *link);
1320 extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
1321 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
1322 ata_postreset_fn_t postreset);
1323 extern void ata_std_error_handler(struct ata_port *ap);
1324 extern void ata_std_sched_eh(struct ata_port *ap);
1325 extern void ata_std_end_eh(struct ata_port *ap);
1326 extern int ata_link_nr_enabled(struct ata_link *link);
1329 * Base operations to inherit from and initializers for sht
1333 * base : Common to all libata drivers.
1334 * sata : SATA controllers w/ native interface.
1335 * pmp : SATA controllers w/ PMP support.
1336 * sff : SFF ATA controllers w/o BMDMA support.
1337 * bmdma : SFF ATA controllers w/ BMDMA support.
1341 * BASE : Common to all libata drivers. The user must set
1342 * sg_tablesize and dma_boundary.
1343 * PIO : SFF ATA controllers w/ only PIO support.
1344 * BMDMA : SFF ATA controllers w/ BMDMA support. sg_tablesize and
1345 * dma_boundary are set to BMDMA limits.
1346 * NCQ : SATA controllers supporting NCQ. The user must set
1347 * sg_tablesize, dma_boundary and can_queue.
1349 extern const struct ata_port_operations ata_base_port_ops;
1350 extern const struct ata_port_operations sata_port_ops;
1351 extern struct device_attribute *ata_common_sdev_attrs[];
1352 extern struct device_attribute *ata_ncq_sdev_attrs[];
1355 * All sht initializers (BASE, PIO, BMDMA, NCQ) must be instantiated
1356 * by the edge drivers. Because the 'module' field of sht must be the
1357 * edge driver's module reference, otherwise the driver can be unloaded
1358 * even if the scsi_device is being accessed.
1360 #define __ATA_BASE_SHT(drv_name) \
1361 .module = THIS_MODULE, \
1363 .ioctl = ata_scsi_ioctl, \
1364 ATA_SCSI_COMPAT_IOCTL \
1365 .queuecommand = ata_scsi_queuecmd, \
1366 .can_queue = ATA_DEF_QUEUE, \
1367 .tag_alloc_policy = BLK_TAG_ALLOC_RR, \
1368 .this_id = ATA_SHT_THIS_ID, \
1369 .emulated = ATA_SHT_EMULATED, \
1370 .proc_name = drv_name, \
1371 .slave_configure = ata_scsi_slave_config, \
1372 .slave_destroy = ata_scsi_slave_destroy, \
1373 .bios_param = ata_std_bios_param, \
1374 .unlock_native_capacity = ata_scsi_unlock_native_capacity
1376 #define ATA_BASE_SHT(drv_name) \
1377 __ATA_BASE_SHT(drv_name), \
1378 .sdev_attrs = ata_common_sdev_attrs
1380 #define ATA_NCQ_SHT(drv_name) \
1381 __ATA_BASE_SHT(drv_name), \
1382 .sdev_attrs = ata_ncq_sdev_attrs, \
1383 .change_queue_depth = ata_scsi_change_queue_depth
1388 #ifdef CONFIG_SATA_PMP
1389 static inline bool sata_pmp_supported(struct ata_port *ap)
1391 return ap->flags & ATA_FLAG_PMP;
1394 static inline bool sata_pmp_attached(struct ata_port *ap)
1396 return ap->nr_pmp_links != 0;
1399 static inline bool ata_is_host_link(const struct ata_link *link)
1401 return link == &link->ap->link || link == link->ap->slave_link;
1403 #else /* CONFIG_SATA_PMP */
1404 static inline bool sata_pmp_supported(struct ata_port *ap)
1409 static inline bool sata_pmp_attached(struct ata_port *ap)
1414 static inline bool ata_is_host_link(const struct ata_link *link)
1418 #endif /* CONFIG_SATA_PMP */
1420 static inline int sata_srst_pmp(struct ata_link *link)
1422 if (sata_pmp_supported(link->ap) && ata_is_host_link(link))
1423 return SATA_PMP_CTRL_PORT;
1431 void ata_port_printk(const struct ata_port *ap, const char *level,
1432 const char *fmt, ...);
1434 void ata_link_printk(const struct ata_link *link, const char *level,
1435 const char *fmt, ...);
1437 void ata_dev_printk(const struct ata_device *dev, const char *level,
1438 const char *fmt, ...);
1440 #define ata_port_err(ap, fmt, ...) \
1441 ata_port_printk(ap, KERN_ERR, fmt, ##__VA_ARGS__)
1442 #define ata_port_warn(ap, fmt, ...) \
1443 ata_port_printk(ap, KERN_WARNING, fmt, ##__VA_ARGS__)
1444 #define ata_port_notice(ap, fmt, ...) \
1445 ata_port_printk(ap, KERN_NOTICE, fmt, ##__VA_ARGS__)
1446 #define ata_port_info(ap, fmt, ...) \
1447 ata_port_printk(ap, KERN_INFO, fmt, ##__VA_ARGS__)
1448 #define ata_port_dbg(ap, fmt, ...) \
1449 ata_port_printk(ap, KERN_DEBUG, fmt, ##__VA_ARGS__)
1451 #define ata_link_err(link, fmt, ...) \
1452 ata_link_printk(link, KERN_ERR, fmt, ##__VA_ARGS__)
1453 #define ata_link_warn(link, fmt, ...) \
1454 ata_link_printk(link, KERN_WARNING, fmt, ##__VA_ARGS__)
1455 #define ata_link_notice(link, fmt, ...) \
1456 ata_link_printk(link, KERN_NOTICE, fmt, ##__VA_ARGS__)
1457 #define ata_link_info(link, fmt, ...) \
1458 ata_link_printk(link, KERN_INFO, fmt, ##__VA_ARGS__)
1459 #define ata_link_dbg(link, fmt, ...) \
1460 ata_link_printk(link, KERN_DEBUG, fmt, ##__VA_ARGS__)
1462 #define ata_dev_err(dev, fmt, ...) \
1463 ata_dev_printk(dev, KERN_ERR, fmt, ##__VA_ARGS__)
1464 #define ata_dev_warn(dev, fmt, ...) \
1465 ata_dev_printk(dev, KERN_WARNING, fmt, ##__VA_ARGS__)
1466 #define ata_dev_notice(dev, fmt, ...) \
1467 ata_dev_printk(dev, KERN_NOTICE, fmt, ##__VA_ARGS__)
1468 #define ata_dev_info(dev, fmt, ...) \
1469 ata_dev_printk(dev, KERN_INFO, fmt, ##__VA_ARGS__)
1470 #define ata_dev_dbg(dev, fmt, ...) \
1471 ata_dev_printk(dev, KERN_DEBUG, fmt, ##__VA_ARGS__)
1473 void ata_print_version(const struct device *dev, const char *version);
1476 * ata_eh_info helpers
1478 extern __printf(2, 3)
1479 void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
1480 extern __printf(2, 3)
1481 void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
1482 extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
1484 static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
1486 ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
1487 ehi->flags |= ATA_EHI_HOTPLUGGED;
1488 ehi->action |= ATA_EH_RESET | ATA_EH_ENABLE_LINK;
1489 ehi->err_mask |= AC_ERR_ATA_BUS;
1493 * port description helpers
1495 extern __printf(2, 3)
1496 void ata_port_desc(struct ata_port *ap, const char *fmt, ...);
1498 extern void ata_port_pbar_desc(struct ata_port *ap, int bar, ssize_t offset,
1502 static inline bool ata_tag_internal(unsigned int tag)
1504 return tag == ATA_TAG_INTERNAL;
1507 static inline bool ata_tag_valid(unsigned int tag)
1509 return tag < ATA_MAX_QUEUE || ata_tag_internal(tag);
1512 #define __ata_qc_for_each(ap, qc, tag, max_tag, fn) \
1513 for ((tag) = 0; (tag) < (max_tag) && \
1514 ({ qc = fn((ap), (tag)); 1; }); (tag)++) \
1517 * Internal use only, iterate commands ignoring error handling and
1520 #define ata_qc_for_each_raw(ap, qc, tag) \
1521 __ata_qc_for_each(ap, qc, tag, ATA_MAX_QUEUE, __ata_qc_from_tag)
1524 * Iterate all potential commands that can be queued
1526 #define ata_qc_for_each(ap, qc, tag) \
1527 __ata_qc_for_each(ap, qc, tag, ATA_MAX_QUEUE, ata_qc_from_tag)
1530 * Like ata_qc_for_each, but with the internal tag included
1532 #define ata_qc_for_each_with_internal(ap, qc, tag) \
1533 __ata_qc_for_each(ap, qc, tag, ATA_MAX_QUEUE + 1, ata_qc_from_tag)
1538 static inline unsigned int ata_class_enabled(unsigned int class)
1540 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI ||
1541 class == ATA_DEV_PMP || class == ATA_DEV_SEMB ||
1542 class == ATA_DEV_ZAC;
1545 static inline unsigned int ata_class_disabled(unsigned int class)
1547 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP ||
1548 class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP ||
1549 class == ATA_DEV_ZAC_UNSUP;
1552 static inline unsigned int ata_class_absent(unsigned int class)
1554 return !ata_class_enabled(class) && !ata_class_disabled(class);
1557 static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1559 return ata_class_enabled(dev->class);
1562 static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1564 return ata_class_disabled(dev->class);
1567 static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1569 return ata_class_absent(dev->class);
1575 static inline int ata_link_max_devices(const struct ata_link *link)
1577 if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS)
1582 static inline int ata_link_active(struct ata_link *link)
1584 return ata_tag_valid(link->active_tag) || link->sactive;
1590 * ATA_LITER_* constants are used to select link iteration mode and
1591 * ATA_DITER_* device iteration mode.
1593 * For a custom iteration directly using ata_{link|dev}_next(), if
1594 * @link or @dev, respectively, is NULL, the first element is
1595 * returned. @dev and @link can be any valid device or link and the
1596 * next element according to the iteration mode will be returned.
1597 * After the last element, NULL is returned.
1599 enum ata_link_iter_mode {
1600 ATA_LITER_EDGE, /* if present, PMP links only; otherwise,
1601 * host link. no slave link */
1602 ATA_LITER_HOST_FIRST, /* host link followed by PMP or slave links */
1603 ATA_LITER_PMP_FIRST, /* PMP links followed by host link,
1604 * slave link still comes after host link */
1607 enum ata_dev_iter_mode {
1609 ATA_DITER_ENABLED_REVERSE,
1611 ATA_DITER_ALL_REVERSE,
1614 extern struct ata_link *ata_link_next(struct ata_link *link,
1615 struct ata_port *ap,
1616 enum ata_link_iter_mode mode);
1618 extern struct ata_device *ata_dev_next(struct ata_device *dev,
1619 struct ata_link *link,
1620 enum ata_dev_iter_mode mode);
1623 * Shortcut notation for iterations
1625 * ata_for_each_link() iterates over each link of @ap according to
1626 * @mode. @link points to the current link in the loop. @link is
1627 * NULL after loop termination. ata_for_each_dev() works the same way
1628 * except that it iterates over each device of @link.
1630 * Note that the mode prefixes ATA_{L|D}ITER_ shouldn't need to be
1631 * specified when using the following shorthand notations. Only the
1632 * mode itself (EDGE, HOST_FIRST, ENABLED, etc...) should be
1633 * specified. This not only increases brevity but also makes it
1634 * impossible to use ATA_LITER_* for device iteration or vice-versa.
1636 #define ata_for_each_link(link, ap, mode) \
1637 for ((link) = ata_link_next(NULL, (ap), ATA_LITER_##mode); (link); \
1638 (link) = ata_link_next((link), (ap), ATA_LITER_##mode))
1640 #define ata_for_each_dev(dev, link, mode) \
1641 for ((dev) = ata_dev_next(NULL, (link), ATA_DITER_##mode); (dev); \
1642 (dev) = ata_dev_next((dev), (link), ATA_DITER_##mode))
1645 * ata_ncq_enabled - Test whether NCQ is enabled
1646 * @dev: ATA device to test for
1649 * spin_lock_irqsave(host lock)
1652 * 1 if NCQ is enabled for @dev, 0 otherwise.
1654 static inline int ata_ncq_enabled(struct ata_device *dev)
1656 if (!IS_ENABLED(CONFIG_SATA_HOST))
1658 return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1659 ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1662 static inline bool ata_fpdma_dsm_supported(struct ata_device *dev)
1664 return (dev->flags & ATA_DFLAG_NCQ_SEND_RECV) &&
1665 (dev->ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_DSM_OFFSET] &
1666 ATA_LOG_NCQ_SEND_RECV_DSM_TRIM);
1669 static inline bool ata_fpdma_read_log_supported(struct ata_device *dev)
1671 return (dev->flags & ATA_DFLAG_NCQ_SEND_RECV) &&
1672 (dev->ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_RD_LOG_OFFSET] &
1673 ATA_LOG_NCQ_SEND_RECV_RD_LOG_SUPPORTED);
1676 static inline bool ata_fpdma_zac_mgmt_in_supported(struct ata_device *dev)
1678 return (dev->flags & ATA_DFLAG_NCQ_SEND_RECV) &&
1679 (dev->ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_ZAC_MGMT_OFFSET] &
1680 ATA_LOG_NCQ_SEND_RECV_ZAC_MGMT_IN_SUPPORTED);
1683 static inline bool ata_fpdma_zac_mgmt_out_supported(struct ata_device *dev)
1685 return (dev->ncq_non_data_cmds[ATA_LOG_NCQ_NON_DATA_ZAC_MGMT_OFFSET] &
1686 ATA_LOG_NCQ_NON_DATA_ZAC_MGMT_OUT);
1689 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1691 qc->tf.ctl |= ATA_NIEN;
1694 static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1697 if (ata_tag_valid(tag))
1698 return &ap->qcmd[tag];
1702 static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1705 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1707 if (unlikely(!qc) || !ap->ops->error_handler)
1710 if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1711 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1717 static inline unsigned int ata_qc_raw_nbytes(struct ata_queued_cmd *qc)
1719 return qc->nbytes - min(qc->extrabytes, qc->nbytes);
1722 static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1724 memset(tf, 0, sizeof(*tf));
1726 #ifdef CONFIG_ATA_SFF
1727 tf->ctl = dev->link->ap->ctl;
1729 tf->ctl = ATA_DEVCTL_OBS;
1731 if (dev->devno == 0)
1732 tf->device = ATA_DEVICE_OBS;
1734 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1737 static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1739 qc->dma_dir = DMA_NONE;
1744 qc->nbytes = qc->extrabytes = qc->curbytes = 0;
1747 qc->sect_size = ATA_SECT_SIZE;
1749 ata_tf_init(qc->dev, &qc->tf);
1751 /* init result_tf such that it indicates normal completion */
1752 qc->result_tf.command = ATA_DRDY;
1753 qc->result_tf.feature = 0;
1756 static inline int ata_try_flush_cache(const struct ata_device *dev)
1758 return ata_id_wcache_enabled(dev->id) ||
1759 ata_id_has_flush(dev->id) ||
1760 ata_id_has_flush_ext(dev->id);
1763 static inline unsigned int ac_err_mask(u8 status)
1765 if (status & (ATA_BUSY | ATA_DRQ))
1767 if (status & (ATA_ERR | ATA_DF))
1772 static inline unsigned int __ac_err_mask(u8 status)
1774 unsigned int mask = ac_err_mask(status);
1776 return AC_ERR_OTHER;
1780 static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1782 return *(struct ata_port **)&host->hostdata[0];
1785 static inline int ata_check_ready(u8 status)
1787 if (!(status & ATA_BUSY))
1790 /* 0xff indicates either no device or device not ready */
1797 static inline unsigned long ata_deadline(unsigned long from_jiffies,
1798 unsigned long timeout_msecs)
1800 return from_jiffies + msecs_to_jiffies(timeout_msecs);
1803 /* Don't open code these in drivers as there are traps. Firstly the range may
1804 change in future hardware and specs, secondly 0xFF means 'no DMA' but is
1805 > UDMA_0. Dyma ddreigiau */
1807 static inline int ata_using_mwdma(struct ata_device *adev)
1809 if (adev->dma_mode >= XFER_MW_DMA_0 && adev->dma_mode <= XFER_MW_DMA_4)
1814 static inline int ata_using_udma(struct ata_device *adev)
1816 if (adev->dma_mode >= XFER_UDMA_0 && adev->dma_mode <= XFER_UDMA_7)
1821 static inline int ata_dma_enabled(struct ata_device *adev)
1823 return (adev->dma_mode == 0xFF ? 0 : 1);
1826 /**************************************************************************
1827 * PATA timings - drivers/ata/libata-pata-timings.c
1829 extern const struct ata_timing *ata_timing_find_mode(u8 xfer_mode);
1830 extern int ata_timing_compute(struct ata_device *, unsigned short,
1831 struct ata_timing *, int, int);
1832 extern void ata_timing_merge(const struct ata_timing *,
1833 const struct ata_timing *, struct ata_timing *,
1836 /**************************************************************************
1837 * PMP - drivers/ata/libata-pmp.c
1839 #ifdef CONFIG_SATA_PMP
1841 extern const struct ata_port_operations sata_pmp_port_ops;
1843 extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc);
1844 extern void sata_pmp_error_handler(struct ata_port *ap);
1846 #else /* CONFIG_SATA_PMP */
1848 #define sata_pmp_port_ops sata_port_ops
1849 #define sata_pmp_qc_defer_cmd_switch ata_std_qc_defer
1850 #define sata_pmp_error_handler ata_std_error_handler
1852 #endif /* CONFIG_SATA_PMP */
1855 /**************************************************************************
1856 * SFF - drivers/ata/libata-sff.c
1858 #ifdef CONFIG_ATA_SFF
1860 extern const struct ata_port_operations ata_sff_port_ops;
1861 extern const struct ata_port_operations ata_bmdma32_port_ops;
1863 /* PIO only, sg_tablesize and dma_boundary limits can be removed */
1864 #define ATA_PIO_SHT(drv_name) \
1865 ATA_BASE_SHT(drv_name), \
1866 .sg_tablesize = LIBATA_MAX_PRD, \
1867 .dma_boundary = ATA_DMA_BOUNDARY
1869 extern void ata_sff_dev_select(struct ata_port *ap, unsigned int device);
1870 extern u8 ata_sff_check_status(struct ata_port *ap);
1871 extern void ata_sff_pause(struct ata_port *ap);
1872 extern void ata_sff_dma_pause(struct ata_port *ap);
1873 extern int ata_sff_busy_sleep(struct ata_port *ap,
1874 unsigned long timeout_pat, unsigned long timeout);
1875 extern int ata_sff_wait_ready(struct ata_link *link, unsigned long deadline);
1876 extern void ata_sff_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
1877 extern void ata_sff_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
1878 extern void ata_sff_exec_command(struct ata_port *ap,
1879 const struct ata_taskfile *tf);
1880 extern unsigned int ata_sff_data_xfer(struct ata_queued_cmd *qc,
1881 unsigned char *buf, unsigned int buflen, int rw);
1882 extern unsigned int ata_sff_data_xfer32(struct ata_queued_cmd *qc,
1883 unsigned char *buf, unsigned int buflen, int rw);
1884 extern void ata_sff_irq_on(struct ata_port *ap);
1885 extern void ata_sff_irq_clear(struct ata_port *ap);
1886 extern int ata_sff_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
1887 u8 status, int in_wq);
1888 extern void ata_sff_queue_work(struct work_struct *work);
1889 extern void ata_sff_queue_delayed_work(struct delayed_work *dwork,
1890 unsigned long delay);
1891 extern void ata_sff_queue_pio_task(struct ata_link *link, unsigned long delay);
1892 extern unsigned int ata_sff_qc_issue(struct ata_queued_cmd *qc);
1893 extern bool ata_sff_qc_fill_rtf(struct ata_queued_cmd *qc);
1894 extern unsigned int ata_sff_port_intr(struct ata_port *ap,
1895 struct ata_queued_cmd *qc);
1896 extern irqreturn_t ata_sff_interrupt(int irq, void *dev_instance);
1897 extern void ata_sff_lost_interrupt(struct ata_port *ap);
1898 extern void ata_sff_freeze(struct ata_port *ap);
1899 extern void ata_sff_thaw(struct ata_port *ap);
1900 extern int ata_sff_prereset(struct ata_link *link, unsigned long deadline);
1901 extern unsigned int ata_sff_dev_classify(struct ata_device *dev, int present,
1903 extern int ata_sff_wait_after_reset(struct ata_link *link, unsigned int devmask,
1904 unsigned long deadline);
1905 extern int ata_sff_softreset(struct ata_link *link, unsigned int *classes,
1906 unsigned long deadline);
1907 extern int sata_sff_hardreset(struct ata_link *link, unsigned int *class,
1908 unsigned long deadline);
1909 extern void ata_sff_postreset(struct ata_link *link, unsigned int *classes);
1910 extern void ata_sff_drain_fifo(struct ata_queued_cmd *qc);
1911 extern void ata_sff_error_handler(struct ata_port *ap);
1912 extern void ata_sff_std_ports(struct ata_ioports *ioaddr);
1914 extern int ata_pci_sff_init_host(struct ata_host *host);
1915 extern int ata_pci_sff_prepare_host(struct pci_dev *pdev,
1916 const struct ata_port_info * const * ppi,
1917 struct ata_host **r_host);
1918 extern int ata_pci_sff_activate_host(struct ata_host *host,
1919 irq_handler_t irq_handler,
1920 struct scsi_host_template *sht);
1921 extern int ata_pci_sff_init_one(struct pci_dev *pdev,
1922 const struct ata_port_info * const * ppi,
1923 struct scsi_host_template *sht, void *host_priv, int hflags);
1924 #endif /* CONFIG_PCI */
1926 #ifdef CONFIG_ATA_BMDMA
1928 extern const struct ata_port_operations ata_bmdma_port_ops;
1930 #define ATA_BMDMA_SHT(drv_name) \
1931 ATA_BASE_SHT(drv_name), \
1932 .sg_tablesize = LIBATA_MAX_PRD, \
1933 .dma_boundary = ATA_DMA_BOUNDARY
1935 extern enum ata_completion_errors ata_bmdma_qc_prep(struct ata_queued_cmd *qc);
1936 extern unsigned int ata_bmdma_qc_issue(struct ata_queued_cmd *qc);
1937 extern enum ata_completion_errors ata_bmdma_dumb_qc_prep(struct ata_queued_cmd *qc);
1938 extern unsigned int ata_bmdma_port_intr(struct ata_port *ap,
1939 struct ata_queued_cmd *qc);
1940 extern irqreturn_t ata_bmdma_interrupt(int irq, void *dev_instance);
1941 extern void ata_bmdma_error_handler(struct ata_port *ap);
1942 extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
1943 extern void ata_bmdma_irq_clear(struct ata_port *ap);
1944 extern void ata_bmdma_setup(struct ata_queued_cmd *qc);
1945 extern void ata_bmdma_start(struct ata_queued_cmd *qc);
1946 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
1947 extern u8 ata_bmdma_status(struct ata_port *ap);
1948 extern int ata_bmdma_port_start(struct ata_port *ap);
1949 extern int ata_bmdma_port_start32(struct ata_port *ap);
1952 extern int ata_pci_bmdma_clear_simplex(struct pci_dev *pdev);
1953 extern void ata_pci_bmdma_init(struct ata_host *host);
1954 extern int ata_pci_bmdma_prepare_host(struct pci_dev *pdev,
1955 const struct ata_port_info * const * ppi,
1956 struct ata_host **r_host);
1957 extern int ata_pci_bmdma_init_one(struct pci_dev *pdev,
1958 const struct ata_port_info * const * ppi,
1959 struct scsi_host_template *sht,
1960 void *host_priv, int hflags);
1961 #endif /* CONFIG_PCI */
1962 #endif /* CONFIG_ATA_BMDMA */
1965 * ata_sff_busy_wait - Wait for a port status register
1966 * @ap: Port to wait for.
1967 * @bits: bits that must be clear
1968 * @max: number of 10uS waits to perform
1970 * Waits up to max*10 microseconds for the selected bits in the port's
1971 * status register to be cleared.
1972 * Returns final value of status register.
1975 * Inherited from caller.
1977 static inline u8 ata_sff_busy_wait(struct ata_port *ap, unsigned int bits,
1984 status = ap->ops->sff_check_status(ap);
1986 } while (status != 0xff && (status & bits) && (max > 0));
1992 * ata_wait_idle - Wait for a port to be idle.
1993 * @ap: Port to wait for.
1995 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
1996 * Returns final value of status register.
1999 * Inherited from caller.
2001 static inline u8 ata_wait_idle(struct ata_port *ap)
2003 u8 status = ata_sff_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
2006 if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
2007 ata_port_printk(ap, KERN_DEBUG, "abnormal Status 0x%X\n",
2013 #endif /* CONFIG_ATA_SFF */
2015 #endif /* __LINUX_LIBATA_H__ */