1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3 * Copyright 2003-2005 Red Hat, Inc. All rights reserved.
4 * Copyright 2003-2005 Jeff Garzik
5 *
6 * libata documentation is available via 'make {ps|pdf}docs',
7 * as Documentation/driver-api/libata.rst
8 */
9
10 #ifndef __LINUX_LIBATA_H__
11 #define __LINUX_LIBATA_H__
12
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>
18 #include <linux/io.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>
26
27 /*
28 * Define if arch has non-standard setup. This is a _PCI_ standard
29 * not a legacy or ISA standard.
30 */
31 #ifdef CONFIG_ATA_NONSTANDARD
32 #include <asm/libata-portmap.h>
33 #else
34 #define ATA_PRIMARY_IRQ(dev) 14
35 #define ATA_SECONDARY_IRQ(dev) 15
36 #endif
37
38 /*
39 * compile-time options: to be removed as soon as all the drivers are
40 * converted to the new debugging mechanism
41 */
42 #undef ATA_IRQ_TRAP /* define to ack screaming irqs */
43
44 /* defines only for the constants which don't work well as enums */
45 #define ATA_TAG_POISON 0xfafbfcfdU
46
47 /*
48 * Quirk flags bits.
49 * ata_device->quirks is an unsigned int, so __ATA_QUIRK_MAX must not exceed 32.
50 */
51 enum ata_quirks {
52 __ATA_QUIRK_DIAGNOSTIC, /* Failed boot diag */
53 __ATA_QUIRK_NODMA, /* DMA problems */
54 __ATA_QUIRK_NONCQ, /* Don't use NCQ */
55 __ATA_QUIRK_MAX_SEC_128, /* Limit max sects to 128 */
56 __ATA_QUIRK_BROKEN_HPA, /* Broken HPA */
57 __ATA_QUIRK_DISABLE, /* Disable it */
58 __ATA_QUIRK_HPA_SIZE, /* Native size off by one */
59 __ATA_QUIRK_IVB, /* cbl det validity bit bugs */
60 __ATA_QUIRK_STUCK_ERR, /* Stuck ERR on next PACKET */
61 __ATA_QUIRK_BRIDGE_OK, /* No bridge limits */
62 __ATA_QUIRK_ATAPI_MOD16_DMA, /* Use ATAPI DMA for commands that */
63 /* are not a multiple of 16 bytes */
64 __ATA_QUIRK_FIRMWARE_WARN, /* Firmware update warning */
65 __ATA_QUIRK_1_5_GBPS, /* Force 1.5 Gbps */
66 __ATA_QUIRK_NOSETXFER, /* Skip SETXFER, SATA only */
67 __ATA_QUIRK_BROKEN_FPDMA_AA, /* Skip AA */
68 __ATA_QUIRK_DUMP_ID, /* Dump IDENTIFY data */
69 __ATA_QUIRK_MAX_SEC_LBA48, /* Set max sects to 65535 */
70 __ATA_QUIRK_ATAPI_DMADIR, /* Device requires dmadir */
71 __ATA_QUIRK_NO_NCQ_TRIM, /* Do not use queued TRIM */
72 __ATA_QUIRK_NOLPM, /* Do not use LPM */
73 __ATA_QUIRK_WD_BROKEN_LPM, /* Some WDs have broken LPM */
74 __ATA_QUIRK_ZERO_AFTER_TRIM, /* Guarantees zero after trim */
75 __ATA_QUIRK_NO_DMA_LOG, /* Do not use DMA for log read */
76 __ATA_QUIRK_NOTRIM, /* Do not use TRIM */
77 __ATA_QUIRK_MAX_SEC_1024, /* Limit max sects to 1024 */
78 __ATA_QUIRK_MAX_TRIM_128M, /* Limit max trim size to 128M */
79 __ATA_QUIRK_NO_NCQ_ON_ATI, /* Disable NCQ on ATI chipset */
80 __ATA_QUIRK_NO_LPM_ON_ATI, /* Disable LPM on ATI chipset */
81 __ATA_QUIRK_NO_ID_DEV_LOG, /* Identify device log missing */
82 __ATA_QUIRK_NO_LOG_DIR, /* Do not read log directory */
83 __ATA_QUIRK_NO_FUA, /* Do not use FUA */
84
85 __ATA_QUIRK_MAX,
86 };
87
88 enum {
89 /* various global constants */
90 LIBATA_MAX_PRD = ATA_MAX_PRD / 2,
91 LIBATA_DUMB_MAX_PRD = ATA_MAX_PRD / 4, /* Worst case */
92 ATA_DEF_QUEUE = 1,
93 ATA_MAX_QUEUE = 32,
94 ATA_TAG_INTERNAL = ATA_MAX_QUEUE,
95 ATA_SHORT_PAUSE = 16,
96
97 ATAPI_MAX_DRAIN = 16 << 10,
98
99 ATA_ALL_DEVICES = (1 << ATA_MAX_DEVICES) - 1,
100
101 ATA_SHT_EMULATED = 1,
102 ATA_SHT_THIS_ID = -1,
103
104 /* struct ata_taskfile flags */
105 ATA_TFLAG_LBA48 = (1 << 0), /* enable 48-bit LBA and "HOB" */
106 ATA_TFLAG_ISADDR = (1 << 1), /* enable r/w to nsect/lba regs */
107 ATA_TFLAG_DEVICE = (1 << 2), /* enable r/w to device reg */
108 ATA_TFLAG_WRITE = (1 << 3), /* data dir: host->dev==1 (write) */
109 ATA_TFLAG_LBA = (1 << 4), /* enable LBA */
110 ATA_TFLAG_FUA = (1 << 5), /* enable FUA */
111 ATA_TFLAG_POLLING = (1 << 6), /* set nIEN to 1 and use polling */
112
113 /* struct ata_device stuff */
114 ATA_DFLAG_LBA = (1 << 0), /* device supports LBA */
115 ATA_DFLAG_LBA48 = (1 << 1), /* device supports LBA48 */
116 ATA_DFLAG_CDB_INTR = (1 << 2), /* device asserts INTRQ when ready for CDB */
117 ATA_DFLAG_NCQ = (1 << 3), /* device supports NCQ */
118 ATA_DFLAG_FLUSH_EXT = (1 << 4), /* do FLUSH_EXT instead of FLUSH */
119 ATA_DFLAG_ACPI_PENDING = (1 << 5), /* ACPI resume action pending */
120 ATA_DFLAG_ACPI_FAILED = (1 << 6), /* ACPI on devcfg has failed */
121 ATA_DFLAG_AN = (1 << 7), /* AN configured */
122 ATA_DFLAG_TRUSTED = (1 << 8), /* device supports trusted send/recv */
123 ATA_DFLAG_FUA = (1 << 9), /* device supports FUA */
124 ATA_DFLAG_DMADIR = (1 << 10), /* device requires DMADIR */
125 ATA_DFLAG_NCQ_SEND_RECV = (1 << 11), /* device supports NCQ SEND and RECV */
126 ATA_DFLAG_NCQ_PRIO = (1 << 12), /* device supports NCQ priority */
127 ATA_DFLAG_CDL = (1 << 13), /* supports cmd duration limits */
128 ATA_DFLAG_CFG_MASK = (1 << 14) - 1,
129
130 ATA_DFLAG_PIO = (1 << 14), /* device limited to PIO mode */
131 ATA_DFLAG_NCQ_OFF = (1 << 15), /* device limited to non-NCQ mode */
132 ATA_DFLAG_SLEEPING = (1 << 16), /* device is sleeping */
133 ATA_DFLAG_DUBIOUS_XFER = (1 << 17), /* data transfer not verified */
134 ATA_DFLAG_NO_UNLOAD = (1 << 18), /* device doesn't support unload */
135 ATA_DFLAG_UNLOCK_HPA = (1 << 19), /* unlock HPA */
136 ATA_DFLAG_INIT_MASK = (1 << 20) - 1,
137
138 ATA_DFLAG_NCQ_PRIO_ENABLED = (1 << 20), /* Priority cmds sent to dev */
139 ATA_DFLAG_CDL_ENABLED = (1 << 21), /* cmd duration limits is enabled */
140 ATA_DFLAG_RESUMING = (1 << 22), /* Device is resuming */
141 ATA_DFLAG_DETACH = (1 << 24),
142 ATA_DFLAG_DETACHED = (1 << 25),
143 ATA_DFLAG_DA = (1 << 26), /* device supports Device Attention */
144 ATA_DFLAG_DEVSLP = (1 << 27), /* device supports Device Sleep */
145 ATA_DFLAG_ACPI_DISABLED = (1 << 28), /* ACPI for the device is disabled */
146 ATA_DFLAG_D_SENSE = (1 << 29), /* Descriptor sense requested */
147
148 ATA_DFLAG_FEATURES_MASK = (ATA_DFLAG_TRUSTED | ATA_DFLAG_DA | \
149 ATA_DFLAG_DEVSLP | ATA_DFLAG_NCQ_SEND_RECV | \
150 ATA_DFLAG_NCQ_PRIO | ATA_DFLAG_FUA | \
151 ATA_DFLAG_CDL),
152
153 ATA_DEV_UNKNOWN = 0, /* unknown device */
154 ATA_DEV_ATA = 1, /* ATA device */
155 ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */
156 ATA_DEV_ATAPI = 3, /* ATAPI device */
157 ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */
158 ATA_DEV_PMP = 5, /* SATA port multiplier */
159 ATA_DEV_PMP_UNSUP = 6, /* SATA port multiplier (unsupported) */
160 ATA_DEV_SEMB = 7, /* SEMB */
161 ATA_DEV_SEMB_UNSUP = 8, /* SEMB (unsupported) */
162 ATA_DEV_ZAC = 9, /* ZAC device */
163 ATA_DEV_ZAC_UNSUP = 10, /* ZAC device (unsupported) */
164 ATA_DEV_NONE = 11, /* no device */
165
166 /* struct ata_link flags */
167 /* NOTE: struct ata_force_param currently stores lflags in u16 */
168 ATA_LFLAG_NO_HRST = (1 << 1), /* avoid hardreset */
169 ATA_LFLAG_NO_SRST = (1 << 2), /* avoid softreset */
170 ATA_LFLAG_ASSUME_ATA = (1 << 3), /* assume ATA class */
171 ATA_LFLAG_ASSUME_SEMB = (1 << 4), /* assume SEMB class */
172 ATA_LFLAG_ASSUME_CLASS = ATA_LFLAG_ASSUME_ATA | ATA_LFLAG_ASSUME_SEMB,
173 ATA_LFLAG_NO_RETRY = (1 << 5), /* don't retry this link */
174 ATA_LFLAG_DISABLED = (1 << 6), /* link is disabled */
175 ATA_LFLAG_SW_ACTIVITY = (1 << 7), /* keep activity stats */
176 ATA_LFLAG_NO_LPM = (1 << 8), /* disable LPM on this link */
177 ATA_LFLAG_RST_ONCE = (1 << 9), /* limit recovery to one reset */
178 ATA_LFLAG_CHANGED = (1 << 10), /* LPM state changed on this link */
179 ATA_LFLAG_NO_DEBOUNCE_DELAY = (1 << 11), /* no debounce delay on link resume */
180
181 /* struct ata_port flags */
182 ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */
183 /* (doesn't imply presence) */
184 ATA_FLAG_SATA = (1 << 1),
185 ATA_FLAG_NO_LPM = (1 << 2), /* host not happy with LPM */
186 ATA_FLAG_NO_LOG_PAGE = (1 << 5), /* do not issue log page read */
187 ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */
188 ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */
189 ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */
190 ATA_FLAG_PIO_POLLING = (1 << 9), /* use polling PIO if LLD
191 * doesn't handle PIO interrupts */
192 ATA_FLAG_NCQ = (1 << 10), /* host supports NCQ */
193 ATA_FLAG_NO_POWEROFF_SPINDOWN = (1 << 11), /* don't spindown before poweroff */
194 ATA_FLAG_NO_HIBERNATE_SPINDOWN = (1 << 12), /* don't spindown before hibernation */
195 ATA_FLAG_DEBUGMSG = (1 << 13),
196 ATA_FLAG_FPDMA_AA = (1 << 14), /* driver supports Auto-Activate */
197 ATA_FLAG_IGN_SIMPLEX = (1 << 15), /* ignore SIMPLEX */
198 ATA_FLAG_NO_IORDY = (1 << 16), /* controller lacks iordy */
199 ATA_FLAG_ACPI_SATA = (1 << 17), /* need native SATA ACPI layout */
200 ATA_FLAG_AN = (1 << 18), /* controller supports AN */
201 ATA_FLAG_PMP = (1 << 19), /* controller supports PMP */
202 ATA_FLAG_FPDMA_AUX = (1 << 20), /* controller supports H2DFIS aux field */
203 ATA_FLAG_EM = (1 << 21), /* driver supports enclosure
204 * management */
205 ATA_FLAG_SW_ACTIVITY = (1 << 22), /* driver supports sw activity
206 * led */
207 ATA_FLAG_NO_DIPM = (1 << 23), /* host not happy with DIPM */
208 ATA_FLAG_SAS_HOST = (1 << 24), /* SAS host */
209
210 /* bits 24:31 of ap->flags are reserved for LLD specific flags */
211
212
213 /* struct ata_port pflags */
214 ATA_PFLAG_EH_PENDING = (1 << 0), /* EH pending */
215 ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */
216 ATA_PFLAG_FROZEN = (1 << 2), /* port is frozen */
217 ATA_PFLAG_RECOVERED = (1 << 3), /* recovery action performed */
218 ATA_PFLAG_LOADING = (1 << 4), /* boot/loading probe */
219 ATA_PFLAG_SCSI_HOTPLUG = (1 << 6), /* SCSI hotplug scheduled */
220 ATA_PFLAG_INITIALIZING = (1 << 7), /* being initialized, don't touch */
221 ATA_PFLAG_RESETTING = (1 << 8), /* reset in progress */
222 ATA_PFLAG_UNLOADING = (1 << 9), /* driver is being unloaded */
223 ATA_PFLAG_UNLOADED = (1 << 10), /* driver is unloaded */
224
225 ATA_PFLAG_RESUMING = (1 << 16), /* port is being resumed */
226 ATA_PFLAG_SUSPENDED = (1 << 17), /* port is suspended (power) */
227 ATA_PFLAG_PM_PENDING = (1 << 18), /* PM operation pending */
228 ATA_PFLAG_INIT_GTM_VALID = (1 << 19), /* initial gtm data valid */
229
230 ATA_PFLAG_PIO32 = (1 << 20), /* 32bit PIO */
231 ATA_PFLAG_PIO32CHANGE = (1 << 21), /* 32bit PIO can be turned on/off */
232 ATA_PFLAG_EXTERNAL = (1 << 22), /* eSATA/external port */
233
234 /* struct ata_queued_cmd flags */
235 ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */
236 ATA_QCFLAG_DMAMAP = (1 << 1), /* SG table is DMA mapped */
237 ATA_QCFLAG_RTF_FILLED = (1 << 2), /* result TF has been filled */
238 ATA_QCFLAG_IO = (1 << 3), /* standard IO command */
239 ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */
240 ATA_QCFLAG_CLEAR_EXCL = (1 << 5), /* clear excl_link on completion */
241 ATA_QCFLAG_QUIET = (1 << 6), /* don't report device error */
242 ATA_QCFLAG_RETRY = (1 << 7), /* retry after failure */
243 ATA_QCFLAG_HAS_CDL = (1 << 8), /* qc has CDL a descriptor set */
244
245 ATA_QCFLAG_EH = (1 << 16), /* cmd aborted and owned by EH */
246 ATA_QCFLAG_SENSE_VALID = (1 << 17), /* sense data valid */
247 ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
248 ATA_QCFLAG_EH_SUCCESS_CMD = (1 << 19), /* EH should fetch sense for this successful cmd */
249
250 /* host set flags */
251 ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host only */
252 ATA_HOST_STARTED = (1 << 1), /* Host started */
253 ATA_HOST_PARALLEL_SCAN = (1 << 2), /* Ports on this host can be scanned in parallel */
254 ATA_HOST_IGNORE_ATA = (1 << 3), /* Ignore ATA devices on this host. */
255
256 ATA_HOST_NO_PART = (1 << 4), /* Host does not support partial */
257 ATA_HOST_NO_SSC = (1 << 5), /* Host does not support slumber */
258 ATA_HOST_NO_DEVSLP = (1 << 6), /* Host does not support devslp */
259
260 /* bits 24:31 of host->flags are reserved for LLD specific flags */
261
262 /* Various lengths of time */
263 ATA_TMOUT_INTERNAL_QUICK = 5000,
264 ATA_TMOUT_MAX_PARK = 30000,
265
266 /*
267 * GoVault needs 2s and iVDR disk HHD424020F7SV00 800ms. 2s
268 * is too much without parallel probing. Use 2s if parallel
269 * probing is available, 800ms otherwise.
270 */
271 ATA_TMOUT_FF_WAIT_LONG = 2000,
272 ATA_TMOUT_FF_WAIT = 800,
273
274 /* Spec mandates to wait for ">= 2ms" before checking status
275 * after reset. We wait 150ms, because that was the magic
276 * delay used for ATAPI devices in Hale Landis's ATADRVR, for
277 * the period of time between when the ATA command register is
278 * written, and then status is checked. Because waiting for
279 * "a while" before checking status is fine, post SRST, we
280 * perform this magic delay here as well.
281 *
282 * Old drivers/ide uses the 2mS rule and then waits for ready.
283 */
284 ATA_WAIT_AFTER_RESET = 150,
285
286 /* If PMP is supported, we have to do follow-up SRST. As some
287 * PMPs don't send D2H Reg FIS after hardreset, LLDs are
288 * advised to wait only for the following duration before
289 * doing SRST.
290 */
291 ATA_TMOUT_PMP_SRST_WAIT = 10000,
292
293 /* When the LPM policy is set to ATA_LPM_MAX_POWER, there might
294 * be a spurious PHY event, so ignore the first PHY event that
295 * occurs within 10s after the policy change.
296 */
297 ATA_TMOUT_SPURIOUS_PHY = 10000,
298
299 /* ATA bus states */
300 BUS_UNKNOWN = 0,
301 BUS_DMA = 1,
302 BUS_IDLE = 2,
303 BUS_NOINTR = 3,
304 BUS_NODATA = 4,
305 BUS_TIMER = 5,
306 BUS_PIO = 6,
307 BUS_EDD = 7,
308 BUS_IDENTIFY = 8,
309 BUS_PACKET = 9,
310
311 /* SATA port states */
312 PORT_UNKNOWN = 0,
313 PORT_ENABLED = 1,
314 PORT_DISABLED = 2,
315
316 /* encoding various smaller bitmaps into a single
317 * unsigned int bitmap
318 */
319 ATA_NR_PIO_MODES = 7,
320 ATA_NR_MWDMA_MODES = 5,
321 ATA_NR_UDMA_MODES = 8,
322
323 ATA_SHIFT_PIO = 0,
324 ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_NR_PIO_MODES,
325 ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_NR_MWDMA_MODES,
326 ATA_SHIFT_PRIO = 6,
327
328 ATA_PRIO_HIGH = 2,
329 /* size of buffer to pad xfers ending on unaligned boundaries */
330 ATA_DMA_PAD_SZ = 4,
331
332 /* ering size */
333 ATA_ERING_SIZE = 32,
334
335 /* return values for ->qc_defer */
336 ATA_DEFER_LINK = 1,
337 ATA_DEFER_PORT = 2,
338
339 /* desc_len for ata_eh_info and context */
340 ATA_EH_DESC_LEN = 80,
341
342 /* reset / recovery action types */
343 ATA_EH_REVALIDATE = (1 << 0),
344 ATA_EH_SOFTRESET = (1 << 1), /* meaningful only in ->prereset */
345 ATA_EH_HARDRESET = (1 << 2), /* meaningful only in ->prereset */
346 ATA_EH_RESET = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
347 ATA_EH_ENABLE_LINK = (1 << 3),
348 ATA_EH_PARK = (1 << 5), /* unload heads and stop I/O */
349 ATA_EH_GET_SUCCESS_SENSE = (1 << 6), /* Get sense data for successful cmd */
350 ATA_EH_SET_ACTIVE = (1 << 7), /* Set a device to active power mode */
351
352 ATA_EH_PERDEV_MASK = ATA_EH_REVALIDATE | ATA_EH_PARK |
353 ATA_EH_GET_SUCCESS_SENSE | ATA_EH_SET_ACTIVE,
354 ATA_EH_ALL_ACTIONS = ATA_EH_REVALIDATE | ATA_EH_RESET |
355 ATA_EH_ENABLE_LINK,
356
357 /* ata_eh_info->flags */
358 ATA_EHI_HOTPLUGGED = (1 << 0), /* could have been hotplugged */
359 ATA_EHI_NO_AUTOPSY = (1 << 2), /* no autopsy */
360 ATA_EHI_QUIET = (1 << 3), /* be quiet */
361 ATA_EHI_NO_RECOVERY = (1 << 4), /* no recovery */
362
363 ATA_EHI_DID_SOFTRESET = (1 << 16), /* already soft-reset this port */
364 ATA_EHI_DID_HARDRESET = (1 << 17), /* already soft-reset this port */
365 ATA_EHI_PRINTINFO = (1 << 18), /* print configuration info */
366 ATA_EHI_SETMODE = (1 << 19), /* configure transfer mode */
367 ATA_EHI_POST_SETMODE = (1 << 20), /* revalidating after setmode */
368 ATA_EHI_DID_PRINT_QUIRKS = (1 << 21), /* already printed quirks info */
369
370 ATA_EHI_DID_RESET = ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
371
372 /* mask of flags to transfer *to* the slave link */
373 ATA_EHI_TO_SLAVE_MASK = ATA_EHI_NO_AUTOPSY | ATA_EHI_QUIET,
374
375 /* max tries if error condition is still set after ->error_handler */
376 ATA_EH_MAX_TRIES = 5,
377
378 /* sometimes resuming a link requires several retries */
379 ATA_LINK_RESUME_TRIES = 5,
380
381 /* how hard are we gonna try to probe/recover devices */
382 ATA_EH_DEV_TRIES = 3,
383 ATA_EH_PMP_TRIES = 5,
384 ATA_EH_PMP_LINK_TRIES = 3,
385
386 SATA_PMP_RW_TIMEOUT = 3000, /* PMP read/write timeout */
387
388 /* This should match the actual table size of
389 * ata_eh_cmd_timeout_table in libata-eh.c.
390 */
391 ATA_EH_CMD_TIMEOUT_TABLE_SIZE = 8,
392
393 /*
394 * Quirk flags: may be set by libata or controller drivers on drives.
395 * Some quirks may be drive/controller pair dependent.
396 */
397 ATA_QUIRK_DIAGNOSTIC = (1U << __ATA_QUIRK_DIAGNOSTIC),
398 ATA_QUIRK_NODMA = (1U << __ATA_QUIRK_NODMA),
399 ATA_QUIRK_NONCQ = (1U << __ATA_QUIRK_NONCQ),
400 ATA_QUIRK_MAX_SEC_128 = (1U << __ATA_QUIRK_MAX_SEC_128),
401 ATA_QUIRK_BROKEN_HPA = (1U << __ATA_QUIRK_BROKEN_HPA),
402 ATA_QUIRK_DISABLE = (1U << __ATA_QUIRK_DISABLE),
403 ATA_QUIRK_HPA_SIZE = (1U << __ATA_QUIRK_HPA_SIZE),
404 ATA_QUIRK_IVB = (1U << __ATA_QUIRK_IVB),
405 ATA_QUIRK_STUCK_ERR = (1U << __ATA_QUIRK_STUCK_ERR),
406 ATA_QUIRK_BRIDGE_OK = (1U << __ATA_QUIRK_BRIDGE_OK),
407 ATA_QUIRK_ATAPI_MOD16_DMA = (1U << __ATA_QUIRK_ATAPI_MOD16_DMA),
408 ATA_QUIRK_FIRMWARE_WARN = (1U << __ATA_QUIRK_FIRMWARE_WARN),
409 ATA_QUIRK_1_5_GBPS = (1U << __ATA_QUIRK_1_5_GBPS),
410 ATA_QUIRK_NOSETXFER = (1U << __ATA_QUIRK_NOSETXFER),
411 ATA_QUIRK_BROKEN_FPDMA_AA = (1U << __ATA_QUIRK_BROKEN_FPDMA_AA),
412 ATA_QUIRK_DUMP_ID = (1U << __ATA_QUIRK_DUMP_ID),
413 ATA_QUIRK_MAX_SEC_LBA48 = (1U << __ATA_QUIRK_MAX_SEC_LBA48),
414 ATA_QUIRK_ATAPI_DMADIR = (1U << __ATA_QUIRK_ATAPI_DMADIR),
415 ATA_QUIRK_NO_NCQ_TRIM = (1U << __ATA_QUIRK_NO_NCQ_TRIM),
416 ATA_QUIRK_NOLPM = (1U << __ATA_QUIRK_NOLPM),
417 ATA_QUIRK_WD_BROKEN_LPM = (1U << __ATA_QUIRK_WD_BROKEN_LPM),
418 ATA_QUIRK_ZERO_AFTER_TRIM = (1U << __ATA_QUIRK_ZERO_AFTER_TRIM),
419 ATA_QUIRK_NO_DMA_LOG = (1U << __ATA_QUIRK_NO_DMA_LOG),
420 ATA_QUIRK_NOTRIM = (1U << __ATA_QUIRK_NOTRIM),
421 ATA_QUIRK_MAX_SEC_1024 = (1U << __ATA_QUIRK_MAX_SEC_1024),
422 ATA_QUIRK_MAX_TRIM_128M = (1U << __ATA_QUIRK_MAX_TRIM_128M),
423 ATA_QUIRK_NO_NCQ_ON_ATI = (1U << __ATA_QUIRK_NO_NCQ_ON_ATI),
424 ATA_QUIRK_NO_LPM_ON_ATI = (1U << __ATA_QUIRK_NO_LPM_ON_ATI),
425 ATA_QUIRK_NO_ID_DEV_LOG = (1U << __ATA_QUIRK_NO_ID_DEV_LOG),
426 ATA_QUIRK_NO_LOG_DIR = (1U << __ATA_QUIRK_NO_LOG_DIR),
427 ATA_QUIRK_NO_FUA = (1U << __ATA_QUIRK_NO_FUA),
428
429 /* User visible DMA mask for DMA control. DO NOT renumber. */
430 ATA_DMA_MASK_ATA = (1 << 0), /* DMA on ATA Disk */
431 ATA_DMA_MASK_ATAPI = (1 << 1), /* DMA on ATAPI */
432 ATA_DMA_MASK_CFA = (1 << 2), /* DMA on CF Card */
433
434 /* ATAPI command types */
435 ATAPI_READ = 0, /* READs */
436 ATAPI_WRITE = 1, /* WRITEs */
437 ATAPI_READ_CD = 2, /* READ CD [MSF] */
438 ATAPI_PASS_THRU = 3, /* SAT pass-thru */
439 ATAPI_MISC = 4, /* the rest */
440
441 /* Timing constants */
442 ATA_TIMING_SETUP = (1 << 0),
443 ATA_TIMING_ACT8B = (1 << 1),
444 ATA_TIMING_REC8B = (1 << 2),
445 ATA_TIMING_CYC8B = (1 << 3),
446 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
447 ATA_TIMING_CYC8B,
448 ATA_TIMING_ACTIVE = (1 << 4),
449 ATA_TIMING_RECOVER = (1 << 5),
450 ATA_TIMING_DMACK_HOLD = (1 << 6),
451 ATA_TIMING_CYCLE = (1 << 7),
452 ATA_TIMING_UDMA = (1 << 8),
453 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
454 ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
455 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
456 ATA_TIMING_DMACK_HOLD | ATA_TIMING_CYCLE |
457 ATA_TIMING_UDMA,
458
459 /* ACPI constants */
460 ATA_ACPI_FILTER_SETXFER = 1 << 0,
461 ATA_ACPI_FILTER_LOCK = 1 << 1,
462 ATA_ACPI_FILTER_DIPM = 1 << 2,
463 ATA_ACPI_FILTER_FPDMA_OFFSET = 1 << 3, /* FPDMA non-zero offset */
464 ATA_ACPI_FILTER_FPDMA_AA = 1 << 4, /* FPDMA auto activate */
465
466 ATA_ACPI_FILTER_DEFAULT = ATA_ACPI_FILTER_SETXFER |
467 ATA_ACPI_FILTER_LOCK |
468 ATA_ACPI_FILTER_DIPM,
469 };
470
471 enum ata_xfer_mask {
472 ATA_MASK_PIO = ((1U << ATA_NR_PIO_MODES) - 1) << ATA_SHIFT_PIO,
473 ATA_MASK_MWDMA = ((1U << ATA_NR_MWDMA_MODES) - 1) << ATA_SHIFT_MWDMA,
474 ATA_MASK_UDMA = ((1U << ATA_NR_UDMA_MODES) - 1) << ATA_SHIFT_UDMA,
475 };
476
477 enum hsm_task_states {
478 HSM_ST_IDLE, /* no command on going */
479 HSM_ST_FIRST, /* (waiting the device to)
480 write CDB or first data block */
481 HSM_ST, /* (waiting the device to) transfer data */
482 HSM_ST_LAST, /* (waiting the device to) complete command */
483 HSM_ST_ERR, /* error */
484 };
485
486 enum ata_completion_errors {
487 AC_ERR_OK = 0, /* no error */
488 AC_ERR_DEV = (1 << 0), /* device reported error */
489 AC_ERR_HSM = (1 << 1), /* host state machine violation */
490 AC_ERR_TIMEOUT = (1 << 2), /* timeout */
491 AC_ERR_MEDIA = (1 << 3), /* media error */
492 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
493 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
494 AC_ERR_SYSTEM = (1 << 6), /* system error */
495 AC_ERR_INVALID = (1 << 7), /* invalid argument */
496 AC_ERR_OTHER = (1 << 8), /* unknown */
497 AC_ERR_NODEV_HINT = (1 << 9), /* polling device detection hint */
498 AC_ERR_NCQ = (1 << 10), /* marker for offending NCQ qc */
499 };
500
501 /*
502 * Link Power Management (LPM) policies.
503 *
504 * The default LPM policy to use for a device link is defined using these values
505 * with the CONFIG_SATA_MOBILE_LPM_POLICY config option and applied through the
506 * target_lpm_policy field of struct ata_port.
507 *
508 * If you alter this, you also need to alter the policy names used with the
509 * sysfs attribute link_power_management_policy defined in libata-sata.c.
510 */
511 enum ata_lpm_policy {
512 /* Keep firmware settings */
513 ATA_LPM_UNKNOWN,
514 /* No power savings (maximum performance) */
515 ATA_LPM_MAX_POWER,
516 /* HIPM (Partial) */
517 ATA_LPM_MED_POWER,
518 /* HIPM (Partial) and DIPM (Partial and Slumber) */
519 ATA_LPM_MED_POWER_WITH_DIPM,
520 /* HIPM (Partial and DevSleep) and DIPM (Partial and Slumber) */
521 ATA_LPM_MIN_POWER_WITH_PARTIAL,
522 /* HIPM (Slumber and DevSleep) and DIPM (Partial and Slumber) */
523 ATA_LPM_MIN_POWER,
524 };
525
526 enum ata_lpm_hints {
527 ATA_LPM_EMPTY = (1 << 0), /* port empty/probing */
528 ATA_LPM_HIPM = (1 << 1), /* may use HIPM */
529 ATA_LPM_WAKE_ONLY = (1 << 2), /* only wake up link */
530 };
531
532 /* forward declarations */
533 struct scsi_device;
534 struct ata_port_operations;
535 struct ata_port;
536 struct ata_link;
537 struct ata_queued_cmd;
538
539 /* typedefs */
540 typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
541 typedef int (*ata_prereset_fn_t)(struct ata_link *link, unsigned long deadline);
542 typedef int (*ata_reset_fn_t)(struct ata_link *link, unsigned int *classes,
543 unsigned long deadline);
544 typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes);
545
546 extern struct device_attribute dev_attr_unload_heads;
547 #ifdef CONFIG_SATA_HOST
548 extern struct device_attribute dev_attr_link_power_management_supported;
549 extern struct device_attribute dev_attr_link_power_management_policy;
550 extern struct device_attribute dev_attr_ncq_prio_supported;
551 extern struct device_attribute dev_attr_ncq_prio_enable;
552 extern struct device_attribute dev_attr_em_message_type;
553 extern struct device_attribute dev_attr_em_message;
554 extern struct device_attribute dev_attr_sw_activity;
555 #endif
556
557 enum sw_activity {
558 OFF,
559 BLINK_ON,
560 BLINK_OFF,
561 };
562
563 struct ata_taskfile {
564 unsigned long flags; /* ATA_TFLAG_xxx */
565 u8 protocol; /* ATA_PROT_xxx */
566
567 u8 ctl; /* control reg */
568
569 u8 hob_feature; /* additional data */
570 u8 hob_nsect; /* to support LBA48 */
571 u8 hob_lbal;
572 u8 hob_lbam;
573 u8 hob_lbah;
574
575 union {
576 u8 error;
577 u8 feature;
578 };
579 u8 nsect;
580 u8 lbal;
581 u8 lbam;
582 u8 lbah;
583
584 u8 device;
585
586 union {
587 u8 status;
588 u8 command;
589 };
590
591 u32 auxiliary; /* auxiliary field */
592 /* from SATA 3.1 and */
593 /* ATA-8 ACS-3 */
594 };
595
596 #ifdef CONFIG_ATA_SFF
597 struct ata_ioports {
598 void __iomem *cmd_addr;
599 void __iomem *data_addr;
600 void __iomem *error_addr;
601 void __iomem *feature_addr;
602 void __iomem *nsect_addr;
603 void __iomem *lbal_addr;
604 void __iomem *lbam_addr;
605 void __iomem *lbah_addr;
606 void __iomem *device_addr;
607 void __iomem *status_addr;
608 void __iomem *command_addr;
609 void __iomem *altstatus_addr;
610 void __iomem *ctl_addr;
611 #ifdef CONFIG_ATA_BMDMA
612 void __iomem *bmdma_addr;
613 #endif /* CONFIG_ATA_BMDMA */
614 void __iomem *scr_addr;
615 };
616 #endif /* CONFIG_ATA_SFF */
617
618 struct ata_host {
619 spinlock_t lock;
620 struct device *dev;
621 void __iomem * const *iomap;
622 unsigned int n_ports;
623 unsigned int n_tags; /* nr of NCQ tags */
624 void *private_data;
625 struct ata_port_operations *ops;
626 unsigned long flags;
627 struct kref kref;
628
629 struct mutex eh_mutex;
630 struct task_struct *eh_owner;
631
632 struct ata_port *simplex_claimed; /* channel owning the DMA */
633 struct ata_port *ports[];
634 };
635
636 struct ata_queued_cmd {
637 struct ata_port *ap;
638 struct ata_device *dev;
639
640 struct scsi_cmnd *scsicmd;
641 void (*scsidone)(struct scsi_cmnd *);
642
643 struct ata_taskfile tf;
644 u8 cdb[ATAPI_CDB_LEN];
645
646 unsigned long flags; /* ATA_QCFLAG_xxx */
647 unsigned int tag; /* libata core tag */
648 unsigned int hw_tag; /* driver tag */
649 unsigned int n_elem;
650 unsigned int orig_n_elem;
651
652 int dma_dir;
653
654 unsigned int sect_size;
655
656 unsigned int nbytes;
657 unsigned int extrabytes;
658 unsigned int curbytes;
659
660 struct scatterlist sgent;
661
662 struct scatterlist *sg;
663
664 struct scatterlist *cursg;
665 unsigned int cursg_ofs;
666
667 unsigned int err_mask;
668 struct ata_taskfile result_tf;
669 ata_qc_cb_t complete_fn;
670
671 void *private_data;
672 void *lldd_task;
673 };
674
675 struct ata_port_stats {
676 unsigned long unhandled_irq;
677 unsigned long idle_irq;
678 unsigned long rw_reqbuf;
679 };
680
681 struct ata_ering_entry {
682 unsigned int eflags;
683 unsigned int err_mask;
684 u64 timestamp;
685 };
686
687 struct ata_ering {
688 int cursor;
689 struct ata_ering_entry ring[ATA_ERING_SIZE];
690 };
691
692 struct ata_cpr {
693 u8 num;
694 u8 num_storage_elements;
695 u64 start_lba;
696 u64 num_lbas;
697 };
698
699 struct ata_cpr_log {
700 u8 nr_cpr;
701 struct ata_cpr cpr[] __counted_by(nr_cpr);
702 };
703
704 struct ata_cdl {
705 /*
706 * Buffer to cache the CDL log page 18h (command duration descriptors)
707 * for SCSI-ATA translation.
708 */
709 u8 desc_log_buf[ATA_LOG_CDL_SIZE];
710
711 /*
712 * Buffer to handle reading the sense data for successful NCQ Commands
713 * log page for commands using a CDL with one of the limits policy set
714 * to 0xD (successful completion with sense data available bit set).
715 */
716 u8 ncq_sense_log_buf[ATA_LOG_SENSE_NCQ_SIZE];
717 };
718
719 struct ata_device {
720 struct ata_link *link;
721 unsigned int devno; /* 0 or 1 */
722 unsigned int quirks; /* List of broken features */
723 unsigned long flags; /* ATA_DFLAG_xxx */
724 struct scsi_device *sdev; /* attached SCSI device */
725 void *private_data;
726 #ifdef CONFIG_ATA_ACPI
727 union acpi_object *gtf_cache;
728 unsigned int gtf_filter;
729 #endif
730 #ifdef CONFIG_SATA_ZPODD
731 void *zpodd;
732 #endif
733 struct device tdev;
734 /* n_sector is CLEAR_BEGIN, read comment above CLEAR_BEGIN */
735 u64 n_sectors; /* size of device, if ATA */
736 u64 n_native_sectors; /* native size, if ATA */
737 unsigned int class; /* ATA_DEV_xxx */
738 unsigned long unpark_deadline;
739
740 u8 pio_mode;
741 u8 dma_mode;
742 u8 xfer_mode;
743 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
744
745 unsigned int multi_count; /* sectors count for
746 READ/WRITE MULTIPLE */
747 unsigned int max_sectors; /* per-device max sectors */
748 unsigned int cdb_len;
749
750 /* per-dev xfer mask */
751 unsigned int pio_mask;
752 unsigned int mwdma_mask;
753 unsigned int udma_mask;
754
755 /* for CHS addressing */
756 u16 cylinders; /* Number of cylinders */
757 u16 heads; /* Number of heads */
758 u16 sectors; /* Number of sectors per track */
759
760 union {
761 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
762 u32 gscr[SATA_PMP_GSCR_DWORDS]; /* PMP GSCR block */
763 } ____cacheline_aligned;
764
765 /* General Purpose Log Directory log page */
766 u8 gp_log_dir[ATA_SECT_SIZE] ____cacheline_aligned;
767
768 /* DEVSLP Timing Variables from Identify Device Data Log */
769 u8 devslp_timing[ATA_LOG_DEVSLP_SIZE];
770
771 /* NCQ send and receive log subcommand support */
772 u8 ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_SIZE];
773 u8 ncq_non_data_cmds[ATA_LOG_NCQ_NON_DATA_SIZE];
774
775 /* ZAC zone configuration */
776 u32 zac_zoned_cap;
777 u32 zac_zones_optimal_open;
778 u32 zac_zones_optimal_nonseq;
779 u32 zac_zones_max_open;
780
781 /* Concurrent positioning ranges */
782 struct ata_cpr_log *cpr_log;
783
784 /* Command Duration Limits support */
785 struct ata_cdl *cdl;
786
787 /* error history */
788 int spdn_cnt;
789 /* ering is CLEAR_END, read comment above CLEAR_END */
790 struct ata_ering ering;
791
792 /* For EH */
793 u8 sector_buf[ATA_SECT_SIZE] ____cacheline_aligned;
794 };
795
796 /* Fields between ATA_DEVICE_CLEAR_BEGIN and ATA_DEVICE_CLEAR_END are
797 * cleared to zero on ata_dev_init().
798 */
799 #define ATA_DEVICE_CLEAR_BEGIN offsetof(struct ata_device, n_sectors)
800 #define ATA_DEVICE_CLEAR_END offsetof(struct ata_device, ering)
801
802 struct ata_eh_info {
803 struct ata_device *dev; /* offending device */
804 u32 serror; /* SError from LLDD */
805 unsigned int err_mask; /* port-wide err_mask */
806 unsigned int action; /* ATA_EH_* action mask */
807 unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */
808 unsigned int flags; /* ATA_EHI_* flags */
809
810 unsigned int probe_mask;
811
812 char desc[ATA_EH_DESC_LEN];
813 int desc_len;
814 };
815
816 struct ata_eh_context {
817 struct ata_eh_info i;
818 int tries[ATA_MAX_DEVICES];
819 int cmd_timeout_idx[ATA_MAX_DEVICES]
820 [ATA_EH_CMD_TIMEOUT_TABLE_SIZE];
821 unsigned int classes[ATA_MAX_DEVICES];
822 unsigned int did_probe_mask;
823 unsigned int unloaded_mask;
824 unsigned int saved_ncq_enabled;
825 u8 saved_xfer_mode[ATA_MAX_DEVICES];
826 /* timestamp for the last reset attempt or success */
827 unsigned long last_reset;
828 };
829
830 struct ata_acpi_drive
831 {
832 u32 pio;
833 u32 dma;
834 } __packed;
835
836 struct ata_acpi_gtm {
837 struct ata_acpi_drive drive[2];
838 u32 flags;
839 } __packed;
840
841 struct ata_link {
842 struct ata_port *ap;
843 int pmp; /* port multiplier port # */
844
845 struct device tdev;
846 unsigned int active_tag; /* active tag on this link */
847 u32 sactive; /* active NCQ commands */
848
849 unsigned int flags; /* ATA_LFLAG_xxx */
850
851 u32 saved_scontrol; /* SControl on probe */
852 unsigned int hw_sata_spd_limit;
853 unsigned int sata_spd_limit;
854 unsigned int sata_spd; /* current SATA PHY speed */
855 enum ata_lpm_policy lpm_policy;
856
857 /* record runtime error info, protected by host_set lock */
858 struct ata_eh_info eh_info;
859 /* EH context */
860 struct ata_eh_context eh_context;
861
862 struct ata_device device[ATA_MAX_DEVICES];
863
864 unsigned long last_lpm_change; /* when last LPM change happened */
865 };
866 #define ATA_LINK_CLEAR_BEGIN offsetof(struct ata_link, active_tag)
867 #define ATA_LINK_CLEAR_END offsetof(struct ata_link, device[0])
868
869 struct ata_port {
870 struct Scsi_Host *scsi_host; /* our co-allocated scsi host */
871 struct ata_port_operations *ops;
872 spinlock_t *lock;
873 /* Flags owned by the EH context. Only EH should touch these once the
874 port is active */
875 unsigned long flags; /* ATA_FLAG_xxx */
876 /* Flags that change dynamically, protected by ap->lock */
877 unsigned int pflags; /* ATA_PFLAG_xxx */
878 unsigned int print_id; /* user visible unique port ID */
879 unsigned int port_no; /* 0 based port no. inside the host */
880
881 #ifdef CONFIG_ATA_SFF
882 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
883 u8 ctl; /* cache of ATA control register */
884 u8 last_ctl; /* Cache last written value */
885 struct ata_link* sff_pio_task_link; /* link currently used */
886 struct delayed_work sff_pio_task;
887 #ifdef CONFIG_ATA_BMDMA
888 struct ata_bmdma_prd *bmdma_prd; /* BMDMA SG list */
889 dma_addr_t bmdma_prd_dma; /* and its DMA mapping */
890 #endif /* CONFIG_ATA_BMDMA */
891 #endif /* CONFIG_ATA_SFF */
892
893 unsigned int pio_mask;
894 unsigned int mwdma_mask;
895 unsigned int udma_mask;
896 unsigned int cbl; /* cable type; ATA_CBL_xxx */
897
898 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE + 1];
899 u64 qc_active;
900 int nr_active_links; /* #links with active qcs */
901
902 struct ata_link link; /* host default link */
903 struct ata_link *slave_link; /* see ata_slave_link_init() */
904
905 int nr_pmp_links; /* nr of available PMP links */
906 struct ata_link *pmp_link; /* array of PMP links */
907 struct ata_link *excl_link; /* for PMP qc exclusion */
908
909 struct ata_port_stats stats;
910 struct ata_host *host;
911 struct device *dev;
912 struct device tdev;
913
914 struct mutex scsi_scan_mutex;
915 struct delayed_work hotplug_task;
916 struct delayed_work scsi_rescan_task;
917
918 unsigned int hsm_task_state;
919
920 struct list_head eh_done_q;
921 wait_queue_head_t eh_wait_q;
922 int eh_tries;
923 struct completion park_req_pending;
924
925 pm_message_t pm_mesg;
926 enum ata_lpm_policy target_lpm_policy;
927
928 struct timer_list fastdrain_timer;
929 unsigned int fastdrain_cnt;
930
931 async_cookie_t cookie;
932
933 int em_message_type;
934 void *private_data;
935
936 #ifdef CONFIG_ATA_ACPI
937 struct ata_acpi_gtm __acpi_init_gtm; /* use ata_acpi_init_gtm() */
938 #endif
939 };
940
941 /* The following initializer overrides a method to NULL whether one of
942 * its parent has the method defined or not. This is equivalent to
943 * ERR_PTR(-ENOENT). Unfortunately, ERR_PTR doesn't render a constant
944 * expression and thus can't be used as an initializer.
945 */
946 #define ATA_OP_NULL (void *)(unsigned long)(-ENOENT)
947
948 struct ata_reset_operations {
949 ata_prereset_fn_t prereset;
950 ata_reset_fn_t softreset;
951 ata_reset_fn_t hardreset;
952 ata_postreset_fn_t postreset;
953 };
954
955 struct ata_port_operations {
956 /*
957 * Command execution
958 */
959 int (*qc_defer)(struct ata_queued_cmd *qc);
960 int (*check_atapi_dma)(struct ata_queued_cmd *qc);
961 enum ata_completion_errors (*qc_prep)(struct ata_queued_cmd *qc);
962 unsigned int (*qc_issue)(struct ata_queued_cmd *qc);
963 void (*qc_fill_rtf)(struct ata_queued_cmd *qc);
964 void (*qc_ncq_fill_rtf)(struct ata_port *ap, u64 done_mask);
965
966 /*
967 * Configuration and exception handling
968 */
969 int (*cable_detect)(struct ata_port *ap);
970 unsigned int (*mode_filter)(struct ata_device *dev, unsigned int xfer_mask);
971 void (*set_piomode)(struct ata_port *ap, struct ata_device *dev);
972 void (*set_dmamode)(struct ata_port *ap, struct ata_device *dev);
973 int (*set_mode)(struct ata_link *link, struct ata_device **r_failed_dev);
974 unsigned int (*read_id)(struct ata_device *dev, struct ata_taskfile *tf,
975 __le16 *id);
976
977 void (*dev_config)(struct ata_device *dev);
978
979 void (*freeze)(struct ata_port *ap);
980 void (*thaw)(struct ata_port *ap);
981 struct ata_reset_operations reset;
982 struct ata_reset_operations pmp_reset;
983 void (*error_handler)(struct ata_port *ap);
984 void (*lost_interrupt)(struct ata_port *ap);
985 void (*post_internal_cmd)(struct ata_queued_cmd *qc);
986 void (*sched_eh)(struct ata_port *ap);
987 void (*end_eh)(struct ata_port *ap);
988
989 /*
990 * Optional features
991 */
992 int (*scr_read)(struct ata_link *link, unsigned int sc_reg, u32 *val);
993 int (*scr_write)(struct ata_link *link, unsigned int sc_reg, u32 val);
994 void (*pmp_attach)(struct ata_port *ap);
995 void (*pmp_detach)(struct ata_port *ap);
996 int (*set_lpm)(struct ata_link *link, enum ata_lpm_policy policy,
997 unsigned hints);
998
999 /*
1000 * Start, stop, suspend and resume
1001 */
1002 int (*port_suspend)(struct ata_port *ap, pm_message_t mesg);
1003 int (*port_resume)(struct ata_port *ap);
1004 int (*port_start)(struct ata_port *ap);
1005 void (*port_stop)(struct ata_port *ap);
1006 void (*host_stop)(struct ata_host *host);
1007
1008 #ifdef CONFIG_ATA_SFF
1009 /*
1010 * SFF / taskfile oriented ops
1011 */
1012 void (*sff_dev_select)(struct ata_port *ap, unsigned int device);
1013 void (*sff_set_devctl)(struct ata_port *ap, u8 ctl);
1014 u8 (*sff_check_status)(struct ata_port *ap);
1015 u8 (*sff_check_altstatus)(struct ata_port *ap);
1016 void (*sff_tf_load)(struct ata_port *ap, const struct ata_taskfile *tf);
1017 void (*sff_tf_read)(struct ata_port *ap, struct ata_taskfile *tf);
1018 void (*sff_exec_command)(struct ata_port *ap,
1019 const struct ata_taskfile *tf);
1020 unsigned int (*sff_data_xfer)(struct ata_queued_cmd *qc,
1021 unsigned char *buf, unsigned int buflen, int rw);
1022 void (*sff_irq_on)(struct ata_port *);
1023 bool (*sff_irq_check)(struct ata_port *);
1024 void (*sff_irq_clear)(struct ata_port *);
1025 void (*sff_drain_fifo)(struct ata_queued_cmd *qc);
1026
1027 #ifdef CONFIG_ATA_BMDMA
1028 void (*bmdma_setup)(struct ata_queued_cmd *qc);
1029 void (*bmdma_start)(struct ata_queued_cmd *qc);
1030 void (*bmdma_stop)(struct ata_queued_cmd *qc);
1031 u8 (*bmdma_status)(struct ata_port *ap);
1032 #endif /* CONFIG_ATA_BMDMA */
1033 #endif /* CONFIG_ATA_SFF */
1034
1035 ssize_t (*em_show)(struct ata_port *ap, char *buf);
1036 ssize_t (*em_store)(struct ata_port *ap, const char *message,
1037 size_t size);
1038 ssize_t (*sw_activity_show)(struct ata_device *dev, char *buf);
1039 ssize_t (*sw_activity_store)(struct ata_device *dev,
1040 enum sw_activity val);
1041 ssize_t (*transmit_led_message)(struct ata_port *ap, u32 state,
1042 ssize_t size);
1043
1044 /*
1045 * ->inherits must be the last field and all the preceding
1046 * fields must be pointers.
1047 */
1048 const struct ata_port_operations *inherits;
1049 };
1050
1051 struct ata_port_info {
1052 unsigned long flags;
1053 unsigned long link_flags;
1054 unsigned int pio_mask;
1055 unsigned int mwdma_mask;
1056 unsigned int udma_mask;
1057 struct ata_port_operations *port_ops;
1058 void *private_data;
1059 };
1060
1061 struct ata_timing {
1062 unsigned short mode; /* ATA mode */
1063 unsigned short setup; /* t1 */
1064 unsigned short act8b; /* t2 for 8-bit I/O */
1065 unsigned short rec8b; /* t2i for 8-bit I/O */
1066 unsigned short cyc8b; /* t0 for 8-bit I/O */
1067 unsigned short active; /* t2 or tD */
1068 unsigned short recover; /* t2i or tK */
1069 unsigned short dmack_hold; /* tj */
1070 unsigned short cycle; /* t0 */
1071 unsigned short udma; /* t2CYCTYP/2 */
1072 };
1073
1074 /*
1075 * Core layer - drivers/ata/libata-core.c
1076 */
1077 extern struct ata_port_operations ata_dummy_port_ops;
1078 extern const struct ata_port_info ata_dummy_port_info;
1079
ata_is_atapi(u8 prot)1080 static inline bool ata_is_atapi(u8 prot)
1081 {
1082 return prot & ATA_PROT_FLAG_ATAPI;
1083 }
1084
ata_is_pio(u8 prot)1085 static inline bool ata_is_pio(u8 prot)
1086 {
1087 return prot & ATA_PROT_FLAG_PIO;
1088 }
1089
ata_is_dma(u8 prot)1090 static inline bool ata_is_dma(u8 prot)
1091 {
1092 return prot & ATA_PROT_FLAG_DMA;
1093 }
1094
ata_is_ncq(u8 prot)1095 static inline bool ata_is_ncq(u8 prot)
1096 {
1097 return prot & ATA_PROT_FLAG_NCQ;
1098 }
1099
ata_is_data(u8 prot)1100 static inline bool ata_is_data(u8 prot)
1101 {
1102 return prot & (ATA_PROT_FLAG_PIO | ATA_PROT_FLAG_DMA);
1103 }
1104
is_multi_taskfile(struct ata_taskfile * tf)1105 static inline int is_multi_taskfile(struct ata_taskfile *tf)
1106 {
1107 return (tf->command == ATA_CMD_READ_MULTI) ||
1108 (tf->command == ATA_CMD_WRITE_MULTI) ||
1109 (tf->command == ATA_CMD_READ_MULTI_EXT) ||
1110 (tf->command == ATA_CMD_WRITE_MULTI_EXT) ||
1111 (tf->command == ATA_CMD_WRITE_MULTI_FUA_EXT);
1112 }
1113
ata_port_is_dummy(struct ata_port * ap)1114 static inline int ata_port_is_dummy(struct ata_port *ap)
1115 {
1116 return ap->ops == &ata_dummy_port_ops;
1117 }
1118
ata_port_is_frozen(const struct ata_port * ap)1119 static inline bool ata_port_is_frozen(const struct ata_port *ap)
1120 {
1121 return ap->pflags & ATA_PFLAG_FROZEN;
1122 }
1123
1124 extern int ata_std_prereset(struct ata_link *link, unsigned long deadline);
1125 extern int ata_wait_after_reset(struct ata_link *link, unsigned long deadline,
1126 int (*check_ready)(struct ata_link *link));
1127 extern void ata_std_postreset(struct ata_link *link, unsigned int *classes);
1128
1129 extern struct ata_host *ata_host_alloc(struct device *dev, int n_ports);
1130 extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
1131 const struct ata_port_info * const * ppi, int n_ports);
1132 extern void ata_host_get(struct ata_host *host);
1133 extern void ata_host_put(struct ata_host *host);
1134 extern int ata_host_start(struct ata_host *host);
1135 extern int ata_host_register(struct ata_host *host,
1136 const struct scsi_host_template *sht);
1137 extern int ata_host_activate(struct ata_host *host, int irq,
1138 irq_handler_t irq_handler, unsigned long irq_flags,
1139 const struct scsi_host_template *sht);
1140 extern void ata_host_detach(struct ata_host *host);
1141 extern void ata_host_init(struct ata_host *, struct device *, struct ata_port_operations *);
1142 extern int ata_scsi_ioctl(struct scsi_device *dev, unsigned int cmd,
1143 void __user *arg);
1144 #ifdef CONFIG_COMPAT
1145 #define ATA_SCSI_COMPAT_IOCTL .compat_ioctl = ata_scsi_ioctl,
1146 #else
1147 #define ATA_SCSI_COMPAT_IOCTL /* empty */
1148 #endif
1149 extern int ata_scsi_queuecmd(struct Scsi_Host *h, struct scsi_cmnd *cmd);
1150 #if IS_REACHABLE(CONFIG_ATA)
1151 bool ata_scsi_dma_need_drain(struct request *rq);
1152 #else
1153 #define ata_scsi_dma_need_drain NULL
1154 #endif
1155 extern int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *dev,
1156 unsigned int cmd, void __user *arg);
1157 extern bool ata_link_online(struct ata_link *link);
1158 extern bool ata_link_offline(struct ata_link *link);
1159 #ifdef CONFIG_PM
1160 extern void ata_host_suspend(struct ata_host *host, pm_message_t mesg);
1161 extern void ata_host_resume(struct ata_host *host);
1162 extern void ata_sas_port_suspend(struct ata_port *ap);
1163 extern void ata_sas_port_resume(struct ata_port *ap);
1164 #else
ata_sas_port_suspend(struct ata_port * ap)1165 static inline void ata_sas_port_suspend(struct ata_port *ap)
1166 {
1167 }
ata_sas_port_resume(struct ata_port * ap)1168 static inline void ata_sas_port_resume(struct ata_port *ap)
1169 {
1170 }
1171 #endif
1172 extern int ata_ratelimit(void);
1173 extern void ata_msleep(struct ata_port *ap, unsigned int msecs);
1174 extern u32 ata_wait_register(struct ata_port *ap, void __iomem *reg, u32 mask,
1175 u32 val, unsigned int interval, unsigned int timeout);
1176 extern int atapi_cmd_type(u8 opcode);
1177 extern unsigned int ata_pack_xfermask(unsigned int pio_mask,
1178 unsigned int mwdma_mask,
1179 unsigned int udma_mask);
1180 extern void ata_unpack_xfermask(unsigned int xfer_mask,
1181 unsigned int *pio_mask,
1182 unsigned int *mwdma_mask,
1183 unsigned int *udma_mask);
1184 extern u8 ata_xfer_mask2mode(unsigned int xfer_mask);
1185 extern unsigned int ata_xfer_mode2mask(u8 xfer_mode);
1186 extern int ata_xfer_mode2shift(u8 xfer_mode);
1187 extern const char *ata_mode_string(unsigned int xfer_mask);
1188 extern unsigned int ata_id_xfermask(const u16 *id);
1189 extern int ata_std_qc_defer(struct ata_queued_cmd *qc);
1190 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
1191 unsigned int n_elem);
1192 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
1193 extern unsigned int ata_port_classify(struct ata_port *ap,
1194 const struct ata_taskfile *tf);
1195 extern void ata_dev_disable(struct ata_device *adev);
1196 extern void ata_id_string(const u16 *id, unsigned char *s,
1197 unsigned int ofs, unsigned int len);
1198 extern void ata_id_c_string(const u16 *id, unsigned char *s,
1199 unsigned int ofs, unsigned int len);
1200 extern unsigned int ata_do_dev_read_id(struct ata_device *dev,
1201 struct ata_taskfile *tf, __le16 *id);
1202 extern void ata_qc_complete(struct ata_queued_cmd *qc);
1203 extern u64 ata_qc_get_active(struct ata_port *ap);
1204 extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd);
1205 extern int ata_std_bios_param(struct scsi_device *sdev,
1206 struct gendisk *unused,
1207 sector_t capacity, int geom[]);
1208 extern void ata_scsi_unlock_native_capacity(struct scsi_device *sdev);
1209 extern int ata_scsi_sdev_init(struct scsi_device *sdev);
1210 int ata_scsi_sdev_configure(struct scsi_device *sdev, struct queue_limits *lim);
1211 extern void ata_scsi_sdev_destroy(struct scsi_device *sdev);
1212 extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
1213 int queue_depth);
1214 extern int ata_change_queue_depth(struct ata_port *ap, struct scsi_device *sdev,
1215 int queue_depth);
1216 extern int ata_ncq_prio_supported(struct ata_port *ap, struct scsi_device *sdev,
1217 bool *supported);
1218 extern int ata_ncq_prio_enabled(struct ata_port *ap, struct scsi_device *sdev,
1219 bool *enabled);
1220 extern int ata_ncq_prio_enable(struct ata_port *ap, struct scsi_device *sdev,
1221 bool enable);
1222 extern struct ata_device *ata_dev_pair(struct ata_device *adev);
1223 int ata_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
1224 extern void ata_scsi_port_error_handler(struct Scsi_Host *host, struct ata_port *ap);
1225 extern void ata_scsi_cmd_error_handler(struct Scsi_Host *host, struct ata_port *ap, struct list_head *eh_q);
1226
1227 /*
1228 * SATA specific code - drivers/ata/libata-sata.c
1229 */
1230 #ifdef CONFIG_SATA_HOST
1231 extern const unsigned int sata_deb_timing_normal[];
1232 extern const unsigned int sata_deb_timing_hotplug[];
1233 extern const unsigned int sata_deb_timing_long[];
1234
1235 static inline const unsigned int *
sata_ehc_deb_timing(struct ata_eh_context * ehc)1236 sata_ehc_deb_timing(struct ata_eh_context *ehc)
1237 {
1238 if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
1239 return sata_deb_timing_hotplug;
1240 else
1241 return sata_deb_timing_normal;
1242 }
1243
1244 extern int sata_scr_valid(struct ata_link *link);
1245 extern int sata_scr_read(struct ata_link *link, int reg, u32 *val);
1246 extern int sata_scr_write(struct ata_link *link, int reg, u32 val);
1247 extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val);
1248 extern int sata_set_spd(struct ata_link *link);
1249 int sata_std_hardreset(struct ata_link *link, unsigned int *class,
1250 unsigned long deadline);
1251 extern int sata_link_hardreset(struct ata_link *link,
1252 const unsigned int *timing, unsigned long deadline,
1253 bool *online, int (*check_ready)(struct ata_link *));
1254 extern int sata_link_resume(struct ata_link *link, const unsigned int *params,
1255 unsigned long deadline);
1256 extern void ata_eh_analyze_ncq_error(struct ata_link *link);
1257 #else
1258 static inline const unsigned int *
sata_ehc_deb_timing(struct ata_eh_context * ehc)1259 sata_ehc_deb_timing(struct ata_eh_context *ehc)
1260 {
1261 return NULL;
1262 }
sata_scr_valid(struct ata_link * link)1263 static inline int sata_scr_valid(struct ata_link *link) { return 0; }
sata_scr_read(struct ata_link * link,int reg,u32 * val)1264 static inline int sata_scr_read(struct ata_link *link, int reg, u32 *val)
1265 {
1266 return -EOPNOTSUPP;
1267 }
sata_scr_write(struct ata_link * link,int reg,u32 val)1268 static inline int sata_scr_write(struct ata_link *link, int reg, u32 val)
1269 {
1270 return -EOPNOTSUPP;
1271 }
sata_scr_write_flush(struct ata_link * link,int reg,u32 val)1272 static inline int sata_scr_write_flush(struct ata_link *link, int reg, u32 val)
1273 {
1274 return -EOPNOTSUPP;
1275 }
sata_set_spd(struct ata_link * link)1276 static inline int sata_set_spd(struct ata_link *link) { return -EOPNOTSUPP; }
sata_std_hardreset(struct ata_link * link,unsigned int * class,unsigned long deadline)1277 static inline int sata_std_hardreset(struct ata_link *link, unsigned int *class,
1278 unsigned long deadline)
1279 {
1280 return -EOPNOTSUPP;
1281 }
sata_link_hardreset(struct ata_link * link,const unsigned int * timing,unsigned long deadline,bool * online,int (* check_ready)(struct ata_link *))1282 static inline int sata_link_hardreset(struct ata_link *link,
1283 const unsigned int *timing,
1284 unsigned long deadline,
1285 bool *online,
1286 int (*check_ready)(struct ata_link *))
1287 {
1288 if (online)
1289 *online = false;
1290 return -EOPNOTSUPP;
1291 }
sata_link_resume(struct ata_link * link,const unsigned int * params,unsigned long deadline)1292 static inline int sata_link_resume(struct ata_link *link,
1293 const unsigned int *params,
1294 unsigned long deadline)
1295 {
1296 return -EOPNOTSUPP;
1297 }
ata_eh_analyze_ncq_error(struct ata_link * link)1298 static inline void ata_eh_analyze_ncq_error(struct ata_link *link) { }
1299 #endif
1300 extern int sata_link_debounce(struct ata_link *link,
1301 const unsigned int *params, unsigned long deadline);
1302 extern int sata_link_scr_lpm(struct ata_link *link, enum ata_lpm_policy policy,
1303 bool spm_wakeup);
1304 extern int ata_slave_link_init(struct ata_port *ap);
1305 extern void ata_port_probe(struct ata_port *ap);
1306 extern struct ata_port *ata_port_alloc(struct ata_host *host);
1307 extern void ata_port_free(struct ata_port *ap);
1308 extern int ata_tport_add(struct device *parent, struct ata_port *ap);
1309 extern void ata_tport_delete(struct ata_port *ap);
1310 int ata_sas_sdev_configure(struct scsi_device *sdev, struct queue_limits *lim,
1311 struct ata_port *ap);
1312 extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, struct ata_port *ap);
1313 extern void ata_tf_to_fis(const struct ata_taskfile *tf,
1314 u8 pmp, int is_cmd, u8 *fis);
1315 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
1316 extern int ata_qc_complete_multiple(struct ata_port *ap, u64 qc_active);
1317 extern bool sata_lpm_ignore_phy_events(struct ata_link *link);
1318 extern int sata_async_notification(struct ata_port *ap);
1319
1320 extern int ata_cable_40wire(struct ata_port *ap);
1321 extern int ata_cable_80wire(struct ata_port *ap);
1322 extern int ata_cable_sata(struct ata_port *ap);
1323 extern int ata_cable_ignore(struct ata_port *ap);
1324 extern int ata_cable_unknown(struct ata_port *ap);
1325
1326 /* Timing helpers */
1327 extern unsigned int ata_pio_need_iordy(const struct ata_device *);
1328 extern u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle);
1329
1330 /* PCI */
1331 #ifdef CONFIG_PCI
1332 struct pci_dev;
1333
1334 struct pci_bits {
1335 unsigned int reg; /* PCI config register to read */
1336 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
1337 unsigned long mask;
1338 unsigned long val;
1339 };
1340
1341 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
1342 extern void ata_pci_shutdown_one(struct pci_dev *pdev);
1343 extern void ata_pci_remove_one(struct pci_dev *pdev);
1344
1345 #ifdef CONFIG_PM
1346 extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
1347 extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
1348 extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
1349 extern int ata_pci_device_resume(struct pci_dev *pdev);
1350 #endif /* CONFIG_PM */
1351 #endif /* CONFIG_PCI */
1352
1353 struct platform_device;
1354
1355 extern void ata_platform_remove_one(struct platform_device *pdev);
1356
1357 /*
1358 * ACPI - drivers/ata/libata-acpi.c
1359 */
1360 #ifdef CONFIG_ATA_ACPI
ata_acpi_init_gtm(struct ata_port * ap)1361 static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1362 {
1363 if (ap->pflags & ATA_PFLAG_INIT_GTM_VALID)
1364 return &ap->__acpi_init_gtm;
1365 return NULL;
1366 }
1367 int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm);
1368 int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *stm);
1369 unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev,
1370 const struct ata_acpi_gtm *gtm);
1371 int ata_acpi_cbl_pata_type(struct ata_port *ap);
1372 #else
ata_acpi_init_gtm(struct ata_port * ap)1373 static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1374 {
1375 return NULL;
1376 }
1377
ata_acpi_stm(const struct ata_port * ap,struct ata_acpi_gtm * stm)1378 static inline int ata_acpi_stm(const struct ata_port *ap,
1379 struct ata_acpi_gtm *stm)
1380 {
1381 return -ENOSYS;
1382 }
1383
ata_acpi_gtm(const struct ata_port * ap,struct ata_acpi_gtm * stm)1384 static inline int ata_acpi_gtm(const struct ata_port *ap,
1385 struct ata_acpi_gtm *stm)
1386 {
1387 return -ENOSYS;
1388 }
1389
ata_acpi_gtm_xfermask(struct ata_device * dev,const struct ata_acpi_gtm * gtm)1390 static inline unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev,
1391 const struct ata_acpi_gtm *gtm)
1392 {
1393 return 0;
1394 }
1395
ata_acpi_cbl_pata_type(struct ata_port * ap)1396 static inline int ata_acpi_cbl_pata_type(struct ata_port *ap)
1397 {
1398 return ATA_CBL_PATA40;
1399 }
1400 #endif
1401
1402 /*
1403 * EH - drivers/ata/libata-eh.c
1404 */
1405 extern void ata_port_schedule_eh(struct ata_port *ap);
1406 extern void ata_port_wait_eh(struct ata_port *ap);
1407 extern int ata_link_abort(struct ata_link *link);
1408 extern int ata_port_abort(struct ata_port *ap);
1409 extern int ata_port_freeze(struct ata_port *ap);
1410
1411 extern void ata_eh_freeze_port(struct ata_port *ap);
1412 extern void ata_eh_thaw_port(struct ata_port *ap);
1413
1414 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
1415 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
1416
1417 extern void ata_std_error_handler(struct ata_port *ap);
1418 extern void ata_std_sched_eh(struct ata_port *ap);
1419 extern void ata_std_end_eh(struct ata_port *ap);
1420 extern int ata_link_nr_enabled(struct ata_link *link);
1421
1422 /*
1423 * Base operations to inherit from and initializers for sht
1424 *
1425 * Operations
1426 *
1427 * base : Common to all libata drivers.
1428 * sata : SATA controllers w/ native interface.
1429 * pmp : SATA controllers w/ PMP support.
1430 * sff : SFF ATA controllers w/o BMDMA support.
1431 * bmdma : SFF ATA controllers w/ BMDMA support.
1432 *
1433 * sht initializers
1434 *
1435 * BASE : Common to all libata drivers. The user must set
1436 * sg_tablesize and dma_boundary.
1437 * PIO : SFF ATA controllers w/ only PIO support.
1438 * BMDMA : SFF ATA controllers w/ BMDMA support. sg_tablesize and
1439 * dma_boundary are set to BMDMA limits.
1440 * NCQ : SATA controllers supporting NCQ. The user must set
1441 * sg_tablesize, dma_boundary and can_queue.
1442 */
1443 extern const struct ata_port_operations ata_base_port_ops;
1444 extern const struct ata_port_operations sata_port_ops;
1445 extern const struct attribute_group *ata_common_sdev_groups[];
1446
1447 /*
1448 * All sht initializers (BASE, PIO, BMDMA, NCQ) must be instantiated
1449 * by the edge drivers. Because the 'module' field of sht must be the
1450 * edge driver's module reference, otherwise the driver can be unloaded
1451 * even if the scsi_device is being accessed.
1452 */
1453 #define __ATA_BASE_SHT(drv_name) \
1454 .module = THIS_MODULE, \
1455 .name = drv_name, \
1456 .ioctl = ata_scsi_ioctl, \
1457 ATA_SCSI_COMPAT_IOCTL \
1458 .queuecommand = ata_scsi_queuecmd, \
1459 .dma_need_drain = ata_scsi_dma_need_drain, \
1460 .this_id = ATA_SHT_THIS_ID, \
1461 .emulated = ATA_SHT_EMULATED, \
1462 .proc_name = drv_name, \
1463 .sdev_init = ata_scsi_sdev_init, \
1464 .sdev_destroy = ata_scsi_sdev_destroy, \
1465 .bios_param = ata_std_bios_param, \
1466 .unlock_native_capacity = ata_scsi_unlock_native_capacity,\
1467 .max_sectors = ATA_MAX_SECTORS_LBA48
1468
1469 #define ATA_SUBBASE_SHT(drv_name) \
1470 __ATA_BASE_SHT(drv_name), \
1471 .can_queue = ATA_DEF_QUEUE, \
1472 .tag_alloc_policy_rr = true, \
1473 .sdev_configure = ata_scsi_sdev_configure
1474
1475 #define ATA_SUBBASE_SHT_QD(drv_name, drv_qd) \
1476 __ATA_BASE_SHT(drv_name), \
1477 .can_queue = drv_qd, \
1478 .tag_alloc_policy_rr = true, \
1479 .sdev_configure = ata_scsi_sdev_configure
1480
1481 #define ATA_BASE_SHT(drv_name) \
1482 ATA_SUBBASE_SHT(drv_name), \
1483 .sdev_groups = ata_common_sdev_groups
1484
1485 #ifdef CONFIG_SATA_HOST
1486 extern const struct attribute_group *ata_ncq_sdev_groups[];
1487
1488 #define ATA_NCQ_SHT(drv_name) \
1489 ATA_SUBBASE_SHT(drv_name), \
1490 .sdev_groups = ata_ncq_sdev_groups, \
1491 .change_queue_depth = ata_scsi_change_queue_depth
1492
1493 #define ATA_NCQ_SHT_QD(drv_name, drv_qd) \
1494 ATA_SUBBASE_SHT_QD(drv_name, drv_qd), \
1495 .sdev_groups = ata_ncq_sdev_groups, \
1496 .change_queue_depth = ata_scsi_change_queue_depth
1497 #endif
1498
1499 /*
1500 * PMP helpers
1501 */
1502 #ifdef CONFIG_SATA_PMP
sata_pmp_supported(struct ata_port * ap)1503 static inline bool sata_pmp_supported(struct ata_port *ap)
1504 {
1505 return ap->flags & ATA_FLAG_PMP;
1506 }
1507
sata_pmp_attached(struct ata_port * ap)1508 static inline bool sata_pmp_attached(struct ata_port *ap)
1509 {
1510 return ap->nr_pmp_links != 0;
1511 }
1512
ata_is_host_link(const struct ata_link * link)1513 static inline bool ata_is_host_link(const struct ata_link *link)
1514 {
1515 return link == &link->ap->link || link == link->ap->slave_link;
1516 }
1517 #else /* CONFIG_SATA_PMP */
sata_pmp_supported(struct ata_port * ap)1518 static inline bool sata_pmp_supported(struct ata_port *ap)
1519 {
1520 return false;
1521 }
1522
sata_pmp_attached(struct ata_port * ap)1523 static inline bool sata_pmp_attached(struct ata_port *ap)
1524 {
1525 return false;
1526 }
1527
ata_is_host_link(const struct ata_link * link)1528 static inline bool ata_is_host_link(const struct ata_link *link)
1529 {
1530 return true;
1531 }
1532 #endif /* CONFIG_SATA_PMP */
1533
sata_srst_pmp(struct ata_link * link)1534 static inline int sata_srst_pmp(struct ata_link *link)
1535 {
1536 if (sata_pmp_supported(link->ap) && ata_is_host_link(link))
1537 return SATA_PMP_CTRL_PORT;
1538 return link->pmp;
1539 }
1540
1541 #define ata_port_printk(level, ap, fmt, ...) \
1542 pr_ ## level ("ata%u: " fmt, (ap)->print_id, ##__VA_ARGS__)
1543
1544 #define ata_port_err(ap, fmt, ...) \
1545 ata_port_printk(err, ap, fmt, ##__VA_ARGS__)
1546 #define ata_port_warn(ap, fmt, ...) \
1547 ata_port_printk(warn, ap, fmt, ##__VA_ARGS__)
1548 #define ata_port_notice(ap, fmt, ...) \
1549 ata_port_printk(notice, ap, fmt, ##__VA_ARGS__)
1550 #define ata_port_info(ap, fmt, ...) \
1551 ata_port_printk(info, ap, fmt, ##__VA_ARGS__)
1552 #define ata_port_dbg(ap, fmt, ...) \
1553 ata_port_printk(debug, ap, fmt, ##__VA_ARGS__)
1554
1555 #define ata_link_printk(level, link, fmt, ...) \
1556 do { \
1557 if (sata_pmp_attached((link)->ap) || \
1558 (link)->ap->slave_link) \
1559 pr_ ## level ("ata%u.%02u: " fmt, \
1560 (link)->ap->print_id, \
1561 (link)->pmp, \
1562 ##__VA_ARGS__); \
1563 else \
1564 pr_ ## level ("ata%u: " fmt, \
1565 (link)->ap->print_id, \
1566 ##__VA_ARGS__); \
1567 } while (0)
1568
1569 #define ata_link_err(link, fmt, ...) \
1570 ata_link_printk(err, link, fmt, ##__VA_ARGS__)
1571 #define ata_link_warn(link, fmt, ...) \
1572 ata_link_printk(warn, link, fmt, ##__VA_ARGS__)
1573 #define ata_link_notice(link, fmt, ...) \
1574 ata_link_printk(notice, link, fmt, ##__VA_ARGS__)
1575 #define ata_link_info(link, fmt, ...) \
1576 ata_link_printk(info, link, fmt, ##__VA_ARGS__)
1577 #define ata_link_dbg(link, fmt, ...) \
1578 ata_link_printk(debug, link, fmt, ##__VA_ARGS__)
1579
1580 #define ata_dev_printk(level, dev, fmt, ...) \
1581 pr_ ## level("ata%u.%02u: " fmt, \
1582 (dev)->link->ap->print_id, \
1583 (dev)->link->pmp + (dev)->devno, \
1584 ##__VA_ARGS__)
1585
1586 #define ata_dev_err(dev, fmt, ...) \
1587 ata_dev_printk(err, dev, fmt, ##__VA_ARGS__)
1588 #define ata_dev_warn(dev, fmt, ...) \
1589 ata_dev_printk(warn, dev, fmt, ##__VA_ARGS__)
1590 #define ata_dev_notice(dev, fmt, ...) \
1591 ata_dev_printk(notice, dev, fmt, ##__VA_ARGS__)
1592 #define ata_dev_info(dev, fmt, ...) \
1593 ata_dev_printk(info, dev, fmt, ##__VA_ARGS__)
1594 #define ata_dev_dbg(dev, fmt, ...) \
1595 ata_dev_printk(debug, dev, fmt, ##__VA_ARGS__)
1596
1597 #define ata_dev_warn_once(dev, fmt, ...) \
1598 pr_warn_once("ata%u.%02u: " fmt, \
1599 (dev)->link->ap->print_id, \
1600 (dev)->link->pmp + (dev)->devno, \
1601 ##__VA_ARGS__)
1602
ata_print_version_once(const struct device * dev,const char * version)1603 static inline void ata_print_version_once(const struct device *dev,
1604 const char *version)
1605 {
1606 dev_dbg_once(dev, "version %s\n", version);
1607 }
1608
1609 /*
1610 * ata_eh_info helpers
1611 */
1612 extern __printf(2, 3)
1613 void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
1614 extern __printf(2, 3)
1615 void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
1616 extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
1617
ata_ehi_hotplugged(struct ata_eh_info * ehi)1618 static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
1619 {
1620 ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
1621 ehi->flags |= ATA_EHI_HOTPLUGGED;
1622 ehi->action |= ATA_EH_RESET | ATA_EH_ENABLE_LINK;
1623 ehi->err_mask |= AC_ERR_ATA_BUS;
1624 }
1625
1626 /*
1627 * port description helpers
1628 */
1629 extern __printf(2, 3)
1630 void ata_port_desc(struct ata_port *ap, const char *fmt, ...);
1631 #ifdef CONFIG_PCI
1632 extern void ata_port_pbar_desc(struct ata_port *ap, int bar, ssize_t offset,
1633 const char *name);
1634 #endif
ata_port_desc_misc(struct ata_port * ap,int irq)1635 static inline void ata_port_desc_misc(struct ata_port *ap, int irq)
1636 {
1637 ata_port_desc(ap, "irq %d", irq);
1638 ata_port_desc(ap, "lpm-pol %d", ap->target_lpm_policy);
1639 if (ap->pflags & ATA_PFLAG_EXTERNAL)
1640 ata_port_desc(ap, "ext");
1641 }
1642
ata_tag_internal(unsigned int tag)1643 static inline bool ata_tag_internal(unsigned int tag)
1644 {
1645 return tag == ATA_TAG_INTERNAL;
1646 }
1647
ata_tag_valid(unsigned int tag)1648 static inline bool ata_tag_valid(unsigned int tag)
1649 {
1650 return tag < ATA_MAX_QUEUE || ata_tag_internal(tag);
1651 }
1652
1653 #define __ata_qc_for_each(ap, qc, tag, max_tag, fn) \
1654 for ((tag) = 0; (tag) < (max_tag) && \
1655 ({ qc = fn((ap), (tag)); 1; }); (tag)++) \
1656
1657 /*
1658 * Internal use only, iterate commands ignoring error handling and
1659 * status of 'qc'.
1660 */
1661 #define ata_qc_for_each_raw(ap, qc, tag) \
1662 __ata_qc_for_each(ap, qc, tag, ATA_MAX_QUEUE, __ata_qc_from_tag)
1663
1664 /*
1665 * Iterate all potential commands that can be queued
1666 */
1667 #define ata_qc_for_each(ap, qc, tag) \
1668 __ata_qc_for_each(ap, qc, tag, ATA_MAX_QUEUE, ata_qc_from_tag)
1669
1670 /*
1671 * Like ata_qc_for_each, but with the internal tag included
1672 */
1673 #define ata_qc_for_each_with_internal(ap, qc, tag) \
1674 __ata_qc_for_each(ap, qc, tag, ATA_MAX_QUEUE + 1, ata_qc_from_tag)
1675
1676 /*
1677 * device helpers
1678 */
ata_class_enabled(unsigned int class)1679 static inline unsigned int ata_class_enabled(unsigned int class)
1680 {
1681 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI ||
1682 class == ATA_DEV_PMP || class == ATA_DEV_SEMB ||
1683 class == ATA_DEV_ZAC;
1684 }
1685
ata_class_disabled(unsigned int class)1686 static inline unsigned int ata_class_disabled(unsigned int class)
1687 {
1688 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP ||
1689 class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP ||
1690 class == ATA_DEV_ZAC_UNSUP;
1691 }
1692
ata_class_absent(unsigned int class)1693 static inline unsigned int ata_class_absent(unsigned int class)
1694 {
1695 return !ata_class_enabled(class) && !ata_class_disabled(class);
1696 }
1697
ata_dev_enabled(const struct ata_device * dev)1698 static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1699 {
1700 return ata_class_enabled(dev->class);
1701 }
1702
ata_dev_disabled(const struct ata_device * dev)1703 static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1704 {
1705 return ata_class_disabled(dev->class);
1706 }
1707
ata_dev_absent(const struct ata_device * dev)1708 static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1709 {
1710 return ata_class_absent(dev->class);
1711 }
1712
1713 /*
1714 * link helpers
1715 */
ata_link_max_devices(const struct ata_link * link)1716 static inline int ata_link_max_devices(const struct ata_link *link)
1717 {
1718 if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS)
1719 return 2;
1720 return 1;
1721 }
1722
ata_link_active(struct ata_link * link)1723 static inline int ata_link_active(struct ata_link *link)
1724 {
1725 return ata_tag_valid(link->active_tag) || link->sactive;
1726 }
1727
1728 /*
1729 * Iterators
1730 *
1731 * ATA_LITER_* constants are used to select link iteration mode and
1732 * ATA_DITER_* device iteration mode.
1733 *
1734 * For a custom iteration directly using ata_{link|dev}_next(), if
1735 * @link or @dev, respectively, is NULL, the first element is
1736 * returned. @dev and @link can be any valid device or link and the
1737 * next element according to the iteration mode will be returned.
1738 * After the last element, NULL is returned.
1739 */
1740 enum ata_link_iter_mode {
1741 ATA_LITER_EDGE, /* if present, PMP links only; otherwise,
1742 * host link. no slave link */
1743 ATA_LITER_HOST_FIRST, /* host link followed by PMP or slave links */
1744 ATA_LITER_PMP_FIRST, /* PMP links followed by host link,
1745 * slave link still comes after host link */
1746 };
1747
1748 enum ata_dev_iter_mode {
1749 ATA_DITER_ENABLED,
1750 ATA_DITER_ENABLED_REVERSE,
1751 ATA_DITER_ALL,
1752 ATA_DITER_ALL_REVERSE,
1753 };
1754
1755 extern struct ata_link *ata_link_next(struct ata_link *link,
1756 struct ata_port *ap,
1757 enum ata_link_iter_mode mode);
1758
1759 extern struct ata_device *ata_dev_next(struct ata_device *dev,
1760 struct ata_link *link,
1761 enum ata_dev_iter_mode mode);
1762
1763 /*
1764 * Shortcut notation for iterations
1765 *
1766 * ata_for_each_link() iterates over each link of @ap according to
1767 * @mode. @link points to the current link in the loop. @link is
1768 * NULL after loop termination. ata_for_each_dev() works the same way
1769 * except that it iterates over each device of @link.
1770 *
1771 * Note that the mode prefixes ATA_{L|D}ITER_ shouldn't need to be
1772 * specified when using the following shorthand notations. Only the
1773 * mode itself (EDGE, HOST_FIRST, ENABLED, etc...) should be
1774 * specified. This not only increases brevity but also makes it
1775 * impossible to use ATA_LITER_* for device iteration or vice-versa.
1776 */
1777 #define ata_for_each_link(link, ap, mode) \
1778 for ((link) = ata_link_next(NULL, (ap), ATA_LITER_##mode); (link); \
1779 (link) = ata_link_next((link), (ap), ATA_LITER_##mode))
1780
1781 #define ata_for_each_dev(dev, link, mode) \
1782 for ((dev) = ata_dev_next(NULL, (link), ATA_DITER_##mode); (dev); \
1783 (dev) = ata_dev_next((dev), (link), ATA_DITER_##mode))
1784
1785 /**
1786 * ata_ncq_supported - Test whether NCQ is supported
1787 * @dev: ATA device to test
1788 *
1789 * LOCKING:
1790 * spin_lock_irqsave(host lock)
1791 *
1792 * RETURNS:
1793 * true if @dev supports NCQ, false otherwise.
1794 */
ata_ncq_supported(struct ata_device * dev)1795 static inline bool ata_ncq_supported(struct ata_device *dev)
1796 {
1797 if (!IS_ENABLED(CONFIG_SATA_HOST))
1798 return false;
1799 return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1800 }
1801
1802 /**
1803 * ata_ncq_enabled - Test whether NCQ is enabled
1804 * @dev: ATA device to test
1805 *
1806 * LOCKING:
1807 * spin_lock_irqsave(host lock)
1808 *
1809 * RETURNS:
1810 * true if NCQ is enabled for @dev, false otherwise.
1811 */
ata_ncq_enabled(struct ata_device * dev)1812 static inline bool ata_ncq_enabled(struct ata_device *dev)
1813 {
1814 return ata_ncq_supported(dev) && !(dev->flags & ATA_DFLAG_NCQ_OFF);
1815 }
1816
ata_fpdma_dsm_supported(struct ata_device * dev)1817 static inline bool ata_fpdma_dsm_supported(struct ata_device *dev)
1818 {
1819 return (dev->flags & ATA_DFLAG_NCQ_SEND_RECV) &&
1820 (dev->ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_DSM_OFFSET] &
1821 ATA_LOG_NCQ_SEND_RECV_DSM_TRIM);
1822 }
1823
ata_fpdma_read_log_supported(struct ata_device * dev)1824 static inline bool ata_fpdma_read_log_supported(struct ata_device *dev)
1825 {
1826 return (dev->flags & ATA_DFLAG_NCQ_SEND_RECV) &&
1827 (dev->ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_RD_LOG_OFFSET] &
1828 ATA_LOG_NCQ_SEND_RECV_RD_LOG_SUPPORTED);
1829 }
1830
ata_fpdma_zac_mgmt_in_supported(struct ata_device * dev)1831 static inline bool ata_fpdma_zac_mgmt_in_supported(struct ata_device *dev)
1832 {
1833 return (dev->flags & ATA_DFLAG_NCQ_SEND_RECV) &&
1834 (dev->ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_ZAC_MGMT_OFFSET] &
1835 ATA_LOG_NCQ_SEND_RECV_ZAC_MGMT_IN_SUPPORTED);
1836 }
1837
ata_fpdma_zac_mgmt_out_supported(struct ata_device * dev)1838 static inline bool ata_fpdma_zac_mgmt_out_supported(struct ata_device *dev)
1839 {
1840 return (dev->ncq_non_data_cmds[ATA_LOG_NCQ_NON_DATA_ZAC_MGMT_OFFSET] &
1841 ATA_LOG_NCQ_NON_DATA_ZAC_MGMT_OUT);
1842 }
1843
ata_qc_set_polling(struct ata_queued_cmd * qc)1844 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1845 {
1846 qc->tf.ctl |= ATA_NIEN;
1847 }
1848
__ata_qc_from_tag(struct ata_port * ap,unsigned int tag)1849 static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1850 unsigned int tag)
1851 {
1852 if (ata_tag_valid(tag))
1853 return &ap->qcmd[tag];
1854 return NULL;
1855 }
1856
ata_qc_from_tag(struct ata_port * ap,unsigned int tag)1857 static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1858 unsigned int tag)
1859 {
1860 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1861
1862 if (unlikely(!qc))
1863 return qc;
1864
1865 if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1866 ATA_QCFLAG_EH)) == ATA_QCFLAG_ACTIVE)
1867 return qc;
1868
1869 return NULL;
1870 }
1871
ata_qc_raw_nbytes(struct ata_queued_cmd * qc)1872 static inline unsigned int ata_qc_raw_nbytes(struct ata_queued_cmd *qc)
1873 {
1874 return qc->nbytes - min(qc->extrabytes, qc->nbytes);
1875 }
1876
ata_tf_init(struct ata_device * dev,struct ata_taskfile * tf)1877 static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1878 {
1879 memset(tf, 0, sizeof(*tf));
1880
1881 #ifdef CONFIG_ATA_SFF
1882 tf->ctl = dev->link->ap->ctl;
1883 #else
1884 tf->ctl = ATA_DEVCTL_OBS;
1885 #endif
1886 if (dev->devno == 0)
1887 tf->device = ATA_DEVICE_OBS;
1888 else
1889 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1890 }
1891
ata_qc_reinit(struct ata_queued_cmd * qc)1892 static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1893 {
1894 qc->dma_dir = DMA_NONE;
1895 qc->sg = NULL;
1896 qc->flags = 0;
1897 qc->cursg = NULL;
1898 qc->cursg_ofs = 0;
1899 qc->nbytes = qc->extrabytes = qc->curbytes = 0;
1900 qc->n_elem = 0;
1901 qc->err_mask = 0;
1902 qc->sect_size = ATA_SECT_SIZE;
1903
1904 ata_tf_init(qc->dev, &qc->tf);
1905
1906 /* init result_tf such that it indicates normal completion */
1907 qc->result_tf.command = ATA_DRDY;
1908 qc->result_tf.feature = 0;
1909 }
1910
ata_try_flush_cache(const struct ata_device * dev)1911 static inline int ata_try_flush_cache(const struct ata_device *dev)
1912 {
1913 return ata_id_wcache_enabled(dev->id) ||
1914 ata_id_has_flush(dev->id) ||
1915 ata_id_has_flush_ext(dev->id);
1916 }
1917
ac_err_mask(u8 status)1918 static inline unsigned int ac_err_mask(u8 status)
1919 {
1920 if (status & (ATA_BUSY | ATA_DRQ))
1921 return AC_ERR_HSM;
1922 if (status & (ATA_ERR | ATA_DF))
1923 return AC_ERR_DEV;
1924 return 0;
1925 }
1926
__ac_err_mask(u8 status)1927 static inline unsigned int __ac_err_mask(u8 status)
1928 {
1929 unsigned int mask = ac_err_mask(status);
1930 if (mask == 0)
1931 return AC_ERR_OTHER;
1932 return mask;
1933 }
1934
ata_shost_to_port(struct Scsi_Host * host)1935 static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1936 {
1937 return *(struct ata_port **)&host->hostdata[0];
1938 }
1939
ata_check_ready(u8 status)1940 static inline int ata_check_ready(u8 status)
1941 {
1942 if (!(status & ATA_BUSY))
1943 return 1;
1944
1945 /* 0xff indicates either no device or device not ready */
1946 if (status == 0xff)
1947 return -ENODEV;
1948
1949 return 0;
1950 }
1951
ata_deadline(unsigned long from_jiffies,unsigned int timeout_msecs)1952 static inline unsigned long ata_deadline(unsigned long from_jiffies,
1953 unsigned int timeout_msecs)
1954 {
1955 return from_jiffies + msecs_to_jiffies(timeout_msecs);
1956 }
1957
1958 /* Don't open code these in drivers as there are traps. Firstly the range may
1959 change in future hardware and specs, secondly 0xFF means 'no DMA' but is
1960 > UDMA_0. Dyma ddreigiau */
1961
ata_using_mwdma(struct ata_device * adev)1962 static inline bool ata_using_mwdma(struct ata_device *adev)
1963 {
1964 return adev->dma_mode >= XFER_MW_DMA_0 &&
1965 adev->dma_mode <= XFER_MW_DMA_4;
1966 }
1967
ata_using_udma(struct ata_device * adev)1968 static inline bool ata_using_udma(struct ata_device *adev)
1969 {
1970 return adev->dma_mode >= XFER_UDMA_0 &&
1971 adev->dma_mode <= XFER_UDMA_7;
1972 }
1973
ata_dma_enabled(struct ata_device * adev)1974 static inline bool ata_dma_enabled(struct ata_device *adev)
1975 {
1976 return adev->dma_mode != 0xFF;
1977 }
1978
1979 /**************************************************************************
1980 * PATA timings - drivers/ata/libata-pata-timings.c
1981 */
1982 extern const struct ata_timing *ata_timing_find_mode(u8 xfer_mode);
1983 extern int ata_timing_compute(struct ata_device *, unsigned short,
1984 struct ata_timing *, int, int);
1985 extern void ata_timing_merge(const struct ata_timing *,
1986 const struct ata_timing *, struct ata_timing *,
1987 unsigned int);
1988
1989 /**************************************************************************
1990 * PMP - drivers/ata/libata-pmp.c
1991 */
1992 #ifdef CONFIG_SATA_PMP
1993
1994 extern const struct ata_port_operations sata_pmp_port_ops;
1995
1996 extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc);
1997 extern void sata_pmp_error_handler(struct ata_port *ap);
1998
1999 #else /* CONFIG_SATA_PMP */
2000
2001 #define sata_pmp_port_ops sata_port_ops
2002 #define sata_pmp_qc_defer_cmd_switch ata_std_qc_defer
2003 #define sata_pmp_error_handler ata_std_error_handler
2004
2005 #endif /* CONFIG_SATA_PMP */
2006
2007
2008 /**************************************************************************
2009 * SFF - drivers/ata/libata-sff.c
2010 */
2011 #ifdef CONFIG_ATA_SFF
2012
2013 extern const struct ata_port_operations ata_sff_port_ops;
2014 extern const struct ata_port_operations ata_bmdma32_port_ops;
2015
2016 /* PIO only, sg_tablesize and dma_boundary limits can be removed */
2017 #define ATA_PIO_SHT(drv_name) \
2018 ATA_BASE_SHT(drv_name), \
2019 .sg_tablesize = LIBATA_MAX_PRD, \
2020 .dma_boundary = ATA_DMA_BOUNDARY
2021
2022 extern void ata_sff_dev_select(struct ata_port *ap, unsigned int device);
2023 extern u8 ata_sff_check_status(struct ata_port *ap);
2024 extern void ata_sff_pause(struct ata_port *ap);
2025 extern void ata_sff_dma_pause(struct ata_port *ap);
2026 extern int ata_sff_wait_ready(struct ata_link *link, unsigned long deadline);
2027 extern void ata_sff_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
2028 extern void ata_sff_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
2029 extern void ata_sff_exec_command(struct ata_port *ap,
2030 const struct ata_taskfile *tf);
2031 extern unsigned int ata_sff_data_xfer(struct ata_queued_cmd *qc,
2032 unsigned char *buf, unsigned int buflen, int rw);
2033 extern unsigned int ata_sff_data_xfer32(struct ata_queued_cmd *qc,
2034 unsigned char *buf, unsigned int buflen, int rw);
2035 extern void ata_sff_irq_on(struct ata_port *ap);
2036 extern int ata_sff_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
2037 u8 status, int in_wq);
2038 extern void ata_sff_queue_work(struct work_struct *work);
2039 extern void ata_sff_queue_delayed_work(struct delayed_work *dwork,
2040 unsigned long delay);
2041 extern void ata_sff_queue_pio_task(struct ata_link *link, unsigned long delay);
2042 extern unsigned int ata_sff_qc_issue(struct ata_queued_cmd *qc);
2043 extern void ata_sff_qc_fill_rtf(struct ata_queued_cmd *qc);
2044 extern unsigned int ata_sff_port_intr(struct ata_port *ap,
2045 struct ata_queued_cmd *qc);
2046 extern irqreturn_t ata_sff_interrupt(int irq, void *dev_instance);
2047 extern void ata_sff_lost_interrupt(struct ata_port *ap);
2048 extern void ata_sff_freeze(struct ata_port *ap);
2049 extern void ata_sff_thaw(struct ata_port *ap);
2050 extern int ata_sff_prereset(struct ata_link *link, unsigned long deadline);
2051 extern unsigned int ata_sff_dev_classify(struct ata_device *dev, int present,
2052 u8 *r_err);
2053 extern int ata_sff_wait_after_reset(struct ata_link *link, unsigned int devmask,
2054 unsigned long deadline);
2055 extern int ata_sff_softreset(struct ata_link *link, unsigned int *classes,
2056 unsigned long deadline);
2057 extern int sata_sff_hardreset(struct ata_link *link, unsigned int *class,
2058 unsigned long deadline);
2059 extern void ata_sff_postreset(struct ata_link *link, unsigned int *classes);
2060 extern void ata_sff_drain_fifo(struct ata_queued_cmd *qc);
2061 extern void ata_sff_error_handler(struct ata_port *ap);
2062 extern void ata_sff_std_ports(struct ata_ioports *ioaddr);
2063 #ifdef CONFIG_PCI
2064 extern int ata_pci_sff_init_host(struct ata_host *host);
2065 extern int ata_pci_sff_prepare_host(struct pci_dev *pdev,
2066 const struct ata_port_info * const * ppi,
2067 struct ata_host **r_host);
2068 extern int ata_pci_sff_activate_host(struct ata_host *host,
2069 irq_handler_t irq_handler,
2070 const struct scsi_host_template *sht);
2071 extern int ata_pci_sff_init_one(struct pci_dev *pdev,
2072 const struct ata_port_info * const * ppi,
2073 const struct scsi_host_template *sht, void *host_priv, int hflags);
2074 #endif /* CONFIG_PCI */
2075
2076 #ifdef CONFIG_ATA_BMDMA
2077
2078 extern const struct ata_port_operations ata_bmdma_port_ops;
2079
2080 #define ATA_BMDMA_SHT(drv_name) \
2081 ATA_BASE_SHT(drv_name), \
2082 .sg_tablesize = LIBATA_MAX_PRD, \
2083 .dma_boundary = ATA_DMA_BOUNDARY
2084
2085 extern enum ata_completion_errors ata_bmdma_qc_prep(struct ata_queued_cmd *qc);
2086 extern unsigned int ata_bmdma_qc_issue(struct ata_queued_cmd *qc);
2087 extern enum ata_completion_errors ata_bmdma_dumb_qc_prep(struct ata_queued_cmd *qc);
2088 extern unsigned int ata_bmdma_port_intr(struct ata_port *ap,
2089 struct ata_queued_cmd *qc);
2090 extern irqreturn_t ata_bmdma_interrupt(int irq, void *dev_instance);
2091 extern void ata_bmdma_error_handler(struct ata_port *ap);
2092 extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
2093 extern void ata_bmdma_irq_clear(struct ata_port *ap);
2094 extern void ata_bmdma_setup(struct ata_queued_cmd *qc);
2095 extern void ata_bmdma_start(struct ata_queued_cmd *qc);
2096 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
2097 extern u8 ata_bmdma_status(struct ata_port *ap);
2098 extern int ata_bmdma_port_start(struct ata_port *ap);
2099 extern int ata_bmdma_port_start32(struct ata_port *ap);
2100
2101 #ifdef CONFIG_PCI
2102 extern int ata_pci_bmdma_clear_simplex(struct pci_dev *pdev);
2103 extern void ata_pci_bmdma_init(struct ata_host *host);
2104 extern int ata_pci_bmdma_prepare_host(struct pci_dev *pdev,
2105 const struct ata_port_info * const * ppi,
2106 struct ata_host **r_host);
2107 extern int ata_pci_bmdma_init_one(struct pci_dev *pdev,
2108 const struct ata_port_info * const * ppi,
2109 const struct scsi_host_template *sht,
2110 void *host_priv, int hflags);
2111 #endif /* CONFIG_PCI */
2112 #endif /* CONFIG_ATA_BMDMA */
2113
2114 /**
2115 * ata_sff_busy_wait - Wait for a port status register
2116 * @ap: Port to wait for.
2117 * @bits: bits that must be clear
2118 * @max: number of 10uS waits to perform
2119 *
2120 * Waits up to max*10 microseconds for the selected bits in the port's
2121 * status register to be cleared.
2122 * Returns final value of status register.
2123 *
2124 * LOCKING:
2125 * Inherited from caller.
2126 */
ata_sff_busy_wait(struct ata_port * ap,unsigned int bits,unsigned int max)2127 static inline u8 ata_sff_busy_wait(struct ata_port *ap, unsigned int bits,
2128 unsigned int max)
2129 {
2130 u8 status;
2131
2132 do {
2133 udelay(10);
2134 status = ap->ops->sff_check_status(ap);
2135 max--;
2136 } while (status != 0xff && (status & bits) && (max > 0));
2137
2138 return status;
2139 }
2140
2141 /**
2142 * ata_wait_idle - Wait for a port to be idle.
2143 * @ap: Port to wait for.
2144 *
2145 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
2146 * Returns final value of status register.
2147 *
2148 * LOCKING:
2149 * Inherited from caller.
2150 */
ata_wait_idle(struct ata_port * ap)2151 static inline u8 ata_wait_idle(struct ata_port *ap)
2152 {
2153 u8 status = ata_sff_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
2154
2155 if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
2156 ata_port_dbg(ap, "abnormal Status 0x%X\n", status);
2157
2158 return status;
2159 }
2160 #else /* CONFIG_ATA_SFF */
sata_sff_hardreset(struct ata_link * link,unsigned int * class,unsigned long deadline)2161 static inline int sata_sff_hardreset(struct ata_link *link, unsigned int *class,
2162 unsigned long deadline)
2163 {
2164 return -EOPNOTSUPP;
2165 }
2166 #endif /* CONFIG_ATA_SFF */
2167
2168 #endif /* __LINUX_LIBATA_H__ */
2169