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