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