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