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