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