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