]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - include/linux/libata.h
projects / mirror_ubuntu-artful-kernel.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
ahci: improve and limit spurious interrupt messages, take#3
[mirror_ubuntu-artful-kernel.git] / include / linux / libata.h
CommitLineData
1da177e4 1/*
af36d7f0
JG		 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 *
1da177e4
LT		 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>
1c72d8d9 32#include <linux/dma-mapping.h>
41542dbe 33#include <asm/scatterlist.h>
1da177e4
LT		 34#include <asm/io.h>
35#include <linux/ata.h>
36#include <linux/workqueue.h>
35bb94b1 37#include <scsi/scsi_host.h>
1da177e4 38
a6d967a4
JG		 39/*
40 * Define if arch has non-standard setup. This is a _PCI_ standard
41 * not a legacy or ISA standard.
42 */
43#ifdef CONFIG_ATA_NONSTANDARD
2ec7df04 44#include <asm/libata-portmap.h>
a6d967a4
JG		 45#else
46#include <asm-generic/libata-portmap.h>
47#endif
2ec7df04 48
1da177e4 49/*
bfd60579
RD		 50 * compile-time options: to be removed as soon as all the drivers are
51 * converted to the new debugging mechanism
1da177e4
LT		 52 */
53#undef ATA_DEBUG /* debugging output */
54#undef ATA_VERBOSE_DEBUG /* yet more debugging output */
55#undef ATA_IRQ_TRAP /* define to ack screaming irqs */
56#undef ATA_NDEBUG /* define to disable quick runtime checks */
669a5db4 57#define ATA_ENABLE_PATA /* define to enable PATA support in some
1da177e4 58 * low-level drivers */
1da177e4
LT		 59
60
61/* note: prints function name for you */
62#ifdef ATA_DEBUG
63#define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
64#ifdef ATA_VERBOSE_DEBUG
65#define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
66#else
67#define VPRINTK(fmt, args...)
68#endif /* ATA_VERBOSE_DEBUG */
69#else
70#define DPRINTK(fmt, args...)
71#define VPRINTK(fmt, args...)
72#endif /* ATA_DEBUG */
73
2c13b7ce
JG		 74#define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
75
bfd60579
RD		 76/* NEW: debug levels */
77#define HAVE_LIBATA_MSG 1
78
79enum {
80 ATA_MSG_DRV = 0x0001,
81 ATA_MSG_INFO = 0x0002,
82 ATA_MSG_PROBE = 0x0004,
83 ATA_MSG_WARN = 0x0008,
84 ATA_MSG_MALLOC = 0x0010,
85 ATA_MSG_CTL = 0x0020,
86 ATA_MSG_INTR = 0x0040,
87 ATA_MSG_ERR = 0x0080,
88};
89
90#define ata_msg_drv(p) ((p)->msg_enable & ATA_MSG_DRV)
91#define ata_msg_info(p) ((p)->msg_enable & ATA_MSG_INFO)
92#define ata_msg_probe(p) ((p)->msg_enable & ATA_MSG_PROBE)
93#define ata_msg_warn(p) ((p)->msg_enable & ATA_MSG_WARN)
94#define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC)
95#define ata_msg_ctl(p) ((p)->msg_enable & ATA_MSG_CTL)
96#define ata_msg_intr(p) ((p)->msg_enable & ATA_MSG_INTR)
97#define ata_msg_err(p) ((p)->msg_enable & ATA_MSG_ERR)
98
99static inline u32 ata_msg_init(int dval, int default_msg_enable_bits)
100{
101 if (dval < 0 || dval >= (sizeof(u32) * 8))
102 return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */
103 if (!dval)
104 return 0;
105 return (1 << dval) - 1;
106}
107
1da177e4
LT		 108/* defines only for the constants which don't work well as enums */
109#define ATA_TAG_POISON 0xfafbfcfdU
110
111/* move to PCI layer? */
54bb3a94
JG		 112#define PCI_VDEVICE(vendor, device) \
113 PCI_VENDOR_ID_##vendor, (device), \
114 PCI_ANY_ID, PCI_ANY_ID, 0, 0
115
1da177e4
LT		 116static inline struct device *pci_dev_to_dev(struct pci_dev *pdev)
117{
118 return &pdev->dev;
119}
120
121enum {
122 /* various global constants */
123 LIBATA_MAX_PRD = ATA_MAX_PRD / 2,
124 ATA_MAX_PORTS = 8,
125 ATA_DEF_QUEUE = 1,
2ab7db1f 126 /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
a6e6ce8e 127 ATA_MAX_QUEUE = 32,
2ab7db1f 128 ATA_TAG_INTERNAL = ATA_MAX_QUEUE - 1,
1da177e4
LT		 129 ATA_MAX_BUS = 2,
130 ATA_DEF_BUSY_WAIT = 10000,
131 ATA_SHORT_PAUSE = (HZ >> 6) + 1,
132
133 ATA_SHT_EMULATED = 1,
134 ATA_SHT_CMD_PER_LUN = 1,
135 ATA_SHT_THIS_ID = -1,
cf482935 136 ATA_SHT_USE_CLUSTERING = 1,
1da177e4
LT		 137
138 /* struct ata_device stuff */
949b38af
TH		 139 ATA_DFLAG_LBA = (1 << 0), /* device supports LBA */
140 ATA_DFLAG_LBA48 = (1 << 1), /* device supports LBA48 */
029f5468 141 ATA_DFLAG_CDB_INTR = (1 << 2), /* device asserts INTRQ when ready for CDB */
88e49034 142 ATA_DFLAG_NCQ = (1 << 3), /* device supports NCQ */
6fc49adb 143 ATA_DFLAG_FLUSH_EXT = (1 << 4), /* do FLUSH_EXT instead of FLUSH */
ea1dd4e1 144 ATA_DFLAG_CFG_MASK = (1 << 8) - 1,
949b38af 145
e5c9e081 146 ATA_DFLAG_PIO = (1 << 8), /* device limited to PIO mode */
3343571d 147 ATA_DFLAG_NCQ_OFF = (1 << 9), /* device limited to non-NCQ mode */
e5c9e081 148 ATA_DFLAG_SUSPENDED = (1 << 10), /* device suspended */
72fa4b74 149 ATA_DFLAG_INIT_MASK = (1 << 16) - 1,
1da177e4 150
abdda733
TH		 151 ATA_DFLAG_DETACH = (1 << 16),
152 ATA_DFLAG_DETACHED = (1 << 17),
153
1da177e4
LT		 154 ATA_DEV_UNKNOWN = 0, /* unknown device */
155 ATA_DEV_ATA = 1, /* ATA device */
156 ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */
157 ATA_DEV_ATAPI = 3, /* ATAPI device */
158 ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */
159 ATA_DEV_NONE = 5, /* no device */
160
161 /* struct ata_port flags */
949b38af 162 ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */
1da177e4 163 /* (doesn't imply presence) */
949b38af
TH		 164 ATA_FLAG_SATA = (1 << 1),
165 ATA_FLAG_NO_LEGACY = (1 << 2), /* no legacy mode check */
166 ATA_FLAG_MMIO = (1 << 3), /* use MMIO, not PIO */
167 ATA_FLAG_SRST = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */
168 ATA_FLAG_SATA_RESET = (1 << 5), /* (obsolete) use COMRESET */
169 ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */
170 ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */
171 ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */
7395acb2
TH		 172 ATA_FLAG_PIO_POLLING = (1 << 9), /* use polling PIO if LLD
173 * doesn't handle PIO interrupts */
174 ATA_FLAG_NCQ = (1 << 10), /* host supports NCQ */
abdda733
TH		 175 ATA_FLAG_HRST_TO_RESUME = (1 << 11), /* hardreset to resume phy */
176 ATA_FLAG_SKIP_D2H_BSY = (1 << 12), /* can't wait for the first D2H
177 * Register FIS clearing BSY */
7395acb2 178 ATA_FLAG_DEBUGMSG = (1 << 13),
800b3996 179 ATA_FLAG_SETXFER_POLLING= (1 << 14), /* use polling for SETXFER */
949b38af 180
b51e9e5d
TH		 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 */
9ec957f2 188
b51e9e5d
TH		 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 */
949b38af 197
b51e9e5d
TH		 198 ATA_PFLAG_FLUSH_PORT_TASK = (1 << 16), /* flush port task */
199 ATA_PFLAG_SUSPENDED = (1 << 17), /* port is suspended (power) */
500530f6 200 ATA_PFLAG_PM_PENDING = (1 << 18), /* PM operation pending */
949b38af
TH		 201
202 /* struct ata_queued_cmd flags */
203 ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */
204 ATA_QCFLAG_SG = (1 << 1), /* have s/g table? */
205 ATA_QCFLAG_SINGLE = (1 << 2), /* no s/g, just a single buffer */
1da177e4 206 ATA_QCFLAG_DMAMAP = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE,
27197367 207 ATA_QCFLAG_IO = (1 << 3), /* standard IO command */
e61e0672
TH		 208 ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */
209
9ec957f2
TH		 210 ATA_QCFLAG_FAILED = (1 << 16), /* cmd failed and is owned by EH */
211 ATA_QCFLAG_SENSE_VALID = (1 << 17), /* sense data valid */
212 ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
1da177e4 213
4e5ec5db 214 /* host set flags */
cca3974e 215 ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host only */
9bec2e38 216
1da177e4 217 /* various lengths of time */
8d238e01
AC		 218 ATA_TMOUT_BOOT = 30 * HZ, /* heuristic */
219 ATA_TMOUT_BOOT_QUICK = 7 * HZ, /* heuristic */
a2a7a662
TH		 220 ATA_TMOUT_INTERNAL = 30 * HZ,
221 ATA_TMOUT_INTERNAL_QUICK = 5 * HZ,
1da177e4
LT		 222
223 /* ATA bus states */
224 BUS_UNKNOWN = 0,
225 BUS_DMA = 1,
226 BUS_IDLE = 2,
227 BUS_NOINTR = 3,
228 BUS_NODATA = 4,
229 BUS_TIMER = 5,
230 BUS_PIO = 6,
231 BUS_EDD = 7,
232 BUS_IDENTIFY = 8,
233 BUS_PACKET = 9,
234
235 /* SATA port states */
236 PORT_UNKNOWN = 0,
237 PORT_ENABLED = 1,
238 PORT_DISABLED = 2,
239
240 /* encoding various smaller bitmaps into a single
1da7b0d0 241 * unsigned int bitmap
1da177e4 242 */
b352e57d
AC		 243 ATA_BITS_PIO = 7,
244 ATA_BITS_MWDMA = 5,
1da7b0d0
TH		 245 ATA_BITS_UDMA = 8,
246
247 ATA_SHIFT_PIO = 0,
248 ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_BITS_PIO,
249 ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_BITS_MWDMA,
250
251 ATA_MASK_PIO = ((1 << ATA_BITS_PIO) - 1) << ATA_SHIFT_PIO,
252 ATA_MASK_MWDMA = ((1 << ATA_BITS_MWDMA) - 1) << ATA_SHIFT_MWDMA,
253 ATA_MASK_UDMA = ((1 << ATA_BITS_UDMA) - 1) << ATA_SHIFT_UDMA,
cedc9a47
JG		 254
255 /* size of buffer to pad xfers ending on unaligned boundaries */
256 ATA_DMA_PAD_SZ = 4,
257 ATA_DMA_PAD_BUF_SZ = ATA_DMA_PAD_SZ * ATA_MAX_QUEUE,
949b38af
TH		 258
259 /* masks for port functions */
47a86593
AC		 260 ATA_PORT_PRIMARY = (1 << 0),
261 ATA_PORT_SECONDARY = (1 << 1),
14d2bac1 262
0c247c55
TH		 263 /* ering size */
264 ATA_ERING_SIZE = 32,
265
f3e81b19
TH		 266 /* desc_len for ata_eh_info and context */
267 ATA_EH_DESC_LEN = 80,
268
9be1e979
TH		 269 /* reset / recovery action types */
270 ATA_EH_REVALIDATE = (1 << 0),
271 ATA_EH_SOFTRESET = (1 << 1),
272 ATA_EH_HARDRESET = (1 << 2),
02670bf3
TH		 273 ATA_EH_SUSPEND = (1 << 3),
274 ATA_EH_RESUME = (1 << 4),
275 ATA_EH_PM_FREEZE = (1 << 5),
9be1e979
TH		 276
277 ATA_EH_RESET_MASK = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
02670bf3
TH		 278 ATA_EH_PERDEV_MASK = ATA_EH_REVALIDATE | ATA_EH_SUSPEND |
279 ATA_EH_RESUME | ATA_EH_PM_FREEZE,
9be1e979 280
f3e81b19 281 /* ata_eh_info->flags */
abdda733 282 ATA_EHI_HOTPLUGGED = (1 << 0), /* could have been hotplugged */
13abf50d 283 ATA_EHI_RESUME_LINK = (1 << 1), /* resume link (reset modifier) */
1cdaf534
TH		 284 ATA_EHI_NO_AUTOPSY = (1 << 2), /* no autopsy */
285 ATA_EHI_QUIET = (1 << 3), /* be quiet */
abdda733
TH		 286
287 ATA_EHI_DID_RESET = (1 << 16), /* already reset this port */
efdaedc4 288 ATA_EHI_PRINTINFO = (1 << 17), /* print configuration info */
baa1e78a
TH		 289 ATA_EHI_SETMODE = (1 << 18), /* configure transfer mode */
290 ATA_EHI_POST_SETMODE = (1 << 19), /* revaildating after setmode */
f3e81b19 291
13abf50d
TH		 292 ATA_EHI_RESET_MODIFIER_MASK = ATA_EHI_RESUME_LINK,
293
ad9e2762
TH		 294 /* max repeat if error condition is still set after ->error_handler */
295 ATA_EH_MAX_REPEAT = 5,
296
14d2bac1
TH		 297 /* how hard are we gonna try to probe/recover devices */
298 ATA_PROBE_MAX_TRIES = 3,
022bdb07
TH		 299 ATA_EH_RESET_TRIES = 3,
300 ATA_EH_DEV_TRIES = 3,
f5914a46
TH		 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,
93590859
AC		 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 */
6919a0a6
AC		 315 ATA_HORKAGE_NODMA = (1 << 1), /* DMA problems */
316 ATA_HORKAGE_NONCQ = (1 << 2), /* Don't use NCQ */
1da177e4
LT		 317};
318
14be71f4 319enum hsm_task_states {
c56b14d2 320 HSM_ST_IDLE, /* no command on going */
c56b14d2
AL		 321 HSM_ST, /* (waiting the device to) transfer data */
322 HSM_ST_LAST, /* (waiting the device to) complete command */
c56b14d2
AL		 323 HSM_ST_ERR, /* error */
324 HSM_ST_FIRST, /* (waiting the device to)
325 write CDB or first data block */
1da177e4
LT		 326};
327
a7dac447 328enum ata_completion_errors {
11a56d24
TH		 329 AC_ERR_DEV = (1 << 0), /* device reported error */
330 AC_ERR_HSM = (1 << 1), /* host state machine violation */
331 AC_ERR_TIMEOUT = (1 << 2), /* timeout */
332 AC_ERR_MEDIA = (1 << 3), /* media error */
333 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
334 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
335 AC_ERR_SYSTEM = (1 << 6), /* system error */
336 AC_ERR_INVALID = (1 << 7), /* invalid argument */
337 AC_ERR_OTHER = (1 << 8), /* unknown */
55a8e2c8 338 AC_ERR_NODEV_HINT = (1 << 9), /* polling device detection hint */
a7dac447
JG		 339};
340
1da177e4
LT		 341/* forward declarations */
342struct scsi_device;
343struct ata_port_operations;
344struct ata_port;
345struct ata_queued_cmd;
346
347/* typedefs */
77853bf2 348typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
f5914a46
TH		 349typedef int (*ata_prereset_fn_t)(struct ata_port *ap);
350typedef int (*ata_reset_fn_t)(struct ata_port *ap, unsigned int *classes);
351typedef void (*ata_postreset_fn_t)(struct ata_port *ap, unsigned int *classes);
1da177e4
LT		 352
353struct ata_ioports {
354 unsigned long cmd_addr;
355 unsigned long data_addr;
356 unsigned long error_addr;
357 unsigned long feature_addr;
358 unsigned long nsect_addr;
359 unsigned long lbal_addr;
360 unsigned long lbam_addr;
361 unsigned long lbah_addr;
362 unsigned long device_addr;
363 unsigned long status_addr;
364 unsigned long command_addr;
365 unsigned long altstatus_addr;
366 unsigned long ctl_addr;
367 unsigned long bmdma_addr;
368 unsigned long scr_addr;
369};
370
371struct ata_probe_ent {
372 struct list_head node;
373 struct device *dev;
057ace5e 374 const struct ata_port_operations *port_ops;
193515d5 375 struct scsi_host_template *sht;
1da177e4
LT		 376 struct ata_ioports port[ATA_MAX_PORTS];
377 unsigned int n_ports;
dd5b06c4 378 unsigned int dummy_port_mask;
1da177e4
LT		 379 unsigned int pio_mask;
380 unsigned int mwdma_mask;
381 unsigned int udma_mask;
1da177e4 382 unsigned long irq;
2ec7df04 383 unsigned long irq2;
1da177e4 384 unsigned int irq_flags;
cca3974e
JG		 385 unsigned long port_flags;
386 unsigned long _host_flags;
1da177e4
LT		 387 void __iomem *mmio_base;
388 void *private_data;
fea63e38
TH		 389
390 /* port_info for the secondary port. Together with irq2, it's
391 * used to implement non-uniform secondary port. Currently,
392 * the only user is ata_piix combined mode. This workaround
393 * will be removed together with ata_probe_ent when init model
394 * is updated.
395 */
396 const struct ata_port_info *pinfo2;
1da177e4
LT		 397};
398
cca3974e 399struct ata_host {
1da177e4
LT		 400 spinlock_t lock;
401 struct device *dev;
402 unsigned long irq;
2ec7df04 403 unsigned long irq2;
1da177e4
LT		 404 void __iomem *mmio_base;
405 unsigned int n_ports;
406 void *private_data;
057ace5e 407 const struct ata_port_operations *ops;
5444a6f4
AC		 408 unsigned long flags;
409 int simplex_claimed; /* Keep seperate in case we
410 ever need to do this locked */
f0eb62b8 411 struct ata_port *ports[0];
1da177e4
LT		 412};
413
414struct ata_queued_cmd {
415 struct ata_port *ap;
416 struct ata_device *dev;
417
418 struct scsi_cmnd *scsicmd;
419 void (*scsidone)(struct scsi_cmnd *);
420
421 struct ata_taskfile tf;
422 u8 cdb[ATAPI_CDB_LEN];
423
424 unsigned long flags; /* ATA_QCFLAG_xxx */
425 unsigned int tag;
426 unsigned int n_elem;
cedc9a47 427 unsigned int orig_n_elem;
1da177e4
LT		 428
429 int dma_dir;
430
cedc9a47
JG		 431 unsigned int pad_len;
432
1da177e4
LT		 433 unsigned int nsect;
434 unsigned int cursect;
435
436 unsigned int nbytes;
437 unsigned int curbytes;
438
439 unsigned int cursg;
440 unsigned int cursg_ofs;
441
442 struct scatterlist sgent;
cedc9a47 443 struct scatterlist pad_sgent;
1da177e4
LT		 444 void *buf_virt;
445
cedc9a47
JG		 446 /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
447 struct scatterlist *__sg;
1da177e4 448
a22e2eb0 449 unsigned int err_mask;
e61e0672 450 struct ata_taskfile result_tf;
1da177e4
LT		 451 ata_qc_cb_t complete_fn;
452
1da177e4
LT		 453 void *private_data;
454};
455
cca3974e 456struct ata_port_stats {
1da177e4
LT		 457 unsigned long unhandled_irq;
458 unsigned long idle_irq;
459 unsigned long rw_reqbuf;
460};
461
0c247c55
TH		 462struct ata_ering_entry {
463 int is_io;
464 unsigned int err_mask;
465 u64 timestamp;
466};
467
468struct ata_ering {
469 int cursor;
470 struct ata_ering_entry ring[ATA_ERING_SIZE];
471};
472
1da177e4 473struct ata_device {
38d87234 474 struct ata_port *ap;
72fa4b74 475 unsigned int devno; /* 0 or 1 */
1da177e4 476 unsigned long flags; /* ATA_DFLAG_xxx */
3edebac4 477 struct scsi_device *sdev; /* attached SCSI device */
72fa4b74
TH		 478 /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */
479 u64 n_sectors; /* size of device, if ATA */
1da177e4 480 unsigned int class; /* ATA_DEV_xxx */
fe635c7e 481 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
1da177e4
LT		 482 u8 pio_mode;
483 u8 dma_mode;
484 u8 xfer_mode;
485 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
486
8cbd6df1
AL		 487 unsigned int multi_count; /* sectors count for
488 READ/WRITE MULTIPLE */
b00eec1d 489 unsigned int max_sectors; /* per-device max sectors */
6e7846e9 490 unsigned int cdb_len;
8bf62ece 491
acf356b1
TH		 492 /* per-dev xfer mask */
493 unsigned int pio_mask;
494 unsigned int mwdma_mask;
495 unsigned int udma_mask;
496
8bf62ece
AL		 497 /* for CHS addressing */
498 u16 cylinders; /* Number of cylinders */
499 u16 heads; /* Number of heads */
500 u16 sectors; /* Number of sectors per track */
0c247c55
TH		 501
502 /* error history */
503 struct ata_ering ering;
93590859 504 unsigned int horkage; /* List of broken features */
1da177e4
LT		 505};
506
72fa4b74
TH		 507/* Offset into struct ata_device. Fields above it are maintained
508 * acress device init. Fields below are zeroed.
509 */
510#define ATA_DEVICE_CLEAR_OFFSET offsetof(struct ata_device, n_sectors)
511
f3e81b19
TH		 512struct ata_eh_info {
513 struct ata_device *dev; /* offending device */
514 u32 serror; /* SError from LLDD */
515 unsigned int err_mask; /* port-wide err_mask */
516 unsigned int action; /* ATA_EH_* action mask */
47005f25 517 unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */
f3e81b19 518 unsigned int flags; /* ATA_EHI_* flags */
abdda733
TH		 519
520 unsigned long hotplug_timestamp;
521 unsigned int probe_mask;
522
f3e81b19
TH		 523 char desc[ATA_EH_DESC_LEN];
524 int desc_len;
525};
526
527struct ata_eh_context {
528 struct ata_eh_info i;
529 int tries[ATA_MAX_DEVICES];
abdda733
TH		 530 unsigned int classes[ATA_MAX_DEVICES];
531 unsigned int did_probe_mask;
f3e81b19
TH		 532};
533
1da177e4 534struct ata_port {
cca3974e 535 struct Scsi_Host *scsi_host; /* our co-allocated scsi host */
057ace5e 536 const struct ata_port_operations *ops;
ba6a1308 537 spinlock_t *lock;
1da177e4 538 unsigned long flags; /* ATA_FLAG_xxx */
b51e9e5d 539 unsigned int pflags; /* ATA_PFLAG_xxx */
1da177e4
LT		 540 unsigned int id; /* unique id req'd by scsi midlyr */
541 unsigned int port_no; /* unique port #; from zero */
1da177e4
LT		 542
543 struct ata_prd *prd; /* our SG list */
544 dma_addr_t prd_dma; /* and its DMA mapping */
545
cedc9a47
JG		 546 void *pad; /* array of DMA pad buffers */
547 dma_addr_t pad_dma;
548
1da177e4
LT		 549 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
550
551 u8 ctl; /* cache of ATA control register */
552 u8 last_ctl; /* Cache last written value */
1da177e4
LT		 553 unsigned int pio_mask;
554 unsigned int mwdma_mask;
555 unsigned int udma_mask;
556 unsigned int cbl; /* cable type; ATA_CBL_xxx */
5a04bf4b 557 unsigned int hw_sata_spd_limit;
1c3fae4d 558 unsigned int sata_spd_limit; /* SATA PHY speed limit */
1da177e4 559
cca3974e 560 /* record runtime error info, protected by host lock */
f3e81b19
TH		 561 struct ata_eh_info eh_info;
562 /* EH context owned by EH */
563 struct ata_eh_context eh_context;
564
1da177e4
LT		 565 struct ata_device device[ATA_MAX_DEVICES];
566
567 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
6cec4a39 568 unsigned long qc_allocated;
dedaf2b0
TH		 569 unsigned int qc_active;
570
1da177e4 571 unsigned int active_tag;
dedaf2b0 572 u32 sactive;
1da177e4 573
cca3974e
JG		 574 struct ata_port_stats stats;
575 struct ata_host *host;
2f1f610b 576 struct device *dev;
1da177e4 577
65f27f38 578 void *port_task_data;
52bad64d
DH		 579 struct delayed_work port_task;
580 struct delayed_work hotplug_task;
3b01b8af 581 struct work_struct scsi_rescan_task;
86e45b6b 582
14be71f4 583 unsigned int hsm_task_state;
1da177e4 584
bfd60579 585 u32 msg_enable;
a72ec4ce 586 struct list_head eh_done_q;
c6cf9e99 587 wait_queue_head_t eh_wait_q;
bfd60579 588
500530f6
TH		 589 pm_message_t pm_mesg;
590 int *pm_result;
591
1da177e4 592 void *private_data;
fe635c7e
TH		 593
594 u8 sector_buf[ATA_SECT_SIZE]; /* owned by EH */
1da177e4
LT		 595};
596
597struct ata_port_operations {
598 void (*port_disable) (struct ata_port *);
599
600 void (*dev_config) (struct ata_port *, struct ata_device *);
601
602 void (*set_piomode) (struct ata_port *, struct ata_device *);
603 void (*set_dmamode) (struct ata_port *, struct ata_device *);
5444a6f4 604 unsigned long (*mode_filter) (const struct ata_port *, struct ata_device *, unsigned long);
1da177e4 605
057ace5e 606 void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
1da177e4
LT		 607 void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
608
057ace5e 609 void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
1da177e4
LT		 610 u8 (*check_status)(struct ata_port *ap);
611 u8 (*check_altstatus)(struct ata_port *ap);
1da177e4
LT		 612 void (*dev_select)(struct ata_port *ap, unsigned int device);
613
c19ba8af 614 void (*phy_reset) (struct ata_port *ap); /* obsolete */
b229a7b0 615 int (*set_mode) (struct ata_port *ap, struct ata_device **r_failed_dev);
c19ba8af 616
1da177e4
LT		 617 void (*post_set_mode) (struct ata_port *ap);
618
b229a7b0 619 int (*check_atapi_dma) (struct ata_queued_cmd *qc);
1da177e4
LT		 620
621 void (*bmdma_setup) (struct ata_queued_cmd *qc);
622 void (*bmdma_start) (struct ata_queued_cmd *qc);
623
a6b2c5d4
AC		 624 void (*data_xfer) (struct ata_device *, unsigned char *, unsigned int, int);
625
1da177e4 626 void (*qc_prep) (struct ata_queued_cmd *qc);
9a3d9eb0 627 unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
1da177e4 628
9ec957f2
TH		 629 /* Error handlers. ->error_handler overrides ->eng_timeout and
630 * indicates that new-style EH is in place.
631 */
632 void (*eng_timeout) (struct ata_port *ap); /* obsolete */
633
634 void (*freeze) (struct ata_port *ap);
635 void (*thaw) (struct ata_port *ap);
636 void (*error_handler) (struct ata_port *ap);
637 void (*post_internal_cmd) (struct ata_queued_cmd *qc);
1da177e4 638
7d12e780 639 irq_handler_t irq_handler;
1da177e4
LT		 640 void (*irq_clear) (struct ata_port *);
641
642 u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg);
643 void (*scr_write) (struct ata_port *ap, unsigned int sc_reg,
644 u32 val);
645
500530f6
TH		 646 int (*port_suspend) (struct ata_port *ap, pm_message_t mesg);
647 int (*port_resume) (struct ata_port *ap);
648
1da177e4
LT		 649 int (*port_start) (struct ata_port *ap);
650 void (*port_stop) (struct ata_port *ap);
651
cca3974e 652 void (*host_stop) (struct ata_host *host);
1da177e4 653
b73fc89f 654 void (*bmdma_stop) (struct ata_queued_cmd *qc);
1da177e4
LT		 655 u8 (*bmdma_status) (struct ata_port *ap);
656};
657
658struct ata_port_info {
d0be4a7d 659 struct scsi_host_template *sht;
cca3974e 660 unsigned long flags;
1da177e4
LT		 661 unsigned long pio_mask;
662 unsigned long mwdma_mask;
663 unsigned long udma_mask;
057ace5e 664 const struct ata_port_operations *port_ops;
e99f8b5e 665 void *private_data;
1da177e4
LT		 666};
667
452503f9
AC		 668struct ata_timing {
669 unsigned short mode; /* ATA mode */
670 unsigned short setup; /* t1 */
671 unsigned short act8b; /* t2 for 8-bit I/O */
672 unsigned short rec8b; /* t2i for 8-bit I/O */
673 unsigned short cyc8b; /* t0 for 8-bit I/O */
674 unsigned short active; /* t2 or tD */
675 unsigned short recover; /* t2i or tK */
676 unsigned short cycle; /* t0 */
677 unsigned short udma; /* t2CYCTYP/2 */
678};
679
680#define FIT(v,vmin,vmax) max_t(short,min_t(short,v,vmax),vmin)
1da177e4 681
e9c83914
TH		 682extern const unsigned long sata_deb_timing_normal[];
683extern const unsigned long sata_deb_timing_hotplug[];
684extern const unsigned long sata_deb_timing_long[];
685
dd5b06c4
TH		 686extern const struct ata_port_operations ata_dummy_port_ops;
687
e9c83914
TH		 688static inline const unsigned long *
689sata_ehc_deb_timing(struct ata_eh_context *ehc)
690{
691 if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
692 return sata_deb_timing_hotplug;
693 else
694 return sata_deb_timing_normal;
695}
d7bb4cc7 696
dd5b06c4
TH		 697static inline int ata_port_is_dummy(struct ata_port *ap)
698{
699 return ap->ops == &ata_dummy_port_ops;
700}
701
1da177e4
LT		 702extern void ata_port_probe(struct ata_port *);
703extern void __sata_phy_reset(struct ata_port *ap);
704extern void sata_phy_reset(struct ata_port *ap);
705extern void ata_bus_reset(struct ata_port *ap);
3c567b7d 706extern int sata_set_spd(struct ata_port *ap);
d7bb4cc7
TH		 707extern int sata_phy_debounce(struct ata_port *ap, const unsigned long *param);
708extern int sata_phy_resume(struct ata_port *ap, const unsigned long *param);
f5914a46 709extern int ata_std_prereset(struct ata_port *ap);
2bf2cb26 710extern int ata_std_softreset(struct ata_port *ap, unsigned int *classes);
b6103f6d
TH		 711extern int sata_port_hardreset(struct ata_port *ap,
712 const unsigned long *timing);
2bf2cb26 713extern int sata_std_hardreset(struct ata_port *ap, unsigned int *class);
c2bd5804 714extern void ata_std_postreset(struct ata_port *ap, unsigned int *classes);
1da177e4
LT		 715extern void ata_port_disable(struct ata_port *);
716extern void ata_std_ports(struct ata_ioports *ioaddr);
717#ifdef CONFIG_PCI
718extern int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info,
719 unsigned int n_ports);
720extern void ata_pci_remove_one (struct pci_dev *pdev);
3c5100c1 721extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
500530f6 722extern void ata_pci_device_do_resume(struct pci_dev *pdev);
3c5100c1 723extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
9b847548 724extern int ata_pci_device_resume(struct pci_dev *pdev);
17bb34a3 725extern int ata_pci_clear_simplex(struct pci_dev *pdev);
1da177e4 726#endif /* CONFIG_PCI */
057ace5e 727extern int ata_device_add(const struct ata_probe_ent *ent);
720ba126 728extern void ata_port_detach(struct ata_port *ap);
cca3974e
JG		 729extern void ata_host_init(struct ata_host *, struct device *,
730 unsigned long, const struct ata_port_operations *);
731extern void ata_host_remove(struct ata_host *host);
193515d5 732extern int ata_scsi_detect(struct scsi_host_template *sht);
1da177e4
LT		 733extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
734extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
1da177e4 735extern int ata_scsi_release(struct Scsi_Host *host);
80289167 736extern void ata_sas_port_destroy(struct ata_port *);
cca3974e 737extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
80289167
BK		 738 struct ata_port_info *, struct Scsi_Host *);
739extern int ata_sas_port_init(struct ata_port *);
740extern int ata_sas_port_start(struct ata_port *ap);
741extern void ata_sas_port_stop(struct ata_port *ap);
742extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
743extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
744 struct ata_port *ap);
1da177e4 745extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
34bf2170
TH		 746extern int sata_scr_valid(struct ata_port *ap);
747extern int sata_scr_read(struct ata_port *ap, int reg, u32 *val);
748extern int sata_scr_write(struct ata_port *ap, int reg, u32 val);
749extern int sata_scr_write_flush(struct ata_port *ap, int reg, u32 val);
750extern int ata_port_online(struct ata_port *ap);
751extern int ata_port_offline(struct ata_port *ap);
9b847548 752extern int ata_scsi_device_resume(struct scsi_device *);
3c5100c1 753extern int ata_scsi_device_suspend(struct scsi_device *, pm_message_t mesg);
cca3974e
JG		 754extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
755extern void ata_host_resume(struct ata_host *host);
67846b30 756extern int ata_ratelimit(void);
d1adc1bb
TH		 757extern int ata_busy_sleep(struct ata_port *ap,
758 unsigned long timeout_pat, unsigned long timeout);
65f27f38 759extern void ata_port_queue_task(struct ata_port *ap, work_func_t fn,
86e45b6b 760 void *data, unsigned long delay);
c22daff4
TH		 761extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
762 unsigned long interval_msec,
763 unsigned long timeout_msec);
67846b30 764
1da177e4
LT		 765/*
766 * Default driver ops implementations
767 */
057ace5e 768extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
1da177e4 769extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
057ace5e
JG		 770extern void ata_tf_to_fis(const struct ata_taskfile *tf, u8 *fis, u8 pmp);
771extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
1da177e4
LT		 772extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
773extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
774extern u8 ata_check_status(struct ata_port *ap);
775extern u8 ata_altstatus(struct ata_port *ap);
057ace5e 776extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
1da177e4
LT		 777extern int ata_port_start (struct ata_port *ap);
778extern void ata_port_stop (struct ata_port *ap);
cca3974e 779extern void ata_host_stop (struct ata_host *host);
7d12e780 780extern irqreturn_t ata_interrupt (int irq, void *dev_instance);
a6b2c5d4
AC		 781extern void ata_mmio_data_xfer(struct ata_device *adev, unsigned char *buf,
782 unsigned int buflen, int write_data);
783extern void ata_pio_data_xfer(struct ata_device *adev, unsigned char *buf,
784 unsigned int buflen, int write_data);
75e99585
AC		 785extern void ata_pio_data_xfer_noirq(struct ata_device *adev, unsigned char *buf,
786 unsigned int buflen, int write_data);
1da177e4 787extern void ata_qc_prep(struct ata_queued_cmd *qc);
e46834cd 788extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
9a3d9eb0 789extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
1da177e4
LT		 790extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
791 unsigned int buflen);
792extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
793 unsigned int n_elem);
057ace5e 794extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
6a62a04d
TH		 795extern void ata_id_string(const u16 *id, unsigned char *s,
796 unsigned int ofs, unsigned int len);
797extern void ata_id_c_string(const u16 *id, unsigned char *s,
798 unsigned int ofs, unsigned int len);
6919a0a6 799extern unsigned long ata_device_blacklisted(const struct ata_device *dev);
1da177e4
LT		 800extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
801extern void ata_bmdma_start (struct ata_queued_cmd *qc);
b73fc89f 802extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
1da177e4
LT		 803extern u8 ata_bmdma_status(struct ata_port *ap);
804extern void ata_bmdma_irq_clear(struct ata_port *ap);
6d97dbd7
TH		 805extern void ata_bmdma_freeze(struct ata_port *ap);
806extern void ata_bmdma_thaw(struct ata_port *ap);
f5914a46 807extern void ata_bmdma_drive_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
6d97dbd7
TH		 808 ata_reset_fn_t softreset,
809 ata_reset_fn_t hardreset,
810 ata_postreset_fn_t postreset);
811extern void ata_bmdma_error_handler(struct ata_port *ap);
812extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
9a1004d0
TH		 813extern int ata_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
814 u8 status, int in_wq);
f686bcb8 815extern void ata_qc_complete(struct ata_queued_cmd *qc);
dedaf2b0
TH		 816extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active,
817 void (*finish_qc)(struct ata_queued_cmd *));
3373efd8 818extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
1da177e4
LT		 819 void (*done)(struct scsi_cmnd *));
820extern int ata_std_bios_param(struct scsi_device *sdev,
821 struct block_device *bdev,
822 sector_t capacity, int geom[]);
823extern int ata_scsi_slave_config(struct scsi_device *sdev);
83c47bcb 824extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
a6e6ce8e
TH		 825extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
826 int queue_depth);
3373efd8 827extern struct ata_device *ata_dev_pair(struct ata_device *adev);
1da177e4 828
452503f9
AC		 829/*
830 * Timing helpers
831 */
1bc4ccff
AC		 832
833extern unsigned int ata_pio_need_iordy(const struct ata_device *);
452503f9
AC		 834extern int ata_timing_compute(struct ata_device *, unsigned short,
835 struct ata_timing *, int, int);
836extern void ata_timing_merge(const struct ata_timing *,
837 const struct ata_timing *, struct ata_timing *,
838 unsigned int);
839
840enum {
841 ATA_TIMING_SETUP = (1 << 0),
842 ATA_TIMING_ACT8B = (1 << 1),
843 ATA_TIMING_REC8B = (1 << 2),
844 ATA_TIMING_CYC8B = (1 << 3),
845 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
846 ATA_TIMING_CYC8B,
847 ATA_TIMING_ACTIVE = (1 << 4),
848 ATA_TIMING_RECOVER = (1 << 5),
849 ATA_TIMING_CYCLE = (1 << 6),
850 ATA_TIMING_UDMA = (1 << 7),
851 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
852 ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
853 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
854 ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
855};
856
1da177e4
LT		 857
858#ifdef CONFIG_PCI
859struct pci_bits {
860 unsigned int reg; /* PCI config register to read */
861 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
862 unsigned long mask;
863 unsigned long val;
864};
865
cca3974e 866extern void ata_pci_host_stop (struct ata_host *host);
1da177e4 867extern struct ata_probe_ent *
47a86593 868ata_pci_init_native_mode(struct pci_dev *pdev, struct ata_port_info **port, int portmask);
057ace5e 869extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
17bb34a3 870extern unsigned long ata_pci_default_filter(const struct ata_port *, struct ata_device *, unsigned long);
1da177e4
LT		 871#endif /* CONFIG_PCI */
872
ece1d636
TH		 873/*
874 * EH
875 */
ece1d636 876extern void ata_eng_timeout(struct ata_port *ap);
7b70fc03
TH		 877
878extern void ata_port_schedule_eh(struct ata_port *ap);
879extern int ata_port_abort(struct ata_port *ap);
e3180499
TH		 880extern int ata_port_freeze(struct ata_port *ap);
881
882extern void ata_eh_freeze_port(struct ata_port *ap);
883extern void ata_eh_thaw_port(struct ata_port *ap);
7b70fc03 884
ece1d636
TH		 885extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
886extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
887
f5914a46
TH		 888extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
889 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
890 ata_postreset_fn_t postreset);
022bdb07 891
61440db6
TH		 892/*
893 * printk helpers
894 */
895#define ata_port_printk(ap, lv, fmt, args...) \
896 printk(lv"ata%u: "fmt, (ap)->id , ##args)
897
898#define ata_dev_printk(dev, lv, fmt, args...) \
899 printk(lv"ata%u.%02u: "fmt, (dev)->ap->id, (dev)->devno , ##args)
1da177e4 900
f3e81b19
TH		 901/*
902 * ata_eh_info helpers
903 */
904#define ata_ehi_push_desc(ehi, fmt, args...) do { \
905 (ehi)->desc_len += scnprintf((ehi)->desc + (ehi)->desc_len, \
906 ATA_EH_DESC_LEN - (ehi)->desc_len, \
907 fmt , ##args); \
908} while (0)
909
910#define ata_ehi_clear_desc(ehi) do { \
911 (ehi)->desc[0] = '\0'; \
912 (ehi)->desc_len = 0; \
913} while (0)
914
c0b6c037 915static inline void __ata_ehi_hotplugged(struct ata_eh_info *ehi)
084fe639
TH		 916{
917 if (ehi->flags & ATA_EHI_HOTPLUGGED)
918 return;
919
28324304 920 ehi->flags |= ATA_EHI_HOTPLUGGED | ATA_EHI_RESUME_LINK;
084fe639
TH		 921 ehi->hotplug_timestamp = jiffies;
922
084fe639
TH		 923 ehi->action |= ATA_EH_SOFTRESET;
924 ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
925}
926
c0b6c037
TH		 927static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
928{
929 __ata_ehi_hotplugged(ehi);
930 ehi->err_mask |= AC_ERR_ATA_BUS;
931}
932
61440db6
TH		 933/*
934 * qc helpers
935 */
972c26bd
JG		 936static inline int
937ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
938{
939 if (sg == &qc->pad_sgent)
940 return 1;
941 if (qc->pad_len)
942 return 0;
943 if (((sg - qc->__sg) + 1) == qc->n_elem)
944 return 1;
945 return 0;
946}
947
cc1887f3
TH		 948static inline struct scatterlist *
949ata_qc_first_sg(struct ata_queued_cmd *qc)
950{
951 if (qc->n_elem)
952 return qc->__sg;
953 if (qc->pad_len)
954 return &qc->pad_sgent;
955 return NULL;
956}
957
cedc9a47
JG		 958static inline struct scatterlist *
959ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
960{
961 if (sg == &qc->pad_sgent)
962 return NULL;
963 if (++sg - qc->__sg < qc->n_elem)
964 return sg;
cc1887f3
TH		 965 if (qc->pad_len)
966 return &qc->pad_sgent;
967 return NULL;
cedc9a47
JG		 968}
969
970#define ata_for_each_sg(sg, qc) \
cc1887f3 971 for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
cedc9a47 972
1da177e4
LT		 973static inline unsigned int ata_tag_valid(unsigned int tag)
974{
975 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
976}
977
2ab7db1f
TH		 978static inline unsigned int ata_tag_internal(unsigned int tag)
979{
980 return tag == ATA_MAX_QUEUE - 1;
981}
982
5806db22
TH		 983/*
984 * device helpers
985 */
e1211e3f 986static inline unsigned int ata_class_enabled(unsigned int class)
597afd21
TH		 987{
988 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI;
989}
990
e1211e3f 991static inline unsigned int ata_class_disabled(unsigned int class)
1da177e4 992{
e1211e3f
TH		 993 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP;
994}
995
002c8054
TH		 996static inline unsigned int ata_class_absent(unsigned int class)
997{
998 return !ata_class_enabled(class) && !ata_class_disabled(class);
999}
1000
e1211e3f
TH		 1001static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1002{
1003 return ata_class_enabled(dev->class);
1004}
1005
1006static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1007{
1008 return ata_class_disabled(dev->class);
1da177e4
LT		 1009}
1010
002c8054
TH		 1011static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1012{
1013 return ata_class_absent(dev->class);
1014}
1015
02670bf3
TH		 1016static inline unsigned int ata_dev_ready(const struct ata_device *dev)
1017{
1018 return ata_dev_enabled(dev) && !(dev->flags & ATA_DFLAG_SUSPENDED);
1019}
1020
5806db22
TH		 1021/*
1022 * port helpers
1023 */
1024static inline int ata_port_max_devices(const struct ata_port *ap)
1025{
1026 if (ap->flags & ATA_FLAG_SLAVE_POSS)
1027 return 2;
1028 return 1;
1029}
1030
1031
1da177e4
LT		 1032static inline u8 ata_chk_status(struct ata_port *ap)
1033{
1034 return ap->ops->check_status(ap);
1035}
1036
0baab86b
EF		 1037
1038/**
1039 * ata_pause - Flush writes and pause 400 nanoseconds.
1040 * @ap: Port to wait for.
1041 *
1042 * LOCKING:
1043 * Inherited from caller.
1044 */
1045
1da177e4
LT		 1046static inline void ata_pause(struct ata_port *ap)
1047{
1048 ata_altstatus(ap);
1049 ndelay(400);
1050}
1051
0baab86b
EF		 1052
1053/**
1054 * ata_busy_wait - Wait for a port status register
1055 * @ap: Port to wait for.
1056 *
1057 * Waits up to max*10 microseconds for the selected bits in the port's
1058 * status register to be cleared.
1059 * Returns final value of status register.
1060 *
1061 * LOCKING:
1062 * Inherited from caller.
1063 */
1064
1da177e4
LT		 1065static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
1066 unsigned int max)
1067{
1068 u8 status;
1069
1070 do {
1071 udelay(10);
1072 status = ata_chk_status(ap);
1073 max--;
d1adc1bb 1074 } while (status != 0xff && (status & bits) && (max > 0));
1da177e4
LT		 1075
1076 return status;
1077}
1078
0baab86b
EF		 1079
1080/**
1081 * ata_wait_idle - Wait for a port to be idle.
1082 * @ap: Port to wait for.
1083 *
1084 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
1085 * Returns final value of status register.
1086 *
1087 * LOCKING:
1088 * Inherited from caller.
1089 */
1090
1da177e4
LT		 1091static inline u8 ata_wait_idle(struct ata_port *ap)
1092{
1093 u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1094
d1adc1bb 1095 if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ))) {
1da177e4 1096 unsigned long l = ap->ioaddr.status_addr;
bfd60579
RD		 1097 if (ata_msg_warn(ap))
1098 printk(KERN_WARNING "ATA: abnormal status 0x%X on port 0x%lX\n",
1099 status, l);
1da177e4
LT		 1100 }
1101
1102 return status;
1103}
1104
1105static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1106{
1107 qc->tf.ctl |= ATA_NIEN;
1108}
1109
f69499f4
TH		 1110static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1111 unsigned int tag)
1da177e4
LT		 1112{
1113 if (likely(ata_tag_valid(tag)))
1114 return &ap->qcmd[tag];
1115 return NULL;
1116}
1117
f69499f4
TH		 1118static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1119 unsigned int tag)
1120{
1121 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1122
1123 if (unlikely(!qc) || !ap->ops->error_handler)
1124 return qc;
1125
1126 if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1127 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1128 return qc;
1129
1130 return NULL;
1131}
1132
3373efd8 1133static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1da177e4
LT		 1134{
1135 memset(tf, 0, sizeof(*tf));
1136
3373efd8
TH		 1137 tf->ctl = dev->ap->ctl;
1138 if (dev->devno == 0)
1da177e4
LT		 1139 tf->device = ATA_DEVICE_OBS;
1140 else
1141 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1142}
1143
2c13b7ce
JG		 1144static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1145{
501e0c50 1146 qc->dma_dir = DMA_NONE;
2c13b7ce
JG		 1147 qc->__sg = NULL;
1148 qc->flags = 0;
1149 qc->cursect = qc->cursg = qc->cursg_ofs = 0;
1150 qc->nsect = 0;
1151 qc->nbytes = qc->curbytes = 0;
7a801184 1152 qc->n_elem = 0;
a22e2eb0 1153 qc->err_mask = 0;
d0f29485 1154 qc->pad_len = 0;
2c13b7ce 1155
3373efd8 1156 ata_tf_init(qc->dev, &qc->tf);
e61e0672
TH		 1157
1158 /* init result_tf such that it indicates normal completion */
1159 qc->result_tf.command = ATA_DRDY;
1160 qc->result_tf.feature = 0;
2c13b7ce
JG		 1161}
1162
0baab86b
EF		 1163/**
1164 * ata_irq_ack - Acknowledge a device interrupt.
1165 * @ap: Port on which interrupts are enabled.
1166 *
1167 * Wait up to 10 ms for legacy IDE device to become idle (BUSY
1168 * or BUSY+DRQ clear). Obtain dma status and port status from
1169 * device. Clear the interrupt. Return port status.
1170 *
1171 * LOCKING:
1172 */
1173
1da177e4
LT		 1174static inline u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq)
1175{
1176 unsigned int bits = chk_drq ? ATA_BUSY | ATA_DRQ : ATA_BUSY;
1177 u8 host_stat, post_stat, status;
1178
1179 status = ata_busy_wait(ap, bits, 1000);
1180 if (status & bits)
bfd60579
RD		 1181 if (ata_msg_err(ap))
1182 printk(KERN_ERR "abnormal status 0x%X\n", status);
1da177e4
LT		 1183
1184 /* get controller status; clear intr, err bits */
1185 if (ap->flags & ATA_FLAG_MMIO) {
1186 void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr;
1187 host_stat = readb(mmio + ATA_DMA_STATUS);
1188 writeb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
1189 mmio + ATA_DMA_STATUS);
1190
1191 post_stat = readb(mmio + ATA_DMA_STATUS);
1192 } else {
1193 host_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
1194 outb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
1195 ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
1196
1197 post_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
1198 }
1199
bfd60579
RD		 1200 if (ata_msg_intr(ap))
1201 printk(KERN_INFO "%s: irq ack: host_stat 0x%X, new host_stat 0x%X, drv_stat 0x%X\n",
1202 __FUNCTION__,
1203 host_stat, post_stat, status);
1da177e4
LT		 1204
1205 return status;
1206}
1207
057ace5e 1208static inline int ata_try_flush_cache(const struct ata_device *dev)
1da177e4
LT		 1209{
1210 return ata_id_wcache_enabled(dev->id) ||
1211 ata_id_has_flush(dev->id) ||
1212 ata_id_has_flush_ext(dev->id);
1213}
1214
a7dac447
JG		 1215static inline unsigned int ac_err_mask(u8 status)
1216{
3655d1d3 1217 if (status & (ATA_BUSY | ATA_DRQ))
11a56d24 1218 return AC_ERR_HSM;
a7dac447
JG		 1219 if (status & (ATA_ERR | ATA_DF))
1220 return AC_ERR_DEV;
1221 return 0;
1222}
1223
1224static inline unsigned int __ac_err_mask(u8 status)
1225{
1226 unsigned int mask = ac_err_mask(status);
1227 if (mask == 0)
1228 return AC_ERR_OTHER;
1229 return mask;
1230}
1231
6037d6bb
JG		 1232static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
1233{
1234 ap->pad_dma = 0;
1235 ap->pad = dma_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
1236 &ap->pad_dma, GFP_KERNEL);
1237 return (ap->pad == NULL) ? -ENOMEM : 0;
1238}
1239
1240static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
1241{
1242 dma_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
1243}
1244
35bb94b1
JG		 1245static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1246{
1247 return (struct ata_port *) &host->hostdata[0];
1248}
1249
1da177e4 1250#endif /* __LINUX_LIBATA_H__ */
Ubuntu Artful kernel mirror