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