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