]> git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blob - include/linux/libata.h
projects / mirror_ubuntu-zesty-kernel.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
libata: clear SError after link resume
[mirror_ubuntu-zesty-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/interrupt.h>
31 #include <linux/dma-mapping.h>
32 #include <linux/scatterlist.h>
33 #include <linux/io.h>
34 #include <linux/ata.h>
35 #include <linux/workqueue.h>
36 #include <scsi/scsi_host.h>
37 #include <linux/acpi.h>
38 #include <linux/cdrom.h>
39
40 /*
41 * Define if arch has non-standard setup. This is a _PCI_ standard
42 * not a legacy or ISA standard.
43 */
44 #ifdef CONFIG_ATA_NONSTANDARD
45 #include <asm/libata-portmap.h>
46 #else
47 #include <asm-generic/libata-portmap.h>
48 #endif
49
50 /*
51 * compile-time options: to be removed as soon as all the drivers are
52 * converted to the new debugging mechanism
53 */
54 #undef ATA_DEBUG /* debugging output */
55 #undef ATA_VERBOSE_DEBUG /* yet more debugging output */
56 #undef ATA_IRQ_TRAP /* define to ack screaming irqs */
57 #undef ATA_NDEBUG /* define to disable quick runtime checks */
58
59
60 /* note: prints function name for you */
61 #ifdef ATA_DEBUG
62 #define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
63 #ifdef ATA_VERBOSE_DEBUG
64 #define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
65 #else
66 #define VPRINTK(fmt, args...)
67 #endif /* ATA_VERBOSE_DEBUG */
68 #else
69 #define DPRINTK(fmt, args...)
70 #define VPRINTK(fmt, args...)
71 #endif /* ATA_DEBUG */
72
73 #define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
74
75 /* NEW: debug levels */
76 #define HAVE_LIBATA_MSG 1
77
78 enum {
79 ATA_MSG_DRV = 0x0001,
80 ATA_MSG_INFO = 0x0002,
81 ATA_MSG_PROBE = 0x0004,
82 ATA_MSG_WARN = 0x0008,
83 ATA_MSG_MALLOC = 0x0010,
84 ATA_MSG_CTL = 0x0020,
85 ATA_MSG_INTR = 0x0040,
86 ATA_MSG_ERR = 0x0080,
87 };
88
89 #define ata_msg_drv(p) ((p)->msg_enable & ATA_MSG_DRV)
90 #define ata_msg_info(p) ((p)->msg_enable & ATA_MSG_INFO)
91 #define ata_msg_probe(p) ((p)->msg_enable & ATA_MSG_PROBE)
92 #define ata_msg_warn(p) ((p)->msg_enable & ATA_MSG_WARN)
93 #define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC)
94 #define ata_msg_ctl(p) ((p)->msg_enable & ATA_MSG_CTL)
95 #define ata_msg_intr(p) ((p)->msg_enable & ATA_MSG_INTR)
96 #define ata_msg_err(p) ((p)->msg_enable & ATA_MSG_ERR)
97
98 static inline u32 ata_msg_init(int dval, int default_msg_enable_bits)
99 {
100 if (dval < 0 || dval >= (sizeof(u32) * 8))
101 return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */
102 if (!dval)
103 return 0;
104 return (1 << dval) - 1;
105 }
106
107 /* defines only for the constants which don't work well as enums */
108 #define ATA_TAG_POISON 0xfafbfcfdU
109
110 enum {
111 /* various global constants */
112 LIBATA_MAX_PRD = ATA_MAX_PRD / 2,
113 LIBATA_DUMB_MAX_PRD = ATA_MAX_PRD / 4, /* Worst case */
114 ATA_MAX_PORTS = 8,
115 ATA_DEF_QUEUE = 1,
116 /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
117 ATA_MAX_QUEUE = 32,
118 ATA_TAG_INTERNAL = ATA_MAX_QUEUE - 1,
119 ATA_MAX_BUS = 2,
120 ATA_DEF_BUSY_WAIT = 10000,
121 ATA_SHORT_PAUSE = (HZ >> 6) + 1,
122
123 ATAPI_MAX_DRAIN = 16 << 10,
124
125 ATA_ALL_DEVICES = (1 << ATA_MAX_DEVICES) - 1,
126
127 ATA_SHT_EMULATED = 1,
128 ATA_SHT_CMD_PER_LUN = 1,
129 ATA_SHT_THIS_ID = -1,
130 ATA_SHT_USE_CLUSTERING = 1,
131
132 /* struct ata_device stuff */
133 ATA_DFLAG_LBA = (1 << 0), /* device supports LBA */
134 ATA_DFLAG_LBA48 = (1 << 1), /* device supports LBA48 */
135 ATA_DFLAG_CDB_INTR = (1 << 2), /* device asserts INTRQ when ready for CDB */
136 ATA_DFLAG_NCQ = (1 << 3), /* device supports NCQ */
137 ATA_DFLAG_FLUSH_EXT = (1 << 4), /* do FLUSH_EXT instead of FLUSH */
138 ATA_DFLAG_ACPI_PENDING = (1 << 5), /* ACPI resume action pending */
139 ATA_DFLAG_ACPI_FAILED = (1 << 6), /* ACPI on devcfg has failed */
140 ATA_DFLAG_AN = (1 << 7), /* AN configured */
141 ATA_DFLAG_HIPM = (1 << 8), /* device supports HIPM */
142 ATA_DFLAG_DIPM = (1 << 9), /* device supports DIPM */
143 ATA_DFLAG_DMADIR = (1 << 10), /* device requires DMADIR */
144 ATA_DFLAG_CFG_MASK = (1 << 12) - 1,
145
146 ATA_DFLAG_PIO = (1 << 12), /* device limited to PIO mode */
147 ATA_DFLAG_NCQ_OFF = (1 << 13), /* device limited to non-NCQ mode */
148 ATA_DFLAG_SPUNDOWN = (1 << 14), /* XXX: for spindown_compat */
149 ATA_DFLAG_SLEEPING = (1 << 15), /* device is sleeping */
150 ATA_DFLAG_DUBIOUS_XFER = (1 << 16), /* data transfer not verified */
151 ATA_DFLAG_INIT_MASK = (1 << 24) - 1,
152
153 ATA_DFLAG_DETACH = (1 << 24),
154 ATA_DFLAG_DETACHED = (1 << 25),
155
156 ATA_DEV_UNKNOWN = 0, /* unknown device */
157 ATA_DEV_ATA = 1, /* ATA device */
158 ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */
159 ATA_DEV_ATAPI = 3, /* ATAPI device */
160 ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */
161 ATA_DEV_PMP = 5, /* SATA port multiplier */
162 ATA_DEV_PMP_UNSUP = 6, /* SATA port multiplier (unsupported) */
163 ATA_DEV_SEMB = 7, /* SEMB */
164 ATA_DEV_SEMB_UNSUP = 8, /* SEMB (unsupported) */
165 ATA_DEV_NONE = 9, /* no device */
166
167 /* struct ata_link flags */
168 ATA_LFLAG_NO_SRST = (1 << 2), /* avoid softreset */
169 ATA_LFLAG_ASSUME_ATA = (1 << 3), /* assume ATA class */
170 ATA_LFLAG_ASSUME_SEMB = (1 << 4), /* assume SEMB class */
171 ATA_LFLAG_ASSUME_CLASS = ATA_LFLAG_ASSUME_ATA | ATA_LFLAG_ASSUME_SEMB,
172 ATA_LFLAG_NO_RETRY = (1 << 5), /* don't retry this link */
173 ATA_LFLAG_DISABLED = (1 << 6), /* link is disabled */
174
175 /* struct ata_port flags */
176 ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */
177 /* (doesn't imply presence) */
178 ATA_FLAG_SATA = (1 << 1),
179 ATA_FLAG_NO_LEGACY = (1 << 2), /* no legacy mode check */
180 ATA_FLAG_MMIO = (1 << 3), /* use MMIO, not PIO */
181 ATA_FLAG_SRST = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */
182 ATA_FLAG_SATA_RESET = (1 << 5), /* (obsolete) use COMRESET */
183 ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */
184 ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */
185 ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */
186 ATA_FLAG_PIO_POLLING = (1 << 9), /* use polling PIO if LLD
187 * doesn't handle PIO interrupts */
188 ATA_FLAG_NCQ = (1 << 10), /* host supports NCQ */
189 ATA_FLAG_DEBUGMSG = (1 << 13),
190 ATA_FLAG_IGN_SIMPLEX = (1 << 15), /* ignore SIMPLEX */
191 ATA_FLAG_NO_IORDY = (1 << 16), /* controller lacks iordy */
192 ATA_FLAG_ACPI_SATA = (1 << 17), /* need native SATA ACPI layout */
193 ATA_FLAG_AN = (1 << 18), /* controller supports AN */
194 ATA_FLAG_PMP = (1 << 19), /* controller supports PMP */
195 ATA_FLAG_IPM = (1 << 20), /* driver can handle IPM */
196
197 /* The following flag belongs to ap->pflags but is kept in
198 * ap->flags because it's referenced in many LLDs and will be
199 * removed in not-too-distant future.
200 */
201 ATA_FLAG_DISABLED = (1 << 23), /* port is disabled, ignore it */
202
203 /* bits 24:31 of ap->flags are reserved for LLD specific flags */
204
205 /* struct ata_port pflags */
206 ATA_PFLAG_EH_PENDING = (1 << 0), /* EH pending */
207 ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */
208 ATA_PFLAG_FROZEN = (1 << 2), /* port is frozen */
209 ATA_PFLAG_RECOVERED = (1 << 3), /* recovery action performed */
210 ATA_PFLAG_LOADING = (1 << 4), /* boot/loading probe */
211 ATA_PFLAG_UNLOADING = (1 << 5), /* module is unloading */
212 ATA_PFLAG_SCSI_HOTPLUG = (1 << 6), /* SCSI hotplug scheduled */
213 ATA_PFLAG_INITIALIZING = (1 << 7), /* being initialized, don't touch */
214 ATA_PFLAG_RESETTING = (1 << 8), /* reset in progress */
215
216 ATA_PFLAG_SUSPENDED = (1 << 17), /* port is suspended (power) */
217 ATA_PFLAG_PM_PENDING = (1 << 18), /* PM operation pending */
218 ATA_PFLAG_INIT_GTM_VALID = (1 << 19), /* initial gtm data valid */
219
220 /* struct ata_queued_cmd flags */
221 ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */
222 ATA_QCFLAG_DMAMAP = (1 << 1), /* SG table is DMA mapped */
223 ATA_QCFLAG_IO = (1 << 3), /* standard IO command */
224 ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */
225 ATA_QCFLAG_CLEAR_EXCL = (1 << 5), /* clear excl_link on completion */
226 ATA_QCFLAG_QUIET = (1 << 6), /* don't report device error */
227 ATA_QCFLAG_RETRY = (1 << 7), /* retry after failure */
228
229 ATA_QCFLAG_FAILED = (1 << 16), /* cmd failed and is owned by EH */
230 ATA_QCFLAG_SENSE_VALID = (1 << 17), /* sense data valid */
231 ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
232
233 /* host set flags */
234 ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host only */
235 ATA_HOST_STARTED = (1 << 1), /* Host started */
236
237 /* bits 24:31 of host->flags are reserved for LLD specific flags */
238
239 /* various lengths of time */
240 ATA_TMOUT_BOOT = 30 * HZ, /* heuristic */
241 ATA_TMOUT_BOOT_QUICK = 7 * HZ, /* heuristic */
242 ATA_TMOUT_INTERNAL = 30 * HZ,
243 ATA_TMOUT_INTERNAL_QUICK = 5 * HZ,
244
245 /* FIXME: GoVault needs 2s but we can't afford that without
246 * parallel probing. 800ms is enough for iVDR disk
247 * HHD424020F7SV00. Increase to 2secs when parallel probing
248 * is in place.
249 */
250 ATA_TMOUT_FF_WAIT = 4 * HZ / 5,
251
252 /* Spec mandates to wait for ">= 2ms" before checking status
253 * after reset. We wait 150ms, because that was the magic
254 * delay used for ATAPI devices in Hale Landis's ATADRVR, for
255 * the period of time between when the ATA command register is
256 * written, and then status is checked. Because waiting for
257 * "a while" before checking status is fine, post SRST, we
258 * perform this magic delay here as well.
259 *
260 * Old drivers/ide uses the 2mS rule and then waits for ready.
261 */
262 ATA_WAIT_AFTER_RESET_MSECS = 150,
263
264 /* If PMP is supported, we have to do follow-up SRST. As some
265 * PMPs don't send D2H Reg FIS after hardreset, LLDs are
266 * advised to wait only for the following duration before
267 * doing SRST.
268 */
269 ATA_TMOUT_PMP_SRST_WAIT = 1 * HZ,
270
271 /* ATA bus states */
272 BUS_UNKNOWN = 0,
273 BUS_DMA = 1,
274 BUS_IDLE = 2,
275 BUS_NOINTR = 3,
276 BUS_NODATA = 4,
277 BUS_TIMER = 5,
278 BUS_PIO = 6,
279 BUS_EDD = 7,
280 BUS_IDENTIFY = 8,
281 BUS_PACKET = 9,
282
283 /* SATA port states */
284 PORT_UNKNOWN = 0,
285 PORT_ENABLED = 1,
286 PORT_DISABLED = 2,
287
288 /* encoding various smaller bitmaps into a single
289 * unsigned long bitmap
290 */
291 ATA_NR_PIO_MODES = 7,
292 ATA_NR_MWDMA_MODES = 5,
293 ATA_NR_UDMA_MODES = 8,
294
295 ATA_SHIFT_PIO = 0,
296 ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_NR_PIO_MODES,
297 ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_NR_MWDMA_MODES,
298
299 /* size of buffer to pad xfers ending on unaligned boundaries */
300 ATA_DMA_PAD_SZ = 4,
301
302 /* ering size */
303 ATA_ERING_SIZE = 32,
304
305 /* return values for ->qc_defer */
306 ATA_DEFER_LINK = 1,
307 ATA_DEFER_PORT = 2,
308
309 /* desc_len for ata_eh_info and context */
310 ATA_EH_DESC_LEN = 80,
311
312 /* reset / recovery action types */
313 ATA_EH_REVALIDATE = (1 << 0),
314 ATA_EH_SOFTRESET = (1 << 1), /* meaningful only in ->prereset */
315 ATA_EH_HARDRESET = (1 << 2), /* meaningful only in ->prereset */
316 ATA_EH_RESET = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
317 ATA_EH_ENABLE_LINK = (1 << 3),
318 ATA_EH_LPM = (1 << 4), /* link power management action */
319
320 ATA_EH_PERDEV_MASK = ATA_EH_REVALIDATE,
321
322 /* ata_eh_info->flags */
323 ATA_EHI_HOTPLUGGED = (1 << 0), /* could have been hotplugged */
324 ATA_EHI_NO_AUTOPSY = (1 << 2), /* no autopsy */
325 ATA_EHI_QUIET = (1 << 3), /* be quiet */
326
327 ATA_EHI_DID_SOFTRESET = (1 << 16), /* already soft-reset this port */
328 ATA_EHI_DID_HARDRESET = (1 << 17), /* already soft-reset this port */
329 ATA_EHI_PRINTINFO = (1 << 18), /* print configuration info */
330 ATA_EHI_SETMODE = (1 << 19), /* configure transfer mode */
331 ATA_EHI_POST_SETMODE = (1 << 20), /* revaildating after setmode */
332
333 ATA_EHI_DID_RESET = ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
334
335 /* max tries if error condition is still set after ->error_handler */
336 ATA_EH_MAX_TRIES = 5,
337
338 /* how hard are we gonna try to probe/recover devices */
339 ATA_PROBE_MAX_TRIES = 3,
340 ATA_EH_DEV_TRIES = 3,
341 ATA_EH_PMP_TRIES = 5,
342 ATA_EH_PMP_LINK_TRIES = 3,
343
344 SATA_PMP_SCR_TIMEOUT = 250,
345
346 /* Horkage types. May be set by libata or controller on drives
347 (some horkage may be drive/controller pair dependant */
348
349 ATA_HORKAGE_DIAGNOSTIC = (1 << 0), /* Failed boot diag */
350 ATA_HORKAGE_NODMA = (1 << 1), /* DMA problems */
351 ATA_HORKAGE_NONCQ = (1 << 2), /* Don't use NCQ */
352 ATA_HORKAGE_MAX_SEC_128 = (1 << 3), /* Limit max sects to 128 */
353 ATA_HORKAGE_BROKEN_HPA = (1 << 4), /* Broken HPA */
354 ATA_HORKAGE_SKIP_PM = (1 << 5), /* Skip PM operations */
355 ATA_HORKAGE_HPA_SIZE = (1 << 6), /* native size off by one */
356 ATA_HORKAGE_IPM = (1 << 7), /* Link PM problems */
357 ATA_HORKAGE_IVB = (1 << 8), /* cbl det validity bit bugs */
358 ATA_HORKAGE_STUCK_ERR = (1 << 9), /* stuck ERR on next PACKET */
359
360 /* DMA mask for user DMA control: User visible values; DO NOT
361 renumber */
362 ATA_DMA_MASK_ATA = (1 << 0), /* DMA on ATA Disk */
363 ATA_DMA_MASK_ATAPI = (1 << 1), /* DMA on ATAPI */
364 ATA_DMA_MASK_CFA = (1 << 2), /* DMA on CF Card */
365
366 /* ATAPI command types */
367 ATAPI_READ = 0, /* READs */
368 ATAPI_WRITE = 1, /* WRITEs */
369 ATAPI_READ_CD = 2, /* READ CD [MSF] */
370 ATAPI_PASS_THRU = 3, /* SAT pass-thru */
371 ATAPI_MISC = 4, /* the rest */
372
373 /* Timing constants */
374 ATA_TIMING_SETUP = (1 << 0),
375 ATA_TIMING_ACT8B = (1 << 1),
376 ATA_TIMING_REC8B = (1 << 2),
377 ATA_TIMING_CYC8B = (1 << 3),
378 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
379 ATA_TIMING_CYC8B,
380 ATA_TIMING_ACTIVE = (1 << 4),
381 ATA_TIMING_RECOVER = (1 << 5),
382 ATA_TIMING_CYCLE = (1 << 6),
383 ATA_TIMING_UDMA = (1 << 7),
384 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
385 ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
386 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
387 ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
388 };
389
390 enum ata_xfer_mask {
391 ATA_MASK_PIO = ((1LU << ATA_NR_PIO_MODES) - 1)
392 << ATA_SHIFT_PIO,
393 ATA_MASK_MWDMA = ((1LU << ATA_NR_MWDMA_MODES) - 1)
394 << ATA_SHIFT_MWDMA,
395 ATA_MASK_UDMA = ((1LU << ATA_NR_UDMA_MODES) - 1)
396 << ATA_SHIFT_UDMA,
397 };
398
399 enum hsm_task_states {
400 HSM_ST_IDLE, /* no command on going */
401 HSM_ST_FIRST, /* (waiting the device to)
402 write CDB or first data block */
403 HSM_ST, /* (waiting the device to) transfer data */
404 HSM_ST_LAST, /* (waiting the device to) complete command */
405 HSM_ST_ERR, /* error */
406 };
407
408 enum ata_completion_errors {
409 AC_ERR_DEV = (1 << 0), /* device reported error */
410 AC_ERR_HSM = (1 << 1), /* host state machine violation */
411 AC_ERR_TIMEOUT = (1 << 2), /* timeout */
412 AC_ERR_MEDIA = (1 << 3), /* media error */
413 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
414 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
415 AC_ERR_SYSTEM = (1 << 6), /* system error */
416 AC_ERR_INVALID = (1 << 7), /* invalid argument */
417 AC_ERR_OTHER = (1 << 8), /* unknown */
418 AC_ERR_NODEV_HINT = (1 << 9), /* polling device detection hint */
419 AC_ERR_NCQ = (1 << 10), /* marker for offending NCQ qc */
420 };
421
422 /* forward declarations */
423 struct scsi_device;
424 struct ata_port_operations;
425 struct ata_port;
426 struct ata_link;
427 struct ata_queued_cmd;
428
429 /* typedefs */
430 typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
431 typedef int (*ata_prereset_fn_t)(struct ata_link *link, unsigned long deadline);
432 typedef int (*ata_reset_fn_t)(struct ata_link *link, unsigned int *classes,
433 unsigned long deadline);
434 typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes);
435
436 /*
437 * host pm policy: If you alter this, you also need to alter libata-scsi.c
438 * (for the ascii descriptions)
439 */
440 enum link_pm {
441 NOT_AVAILABLE,
442 MIN_POWER,
443 MAX_PERFORMANCE,
444 MEDIUM_POWER,
445 };
446 extern struct class_device_attribute class_device_attr_link_power_management_policy;
447
448 struct ata_ioports {
449 void __iomem *cmd_addr;
450 void __iomem *data_addr;
451 void __iomem *error_addr;
452 void __iomem *feature_addr;
453 void __iomem *nsect_addr;
454 void __iomem *lbal_addr;
455 void __iomem *lbam_addr;
456 void __iomem *lbah_addr;
457 void __iomem *device_addr;
458 void __iomem *status_addr;
459 void __iomem *command_addr;
460 void __iomem *altstatus_addr;
461 void __iomem *ctl_addr;
462 void __iomem *bmdma_addr;
463 void __iomem *scr_addr;
464 };
465
466 struct ata_host {
467 spinlock_t lock;
468 struct device *dev;
469 void __iomem * const *iomap;
470 unsigned int n_ports;
471 void *private_data;
472 struct ata_port_operations *ops;
473 unsigned long flags;
474 #ifdef CONFIG_ATA_ACPI
475 acpi_handle acpi_handle;
476 #endif
477 struct ata_port *simplex_claimed; /* channel owning the DMA */
478 struct ata_port *ports[0];
479 };
480
481 struct ata_queued_cmd {
482 struct ata_port *ap;
483 struct ata_device *dev;
484
485 struct scsi_cmnd *scsicmd;
486 void (*scsidone)(struct scsi_cmnd *);
487
488 struct ata_taskfile tf;
489 u8 cdb[ATAPI_CDB_LEN];
490
491 unsigned long flags; /* ATA_QCFLAG_xxx */
492 unsigned int tag;
493 unsigned int n_elem;
494
495 int dma_dir;
496
497 unsigned int sect_size;
498
499 unsigned int nbytes;
500 unsigned int extrabytes;
501 unsigned int curbytes;
502
503 struct scatterlist *cursg;
504 unsigned int cursg_ofs;
505
506 struct scatterlist sgent;
507
508 struct scatterlist *sg;
509
510 unsigned int err_mask;
511 struct ata_taskfile result_tf;
512 ata_qc_cb_t complete_fn;
513
514 void *private_data;
515 void *lldd_task;
516 };
517
518 struct ata_port_stats {
519 unsigned long unhandled_irq;
520 unsigned long idle_irq;
521 unsigned long rw_reqbuf;
522 };
523
524 struct ata_ering_entry {
525 unsigned int eflags;
526 unsigned int err_mask;
527 u64 timestamp;
528 };
529
530 struct ata_ering {
531 int cursor;
532 struct ata_ering_entry ring[ATA_ERING_SIZE];
533 };
534
535 struct ata_device {
536 struct ata_link *link;
537 unsigned int devno; /* 0 or 1 */
538 unsigned long flags; /* ATA_DFLAG_xxx */
539 unsigned int horkage; /* List of broken features */
540 struct scsi_device *sdev; /* attached SCSI device */
541 #ifdef CONFIG_ATA_ACPI
542 acpi_handle acpi_handle;
543 union acpi_object *gtf_cache;
544 #endif
545 /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */
546 u64 n_sectors; /* size of device, if ATA */
547 unsigned int class; /* ATA_DEV_xxx */
548
549 union {
550 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
551 u32 gscr[SATA_PMP_GSCR_DWORDS]; /* PMP GSCR block */
552 };
553
554 u8 pio_mode;
555 u8 dma_mode;
556 u8 xfer_mode;
557 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
558
559 unsigned int multi_count; /* sectors count for
560 READ/WRITE MULTIPLE */
561 unsigned int max_sectors; /* per-device max sectors */
562 unsigned int cdb_len;
563
564 /* per-dev xfer mask */
565 unsigned long pio_mask;
566 unsigned long mwdma_mask;
567 unsigned long udma_mask;
568
569 /* for CHS addressing */
570 u16 cylinders; /* Number of cylinders */
571 u16 heads; /* Number of heads */
572 u16 sectors; /* Number of sectors per track */
573
574 /* error history */
575 struct ata_ering ering;
576 int spdn_cnt;
577 };
578
579 /* Offset into struct ata_device. Fields above it are maintained
580 * acress device init. Fields below are zeroed.
581 */
582 #define ATA_DEVICE_CLEAR_OFFSET offsetof(struct ata_device, n_sectors)
583
584 struct ata_eh_info {
585 struct ata_device *dev; /* offending device */
586 u32 serror; /* SError from LLDD */
587 unsigned int err_mask; /* port-wide err_mask */
588 unsigned int action; /* ATA_EH_* action mask */
589 unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */
590 unsigned int flags; /* ATA_EHI_* flags */
591
592 unsigned int probe_mask;
593
594 char desc[ATA_EH_DESC_LEN];
595 int desc_len;
596 };
597
598 struct ata_eh_context {
599 struct ata_eh_info i;
600 int tries[ATA_MAX_DEVICES];
601 unsigned int classes[ATA_MAX_DEVICES];
602 unsigned int did_probe_mask;
603 unsigned int saved_ncq_enabled;
604 u8 saved_xfer_mode[ATA_MAX_DEVICES];
605 };
606
607 struct ata_acpi_drive
608 {
609 u32 pio;
610 u32 dma;
611 } __packed;
612
613 struct ata_acpi_gtm {
614 struct ata_acpi_drive drive[2];
615 u32 flags;
616 } __packed;
617
618 struct ata_link {
619 struct ata_port *ap;
620 int pmp; /* port multiplier port # */
621
622 unsigned int active_tag; /* active tag on this link */
623 u32 sactive; /* active NCQ commands */
624
625 unsigned int flags; /* ATA_LFLAG_xxx */
626
627 unsigned int hw_sata_spd_limit;
628 unsigned int sata_spd_limit;
629 unsigned int sata_spd; /* current SATA PHY speed */
630
631 /* record runtime error info, protected by host_set lock */
632 struct ata_eh_info eh_info;
633 /* EH context */
634 struct ata_eh_context eh_context;
635
636 struct ata_device device[ATA_MAX_DEVICES];
637 };
638
639 struct ata_port {
640 struct Scsi_Host *scsi_host; /* our co-allocated scsi host */
641 struct ata_port_operations *ops;
642 spinlock_t *lock;
643 unsigned long flags; /* ATA_FLAG_xxx */
644 unsigned int pflags; /* ATA_PFLAG_xxx */
645 unsigned int print_id; /* user visible unique port ID */
646 unsigned int port_no; /* 0 based port no. inside the host */
647
648 struct ata_prd *prd; /* our SG list */
649 dma_addr_t prd_dma; /* and its DMA mapping */
650
651 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
652
653 u8 ctl; /* cache of ATA control register */
654 u8 last_ctl; /* Cache last written value */
655 unsigned int pio_mask;
656 unsigned int mwdma_mask;
657 unsigned int udma_mask;
658 unsigned int cbl; /* cable type; ATA_CBL_xxx */
659
660 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
661 unsigned long qc_allocated;
662 unsigned int qc_active;
663 int nr_active_links; /* #links with active qcs */
664
665 struct ata_link link; /* host default link */
666
667 int nr_pmp_links; /* nr of available PMP links */
668 struct ata_link *pmp_link; /* array of PMP links */
669 struct ata_link *excl_link; /* for PMP qc exclusion */
670
671 struct ata_port_stats stats;
672 struct ata_host *host;
673 struct device *dev;
674
675 void *port_task_data;
676 struct delayed_work port_task;
677 struct delayed_work hotplug_task;
678 struct work_struct scsi_rescan_task;
679
680 unsigned int hsm_task_state;
681
682 u32 msg_enable;
683 struct list_head eh_done_q;
684 wait_queue_head_t eh_wait_q;
685 int eh_tries;
686
687 pm_message_t pm_mesg;
688 int *pm_result;
689 enum link_pm pm_policy;
690
691 struct timer_list fastdrain_timer;
692 unsigned long fastdrain_cnt;
693
694 void *private_data;
695
696 #ifdef CONFIG_ATA_ACPI
697 acpi_handle acpi_handle;
698 struct ata_acpi_gtm __acpi_init_gtm; /* use ata_acpi_init_gtm() */
699 #endif
700 u8 sector_buf[ATA_SECT_SIZE]; /* owned by EH */
701 };
702
703 /* The following initializer overrides a method to NULL whether one of
704 * its parent has the method defined or not. This is equivalent to
705 * ERR_PTR(-ENOENT). Unfortunately, ERR_PTR doesn't render a constant
706 * expression and thus can't be used as an initializer.
707 */
708 #define ATA_OP_NULL (void *)(unsigned long)(-ENOENT)
709
710 struct ata_port_operations {
711 /*
712 * Command execution
713 */
714 int (*qc_defer)(struct ata_queued_cmd *qc);
715 int (*check_atapi_dma)(struct ata_queued_cmd *qc);
716 void (*qc_prep)(struct ata_queued_cmd *qc);
717 unsigned int (*qc_issue)(struct ata_queued_cmd *qc);
718
719 /*
720 * Configuration and exception handling
721 */
722 int (*cable_detect)(struct ata_port *ap);
723 unsigned long (*mode_filter)(struct ata_device *dev, unsigned long xfer_mask);
724 void (*set_piomode)(struct ata_port *ap, struct ata_device *dev);
725 void (*set_dmamode)(struct ata_port *ap, struct ata_device *dev);
726 int (*set_mode)(struct ata_link *link, struct ata_device **r_failed_dev);
727
728 void (*dev_config)(struct ata_device *dev);
729
730 void (*freeze)(struct ata_port *ap);
731 void (*thaw)(struct ata_port *ap);
732 ata_prereset_fn_t prereset;
733 ata_reset_fn_t softreset;
734 ata_reset_fn_t hardreset;
735 ata_postreset_fn_t postreset;
736 ata_prereset_fn_t pmp_prereset;
737 ata_reset_fn_t pmp_softreset;
738 ata_reset_fn_t pmp_hardreset;
739 ata_postreset_fn_t pmp_postreset;
740 void (*error_handler)(struct ata_port *ap);
741 void (*post_internal_cmd)(struct ata_queued_cmd *qc);
742
743 /*
744 * Optional features
745 */
746 int (*scr_read)(struct ata_port *ap, unsigned int sc_reg, u32 *val);
747 int (*scr_write)(struct ata_port *ap, unsigned int sc_reg, u32 val);
748 void (*pmp_attach)(struct ata_port *ap);
749 void (*pmp_detach)(struct ata_port *ap);
750 int (*enable_pm)(struct ata_port *ap, enum link_pm policy);
751 void (*disable_pm)(struct ata_port *ap);
752
753 /*
754 * Start, stop, suspend and resume
755 */
756 int (*port_suspend)(struct ata_port *ap, pm_message_t mesg);
757 int (*port_resume)(struct ata_port *ap);
758 int (*port_start)(struct ata_port *ap);
759 void (*port_stop)(struct ata_port *ap);
760 void (*host_stop)(struct ata_host *host);
761
762 /*
763 * SFF / taskfile oriented ops
764 */
765 void (*sff_dev_select)(struct ata_port *ap, unsigned int device);
766 u8 (*sff_check_status)(struct ata_port *ap);
767 u8 (*sff_check_altstatus)(struct ata_port *ap);
768 void (*sff_tf_load)(struct ata_port *ap, const struct ata_taskfile *tf);
769 void (*sff_tf_read)(struct ata_port *ap, struct ata_taskfile *tf);
770 void (*sff_exec_command)(struct ata_port *ap,
771 const struct ata_taskfile *tf);
772 unsigned int (*sff_data_xfer)(struct ata_device *dev,
773 unsigned char *buf, unsigned int buflen, int rw);
774 u8 (*sff_irq_on)(struct ata_port *);
775 void (*sff_irq_clear)(struct ata_port *);
776
777 void (*bmdma_setup)(struct ata_queued_cmd *qc);
778 void (*bmdma_start)(struct ata_queued_cmd *qc);
779 void (*bmdma_stop)(struct ata_queued_cmd *qc);
780 u8 (*bmdma_status)(struct ata_port *ap);
781
782 /*
783 * Obsolete
784 */
785 void (*phy_reset)(struct ata_port *ap);
786 void (*eng_timeout)(struct ata_port *ap);
787
788 /*
789 * ->inherits must be the last field and all the preceding
790 * fields must be pointers.
791 */
792 const struct ata_port_operations *inherits;
793 };
794
795 struct ata_port_info {
796 unsigned long flags;
797 unsigned long link_flags;
798 unsigned long pio_mask;
799 unsigned long mwdma_mask;
800 unsigned long udma_mask;
801 struct ata_port_operations *port_ops;
802 void *private_data;
803 };
804
805 struct ata_timing {
806 unsigned short mode; /* ATA mode */
807 unsigned short setup; /* t1 */
808 unsigned short act8b; /* t2 for 8-bit I/O */
809 unsigned short rec8b; /* t2i for 8-bit I/O */
810 unsigned short cyc8b; /* t0 for 8-bit I/O */
811 unsigned short active; /* t2 or tD */
812 unsigned short recover; /* t2i or tK */
813 unsigned short cycle; /* t0 */
814 unsigned short udma; /* t2CYCTYP/2 */
815 };
816
817 #define FIT(v, vmin, vmax) max_t(short, min_t(short, v, vmax), vmin)
818
819 /*
820 * Core layer - drivers/ata/libata-core.c
821 */
822 extern const unsigned long sata_deb_timing_normal[];
823 extern const unsigned long sata_deb_timing_hotplug[];
824 extern const unsigned long sata_deb_timing_long[];
825
826 extern struct ata_port_operations ata_dummy_port_ops;
827 extern const struct ata_port_info ata_dummy_port_info;
828
829 static inline const unsigned long *
830 sata_ehc_deb_timing(struct ata_eh_context *ehc)
831 {
832 if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
833 return sata_deb_timing_hotplug;
834 else
835 return sata_deb_timing_normal;
836 }
837
838 static inline int ata_port_is_dummy(struct ata_port *ap)
839 {
840 return ap->ops == &ata_dummy_port_ops;
841 }
842
843 extern void sata_print_link_status(struct ata_link *link);
844 extern void ata_port_probe(struct ata_port *);
845 extern int sata_set_spd(struct ata_link *link);
846 extern int ata_std_prereset(struct ata_link *link, unsigned long deadline);
847 extern int ata_wait_after_reset(struct ata_link *link, unsigned long deadline,
848 int (*check_ready)(struct ata_link *link));
849 extern int sata_link_debounce(struct ata_link *link,
850 const unsigned long *params, unsigned long deadline);
851 extern int sata_link_resume(struct ata_link *link, const unsigned long *params,
852 unsigned long deadline);
853 extern int sata_link_hardreset(struct ata_link *link,
854 const unsigned long *timing, unsigned long deadline,
855 bool *online, int (*check_ready)(struct ata_link *));
856 extern int sata_std_hardreset(struct ata_link *link, unsigned int *class,
857 unsigned long deadline);
858 extern void ata_std_postreset(struct ata_link *link, unsigned int *classes);
859 extern void ata_port_disable(struct ata_port *);
860
861 extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
862 extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
863 const struct ata_port_info * const * ppi, int n_ports);
864 extern int ata_host_start(struct ata_host *host);
865 extern int ata_host_register(struct ata_host *host,
866 struct scsi_host_template *sht);
867 extern int ata_host_activate(struct ata_host *host, int irq,
868 irq_handler_t irq_handler, unsigned long irq_flags,
869 struct scsi_host_template *sht);
870 extern void ata_host_detach(struct ata_host *host);
871 extern void ata_host_init(struct ata_host *, struct device *,
872 unsigned long, struct ata_port_operations *);
873 extern int ata_scsi_detect(struct scsi_host_template *sht);
874 extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
875 extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
876 extern void ata_sas_port_destroy(struct ata_port *);
877 extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
878 struct ata_port_info *, struct Scsi_Host *);
879 extern int ata_sas_port_init(struct ata_port *);
880 extern int ata_sas_port_start(struct ata_port *ap);
881 extern void ata_sas_port_stop(struct ata_port *ap);
882 extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
883 extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
884 struct ata_port *ap);
885 extern int sata_scr_valid(struct ata_link *link);
886 extern int sata_scr_read(struct ata_link *link, int reg, u32 *val);
887 extern int sata_scr_write(struct ata_link *link, int reg, u32 val);
888 extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val);
889 extern int ata_link_online(struct ata_link *link);
890 extern int ata_link_offline(struct ata_link *link);
891 #ifdef CONFIG_PM
892 extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
893 extern void ata_host_resume(struct ata_host *host);
894 #endif
895 extern int ata_ratelimit(void);
896 extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
897 unsigned long interval_msec,
898 unsigned long timeout_msec);
899 extern int atapi_cmd_type(u8 opcode);
900 extern void ata_tf_to_fis(const struct ata_taskfile *tf,
901 u8 pmp, int is_cmd, u8 *fis);
902 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
903 extern unsigned long ata_pack_xfermask(unsigned long pio_mask,
904 unsigned long mwdma_mask, unsigned long udma_mask);
905 extern void ata_unpack_xfermask(unsigned long xfer_mask,
906 unsigned long *pio_mask, unsigned long *mwdma_mask,
907 unsigned long *udma_mask);
908 extern u8 ata_xfer_mask2mode(unsigned long xfer_mask);
909 extern unsigned long ata_xfer_mode2mask(u8 xfer_mode);
910 extern int ata_xfer_mode2shift(unsigned long xfer_mode);
911 extern const char *ata_mode_string(unsigned long xfer_mask);
912 extern unsigned long ata_id_xfermask(const u16 *id);
913 extern void ata_noop_dev_select(struct ata_port *ap, unsigned int device);
914 extern int ata_port_start(struct ata_port *ap);
915 extern int ata_std_qc_defer(struct ata_queued_cmd *qc);
916 extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
917 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
918 unsigned int n_elem);
919 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
920 extern void ata_dev_disable(struct ata_device *adev);
921 extern void ata_id_string(const u16 *id, unsigned char *s,
922 unsigned int ofs, unsigned int len);
923 extern void ata_id_c_string(const u16 *id, unsigned char *s,
924 unsigned int ofs, unsigned int len);
925 extern void ata_qc_complete(struct ata_queued_cmd *qc);
926 extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active,
927 void (*finish_qc)(struct ata_queued_cmd *));
928 extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
929 void (*done)(struct scsi_cmnd *));
930 extern int ata_std_bios_param(struct scsi_device *sdev,
931 struct block_device *bdev,
932 sector_t capacity, int geom[]);
933 extern int ata_scsi_slave_config(struct scsi_device *sdev);
934 extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
935 extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
936 int queue_depth);
937 extern struct ata_device *ata_dev_pair(struct ata_device *adev);
938 extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
939
940 extern int ata_cable_40wire(struct ata_port *ap);
941 extern int ata_cable_80wire(struct ata_port *ap);
942 extern int ata_cable_sata(struct ata_port *ap);
943 extern int ata_cable_ignore(struct ata_port *ap);
944 extern int ata_cable_unknown(struct ata_port *ap);
945
946 /* Timing helpers */
947 extern unsigned int ata_pio_need_iordy(const struct ata_device *);
948 extern const struct ata_timing *ata_timing_find_mode(u8 xfer_mode);
949 extern int ata_timing_compute(struct ata_device *, unsigned short,
950 struct ata_timing *, int, int);
951 extern void ata_timing_merge(const struct ata_timing *,
952 const struct ata_timing *, struct ata_timing *,
953 unsigned int);
954 extern u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle);
955
956 /* PCI */
957 #ifdef CONFIG_PCI
958 struct pci_dev;
959
960 struct pci_bits {
961 unsigned int reg; /* PCI config register to read */
962 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
963 unsigned long mask;
964 unsigned long val;
965 };
966
967 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
968 extern void ata_pci_remove_one(struct pci_dev *pdev);
969
970 #ifdef CONFIG_PM
971 extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
972 extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
973 extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
974 extern int ata_pci_device_resume(struct pci_dev *pdev);
975 #endif /* CONFIG_PM */
976 #endif /* CONFIG_PCI */
977
978 /*
979 * ACPI - drivers/ata/libata-acpi.c
980 */
981 #ifdef CONFIG_ATA_ACPI
982 static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
983 {
984 if (ap->pflags & ATA_PFLAG_INIT_GTM_VALID)
985 return &ap->__acpi_init_gtm;
986 return NULL;
987 }
988 int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm);
989 int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *stm);
990 unsigned long ata_acpi_gtm_xfermask(struct ata_device *dev,
991 const struct ata_acpi_gtm *gtm);
992 int ata_acpi_cbl_80wire(struct ata_port *ap, const struct ata_acpi_gtm *gtm);
993 #else
994 static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
995 {
996 return NULL;
997 }
998
999 static inline int ata_acpi_stm(const struct ata_port *ap,
1000 struct ata_acpi_gtm *stm)
1001 {
1002 return -ENOSYS;
1003 }
1004
1005 static inline int ata_acpi_gtm(const struct ata_port *ap,
1006 struct ata_acpi_gtm *stm)
1007 {
1008 return -ENOSYS;
1009 }
1010
1011 static inline unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev,
1012 const struct ata_acpi_gtm *gtm)
1013 {
1014 return 0;
1015 }
1016
1017 static inline int ata_acpi_cbl_80wire(struct ata_port *ap,
1018 const struct ata_acpi_gtm *gtm)
1019 {
1020 return 0;
1021 }
1022 #endif
1023
1024 /*
1025 * PMP - drivers/ata/libata-pmp.c
1026 */
1027 extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc);
1028 extern int sata_pmp_std_hardreset(struct ata_link *link, unsigned int *class,
1029 unsigned long deadline);
1030 extern void sata_pmp_error_handler(struct ata_port *ap);
1031
1032 /*
1033 * EH - drivers/ata/libata-eh.c
1034 */
1035 extern void ata_port_schedule_eh(struct ata_port *ap);
1036 extern int ata_link_abort(struct ata_link *link);
1037 extern int ata_port_abort(struct ata_port *ap);
1038 extern int ata_port_freeze(struct ata_port *ap);
1039 extern int sata_async_notification(struct ata_port *ap);
1040
1041 extern void ata_eh_freeze_port(struct ata_port *ap);
1042 extern void ata_eh_thaw_port(struct ata_port *ap);
1043
1044 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
1045 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
1046
1047 extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
1048 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
1049 ata_postreset_fn_t postreset);
1050 extern void ata_std_error_handler(struct ata_port *ap);
1051
1052 /*
1053 * Base operations to inherit from and initializers for sht
1054 *
1055 * Operations
1056 *
1057 * base : Common to all libata drivers.
1058 * sata : SATA controllers w/ native interface.
1059 * pmp : SATA controllers w/ PMP support.
1060 * sff : SFF ATA controllers w/o BMDMA support.
1061 * bmdma : SFF ATA controllers w/ BMDMA support.
1062 *
1063 * sht initializers
1064 *
1065 * BASE : Common to all libata drivers. The user must set
1066 * sg_tablesize and dma_boundary.
1067 * PIO : SFF ATA controllers w/ only PIO support.
1068 * BMDMA : SFF ATA controllers w/ BMDMA support. sg_tablesize and
1069 * dma_boundary are set to BMDMA limits.
1070 * NCQ : SATA controllers supporting NCQ. The user must set
1071 * sg_tablesize, dma_boundary and can_queue.
1072 */
1073 extern const struct ata_port_operations ata_base_port_ops;
1074 extern const struct ata_port_operations sata_port_ops;
1075 extern const struct ata_port_operations sata_pmp_port_ops;
1076
1077 #define ATA_BASE_SHT(drv_name) \
1078 .module = THIS_MODULE, \
1079 .name = drv_name, \
1080 .ioctl = ata_scsi_ioctl, \
1081 .queuecommand = ata_scsi_queuecmd, \
1082 .can_queue = ATA_DEF_QUEUE, \
1083 .this_id = ATA_SHT_THIS_ID, \
1084 .cmd_per_lun = ATA_SHT_CMD_PER_LUN, \
1085 .emulated = ATA_SHT_EMULATED, \
1086 .use_clustering = ATA_SHT_USE_CLUSTERING, \
1087 .proc_name = drv_name, \
1088 .slave_configure = ata_scsi_slave_config, \
1089 .slave_destroy = ata_scsi_slave_destroy, \
1090 .bios_param = ata_std_bios_param
1091
1092 #define ATA_NCQ_SHT(drv_name) \
1093 ATA_BASE_SHT(drv_name), \
1094 .change_queue_depth = ata_scsi_change_queue_depth
1095
1096 /*
1097 * printk helpers
1098 */
1099 #define ata_port_printk(ap, lv, fmt, args...) \
1100 printk("%sata%u: "fmt, lv, (ap)->print_id , ##args)
1101
1102 #define ata_link_printk(link, lv, fmt, args...) do { \
1103 if ((link)->ap->nr_pmp_links) \
1104 printk("%sata%u.%02u: "fmt, lv, (link)->ap->print_id, \
1105 (link)->pmp , ##args); \
1106 else \
1107 printk("%sata%u: "fmt, lv, (link)->ap->print_id , ##args); \
1108 } while(0)
1109
1110 #define ata_dev_printk(dev, lv, fmt, args...) \
1111 printk("%sata%u.%02u: "fmt, lv, (dev)->link->ap->print_id, \
1112 (dev)->link->pmp + (dev)->devno , ##args)
1113
1114 /*
1115 * ata_eh_info helpers
1116 */
1117 extern void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...)
1118 __attribute__ ((format (printf, 2, 3)));
1119 extern void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...)
1120 __attribute__ ((format (printf, 2, 3)));
1121 extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
1122
1123 static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
1124 {
1125 ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
1126 ehi->flags |= ATA_EHI_HOTPLUGGED;
1127 ehi->action |= ATA_EH_RESET | ATA_EH_ENABLE_LINK;
1128 ehi->err_mask |= AC_ERR_ATA_BUS;
1129 }
1130
1131 /*
1132 * port description helpers
1133 */
1134 extern void ata_port_desc(struct ata_port *ap, const char *fmt, ...)
1135 __attribute__ ((format (printf, 2, 3)));
1136 #ifdef CONFIG_PCI
1137 extern void ata_port_pbar_desc(struct ata_port *ap, int bar, ssize_t offset,
1138 const char *name);
1139 #endif
1140
1141 static inline unsigned int ata_tag_valid(unsigned int tag)
1142 {
1143 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
1144 }
1145
1146 static inline unsigned int ata_tag_internal(unsigned int tag)
1147 {
1148 return tag == ATA_TAG_INTERNAL;
1149 }
1150
1151 /*
1152 * device helpers
1153 */
1154 static inline unsigned int ata_class_enabled(unsigned int class)
1155 {
1156 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI ||
1157 class == ATA_DEV_PMP || class == ATA_DEV_SEMB;
1158 }
1159
1160 static inline unsigned int ata_class_disabled(unsigned int class)
1161 {
1162 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP ||
1163 class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP;
1164 }
1165
1166 static inline unsigned int ata_class_absent(unsigned int class)
1167 {
1168 return !ata_class_enabled(class) && !ata_class_disabled(class);
1169 }
1170
1171 static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1172 {
1173 return ata_class_enabled(dev->class);
1174 }
1175
1176 static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1177 {
1178 return ata_class_disabled(dev->class);
1179 }
1180
1181 static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1182 {
1183 return ata_class_absent(dev->class);
1184 }
1185
1186 /*
1187 * link helpers
1188 */
1189 static inline int ata_is_host_link(const struct ata_link *link)
1190 {
1191 return link == &link->ap->link;
1192 }
1193
1194 static inline int ata_link_max_devices(const struct ata_link *link)
1195 {
1196 if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS)
1197 return 2;
1198 return 1;
1199 }
1200
1201 static inline int ata_link_active(struct ata_link *link)
1202 {
1203 return ata_tag_valid(link->active_tag) || link->sactive;
1204 }
1205
1206 static inline struct ata_link *ata_port_first_link(struct ata_port *ap)
1207 {
1208 if (ap->nr_pmp_links)
1209 return ap->pmp_link;
1210 return &ap->link;
1211 }
1212
1213 static inline struct ata_link *ata_port_next_link(struct ata_link *link)
1214 {
1215 struct ata_port *ap = link->ap;
1216
1217 if (link == &ap->link) {
1218 if (!ap->nr_pmp_links)
1219 return NULL;
1220 return ap->pmp_link;
1221 }
1222
1223 if (++link < ap->nr_pmp_links + ap->pmp_link)
1224 return link;
1225 return NULL;
1226 }
1227
1228 #define __ata_port_for_each_link(lk, ap) \
1229 for ((lk) = &(ap)->link; (lk); (lk) = ata_port_next_link(lk))
1230
1231 #define ata_port_for_each_link(link, ap) \
1232 for ((link) = ata_port_first_link(ap); (link); \
1233 (link) = ata_port_next_link(link))
1234
1235 #define ata_link_for_each_dev(dev, link) \
1236 for ((dev) = (link)->device; \
1237 (dev) < (link)->device + ata_link_max_devices(link) || ((dev) = NULL); \
1238 (dev)++)
1239
1240 #define ata_link_for_each_dev_reverse(dev, link) \
1241 for ((dev) = (link)->device + ata_link_max_devices(link) - 1; \
1242 (dev) >= (link)->device || ((dev) = NULL); (dev)--)
1243
1244 /**
1245 * ata_ncq_enabled - Test whether NCQ is enabled
1246 * @dev: ATA device to test for
1247 *
1248 * LOCKING:
1249 * spin_lock_irqsave(host lock)
1250 *
1251 * RETURNS:
1252 * 1 if NCQ is enabled for @dev, 0 otherwise.
1253 */
1254 static inline int ata_ncq_enabled(struct ata_device *dev)
1255 {
1256 return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1257 ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1258 }
1259
1260 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1261 {
1262 qc->tf.ctl |= ATA_NIEN;
1263 }
1264
1265 static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1266 unsigned int tag)
1267 {
1268 if (likely(ata_tag_valid(tag)))
1269 return &ap->qcmd[tag];
1270 return NULL;
1271 }
1272
1273 static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1274 unsigned int tag)
1275 {
1276 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1277
1278 if (unlikely(!qc) || !ap->ops->error_handler)
1279 return qc;
1280
1281 if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1282 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1283 return qc;
1284
1285 return NULL;
1286 }
1287
1288 static inline unsigned int ata_qc_raw_nbytes(struct ata_queued_cmd *qc)
1289 {
1290 return qc->nbytes - min(qc->extrabytes, qc->nbytes);
1291 }
1292
1293 static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1294 {
1295 memset(tf, 0, sizeof(*tf));
1296
1297 tf->ctl = dev->link->ap->ctl;
1298 if (dev->devno == 0)
1299 tf->device = ATA_DEVICE_OBS;
1300 else
1301 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1302 }
1303
1304 static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1305 {
1306 qc->dma_dir = DMA_NONE;
1307 qc->sg = NULL;
1308 qc->flags = 0;
1309 qc->cursg = NULL;
1310 qc->cursg_ofs = 0;
1311 qc->nbytes = qc->extrabytes = qc->curbytes = 0;
1312 qc->n_elem = 0;
1313 qc->err_mask = 0;
1314 qc->sect_size = ATA_SECT_SIZE;
1315
1316 ata_tf_init(qc->dev, &qc->tf);
1317
1318 /* init result_tf such that it indicates normal completion */
1319 qc->result_tf.command = ATA_DRDY;
1320 qc->result_tf.feature = 0;
1321 }
1322
1323 static inline int ata_try_flush_cache(const struct ata_device *dev)
1324 {
1325 return ata_id_wcache_enabled(dev->id) ||
1326 ata_id_has_flush(dev->id) ||
1327 ata_id_has_flush_ext(dev->id);
1328 }
1329
1330 static inline unsigned int ac_err_mask(u8 status)
1331 {
1332 if (status & (ATA_BUSY | ATA_DRQ))
1333 return AC_ERR_HSM;
1334 if (status & (ATA_ERR | ATA_DF))
1335 return AC_ERR_DEV;
1336 return 0;
1337 }
1338
1339 static inline unsigned int __ac_err_mask(u8 status)
1340 {
1341 unsigned int mask = ac_err_mask(status);
1342 if (mask == 0)
1343 return AC_ERR_OTHER;
1344 return mask;
1345 }
1346
1347 static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1348 {
1349 return *(struct ata_port **)&host->hostdata[0];
1350 }
1351
1352 /**************************************************************************
1353 * SFF - drivers/ata/libata-sff.c
1354 */
1355 extern const struct ata_port_operations ata_sff_port_ops;
1356 extern const struct ata_port_operations ata_bmdma_port_ops;
1357
1358 /* PIO only, sg_tablesize and dma_boundary limits can be removed */
1359 #define ATA_PIO_SHT(drv_name) \
1360 ATA_BASE_SHT(drv_name), \
1361 .sg_tablesize = LIBATA_MAX_PRD, \
1362 .dma_boundary = ATA_DMA_BOUNDARY
1363
1364 #define ATA_BMDMA_SHT(drv_name) \
1365 ATA_BASE_SHT(drv_name), \
1366 .sg_tablesize = LIBATA_MAX_PRD, \
1367 .dma_boundary = ATA_DMA_BOUNDARY
1368
1369 extern void ata_sff_qc_prep(struct ata_queued_cmd *qc);
1370 extern void ata_sff_dumb_qc_prep(struct ata_queued_cmd *qc);
1371 extern void ata_sff_dev_select(struct ata_port *ap, unsigned int device);
1372 extern u8 ata_sff_check_status(struct ata_port *ap);
1373 extern u8 ata_sff_altstatus(struct ata_port *ap);
1374 extern int ata_sff_busy_sleep(struct ata_port *ap,
1375 unsigned long timeout_pat, unsigned long timeout);
1376 extern int ata_sff_wait_ready(struct ata_link *link, unsigned long deadline);
1377 extern void ata_sff_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
1378 extern void ata_sff_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
1379 extern void ata_sff_exec_command(struct ata_port *ap,
1380 const struct ata_taskfile *tf);
1381 extern unsigned int ata_sff_data_xfer(struct ata_device *dev,
1382 unsigned char *buf, unsigned int buflen, int rw);
1383 extern unsigned int ata_sff_data_xfer_noirq(struct ata_device *dev,
1384 unsigned char *buf, unsigned int buflen, int rw);
1385 extern u8 ata_sff_irq_on(struct ata_port *ap);
1386 extern void ata_sff_irq_clear(struct ata_port *ap);
1387 extern int ata_sff_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
1388 u8 status, int in_wq);
1389 extern unsigned int ata_sff_qc_issue(struct ata_queued_cmd *qc);
1390 extern unsigned int ata_sff_host_intr(struct ata_port *ap,
1391 struct ata_queued_cmd *qc);
1392 extern irqreturn_t ata_sff_interrupt(int irq, void *dev_instance);
1393 extern void ata_sff_freeze(struct ata_port *ap);
1394 extern void ata_sff_thaw(struct ata_port *ap);
1395 extern int ata_sff_prereset(struct ata_link *link, unsigned long deadline);
1396 extern unsigned int ata_sff_dev_classify(struct ata_device *dev, int present,
1397 u8 *r_err);
1398 extern int ata_sff_wait_after_reset(struct ata_link *link, unsigned int devmask,
1399 unsigned long deadline);
1400 extern int ata_sff_softreset(struct ata_link *link, unsigned int *classes,
1401 unsigned long deadline);
1402 extern int sata_sff_hardreset(struct ata_link *link, unsigned int *class,
1403 unsigned long deadline);
1404 extern void ata_sff_postreset(struct ata_link *link, unsigned int *classes);
1405 extern void ata_sff_error_handler(struct ata_port *ap);
1406 extern void ata_sff_post_internal_cmd(struct ata_queued_cmd *qc);
1407 extern int ata_sff_port_start(struct ata_port *ap);
1408 extern void ata_sff_std_ports(struct ata_ioports *ioaddr);
1409 extern unsigned long ata_bmdma_mode_filter(struct ata_device *dev,
1410 unsigned long xfer_mask);
1411 extern void ata_bmdma_setup(struct ata_queued_cmd *qc);
1412 extern void ata_bmdma_start(struct ata_queued_cmd *qc);
1413 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
1414 extern u8 ata_bmdma_status(struct ata_port *ap);
1415 extern void ata_bus_reset(struct ata_port *ap);
1416
1417 #ifdef CONFIG_PCI
1418 extern int ata_pci_bmdma_clear_simplex(struct pci_dev *pdev);
1419 extern int ata_pci_bmdma_init(struct ata_host *host);
1420 extern int ata_pci_sff_init_host(struct ata_host *host);
1421 extern int ata_pci_sff_prepare_host(struct pci_dev *pdev,
1422 const struct ata_port_info * const * ppi,
1423 struct ata_host **r_host);
1424 extern int ata_pci_sff_activate_host(struct ata_host *host,
1425 irq_handler_t irq_handler,
1426 struct scsi_host_template *sht);
1427 extern int ata_pci_sff_init_one(struct pci_dev *pdev,
1428 const struct ata_port_info * const * ppi,
1429 struct scsi_host_template *sht, void *host_priv);
1430 #endif /* CONFIG_PCI */
1431
1432 /**
1433 * ata_sff_pause - Flush writes and pause 400 nanoseconds.
1434 * @ap: Port to wait for.
1435 *
1436 * LOCKING:
1437 * Inherited from caller.
1438 */
1439 static inline void ata_sff_pause(struct ata_port *ap)
1440 {
1441 ata_sff_altstatus(ap);
1442 ndelay(400);
1443 }
1444
1445 /**
1446 * ata_sff_busy_wait - Wait for a port status register
1447 * @ap: Port to wait for.
1448 * @bits: bits that must be clear
1449 * @max: number of 10uS waits to perform
1450 *
1451 * Waits up to max*10 microseconds for the selected bits in the port's
1452 * status register to be cleared.
1453 * Returns final value of status register.
1454 *
1455 * LOCKING:
1456 * Inherited from caller.
1457 */
1458 static inline u8 ata_sff_busy_wait(struct ata_port *ap, unsigned int bits,
1459 unsigned int max)
1460 {
1461 u8 status;
1462
1463 do {
1464 udelay(10);
1465 status = ap->ops->sff_check_status(ap);
1466 max--;
1467 } while (status != 0xff && (status & bits) && (max > 0));
1468
1469 return status;
1470 }
1471
1472 /**
1473 * ata_wait_idle - Wait for a port to be idle.
1474 * @ap: Port to wait for.
1475 *
1476 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
1477 * Returns final value of status register.
1478 *
1479 * LOCKING:
1480 * Inherited from caller.
1481 */
1482 static inline u8 ata_wait_idle(struct ata_port *ap)
1483 {
1484 u8 status = ata_sff_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1485
1486 #ifdef ATA_DEBUG
1487 if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
1488 ata_port_printk(ap, KERN_DEBUG, "abnormal Status 0x%X\n",
1489 status);
1490 #endif
1491
1492 return status;
1493 }
1494
1495 #endif /* __LINUX_LIBATA_H__ */
ubuntu-zesty-kernel mirror