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