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