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