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