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