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