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