libata.h revision 52bad64d95bd89e08c49ec5a071fa6dcbe5a1a9c
1/*
2 *  Copyright 2003-2005 Red Hat, Inc.  All rights reserved.
3 *  Copyright 2003-2005 Jeff Garzik
4 *
5 *
6 *  This program is free software; you can redistribute it and/or modify
7 *  it under the terms of the GNU General Public License as published by
8 *  the Free Software Foundation; either version 2, or (at your option)
9 *  any later version.
10 *
11 *  This program is distributed in the hope that it will be useful,
12 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 *  GNU General Public License for more details.
15 *
16 *  You should have received a copy of the GNU General Public License
17 *  along with this program; see the file COPYING.  If not, write to
18 *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
19 *
20 *
21 *  libata documentation is available via 'make {ps|pdf}docs',
22 *  as Documentation/DocBook/libata.*
23 *
24 */
25
26#ifndef __LINUX_LIBATA_H__
27#define __LINUX_LIBATA_H__
28
29#include <linux/delay.h>
30#include <linux/interrupt.h>
31#include <linux/pci.h>
32#include <linux/dma-mapping.h>
33#include <asm/scatterlist.h>
34#include <asm/io.h>
35#include <linux/ata.h>
36#include <linux/workqueue.h>
37#include <scsi/scsi_host.h>
38
39/*
40 * Define if arch has non-standard setup.  This is a _PCI_ standard
41 * not a legacy or ISA standard.
42 */
43#ifdef CONFIG_ATA_NONSTANDARD
44#include <asm/libata-portmap.h>
45#else
46#include <asm-generic/libata-portmap.h>
47#endif
48
49/*
50 * compile-time options: to be removed as soon as all the drivers are
51 * converted to the new debugging mechanism
52 */
53#undef ATA_DEBUG		/* debugging output */
54#undef ATA_VERBOSE_DEBUG	/* yet more debugging output */
55#undef ATA_IRQ_TRAP		/* define to ack screaming irqs */
56#undef ATA_NDEBUG		/* define to disable quick runtime checks */
57#define ATA_ENABLE_PATA		/* define to enable PATA support in some
58				 * low-level drivers */
59
60
61/* note: prints function name for you */
62#ifdef ATA_DEBUG
63#define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
64#ifdef ATA_VERBOSE_DEBUG
65#define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
66#else
67#define VPRINTK(fmt, args...)
68#endif	/* ATA_VERBOSE_DEBUG */
69#else
70#define DPRINTK(fmt, args...)
71#define VPRINTK(fmt, args...)
72#endif	/* ATA_DEBUG */
73
74#define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
75
76/* NEW: debug levels */
77#define HAVE_LIBATA_MSG 1
78
79enum {
80	ATA_MSG_DRV	= 0x0001,
81	ATA_MSG_INFO	= 0x0002,
82	ATA_MSG_PROBE	= 0x0004,
83	ATA_MSG_WARN	= 0x0008,
84	ATA_MSG_MALLOC	= 0x0010,
85	ATA_MSG_CTL	= 0x0020,
86	ATA_MSG_INTR	= 0x0040,
87	ATA_MSG_ERR	= 0x0080,
88};
89
90#define ata_msg_drv(p)    ((p)->msg_enable & ATA_MSG_DRV)
91#define ata_msg_info(p)   ((p)->msg_enable & ATA_MSG_INFO)
92#define ata_msg_probe(p)  ((p)->msg_enable & ATA_MSG_PROBE)
93#define ata_msg_warn(p)   ((p)->msg_enable & ATA_MSG_WARN)
94#define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC)
95#define ata_msg_ctl(p)    ((p)->msg_enable & ATA_MSG_CTL)
96#define ata_msg_intr(p)   ((p)->msg_enable & ATA_MSG_INTR)
97#define ata_msg_err(p)    ((p)->msg_enable & ATA_MSG_ERR)
98
99static inline u32 ata_msg_init(int dval, int default_msg_enable_bits)
100{
101	if (dval < 0 || dval >= (sizeof(u32) * 8))
102		return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */
103	if (!dval)
104		return 0;
105	return (1 << dval) - 1;
106}
107
108/* defines only for the constants which don't work well as enums */
109#define ATA_TAG_POISON		0xfafbfcfdU
110
111/* move to PCI layer? */
112#define PCI_VDEVICE(vendor, device)		\
113	PCI_VENDOR_ID_##vendor, (device),	\
114	PCI_ANY_ID, PCI_ANY_ID, 0, 0
115
116static inline struct device *pci_dev_to_dev(struct pci_dev *pdev)
117{
118	return &pdev->dev;
119}
120
121enum {
122	/* various global constants */
123	LIBATA_MAX_PRD		= ATA_MAX_PRD / 2,
124	ATA_MAX_PORTS		= 8,
125	ATA_DEF_QUEUE		= 1,
126	/* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
127	ATA_MAX_QUEUE		= 32,
128	ATA_TAG_INTERNAL	= ATA_MAX_QUEUE - 1,
129	ATA_MAX_BUS		= 2,
130	ATA_DEF_BUSY_WAIT	= 10000,
131	ATA_SHORT_PAUSE		= (HZ >> 6) + 1,
132
133	ATA_SHT_EMULATED	= 1,
134	ATA_SHT_CMD_PER_LUN	= 1,
135	ATA_SHT_THIS_ID		= -1,
136	ATA_SHT_USE_CLUSTERING	= 1,
137
138	/* struct ata_device stuff */
139	ATA_DFLAG_LBA		= (1 << 0), /* device supports LBA */
140	ATA_DFLAG_LBA48		= (1 << 1), /* device supports LBA48 */
141	ATA_DFLAG_CDB_INTR	= (1 << 2), /* device asserts INTRQ when ready for CDB */
142	ATA_DFLAG_NCQ		= (1 << 3), /* device supports NCQ */
143	ATA_DFLAG_CFG_MASK	= (1 << 8) - 1,
144
145	ATA_DFLAG_PIO		= (1 << 8), /* device limited to PIO mode */
146	ATA_DFLAG_NCQ_OFF	= (1 << 9), /* device limited to non-NCQ mode */
147	ATA_DFLAG_SUSPENDED	= (1 << 10), /* device suspended */
148	ATA_DFLAG_INIT_MASK	= (1 << 16) - 1,
149
150	ATA_DFLAG_DETACH	= (1 << 16),
151	ATA_DFLAG_DETACHED	= (1 << 17),
152
153	ATA_DEV_UNKNOWN		= 0,	/* unknown device */
154	ATA_DEV_ATA		= 1,	/* ATA device */
155	ATA_DEV_ATA_UNSUP	= 2,	/* ATA device (unsupported) */
156	ATA_DEV_ATAPI		= 3,	/* ATAPI device */
157	ATA_DEV_ATAPI_UNSUP	= 4,	/* ATAPI device (unsupported) */
158	ATA_DEV_NONE		= 5,	/* no device */
159
160	/* struct ata_port flags */
161	ATA_FLAG_SLAVE_POSS	= (1 << 0), /* host supports slave dev */
162					    /* (doesn't imply presence) */
163	ATA_FLAG_SATA		= (1 << 1),
164	ATA_FLAG_NO_LEGACY	= (1 << 2), /* no legacy mode check */
165	ATA_FLAG_MMIO		= (1 << 3), /* use MMIO, not PIO */
166	ATA_FLAG_SRST		= (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */
167	ATA_FLAG_SATA_RESET	= (1 << 5), /* (obsolete) use COMRESET */
168	ATA_FLAG_NO_ATAPI	= (1 << 6), /* No ATAPI support */
169	ATA_FLAG_PIO_DMA	= (1 << 7), /* PIO cmds via DMA */
170	ATA_FLAG_PIO_LBA48	= (1 << 8), /* Host DMA engine is LBA28 only */
171	ATA_FLAG_PIO_POLLING	= (1 << 9), /* use polling PIO if LLD
172					     * doesn't handle PIO interrupts */
173	ATA_FLAG_NCQ		= (1 << 10), /* host supports NCQ */
174	ATA_FLAG_HRST_TO_RESUME	= (1 << 11), /* hardreset to resume phy */
175	ATA_FLAG_SKIP_D2H_BSY	= (1 << 12), /* can't wait for the first D2H
176					      * Register FIS clearing BSY */
177	ATA_FLAG_DEBUGMSG	= (1 << 13),
178
179	/* The following flag belongs to ap->pflags but is kept in
180	 * ap->flags because it's referenced in many LLDs and will be
181	 * removed in not-too-distant future.
182	 */
183	ATA_FLAG_DISABLED	= (1 << 23), /* port is disabled, ignore it */
184
185	/* bits 24:31 of ap->flags are reserved for LLD specific flags */
186
187	/* struct ata_port pflags */
188	ATA_PFLAG_EH_PENDING	= (1 << 0), /* EH pending */
189	ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */
190	ATA_PFLAG_FROZEN	= (1 << 2), /* port is frozen */
191	ATA_PFLAG_RECOVERED	= (1 << 3), /* recovery action performed */
192	ATA_PFLAG_LOADING	= (1 << 4), /* boot/loading probe */
193	ATA_PFLAG_UNLOADING	= (1 << 5), /* module is unloading */
194	ATA_PFLAG_SCSI_HOTPLUG	= (1 << 6), /* SCSI hotplug scheduled */
195
196	ATA_PFLAG_FLUSH_PORT_TASK = (1 << 16), /* flush port task */
197	ATA_PFLAG_SUSPENDED	= (1 << 17), /* port is suspended (power) */
198	ATA_PFLAG_PM_PENDING	= (1 << 18), /* PM operation pending */
199
200	/* struct ata_queued_cmd flags */
201	ATA_QCFLAG_ACTIVE	= (1 << 0), /* cmd not yet ack'd to scsi lyer */
202	ATA_QCFLAG_SG		= (1 << 1), /* have s/g table? */
203	ATA_QCFLAG_SINGLE	= (1 << 2), /* no s/g, just a single buffer */
204	ATA_QCFLAG_DMAMAP	= ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE,
205	ATA_QCFLAG_IO		= (1 << 3), /* standard IO command */
206	ATA_QCFLAG_RESULT_TF	= (1 << 4), /* result TF requested */
207
208	ATA_QCFLAG_FAILED	= (1 << 16), /* cmd failed and is owned by EH */
209	ATA_QCFLAG_SENSE_VALID	= (1 << 17), /* sense data valid */
210	ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
211
212	/* host set flags */
213	ATA_HOST_SIMPLEX	= (1 << 0),	/* Host is simplex, one DMA channel per host only */
214
215	/* various lengths of time */
216	ATA_TMOUT_BOOT		= 30 * HZ,	/* heuristic */
217	ATA_TMOUT_BOOT_QUICK	= 7 * HZ,	/* heuristic */
218	ATA_TMOUT_INTERNAL	= 30 * HZ,
219	ATA_TMOUT_INTERNAL_QUICK = 5 * HZ,
220
221	/* ATA bus states */
222	BUS_UNKNOWN		= 0,
223	BUS_DMA			= 1,
224	BUS_IDLE		= 2,
225	BUS_NOINTR		= 3,
226	BUS_NODATA		= 4,
227	BUS_TIMER		= 5,
228	BUS_PIO			= 6,
229	BUS_EDD			= 7,
230	BUS_IDENTIFY		= 8,
231	BUS_PACKET		= 9,
232
233	/* SATA port states */
234	PORT_UNKNOWN		= 0,
235	PORT_ENABLED		= 1,
236	PORT_DISABLED		= 2,
237
238	/* encoding various smaller bitmaps into a single
239	 * unsigned int bitmap
240	 */
241	ATA_BITS_PIO		= 7,
242	ATA_BITS_MWDMA		= 5,
243	ATA_BITS_UDMA		= 8,
244
245	ATA_SHIFT_PIO		= 0,
246	ATA_SHIFT_MWDMA		= ATA_SHIFT_PIO + ATA_BITS_PIO,
247	ATA_SHIFT_UDMA		= ATA_SHIFT_MWDMA + ATA_BITS_MWDMA,
248
249	ATA_MASK_PIO		= ((1 << ATA_BITS_PIO) - 1) << ATA_SHIFT_PIO,
250	ATA_MASK_MWDMA		= ((1 << ATA_BITS_MWDMA) - 1) << ATA_SHIFT_MWDMA,
251	ATA_MASK_UDMA		= ((1 << ATA_BITS_UDMA) - 1) << ATA_SHIFT_UDMA,
252
253	/* size of buffer to pad xfers ending on unaligned boundaries */
254	ATA_DMA_PAD_SZ		= 4,
255	ATA_DMA_PAD_BUF_SZ	= ATA_DMA_PAD_SZ * ATA_MAX_QUEUE,
256
257	/* masks for port functions */
258	ATA_PORT_PRIMARY	= (1 << 0),
259	ATA_PORT_SECONDARY	= (1 << 1),
260
261	/* ering size */
262	ATA_ERING_SIZE		= 32,
263
264	/* desc_len for ata_eh_info and context */
265	ATA_EH_DESC_LEN		= 80,
266
267	/* reset / recovery action types */
268	ATA_EH_REVALIDATE	= (1 << 0),
269	ATA_EH_SOFTRESET	= (1 << 1),
270	ATA_EH_HARDRESET	= (1 << 2),
271	ATA_EH_SUSPEND		= (1 << 3),
272	ATA_EH_RESUME		= (1 << 4),
273	ATA_EH_PM_FREEZE	= (1 << 5),
274
275	ATA_EH_RESET_MASK	= ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
276	ATA_EH_PERDEV_MASK	= ATA_EH_REVALIDATE | ATA_EH_SUSPEND |
277				  ATA_EH_RESUME | ATA_EH_PM_FREEZE,
278
279	/* ata_eh_info->flags */
280	ATA_EHI_HOTPLUGGED	= (1 << 0),  /* could have been hotplugged */
281	ATA_EHI_RESUME_LINK	= (1 << 1),  /* resume link (reset modifier) */
282	ATA_EHI_NO_AUTOPSY	= (1 << 2),  /* no autopsy */
283	ATA_EHI_QUIET		= (1 << 3),  /* be quiet */
284
285	ATA_EHI_DID_RESET	= (1 << 16), /* already reset this port */
286
287	ATA_EHI_RESET_MODIFIER_MASK = ATA_EHI_RESUME_LINK,
288
289	/* max repeat if error condition is still set after ->error_handler */
290	ATA_EH_MAX_REPEAT	= 5,
291
292	/* how hard are we gonna try to probe/recover devices */
293	ATA_PROBE_MAX_TRIES	= 3,
294	ATA_EH_RESET_TRIES	= 3,
295	ATA_EH_DEV_TRIES	= 3,
296
297	/* Drive spinup time (time from power-on to the first D2H FIS)
298	 * in msecs - 8s currently.  Failing to get ready in this time
299	 * isn't critical.  It will result in reset failure for
300	 * controllers which can't wait for the first D2H FIS.  libata
301	 * will retry, so it just has to be long enough to spin up
302	 * most devices.
303	 */
304	ATA_SPINUP_WAIT		= 8000,
305
306	/* Horkage types. May be set by libata or controller on drives
307	   (some horkage may be drive/controller pair dependant */
308
309	ATA_HORKAGE_DIAGNOSTIC	= (1 << 0),	/* Failed boot diag */
310};
311
312enum hsm_task_states {
313	HSM_ST_UNKNOWN,		/* state unknown */
314	HSM_ST_IDLE,		/* no command on going */
315	HSM_ST,			/* (waiting the device to) transfer data */
316	HSM_ST_LAST,		/* (waiting the device to) complete command */
317	HSM_ST_ERR,		/* error */
318	HSM_ST_FIRST,		/* (waiting the device to)
319				   write CDB or first data block */
320};
321
322enum ata_completion_errors {
323	AC_ERR_DEV		= (1 << 0), /* device reported error */
324	AC_ERR_HSM		= (1 << 1), /* host state machine violation */
325	AC_ERR_TIMEOUT		= (1 << 2), /* timeout */
326	AC_ERR_MEDIA		= (1 << 3), /* media error */
327	AC_ERR_ATA_BUS		= (1 << 4), /* ATA bus error */
328	AC_ERR_HOST_BUS		= (1 << 5), /* host bus error */
329	AC_ERR_SYSTEM		= (1 << 6), /* system error */
330	AC_ERR_INVALID		= (1 << 7), /* invalid argument */
331	AC_ERR_OTHER		= (1 << 8), /* unknown */
332};
333
334/* forward declarations */
335struct scsi_device;
336struct ata_port_operations;
337struct ata_port;
338struct ata_queued_cmd;
339
340/* typedefs */
341typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
342typedef int (*ata_prereset_fn_t)(struct ata_port *ap);
343typedef int (*ata_reset_fn_t)(struct ata_port *ap, unsigned int *classes);
344typedef void (*ata_postreset_fn_t)(struct ata_port *ap, unsigned int *classes);
345
346struct ata_ioports {
347	unsigned long		cmd_addr;
348	unsigned long		data_addr;
349	unsigned long		error_addr;
350	unsigned long		feature_addr;
351	unsigned long		nsect_addr;
352	unsigned long		lbal_addr;
353	unsigned long		lbam_addr;
354	unsigned long		lbah_addr;
355	unsigned long		device_addr;
356	unsigned long		status_addr;
357	unsigned long		command_addr;
358	unsigned long		altstatus_addr;
359	unsigned long		ctl_addr;
360	unsigned long		bmdma_addr;
361	unsigned long		scr_addr;
362};
363
364struct ata_probe_ent {
365	struct list_head	node;
366	struct device 		*dev;
367	const struct ata_port_operations *port_ops;
368	struct scsi_host_template *sht;
369	struct ata_ioports	port[ATA_MAX_PORTS];
370	unsigned int		n_ports;
371	unsigned int		dummy_port_mask;
372	unsigned int		pio_mask;
373	unsigned int		mwdma_mask;
374	unsigned int		udma_mask;
375	unsigned long		irq;
376	unsigned long		irq2;
377	unsigned int		irq_flags;
378	unsigned long		port_flags;
379	unsigned long		_host_flags;
380	void __iomem		*mmio_base;
381	void			*private_data;
382
383	/* port_info for the secondary port.  Together with irq2, it's
384	 * used to implement non-uniform secondary port.  Currently,
385	 * the only user is ata_piix combined mode.  This workaround
386	 * will be removed together with ata_probe_ent when init model
387	 * is updated.
388	 */
389	const struct ata_port_info *pinfo2;
390};
391
392struct ata_host {
393	spinlock_t		lock;
394	struct device 		*dev;
395	unsigned long		irq;
396	unsigned long		irq2;
397	void __iomem		*mmio_base;
398	unsigned int		n_ports;
399	void			*private_data;
400	const struct ata_port_operations *ops;
401	unsigned long		flags;
402	int			simplex_claimed;	/* Keep seperate in case we
403							   ever need to do this locked */
404	struct ata_port		*ports[0];
405};
406
407struct ata_queued_cmd {
408	struct ata_port		*ap;
409	struct ata_device	*dev;
410
411	struct scsi_cmnd	*scsicmd;
412	void			(*scsidone)(struct scsi_cmnd *);
413
414	struct ata_taskfile	tf;
415	u8			cdb[ATAPI_CDB_LEN];
416
417	unsigned long		flags;		/* ATA_QCFLAG_xxx */
418	unsigned int		tag;
419	unsigned int		n_elem;
420	unsigned int		orig_n_elem;
421
422	int			dma_dir;
423
424	unsigned int		pad_len;
425
426	unsigned int		nsect;
427	unsigned int		cursect;
428
429	unsigned int		nbytes;
430	unsigned int		curbytes;
431
432	unsigned int		cursg;
433	unsigned int		cursg_ofs;
434
435	struct scatterlist	sgent;
436	struct scatterlist	pad_sgent;
437	void			*buf_virt;
438
439	/* DO NOT iterate over __sg manually, use ata_for_each_sg() */
440	struct scatterlist	*__sg;
441
442	unsigned int		err_mask;
443	struct ata_taskfile	result_tf;
444	ata_qc_cb_t		complete_fn;
445
446	void			*private_data;
447};
448
449struct ata_port_stats {
450	unsigned long		unhandled_irq;
451	unsigned long		idle_irq;
452	unsigned long		rw_reqbuf;
453};
454
455struct ata_ering_entry {
456	int			is_io;
457	unsigned int		err_mask;
458	u64			timestamp;
459};
460
461struct ata_ering {
462	int			cursor;
463	struct ata_ering_entry	ring[ATA_ERING_SIZE];
464};
465
466struct ata_device {
467	struct ata_port		*ap;
468	unsigned int		devno;		/* 0 or 1 */
469	unsigned long		flags;		/* ATA_DFLAG_xxx */
470	struct scsi_device	*sdev;		/* attached SCSI device */
471	/* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */
472	u64			n_sectors;	/* size of device, if ATA */
473	unsigned int		class;		/* ATA_DEV_xxx */
474	u16			id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
475	u8			pio_mode;
476	u8			dma_mode;
477	u8			xfer_mode;
478	unsigned int		xfer_shift;	/* ATA_SHIFT_xxx */
479
480	unsigned int		multi_count;	/* sectors count for
481						   READ/WRITE MULTIPLE */
482	unsigned int		max_sectors;	/* per-device max sectors */
483	unsigned int		cdb_len;
484
485	/* per-dev xfer mask */
486	unsigned int		pio_mask;
487	unsigned int		mwdma_mask;
488	unsigned int		udma_mask;
489
490	/* for CHS addressing */
491	u16			cylinders;	/* Number of cylinders */
492	u16			heads;		/* Number of heads */
493	u16			sectors;	/* Number of sectors per track */
494
495	/* error history */
496	struct ata_ering	ering;
497	unsigned int		horkage;	/* List of broken features */
498};
499
500/* Offset into struct ata_device.  Fields above it are maintained
501 * acress device init.  Fields below are zeroed.
502 */
503#define ATA_DEVICE_CLEAR_OFFSET		offsetof(struct ata_device, n_sectors)
504
505struct ata_eh_info {
506	struct ata_device	*dev;		/* offending device */
507	u32			serror;		/* SError from LLDD */
508	unsigned int		err_mask;	/* port-wide err_mask */
509	unsigned int		action;		/* ATA_EH_* action mask */
510	unsigned int		dev_action[ATA_MAX_DEVICES]; /* dev EH action */
511	unsigned int		flags;		/* ATA_EHI_* flags */
512
513	unsigned long		hotplug_timestamp;
514	unsigned int		probe_mask;
515
516	char			desc[ATA_EH_DESC_LEN];
517	int			desc_len;
518};
519
520struct ata_eh_context {
521	struct ata_eh_info	i;
522	int			tries[ATA_MAX_DEVICES];
523	unsigned int		classes[ATA_MAX_DEVICES];
524	unsigned int		did_probe_mask;
525};
526
527struct ata_port {
528	struct Scsi_Host	*scsi_host; /* our co-allocated scsi host */
529	const struct ata_port_operations *ops;
530	spinlock_t		*lock;
531	unsigned long		flags;	/* ATA_FLAG_xxx */
532	unsigned int		pflags; /* ATA_PFLAG_xxx */
533	unsigned int		id;	/* unique id req'd by scsi midlyr */
534	unsigned int		port_no; /* unique port #; from zero */
535
536	struct ata_prd		*prd;	 /* our SG list */
537	dma_addr_t		prd_dma; /* and its DMA mapping */
538
539	void			*pad;	/* array of DMA pad buffers */
540	dma_addr_t		pad_dma;
541
542	struct ata_ioports	ioaddr;	/* ATA cmd/ctl/dma register blocks */
543
544	u8			ctl;	/* cache of ATA control register */
545	u8			last_ctl;	/* Cache last written value */
546	unsigned int		pio_mask;
547	unsigned int		mwdma_mask;
548	unsigned int		udma_mask;
549	unsigned int		cbl;	/* cable type; ATA_CBL_xxx */
550	unsigned int		hw_sata_spd_limit;
551	unsigned int		sata_spd_limit;	/* SATA PHY speed limit */
552
553	/* record runtime error info, protected by host lock */
554	struct ata_eh_info	eh_info;
555	/* EH context owned by EH */
556	struct ata_eh_context	eh_context;
557
558	struct ata_device	device[ATA_MAX_DEVICES];
559
560	struct ata_queued_cmd	qcmd[ATA_MAX_QUEUE];
561	unsigned long		qc_allocated;
562	unsigned int		qc_active;
563
564	unsigned int		active_tag;
565	u32			sactive;
566
567	struct ata_port_stats	stats;
568	struct ata_host		*host;
569	struct device 		*dev;
570
571	struct delayed_work	port_task;
572	struct delayed_work	hotplug_task;
573	struct work_struct	scsi_rescan_task;
574
575	unsigned int		hsm_task_state;
576
577	u32			msg_enable;
578	struct list_head	eh_done_q;
579	wait_queue_head_t	eh_wait_q;
580
581	pm_message_t		pm_mesg;
582	int			*pm_result;
583
584	void			*private_data;
585
586	u8			sector_buf[ATA_SECT_SIZE]; /* owned by EH */
587};
588
589struct ata_port_operations {
590	void (*port_disable) (struct ata_port *);
591
592	void (*dev_config) (struct ata_port *, struct ata_device *);
593
594	void (*set_piomode) (struct ata_port *, struct ata_device *);
595	void (*set_dmamode) (struct ata_port *, struct ata_device *);
596	unsigned long (*mode_filter) (const struct ata_port *, struct ata_device *, unsigned long);
597
598	void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
599	void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
600
601	void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
602	u8   (*check_status)(struct ata_port *ap);
603	u8   (*check_altstatus)(struct ata_port *ap);
604	void (*dev_select)(struct ata_port *ap, unsigned int device);
605
606	void (*phy_reset) (struct ata_port *ap); /* obsolete */
607	void (*set_mode) (struct ata_port *ap);
608
609	void (*post_set_mode) (struct ata_port *ap);
610
611	int (*check_atapi_dma) (struct ata_queued_cmd *qc);
612
613	void (*bmdma_setup) (struct ata_queued_cmd *qc);
614	void (*bmdma_start) (struct ata_queued_cmd *qc);
615
616	void (*data_xfer) (struct ata_device *, unsigned char *, unsigned int, int);
617
618	void (*qc_prep) (struct ata_queued_cmd *qc);
619	unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
620
621	/* Error handlers.  ->error_handler overrides ->eng_timeout and
622	 * indicates that new-style EH is in place.
623	 */
624	void (*eng_timeout) (struct ata_port *ap); /* obsolete */
625
626	void (*freeze) (struct ata_port *ap);
627	void (*thaw) (struct ata_port *ap);
628	void (*error_handler) (struct ata_port *ap);
629	void (*post_internal_cmd) (struct ata_queued_cmd *qc);
630
631	irq_handler_t irq_handler;
632	void (*irq_clear) (struct ata_port *);
633
634	u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg);
635	void (*scr_write) (struct ata_port *ap, unsigned int sc_reg,
636			   u32 val);
637
638	int (*port_suspend) (struct ata_port *ap, pm_message_t mesg);
639	int (*port_resume) (struct ata_port *ap);
640
641	int (*port_start) (struct ata_port *ap);
642	void (*port_stop) (struct ata_port *ap);
643
644	void (*host_stop) (struct ata_host *host);
645
646	void (*bmdma_stop) (struct ata_queued_cmd *qc);
647	u8   (*bmdma_status) (struct ata_port *ap);
648};
649
650struct ata_port_info {
651	struct scsi_host_template	*sht;
652	unsigned long		flags;
653	unsigned long		pio_mask;
654	unsigned long		mwdma_mask;
655	unsigned long		udma_mask;
656	const struct ata_port_operations *port_ops;
657	void 			*private_data;
658};
659
660struct ata_timing {
661	unsigned short mode;		/* ATA mode */
662	unsigned short setup;		/* t1 */
663	unsigned short act8b;		/* t2 for 8-bit I/O */
664	unsigned short rec8b;		/* t2i for 8-bit I/O */
665	unsigned short cyc8b;		/* t0 for 8-bit I/O */
666	unsigned short active;		/* t2 or tD */
667	unsigned short recover;		/* t2i or tK */
668	unsigned short cycle;		/* t0 */
669	unsigned short udma;		/* t2CYCTYP/2 */
670};
671
672#define FIT(v,vmin,vmax)	max_t(short,min_t(short,v,vmax),vmin)
673
674extern const unsigned long sata_deb_timing_normal[];
675extern const unsigned long sata_deb_timing_hotplug[];
676extern const unsigned long sata_deb_timing_long[];
677
678extern const struct ata_port_operations ata_dummy_port_ops;
679
680static inline const unsigned long *
681sata_ehc_deb_timing(struct ata_eh_context *ehc)
682{
683	if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
684		return sata_deb_timing_hotplug;
685	else
686		return sata_deb_timing_normal;
687}
688
689static inline int ata_port_is_dummy(struct ata_port *ap)
690{
691	return ap->ops == &ata_dummy_port_ops;
692}
693
694extern void ata_port_probe(struct ata_port *);
695extern void __sata_phy_reset(struct ata_port *ap);
696extern void sata_phy_reset(struct ata_port *ap);
697extern void ata_bus_reset(struct ata_port *ap);
698extern int sata_set_spd(struct ata_port *ap);
699extern int sata_phy_debounce(struct ata_port *ap, const unsigned long *param);
700extern int sata_phy_resume(struct ata_port *ap, const unsigned long *param);
701extern int ata_std_prereset(struct ata_port *ap);
702extern int ata_std_softreset(struct ata_port *ap, unsigned int *classes);
703extern int sata_std_hardreset(struct ata_port *ap, unsigned int *class);
704extern void ata_std_postreset(struct ata_port *ap, unsigned int *classes);
705extern void ata_port_disable(struct ata_port *);
706extern void ata_std_ports(struct ata_ioports *ioaddr);
707#ifdef CONFIG_PCI
708extern int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info,
709			     unsigned int n_ports);
710extern void ata_pci_remove_one (struct pci_dev *pdev);
711extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
712extern void ata_pci_device_do_resume(struct pci_dev *pdev);
713extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
714extern int ata_pci_device_resume(struct pci_dev *pdev);
715extern int ata_pci_clear_simplex(struct pci_dev *pdev);
716#endif /* CONFIG_PCI */
717extern int ata_device_add(const struct ata_probe_ent *ent);
718extern void ata_port_detach(struct ata_port *ap);
719extern void ata_host_init(struct ata_host *, struct device *,
720			  unsigned long, const struct ata_port_operations *);
721extern void ata_host_remove(struct ata_host *host);
722extern int ata_scsi_detect(struct scsi_host_template *sht);
723extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
724extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
725extern int ata_scsi_release(struct Scsi_Host *host);
726extern void ata_sas_port_destroy(struct ata_port *);
727extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
728					   struct ata_port_info *, struct Scsi_Host *);
729extern int ata_sas_port_init(struct ata_port *);
730extern int ata_sas_port_start(struct ata_port *ap);
731extern void ata_sas_port_stop(struct ata_port *ap);
732extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
733extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
734			    struct ata_port *ap);
735extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
736extern int sata_scr_valid(struct ata_port *ap);
737extern int sata_scr_read(struct ata_port *ap, int reg, u32 *val);
738extern int sata_scr_write(struct ata_port *ap, int reg, u32 val);
739extern int sata_scr_write_flush(struct ata_port *ap, int reg, u32 val);
740extern int ata_port_online(struct ata_port *ap);
741extern int ata_port_offline(struct ata_port *ap);
742extern int ata_scsi_device_resume(struct scsi_device *);
743extern int ata_scsi_device_suspend(struct scsi_device *, pm_message_t mesg);
744extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
745extern void ata_host_resume(struct ata_host *host);
746extern int ata_ratelimit(void);
747extern unsigned int ata_busy_sleep(struct ata_port *ap,
748				   unsigned long timeout_pat,
749				   unsigned long timeout);
750extern void ata_port_queue_task(struct ata_port *ap, void (*fn)(void *),
751				void *data, unsigned long delay);
752extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
753			     unsigned long interval_msec,
754			     unsigned long timeout_msec);
755
756/*
757 * Default driver ops implementations
758 */
759extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
760extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
761extern void ata_tf_to_fis(const struct ata_taskfile *tf, u8 *fis, u8 pmp);
762extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
763extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
764extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
765extern u8 ata_check_status(struct ata_port *ap);
766extern u8 ata_altstatus(struct ata_port *ap);
767extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
768extern int ata_port_start (struct ata_port *ap);
769extern void ata_port_stop (struct ata_port *ap);
770extern void ata_host_stop (struct ata_host *host);
771extern irqreturn_t ata_interrupt (int irq, void *dev_instance);
772extern void ata_mmio_data_xfer(struct ata_device *adev, unsigned char *buf,
773			       unsigned int buflen, int write_data);
774extern void ata_pio_data_xfer(struct ata_device *adev, unsigned char *buf,
775			      unsigned int buflen, int write_data);
776extern void ata_pio_data_xfer_noirq(struct ata_device *adev, unsigned char *buf,
777			      unsigned int buflen, int write_data);
778extern void ata_qc_prep(struct ata_queued_cmd *qc);
779extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
780extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
781extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
782		unsigned int buflen);
783extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
784		 unsigned int n_elem);
785extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
786extern void ata_id_string(const u16 *id, unsigned char *s,
787			  unsigned int ofs, unsigned int len);
788extern void ata_id_c_string(const u16 *id, unsigned char *s,
789			    unsigned int ofs, unsigned int len);
790extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
791extern void ata_bmdma_start (struct ata_queued_cmd *qc);
792extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
793extern u8   ata_bmdma_status(struct ata_port *ap);
794extern void ata_bmdma_irq_clear(struct ata_port *ap);
795extern void ata_bmdma_freeze(struct ata_port *ap);
796extern void ata_bmdma_thaw(struct ata_port *ap);
797extern void ata_bmdma_drive_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
798			       ata_reset_fn_t softreset,
799			       ata_reset_fn_t hardreset,
800			       ata_postreset_fn_t postreset);
801extern void ata_bmdma_error_handler(struct ata_port *ap);
802extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
803extern int ata_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
804			u8 status, int in_wq);
805extern void ata_qc_complete(struct ata_queued_cmd *qc);
806extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active,
807				    void (*finish_qc)(struct ata_queued_cmd *));
808extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
809			      void (*done)(struct scsi_cmnd *));
810extern int ata_std_bios_param(struct scsi_device *sdev,
811			      struct block_device *bdev,
812			      sector_t capacity, int geom[]);
813extern int ata_scsi_slave_config(struct scsi_device *sdev);
814extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
815extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
816				       int queue_depth);
817extern struct ata_device *ata_dev_pair(struct ata_device *adev);
818
819/*
820 * Timing helpers
821 */
822
823extern unsigned int ata_pio_need_iordy(const struct ata_device *);
824extern int ata_timing_compute(struct ata_device *, unsigned short,
825			      struct ata_timing *, int, int);
826extern void ata_timing_merge(const struct ata_timing *,
827			     const struct ata_timing *, struct ata_timing *,
828			     unsigned int);
829
830enum {
831	ATA_TIMING_SETUP	= (1 << 0),
832	ATA_TIMING_ACT8B	= (1 << 1),
833	ATA_TIMING_REC8B	= (1 << 2),
834	ATA_TIMING_CYC8B	= (1 << 3),
835	ATA_TIMING_8BIT		= ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
836				  ATA_TIMING_CYC8B,
837	ATA_TIMING_ACTIVE	= (1 << 4),
838	ATA_TIMING_RECOVER	= (1 << 5),
839	ATA_TIMING_CYCLE	= (1 << 6),
840	ATA_TIMING_UDMA		= (1 << 7),
841	ATA_TIMING_ALL		= ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
842				  ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
843				  ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
844				  ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
845};
846
847
848#ifdef CONFIG_PCI
849struct pci_bits {
850	unsigned int		reg;	/* PCI config register to read */
851	unsigned int		width;	/* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
852	unsigned long		mask;
853	unsigned long		val;
854};
855
856extern void ata_pci_host_stop (struct ata_host *host);
857extern struct ata_probe_ent *
858ata_pci_init_native_mode(struct pci_dev *pdev, struct ata_port_info **port, int portmask);
859extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
860extern unsigned long ata_pci_default_filter(const struct ata_port *, 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)->id , ##args)
887
888#define ata_dev_printk(dev, lv, fmt, args...) \
889	printk(lv"ata%u.%02u: "fmt, (dev)->ap->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	if (ehi->flags & ATA_EHI_HOTPLUGGED)
908		return;
909
910	ehi->flags |= ATA_EHI_HOTPLUGGED | ATA_EHI_RESUME_LINK;
911	ehi->hotplug_timestamp = jiffies;
912
913	ehi->action |= ATA_EH_SOFTRESET;
914	ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
915}
916
917static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
918{
919	__ata_ehi_hotplugged(ehi);
920	ehi->err_mask |= AC_ERR_ATA_BUS;
921}
922
923/*
924 * qc helpers
925 */
926static inline int
927ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
928{
929	if (sg == &qc->pad_sgent)
930		return 1;
931	if (qc->pad_len)
932		return 0;
933	if (((sg - qc->__sg) + 1) == qc->n_elem)
934		return 1;
935	return 0;
936}
937
938static inline struct scatterlist *
939ata_qc_first_sg(struct ata_queued_cmd *qc)
940{
941	if (qc->n_elem)
942		return qc->__sg;
943	if (qc->pad_len)
944		return &qc->pad_sgent;
945	return NULL;
946}
947
948static inline struct scatterlist *
949ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
950{
951	if (sg == &qc->pad_sgent)
952		return NULL;
953	if (++sg - qc->__sg < qc->n_elem)
954		return sg;
955	if (qc->pad_len)
956		return &qc->pad_sgent;
957	return NULL;
958}
959
960#define ata_for_each_sg(sg, qc) \
961	for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
962
963static inline unsigned int ata_tag_valid(unsigned int tag)
964{
965	return (tag < ATA_MAX_QUEUE) ? 1 : 0;
966}
967
968static inline unsigned int ata_tag_internal(unsigned int tag)
969{
970	return tag == ATA_MAX_QUEUE - 1;
971}
972
973/*
974 * device helpers
975 */
976static inline unsigned int ata_class_enabled(unsigned int class)
977{
978	return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI;
979}
980
981static inline unsigned int ata_class_disabled(unsigned int class)
982{
983	return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP;
984}
985
986static inline unsigned int ata_class_absent(unsigned int class)
987{
988	return !ata_class_enabled(class) && !ata_class_disabled(class);
989}
990
991static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
992{
993	return ata_class_enabled(dev->class);
994}
995
996static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
997{
998	return ata_class_disabled(dev->class);
999}
1000
1001static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1002{
1003	return ata_class_absent(dev->class);
1004}
1005
1006static inline unsigned int ata_dev_ready(const struct ata_device *dev)
1007{
1008	return ata_dev_enabled(dev) && !(dev->flags & ATA_DFLAG_SUSPENDED);
1009}
1010
1011/*
1012 * port helpers
1013 */
1014static inline int ata_port_max_devices(const struct ata_port *ap)
1015{
1016	if (ap->flags & ATA_FLAG_SLAVE_POSS)
1017		return 2;
1018	return 1;
1019}
1020
1021
1022static inline u8 ata_chk_status(struct ata_port *ap)
1023{
1024	return ap->ops->check_status(ap);
1025}
1026
1027
1028/**
1029 *	ata_pause - Flush writes and pause 400 nanoseconds.
1030 *	@ap: Port to wait for.
1031 *
1032 *	LOCKING:
1033 *	Inherited from caller.
1034 */
1035
1036static inline void ata_pause(struct ata_port *ap)
1037{
1038	ata_altstatus(ap);
1039	ndelay(400);
1040}
1041
1042
1043/**
1044 *	ata_busy_wait - Wait for a port status register
1045 *	@ap: Port to wait for.
1046 *
1047 *	Waits up to max*10 microseconds for the selected bits in the port's
1048 *	status register to be cleared.
1049 *	Returns final value of status register.
1050 *
1051 *	LOCKING:
1052 *	Inherited from caller.
1053 */
1054
1055static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
1056			       unsigned int max)
1057{
1058	u8 status;
1059
1060	do {
1061		udelay(10);
1062		status = ata_chk_status(ap);
1063		max--;
1064	} while ((status & bits) && (max > 0));
1065
1066	return status;
1067}
1068
1069
1070/**
1071 *	ata_wait_idle - Wait for a port to be idle.
1072 *	@ap: Port to wait for.
1073 *
1074 *	Waits up to 10ms for port's BUSY and DRQ signals to clear.
1075 *	Returns final value of status register.
1076 *
1077 *	LOCKING:
1078 *	Inherited from caller.
1079 */
1080
1081static inline u8 ata_wait_idle(struct ata_port *ap)
1082{
1083	u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1084
1085	if (status & (ATA_BUSY | ATA_DRQ)) {
1086		unsigned long l = ap->ioaddr.status_addr;
1087		if (ata_msg_warn(ap))
1088			printk(KERN_WARNING "ATA: abnormal status 0x%X on port 0x%lX\n",
1089				status, l);
1090	}
1091
1092	return status;
1093}
1094
1095static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1096{
1097	qc->tf.ctl |= ATA_NIEN;
1098}
1099
1100static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1101						       unsigned int tag)
1102{
1103	if (likely(ata_tag_valid(tag)))
1104		return &ap->qcmd[tag];
1105	return NULL;
1106}
1107
1108static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1109						     unsigned int tag)
1110{
1111	struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1112
1113	if (unlikely(!qc) || !ap->ops->error_handler)
1114		return qc;
1115
1116	if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1117			  ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1118		return qc;
1119
1120	return NULL;
1121}
1122
1123static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1124{
1125	memset(tf, 0, sizeof(*tf));
1126
1127	tf->ctl = dev->ap->ctl;
1128	if (dev->devno == 0)
1129		tf->device = ATA_DEVICE_OBS;
1130	else
1131		tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1132}
1133
1134static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1135{
1136	qc->__sg = NULL;
1137	qc->flags = 0;
1138	qc->cursect = qc->cursg = qc->cursg_ofs = 0;
1139	qc->nsect = 0;
1140	qc->nbytes = qc->curbytes = 0;
1141	qc->err_mask = 0;
1142
1143	ata_tf_init(qc->dev, &qc->tf);
1144
1145	/* init result_tf such that it indicates normal completion */
1146	qc->result_tf.command = ATA_DRDY;
1147	qc->result_tf.feature = 0;
1148}
1149
1150/**
1151 *	ata_irq_on - Enable interrupts on a port.
1152 *	@ap: Port on which interrupts are enabled.
1153 *
1154 *	Enable interrupts on a legacy IDE device using MMIO or PIO,
1155 *	wait for idle, clear any pending interrupts.
1156 *
1157 *	LOCKING:
1158 *	Inherited from caller.
1159 */
1160
1161static inline u8 ata_irq_on(struct ata_port *ap)
1162{
1163	struct ata_ioports *ioaddr = &ap->ioaddr;
1164	u8 tmp;
1165
1166	ap->ctl &= ~ATA_NIEN;
1167	ap->last_ctl = ap->ctl;
1168
1169	if (ap->flags & ATA_FLAG_MMIO)
1170		writeb(ap->ctl, (void __iomem *) ioaddr->ctl_addr);
1171	else
1172		outb(ap->ctl, ioaddr->ctl_addr);
1173	tmp = ata_wait_idle(ap);
1174
1175	ap->ops->irq_clear(ap);
1176
1177	return tmp;
1178}
1179
1180
1181/**
1182 *	ata_irq_ack - Acknowledge a device interrupt.
1183 *	@ap: Port on which interrupts are enabled.
1184 *
1185 *	Wait up to 10 ms for legacy IDE device to become idle (BUSY
1186 *	or BUSY+DRQ clear).  Obtain dma status and port status from
1187 *	device.  Clear the interrupt.  Return port status.
1188 *
1189 *	LOCKING:
1190 */
1191
1192static inline u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq)
1193{
1194	unsigned int bits = chk_drq ? ATA_BUSY | ATA_DRQ : ATA_BUSY;
1195	u8 host_stat, post_stat, status;
1196
1197	status = ata_busy_wait(ap, bits, 1000);
1198	if (status & bits)
1199		if (ata_msg_err(ap))
1200			printk(KERN_ERR "abnormal status 0x%X\n", status);
1201
1202	/* get controller status; clear intr, err bits */
1203	if (ap->flags & ATA_FLAG_MMIO) {
1204		void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr;
1205		host_stat = readb(mmio + ATA_DMA_STATUS);
1206		writeb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
1207		       mmio + ATA_DMA_STATUS);
1208
1209		post_stat = readb(mmio + ATA_DMA_STATUS);
1210	} else {
1211		host_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
1212		outb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
1213		     ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
1214
1215		post_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
1216	}
1217
1218	if (ata_msg_intr(ap))
1219		printk(KERN_INFO "%s: irq ack: host_stat 0x%X, new host_stat 0x%X, drv_stat 0x%X\n",
1220			__FUNCTION__,
1221			host_stat, post_stat, status);
1222
1223	return status;
1224}
1225
1226static inline int ata_try_flush_cache(const struct ata_device *dev)
1227{
1228	return ata_id_wcache_enabled(dev->id) ||
1229	       ata_id_has_flush(dev->id) ||
1230	       ata_id_has_flush_ext(dev->id);
1231}
1232
1233static inline unsigned int ac_err_mask(u8 status)
1234{
1235	if (status & (ATA_BUSY | ATA_DRQ))
1236		return AC_ERR_HSM;
1237	if (status & (ATA_ERR | ATA_DF))
1238		return AC_ERR_DEV;
1239	return 0;
1240}
1241
1242static inline unsigned int __ac_err_mask(u8 status)
1243{
1244	unsigned int mask = ac_err_mask(status);
1245	if (mask == 0)
1246		return AC_ERR_OTHER;
1247	return mask;
1248}
1249
1250static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
1251{
1252	ap->pad_dma = 0;
1253	ap->pad = dma_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
1254				     &ap->pad_dma, GFP_KERNEL);
1255	return (ap->pad == NULL) ? -ENOMEM : 0;
1256}
1257
1258static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
1259{
1260	dma_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
1261}
1262
1263static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1264{
1265	return (struct ata_port *) &host->hostdata[0];
1266}
1267
1268#endif /* __LINUX_LIBATA_H__ */
1269