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