]> 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
sata_promise: FastTrack TX4200 is a second-generation chip
[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>
41542dbe 33#include <asm/scatterlist.h>
f0d36efd 34#include <linux/io.h>
1da177e4
LT		 35#include <linux/ata.h>
36#include <linux/workqueue.h>
35bb94b1 37#include <scsi/scsi_host.h>
11ef697b 38#include <linux/acpi.h>
1da177e4 39
a6d967a4
JG		 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
2ec7df04 45#include <asm/libata-portmap.h>
a6d967a4
JG		 46#else
47#include <asm-generic/libata-portmap.h>
48#endif
2ec7df04 49
1da177e4 50/*
bfd60579
RD		 51 * compile-time options: to be removed as soon as all the drivers are
52 * converted to the new debugging mechanism
1da177e4
LT		 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 */
1da177e4
LT		 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
2c13b7ce
JG		 73#define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
74
bfd60579
RD		 75/* NEW: debug levels */
76#define HAVE_LIBATA_MSG 1
77
78enum {
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
98static 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
1da177e4
LT		 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? */
111static inline struct device *pci_dev_to_dev(struct pci_dev *pdev)
112{
113 return &pdev->dev;
114}
115
116enum {
117 /* various global constants */
118 LIBATA_MAX_PRD = ATA_MAX_PRD / 2,
d26fc955 119 LIBATA_DUMB_MAX_PRD = ATA_MAX_PRD / 4, /* Worst case */
1da177e4
LT		 120 ATA_MAX_PORTS = 8,
121 ATA_DEF_QUEUE = 1,
2ab7db1f 122 /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
a6e6ce8e 123 ATA_MAX_QUEUE = 32,
2ab7db1f 124 ATA_TAG_INTERNAL = ATA_MAX_QUEUE - 1,
1da177e4
LT		 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,
cf482935 132 ATA_SHT_USE_CLUSTERING = 1,
1da177e4
LT		 133
134 /* struct ata_device stuff */
949b38af
TH		 135 ATA_DFLAG_LBA = (1 << 0), /* device supports LBA */
136 ATA_DFLAG_LBA48 = (1 << 1), /* device supports LBA48 */
029f5468 137 ATA_DFLAG_CDB_INTR = (1 << 2), /* device asserts INTRQ when ready for CDB */
88e49034 138 ATA_DFLAG_NCQ = (1 << 3), /* device supports NCQ */
6fc49adb 139 ATA_DFLAG_FLUSH_EXT = (1 << 4), /* do FLUSH_EXT instead of FLUSH */
6746544c
TH		 140 ATA_DFLAG_ACPI_PENDING = (1 << 5), /* ACPI resume action pending */
141 ATA_DFLAG_ACPI_FAILED = (1 << 6), /* ACPI on devcfg has failed */
ea1dd4e1 142 ATA_DFLAG_CFG_MASK = (1 << 8) - 1,
949b38af 143
e5c9e081 144 ATA_DFLAG_PIO = (1 << 8), /* device limited to PIO mode */
3343571d 145 ATA_DFLAG_NCQ_OFF = (1 << 9), /* device limited to non-NCQ mode */
13b8d09f 146 ATA_DFLAG_SPUNDOWN = (1 << 10), /* XXX: for spindown_compat */
72fa4b74 147 ATA_DFLAG_INIT_MASK = (1 << 16) - 1,
1da177e4 148
abdda733
TH		 149 ATA_DFLAG_DETACH = (1 << 16),
150 ATA_DFLAG_DETACHED = (1 << 17),
151
1da177e4
LT		 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 */
949b38af 160 ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */
1da177e4 161 /* (doesn't imply presence) */
949b38af
TH		 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 */
7395acb2
TH		 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 */
abdda733
TH		 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 */
7395acb2 176 ATA_FLAG_DEBUGMSG = (1 << 13),
b2a8bbe6 177 ATA_FLAG_IGN_SIMPLEX = (1 << 15), /* ignore SIMPLEX */
f834e49f 178 ATA_FLAG_NO_IORDY = (1 << 16), /* controller lacks iordy */
3cadbcc0 179 ATA_FLAG_ACPI_SATA = (1 << 17), /* need native SATA ACPI layout */
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 */
f4d6d004 197 ATA_PFLAG_INITIALIZING = (1 << 7), /* being initialized, don't touch */
949b38af 198
b51e9e5d 199 ATA_PFLAG_SUSPENDED = (1 << 17), /* port is suspended (power) */
500530f6 200 ATA_PFLAG_PM_PENDING = (1 << 18), /* PM operation pending */
64578a3d 201 ATA_PFLAG_GTM_VALID = (1 << 19), /* acpi_gtm data valid */
949b38af
TH		 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 */
1da177e4 207 ATA_QCFLAG_DMAMAP = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE,
27197367 208 ATA_QCFLAG_IO = (1 << 3), /* standard IO command */
e61e0672
TH		 209 ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */
210
9ec957f2
TH		 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) */
1da177e4 214
4e5ec5db 215 /* host set flags */
cca3974e 216 ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host only */
ecef7253 217 ATA_HOST_STARTED = (1 << 1), /* Host started */
9bec2e38 218
b8b275ef
TH		 219 /* bits 24:31 of host->flags are reserved for LLD specific flags */
220
1da177e4 221 /* various lengths of time */
8d238e01
AC		 222 ATA_TMOUT_BOOT = 30 * HZ, /* heuristic */
223 ATA_TMOUT_BOOT_QUICK = 7 * HZ, /* heuristic */
a2a7a662
TH		 224 ATA_TMOUT_INTERNAL = 30 * HZ,
225 ATA_TMOUT_INTERNAL_QUICK = 5 * HZ,
1da177e4
LT		 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
1da7b0d0 245 * unsigned int bitmap
1da177e4 246 */
b352e57d
AC		 247 ATA_BITS_PIO = 7,
248 ATA_BITS_MWDMA = 5,
1da7b0d0
TH		 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,
cedc9a47
JG		 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,
949b38af 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),
273
274 ATA_EH_RESET_MASK = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
9666f400 275 ATA_EH_PERDEV_MASK = ATA_EH_REVALIDATE,
9be1e979 276
f3e81b19 277 /* ata_eh_info->flags */
abdda733 278 ATA_EHI_HOTPLUGGED = (1 << 0), /* could have been hotplugged */
13abf50d 279 ATA_EHI_RESUME_LINK = (1 << 1), /* resume link (reset modifier) */
1cdaf534
TH		 280 ATA_EHI_NO_AUTOPSY = (1 << 2), /* no autopsy */
281 ATA_EHI_QUIET = (1 << 3), /* be quiet */
abdda733 282
0d64a233
TH		 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 */
f3e81b19 288
0d64a233 289 ATA_EHI_DID_RESET = ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
13abf50d
TH		 290 ATA_EHI_RESET_MODIFIER_MASK = ATA_EHI_RESUME_LINK,
291
ad9e2762
TH		 292 /* max repeat if error condition is still set after ->error_handler */
293 ATA_EH_MAX_REPEAT = 5,
294
14d2bac1
TH		 295 /* how hard are we gonna try to probe/recover devices */
296 ATA_PROBE_MAX_TRIES = 3,
022bdb07 297 ATA_EH_DEV_TRIES = 3,
f5914a46 298
93590859
AC		 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 */
6919a0a6
AC		 303 ATA_HORKAGE_NODMA = (1 << 1), /* DMA problems */
304 ATA_HORKAGE_NONCQ = (1 << 2), /* Don't use NCQ */
18d6e9d5 305 ATA_HORKAGE_MAX_SEC_128 = (1 << 3), /* Limit max sects to 128 */
1da177e4
LT		 306};
307
14be71f4 308enum hsm_task_states {
c56b14d2 309 HSM_ST_IDLE, /* no command on going */
71527647
AL		 310 HSM_ST_FIRST, /* (waiting the device to)
311 write CDB or first data block */
c56b14d2
AL		 312 HSM_ST, /* (waiting the device to) transfer data */
313 HSM_ST_LAST, /* (waiting the device to) complete command */
c56b14d2 314 HSM_ST_ERR, /* error */
1da177e4
LT		 315};
316
a7dac447 317enum ata_completion_errors {
11a56d24
TH		 318 AC_ERR_DEV = (1 << 0), /* device reported error */
319 AC_ERR_HSM = (1 << 1), /* host state machine violation */
320 AC_ERR_TIMEOUT = (1 << 2), /* timeout */
321 AC_ERR_MEDIA = (1 << 3), /* media error */
322 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
323 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
324 AC_ERR_SYSTEM = (1 << 6), /* system error */
325 AC_ERR_INVALID = (1 << 7), /* invalid argument */
326 AC_ERR_OTHER = (1 << 8), /* unknown */
55a8e2c8 327 AC_ERR_NODEV_HINT = (1 << 9), /* polling device detection hint */
5335b729 328 AC_ERR_NCQ = (1 << 10), /* marker for offending NCQ qc */
a7dac447
JG		 329};
330
1da177e4
LT		 331/* forward declarations */
332struct scsi_device;
333struct ata_port_operations;
334struct ata_port;
335struct ata_queued_cmd;
336
337/* typedefs */
77853bf2 338typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
d4b2bab4
TH		 339typedef int (*ata_prereset_fn_t)(struct ata_port *ap, unsigned long deadline);
340typedef int (*ata_reset_fn_t)(struct ata_port *ap, unsigned int *classes,
341 unsigned long deadline);
f5914a46 342typedef void (*ata_postreset_fn_t)(struct ata_port *ap, unsigned int *classes);
1da177e4
LT		 343
344struct ata_ioports {
0d5ff566
TH		 345 void __iomem *cmd_addr;
346 void __iomem *data_addr;
347 void __iomem *error_addr;
348 void __iomem *feature_addr;
349 void __iomem *nsect_addr;
350 void __iomem *lbal_addr;
351 void __iomem *lbam_addr;
352 void __iomem *lbah_addr;
353 void __iomem *device_addr;
354 void __iomem *status_addr;
355 void __iomem *command_addr;
356 void __iomem *altstatus_addr;
357 void __iomem *ctl_addr;
358 void __iomem *bmdma_addr;
359 void __iomem *scr_addr;
1da177e4
LT		 360};
361
cca3974e 362struct ata_host {
1da177e4
LT		 363 spinlock_t lock;
364 struct device *dev;
365 unsigned long irq;
2ec7df04 366 unsigned long irq2;
0d5ff566 367 void __iomem * const *iomap;
1da177e4
LT		 368 unsigned int n_ports;
369 void *private_data;
057ace5e 370 const struct ata_port_operations *ops;
5444a6f4 371 unsigned long flags;
fafbae87
TH		 372#ifdef CONFIG_ATA_ACPI
373 acpi_handle acpi_handle;
374#endif
032af1ce 375 struct ata_port *simplex_claimed; /* channel owning the DMA */
f0eb62b8 376 struct ata_port *ports[0];
1da177e4
LT		 377};
378
379struct ata_queued_cmd {
380 struct ata_port *ap;
381 struct ata_device *dev;
382
383 struct scsi_cmnd *scsicmd;
384 void (*scsidone)(struct scsi_cmnd *);
385
386 struct ata_taskfile tf;
387 u8 cdb[ATAPI_CDB_LEN];
388
389 unsigned long flags; /* ATA_QCFLAG_xxx */
390 unsigned int tag;
391 unsigned int n_elem;
cedc9a47 392 unsigned int orig_n_elem;
1da177e4
LT		 393
394 int dma_dir;
395
cedc9a47 396 unsigned int pad_len;
5a5dbd18 397 unsigned int sect_size;
cedc9a47 398
1da177e4
LT		 399 unsigned int nbytes;
400 unsigned int curbytes;
401
402 unsigned int cursg;
403 unsigned int cursg_ofs;
404
405 struct scatterlist sgent;
cedc9a47 406 struct scatterlist pad_sgent;
1da177e4
LT		 407 void *buf_virt;
408
cedc9a47
JG		 409 /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
410 struct scatterlist *__sg;
1da177e4 411
a22e2eb0 412 unsigned int err_mask;
e61e0672 413 struct ata_taskfile result_tf;
1da177e4
LT		 414 ata_qc_cb_t complete_fn;
415
1da177e4 416 void *private_data;
1c50dc83 417 void *lldd_task;
1da177e4
LT		 418};
419
cca3974e 420struct ata_port_stats {
1da177e4
LT		 421 unsigned long unhandled_irq;
422 unsigned long idle_irq;
423 unsigned long rw_reqbuf;
424};
425
0c247c55
TH		 426struct ata_ering_entry {
427 int is_io;
428 unsigned int err_mask;
429 u64 timestamp;
430};
431
432struct ata_ering {
433 int cursor;
434 struct ata_ering_entry ring[ATA_ERING_SIZE];
435};
436
1da177e4 437struct ata_device {
38d87234 438 struct ata_port *ap;
72fa4b74 439 unsigned int devno; /* 0 or 1 */
1da177e4 440 unsigned long flags; /* ATA_DFLAG_xxx */
75683fe7 441 unsigned int horkage; /* List of broken features */
3edebac4 442 struct scsi_device *sdev; /* attached SCSI device */
fafbae87
TH		 443#ifdef CONFIG_ATA_ACPI
444 acpi_handle acpi_handle;
445#endif
72fa4b74
TH		 446 /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */
447 u64 n_sectors; /* size of device, if ATA */
1da177e4 448 unsigned int class; /* ATA_DEV_xxx */
fe635c7e 449 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
1da177e4
LT		 450 u8 pio_mode;
451 u8 dma_mode;
452 u8 xfer_mode;
453 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
454
8cbd6df1
AL		 455 unsigned int multi_count; /* sectors count for
456 READ/WRITE MULTIPLE */
b00eec1d 457 unsigned int max_sectors; /* per-device max sectors */
6e7846e9 458 unsigned int cdb_len;
8bf62ece 459
acf356b1
TH		 460 /* per-dev xfer mask */
461 unsigned int pio_mask;
462 unsigned int mwdma_mask;
463 unsigned int udma_mask;
464
8bf62ece
AL		 465 /* for CHS addressing */
466 u16 cylinders; /* Number of cylinders */
467 u16 heads; /* Number of heads */
468 u16 sectors; /* Number of sectors per track */
0c247c55
TH		 469
470 /* error history */
471 struct ata_ering ering;
7d47e8d4 472 int spdn_cnt;
1da177e4
LT		 473};
474
72fa4b74
TH		 475/* Offset into struct ata_device. Fields above it are maintained
476 * acress device init. Fields below are zeroed.
477 */
478#define ATA_DEVICE_CLEAR_OFFSET offsetof(struct ata_device, n_sectors)
479
f3e81b19
TH		 480struct ata_eh_info {
481 struct ata_device *dev; /* offending device */
482 u32 serror; /* SError from LLDD */
483 unsigned int err_mask; /* port-wide err_mask */
484 unsigned int action; /* ATA_EH_* action mask */
47005f25 485 unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */
f3e81b19 486 unsigned int flags; /* ATA_EHI_* flags */
abdda733 487
abdda733
TH		 488 unsigned int probe_mask;
489
f3e81b19
TH		 490 char desc[ATA_EH_DESC_LEN];
491 int desc_len;
492};
493
494struct ata_eh_context {
495 struct ata_eh_info i;
496 int tries[ATA_MAX_DEVICES];
abdda733
TH		 497 unsigned int classes[ATA_MAX_DEVICES];
498 unsigned int did_probe_mask;
f3e81b19
TH		 499};
500
64578a3d
TH		 501struct ata_acpi_drive
502{
503 u32 pio;
504 u32 dma;
505} __packed;
506
507struct ata_acpi_gtm {
508 struct ata_acpi_drive drive[2];
509 u32 flags;
510} __packed;
511
1da177e4 512struct ata_port {
cca3974e 513 struct Scsi_Host *scsi_host; /* our co-allocated scsi host */
057ace5e 514 const struct ata_port_operations *ops;
ba6a1308 515 spinlock_t *lock;
1da177e4 516 unsigned long flags; /* ATA_FLAG_xxx */
b51e9e5d 517 unsigned int pflags; /* ATA_PFLAG_xxx */
44877b4e
TH		 518 unsigned int print_id; /* user visible unique port ID */
519 unsigned int port_no; /* 0 based port no. inside the host */
1da177e4
LT		 520
521 struct ata_prd *prd; /* our SG list */
522 dma_addr_t prd_dma; /* and its DMA mapping */
523
cedc9a47
JG		 524 void *pad; /* array of DMA pad buffers */
525 dma_addr_t pad_dma;
526
1da177e4
LT		 527 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
528
529 u8 ctl; /* cache of ATA control register */
530 u8 last_ctl; /* Cache last written value */
1da177e4
LT		 531 unsigned int pio_mask;
532 unsigned int mwdma_mask;
533 unsigned int udma_mask;
534 unsigned int cbl; /* cable type; ATA_CBL_xxx */
5a04bf4b 535 unsigned int hw_sata_spd_limit;
1c3fae4d 536 unsigned int sata_spd_limit; /* SATA PHY speed limit */
008a7896 537 unsigned int sata_spd; /* current SATA PHY speed */
1da177e4 538
cca3974e 539 /* record runtime error info, protected by host lock */
f3e81b19
TH		 540 struct ata_eh_info eh_info;
541 /* EH context owned by EH */
542 struct ata_eh_context eh_context;
543
1da177e4
LT		 544 struct ata_device device[ATA_MAX_DEVICES];
545
546 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
6cec4a39 547 unsigned long qc_allocated;
dedaf2b0
TH		 548 unsigned int qc_active;
549
1da177e4 550 unsigned int active_tag;
dedaf2b0 551 u32 sactive;
1da177e4 552
cca3974e
JG		 553 struct ata_port_stats stats;
554 struct ata_host *host;
2f1f610b 555 struct device *dev;
1da177e4 556
65f27f38 557 void *port_task_data;
52bad64d
DH		 558 struct delayed_work port_task;
559 struct delayed_work hotplug_task;
3b01b8af 560 struct work_struct scsi_rescan_task;
86e45b6b 561
14be71f4 562 unsigned int hsm_task_state;
1da177e4 563
bfd60579 564 u32 msg_enable;
a72ec4ce 565 struct list_head eh_done_q;
c6cf9e99 566 wait_queue_head_t eh_wait_q;
bfd60579 567
500530f6
TH		 568 pm_message_t pm_mesg;
569 int *pm_result;
570
5ddf24c5
TH		 571 struct timer_list fastdrain_timer;
572 unsigned long fastdrain_cnt;
573
1da177e4 574 void *private_data;
fe635c7e 575
fafbae87
TH		 576#ifdef CONFIG_ATA_ACPI
577 acpi_handle acpi_handle;
64578a3d 578 struct ata_acpi_gtm acpi_gtm;
fafbae87 579#endif
fe635c7e 580 u8 sector_buf[ATA_SECT_SIZE]; /* owned by EH */
1da177e4
LT		 581};
582
583struct ata_port_operations {
584 void (*port_disable) (struct ata_port *);
585
cd0d3bbc 586 void (*dev_config) (struct ata_device *);
1da177e4
LT		 587
588 void (*set_piomode) (struct ata_port *, struct ata_device *);
589 void (*set_dmamode) (struct ata_port *, struct ata_device *);
a76b62ca 590 unsigned long (*mode_filter) (struct ata_device *, unsigned long);
1da177e4 591
057ace5e 592 void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
1da177e4
LT		 593 void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
594
057ace5e 595 void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
1da177e4
LT		 596 u8 (*check_status)(struct ata_port *ap);
597 u8 (*check_altstatus)(struct ata_port *ap);
1da177e4
LT		 598 void (*dev_select)(struct ata_port *ap, unsigned int device);
599
c19ba8af 600 void (*phy_reset) (struct ata_port *ap); /* obsolete */
b229a7b0 601 int (*set_mode) (struct ata_port *ap, struct ata_device **r_failed_dev);
c19ba8af 602
be0d18df
AC		 603 int (*cable_detect) (struct ata_port *ap);
604
b229a7b0 605 int (*check_atapi_dma) (struct ata_queued_cmd *qc);
1da177e4
LT		 606
607 void (*bmdma_setup) (struct ata_queued_cmd *qc);
608 void (*bmdma_start) (struct ata_queued_cmd *qc);
609
a6b2c5d4
AC		 610 void (*data_xfer) (struct ata_device *, unsigned char *, unsigned int, int);
611
1da177e4 612 void (*qc_prep) (struct ata_queued_cmd *qc);
9a3d9eb0 613 unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
1da177e4 614
9ec957f2
TH		 615 /* Error handlers. ->error_handler overrides ->eng_timeout and
616 * indicates that new-style EH is in place.
617 */
618 void (*eng_timeout) (struct ata_port *ap); /* obsolete */
619
620 void (*freeze) (struct ata_port *ap);
621 void (*thaw) (struct ata_port *ap);
622 void (*error_handler) (struct ata_port *ap);
623 void (*post_internal_cmd) (struct ata_queued_cmd *qc);
1da177e4 624
7d12e780 625 irq_handler_t irq_handler;
1da177e4 626 void (*irq_clear) (struct ata_port *);
83625006
AI		 627 u8 (*irq_on) (struct ata_port *);
628 u8 (*irq_ack) (struct ata_port *ap, unsigned int chk_drq);
1da177e4 629
da3dbb17
TH		 630 int (*scr_read) (struct ata_port *ap, unsigned int sc_reg, u32 *val);
631 int (*scr_write) (struct ata_port *ap, unsigned int sc_reg, u32 val);
1da177e4 632
500530f6
TH		 633 int (*port_suspend) (struct ata_port *ap, pm_message_t mesg);
634 int (*port_resume) (struct ata_port *ap);
635
1da177e4
LT		 636 int (*port_start) (struct ata_port *ap);
637 void (*port_stop) (struct ata_port *ap);
638
cca3974e 639 void (*host_stop) (struct ata_host *host);
1da177e4 640
b73fc89f 641 void (*bmdma_stop) (struct ata_queued_cmd *qc);
1da177e4
LT		 642 u8 (*bmdma_status) (struct ata_port *ap);
643};
644
645struct ata_port_info {
d0be4a7d 646 struct scsi_host_template *sht;
cca3974e 647 unsigned long flags;
1da177e4
LT		 648 unsigned long pio_mask;
649 unsigned long mwdma_mask;
650 unsigned long udma_mask;
057ace5e 651 const struct ata_port_operations *port_ops;
21b0ad4f 652 irq_handler_t irq_handler;
e99f8b5e 653 void *private_data;
1da177e4
LT		 654};
655
452503f9
AC		 656struct ata_timing {
657 unsigned short mode; /* ATA mode */
658 unsigned short setup; /* t1 */
659 unsigned short act8b; /* t2 for 8-bit I/O */
660 unsigned short rec8b; /* t2i for 8-bit I/O */
661 unsigned short cyc8b; /* t0 for 8-bit I/O */
662 unsigned short active; /* t2 or tD */
663 unsigned short recover; /* t2i or tK */
664 unsigned short cycle; /* t0 */
665 unsigned short udma; /* t2CYCTYP/2 */
666};
667
668#define FIT(v,vmin,vmax) max_t(short,min_t(short,v,vmax),vmin)
1da177e4 669
e9c83914
TH		 670extern const unsigned long sata_deb_timing_normal[];
671extern const unsigned long sata_deb_timing_hotplug[];
672extern const unsigned long sata_deb_timing_long[];
673
dd5b06c4 674extern const struct ata_port_operations ata_dummy_port_ops;
21b0ad4f 675extern const struct ata_port_info ata_dummy_port_info;
dd5b06c4 676
e9c83914
TH		 677static inline const unsigned long *
678sata_ehc_deb_timing(struct ata_eh_context *ehc)
679{
680 if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
681 return sata_deb_timing_hotplug;
682 else
683 return sata_deb_timing_normal;
684}
d7bb4cc7 685
dd5b06c4
TH		 686static inline int ata_port_is_dummy(struct ata_port *ap)
687{
688 return ap->ops == &ata_dummy_port_ops;
689}
690
43727fbc 691extern void sata_print_link_status(struct ata_port *ap);
1da177e4
LT		 692extern void ata_port_probe(struct ata_port *);
693extern void __sata_phy_reset(struct ata_port *ap);
694extern void sata_phy_reset(struct ata_port *ap);
695extern void ata_bus_reset(struct ata_port *ap);
3c567b7d 696extern int sata_set_spd(struct ata_port *ap);
d4b2bab4
TH		 697extern int sata_phy_debounce(struct ata_port *ap, const unsigned long *param,
698 unsigned long deadline);
699extern int sata_phy_resume(struct ata_port *ap, const unsigned long *param,
700 unsigned long deadline);
701extern int ata_std_prereset(struct ata_port *ap, unsigned long deadline);
702extern int ata_std_softreset(struct ata_port *ap, unsigned int *classes,
703 unsigned long deadline);
704extern int sata_port_hardreset(struct ata_port *ap, const unsigned long *timing,
705 unsigned long deadline);
706extern int sata_std_hardreset(struct ata_port *ap, unsigned int *class,
707 unsigned long deadline);
c2bd5804 708extern void ata_std_postreset(struct ata_port *ap, unsigned int *classes);
1da177e4
LT		 709extern void ata_port_disable(struct ata_port *);
710extern void ata_std_ports(struct ata_ioports *ioaddr);
711#ifdef CONFIG_PCI
1626aeb8
TH		 712extern int ata_pci_init_one (struct pci_dev *pdev,
713 const struct ata_port_info * const * ppi);
1da177e4 714extern void ata_pci_remove_one (struct pci_dev *pdev);
6ffa01d8 715#ifdef CONFIG_PM
3c5100c1 716extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
553c4aa6 717extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
3c5100c1 718extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
9b847548 719extern int ata_pci_device_resume(struct pci_dev *pdev);
6ffa01d8 720#endif
17bb34a3 721extern int ata_pci_clear_simplex(struct pci_dev *pdev);
1da177e4 722#endif /* CONFIG_PCI */
f3187195 723extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
f5cda257
TH		 724extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
725 const struct ata_port_info * const * ppi, int n_ports);
ecef7253 726extern int ata_host_start(struct ata_host *host);
f3187195
TH		 727extern int ata_host_register(struct ata_host *host,
728 struct scsi_host_template *sht);
f5cda257
TH		 729extern int ata_host_activate(struct ata_host *host, int irq,
730 irq_handler_t irq_handler, unsigned long irq_flags,
731 struct scsi_host_template *sht);
0529c159 732extern void ata_host_detach(struct ata_host *host);
cca3974e
JG		 733extern void ata_host_init(struct ata_host *, struct device *,
734 unsigned long, const struct ata_port_operations *);
193515d5 735extern int ata_scsi_detect(struct scsi_host_template *sht);
1da177e4
LT		 736extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
737extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
80289167 738extern void ata_sas_port_destroy(struct ata_port *);
cca3974e 739extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
80289167
BK		 740 struct ata_port_info *, struct Scsi_Host *);
741extern int ata_sas_port_init(struct ata_port *);
742extern int ata_sas_port_start(struct ata_port *ap);
743extern void ata_sas_port_stop(struct ata_port *ap);
744extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
745extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
746 struct ata_port *ap);
1da177e4 747extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
34bf2170
TH		 748extern int sata_scr_valid(struct ata_port *ap);
749extern int sata_scr_read(struct ata_port *ap, int reg, u32 *val);
750extern int sata_scr_write(struct ata_port *ap, int reg, u32 val);
751extern int sata_scr_write_flush(struct ata_port *ap, int reg, u32 val);
752extern int ata_port_online(struct ata_port *ap);
753extern int ata_port_offline(struct ata_port *ap);
6ffa01d8 754#ifdef CONFIG_PM
cca3974e
JG		 755extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
756extern void ata_host_resume(struct ata_host *host);
6ffa01d8 757#endif
67846b30 758extern int ata_ratelimit(void);
d1adc1bb
TH		 759extern int ata_busy_sleep(struct ata_port *ap,
760 unsigned long timeout_pat, unsigned long timeout);
d4b2bab4 761extern int ata_wait_ready(struct ata_port *ap, unsigned long deadline);
65f27f38 762extern void ata_port_queue_task(struct ata_port *ap, work_func_t fn,
86e45b6b 763 void *data, unsigned long delay);
c22daff4
TH		 764extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
765 unsigned long interval_msec,
766 unsigned long timeout_msec);
a619f981 767extern unsigned int ata_dev_try_classify(struct ata_port *, unsigned int, u8 *);
67846b30 768
1da177e4
LT		 769/*
770 * Default driver ops implementations
771 */
057ace5e 772extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
1da177e4 773extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
9977126c
TH		 774extern void ata_tf_to_fis(const struct ata_taskfile *tf,
775 u8 pmp, int is_cmd, u8 *fis);
057ace5e 776extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
1da177e4
LT		 777extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
778extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
779extern u8 ata_check_status(struct ata_port *ap);
780extern u8 ata_altstatus(struct ata_port *ap);
057ace5e 781extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
1da177e4 782extern int ata_port_start (struct ata_port *ap);
d92e74d3 783extern int ata_sff_port_start (struct ata_port *ap);
7d12e780 784extern irqreturn_t ata_interrupt (int irq, void *dev_instance);
0d5ff566
TH		 785extern void ata_data_xfer(struct ata_device *adev, unsigned char *buf,
786 unsigned int buflen, int write_data);
787extern void ata_data_xfer_noirq(struct ata_device *adev, unsigned char *buf,
788 unsigned int buflen, int write_data);
d26fc955 789extern void ata_dumb_qc_prep(struct ata_queued_cmd *qc);
1da177e4 790extern void ata_qc_prep(struct ata_queued_cmd *qc);
e46834cd 791extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
9a3d9eb0 792extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
1da177e4
LT		 793extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
794 unsigned int buflen);
795extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
796 unsigned int n_elem);
057ace5e 797extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
10305f0f 798extern void ata_dev_disable(struct ata_device *adev);
6a62a04d
TH		 799extern void ata_id_string(const u16 *id, unsigned char *s,
800 unsigned int ofs, unsigned int len);
801extern void ata_id_c_string(const u16 *id, unsigned char *s,
802 unsigned int ofs, unsigned int len);
10305f0f 803extern void ata_id_to_dma_mode(struct ata_device *dev, u8 unknown);
1da177e4
LT		 804extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
805extern void ata_bmdma_start (struct ata_queued_cmd *qc);
b73fc89f 806extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
1da177e4
LT		 807extern u8 ata_bmdma_status(struct ata_port *ap);
808extern void ata_bmdma_irq_clear(struct ata_port *ap);
6d97dbd7
TH		 809extern void ata_bmdma_freeze(struct ata_port *ap);
810extern void ata_bmdma_thaw(struct ata_port *ap);
f5914a46 811extern void ata_bmdma_drive_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
6d97dbd7
TH		 812 ata_reset_fn_t softreset,
813 ata_reset_fn_t hardreset,
814 ata_postreset_fn_t postreset);
815extern void ata_bmdma_error_handler(struct ata_port *ap);
816extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
9a1004d0
TH		 817extern int ata_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
818 u8 status, int in_wq);
f686bcb8 819extern void ata_qc_complete(struct ata_queued_cmd *qc);
dedaf2b0
TH		 820extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active,
821 void (*finish_qc)(struct ata_queued_cmd *));
3373efd8 822extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
1da177e4
LT		 823 void (*done)(struct scsi_cmnd *));
824extern int ata_std_bios_param(struct scsi_device *sdev,
825 struct block_device *bdev,
826 sector_t capacity, int geom[]);
827extern int ata_scsi_slave_config(struct scsi_device *sdev);
83c47bcb 828extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
a6e6ce8e
TH		 829extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
830 int queue_depth);
3373efd8 831extern struct ata_device *ata_dev_pair(struct ata_device *adev);
04351821 832extern int ata_do_set_mode(struct ata_port *ap, struct ata_device **r_failed_dev);
83625006
AI		 833extern u8 ata_irq_on(struct ata_port *ap);
834extern u8 ata_dummy_irq_on(struct ata_port *ap);
835extern u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq);
836extern u8 ata_dummy_irq_ack(struct ata_port *ap, unsigned int chk_drq);
1da177e4 837
be0d18df
AC		 838extern int ata_cable_40wire(struct ata_port *ap);
839extern int ata_cable_80wire(struct ata_port *ap);
840extern int ata_cable_sata(struct ata_port *ap);
841extern int ata_cable_unknown(struct ata_port *ap);
842
452503f9
AC		 843/*
844 * Timing helpers
845 */
1bc4ccff
AC		 846
847extern unsigned int ata_pio_need_iordy(const struct ata_device *);
452503f9
AC		 848extern int ata_timing_compute(struct ata_device *, unsigned short,
849 struct ata_timing *, int, int);
850extern void ata_timing_merge(const struct ata_timing *,
851 const struct ata_timing *, struct ata_timing *,
852 unsigned int);
853
854enum {
855 ATA_TIMING_SETUP = (1 << 0),
856 ATA_TIMING_ACT8B = (1 << 1),
857 ATA_TIMING_REC8B = (1 << 2),
858 ATA_TIMING_CYC8B = (1 << 3),
859 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
860 ATA_TIMING_CYC8B,
861 ATA_TIMING_ACTIVE = (1 << 4),
862 ATA_TIMING_RECOVER = (1 << 5),
863 ATA_TIMING_CYCLE = (1 << 6),
864 ATA_TIMING_UDMA = (1 << 7),
865 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
866 ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
867 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
868 ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
869};
870
1da177e4
LT		 871
872#ifdef CONFIG_PCI
873struct pci_bits {
874 unsigned int reg; /* PCI config register to read */
875 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
876 unsigned long mask;
877 unsigned long val;
878};
879
d583bc18 880extern int ata_pci_init_sff_host(struct ata_host *host);
1626aeb8 881extern int ata_pci_init_bmdma(struct ata_host *host);
d583bc18
TH		 882extern int ata_pci_prepare_sff_host(struct pci_dev *pdev,
883 const struct ata_port_info * const * ppi,
884 struct ata_host **r_host);
057ace5e 885extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
a76b62ca 886extern unsigned long ata_pci_default_filter(struct ata_device *, unsigned long);
1da177e4
LT		 887#endif /* CONFIG_PCI */
888
ece1d636
TH		 889/*
890 * EH
891 */
ece1d636 892extern void ata_eng_timeout(struct ata_port *ap);
7b70fc03
TH		 893
894extern void ata_port_schedule_eh(struct ata_port *ap);
895extern int ata_port_abort(struct ata_port *ap);
e3180499
TH		 896extern int ata_port_freeze(struct ata_port *ap);
897
898extern void ata_eh_freeze_port(struct ata_port *ap);
899extern void ata_eh_thaw_port(struct ata_port *ap);
7b70fc03 900
ece1d636
TH		 901extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
902extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
903
f5914a46
TH		 904extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
905 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
906 ata_postreset_fn_t postreset);
022bdb07 907
61440db6
TH		 908/*
909 * printk helpers
910 */
911#define ata_port_printk(ap, lv, fmt, args...) \
44877b4e 912 printk(lv"ata%u: "fmt, (ap)->print_id , ##args)
61440db6
TH		 913
914#define ata_dev_printk(dev, lv, fmt, args...) \
44877b4e 915 printk(lv"ata%u.%02u: "fmt, (dev)->ap->print_id, (dev)->devno , ##args)
1da177e4 916
f3e81b19
TH		 917/*
918 * ata_eh_info helpers
919 */
b64bbc39
TH		 920extern void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
921extern void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
922extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
f3e81b19 923
f8f1e1cc 924static inline void ata_ehi_schedule_probe(struct ata_eh_info *ehi)
084fe639 925{
f8f1e1cc 926 ehi->flags |= ATA_EHI_RESUME_LINK;
084fe639
TH		 927 ehi->action |= ATA_EH_SOFTRESET;
928 ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
929}
930
c0b6c037
TH		 931static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
932{
f8f1e1cc
TH		 933 ata_ehi_schedule_probe(ehi);
934 ehi->flags |= ATA_EHI_HOTPLUGGED;
c0b6c037
TH		 935 ehi->err_mask |= AC_ERR_ATA_BUS;
936}
937
61440db6
TH		 938/*
939 * qc helpers
940 */
972c26bd
JG		 941static inline int
942ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
943{
944 if (sg == &qc->pad_sgent)
945 return 1;
946 if (qc->pad_len)
947 return 0;
948 if (((sg - qc->__sg) + 1) == qc->n_elem)
949 return 1;
950 return 0;
951}
952
cc1887f3
TH		 953static inline struct scatterlist *
954ata_qc_first_sg(struct ata_queued_cmd *qc)
955{
956 if (qc->n_elem)
957 return qc->__sg;
958 if (qc->pad_len)
959 return &qc->pad_sgent;
960 return NULL;
961}
962
cedc9a47
JG		 963static inline struct scatterlist *
964ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
965{
966 if (sg == &qc->pad_sgent)
967 return NULL;
968 if (++sg - qc->__sg < qc->n_elem)
969 return sg;
cc1887f3
TH		 970 if (qc->pad_len)
971 return &qc->pad_sgent;
972 return NULL;
cedc9a47
JG		 973}
974
975#define ata_for_each_sg(sg, qc) \
cc1887f3 976 for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
cedc9a47 977
1da177e4
LT		 978static inline unsigned int ata_tag_valid(unsigned int tag)
979{
980 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
981}
982
2ab7db1f
TH		 983static inline unsigned int ata_tag_internal(unsigned int tag)
984{
985 return tag == ATA_MAX_QUEUE - 1;
986}
987
5806db22
TH		 988/*
989 * device helpers
990 */
e1211e3f 991static inline unsigned int ata_class_enabled(unsigned int class)
597afd21
TH		 992{
993 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI;
994}
995
e1211e3f 996static inline unsigned int ata_class_disabled(unsigned int class)
1da177e4 997{
e1211e3f
TH		 998 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP;
999}
1000
002c8054
TH		 1001static inline unsigned int ata_class_absent(unsigned int class)
1002{
1003 return !ata_class_enabled(class) && !ata_class_disabled(class);
1004}
1005
e1211e3f
TH		 1006static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1007{
1008 return ata_class_enabled(dev->class);
1009}
1010
1011static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1012{
1013 return ata_class_disabled(dev->class);
1da177e4
LT		 1014}
1015
002c8054
TH		 1016static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1017{
1018 return ata_class_absent(dev->class);
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
6d1245bf
TH		 1037/**
1038 * ata_ncq_enabled - Test whether NCQ is enabled
1039 * @dev: ATA device to test for
1040 *
1041 * LOCKING:
1042 * spin_lock_irqsave(host lock)
1043 *
1044 * RETURNS:
1045 * 1 if NCQ is enabled for @dev, 0 otherwise.
1046 */
1047static inline int ata_ncq_enabled(struct ata_device *dev)
1048{
1049 return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1050 ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1051}
0baab86b
EF		 1052
1053/**
1054 * ata_pause - Flush writes and pause 400 nanoseconds.
1055 * @ap: Port to wait for.
1056 *
1057 * LOCKING:
1058 * Inherited from caller.
1059 */
1060
1da177e4
LT		 1061static inline void ata_pause(struct ata_port *ap)
1062{
1063 ata_altstatus(ap);
1064 ndelay(400);
1065}
1066
0baab86b
EF		 1067
1068/**
1069 * ata_busy_wait - Wait for a port status register
1070 * @ap: Port to wait for.
0777721c
AC		 1071 * @bits: bits that must be clear
1072 * @max: number of 10uS waits to perform
0baab86b
EF		 1073 *
1074 * Waits up to max*10 microseconds for the selected bits in the port's
1075 * status register to be cleared.
1076 * Returns final value of status register.
1077 *
1078 * LOCKING:
1079 * Inherited from caller.
1080 */
1081
1da177e4
LT		 1082static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
1083 unsigned int max)
1084{
1085 u8 status;
1086
1087 do {
1088 udelay(10);
1089 status = ata_chk_status(ap);
1090 max--;
d1adc1bb 1091 } while (status != 0xff && (status & bits) && (max > 0));
1da177e4
LT		 1092
1093 return status;
1094}
1095
0baab86b
EF		 1096
1097/**
1098 * ata_wait_idle - Wait for a port to be idle.
1099 * @ap: Port to wait for.
1100 *
1101 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
1102 * Returns final value of status register.
1103 *
1104 * LOCKING:
1105 * Inherited from caller.
1106 */
1107
1da177e4
LT		 1108static inline u8 ata_wait_idle(struct ata_port *ap)
1109{
1110 u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1111
55f3952d
TH		 1112 if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
1113 DPRINTK("ATA: abnormal status 0x%X on port 0x%p\n",
1114 status, ap->ioaddr.status_addr);
1da177e4
LT		 1115
1116 return status;
1117}
1118
1119static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1120{
1121 qc->tf.ctl |= ATA_NIEN;
1122}
1123
f69499f4
TH		 1124static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1125 unsigned int tag)
1da177e4
LT		 1126{
1127 if (likely(ata_tag_valid(tag)))
1128 return &ap->qcmd[tag];
1129 return NULL;
1130}
1131
f69499f4
TH		 1132static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1133 unsigned int tag)
1134{
1135 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1136
1137 if (unlikely(!qc) || !ap->ops->error_handler)
1138 return qc;
1139
1140 if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1141 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1142 return qc;
1143
1144 return NULL;
1145}
1146
3373efd8 1147static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1da177e4
LT		 1148{
1149 memset(tf, 0, sizeof(*tf));
1150
3373efd8
TH		 1151 tf->ctl = dev->ap->ctl;
1152 if (dev->devno == 0)
1da177e4
LT		 1153 tf->device = ATA_DEVICE_OBS;
1154 else
1155 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1156}
1157
2c13b7ce
JG		 1158static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1159{
501e0c50 1160 qc->dma_dir = DMA_NONE;
2c13b7ce
JG		 1161 qc->__sg = NULL;
1162 qc->flags = 0;
726f0785 1163 qc->cursg = qc->cursg_ofs = 0;
2c13b7ce 1164 qc->nbytes = qc->curbytes = 0;
7a801184 1165 qc->n_elem = 0;
a22e2eb0 1166 qc->err_mask = 0;
d0f29485 1167 qc->pad_len = 0;
5a5dbd18 1168 qc->sect_size = ATA_SECT_SIZE;
2c13b7ce 1169
3373efd8 1170 ata_tf_init(qc->dev, &qc->tf);
e61e0672
TH		 1171
1172 /* init result_tf such that it indicates normal completion */
1173 qc->result_tf.command = ATA_DRDY;
1174 qc->result_tf.feature = 0;
2c13b7ce
JG		 1175}
1176
057ace5e 1177static inline int ata_try_flush_cache(const struct ata_device *dev)
1da177e4
LT		 1178{
1179 return ata_id_wcache_enabled(dev->id) ||
1180 ata_id_has_flush(dev->id) ||
1181 ata_id_has_flush_ext(dev->id);
1182}
1183
a7dac447
JG		 1184static inline unsigned int ac_err_mask(u8 status)
1185{
3655d1d3 1186 if (status & (ATA_BUSY | ATA_DRQ))
11a56d24 1187 return AC_ERR_HSM;
a7dac447
JG		 1188 if (status & (ATA_ERR | ATA_DF))
1189 return AC_ERR_DEV;
1190 return 0;
1191}
1192
1193static inline unsigned int __ac_err_mask(u8 status)
1194{
1195 unsigned int mask = ac_err_mask(status);
1196 if (mask == 0)
1197 return AC_ERR_OTHER;
1198 return mask;
1199}
1200
6037d6bb
JG		 1201static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
1202{
1203 ap->pad_dma = 0;
f0d36efd
TH		 1204 ap->pad = dmam_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
1205 &ap->pad_dma, GFP_KERNEL);
6037d6bb
JG		 1206 return (ap->pad == NULL) ? -ENOMEM : 0;
1207}
1208
1209static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
1210{
f0d36efd 1211 dmam_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
6037d6bb
JG		 1212}
1213
35bb94b1
JG		 1214static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1215{
4911487a 1216 return *(struct ata_port **)&host->hostdata[0];
35bb94b1
JG		 1217}
1218
1da177e4 1219#endif /* __LINUX_LIBATA_H__ */
Ubuntu Jammy Linux kernel mirror