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