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