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_policy;
549 extern struct device_attribute dev_attr_ncq_prio_supported;
550 extern struct device_attribute dev_attr_ncq_prio_enable;
551 extern struct device_attribute dev_attr_em_message_type;
552 extern struct device_attribute dev_attr_em_message;
553 extern struct device_attribute dev_attr_sw_activity;
554 #endif
555
556 enum sw_activity {
557 OFF,
558 BLINK_ON,
559 BLINK_OFF,
560 };
561
562 struct ata_taskfile {
563 unsigned long flags; /* ATA_TFLAG_xxx */
564 u8 protocol; /* ATA_PROT_xxx */
565
566 u8 ctl; /* control reg */
567
568 u8 hob_feature; /* additional data */
569 u8 hob_nsect; /* to support LBA48 */
570 u8 hob_lbal;
571 u8 hob_lbam;
572 u8 hob_lbah;
573
574 union {
575 u8 error;
576 u8 feature;
577 };
578 u8 nsect;
579 u8 lbal;
580 u8 lbam;
581 u8 lbah;
582
583 u8 device;
584
585 union {
586 u8 status;
587 u8 command;
588 };
589
590 u32 auxiliary; /* auxiliary field */
591 /* from SATA 3.1 and */
592 /* ATA-8 ACS-3 */
593 };
594
595 #ifdef CONFIG_ATA_SFF
596 struct ata_ioports {
597 void __iomem *cmd_addr;
598 void __iomem *data_addr;
599 void __iomem *error_addr;
600 void __iomem *feature_addr;
601 void __iomem *nsect_addr;
602 void __iomem *lbal_addr;
603 void __iomem *lbam_addr;
604 void __iomem *lbah_addr;
605 void __iomem *device_addr;
606 void __iomem *status_addr;
607 void __iomem *command_addr;
608 void __iomem *altstatus_addr;
609 void __iomem *ctl_addr;
610 #ifdef CONFIG_ATA_BMDMA
611 void __iomem *bmdma_addr;
612 #endif /* CONFIG_ATA_BMDMA */
613 void __iomem *scr_addr;
614 };
615 #endif /* CONFIG_ATA_SFF */
616
617 struct ata_host {
618 spinlock_t lock;
619 struct device *dev;
620 void __iomem * const *iomap;
621 unsigned int n_ports;
622 unsigned int n_tags; /* nr of NCQ tags */
623 void *private_data;
624 struct ata_port_operations *ops;
625 unsigned long flags;
626 struct kref kref;
627
628 struct mutex eh_mutex;
629 struct task_struct *eh_owner;
630
631 struct ata_port *simplex_claimed; /* channel owning the DMA */
632 struct ata_port *ports[];
633 };
634
635 struct ata_queued_cmd {
636 struct ata_port *ap;
637 struct ata_device *dev;
638
639 struct scsi_cmnd *scsicmd;
640 void (*scsidone)(struct scsi_cmnd *);
641
642 struct ata_taskfile tf;
643 u8 cdb[ATAPI_CDB_LEN];
644
645 unsigned long flags; /* ATA_QCFLAG_xxx */
646 unsigned int tag; /* libata core tag */
647 unsigned int hw_tag; /* driver tag */
648 unsigned int n_elem;
649 unsigned int orig_n_elem;
650
651 int dma_dir;
652
653 unsigned int sect_size;
654
655 unsigned int nbytes;
656 unsigned int extrabytes;
657 unsigned int curbytes;
658
659 struct scatterlist sgent;
660
661 struct scatterlist *sg;
662
663 struct scatterlist *cursg;
664 unsigned int cursg_ofs;
665
666 unsigned int err_mask;
667 struct ata_taskfile result_tf;
668 ata_qc_cb_t complete_fn;
669
670 void *private_data;
671 void *lldd_task;
672 };
673
674 struct ata_port_stats {
675 unsigned long unhandled_irq;
676 unsigned long idle_irq;
677 unsigned long rw_reqbuf;
678 };
679
680 struct ata_ering_entry {
681 unsigned int eflags;
682 unsigned int err_mask;
683 u64 timestamp;
684 };
685
686 struct ata_ering {
687 int cursor;
688 struct ata_ering_entry ring[ATA_ERING_SIZE];
689 };
690
691 struct ata_cpr {
692 u8 num;
693 u8 num_storage_elements;
694 u64 start_lba;
695 u64 num_lbas;
696 };
697
698 struct ata_cpr_log {
699 u8 nr_cpr;
700 struct ata_cpr cpr[] __counted_by(nr_cpr);
701 };
702
703 struct ata_cdl {
704 /*
705 * Buffer to cache the CDL log page 18h (command duration descriptors)
706 * for SCSI-ATA translation.
707 */
708 u8 desc_log_buf[ATA_LOG_CDL_SIZE];
709
710 /*
711 * Buffer to handle reading the sense data for successful NCQ Commands
712 * log page for commands using a CDL with one of the limits policy set
713 * to 0xD (successful completion with sense data available bit set).
714 */
715 u8 ncq_sense_log_buf[ATA_LOG_SENSE_NCQ_SIZE];
716 };
717
718 struct ata_device {
719 struct ata_link *link;
720 unsigned int devno; /* 0 or 1 */
721 unsigned int quirks; /* List of broken features */
722 unsigned long flags; /* ATA_DFLAG_xxx */
723 struct scsi_device *sdev; /* attached SCSI device */
724 void *private_data;
725 #ifdef CONFIG_ATA_ACPI
726 union acpi_object *gtf_cache;
727 unsigned int gtf_filter;
728 #endif
729 #ifdef CONFIG_SATA_ZPODD
730 void *zpodd;
731 #endif
732 struct device tdev;
733 /* n_sector is CLEAR_BEGIN, read comment above CLEAR_BEGIN */
734 u64 n_sectors; /* size of device, if ATA */
735 u64 n_native_sectors; /* native size, if ATA */
736 unsigned int class; /* ATA_DEV_xxx */
737 unsigned long unpark_deadline;
738
739 u8 pio_mode;
740 u8 dma_mode;
741 u8 xfer_mode;
742 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
743
744 unsigned int multi_count; /* sectors count for
745 READ/WRITE MULTIPLE */
746 unsigned int max_sectors; /* per-device max sectors */
747 unsigned int cdb_len;
748
749 /* per-dev xfer mask */
750 unsigned int pio_mask;
751 unsigned int mwdma_mask;
752 unsigned int udma_mask;
753
754 /* for CHS addressing */
755 u16 cylinders; /* Number of cylinders */
756 u16 heads; /* Number of heads */
757 u16 sectors; /* Number of sectors per track */
758
759 union {
760 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
761 u32 gscr[SATA_PMP_GSCR_DWORDS]; /* PMP GSCR block */
762 } ____cacheline_aligned;
763
764 /* General Purpose Log Directory log page */
765 u8 gp_log_dir[ATA_SECT_SIZE] ____cacheline_aligned;
766
767 /* DEVSLP Timing Variables from Identify Device Data Log */
768 u8 devslp_timing[ATA_LOG_DEVSLP_SIZE];
769
770 /* NCQ send and receive log subcommand support */
771 u8 ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_SIZE];
772 u8 ncq_non_data_cmds[ATA_LOG_NCQ_NON_DATA_SIZE];
773
774 /* ZAC zone configuration */
775 u32 zac_zoned_cap;
776 u32 zac_zones_optimal_open;
777 u32 zac_zones_optimal_nonseq;
778 u32 zac_zones_max_open;
779
780 /* Concurrent positioning ranges */
781 struct ata_cpr_log *cpr_log;
782
783 /* Command Duration Limits support */
784 struct ata_cdl *cdl;
785
786 /* error history */
787 int spdn_cnt;
788 /* ering is CLEAR_END, read comment above CLEAR_END */
789 struct ata_ering ering;
790
791 /* For EH */
792 u8 sector_buf[ATA_SECT_SIZE] ____cacheline_aligned;
793 };
794
795 /* Fields between ATA_DEVICE_CLEAR_BEGIN and ATA_DEVICE_CLEAR_END are
796 * cleared to zero on ata_dev_init().
797 */
798 #define ATA_DEVICE_CLEAR_BEGIN offsetof(struct ata_device, n_sectors)
799 #define ATA_DEVICE_CLEAR_END offsetof(struct ata_device, ering)
800
801 struct ata_eh_info {
802 struct ata_device *dev; /* offending device */
803 u32 serror; /* SError from LLDD */
804 unsigned int err_mask; /* port-wide err_mask */
805 unsigned int action; /* ATA_EH_* action mask */
806 unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */
807 unsigned int flags; /* ATA_EHI_* flags */
808
809 unsigned int probe_mask;
810
811 char desc[ATA_EH_DESC_LEN];
812 int desc_len;
813 };
814
815 struct ata_eh_context {
816 struct ata_eh_info i;
817 int tries[ATA_MAX_DEVICES];
818 int cmd_timeout_idx[ATA_MAX_DEVICES]
819 [ATA_EH_CMD_TIMEOUT_TABLE_SIZE];
820 unsigned int classes[ATA_MAX_DEVICES];
821 unsigned int did_probe_mask;
822 unsigned int unloaded_mask;
823 unsigned int saved_ncq_enabled;
824 u8 saved_xfer_mode[ATA_MAX_DEVICES];
825 /* timestamp for the last reset attempt or success */
826 unsigned long last_reset;
827 };
828
829 struct ata_acpi_drive
830 {
831 u32 pio;
832 u32 dma;
833 } __packed;
834
835 struct ata_acpi_gtm {
836 struct ata_acpi_drive drive[2];
837 u32 flags;
838 } __packed;
839
840 struct ata_link {
841 struct ata_port *ap;
842 int pmp; /* port multiplier port # */
843
844 struct device tdev;
845 unsigned int active_tag; /* active tag on this link */
846 u32 sactive; /* active NCQ commands */
847
848 unsigned int flags; /* ATA_LFLAG_xxx */
849
850 u32 saved_scontrol; /* SControl on probe */
851 unsigned int hw_sata_spd_limit;
852 unsigned int sata_spd_limit;
853 unsigned int sata_spd; /* current SATA PHY speed */
854 enum ata_lpm_policy lpm_policy;
855
856 /* record runtime error info, protected by host_set lock */
857 struct ata_eh_info eh_info;
858 /* EH context */
859 struct ata_eh_context eh_context;
860
861 struct ata_device device[ATA_MAX_DEVICES];
862
863 unsigned long last_lpm_change; /* when last LPM change happened */
864 };
865 #define ATA_LINK_CLEAR_BEGIN offsetof(struct ata_link, active_tag)
866 #define ATA_LINK_CLEAR_END offsetof(struct ata_link, device[0])
867
868 struct ata_port {
869 struct Scsi_Host *scsi_host; /* our co-allocated scsi host */
870 struct ata_port_operations *ops;
871 spinlock_t *lock;
872 /* Flags owned by the EH context. Only EH should touch these once the
873 port is active */
874 unsigned long flags; /* ATA_FLAG_xxx */
875 /* Flags that change dynamically, protected by ap->lock */
876 unsigned int pflags; /* ATA_PFLAG_xxx */
877 unsigned int print_id; /* user visible unique port ID */
878 unsigned int port_no; /* 0 based port no. inside the host */
879
880 #ifdef CONFIG_ATA_SFF
881 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
882 u8 ctl; /* cache of ATA control register */
883 u8 last_ctl; /* Cache last written value */
884 struct ata_link* sff_pio_task_link; /* link currently used */
885 struct delayed_work sff_pio_task;
886 #ifdef CONFIG_ATA_BMDMA
887 struct ata_bmdma_prd *bmdma_prd; /* BMDMA SG list */
888 dma_addr_t bmdma_prd_dma; /* and its DMA mapping */
889 #endif /* CONFIG_ATA_BMDMA */
890 #endif /* CONFIG_ATA_SFF */
891
892 unsigned int pio_mask;
893 unsigned int mwdma_mask;
894 unsigned int udma_mask;
895 unsigned int cbl; /* cable type; ATA_CBL_xxx */
896
897 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE + 1];
898 u64 qc_active;
899 int nr_active_links; /* #links with active qcs */
900
901 struct ata_link link; /* host default link */
902 struct ata_link *slave_link; /* see ata_slave_link_init() */
903
904 int nr_pmp_links; /* nr of available PMP links */
905 struct ata_link *pmp_link; /* array of PMP links */
906 struct ata_link *excl_link; /* for PMP qc exclusion */
907
908 struct ata_port_stats stats;
909 struct ata_host *host;
910 struct device *dev;
911 struct device tdev;
912
913 struct mutex scsi_scan_mutex;
914 struct delayed_work hotplug_task;
915 struct delayed_work scsi_rescan_task;
916
917 unsigned int hsm_task_state;
918
919 struct list_head eh_done_q;
920 wait_queue_head_t eh_wait_q;
921 int eh_tries;
922 struct completion park_req_pending;
923
924 pm_message_t pm_mesg;
925 enum ata_lpm_policy target_lpm_policy;
926
927 struct timer_list fastdrain_timer;
928 unsigned int fastdrain_cnt;
929
930 async_cookie_t cookie;
931
932 int em_message_type;
933 void *private_data;
934
935 #ifdef CONFIG_ATA_ACPI
936 struct ata_acpi_gtm __acpi_init_gtm; /* use ata_acpi_init_gtm() */
937 #endif
938 };
939
940 /* The following initializer overrides a method to NULL whether one of
941 * its parent has the method defined or not. This is equivalent to
942 * ERR_PTR(-ENOENT). Unfortunately, ERR_PTR doesn't render a constant
943 * expression and thus can't be used as an initializer.
944 */
945 #define ATA_OP_NULL (void *)(unsigned long)(-ENOENT)
946
947 struct ata_reset_operations {
948 ata_prereset_fn_t prereset;
949 ata_reset_fn_t softreset;
950 ata_reset_fn_t hardreset;
951 ata_postreset_fn_t postreset;
952 };
953
954 struct ata_port_operations {
955 /*
956 * Command execution
957 */
958 int (*qc_defer)(struct ata_queued_cmd *qc);
959 int (*check_atapi_dma)(struct ata_queued_cmd *qc);
960 enum ata_completion_errors (*qc_prep)(struct ata_queued_cmd *qc);
961 unsigned int (*qc_issue)(struct ata_queued_cmd *qc);
962 void (*qc_fill_rtf)(struct ata_queued_cmd *qc);
963 void (*qc_ncq_fill_rtf)(struct ata_port *ap, u64 done_mask);
964
965 /*
966 * Configuration and exception handling
967 */
968 int (*cable_detect)(struct ata_port *ap);
969 unsigned int (*mode_filter)(struct ata_device *dev, unsigned int xfer_mask);
970 void (*set_piomode)(struct ata_port *ap, struct ata_device *dev);
971 void (*set_dmamode)(struct ata_port *ap, struct ata_device *dev);
972 int (*set_mode)(struct ata_link *link, struct ata_device **r_failed_dev);
973 unsigned int (*read_id)(struct ata_device *dev, struct ata_taskfile *tf,
974 __le16 *id);
975
976 void (*dev_config)(struct ata_device *dev);
977
978 void (*freeze)(struct ata_port *ap);
979 void (*thaw)(struct ata_port *ap);
980 struct ata_reset_operations reset;
981 struct ata_reset_operations pmp_reset;
982 void (*error_handler)(struct ata_port *ap);
983 void (*lost_interrupt)(struct ata_port *ap);
984 void (*post_internal_cmd)(struct ata_queued_cmd *qc);
985 void (*sched_eh)(struct ata_port *ap);
986 void (*end_eh)(struct ata_port *ap);
987
988 /*
989 * Optional features
990 */
991 int (*scr_read)(struct ata_link *link, unsigned int sc_reg, u32 *val);
992 int (*scr_write)(struct ata_link *link, unsigned int sc_reg, u32 val);
993 void (*pmp_attach)(struct ata_port *ap);
994 void (*pmp_detach)(struct ata_port *ap);
995 int (*set_lpm)(struct ata_link *link, enum ata_lpm_policy policy,
996 unsigned hints);
997
998 /*
999 * Start, stop, suspend and resume
1000 */
1001 int (*port_suspend)(struct ata_port *ap, pm_message_t mesg);
1002 int (*port_resume)(struct ata_port *ap);
1003 int (*port_start)(struct ata_port *ap);
1004 void (*port_stop)(struct ata_port *ap);
1005 void (*host_stop)(struct ata_host *host);
1006
1007 #ifdef CONFIG_ATA_SFF
1008 /*
1009 * SFF / taskfile oriented ops
1010 */
1011 void (*sff_dev_select)(struct ata_port *ap, unsigned int device);
1012 void (*sff_set_devctl)(struct ata_port *ap, u8 ctl);
1013 u8 (*sff_check_status)(struct ata_port *ap);
1014 u8 (*sff_check_altstatus)(struct ata_port *ap);
1015 void (*sff_tf_load)(struct ata_port *ap, const struct ata_taskfile *tf);
1016 void (*sff_tf_read)(struct ata_port *ap, struct ata_taskfile *tf);
1017 void (*sff_exec_command)(struct ata_port *ap,
1018 const struct ata_taskfile *tf);
1019 unsigned int (*sff_data_xfer)(struct ata_queued_cmd *qc,
1020 unsigned char *buf, unsigned int buflen, int rw);
1021 void (*sff_irq_on)(struct ata_port *);
1022 bool (*sff_irq_check)(struct ata_port *);
1023 void (*sff_irq_clear)(struct ata_port *);
1024 void (*sff_drain_fifo)(struct ata_queued_cmd *qc);
1025
1026 #ifdef CONFIG_ATA_BMDMA
1027 void (*bmdma_setup)(struct ata_queued_cmd *qc);
1028 void (*bmdma_start)(struct ata_queued_cmd *qc);
1029 void (*bmdma_stop)(struct ata_queued_cmd *qc);
1030 u8 (*bmdma_status)(struct ata_port *ap);
1031 #endif /* CONFIG_ATA_BMDMA */
1032 #endif /* CONFIG_ATA_SFF */
1033
1034 ssize_t (*em_show)(struct ata_port *ap, char *buf);
1035 ssize_t (*em_store)(struct ata_port *ap, const char *message,
1036 size_t size);
1037 ssize_t (*sw_activity_show)(struct ata_device *dev, char *buf);
1038 ssize_t (*sw_activity_store)(struct ata_device *dev,
1039 enum sw_activity val);
1040 ssize_t (*transmit_led_message)(struct ata_port *ap, u32 state,
1041 ssize_t size);
1042
1043 /*
1044 * ->inherits must be the last field and all the preceding
1045 * fields must be pointers.
1046 */
1047 const struct ata_port_operations *inherits;
1048 };
1049
1050 struct ata_port_info {
1051 unsigned long flags;
1052 unsigned long link_flags;
1053 unsigned int pio_mask;
1054 unsigned int mwdma_mask;
1055 unsigned int udma_mask;
1056 struct ata_port_operations *port_ops;
1057 void *private_data;
1058 };
1059
1060 struct ata_timing {
1061 unsigned short mode; /* ATA mode */
1062 unsigned short setup; /* t1 */
1063 unsigned short act8b; /* t2 for 8-bit I/O */
1064 unsigned short rec8b; /* t2i for 8-bit I/O */
1065 unsigned short cyc8b; /* t0 for 8-bit I/O */
1066 unsigned short active; /* t2 or tD */
1067 unsigned short recover; /* t2i or tK */
1068 unsigned short dmack_hold; /* tj */
1069 unsigned short cycle; /* t0 */
1070 unsigned short udma; /* t2CYCTYP/2 */
1071 };
1072
1073 /*
1074 * Core layer - drivers/ata/libata-core.c
1075 */
1076 extern struct ata_port_operations ata_dummy_port_ops;
1077 extern const struct ata_port_info ata_dummy_port_info;
1078
ata_is_atapi(u8 prot)1079 static inline bool ata_is_atapi(u8 prot)
1080 {
1081 return prot & ATA_PROT_FLAG_ATAPI;
1082 }
1083
ata_is_pio(u8 prot)1084 static inline bool ata_is_pio(u8 prot)
1085 {
1086 return prot & ATA_PROT_FLAG_PIO;
1087 }
1088
ata_is_dma(u8 prot)1089 static inline bool ata_is_dma(u8 prot)
1090 {
1091 return prot & ATA_PROT_FLAG_DMA;
1092 }
1093
ata_is_ncq(u8 prot)1094 static inline bool ata_is_ncq(u8 prot)
1095 {
1096 return prot & ATA_PROT_FLAG_NCQ;
1097 }
1098
ata_is_data(u8 prot)1099 static inline bool ata_is_data(u8 prot)
1100 {
1101 return prot & (ATA_PROT_FLAG_PIO | ATA_PROT_FLAG_DMA);
1102 }
1103
is_multi_taskfile(struct ata_taskfile * tf)1104 static inline int is_multi_taskfile(struct ata_taskfile *tf)
1105 {
1106 return (tf->command == ATA_CMD_READ_MULTI) ||
1107 (tf->command == ATA_CMD_WRITE_MULTI) ||
1108 (tf->command == ATA_CMD_READ_MULTI_EXT) ||
1109 (tf->command == ATA_CMD_WRITE_MULTI_EXT) ||
1110 (tf->command == ATA_CMD_WRITE_MULTI_FUA_EXT);
1111 }
1112
ata_port_is_dummy(struct ata_port * ap)1113 static inline int ata_port_is_dummy(struct ata_port *ap)
1114 {
1115 return ap->ops == &ata_dummy_port_ops;
1116 }
1117
ata_port_is_frozen(const struct ata_port * ap)1118 static inline bool ata_port_is_frozen(const struct ata_port *ap)
1119 {
1120 return ap->pflags & ATA_PFLAG_FROZEN;
1121 }
1122
1123 extern int ata_std_prereset(struct ata_link *link, unsigned long deadline);
1124 extern int ata_wait_after_reset(struct ata_link *link, unsigned long deadline,
1125 int (*check_ready)(struct ata_link *link));
1126 extern void ata_std_postreset(struct ata_link *link, unsigned int *classes);
1127
1128 extern struct ata_host *ata_host_alloc(struct device *dev, int n_ports);
1129 extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
1130 const struct ata_port_info * const * ppi, int n_ports);
1131 extern void ata_host_get(struct ata_host *host);
1132 extern void ata_host_put(struct ata_host *host);
1133 extern int ata_host_start(struct ata_host *host);
1134 extern int ata_host_register(struct ata_host *host,
1135 const struct scsi_host_template *sht);
1136 extern int ata_host_activate(struct ata_host *host, int irq,
1137 irq_handler_t irq_handler, unsigned long irq_flags,
1138 const struct scsi_host_template *sht);
1139 extern void ata_host_detach(struct ata_host *host);
1140 extern void ata_host_init(struct ata_host *, struct device *, struct ata_port_operations *);
1141 extern int ata_scsi_ioctl(struct scsi_device *dev, unsigned int cmd,
1142 void __user *arg);
1143 #ifdef CONFIG_COMPAT
1144 #define ATA_SCSI_COMPAT_IOCTL .compat_ioctl = ata_scsi_ioctl,
1145 #else
1146 #define ATA_SCSI_COMPAT_IOCTL /* empty */
1147 #endif
1148 extern int ata_scsi_queuecmd(struct Scsi_Host *h, struct scsi_cmnd *cmd);
1149 #if IS_REACHABLE(CONFIG_ATA)
1150 bool ata_scsi_dma_need_drain(struct request *rq);
1151 #else
1152 #define ata_scsi_dma_need_drain NULL
1153 #endif
1154 extern int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *dev,
1155 unsigned int cmd, void __user *arg);
1156 extern bool ata_link_online(struct ata_link *link);
1157 extern bool ata_link_offline(struct ata_link *link);
1158 #ifdef CONFIG_PM
1159 extern void ata_host_suspend(struct ata_host *host, pm_message_t mesg);
1160 extern void ata_host_resume(struct ata_host *host);
1161 extern void ata_sas_port_suspend(struct ata_port *ap);
1162 extern void ata_sas_port_resume(struct ata_port *ap);
1163 #else
ata_sas_port_suspend(struct ata_port * ap)1164 static inline void ata_sas_port_suspend(struct ata_port *ap)
1165 {
1166 }
ata_sas_port_resume(struct ata_port * ap)1167 static inline void ata_sas_port_resume(struct ata_port *ap)
1168 {
1169 }
1170 #endif
1171 extern int ata_ratelimit(void);
1172 extern void ata_msleep(struct ata_port *ap, unsigned int msecs);
1173 extern u32 ata_wait_register(struct ata_port *ap, void __iomem *reg, u32 mask,
1174 u32 val, unsigned int interval, unsigned int timeout);
1175 extern int atapi_cmd_type(u8 opcode);
1176 extern unsigned int ata_pack_xfermask(unsigned int pio_mask,
1177 unsigned int mwdma_mask,
1178 unsigned int udma_mask);
1179 extern void ata_unpack_xfermask(unsigned int xfer_mask,
1180 unsigned int *pio_mask,
1181 unsigned int *mwdma_mask,
1182 unsigned int *udma_mask);
1183 extern u8 ata_xfer_mask2mode(unsigned int xfer_mask);
1184 extern unsigned int ata_xfer_mode2mask(u8 xfer_mode);
1185 extern int ata_xfer_mode2shift(u8 xfer_mode);
1186 extern const char *ata_mode_string(unsigned int xfer_mask);
1187 extern unsigned int ata_id_xfermask(const u16 *id);
1188 extern int ata_std_qc_defer(struct ata_queued_cmd *qc);
1189 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
1190 unsigned int n_elem);
1191 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
1192 extern unsigned int ata_port_classify(struct ata_port *ap,
1193 const struct ata_taskfile *tf);
1194 extern void ata_dev_disable(struct ata_device *adev);
1195 extern void ata_id_string(const u16 *id, unsigned char *s,
1196 unsigned int ofs, unsigned int len);
1197 extern void ata_id_c_string(const u16 *id, unsigned char *s,
1198 unsigned int ofs, unsigned int len);
1199 extern unsigned int ata_do_dev_read_id(struct ata_device *dev,
1200 struct ata_taskfile *tf, __le16 *id);
1201 extern void ata_qc_complete(struct ata_queued_cmd *qc);
1202 extern u64 ata_qc_get_active(struct ata_port *ap);
1203 extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd);
1204 extern int ata_std_bios_param(struct scsi_device *sdev,
1205 struct block_device *bdev,
1206 sector_t capacity, int geom[]);
1207 extern void ata_scsi_unlock_native_capacity(struct scsi_device *sdev);
1208 extern int ata_scsi_sdev_init(struct scsi_device *sdev);
1209 int ata_scsi_sdev_configure(struct scsi_device *sdev, struct queue_limits *lim);
1210 extern void ata_scsi_sdev_destroy(struct scsi_device *sdev);
1211 extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
1212 int queue_depth);
1213 extern int ata_change_queue_depth(struct ata_port *ap, struct scsi_device *sdev,
1214 int queue_depth);
1215 extern int ata_ncq_prio_supported(struct ata_port *ap, struct scsi_device *sdev,
1216 bool *supported);
1217 extern int ata_ncq_prio_enabled(struct ata_port *ap, struct scsi_device *sdev,
1218 bool *enabled);
1219 extern int ata_ncq_prio_enable(struct ata_port *ap, struct scsi_device *sdev,
1220 bool enable);
1221 extern struct ata_device *ata_dev_pair(struct ata_device *adev);
1222 int ata_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
1223 extern void ata_scsi_port_error_handler(struct Scsi_Host *host, struct ata_port *ap);
1224 extern void ata_scsi_cmd_error_handler(struct Scsi_Host *host, struct ata_port *ap, struct list_head *eh_q);
1225
1226 /*
1227 * SATA specific code - drivers/ata/libata-sata.c
1228 */
1229 #ifdef CONFIG_SATA_HOST
1230 extern const unsigned int sata_deb_timing_normal[];
1231 extern const unsigned int sata_deb_timing_hotplug[];
1232 extern const unsigned int sata_deb_timing_long[];
1233
1234 static inline const unsigned int *
sata_ehc_deb_timing(struct ata_eh_context * ehc)1235 sata_ehc_deb_timing(struct ata_eh_context *ehc)
1236 {
1237 if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
1238 return sata_deb_timing_hotplug;
1239 else
1240 return sata_deb_timing_normal;
1241 }
1242
1243 extern int sata_scr_valid(struct ata_link *link);
1244 extern int sata_scr_read(struct ata_link *link, int reg, u32 *val);
1245 extern int sata_scr_write(struct ata_link *link, int reg, u32 val);
1246 extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val);
1247 extern int sata_set_spd(struct ata_link *link);
1248 int sata_std_hardreset(struct ata_link *link, unsigned int *class,
1249 unsigned long deadline);
1250 extern int sata_link_hardreset(struct ata_link *link,
1251 const unsigned int *timing, unsigned long deadline,
1252 bool *online, int (*check_ready)(struct ata_link *));
1253 extern int sata_link_resume(struct ata_link *link, const unsigned int *params,
1254 unsigned long deadline);
1255 extern void ata_eh_analyze_ncq_error(struct ata_link *link);
1256 #else
1257 static inline const unsigned int *
sata_ehc_deb_timing(struct ata_eh_context * ehc)1258 sata_ehc_deb_timing(struct ata_eh_context *ehc)
1259 {
1260 return NULL;
1261 }
sata_scr_valid(struct ata_link * link)1262 static inline int sata_scr_valid(struct ata_link *link) { return 0; }
sata_scr_read(struct ata_link * link,int reg,u32 * val)1263 static inline int sata_scr_read(struct ata_link *link, int reg, u32 *val)
1264 {
1265 return -EOPNOTSUPP;
1266 }
sata_scr_write(struct ata_link * link,int reg,u32 val)1267 static inline int sata_scr_write(struct ata_link *link, int reg, u32 val)
1268 {
1269 return -EOPNOTSUPP;
1270 }
sata_scr_write_flush(struct ata_link * link,int reg,u32 val)1271 static inline int sata_scr_write_flush(struct ata_link *link, int reg, u32 val)
1272 {
1273 return -EOPNOTSUPP;
1274 }
sata_set_spd(struct ata_link * link)1275 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)1276 static inline int sata_std_hardreset(struct ata_link *link, unsigned int *class,
1277 unsigned long deadline)
1278 {
1279 return -EOPNOTSUPP;
1280 }
sata_link_hardreset(struct ata_link * link,const unsigned int * timing,unsigned long deadline,bool * online,int (* check_ready)(struct ata_link *))1281 static inline int sata_link_hardreset(struct ata_link *link,
1282 const unsigned int *timing,
1283 unsigned long deadline,
1284 bool *online,
1285 int (*check_ready)(struct ata_link *))
1286 {
1287 if (online)
1288 *online = false;
1289 return -EOPNOTSUPP;
1290 }
sata_link_resume(struct ata_link * link,const unsigned int * params,unsigned long deadline)1291 static inline int sata_link_resume(struct ata_link *link,
1292 const unsigned int *params,
1293 unsigned long deadline)
1294 {
1295 return -EOPNOTSUPP;
1296 }
ata_eh_analyze_ncq_error(struct ata_link * link)1297 static inline void ata_eh_analyze_ncq_error(struct ata_link *link) { }
1298 #endif
1299 extern int sata_link_debounce(struct ata_link *link,
1300 const unsigned int *params, unsigned long deadline);
1301 extern int sata_link_scr_lpm(struct ata_link *link, enum ata_lpm_policy policy,
1302 bool spm_wakeup);
1303 extern int ata_slave_link_init(struct ata_port *ap);
1304 extern void ata_port_probe(struct ata_port *ap);
1305 extern struct ata_port *ata_port_alloc(struct ata_host *host);
1306 extern void ata_port_free(struct ata_port *ap);
1307 extern int ata_tport_add(struct device *parent, struct ata_port *ap);
1308 extern void ata_tport_delete(struct ata_port *ap);
1309 int ata_sas_sdev_configure(struct scsi_device *sdev, struct queue_limits *lim,
1310 struct ata_port *ap);
1311 extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, struct ata_port *ap);
1312 extern void ata_tf_to_fis(const struct ata_taskfile *tf,
1313 u8 pmp, int is_cmd, u8 *fis);
1314 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
1315 extern int ata_qc_complete_multiple(struct ata_port *ap, u64 qc_active);
1316 extern bool sata_lpm_ignore_phy_events(struct ata_link *link);
1317 extern int sata_async_notification(struct ata_port *ap);
1318
1319 extern int ata_cable_40wire(struct ata_port *ap);
1320 extern int ata_cable_80wire(struct ata_port *ap);
1321 extern int ata_cable_sata(struct ata_port *ap);
1322 extern int ata_cable_ignore(struct ata_port *ap);
1323 extern int ata_cable_unknown(struct ata_port *ap);
1324
1325 /* Timing helpers */
1326 extern unsigned int ata_pio_need_iordy(const struct ata_device *);
1327 extern u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle);
1328
1329 /* PCI */
1330 #ifdef CONFIG_PCI
1331 struct pci_dev;
1332
1333 struct pci_bits {
1334 unsigned int reg; /* PCI config register to read */
1335 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
1336 unsigned long mask;
1337 unsigned long val;
1338 };
1339
1340 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
1341 extern void ata_pci_shutdown_one(struct pci_dev *pdev);
1342 extern void ata_pci_remove_one(struct pci_dev *pdev);
1343
1344 #ifdef CONFIG_PM
1345 extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
1346 extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
1347 extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
1348 extern int ata_pci_device_resume(struct pci_dev *pdev);
1349 #endif /* CONFIG_PM */
1350 #endif /* CONFIG_PCI */
1351
1352 struct platform_device;
1353
1354 extern void ata_platform_remove_one(struct platform_device *pdev);
1355
1356 /*
1357 * ACPI - drivers/ata/libata-acpi.c
1358 */
1359 #ifdef CONFIG_ATA_ACPI
ata_acpi_init_gtm(struct ata_port * ap)1360 static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1361 {
1362 if (ap->pflags & ATA_PFLAG_INIT_GTM_VALID)
1363 return &ap->__acpi_init_gtm;
1364 return NULL;
1365 }
1366 int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm);
1367 int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *stm);
1368 unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev,
1369 const struct ata_acpi_gtm *gtm);
1370 int ata_acpi_cbl_pata_type(struct ata_port *ap);
1371 #else
ata_acpi_init_gtm(struct ata_port * ap)1372 static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1373 {
1374 return NULL;
1375 }
1376
ata_acpi_stm(const struct ata_port * ap,struct ata_acpi_gtm * stm)1377 static inline int ata_acpi_stm(const struct ata_port *ap,
1378 struct ata_acpi_gtm *stm)
1379 {
1380 return -ENOSYS;
1381 }
1382
ata_acpi_gtm(const struct ata_port * ap,struct ata_acpi_gtm * stm)1383 static inline int ata_acpi_gtm(const struct ata_port *ap,
1384 struct ata_acpi_gtm *stm)
1385 {
1386 return -ENOSYS;
1387 }
1388
ata_acpi_gtm_xfermask(struct ata_device * dev,const struct ata_acpi_gtm * gtm)1389 static inline unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev,
1390 const struct ata_acpi_gtm *gtm)
1391 {
1392 return 0;
1393 }
1394
ata_acpi_cbl_pata_type(struct ata_port * ap)1395 static inline int ata_acpi_cbl_pata_type(struct ata_port *ap)
1396 {
1397 return ATA_CBL_PATA40;
1398 }
1399 #endif
1400
1401 /*
1402 * EH - drivers/ata/libata-eh.c
1403 */
1404 extern void ata_port_schedule_eh(struct ata_port *ap);
1405 extern void ata_port_wait_eh(struct ata_port *ap);
1406 extern int ata_link_abort(struct ata_link *link);
1407 extern int ata_port_abort(struct ata_port *ap);
1408 extern int ata_port_freeze(struct ata_port *ap);
1409
1410 extern void ata_eh_freeze_port(struct ata_port *ap);
1411 extern void ata_eh_thaw_port(struct ata_port *ap);
1412
1413 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
1414 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
1415
1416 extern void ata_std_error_handler(struct ata_port *ap);
1417 extern void ata_std_sched_eh(struct ata_port *ap);
1418 extern void ata_std_end_eh(struct ata_port *ap);
1419 extern int ata_link_nr_enabled(struct ata_link *link);
1420
1421 /*
1422 * Base operations to inherit from and initializers for sht
1423 *
1424 * Operations
1425 *
1426 * base : Common to all libata drivers.
1427 * sata : SATA controllers w/ native interface.
1428 * pmp : SATA controllers w/ PMP support.
1429 * sff : SFF ATA controllers w/o BMDMA support.
1430 * bmdma : SFF ATA controllers w/ BMDMA support.
1431 *
1432 * sht initializers
1433 *
1434 * BASE : Common to all libata drivers. The user must set
1435 * sg_tablesize and dma_boundary.
1436 * PIO : SFF ATA controllers w/ only PIO support.
1437 * BMDMA : SFF ATA controllers w/ BMDMA support. sg_tablesize and
1438 * dma_boundary are set to BMDMA limits.
1439 * NCQ : SATA controllers supporting NCQ. The user must set
1440 * sg_tablesize, dma_boundary and can_queue.
1441 */
1442 extern const struct ata_port_operations ata_base_port_ops;
1443 extern const struct ata_port_operations sata_port_ops;
1444 extern const struct attribute_group *ata_common_sdev_groups[];
1445
1446 /*
1447 * All sht initializers (BASE, PIO, BMDMA, NCQ) must be instantiated
1448 * by the edge drivers. Because the 'module' field of sht must be the
1449 * edge driver's module reference, otherwise the driver can be unloaded
1450 * even if the scsi_device is being accessed.
1451 */
1452 #define __ATA_BASE_SHT(drv_name) \
1453 .module = THIS_MODULE, \
1454 .name = drv_name, \
1455 .ioctl = ata_scsi_ioctl, \
1456 ATA_SCSI_COMPAT_IOCTL \
1457 .queuecommand = ata_scsi_queuecmd, \
1458 .dma_need_drain = ata_scsi_dma_need_drain, \
1459 .this_id = ATA_SHT_THIS_ID, \
1460 .emulated = ATA_SHT_EMULATED, \
1461 .proc_name = drv_name, \
1462 .sdev_init = ata_scsi_sdev_init, \
1463 .sdev_destroy = ata_scsi_sdev_destroy, \
1464 .bios_param = ata_std_bios_param, \
1465 .unlock_native_capacity = ata_scsi_unlock_native_capacity,\
1466 .max_sectors = ATA_MAX_SECTORS_LBA48
1467
1468 #define ATA_SUBBASE_SHT(drv_name) \
1469 __ATA_BASE_SHT(drv_name), \
1470 .can_queue = ATA_DEF_QUEUE, \
1471 .tag_alloc_policy_rr = true, \
1472 .sdev_configure = ata_scsi_sdev_configure
1473
1474 #define ATA_SUBBASE_SHT_QD(drv_name, drv_qd) \
1475 __ATA_BASE_SHT(drv_name), \
1476 .can_queue = drv_qd, \
1477 .tag_alloc_policy_rr = true, \
1478 .sdev_configure = ata_scsi_sdev_configure
1479
1480 #define ATA_BASE_SHT(drv_name) \
1481 ATA_SUBBASE_SHT(drv_name), \
1482 .sdev_groups = ata_common_sdev_groups
1483
1484 #ifdef CONFIG_SATA_HOST
1485 extern const struct attribute_group *ata_ncq_sdev_groups[];
1486
1487 #define ATA_NCQ_SHT(drv_name) \
1488 ATA_SUBBASE_SHT(drv_name), \
1489 .sdev_groups = ata_ncq_sdev_groups, \
1490 .change_queue_depth = ata_scsi_change_queue_depth
1491
1492 #define ATA_NCQ_SHT_QD(drv_name, drv_qd) \
1493 ATA_SUBBASE_SHT_QD(drv_name, drv_qd), \
1494 .sdev_groups = ata_ncq_sdev_groups, \
1495 .change_queue_depth = ata_scsi_change_queue_depth
1496 #endif
1497
1498 /*
1499 * PMP helpers
1500 */
1501 #ifdef CONFIG_SATA_PMP
sata_pmp_supported(struct ata_port * ap)1502 static inline bool sata_pmp_supported(struct ata_port *ap)
1503 {
1504 return ap->flags & ATA_FLAG_PMP;
1505 }
1506
sata_pmp_attached(struct ata_port * ap)1507 static inline bool sata_pmp_attached(struct ata_port *ap)
1508 {
1509 return ap->nr_pmp_links != 0;
1510 }
1511
ata_is_host_link(const struct ata_link * link)1512 static inline bool ata_is_host_link(const struct ata_link *link)
1513 {
1514 return link == &link->ap->link || link == link->ap->slave_link;
1515 }
1516 #else /* CONFIG_SATA_PMP */
sata_pmp_supported(struct ata_port * ap)1517 static inline bool sata_pmp_supported(struct ata_port *ap)
1518 {
1519 return false;
1520 }
1521
sata_pmp_attached(struct ata_port * ap)1522 static inline bool sata_pmp_attached(struct ata_port *ap)
1523 {
1524 return false;
1525 }
1526
ata_is_host_link(const struct ata_link * link)1527 static inline bool ata_is_host_link(const struct ata_link *link)
1528 {
1529 return true;
1530 }
1531 #endif /* CONFIG_SATA_PMP */
1532
sata_srst_pmp(struct ata_link * link)1533 static inline int sata_srst_pmp(struct ata_link *link)
1534 {
1535 if (sata_pmp_supported(link->ap) && ata_is_host_link(link))
1536 return SATA_PMP_CTRL_PORT;
1537 return link->pmp;
1538 }
1539
1540 #define ata_port_printk(level, ap, fmt, ...) \
1541 pr_ ## level ("ata%u: " fmt, (ap)->print_id, ##__VA_ARGS__)
1542
1543 #define ata_port_err(ap, fmt, ...) \
1544 ata_port_printk(err, ap, fmt, ##__VA_ARGS__)
1545 #define ata_port_warn(ap, fmt, ...) \
1546 ata_port_printk(warn, ap, fmt, ##__VA_ARGS__)
1547 #define ata_port_notice(ap, fmt, ...) \
1548 ata_port_printk(notice, ap, fmt, ##__VA_ARGS__)
1549 #define ata_port_info(ap, fmt, ...) \
1550 ata_port_printk(info, ap, fmt, ##__VA_ARGS__)
1551 #define ata_port_dbg(ap, fmt, ...) \
1552 ata_port_printk(debug, ap, fmt, ##__VA_ARGS__)
1553
1554 #define ata_link_printk(level, link, fmt, ...) \
1555 do { \
1556 if (sata_pmp_attached((link)->ap) || \
1557 (link)->ap->slave_link) \
1558 pr_ ## level ("ata%u.%02u: " fmt, \
1559 (link)->ap->print_id, \
1560 (link)->pmp, \
1561 ##__VA_ARGS__); \
1562 else \
1563 pr_ ## level ("ata%u: " fmt, \
1564 (link)->ap->print_id, \
1565 ##__VA_ARGS__); \
1566 } while (0)
1567
1568 #define ata_link_err(link, fmt, ...) \
1569 ata_link_printk(err, link, fmt, ##__VA_ARGS__)
1570 #define ata_link_warn(link, fmt, ...) \
1571 ata_link_printk(warn, link, fmt, ##__VA_ARGS__)
1572 #define ata_link_notice(link, fmt, ...) \
1573 ata_link_printk(notice, link, fmt, ##__VA_ARGS__)
1574 #define ata_link_info(link, fmt, ...) \
1575 ata_link_printk(info, link, fmt, ##__VA_ARGS__)
1576 #define ata_link_dbg(link, fmt, ...) \
1577 ata_link_printk(debug, link, fmt, ##__VA_ARGS__)
1578
1579 #define ata_dev_printk(level, dev, fmt, ...) \
1580 pr_ ## level("ata%u.%02u: " fmt, \
1581 (dev)->link->ap->print_id, \
1582 (dev)->link->pmp + (dev)->devno, \
1583 ##__VA_ARGS__)
1584
1585 #define ata_dev_err(dev, fmt, ...) \
1586 ata_dev_printk(err, dev, fmt, ##__VA_ARGS__)
1587 #define ata_dev_warn(dev, fmt, ...) \
1588 ata_dev_printk(warn, dev, fmt, ##__VA_ARGS__)
1589 #define ata_dev_notice(dev, fmt, ...) \
1590 ata_dev_printk(notice, dev, fmt, ##__VA_ARGS__)
1591 #define ata_dev_info(dev, fmt, ...) \
1592 ata_dev_printk(info, dev, fmt, ##__VA_ARGS__)
1593 #define ata_dev_dbg(dev, fmt, ...) \
1594 ata_dev_printk(debug, dev, fmt, ##__VA_ARGS__)
1595
ata_print_version_once(const struct device * dev,const char * version)1596 static inline void ata_print_version_once(const struct device *dev,
1597 const char *version)
1598 {
1599 dev_dbg_once(dev, "version %s\n", version);
1600 }
1601
1602 /*
1603 * ata_eh_info helpers
1604 */
1605 extern __printf(2, 3)
1606 void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
1607 extern __printf(2, 3)
1608 void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
1609 extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
1610
ata_ehi_hotplugged(struct ata_eh_info * ehi)1611 static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
1612 {
1613 ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
1614 ehi->flags |= ATA_EHI_HOTPLUGGED;
1615 ehi->action |= ATA_EH_RESET | ATA_EH_ENABLE_LINK;
1616 ehi->err_mask |= AC_ERR_ATA_BUS;
1617 }
1618
1619 /*
1620 * port description helpers
1621 */
1622 extern __printf(2, 3)
1623 void ata_port_desc(struct ata_port *ap, const char *fmt, ...);
1624 #ifdef CONFIG_PCI
1625 extern void ata_port_pbar_desc(struct ata_port *ap, int bar, ssize_t offset,
1626 const char *name);
1627 #endif
ata_port_desc_misc(struct ata_port * ap,int irq)1628 static inline void ata_port_desc_misc(struct ata_port *ap, int irq)
1629 {
1630 ata_port_desc(ap, "irq %d", irq);
1631 ata_port_desc(ap, "lpm-pol %d", ap->target_lpm_policy);
1632 if (ap->pflags & ATA_PFLAG_EXTERNAL)
1633 ata_port_desc(ap, "ext");
1634 }
1635
ata_tag_internal(unsigned int tag)1636 static inline bool ata_tag_internal(unsigned int tag)
1637 {
1638 return tag == ATA_TAG_INTERNAL;
1639 }
1640
ata_tag_valid(unsigned int tag)1641 static inline bool ata_tag_valid(unsigned int tag)
1642 {
1643 return tag < ATA_MAX_QUEUE || ata_tag_internal(tag);
1644 }
1645
1646 #define __ata_qc_for_each(ap, qc, tag, max_tag, fn) \
1647 for ((tag) = 0; (tag) < (max_tag) && \
1648 ({ qc = fn((ap), (tag)); 1; }); (tag)++) \
1649
1650 /*
1651 * Internal use only, iterate commands ignoring error handling and
1652 * status of 'qc'.
1653 */
1654 #define ata_qc_for_each_raw(ap, qc, tag) \
1655 __ata_qc_for_each(ap, qc, tag, ATA_MAX_QUEUE, __ata_qc_from_tag)
1656
1657 /*
1658 * Iterate all potential commands that can be queued
1659 */
1660 #define ata_qc_for_each(ap, qc, tag) \
1661 __ata_qc_for_each(ap, qc, tag, ATA_MAX_QUEUE, ata_qc_from_tag)
1662
1663 /*
1664 * Like ata_qc_for_each, but with the internal tag included
1665 */
1666 #define ata_qc_for_each_with_internal(ap, qc, tag) \
1667 __ata_qc_for_each(ap, qc, tag, ATA_MAX_QUEUE + 1, ata_qc_from_tag)
1668
1669 /*
1670 * device helpers
1671 */
ata_class_enabled(unsigned int class)1672 static inline unsigned int ata_class_enabled(unsigned int class)
1673 {
1674 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI ||
1675 class == ATA_DEV_PMP || class == ATA_DEV_SEMB ||
1676 class == ATA_DEV_ZAC;
1677 }
1678
ata_class_disabled(unsigned int class)1679 static inline unsigned int ata_class_disabled(unsigned int class)
1680 {
1681 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP ||
1682 class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP ||
1683 class == ATA_DEV_ZAC_UNSUP;
1684 }
1685
ata_class_absent(unsigned int class)1686 static inline unsigned int ata_class_absent(unsigned int class)
1687 {
1688 return !ata_class_enabled(class) && !ata_class_disabled(class);
1689 }
1690
ata_dev_enabled(const struct ata_device * dev)1691 static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1692 {
1693 return ata_class_enabled(dev->class);
1694 }
1695
ata_dev_disabled(const struct ata_device * dev)1696 static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1697 {
1698 return ata_class_disabled(dev->class);
1699 }
1700
ata_dev_absent(const struct ata_device * dev)1701 static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1702 {
1703 return ata_class_absent(dev->class);
1704 }
1705
1706 /*
1707 * link helpers
1708 */
ata_link_max_devices(const struct ata_link * link)1709 static inline int ata_link_max_devices(const struct ata_link *link)
1710 {
1711 if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS)
1712 return 2;
1713 return 1;
1714 }
1715
ata_link_active(struct ata_link * link)1716 static inline int ata_link_active(struct ata_link *link)
1717 {
1718 return ata_tag_valid(link->active_tag) || link->sactive;
1719 }
1720
1721 /*
1722 * Iterators
1723 *
1724 * ATA_LITER_* constants are used to select link iteration mode and
1725 * ATA_DITER_* device iteration mode.
1726 *
1727 * For a custom iteration directly using ata_{link|dev}_next(), if
1728 * @link or @dev, respectively, is NULL, the first element is
1729 * returned. @dev and @link can be any valid device or link and the
1730 * next element according to the iteration mode will be returned.
1731 * After the last element, NULL is returned.
1732 */
1733 enum ata_link_iter_mode {
1734 ATA_LITER_EDGE, /* if present, PMP links only; otherwise,
1735 * host link. no slave link */
1736 ATA_LITER_HOST_FIRST, /* host link followed by PMP or slave links */
1737 ATA_LITER_PMP_FIRST, /* PMP links followed by host link,
1738 * slave link still comes after host link */
1739 };
1740
1741 enum ata_dev_iter_mode {
1742 ATA_DITER_ENABLED,
1743 ATA_DITER_ENABLED_REVERSE,
1744 ATA_DITER_ALL,
1745 ATA_DITER_ALL_REVERSE,
1746 };
1747
1748 extern struct ata_link *ata_link_next(struct ata_link *link,
1749 struct ata_port *ap,
1750 enum ata_link_iter_mode mode);
1751
1752 extern struct ata_device *ata_dev_next(struct ata_device *dev,
1753 struct ata_link *link,
1754 enum ata_dev_iter_mode mode);
1755
1756 /*
1757 * Shortcut notation for iterations
1758 *
1759 * ata_for_each_link() iterates over each link of @ap according to
1760 * @mode. @link points to the current link in the loop. @link is
1761 * NULL after loop termination. ata_for_each_dev() works the same way
1762 * except that it iterates over each device of @link.
1763 *
1764 * Note that the mode prefixes ATA_{L|D}ITER_ shouldn't need to be
1765 * specified when using the following shorthand notations. Only the
1766 * mode itself (EDGE, HOST_FIRST, ENABLED, etc...) should be
1767 * specified. This not only increases brevity but also makes it
1768 * impossible to use ATA_LITER_* for device iteration or vice-versa.
1769 */
1770 #define ata_for_each_link(link, ap, mode) \
1771 for ((link) = ata_link_next(NULL, (ap), ATA_LITER_##mode); (link); \
1772 (link) = ata_link_next((link), (ap), ATA_LITER_##mode))
1773
1774 #define ata_for_each_dev(dev, link, mode) \
1775 for ((dev) = ata_dev_next(NULL, (link), ATA_DITER_##mode); (dev); \
1776 (dev) = ata_dev_next((dev), (link), ATA_DITER_##mode))
1777
1778 /**
1779 * ata_ncq_supported - Test whether NCQ is supported
1780 * @dev: ATA device to test
1781 *
1782 * LOCKING:
1783 * spin_lock_irqsave(host lock)
1784 *
1785 * RETURNS:
1786 * true if @dev supports NCQ, false otherwise.
1787 */
ata_ncq_supported(struct ata_device * dev)1788 static inline bool ata_ncq_supported(struct ata_device *dev)
1789 {
1790 if (!IS_ENABLED(CONFIG_SATA_HOST))
1791 return false;
1792 return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1793 }
1794
1795 /**
1796 * ata_ncq_enabled - Test whether NCQ is enabled
1797 * @dev: ATA device to test
1798 *
1799 * LOCKING:
1800 * spin_lock_irqsave(host lock)
1801 *
1802 * RETURNS:
1803 * true if NCQ is enabled for @dev, false otherwise.
1804 */
ata_ncq_enabled(struct ata_device * dev)1805 static inline bool ata_ncq_enabled(struct ata_device *dev)
1806 {
1807 return ata_ncq_supported(dev) && !(dev->flags & ATA_DFLAG_NCQ_OFF);
1808 }
1809
ata_fpdma_dsm_supported(struct ata_device * dev)1810 static inline bool ata_fpdma_dsm_supported(struct ata_device *dev)
1811 {
1812 return (dev->flags & ATA_DFLAG_NCQ_SEND_RECV) &&
1813 (dev->ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_DSM_OFFSET] &
1814 ATA_LOG_NCQ_SEND_RECV_DSM_TRIM);
1815 }
1816
ata_fpdma_read_log_supported(struct ata_device * dev)1817 static inline bool ata_fpdma_read_log_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_RD_LOG_OFFSET] &
1821 ATA_LOG_NCQ_SEND_RECV_RD_LOG_SUPPORTED);
1822 }
1823
ata_fpdma_zac_mgmt_in_supported(struct ata_device * dev)1824 static inline bool ata_fpdma_zac_mgmt_in_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_ZAC_MGMT_OFFSET] &
1828 ATA_LOG_NCQ_SEND_RECV_ZAC_MGMT_IN_SUPPORTED);
1829 }
1830
ata_fpdma_zac_mgmt_out_supported(struct ata_device * dev)1831 static inline bool ata_fpdma_zac_mgmt_out_supported(struct ata_device *dev)
1832 {
1833 return (dev->ncq_non_data_cmds[ATA_LOG_NCQ_NON_DATA_ZAC_MGMT_OFFSET] &
1834 ATA_LOG_NCQ_NON_DATA_ZAC_MGMT_OUT);
1835 }
1836
ata_qc_set_polling(struct ata_queued_cmd * qc)1837 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1838 {
1839 qc->tf.ctl |= ATA_NIEN;
1840 }
1841
__ata_qc_from_tag(struct ata_port * ap,unsigned int tag)1842 static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1843 unsigned int tag)
1844 {
1845 if (ata_tag_valid(tag))
1846 return &ap->qcmd[tag];
1847 return NULL;
1848 }
1849
ata_qc_from_tag(struct ata_port * ap,unsigned int tag)1850 static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1851 unsigned int tag)
1852 {
1853 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1854
1855 if (unlikely(!qc))
1856 return qc;
1857
1858 if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1859 ATA_QCFLAG_EH)) == ATA_QCFLAG_ACTIVE)
1860 return qc;
1861
1862 return NULL;
1863 }
1864
ata_qc_raw_nbytes(struct ata_queued_cmd * qc)1865 static inline unsigned int ata_qc_raw_nbytes(struct ata_queued_cmd *qc)
1866 {
1867 return qc->nbytes - min(qc->extrabytes, qc->nbytes);
1868 }
1869
ata_tf_init(struct ata_device * dev,struct ata_taskfile * tf)1870 static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1871 {
1872 memset(tf, 0, sizeof(*tf));
1873
1874 #ifdef CONFIG_ATA_SFF
1875 tf->ctl = dev->link->ap->ctl;
1876 #else
1877 tf->ctl = ATA_DEVCTL_OBS;
1878 #endif
1879 if (dev->devno == 0)
1880 tf->device = ATA_DEVICE_OBS;
1881 else
1882 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1883 }
1884
ata_qc_reinit(struct ata_queued_cmd * qc)1885 static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1886 {
1887 qc->dma_dir = DMA_NONE;
1888 qc->sg = NULL;
1889 qc->flags = 0;
1890 qc->cursg = NULL;
1891 qc->cursg_ofs = 0;
1892 qc->nbytes = qc->extrabytes = qc->curbytes = 0;
1893 qc->n_elem = 0;
1894 qc->err_mask = 0;
1895 qc->sect_size = ATA_SECT_SIZE;
1896
1897 ata_tf_init(qc->dev, &qc->tf);
1898
1899 /* init result_tf such that it indicates normal completion */
1900 qc->result_tf.command = ATA_DRDY;
1901 qc->result_tf.feature = 0;
1902 }
1903
ata_try_flush_cache(const struct ata_device * dev)1904 static inline int ata_try_flush_cache(const struct ata_device *dev)
1905 {
1906 return ata_id_wcache_enabled(dev->id) ||
1907 ata_id_has_flush(dev->id) ||
1908 ata_id_has_flush_ext(dev->id);
1909 }
1910
ac_err_mask(u8 status)1911 static inline unsigned int ac_err_mask(u8 status)
1912 {
1913 if (status & (ATA_BUSY | ATA_DRQ))
1914 return AC_ERR_HSM;
1915 if (status & (ATA_ERR | ATA_DF))
1916 return AC_ERR_DEV;
1917 return 0;
1918 }
1919
__ac_err_mask(u8 status)1920 static inline unsigned int __ac_err_mask(u8 status)
1921 {
1922 unsigned int mask = ac_err_mask(status);
1923 if (mask == 0)
1924 return AC_ERR_OTHER;
1925 return mask;
1926 }
1927
ata_shost_to_port(struct Scsi_Host * host)1928 static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1929 {
1930 return *(struct ata_port **)&host->hostdata[0];
1931 }
1932
ata_check_ready(u8 status)1933 static inline int ata_check_ready(u8 status)
1934 {
1935 if (!(status & ATA_BUSY))
1936 return 1;
1937
1938 /* 0xff indicates either no device or device not ready */
1939 if (status == 0xff)
1940 return -ENODEV;
1941
1942 return 0;
1943 }
1944
ata_deadline(unsigned long from_jiffies,unsigned int timeout_msecs)1945 static inline unsigned long ata_deadline(unsigned long from_jiffies,
1946 unsigned int timeout_msecs)
1947 {
1948 return from_jiffies + msecs_to_jiffies(timeout_msecs);
1949 }
1950
1951 /* Don't open code these in drivers as there are traps. Firstly the range may
1952 change in future hardware and specs, secondly 0xFF means 'no DMA' but is
1953 > UDMA_0. Dyma ddreigiau */
1954
ata_using_mwdma(struct ata_device * adev)1955 static inline bool ata_using_mwdma(struct ata_device *adev)
1956 {
1957 return adev->dma_mode >= XFER_MW_DMA_0 &&
1958 adev->dma_mode <= XFER_MW_DMA_4;
1959 }
1960
ata_using_udma(struct ata_device * adev)1961 static inline bool ata_using_udma(struct ata_device *adev)
1962 {
1963 return adev->dma_mode >= XFER_UDMA_0 &&
1964 adev->dma_mode <= XFER_UDMA_7;
1965 }
1966
ata_dma_enabled(struct ata_device * adev)1967 static inline bool ata_dma_enabled(struct ata_device *adev)
1968 {
1969 return adev->dma_mode != 0xFF;
1970 }
1971
1972 /**************************************************************************
1973 * PATA timings - drivers/ata/libata-pata-timings.c
1974 */
1975 extern const struct ata_timing *ata_timing_find_mode(u8 xfer_mode);
1976 extern int ata_timing_compute(struct ata_device *, unsigned short,
1977 struct ata_timing *, int, int);
1978 extern void ata_timing_merge(const struct ata_timing *,
1979 const struct ata_timing *, struct ata_timing *,
1980 unsigned int);
1981
1982 /**************************************************************************
1983 * PMP - drivers/ata/libata-pmp.c
1984 */
1985 #ifdef CONFIG_SATA_PMP
1986
1987 extern const struct ata_port_operations sata_pmp_port_ops;
1988
1989 extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc);
1990 extern void sata_pmp_error_handler(struct ata_port *ap);
1991
1992 #else /* CONFIG_SATA_PMP */
1993
1994 #define sata_pmp_port_ops sata_port_ops
1995 #define sata_pmp_qc_defer_cmd_switch ata_std_qc_defer
1996 #define sata_pmp_error_handler ata_std_error_handler
1997
1998 #endif /* CONFIG_SATA_PMP */
1999
2000
2001 /**************************************************************************
2002 * SFF - drivers/ata/libata-sff.c
2003 */
2004 #ifdef CONFIG_ATA_SFF
2005
2006 extern const struct ata_port_operations ata_sff_port_ops;
2007 extern const struct ata_port_operations ata_bmdma32_port_ops;
2008
2009 /* PIO only, sg_tablesize and dma_boundary limits can be removed */
2010 #define ATA_PIO_SHT(drv_name) \
2011 ATA_BASE_SHT(drv_name), \
2012 .sg_tablesize = LIBATA_MAX_PRD, \
2013 .dma_boundary = ATA_DMA_BOUNDARY
2014
2015 extern void ata_sff_dev_select(struct ata_port *ap, unsigned int device);
2016 extern u8 ata_sff_check_status(struct ata_port *ap);
2017 extern void ata_sff_pause(struct ata_port *ap);
2018 extern void ata_sff_dma_pause(struct ata_port *ap);
2019 extern int ata_sff_wait_ready(struct ata_link *link, unsigned long deadline);
2020 extern void ata_sff_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
2021 extern void ata_sff_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
2022 extern void ata_sff_exec_command(struct ata_port *ap,
2023 const struct ata_taskfile *tf);
2024 extern unsigned int ata_sff_data_xfer(struct ata_queued_cmd *qc,
2025 unsigned char *buf, unsigned int buflen, int rw);
2026 extern unsigned int ata_sff_data_xfer32(struct ata_queued_cmd *qc,
2027 unsigned char *buf, unsigned int buflen, int rw);
2028 extern void ata_sff_irq_on(struct ata_port *ap);
2029 extern int ata_sff_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
2030 u8 status, int in_wq);
2031 extern void ata_sff_queue_work(struct work_struct *work);
2032 extern void ata_sff_queue_delayed_work(struct delayed_work *dwork,
2033 unsigned long delay);
2034 extern void ata_sff_queue_pio_task(struct ata_link *link, unsigned long delay);
2035 extern unsigned int ata_sff_qc_issue(struct ata_queued_cmd *qc);
2036 extern void ata_sff_qc_fill_rtf(struct ata_queued_cmd *qc);
2037 extern unsigned int ata_sff_port_intr(struct ata_port *ap,
2038 struct ata_queued_cmd *qc);
2039 extern irqreturn_t ata_sff_interrupt(int irq, void *dev_instance);
2040 extern void ata_sff_lost_interrupt(struct ata_port *ap);
2041 extern void ata_sff_freeze(struct ata_port *ap);
2042 extern void ata_sff_thaw(struct ata_port *ap);
2043 extern int ata_sff_prereset(struct ata_link *link, unsigned long deadline);
2044 extern unsigned int ata_sff_dev_classify(struct ata_device *dev, int present,
2045 u8 *r_err);
2046 extern int ata_sff_wait_after_reset(struct ata_link *link, unsigned int devmask,
2047 unsigned long deadline);
2048 extern int ata_sff_softreset(struct ata_link *link, unsigned int *classes,
2049 unsigned long deadline);
2050 extern int sata_sff_hardreset(struct ata_link *link, unsigned int *class,
2051 unsigned long deadline);
2052 extern void ata_sff_postreset(struct ata_link *link, unsigned int *classes);
2053 extern void ata_sff_drain_fifo(struct ata_queued_cmd *qc);
2054 extern void ata_sff_error_handler(struct ata_port *ap);
2055 extern void ata_sff_std_ports(struct ata_ioports *ioaddr);
2056 #ifdef CONFIG_PCI
2057 extern int ata_pci_sff_init_host(struct ata_host *host);
2058 extern int ata_pci_sff_prepare_host(struct pci_dev *pdev,
2059 const struct ata_port_info * const * ppi,
2060 struct ata_host **r_host);
2061 extern int ata_pci_sff_activate_host(struct ata_host *host,
2062 irq_handler_t irq_handler,
2063 const struct scsi_host_template *sht);
2064 extern int ata_pci_sff_init_one(struct pci_dev *pdev,
2065 const struct ata_port_info * const * ppi,
2066 const struct scsi_host_template *sht, void *host_priv, int hflags);
2067 #endif /* CONFIG_PCI */
2068
2069 #ifdef CONFIG_ATA_BMDMA
2070
2071 extern const struct ata_port_operations ata_bmdma_port_ops;
2072
2073 #define ATA_BMDMA_SHT(drv_name) \
2074 ATA_BASE_SHT(drv_name), \
2075 .sg_tablesize = LIBATA_MAX_PRD, \
2076 .dma_boundary = ATA_DMA_BOUNDARY
2077
2078 extern enum ata_completion_errors ata_bmdma_qc_prep(struct ata_queued_cmd *qc);
2079 extern unsigned int ata_bmdma_qc_issue(struct ata_queued_cmd *qc);
2080 extern enum ata_completion_errors ata_bmdma_dumb_qc_prep(struct ata_queued_cmd *qc);
2081 extern unsigned int ata_bmdma_port_intr(struct ata_port *ap,
2082 struct ata_queued_cmd *qc);
2083 extern irqreturn_t ata_bmdma_interrupt(int irq, void *dev_instance);
2084 extern void ata_bmdma_error_handler(struct ata_port *ap);
2085 extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
2086 extern void ata_bmdma_irq_clear(struct ata_port *ap);
2087 extern void ata_bmdma_setup(struct ata_queued_cmd *qc);
2088 extern void ata_bmdma_start(struct ata_queued_cmd *qc);
2089 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
2090 extern u8 ata_bmdma_status(struct ata_port *ap);
2091 extern int ata_bmdma_port_start(struct ata_port *ap);
2092 extern int ata_bmdma_port_start32(struct ata_port *ap);
2093
2094 #ifdef CONFIG_PCI
2095 extern int ata_pci_bmdma_clear_simplex(struct pci_dev *pdev);
2096 extern void ata_pci_bmdma_init(struct ata_host *host);
2097 extern int ata_pci_bmdma_prepare_host(struct pci_dev *pdev,
2098 const struct ata_port_info * const * ppi,
2099 struct ata_host **r_host);
2100 extern int ata_pci_bmdma_init_one(struct pci_dev *pdev,
2101 const struct ata_port_info * const * ppi,
2102 const struct scsi_host_template *sht,
2103 void *host_priv, int hflags);
2104 #endif /* CONFIG_PCI */
2105 #endif /* CONFIG_ATA_BMDMA */
2106
2107 /**
2108 * ata_sff_busy_wait - Wait for a port status register
2109 * @ap: Port to wait for.
2110 * @bits: bits that must be clear
2111 * @max: number of 10uS waits to perform
2112 *
2113 * Waits up to max*10 microseconds for the selected bits in the port's
2114 * status register to be cleared.
2115 * Returns final value of status register.
2116 *
2117 * LOCKING:
2118 * Inherited from caller.
2119 */
ata_sff_busy_wait(struct ata_port * ap,unsigned int bits,unsigned int max)2120 static inline u8 ata_sff_busy_wait(struct ata_port *ap, unsigned int bits,
2121 unsigned int max)
2122 {
2123 u8 status;
2124
2125 do {
2126 udelay(10);
2127 status = ap->ops->sff_check_status(ap);
2128 max--;
2129 } while (status != 0xff && (status & bits) && (max > 0));
2130
2131 return status;
2132 }
2133
2134 /**
2135 * ata_wait_idle - Wait for a port to be idle.
2136 * @ap: Port to wait for.
2137 *
2138 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
2139 * Returns final value of status register.
2140 *
2141 * LOCKING:
2142 * Inherited from caller.
2143 */
ata_wait_idle(struct ata_port * ap)2144 static inline u8 ata_wait_idle(struct ata_port *ap)
2145 {
2146 u8 status = ata_sff_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
2147
2148 if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
2149 ata_port_dbg(ap, "abnormal Status 0x%X\n", status);
2150
2151 return status;
2152 }
2153 #else /* CONFIG_ATA_SFF */
sata_sff_hardreset(struct ata_link * link,unsigned int * class,unsigned long deadline)2154 static inline int sata_sff_hardreset(struct ata_link *link, unsigned int *class,
2155 unsigned long deadline)
2156 {
2157 return -EOPNOTSUPP;
2158 }
2159 #endif /* CONFIG_ATA_SFF */
2160
2161 #endif /* __LINUX_LIBATA_H__ */
2162