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>
25 #include <linux/async.h>
28 * Define if arch has non-standard setup. This is a _PCI_ standard
29 * not a legacy or ISA standard.
31 #ifdef CONFIG_ATA_NONSTANDARD
32 #include <asm/libata-portmap.h>
34 #define ATA_PRIMARY_IRQ(dev) 14
35 #define ATA_SECONDARY_IRQ(dev) 15
39 * compile-time options: to be removed as soon as all the drivers are
40 * converted to the new debugging mechanism
42 #undef ATA_IRQ_TRAP /* define to ack screaming irqs */
45 #define ata_print_version_once(dev, version) \
47 static bool __print_once; \
49 if (!__print_once) { \
50 __print_once = true; \
51 ata_print_version(dev, version); \
55 /* defines only for the constants which don't work well as enums */
56 #define ATA_TAG_POISON 0xfafbfcfdU
60 * ata_device->quirks is an unsigned int, so __ATA_QUIRK_MAX must not exceed 32.
63 __ATA_QUIRK_DIAGNOSTIC
, /* Failed boot diag */
64 __ATA_QUIRK_NODMA
, /* DMA problems */
65 __ATA_QUIRK_NONCQ
, /* Don't use NCQ */
66 __ATA_QUIRK_MAX_SEC_128
, /* Limit max sects to 128 */
67 __ATA_QUIRK_BROKEN_HPA
, /* Broken HPA */
68 __ATA_QUIRK_DISABLE
, /* Disable it */
69 __ATA_QUIRK_HPA_SIZE
, /* Native size off by one */
70 __ATA_QUIRK_IVB
, /* cbl det validity bit bugs */
71 __ATA_QUIRK_STUCK_ERR
, /* Stuck ERR on next PACKET */
72 __ATA_QUIRK_BRIDGE_OK
, /* No bridge limits */
73 __ATA_QUIRK_ATAPI_MOD16_DMA
, /* Use ATAPI DMA for commands that */
74 /* are not a multiple of 16 bytes */
75 __ATA_QUIRK_FIRMWARE_WARN
, /* Firmware update warning */
76 __ATA_QUIRK_1_5_GBPS
, /* Force 1.5 Gbps */
77 __ATA_QUIRK_NOSETXFER
, /* Skip SETXFER, SATA only */
78 __ATA_QUIRK_BROKEN_FPDMA_AA
, /* Skip AA */
79 __ATA_QUIRK_DUMP_ID
, /* Dump IDENTIFY data */
80 __ATA_QUIRK_MAX_SEC_LBA48
, /* Set max sects to 65535 */
81 __ATA_QUIRK_ATAPI_DMADIR
, /* Device requires dmadir */
82 __ATA_QUIRK_NO_NCQ_TRIM
, /* Do not use queued TRIM */
83 __ATA_QUIRK_NOLPM
, /* Do not use LPM */
84 __ATA_QUIRK_WD_BROKEN_LPM
, /* Some WDs have broken LPM */
85 __ATA_QUIRK_ZERO_AFTER_TRIM
, /* Guarantees zero after trim */
86 __ATA_QUIRK_NO_DMA_LOG
, /* Do not use DMA for log read */
87 __ATA_QUIRK_NOTRIM
, /* Do not use TRIM */
88 __ATA_QUIRK_MAX_SEC_1024
, /* Limit max sects to 1024 */
89 __ATA_QUIRK_MAX_TRIM_128M
, /* Limit max trim size to 128M */
90 __ATA_QUIRK_NO_NCQ_ON_ATI
, /* Disable NCQ on ATI chipset */
91 __ATA_QUIRK_NO_ID_DEV_LOG
, /* Identify device log missing */
92 __ATA_QUIRK_NO_LOG_DIR
, /* Do not read log directory */
93 __ATA_QUIRK_NO_FUA
, /* Do not use FUA */
99 /* various global constants */
100 LIBATA_MAX_PRD
= ATA_MAX_PRD
/ 2,
101 LIBATA_DUMB_MAX_PRD
= ATA_MAX_PRD
/ 4, /* Worst case */
104 ATA_TAG_INTERNAL
= ATA_MAX_QUEUE
,
105 ATA_SHORT_PAUSE
= 16,
107 ATAPI_MAX_DRAIN
= 16 << 10,
109 ATA_ALL_DEVICES
= (1 << ATA_MAX_DEVICES
) - 1,
111 ATA_SHT_EMULATED
= 1,
112 ATA_SHT_THIS_ID
= -1,
114 /* struct ata_taskfile flags */
115 ATA_TFLAG_LBA48
= (1 << 0), /* enable 48-bit LBA and "HOB" */
116 ATA_TFLAG_ISADDR
= (1 << 1), /* enable r/w to nsect/lba regs */
117 ATA_TFLAG_DEVICE
= (1 << 2), /* enable r/w to device reg */
118 ATA_TFLAG_WRITE
= (1 << 3), /* data dir: host->dev==1 (write) */
119 ATA_TFLAG_LBA
= (1 << 4), /* enable LBA */
120 ATA_TFLAG_FUA
= (1 << 5), /* enable FUA */
121 ATA_TFLAG_POLLING
= (1 << 6), /* set nIEN to 1 and use polling */
123 /* struct ata_device stuff */
124 ATA_DFLAG_LBA
= (1 << 0), /* device supports LBA */
125 ATA_DFLAG_LBA48
= (1 << 1), /* device supports LBA48 */
126 ATA_DFLAG_CDB_INTR
= (1 << 2), /* device asserts INTRQ when ready for CDB */
127 ATA_DFLAG_NCQ
= (1 << 3), /* device supports NCQ */
128 ATA_DFLAG_FLUSH_EXT
= (1 << 4), /* do FLUSH_EXT instead of FLUSH */
129 ATA_DFLAG_ACPI_PENDING
= (1 << 5), /* ACPI resume action pending */
130 ATA_DFLAG_ACPI_FAILED
= (1 << 6), /* ACPI on devcfg has failed */
131 ATA_DFLAG_AN
= (1 << 7), /* AN configured */
132 ATA_DFLAG_TRUSTED
= (1 << 8), /* device supports trusted send/recv */
133 ATA_DFLAG_FUA
= (1 << 9), /* device supports FUA */
134 ATA_DFLAG_DMADIR
= (1 << 10), /* device requires DMADIR */
135 ATA_DFLAG_NCQ_SEND_RECV
= (1 << 11), /* device supports NCQ SEND and RECV */
136 ATA_DFLAG_NCQ_PRIO
= (1 << 12), /* device supports NCQ priority */
137 ATA_DFLAG_CDL
= (1 << 13), /* supports cmd duration limits */
138 ATA_DFLAG_CFG_MASK
= (1 << 14) - 1,
140 ATA_DFLAG_PIO
= (1 << 14), /* device limited to PIO mode */
141 ATA_DFLAG_NCQ_OFF
= (1 << 15), /* device limited to non-NCQ mode */
142 ATA_DFLAG_SLEEPING
= (1 << 16), /* device is sleeping */
143 ATA_DFLAG_DUBIOUS_XFER
= (1 << 17), /* data transfer not verified */
144 ATA_DFLAG_NO_UNLOAD
= (1 << 18), /* device doesn't support unload */
145 ATA_DFLAG_UNLOCK_HPA
= (1 << 19), /* unlock HPA */
146 ATA_DFLAG_INIT_MASK
= (1 << 20) - 1,
148 ATA_DFLAG_NCQ_PRIO_ENABLED
= (1 << 20), /* Priority cmds sent to dev */
149 ATA_DFLAG_CDL_ENABLED
= (1 << 21), /* cmd duration limits is enabled */
150 ATA_DFLAG_RESUMING
= (1 << 22), /* Device is resuming */
151 ATA_DFLAG_DETACH
= (1 << 24),
152 ATA_DFLAG_DETACHED
= (1 << 25),
153 ATA_DFLAG_DA
= (1 << 26), /* device supports Device Attention */
154 ATA_DFLAG_DEVSLP
= (1 << 27), /* device supports Device Sleep */
155 ATA_DFLAG_ACPI_DISABLED
= (1 << 28), /* ACPI for the device is disabled */
156 ATA_DFLAG_D_SENSE
= (1 << 29), /* Descriptor sense requested */
157 ATA_DFLAG_ZAC
= (1 << 30), /* ZAC device */
159 ATA_DFLAG_FEATURES_MASK
= (ATA_DFLAG_TRUSTED
| ATA_DFLAG_DA
| \
160 ATA_DFLAG_DEVSLP
| ATA_DFLAG_NCQ_SEND_RECV
| \
161 ATA_DFLAG_NCQ_PRIO
| ATA_DFLAG_FUA
| \
164 ATA_DEV_UNKNOWN
= 0, /* unknown device */
165 ATA_DEV_ATA
= 1, /* ATA device */
166 ATA_DEV_ATA_UNSUP
= 2, /* ATA device (unsupported) */
167 ATA_DEV_ATAPI
= 3, /* ATAPI device */
168 ATA_DEV_ATAPI_UNSUP
= 4, /* ATAPI device (unsupported) */
169 ATA_DEV_PMP
= 5, /* SATA port multiplier */
170 ATA_DEV_PMP_UNSUP
= 6, /* SATA port multiplier (unsupported) */
171 ATA_DEV_SEMB
= 7, /* SEMB */
172 ATA_DEV_SEMB_UNSUP
= 8, /* SEMB (unsupported) */
173 ATA_DEV_ZAC
= 9, /* ZAC device */
174 ATA_DEV_ZAC_UNSUP
= 10, /* ZAC device (unsupported) */
175 ATA_DEV_NONE
= 11, /* no device */
177 /* struct ata_link flags */
178 /* NOTE: struct ata_force_param currently stores lflags in u16 */
179 ATA_LFLAG_NO_HRST
= (1 << 1), /* avoid hardreset */
180 ATA_LFLAG_NO_SRST
= (1 << 2), /* avoid softreset */
181 ATA_LFLAG_ASSUME_ATA
= (1 << 3), /* assume ATA class */
182 ATA_LFLAG_ASSUME_SEMB
= (1 << 4), /* assume SEMB class */
183 ATA_LFLAG_ASSUME_CLASS
= ATA_LFLAG_ASSUME_ATA
| ATA_LFLAG_ASSUME_SEMB
,
184 ATA_LFLAG_NO_RETRY
= (1 << 5), /* don't retry this link */
185 ATA_LFLAG_DISABLED
= (1 << 6), /* link is disabled */
186 ATA_LFLAG_SW_ACTIVITY
= (1 << 7), /* keep activity stats */
187 ATA_LFLAG_NO_LPM
= (1 << 8), /* disable LPM on this link */
188 ATA_LFLAG_RST_ONCE
= (1 << 9), /* limit recovery to one reset */
189 ATA_LFLAG_CHANGED
= (1 << 10), /* LPM state changed on this link */
190 ATA_LFLAG_NO_DEBOUNCE_DELAY
= (1 << 11), /* no debounce delay on link resume */
192 /* struct ata_port flags */
193 ATA_FLAG_SLAVE_POSS
= (1 << 0), /* host supports slave dev */
194 /* (doesn't imply presence) */
195 ATA_FLAG_SATA
= (1 << 1),
196 ATA_FLAG_NO_LPM
= (1 << 2), /* host not happy with LPM */
197 ATA_FLAG_NO_LOG_PAGE
= (1 << 5), /* do not issue log page read */
198 ATA_FLAG_NO_ATAPI
= (1 << 6), /* No ATAPI support */
199 ATA_FLAG_PIO_DMA
= (1 << 7), /* PIO cmds via DMA */
200 ATA_FLAG_PIO_LBA48
= (1 << 8), /* Host DMA engine is LBA28 only */
201 ATA_FLAG_PIO_POLLING
= (1 << 9), /* use polling PIO if LLD
202 * doesn't handle PIO interrupts */
203 ATA_FLAG_NCQ
= (1 << 10), /* host supports NCQ */
204 ATA_FLAG_NO_POWEROFF_SPINDOWN
= (1 << 11), /* don't spindown before poweroff */
205 ATA_FLAG_NO_HIBERNATE_SPINDOWN
= (1 << 12), /* don't spindown before hibernation */
206 ATA_FLAG_DEBUGMSG
= (1 << 13),
207 ATA_FLAG_FPDMA_AA
= (1 << 14), /* driver supports Auto-Activate */
208 ATA_FLAG_IGN_SIMPLEX
= (1 << 15), /* ignore SIMPLEX */
209 ATA_FLAG_NO_IORDY
= (1 << 16), /* controller lacks iordy */
210 ATA_FLAG_ACPI_SATA
= (1 << 17), /* need native SATA ACPI layout */
211 ATA_FLAG_AN
= (1 << 18), /* controller supports AN */
212 ATA_FLAG_PMP
= (1 << 19), /* controller supports PMP */
213 ATA_FLAG_FPDMA_AUX
= (1 << 20), /* controller supports H2DFIS aux field */
214 ATA_FLAG_EM
= (1 << 21), /* driver supports enclosure
216 ATA_FLAG_SW_ACTIVITY
= (1 << 22), /* driver supports sw activity
218 ATA_FLAG_NO_DIPM
= (1 << 23), /* host not happy with DIPM */
219 ATA_FLAG_SAS_HOST
= (1 << 24), /* SAS host */
221 /* bits 24:31 of ap->flags are reserved for LLD specific flags */
224 /* struct ata_port pflags */
225 ATA_PFLAG_EH_PENDING
= (1 << 0), /* EH pending */
226 ATA_PFLAG_EH_IN_PROGRESS
= (1 << 1), /* EH in progress */
227 ATA_PFLAG_FROZEN
= (1 << 2), /* port is frozen */
228 ATA_PFLAG_RECOVERED
= (1 << 3), /* recovery action performed */
229 ATA_PFLAG_LOADING
= (1 << 4), /* boot/loading probe */
230 ATA_PFLAG_SCSI_HOTPLUG
= (1 << 6), /* SCSI hotplug scheduled */
231 ATA_PFLAG_INITIALIZING
= (1 << 7), /* being initialized, don't touch */
232 ATA_PFLAG_RESETTING
= (1 << 8), /* reset in progress */
233 ATA_PFLAG_UNLOADING
= (1 << 9), /* driver is being unloaded */
234 ATA_PFLAG_UNLOADED
= (1 << 10), /* driver is unloaded */
236 ATA_PFLAG_RESUMING
= (1 << 16), /* port is being resumed */
237 ATA_PFLAG_SUSPENDED
= (1 << 17), /* port is suspended (power) */
238 ATA_PFLAG_PM_PENDING
= (1 << 18), /* PM operation pending */
239 ATA_PFLAG_INIT_GTM_VALID
= (1 << 19), /* initial gtm data valid */
241 ATA_PFLAG_PIO32
= (1 << 20), /* 32bit PIO */
242 ATA_PFLAG_PIO32CHANGE
= (1 << 21), /* 32bit PIO can be turned on/off */
243 ATA_PFLAG_EXTERNAL
= (1 << 22), /* eSATA/external port */
245 /* struct ata_queued_cmd flags */
246 ATA_QCFLAG_ACTIVE
= (1 << 0), /* cmd not yet ack'd to scsi lyer */
247 ATA_QCFLAG_DMAMAP
= (1 << 1), /* SG table is DMA mapped */
248 ATA_QCFLAG_RTF_FILLED
= (1 << 2), /* result TF has been filled */
249 ATA_QCFLAG_IO
= (1 << 3), /* standard IO command */
250 ATA_QCFLAG_RESULT_TF
= (1 << 4), /* result TF requested */
251 ATA_QCFLAG_CLEAR_EXCL
= (1 << 5), /* clear excl_link on completion */
252 ATA_QCFLAG_QUIET
= (1 << 6), /* don't report device error */
253 ATA_QCFLAG_RETRY
= (1 << 7), /* retry after failure */
254 ATA_QCFLAG_HAS_CDL
= (1 << 8), /* qc has CDL a descriptor set */
256 ATA_QCFLAG_EH
= (1 << 16), /* cmd aborted and owned by EH */
257 ATA_QCFLAG_SENSE_VALID
= (1 << 17), /* sense data valid */
258 ATA_QCFLAG_EH_SCHEDULED
= (1 << 18), /* EH scheduled (obsolete) */
259 ATA_QCFLAG_EH_SUCCESS_CMD
= (1 << 19), /* EH should fetch sense for this successful cmd */
262 ATA_HOST_SIMPLEX
= (1 << 0), /* Host is simplex, one DMA channel per host only */
263 ATA_HOST_STARTED
= (1 << 1), /* Host started */
264 ATA_HOST_PARALLEL_SCAN
= (1 << 2), /* Ports on this host can be scanned in parallel */
265 ATA_HOST_IGNORE_ATA
= (1 << 3), /* Ignore ATA devices on this host. */
267 ATA_HOST_NO_PART
= (1 << 4), /* Host does not support partial */
268 ATA_HOST_NO_SSC
= (1 << 5), /* Host does not support slumber */
269 ATA_HOST_NO_DEVSLP
= (1 << 6), /* Host does not support devslp */
271 /* bits 24:31 of host->flags are reserved for LLD specific flags */
273 /* Various lengths of time */
274 ATA_TMOUT_INTERNAL_QUICK
= 5000,
275 ATA_TMOUT_MAX_PARK
= 30000,
278 * GoVault needs 2s and iVDR disk HHD424020F7SV00 800ms. 2s
279 * is too much without parallel probing. Use 2s if parallel
280 * probing is available, 800ms otherwise.
282 ATA_TMOUT_FF_WAIT_LONG
= 2000,
283 ATA_TMOUT_FF_WAIT
= 800,
285 /* Spec mandates to wait for ">= 2ms" before checking status
286 * after reset. We wait 150ms, because that was the magic
287 * delay used for ATAPI devices in Hale Landis's ATADRVR, for
288 * the period of time between when the ATA command register is
289 * written, and then status is checked. Because waiting for
290 * "a while" before checking status is fine, post SRST, we
291 * perform this magic delay here as well.
293 * Old drivers/ide uses the 2mS rule and then waits for ready.
295 ATA_WAIT_AFTER_RESET
= 150,
297 /* If PMP is supported, we have to do follow-up SRST. As some
298 * PMPs don't send D2H Reg FIS after hardreset, LLDs are
299 * advised to wait only for the following duration before
302 ATA_TMOUT_PMP_SRST_WAIT
= 10000,
304 /* When the LPM policy is set to ATA_LPM_MAX_POWER, there might
305 * be a spurious PHY event, so ignore the first PHY event that
306 * occurs within 10s after the policy change.
308 ATA_TMOUT_SPURIOUS_PHY
= 10000,
322 /* SATA port states */
327 /* encoding various smaller bitmaps into a single
328 * unsigned int bitmap
330 ATA_NR_PIO_MODES
= 7,
331 ATA_NR_MWDMA_MODES
= 5,
332 ATA_NR_UDMA_MODES
= 8,
335 ATA_SHIFT_MWDMA
= ATA_SHIFT_PIO
+ ATA_NR_PIO_MODES
,
336 ATA_SHIFT_UDMA
= ATA_SHIFT_MWDMA
+ ATA_NR_MWDMA_MODES
,
340 /* size of buffer to pad xfers ending on unaligned boundaries */
346 /* return values for ->qc_defer */
350 /* desc_len for ata_eh_info and context */
351 ATA_EH_DESC_LEN
= 80,
353 /* reset / recovery action types */
354 ATA_EH_REVALIDATE
= (1 << 0),
355 ATA_EH_SOFTRESET
= (1 << 1), /* meaningful only in ->prereset */
356 ATA_EH_HARDRESET
= (1 << 2), /* meaningful only in ->prereset */
357 ATA_EH_RESET
= ATA_EH_SOFTRESET
| ATA_EH_HARDRESET
,
358 ATA_EH_ENABLE_LINK
= (1 << 3),
359 ATA_EH_PARK
= (1 << 5), /* unload heads and stop I/O */
360 ATA_EH_GET_SUCCESS_SENSE
= (1 << 6), /* Get sense data for successful cmd */
361 ATA_EH_SET_ACTIVE
= (1 << 7), /* Set a device to active power mode */
363 ATA_EH_PERDEV_MASK
= ATA_EH_REVALIDATE
| ATA_EH_PARK
|
364 ATA_EH_GET_SUCCESS_SENSE
| ATA_EH_SET_ACTIVE
,
365 ATA_EH_ALL_ACTIONS
= ATA_EH_REVALIDATE
| ATA_EH_RESET
|
368 /* ata_eh_info->flags */
369 ATA_EHI_HOTPLUGGED
= (1 << 0), /* could have been hotplugged */
370 ATA_EHI_NO_AUTOPSY
= (1 << 2), /* no autopsy */
371 ATA_EHI_QUIET
= (1 << 3), /* be quiet */
372 ATA_EHI_NO_RECOVERY
= (1 << 4), /* no recovery */
374 ATA_EHI_DID_SOFTRESET
= (1 << 16), /* already soft-reset this port */
375 ATA_EHI_DID_HARDRESET
= (1 << 17), /* already soft-reset this port */
376 ATA_EHI_PRINTINFO
= (1 << 18), /* print configuration info */
377 ATA_EHI_SETMODE
= (1 << 19), /* configure transfer mode */
378 ATA_EHI_POST_SETMODE
= (1 << 20), /* revalidating after setmode */
379 ATA_EHI_DID_PRINT_QUIRKS
= (1 << 21), /* already printed quirks info */
381 ATA_EHI_DID_RESET
= ATA_EHI_DID_SOFTRESET
| ATA_EHI_DID_HARDRESET
,
383 /* mask of flags to transfer *to* the slave link */
384 ATA_EHI_TO_SLAVE_MASK
= ATA_EHI_NO_AUTOPSY
| ATA_EHI_QUIET
,
386 /* max tries if error condition is still set after ->error_handler */
387 ATA_EH_MAX_TRIES
= 5,
389 /* sometimes resuming a link requires several retries */
390 ATA_LINK_RESUME_TRIES
= 5,
392 /* how hard are we gonna try to probe/recover devices */
393 ATA_EH_DEV_TRIES
= 3,
394 ATA_EH_PMP_TRIES
= 5,
395 ATA_EH_PMP_LINK_TRIES
= 3,
397 SATA_PMP_RW_TIMEOUT
= 3000, /* PMP read/write timeout */
399 /* This should match the actual table size of
400 * ata_eh_cmd_timeout_table in libata-eh.c.
402 ATA_EH_CMD_TIMEOUT_TABLE_SIZE
= 8,
405 * Quirk flags: may be set by libata or controller drivers on drives.
406 * Some quirks may be drive/controller pair dependent.
408 ATA_QUIRK_DIAGNOSTIC
= (1U << __ATA_QUIRK_DIAGNOSTIC
),
409 ATA_QUIRK_NODMA
= (1U << __ATA_QUIRK_NODMA
),
410 ATA_QUIRK_NONCQ
= (1U << __ATA_QUIRK_NONCQ
),
411 ATA_QUIRK_MAX_SEC_128
= (1U << __ATA_QUIRK_MAX_SEC_128
),
412 ATA_QUIRK_BROKEN_HPA
= (1U << __ATA_QUIRK_BROKEN_HPA
),
413 ATA_QUIRK_DISABLE
= (1U << __ATA_QUIRK_DISABLE
),
414 ATA_QUIRK_HPA_SIZE
= (1U << __ATA_QUIRK_HPA_SIZE
),
415 ATA_QUIRK_IVB
= (1U << __ATA_QUIRK_IVB
),
416 ATA_QUIRK_STUCK_ERR
= (1U << __ATA_QUIRK_STUCK_ERR
),
417 ATA_QUIRK_BRIDGE_OK
= (1U << __ATA_QUIRK_BRIDGE_OK
),
418 ATA_QUIRK_ATAPI_MOD16_DMA
= (1U << __ATA_QUIRK_ATAPI_MOD16_DMA
),
419 ATA_QUIRK_FIRMWARE_WARN
= (1U << __ATA_QUIRK_FIRMWARE_WARN
),
420 ATA_QUIRK_1_5_GBPS
= (1U << __ATA_QUIRK_1_5_GBPS
),
421 ATA_QUIRK_NOSETXFER
= (1U << __ATA_QUIRK_NOSETXFER
),
422 ATA_QUIRK_BROKEN_FPDMA_AA
= (1U << __ATA_QUIRK_BROKEN_FPDMA_AA
),
423 ATA_QUIRK_DUMP_ID
= (1U << __ATA_QUIRK_DUMP_ID
),
424 ATA_QUIRK_MAX_SEC_LBA48
= (1U << __ATA_QUIRK_MAX_SEC_LBA48
),
425 ATA_QUIRK_ATAPI_DMADIR
= (1U << __ATA_QUIRK_ATAPI_DMADIR
),
426 ATA_QUIRK_NO_NCQ_TRIM
= (1U << __ATA_QUIRK_NO_NCQ_TRIM
),
427 ATA_QUIRK_NOLPM
= (1U << __ATA_QUIRK_NOLPM
),
428 ATA_QUIRK_WD_BROKEN_LPM
= (1U << __ATA_QUIRK_WD_BROKEN_LPM
),
429 ATA_QUIRK_ZERO_AFTER_TRIM
= (1U << __ATA_QUIRK_ZERO_AFTER_TRIM
),
430 ATA_QUIRK_NO_DMA_LOG
= (1U << __ATA_QUIRK_NO_DMA_LOG
),
431 ATA_QUIRK_NOTRIM
= (1U << __ATA_QUIRK_NOTRIM
),
432 ATA_QUIRK_MAX_SEC_1024
= (1U << __ATA_QUIRK_MAX_SEC_1024
),
433 ATA_QUIRK_MAX_TRIM_128M
= (1U << __ATA_QUIRK_MAX_TRIM_128M
),
434 ATA_QUIRK_NO_NCQ_ON_ATI
= (1U << __ATA_QUIRK_NO_NCQ_ON_ATI
),
435 ATA_QUIRK_NO_ID_DEV_LOG
= (1U << __ATA_QUIRK_NO_ID_DEV_LOG
),
436 ATA_QUIRK_NO_LOG_DIR
= (1U << __ATA_QUIRK_NO_LOG_DIR
),
437 ATA_QUIRK_NO_FUA
= (1U << __ATA_QUIRK_NO_FUA
),
439 /* User visible DMA mask for DMA control. DO NOT renumber. */
440 ATA_DMA_MASK_ATA
= (1 << 0), /* DMA on ATA Disk */
441 ATA_DMA_MASK_ATAPI
= (1 << 1), /* DMA on ATAPI */
442 ATA_DMA_MASK_CFA
= (1 << 2), /* DMA on CF Card */
444 /* ATAPI command types */
445 ATAPI_READ
= 0, /* READs */
446 ATAPI_WRITE
= 1, /* WRITEs */
447 ATAPI_READ_CD
= 2, /* READ CD [MSF] */
448 ATAPI_PASS_THRU
= 3, /* SAT pass-thru */
449 ATAPI_MISC
= 4, /* the rest */
451 /* Timing constants */
452 ATA_TIMING_SETUP
= (1 << 0),
453 ATA_TIMING_ACT8B
= (1 << 1),
454 ATA_TIMING_REC8B
= (1 << 2),
455 ATA_TIMING_CYC8B
= (1 << 3),
456 ATA_TIMING_8BIT
= ATA_TIMING_ACT8B
| ATA_TIMING_REC8B
|
458 ATA_TIMING_ACTIVE
= (1 << 4),
459 ATA_TIMING_RECOVER
= (1 << 5),
460 ATA_TIMING_DMACK_HOLD
= (1 << 6),
461 ATA_TIMING_CYCLE
= (1 << 7),
462 ATA_TIMING_UDMA
= (1 << 8),
463 ATA_TIMING_ALL
= ATA_TIMING_SETUP
| ATA_TIMING_ACT8B
|
464 ATA_TIMING_REC8B
| ATA_TIMING_CYC8B
|
465 ATA_TIMING_ACTIVE
| ATA_TIMING_RECOVER
|
466 ATA_TIMING_DMACK_HOLD
| ATA_TIMING_CYCLE
|
470 ATA_ACPI_FILTER_SETXFER
= 1 << 0,
471 ATA_ACPI_FILTER_LOCK
= 1 << 1,
472 ATA_ACPI_FILTER_DIPM
= 1 << 2,
473 ATA_ACPI_FILTER_FPDMA_OFFSET
= 1 << 3, /* FPDMA non-zero offset */
474 ATA_ACPI_FILTER_FPDMA_AA
= 1 << 4, /* FPDMA auto activate */
476 ATA_ACPI_FILTER_DEFAULT
= ATA_ACPI_FILTER_SETXFER
|
477 ATA_ACPI_FILTER_LOCK
|
478 ATA_ACPI_FILTER_DIPM
,
482 ATA_MASK_PIO
= ((1U << ATA_NR_PIO_MODES
) - 1) << ATA_SHIFT_PIO
,
483 ATA_MASK_MWDMA
= ((1U << ATA_NR_MWDMA_MODES
) - 1) << ATA_SHIFT_MWDMA
,
484 ATA_MASK_UDMA
= ((1U << ATA_NR_UDMA_MODES
) - 1) << ATA_SHIFT_UDMA
,
487 enum hsm_task_states
{
488 HSM_ST_IDLE
, /* no command on going */
489 HSM_ST_FIRST
, /* (waiting the device to)
490 write CDB or first data block */
491 HSM_ST
, /* (waiting the device to) transfer data */
492 HSM_ST_LAST
, /* (waiting the device to) complete command */
493 HSM_ST_ERR
, /* error */
496 enum ata_completion_errors
{
497 AC_ERR_OK
= 0, /* no error */
498 AC_ERR_DEV
= (1 << 0), /* device reported error */
499 AC_ERR_HSM
= (1 << 1), /* host state machine violation */
500 AC_ERR_TIMEOUT
= (1 << 2), /* timeout */
501 AC_ERR_MEDIA
= (1 << 3), /* media error */
502 AC_ERR_ATA_BUS
= (1 << 4), /* ATA bus error */
503 AC_ERR_HOST_BUS
= (1 << 5), /* host bus error */
504 AC_ERR_SYSTEM
= (1 << 6), /* system error */
505 AC_ERR_INVALID
= (1 << 7), /* invalid argument */
506 AC_ERR_OTHER
= (1 << 8), /* unknown */
507 AC_ERR_NODEV_HINT
= (1 << 9), /* polling device detection hint */
508 AC_ERR_NCQ
= (1 << 10), /* marker for offending NCQ qc */
512 * Link power management policy: If you alter this, you also need to
513 * alter libata-sata.c (for the ascii descriptions)
515 enum ata_lpm_policy
{
519 ATA_LPM_MED_POWER_WITH_DIPM
, /* Med power + DIPM as win IRST does */
520 ATA_LPM_MIN_POWER_WITH_PARTIAL
, /* Min Power + partial and slumber */
521 ATA_LPM_MIN_POWER
, /* Min power + no partial (slumber only) */
525 ATA_LPM_EMPTY
= (1 << 0), /* port empty/probing */
526 ATA_LPM_HIPM
= (1 << 1), /* may use HIPM */
527 ATA_LPM_WAKE_ONLY
= (1 << 2), /* only wake up link */
530 /* forward declarations */
532 struct ata_port_operations
;
535 struct ata_queued_cmd
;
538 typedef void (*ata_qc_cb_t
) (struct ata_queued_cmd
*qc
);
539 typedef int (*ata_prereset_fn_t
)(struct ata_link
*link
, unsigned long deadline
);
540 typedef int (*ata_reset_fn_t
)(struct ata_link
*link
, unsigned int *classes
,
541 unsigned long deadline
);
542 typedef void (*ata_postreset_fn_t
)(struct ata_link
*link
, unsigned int *classes
);
544 extern struct device_attribute dev_attr_unload_heads
;
545 #ifdef CONFIG_SATA_HOST
546 extern struct device_attribute dev_attr_link_power_management_policy
;
547 extern struct device_attribute dev_attr_ncq_prio_supported
;
548 extern struct device_attribute dev_attr_ncq_prio_enable
;
549 extern struct device_attribute dev_attr_em_message_type
;
550 extern struct device_attribute dev_attr_em_message
;
551 extern struct device_attribute dev_attr_sw_activity
;
560 struct ata_taskfile
{
561 unsigned long flags
; /* ATA_TFLAG_xxx */
562 u8 protocol
; /* ATA_PROT_xxx */
564 u8 ctl
; /* control reg */
566 u8 hob_feature
; /* additional data */
567 u8 hob_nsect
; /* to support LBA48 */
588 u32 auxiliary
; /* auxiliary field */
589 /* from SATA 3.1 and */
593 #ifdef CONFIG_ATA_SFF
595 void __iomem
*cmd_addr
;
596 void __iomem
*data_addr
;
597 void __iomem
*error_addr
;
598 void __iomem
*feature_addr
;
599 void __iomem
*nsect_addr
;
600 void __iomem
*lbal_addr
;
601 void __iomem
*lbam_addr
;
602 void __iomem
*lbah_addr
;
603 void __iomem
*device_addr
;
604 void __iomem
*status_addr
;
605 void __iomem
*command_addr
;
606 void __iomem
*altstatus_addr
;
607 void __iomem
*ctl_addr
;
608 #ifdef CONFIG_ATA_BMDMA
609 void __iomem
*bmdma_addr
;
610 #endif /* CONFIG_ATA_BMDMA */
611 void __iomem
*scr_addr
;
613 #endif /* CONFIG_ATA_SFF */
618 void __iomem
* const *iomap
;
619 unsigned int n_ports
;
620 unsigned int n_tags
; /* nr of NCQ tags */
622 struct ata_port_operations
*ops
;
626 struct mutex eh_mutex
;
627 struct task_struct
*eh_owner
;
629 struct ata_port
*simplex_claimed
; /* channel owning the DMA */
630 struct ata_port
*ports
[];
633 struct ata_queued_cmd
{
635 struct ata_device
*dev
;
637 struct scsi_cmnd
*scsicmd
;
638 void (*scsidone
)(struct scsi_cmnd
*);
640 struct ata_taskfile tf
;
641 u8 cdb
[ATAPI_CDB_LEN
];
643 unsigned long flags
; /* ATA_QCFLAG_xxx */
644 unsigned int tag
; /* libata core tag */
645 unsigned int hw_tag
; /* driver tag */
647 unsigned int orig_n_elem
;
651 unsigned int sect_size
;
654 unsigned int extrabytes
;
655 unsigned int curbytes
;
657 struct scatterlist sgent
;
659 struct scatterlist
*sg
;
661 struct scatterlist
*cursg
;
662 unsigned int cursg_ofs
;
664 unsigned int err_mask
;
665 struct ata_taskfile result_tf
;
666 ata_qc_cb_t complete_fn
;
672 struct ata_port_stats
{
673 unsigned long unhandled_irq
;
674 unsigned long idle_irq
;
675 unsigned long rw_reqbuf
;
678 struct ata_ering_entry
{
680 unsigned int err_mask
;
686 struct ata_ering_entry ring
[ATA_ERING_SIZE
];
691 u8 num_storage_elements
;
698 struct ata_cpr cpr
[] __counted_by(nr_cpr
);
703 * Buffer to cache the CDL log page 18h (command duration descriptors)
704 * for SCSI-ATA translation.
706 u8 desc_log_buf
[ATA_LOG_CDL_SIZE
];
709 * Buffer to handle reading the sense data for successful NCQ Commands
710 * log page for commands using a CDL with one of the limits policy set
711 * to 0xD (successful completion with sense data available bit set).
713 u8 ncq_sense_log_buf
[ATA_LOG_SENSE_NCQ_SIZE
];
717 struct ata_link
*link
;
718 unsigned int devno
; /* 0 or 1 */
719 unsigned int quirks
; /* List of broken features */
720 unsigned long flags
; /* ATA_DFLAG_xxx */
721 struct scsi_device
*sdev
; /* attached SCSI device */
723 #ifdef CONFIG_ATA_ACPI
724 union acpi_object
*gtf_cache
;
725 unsigned int gtf_filter
;
727 #ifdef CONFIG_SATA_ZPODD
731 /* n_sector is CLEAR_BEGIN, read comment above CLEAR_BEGIN */
732 u64 n_sectors
; /* size of device, if ATA */
733 u64 n_native_sectors
; /* native size, if ATA */
734 unsigned int class; /* ATA_DEV_xxx */
735 unsigned long unpark_deadline
;
740 unsigned int xfer_shift
; /* ATA_SHIFT_xxx */
742 unsigned int multi_count
; /* sectors count for
743 READ/WRITE MULTIPLE */
744 unsigned int max_sectors
; /* per-device max sectors */
745 unsigned int cdb_len
;
747 /* per-dev xfer mask */
748 unsigned int pio_mask
;
749 unsigned int mwdma_mask
;
750 unsigned int udma_mask
;
752 /* for CHS addressing */
753 u16 cylinders
; /* Number of cylinders */
754 u16 heads
; /* Number of heads */
755 u16 sectors
; /* Number of sectors per track */
758 u16 id
[ATA_ID_WORDS
]; /* IDENTIFY xxx DEVICE data */
759 u32 gscr
[SATA_PMP_GSCR_DWORDS
]; /* PMP GSCR block */
760 } ____cacheline_aligned
;
762 /* DEVSLP Timing Variables from Identify Device Data Log */
763 u8 devslp_timing
[ATA_LOG_DEVSLP_SIZE
];
765 /* NCQ send and receive log subcommand support */
766 u8 ncq_send_recv_cmds
[ATA_LOG_NCQ_SEND_RECV_SIZE
];
767 u8 ncq_non_data_cmds
[ATA_LOG_NCQ_NON_DATA_SIZE
];
769 /* ZAC zone configuration */
771 u32 zac_zones_optimal_open
;
772 u32 zac_zones_optimal_nonseq
;
773 u32 zac_zones_max_open
;
775 /* Concurrent positioning ranges */
776 struct ata_cpr_log
*cpr_log
;
778 /* Command Duration Limits support */
783 /* ering is CLEAR_END, read comment above CLEAR_END */
784 struct ata_ering ering
;
787 u8 sector_buf
[ATA_SECT_SIZE
] ____cacheline_aligned
;
790 /* Fields between ATA_DEVICE_CLEAR_BEGIN and ATA_DEVICE_CLEAR_END are
791 * cleared to zero on ata_dev_init().
793 #define ATA_DEVICE_CLEAR_BEGIN offsetof(struct ata_device, n_sectors)
794 #define ATA_DEVICE_CLEAR_END offsetof(struct ata_device, ering)
797 struct ata_device
*dev
; /* offending device */
798 u32 serror
; /* SError from LLDD */
799 unsigned int err_mask
; /* port-wide err_mask */
800 unsigned int action
; /* ATA_EH_* action mask */
801 unsigned int dev_action
[ATA_MAX_DEVICES
]; /* dev EH action */
802 unsigned int flags
; /* ATA_EHI_* flags */
804 unsigned int probe_mask
;
806 char desc
[ATA_EH_DESC_LEN
];
810 struct ata_eh_context
{
811 struct ata_eh_info i
;
812 int tries
[ATA_MAX_DEVICES
];
813 int cmd_timeout_idx
[ATA_MAX_DEVICES
]
814 [ATA_EH_CMD_TIMEOUT_TABLE_SIZE
];
815 unsigned int classes
[ATA_MAX_DEVICES
];
816 unsigned int did_probe_mask
;
817 unsigned int unloaded_mask
;
818 unsigned int saved_ncq_enabled
;
819 u8 saved_xfer_mode
[ATA_MAX_DEVICES
];
820 /* timestamp for the last reset attempt or success */
821 unsigned long last_reset
;
824 struct ata_acpi_drive
830 struct ata_acpi_gtm
{
831 struct ata_acpi_drive drive
[2];
837 int pmp
; /* port multiplier port # */
840 unsigned int active_tag
; /* active tag on this link */
841 u32 sactive
; /* active NCQ commands */
843 unsigned int flags
; /* ATA_LFLAG_xxx */
845 u32 saved_scontrol
; /* SControl on probe */
846 unsigned int hw_sata_spd_limit
;
847 unsigned int sata_spd_limit
;
848 unsigned int sata_spd
; /* current SATA PHY speed */
849 enum ata_lpm_policy lpm_policy
;
851 /* record runtime error info, protected by host_set lock */
852 struct ata_eh_info eh_info
;
854 struct ata_eh_context eh_context
;
856 struct ata_device device
[ATA_MAX_DEVICES
];
858 unsigned long last_lpm_change
; /* when last LPM change happened */
860 #define ATA_LINK_CLEAR_BEGIN offsetof(struct ata_link, active_tag)
861 #define ATA_LINK_CLEAR_END offsetof(struct ata_link, device[0])
864 struct Scsi_Host
*scsi_host
; /* our co-allocated scsi host */
865 struct ata_port_operations
*ops
;
867 /* Flags owned by the EH context. Only EH should touch these once the
869 unsigned long flags
; /* ATA_FLAG_xxx */
870 /* Flags that change dynamically, protected by ap->lock */
871 unsigned int pflags
; /* ATA_PFLAG_xxx */
872 unsigned int print_id
; /* user visible unique port ID */
873 unsigned int port_no
; /* 0 based port no. inside the host */
875 #ifdef CONFIG_ATA_SFF
876 struct ata_ioports ioaddr
; /* ATA cmd/ctl/dma register blocks */
877 u8 ctl
; /* cache of ATA control register */
878 u8 last_ctl
; /* Cache last written value */
879 struct ata_link
* sff_pio_task_link
; /* link currently used */
880 struct delayed_work sff_pio_task
;
881 #ifdef CONFIG_ATA_BMDMA
882 struct ata_bmdma_prd
*bmdma_prd
; /* BMDMA SG list */
883 dma_addr_t bmdma_prd_dma
; /* and its DMA mapping */
884 #endif /* CONFIG_ATA_BMDMA */
885 #endif /* CONFIG_ATA_SFF */
887 unsigned int pio_mask
;
888 unsigned int mwdma_mask
;
889 unsigned int udma_mask
;
890 unsigned int cbl
; /* cable type; ATA_CBL_xxx */
892 struct ata_queued_cmd qcmd
[ATA_MAX_QUEUE
+ 1];
894 int nr_active_links
; /* #links with active qcs */
896 struct ata_link link
; /* host default link */
897 struct ata_link
*slave_link
; /* see ata_slave_link_init() */
899 int nr_pmp_links
; /* nr of available PMP links */
900 struct ata_link
*pmp_link
; /* array of PMP links */
901 struct ata_link
*excl_link
; /* for PMP qc exclusion */
903 struct ata_port_stats stats
;
904 struct ata_host
*host
;
908 struct mutex scsi_scan_mutex
;
909 struct delayed_work hotplug_task
;
910 struct delayed_work scsi_rescan_task
;
912 unsigned int hsm_task_state
;
914 struct list_head eh_done_q
;
915 wait_queue_head_t eh_wait_q
;
917 struct completion park_req_pending
;
919 pm_message_t pm_mesg
;
920 enum ata_lpm_policy target_lpm_policy
;
922 struct timer_list fastdrain_timer
;
923 unsigned int fastdrain_cnt
;
925 async_cookie_t cookie
;
930 #ifdef CONFIG_ATA_ACPI
931 struct ata_acpi_gtm __acpi_init_gtm
; /* use ata_acpi_init_gtm() */
935 /* The following initializer overrides a method to NULL whether one of
936 * its parent has the method defined or not. This is equivalent to
937 * ERR_PTR(-ENOENT). Unfortunately, ERR_PTR doesn't render a constant
938 * expression and thus can't be used as an initializer.
940 #define ATA_OP_NULL (void *)(unsigned long)(-ENOENT)
942 struct ata_port_operations
{
946 int (*qc_defer
)(struct ata_queued_cmd
*qc
);
947 int (*check_atapi_dma
)(struct ata_queued_cmd
*qc
);
948 enum ata_completion_errors (*qc_prep
)(struct ata_queued_cmd
*qc
);
949 unsigned int (*qc_issue
)(struct ata_queued_cmd
*qc
);
950 void (*qc_fill_rtf
)(struct ata_queued_cmd
*qc
);
951 void (*qc_ncq_fill_rtf
)(struct ata_port
*ap
, u64 done_mask
);
954 * Configuration and exception handling
956 int (*cable_detect
)(struct ata_port
*ap
);
957 unsigned int (*mode_filter
)(struct ata_device
*dev
, unsigned int xfer_mask
);
958 void (*set_piomode
)(struct ata_port
*ap
, struct ata_device
*dev
);
959 void (*set_dmamode
)(struct ata_port
*ap
, struct ata_device
*dev
);
960 int (*set_mode
)(struct ata_link
*link
, struct ata_device
**r_failed_dev
);
961 unsigned int (*read_id
)(struct ata_device
*dev
, struct ata_taskfile
*tf
,
964 void (*dev_config
)(struct ata_device
*dev
);
966 void (*freeze
)(struct ata_port
*ap
);
967 void (*thaw
)(struct ata_port
*ap
);
968 ata_prereset_fn_t prereset
;
969 ata_reset_fn_t softreset
;
970 ata_reset_fn_t hardreset
;
971 ata_postreset_fn_t postreset
;
972 ata_prereset_fn_t pmp_prereset
;
973 ata_reset_fn_t pmp_softreset
;
974 ata_reset_fn_t pmp_hardreset
;
975 ata_postreset_fn_t pmp_postreset
;
976 void (*error_handler
)(struct ata_port
*ap
);
977 void (*lost_interrupt
)(struct ata_port
*ap
);
978 void (*post_internal_cmd
)(struct ata_queued_cmd
*qc
);
979 void (*sched_eh
)(struct ata_port
*ap
);
980 void (*end_eh
)(struct ata_port
*ap
);
985 int (*scr_read
)(struct ata_link
*link
, unsigned int sc_reg
, u32
*val
);
986 int (*scr_write
)(struct ata_link
*link
, unsigned int sc_reg
, u32 val
);
987 void (*pmp_attach
)(struct ata_port
*ap
);
988 void (*pmp_detach
)(struct ata_port
*ap
);
989 int (*set_lpm
)(struct ata_link
*link
, enum ata_lpm_policy policy
,
993 * Start, stop, suspend and resume
995 int (*port_suspend
)(struct ata_port
*ap
, pm_message_t mesg
);
996 int (*port_resume
)(struct ata_port
*ap
);
997 int (*port_start
)(struct ata_port
*ap
);
998 void (*port_stop
)(struct ata_port
*ap
);
999 void (*host_stop
)(struct ata_host
*host
);
1001 #ifdef CONFIG_ATA_SFF
1003 * SFF / taskfile oriented ops
1005 void (*sff_dev_select
)(struct ata_port
*ap
, unsigned int device
);
1006 void (*sff_set_devctl
)(struct ata_port
*ap
, u8 ctl
);
1007 u8 (*sff_check_status
)(struct ata_port
*ap
);
1008 u8 (*sff_check_altstatus
)(struct ata_port
*ap
);
1009 void (*sff_tf_load
)(struct ata_port
*ap
, const struct ata_taskfile
*tf
);
1010 void (*sff_tf_read
)(struct ata_port
*ap
, struct ata_taskfile
*tf
);
1011 void (*sff_exec_command
)(struct ata_port
*ap
,
1012 const struct ata_taskfile
*tf
);
1013 unsigned int (*sff_data_xfer
)(struct ata_queued_cmd
*qc
,
1014 unsigned char *buf
, unsigned int buflen
, int rw
);
1015 void (*sff_irq_on
)(struct ata_port
*);
1016 bool (*sff_irq_check
)(struct ata_port
*);
1017 void (*sff_irq_clear
)(struct ata_port
*);
1018 void (*sff_drain_fifo
)(struct ata_queued_cmd
*qc
);
1020 #ifdef CONFIG_ATA_BMDMA
1021 void (*bmdma_setup
)(struct ata_queued_cmd
*qc
);
1022 void (*bmdma_start
)(struct ata_queued_cmd
*qc
);
1023 void (*bmdma_stop
)(struct ata_queued_cmd
*qc
);
1024 u8 (*bmdma_status
)(struct ata_port
*ap
);
1025 #endif /* CONFIG_ATA_BMDMA */
1026 #endif /* CONFIG_ATA_SFF */
1028 ssize_t (*em_show
)(struct ata_port
*ap
, char *buf
);
1029 ssize_t (*em_store
)(struct ata_port
*ap
, const char *message
,
1031 ssize_t (*sw_activity_show
)(struct ata_device
*dev
, char *buf
);
1032 ssize_t (*sw_activity_store
)(struct ata_device
*dev
,
1033 enum sw_activity val
);
1034 ssize_t (*transmit_led_message
)(struct ata_port
*ap
, u32 state
,
1038 * ->inherits must be the last field and all the preceding
1039 * fields must be pointers.
1041 const struct ata_port_operations
*inherits
;
1044 struct ata_port_info
{
1045 unsigned long flags
;
1046 unsigned long link_flags
;
1047 unsigned int pio_mask
;
1048 unsigned int mwdma_mask
;
1049 unsigned int udma_mask
;
1050 struct ata_port_operations
*port_ops
;
1055 unsigned short mode
; /* ATA mode */
1056 unsigned short setup
; /* t1 */
1057 unsigned short act8b
; /* t2 for 8-bit I/O */
1058 unsigned short rec8b
; /* t2i for 8-bit I/O */
1059 unsigned short cyc8b
; /* t0 for 8-bit I/O */
1060 unsigned short active
; /* t2 or tD */
1061 unsigned short recover
; /* t2i or tK */
1062 unsigned short dmack_hold
; /* tj */
1063 unsigned short cycle
; /* t0 */
1064 unsigned short udma
; /* t2CYCTYP/2 */
1068 * Core layer - drivers/ata/libata-core.c
1070 extern struct ata_port_operations ata_dummy_port_ops
;
1071 extern const struct ata_port_info ata_dummy_port_info
;
1073 static inline bool ata_is_atapi(u8 prot
)
1075 return prot
& ATA_PROT_FLAG_ATAPI
;
1078 static inline bool ata_is_pio(u8 prot
)
1080 return prot
& ATA_PROT_FLAG_PIO
;
1083 static inline bool ata_is_dma(u8 prot
)
1085 return prot
& ATA_PROT_FLAG_DMA
;
1088 static inline bool ata_is_ncq(u8 prot
)
1090 return prot
& ATA_PROT_FLAG_NCQ
;
1093 static inline bool ata_is_data(u8 prot
)
1095 return prot
& (ATA_PROT_FLAG_PIO
| ATA_PROT_FLAG_DMA
);
1098 static inline int is_multi_taskfile(struct ata_taskfile
*tf
)
1100 return (tf
->command
== ATA_CMD_READ_MULTI
) ||
1101 (tf
->command
== ATA_CMD_WRITE_MULTI
) ||
1102 (tf
->command
== ATA_CMD_READ_MULTI_EXT
) ||
1103 (tf
->command
== ATA_CMD_WRITE_MULTI_EXT
) ||
1104 (tf
->command
== ATA_CMD_WRITE_MULTI_FUA_EXT
);
1107 static inline int ata_port_is_dummy(struct ata_port
*ap
)
1109 return ap
->ops
== &ata_dummy_port_ops
;
1112 static inline bool ata_port_is_frozen(const struct ata_port
*ap
)
1114 return ap
->pflags
& ATA_PFLAG_FROZEN
;
1117 extern int ata_std_prereset(struct ata_link
*link
, unsigned long deadline
);
1118 extern int ata_wait_after_reset(struct ata_link
*link
, unsigned long deadline
,
1119 int (*check_ready
)(struct ata_link
*link
));
1120 extern void ata_std_postreset(struct ata_link
*link
, unsigned int *classes
);
1122 extern struct ata_host
*ata_host_alloc(struct device
*dev
, int n_ports
);
1123 extern struct ata_host
*ata_host_alloc_pinfo(struct device
*dev
,
1124 const struct ata_port_info
* const * ppi
, int n_ports
);
1125 extern void ata_host_get(struct ata_host
*host
);
1126 extern void ata_host_put(struct ata_host
*host
);
1127 extern int ata_host_start(struct ata_host
*host
);
1128 extern int ata_host_register(struct ata_host
*host
,
1129 const struct scsi_host_template
*sht
);
1130 extern int ata_host_activate(struct ata_host
*host
, int irq
,
1131 irq_handler_t irq_handler
, unsigned long irq_flags
,
1132 const struct scsi_host_template
*sht
);
1133 extern void ata_host_detach(struct ata_host
*host
);
1134 extern void ata_host_init(struct ata_host
*, struct device
*, struct ata_port_operations
*);
1135 extern int ata_scsi_ioctl(struct scsi_device
*dev
, unsigned int cmd
,
1137 #ifdef CONFIG_COMPAT
1138 #define ATA_SCSI_COMPAT_IOCTL .compat_ioctl = ata_scsi_ioctl,
1140 #define ATA_SCSI_COMPAT_IOCTL /* empty */
1142 extern int ata_scsi_queuecmd(struct Scsi_Host
*h
, struct scsi_cmnd
*cmd
);
1143 #if IS_REACHABLE(CONFIG_ATA)
1144 bool ata_scsi_dma_need_drain(struct request
*rq
);
1146 #define ata_scsi_dma_need_drain NULL
1148 extern int ata_sas_scsi_ioctl(struct ata_port
*ap
, struct scsi_device
*dev
,
1149 unsigned int cmd
, void __user
*arg
);
1150 extern bool ata_link_online(struct ata_link
*link
);
1151 extern bool ata_link_offline(struct ata_link
*link
);
1153 extern void ata_host_suspend(struct ata_host
*host
, pm_message_t mesg
);
1154 extern void ata_host_resume(struct ata_host
*host
);
1155 extern void ata_sas_port_suspend(struct ata_port
*ap
);
1156 extern void ata_sas_port_resume(struct ata_port
*ap
);
1158 static inline void ata_sas_port_suspend(struct ata_port
*ap
)
1161 static inline void ata_sas_port_resume(struct ata_port
*ap
)
1165 extern int ata_ratelimit(void);
1166 extern void ata_msleep(struct ata_port
*ap
, unsigned int msecs
);
1167 extern u32
ata_wait_register(struct ata_port
*ap
, void __iomem
*reg
, u32 mask
,
1168 u32 val
, unsigned int interval
, unsigned int timeout
);
1169 extern int atapi_cmd_type(u8 opcode
);
1170 extern unsigned int ata_pack_xfermask(unsigned int pio_mask
,
1171 unsigned int mwdma_mask
,
1172 unsigned int udma_mask
);
1173 extern void ata_unpack_xfermask(unsigned int xfer_mask
,
1174 unsigned int *pio_mask
,
1175 unsigned int *mwdma_mask
,
1176 unsigned int *udma_mask
);
1177 extern u8
ata_xfer_mask2mode(unsigned int xfer_mask
);
1178 extern unsigned int ata_xfer_mode2mask(u8 xfer_mode
);
1179 extern int ata_xfer_mode2shift(u8 xfer_mode
);
1180 extern const char *ata_mode_string(unsigned int xfer_mask
);
1181 extern unsigned int ata_id_xfermask(const u16
*id
);
1182 extern int ata_std_qc_defer(struct ata_queued_cmd
*qc
);
1183 extern void ata_sg_init(struct ata_queued_cmd
*qc
, struct scatterlist
*sg
,
1184 unsigned int n_elem
);
1185 extern unsigned int ata_dev_classify(const struct ata_taskfile
*tf
);
1186 extern unsigned int ata_port_classify(struct ata_port
*ap
,
1187 const struct ata_taskfile
*tf
);
1188 extern void ata_dev_disable(struct ata_device
*adev
);
1189 extern void ata_id_string(const u16
*id
, unsigned char *s
,
1190 unsigned int ofs
, unsigned int len
);
1191 extern void ata_id_c_string(const u16
*id
, unsigned char *s
,
1192 unsigned int ofs
, unsigned int len
);
1193 extern unsigned int ata_do_dev_read_id(struct ata_device
*dev
,
1194 struct ata_taskfile
*tf
, __le16
*id
);
1195 extern void ata_qc_complete(struct ata_queued_cmd
*qc
);
1196 extern u64
ata_qc_get_active(struct ata_port
*ap
);
1197 extern void ata_scsi_simulate(struct ata_device
*dev
, struct scsi_cmnd
*cmd
);
1198 extern int ata_std_bios_param(struct scsi_device
*sdev
,
1199 struct block_device
*bdev
,
1200 sector_t capacity
, int geom
[]);
1201 extern void ata_scsi_unlock_native_capacity(struct scsi_device
*sdev
);
1202 extern int ata_scsi_slave_alloc(struct scsi_device
*sdev
);
1203 int ata_scsi_device_configure(struct scsi_device
*sdev
,
1204 struct queue_limits
*lim
);
1205 extern void ata_scsi_slave_destroy(struct scsi_device
*sdev
);
1206 extern int ata_scsi_change_queue_depth(struct scsi_device
*sdev
,
1208 extern int ata_change_queue_depth(struct ata_port
*ap
, struct scsi_device
*sdev
,
1210 extern int ata_ncq_prio_supported(struct ata_port
*ap
, struct scsi_device
*sdev
,
1212 extern int ata_ncq_prio_enabled(struct ata_port
*ap
, struct scsi_device
*sdev
,
1214 extern int ata_ncq_prio_enable(struct ata_port
*ap
, struct scsi_device
*sdev
,
1216 extern struct ata_device
*ata_dev_pair(struct ata_device
*adev
);
1217 extern int ata_do_set_mode(struct ata_link
*link
, struct ata_device
**r_failed_dev
);
1218 extern void ata_scsi_port_error_handler(struct Scsi_Host
*host
, struct ata_port
*ap
);
1219 extern void ata_scsi_cmd_error_handler(struct Scsi_Host
*host
, struct ata_port
*ap
, struct list_head
*eh_q
);
1222 * SATA specific code - drivers/ata/libata-sata.c
1224 #ifdef CONFIG_SATA_HOST
1225 extern const unsigned int sata_deb_timing_normal
[];
1226 extern const unsigned int sata_deb_timing_hotplug
[];
1227 extern const unsigned int sata_deb_timing_long
[];
1229 static inline const unsigned int *
1230 sata_ehc_deb_timing(struct ata_eh_context
*ehc
)
1232 if (ehc
->i
.flags
& ATA_EHI_HOTPLUGGED
)
1233 return sata_deb_timing_hotplug
;
1235 return sata_deb_timing_normal
;
1238 extern int sata_scr_valid(struct ata_link
*link
);
1239 extern int sata_scr_read(struct ata_link
*link
, int reg
, u32
*val
);
1240 extern int sata_scr_write(struct ata_link
*link
, int reg
, u32 val
);
1241 extern int sata_scr_write_flush(struct ata_link
*link
, int reg
, u32 val
);
1242 extern int sata_set_spd(struct ata_link
*link
);
1243 int sata_std_hardreset(struct ata_link
*link
, unsigned int *class,
1244 unsigned long deadline
);
1245 extern int sata_link_hardreset(struct ata_link
*link
,
1246 const unsigned int *timing
, unsigned long deadline
,
1247 bool *online
, int (*check_ready
)(struct ata_link
*));
1248 extern int sata_link_resume(struct ata_link
*link
, const unsigned int *params
,
1249 unsigned long deadline
);
1250 extern void ata_eh_analyze_ncq_error(struct ata_link
*link
);
1252 static inline const unsigned int *
1253 sata_ehc_deb_timing(struct ata_eh_context
*ehc
)
1257 static inline int sata_scr_valid(struct ata_link
*link
) { return 0; }
1258 static inline int sata_scr_read(struct ata_link
*link
, int reg
, u32
*val
)
1262 static inline int sata_scr_write(struct ata_link
*link
, int reg
, u32 val
)
1266 static inline int sata_scr_write_flush(struct ata_link
*link
, int reg
, u32 val
)
1270 static inline int sata_set_spd(struct ata_link
*link
) { return -EOPNOTSUPP
; }
1271 static inline int sata_std_hardreset(struct ata_link
*link
, unsigned int *class,
1272 unsigned long deadline
)
1276 static inline int sata_link_hardreset(struct ata_link
*link
,
1277 const unsigned int *timing
,
1278 unsigned long deadline
,
1280 int (*check_ready
)(struct ata_link
*))
1286 static inline int sata_link_resume(struct ata_link
*link
,
1287 const unsigned int *params
,
1288 unsigned long deadline
)
1292 static inline void ata_eh_analyze_ncq_error(struct ata_link
*link
) { }
1294 extern int sata_link_debounce(struct ata_link
*link
,
1295 const unsigned int *params
, unsigned long deadline
);
1296 extern int sata_link_scr_lpm(struct ata_link
*link
, enum ata_lpm_policy policy
,
1298 extern int ata_slave_link_init(struct ata_port
*ap
);
1299 extern void ata_port_probe(struct ata_port
*ap
);
1300 extern struct ata_port
*ata_port_alloc(struct ata_host
*host
);
1301 extern void ata_port_free(struct ata_port
*ap
);
1302 extern int ata_tport_add(struct device
*parent
, struct ata_port
*ap
);
1303 extern void ata_tport_delete(struct ata_port
*ap
);
1304 int ata_sas_device_configure(struct scsi_device
*sdev
, struct queue_limits
*lim
,
1305 struct ata_port
*ap
);
1306 extern int ata_sas_queuecmd(struct scsi_cmnd
*cmd
, struct ata_port
*ap
);
1307 extern void ata_tf_to_fis(const struct ata_taskfile
*tf
,
1308 u8 pmp
, int is_cmd
, u8
*fis
);
1309 extern void ata_tf_from_fis(const u8
*fis
, struct ata_taskfile
*tf
);
1310 extern int ata_qc_complete_multiple(struct ata_port
*ap
, u64 qc_active
);
1311 extern bool sata_lpm_ignore_phy_events(struct ata_link
*link
);
1312 extern int sata_async_notification(struct ata_port
*ap
);
1314 extern int ata_cable_40wire(struct ata_port
*ap
);
1315 extern int ata_cable_80wire(struct ata_port
*ap
);
1316 extern int ata_cable_sata(struct ata_port
*ap
);
1317 extern int ata_cable_ignore(struct ata_port
*ap
);
1318 extern int ata_cable_unknown(struct ata_port
*ap
);
1320 /* Timing helpers */
1321 extern unsigned int ata_pio_need_iordy(const struct ata_device
*);
1322 extern u8
ata_timing_cycle2mode(unsigned int xfer_shift
, int cycle
);
1329 unsigned int reg
; /* PCI config register to read */
1330 unsigned int width
; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
1335 extern int pci_test_config_bits(struct pci_dev
*pdev
, const struct pci_bits
*bits
);
1336 extern void ata_pci_shutdown_one(struct pci_dev
*pdev
);
1337 extern void ata_pci_remove_one(struct pci_dev
*pdev
);
1340 extern void ata_pci_device_do_suspend(struct pci_dev
*pdev
, pm_message_t mesg
);
1341 extern int __must_check
ata_pci_device_do_resume(struct pci_dev
*pdev
);
1342 extern int ata_pci_device_suspend(struct pci_dev
*pdev
, pm_message_t mesg
);
1343 extern int ata_pci_device_resume(struct pci_dev
*pdev
);
1344 #endif /* CONFIG_PM */
1345 #endif /* CONFIG_PCI */
1347 struct platform_device
;
1349 extern void ata_platform_remove_one(struct platform_device
*pdev
);
1352 * ACPI - drivers/ata/libata-acpi.c
1354 #ifdef CONFIG_ATA_ACPI
1355 static inline const struct ata_acpi_gtm
*ata_acpi_init_gtm(struct ata_port
*ap
)
1357 if (ap
->pflags
& ATA_PFLAG_INIT_GTM_VALID
)
1358 return &ap
->__acpi_init_gtm
;
1361 int ata_acpi_stm(struct ata_port
*ap
, const struct ata_acpi_gtm
*stm
);
1362 int ata_acpi_gtm(struct ata_port
*ap
, struct ata_acpi_gtm
*stm
);
1363 unsigned int ata_acpi_gtm_xfermask(struct ata_device
*dev
,
1364 const struct ata_acpi_gtm
*gtm
);
1365 int ata_acpi_cbl_80wire(struct ata_port
*ap
, const struct ata_acpi_gtm
*gtm
);
1367 static inline const struct ata_acpi_gtm
*ata_acpi_init_gtm(struct ata_port
*ap
)
1372 static inline int ata_acpi_stm(const struct ata_port
*ap
,
1373 struct ata_acpi_gtm
*stm
)
1378 static inline int ata_acpi_gtm(const struct ata_port
*ap
,
1379 struct ata_acpi_gtm
*stm
)
1384 static inline unsigned int ata_acpi_gtm_xfermask(struct ata_device
*dev
,
1385 const struct ata_acpi_gtm
*gtm
)
1390 static inline int ata_acpi_cbl_80wire(struct ata_port
*ap
,
1391 const struct ata_acpi_gtm
*gtm
)
1398 * EH - drivers/ata/libata-eh.c
1400 extern void ata_port_schedule_eh(struct ata_port
*ap
);
1401 extern void ata_port_wait_eh(struct ata_port
*ap
);
1402 extern int ata_link_abort(struct ata_link
*link
);
1403 extern int ata_port_abort(struct ata_port
*ap
);
1404 extern int ata_port_freeze(struct ata_port
*ap
);
1406 extern void ata_eh_freeze_port(struct ata_port
*ap
);
1407 extern void ata_eh_thaw_port(struct ata_port
*ap
);
1409 extern void ata_eh_qc_complete(struct ata_queued_cmd
*qc
);
1410 extern void ata_eh_qc_retry(struct ata_queued_cmd
*qc
);
1412 extern void ata_do_eh(struct ata_port
*ap
, ata_prereset_fn_t prereset
,
1413 ata_reset_fn_t softreset
, ata_reset_fn_t hardreset
,
1414 ata_postreset_fn_t postreset
);
1415 extern void ata_std_error_handler(struct ata_port
*ap
);
1416 extern void ata_std_sched_eh(struct ata_port
*ap
);
1417 extern void ata_std_end_eh(struct ata_port
*ap
);
1418 extern int ata_link_nr_enabled(struct ata_link
*link
);
1421 * Base operations to inherit from and initializers for sht
1425 * base : Common to all libata drivers.
1426 * sata : SATA controllers w/ native interface.
1427 * pmp : SATA controllers w/ PMP support.
1428 * sff : SFF ATA controllers w/o BMDMA support.
1429 * bmdma : SFF ATA controllers w/ BMDMA support.
1433 * BASE : Common to all libata drivers. The user must set
1434 * sg_tablesize and dma_boundary.
1435 * PIO : SFF ATA controllers w/ only PIO support.
1436 * BMDMA : SFF ATA controllers w/ BMDMA support. sg_tablesize and
1437 * dma_boundary are set to BMDMA limits.
1438 * NCQ : SATA controllers supporting NCQ. The user must set
1439 * sg_tablesize, dma_boundary and can_queue.
1441 extern const struct ata_port_operations ata_base_port_ops
;
1442 extern const struct ata_port_operations sata_port_ops
;
1443 extern const struct attribute_group
*ata_common_sdev_groups
[];
1446 * All sht initializers (BASE, PIO, BMDMA, NCQ) must be instantiated
1447 * by the edge drivers. Because the 'module' field of sht must be the
1448 * edge driver's module reference, otherwise the driver can be unloaded
1449 * even if the scsi_device is being accessed.
1451 #define __ATA_BASE_SHT(drv_name) \
1452 .module = THIS_MODULE, \
1454 .ioctl = ata_scsi_ioctl, \
1455 ATA_SCSI_COMPAT_IOCTL \
1456 .queuecommand = ata_scsi_queuecmd, \
1457 .dma_need_drain = ata_scsi_dma_need_drain, \
1458 .this_id = ATA_SHT_THIS_ID, \
1459 .emulated = ATA_SHT_EMULATED, \
1460 .proc_name = drv_name, \
1461 .slave_alloc = ata_scsi_slave_alloc, \
1462 .slave_destroy = ata_scsi_slave_destroy, \
1463 .bios_param = ata_std_bios_param, \
1464 .unlock_native_capacity = ata_scsi_unlock_native_capacity,\
1465 .max_sectors = ATA_MAX_SECTORS_LBA48
1467 #define ATA_SUBBASE_SHT(drv_name) \
1468 __ATA_BASE_SHT(drv_name), \
1469 .can_queue = ATA_DEF_QUEUE, \
1470 .tag_alloc_policy = BLK_TAG_ALLOC_RR, \
1471 .device_configure = ata_scsi_device_configure
1473 #define ATA_SUBBASE_SHT_QD(drv_name, drv_qd) \
1474 __ATA_BASE_SHT(drv_name), \
1475 .can_queue = drv_qd, \
1476 .tag_alloc_policy = BLK_TAG_ALLOC_RR, \
1477 .device_configure = ata_scsi_device_configure
1479 #define ATA_BASE_SHT(drv_name) \
1480 ATA_SUBBASE_SHT(drv_name), \
1481 .sdev_groups = ata_common_sdev_groups
1483 #ifdef CONFIG_SATA_HOST
1484 extern const struct attribute_group
*ata_ncq_sdev_groups
[];
1486 #define ATA_NCQ_SHT(drv_name) \
1487 ATA_SUBBASE_SHT(drv_name), \
1488 .sdev_groups = ata_ncq_sdev_groups, \
1489 .change_queue_depth = ata_scsi_change_queue_depth
1491 #define ATA_NCQ_SHT_QD(drv_name, drv_qd) \
1492 ATA_SUBBASE_SHT_QD(drv_name, drv_qd), \
1493 .sdev_groups = ata_ncq_sdev_groups, \
1494 .change_queue_depth = ata_scsi_change_queue_depth
1500 #ifdef CONFIG_SATA_PMP
1501 static inline bool sata_pmp_supported(struct ata_port
*ap
)
1503 return ap
->flags
& ATA_FLAG_PMP
;
1506 static inline bool sata_pmp_attached(struct ata_port
*ap
)
1508 return ap
->nr_pmp_links
!= 0;
1511 static inline bool ata_is_host_link(const struct ata_link
*link
)
1513 return link
== &link
->ap
->link
|| link
== link
->ap
->slave_link
;
1515 #else /* CONFIG_SATA_PMP */
1516 static inline bool sata_pmp_supported(struct ata_port
*ap
)
1521 static inline bool sata_pmp_attached(struct ata_port
*ap
)
1526 static inline bool ata_is_host_link(const struct ata_link
*link
)
1530 #endif /* CONFIG_SATA_PMP */
1532 static inline int sata_srst_pmp(struct ata_link
*link
)
1534 if (sata_pmp_supported(link
->ap
) && ata_is_host_link(link
))
1535 return SATA_PMP_CTRL_PORT
;
1539 #define ata_port_printk(level, ap, fmt, ...) \
1540 pr_ ## level ("ata%u: " fmt, (ap)->print_id, ##__VA_ARGS__)
1542 #define ata_port_err(ap, fmt, ...) \
1543 ata_port_printk(err, ap, fmt, ##__VA_ARGS__)
1544 #define ata_port_warn(ap, fmt, ...) \
1545 ata_port_printk(warn, ap, fmt, ##__VA_ARGS__)
1546 #define ata_port_notice(ap, fmt, ...) \
1547 ata_port_printk(notice, ap, fmt, ##__VA_ARGS__)
1548 #define ata_port_info(ap, fmt, ...) \
1549 ata_port_printk(info, ap, fmt, ##__VA_ARGS__)
1550 #define ata_port_dbg(ap, fmt, ...) \
1551 ata_port_printk(debug, ap, fmt, ##__VA_ARGS__)
1553 #define ata_link_printk(level, link, fmt, ...) \
1555 if (sata_pmp_attached((link)->ap) || \
1556 (link)->ap->slave_link) \
1557 pr_ ## level ("ata%u.%02u: " fmt, \
1558 (link)->ap->print_id, \
1562 pr_ ## level ("ata%u: " fmt, \
1563 (link)->ap->print_id, \
1567 #define ata_link_err(link, fmt, ...) \
1568 ata_link_printk(err, link, fmt, ##__VA_ARGS__)
1569 #define ata_link_warn(link, fmt, ...) \
1570 ata_link_printk(warn, link, fmt, ##__VA_ARGS__)
1571 #define ata_link_notice(link, fmt, ...) \
1572 ata_link_printk(notice, link, fmt, ##__VA_ARGS__)
1573 #define ata_link_info(link, fmt, ...) \
1574 ata_link_printk(info, link, fmt, ##__VA_ARGS__)
1575 #define ata_link_dbg(link, fmt, ...) \
1576 ata_link_printk(debug, link, fmt, ##__VA_ARGS__)
1578 #define ata_dev_printk(level, dev, fmt, ...) \
1579 pr_ ## level("ata%u.%02u: " fmt, \
1580 (dev)->link->ap->print_id, \
1581 (dev)->link->pmp + (dev)->devno, \
1584 #define ata_dev_err(dev, fmt, ...) \
1585 ata_dev_printk(err, dev, fmt, ##__VA_ARGS__)
1586 #define ata_dev_warn(dev, fmt, ...) \
1587 ata_dev_printk(warn, dev, fmt, ##__VA_ARGS__)
1588 #define ata_dev_notice(dev, fmt, ...) \
1589 ata_dev_printk(notice, dev, fmt, ##__VA_ARGS__)
1590 #define ata_dev_info(dev, fmt, ...) \
1591 ata_dev_printk(info, dev, fmt, ##__VA_ARGS__)
1592 #define ata_dev_dbg(dev, fmt, ...) \
1593 ata_dev_printk(debug, dev, fmt, ##__VA_ARGS__)
1595 void ata_print_version(const struct device
*dev
, const char *version
);
1598 * ata_eh_info helpers
1600 extern __printf(2, 3)
1601 void __ata_ehi_push_desc(struct ata_eh_info
*ehi
, const char *fmt
, ...);
1602 extern __printf(2, 3)
1603 void ata_ehi_push_desc(struct ata_eh_info
*ehi
, const char *fmt
, ...);
1604 extern void ata_ehi_clear_desc(struct ata_eh_info
*ehi
);
1606 static inline void ata_ehi_hotplugged(struct ata_eh_info
*ehi
)
1608 ehi
->probe_mask
|= (1 << ATA_MAX_DEVICES
) - 1;
1609 ehi
->flags
|= ATA_EHI_HOTPLUGGED
;
1610 ehi
->action
|= ATA_EH_RESET
| ATA_EH_ENABLE_LINK
;
1611 ehi
->err_mask
|= AC_ERR_ATA_BUS
;
1615 * port description helpers
1617 extern __printf(2, 3)
1618 void ata_port_desc(struct ata_port
*ap
, const char *fmt
, ...);
1620 extern void ata_port_pbar_desc(struct ata_port
*ap
, int bar
, ssize_t offset
,
1623 static inline void ata_port_desc_misc(struct ata_port
*ap
, int irq
)
1625 ata_port_desc(ap
, "irq %d", irq
);
1626 ata_port_desc(ap
, "lpm-pol %d", ap
->target_lpm_policy
);
1629 static inline bool ata_tag_internal(unsigned int tag
)
1631 return tag
== ATA_TAG_INTERNAL
;
1634 static inline bool ata_tag_valid(unsigned int tag
)
1636 return tag
< ATA_MAX_QUEUE
|| ata_tag_internal(tag
);
1639 #define __ata_qc_for_each(ap, qc, tag, max_tag, fn) \
1640 for ((tag) = 0; (tag) < (max_tag) && \
1641 ({ qc = fn((ap), (tag)); 1; }); (tag)++) \
1644 * Internal use only, iterate commands ignoring error handling and
1647 #define ata_qc_for_each_raw(ap, qc, tag) \
1648 __ata_qc_for_each(ap, qc, tag, ATA_MAX_QUEUE, __ata_qc_from_tag)
1651 * Iterate all potential commands that can be queued
1653 #define ata_qc_for_each(ap, qc, tag) \
1654 __ata_qc_for_each(ap, qc, tag, ATA_MAX_QUEUE, ata_qc_from_tag)
1657 * Like ata_qc_for_each, but with the internal tag included
1659 #define ata_qc_for_each_with_internal(ap, qc, tag) \
1660 __ata_qc_for_each(ap, qc, tag, ATA_MAX_QUEUE + 1, ata_qc_from_tag)
1665 static inline unsigned int ata_class_enabled(unsigned int class)
1667 return class == ATA_DEV_ATA
|| class == ATA_DEV_ATAPI
||
1668 class == ATA_DEV_PMP
|| class == ATA_DEV_SEMB
||
1669 class == ATA_DEV_ZAC
;
1672 static inline unsigned int ata_class_disabled(unsigned int class)
1674 return class == ATA_DEV_ATA_UNSUP
|| class == ATA_DEV_ATAPI_UNSUP
||
1675 class == ATA_DEV_PMP_UNSUP
|| class == ATA_DEV_SEMB_UNSUP
||
1676 class == ATA_DEV_ZAC_UNSUP
;
1679 static inline unsigned int ata_class_absent(unsigned int class)
1681 return !ata_class_enabled(class) && !ata_class_disabled(class);
1684 static inline unsigned int ata_dev_enabled(const struct ata_device
*dev
)
1686 return ata_class_enabled(dev
->class);
1689 static inline unsigned int ata_dev_disabled(const struct ata_device
*dev
)
1691 return ata_class_disabled(dev
->class);
1694 static inline unsigned int ata_dev_absent(const struct ata_device
*dev
)
1696 return ata_class_absent(dev
->class);
1702 static inline int ata_link_max_devices(const struct ata_link
*link
)
1704 if (ata_is_host_link(link
) && link
->ap
->flags
& ATA_FLAG_SLAVE_POSS
)
1709 static inline int ata_link_active(struct ata_link
*link
)
1711 return ata_tag_valid(link
->active_tag
) || link
->sactive
;
1717 * ATA_LITER_* constants are used to select link iteration mode and
1718 * ATA_DITER_* device iteration mode.
1720 * For a custom iteration directly using ata_{link|dev}_next(), if
1721 * @link or @dev, respectively, is NULL, the first element is
1722 * returned. @dev and @link can be any valid device or link and the
1723 * next element according to the iteration mode will be returned.
1724 * After the last element, NULL is returned.
1726 enum ata_link_iter_mode
{
1727 ATA_LITER_EDGE
, /* if present, PMP links only; otherwise,
1728 * host link. no slave link */
1729 ATA_LITER_HOST_FIRST
, /* host link followed by PMP or slave links */
1730 ATA_LITER_PMP_FIRST
, /* PMP links followed by host link,
1731 * slave link still comes after host link */
1734 enum ata_dev_iter_mode
{
1736 ATA_DITER_ENABLED_REVERSE
,
1738 ATA_DITER_ALL_REVERSE
,
1741 extern struct ata_link
*ata_link_next(struct ata_link
*link
,
1742 struct ata_port
*ap
,
1743 enum ata_link_iter_mode mode
);
1745 extern struct ata_device
*ata_dev_next(struct ata_device
*dev
,
1746 struct ata_link
*link
,
1747 enum ata_dev_iter_mode mode
);
1750 * Shortcut notation for iterations
1752 * ata_for_each_link() iterates over each link of @ap according to
1753 * @mode. @link points to the current link in the loop. @link is
1754 * NULL after loop termination. ata_for_each_dev() works the same way
1755 * except that it iterates over each device of @link.
1757 * Note that the mode prefixes ATA_{L|D}ITER_ shouldn't need to be
1758 * specified when using the following shorthand notations. Only the
1759 * mode itself (EDGE, HOST_FIRST, ENABLED, etc...) should be
1760 * specified. This not only increases brevity but also makes it
1761 * impossible to use ATA_LITER_* for device iteration or vice-versa.
1763 #define ata_for_each_link(link, ap, mode) \
1764 for ((link) = ata_link_next(NULL, (ap), ATA_LITER_##mode); (link); \
1765 (link) = ata_link_next((link), (ap), ATA_LITER_##mode))
1767 #define ata_for_each_dev(dev, link, mode) \
1768 for ((dev) = ata_dev_next(NULL, (link), ATA_DITER_##mode); (dev); \
1769 (dev) = ata_dev_next((dev), (link), ATA_DITER_##mode))
1772 * ata_ncq_supported - Test whether NCQ is supported
1773 * @dev: ATA device to test
1776 * spin_lock_irqsave(host lock)
1779 * true if @dev supports NCQ, false otherwise.
1781 static inline bool ata_ncq_supported(struct ata_device
*dev
)
1783 if (!IS_ENABLED(CONFIG_SATA_HOST
))
1785 return (dev
->flags
& (ATA_DFLAG_PIO
| ATA_DFLAG_NCQ
)) == ATA_DFLAG_NCQ
;
1789 * ata_ncq_enabled - Test whether NCQ is enabled
1790 * @dev: ATA device to test
1793 * spin_lock_irqsave(host lock)
1796 * true if NCQ is enabled for @dev, false otherwise.
1798 static inline bool ata_ncq_enabled(struct ata_device
*dev
)
1800 return ata_ncq_supported(dev
) && !(dev
->flags
& ATA_DFLAG_NCQ_OFF
);
1803 static inline bool ata_fpdma_dsm_supported(struct ata_device
*dev
)
1805 return (dev
->flags
& ATA_DFLAG_NCQ_SEND_RECV
) &&
1806 (dev
->ncq_send_recv_cmds
[ATA_LOG_NCQ_SEND_RECV_DSM_OFFSET
] &
1807 ATA_LOG_NCQ_SEND_RECV_DSM_TRIM
);
1810 static inline bool ata_fpdma_read_log_supported(struct ata_device
*dev
)
1812 return (dev
->flags
& ATA_DFLAG_NCQ_SEND_RECV
) &&
1813 (dev
->ncq_send_recv_cmds
[ATA_LOG_NCQ_SEND_RECV_RD_LOG_OFFSET
] &
1814 ATA_LOG_NCQ_SEND_RECV_RD_LOG_SUPPORTED
);
1817 static inline bool ata_fpdma_zac_mgmt_in_supported(struct ata_device
*dev
)
1819 return (dev
->flags
& ATA_DFLAG_NCQ_SEND_RECV
) &&
1820 (dev
->ncq_send_recv_cmds
[ATA_LOG_NCQ_SEND_RECV_ZAC_MGMT_OFFSET
] &
1821 ATA_LOG_NCQ_SEND_RECV_ZAC_MGMT_IN_SUPPORTED
);
1824 static inline bool ata_fpdma_zac_mgmt_out_supported(struct ata_device
*dev
)
1826 return (dev
->ncq_non_data_cmds
[ATA_LOG_NCQ_NON_DATA_ZAC_MGMT_OFFSET
] &
1827 ATA_LOG_NCQ_NON_DATA_ZAC_MGMT_OUT
);
1830 static inline void ata_qc_set_polling(struct ata_queued_cmd
*qc
)
1832 qc
->tf
.ctl
|= ATA_NIEN
;
1835 static inline struct ata_queued_cmd
*__ata_qc_from_tag(struct ata_port
*ap
,
1838 if (ata_tag_valid(tag
))
1839 return &ap
->qcmd
[tag
];
1843 static inline struct ata_queued_cmd
*ata_qc_from_tag(struct ata_port
*ap
,
1846 struct ata_queued_cmd
*qc
= __ata_qc_from_tag(ap
, tag
);
1851 if ((qc
->flags
& (ATA_QCFLAG_ACTIVE
|
1852 ATA_QCFLAG_EH
)) == ATA_QCFLAG_ACTIVE
)
1858 static inline unsigned int ata_qc_raw_nbytes(struct ata_queued_cmd
*qc
)
1860 return qc
->nbytes
- min(qc
->extrabytes
, qc
->nbytes
);
1863 static inline void ata_tf_init(struct ata_device
*dev
, struct ata_taskfile
*tf
)
1865 memset(tf
, 0, sizeof(*tf
));
1867 #ifdef CONFIG_ATA_SFF
1868 tf
->ctl
= dev
->link
->ap
->ctl
;
1870 tf
->ctl
= ATA_DEVCTL_OBS
;
1872 if (dev
->devno
== 0)
1873 tf
->device
= ATA_DEVICE_OBS
;
1875 tf
->device
= ATA_DEVICE_OBS
| ATA_DEV1
;
1878 static inline void ata_qc_reinit(struct ata_queued_cmd
*qc
)
1880 qc
->dma_dir
= DMA_NONE
;
1885 qc
->nbytes
= qc
->extrabytes
= qc
->curbytes
= 0;
1888 qc
->sect_size
= ATA_SECT_SIZE
;
1890 ata_tf_init(qc
->dev
, &qc
->tf
);
1892 /* init result_tf such that it indicates normal completion */
1893 qc
->result_tf
.command
= ATA_DRDY
;
1894 qc
->result_tf
.feature
= 0;
1897 static inline int ata_try_flush_cache(const struct ata_device
*dev
)
1899 return ata_id_wcache_enabled(dev
->id
) ||
1900 ata_id_has_flush(dev
->id
) ||
1901 ata_id_has_flush_ext(dev
->id
);
1904 static inline unsigned int ac_err_mask(u8 status
)
1906 if (status
& (ATA_BUSY
| ATA_DRQ
))
1908 if (status
& (ATA_ERR
| ATA_DF
))
1913 static inline unsigned int __ac_err_mask(u8 status
)
1915 unsigned int mask
= ac_err_mask(status
);
1917 return AC_ERR_OTHER
;
1921 static inline struct ata_port
*ata_shost_to_port(struct Scsi_Host
*host
)
1923 return *(struct ata_port
**)&host
->hostdata
[0];
1926 static inline int ata_check_ready(u8 status
)
1928 if (!(status
& ATA_BUSY
))
1931 /* 0xff indicates either no device or device not ready */
1938 static inline unsigned long ata_deadline(unsigned long from_jiffies
,
1939 unsigned int timeout_msecs
)
1941 return from_jiffies
+ msecs_to_jiffies(timeout_msecs
);
1944 /* Don't open code these in drivers as there are traps. Firstly the range may
1945 change in future hardware and specs, secondly 0xFF means 'no DMA' but is
1946 > UDMA_0. Dyma ddreigiau */
1948 static inline bool ata_using_mwdma(struct ata_device
*adev
)
1950 return adev
->dma_mode
>= XFER_MW_DMA_0
&&
1951 adev
->dma_mode
<= XFER_MW_DMA_4
;
1954 static inline bool ata_using_udma(struct ata_device
*adev
)
1956 return adev
->dma_mode
>= XFER_UDMA_0
&&
1957 adev
->dma_mode
<= XFER_UDMA_7
;
1960 static inline bool ata_dma_enabled(struct ata_device
*adev
)
1962 return adev
->dma_mode
!= 0xFF;
1965 /**************************************************************************
1966 * PATA timings - drivers/ata/libata-pata-timings.c
1968 extern const struct ata_timing
*ata_timing_find_mode(u8 xfer_mode
);
1969 extern int ata_timing_compute(struct ata_device
*, unsigned short,
1970 struct ata_timing
*, int, int);
1971 extern void ata_timing_merge(const struct ata_timing
*,
1972 const struct ata_timing
*, struct ata_timing
*,
1975 /**************************************************************************
1976 * PMP - drivers/ata/libata-pmp.c
1978 #ifdef CONFIG_SATA_PMP
1980 extern const struct ata_port_operations sata_pmp_port_ops
;
1982 extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd
*qc
);
1983 extern void sata_pmp_error_handler(struct ata_port
*ap
);
1985 #else /* CONFIG_SATA_PMP */
1987 #define sata_pmp_port_ops sata_port_ops
1988 #define sata_pmp_qc_defer_cmd_switch ata_std_qc_defer
1989 #define sata_pmp_error_handler ata_std_error_handler
1991 #endif /* CONFIG_SATA_PMP */
1994 /**************************************************************************
1995 * SFF - drivers/ata/libata-sff.c
1997 #ifdef CONFIG_ATA_SFF
1999 extern const struct ata_port_operations ata_sff_port_ops
;
2000 extern const struct ata_port_operations ata_bmdma32_port_ops
;
2002 /* PIO only, sg_tablesize and dma_boundary limits can be removed */
2003 #define ATA_PIO_SHT(drv_name) \
2004 ATA_BASE_SHT(drv_name), \
2005 .sg_tablesize = LIBATA_MAX_PRD, \
2006 .dma_boundary = ATA_DMA_BOUNDARY
2008 extern void ata_sff_dev_select(struct ata_port
*ap
, unsigned int device
);
2009 extern u8
ata_sff_check_status(struct ata_port
*ap
);
2010 extern void ata_sff_pause(struct ata_port
*ap
);
2011 extern void ata_sff_dma_pause(struct ata_port
*ap
);
2012 extern int ata_sff_wait_ready(struct ata_link
*link
, unsigned long deadline
);
2013 extern void ata_sff_tf_load(struct ata_port
*ap
, const struct ata_taskfile
*tf
);
2014 extern void ata_sff_tf_read(struct ata_port
*ap
, struct ata_taskfile
*tf
);
2015 extern void ata_sff_exec_command(struct ata_port
*ap
,
2016 const struct ata_taskfile
*tf
);
2017 extern unsigned int ata_sff_data_xfer(struct ata_queued_cmd
*qc
,
2018 unsigned char *buf
, unsigned int buflen
, int rw
);
2019 extern unsigned int ata_sff_data_xfer32(struct ata_queued_cmd
*qc
,
2020 unsigned char *buf
, unsigned int buflen
, int rw
);
2021 extern void ata_sff_irq_on(struct ata_port
*ap
);
2022 extern int ata_sff_hsm_move(struct ata_port
*ap
, struct ata_queued_cmd
*qc
,
2023 u8 status
, int in_wq
);
2024 extern void ata_sff_queue_work(struct work_struct
*work
);
2025 extern void ata_sff_queue_delayed_work(struct delayed_work
*dwork
,
2026 unsigned long delay
);
2027 extern void ata_sff_queue_pio_task(struct ata_link
*link
, unsigned long delay
);
2028 extern unsigned int ata_sff_qc_issue(struct ata_queued_cmd
*qc
);
2029 extern void ata_sff_qc_fill_rtf(struct ata_queued_cmd
*qc
);
2030 extern unsigned int ata_sff_port_intr(struct ata_port
*ap
,
2031 struct ata_queued_cmd
*qc
);
2032 extern irqreturn_t
ata_sff_interrupt(int irq
, void *dev_instance
);
2033 extern void ata_sff_lost_interrupt(struct ata_port
*ap
);
2034 extern void ata_sff_freeze(struct ata_port
*ap
);
2035 extern void ata_sff_thaw(struct ata_port
*ap
);
2036 extern int ata_sff_prereset(struct ata_link
*link
, unsigned long deadline
);
2037 extern unsigned int ata_sff_dev_classify(struct ata_device
*dev
, int present
,
2039 extern int ata_sff_wait_after_reset(struct ata_link
*link
, unsigned int devmask
,
2040 unsigned long deadline
);
2041 extern int ata_sff_softreset(struct ata_link
*link
, unsigned int *classes
,
2042 unsigned long deadline
);
2043 extern int sata_sff_hardreset(struct ata_link
*link
, unsigned int *class,
2044 unsigned long deadline
);
2045 extern void ata_sff_postreset(struct ata_link
*link
, unsigned int *classes
);
2046 extern void ata_sff_drain_fifo(struct ata_queued_cmd
*qc
);
2047 extern void ata_sff_error_handler(struct ata_port
*ap
);
2048 extern void ata_sff_std_ports(struct ata_ioports
*ioaddr
);
2050 extern int ata_pci_sff_init_host(struct ata_host
*host
);
2051 extern int ata_pci_sff_prepare_host(struct pci_dev
*pdev
,
2052 const struct ata_port_info
* const * ppi
,
2053 struct ata_host
**r_host
);
2054 extern int ata_pci_sff_activate_host(struct ata_host
*host
,
2055 irq_handler_t irq_handler
,
2056 const struct scsi_host_template
*sht
);
2057 extern int ata_pci_sff_init_one(struct pci_dev
*pdev
,
2058 const struct ata_port_info
* const * ppi
,
2059 const struct scsi_host_template
*sht
, void *host_priv
, int hflags
);
2060 #endif /* CONFIG_PCI */
2062 #ifdef CONFIG_ATA_BMDMA
2064 extern const struct ata_port_operations ata_bmdma_port_ops
;
2066 #define ATA_BMDMA_SHT(drv_name) \
2067 ATA_BASE_SHT(drv_name), \
2068 .sg_tablesize = LIBATA_MAX_PRD, \
2069 .dma_boundary = ATA_DMA_BOUNDARY
2071 extern enum ata_completion_errors
ata_bmdma_qc_prep(struct ata_queued_cmd
*qc
);
2072 extern unsigned int ata_bmdma_qc_issue(struct ata_queued_cmd
*qc
);
2073 extern enum ata_completion_errors
ata_bmdma_dumb_qc_prep(struct ata_queued_cmd
*qc
);
2074 extern unsigned int ata_bmdma_port_intr(struct ata_port
*ap
,
2075 struct ata_queued_cmd
*qc
);
2076 extern irqreturn_t
ata_bmdma_interrupt(int irq
, void *dev_instance
);
2077 extern void ata_bmdma_error_handler(struct ata_port
*ap
);
2078 extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd
*qc
);
2079 extern void ata_bmdma_irq_clear(struct ata_port
*ap
);
2080 extern void ata_bmdma_setup(struct ata_queued_cmd
*qc
);
2081 extern void ata_bmdma_start(struct ata_queued_cmd
*qc
);
2082 extern void ata_bmdma_stop(struct ata_queued_cmd
*qc
);
2083 extern u8
ata_bmdma_status(struct ata_port
*ap
);
2084 extern int ata_bmdma_port_start(struct ata_port
*ap
);
2085 extern int ata_bmdma_port_start32(struct ata_port
*ap
);
2088 extern int ata_pci_bmdma_clear_simplex(struct pci_dev
*pdev
);
2089 extern void ata_pci_bmdma_init(struct ata_host
*host
);
2090 extern int ata_pci_bmdma_prepare_host(struct pci_dev
*pdev
,
2091 const struct ata_port_info
* const * ppi
,
2092 struct ata_host
**r_host
);
2093 extern int ata_pci_bmdma_init_one(struct pci_dev
*pdev
,
2094 const struct ata_port_info
* const * ppi
,
2095 const struct scsi_host_template
*sht
,
2096 void *host_priv
, int hflags
);
2097 #endif /* CONFIG_PCI */
2098 #endif /* CONFIG_ATA_BMDMA */
2101 * ata_sff_busy_wait - Wait for a port status register
2102 * @ap: Port to wait for.
2103 * @bits: bits that must be clear
2104 * @max: number of 10uS waits to perform
2106 * Waits up to max*10 microseconds for the selected bits in the port's
2107 * status register to be cleared.
2108 * Returns final value of status register.
2111 * Inherited from caller.
2113 static inline u8
ata_sff_busy_wait(struct ata_port
*ap
, unsigned int bits
,
2120 status
= ap
->ops
->sff_check_status(ap
);
2122 } while (status
!= 0xff && (status
& bits
) && (max
> 0));
2128 * ata_wait_idle - Wait for a port to be idle.
2129 * @ap: Port to wait for.
2131 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
2132 * Returns final value of status register.
2135 * Inherited from caller.
2137 static inline u8
ata_wait_idle(struct ata_port
*ap
)
2139 u8 status
= ata_sff_busy_wait(ap
, ATA_BUSY
| ATA_DRQ
, 1000);
2141 if (status
!= 0xff && (status
& (ATA_BUSY
| ATA_DRQ
)))
2142 ata_port_dbg(ap
, "abnormal Status 0x%X\n", status
);
2146 #endif /* CONFIG_ATA_SFF */
2148 #endif /* __LINUX_LIBATA_H__ */