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