xref: /linux-6.15/include/linux/libata.h (revision e67f88dd)
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/jiffies.h>
31 #include <linux/interrupt.h>
32 #include <linux/dma-mapping.h>
33 #include <linux/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 #include <linux/cdrom.h>
40 #include <linux/sched.h>
41 
42 /*
43  * Define if arch has non-standard setup.  This is a _PCI_ standard
44  * not a legacy or ISA standard.
45  */
46 #ifdef CONFIG_ATA_NONSTANDARD
47 #include <asm/libata-portmap.h>
48 #else
49 #include <asm-generic/libata-portmap.h>
50 #endif
51 
52 /*
53  * compile-time options: to be removed as soon as all the drivers are
54  * converted to the new debugging mechanism
55  */
56 #undef ATA_DEBUG		/* debugging output */
57 #undef ATA_VERBOSE_DEBUG	/* yet more debugging output */
58 #undef ATA_IRQ_TRAP		/* define to ack screaming irqs */
59 #undef ATA_NDEBUG		/* define to disable quick runtime checks */
60 
61 
62 /* note: prints function name for you */
63 #ifdef ATA_DEBUG
64 #define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __func__, ## args)
65 #ifdef ATA_VERBOSE_DEBUG
66 #define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __func__, ## args)
67 #else
68 #define VPRINTK(fmt, args...)
69 #endif	/* ATA_VERBOSE_DEBUG */
70 #else
71 #define DPRINTK(fmt, args...)
72 #define VPRINTK(fmt, args...)
73 #endif	/* ATA_DEBUG */
74 
75 #define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __func__, ## args)
76 
77 /* NEW: debug levels */
78 #define HAVE_LIBATA_MSG 1
79 
80 enum {
81 	ATA_MSG_DRV	= 0x0001,
82 	ATA_MSG_INFO	= 0x0002,
83 	ATA_MSG_PROBE	= 0x0004,
84 	ATA_MSG_WARN	= 0x0008,
85 	ATA_MSG_MALLOC	= 0x0010,
86 	ATA_MSG_CTL	= 0x0020,
87 	ATA_MSG_INTR	= 0x0040,
88 	ATA_MSG_ERR	= 0x0080,
89 };
90 
91 #define ata_msg_drv(p)    ((p)->msg_enable & ATA_MSG_DRV)
92 #define ata_msg_info(p)   ((p)->msg_enable & ATA_MSG_INFO)
93 #define ata_msg_probe(p)  ((p)->msg_enable & ATA_MSG_PROBE)
94 #define ata_msg_warn(p)   ((p)->msg_enable & ATA_MSG_WARN)
95 #define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC)
96 #define ata_msg_ctl(p)    ((p)->msg_enable & ATA_MSG_CTL)
97 #define ata_msg_intr(p)   ((p)->msg_enable & ATA_MSG_INTR)
98 #define ata_msg_err(p)    ((p)->msg_enable & ATA_MSG_ERR)
99 
100 static inline u32 ata_msg_init(int dval, int default_msg_enable_bits)
101 {
102 	if (dval < 0 || dval >= (sizeof(u32) * 8))
103 		return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */
104 	if (!dval)
105 		return 0;
106 	return (1 << dval) - 1;
107 }
108 
109 /* defines only for the constants which don't work well as enums */
110 #define ATA_TAG_POISON		0xfafbfcfdU
111 
112 enum {
113 	/* various global constants */
114 	LIBATA_MAX_PRD		= ATA_MAX_PRD / 2,
115 	LIBATA_DUMB_MAX_PRD	= ATA_MAX_PRD / 4,	/* Worst case */
116 	ATA_DEF_QUEUE		= 1,
117 	/* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
118 	ATA_MAX_QUEUE		= 32,
119 	ATA_TAG_INTERNAL	= ATA_MAX_QUEUE - 1,
120 	ATA_SHORT_PAUSE		= 16,
121 
122 	ATAPI_MAX_DRAIN		= 16 << 10,
123 
124 	ATA_ALL_DEVICES		= (1 << ATA_MAX_DEVICES) - 1,
125 
126 	ATA_SHT_EMULATED	= 1,
127 	ATA_SHT_CMD_PER_LUN	= 1,
128 	ATA_SHT_THIS_ID		= -1,
129 	ATA_SHT_USE_CLUSTERING	= 1,
130 
131 	/* struct ata_device stuff */
132 	ATA_DFLAG_LBA		= (1 << 0), /* device supports LBA */
133 	ATA_DFLAG_LBA48		= (1 << 1), /* device supports LBA48 */
134 	ATA_DFLAG_CDB_INTR	= (1 << 2), /* device asserts INTRQ when ready for CDB */
135 	ATA_DFLAG_NCQ		= (1 << 3), /* device supports NCQ */
136 	ATA_DFLAG_FLUSH_EXT	= (1 << 4), /* do FLUSH_EXT instead of FLUSH */
137 	ATA_DFLAG_ACPI_PENDING	= (1 << 5), /* ACPI resume action pending */
138 	ATA_DFLAG_ACPI_FAILED	= (1 << 6), /* ACPI on devcfg has failed */
139 	ATA_DFLAG_AN		= (1 << 7), /* AN configured */
140 	ATA_DFLAG_HIPM		= (1 << 8), /* device supports HIPM */
141 	ATA_DFLAG_DIPM		= (1 << 9), /* device supports DIPM */
142 	ATA_DFLAG_DMADIR	= (1 << 10), /* device requires DMADIR */
143 	ATA_DFLAG_CFG_MASK	= (1 << 12) - 1,
144 
145 	ATA_DFLAG_PIO		= (1 << 12), /* device limited to PIO mode */
146 	ATA_DFLAG_NCQ_OFF	= (1 << 13), /* device limited to non-NCQ mode */
147 	ATA_DFLAG_SLEEPING	= (1 << 15), /* device is sleeping */
148 	ATA_DFLAG_DUBIOUS_XFER	= (1 << 16), /* data transfer not verified */
149 	ATA_DFLAG_NO_UNLOAD	= (1 << 17), /* device doesn't support unload */
150 	ATA_DFLAG_UNLOCK_HPA	= (1 << 18), /* unlock HPA */
151 	ATA_DFLAG_INIT_MASK	= (1 << 24) - 1,
152 
153 	ATA_DFLAG_DETACH	= (1 << 24),
154 	ATA_DFLAG_DETACHED	= (1 << 25),
155 
156 	ATA_DEV_UNKNOWN		= 0,	/* unknown device */
157 	ATA_DEV_ATA		= 1,	/* ATA device */
158 	ATA_DEV_ATA_UNSUP	= 2,	/* ATA device (unsupported) */
159 	ATA_DEV_ATAPI		= 3,	/* ATAPI device */
160 	ATA_DEV_ATAPI_UNSUP	= 4,	/* ATAPI device (unsupported) */
161 	ATA_DEV_PMP		= 5,	/* SATA port multiplier */
162 	ATA_DEV_PMP_UNSUP	= 6,	/* SATA port multiplier (unsupported) */
163 	ATA_DEV_SEMB		= 7,	/* SEMB */
164 	ATA_DEV_SEMB_UNSUP	= 8,	/* SEMB (unsupported) */
165 	ATA_DEV_NONE		= 9,	/* no device */
166 
167 	/* struct ata_link flags */
168 	ATA_LFLAG_NO_HRST	= (1 << 1), /* avoid hardreset */
169 	ATA_LFLAG_NO_SRST	= (1 << 2), /* avoid softreset */
170 	ATA_LFLAG_ASSUME_ATA	= (1 << 3), /* assume ATA class */
171 	ATA_LFLAG_ASSUME_SEMB	= (1 << 4), /* assume SEMB class */
172 	ATA_LFLAG_ASSUME_CLASS	= ATA_LFLAG_ASSUME_ATA | ATA_LFLAG_ASSUME_SEMB,
173 	ATA_LFLAG_NO_RETRY	= (1 << 5), /* don't retry this link */
174 	ATA_LFLAG_DISABLED	= (1 << 6), /* link is disabled */
175 	ATA_LFLAG_SW_ACTIVITY	= (1 << 7), /* keep activity stats */
176 	ATA_LFLAG_NO_LPM	= (1 << 8), /* disable LPM on this link */
177 
178 	/* struct ata_port flags */
179 	ATA_FLAG_SLAVE_POSS	= (1 << 0), /* host supports slave dev */
180 					    /* (doesn't imply presence) */
181 	ATA_FLAG_SATA		= (1 << 1),
182 	ATA_FLAG_NO_ATAPI	= (1 << 6), /* No ATAPI support */
183 	ATA_FLAG_PIO_DMA	= (1 << 7), /* PIO cmds via DMA */
184 	ATA_FLAG_PIO_LBA48	= (1 << 8), /* Host DMA engine is LBA28 only */
185 	ATA_FLAG_PIO_POLLING	= (1 << 9), /* use polling PIO if LLD
186 					     * doesn't handle PIO interrupts */
187 	ATA_FLAG_NCQ		= (1 << 10), /* host supports NCQ */
188 	ATA_FLAG_NO_POWEROFF_SPINDOWN = (1 << 11), /* don't spindown before poweroff */
189 	ATA_FLAG_NO_HIBERNATE_SPINDOWN = (1 << 12), /* don't spindown before hibernation */
190 	ATA_FLAG_DEBUGMSG	= (1 << 13),
191 	ATA_FLAG_FPDMA_AA		= (1 << 14), /* driver supports Auto-Activate */
192 	ATA_FLAG_IGN_SIMPLEX	= (1 << 15), /* ignore SIMPLEX */
193 	ATA_FLAG_NO_IORDY	= (1 << 16), /* controller lacks iordy */
194 	ATA_FLAG_ACPI_SATA	= (1 << 17), /* need native SATA ACPI layout */
195 	ATA_FLAG_AN		= (1 << 18), /* controller supports AN */
196 	ATA_FLAG_PMP		= (1 << 19), /* controller supports PMP */
197 	ATA_FLAG_EM		= (1 << 21), /* driver supports enclosure
198 					      * management */
199 	ATA_FLAG_SW_ACTIVITY	= (1 << 22), /* driver supports sw activity
200 					      * led */
201 
202 	/* bits 24:31 of ap->flags are reserved for LLD specific flags */
203 
204 
205 	/* struct ata_port pflags */
206 	ATA_PFLAG_EH_PENDING	= (1 << 0), /* EH pending */
207 	ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */
208 	ATA_PFLAG_FROZEN	= (1 << 2), /* port is frozen */
209 	ATA_PFLAG_RECOVERED	= (1 << 3), /* recovery action performed */
210 	ATA_PFLAG_LOADING	= (1 << 4), /* boot/loading probe */
211 	ATA_PFLAG_SCSI_HOTPLUG	= (1 << 6), /* SCSI hotplug scheduled */
212 	ATA_PFLAG_INITIALIZING	= (1 << 7), /* being initialized, don't touch */
213 	ATA_PFLAG_RESETTING	= (1 << 8), /* reset in progress */
214 	ATA_PFLAG_UNLOADING	= (1 << 9), /* driver is being unloaded */
215 	ATA_PFLAG_UNLOADED	= (1 << 10), /* driver is unloaded */
216 
217 	ATA_PFLAG_SUSPENDED	= (1 << 17), /* port is suspended (power) */
218 	ATA_PFLAG_PM_PENDING	= (1 << 18), /* PM operation pending */
219 	ATA_PFLAG_INIT_GTM_VALID = (1 << 19), /* initial gtm data valid */
220 
221 	ATA_PFLAG_PIO32		= (1 << 20),  /* 32bit PIO */
222 	ATA_PFLAG_PIO32CHANGE	= (1 << 21),  /* 32bit PIO can be turned on/off */
223 
224 	/* struct ata_queued_cmd flags */
225 	ATA_QCFLAG_ACTIVE	= (1 << 0), /* cmd not yet ack'd to scsi lyer */
226 	ATA_QCFLAG_DMAMAP	= (1 << 1), /* SG table is DMA mapped */
227 	ATA_QCFLAG_IO		= (1 << 3), /* standard IO command */
228 	ATA_QCFLAG_RESULT_TF	= (1 << 4), /* result TF requested */
229 	ATA_QCFLAG_CLEAR_EXCL	= (1 << 5), /* clear excl_link on completion */
230 	ATA_QCFLAG_QUIET	= (1 << 6), /* don't report device error */
231 	ATA_QCFLAG_RETRY	= (1 << 7), /* retry after failure */
232 
233 	ATA_QCFLAG_FAILED	= (1 << 16), /* cmd failed and is owned by EH */
234 	ATA_QCFLAG_SENSE_VALID	= (1 << 17), /* sense data valid */
235 	ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
236 
237 	/* host set flags */
238 	ATA_HOST_SIMPLEX	= (1 << 0),	/* Host is simplex, one DMA channel per host only */
239 	ATA_HOST_STARTED	= (1 << 1),	/* Host started */
240 	ATA_HOST_PARALLEL_SCAN	= (1 << 2),	/* Ports on this host can be scanned in parallel */
241 
242 	/* bits 24:31 of host->flags are reserved for LLD specific flags */
243 
244 	/* various lengths of time */
245 	ATA_TMOUT_BOOT		= 30000,	/* heuristic */
246 	ATA_TMOUT_BOOT_QUICK	=  7000,	/* heuristic */
247 	ATA_TMOUT_INTERNAL_QUICK = 5000,
248 	ATA_TMOUT_MAX_PARK	= 30000,
249 
250 	/*
251 	 * GoVault needs 2s and iVDR disk HHD424020F7SV00 800ms.  2s
252 	 * is too much without parallel probing.  Use 2s if parallel
253 	 * probing is available, 800ms otherwise.
254 	 */
255 	ATA_TMOUT_FF_WAIT_LONG	=  2000,
256 	ATA_TMOUT_FF_WAIT	=   800,
257 
258 	/* Spec mandates to wait for ">= 2ms" before checking status
259 	 * after reset.  We wait 150ms, because that was the magic
260 	 * delay used for ATAPI devices in Hale Landis's ATADRVR, for
261 	 * the period of time between when the ATA command register is
262 	 * written, and then status is checked.  Because waiting for
263 	 * "a while" before checking status is fine, post SRST, we
264 	 * perform this magic delay here as well.
265 	 *
266 	 * Old drivers/ide uses the 2mS rule and then waits for ready.
267 	 */
268 	ATA_WAIT_AFTER_RESET	=  150,
269 
270 	/* If PMP is supported, we have to do follow-up SRST.  As some
271 	 * PMPs don't send D2H Reg FIS after hardreset, LLDs are
272 	 * advised to wait only for the following duration before
273 	 * doing SRST.
274 	 */
275 	ATA_TMOUT_PMP_SRST_WAIT	= 5000,
276 
277 	/* ATA bus states */
278 	BUS_UNKNOWN		= 0,
279 	BUS_DMA			= 1,
280 	BUS_IDLE		= 2,
281 	BUS_NOINTR		= 3,
282 	BUS_NODATA		= 4,
283 	BUS_TIMER		= 5,
284 	BUS_PIO			= 6,
285 	BUS_EDD			= 7,
286 	BUS_IDENTIFY		= 8,
287 	BUS_PACKET		= 9,
288 
289 	/* SATA port states */
290 	PORT_UNKNOWN		= 0,
291 	PORT_ENABLED		= 1,
292 	PORT_DISABLED		= 2,
293 
294 	/* encoding various smaller bitmaps into a single
295 	 * unsigned long bitmap
296 	 */
297 	ATA_NR_PIO_MODES	= 7,
298 	ATA_NR_MWDMA_MODES	= 5,
299 	ATA_NR_UDMA_MODES	= 8,
300 
301 	ATA_SHIFT_PIO		= 0,
302 	ATA_SHIFT_MWDMA		= ATA_SHIFT_PIO + ATA_NR_PIO_MODES,
303 	ATA_SHIFT_UDMA		= ATA_SHIFT_MWDMA + ATA_NR_MWDMA_MODES,
304 
305 	/* size of buffer to pad xfers ending on unaligned boundaries */
306 	ATA_DMA_PAD_SZ		= 4,
307 
308 	/* ering size */
309 	ATA_ERING_SIZE		= 32,
310 
311 	/* return values for ->qc_defer */
312 	ATA_DEFER_LINK		= 1,
313 	ATA_DEFER_PORT		= 2,
314 
315 	/* desc_len for ata_eh_info and context */
316 	ATA_EH_DESC_LEN		= 80,
317 
318 	/* reset / recovery action types */
319 	ATA_EH_REVALIDATE	= (1 << 0),
320 	ATA_EH_SOFTRESET	= (1 << 1), /* meaningful only in ->prereset */
321 	ATA_EH_HARDRESET	= (1 << 2), /* meaningful only in ->prereset */
322 	ATA_EH_RESET		= ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
323 	ATA_EH_ENABLE_LINK	= (1 << 3),
324 	ATA_EH_PARK		= (1 << 5), /* unload heads and stop I/O */
325 
326 	ATA_EH_PERDEV_MASK	= ATA_EH_REVALIDATE | ATA_EH_PARK,
327 	ATA_EH_ALL_ACTIONS	= ATA_EH_REVALIDATE | ATA_EH_RESET |
328 				  ATA_EH_ENABLE_LINK,
329 
330 	/* ata_eh_info->flags */
331 	ATA_EHI_HOTPLUGGED	= (1 << 0),  /* could have been hotplugged */
332 	ATA_EHI_NO_AUTOPSY	= (1 << 2),  /* no autopsy */
333 	ATA_EHI_QUIET		= (1 << 3),  /* be quiet */
334 	ATA_EHI_NO_RECOVERY	= (1 << 4),  /* no recovery */
335 
336 	ATA_EHI_DID_SOFTRESET	= (1 << 16), /* already soft-reset this port */
337 	ATA_EHI_DID_HARDRESET	= (1 << 17), /* already soft-reset this port */
338 	ATA_EHI_PRINTINFO	= (1 << 18), /* print configuration info */
339 	ATA_EHI_SETMODE		= (1 << 19), /* configure transfer mode */
340 	ATA_EHI_POST_SETMODE	= (1 << 20), /* revalidating after setmode */
341 
342 	ATA_EHI_DID_RESET	= ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
343 
344 	/* mask of flags to transfer *to* the slave link */
345 	ATA_EHI_TO_SLAVE_MASK	= ATA_EHI_NO_AUTOPSY | ATA_EHI_QUIET,
346 
347 	/* max tries if error condition is still set after ->error_handler */
348 	ATA_EH_MAX_TRIES	= 5,
349 
350 	/* sometimes resuming a link requires several retries */
351 	ATA_LINK_RESUME_TRIES	= 5,
352 
353 	/* how hard are we gonna try to probe/recover devices */
354 	ATA_PROBE_MAX_TRIES	= 3,
355 	ATA_EH_DEV_TRIES	= 3,
356 	ATA_EH_PMP_TRIES	= 5,
357 	ATA_EH_PMP_LINK_TRIES	= 3,
358 
359 	SATA_PMP_RW_TIMEOUT	= 3000,		/* PMP read/write timeout */
360 
361 	/* This should match the actual table size of
362 	 * ata_eh_cmd_timeout_table in libata-eh.c.
363 	 */
364 	ATA_EH_CMD_TIMEOUT_TABLE_SIZE = 6,
365 
366 	/* Horkage types. May be set by libata or controller on drives
367 	   (some horkage may be drive/controller pair dependent */
368 
369 	ATA_HORKAGE_DIAGNOSTIC	= (1 << 0),	/* Failed boot diag */
370 	ATA_HORKAGE_NODMA	= (1 << 1),	/* DMA problems */
371 	ATA_HORKAGE_NONCQ	= (1 << 2),	/* Don't use NCQ */
372 	ATA_HORKAGE_MAX_SEC_128	= (1 << 3),	/* Limit max sects to 128 */
373 	ATA_HORKAGE_BROKEN_HPA	= (1 << 4),	/* Broken HPA */
374 	ATA_HORKAGE_DISABLE	= (1 << 5),	/* Disable it */
375 	ATA_HORKAGE_HPA_SIZE	= (1 << 6),	/* native size off by one */
376 	ATA_HORKAGE_IVB		= (1 << 8),	/* cbl det validity bit bugs */
377 	ATA_HORKAGE_STUCK_ERR	= (1 << 9),	/* stuck ERR on next PACKET */
378 	ATA_HORKAGE_BRIDGE_OK	= (1 << 10),	/* no bridge limits */
379 	ATA_HORKAGE_ATAPI_MOD16_DMA = (1 << 11), /* use ATAPI DMA for commands
380 						    not multiple of 16 bytes */
381 	ATA_HORKAGE_FIRMWARE_WARN = (1 << 12),	/* firmware update warning */
382 	ATA_HORKAGE_1_5_GBPS	= (1 << 13),	/* force 1.5 Gbps */
383 	ATA_HORKAGE_NOSETXFER	= (1 << 14),	/* skip SETXFER, SATA only */
384 	ATA_HORKAGE_BROKEN_FPDMA_AA	= (1 << 15),	/* skip AA */
385 	ATA_HORKAGE_DUMP_ID	= (1 << 16),	/* dump IDENTIFY data */
386 
387 	 /* DMA mask for user DMA control: User visible values; DO NOT
388 	    renumber */
389 	ATA_DMA_MASK_ATA	= (1 << 0),	/* DMA on ATA Disk */
390 	ATA_DMA_MASK_ATAPI	= (1 << 1),	/* DMA on ATAPI */
391 	ATA_DMA_MASK_CFA	= (1 << 2),	/* DMA on CF Card */
392 
393 	/* ATAPI command types */
394 	ATAPI_READ		= 0,		/* READs */
395 	ATAPI_WRITE		= 1,		/* WRITEs */
396 	ATAPI_READ_CD		= 2,		/* READ CD [MSF] */
397 	ATAPI_PASS_THRU		= 3,		/* SAT pass-thru */
398 	ATAPI_MISC		= 4,		/* the rest */
399 
400 	/* Timing constants */
401 	ATA_TIMING_SETUP	= (1 << 0),
402 	ATA_TIMING_ACT8B	= (1 << 1),
403 	ATA_TIMING_REC8B	= (1 << 2),
404 	ATA_TIMING_CYC8B	= (1 << 3),
405 	ATA_TIMING_8BIT		= ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
406 				  ATA_TIMING_CYC8B,
407 	ATA_TIMING_ACTIVE	= (1 << 4),
408 	ATA_TIMING_RECOVER	= (1 << 5),
409 	ATA_TIMING_DMACK_HOLD	= (1 << 6),
410 	ATA_TIMING_CYCLE	= (1 << 7),
411 	ATA_TIMING_UDMA		= (1 << 8),
412 	ATA_TIMING_ALL		= ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
413 				  ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
414 				  ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
415 				  ATA_TIMING_DMACK_HOLD | ATA_TIMING_CYCLE |
416 				  ATA_TIMING_UDMA,
417 
418 	/* ACPI constants */
419 	ATA_ACPI_FILTER_SETXFER	= 1 << 0,
420 	ATA_ACPI_FILTER_LOCK	= 1 << 1,
421 	ATA_ACPI_FILTER_DIPM	= 1 << 2,
422 	ATA_ACPI_FILTER_FPDMA_OFFSET = 1 << 3,	/* FPDMA non-zero offset */
423 	ATA_ACPI_FILTER_FPDMA_AA = 1 << 4,	/* FPDMA auto activate */
424 
425 	ATA_ACPI_FILTER_DEFAULT	= ATA_ACPI_FILTER_SETXFER |
426 				  ATA_ACPI_FILTER_LOCK |
427 				  ATA_ACPI_FILTER_DIPM,
428 };
429 
430 enum ata_xfer_mask {
431 	ATA_MASK_PIO		= ((1LU << ATA_NR_PIO_MODES) - 1)
432 					<< ATA_SHIFT_PIO,
433 	ATA_MASK_MWDMA		= ((1LU << ATA_NR_MWDMA_MODES) - 1)
434 					<< ATA_SHIFT_MWDMA,
435 	ATA_MASK_UDMA		= ((1LU << ATA_NR_UDMA_MODES) - 1)
436 					<< ATA_SHIFT_UDMA,
437 };
438 
439 enum hsm_task_states {
440 	HSM_ST_IDLE,		/* no command on going */
441 	HSM_ST_FIRST,		/* (waiting the device to)
442 				   write CDB or first data block */
443 	HSM_ST,			/* (waiting the device to) transfer data */
444 	HSM_ST_LAST,		/* (waiting the device to) complete command */
445 	HSM_ST_ERR,		/* error */
446 };
447 
448 enum ata_completion_errors {
449 	AC_ERR_DEV		= (1 << 0), /* device reported error */
450 	AC_ERR_HSM		= (1 << 1), /* host state machine violation */
451 	AC_ERR_TIMEOUT		= (1 << 2), /* timeout */
452 	AC_ERR_MEDIA		= (1 << 3), /* media error */
453 	AC_ERR_ATA_BUS		= (1 << 4), /* ATA bus error */
454 	AC_ERR_HOST_BUS		= (1 << 5), /* host bus error */
455 	AC_ERR_SYSTEM		= (1 << 6), /* system error */
456 	AC_ERR_INVALID		= (1 << 7), /* invalid argument */
457 	AC_ERR_OTHER		= (1 << 8), /* unknown */
458 	AC_ERR_NODEV_HINT	= (1 << 9), /* polling device detection hint */
459 	AC_ERR_NCQ		= (1 << 10), /* marker for offending NCQ qc */
460 };
461 
462 /*
463  * Link power management policy: If you alter this, you also need to
464  * alter libata-scsi.c (for the ascii descriptions)
465  */
466 enum ata_lpm_policy {
467 	ATA_LPM_UNKNOWN,
468 	ATA_LPM_MAX_POWER,
469 	ATA_LPM_MED_POWER,
470 	ATA_LPM_MIN_POWER,
471 };
472 
473 enum ata_lpm_hints {
474 	ATA_LPM_EMPTY		= (1 << 0), /* port empty/probing */
475 	ATA_LPM_HIPM		= (1 << 1), /* may use HIPM */
476 };
477 
478 /* forward declarations */
479 struct scsi_device;
480 struct ata_port_operations;
481 struct ata_port;
482 struct ata_link;
483 struct ata_queued_cmd;
484 
485 /* typedefs */
486 typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
487 typedef int (*ata_prereset_fn_t)(struct ata_link *link, unsigned long deadline);
488 typedef int (*ata_reset_fn_t)(struct ata_link *link, unsigned int *classes,
489 			      unsigned long deadline);
490 typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes);
491 
492 extern struct device_attribute dev_attr_link_power_management_policy;
493 extern struct device_attribute dev_attr_unload_heads;
494 extern struct device_attribute dev_attr_em_message_type;
495 extern struct device_attribute dev_attr_em_message;
496 extern struct device_attribute dev_attr_sw_activity;
497 
498 enum sw_activity {
499 	OFF,
500 	BLINK_ON,
501 	BLINK_OFF,
502 };
503 
504 #ifdef CONFIG_ATA_SFF
505 struct ata_ioports {
506 	void __iomem		*cmd_addr;
507 	void __iomem		*data_addr;
508 	void __iomem		*error_addr;
509 	void __iomem		*feature_addr;
510 	void __iomem		*nsect_addr;
511 	void __iomem		*lbal_addr;
512 	void __iomem		*lbam_addr;
513 	void __iomem		*lbah_addr;
514 	void __iomem		*device_addr;
515 	void __iomem		*status_addr;
516 	void __iomem		*command_addr;
517 	void __iomem		*altstatus_addr;
518 	void __iomem		*ctl_addr;
519 #ifdef CONFIG_ATA_BMDMA
520 	void __iomem		*bmdma_addr;
521 #endif /* CONFIG_ATA_BMDMA */
522 	void __iomem		*scr_addr;
523 };
524 #endif /* CONFIG_ATA_SFF */
525 
526 struct ata_host {
527 	spinlock_t		lock;
528 	struct device 		*dev;
529 	void __iomem * const	*iomap;
530 	unsigned int		n_ports;
531 	void			*private_data;
532 	struct ata_port_operations *ops;
533 	unsigned long		flags;
534 
535 	struct mutex		eh_mutex;
536 	struct task_struct	*eh_owner;
537 
538 #ifdef CONFIG_ATA_ACPI
539 	acpi_handle		acpi_handle;
540 #endif
541 	struct ata_port		*simplex_claimed;	/* channel owning the DMA */
542 	struct ata_port		*ports[0];
543 };
544 
545 struct ata_queued_cmd {
546 	struct ata_port		*ap;
547 	struct ata_device	*dev;
548 
549 	struct scsi_cmnd	*scsicmd;
550 	void			(*scsidone)(struct scsi_cmnd *);
551 
552 	struct ata_taskfile	tf;
553 	u8			cdb[ATAPI_CDB_LEN];
554 
555 	unsigned long		flags;		/* ATA_QCFLAG_xxx */
556 	unsigned int		tag;
557 	unsigned int		n_elem;
558 	unsigned int		orig_n_elem;
559 
560 	int			dma_dir;
561 
562 	unsigned int		sect_size;
563 
564 	unsigned int		nbytes;
565 	unsigned int		extrabytes;
566 	unsigned int		curbytes;
567 
568 	struct scatterlist	sgent;
569 
570 	struct scatterlist	*sg;
571 
572 	struct scatterlist	*cursg;
573 	unsigned int		cursg_ofs;
574 
575 	unsigned int		err_mask;
576 	struct ata_taskfile	result_tf;
577 	ata_qc_cb_t		complete_fn;
578 
579 	void			*private_data;
580 	void			*lldd_task;
581 };
582 
583 struct ata_port_stats {
584 	unsigned long		unhandled_irq;
585 	unsigned long		idle_irq;
586 	unsigned long		rw_reqbuf;
587 };
588 
589 struct ata_ering_entry {
590 	unsigned int		eflags;
591 	unsigned int		err_mask;
592 	u64			timestamp;
593 };
594 
595 struct ata_ering {
596 	int			cursor;
597 	struct ata_ering_entry	ring[ATA_ERING_SIZE];
598 };
599 
600 struct ata_device {
601 	struct ata_link		*link;
602 	unsigned int		devno;		/* 0 or 1 */
603 	unsigned int		horkage;	/* List of broken features */
604 	unsigned long		flags;		/* ATA_DFLAG_xxx */
605 	struct scsi_device	*sdev;		/* attached SCSI device */
606 	void			*private_data;
607 #ifdef CONFIG_ATA_ACPI
608 	acpi_handle		acpi_handle;
609 	union acpi_object	*gtf_cache;
610 	unsigned int		gtf_filter;
611 #endif
612 	struct device		tdev;
613 	/* n_sector is CLEAR_BEGIN, read comment above CLEAR_BEGIN */
614 	u64			n_sectors;	/* size of device, if ATA */
615 	u64			n_native_sectors; /* native size, if ATA */
616 	unsigned int		class;		/* ATA_DEV_xxx */
617 	unsigned long		unpark_deadline;
618 
619 	u8			pio_mode;
620 	u8			dma_mode;
621 	u8			xfer_mode;
622 	unsigned int		xfer_shift;	/* ATA_SHIFT_xxx */
623 
624 	unsigned int		multi_count;	/* sectors count for
625 						   READ/WRITE MULTIPLE */
626 	unsigned int		max_sectors;	/* per-device max sectors */
627 	unsigned int		cdb_len;
628 
629 	/* per-dev xfer mask */
630 	unsigned long		pio_mask;
631 	unsigned long		mwdma_mask;
632 	unsigned long		udma_mask;
633 
634 	/* for CHS addressing */
635 	u16			cylinders;	/* Number of cylinders */
636 	u16			heads;		/* Number of heads */
637 	u16			sectors;	/* Number of sectors per track */
638 
639 	union {
640 		u16		id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
641 		u32		gscr[SATA_PMP_GSCR_DWORDS]; /* PMP GSCR block */
642 	};
643 
644 	/* error history */
645 	int			spdn_cnt;
646 	/* ering is CLEAR_END, read comment above CLEAR_END */
647 	struct ata_ering	ering;
648 };
649 
650 /* Fields between ATA_DEVICE_CLEAR_BEGIN and ATA_DEVICE_CLEAR_END are
651  * cleared to zero on ata_dev_init().
652  */
653 #define ATA_DEVICE_CLEAR_BEGIN		offsetof(struct ata_device, n_sectors)
654 #define ATA_DEVICE_CLEAR_END		offsetof(struct ata_device, ering)
655 
656 struct ata_eh_info {
657 	struct ata_device	*dev;		/* offending device */
658 	u32			serror;		/* SError from LLDD */
659 	unsigned int		err_mask;	/* port-wide err_mask */
660 	unsigned int		action;		/* ATA_EH_* action mask */
661 	unsigned int		dev_action[ATA_MAX_DEVICES]; /* dev EH action */
662 	unsigned int		flags;		/* ATA_EHI_* flags */
663 
664 	unsigned int		probe_mask;
665 
666 	char			desc[ATA_EH_DESC_LEN];
667 	int			desc_len;
668 };
669 
670 struct ata_eh_context {
671 	struct ata_eh_info	i;
672 	int			tries[ATA_MAX_DEVICES];
673 	int			cmd_timeout_idx[ATA_MAX_DEVICES]
674 					       [ATA_EH_CMD_TIMEOUT_TABLE_SIZE];
675 	unsigned int		classes[ATA_MAX_DEVICES];
676 	unsigned int		did_probe_mask;
677 	unsigned int		unloaded_mask;
678 	unsigned int		saved_ncq_enabled;
679 	u8			saved_xfer_mode[ATA_MAX_DEVICES];
680 	/* timestamp for the last reset attempt or success */
681 	unsigned long		last_reset;
682 };
683 
684 struct ata_acpi_drive
685 {
686 	u32 pio;
687 	u32 dma;
688 } __packed;
689 
690 struct ata_acpi_gtm {
691 	struct ata_acpi_drive drive[2];
692 	u32 flags;
693 } __packed;
694 
695 struct ata_link {
696 	struct ata_port		*ap;
697 	int			pmp;		/* port multiplier port # */
698 
699 	struct device		tdev;
700 	unsigned int		active_tag;	/* active tag on this link */
701 	u32			sactive;	/* active NCQ commands */
702 
703 	unsigned int		flags;		/* ATA_LFLAG_xxx */
704 
705 	u32			saved_scontrol;	/* SControl on probe */
706 	unsigned int		hw_sata_spd_limit;
707 	unsigned int		sata_spd_limit;
708 	unsigned int		sata_spd;	/* current SATA PHY speed */
709 	enum ata_lpm_policy	lpm_policy;
710 
711 	/* record runtime error info, protected by host_set lock */
712 	struct ata_eh_info	eh_info;
713 	/* EH context */
714 	struct ata_eh_context	eh_context;
715 
716 	struct ata_device	device[ATA_MAX_DEVICES];
717 };
718 #define ATA_LINK_CLEAR_BEGIN		offsetof(struct ata_link, active_tag)
719 #define ATA_LINK_CLEAR_END		offsetof(struct ata_link, device[0])
720 
721 struct ata_port {
722 	struct Scsi_Host	*scsi_host; /* our co-allocated scsi host */
723 	struct ata_port_operations *ops;
724 	spinlock_t		*lock;
725 	/* Flags owned by the EH context. Only EH should touch these once the
726 	   port is active */
727 	unsigned long		flags;	/* ATA_FLAG_xxx */
728 	/* Flags that change dynamically, protected by ap->lock */
729 	unsigned int		pflags; /* ATA_PFLAG_xxx */
730 	unsigned int		print_id; /* user visible unique port ID */
731 	unsigned int		port_no; /* 0 based port no. inside the host */
732 
733 #ifdef CONFIG_ATA_SFF
734 	struct ata_ioports	ioaddr;	/* ATA cmd/ctl/dma register blocks */
735 	u8			ctl;	/* cache of ATA control register */
736 	u8			last_ctl;	/* Cache last written value */
737 	struct ata_link*	sff_pio_task_link; /* link currently used */
738 	struct delayed_work	sff_pio_task;
739 #ifdef CONFIG_ATA_BMDMA
740 	struct ata_bmdma_prd	*bmdma_prd;	/* BMDMA SG list */
741 	dma_addr_t		bmdma_prd_dma;	/* and its DMA mapping */
742 #endif /* CONFIG_ATA_BMDMA */
743 #endif /* CONFIG_ATA_SFF */
744 
745 	unsigned int		pio_mask;
746 	unsigned int		mwdma_mask;
747 	unsigned int		udma_mask;
748 	unsigned int		cbl;	/* cable type; ATA_CBL_xxx */
749 
750 	struct ata_queued_cmd	qcmd[ATA_MAX_QUEUE];
751 	unsigned long		qc_allocated;
752 	unsigned int		qc_active;
753 	int			nr_active_links; /* #links with active qcs */
754 
755 	struct ata_link		link;		/* host default link */
756 	struct ata_link		*slave_link;	/* see ata_slave_link_init() */
757 
758 	int			nr_pmp_links;	/* nr of available PMP links */
759 	struct ata_link		*pmp_link;	/* array of PMP links */
760 	struct ata_link		*excl_link;	/* for PMP qc exclusion */
761 
762 	struct ata_port_stats	stats;
763 	struct ata_host		*host;
764 	struct device 		*dev;
765 	struct device		tdev;
766 
767 	struct mutex		scsi_scan_mutex;
768 	struct delayed_work	hotplug_task;
769 	struct work_struct	scsi_rescan_task;
770 
771 	unsigned int		hsm_task_state;
772 
773 	u32			msg_enable;
774 	struct list_head	eh_done_q;
775 	wait_queue_head_t	eh_wait_q;
776 	int			eh_tries;
777 	struct completion	park_req_pending;
778 
779 	pm_message_t		pm_mesg;
780 	int			*pm_result;
781 	enum ata_lpm_policy	target_lpm_policy;
782 
783 	struct timer_list	fastdrain_timer;
784 	unsigned long		fastdrain_cnt;
785 
786 	int			em_message_type;
787 	void			*private_data;
788 
789 #ifdef CONFIG_ATA_ACPI
790 	acpi_handle		acpi_handle;
791 	struct ata_acpi_gtm	__acpi_init_gtm; /* use ata_acpi_init_gtm() */
792 #endif
793 	/* owned by EH */
794 	u8			sector_buf[ATA_SECT_SIZE] ____cacheline_aligned;
795 };
796 
797 /* The following initializer overrides a method to NULL whether one of
798  * its parent has the method defined or not.  This is equivalent to
799  * ERR_PTR(-ENOENT).  Unfortunately, ERR_PTR doesn't render a constant
800  * expression and thus can't be used as an initializer.
801  */
802 #define ATA_OP_NULL		(void *)(unsigned long)(-ENOENT)
803 
804 struct ata_port_operations {
805 	/*
806 	 * Command execution
807 	 */
808 	int  (*qc_defer)(struct ata_queued_cmd *qc);
809 	int  (*check_atapi_dma)(struct ata_queued_cmd *qc);
810 	void (*qc_prep)(struct ata_queued_cmd *qc);
811 	unsigned int (*qc_issue)(struct ata_queued_cmd *qc);
812 	bool (*qc_fill_rtf)(struct ata_queued_cmd *qc);
813 
814 	/*
815 	 * Configuration and exception handling
816 	 */
817 	int  (*cable_detect)(struct ata_port *ap);
818 	unsigned long (*mode_filter)(struct ata_device *dev, unsigned long xfer_mask);
819 	void (*set_piomode)(struct ata_port *ap, struct ata_device *dev);
820 	void (*set_dmamode)(struct ata_port *ap, struct ata_device *dev);
821 	int  (*set_mode)(struct ata_link *link, struct ata_device **r_failed_dev);
822 	unsigned int (*read_id)(struct ata_device *dev, struct ata_taskfile *tf, u16 *id);
823 
824 	void (*dev_config)(struct ata_device *dev);
825 
826 	void (*freeze)(struct ata_port *ap);
827 	void (*thaw)(struct ata_port *ap);
828 	ata_prereset_fn_t	prereset;
829 	ata_reset_fn_t		softreset;
830 	ata_reset_fn_t		hardreset;
831 	ata_postreset_fn_t	postreset;
832 	ata_prereset_fn_t	pmp_prereset;
833 	ata_reset_fn_t		pmp_softreset;
834 	ata_reset_fn_t		pmp_hardreset;
835 	ata_postreset_fn_t	pmp_postreset;
836 	void (*error_handler)(struct ata_port *ap);
837 	void (*lost_interrupt)(struct ata_port *ap);
838 	void (*post_internal_cmd)(struct ata_queued_cmd *qc);
839 
840 	/*
841 	 * Optional features
842 	 */
843 	int  (*scr_read)(struct ata_link *link, unsigned int sc_reg, u32 *val);
844 	int  (*scr_write)(struct ata_link *link, unsigned int sc_reg, u32 val);
845 	void (*pmp_attach)(struct ata_port *ap);
846 	void (*pmp_detach)(struct ata_port *ap);
847 	int  (*set_lpm)(struct ata_link *link, enum ata_lpm_policy policy,
848 			unsigned hints);
849 
850 	/*
851 	 * Start, stop, suspend and resume
852 	 */
853 	int  (*port_suspend)(struct ata_port *ap, pm_message_t mesg);
854 	int  (*port_resume)(struct ata_port *ap);
855 	int  (*port_start)(struct ata_port *ap);
856 	void (*port_stop)(struct ata_port *ap);
857 	void (*host_stop)(struct ata_host *host);
858 
859 #ifdef CONFIG_ATA_SFF
860 	/*
861 	 * SFF / taskfile oriented ops
862 	 */
863 	void (*sff_dev_select)(struct ata_port *ap, unsigned int device);
864 	void (*sff_set_devctl)(struct ata_port *ap, u8 ctl);
865 	u8   (*sff_check_status)(struct ata_port *ap);
866 	u8   (*sff_check_altstatus)(struct ata_port *ap);
867 	void (*sff_tf_load)(struct ata_port *ap, const struct ata_taskfile *tf);
868 	void (*sff_tf_read)(struct ata_port *ap, struct ata_taskfile *tf);
869 	void (*sff_exec_command)(struct ata_port *ap,
870 				 const struct ata_taskfile *tf);
871 	unsigned int (*sff_data_xfer)(struct ata_device *dev,
872 			unsigned char *buf, unsigned int buflen, int rw);
873 	void (*sff_irq_on)(struct ata_port *);
874 	bool (*sff_irq_check)(struct ata_port *);
875 	void (*sff_irq_clear)(struct ata_port *);
876 	void (*sff_drain_fifo)(struct ata_queued_cmd *qc);
877 
878 #ifdef CONFIG_ATA_BMDMA
879 	void (*bmdma_setup)(struct ata_queued_cmd *qc);
880 	void (*bmdma_start)(struct ata_queued_cmd *qc);
881 	void (*bmdma_stop)(struct ata_queued_cmd *qc);
882 	u8   (*bmdma_status)(struct ata_port *ap);
883 #endif /* CONFIG_ATA_BMDMA */
884 #endif /* CONFIG_ATA_SFF */
885 
886 	ssize_t (*em_show)(struct ata_port *ap, char *buf);
887 	ssize_t (*em_store)(struct ata_port *ap, const char *message,
888 			    size_t size);
889 	ssize_t (*sw_activity_show)(struct ata_device *dev, char *buf);
890 	ssize_t (*sw_activity_store)(struct ata_device *dev,
891 				     enum sw_activity val);
892 	/*
893 	 * Obsolete
894 	 */
895 	void (*phy_reset)(struct ata_port *ap);
896 	void (*eng_timeout)(struct ata_port *ap);
897 
898 	/*
899 	 * ->inherits must be the last field and all the preceding
900 	 * fields must be pointers.
901 	 */
902 	const struct ata_port_operations	*inherits;
903 };
904 
905 struct ata_port_info {
906 	unsigned long		flags;
907 	unsigned long		link_flags;
908 	unsigned long		pio_mask;
909 	unsigned long		mwdma_mask;
910 	unsigned long		udma_mask;
911 	struct ata_port_operations *port_ops;
912 	void 			*private_data;
913 };
914 
915 struct ata_timing {
916 	unsigned short mode;		/* ATA mode */
917 	unsigned short setup;		/* t1 */
918 	unsigned short act8b;		/* t2 for 8-bit I/O */
919 	unsigned short rec8b;		/* t2i for 8-bit I/O */
920 	unsigned short cyc8b;		/* t0 for 8-bit I/O */
921 	unsigned short active;		/* t2 or tD */
922 	unsigned short recover;		/* t2i or tK */
923 	unsigned short dmack_hold;	/* tj */
924 	unsigned short cycle;		/* t0 */
925 	unsigned short udma;		/* t2CYCTYP/2 */
926 };
927 
928 /*
929  * Core layer - drivers/ata/libata-core.c
930  */
931 extern const unsigned long sata_deb_timing_normal[];
932 extern const unsigned long sata_deb_timing_hotplug[];
933 extern const unsigned long sata_deb_timing_long[];
934 
935 extern struct ata_port_operations ata_dummy_port_ops;
936 extern const struct ata_port_info ata_dummy_port_info;
937 
938 static inline const unsigned long *
939 sata_ehc_deb_timing(struct ata_eh_context *ehc)
940 {
941 	if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
942 		return sata_deb_timing_hotplug;
943 	else
944 		return sata_deb_timing_normal;
945 }
946 
947 static inline int ata_port_is_dummy(struct ata_port *ap)
948 {
949 	return ap->ops == &ata_dummy_port_ops;
950 }
951 
952 extern int sata_set_spd(struct ata_link *link);
953 extern int ata_std_prereset(struct ata_link *link, unsigned long deadline);
954 extern int ata_wait_after_reset(struct ata_link *link, unsigned long deadline,
955 				int (*check_ready)(struct ata_link *link));
956 extern int sata_link_debounce(struct ata_link *link,
957 			const unsigned long *params, unsigned long deadline);
958 extern int sata_link_resume(struct ata_link *link, const unsigned long *params,
959 			    unsigned long deadline);
960 extern int sata_link_scr_lpm(struct ata_link *link, enum ata_lpm_policy policy,
961 			     bool spm_wakeup);
962 extern int sata_link_hardreset(struct ata_link *link,
963 			const unsigned long *timing, unsigned long deadline,
964 			bool *online, int (*check_ready)(struct ata_link *));
965 extern int sata_std_hardreset(struct ata_link *link, unsigned int *class,
966 			      unsigned long deadline);
967 extern void ata_std_postreset(struct ata_link *link, unsigned int *classes);
968 
969 extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
970 extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
971 			const struct ata_port_info * const * ppi, int n_ports);
972 extern int ata_slave_link_init(struct ata_port *ap);
973 extern int ata_host_start(struct ata_host *host);
974 extern int ata_host_register(struct ata_host *host,
975 			     struct scsi_host_template *sht);
976 extern int ata_host_activate(struct ata_host *host, int irq,
977 			     irq_handler_t irq_handler, unsigned long irq_flags,
978 			     struct scsi_host_template *sht);
979 extern void ata_host_detach(struct ata_host *host);
980 extern void ata_host_init(struct ata_host *, struct device *,
981 			  unsigned long, struct ata_port_operations *);
982 extern int ata_scsi_detect(struct scsi_host_template *sht);
983 extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
984 extern int ata_scsi_queuecmd(struct Scsi_Host *h, struct scsi_cmnd *cmd);
985 extern int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *dev,
986 			    int cmd, void __user *arg);
987 extern void ata_sas_port_destroy(struct ata_port *);
988 extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
989 					   struct ata_port_info *, struct Scsi_Host *);
990 extern int ata_sas_port_init(struct ata_port *);
991 extern int ata_sas_port_start(struct ata_port *ap);
992 extern void ata_sas_port_stop(struct ata_port *ap);
993 extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
994 extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, struct ata_port *ap);
995 extern int sata_scr_valid(struct ata_link *link);
996 extern int sata_scr_read(struct ata_link *link, int reg, u32 *val);
997 extern int sata_scr_write(struct ata_link *link, int reg, u32 val);
998 extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val);
999 extern bool ata_link_online(struct ata_link *link);
1000 extern bool ata_link_offline(struct ata_link *link);
1001 #ifdef CONFIG_PM
1002 extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
1003 extern void ata_host_resume(struct ata_host *host);
1004 #endif
1005 extern int ata_ratelimit(void);
1006 extern void ata_msleep(struct ata_port *ap, unsigned int msecs);
1007 extern u32 ata_wait_register(struct ata_port *ap, void __iomem *reg, u32 mask,
1008 			u32 val, unsigned long interval, unsigned long timeout);
1009 extern int atapi_cmd_type(u8 opcode);
1010 extern void ata_tf_to_fis(const struct ata_taskfile *tf,
1011 			  u8 pmp, int is_cmd, u8 *fis);
1012 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
1013 extern unsigned long ata_pack_xfermask(unsigned long pio_mask,
1014 			unsigned long mwdma_mask, unsigned long udma_mask);
1015 extern void ata_unpack_xfermask(unsigned long xfer_mask,
1016 			unsigned long *pio_mask, unsigned long *mwdma_mask,
1017 			unsigned long *udma_mask);
1018 extern u8 ata_xfer_mask2mode(unsigned long xfer_mask);
1019 extern unsigned long ata_xfer_mode2mask(u8 xfer_mode);
1020 extern int ata_xfer_mode2shift(unsigned long xfer_mode);
1021 extern const char *ata_mode_string(unsigned long xfer_mask);
1022 extern unsigned long ata_id_xfermask(const u16 *id);
1023 extern int ata_std_qc_defer(struct ata_queued_cmd *qc);
1024 extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
1025 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
1026 		 unsigned int n_elem);
1027 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
1028 extern void ata_dev_disable(struct ata_device *adev);
1029 extern void ata_id_string(const u16 *id, unsigned char *s,
1030 			  unsigned int ofs, unsigned int len);
1031 extern void ata_id_c_string(const u16 *id, unsigned char *s,
1032 			    unsigned int ofs, unsigned int len);
1033 extern unsigned int ata_do_dev_read_id(struct ata_device *dev,
1034 					struct ata_taskfile *tf, u16 *id);
1035 extern void ata_qc_complete(struct ata_queued_cmd *qc);
1036 extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active);
1037 extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd);
1038 extern int ata_std_bios_param(struct scsi_device *sdev,
1039 			      struct block_device *bdev,
1040 			      sector_t capacity, int geom[]);
1041 extern void ata_scsi_unlock_native_capacity(struct scsi_device *sdev);
1042 extern int ata_scsi_slave_config(struct scsi_device *sdev);
1043 extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
1044 extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
1045 				       int queue_depth, int reason);
1046 extern struct ata_device *ata_dev_pair(struct ata_device *adev);
1047 extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
1048 extern void ata_scsi_port_error_handler(struct Scsi_Host *host, struct ata_port *ap);
1049 extern void ata_scsi_cmd_error_handler(struct Scsi_Host *host, struct ata_port *ap, struct list_head *eh_q);
1050 
1051 extern int ata_cable_40wire(struct ata_port *ap);
1052 extern int ata_cable_80wire(struct ata_port *ap);
1053 extern int ata_cable_sata(struct ata_port *ap);
1054 extern int ata_cable_ignore(struct ata_port *ap);
1055 extern int ata_cable_unknown(struct ata_port *ap);
1056 
1057 /* Timing helpers */
1058 extern unsigned int ata_pio_need_iordy(const struct ata_device *);
1059 extern const struct ata_timing *ata_timing_find_mode(u8 xfer_mode);
1060 extern int ata_timing_compute(struct ata_device *, unsigned short,
1061 			      struct ata_timing *, int, int);
1062 extern void ata_timing_merge(const struct ata_timing *,
1063 			     const struct ata_timing *, struct ata_timing *,
1064 			     unsigned int);
1065 extern u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle);
1066 
1067 /* PCI */
1068 #ifdef CONFIG_PCI
1069 struct pci_dev;
1070 
1071 struct pci_bits {
1072 	unsigned int		reg;	/* PCI config register to read */
1073 	unsigned int		width;	/* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
1074 	unsigned long		mask;
1075 	unsigned long		val;
1076 };
1077 
1078 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
1079 extern void ata_pci_remove_one(struct pci_dev *pdev);
1080 
1081 #ifdef CONFIG_PM
1082 extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
1083 extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
1084 extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
1085 extern int ata_pci_device_resume(struct pci_dev *pdev);
1086 #endif /* CONFIG_PM */
1087 #endif /* CONFIG_PCI */
1088 
1089 /*
1090  * ACPI - drivers/ata/libata-acpi.c
1091  */
1092 #ifdef CONFIG_ATA_ACPI
1093 static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1094 {
1095 	if (ap->pflags & ATA_PFLAG_INIT_GTM_VALID)
1096 		return &ap->__acpi_init_gtm;
1097 	return NULL;
1098 }
1099 int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm);
1100 int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *stm);
1101 unsigned long ata_acpi_gtm_xfermask(struct ata_device *dev,
1102 				    const struct ata_acpi_gtm *gtm);
1103 int ata_acpi_cbl_80wire(struct ata_port *ap, const struct ata_acpi_gtm *gtm);
1104 #else
1105 static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1106 {
1107 	return NULL;
1108 }
1109 
1110 static inline int ata_acpi_stm(const struct ata_port *ap,
1111 			       struct ata_acpi_gtm *stm)
1112 {
1113 	return -ENOSYS;
1114 }
1115 
1116 static inline int ata_acpi_gtm(const struct ata_port *ap,
1117 			       struct ata_acpi_gtm *stm)
1118 {
1119 	return -ENOSYS;
1120 }
1121 
1122 static inline unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev,
1123 					const struct ata_acpi_gtm *gtm)
1124 {
1125 	return 0;
1126 }
1127 
1128 static inline int ata_acpi_cbl_80wire(struct ata_port *ap,
1129 				      const struct ata_acpi_gtm *gtm)
1130 {
1131 	return 0;
1132 }
1133 #endif
1134 
1135 /*
1136  * EH - drivers/ata/libata-eh.c
1137  */
1138 extern void ata_port_schedule_eh(struct ata_port *ap);
1139 extern int ata_link_abort(struct ata_link *link);
1140 extern int ata_port_abort(struct ata_port *ap);
1141 extern int ata_port_freeze(struct ata_port *ap);
1142 extern int sata_async_notification(struct ata_port *ap);
1143 
1144 extern void ata_eh_freeze_port(struct ata_port *ap);
1145 extern void ata_eh_thaw_port(struct ata_port *ap);
1146 
1147 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
1148 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
1149 extern void ata_eh_analyze_ncq_error(struct ata_link *link);
1150 
1151 extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
1152 		      ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
1153 		      ata_postreset_fn_t postreset);
1154 extern void ata_std_error_handler(struct ata_port *ap);
1155 
1156 /*
1157  * Base operations to inherit from and initializers for sht
1158  *
1159  * Operations
1160  *
1161  * base  : Common to all libata drivers.
1162  * sata  : SATA controllers w/ native interface.
1163  * pmp   : SATA controllers w/ PMP support.
1164  * sff   : SFF ATA controllers w/o BMDMA support.
1165  * bmdma : SFF ATA controllers w/ BMDMA support.
1166  *
1167  * sht initializers
1168  *
1169  * BASE  : Common to all libata drivers.  The user must set
1170  *	   sg_tablesize and dma_boundary.
1171  * PIO   : SFF ATA controllers w/ only PIO support.
1172  * BMDMA : SFF ATA controllers w/ BMDMA support.  sg_tablesize and
1173  *	   dma_boundary are set to BMDMA limits.
1174  * NCQ   : SATA controllers supporting NCQ.  The user must set
1175  *	   sg_tablesize, dma_boundary and can_queue.
1176  */
1177 extern const struct ata_port_operations ata_base_port_ops;
1178 extern const struct ata_port_operations sata_port_ops;
1179 extern struct device_attribute *ata_common_sdev_attrs[];
1180 
1181 #define ATA_BASE_SHT(drv_name)					\
1182 	.module			= THIS_MODULE,			\
1183 	.name			= drv_name,			\
1184 	.ioctl			= ata_scsi_ioctl,		\
1185 	.queuecommand		= ata_scsi_queuecmd,		\
1186 	.can_queue		= ATA_DEF_QUEUE,		\
1187 	.this_id		= ATA_SHT_THIS_ID,		\
1188 	.cmd_per_lun		= ATA_SHT_CMD_PER_LUN,		\
1189 	.emulated		= ATA_SHT_EMULATED,		\
1190 	.use_clustering		= ATA_SHT_USE_CLUSTERING,	\
1191 	.proc_name		= drv_name,			\
1192 	.slave_configure	= ata_scsi_slave_config,	\
1193 	.slave_destroy		= ata_scsi_slave_destroy,	\
1194 	.bios_param		= ata_std_bios_param,		\
1195 	.unlock_native_capacity	= ata_scsi_unlock_native_capacity, \
1196 	.sdev_attrs		= ata_common_sdev_attrs
1197 
1198 #define ATA_NCQ_SHT(drv_name)					\
1199 	ATA_BASE_SHT(drv_name),					\
1200 	.change_queue_depth	= ata_scsi_change_queue_depth
1201 
1202 /*
1203  * PMP helpers
1204  */
1205 #ifdef CONFIG_SATA_PMP
1206 static inline bool sata_pmp_supported(struct ata_port *ap)
1207 {
1208 	return ap->flags & ATA_FLAG_PMP;
1209 }
1210 
1211 static inline bool sata_pmp_attached(struct ata_port *ap)
1212 {
1213 	return ap->nr_pmp_links != 0;
1214 }
1215 
1216 static inline int ata_is_host_link(const struct ata_link *link)
1217 {
1218 	return link == &link->ap->link || link == link->ap->slave_link;
1219 }
1220 #else /* CONFIG_SATA_PMP */
1221 static inline bool sata_pmp_supported(struct ata_port *ap)
1222 {
1223 	return false;
1224 }
1225 
1226 static inline bool sata_pmp_attached(struct ata_port *ap)
1227 {
1228 	return false;
1229 }
1230 
1231 static inline int ata_is_host_link(const struct ata_link *link)
1232 {
1233 	return 1;
1234 }
1235 #endif /* CONFIG_SATA_PMP */
1236 
1237 static inline int sata_srst_pmp(struct ata_link *link)
1238 {
1239 	if (sata_pmp_supported(link->ap) && ata_is_host_link(link))
1240 		return SATA_PMP_CTRL_PORT;
1241 	return link->pmp;
1242 }
1243 
1244 /*
1245  * printk helpers
1246  */
1247 #define ata_port_printk(ap, lv, fmt, args...) \
1248 	printk("%sata%u: "fmt, lv, (ap)->print_id , ##args)
1249 
1250 #define ata_link_printk(link, lv, fmt, args...) do { \
1251 	if (sata_pmp_attached((link)->ap) || (link)->ap->slave_link)	\
1252 		printk("%sata%u.%02u: "fmt, lv, (link)->ap->print_id,	\
1253 		       (link)->pmp , ##args); \
1254 	else \
1255 		printk("%sata%u: "fmt, lv, (link)->ap->print_id , ##args); \
1256 	} while(0)
1257 
1258 #define ata_dev_printk(dev, lv, fmt, args...) \
1259 	printk("%sata%u.%02u: "fmt, lv, (dev)->link->ap->print_id,	\
1260 	       (dev)->link->pmp + (dev)->devno , ##args)
1261 
1262 /*
1263  * ata_eh_info helpers
1264  */
1265 extern void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...)
1266 	__attribute__ ((format (printf, 2, 3)));
1267 extern void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...)
1268 	__attribute__ ((format (printf, 2, 3)));
1269 extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
1270 
1271 static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
1272 {
1273 	ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
1274 	ehi->flags |= ATA_EHI_HOTPLUGGED;
1275 	ehi->action |= ATA_EH_RESET | ATA_EH_ENABLE_LINK;
1276 	ehi->err_mask |= AC_ERR_ATA_BUS;
1277 }
1278 
1279 /*
1280  * port description helpers
1281  */
1282 extern void ata_port_desc(struct ata_port *ap, const char *fmt, ...)
1283 	__attribute__ ((format (printf, 2, 3)));
1284 #ifdef CONFIG_PCI
1285 extern void ata_port_pbar_desc(struct ata_port *ap, int bar, ssize_t offset,
1286 			       const char *name);
1287 #endif
1288 
1289 static inline unsigned int ata_tag_valid(unsigned int tag)
1290 {
1291 	return (tag < ATA_MAX_QUEUE) ? 1 : 0;
1292 }
1293 
1294 static inline unsigned int ata_tag_internal(unsigned int tag)
1295 {
1296 	return tag == ATA_TAG_INTERNAL;
1297 }
1298 
1299 /*
1300  * device helpers
1301  */
1302 static inline unsigned int ata_class_enabled(unsigned int class)
1303 {
1304 	return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI ||
1305 		class == ATA_DEV_PMP || class == ATA_DEV_SEMB;
1306 }
1307 
1308 static inline unsigned int ata_class_disabled(unsigned int class)
1309 {
1310 	return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP ||
1311 		class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP;
1312 }
1313 
1314 static inline unsigned int ata_class_absent(unsigned int class)
1315 {
1316 	return !ata_class_enabled(class) && !ata_class_disabled(class);
1317 }
1318 
1319 static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1320 {
1321 	return ata_class_enabled(dev->class);
1322 }
1323 
1324 static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1325 {
1326 	return ata_class_disabled(dev->class);
1327 }
1328 
1329 static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1330 {
1331 	return ata_class_absent(dev->class);
1332 }
1333 
1334 /*
1335  * link helpers
1336  */
1337 static inline int ata_link_max_devices(const struct ata_link *link)
1338 {
1339 	if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS)
1340 		return 2;
1341 	return 1;
1342 }
1343 
1344 static inline int ata_link_active(struct ata_link *link)
1345 {
1346 	return ata_tag_valid(link->active_tag) || link->sactive;
1347 }
1348 
1349 /*
1350  * Iterators
1351  *
1352  * ATA_LITER_* constants are used to select link iteration mode and
1353  * ATA_DITER_* device iteration mode.
1354  *
1355  * For a custom iteration directly using ata_{link|dev}_next(), if
1356  * @link or @dev, respectively, is NULL, the first element is
1357  * returned.  @dev and @link can be any valid device or link and the
1358  * next element according to the iteration mode will be returned.
1359  * After the last element, NULL is returned.
1360  */
1361 enum ata_link_iter_mode {
1362 	ATA_LITER_EDGE,		/* if present, PMP links only; otherwise,
1363 				 * host link.  no slave link */
1364 	ATA_LITER_HOST_FIRST,	/* host link followed by PMP or slave links */
1365 	ATA_LITER_PMP_FIRST,	/* PMP links followed by host link,
1366 				 * slave link still comes after host link */
1367 };
1368 
1369 enum ata_dev_iter_mode {
1370 	ATA_DITER_ENABLED,
1371 	ATA_DITER_ENABLED_REVERSE,
1372 	ATA_DITER_ALL,
1373 	ATA_DITER_ALL_REVERSE,
1374 };
1375 
1376 extern struct ata_link *ata_link_next(struct ata_link *link,
1377 				      struct ata_port *ap,
1378 				      enum ata_link_iter_mode mode);
1379 
1380 extern struct ata_device *ata_dev_next(struct ata_device *dev,
1381 				       struct ata_link *link,
1382 				       enum ata_dev_iter_mode mode);
1383 
1384 /*
1385  * Shortcut notation for iterations
1386  *
1387  * ata_for_each_link() iterates over each link of @ap according to
1388  * @mode.  @link points to the current link in the loop.  @link is
1389  * NULL after loop termination.  ata_for_each_dev() works the same way
1390  * except that it iterates over each device of @link.
1391  *
1392  * Note that the mode prefixes ATA_{L|D}ITER_ shouldn't need to be
1393  * specified when using the following shorthand notations.  Only the
1394  * mode itself (EDGE, HOST_FIRST, ENABLED, etc...) should be
1395  * specified.  This not only increases brevity but also makes it
1396  * impossible to use ATA_LITER_* for device iteration or vice-versa.
1397  */
1398 #define ata_for_each_link(link, ap, mode) \
1399 	for ((link) = ata_link_next(NULL, (ap), ATA_LITER_##mode); (link); \
1400 	     (link) = ata_link_next((link), (ap), ATA_LITER_##mode))
1401 
1402 #define ata_for_each_dev(dev, link, mode) \
1403 	for ((dev) = ata_dev_next(NULL, (link), ATA_DITER_##mode); (dev); \
1404 	     (dev) = ata_dev_next((dev), (link), ATA_DITER_##mode))
1405 
1406 /**
1407  *	ata_ncq_enabled - Test whether NCQ is enabled
1408  *	@dev: ATA device to test for
1409  *
1410  *	LOCKING:
1411  *	spin_lock_irqsave(host lock)
1412  *
1413  *	RETURNS:
1414  *	1 if NCQ is enabled for @dev, 0 otherwise.
1415  */
1416 static inline int ata_ncq_enabled(struct ata_device *dev)
1417 {
1418 	return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1419 			      ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1420 }
1421 
1422 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1423 {
1424 	qc->tf.ctl |= ATA_NIEN;
1425 }
1426 
1427 static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1428 						       unsigned int tag)
1429 {
1430 	if (likely(ata_tag_valid(tag)))
1431 		return &ap->qcmd[tag];
1432 	return NULL;
1433 }
1434 
1435 static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1436 						     unsigned int tag)
1437 {
1438 	struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1439 
1440 	if (unlikely(!qc) || !ap->ops->error_handler)
1441 		return qc;
1442 
1443 	if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1444 			  ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1445 		return qc;
1446 
1447 	return NULL;
1448 }
1449 
1450 static inline unsigned int ata_qc_raw_nbytes(struct ata_queued_cmd *qc)
1451 {
1452 	return qc->nbytes - min(qc->extrabytes, qc->nbytes);
1453 }
1454 
1455 static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1456 {
1457 	memset(tf, 0, sizeof(*tf));
1458 
1459 #ifdef CONFIG_ATA_SFF
1460 	tf->ctl = dev->link->ap->ctl;
1461 #else
1462 	tf->ctl = ATA_DEVCTL_OBS;
1463 #endif
1464 	if (dev->devno == 0)
1465 		tf->device = ATA_DEVICE_OBS;
1466 	else
1467 		tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1468 }
1469 
1470 static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1471 {
1472 	qc->dma_dir = DMA_NONE;
1473 	qc->sg = NULL;
1474 	qc->flags = 0;
1475 	qc->cursg = NULL;
1476 	qc->cursg_ofs = 0;
1477 	qc->nbytes = qc->extrabytes = qc->curbytes = 0;
1478 	qc->n_elem = 0;
1479 	qc->err_mask = 0;
1480 	qc->sect_size = ATA_SECT_SIZE;
1481 
1482 	ata_tf_init(qc->dev, &qc->tf);
1483 
1484 	/* init result_tf such that it indicates normal completion */
1485 	qc->result_tf.command = ATA_DRDY;
1486 	qc->result_tf.feature = 0;
1487 }
1488 
1489 static inline int ata_try_flush_cache(const struct ata_device *dev)
1490 {
1491 	return ata_id_wcache_enabled(dev->id) ||
1492 	       ata_id_has_flush(dev->id) ||
1493 	       ata_id_has_flush_ext(dev->id);
1494 }
1495 
1496 static inline unsigned int ac_err_mask(u8 status)
1497 {
1498 	if (status & (ATA_BUSY | ATA_DRQ))
1499 		return AC_ERR_HSM;
1500 	if (status & (ATA_ERR | ATA_DF))
1501 		return AC_ERR_DEV;
1502 	return 0;
1503 }
1504 
1505 static inline unsigned int __ac_err_mask(u8 status)
1506 {
1507 	unsigned int mask = ac_err_mask(status);
1508 	if (mask == 0)
1509 		return AC_ERR_OTHER;
1510 	return mask;
1511 }
1512 
1513 static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1514 {
1515 	return *(struct ata_port **)&host->hostdata[0];
1516 }
1517 
1518 static inline int ata_check_ready(u8 status)
1519 {
1520 	if (!(status & ATA_BUSY))
1521 		return 1;
1522 
1523 	/* 0xff indicates either no device or device not ready */
1524 	if (status == 0xff)
1525 		return -ENODEV;
1526 
1527 	return 0;
1528 }
1529 
1530 static inline unsigned long ata_deadline(unsigned long from_jiffies,
1531 					 unsigned long timeout_msecs)
1532 {
1533 	return from_jiffies + msecs_to_jiffies(timeout_msecs);
1534 }
1535 
1536 /* Don't open code these in drivers as there are traps. Firstly the range may
1537    change in future hardware and specs, secondly 0xFF means 'no DMA' but is
1538    > UDMA_0. Dyma ddreigiau */
1539 
1540 static inline int ata_using_mwdma(struct ata_device *adev)
1541 {
1542 	if (adev->dma_mode >= XFER_MW_DMA_0 && adev->dma_mode <= XFER_MW_DMA_4)
1543 		return 1;
1544 	return 0;
1545 }
1546 
1547 static inline int ata_using_udma(struct ata_device *adev)
1548 {
1549 	if (adev->dma_mode >= XFER_UDMA_0 && adev->dma_mode <= XFER_UDMA_7)
1550 		return 1;
1551 	return 0;
1552 }
1553 
1554 static inline int ata_dma_enabled(struct ata_device *adev)
1555 {
1556 	return (adev->dma_mode == 0xFF ? 0 : 1);
1557 }
1558 
1559 /**************************************************************************
1560  * PMP - drivers/ata/libata-pmp.c
1561  */
1562 #ifdef CONFIG_SATA_PMP
1563 
1564 extern const struct ata_port_operations sata_pmp_port_ops;
1565 
1566 extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc);
1567 extern void sata_pmp_error_handler(struct ata_port *ap);
1568 
1569 #else /* CONFIG_SATA_PMP */
1570 
1571 #define sata_pmp_port_ops		sata_port_ops
1572 #define sata_pmp_qc_defer_cmd_switch	ata_std_qc_defer
1573 #define sata_pmp_error_handler		ata_std_error_handler
1574 
1575 #endif /* CONFIG_SATA_PMP */
1576 
1577 
1578 /**************************************************************************
1579  * SFF - drivers/ata/libata-sff.c
1580  */
1581 #ifdef CONFIG_ATA_SFF
1582 
1583 extern const struct ata_port_operations ata_sff_port_ops;
1584 extern const struct ata_port_operations ata_bmdma32_port_ops;
1585 
1586 /* PIO only, sg_tablesize and dma_boundary limits can be removed */
1587 #define ATA_PIO_SHT(drv_name)					\
1588 	ATA_BASE_SHT(drv_name),					\
1589 	.sg_tablesize		= LIBATA_MAX_PRD,		\
1590 	.dma_boundary		= ATA_DMA_BOUNDARY
1591 
1592 extern void ata_sff_dev_select(struct ata_port *ap, unsigned int device);
1593 extern u8 ata_sff_check_status(struct ata_port *ap);
1594 extern void ata_sff_pause(struct ata_port *ap);
1595 extern void ata_sff_dma_pause(struct ata_port *ap);
1596 extern int ata_sff_busy_sleep(struct ata_port *ap,
1597 			      unsigned long timeout_pat, unsigned long timeout);
1598 extern int ata_sff_wait_ready(struct ata_link *link, unsigned long deadline);
1599 extern void ata_sff_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
1600 extern void ata_sff_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
1601 extern void ata_sff_exec_command(struct ata_port *ap,
1602 				 const struct ata_taskfile *tf);
1603 extern unsigned int ata_sff_data_xfer(struct ata_device *dev,
1604 			unsigned char *buf, unsigned int buflen, int rw);
1605 extern unsigned int ata_sff_data_xfer32(struct ata_device *dev,
1606 			unsigned char *buf, unsigned int buflen, int rw);
1607 extern unsigned int ata_sff_data_xfer_noirq(struct ata_device *dev,
1608 			unsigned char *buf, unsigned int buflen, int rw);
1609 extern void ata_sff_irq_on(struct ata_port *ap);
1610 extern void ata_sff_irq_clear(struct ata_port *ap);
1611 extern int ata_sff_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
1612 			    u8 status, int in_wq);
1613 extern void ata_sff_queue_work(struct work_struct *work);
1614 extern void ata_sff_queue_delayed_work(struct delayed_work *dwork,
1615 		unsigned long delay);
1616 extern void ata_sff_queue_pio_task(struct ata_link *link, unsigned long delay);
1617 extern unsigned int ata_sff_qc_issue(struct ata_queued_cmd *qc);
1618 extern bool ata_sff_qc_fill_rtf(struct ata_queued_cmd *qc);
1619 extern unsigned int ata_sff_port_intr(struct ata_port *ap,
1620 				      struct ata_queued_cmd *qc);
1621 extern irqreturn_t ata_sff_interrupt(int irq, void *dev_instance);
1622 extern void ata_sff_lost_interrupt(struct ata_port *ap);
1623 extern void ata_sff_freeze(struct ata_port *ap);
1624 extern void ata_sff_thaw(struct ata_port *ap);
1625 extern int ata_sff_prereset(struct ata_link *link, unsigned long deadline);
1626 extern unsigned int ata_sff_dev_classify(struct ata_device *dev, int present,
1627 					  u8 *r_err);
1628 extern int ata_sff_wait_after_reset(struct ata_link *link, unsigned int devmask,
1629 				    unsigned long deadline);
1630 extern int ata_sff_softreset(struct ata_link *link, unsigned int *classes,
1631 			     unsigned long deadline);
1632 extern int sata_sff_hardreset(struct ata_link *link, unsigned int *class,
1633 			       unsigned long deadline);
1634 extern void ata_sff_postreset(struct ata_link *link, unsigned int *classes);
1635 extern void ata_sff_drain_fifo(struct ata_queued_cmd *qc);
1636 extern void ata_sff_error_handler(struct ata_port *ap);
1637 extern void ata_sff_std_ports(struct ata_ioports *ioaddr);
1638 #ifdef CONFIG_PCI
1639 extern int ata_pci_sff_init_host(struct ata_host *host);
1640 extern int ata_pci_sff_prepare_host(struct pci_dev *pdev,
1641 				    const struct ata_port_info * const * ppi,
1642 				    struct ata_host **r_host);
1643 extern int ata_pci_sff_activate_host(struct ata_host *host,
1644 				     irq_handler_t irq_handler,
1645 				     struct scsi_host_template *sht);
1646 extern int ata_pci_sff_init_one(struct pci_dev *pdev,
1647 		const struct ata_port_info * const * ppi,
1648 		struct scsi_host_template *sht, void *host_priv, int hflags);
1649 #endif /* CONFIG_PCI */
1650 
1651 #ifdef CONFIG_ATA_BMDMA
1652 
1653 extern const struct ata_port_operations ata_bmdma_port_ops;
1654 
1655 #define ATA_BMDMA_SHT(drv_name)					\
1656 	ATA_BASE_SHT(drv_name),					\
1657 	.sg_tablesize		= LIBATA_MAX_PRD,		\
1658 	.dma_boundary		= ATA_DMA_BOUNDARY
1659 
1660 extern void ata_bmdma_qc_prep(struct ata_queued_cmd *qc);
1661 extern unsigned int ata_bmdma_qc_issue(struct ata_queued_cmd *qc);
1662 extern void ata_bmdma_dumb_qc_prep(struct ata_queued_cmd *qc);
1663 extern unsigned int ata_bmdma_port_intr(struct ata_port *ap,
1664 				      struct ata_queued_cmd *qc);
1665 extern irqreturn_t ata_bmdma_interrupt(int irq, void *dev_instance);
1666 extern void ata_bmdma_error_handler(struct ata_port *ap);
1667 extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
1668 extern void ata_bmdma_irq_clear(struct ata_port *ap);
1669 extern void ata_bmdma_setup(struct ata_queued_cmd *qc);
1670 extern void ata_bmdma_start(struct ata_queued_cmd *qc);
1671 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
1672 extern u8 ata_bmdma_status(struct ata_port *ap);
1673 extern int ata_bmdma_port_start(struct ata_port *ap);
1674 extern int ata_bmdma_port_start32(struct ata_port *ap);
1675 
1676 #ifdef CONFIG_PCI
1677 extern int ata_pci_bmdma_clear_simplex(struct pci_dev *pdev);
1678 extern void ata_pci_bmdma_init(struct ata_host *host);
1679 extern int ata_pci_bmdma_prepare_host(struct pci_dev *pdev,
1680 				      const struct ata_port_info * const * ppi,
1681 				      struct ata_host **r_host);
1682 extern int ata_pci_bmdma_init_one(struct pci_dev *pdev,
1683 				  const struct ata_port_info * const * ppi,
1684 				  struct scsi_host_template *sht,
1685 				  void *host_priv, int hflags);
1686 #endif /* CONFIG_PCI */
1687 #endif /* CONFIG_ATA_BMDMA */
1688 
1689 /**
1690  *	ata_sff_busy_wait - Wait for a port status register
1691  *	@ap: Port to wait for.
1692  *	@bits: bits that must be clear
1693  *	@max: number of 10uS waits to perform
1694  *
1695  *	Waits up to max*10 microseconds for the selected bits in the port's
1696  *	status register to be cleared.
1697  *	Returns final value of status register.
1698  *
1699  *	LOCKING:
1700  *	Inherited from caller.
1701  */
1702 static inline u8 ata_sff_busy_wait(struct ata_port *ap, unsigned int bits,
1703 				   unsigned int max)
1704 {
1705 	u8 status;
1706 
1707 	do {
1708 		udelay(10);
1709 		status = ap->ops->sff_check_status(ap);
1710 		max--;
1711 	} while (status != 0xff && (status & bits) && (max > 0));
1712 
1713 	return status;
1714 }
1715 
1716 /**
1717  *	ata_wait_idle - Wait for a port to be idle.
1718  *	@ap: Port to wait for.
1719  *
1720  *	Waits up to 10ms for port's BUSY and DRQ signals to clear.
1721  *	Returns final value of status register.
1722  *
1723  *	LOCKING:
1724  *	Inherited from caller.
1725  */
1726 static inline u8 ata_wait_idle(struct ata_port *ap)
1727 {
1728 	u8 status = ata_sff_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1729 
1730 #ifdef ATA_DEBUG
1731 	if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
1732 		ata_port_printk(ap, KERN_DEBUG, "abnormal Status 0x%X\n",
1733 				status);
1734 #endif
1735 
1736 	return status;
1737 }
1738 #endif /* CONFIG_ATA_SFF */
1739 
1740 #endif /* __LINUX_LIBATA_H__ */
1741