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