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