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