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