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