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