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