]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blob - include/linux/libata.h
projects / mirror_ubuntu-artful-kernel.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
libata: add deadline support to prereset and reset methods
[mirror_ubuntu-artful-kernel.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/pci.h>
32 #include <linux/dma-mapping.h>
33 #include <asm/scatterlist.h>
34 #include <linux/io.h>
35 #include <linux/ata.h>
36 #include <linux/workqueue.h>
37 #include <scsi/scsi_host.h>
38 #include <linux/acpi.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 /* move to PCI layer? */
111 static inline struct device *pci_dev_to_dev(struct pci_dev *pdev)
112 {
113 return &pdev->dev;
114 }
115
116 enum {
117 /* various global constants */
118 LIBATA_MAX_PRD = ATA_MAX_PRD / 2,
119 ATA_MAX_PORTS = 8,
120 ATA_DEF_QUEUE = 1,
121 /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
122 ATA_MAX_QUEUE = 32,
123 ATA_TAG_INTERNAL = ATA_MAX_QUEUE - 1,
124 ATA_MAX_BUS = 2,
125 ATA_DEF_BUSY_WAIT = 10000,
126 ATA_SHORT_PAUSE = (HZ >> 6) + 1,
127
128 ATA_SHT_EMULATED = 1,
129 ATA_SHT_CMD_PER_LUN = 1,
130 ATA_SHT_THIS_ID = -1,
131 ATA_SHT_USE_CLUSTERING = 1,
132
133 /* struct ata_device stuff */
134 ATA_DFLAG_LBA = (1 << 0), /* device supports LBA */
135 ATA_DFLAG_LBA48 = (1 << 1), /* device supports LBA48 */
136 ATA_DFLAG_CDB_INTR = (1 << 2), /* device asserts INTRQ when ready for CDB */
137 ATA_DFLAG_NCQ = (1 << 3), /* device supports NCQ */
138 ATA_DFLAG_FLUSH_EXT = (1 << 4), /* do FLUSH_EXT instead of FLUSH */
139 ATA_DFLAG_CFG_MASK = (1 << 8) - 1,
140
141 ATA_DFLAG_PIO = (1 << 8), /* device limited to PIO mode */
142 ATA_DFLAG_NCQ_OFF = (1 << 9), /* device limited to non-NCQ mode */
143 ATA_DFLAG_SUSPENDED = (1 << 10), /* device suspended */
144 ATA_DFLAG_INIT_MASK = (1 << 16) - 1,
145
146 ATA_DFLAG_DETACH = (1 << 16),
147 ATA_DFLAG_DETACHED = (1 << 17),
148
149 ATA_DEV_UNKNOWN = 0, /* unknown device */
150 ATA_DEV_ATA = 1, /* ATA device */
151 ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */
152 ATA_DEV_ATAPI = 3, /* ATAPI device */
153 ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */
154 ATA_DEV_NONE = 5, /* no device */
155
156 /* struct ata_port flags */
157 ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */
158 /* (doesn't imply presence) */
159 ATA_FLAG_SATA = (1 << 1),
160 ATA_FLAG_NO_LEGACY = (1 << 2), /* no legacy mode check */
161 ATA_FLAG_MMIO = (1 << 3), /* use MMIO, not PIO */
162 ATA_FLAG_SRST = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */
163 ATA_FLAG_SATA_RESET = (1 << 5), /* (obsolete) use COMRESET */
164 ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */
165 ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */
166 ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */
167 ATA_FLAG_PIO_POLLING = (1 << 9), /* use polling PIO if LLD
168 * doesn't handle PIO interrupts */
169 ATA_FLAG_NCQ = (1 << 10), /* host supports NCQ */
170 ATA_FLAG_HRST_TO_RESUME = (1 << 11), /* hardreset to resume phy */
171 ATA_FLAG_SKIP_D2H_BSY = (1 << 12), /* can't wait for the first D2H
172 * Register FIS clearing BSY */
173 ATA_FLAG_DEBUGMSG = (1 << 13),
174 ATA_FLAG_SETXFER_POLLING= (1 << 14), /* use polling for SETXFER */
175 ATA_FLAG_IGN_SIMPLEX = (1 << 15), /* ignore SIMPLEX */
176 ATA_FLAG_NO_IORDY = (1 << 16), /* controller lacks iordy */
177
178 /* The following flag belongs to ap->pflags but is kept in
179 * ap->flags because it's referenced in many LLDs and will be
180 * removed in not-too-distant future.
181 */
182 ATA_FLAG_DISABLED = (1 << 23), /* port is disabled, ignore it */
183
184 /* bits 24:31 of ap->flags are reserved for LLD specific flags */
185
186 /* struct ata_port pflags */
187 ATA_PFLAG_EH_PENDING = (1 << 0), /* EH pending */
188 ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */
189 ATA_PFLAG_FROZEN = (1 << 2), /* port is frozen */
190 ATA_PFLAG_RECOVERED = (1 << 3), /* recovery action performed */
191 ATA_PFLAG_LOADING = (1 << 4), /* boot/loading probe */
192 ATA_PFLAG_UNLOADING = (1 << 5), /* module is unloading */
193 ATA_PFLAG_SCSI_HOTPLUG = (1 << 6), /* SCSI hotplug scheduled */
194
195 ATA_PFLAG_FLUSH_PORT_TASK = (1 << 16), /* flush port task */
196 ATA_PFLAG_SUSPENDED = (1 << 17), /* port is suspended (power) */
197 ATA_PFLAG_PM_PENDING = (1 << 18), /* PM operation pending */
198
199 /* struct ata_queued_cmd flags */
200 ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */
201 ATA_QCFLAG_SG = (1 << 1), /* have s/g table? */
202 ATA_QCFLAG_SINGLE = (1 << 2), /* no s/g, just a single buffer */
203 ATA_QCFLAG_DMAMAP = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE,
204 ATA_QCFLAG_IO = (1 << 3), /* standard IO command */
205 ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */
206
207 ATA_QCFLAG_FAILED = (1 << 16), /* cmd failed and is owned by EH */
208 ATA_QCFLAG_SENSE_VALID = (1 << 17), /* sense data valid */
209 ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
210
211 /* host set flags */
212 ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host only */
213 ATA_HOST_STARTED = (1 << 1), /* Host started */
214
215 /* various lengths of time */
216 ATA_TMOUT_BOOT = 30 * HZ, /* heuristic */
217 ATA_TMOUT_BOOT_QUICK = 7 * HZ, /* heuristic */
218 ATA_TMOUT_INTERNAL = 30 * HZ,
219 ATA_TMOUT_INTERNAL_QUICK = 5 * HZ,
220
221 /* ATA bus states */
222 BUS_UNKNOWN = 0,
223 BUS_DMA = 1,
224 BUS_IDLE = 2,
225 BUS_NOINTR = 3,
226 BUS_NODATA = 4,
227 BUS_TIMER = 5,
228 BUS_PIO = 6,
229 BUS_EDD = 7,
230 BUS_IDENTIFY = 8,
231 BUS_PACKET = 9,
232
233 /* SATA port states */
234 PORT_UNKNOWN = 0,
235 PORT_ENABLED = 1,
236 PORT_DISABLED = 2,
237
238 /* encoding various smaller bitmaps into a single
239 * unsigned int bitmap
240 */
241 ATA_BITS_PIO = 7,
242 ATA_BITS_MWDMA = 5,
243 ATA_BITS_UDMA = 8,
244
245 ATA_SHIFT_PIO = 0,
246 ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_BITS_PIO,
247 ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_BITS_MWDMA,
248
249 ATA_MASK_PIO = ((1 << ATA_BITS_PIO) - 1) << ATA_SHIFT_PIO,
250 ATA_MASK_MWDMA = ((1 << ATA_BITS_MWDMA) - 1) << ATA_SHIFT_MWDMA,
251 ATA_MASK_UDMA = ((1 << ATA_BITS_UDMA) - 1) << ATA_SHIFT_UDMA,
252
253 /* size of buffer to pad xfers ending on unaligned boundaries */
254 ATA_DMA_PAD_SZ = 4,
255 ATA_DMA_PAD_BUF_SZ = ATA_DMA_PAD_SZ * ATA_MAX_QUEUE,
256
257 /* masks for port functions */
258 ATA_PORT_PRIMARY = (1 << 0),
259 ATA_PORT_SECONDARY = (1 << 1),
260
261 /* ering size */
262 ATA_ERING_SIZE = 32,
263
264 /* desc_len for ata_eh_info and context */
265 ATA_EH_DESC_LEN = 80,
266
267 /* reset / recovery action types */
268 ATA_EH_REVALIDATE = (1 << 0),
269 ATA_EH_SOFTRESET = (1 << 1),
270 ATA_EH_HARDRESET = (1 << 2),
271 ATA_EH_SUSPEND = (1 << 3),
272 ATA_EH_RESUME = (1 << 4),
273 ATA_EH_PM_FREEZE = (1 << 5),
274
275 ATA_EH_RESET_MASK = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
276 ATA_EH_PERDEV_MASK = ATA_EH_REVALIDATE | ATA_EH_SUSPEND |
277 ATA_EH_RESUME | ATA_EH_PM_FREEZE,
278
279 /* ata_eh_info->flags */
280 ATA_EHI_HOTPLUGGED = (1 << 0), /* could have been hotplugged */
281 ATA_EHI_RESUME_LINK = (1 << 1), /* resume link (reset modifier) */
282 ATA_EHI_NO_AUTOPSY = (1 << 2), /* no autopsy */
283 ATA_EHI_QUIET = (1 << 3), /* be quiet */
284
285 ATA_EHI_DID_SOFTRESET = (1 << 16), /* already soft-reset this port */
286 ATA_EHI_DID_HARDRESET = (1 << 17), /* already soft-reset this port */
287 ATA_EHI_PRINTINFO = (1 << 18), /* print configuration info */
288 ATA_EHI_SETMODE = (1 << 19), /* configure transfer mode */
289 ATA_EHI_POST_SETMODE = (1 << 20), /* revaildating after setmode */
290
291 ATA_EHI_DID_RESET = ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
292 ATA_EHI_RESET_MODIFIER_MASK = ATA_EHI_RESUME_LINK,
293
294 /* max repeat if error condition is still set after ->error_handler */
295 ATA_EH_MAX_REPEAT = 5,
296
297 /* how hard are we gonna try to probe/recover devices */
298 ATA_PROBE_MAX_TRIES = 3,
299 ATA_EH_RESET_TRIES = 3,
300 ATA_EH_DEV_TRIES = 3,
301
302 /* Drive spinup time (time from power-on to the first D2H FIS)
303 * in msecs - 8s currently. Failing to get ready in this time
304 * isn't critical. It will result in reset failure for
305 * controllers which can't wait for the first D2H FIS. libata
306 * will retry, so it just has to be long enough to spin up
307 * most devices.
308 */
309 ATA_SPINUP_WAIT = 8000,
310
311 /* Horkage types. May be set by libata or controller on drives
312 (some horkage may be drive/controller pair dependant */
313
314 ATA_HORKAGE_DIAGNOSTIC = (1 << 0), /* Failed boot diag */
315 ATA_HORKAGE_NODMA = (1 << 1), /* DMA problems */
316 ATA_HORKAGE_NONCQ = (1 << 2), /* Don't use NCQ */
317 ATA_HORKAGE_MAX_SEC_128 = (1 << 3), /* Limit max sects to 128 */
318 ATA_HORKAGE_DMA_RW_ONLY = (1 << 4), /* ATAPI DMA for RW only */
319 };
320
321 enum hsm_task_states {
322 HSM_ST_IDLE, /* no command on going */
323 HSM_ST_FIRST, /* (waiting the device to)
324 write CDB or first data block */
325 HSM_ST, /* (waiting the device to) transfer data */
326 HSM_ST_LAST, /* (waiting the device to) complete command */
327 HSM_ST_ERR, /* error */
328 };
329
330 enum ata_completion_errors {
331 AC_ERR_DEV = (1 << 0), /* device reported error */
332 AC_ERR_HSM = (1 << 1), /* host state machine violation */
333 AC_ERR_TIMEOUT = (1 << 2), /* timeout */
334 AC_ERR_MEDIA = (1 << 3), /* media error */
335 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
336 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
337 AC_ERR_SYSTEM = (1 << 6), /* system error */
338 AC_ERR_INVALID = (1 << 7), /* invalid argument */
339 AC_ERR_OTHER = (1 << 8), /* unknown */
340 AC_ERR_NODEV_HINT = (1 << 9), /* polling device detection hint */
341 };
342
343 /* forward declarations */
344 struct scsi_device;
345 struct ata_port_operations;
346 struct ata_port;
347 struct ata_queued_cmd;
348
349 /* typedefs */
350 typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
351 typedef int (*ata_prereset_fn_t)(struct ata_port *ap, unsigned long deadline);
352 typedef int (*ata_reset_fn_t)(struct ata_port *ap, unsigned int *classes,
353 unsigned long deadline);
354 typedef void (*ata_postreset_fn_t)(struct ata_port *ap, unsigned int *classes);
355
356 struct ata_ioports {
357 void __iomem *cmd_addr;
358 void __iomem *data_addr;
359 void __iomem *error_addr;
360 void __iomem *feature_addr;
361 void __iomem *nsect_addr;
362 void __iomem *lbal_addr;
363 void __iomem *lbam_addr;
364 void __iomem *lbah_addr;
365 void __iomem *device_addr;
366 void __iomem *status_addr;
367 void __iomem *command_addr;
368 void __iomem *altstatus_addr;
369 void __iomem *ctl_addr;
370 void __iomem *bmdma_addr;
371 void __iomem *scr_addr;
372 };
373
374 struct ata_host {
375 spinlock_t lock;
376 struct device *dev;
377 unsigned long irq;
378 unsigned long irq2;
379 void __iomem * const *iomap;
380 unsigned int n_ports;
381 void *private_data;
382 const struct ata_port_operations *ops;
383 unsigned long flags;
384 struct ata_port *simplex_claimed; /* channel owning the DMA */
385 struct ata_port *ports[0];
386 };
387
388 struct ata_queued_cmd {
389 struct ata_port *ap;
390 struct ata_device *dev;
391
392 struct scsi_cmnd *scsicmd;
393 void (*scsidone)(struct scsi_cmnd *);
394
395 struct ata_taskfile tf;
396 u8 cdb[ATAPI_CDB_LEN];
397
398 unsigned long flags; /* ATA_QCFLAG_xxx */
399 unsigned int tag;
400 unsigned int n_elem;
401 unsigned int orig_n_elem;
402
403 int dma_dir;
404
405 unsigned int pad_len;
406 unsigned int sect_size;
407
408 unsigned int nbytes;
409 unsigned int curbytes;
410
411 unsigned int cursg;
412 unsigned int cursg_ofs;
413
414 struct scatterlist sgent;
415 struct scatterlist pad_sgent;
416 void *buf_virt;
417
418 /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
419 struct scatterlist *__sg;
420
421 unsigned int err_mask;
422 struct ata_taskfile result_tf;
423 ata_qc_cb_t complete_fn;
424
425 void *private_data;
426 };
427
428 struct ata_port_stats {
429 unsigned long unhandled_irq;
430 unsigned long idle_irq;
431 unsigned long rw_reqbuf;
432 };
433
434 struct ata_ering_entry {
435 int is_io;
436 unsigned int err_mask;
437 u64 timestamp;
438 };
439
440 struct ata_ering {
441 int cursor;
442 struct ata_ering_entry ring[ATA_ERING_SIZE];
443 };
444
445 struct ata_device {
446 struct ata_port *ap;
447 unsigned int devno; /* 0 or 1 */
448 unsigned long flags; /* ATA_DFLAG_xxx */
449 struct scsi_device *sdev; /* attached SCSI device */
450 /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */
451 u64 n_sectors; /* size of device, if ATA */
452 u64 n_sectors_boot; /* size of ATA device at startup */
453 unsigned int class; /* ATA_DEV_xxx */
454 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
455 u8 pio_mode;
456 u8 dma_mode;
457 u8 xfer_mode;
458 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
459
460 unsigned int multi_count; /* sectors count for
461 READ/WRITE MULTIPLE */
462 unsigned int max_sectors; /* per-device max sectors */
463 unsigned int cdb_len;
464
465 /* per-dev xfer mask */
466 unsigned int pio_mask;
467 unsigned int mwdma_mask;
468 unsigned int udma_mask;
469
470 /* for CHS addressing */
471 u16 cylinders; /* Number of cylinders */
472 u16 heads; /* Number of heads */
473 u16 sectors; /* Number of sectors per track */
474
475 /* error history */
476 struct ata_ering ering;
477 int spdn_cnt;
478 unsigned int horkage; /* List of broken features */
479 #ifdef CONFIG_SATA_ACPI
480 /* ACPI objects info */
481 acpi_handle obj_handle;
482 #endif
483 };
484
485 /* Offset into struct ata_device. Fields above it are maintained
486 * acress device init. Fields below are zeroed.
487 */
488 #define ATA_DEVICE_CLEAR_OFFSET offsetof(struct ata_device, n_sectors)
489
490 struct ata_eh_info {
491 struct ata_device *dev; /* offending device */
492 u32 serror; /* SError from LLDD */
493 unsigned int err_mask; /* port-wide err_mask */
494 unsigned int action; /* ATA_EH_* action mask */
495 unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */
496 unsigned int flags; /* ATA_EHI_* flags */
497
498 unsigned long hotplug_timestamp;
499 unsigned int probe_mask;
500
501 char desc[ATA_EH_DESC_LEN];
502 int desc_len;
503 };
504
505 struct ata_eh_context {
506 struct ata_eh_info i;
507 int tries[ATA_MAX_DEVICES];
508 unsigned int classes[ATA_MAX_DEVICES];
509 unsigned int did_probe_mask;
510 };
511
512 struct ata_port {
513 struct Scsi_Host *scsi_host; /* our co-allocated scsi host */
514 const struct ata_port_operations *ops;
515 spinlock_t *lock;
516 unsigned long flags; /* ATA_FLAG_xxx */
517 unsigned int pflags; /* ATA_PFLAG_xxx */
518 unsigned int print_id; /* user visible unique port ID */
519 unsigned int port_no; /* 0 based port no. inside the host */
520
521 struct ata_prd *prd; /* our SG list */
522 dma_addr_t prd_dma; /* and its DMA mapping */
523
524 void *pad; /* array of DMA pad buffers */
525 dma_addr_t pad_dma;
526
527 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
528
529 u8 ctl; /* cache of ATA control register */
530 u8 last_ctl; /* Cache last written value */
531 unsigned int pio_mask;
532 unsigned int mwdma_mask;
533 unsigned int udma_mask;
534 unsigned int cbl; /* cable type; ATA_CBL_xxx */
535 unsigned int hw_sata_spd_limit;
536 unsigned int sata_spd_limit; /* SATA PHY speed limit */
537
538 /* record runtime error info, protected by host lock */
539 struct ata_eh_info eh_info;
540 /* EH context owned by EH */
541 struct ata_eh_context eh_context;
542
543 struct ata_device device[ATA_MAX_DEVICES];
544
545 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
546 unsigned long qc_allocated;
547 unsigned int qc_active;
548
549 unsigned int active_tag;
550 u32 sactive;
551
552 struct ata_port_stats stats;
553 struct ata_host *host;
554 struct device *dev;
555
556 void *port_task_data;
557 struct delayed_work port_task;
558 struct delayed_work hotplug_task;
559 struct work_struct scsi_rescan_task;
560
561 unsigned int hsm_task_state;
562
563 u32 msg_enable;
564 struct list_head eh_done_q;
565 wait_queue_head_t eh_wait_q;
566
567 pm_message_t pm_mesg;
568 int *pm_result;
569
570 void *private_data;
571
572 u8 sector_buf[ATA_SECT_SIZE]; /* owned by EH */
573 };
574
575 struct ata_port_operations {
576 void (*port_disable) (struct ata_port *);
577
578 void (*dev_config) (struct ata_device *);
579
580 void (*set_piomode) (struct ata_port *, struct ata_device *);
581 void (*set_dmamode) (struct ata_port *, struct ata_device *);
582 unsigned long (*mode_filter) (struct ata_device *, unsigned long);
583
584 void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
585 void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
586
587 void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
588 u8 (*check_status)(struct ata_port *ap);
589 u8 (*check_altstatus)(struct ata_port *ap);
590 void (*dev_select)(struct ata_port *ap, unsigned int device);
591
592 void (*phy_reset) (struct ata_port *ap); /* obsolete */
593 int (*set_mode) (struct ata_port *ap, struct ata_device **r_failed_dev);
594
595 void (*post_set_mode) (struct ata_port *ap);
596
597 int (*cable_detect) (struct ata_port *ap);
598
599 int (*check_atapi_dma) (struct ata_queued_cmd *qc);
600
601 void (*bmdma_setup) (struct ata_queued_cmd *qc);
602 void (*bmdma_start) (struct ata_queued_cmd *qc);
603
604 void (*data_xfer) (struct ata_device *, unsigned char *, unsigned int, int);
605
606 void (*qc_prep) (struct ata_queued_cmd *qc);
607 unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
608
609 /* Error handlers. ->error_handler overrides ->eng_timeout and
610 * indicates that new-style EH is in place.
611 */
612 void (*eng_timeout) (struct ata_port *ap); /* obsolete */
613
614 void (*freeze) (struct ata_port *ap);
615 void (*thaw) (struct ata_port *ap);
616 void (*error_handler) (struct ata_port *ap);
617 void (*post_internal_cmd) (struct ata_queued_cmd *qc);
618
619 irq_handler_t irq_handler;
620 void (*irq_clear) (struct ata_port *);
621 u8 (*irq_on) (struct ata_port *);
622 u8 (*irq_ack) (struct ata_port *ap, unsigned int chk_drq);
623
624 u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg);
625 void (*scr_write) (struct ata_port *ap, unsigned int sc_reg,
626 u32 val);
627
628 int (*port_suspend) (struct ata_port *ap, pm_message_t mesg);
629 int (*port_resume) (struct ata_port *ap);
630
631 int (*port_start) (struct ata_port *ap);
632 void (*port_stop) (struct ata_port *ap);
633
634 void (*host_stop) (struct ata_host *host);
635
636 void (*bmdma_stop) (struct ata_queued_cmd *qc);
637 u8 (*bmdma_status) (struct ata_port *ap);
638 };
639
640 struct ata_port_info {
641 struct scsi_host_template *sht;
642 unsigned long flags;
643 unsigned long pio_mask;
644 unsigned long mwdma_mask;
645 unsigned long udma_mask;
646 const struct ata_port_operations *port_ops;
647 irq_handler_t irq_handler;
648 void *private_data;
649 };
650
651 struct ata_timing {
652 unsigned short mode; /* ATA mode */
653 unsigned short setup; /* t1 */
654 unsigned short act8b; /* t2 for 8-bit I/O */
655 unsigned short rec8b; /* t2i for 8-bit I/O */
656 unsigned short cyc8b; /* t0 for 8-bit I/O */
657 unsigned short active; /* t2 or tD */
658 unsigned short recover; /* t2i or tK */
659 unsigned short cycle; /* t0 */
660 unsigned short udma; /* t2CYCTYP/2 */
661 };
662
663 #define FIT(v,vmin,vmax) max_t(short,min_t(short,v,vmax),vmin)
664
665 extern const unsigned long sata_deb_timing_normal[];
666 extern const unsigned long sata_deb_timing_hotplug[];
667 extern const unsigned long sata_deb_timing_long[];
668
669 extern const struct ata_port_operations ata_dummy_port_ops;
670 extern const struct ata_port_info ata_dummy_port_info;
671
672 static inline const unsigned long *
673 sata_ehc_deb_timing(struct ata_eh_context *ehc)
674 {
675 if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
676 return sata_deb_timing_hotplug;
677 else
678 return sata_deb_timing_normal;
679 }
680
681 static inline int ata_port_is_dummy(struct ata_port *ap)
682 {
683 return ap->ops == &ata_dummy_port_ops;
684 }
685
686 extern void sata_print_link_status(struct ata_port *ap);
687 extern void ata_port_probe(struct ata_port *);
688 extern void __sata_phy_reset(struct ata_port *ap);
689 extern void sata_phy_reset(struct ata_port *ap);
690 extern void ata_bus_reset(struct ata_port *ap);
691 extern int sata_set_spd(struct ata_port *ap);
692 extern int sata_phy_debounce(struct ata_port *ap, const unsigned long *param,
693 unsigned long deadline);
694 extern int sata_phy_resume(struct ata_port *ap, const unsigned long *param,
695 unsigned long deadline);
696 extern int ata_std_prereset(struct ata_port *ap, unsigned long deadline);
697 extern int ata_std_softreset(struct ata_port *ap, unsigned int *classes,
698 unsigned long deadline);
699 extern int sata_port_hardreset(struct ata_port *ap, const unsigned long *timing,
700 unsigned long deadline);
701 extern int sata_std_hardreset(struct ata_port *ap, unsigned int *class,
702 unsigned long deadline);
703 extern void ata_std_postreset(struct ata_port *ap, unsigned int *classes);
704 extern void ata_port_disable(struct ata_port *);
705 extern void ata_std_ports(struct ata_ioports *ioaddr);
706 #ifdef CONFIG_PCI
707 extern int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info,
708 unsigned int n_ports);
709 extern void ata_pci_remove_one (struct pci_dev *pdev);
710 #ifdef CONFIG_PM
711 extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
712 extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
713 extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
714 extern int ata_pci_device_resume(struct pci_dev *pdev);
715 #endif
716 extern int ata_pci_clear_simplex(struct pci_dev *pdev);
717 #endif /* CONFIG_PCI */
718 extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
719 extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
720 const struct ata_port_info * const * ppi, int n_ports);
721 extern int ata_host_start(struct ata_host *host);
722 extern int ata_host_register(struct ata_host *host,
723 struct scsi_host_template *sht);
724 extern int ata_host_activate(struct ata_host *host, int irq,
725 irq_handler_t irq_handler, unsigned long irq_flags,
726 struct scsi_host_template *sht);
727 extern void ata_host_detach(struct ata_host *host);
728 extern void ata_host_init(struct ata_host *, struct device *,
729 unsigned long, const struct ata_port_operations *);
730 extern int ata_scsi_detect(struct scsi_host_template *sht);
731 extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
732 extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
733 extern void ata_sas_port_destroy(struct ata_port *);
734 extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
735 struct ata_port_info *, struct Scsi_Host *);
736 extern int ata_sas_port_init(struct ata_port *);
737 extern int ata_sas_port_start(struct ata_port *ap);
738 extern void ata_sas_port_stop(struct ata_port *ap);
739 extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
740 extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
741 struct ata_port *ap);
742 extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
743 extern int sata_scr_valid(struct ata_port *ap);
744 extern int sata_scr_read(struct ata_port *ap, int reg, u32 *val);
745 extern int sata_scr_write(struct ata_port *ap, int reg, u32 val);
746 extern int sata_scr_write_flush(struct ata_port *ap, int reg, u32 val);
747 extern int ata_port_online(struct ata_port *ap);
748 extern int ata_port_offline(struct ata_port *ap);
749 #ifdef CONFIG_PM
750 extern int ata_scsi_device_resume(struct scsi_device *);
751 extern int ata_scsi_device_suspend(struct scsi_device *, pm_message_t mesg);
752 extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
753 extern void ata_host_resume(struct ata_host *host);
754 #endif
755 extern int ata_ratelimit(void);
756 extern int ata_busy_sleep(struct ata_port *ap,
757 unsigned long timeout_pat, unsigned long timeout);
758 extern int ata_wait_ready(struct ata_port *ap, unsigned long deadline);
759 extern void ata_port_queue_task(struct ata_port *ap, work_func_t fn,
760 void *data, unsigned long delay);
761 extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
762 unsigned long interval_msec,
763 unsigned long timeout_msec);
764 extern unsigned int ata_dev_try_classify(struct ata_port *, unsigned int, u8 *);
765
766 /*
767 * Default driver ops implementations
768 */
769 extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
770 extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
771 extern void ata_tf_to_fis(const struct ata_taskfile *tf, u8 *fis, u8 pmp);
772 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
773 extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
774 extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
775 extern u8 ata_check_status(struct ata_port *ap);
776 extern u8 ata_altstatus(struct ata_port *ap);
777 extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
778 extern int ata_port_start (struct ata_port *ap);
779 extern irqreturn_t ata_interrupt (int irq, void *dev_instance);
780 extern void ata_data_xfer(struct ata_device *adev, unsigned char *buf,
781 unsigned int buflen, int write_data);
782 extern void ata_data_xfer_noirq(struct ata_device *adev, unsigned char *buf,
783 unsigned int buflen, int write_data);
784 extern void ata_qc_prep(struct ata_queued_cmd *qc);
785 extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
786 extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
787 extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
788 unsigned int buflen);
789 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
790 unsigned int n_elem);
791 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
792 extern void ata_dev_disable(struct ata_device *adev);
793 extern void ata_id_string(const u16 *id, unsigned char *s,
794 unsigned int ofs, unsigned int len);
795 extern void ata_id_c_string(const u16 *id, unsigned char *s,
796 unsigned int ofs, unsigned int len);
797 extern void ata_id_to_dma_mode(struct ata_device *dev, u8 unknown);
798 extern unsigned long ata_device_blacklisted(const struct ata_device *dev);
799 extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
800 extern void ata_bmdma_start (struct ata_queued_cmd *qc);
801 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
802 extern u8 ata_bmdma_status(struct ata_port *ap);
803 extern void ata_bmdma_irq_clear(struct ata_port *ap);
804 extern void ata_bmdma_freeze(struct ata_port *ap);
805 extern void ata_bmdma_thaw(struct ata_port *ap);
806 extern void ata_bmdma_drive_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
807 ata_reset_fn_t softreset,
808 ata_reset_fn_t hardreset,
809 ata_postreset_fn_t postreset);
810 extern void ata_bmdma_error_handler(struct ata_port *ap);
811 extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
812 extern int ata_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
813 u8 status, int in_wq);
814 extern void ata_qc_complete(struct ata_queued_cmd *qc);
815 extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active,
816 void (*finish_qc)(struct ata_queued_cmd *));
817 extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
818 void (*done)(struct scsi_cmnd *));
819 extern int ata_std_bios_param(struct scsi_device *sdev,
820 struct block_device *bdev,
821 sector_t capacity, int geom[]);
822 extern int ata_scsi_slave_config(struct scsi_device *sdev);
823 extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
824 extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
825 int queue_depth);
826 extern struct ata_device *ata_dev_pair(struct ata_device *adev);
827 extern int ata_do_set_mode(struct ata_port *ap, struct ata_device **r_failed_dev);
828 extern u8 ata_irq_on(struct ata_port *ap);
829 extern u8 ata_dummy_irq_on(struct ata_port *ap);
830 extern u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq);
831 extern u8 ata_dummy_irq_ack(struct ata_port *ap, unsigned int chk_drq);
832
833 extern int ata_cable_40wire(struct ata_port *ap);
834 extern int ata_cable_80wire(struct ata_port *ap);
835 extern int ata_cable_sata(struct ata_port *ap);
836 extern int ata_cable_unknown(struct ata_port *ap);
837
838 /*
839 * Timing helpers
840 */
841
842 extern unsigned int ata_pio_need_iordy(const struct ata_device *);
843 extern int ata_timing_compute(struct ata_device *, unsigned short,
844 struct ata_timing *, int, int);
845 extern void ata_timing_merge(const struct ata_timing *,
846 const struct ata_timing *, struct ata_timing *,
847 unsigned int);
848
849 enum {
850 ATA_TIMING_SETUP = (1 << 0),
851 ATA_TIMING_ACT8B = (1 << 1),
852 ATA_TIMING_REC8B = (1 << 2),
853 ATA_TIMING_CYC8B = (1 << 3),
854 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
855 ATA_TIMING_CYC8B,
856 ATA_TIMING_ACTIVE = (1 << 4),
857 ATA_TIMING_RECOVER = (1 << 5),
858 ATA_TIMING_CYCLE = (1 << 6),
859 ATA_TIMING_UDMA = (1 << 7),
860 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
861 ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
862 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
863 ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
864 };
865
866
867 #ifdef CONFIG_PCI
868 struct pci_bits {
869 unsigned int reg; /* PCI config register to read */
870 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
871 unsigned long mask;
872 unsigned long val;
873 };
874
875 extern int ata_pci_init_native_host(struct ata_host *host,
876 unsigned int port_mask);
877 extern int ata_pci_prepare_native_host(struct pci_dev *pdev,
878 const struct ata_port_info * const * ppi,
879 int n_ports, struct ata_host **r_host);
880 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
881 extern unsigned long ata_pci_default_filter(struct ata_device *, unsigned long);
882 #endif /* CONFIG_PCI */
883
884 /*
885 * EH
886 */
887 extern void ata_eng_timeout(struct ata_port *ap);
888
889 extern void ata_port_schedule_eh(struct ata_port *ap);
890 extern int ata_port_abort(struct ata_port *ap);
891 extern int ata_port_freeze(struct ata_port *ap);
892
893 extern void ata_eh_freeze_port(struct ata_port *ap);
894 extern void ata_eh_thaw_port(struct ata_port *ap);
895
896 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
897 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
898
899 extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
900 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
901 ata_postreset_fn_t postreset);
902
903 /*
904 * printk helpers
905 */
906 #define ata_port_printk(ap, lv, fmt, args...) \
907 printk(lv"ata%u: "fmt, (ap)->print_id , ##args)
908
909 #define ata_dev_printk(dev, lv, fmt, args...) \
910 printk(lv"ata%u.%02u: "fmt, (dev)->ap->print_id, (dev)->devno , ##args)
911
912 /*
913 * ata_eh_info helpers
914 */
915 #define ata_ehi_push_desc(ehi, fmt, args...) do { \
916 (ehi)->desc_len += scnprintf((ehi)->desc + (ehi)->desc_len, \
917 ATA_EH_DESC_LEN - (ehi)->desc_len, \
918 fmt , ##args); \
919 } while (0)
920
921 #define ata_ehi_clear_desc(ehi) do { \
922 (ehi)->desc[0] = '\0'; \
923 (ehi)->desc_len = 0; \
924 } while (0)
925
926 static inline void __ata_ehi_hotplugged(struct ata_eh_info *ehi)
927 {
928 if (ehi->flags & ATA_EHI_HOTPLUGGED)
929 return;
930
931 ehi->flags |= ATA_EHI_HOTPLUGGED | ATA_EHI_RESUME_LINK;
932 ehi->hotplug_timestamp = jiffies;
933
934 ehi->action |= ATA_EH_SOFTRESET;
935 ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
936 }
937
938 static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
939 {
940 __ata_ehi_hotplugged(ehi);
941 ehi->err_mask |= AC_ERR_ATA_BUS;
942 }
943
944 /*
945 * qc helpers
946 */
947 static inline int
948 ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
949 {
950 if (sg == &qc->pad_sgent)
951 return 1;
952 if (qc->pad_len)
953 return 0;
954 if (((sg - qc->__sg) + 1) == qc->n_elem)
955 return 1;
956 return 0;
957 }
958
959 static inline struct scatterlist *
960 ata_qc_first_sg(struct ata_queued_cmd *qc)
961 {
962 if (qc->n_elem)
963 return qc->__sg;
964 if (qc->pad_len)
965 return &qc->pad_sgent;
966 return NULL;
967 }
968
969 static inline struct scatterlist *
970 ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
971 {
972 if (sg == &qc->pad_sgent)
973 return NULL;
974 if (++sg - qc->__sg < qc->n_elem)
975 return sg;
976 if (qc->pad_len)
977 return &qc->pad_sgent;
978 return NULL;
979 }
980
981 #define ata_for_each_sg(sg, qc) \
982 for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
983
984 static inline unsigned int ata_tag_valid(unsigned int tag)
985 {
986 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
987 }
988
989 static inline unsigned int ata_tag_internal(unsigned int tag)
990 {
991 return tag == ATA_MAX_QUEUE - 1;
992 }
993
994 /*
995 * device helpers
996 */
997 static inline unsigned int ata_class_enabled(unsigned int class)
998 {
999 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI;
1000 }
1001
1002 static inline unsigned int ata_class_disabled(unsigned int class)
1003 {
1004 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP;
1005 }
1006
1007 static inline unsigned int ata_class_absent(unsigned int class)
1008 {
1009 return !ata_class_enabled(class) && !ata_class_disabled(class);
1010 }
1011
1012 static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1013 {
1014 return ata_class_enabled(dev->class);
1015 }
1016
1017 static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1018 {
1019 return ata_class_disabled(dev->class);
1020 }
1021
1022 static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1023 {
1024 return ata_class_absent(dev->class);
1025 }
1026
1027 static inline unsigned int ata_dev_ready(const struct ata_device *dev)
1028 {
1029 return ata_dev_enabled(dev) && !(dev->flags & ATA_DFLAG_SUSPENDED);
1030 }
1031
1032 /*
1033 * port helpers
1034 */
1035 static inline int ata_port_max_devices(const struct ata_port *ap)
1036 {
1037 if (ap->flags & ATA_FLAG_SLAVE_POSS)
1038 return 2;
1039 return 1;
1040 }
1041
1042
1043 static inline u8 ata_chk_status(struct ata_port *ap)
1044 {
1045 return ap->ops->check_status(ap);
1046 }
1047
1048 /**
1049 * ata_ncq_enabled - Test whether NCQ is enabled
1050 * @dev: ATA device to test for
1051 *
1052 * LOCKING:
1053 * spin_lock_irqsave(host lock)
1054 *
1055 * RETURNS:
1056 * 1 if NCQ is enabled for @dev, 0 otherwise.
1057 */
1058 static inline int ata_ncq_enabled(struct ata_device *dev)
1059 {
1060 return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1061 ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1062 }
1063
1064 /**
1065 * ata_pause - Flush writes and pause 400 nanoseconds.
1066 * @ap: Port to wait for.
1067 *
1068 * LOCKING:
1069 * Inherited from caller.
1070 */
1071
1072 static inline void ata_pause(struct ata_port *ap)
1073 {
1074 ata_altstatus(ap);
1075 ndelay(400);
1076 }
1077
1078
1079 /**
1080 * ata_busy_wait - Wait for a port status register
1081 * @ap: Port to wait for.
1082 * @bits: bits that must be clear
1083 * @max: number of 10uS waits to perform
1084 *
1085 * Waits up to max*10 microseconds for the selected bits in the port's
1086 * status register to be cleared.
1087 * Returns final value of status register.
1088 *
1089 * LOCKING:
1090 * Inherited from caller.
1091 */
1092
1093 static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
1094 unsigned int max)
1095 {
1096 u8 status;
1097
1098 do {
1099 udelay(10);
1100 status = ata_chk_status(ap);
1101 max--;
1102 } while (status != 0xff && (status & bits) && (max > 0));
1103
1104 return status;
1105 }
1106
1107
1108 /**
1109 * ata_wait_idle - Wait for a port to be idle.
1110 * @ap: Port to wait for.
1111 *
1112 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
1113 * Returns final value of status register.
1114 *
1115 * LOCKING:
1116 * Inherited from caller.
1117 */
1118
1119 static inline u8 ata_wait_idle(struct ata_port *ap)
1120 {
1121 u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1122
1123 if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ))) {
1124 if (ata_msg_warn(ap))
1125 printk(KERN_WARNING "ATA: abnormal status 0x%X on port 0x%p\n",
1126 status, ap->ioaddr.status_addr);
1127 }
1128
1129 return status;
1130 }
1131
1132 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1133 {
1134 qc->tf.ctl |= ATA_NIEN;
1135 }
1136
1137 static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1138 unsigned int tag)
1139 {
1140 if (likely(ata_tag_valid(tag)))
1141 return &ap->qcmd[tag];
1142 return NULL;
1143 }
1144
1145 static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1146 unsigned int tag)
1147 {
1148 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1149
1150 if (unlikely(!qc) || !ap->ops->error_handler)
1151 return qc;
1152
1153 if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1154 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1155 return qc;
1156
1157 return NULL;
1158 }
1159
1160 static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1161 {
1162 memset(tf, 0, sizeof(*tf));
1163
1164 tf->ctl = dev->ap->ctl;
1165 if (dev->devno == 0)
1166 tf->device = ATA_DEVICE_OBS;
1167 else
1168 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1169 }
1170
1171 static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1172 {
1173 qc->dma_dir = DMA_NONE;
1174 qc->__sg = NULL;
1175 qc->flags = 0;
1176 qc->cursg = qc->cursg_ofs = 0;
1177 qc->nbytes = qc->curbytes = 0;
1178 qc->n_elem = 0;
1179 qc->err_mask = 0;
1180 qc->pad_len = 0;
1181 qc->sect_size = ATA_SECT_SIZE;
1182
1183 ata_tf_init(qc->dev, &qc->tf);
1184
1185 /* init result_tf such that it indicates normal completion */
1186 qc->result_tf.command = ATA_DRDY;
1187 qc->result_tf.feature = 0;
1188 }
1189
1190 static inline int ata_try_flush_cache(const struct ata_device *dev)
1191 {
1192 return ata_id_wcache_enabled(dev->id) ||
1193 ata_id_has_flush(dev->id) ||
1194 ata_id_has_flush_ext(dev->id);
1195 }
1196
1197 static inline unsigned int ac_err_mask(u8 status)
1198 {
1199 if (status & (ATA_BUSY | ATA_DRQ))
1200 return AC_ERR_HSM;
1201 if (status & (ATA_ERR | ATA_DF))
1202 return AC_ERR_DEV;
1203 return 0;
1204 }
1205
1206 static inline unsigned int __ac_err_mask(u8 status)
1207 {
1208 unsigned int mask = ac_err_mask(status);
1209 if (mask == 0)
1210 return AC_ERR_OTHER;
1211 return mask;
1212 }
1213
1214 static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
1215 {
1216 ap->pad_dma = 0;
1217 ap->pad = dmam_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
1218 &ap->pad_dma, GFP_KERNEL);
1219 return (ap->pad == NULL) ? -ENOMEM : 0;
1220 }
1221
1222 static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
1223 {
1224 dmam_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
1225 }
1226
1227 static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1228 {
1229 return *(struct ata_port **)&host->hostdata[0];
1230 }
1231
1232 #endif /* __LINUX_LIBATA_H__ */
Ubuntu Artful kernel mirror