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