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