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