]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blob - include/linux/libata.h
projects / mirror_ubuntu-artful-kernel.git / blob
? search:


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