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