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