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