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