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