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


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