libata.h revision 90088bb41200b4da962282dfd45db82544adac3b
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 <asm/io.h>
35#include <linux/ata.h>
36#include <linux/workqueue.h>
37#include <scsi/scsi_host.h>
38
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
44#include <asm/libata-portmap.h>
45#else
46#include <asm-generic/libata-portmap.h>
47#endif
48
49/*
50 * compile-time options: to be removed as soon as all the drivers are
51 * converted to the new debugging mechanism
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 */
57#define ATA_ENABLE_PATA		/* define to enable PATA support in some
58				 * low-level drivers */
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
74#define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
75
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
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? */
112#define PCI_VDEVICE(vendor, device)		\
113	PCI_VENDOR_ID_##vendor, (device),	\
114	PCI_ANY_ID, PCI_ANY_ID, 0, 0
115
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,
126	/* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
127	ATA_MAX_QUEUE		= 32,
128	ATA_TAG_INTERNAL	= ATA_MAX_QUEUE - 1,
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,
136	ATA_SHT_USE_CLUSTERING	= 1,
137
138	/* struct ata_device stuff */
139	ATA_DFLAG_LBA		= (1 << 0), /* device supports LBA */
140	ATA_DFLAG_LBA48		= (1 << 1), /* device supports LBA48 */
141	ATA_DFLAG_CDB_INTR	= (1 << 2), /* device asserts INTRQ when ready for CDB */
142	ATA_DFLAG_NCQ		= (1 << 3), /* device supports NCQ */
143	ATA_DFLAG_CFG_MASK	= (1 << 8) - 1,
144
145	ATA_DFLAG_PIO		= (1 << 8), /* device limited to PIO mode */
146	ATA_DFLAG_NCQ_OFF	= (1 << 9), /* device limited to non-NCQ mode */
147	ATA_DFLAG_SUSPENDED	= (1 << 10), /* device suspended */
148	ATA_DFLAG_INIT_MASK	= (1 << 16) - 1,
149
150	ATA_DFLAG_DETACH	= (1 << 16),
151	ATA_DFLAG_DETACHED	= (1 << 17),
152
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 */
161	ATA_FLAG_SLAVE_POSS	= (1 << 0), /* host supports slave dev */
162					    /* (doesn't imply presence) */
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 */
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 */
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 */
177	ATA_FLAG_DEBUGMSG	= (1 << 13),
178
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 */
186
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 */
195
196	ATA_PFLAG_FLUSH_PORT_TASK = (1 << 16), /* flush port task */
197	ATA_PFLAG_SUSPENDED	= (1 << 17), /* port is suspended (power) */
198	ATA_PFLAG_PM_PENDING	= (1 << 18), /* PM operation pending */
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 */
204	ATA_QCFLAG_DMAMAP	= ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE,
205	ATA_QCFLAG_IO		= (1 << 3), /* standard IO command */
206	ATA_QCFLAG_RESULT_TF	= (1 << 4), /* result TF requested */
207
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) */
211
212	/* host set flags */
213	ATA_HOST_SIMPLEX	= (1 << 0),	/* Host is simplex, one DMA channel per host only */
214
215	/* various lengths of time */
216	ATA_TMOUT_BOOT		= 30 * HZ,	/* heuristic */
217	ATA_TMOUT_BOOT_QUICK	= 7 * HZ,	/* heuristic */
218	ATA_TMOUT_INTERNAL	= 30 * HZ,
219	ATA_TMOUT_INTERNAL_QUICK = 5 * HZ,
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
239	 * unsigned int bitmap
240	 */
241	ATA_BITS_PIO		= 7,
242	ATA_BITS_MWDMA		= 5,
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,
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,
256
257	/* masks for port functions */
258	ATA_PORT_PRIMARY	= (1 << 0),
259	ATA_PORT_SECONDARY	= (1 << 1),
260
261	/* ering size */
262	ATA_ERING_SIZE		= 32,
263
264	/* desc_len for ata_eh_info and context */
265	ATA_EH_DESC_LEN		= 80,
266
267	/* reset / recovery action types */
268	ATA_EH_REVALIDATE	= (1 << 0),
269	ATA_EH_SOFTRESET	= (1 << 1),
270	ATA_EH_HARDRESET	= (1 << 2),
271	ATA_EH_SUSPEND		= (1 << 3),
272	ATA_EH_RESUME		= (1 << 4),
273	ATA_EH_PM_FREEZE	= (1 << 5),
274
275	ATA_EH_RESET_MASK	= ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
276	ATA_EH_PERDEV_MASK	= ATA_EH_REVALIDATE | ATA_EH_SUSPEND |
277				  ATA_EH_RESUME | ATA_EH_PM_FREEZE,
278
279	/* ata_eh_info->flags */
280	ATA_EHI_HOTPLUGGED	= (1 << 0),  /* could have been hotplugged */
281	ATA_EHI_RESUME_LINK	= (1 << 1),  /* resume link (reset modifier) */
282	ATA_EHI_NO_AUTOPSY	= (1 << 2),  /* no autopsy */
283	ATA_EHI_QUIET		= (1 << 3),  /* be quiet */
284
285	ATA_EHI_DID_RESET	= (1 << 16), /* already reset this port */
286
287	ATA_EHI_RESET_MODIFIER_MASK = ATA_EHI_RESUME_LINK,
288
289	/* max repeat if error condition is still set after ->error_handler */
290	ATA_EH_MAX_REPEAT	= 5,
291
292	/* how hard are we gonna try to probe/recover devices */
293	ATA_PROBE_MAX_TRIES	= 3,
294	ATA_EH_RESET_TRIES	= 3,
295	ATA_EH_DEV_TRIES	= 3,
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,
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 */
310	ATA_HORKAGE_NODMA	= (1 << 1),	/* DMA problems */
311	ATA_HORKAGE_NONCQ	= (1 << 2),	/* Don't use NCQ */
312};
313
314enum hsm_task_states {
315	HSM_ST_UNKNOWN,		/* state unknown */
316	HSM_ST_IDLE,		/* no command on going */
317	HSM_ST,			/* (waiting the device to) transfer data */
318	HSM_ST_LAST,		/* (waiting the device to) complete command */
319	HSM_ST_ERR,		/* error */
320	HSM_ST_FIRST,		/* (waiting the device to)
321				   write CDB or first data block */
322};
323
324enum ata_completion_errors {
325	AC_ERR_DEV		= (1 << 0), /* device reported error */
326	AC_ERR_HSM		= (1 << 1), /* host state machine violation */
327	AC_ERR_TIMEOUT		= (1 << 2), /* timeout */
328	AC_ERR_MEDIA		= (1 << 3), /* media error */
329	AC_ERR_ATA_BUS		= (1 << 4), /* ATA bus error */
330	AC_ERR_HOST_BUS		= (1 << 5), /* host bus error */
331	AC_ERR_SYSTEM		= (1 << 6), /* system error */
332	AC_ERR_INVALID		= (1 << 7), /* invalid argument */
333	AC_ERR_OTHER		= (1 << 8), /* unknown */
334};
335
336/* forward declarations */
337struct scsi_device;
338struct ata_port_operations;
339struct ata_port;
340struct ata_queued_cmd;
341
342/* typedefs */
343typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
344typedef int (*ata_prereset_fn_t)(struct ata_port *ap);
345typedef int (*ata_reset_fn_t)(struct ata_port *ap, unsigned int *classes);
346typedef void (*ata_postreset_fn_t)(struct ata_port *ap, unsigned int *classes);
347
348struct ata_ioports {
349	unsigned long		cmd_addr;
350	unsigned long		data_addr;
351	unsigned long		error_addr;
352	unsigned long		feature_addr;
353	unsigned long		nsect_addr;
354	unsigned long		lbal_addr;
355	unsigned long		lbam_addr;
356	unsigned long		lbah_addr;
357	unsigned long		device_addr;
358	unsigned long		status_addr;
359	unsigned long		command_addr;
360	unsigned long		altstatus_addr;
361	unsigned long		ctl_addr;
362	unsigned long		bmdma_addr;
363	unsigned long		scr_addr;
364};
365
366struct ata_probe_ent {
367	struct list_head	node;
368	struct device 		*dev;
369	const struct ata_port_operations *port_ops;
370	struct scsi_host_template *sht;
371	struct ata_ioports	port[ATA_MAX_PORTS];
372	unsigned int		n_ports;
373	unsigned int		dummy_port_mask;
374	unsigned int		pio_mask;
375	unsigned int		mwdma_mask;
376	unsigned int		udma_mask;
377	unsigned long		irq;
378	unsigned long		irq2;
379	unsigned int		irq_flags;
380	unsigned long		port_flags;
381	unsigned long		_host_flags;
382	void __iomem		*mmio_base;
383	void			*private_data;
384
385	/* port_info for the secondary port.  Together with irq2, it's
386	 * used to implement non-uniform secondary port.  Currently,
387	 * the only user is ata_piix combined mode.  This workaround
388	 * will be removed together with ata_probe_ent when init model
389	 * is updated.
390	 */
391	const struct ata_port_info *pinfo2;
392};
393
394struct ata_host {
395	spinlock_t		lock;
396	struct device 		*dev;
397	unsigned long		irq;
398	unsigned long		irq2;
399	void __iomem		*mmio_base;
400	unsigned int		n_ports;
401	void			*private_data;
402	const struct ata_port_operations *ops;
403	unsigned long		flags;
404	int			simplex_claimed;	/* Keep seperate in case we
405							   ever need to do this locked */
406	struct ata_port		*ports[0];
407};
408
409struct ata_queued_cmd {
410	struct ata_port		*ap;
411	struct ata_device	*dev;
412
413	struct scsi_cmnd	*scsicmd;
414	void			(*scsidone)(struct scsi_cmnd *);
415
416	struct ata_taskfile	tf;
417	u8			cdb[ATAPI_CDB_LEN];
418
419	unsigned long		flags;		/* ATA_QCFLAG_xxx */
420	unsigned int		tag;
421	unsigned int		n_elem;
422	unsigned int		orig_n_elem;
423
424	int			dma_dir;
425
426	unsigned int		pad_len;
427
428	unsigned int		nsect;
429	unsigned int		cursect;
430
431	unsigned int		nbytes;
432	unsigned int		curbytes;
433
434	unsigned int		cursg;
435	unsigned int		cursg_ofs;
436
437	struct scatterlist	sgent;
438	struct scatterlist	pad_sgent;
439	void			*buf_virt;
440
441	/* DO NOT iterate over __sg manually, use ata_for_each_sg() */
442	struct scatterlist	*__sg;
443
444	unsigned int		err_mask;
445	struct ata_taskfile	result_tf;
446	ata_qc_cb_t		complete_fn;
447
448	void			*private_data;
449};
450
451struct ata_port_stats {
452	unsigned long		unhandled_irq;
453	unsigned long		idle_irq;
454	unsigned long		rw_reqbuf;
455};
456
457struct ata_ering_entry {
458	int			is_io;
459	unsigned int		err_mask;
460	u64			timestamp;
461};
462
463struct ata_ering {
464	int			cursor;
465	struct ata_ering_entry	ring[ATA_ERING_SIZE];
466};
467
468struct ata_device {
469	struct ata_port		*ap;
470	unsigned int		devno;		/* 0 or 1 */
471	unsigned long		flags;		/* ATA_DFLAG_xxx */
472	struct scsi_device	*sdev;		/* attached SCSI device */
473	/* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */
474	u64			n_sectors;	/* size of device, if ATA */
475	unsigned int		class;		/* ATA_DEV_xxx */
476	u16			id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
477	u8			pio_mode;
478	u8			dma_mode;
479	u8			xfer_mode;
480	unsigned int		xfer_shift;	/* ATA_SHIFT_xxx */
481
482	unsigned int		multi_count;	/* sectors count for
483						   READ/WRITE MULTIPLE */
484	unsigned int		max_sectors;	/* per-device max sectors */
485	unsigned int		cdb_len;
486
487	/* per-dev xfer mask */
488	unsigned int		pio_mask;
489	unsigned int		mwdma_mask;
490	unsigned int		udma_mask;
491
492	/* for CHS addressing */
493	u16			cylinders;	/* Number of cylinders */
494	u16			heads;		/* Number of heads */
495	u16			sectors;	/* Number of sectors per track */
496
497	/* error history */
498	struct ata_ering	ering;
499	unsigned int		horkage;	/* List of broken features */
500};
501
502/* Offset into struct ata_device.  Fields above it are maintained
503 * acress device init.  Fields below are zeroed.
504 */
505#define ATA_DEVICE_CLEAR_OFFSET		offsetof(struct ata_device, n_sectors)
506
507struct ata_eh_info {
508	struct ata_device	*dev;		/* offending device */
509	u32			serror;		/* SError from LLDD */
510	unsigned int		err_mask;	/* port-wide err_mask */
511	unsigned int		action;		/* ATA_EH_* action mask */
512	unsigned int		dev_action[ATA_MAX_DEVICES]; /* dev EH action */
513	unsigned int		flags;		/* ATA_EHI_* flags */
514
515	unsigned long		hotplug_timestamp;
516	unsigned int		probe_mask;
517
518	char			desc[ATA_EH_DESC_LEN];
519	int			desc_len;
520};
521
522struct ata_eh_context {
523	struct ata_eh_info	i;
524	int			tries[ATA_MAX_DEVICES];
525	unsigned int		classes[ATA_MAX_DEVICES];
526	unsigned int		did_probe_mask;
527};
528
529struct ata_port {
530	struct Scsi_Host	*scsi_host; /* our co-allocated scsi host */
531	const struct ata_port_operations *ops;
532	spinlock_t		*lock;
533	unsigned long		flags;	/* ATA_FLAG_xxx */
534	unsigned int		pflags; /* ATA_PFLAG_xxx */
535	unsigned int		id;	/* unique id req'd by scsi midlyr */
536	unsigned int		port_no; /* unique port #; from zero */
537
538	struct ata_prd		*prd;	 /* our SG list */
539	dma_addr_t		prd_dma; /* and its DMA mapping */
540
541	void			*pad;	/* array of DMA pad buffers */
542	dma_addr_t		pad_dma;
543
544	struct ata_ioports	ioaddr;	/* ATA cmd/ctl/dma register blocks */
545
546	u8			ctl;	/* cache of ATA control register */
547	u8			last_ctl;	/* Cache last written value */
548	unsigned int		pio_mask;
549	unsigned int		mwdma_mask;
550	unsigned int		udma_mask;
551	unsigned int		cbl;	/* cable type; ATA_CBL_xxx */
552	unsigned int		hw_sata_spd_limit;
553	unsigned int		sata_spd_limit;	/* SATA PHY speed limit */
554
555	/* record runtime error info, protected by host lock */
556	struct ata_eh_info	eh_info;
557	/* EH context owned by EH */
558	struct ata_eh_context	eh_context;
559
560	struct ata_device	device[ATA_MAX_DEVICES];
561
562	struct ata_queued_cmd	qcmd[ATA_MAX_QUEUE];
563	unsigned long		qc_allocated;
564	unsigned int		qc_active;
565
566	unsigned int		active_tag;
567	u32			sactive;
568
569	struct ata_port_stats	stats;
570	struct ata_host		*host;
571	struct device 		*dev;
572
573	struct work_struct	port_task;
574	struct work_struct	hotplug_task;
575	struct work_struct	scsi_rescan_task;
576
577	unsigned int		hsm_task_state;
578
579	u32			msg_enable;
580	struct list_head	eh_done_q;
581	wait_queue_head_t	eh_wait_q;
582
583	pm_message_t		pm_mesg;
584	int			*pm_result;
585
586	void			*private_data;
587
588	u8			sector_buf[ATA_SECT_SIZE]; /* owned by EH */
589};
590
591struct ata_port_operations {
592	void (*port_disable) (struct ata_port *);
593
594	void (*dev_config) (struct ata_port *, struct ata_device *);
595
596	void (*set_piomode) (struct ata_port *, struct ata_device *);
597	void (*set_dmamode) (struct ata_port *, struct ata_device *);
598	unsigned long (*mode_filter) (const struct ata_port *, struct ata_device *, unsigned long);
599
600	void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
601	void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
602
603	void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
604	u8   (*check_status)(struct ata_port *ap);
605	u8   (*check_altstatus)(struct ata_port *ap);
606	void (*dev_select)(struct ata_port *ap, unsigned int device);
607
608	void (*phy_reset) (struct ata_port *ap); /* obsolete */
609	void (*set_mode) (struct ata_port *ap);
610
611	void (*post_set_mode) (struct ata_port *ap);
612
613	int (*check_atapi_dma) (struct ata_queued_cmd *qc);
614
615	void (*bmdma_setup) (struct ata_queued_cmd *qc);
616	void (*bmdma_start) (struct ata_queued_cmd *qc);
617
618	void (*data_xfer) (struct ata_device *, unsigned char *, unsigned int, int);
619
620	void (*qc_prep) (struct ata_queued_cmd *qc);
621	unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
622
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);
632
633	irq_handler_t irq_handler;
634	void (*irq_clear) (struct ata_port *);
635
636	u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg);
637	void (*scr_write) (struct ata_port *ap, unsigned int sc_reg,
638			   u32 val);
639
640	int (*port_suspend) (struct ata_port *ap, pm_message_t mesg);
641	int (*port_resume) (struct ata_port *ap);
642
643	int (*port_start) (struct ata_port *ap);
644	void (*port_stop) (struct ata_port *ap);
645
646	void (*host_stop) (struct ata_host *host);
647
648	void (*bmdma_stop) (struct ata_queued_cmd *qc);
649	u8   (*bmdma_status) (struct ata_port *ap);
650};
651
652struct ata_port_info {
653	struct scsi_host_template	*sht;
654	unsigned long		flags;
655	unsigned long		pio_mask;
656	unsigned long		mwdma_mask;
657	unsigned long		udma_mask;
658	const struct ata_port_operations *port_ops;
659	void 			*private_data;
660};
661
662struct ata_timing {
663	unsigned short mode;		/* ATA mode */
664	unsigned short setup;		/* t1 */
665	unsigned short act8b;		/* t2 for 8-bit I/O */
666	unsigned short rec8b;		/* t2i for 8-bit I/O */
667	unsigned short cyc8b;		/* t0 for 8-bit I/O */
668	unsigned short active;		/* t2 or tD */
669	unsigned short recover;		/* t2i or tK */
670	unsigned short cycle;		/* t0 */
671	unsigned short udma;		/* t2CYCTYP/2 */
672};
673
674#define FIT(v,vmin,vmax)	max_t(short,min_t(short,v,vmax),vmin)
675
676extern const unsigned long sata_deb_timing_normal[];
677extern const unsigned long sata_deb_timing_hotplug[];
678extern const unsigned long sata_deb_timing_long[];
679
680extern const struct ata_port_operations ata_dummy_port_ops;
681
682static inline const unsigned long *
683sata_ehc_deb_timing(struct ata_eh_context *ehc)
684{
685	if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
686		return sata_deb_timing_hotplug;
687	else
688		return sata_deb_timing_normal;
689}
690
691static inline int ata_port_is_dummy(struct ata_port *ap)
692{
693	return ap->ops == &ata_dummy_port_ops;
694}
695
696extern void ata_port_probe(struct ata_port *);
697extern void __sata_phy_reset(struct ata_port *ap);
698extern void sata_phy_reset(struct ata_port *ap);
699extern void ata_bus_reset(struct ata_port *ap);
700extern int sata_set_spd(struct ata_port *ap);
701extern int sata_phy_debounce(struct ata_port *ap, const unsigned long *param);
702extern int sata_phy_resume(struct ata_port *ap, const unsigned long *param);
703extern int ata_std_prereset(struct ata_port *ap);
704extern int ata_std_softreset(struct ata_port *ap, unsigned int *classes);
705extern int sata_std_hardreset(struct ata_port *ap, unsigned int *class);
706extern void ata_std_postreset(struct ata_port *ap, unsigned int *classes);
707extern void ata_port_disable(struct ata_port *);
708extern void ata_std_ports(struct ata_ioports *ioaddr);
709#ifdef CONFIG_PCI
710extern int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info,
711			     unsigned int n_ports);
712extern void ata_pci_remove_one (struct pci_dev *pdev);
713extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
714extern void ata_pci_device_do_resume(struct pci_dev *pdev);
715extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
716extern int ata_pci_device_resume(struct pci_dev *pdev);
717extern int ata_pci_clear_simplex(struct pci_dev *pdev);
718#endif /* CONFIG_PCI */
719extern int ata_device_add(const struct ata_probe_ent *ent);
720extern void ata_port_detach(struct ata_port *ap);
721extern void ata_host_init(struct ata_host *, struct device *,
722			  unsigned long, const struct ata_port_operations *);
723extern void ata_host_remove(struct ata_host *host);
724extern int ata_scsi_detect(struct scsi_host_template *sht);
725extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
726extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
727extern int ata_scsi_release(struct Scsi_Host *host);
728extern void ata_sas_port_destroy(struct ata_port *);
729extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
730					   struct ata_port_info *, struct Scsi_Host *);
731extern int ata_sas_port_init(struct ata_port *);
732extern int ata_sas_port_start(struct ata_port *ap);
733extern void ata_sas_port_stop(struct ata_port *ap);
734extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
735extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
736			    struct ata_port *ap);
737extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
738extern int sata_scr_valid(struct ata_port *ap);
739extern int sata_scr_read(struct ata_port *ap, int reg, u32 *val);
740extern int sata_scr_write(struct ata_port *ap, int reg, u32 val);
741extern int sata_scr_write_flush(struct ata_port *ap, int reg, u32 val);
742extern int ata_port_online(struct ata_port *ap);
743extern int ata_port_offline(struct ata_port *ap);
744extern int ata_scsi_device_resume(struct scsi_device *);
745extern int ata_scsi_device_suspend(struct scsi_device *, pm_message_t mesg);
746extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
747extern void ata_host_resume(struct ata_host *host);
748extern int ata_ratelimit(void);
749extern int ata_busy_sleep(struct ata_port *ap,
750			  unsigned long timeout_pat, unsigned long timeout);
751extern void ata_port_queue_task(struct ata_port *ap, void (*fn)(void *),
752				void *data, unsigned long delay);
753extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
754			     unsigned long interval_msec,
755			     unsigned long timeout_msec);
756
757/*
758 * Default driver ops implementations
759 */
760extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
761extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
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);
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);
768extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
769extern int ata_port_start (struct ata_port *ap);
770extern void ata_port_stop (struct ata_port *ap);
771extern void ata_host_stop (struct ata_host *host);
772extern irqreturn_t ata_interrupt (int irq, void *dev_instance);
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);
777extern void ata_pio_data_xfer_noirq(struct ata_device *adev, unsigned char *buf,
778			      unsigned int buflen, int write_data);
779extern void ata_qc_prep(struct ata_queued_cmd *qc);
780extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
781extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
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);
786extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
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);
791extern unsigned long ata_device_blacklisted(const struct ata_device *dev);
792extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
793extern void ata_bmdma_start (struct ata_queued_cmd *qc);
794extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
795extern u8   ata_bmdma_status(struct ata_port *ap);
796extern void ata_bmdma_irq_clear(struct ata_port *ap);
797extern void ata_bmdma_freeze(struct ata_port *ap);
798extern void ata_bmdma_thaw(struct ata_port *ap);
799extern void ata_bmdma_drive_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
800			       ata_reset_fn_t softreset,
801			       ata_reset_fn_t hardreset,
802			       ata_postreset_fn_t postreset);
803extern void ata_bmdma_error_handler(struct ata_port *ap);
804extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
805extern int ata_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
806			u8 status, int in_wq);
807extern void ata_qc_complete(struct ata_queued_cmd *qc);
808extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active,
809				    void (*finish_qc)(struct ata_queued_cmd *));
810extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
811			      void (*done)(struct scsi_cmnd *));
812extern int ata_std_bios_param(struct scsi_device *sdev,
813			      struct block_device *bdev,
814			      sector_t capacity, int geom[]);
815extern int ata_scsi_slave_config(struct scsi_device *sdev);
816extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
817extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
818				       int queue_depth);
819extern struct ata_device *ata_dev_pair(struct ata_device *adev);
820
821/*
822 * Timing helpers
823 */
824
825extern unsigned int ata_pio_need_iordy(const struct ata_device *);
826extern int ata_timing_compute(struct ata_device *, unsigned short,
827			      struct ata_timing *, int, int);
828extern void ata_timing_merge(const struct ata_timing *,
829			     const struct ata_timing *, struct ata_timing *,
830			     unsigned int);
831
832enum {
833	ATA_TIMING_SETUP	= (1 << 0),
834	ATA_TIMING_ACT8B	= (1 << 1),
835	ATA_TIMING_REC8B	= (1 << 2),
836	ATA_TIMING_CYC8B	= (1 << 3),
837	ATA_TIMING_8BIT		= ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
838				  ATA_TIMING_CYC8B,
839	ATA_TIMING_ACTIVE	= (1 << 4),
840	ATA_TIMING_RECOVER	= (1 << 5),
841	ATA_TIMING_CYCLE	= (1 << 6),
842	ATA_TIMING_UDMA		= (1 << 7),
843	ATA_TIMING_ALL		= ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
844				  ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
845				  ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
846				  ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
847};
848
849
850#ifdef CONFIG_PCI
851struct pci_bits {
852	unsigned int		reg;	/* PCI config register to read */
853	unsigned int		width;	/* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
854	unsigned long		mask;
855	unsigned long		val;
856};
857
858extern void ata_pci_host_stop (struct ata_host *host);
859extern struct ata_probe_ent *
860ata_pci_init_native_mode(struct pci_dev *pdev, struct ata_port_info **port, int portmask);
861extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
862extern unsigned long ata_pci_default_filter(const struct ata_port *, struct ata_device *, unsigned long);
863#endif /* CONFIG_PCI */
864
865/*
866 * EH
867 */
868extern void ata_eng_timeout(struct ata_port *ap);
869
870extern void ata_port_schedule_eh(struct ata_port *ap);
871extern int ata_port_abort(struct ata_port *ap);
872extern int ata_port_freeze(struct ata_port *ap);
873
874extern void ata_eh_freeze_port(struct ata_port *ap);
875extern void ata_eh_thaw_port(struct ata_port *ap);
876
877extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
878extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
879
880extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
881		      ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
882		      ata_postreset_fn_t postreset);
883
884/*
885 * printk helpers
886 */
887#define ata_port_printk(ap, lv, fmt, args...) \
888	printk(lv"ata%u: "fmt, (ap)->id , ##args)
889
890#define ata_dev_printk(dev, lv, fmt, args...) \
891	printk(lv"ata%u.%02u: "fmt, (dev)->ap->id, (dev)->devno , ##args)
892
893/*
894 * ata_eh_info helpers
895 */
896#define ata_ehi_push_desc(ehi, fmt, args...) do { \
897	(ehi)->desc_len += scnprintf((ehi)->desc + (ehi)->desc_len, \
898				     ATA_EH_DESC_LEN - (ehi)->desc_len, \
899				     fmt , ##args); \
900} while (0)
901
902#define ata_ehi_clear_desc(ehi) do { \
903	(ehi)->desc[0] = '\0'; \
904	(ehi)->desc_len = 0; \
905} while (0)
906
907static inline void __ata_ehi_hotplugged(struct ata_eh_info *ehi)
908{
909	if (ehi->flags & ATA_EHI_HOTPLUGGED)
910		return;
911
912	ehi->flags |= ATA_EHI_HOTPLUGGED | ATA_EHI_RESUME_LINK;
913	ehi->hotplug_timestamp = jiffies;
914
915	ehi->action |= ATA_EH_SOFTRESET;
916	ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
917}
918
919static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
920{
921	__ata_ehi_hotplugged(ehi);
922	ehi->err_mask |= AC_ERR_ATA_BUS;
923}
924
925/*
926 * qc helpers
927 */
928static inline int
929ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
930{
931	if (sg == &qc->pad_sgent)
932		return 1;
933	if (qc->pad_len)
934		return 0;
935	if (((sg - qc->__sg) + 1) == qc->n_elem)
936		return 1;
937	return 0;
938}
939
940static inline struct scatterlist *
941ata_qc_first_sg(struct ata_queued_cmd *qc)
942{
943	if (qc->n_elem)
944		return qc->__sg;
945	if (qc->pad_len)
946		return &qc->pad_sgent;
947	return NULL;
948}
949
950static inline struct scatterlist *
951ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
952{
953	if (sg == &qc->pad_sgent)
954		return NULL;
955	if (++sg - qc->__sg < qc->n_elem)
956		return sg;
957	if (qc->pad_len)
958		return &qc->pad_sgent;
959	return NULL;
960}
961
962#define ata_for_each_sg(sg, qc) \
963	for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
964
965static inline unsigned int ata_tag_valid(unsigned int tag)
966{
967	return (tag < ATA_MAX_QUEUE) ? 1 : 0;
968}
969
970static inline unsigned int ata_tag_internal(unsigned int tag)
971{
972	return tag == ATA_MAX_QUEUE - 1;
973}
974
975/*
976 * device helpers
977 */
978static inline unsigned int ata_class_enabled(unsigned int class)
979{
980	return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI;
981}
982
983static inline unsigned int ata_class_disabled(unsigned int class)
984{
985	return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP;
986}
987
988static inline unsigned int ata_class_absent(unsigned int class)
989{
990	return !ata_class_enabled(class) && !ata_class_disabled(class);
991}
992
993static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
994{
995	return ata_class_enabled(dev->class);
996}
997
998static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
999{
1000	return ata_class_disabled(dev->class);
1001}
1002
1003static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1004{
1005	return ata_class_absent(dev->class);
1006}
1007
1008static inline unsigned int ata_dev_ready(const struct ata_device *dev)
1009{
1010	return ata_dev_enabled(dev) && !(dev->flags & ATA_DFLAG_SUSPENDED);
1011}
1012
1013/*
1014 * port helpers
1015 */
1016static inline int ata_port_max_devices(const struct ata_port *ap)
1017{
1018	if (ap->flags & ATA_FLAG_SLAVE_POSS)
1019		return 2;
1020	return 1;
1021}
1022
1023
1024static inline u8 ata_chk_status(struct ata_port *ap)
1025{
1026	return ap->ops->check_status(ap);
1027}
1028
1029
1030/**
1031 *	ata_pause - Flush writes and pause 400 nanoseconds.
1032 *	@ap: Port to wait for.
1033 *
1034 *	LOCKING:
1035 *	Inherited from caller.
1036 */
1037
1038static inline void ata_pause(struct ata_port *ap)
1039{
1040	ata_altstatus(ap);
1041	ndelay(400);
1042}
1043
1044
1045/**
1046 *	ata_busy_wait - Wait for a port status register
1047 *	@ap: Port to wait for.
1048 *
1049 *	Waits up to max*10 microseconds for the selected bits in the port's
1050 *	status register to be cleared.
1051 *	Returns final value of status register.
1052 *
1053 *	LOCKING:
1054 *	Inherited from caller.
1055 */
1056
1057static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
1058			       unsigned int max)
1059{
1060	u8 status;
1061
1062	do {
1063		udelay(10);
1064		status = ata_chk_status(ap);
1065		max--;
1066	} while (status != 0xff && (status & bits) && (max > 0));
1067
1068	return status;
1069}
1070
1071
1072/**
1073 *	ata_wait_idle - Wait for a port to be idle.
1074 *	@ap: Port to wait for.
1075 *
1076 *	Waits up to 10ms for port's BUSY and DRQ signals to clear.
1077 *	Returns final value of status register.
1078 *
1079 *	LOCKING:
1080 *	Inherited from caller.
1081 */
1082
1083static inline u8 ata_wait_idle(struct ata_port *ap)
1084{
1085	u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1086
1087	if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ))) {
1088		unsigned long l = ap->ioaddr.status_addr;
1089		if (ata_msg_warn(ap))
1090			printk(KERN_WARNING "ATA: abnormal status 0x%X on port 0x%lX\n",
1091				status, l);
1092	}
1093
1094	return status;
1095}
1096
1097static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1098{
1099	qc->tf.ctl |= ATA_NIEN;
1100}
1101
1102static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1103						       unsigned int tag)
1104{
1105	if (likely(ata_tag_valid(tag)))
1106		return &ap->qcmd[tag];
1107	return NULL;
1108}
1109
1110static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1111						     unsigned int tag)
1112{
1113	struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1114
1115	if (unlikely(!qc) || !ap->ops->error_handler)
1116		return qc;
1117
1118	if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1119			  ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1120		return qc;
1121
1122	return NULL;
1123}
1124
1125static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1126{
1127	memset(tf, 0, sizeof(*tf));
1128
1129	tf->ctl = dev->ap->ctl;
1130	if (dev->devno == 0)
1131		tf->device = ATA_DEVICE_OBS;
1132	else
1133		tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1134}
1135
1136static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1137{
1138	qc->__sg = NULL;
1139	qc->flags = 0;
1140	qc->cursect = qc->cursg = qc->cursg_ofs = 0;
1141	qc->nsect = 0;
1142	qc->nbytes = qc->curbytes = 0;
1143	qc->err_mask = 0;
1144
1145	ata_tf_init(qc->dev, &qc->tf);
1146
1147	/* init result_tf such that it indicates normal completion */
1148	qc->result_tf.command = ATA_DRDY;
1149	qc->result_tf.feature = 0;
1150}
1151
1152/**
1153 *	ata_irq_ack - Acknowledge a device interrupt.
1154 *	@ap: Port on which interrupts are enabled.
1155 *
1156 *	Wait up to 10 ms for legacy IDE device to become idle (BUSY
1157 *	or BUSY+DRQ clear).  Obtain dma status and port status from
1158 *	device.  Clear the interrupt.  Return port status.
1159 *
1160 *	LOCKING:
1161 */
1162
1163static inline u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq)
1164{
1165	unsigned int bits = chk_drq ? ATA_BUSY | ATA_DRQ : ATA_BUSY;
1166	u8 host_stat, post_stat, status;
1167
1168	status = ata_busy_wait(ap, bits, 1000);
1169	if (status & bits)
1170		if (ata_msg_err(ap))
1171			printk(KERN_ERR "abnormal status 0x%X\n", status);
1172
1173	/* get controller status; clear intr, err bits */
1174	if (ap->flags & ATA_FLAG_MMIO) {
1175		void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr;
1176		host_stat = readb(mmio + ATA_DMA_STATUS);
1177		writeb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
1178		       mmio + ATA_DMA_STATUS);
1179
1180		post_stat = readb(mmio + ATA_DMA_STATUS);
1181	} else {
1182		host_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
1183		outb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
1184		     ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
1185
1186		post_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
1187	}
1188
1189	if (ata_msg_intr(ap))
1190		printk(KERN_INFO "%s: irq ack: host_stat 0x%X, new host_stat 0x%X, drv_stat 0x%X\n",
1191			__FUNCTION__,
1192			host_stat, post_stat, status);
1193
1194	return status;
1195}
1196
1197static inline int ata_try_flush_cache(const struct ata_device *dev)
1198{
1199	return ata_id_wcache_enabled(dev->id) ||
1200	       ata_id_has_flush(dev->id) ||
1201	       ata_id_has_flush_ext(dev->id);
1202}
1203
1204static inline unsigned int ac_err_mask(u8 status)
1205{
1206	if (status & (ATA_BUSY | ATA_DRQ))
1207		return AC_ERR_HSM;
1208	if (status & (ATA_ERR | ATA_DF))
1209		return AC_ERR_DEV;
1210	return 0;
1211}
1212
1213static inline unsigned int __ac_err_mask(u8 status)
1214{
1215	unsigned int mask = ac_err_mask(status);
1216	if (mask == 0)
1217		return AC_ERR_OTHER;
1218	return mask;
1219}
1220
1221static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
1222{
1223	ap->pad_dma = 0;
1224	ap->pad = dma_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
1225				     &ap->pad_dma, GFP_KERNEL);
1226	return (ap->pad == NULL) ? -ENOMEM : 0;
1227}
1228
1229static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
1230{
1231	dma_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
1232}
1233
1234static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1235{
1236	return (struct ata_port *) &host->hostdata[0];
1237}
1238
1239#endif /* __LINUX_LIBATA_H__ */
1240