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