]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - include/linux/libata.h
projects / mirror_ubuntu-bionic-kernel.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
libata: Limit max sector to 128 for TORiSAN DVD drives (take 3)
[mirror_ubuntu-bionic-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 */
1da177e4
LT		 315};
316
14be71f4 317enum hsm_task_states {
c56b14d2 318 HSM_ST_IDLE, /* no command on going */
71527647
AL		 319 HSM_ST_FIRST, /* (waiting the device to)
320 write CDB or first data block */
c56b14d2
AL		 321 HSM_ST, /* (waiting the device to) transfer data */
322 HSM_ST_LAST, /* (waiting the device to) complete command */
c56b14d2 323 HSM_ST_ERR, /* error */
1da177e4
LT		 324};
325
a7dac447 326enum ata_completion_errors {
11a56d24
TH		 327 AC_ERR_DEV = (1 << 0), /* device reported error */
328 AC_ERR_HSM = (1 << 1), /* host state machine violation */
329 AC_ERR_TIMEOUT = (1 << 2), /* timeout */
330 AC_ERR_MEDIA = (1 << 3), /* media error */
331 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
332 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
333 AC_ERR_SYSTEM = (1 << 6), /* system error */
334 AC_ERR_INVALID = (1 << 7), /* invalid argument */
335 AC_ERR_OTHER = (1 << 8), /* unknown */
55a8e2c8 336 AC_ERR_NODEV_HINT = (1 << 9), /* polling device detection hint */
a7dac447
JG		 337};
338
1da177e4
LT		 339/* forward declarations */
340struct scsi_device;
341struct ata_port_operations;
342struct ata_port;
343struct ata_queued_cmd;
344
345/* typedefs */
77853bf2 346typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
f5914a46
TH		 347typedef int (*ata_prereset_fn_t)(struct ata_port *ap);
348typedef int (*ata_reset_fn_t)(struct ata_port *ap, unsigned int *classes);
349typedef void (*ata_postreset_fn_t)(struct ata_port *ap, unsigned int *classes);
1da177e4
LT		 350
351struct ata_ioports {
0d5ff566
TH		 352 void __iomem *cmd_addr;
353 void __iomem *data_addr;
354 void __iomem *error_addr;
355 void __iomem *feature_addr;
356 void __iomem *nsect_addr;
357 void __iomem *lbal_addr;
358 void __iomem *lbam_addr;
359 void __iomem *lbah_addr;
360 void __iomem *device_addr;
361 void __iomem *status_addr;
362 void __iomem *command_addr;
363 void __iomem *altstatus_addr;
364 void __iomem *ctl_addr;
365 void __iomem *bmdma_addr;
366 void __iomem *scr_addr;
1da177e4
LT		 367};
368
369struct ata_probe_ent {
370 struct list_head node;
371 struct device *dev;
057ace5e 372 const struct ata_port_operations *port_ops;
193515d5 373 struct scsi_host_template *sht;
1da177e4
LT		 374 struct ata_ioports port[ATA_MAX_PORTS];
375 unsigned int n_ports;
dd5b06c4 376 unsigned int dummy_port_mask;
1da177e4
LT		 377 unsigned int pio_mask;
378 unsigned int mwdma_mask;
379 unsigned int udma_mask;
1da177e4 380 unsigned long irq;
2ec7df04 381 unsigned long irq2;
1da177e4 382 unsigned int irq_flags;
cca3974e
JG		 383 unsigned long port_flags;
384 unsigned long _host_flags;
0d5ff566 385 void __iomem * const *iomap;
1da177e4 386 void *private_data;
fea63e38
TH		 387
388 /* port_info for the secondary port. Together with irq2, it's
389 * used to implement non-uniform secondary port. Currently,
390 * the only user is ata_piix combined mode. This workaround
391 * will be removed together with ata_probe_ent when init model
392 * is updated.
393 */
394 const struct ata_port_info *pinfo2;
1da177e4
LT		 395};
396
cca3974e 397struct ata_host {
1da177e4
LT		 398 spinlock_t lock;
399 struct device *dev;
400 unsigned long irq;
2ec7df04 401 unsigned long irq2;
0d5ff566 402 void __iomem * const *iomap;
1da177e4
LT		 403 unsigned int n_ports;
404 void *private_data;
057ace5e 405 const struct ata_port_operations *ops;
5444a6f4 406 unsigned long flags;
032af1ce 407 struct ata_port *simplex_claimed; /* channel owning the DMA */
f0eb62b8 408 struct ata_port *ports[0];
1da177e4
LT		 409};
410
411struct ata_queued_cmd {
412 struct ata_port *ap;
413 struct ata_device *dev;
414
415 struct scsi_cmnd *scsicmd;
416 void (*scsidone)(struct scsi_cmnd *);
417
418 struct ata_taskfile tf;
419 u8 cdb[ATAPI_CDB_LEN];
420
421 unsigned long flags; /* ATA_QCFLAG_xxx */
422 unsigned int tag;
423 unsigned int n_elem;
cedc9a47 424 unsigned int orig_n_elem;
1da177e4
LT		 425
426 int dma_dir;
427
cedc9a47
JG		 428 unsigned int pad_len;
429
1da177e4
LT		 430 unsigned int nbytes;
431 unsigned int curbytes;
432
433 unsigned int cursg;
434 unsigned int cursg_ofs;
435
436 struct scatterlist sgent;
cedc9a47 437 struct scatterlist pad_sgent;
1da177e4
LT		 438 void *buf_virt;
439
cedc9a47
JG		 440 /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
441 struct scatterlist *__sg;
1da177e4 442
a22e2eb0 443 unsigned int err_mask;
e61e0672 444 struct ata_taskfile result_tf;
1da177e4
LT		 445 ata_qc_cb_t complete_fn;
446
1da177e4
LT		 447 void *private_data;
448};
449
cca3974e 450struct ata_port_stats {
1da177e4
LT		 451 unsigned long unhandled_irq;
452 unsigned long idle_irq;
453 unsigned long rw_reqbuf;
454};
455
0c247c55
TH		 456struct ata_ering_entry {
457 int is_io;
458 unsigned int err_mask;
459 u64 timestamp;
460};
461
462struct ata_ering {
463 int cursor;
464 struct ata_ering_entry ring[ATA_ERING_SIZE];
465};
466
1da177e4 467struct ata_device {
38d87234 468 struct ata_port *ap;
72fa4b74 469 unsigned int devno; /* 0 or 1 */
1da177e4 470 unsigned long flags; /* ATA_DFLAG_xxx */
3edebac4 471 struct scsi_device *sdev; /* attached SCSI device */
72fa4b74
TH		 472 /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */
473 u64 n_sectors; /* size of device, if ATA */
1da177e4 474 unsigned int class; /* ATA_DEV_xxx */
fe635c7e 475 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
1da177e4
LT		 476 u8 pio_mode;
477 u8 dma_mode;
478 u8 xfer_mode;
479 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
480
8cbd6df1
AL		 481 unsigned int multi_count; /* sectors count for
482 READ/WRITE MULTIPLE */
b00eec1d 483 unsigned int max_sectors; /* per-device max sectors */
6e7846e9 484 unsigned int cdb_len;
8bf62ece 485
acf356b1
TH		 486 /* per-dev xfer mask */
487 unsigned int pio_mask;
488 unsigned int mwdma_mask;
489 unsigned int udma_mask;
490
8bf62ece
AL		 491 /* for CHS addressing */
492 u16 cylinders; /* Number of cylinders */
493 u16 heads; /* Number of heads */
494 u16 sectors; /* Number of sectors per track */
0c247c55
TH		 495
496 /* error history */
497 struct ata_ering ering;
7d47e8d4 498 int spdn_cnt;
93590859 499 unsigned int horkage; /* List of broken features */
11ef697b
KCA		 500#ifdef CONFIG_SATA_ACPI
501 /* ACPI objects info */
502 acpi_handle obj_handle;
503#endif
1da177e4
LT		 504};
505
72fa4b74
TH		 506/* Offset into struct ata_device. Fields above it are maintained
507 * acress device init. Fields below are zeroed.
508 */
509#define ATA_DEVICE_CLEAR_OFFSET offsetof(struct ata_device, n_sectors)
510
f3e81b19
TH		 511struct ata_eh_info {
512 struct ata_device *dev; /* offending device */
513 u32 serror; /* SError from LLDD */
514 unsigned int err_mask; /* port-wide err_mask */
515 unsigned int action; /* ATA_EH_* action mask */
47005f25 516 unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */
f3e81b19 517 unsigned int flags; /* ATA_EHI_* flags */
abdda733
TH		 518
519 unsigned long hotplug_timestamp;
520 unsigned int probe_mask;
521
f3e81b19
TH		 522 char desc[ATA_EH_DESC_LEN];
523 int desc_len;
524};
525
526struct ata_eh_context {
527 struct ata_eh_info i;
528 int tries[ATA_MAX_DEVICES];
abdda733
TH		 529 unsigned int classes[ATA_MAX_DEVICES];
530 unsigned int did_probe_mask;
f3e81b19
TH		 531};
532
1da177e4 533struct ata_port {
cca3974e 534 struct Scsi_Host *scsi_host; /* our co-allocated scsi host */
057ace5e 535 const struct ata_port_operations *ops;
ba6a1308 536 spinlock_t *lock;
1da177e4 537 unsigned long flags; /* ATA_FLAG_xxx */
b51e9e5d 538 unsigned int pflags; /* ATA_PFLAG_xxx */
44877b4e
TH		 539 unsigned int print_id; /* user visible unique port ID */
540 unsigned int port_no; /* 0 based port no. inside the host */
1da177e4
LT		 541
542 struct ata_prd *prd; /* our SG list */
543 dma_addr_t prd_dma; /* and its DMA mapping */
544
cedc9a47
JG		 545 void *pad; /* array of DMA pad buffers */
546 dma_addr_t pad_dma;
547
1da177e4
LT		 548 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
549
550 u8 ctl; /* cache of ATA control register */
551 u8 last_ctl; /* Cache last written value */
1da177e4
LT		 552 unsigned int pio_mask;
553 unsigned int mwdma_mask;
554 unsigned int udma_mask;
555 unsigned int cbl; /* cable type; ATA_CBL_xxx */
5a04bf4b 556 unsigned int hw_sata_spd_limit;
1c3fae4d 557 unsigned int sata_spd_limit; /* SATA PHY speed limit */
1da177e4 558
cca3974e 559 /* record runtime error info, protected by host lock */
f3e81b19
TH		 560 struct ata_eh_info eh_info;
561 /* EH context owned by EH */
562 struct ata_eh_context eh_context;
563
1da177e4
LT		 564 struct ata_device device[ATA_MAX_DEVICES];
565
566 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
6cec4a39 567 unsigned long qc_allocated;
dedaf2b0
TH		 568 unsigned int qc_active;
569
1da177e4 570 unsigned int active_tag;
dedaf2b0 571 u32 sactive;
1da177e4 572
cca3974e
JG		 573 struct ata_port_stats stats;
574 struct ata_host *host;
2f1f610b 575 struct device *dev;
1da177e4 576
65f27f38 577 void *port_task_data;
52bad64d
DH		 578 struct delayed_work port_task;
579 struct delayed_work hotplug_task;
3b01b8af 580 struct work_struct scsi_rescan_task;
86e45b6b 581
14be71f4 582 unsigned int hsm_task_state;
1da177e4 583
bfd60579 584 u32 msg_enable;
a72ec4ce 585 struct list_head eh_done_q;
c6cf9e99 586 wait_queue_head_t eh_wait_q;
bfd60579 587
500530f6
TH		 588 pm_message_t pm_mesg;
589 int *pm_result;
590
1da177e4 591 void *private_data;
fe635c7e
TH		 592
593 u8 sector_buf[ATA_SECT_SIZE]; /* owned by EH */
1da177e4
LT		 594};
595
596struct ata_port_operations {
597 void (*port_disable) (struct ata_port *);
598
599 void (*dev_config) (struct ata_port *, struct ata_device *);
600
601 void (*set_piomode) (struct ata_port *, struct ata_device *);
602 void (*set_dmamode) (struct ata_port *, struct ata_device *);
5444a6f4 603 unsigned long (*mode_filter) (const struct ata_port *, struct ata_device *, unsigned long);
1da177e4 604
057ace5e 605 void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
1da177e4
LT		 606 void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
607
057ace5e 608 void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
1da177e4
LT		 609 u8 (*check_status)(struct ata_port *ap);
610 u8 (*check_altstatus)(struct ata_port *ap);
1da177e4
LT		 611 void (*dev_select)(struct ata_port *ap, unsigned int device);
612
c19ba8af 613 void (*phy_reset) (struct ata_port *ap); /* obsolete */
b229a7b0 614 int (*set_mode) (struct ata_port *ap, struct ata_device **r_failed_dev);
c19ba8af 615
1da177e4
LT		 616 void (*post_set_mode) (struct ata_port *ap);
617
b229a7b0 618 int (*check_atapi_dma) (struct ata_queued_cmd *qc);
1da177e4
LT		 619
620 void (*bmdma_setup) (struct ata_queued_cmd *qc);
621 void (*bmdma_start) (struct ata_queued_cmd *qc);
622
a6b2c5d4
AC		 623 void (*data_xfer) (struct ata_device *, unsigned char *, unsigned int, int);
624
1da177e4 625 void (*qc_prep) (struct ata_queued_cmd *qc);
9a3d9eb0 626 unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
1da177e4 627
9ec957f2
TH		 628 /* Error handlers. ->error_handler overrides ->eng_timeout and
629 * indicates that new-style EH is in place.
630 */
631 void (*eng_timeout) (struct ata_port *ap); /* obsolete */
632
633 void (*freeze) (struct ata_port *ap);
634 void (*thaw) (struct ata_port *ap);
635 void (*error_handler) (struct ata_port *ap);
636 void (*post_internal_cmd) (struct ata_queued_cmd *qc);
1da177e4 637
7d12e780 638 irq_handler_t irq_handler;
1da177e4 639 void (*irq_clear) (struct ata_port *);
83625006
AI		 640 u8 (*irq_on) (struct ata_port *);
641 u8 (*irq_ack) (struct ata_port *ap, unsigned int chk_drq);
1da177e4
LT		 642
643 u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg);
644 void (*scr_write) (struct ata_port *ap, unsigned int sc_reg,
645 u32 val);
646
500530f6
TH		 647 int (*port_suspend) (struct ata_port *ap, pm_message_t mesg);
648 int (*port_resume) (struct ata_port *ap);
649
1da177e4
LT		 650 int (*port_start) (struct ata_port *ap);
651 void (*port_stop) (struct ata_port *ap);
652
cca3974e 653 void (*host_stop) (struct ata_host *host);
1da177e4 654
b73fc89f 655 void (*bmdma_stop) (struct ata_queued_cmd *qc);
1da177e4
LT		 656 u8 (*bmdma_status) (struct ata_port *ap);
657};
658
659struct ata_port_info {
d0be4a7d 660 struct scsi_host_template *sht;
cca3974e 661 unsigned long flags;
1da177e4
LT		 662 unsigned long pio_mask;
663 unsigned long mwdma_mask;
664 unsigned long udma_mask;
057ace5e 665 const struct ata_port_operations *port_ops;
e99f8b5e 666 void *private_data;
1da177e4
LT		 667};
668
452503f9
AC		 669struct ata_timing {
670 unsigned short mode; /* ATA mode */
671 unsigned short setup; /* t1 */
672 unsigned short act8b; /* t2 for 8-bit I/O */
673 unsigned short rec8b; /* t2i for 8-bit I/O */
674 unsigned short cyc8b; /* t0 for 8-bit I/O */
675 unsigned short active; /* t2 or tD */
676 unsigned short recover; /* t2i or tK */
677 unsigned short cycle; /* t0 */
678 unsigned short udma; /* t2CYCTYP/2 */
679};
680
681#define FIT(v,vmin,vmax) max_t(short,min_t(short,v,vmax),vmin)
1da177e4 682
e9c83914
TH		 683extern const unsigned long sata_deb_timing_normal[];
684extern const unsigned long sata_deb_timing_hotplug[];
685extern const unsigned long sata_deb_timing_long[];
686
dd5b06c4
TH		 687extern const struct ata_port_operations ata_dummy_port_ops;
688
e9c83914
TH		 689static inline const unsigned long *
690sata_ehc_deb_timing(struct ata_eh_context *ehc)
691{
692 if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
693 return sata_deb_timing_hotplug;
694 else
695 return sata_deb_timing_normal;
696}
d7bb4cc7 697
dd5b06c4
TH		 698static inline int ata_port_is_dummy(struct ata_port *ap)
699{
700 return ap->ops == &ata_dummy_port_ops;
701}
702
1da177e4
LT		 703extern void ata_port_probe(struct ata_port *);
704extern void __sata_phy_reset(struct ata_port *ap);
705extern void sata_phy_reset(struct ata_port *ap);
706extern void ata_bus_reset(struct ata_port *ap);
3c567b7d 707extern int sata_set_spd(struct ata_port *ap);
d7bb4cc7
TH		 708extern int sata_phy_debounce(struct ata_port *ap, const unsigned long *param);
709extern int sata_phy_resume(struct ata_port *ap, const unsigned long *param);
f5914a46 710extern int ata_std_prereset(struct ata_port *ap);
2bf2cb26 711extern int ata_std_softreset(struct ata_port *ap, unsigned int *classes);
b6103f6d
TH		 712extern int sata_port_hardreset(struct ata_port *ap,
713 const unsigned long *timing);
2bf2cb26 714extern int sata_std_hardreset(struct ata_port *ap, unsigned int *class);
c2bd5804 715extern void ata_std_postreset(struct ata_port *ap, unsigned int *classes);
1da177e4
LT		 716extern void ata_port_disable(struct ata_port *);
717extern void ata_std_ports(struct ata_ioports *ioaddr);
718#ifdef CONFIG_PCI
719extern int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info,
720 unsigned int n_ports);
721extern void ata_pci_remove_one (struct pci_dev *pdev);
6ffa01d8 722#ifdef CONFIG_PM
3c5100c1 723extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
553c4aa6 724extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
3c5100c1 725extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
9b847548 726extern int ata_pci_device_resume(struct pci_dev *pdev);
6ffa01d8 727#endif
17bb34a3 728extern int ata_pci_clear_simplex(struct pci_dev *pdev);
1da177e4 729#endif /* CONFIG_PCI */
057ace5e 730extern int ata_device_add(const struct ata_probe_ent *ent);
0529c159 731extern void ata_host_detach(struct ata_host *host);
cca3974e
JG		 732extern void ata_host_init(struct ata_host *, struct device *,
733 unsigned long, const struct ata_port_operations *);
193515d5 734extern int ata_scsi_detect(struct scsi_host_template *sht);
1da177e4
LT		 735extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
736extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
80289167 737extern void ata_sas_port_destroy(struct ata_port *);
cca3974e 738extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
80289167
BK		 739 struct ata_port_info *, struct Scsi_Host *);
740extern int ata_sas_port_init(struct ata_port *);
741extern int ata_sas_port_start(struct ata_port *ap);
742extern void ata_sas_port_stop(struct ata_port *ap);
743extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
744extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
745 struct ata_port *ap);
1da177e4 746extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
34bf2170
TH		 747extern int sata_scr_valid(struct ata_port *ap);
748extern int sata_scr_read(struct ata_port *ap, int reg, u32 *val);
749extern int sata_scr_write(struct ata_port *ap, int reg, u32 val);
750extern int sata_scr_write_flush(struct ata_port *ap, int reg, u32 val);
751extern int ata_port_online(struct ata_port *ap);
752extern int ata_port_offline(struct ata_port *ap);
6ffa01d8 753#ifdef CONFIG_PM
9b847548 754extern int ata_scsi_device_resume(struct scsi_device *);
3c5100c1 755extern int ata_scsi_device_suspend(struct scsi_device *, pm_message_t mesg);
cca3974e
JG		 756extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
757extern void ata_host_resume(struct ata_host *host);
6ffa01d8 758#endif
67846b30 759extern int ata_ratelimit(void);
d1adc1bb
TH		 760extern int ata_busy_sleep(struct ata_port *ap,
761 unsigned long timeout_pat, unsigned long timeout);
65f27f38 762extern void ata_port_queue_task(struct ata_port *ap, work_func_t fn,
86e45b6b 763 void *data, unsigned long delay);
c22daff4
TH		 764extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
765 unsigned long interval_msec,
766 unsigned long timeout_msec);
a619f981 767extern unsigned int ata_dev_try_classify(struct ata_port *, unsigned int, u8 *);
67846b30 768
1da177e4
LT		 769/*
770 * Default driver ops implementations
771 */
057ace5e 772extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
1da177e4 773extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
057ace5e
JG		 774extern void ata_tf_to_fis(const struct ata_taskfile *tf, u8 *fis, u8 pmp);
775extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
1da177e4
LT		 776extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
777extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
778extern u8 ata_check_status(struct ata_port *ap);
779extern u8 ata_altstatus(struct ata_port *ap);
057ace5e 780extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
1da177e4 781extern int ata_port_start (struct ata_port *ap);
7d12e780 782extern irqreturn_t ata_interrupt (int irq, void *dev_instance);
0d5ff566
TH		 783extern void ata_data_xfer(struct ata_device *adev, unsigned char *buf,
784 unsigned int buflen, int write_data);
785extern void ata_data_xfer_noirq(struct ata_device *adev, unsigned char *buf,
786 unsigned int buflen, int write_data);
1da177e4 787extern void ata_qc_prep(struct ata_queued_cmd *qc);
e46834cd 788extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
9a3d9eb0 789extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
1da177e4
LT		 790extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
791 unsigned int buflen);
792extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
793 unsigned int n_elem);
057ace5e 794extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
10305f0f 795extern void ata_dev_disable(struct ata_device *adev);
6a62a04d
TH		 796extern void ata_id_string(const u16 *id, unsigned char *s,
797 unsigned int ofs, unsigned int len);
798extern void ata_id_c_string(const u16 *id, unsigned char *s,
799 unsigned int ofs, unsigned int len);
10305f0f 800extern void ata_id_to_dma_mode(struct ata_device *dev, u8 unknown);
6919a0a6 801extern unsigned long ata_device_blacklisted(const struct ata_device *dev);
1da177e4
LT		 802extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
803extern void ata_bmdma_start (struct ata_queued_cmd *qc);
b73fc89f 804extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
1da177e4
LT		 805extern u8 ata_bmdma_status(struct ata_port *ap);
806extern void ata_bmdma_irq_clear(struct ata_port *ap);
6d97dbd7
TH		 807extern void ata_bmdma_freeze(struct ata_port *ap);
808extern void ata_bmdma_thaw(struct ata_port *ap);
f5914a46 809extern void ata_bmdma_drive_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
6d97dbd7
TH		 810 ata_reset_fn_t softreset,
811 ata_reset_fn_t hardreset,
812 ata_postreset_fn_t postreset);
813extern void ata_bmdma_error_handler(struct ata_port *ap);
814extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
9a1004d0
TH		 815extern int ata_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
816 u8 status, int in_wq);
f686bcb8 817extern void ata_qc_complete(struct ata_queued_cmd *qc);
dedaf2b0
TH		 818extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active,
819 void (*finish_qc)(struct ata_queued_cmd *));
3373efd8 820extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
1da177e4
LT		 821 void (*done)(struct scsi_cmnd *));
822extern int ata_std_bios_param(struct scsi_device *sdev,
823 struct block_device *bdev,
824 sector_t capacity, int geom[]);
825extern int ata_scsi_slave_config(struct scsi_device *sdev);
83c47bcb 826extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
a6e6ce8e
TH		 827extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
828 int queue_depth);
3373efd8 829extern struct ata_device *ata_dev_pair(struct ata_device *adev);
83625006
AI		 830extern u8 ata_irq_on(struct ata_port *ap);
831extern u8 ata_dummy_irq_on(struct ata_port *ap);
832extern u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq);
833extern u8 ata_dummy_irq_ack(struct ata_port *ap, unsigned int chk_drq);
1da177e4 834
452503f9
AC		 835/*
836 * Timing helpers
837 */
1bc4ccff
AC		 838
839extern unsigned int ata_pio_need_iordy(const struct ata_device *);
452503f9
AC		 840extern int ata_timing_compute(struct ata_device *, unsigned short,
841 struct ata_timing *, int, int);
842extern void ata_timing_merge(const struct ata_timing *,
843 const struct ata_timing *, struct ata_timing *,
844 unsigned int);
845
846enum {
847 ATA_TIMING_SETUP = (1 << 0),
848 ATA_TIMING_ACT8B = (1 << 1),
849 ATA_TIMING_REC8B = (1 << 2),
850 ATA_TIMING_CYC8B = (1 << 3),
851 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
852 ATA_TIMING_CYC8B,
853 ATA_TIMING_ACTIVE = (1 << 4),
854 ATA_TIMING_RECOVER = (1 << 5),
855 ATA_TIMING_CYCLE = (1 << 6),
856 ATA_TIMING_UDMA = (1 << 7),
857 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
858 ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
859 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
860 ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
861};
862
1da177e4
LT		 863
864#ifdef CONFIG_PCI
865struct pci_bits {
866 unsigned int reg; /* PCI config register to read */
867 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
868 unsigned long mask;
869 unsigned long val;
870};
871
872extern struct ata_probe_ent *
47a86593 873ata_pci_init_native_mode(struct pci_dev *pdev, struct ata_port_info **port, int portmask);
057ace5e 874extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
17bb34a3 875extern unsigned long ata_pci_default_filter(const struct ata_port *, struct ata_device *, unsigned long);
1da177e4
LT		 876#endif /* CONFIG_PCI */
877
ece1d636
TH		 878/*
879 * EH
880 */
ece1d636 881extern void ata_eng_timeout(struct ata_port *ap);
7b70fc03
TH		 882
883extern void ata_port_schedule_eh(struct ata_port *ap);
884extern int ata_port_abort(struct ata_port *ap);
e3180499
TH		 885extern int ata_port_freeze(struct ata_port *ap);
886
887extern void ata_eh_freeze_port(struct ata_port *ap);
888extern void ata_eh_thaw_port(struct ata_port *ap);
7b70fc03 889
ece1d636
TH		 890extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
891extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
892
f5914a46
TH		 893extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
894 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
895 ata_postreset_fn_t postreset);
022bdb07 896
61440db6
TH		 897/*
898 * printk helpers
899 */
900#define ata_port_printk(ap, lv, fmt, args...) \
44877b4e 901 printk(lv"ata%u: "fmt, (ap)->print_id , ##args)
61440db6
TH		 902
903#define ata_dev_printk(dev, lv, fmt, args...) \
44877b4e 904 printk(lv"ata%u.%02u: "fmt, (dev)->ap->print_id, (dev)->devno , ##args)
1da177e4 905
f3e81b19
TH		 906/*
907 * ata_eh_info helpers
908 */
909#define ata_ehi_push_desc(ehi, fmt, args...) do { \
910 (ehi)->desc_len += scnprintf((ehi)->desc + (ehi)->desc_len, \
911 ATA_EH_DESC_LEN - (ehi)->desc_len, \
912 fmt , ##args); \
913} while (0)
914
915#define ata_ehi_clear_desc(ehi) do { \
916 (ehi)->desc[0] = '\0'; \
917 (ehi)->desc_len = 0; \
918} while (0)
919
c0b6c037 920static inline void __ata_ehi_hotplugged(struct ata_eh_info *ehi)
084fe639
TH		 921{
922 if (ehi->flags & ATA_EHI_HOTPLUGGED)
923 return;
924
28324304 925 ehi->flags |= ATA_EHI_HOTPLUGGED | ATA_EHI_RESUME_LINK;
084fe639
TH		 926 ehi->hotplug_timestamp = jiffies;
927
084fe639
TH		 928 ehi->action |= ATA_EH_SOFTRESET;
929 ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
930}
931
c0b6c037
TH		 932static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
933{
934 __ata_ehi_hotplugged(ehi);
935 ehi->err_mask |= AC_ERR_ATA_BUS;
936}
937
61440db6
TH		 938/*
939 * qc helpers
940 */
972c26bd
JG		 941static inline int
942ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
943{
944 if (sg == &qc->pad_sgent)
945 return 1;
946 if (qc->pad_len)
947 return 0;
948 if (((sg - qc->__sg) + 1) == qc->n_elem)
949 return 1;
950 return 0;
951}
952
cc1887f3
TH		 953static inline struct scatterlist *
954ata_qc_first_sg(struct ata_queued_cmd *qc)
955{
956 if (qc->n_elem)
957 return qc->__sg;
958 if (qc->pad_len)
959 return &qc->pad_sgent;
960 return NULL;
961}
962
cedc9a47
JG		 963static inline struct scatterlist *
964ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
965{
966 if (sg == &qc->pad_sgent)
967 return NULL;
968 if (++sg - qc->__sg < qc->n_elem)
969 return sg;
cc1887f3
TH		 970 if (qc->pad_len)
971 return &qc->pad_sgent;
972 return NULL;
cedc9a47
JG		 973}
974
975#define ata_for_each_sg(sg, qc) \
cc1887f3 976 for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
cedc9a47 977
1da177e4
LT		 978static inline unsigned int ata_tag_valid(unsigned int tag)
979{
980 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
981}
982
2ab7db1f
TH		 983static inline unsigned int ata_tag_internal(unsigned int tag)
984{
985 return tag == ATA_MAX_QUEUE - 1;
986}
987
5806db22
TH		 988/*
989 * device helpers
990 */
e1211e3f 991static inline unsigned int ata_class_enabled(unsigned int class)
597afd21
TH		 992{
993 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI;
994}
995
e1211e3f 996static inline unsigned int ata_class_disabled(unsigned int class)
1da177e4 997{
e1211e3f
TH		 998 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP;
999}
1000
002c8054
TH		 1001static inline unsigned int ata_class_absent(unsigned int class)
1002{
1003 return !ata_class_enabled(class) && !ata_class_disabled(class);
1004}
1005
e1211e3f
TH		 1006static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1007{
1008 return ata_class_enabled(dev->class);
1009}
1010
1011static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1012{
1013 return ata_class_disabled(dev->class);
1da177e4
LT		 1014}
1015
002c8054
TH		 1016static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1017{
1018 return ata_class_absent(dev->class);
1019}
1020
02670bf3
TH		 1021static inline unsigned int ata_dev_ready(const struct ata_device *dev)
1022{
1023 return ata_dev_enabled(dev) && !(dev->flags & ATA_DFLAG_SUSPENDED);
1024}
1025
5806db22
TH		 1026/*
1027 * port helpers
1028 */
1029static inline int ata_port_max_devices(const struct ata_port *ap)
1030{
1031 if (ap->flags & ATA_FLAG_SLAVE_POSS)
1032 return 2;
1033 return 1;
1034}
1035
1036
1da177e4
LT		 1037static inline u8 ata_chk_status(struct ata_port *ap)
1038{
1039 return ap->ops->check_status(ap);
1040}
1041
6d1245bf
TH		 1042/**
1043 * ata_ncq_enabled - Test whether NCQ is enabled
1044 * @dev: ATA device to test for
1045 *
1046 * LOCKING:
1047 * spin_lock_irqsave(host lock)
1048 *
1049 * RETURNS:
1050 * 1 if NCQ is enabled for @dev, 0 otherwise.
1051 */
1052static inline int ata_ncq_enabled(struct ata_device *dev)
1053{
1054 return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1055 ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1056}
0baab86b
EF		 1057
1058/**
1059 * ata_pause - Flush writes and pause 400 nanoseconds.
1060 * @ap: Port to wait for.
1061 *
1062 * LOCKING:
1063 * Inherited from caller.
1064 */
1065
1da177e4
LT		 1066static inline void ata_pause(struct ata_port *ap)
1067{
1068 ata_altstatus(ap);
1069 ndelay(400);
1070}
1071
0baab86b
EF		 1072
1073/**
1074 * ata_busy_wait - Wait for a port status register
1075 * @ap: Port to wait for.
0777721c
AC		 1076 * @bits: bits that must be clear
1077 * @max: number of 10uS waits to perform
0baab86b
EF		 1078 *
1079 * Waits up to max*10 microseconds for the selected bits in the port's
1080 * status register to be cleared.
1081 * Returns final value of status register.
1082 *
1083 * LOCKING:
1084 * Inherited from caller.
1085 */
1086
1da177e4
LT		 1087static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
1088 unsigned int max)
1089{
1090 u8 status;
1091
1092 do {
1093 udelay(10);
1094 status = ata_chk_status(ap);
1095 max--;
d1adc1bb 1096 } while (status != 0xff && (status & bits) && (max > 0));
1da177e4
LT		 1097
1098 return status;
1099}
1100
0baab86b
EF		 1101
1102/**
1103 * ata_wait_idle - Wait for a port to be idle.
1104 * @ap: Port to wait for.
1105 *
1106 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
1107 * Returns final value of status register.
1108 *
1109 * LOCKING:
1110 * Inherited from caller.
1111 */
1112
1da177e4
LT		 1113static inline u8 ata_wait_idle(struct ata_port *ap)
1114{
1115 u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1116
d1adc1bb 1117 if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ))) {
bfd60579 1118 if (ata_msg_warn(ap))
0d5ff566
TH		 1119 printk(KERN_WARNING "ATA: abnormal status 0x%X on port 0x%p\n",
1120 status, ap->ioaddr.status_addr);
1da177e4
LT		 1121 }
1122
1123 return status;
1124}
1125
1126static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1127{
1128 qc->tf.ctl |= ATA_NIEN;
1129}
1130
f69499f4
TH		 1131static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1132 unsigned int tag)
1da177e4
LT		 1133{
1134 if (likely(ata_tag_valid(tag)))
1135 return &ap->qcmd[tag];
1136 return NULL;
1137}
1138
f69499f4
TH		 1139static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1140 unsigned int tag)
1141{
1142 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1143
1144 if (unlikely(!qc) || !ap->ops->error_handler)
1145 return qc;
1146
1147 if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1148 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1149 return qc;
1150
1151 return NULL;
1152}
1153
3373efd8 1154static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1da177e4
LT		 1155{
1156 memset(tf, 0, sizeof(*tf));
1157
3373efd8
TH		 1158 tf->ctl = dev->ap->ctl;
1159 if (dev->devno == 0)
1da177e4
LT		 1160 tf->device = ATA_DEVICE_OBS;
1161 else
1162 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1163}
1164
2c13b7ce
JG		 1165static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1166{
501e0c50 1167 qc->dma_dir = DMA_NONE;
2c13b7ce
JG		 1168 qc->__sg = NULL;
1169 qc->flags = 0;
726f0785 1170 qc->cursg = qc->cursg_ofs = 0;
2c13b7ce 1171 qc->nbytes = qc->curbytes = 0;
7a801184 1172 qc->n_elem = 0;
a22e2eb0 1173 qc->err_mask = 0;
d0f29485 1174 qc->pad_len = 0;
2c13b7ce 1175
3373efd8 1176 ata_tf_init(qc->dev, &qc->tf);
e61e0672
TH		 1177
1178 /* init result_tf such that it indicates normal completion */
1179 qc->result_tf.command = ATA_DRDY;
1180 qc->result_tf.feature = 0;
2c13b7ce
JG		 1181}
1182
057ace5e 1183static inline int ata_try_flush_cache(const struct ata_device *dev)
1da177e4
LT		 1184{
1185 return ata_id_wcache_enabled(dev->id) ||
1186 ata_id_has_flush(dev->id) ||
1187 ata_id_has_flush_ext(dev->id);
1188}
1189
a7dac447
JG		 1190static inline unsigned int ac_err_mask(u8 status)
1191{
3655d1d3 1192 if (status & (ATA_BUSY | ATA_DRQ))
11a56d24 1193 return AC_ERR_HSM;
a7dac447
JG		 1194 if (status & (ATA_ERR | ATA_DF))
1195 return AC_ERR_DEV;
1196 return 0;
1197}
1198
1199static inline unsigned int __ac_err_mask(u8 status)
1200{
1201 unsigned int mask = ac_err_mask(status);
1202 if (mask == 0)
1203 return AC_ERR_OTHER;
1204 return mask;
1205}
1206
6037d6bb
JG		 1207static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
1208{
1209 ap->pad_dma = 0;
f0d36efd
TH		 1210 ap->pad = dmam_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
1211 &ap->pad_dma, GFP_KERNEL);
6037d6bb
JG		 1212 return (ap->pad == NULL) ? -ENOMEM : 0;
1213}
1214
1215static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
1216{
f0d36efd 1217 dmam_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
6037d6bb
JG		 1218}
1219
35bb94b1
JG		 1220static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1221{
1222 return (struct ata_port *) &host->hostdata[0];
1223}
1224
1da177e4 1225#endif /* __LINUX_LIBATA_H__ */
ubuntu-bionic-kernel mirror