projects / deliverable / linux.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
libata: reorganize ata_port_operations
[deliverable/linux.git] / include / linux / libata.h
... / ...
CommitLineData
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_ALL_DEVICES = (1 << ATA_MAX_DEVICES) - 1,
126
127 ATA_SHT_EMULATED = 1,
128 ATA_SHT_CMD_PER_LUN = 1,
129 ATA_SHT_THIS_ID = -1,
130 ATA_SHT_USE_CLUSTERING = 1,
131
132 /* struct ata_device stuff */
133 ATA_DFLAG_LBA = (1 << 0), /* device supports LBA */
134 ATA_DFLAG_LBA48 = (1 << 1), /* device supports LBA48 */
135 ATA_DFLAG_CDB_INTR = (1 << 2), /* device asserts INTRQ when ready for CDB */
136 ATA_DFLAG_NCQ = (1 << 3), /* device supports NCQ */
137 ATA_DFLAG_FLUSH_EXT = (1 << 4), /* do FLUSH_EXT instead of FLUSH */
138 ATA_DFLAG_ACPI_PENDING = (1 << 5), /* ACPI resume action pending */
139 ATA_DFLAG_ACPI_FAILED = (1 << 6), /* ACPI on devcfg has failed */
140 ATA_DFLAG_AN = (1 << 7), /* AN configured */
141 ATA_DFLAG_HIPM = (1 << 8), /* device supports HIPM */
142 ATA_DFLAG_DIPM = (1 << 9), /* device supports DIPM */
143 ATA_DFLAG_DMADIR = (1 << 10), /* device requires DMADIR */
144 ATA_DFLAG_CFG_MASK = (1 << 12) - 1,
145
146 ATA_DFLAG_PIO = (1 << 12), /* device limited to PIO mode */
147 ATA_DFLAG_NCQ_OFF = (1 << 13), /* device limited to non-NCQ mode */
148 ATA_DFLAG_SPUNDOWN = (1 << 14), /* XXX: for spindown_compat */
149 ATA_DFLAG_SLEEPING = (1 << 15), /* device is sleeping */
150 ATA_DFLAG_DUBIOUS_XFER = (1 << 16), /* data transfer not verified */
151 ATA_DFLAG_INIT_MASK = (1 << 24) - 1,
152
153 ATA_DFLAG_DETACH = (1 << 24),
154 ATA_DFLAG_DETACHED = (1 << 25),
155
156 ATA_DEV_UNKNOWN = 0, /* unknown device */
157 ATA_DEV_ATA = 1, /* ATA device */
158 ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */
159 ATA_DEV_ATAPI = 3, /* ATAPI device */
160 ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */
161 ATA_DEV_PMP = 5, /* SATA port multiplier */
162 ATA_DEV_PMP_UNSUP = 6, /* SATA port multiplier (unsupported) */
163 ATA_DEV_SEMB = 7, /* SEMB */
164 ATA_DEV_SEMB_UNSUP = 8, /* SEMB (unsupported) */
165 ATA_DEV_NONE = 9, /* no device */
166
167 /* struct ata_link flags */
168 ATA_LFLAG_NO_SRST = (1 << 2), /* avoid softreset */
169 ATA_LFLAG_ASSUME_ATA = (1 << 3), /* assume ATA class */
170 ATA_LFLAG_ASSUME_SEMB = (1 << 4), /* assume SEMB class */
171 ATA_LFLAG_ASSUME_CLASS = ATA_LFLAG_ASSUME_ATA | ATA_LFLAG_ASSUME_SEMB,
172 ATA_LFLAG_NO_RETRY = (1 << 5), /* don't retry this link */
173 ATA_LFLAG_DISABLED = (1 << 6), /* link is disabled */
174
175 /* struct ata_port flags */
176 ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */
177 /* (doesn't imply presence) */
178 ATA_FLAG_SATA = (1 << 1),
179 ATA_FLAG_NO_LEGACY = (1 << 2), /* no legacy mode check */
180 ATA_FLAG_MMIO = (1 << 3), /* use MMIO, not PIO */
181 ATA_FLAG_SRST = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */
182 ATA_FLAG_SATA_RESET = (1 << 5), /* (obsolete) use COMRESET */
183 ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */
184 ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */
185 ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */
186 ATA_FLAG_PIO_POLLING = (1 << 9), /* use polling PIO if LLD
187 * doesn't handle PIO interrupts */
188 ATA_FLAG_NCQ = (1 << 10), /* host supports NCQ */
189 ATA_FLAG_DEBUGMSG = (1 << 13),
190 ATA_FLAG_IGN_SIMPLEX = (1 << 15), /* ignore SIMPLEX */
191 ATA_FLAG_NO_IORDY = (1 << 16), /* controller lacks iordy */
192 ATA_FLAG_ACPI_SATA = (1 << 17), /* need native SATA ACPI layout */
193 ATA_FLAG_AN = (1 << 18), /* controller supports AN */
194 ATA_FLAG_PMP = (1 << 19), /* controller supports PMP */
195 ATA_FLAG_IPM = (1 << 20), /* driver can handle IPM */
196
197 /* The following flag belongs to ap->pflags but is kept in
198 * ap->flags because it's referenced in many LLDs and will be
199 * removed in not-too-distant future.
200 */
201 ATA_FLAG_DISABLED = (1 << 23), /* port is disabled, ignore it */
202
203 /* bits 24:31 of ap->flags are reserved for LLD specific flags */
204
205 /* struct ata_port pflags */
206 ATA_PFLAG_EH_PENDING = (1 << 0), /* EH pending */
207 ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */
208 ATA_PFLAG_FROZEN = (1 << 2), /* port is frozen */
209 ATA_PFLAG_RECOVERED = (1 << 3), /* recovery action performed */
210 ATA_PFLAG_LOADING = (1 << 4), /* boot/loading probe */
211 ATA_PFLAG_UNLOADING = (1 << 5), /* module is unloading */
212 ATA_PFLAG_SCSI_HOTPLUG = (1 << 6), /* SCSI hotplug scheduled */
213 ATA_PFLAG_INITIALIZING = (1 << 7), /* being initialized, don't touch */
214 ATA_PFLAG_RESETTING = (1 << 8), /* reset in progress */
215
216 ATA_PFLAG_SUSPENDED = (1 << 17), /* port is suspended (power) */
217 ATA_PFLAG_PM_PENDING = (1 << 18), /* PM operation pending */
218 ATA_PFLAG_INIT_GTM_VALID = (1 << 19), /* initial gtm data valid */
219
220 /* struct ata_queued_cmd flags */
221 ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */
222 ATA_QCFLAG_DMAMAP = (1 << 1), /* SG table is DMA mapped */
223 ATA_QCFLAG_IO = (1 << 3), /* standard IO command */
224 ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */
225 ATA_QCFLAG_CLEAR_EXCL = (1 << 5), /* clear excl_link on completion */
226 ATA_QCFLAG_QUIET = (1 << 6), /* don't report device error */
227
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
282 /* ering size */
283 ATA_ERING_SIZE = 32,
284
285 /* return values for ->qc_defer */
286 ATA_DEFER_LINK = 1,
287 ATA_DEFER_PORT = 2,
288
289 /* desc_len for ata_eh_info and context */
290 ATA_EH_DESC_LEN = 80,
291
292 /* reset / recovery action types */
293 ATA_EH_REVALIDATE = (1 << 0),
294 ATA_EH_SOFTRESET = (1 << 1), /* meaningful only in ->prereset */
295 ATA_EH_HARDRESET = (1 << 2), /* meaningful only in ->prereset */
296 ATA_EH_RESET = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
297 ATA_EH_ENABLE_LINK = (1 << 3),
298 ATA_EH_LPM = (1 << 4), /* link power management action */
299
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_NO_AUTOPSY = (1 << 2), /* no autopsy */
305 ATA_EHI_QUIET = (1 << 3), /* be quiet */
306
307 ATA_EHI_DID_SOFTRESET = (1 << 16), /* already soft-reset this port */
308 ATA_EHI_DID_HARDRESET = (1 << 17), /* already soft-reset this port */
309 ATA_EHI_PRINTINFO = (1 << 18), /* print configuration info */
310 ATA_EHI_SETMODE = (1 << 19), /* configure transfer mode */
311 ATA_EHI_POST_SETMODE = (1 << 20), /* revaildating after setmode */
312
313 ATA_EHI_DID_RESET = ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
314
315 /* max tries if error condition is still set after ->error_handler */
316 ATA_EH_MAX_TRIES = 5,
317
318 /* how hard are we gonna try to probe/recover devices */
319 ATA_PROBE_MAX_TRIES = 3,
320 ATA_EH_DEV_TRIES = 3,
321 ATA_EH_PMP_TRIES = 5,
322 ATA_EH_PMP_LINK_TRIES = 3,
323
324 SATA_PMP_SCR_TIMEOUT = 250,
325
326 /* Horkage types. May be set by libata or controller on drives
327 (some horkage may be drive/controller pair dependant */
328
329 ATA_HORKAGE_DIAGNOSTIC = (1 << 0), /* Failed boot diag */
330 ATA_HORKAGE_NODMA = (1 << 1), /* DMA problems */
331 ATA_HORKAGE_NONCQ = (1 << 2), /* Don't use NCQ */
332 ATA_HORKAGE_MAX_SEC_128 = (1 << 3), /* Limit max sects to 128 */
333 ATA_HORKAGE_BROKEN_HPA = (1 << 4), /* Broken HPA */
334 ATA_HORKAGE_SKIP_PM = (1 << 5), /* Skip PM operations */
335 ATA_HORKAGE_HPA_SIZE = (1 << 6), /* native size off by one */
336 ATA_HORKAGE_IPM = (1 << 7), /* Link PM problems */
337 ATA_HORKAGE_IVB = (1 << 8), /* cbl det validity bit bugs */
338 ATA_HORKAGE_STUCK_ERR = (1 << 9), /* stuck ERR on next PACKET */
339
340 /* DMA mask for user DMA control: User visible values; DO NOT
341 renumber */
342 ATA_DMA_MASK_ATA = (1 << 0), /* DMA on ATA Disk */
343 ATA_DMA_MASK_ATAPI = (1 << 1), /* DMA on ATAPI */
344 ATA_DMA_MASK_CFA = (1 << 2), /* DMA on CF Card */
345
346 /* ATAPI command types */
347 ATAPI_READ = 0, /* READs */
348 ATAPI_WRITE = 1, /* WRITEs */
349 ATAPI_READ_CD = 2, /* READ CD [MSF] */
350 ATAPI_PASS_THRU = 3, /* SAT pass-thru */
351 ATAPI_MISC = 4, /* the rest */
352};
353
354enum ata_xfer_mask {
355 ATA_MASK_PIO = ((1LU << ATA_NR_PIO_MODES) - 1)
356 << ATA_SHIFT_PIO,
357 ATA_MASK_MWDMA = ((1LU << ATA_NR_MWDMA_MODES) - 1)
358 << ATA_SHIFT_MWDMA,
359 ATA_MASK_UDMA = ((1LU << ATA_NR_UDMA_MODES) - 1)
360 << ATA_SHIFT_UDMA,
361};
362
363enum hsm_task_states {
364 HSM_ST_IDLE, /* no command on going */
365 HSM_ST_FIRST, /* (waiting the device to)
366 write CDB or first data block */
367 HSM_ST, /* (waiting the device to) transfer data */
368 HSM_ST_LAST, /* (waiting the device to) complete command */
369 HSM_ST_ERR, /* error */
370};
371
372enum ata_completion_errors {
373 AC_ERR_DEV = (1 << 0), /* device reported error */
374 AC_ERR_HSM = (1 << 1), /* host state machine violation */
375 AC_ERR_TIMEOUT = (1 << 2), /* timeout */
376 AC_ERR_MEDIA = (1 << 3), /* media error */
377 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
378 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
379 AC_ERR_SYSTEM = (1 << 6), /* system error */
380 AC_ERR_INVALID = (1 << 7), /* invalid argument */
381 AC_ERR_OTHER = (1 << 8), /* unknown */
382 AC_ERR_NODEV_HINT = (1 << 9), /* polling device detection hint */
383 AC_ERR_NCQ = (1 << 10), /* marker for offending NCQ qc */
384};
385
386/* forward declarations */
387struct scsi_device;
388struct ata_port_operations;
389struct ata_port;
390struct ata_link;
391struct ata_queued_cmd;
392
393/* typedefs */
394typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
395typedef int (*ata_prereset_fn_t)(struct ata_link *link, unsigned long deadline);
396typedef int (*ata_reset_fn_t)(struct ata_link *link, unsigned int *classes,
397 unsigned long deadline);
398typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes);
399
400/*
401 * host pm policy: If you alter this, you also need to alter libata-scsi.c
402 * (for the ascii descriptions)
403 */
404enum link_pm {
405 NOT_AVAILABLE,
406 MIN_POWER,
407 MAX_PERFORMANCE,
408 MEDIUM_POWER,
409};
410extern struct class_device_attribute class_device_attr_link_power_management_policy;
411
412struct ata_ioports {
413 void __iomem *cmd_addr;
414 void __iomem *data_addr;
415 void __iomem *error_addr;
416 void __iomem *feature_addr;
417 void __iomem *nsect_addr;
418 void __iomem *lbal_addr;
419 void __iomem *lbam_addr;
420 void __iomem *lbah_addr;
421 void __iomem *device_addr;
422 void __iomem *status_addr;
423 void __iomem *command_addr;
424 void __iomem *altstatus_addr;
425 void __iomem *ctl_addr;
426 void __iomem *bmdma_addr;
427 void __iomem *scr_addr;
428};
429
430struct ata_host {
431 spinlock_t lock;
432 struct device *dev;
433 void __iomem * const *iomap;
434 unsigned int n_ports;
435 void *private_data;
436 const struct ata_port_operations *ops;
437 unsigned long flags;
438#ifdef CONFIG_ATA_ACPI
439 acpi_handle acpi_handle;
440#endif
441 struct ata_port *simplex_claimed; /* channel owning the DMA */
442 struct ata_port *ports[0];
443};
444
445struct ata_queued_cmd {
446 struct ata_port *ap;
447 struct ata_device *dev;
448
449 struct scsi_cmnd *scsicmd;
450 void (*scsidone)(struct scsi_cmnd *);
451
452 struct ata_taskfile tf;
453 u8 cdb[ATAPI_CDB_LEN];
454
455 unsigned long flags; /* ATA_QCFLAG_xxx */
456 unsigned int tag;
457 unsigned int n_elem;
458
459 int dma_dir;
460
461 unsigned int sect_size;
462
463 unsigned int nbytes;
464 unsigned int extrabytes;
465 unsigned int curbytes;
466
467 struct scatterlist *cursg;
468 unsigned int cursg_ofs;
469
470 struct scatterlist sgent;
471
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
482struct ata_port_stats {
483 unsigned long unhandled_irq;
484 unsigned long idle_irq;
485 unsigned long rw_reqbuf;
486};
487
488struct ata_ering_entry {
489 unsigned int eflags;
490 unsigned int err_mask;
491 u64 timestamp;
492};
493
494struct ata_ering {
495 int cursor;
496 struct ata_ering_entry ring[ATA_ERING_SIZE];
497};
498
499struct 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 long pio_mask;
530 unsigned long mwdma_mask;
531 unsigned long 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
548struct 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
562struct 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
571struct ata_acpi_drive
572{
573 u32 pio;
574 u32 dma;
575} __packed;
576
577struct ata_acpi_gtm {
578 struct ata_acpi_drive drive[2];
579 u32 flags;
580} __packed;
581
582struct 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
603struct 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 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
616
617 u8 ctl; /* cache of ATA control register */
618 u8 last_ctl; /* Cache last written value */
619 unsigned int pio_mask;
620 unsigned int mwdma_mask;
621 unsigned int udma_mask;
622 unsigned int cbl; /* cable type; ATA_CBL_xxx */
623
624 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
625 unsigned long qc_allocated;
626 unsigned int qc_active;
627 int nr_active_links; /* #links with active qcs */
628
629 struct ata_link link; /* host default link */
630
631 int nr_pmp_links; /* nr of available PMP links */
632 struct ata_link *pmp_link; /* array of PMP links */
633 struct ata_link *excl_link; /* for PMP qc exclusion */
634
635 struct ata_port_stats stats;
636 struct ata_host *host;
637 struct device *dev;
638
639 void *port_task_data;
640 struct delayed_work port_task;
641 struct delayed_work hotplug_task;
642 struct work_struct scsi_rescan_task;
643
644 unsigned int hsm_task_state;
645
646 u32 msg_enable;
647 struct list_head eh_done_q;
648 wait_queue_head_t eh_wait_q;
649 int eh_tries;
650
651 pm_message_t pm_mesg;
652 int *pm_result;
653 enum link_pm pm_policy;
654
655 struct timer_list fastdrain_timer;
656 unsigned long fastdrain_cnt;
657
658 void *private_data;
659
660#ifdef CONFIG_ATA_ACPI
661 acpi_handle acpi_handle;
662 struct ata_acpi_gtm __acpi_init_gtm; /* use ata_acpi_init_gtm() */
663#endif
664 u8 sector_buf[ATA_SECT_SIZE]; /* owned by EH */
665};
666
667struct ata_port_operations {
668 /*
669 * Command execution
670 */
671 int (*qc_defer)(struct ata_queued_cmd *qc);
672 int (*check_atapi_dma)(struct ata_queued_cmd *qc);
673 void (*qc_prep)(struct ata_queued_cmd *qc);
674 unsigned int (*qc_issue)(struct ata_queued_cmd *qc);
675
676 /*
677 * Configuration and exception handling
678 */
679 int (*cable_detect)(struct ata_port *ap);
680 unsigned long (*mode_filter)(struct ata_device *dev, unsigned long xfer_mask);
681 void (*set_piomode)(struct ata_port *ap, struct ata_device *dev);
682 void (*set_dmamode)(struct ata_port *ap, struct ata_device *dev);
683 int (*set_mode)(struct ata_link *link, struct ata_device **r_failed_dev);
684
685 void (*dev_config)(struct ata_device *dev);
686
687 void (*freeze)(struct ata_port *ap);
688 void (*thaw)(struct ata_port *ap);
689 void (*error_handler)(struct ata_port *ap);
690 void (*post_internal_cmd)(struct ata_queued_cmd *qc);
691
692 /*
693 * Optional features
694 */
695 int (*scr_read)(struct ata_port *ap, unsigned int sc_reg, u32 *val);
696 int (*scr_write)(struct ata_port *ap, unsigned int sc_reg, u32 val);
697 void (*pmp_attach)(struct ata_port *ap);
698 void (*pmp_detach)(struct ata_port *ap);
699 int (*enable_pm)(struct ata_port *ap, enum link_pm policy);
700 void (*disable_pm)(struct ata_port *ap);
701
702 /*
703 * Start, stop, suspend and resume
704 */
705 int (*port_suspend)(struct ata_port *ap, pm_message_t mesg);
706 int (*port_resume)(struct ata_port *ap);
707 int (*port_start)(struct ata_port *ap);
708 void (*port_stop)(struct ata_port *ap);
709 void (*host_stop)(struct ata_host *host);
710
711 /*
712 * SFF / taskfile oriented ops
713 */
714 void (*dev_select)(struct ata_port *ap, unsigned int device);
715 u8 (*check_status)(struct ata_port *ap);
716 u8 (*check_altstatus)(struct ata_port *ap);
717 void (*tf_load)(struct ata_port *ap, const struct ata_taskfile *tf);
718 void (*tf_read)(struct ata_port *ap, struct ata_taskfile *tf);
719 void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
720 unsigned int (*data_xfer)(struct ata_device *dev, unsigned char *buf,
721 unsigned int buflen, int rw);
722 u8 (*irq_on)(struct ata_port *);
723
724 void (*irq_clear)(struct ata_port *);
725 void (*bmdma_setup)(struct ata_queued_cmd *qc);
726 void (*bmdma_start)(struct ata_queued_cmd *qc);
727 void (*bmdma_stop)(struct ata_queued_cmd *qc);
728 u8 (*bmdma_status)(struct ata_port *ap);
729
730 /*
731 * Obsolete
732 */
733 void (*phy_reset)(struct ata_port *ap);
734 void (*eng_timeout)(struct ata_port *ap);
735 irq_handler_t irq_handler;
736};
737
738struct ata_port_info {
739 struct scsi_host_template *sht;
740 unsigned long flags;
741 unsigned long link_flags;
742 unsigned long pio_mask;
743 unsigned long mwdma_mask;
744 unsigned long udma_mask;
745 const struct ata_port_operations *port_ops;
746 irq_handler_t irq_handler;
747 void *private_data;
748};
749
750struct ata_timing {
751 unsigned short mode; /* ATA mode */
752 unsigned short setup; /* t1 */
753 unsigned short act8b; /* t2 for 8-bit I/O */
754 unsigned short rec8b; /* t2i for 8-bit I/O */
755 unsigned short cyc8b; /* t0 for 8-bit I/O */
756 unsigned short active; /* t2 or tD */
757 unsigned short recover; /* t2i or tK */
758 unsigned short cycle; /* t0 */
759 unsigned short udma; /* t2CYCTYP/2 */
760};
761
762#define FIT(v, vmin, vmax) max_t(short, min_t(short, v, vmax), vmin)
763
764extern const unsigned long sata_deb_timing_normal[];
765extern const unsigned long sata_deb_timing_hotplug[];
766extern const unsigned long sata_deb_timing_long[];
767
768extern const struct ata_port_operations ata_dummy_port_ops;
769extern const struct ata_port_info ata_dummy_port_info;
770
771static inline const unsigned long *
772sata_ehc_deb_timing(struct ata_eh_context *ehc)
773{
774 if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
775 return sata_deb_timing_hotplug;
776 else
777 return sata_deb_timing_normal;
778}
779
780static inline int ata_port_is_dummy(struct ata_port *ap)
781{
782 return ap->ops == &ata_dummy_port_ops;
783}
784
785extern void sata_print_link_status(struct ata_link *link);
786extern void ata_port_probe(struct ata_port *);
787extern void ata_bus_reset(struct ata_port *ap);
788extern int sata_set_spd(struct ata_link *link);
789extern int sata_link_debounce(struct ata_link *link,
790 const unsigned long *params, unsigned long deadline);
791extern int sata_link_resume(struct ata_link *link, const unsigned long *params,
792 unsigned long deadline);
793extern int ata_std_prereset(struct ata_link *link, unsigned long deadline);
794extern int ata_std_softreset(struct ata_link *link, unsigned int *classes,
795 unsigned long deadline);
796extern int sata_link_hardreset(struct ata_link *link,
797 const unsigned long *timing, unsigned long deadline);
798extern int sata_std_hardreset(struct ata_link *link, unsigned int *class,
799 unsigned long deadline);
800extern void ata_std_postreset(struct ata_link *link, unsigned int *classes);
801extern void ata_port_disable(struct ata_port *);
802extern void ata_std_ports(struct ata_ioports *ioaddr);
803
804extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
805extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
806 const struct ata_port_info * const * ppi, int n_ports);
807extern int ata_host_start(struct ata_host *host);
808extern int ata_host_register(struct ata_host *host,
809 struct scsi_host_template *sht);
810extern int ata_host_activate(struct ata_host *host, int irq,
811 irq_handler_t irq_handler, unsigned long irq_flags,
812 struct scsi_host_template *sht);
813extern void ata_host_detach(struct ata_host *host);
814extern void ata_host_init(struct ata_host *, struct device *,
815 unsigned long, const struct ata_port_operations *);
816extern int ata_scsi_detect(struct scsi_host_template *sht);
817extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
818extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
819extern void ata_sas_port_destroy(struct ata_port *);
820extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
821 struct ata_port_info *, struct Scsi_Host *);
822extern int ata_sas_port_init(struct ata_port *);
823extern int ata_sas_port_start(struct ata_port *ap);
824extern void ata_sas_port_stop(struct ata_port *ap);
825extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
826extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
827 struct ata_port *ap);
828extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
829extern int sata_scr_valid(struct ata_link *link);
830extern int sata_scr_read(struct ata_link *link, int reg, u32 *val);
831extern int sata_scr_write(struct ata_link *link, int reg, u32 val);
832extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val);
833extern int ata_link_online(struct ata_link *link);
834extern int ata_link_offline(struct ata_link *link);
835#ifdef CONFIG_PM
836extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
837extern void ata_host_resume(struct ata_host *host);
838#endif
839extern int ata_ratelimit(void);
840extern int ata_busy_sleep(struct ata_port *ap,
841 unsigned long timeout_pat, unsigned long timeout);
842extern void ata_wait_after_reset(struct ata_port *ap, unsigned long deadline);
843extern int ata_wait_ready(struct ata_port *ap, unsigned long deadline);
844extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
845 unsigned long interval_msec,
846 unsigned long timeout_msec);
847extern unsigned int ata_dev_try_classify(struct ata_device *dev, int present,
848 u8 *r_err);
849
850/*
851 * Default driver ops implementations
852 */
853extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
854extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
855extern int atapi_cmd_type(u8 opcode);
856extern void ata_tf_to_fis(const struct ata_taskfile *tf,
857 u8 pmp, int is_cmd, u8 *fis);
858extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
859extern unsigned long ata_pack_xfermask(unsigned long pio_mask,
860 unsigned long mwdma_mask, unsigned long udma_mask);
861extern void ata_unpack_xfermask(unsigned long xfer_mask,
862 unsigned long *pio_mask, unsigned long *mwdma_mask,
863 unsigned long *udma_mask);
864extern u8 ata_xfer_mask2mode(unsigned long xfer_mask);
865extern unsigned long ata_xfer_mode2mask(u8 xfer_mode);
866extern int ata_xfer_mode2shift(unsigned long xfer_mode);
867extern const char *ata_mode_string(unsigned long xfer_mask);
868extern unsigned long ata_id_xfermask(const u16 *id);
869extern void ata_noop_dev_select(struct ata_port *ap, unsigned int device);
870extern void ata_std_dev_select(struct ata_port *ap, unsigned int device);
871extern u8 ata_check_status(struct ata_port *ap);
872extern u8 ata_altstatus(struct ata_port *ap);
873extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
874extern int ata_port_start(struct ata_port *ap);
875extern int ata_sff_port_start(struct ata_port *ap);
876extern irqreturn_t ata_interrupt(int irq, void *dev_instance);
877extern unsigned int ata_data_xfer(struct ata_device *dev,
878 unsigned char *buf, unsigned int buflen, int rw);
879extern unsigned int ata_data_xfer_noirq(struct ata_device *dev,
880 unsigned char *buf, unsigned int buflen, int rw);
881extern int ata_std_qc_defer(struct ata_queued_cmd *qc);
882extern void ata_dumb_qc_prep(struct ata_queued_cmd *qc);
883extern void ata_qc_prep(struct ata_queued_cmd *qc);
884extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
885extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
886extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
887 unsigned int n_elem);
888extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
889extern void ata_dev_disable(struct ata_device *adev);
890extern void ata_id_string(const u16 *id, unsigned char *s,
891 unsigned int ofs, unsigned int len);
892extern void ata_id_c_string(const u16 *id, unsigned char *s,
893 unsigned int ofs, unsigned int len);
894extern void ata_bmdma_setup(struct ata_queued_cmd *qc);
895extern void ata_bmdma_start(struct ata_queued_cmd *qc);
896extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
897extern u8 ata_bmdma_status(struct ata_port *ap);
898extern void ata_bmdma_irq_clear(struct ata_port *ap);
899extern void ata_bmdma_freeze(struct ata_port *ap);
900extern void ata_bmdma_thaw(struct ata_port *ap);
901extern void ata_bmdma_drive_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
902 ata_reset_fn_t softreset,
903 ata_reset_fn_t hardreset,
904 ata_postreset_fn_t postreset);
905extern void ata_bmdma_error_handler(struct ata_port *ap);
906extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
907extern int ata_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
908 u8 status, int in_wq);
909extern void ata_qc_complete(struct ata_queued_cmd *qc);
910extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active,
911 void (*finish_qc)(struct ata_queued_cmd *));
912extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
913 void (*done)(struct scsi_cmnd *));
914extern int ata_std_bios_param(struct scsi_device *sdev,
915 struct block_device *bdev,
916 sector_t capacity, int geom[]);
917extern int ata_scsi_slave_config(struct scsi_device *sdev);
918extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
919extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
920 int queue_depth);
921extern struct ata_device *ata_dev_pair(struct ata_device *adev);
922extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
923extern u8 ata_irq_on(struct ata_port *ap);
924
925extern int ata_cable_40wire(struct ata_port *ap);
926extern int ata_cable_80wire(struct ata_port *ap);
927extern int ata_cable_sata(struct ata_port *ap);
928extern int ata_cable_ignore(struct ata_port *ap);
929extern int ata_cable_unknown(struct ata_port *ap);
930
931/*
932 * Timing helpers
933 */
934
935extern unsigned int ata_pio_need_iordy(const struct ata_device *);
936extern const struct ata_timing *ata_timing_find_mode(u8 xfer_mode);
937extern int ata_timing_compute(struct ata_device *, unsigned short,
938 struct ata_timing *, int, int);
939extern void ata_timing_merge(const struct ata_timing *,
940 const struct ata_timing *, struct ata_timing *,
941 unsigned int);
942extern u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle);
943
944enum {
945 ATA_TIMING_SETUP = (1 << 0),
946 ATA_TIMING_ACT8B = (1 << 1),
947 ATA_TIMING_REC8B = (1 << 2),
948 ATA_TIMING_CYC8B = (1 << 3),
949 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
950 ATA_TIMING_CYC8B,
951 ATA_TIMING_ACTIVE = (1 << 4),
952 ATA_TIMING_RECOVER = (1 << 5),
953 ATA_TIMING_CYCLE = (1 << 6),
954 ATA_TIMING_UDMA = (1 << 7),
955 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
956 ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
957 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
958 ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
959};
960
961/* libata-acpi.c */
962#ifdef CONFIG_ATA_ACPI
963static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
964{
965 if (ap->pflags & ATA_PFLAG_INIT_GTM_VALID)
966 return &ap->__acpi_init_gtm;
967 return NULL;
968}
969int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm);
970int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *stm);
971unsigned long ata_acpi_gtm_xfermask(struct ata_device *dev,
972 const struct ata_acpi_gtm *gtm);
973int ata_acpi_cbl_80wire(struct ata_port *ap, const struct ata_acpi_gtm *gtm);
974#else
975static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
976{
977 return NULL;
978}
979
980static inline int ata_acpi_stm(const struct ata_port *ap,
981 struct ata_acpi_gtm *stm)
982{
983 return -ENOSYS;
984}
985
986static inline int ata_acpi_gtm(const struct ata_port *ap,
987 struct ata_acpi_gtm *stm)
988{
989 return -ENOSYS;
990}
991
992static inline unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev,
993 const struct ata_acpi_gtm *gtm)
994{
995 return 0;
996}
997
998static inline int ata_acpi_cbl_80wire(struct ata_port *ap,
999 const struct ata_acpi_gtm *gtm)
1000{
1001 return 0;
1002}
1003#endif
1004
1005#ifdef CONFIG_PCI
1006struct pci_dev;
1007
1008extern int ata_pci_init_one(struct pci_dev *pdev,
1009 const struct ata_port_info * const * ppi);
1010extern void ata_pci_remove_one(struct pci_dev *pdev);
1011#ifdef CONFIG_PM
1012extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
1013extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
1014extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
1015extern int ata_pci_device_resume(struct pci_dev *pdev);
1016#endif
1017extern int ata_pci_clear_simplex(struct pci_dev *pdev);
1018
1019struct pci_bits {
1020 unsigned int reg; /* PCI config register to read */
1021 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
1022 unsigned long mask;
1023 unsigned long val;
1024};
1025
1026extern int ata_pci_init_sff_host(struct ata_host *host);
1027extern int ata_pci_init_bmdma(struct ata_host *host);
1028extern int ata_pci_prepare_sff_host(struct pci_dev *pdev,
1029 const struct ata_port_info * const * ppi,
1030 struct ata_host **r_host);
1031extern int ata_pci_activate_sff_host(struct ata_host *host,
1032 irq_handler_t irq_handler,
1033 struct scsi_host_template *sht);
1034extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
1035extern unsigned long ata_pci_default_filter(struct ata_device *dev,
1036 unsigned long xfer_mask);
1037#endif /* CONFIG_PCI */
1038
1039/*
1040 * PMP
1041 */
1042extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc);
1043extern int sata_pmp_std_prereset(struct ata_link *link, unsigned long deadline);
1044extern int sata_pmp_std_hardreset(struct ata_link *link, unsigned int *class,
1045 unsigned long deadline);
1046extern void sata_pmp_std_postreset(struct ata_link *link, unsigned int *class);
1047extern void sata_pmp_do_eh(struct ata_port *ap,
1048 ata_prereset_fn_t prereset, ata_reset_fn_t softreset,
1049 ata_reset_fn_t hardreset, ata_postreset_fn_t postreset,
1050 ata_prereset_fn_t pmp_prereset, ata_reset_fn_t pmp_softreset,
1051 ata_reset_fn_t pmp_hardreset, ata_postreset_fn_t pmp_postreset);
1052
1053/*
1054 * EH
1055 */
1056extern void ata_port_schedule_eh(struct ata_port *ap);
1057extern int ata_link_abort(struct ata_link *link);
1058extern int ata_port_abort(struct ata_port *ap);
1059extern int ata_port_freeze(struct ata_port *ap);
1060extern int sata_async_notification(struct ata_port *ap);
1061
1062extern void ata_eh_freeze_port(struct ata_port *ap);
1063extern void ata_eh_thaw_port(struct ata_port *ap);
1064
1065extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
1066extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
1067
1068extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
1069 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
1070 ata_postreset_fn_t postreset);
1071
1072/*
1073 * printk helpers
1074 */
1075#define ata_port_printk(ap, lv, fmt, args...) \
1076 printk("%sata%u: "fmt, lv, (ap)->print_id , ##args)
1077
1078#define ata_link_printk(link, lv, fmt, args...) do { \
1079 if ((link)->ap->nr_pmp_links) \
1080 printk("%sata%u.%02u: "fmt, lv, (link)->ap->print_id, \
1081 (link)->pmp , ##args); \
1082 else \
1083 printk("%sata%u: "fmt, lv, (link)->ap->print_id , ##args); \
1084 } while(0)
1085
1086#define ata_dev_printk(dev, lv, fmt, args...) \
1087 printk("%sata%u.%02u: "fmt, lv, (dev)->link->ap->print_id, \
1088 (dev)->link->pmp + (dev)->devno , ##args)
1089
1090/*
1091 * ata_eh_info helpers
1092 */
1093extern void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...)
1094 __attribute__ ((format (printf, 2, 3)));
1095extern void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...)
1096 __attribute__ ((format (printf, 2, 3)));
1097extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
1098
1099static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
1100{
1101 ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
1102 ehi->flags |= ATA_EHI_HOTPLUGGED;
1103 ehi->action |= ATA_EH_RESET | ATA_EH_ENABLE_LINK;
1104 ehi->err_mask |= AC_ERR_ATA_BUS;
1105}
1106
1107/*
1108 * port description helpers
1109 */
1110extern void ata_port_desc(struct ata_port *ap, const char *fmt, ...)
1111 __attribute__ ((format (printf, 2, 3)));
1112#ifdef CONFIG_PCI
1113extern void ata_port_pbar_desc(struct ata_port *ap, int bar, ssize_t offset,
1114 const char *name);
1115#endif
1116
1117static inline unsigned int ata_tag_valid(unsigned int tag)
1118{
1119 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
1120}
1121
1122static inline unsigned int ata_tag_internal(unsigned int tag)
1123{
1124 return tag == ATA_MAX_QUEUE - 1;
1125}
1126
1127/*
1128 * device helpers
1129 */
1130static inline unsigned int ata_class_enabled(unsigned int class)
1131{
1132 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI ||
1133 class == ATA_DEV_PMP || class == ATA_DEV_SEMB;
1134}
1135
1136static inline unsigned int ata_class_disabled(unsigned int class)
1137{
1138 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP ||
1139 class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP;
1140}
1141
1142static inline unsigned int ata_class_absent(unsigned int class)
1143{
1144 return !ata_class_enabled(class) && !ata_class_disabled(class);
1145}
1146
1147static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1148{
1149 return ata_class_enabled(dev->class);
1150}
1151
1152static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1153{
1154 return ata_class_disabled(dev->class);
1155}
1156
1157static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1158{
1159 return ata_class_absent(dev->class);
1160}
1161
1162/*
1163 * link helpers
1164 */
1165static inline int ata_is_host_link(const struct ata_link *link)
1166{
1167 return link == &link->ap->link;
1168}
1169
1170static inline int ata_link_max_devices(const struct ata_link *link)
1171{
1172 if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS)
1173 return 2;
1174 return 1;
1175}
1176
1177static inline int ata_link_active(struct ata_link *link)
1178{
1179 return ata_tag_valid(link->active_tag) || link->sactive;
1180}
1181
1182static inline struct ata_link *ata_port_first_link(struct ata_port *ap)
1183{
1184 if (ap->nr_pmp_links)
1185 return ap->pmp_link;
1186 return &ap->link;
1187}
1188
1189static inline struct ata_link *ata_port_next_link(struct ata_link *link)
1190{
1191 struct ata_port *ap = link->ap;
1192
1193 if (link == &ap->link) {
1194 if (!ap->nr_pmp_links)
1195 return NULL;
1196 return ap->pmp_link;
1197 }
1198
1199 if (++link < ap->nr_pmp_links + ap->pmp_link)
1200 return link;
1201 return NULL;
1202}
1203
1204#define __ata_port_for_each_link(lk, ap) \
1205 for ((lk) = &(ap)->link; (lk); (lk) = ata_port_next_link(lk))
1206
1207#define ata_port_for_each_link(link, ap) \
1208 for ((link) = ata_port_first_link(ap); (link); \
1209 (link) = ata_port_next_link(link))
1210
1211#define ata_link_for_each_dev(dev, link) \
1212 for ((dev) = (link)->device; \
1213 (dev) < (link)->device + ata_link_max_devices(link) || ((dev) = NULL); \
1214 (dev)++)
1215
1216#define ata_link_for_each_dev_reverse(dev, link) \
1217 for ((dev) = (link)->device + ata_link_max_devices(link) - 1; \
1218 (dev) >= (link)->device || ((dev) = NULL); (dev)--)
1219
1220static inline u8 ata_chk_status(struct ata_port *ap)
1221{
1222 return ap->ops->check_status(ap);
1223}
1224
1225/**
1226 * ata_ncq_enabled - Test whether NCQ is enabled
1227 * @dev: ATA device to test for
1228 *
1229 * LOCKING:
1230 * spin_lock_irqsave(host lock)
1231 *
1232 * RETURNS:
1233 * 1 if NCQ is enabled for @dev, 0 otherwise.
1234 */
1235static inline int ata_ncq_enabled(struct ata_device *dev)
1236{
1237 return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1238 ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1239}
1240
1241/**
1242 * ata_pause - Flush writes and pause 400 nanoseconds.
1243 * @ap: Port to wait for.
1244 *
1245 * LOCKING:
1246 * Inherited from caller.
1247 */
1248
1249static inline void ata_pause(struct ata_port *ap)
1250{
1251 ata_altstatus(ap);
1252 ndelay(400);
1253}
1254
1255
1256/**
1257 * ata_busy_wait - Wait for a port status register
1258 * @ap: Port to wait for.
1259 * @bits: bits that must be clear
1260 * @max: number of 10uS waits to perform
1261 *
1262 * Waits up to max*10 microseconds for the selected bits in the port's
1263 * status register to be cleared.
1264 * Returns final value of status register.
1265 *
1266 * LOCKING:
1267 * Inherited from caller.
1268 */
1269
1270static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
1271 unsigned int max)
1272{
1273 u8 status;
1274
1275 do {
1276 udelay(10);
1277 status = ata_chk_status(ap);
1278 max--;
1279 } while (status != 0xff && (status & bits) && (max > 0));
1280
1281 return status;
1282}
1283
1284
1285/**
1286 * ata_wait_idle - Wait for a port to be idle.
1287 * @ap: Port to wait for.
1288 *
1289 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
1290 * Returns final value of status register.
1291 *
1292 * LOCKING:
1293 * Inherited from caller.
1294 */
1295
1296static inline u8 ata_wait_idle(struct ata_port *ap)
1297{
1298 u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1299
1300#ifdef ATA_DEBUG
1301 if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
1302 ata_port_printk(ap, KERN_DEBUG, "abnormal Status 0x%X\n",
1303 status);
1304#endif
1305
1306 return status;
1307}
1308
1309static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1310{
1311 qc->tf.ctl |= ATA_NIEN;
1312}
1313
1314static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1315 unsigned int tag)
1316{
1317 if (likely(ata_tag_valid(tag)))
1318 return &ap->qcmd[tag];
1319 return NULL;
1320}
1321
1322static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1323 unsigned int tag)
1324{
1325 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1326
1327 if (unlikely(!qc) || !ap->ops->error_handler)
1328 return qc;
1329
1330 if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1331 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1332 return qc;
1333
1334 return NULL;
1335}
1336
1337static inline unsigned int ata_qc_raw_nbytes(struct ata_queued_cmd *qc)
1338{
1339 return qc->nbytes - min(qc->extrabytes, qc->nbytes);
1340}
1341
1342static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1343{
1344 memset(tf, 0, sizeof(*tf));
1345
1346 tf->ctl = dev->link->ap->ctl;
1347 if (dev->devno == 0)
1348 tf->device = ATA_DEVICE_OBS;
1349 else
1350 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1351}
1352
1353static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1354{
1355 qc->dma_dir = DMA_NONE;
1356 qc->sg = NULL;
1357 qc->flags = 0;
1358 qc->cursg = NULL;
1359 qc->cursg_ofs = 0;
1360 qc->nbytes = qc->extrabytes = qc->curbytes = 0;
1361 qc->n_elem = 0;
1362 qc->err_mask = 0;
1363 qc->sect_size = ATA_SECT_SIZE;
1364
1365 ata_tf_init(qc->dev, &qc->tf);
1366
1367 /* init result_tf such that it indicates normal completion */
1368 qc->result_tf.command = ATA_DRDY;
1369 qc->result_tf.feature = 0;
1370}
1371
1372static inline int ata_try_flush_cache(const struct ata_device *dev)
1373{
1374 return ata_id_wcache_enabled(dev->id) ||
1375 ata_id_has_flush(dev->id) ||
1376 ata_id_has_flush_ext(dev->id);
1377}
1378
1379static inline unsigned int ac_err_mask(u8 status)
1380{
1381 if (status & (ATA_BUSY | ATA_DRQ))
1382 return AC_ERR_HSM;
1383 if (status & (ATA_ERR | ATA_DF))
1384 return AC_ERR_DEV;
1385 return 0;
1386}
1387
1388static inline unsigned int __ac_err_mask(u8 status)
1389{
1390 unsigned int mask = ac_err_mask(status);
1391 if (mask == 0)
1392 return AC_ERR_OTHER;
1393 return mask;
1394}
1395
1396static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1397{
1398 return *(struct ata_port **)&host->hostdata[0];
1399}
1400
1401#endif /* __LINUX_LIBATA_H__ */
Linux kernel - Deliverables
This page took 0.029433 seconds and 5 git commands to generate.