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