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