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