libata: Add helper to determine when PHY events should be ignored
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / include / linux / libata.h
1 /*
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
90 enum {
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
110 static 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
122 enum {
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_DFLAG_DA = (1 << 26), /* device supports Device Attention */
165 ATA_DFLAG_DEVSLP = (1 << 27), /* device supports Device Sleep */
166 ATA_DFLAG_ACPI_DISABLED = (1 << 28), /* ACPI for the device is disabled */
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_NONE = 9, /* no device */
178
179 /* struct ata_link flags */
180 ATA_LFLAG_NO_HRST = (1 << 1), /* avoid hardreset */
181 ATA_LFLAG_NO_SRST = (1 << 2), /* avoid softreset */
182 ATA_LFLAG_ASSUME_ATA = (1 << 3), /* assume ATA class */
183 ATA_LFLAG_ASSUME_SEMB = (1 << 4), /* assume SEMB class */
184 ATA_LFLAG_ASSUME_CLASS = ATA_LFLAG_ASSUME_ATA | ATA_LFLAG_ASSUME_SEMB,
185 ATA_LFLAG_NO_RETRY = (1 << 5), /* don't retry this link */
186 ATA_LFLAG_DISABLED = (1 << 6), /* link is disabled */
187 ATA_LFLAG_SW_ACTIVITY = (1 << 7), /* keep activity stats */
188 ATA_LFLAG_NO_LPM = (1 << 8), /* disable LPM on this link */
189 ATA_LFLAG_RST_ONCE = (1 << 9), /* limit recovery to one reset */
190
191 /* struct ata_port flags */
192 ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */
193 /* (doesn't imply presence) */
194 ATA_FLAG_SATA = (1 << 1),
195 ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */
196 ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */
197 ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */
198 ATA_FLAG_PIO_POLLING = (1 << 9), /* use polling PIO if LLD
199 * doesn't handle PIO interrupts */
200 ATA_FLAG_NCQ = (1 << 10), /* host supports NCQ */
201 ATA_FLAG_NO_POWEROFF_SPINDOWN = (1 << 11), /* don't spindown before poweroff */
202 ATA_FLAG_NO_HIBERNATE_SPINDOWN = (1 << 12), /* don't spindown before hibernation */
203 ATA_FLAG_DEBUGMSG = (1 << 13),
204 ATA_FLAG_FPDMA_AA = (1 << 14), /* driver supports Auto-Activate */
205 ATA_FLAG_IGN_SIMPLEX = (1 << 15), /* ignore SIMPLEX */
206 ATA_FLAG_NO_IORDY = (1 << 16), /* controller lacks iordy */
207 ATA_FLAG_ACPI_SATA = (1 << 17), /* need native SATA ACPI layout */
208 ATA_FLAG_AN = (1 << 18), /* controller supports AN */
209 ATA_FLAG_PMP = (1 << 19), /* controller supports PMP */
210 ATA_FLAG_EM = (1 << 21), /* driver supports enclosure
211 * management */
212 ATA_FLAG_SW_ACTIVITY = (1 << 22), /* driver supports sw activity
213 * led */
214 ATA_FLAG_NO_DIPM = (1 << 23), /* host not happy with DIPM */
215
216 /* bits 24:31 of ap->flags are reserved for LLD specific flags */
217
218
219 /* struct ata_port pflags */
220 ATA_PFLAG_EH_PENDING = (1 << 0), /* EH pending */
221 ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */
222 ATA_PFLAG_FROZEN = (1 << 2), /* port is frozen */
223 ATA_PFLAG_RECOVERED = (1 << 3), /* recovery action performed */
224 ATA_PFLAG_LOADING = (1 << 4), /* boot/loading probe */
225 ATA_PFLAG_SCSI_HOTPLUG = (1 << 6), /* SCSI hotplug scheduled */
226 ATA_PFLAG_INITIALIZING = (1 << 7), /* being initialized, don't touch */
227 ATA_PFLAG_RESETTING = (1 << 8), /* reset in progress */
228 ATA_PFLAG_UNLOADING = (1 << 9), /* driver is being unloaded */
229 ATA_PFLAG_UNLOADED = (1 << 10), /* driver is unloaded */
230
231 ATA_PFLAG_SUSPENDED = (1 << 17), /* port is suspended (power) */
232 ATA_PFLAG_PM_PENDING = (1 << 18), /* PM operation pending */
233 ATA_PFLAG_INIT_GTM_VALID = (1 << 19), /* initial gtm data valid */
234
235 ATA_PFLAG_PIO32 = (1 << 20), /* 32bit PIO */
236 ATA_PFLAG_PIO32CHANGE = (1 << 21), /* 32bit PIO can be turned on/off */
237
238 /* struct ata_queued_cmd flags */
239 ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */
240 ATA_QCFLAG_DMAMAP = (1 << 1), /* SG table is DMA mapped */
241 ATA_QCFLAG_IO = (1 << 3), /* standard IO command */
242 ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */
243 ATA_QCFLAG_CLEAR_EXCL = (1 << 5), /* clear excl_link on completion */
244 ATA_QCFLAG_QUIET = (1 << 6), /* don't report device error */
245 ATA_QCFLAG_RETRY = (1 << 7), /* retry after failure */
246
247 ATA_QCFLAG_FAILED = (1 << 16), /* cmd failed and is owned by EH */
248 ATA_QCFLAG_SENSE_VALID = (1 << 17), /* sense data valid */
249 ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
250
251 /* host set flags */
252 ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host only */
253 ATA_HOST_STARTED = (1 << 1), /* Host started */
254 ATA_HOST_PARALLEL_SCAN = (1 << 2), /* Ports on this host can be scanned in parallel */
255 ATA_HOST_IGNORE_ATA = (1 << 3), /* Ignore ATA devices on this host. */
256
257 /* bits 24:31 of host->flags are reserved for LLD specific flags */
258
259 /* various lengths of time */
260 ATA_TMOUT_BOOT = 30000, /* heuristic */
261 ATA_TMOUT_BOOT_QUICK = 7000, /* heuristic */
262 ATA_TMOUT_INTERNAL_QUICK = 5000,
263 ATA_TMOUT_MAX_PARK = 30000,
264
265 /*
266 * GoVault needs 2s and iVDR disk HHD424020F7SV00 800ms. 2s
267 * is too much without parallel probing. Use 2s if parallel
268 * probing is available, 800ms otherwise.
269 */
270 ATA_TMOUT_FF_WAIT_LONG = 2000,
271 ATA_TMOUT_FF_WAIT = 800,
272
273 /* Spec mandates to wait for ">= 2ms" before checking status
274 * after reset. We wait 150ms, because that was the magic
275 * delay used for ATAPI devices in Hale Landis's ATADRVR, for
276 * the period of time between when the ATA command register is
277 * written, and then status is checked. Because waiting for
278 * "a while" before checking status is fine, post SRST, we
279 * perform this magic delay here as well.
280 *
281 * Old drivers/ide uses the 2mS rule and then waits for ready.
282 */
283 ATA_WAIT_AFTER_RESET = 150,
284
285 /* If PMP is supported, we have to do follow-up SRST. As some
286 * PMPs don't send D2H Reg FIS after hardreset, LLDs are
287 * advised to wait only for the following duration before
288 * doing SRST.
289 */
290 ATA_TMOUT_PMP_SRST_WAIT = 5000,
291
292 /* ATA bus states */
293 BUS_UNKNOWN = 0,
294 BUS_DMA = 1,
295 BUS_IDLE = 2,
296 BUS_NOINTR = 3,
297 BUS_NODATA = 4,
298 BUS_TIMER = 5,
299 BUS_PIO = 6,
300 BUS_EDD = 7,
301 BUS_IDENTIFY = 8,
302 BUS_PACKET = 9,
303
304 /* SATA port states */
305 PORT_UNKNOWN = 0,
306 PORT_ENABLED = 1,
307 PORT_DISABLED = 2,
308
309 /* encoding various smaller bitmaps into a single
310 * unsigned long bitmap
311 */
312 ATA_NR_PIO_MODES = 7,
313 ATA_NR_MWDMA_MODES = 5,
314 ATA_NR_UDMA_MODES = 8,
315
316 ATA_SHIFT_PIO = 0,
317 ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_NR_PIO_MODES,
318 ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_NR_MWDMA_MODES,
319
320 /* size of buffer to pad xfers ending on unaligned boundaries */
321 ATA_DMA_PAD_SZ = 4,
322
323 /* ering size */
324 ATA_ERING_SIZE = 32,
325
326 /* return values for ->qc_defer */
327 ATA_DEFER_LINK = 1,
328 ATA_DEFER_PORT = 2,
329
330 /* desc_len for ata_eh_info and context */
331 ATA_EH_DESC_LEN = 80,
332
333 /* reset / recovery action types */
334 ATA_EH_REVALIDATE = (1 << 0),
335 ATA_EH_SOFTRESET = (1 << 1), /* meaningful only in ->prereset */
336 ATA_EH_HARDRESET = (1 << 2), /* meaningful only in ->prereset */
337 ATA_EH_RESET = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
338 ATA_EH_ENABLE_LINK = (1 << 3),
339 ATA_EH_PARK = (1 << 5), /* unload heads and stop I/O */
340
341 ATA_EH_PERDEV_MASK = ATA_EH_REVALIDATE | ATA_EH_PARK,
342 ATA_EH_ALL_ACTIONS = ATA_EH_REVALIDATE | ATA_EH_RESET |
343 ATA_EH_ENABLE_LINK,
344
345 /* ata_eh_info->flags */
346 ATA_EHI_HOTPLUGGED = (1 << 0), /* could have been hotplugged */
347 ATA_EHI_NO_AUTOPSY = (1 << 2), /* no autopsy */
348 ATA_EHI_QUIET = (1 << 3), /* be quiet */
349 ATA_EHI_NO_RECOVERY = (1 << 4), /* no recovery */
350
351 ATA_EHI_DID_SOFTRESET = (1 << 16), /* already soft-reset this port */
352 ATA_EHI_DID_HARDRESET = (1 << 17), /* already soft-reset this port */
353 ATA_EHI_PRINTINFO = (1 << 18), /* print configuration info */
354 ATA_EHI_SETMODE = (1 << 19), /* configure transfer mode */
355 ATA_EHI_POST_SETMODE = (1 << 20), /* revalidating after setmode */
356
357 ATA_EHI_DID_RESET = ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
358
359 /* mask of flags to transfer *to* the slave link */
360 ATA_EHI_TO_SLAVE_MASK = ATA_EHI_NO_AUTOPSY | ATA_EHI_QUIET,
361
362 /* max tries if error condition is still set after ->error_handler */
363 ATA_EH_MAX_TRIES = 5,
364
365 /* sometimes resuming a link requires several retries */
366 ATA_LINK_RESUME_TRIES = 5,
367
368 /* how hard are we gonna try to probe/recover devices */
369 ATA_PROBE_MAX_TRIES = 3,
370 ATA_EH_DEV_TRIES = 3,
371 ATA_EH_PMP_TRIES = 5,
372 ATA_EH_PMP_LINK_TRIES = 3,
373
374 SATA_PMP_RW_TIMEOUT = 3000, /* PMP read/write timeout */
375
376 /* This should match the actual table size of
377 * ata_eh_cmd_timeout_table in libata-eh.c.
378 */
379 ATA_EH_CMD_TIMEOUT_TABLE_SIZE = 6,
380
381 /* Horkage types. May be set by libata or controller on drives
382 (some horkage may be drive/controller pair dependent */
383
384 ATA_HORKAGE_DIAGNOSTIC = (1 << 0), /* Failed boot diag */
385 ATA_HORKAGE_NODMA = (1 << 1), /* DMA problems */
386 ATA_HORKAGE_NONCQ = (1 << 2), /* Don't use NCQ */
387 ATA_HORKAGE_MAX_SEC_128 = (1 << 3), /* Limit max sects to 128 */
388 ATA_HORKAGE_BROKEN_HPA = (1 << 4), /* Broken HPA */
389 ATA_HORKAGE_DISABLE = (1 << 5), /* Disable it */
390 ATA_HORKAGE_HPA_SIZE = (1 << 6), /* native size off by one */
391 ATA_HORKAGE_IVB = (1 << 8), /* cbl det validity bit bugs */
392 ATA_HORKAGE_STUCK_ERR = (1 << 9), /* stuck ERR on next PACKET */
393 ATA_HORKAGE_BRIDGE_OK = (1 << 10), /* no bridge limits */
394 ATA_HORKAGE_ATAPI_MOD16_DMA = (1 << 11), /* use ATAPI DMA for commands
395 not multiple of 16 bytes */
396 ATA_HORKAGE_FIRMWARE_WARN = (1 << 12), /* firmware update warning */
397 ATA_HORKAGE_1_5_GBPS = (1 << 13), /* force 1.5 Gbps */
398 ATA_HORKAGE_NOSETXFER = (1 << 14), /* skip SETXFER, SATA only */
399 ATA_HORKAGE_BROKEN_FPDMA_AA = (1 << 15), /* skip AA */
400 ATA_HORKAGE_DUMP_ID = (1 << 16), /* dump IDENTIFY data */
401 ATA_HORKAGE_MAX_SEC_LBA48 = (1 << 17), /* Set max sects to 65535 */
402 ATA_HORKAGE_ATAPI_DMADIR = (1 << 18), /* device requires dmadir */
403 ATA_HORKAGE_NOLPM = (1 << 20), /* don't use LPM */
404 ATA_HORKAGE_WD_BROKEN_LPM = (1 << 21), /* some WDs have broken LPM */
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
449 enum 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
458 enum 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
467 enum 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 */
485 enum ata_lpm_policy {
486 ATA_LPM_UNKNOWN,
487 ATA_LPM_MAX_POWER,
488 ATA_LPM_MED_POWER,
489 ATA_LPM_MIN_POWER,
490 };
491
492 enum 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 */
498 struct scsi_device;
499 struct ata_port_operations;
500 struct ata_port;
501 struct ata_link;
502 struct ata_queued_cmd;
503
504 /* typedefs */
505 typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
506 typedef int (*ata_prereset_fn_t)(struct ata_link *link, unsigned long deadline);
507 typedef int (*ata_reset_fn_t)(struct ata_link *link, unsigned int *classes,
508 unsigned long deadline);
509 typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes);
510
511 extern struct device_attribute dev_attr_link_power_management_policy;
512 extern struct device_attribute dev_attr_unload_heads;
513 extern struct device_attribute dev_attr_em_message_type;
514 extern struct device_attribute dev_attr_em_message;
515 extern struct device_attribute dev_attr_sw_activity;
516
517 enum sw_activity {
518 OFF,
519 BLINK_ON,
520 BLINK_OFF,
521 };
522
523 #ifdef CONFIG_ATA_SFF
524 struct 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
545 struct 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 struct ata_port *simplex_claimed; /* channel owning the DMA */
559 struct ata_port *ports[0];
560 };
561
562 struct ata_queued_cmd {
563 struct ata_port *ap;
564 struct ata_device *dev;
565
566 struct scsi_cmnd *scsicmd;
567 void (*scsidone)(struct scsi_cmnd *);
568
569 struct ata_taskfile tf;
570 u8 cdb[ATAPI_CDB_LEN];
571
572 unsigned long flags; /* ATA_QCFLAG_xxx */
573 unsigned int tag;
574 unsigned int n_elem;
575 unsigned int orig_n_elem;
576
577 int dma_dir;
578
579 unsigned int sect_size;
580
581 unsigned int nbytes;
582 unsigned int extrabytes;
583 unsigned int curbytes;
584
585 struct scatterlist sgent;
586
587 struct scatterlist *sg;
588
589 struct scatterlist *cursg;
590 unsigned int cursg_ofs;
591
592 unsigned int err_mask;
593 struct ata_taskfile result_tf;
594 ata_qc_cb_t complete_fn;
595
596 void *private_data;
597 void *lldd_task;
598 };
599
600 struct ata_port_stats {
601 unsigned long unhandled_irq;
602 unsigned long idle_irq;
603 unsigned long rw_reqbuf;
604 };
605
606 struct ata_ering_entry {
607 unsigned int eflags;
608 unsigned int err_mask;
609 u64 timestamp;
610 };
611
612 struct ata_ering {
613 int cursor;
614 struct ata_ering_entry ring[ATA_ERING_SIZE];
615 };
616
617 struct ata_device {
618 struct ata_link *link;
619 unsigned int devno; /* 0 or 1 */
620 unsigned int horkage; /* List of broken features */
621 unsigned long flags; /* ATA_DFLAG_xxx */
622 struct scsi_device *sdev; /* attached SCSI device */
623 void *private_data;
624 #ifdef CONFIG_ATA_ACPI
625 union acpi_object *gtf_cache;
626 unsigned int gtf_filter;
627 #endif
628 #ifdef CONFIG_SATA_ZPODD
629 void *zpodd;
630 #endif
631 struct device tdev;
632 /* n_sector is CLEAR_BEGIN, read comment above CLEAR_BEGIN */
633 u64 n_sectors; /* size of device, if ATA */
634 u64 n_native_sectors; /* native size, if ATA */
635 unsigned int class; /* ATA_DEV_xxx */
636 unsigned long unpark_deadline;
637
638 u8 pio_mode;
639 u8 dma_mode;
640 u8 xfer_mode;
641 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
642
643 unsigned int multi_count; /* sectors count for
644 READ/WRITE MULTIPLE */
645 unsigned int max_sectors; /* per-device max sectors */
646 unsigned int cdb_len;
647
648 /* per-dev xfer mask */
649 unsigned long pio_mask;
650 unsigned long mwdma_mask;
651 unsigned long udma_mask;
652
653 /* for CHS addressing */
654 u16 cylinders; /* Number of cylinders */
655 u16 heads; /* Number of heads */
656 u16 sectors; /* Number of sectors per track */
657
658 union {
659 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
660 u32 gscr[SATA_PMP_GSCR_DWORDS]; /* PMP GSCR block */
661 };
662
663 /* DEVSLP Timing Variables from Identify Device Data Log */
664 u8 devslp_timing[ATA_LOG_DEVSLP_SIZE];
665
666 /* error history */
667 int spdn_cnt;
668 /* ering is CLEAR_END, read comment above CLEAR_END */
669 struct ata_ering ering;
670 };
671
672 /* Fields between ATA_DEVICE_CLEAR_BEGIN and ATA_DEVICE_CLEAR_END are
673 * cleared to zero on ata_dev_init().
674 */
675 #define ATA_DEVICE_CLEAR_BEGIN offsetof(struct ata_device, n_sectors)
676 #define ATA_DEVICE_CLEAR_END offsetof(struct ata_device, ering)
677
678 struct ata_eh_info {
679 struct ata_device *dev; /* offending device */
680 u32 serror; /* SError from LLDD */
681 unsigned int err_mask; /* port-wide err_mask */
682 unsigned int action; /* ATA_EH_* action mask */
683 unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */
684 unsigned int flags; /* ATA_EHI_* flags */
685
686 unsigned int probe_mask;
687
688 char desc[ATA_EH_DESC_LEN];
689 int desc_len;
690 };
691
692 struct ata_eh_context {
693 struct ata_eh_info i;
694 int tries[ATA_MAX_DEVICES];
695 int cmd_timeout_idx[ATA_MAX_DEVICES]
696 [ATA_EH_CMD_TIMEOUT_TABLE_SIZE];
697 unsigned int classes[ATA_MAX_DEVICES];
698 unsigned int did_probe_mask;
699 unsigned int unloaded_mask;
700 unsigned int saved_ncq_enabled;
701 u8 saved_xfer_mode[ATA_MAX_DEVICES];
702 /* timestamp for the last reset attempt or success */
703 unsigned long last_reset;
704 };
705
706 struct ata_acpi_drive
707 {
708 u32 pio;
709 u32 dma;
710 } __packed;
711
712 struct ata_acpi_gtm {
713 struct ata_acpi_drive drive[2];
714 u32 flags;
715 } __packed;
716
717 struct ata_link {
718 struct ata_port *ap;
719 int pmp; /* port multiplier port # */
720
721 struct device tdev;
722 unsigned int active_tag; /* active tag on this link */
723 u32 sactive; /* active NCQ commands */
724
725 unsigned int flags; /* ATA_LFLAG_xxx */
726
727 u32 saved_scontrol; /* SControl on probe */
728 unsigned int hw_sata_spd_limit;
729 unsigned int sata_spd_limit;
730 unsigned int sata_spd; /* current SATA PHY speed */
731 enum ata_lpm_policy lpm_policy;
732
733 /* record runtime error info, protected by host_set lock */
734 struct ata_eh_info eh_info;
735 /* EH context */
736 struct ata_eh_context eh_context;
737
738 struct ata_device device[ATA_MAX_DEVICES];
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
743 struct 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 struct ata_acpi_gtm __acpi_init_gtm; /* use ata_acpi_init_gtm() */
814 #endif
815 /* owned by EH */
816 u8 sector_buf[ATA_SECT_SIZE] ____cacheline_aligned;
817 };
818
819 /* The following initializer overrides a method to NULL whether one of
820 * its parent has the method defined or not. This is equivalent to
821 * ERR_PTR(-ENOENT). Unfortunately, ERR_PTR doesn't render a constant
822 * expression and thus can't be used as an initializer.
823 */
824 #define ATA_OP_NULL (void *)(unsigned long)(-ENOENT)
825
826 struct ata_port_operations {
827 /*
828 * Command execution
829 */
830 int (*qc_defer)(struct ata_queued_cmd *qc);
831 int (*check_atapi_dma)(struct ata_queued_cmd *qc);
832 void (*qc_prep)(struct ata_queued_cmd *qc);
833 unsigned int (*qc_issue)(struct ata_queued_cmd *qc);
834 bool (*qc_fill_rtf)(struct ata_queued_cmd *qc);
835
836 /*
837 * Configuration and exception handling
838 */
839 int (*cable_detect)(struct ata_port *ap);
840 unsigned long (*mode_filter)(struct ata_device *dev, unsigned long xfer_mask);
841 void (*set_piomode)(struct ata_port *ap, struct ata_device *dev);
842 void (*set_dmamode)(struct ata_port *ap, struct ata_device *dev);
843 int (*set_mode)(struct ata_link *link, struct ata_device **r_failed_dev);
844 unsigned int (*read_id)(struct ata_device *dev, struct ata_taskfile *tf, u16 *id);
845
846 void (*dev_config)(struct ata_device *dev);
847
848 void (*freeze)(struct ata_port *ap);
849 void (*thaw)(struct ata_port *ap);
850 ata_prereset_fn_t prereset;
851 ata_reset_fn_t softreset;
852 ata_reset_fn_t hardreset;
853 ata_postreset_fn_t postreset;
854 ata_prereset_fn_t pmp_prereset;
855 ata_reset_fn_t pmp_softreset;
856 ata_reset_fn_t pmp_hardreset;
857 ata_postreset_fn_t pmp_postreset;
858 void (*error_handler)(struct ata_port *ap);
859 void (*lost_interrupt)(struct ata_port *ap);
860 void (*post_internal_cmd)(struct ata_queued_cmd *qc);
861 void (*sched_eh)(struct ata_port *ap);
862 void (*end_eh)(struct ata_port *ap);
863
864 /*
865 * Optional features
866 */
867 int (*scr_read)(struct ata_link *link, unsigned int sc_reg, u32 *val);
868 int (*scr_write)(struct ata_link *link, unsigned int sc_reg, u32 val);
869 void (*pmp_attach)(struct ata_port *ap);
870 void (*pmp_detach)(struct ata_port *ap);
871 int (*set_lpm)(struct ata_link *link, enum ata_lpm_policy policy,
872 unsigned hints);
873
874 /*
875 * Start, stop, suspend and resume
876 */
877 int (*port_suspend)(struct ata_port *ap, pm_message_t mesg);
878 int (*port_resume)(struct ata_port *ap);
879 int (*port_start)(struct ata_port *ap);
880 void (*port_stop)(struct ata_port *ap);
881 void (*host_stop)(struct ata_host *host);
882
883 #ifdef CONFIG_ATA_SFF
884 /*
885 * SFF / taskfile oriented ops
886 */
887 void (*sff_dev_select)(struct ata_port *ap, unsigned int device);
888 void (*sff_set_devctl)(struct ata_port *ap, u8 ctl);
889 u8 (*sff_check_status)(struct ata_port *ap);
890 u8 (*sff_check_altstatus)(struct ata_port *ap);
891 void (*sff_tf_load)(struct ata_port *ap, const struct ata_taskfile *tf);
892 void (*sff_tf_read)(struct ata_port *ap, struct ata_taskfile *tf);
893 void (*sff_exec_command)(struct ata_port *ap,
894 const struct ata_taskfile *tf);
895 unsigned int (*sff_data_xfer)(struct ata_device *dev,
896 unsigned char *buf, unsigned int buflen, int rw);
897 void (*sff_irq_on)(struct ata_port *);
898 bool (*sff_irq_check)(struct ata_port *);
899 void (*sff_irq_clear)(struct ata_port *);
900 void (*sff_drain_fifo)(struct ata_queued_cmd *qc);
901
902 #ifdef CONFIG_ATA_BMDMA
903 void (*bmdma_setup)(struct ata_queued_cmd *qc);
904 void (*bmdma_start)(struct ata_queued_cmd *qc);
905 void (*bmdma_stop)(struct ata_queued_cmd *qc);
906 u8 (*bmdma_status)(struct ata_port *ap);
907 #endif /* CONFIG_ATA_BMDMA */
908 #endif /* CONFIG_ATA_SFF */
909
910 ssize_t (*em_show)(struct ata_port *ap, char *buf);
911 ssize_t (*em_store)(struct ata_port *ap, const char *message,
912 size_t size);
913 ssize_t (*sw_activity_show)(struct ata_device *dev, char *buf);
914 ssize_t (*sw_activity_store)(struct ata_device *dev,
915 enum sw_activity val);
916 /*
917 * Obsolete
918 */
919 void (*phy_reset)(struct ata_port *ap);
920 void (*eng_timeout)(struct ata_port *ap);
921
922 /*
923 * ->inherits must be the last field and all the preceding
924 * fields must be pointers.
925 */
926 const struct ata_port_operations *inherits;
927 };
928
929 struct ata_port_info {
930 unsigned long flags;
931 unsigned long link_flags;
932 unsigned long pio_mask;
933 unsigned long mwdma_mask;
934 unsigned long udma_mask;
935 struct ata_port_operations *port_ops;
936 void *private_data;
937 };
938
939 struct ata_timing {
940 unsigned short mode; /* ATA mode */
941 unsigned short setup; /* t1 */
942 unsigned short act8b; /* t2 for 8-bit I/O */
943 unsigned short rec8b; /* t2i for 8-bit I/O */
944 unsigned short cyc8b; /* t0 for 8-bit I/O */
945 unsigned short active; /* t2 or tD */
946 unsigned short recover; /* t2i or tK */
947 unsigned short dmack_hold; /* tj */
948 unsigned short cycle; /* t0 */
949 unsigned short udma; /* t2CYCTYP/2 */
950 };
951
952 /*
953 * Core layer - drivers/ata/libata-core.c
954 */
955 extern const unsigned long sata_deb_timing_normal[];
956 extern const unsigned long sata_deb_timing_hotplug[];
957 extern const unsigned long sata_deb_timing_long[];
958
959 extern struct ata_port_operations ata_dummy_port_ops;
960 extern const struct ata_port_info ata_dummy_port_info;
961
962 static inline const unsigned long *
963 sata_ehc_deb_timing(struct ata_eh_context *ehc)
964 {
965 if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
966 return sata_deb_timing_hotplug;
967 else
968 return sata_deb_timing_normal;
969 }
970
971 static inline int ata_port_is_dummy(struct ata_port *ap)
972 {
973 return ap->ops == &ata_dummy_port_ops;
974 }
975
976 extern int sata_set_spd(struct ata_link *link);
977 extern int ata_std_prereset(struct ata_link *link, unsigned long deadline);
978 extern int ata_wait_after_reset(struct ata_link *link, unsigned long deadline,
979 int (*check_ready)(struct ata_link *link));
980 extern int sata_link_debounce(struct ata_link *link,
981 const unsigned long *params, unsigned long deadline);
982 extern int sata_link_resume(struct ata_link *link, const unsigned long *params,
983 unsigned long deadline);
984 extern int sata_link_scr_lpm(struct ata_link *link, enum ata_lpm_policy policy,
985 bool spm_wakeup);
986 extern int sata_link_hardreset(struct ata_link *link,
987 const unsigned long *timing, unsigned long deadline,
988 bool *online, int (*check_ready)(struct ata_link *));
989 extern int sata_std_hardreset(struct ata_link *link, unsigned int *class,
990 unsigned long deadline);
991 extern void ata_std_postreset(struct ata_link *link, unsigned int *classes);
992
993 extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
994 extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
995 const struct ata_port_info * const * ppi, int n_ports);
996 extern int ata_slave_link_init(struct ata_port *ap);
997 extern int ata_host_start(struct ata_host *host);
998 extern int ata_host_register(struct ata_host *host,
999 struct scsi_host_template *sht);
1000 extern int ata_host_activate(struct ata_host *host, int irq,
1001 irq_handler_t irq_handler, unsigned long irq_flags,
1002 struct scsi_host_template *sht);
1003 extern void ata_host_detach(struct ata_host *host);
1004 extern void ata_host_init(struct ata_host *, struct device *, struct ata_port_operations *);
1005 extern int ata_scsi_detect(struct scsi_host_template *sht);
1006 extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
1007 extern int ata_scsi_queuecmd(struct Scsi_Host *h, struct scsi_cmnd *cmd);
1008 extern int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *dev,
1009 int cmd, void __user *arg);
1010 extern void ata_sas_port_destroy(struct ata_port *);
1011 extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
1012 struct ata_port_info *, struct Scsi_Host *);
1013 extern void ata_sas_async_probe(struct ata_port *ap);
1014 extern int ata_sas_sync_probe(struct ata_port *ap);
1015 extern int ata_sas_port_init(struct ata_port *);
1016 extern int ata_sas_port_start(struct ata_port *ap);
1017 extern void ata_sas_port_stop(struct ata_port *ap);
1018 extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
1019 extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, struct ata_port *ap);
1020 extern int sata_scr_valid(struct ata_link *link);
1021 extern int sata_scr_read(struct ata_link *link, int reg, u32 *val);
1022 extern int sata_scr_write(struct ata_link *link, int reg, u32 val);
1023 extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val);
1024 extern bool ata_link_online(struct ata_link *link);
1025 extern bool ata_link_offline(struct ata_link *link);
1026 #ifdef CONFIG_PM
1027 extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
1028 extern void ata_host_resume(struct ata_host *host);
1029 extern int ata_sas_port_async_suspend(struct ata_port *ap, int *async);
1030 extern int ata_sas_port_async_resume(struct ata_port *ap, int *async);
1031 #else
1032 static inline int ata_sas_port_async_suspend(struct ata_port *ap, int *async)
1033 {
1034 return 0;
1035 }
1036 static inline int ata_sas_port_async_resume(struct ata_port *ap, int *async)
1037 {
1038 return 0;
1039 }
1040 #endif
1041 extern int ata_ratelimit(void);
1042 extern void ata_msleep(struct ata_port *ap, unsigned int msecs);
1043 extern u32 ata_wait_register(struct ata_port *ap, void __iomem *reg, u32 mask,
1044 u32 val, unsigned long interval, unsigned long timeout);
1045 extern int atapi_cmd_type(u8 opcode);
1046 extern void ata_tf_to_fis(const struct ata_taskfile *tf,
1047 u8 pmp, int is_cmd, u8 *fis);
1048 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
1049 extern unsigned long ata_pack_xfermask(unsigned long pio_mask,
1050 unsigned long mwdma_mask, unsigned long udma_mask);
1051 extern void ata_unpack_xfermask(unsigned long xfer_mask,
1052 unsigned long *pio_mask, unsigned long *mwdma_mask,
1053 unsigned long *udma_mask);
1054 extern u8 ata_xfer_mask2mode(unsigned long xfer_mask);
1055 extern unsigned long ata_xfer_mode2mask(u8 xfer_mode);
1056 extern int ata_xfer_mode2shift(unsigned long xfer_mode);
1057 extern const char *ata_mode_string(unsigned long xfer_mask);
1058 extern unsigned long ata_id_xfermask(const u16 *id);
1059 extern int ata_std_qc_defer(struct ata_queued_cmd *qc);
1060 extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
1061 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
1062 unsigned int n_elem);
1063 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
1064 extern void ata_dev_disable(struct ata_device *adev);
1065 extern void ata_id_string(const u16 *id, unsigned char *s,
1066 unsigned int ofs, unsigned int len);
1067 extern void ata_id_c_string(const u16 *id, unsigned char *s,
1068 unsigned int ofs, unsigned int len);
1069 extern unsigned int ata_do_dev_read_id(struct ata_device *dev,
1070 struct ata_taskfile *tf, u16 *id);
1071 extern void ata_qc_complete(struct ata_queued_cmd *qc);
1072 extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active);
1073 extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd);
1074 extern int ata_std_bios_param(struct scsi_device *sdev,
1075 struct block_device *bdev,
1076 sector_t capacity, int geom[]);
1077 extern void ata_scsi_unlock_native_capacity(struct scsi_device *sdev);
1078 extern int ata_scsi_slave_config(struct scsi_device *sdev);
1079 extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
1080 extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
1081 int queue_depth, int reason);
1082 extern int __ata_change_queue_depth(struct ata_port *ap, struct scsi_device *sdev,
1083 int queue_depth, int reason);
1084 extern struct ata_device *ata_dev_pair(struct ata_device *adev);
1085 extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
1086 extern void ata_scsi_port_error_handler(struct Scsi_Host *host, struct ata_port *ap);
1087 extern void ata_scsi_cmd_error_handler(struct Scsi_Host *host, struct ata_port *ap, struct list_head *eh_q);
1088 extern bool sata_lpm_ignore_phy_events(struct ata_link *link);
1089
1090 extern int ata_cable_40wire(struct ata_port *ap);
1091 extern int ata_cable_80wire(struct ata_port *ap);
1092 extern int ata_cable_sata(struct ata_port *ap);
1093 extern int ata_cable_ignore(struct ata_port *ap);
1094 extern int ata_cable_unknown(struct ata_port *ap);
1095
1096 /* Timing helpers */
1097 extern unsigned int ata_pio_need_iordy(const struct ata_device *);
1098 extern const struct ata_timing *ata_timing_find_mode(u8 xfer_mode);
1099 extern int ata_timing_compute(struct ata_device *, unsigned short,
1100 struct ata_timing *, int, int);
1101 extern void ata_timing_merge(const struct ata_timing *,
1102 const struct ata_timing *, struct ata_timing *,
1103 unsigned int);
1104 extern u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle);
1105
1106 /* PCI */
1107 #ifdef CONFIG_PCI
1108 struct pci_dev;
1109
1110 struct pci_bits {
1111 unsigned int reg; /* PCI config register to read */
1112 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
1113 unsigned long mask;
1114 unsigned long val;
1115 };
1116
1117 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
1118 extern void ata_pci_remove_one(struct pci_dev *pdev);
1119
1120 #ifdef CONFIG_PM
1121 extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
1122 extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
1123 extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
1124 extern int ata_pci_device_resume(struct pci_dev *pdev);
1125 #endif /* CONFIG_PM */
1126 #endif /* CONFIG_PCI */
1127
1128 struct platform_device;
1129
1130 extern int ata_platform_remove_one(struct platform_device *pdev);
1131
1132 /*
1133 * ACPI - drivers/ata/libata-acpi.c
1134 */
1135 #ifdef CONFIG_ATA_ACPI
1136 static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1137 {
1138 if (ap->pflags & ATA_PFLAG_INIT_GTM_VALID)
1139 return &ap->__acpi_init_gtm;
1140 return NULL;
1141 }
1142 int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm);
1143 int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *stm);
1144 unsigned long ata_acpi_gtm_xfermask(struct ata_device *dev,
1145 const struct ata_acpi_gtm *gtm);
1146 acpi_handle ata_ap_acpi_handle(struct ata_port *ap);
1147 acpi_handle ata_dev_acpi_handle(struct ata_device *dev);
1148 int ata_acpi_cbl_80wire(struct ata_port *ap, const struct ata_acpi_gtm *gtm);
1149 #else
1150 static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1151 {
1152 return NULL;
1153 }
1154
1155 static inline int ata_acpi_stm(const struct ata_port *ap,
1156 struct ata_acpi_gtm *stm)
1157 {
1158 return -ENOSYS;
1159 }
1160
1161 static inline int ata_acpi_gtm(const struct ata_port *ap,
1162 struct ata_acpi_gtm *stm)
1163 {
1164 return -ENOSYS;
1165 }
1166
1167 static inline unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev,
1168 const struct ata_acpi_gtm *gtm)
1169 {
1170 return 0;
1171 }
1172
1173 static inline int ata_acpi_cbl_80wire(struct ata_port *ap,
1174 const struct ata_acpi_gtm *gtm)
1175 {
1176 return 0;
1177 }
1178 #endif
1179
1180 /*
1181 * EH - drivers/ata/libata-eh.c
1182 */
1183 extern void ata_port_schedule_eh(struct ata_port *ap);
1184 extern void ata_port_wait_eh(struct ata_port *ap);
1185 extern int ata_link_abort(struct ata_link *link);
1186 extern int ata_port_abort(struct ata_port *ap);
1187 extern int ata_port_freeze(struct ata_port *ap);
1188 extern int sata_async_notification(struct ata_port *ap);
1189
1190 extern void ata_eh_freeze_port(struct ata_port *ap);
1191 extern void ata_eh_thaw_port(struct ata_port *ap);
1192
1193 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
1194 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
1195 extern void ata_eh_analyze_ncq_error(struct ata_link *link);
1196
1197 extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
1198 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
1199 ata_postreset_fn_t postreset);
1200 extern void ata_std_error_handler(struct ata_port *ap);
1201 extern void ata_std_sched_eh(struct ata_port *ap);
1202 extern void ata_std_end_eh(struct ata_port *ap);
1203 extern int ata_link_nr_enabled(struct ata_link *link);
1204
1205 /*
1206 * Base operations to inherit from and initializers for sht
1207 *
1208 * Operations
1209 *
1210 * base : Common to all libata drivers.
1211 * sata : SATA controllers w/ native interface.
1212 * pmp : SATA controllers w/ PMP support.
1213 * sff : SFF ATA controllers w/o BMDMA support.
1214 * bmdma : SFF ATA controllers w/ BMDMA support.
1215 *
1216 * sht initializers
1217 *
1218 * BASE : Common to all libata drivers. The user must set
1219 * sg_tablesize and dma_boundary.
1220 * PIO : SFF ATA controllers w/ only PIO support.
1221 * BMDMA : SFF ATA controllers w/ BMDMA support. sg_tablesize and
1222 * dma_boundary are set to BMDMA limits.
1223 * NCQ : SATA controllers supporting NCQ. The user must set
1224 * sg_tablesize, dma_boundary and can_queue.
1225 */
1226 extern const struct ata_port_operations ata_base_port_ops;
1227 extern const struct ata_port_operations sata_port_ops;
1228 extern struct device_attribute *ata_common_sdev_attrs[];
1229
1230 #define ATA_BASE_SHT(drv_name) \
1231 .module = THIS_MODULE, \
1232 .name = drv_name, \
1233 .ioctl = ata_scsi_ioctl, \
1234 .queuecommand = ata_scsi_queuecmd, \
1235 .can_queue = ATA_DEF_QUEUE, \
1236 .this_id = ATA_SHT_THIS_ID, \
1237 .cmd_per_lun = ATA_SHT_CMD_PER_LUN, \
1238 .emulated = ATA_SHT_EMULATED, \
1239 .use_clustering = ATA_SHT_USE_CLUSTERING, \
1240 .proc_name = drv_name, \
1241 .slave_configure = ata_scsi_slave_config, \
1242 .slave_destroy = ata_scsi_slave_destroy, \
1243 .bios_param = ata_std_bios_param, \
1244 .unlock_native_capacity = ata_scsi_unlock_native_capacity, \
1245 .sdev_attrs = ata_common_sdev_attrs
1246
1247 #define ATA_NCQ_SHT(drv_name) \
1248 ATA_BASE_SHT(drv_name), \
1249 .change_queue_depth = ata_scsi_change_queue_depth
1250
1251 /*
1252 * PMP helpers
1253 */
1254 #ifdef CONFIG_SATA_PMP
1255 static inline bool sata_pmp_supported(struct ata_port *ap)
1256 {
1257 return ap->flags & ATA_FLAG_PMP;
1258 }
1259
1260 static inline bool sata_pmp_attached(struct ata_port *ap)
1261 {
1262 return ap->nr_pmp_links != 0;
1263 }
1264
1265 static inline int ata_is_host_link(const struct ata_link *link)
1266 {
1267 return link == &link->ap->link || link == link->ap->slave_link;
1268 }
1269 #else /* CONFIG_SATA_PMP */
1270 static inline bool sata_pmp_supported(struct ata_port *ap)
1271 {
1272 return false;
1273 }
1274
1275 static inline bool sata_pmp_attached(struct ata_port *ap)
1276 {
1277 return false;
1278 }
1279
1280 static inline int ata_is_host_link(const struct ata_link *link)
1281 {
1282 return 1;
1283 }
1284 #endif /* CONFIG_SATA_PMP */
1285
1286 static inline int sata_srst_pmp(struct ata_link *link)
1287 {
1288 if (sata_pmp_supported(link->ap) && ata_is_host_link(link))
1289 return SATA_PMP_CTRL_PORT;
1290 return link->pmp;
1291 }
1292
1293 /*
1294 * printk helpers
1295 */
1296 __printf(3, 4)
1297 int ata_port_printk(const struct ata_port *ap, const char *level,
1298 const char *fmt, ...);
1299 __printf(3, 4)
1300 int ata_link_printk(const struct ata_link *link, const char *level,
1301 const char *fmt, ...);
1302 __printf(3, 4)
1303 int ata_dev_printk(const struct ata_device *dev, const char *level,
1304 const char *fmt, ...);
1305
1306 #define ata_port_err(ap, fmt, ...) \
1307 ata_port_printk(ap, KERN_ERR, fmt, ##__VA_ARGS__)
1308 #define ata_port_warn(ap, fmt, ...) \
1309 ata_port_printk(ap, KERN_WARNING, fmt, ##__VA_ARGS__)
1310 #define ata_port_notice(ap, fmt, ...) \
1311 ata_port_printk(ap, KERN_NOTICE, fmt, ##__VA_ARGS__)
1312 #define ata_port_info(ap, fmt, ...) \
1313 ata_port_printk(ap, KERN_INFO, fmt, ##__VA_ARGS__)
1314 #define ata_port_dbg(ap, fmt, ...) \
1315 ata_port_printk(ap, KERN_DEBUG, fmt, ##__VA_ARGS__)
1316
1317 #define ata_link_err(link, fmt, ...) \
1318 ata_link_printk(link, KERN_ERR, fmt, ##__VA_ARGS__)
1319 #define ata_link_warn(link, fmt, ...) \
1320 ata_link_printk(link, KERN_WARNING, fmt, ##__VA_ARGS__)
1321 #define ata_link_notice(link, fmt, ...) \
1322 ata_link_printk(link, KERN_NOTICE, fmt, ##__VA_ARGS__)
1323 #define ata_link_info(link, fmt, ...) \
1324 ata_link_printk(link, KERN_INFO, fmt, ##__VA_ARGS__)
1325 #define ata_link_dbg(link, fmt, ...) \
1326 ata_link_printk(link, KERN_DEBUG, fmt, ##__VA_ARGS__)
1327
1328 #define ata_dev_err(dev, fmt, ...) \
1329 ata_dev_printk(dev, KERN_ERR, fmt, ##__VA_ARGS__)
1330 #define ata_dev_warn(dev, fmt, ...) \
1331 ata_dev_printk(dev, KERN_WARNING, fmt, ##__VA_ARGS__)
1332 #define ata_dev_notice(dev, fmt, ...) \
1333 ata_dev_printk(dev, KERN_NOTICE, fmt, ##__VA_ARGS__)
1334 #define ata_dev_info(dev, fmt, ...) \
1335 ata_dev_printk(dev, KERN_INFO, fmt, ##__VA_ARGS__)
1336 #define ata_dev_dbg(dev, fmt, ...) \
1337 ata_dev_printk(dev, KERN_DEBUG, fmt, ##__VA_ARGS__)
1338
1339 void ata_print_version(const struct device *dev, const char *version);
1340
1341 /*
1342 * ata_eh_info helpers
1343 */
1344 extern __printf(2, 3)
1345 void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
1346 extern __printf(2, 3)
1347 void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
1348 extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
1349
1350 static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
1351 {
1352 ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
1353 ehi->flags |= ATA_EHI_HOTPLUGGED;
1354 ehi->action |= ATA_EH_RESET | ATA_EH_ENABLE_LINK;
1355 ehi->err_mask |= AC_ERR_ATA_BUS;
1356 }
1357
1358 /*
1359 * port description helpers
1360 */
1361 extern __printf(2, 3)
1362 void ata_port_desc(struct ata_port *ap, const char *fmt, ...);
1363 #ifdef CONFIG_PCI
1364 extern void ata_port_pbar_desc(struct ata_port *ap, int bar, ssize_t offset,
1365 const char *name);
1366 #endif
1367
1368 static inline unsigned int ata_tag_valid(unsigned int tag)
1369 {
1370 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
1371 }
1372
1373 static inline unsigned int ata_tag_internal(unsigned int tag)
1374 {
1375 return tag == ATA_TAG_INTERNAL;
1376 }
1377
1378 /*
1379 * device helpers
1380 */
1381 static inline unsigned int ata_class_enabled(unsigned int class)
1382 {
1383 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI ||
1384 class == ATA_DEV_PMP || class == ATA_DEV_SEMB;
1385 }
1386
1387 static inline unsigned int ata_class_disabled(unsigned int class)
1388 {
1389 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP ||
1390 class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP;
1391 }
1392
1393 static inline unsigned int ata_class_absent(unsigned int class)
1394 {
1395 return !ata_class_enabled(class) && !ata_class_disabled(class);
1396 }
1397
1398 static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1399 {
1400 return ata_class_enabled(dev->class);
1401 }
1402
1403 static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1404 {
1405 return ata_class_disabled(dev->class);
1406 }
1407
1408 static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1409 {
1410 return ata_class_absent(dev->class);
1411 }
1412
1413 /*
1414 * link helpers
1415 */
1416 static inline int ata_link_max_devices(const struct ata_link *link)
1417 {
1418 if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS)
1419 return 2;
1420 return 1;
1421 }
1422
1423 static inline int ata_link_active(struct ata_link *link)
1424 {
1425 return ata_tag_valid(link->active_tag) || link->sactive;
1426 }
1427
1428 /*
1429 * Iterators
1430 *
1431 * ATA_LITER_* constants are used to select link iteration mode and
1432 * ATA_DITER_* device iteration mode.
1433 *
1434 * For a custom iteration directly using ata_{link|dev}_next(), if
1435 * @link or @dev, respectively, is NULL, the first element is
1436 * returned. @dev and @link can be any valid device or link and the
1437 * next element according to the iteration mode will be returned.
1438 * After the last element, NULL is returned.
1439 */
1440 enum ata_link_iter_mode {
1441 ATA_LITER_EDGE, /* if present, PMP links only; otherwise,
1442 * host link. no slave link */
1443 ATA_LITER_HOST_FIRST, /* host link followed by PMP or slave links */
1444 ATA_LITER_PMP_FIRST, /* PMP links followed by host link,
1445 * slave link still comes after host link */
1446 };
1447
1448 enum ata_dev_iter_mode {
1449 ATA_DITER_ENABLED,
1450 ATA_DITER_ENABLED_REVERSE,
1451 ATA_DITER_ALL,
1452 ATA_DITER_ALL_REVERSE,
1453 };
1454
1455 extern struct ata_link *ata_link_next(struct ata_link *link,
1456 struct ata_port *ap,
1457 enum ata_link_iter_mode mode);
1458
1459 extern struct ata_device *ata_dev_next(struct ata_device *dev,
1460 struct ata_link *link,
1461 enum ata_dev_iter_mode mode);
1462
1463 /*
1464 * Shortcut notation for iterations
1465 *
1466 * ata_for_each_link() iterates over each link of @ap according to
1467 * @mode. @link points to the current link in the loop. @link is
1468 * NULL after loop termination. ata_for_each_dev() works the same way
1469 * except that it iterates over each device of @link.
1470 *
1471 * Note that the mode prefixes ATA_{L|D}ITER_ shouldn't need to be
1472 * specified when using the following shorthand notations. Only the
1473 * mode itself (EDGE, HOST_FIRST, ENABLED, etc...) should be
1474 * specified. This not only increases brevity but also makes it
1475 * impossible to use ATA_LITER_* for device iteration or vice-versa.
1476 */
1477 #define ata_for_each_link(link, ap, mode) \
1478 for ((link) = ata_link_next(NULL, (ap), ATA_LITER_##mode); (link); \
1479 (link) = ata_link_next((link), (ap), ATA_LITER_##mode))
1480
1481 #define ata_for_each_dev(dev, link, mode) \
1482 for ((dev) = ata_dev_next(NULL, (link), ATA_DITER_##mode); (dev); \
1483 (dev) = ata_dev_next((dev), (link), ATA_DITER_##mode))
1484
1485 /**
1486 * ata_ncq_enabled - Test whether NCQ is enabled
1487 * @dev: ATA device to test for
1488 *
1489 * LOCKING:
1490 * spin_lock_irqsave(host lock)
1491 *
1492 * RETURNS:
1493 * 1 if NCQ is enabled for @dev, 0 otherwise.
1494 */
1495 static inline int ata_ncq_enabled(struct ata_device *dev)
1496 {
1497 return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1498 ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1499 }
1500
1501 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1502 {
1503 qc->tf.ctl |= ATA_NIEN;
1504 }
1505
1506 static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1507 unsigned int tag)
1508 {
1509 if (likely(ata_tag_valid(tag)))
1510 return &ap->qcmd[tag];
1511 return NULL;
1512 }
1513
1514 static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1515 unsigned int tag)
1516 {
1517 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1518
1519 if (unlikely(!qc) || !ap->ops->error_handler)
1520 return qc;
1521
1522 if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1523 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1524 return qc;
1525
1526 return NULL;
1527 }
1528
1529 static inline unsigned int ata_qc_raw_nbytes(struct ata_queued_cmd *qc)
1530 {
1531 return qc->nbytes - min(qc->extrabytes, qc->nbytes);
1532 }
1533
1534 static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1535 {
1536 memset(tf, 0, sizeof(*tf));
1537
1538 #ifdef CONFIG_ATA_SFF
1539 tf->ctl = dev->link->ap->ctl;
1540 #else
1541 tf->ctl = ATA_DEVCTL_OBS;
1542 #endif
1543 if (dev->devno == 0)
1544 tf->device = ATA_DEVICE_OBS;
1545 else
1546 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1547 }
1548
1549 static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1550 {
1551 qc->dma_dir = DMA_NONE;
1552 qc->sg = NULL;
1553 qc->flags = 0;
1554 qc->cursg = NULL;
1555 qc->cursg_ofs = 0;
1556 qc->nbytes = qc->extrabytes = qc->curbytes = 0;
1557 qc->n_elem = 0;
1558 qc->err_mask = 0;
1559 qc->sect_size = ATA_SECT_SIZE;
1560
1561 ata_tf_init(qc->dev, &qc->tf);
1562
1563 /* init result_tf such that it indicates normal completion */
1564 qc->result_tf.command = ATA_DRDY;
1565 qc->result_tf.feature = 0;
1566 }
1567
1568 static inline int ata_try_flush_cache(const struct ata_device *dev)
1569 {
1570 return ata_id_wcache_enabled(dev->id) ||
1571 ata_id_has_flush(dev->id) ||
1572 ata_id_has_flush_ext(dev->id);
1573 }
1574
1575 static inline unsigned int ac_err_mask(u8 status)
1576 {
1577 if (status & (ATA_BUSY | ATA_DRQ))
1578 return AC_ERR_HSM;
1579 if (status & (ATA_ERR | ATA_DF))
1580 return AC_ERR_DEV;
1581 return 0;
1582 }
1583
1584 static inline unsigned int __ac_err_mask(u8 status)
1585 {
1586 unsigned int mask = ac_err_mask(status);
1587 if (mask == 0)
1588 return AC_ERR_OTHER;
1589 return mask;
1590 }
1591
1592 static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1593 {
1594 return *(struct ata_port **)&host->hostdata[0];
1595 }
1596
1597 static inline int ata_check_ready(u8 status)
1598 {
1599 if (!(status & ATA_BUSY))
1600 return 1;
1601
1602 /* 0xff indicates either no device or device not ready */
1603 if (status == 0xff)
1604 return -ENODEV;
1605
1606 return 0;
1607 }
1608
1609 static inline unsigned long ata_deadline(unsigned long from_jiffies,
1610 unsigned long timeout_msecs)
1611 {
1612 return from_jiffies + msecs_to_jiffies(timeout_msecs);
1613 }
1614
1615 /* Don't open code these in drivers as there are traps. Firstly the range may
1616 change in future hardware and specs, secondly 0xFF means 'no DMA' but is
1617 > UDMA_0. Dyma ddreigiau */
1618
1619 static inline int ata_using_mwdma(struct ata_device *adev)
1620 {
1621 if (adev->dma_mode >= XFER_MW_DMA_0 && adev->dma_mode <= XFER_MW_DMA_4)
1622 return 1;
1623 return 0;
1624 }
1625
1626 static inline int ata_using_udma(struct ata_device *adev)
1627 {
1628 if (adev->dma_mode >= XFER_UDMA_0 && adev->dma_mode <= XFER_UDMA_7)
1629 return 1;
1630 return 0;
1631 }
1632
1633 static inline int ata_dma_enabled(struct ata_device *adev)
1634 {
1635 return (adev->dma_mode == 0xFF ? 0 : 1);
1636 }
1637
1638 /**************************************************************************
1639 * PMP - drivers/ata/libata-pmp.c
1640 */
1641 #ifdef CONFIG_SATA_PMP
1642
1643 extern const struct ata_port_operations sata_pmp_port_ops;
1644
1645 extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc);
1646 extern void sata_pmp_error_handler(struct ata_port *ap);
1647
1648 #else /* CONFIG_SATA_PMP */
1649
1650 #define sata_pmp_port_ops sata_port_ops
1651 #define sata_pmp_qc_defer_cmd_switch ata_std_qc_defer
1652 #define sata_pmp_error_handler ata_std_error_handler
1653
1654 #endif /* CONFIG_SATA_PMP */
1655
1656
1657 /**************************************************************************
1658 * SFF - drivers/ata/libata-sff.c
1659 */
1660 #ifdef CONFIG_ATA_SFF
1661
1662 extern const struct ata_port_operations ata_sff_port_ops;
1663 extern const struct ata_port_operations ata_bmdma32_port_ops;
1664
1665 /* PIO only, sg_tablesize and dma_boundary limits can be removed */
1666 #define ATA_PIO_SHT(drv_name) \
1667 ATA_BASE_SHT(drv_name), \
1668 .sg_tablesize = LIBATA_MAX_PRD, \
1669 .dma_boundary = ATA_DMA_BOUNDARY
1670
1671 extern void ata_sff_dev_select(struct ata_port *ap, unsigned int device);
1672 extern u8 ata_sff_check_status(struct ata_port *ap);
1673 extern void ata_sff_pause(struct ata_port *ap);
1674 extern void ata_sff_dma_pause(struct ata_port *ap);
1675 extern int ata_sff_busy_sleep(struct ata_port *ap,
1676 unsigned long timeout_pat, unsigned long timeout);
1677 extern int ata_sff_wait_ready(struct ata_link *link, unsigned long deadline);
1678 extern void ata_sff_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
1679 extern void ata_sff_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
1680 extern void ata_sff_exec_command(struct ata_port *ap,
1681 const struct ata_taskfile *tf);
1682 extern unsigned int ata_sff_data_xfer(struct ata_device *dev,
1683 unsigned char *buf, unsigned int buflen, int rw);
1684 extern unsigned int ata_sff_data_xfer32(struct ata_device *dev,
1685 unsigned char *buf, unsigned int buflen, int rw);
1686 extern unsigned int ata_sff_data_xfer_noirq(struct ata_device *dev,
1687 unsigned char *buf, unsigned int buflen, int rw);
1688 extern void ata_sff_irq_on(struct ata_port *ap);
1689 extern void ata_sff_irq_clear(struct ata_port *ap);
1690 extern int ata_sff_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
1691 u8 status, int in_wq);
1692 extern void ata_sff_queue_work(struct work_struct *work);
1693 extern void ata_sff_queue_delayed_work(struct delayed_work *dwork,
1694 unsigned long delay);
1695 extern void ata_sff_queue_pio_task(struct ata_link *link, unsigned long delay);
1696 extern unsigned int ata_sff_qc_issue(struct ata_queued_cmd *qc);
1697 extern bool ata_sff_qc_fill_rtf(struct ata_queued_cmd *qc);
1698 extern unsigned int ata_sff_port_intr(struct ata_port *ap,
1699 struct ata_queued_cmd *qc);
1700 extern irqreturn_t ata_sff_interrupt(int irq, void *dev_instance);
1701 extern void ata_sff_lost_interrupt(struct ata_port *ap);
1702 extern void ata_sff_freeze(struct ata_port *ap);
1703 extern void ata_sff_thaw(struct ata_port *ap);
1704 extern int ata_sff_prereset(struct ata_link *link, unsigned long deadline);
1705 extern unsigned int ata_sff_dev_classify(struct ata_device *dev, int present,
1706 u8 *r_err);
1707 extern int ata_sff_wait_after_reset(struct ata_link *link, unsigned int devmask,
1708 unsigned long deadline);
1709 extern int ata_sff_softreset(struct ata_link *link, unsigned int *classes,
1710 unsigned long deadline);
1711 extern int sata_sff_hardreset(struct ata_link *link, unsigned int *class,
1712 unsigned long deadline);
1713 extern void ata_sff_postreset(struct ata_link *link, unsigned int *classes);
1714 extern void ata_sff_drain_fifo(struct ata_queued_cmd *qc);
1715 extern void ata_sff_error_handler(struct ata_port *ap);
1716 extern void ata_sff_std_ports(struct ata_ioports *ioaddr);
1717 #ifdef CONFIG_PCI
1718 extern int ata_pci_sff_init_host(struct ata_host *host);
1719 extern int ata_pci_sff_prepare_host(struct pci_dev *pdev,
1720 const struct ata_port_info * const * ppi,
1721 struct ata_host **r_host);
1722 extern int ata_pci_sff_activate_host(struct ata_host *host,
1723 irq_handler_t irq_handler,
1724 struct scsi_host_template *sht);
1725 extern int ata_pci_sff_init_one(struct pci_dev *pdev,
1726 const struct ata_port_info * const * ppi,
1727 struct scsi_host_template *sht, void *host_priv, int hflags);
1728 #endif /* CONFIG_PCI */
1729
1730 #ifdef CONFIG_ATA_BMDMA
1731
1732 extern const struct ata_port_operations ata_bmdma_port_ops;
1733
1734 #define ATA_BMDMA_SHT(drv_name) \
1735 ATA_BASE_SHT(drv_name), \
1736 .sg_tablesize = LIBATA_MAX_PRD, \
1737 .dma_boundary = ATA_DMA_BOUNDARY
1738
1739 extern void ata_bmdma_qc_prep(struct ata_queued_cmd *qc);
1740 extern unsigned int ata_bmdma_qc_issue(struct ata_queued_cmd *qc);
1741 extern void ata_bmdma_dumb_qc_prep(struct ata_queued_cmd *qc);
1742 extern unsigned int ata_bmdma_port_intr(struct ata_port *ap,
1743 struct ata_queued_cmd *qc);
1744 extern irqreturn_t ata_bmdma_interrupt(int irq, void *dev_instance);
1745 extern void ata_bmdma_error_handler(struct ata_port *ap);
1746 extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
1747 extern void ata_bmdma_irq_clear(struct ata_port *ap);
1748 extern void ata_bmdma_setup(struct ata_queued_cmd *qc);
1749 extern void ata_bmdma_start(struct ata_queued_cmd *qc);
1750 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
1751 extern u8 ata_bmdma_status(struct ata_port *ap);
1752 extern int ata_bmdma_port_start(struct ata_port *ap);
1753 extern int ata_bmdma_port_start32(struct ata_port *ap);
1754
1755 #ifdef CONFIG_PCI
1756 extern int ata_pci_bmdma_clear_simplex(struct pci_dev *pdev);
1757 extern void ata_pci_bmdma_init(struct ata_host *host);
1758 extern int ata_pci_bmdma_prepare_host(struct pci_dev *pdev,
1759 const struct ata_port_info * const * ppi,
1760 struct ata_host **r_host);
1761 extern int ata_pci_bmdma_init_one(struct pci_dev *pdev,
1762 const struct ata_port_info * const * ppi,
1763 struct scsi_host_template *sht,
1764 void *host_priv, int hflags);
1765 #endif /* CONFIG_PCI */
1766 #endif /* CONFIG_ATA_BMDMA */
1767
1768 /**
1769 * ata_sff_busy_wait - Wait for a port status register
1770 * @ap: Port to wait for.
1771 * @bits: bits that must be clear
1772 * @max: number of 10uS waits to perform
1773 *
1774 * Waits up to max*10 microseconds for the selected bits in the port's
1775 * status register to be cleared.
1776 * Returns final value of status register.
1777 *
1778 * LOCKING:
1779 * Inherited from caller.
1780 */
1781 static inline u8 ata_sff_busy_wait(struct ata_port *ap, unsigned int bits,
1782 unsigned int max)
1783 {
1784 u8 status;
1785
1786 do {
1787 udelay(10);
1788 status = ap->ops->sff_check_status(ap);
1789 max--;
1790 } while (status != 0xff && (status & bits) && (max > 0));
1791
1792 return status;
1793 }
1794
1795 /**
1796 * ata_wait_idle - Wait for a port to be idle.
1797 * @ap: Port to wait for.
1798 *
1799 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
1800 * Returns final value of status register.
1801 *
1802 * LOCKING:
1803 * Inherited from caller.
1804 */
1805 static inline u8 ata_wait_idle(struct ata_port *ap)
1806 {
1807 u8 status = ata_sff_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1808
1809 #ifdef ATA_DEBUG
1810 if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
1811 ata_port_printk(ap, KERN_DEBUG, "abnormal Status 0x%X\n",
1812 status);
1813 #endif
1814
1815 return status;
1816 }
1817 #endif /* CONFIG_ATA_SFF */
1818
1819 #endif /* __LINUX_LIBATA_H__ */