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