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