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