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