2 * Copyright 2003-2005 Red Hat, Inc. All rights reserved.
3 * Copyright 2003-2005 Jeff Garzik
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)
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.
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.
21 * libata documentation is available via 'make {ps|pdf}docs',
22 * as Documentation/DocBook/libata.*
26 #ifndef __LINUX_LIBATA_H__
27 #define __LINUX_LIBATA_H__
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>
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>
43 * Define if arch has non-standard setup. This is a _PCI_ standard
44 * not a legacy or ISA standard.
46 #ifdef CONFIG_ATA_NONSTANDARD
47 #include <asm/libata-portmap.h>
49 #include <asm-generic/libata-portmap.h>
53 * compile-time options: to be removed as soon as all the drivers are
54 * converted to the new debugging mechanism
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 */
62 /* note: prints function name for you */
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)
68 #define VPRINTK(fmt, args...)
69 #endif /* ATA_VERBOSE_DEBUG */
71 #define DPRINTK(fmt, args...)
72 #define VPRINTK(fmt, args...)
73 #endif /* ATA_DEBUG */
75 #define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __func__, ## args)
77 #define ata_print_version_once(dev, version) \
79 static bool __print_once; \
81 if (!__print_once) { \
82 __print_once = true; \
83 ata_print_version(dev, version); \
87 /* NEW: debug levels */
88 #define HAVE_LIBATA_MSG 1
92 ATA_MSG_INFO
= 0x0002,
93 ATA_MSG_PROBE
= 0x0004,
94 ATA_MSG_WARN
= 0x0008,
95 ATA_MSG_MALLOC
= 0x0010,
97 ATA_MSG_INTR
= 0x0040,
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)
110 static inline u32
ata_msg_init(int dval
, int default_msg_enable_bits
)
112 if (dval
< 0 || dval
>= (sizeof(u32
) * 8))
113 return default_msg_enable_bits
; /* should be 0x1 - only driver info msgs */
116 return (1 << dval
) - 1;
119 /* defines only for the constants which don't work well as enums */
120 #define ATA_TAG_POISON 0xfafbfcfdU
123 /* various global constants */
124 LIBATA_MAX_PRD
= ATA_MAX_PRD
/ 2,
125 LIBATA_DUMB_MAX_PRD
= ATA_MAX_PRD
/ 4, /* Worst case */
127 /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
129 ATA_TAG_INTERNAL
= ATA_MAX_QUEUE
- 1,
130 ATA_SHORT_PAUSE
= 16,
132 ATAPI_MAX_DRAIN
= 16 << 10,
134 ATA_ALL_DEVICES
= (1 << ATA_MAX_DEVICES
) - 1,
136 ATA_SHT_EMULATED
= 1,
137 ATA_SHT_THIS_ID
= -1,
138 ATA_SHT_USE_CLUSTERING
= 1,
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 */
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 */
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,
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,
177 ATA_DFLAG_DETACH
= (1 << 24),
178 ATA_DFLAG_DETACHED
= (1 << 25),
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 */
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 */
196 /* struct ata_link flags */
197 ATA_LFLAG_NO_HRST
= (1 << 1), /* avoid hardreset */
198 ATA_LFLAG_NO_SRST
= (1 << 2), /* avoid softreset */
199 ATA_LFLAG_ASSUME_ATA
= (1 << 3), /* assume ATA class */
200 ATA_LFLAG_ASSUME_SEMB
= (1 << 4), /* assume SEMB class */
201 ATA_LFLAG_ASSUME_CLASS
= ATA_LFLAG_ASSUME_ATA
| ATA_LFLAG_ASSUME_SEMB
,
202 ATA_LFLAG_NO_RETRY
= (1 << 5), /* don't retry this link */
203 ATA_LFLAG_DISABLED
= (1 << 6), /* link is disabled */
204 ATA_LFLAG_SW_ACTIVITY
= (1 << 7), /* keep activity stats */
205 ATA_LFLAG_NO_LPM
= (1 << 8), /* disable LPM on this link */
206 ATA_LFLAG_RST_ONCE
= (1 << 9), /* limit recovery to one reset */
207 ATA_LFLAG_CHANGED
= (1 << 10), /* LPM state changed on this link */
208 ATA_LFLAG_NO_DB_DELAY
= (1 << 11), /* no debounce delay on link resume */
210 /* struct ata_port flags */
211 ATA_FLAG_SLAVE_POSS
= (1 << 0), /* host supports slave dev */
212 /* (doesn't imply presence) */
213 ATA_FLAG_SATA
= (1 << 1),
214 ATA_FLAG_NO_LOG_PAGE
= (1 << 5), /* do not issue log page read */
215 ATA_FLAG_NO_ATAPI
= (1 << 6), /* No ATAPI support */
216 ATA_FLAG_PIO_DMA
= (1 << 7), /* PIO cmds via DMA */
217 ATA_FLAG_PIO_LBA48
= (1 << 8), /* Host DMA engine is LBA28 only */
218 ATA_FLAG_PIO_POLLING
= (1 << 9), /* use polling PIO if LLD
219 * doesn't handle PIO interrupts */
220 ATA_FLAG_NCQ
= (1 << 10), /* host supports NCQ */
221 ATA_FLAG_NO_POWEROFF_SPINDOWN
= (1 << 11), /* don't spindown before poweroff */
222 ATA_FLAG_NO_HIBERNATE_SPINDOWN
= (1 << 12), /* don't spindown before hibernation */
223 ATA_FLAG_DEBUGMSG
= (1 << 13),
224 ATA_FLAG_FPDMA_AA
= (1 << 14), /* driver supports Auto-Activate */
225 ATA_FLAG_IGN_SIMPLEX
= (1 << 15), /* ignore SIMPLEX */
226 ATA_FLAG_NO_IORDY
= (1 << 16), /* controller lacks iordy */
227 ATA_FLAG_ACPI_SATA
= (1 << 17), /* need native SATA ACPI layout */
228 ATA_FLAG_AN
= (1 << 18), /* controller supports AN */
229 ATA_FLAG_PMP
= (1 << 19), /* controller supports PMP */
230 ATA_FLAG_FPDMA_AUX
= (1 << 20), /* controller supports H2DFIS aux field */
231 ATA_FLAG_EM
= (1 << 21), /* driver supports enclosure
233 ATA_FLAG_SW_ACTIVITY
= (1 << 22), /* driver supports sw activity
235 ATA_FLAG_NO_DIPM
= (1 << 23), /* host not happy with DIPM */
236 ATA_FLAG_SAS_HOST
= (1 << 24), /* SAS host */
238 /* bits 24:31 of ap->flags are reserved for LLD specific flags */
241 /* struct ata_port pflags */
242 ATA_PFLAG_EH_PENDING
= (1 << 0), /* EH pending */
243 ATA_PFLAG_EH_IN_PROGRESS
= (1 << 1), /* EH in progress */
244 ATA_PFLAG_FROZEN
= (1 << 2), /* port is frozen */
245 ATA_PFLAG_RECOVERED
= (1 << 3), /* recovery action performed */
246 ATA_PFLAG_LOADING
= (1 << 4), /* boot/loading probe */
247 ATA_PFLAG_SCSI_HOTPLUG
= (1 << 6), /* SCSI hotplug scheduled */
248 ATA_PFLAG_INITIALIZING
= (1 << 7), /* being initialized, don't touch */
249 ATA_PFLAG_RESETTING
= (1 << 8), /* reset in progress */
250 ATA_PFLAG_UNLOADING
= (1 << 9), /* driver is being unloaded */
251 ATA_PFLAG_UNLOADED
= (1 << 10), /* driver is unloaded */
253 ATA_PFLAG_SUSPENDED
= (1 << 17), /* port is suspended (power) */
254 ATA_PFLAG_PM_PENDING
= (1 << 18), /* PM operation pending */
255 ATA_PFLAG_INIT_GTM_VALID
= (1 << 19), /* initial gtm data valid */
257 ATA_PFLAG_PIO32
= (1 << 20), /* 32bit PIO */
258 ATA_PFLAG_PIO32CHANGE
= (1 << 21), /* 32bit PIO can be turned on/off */
259 ATA_PFLAG_EXTERNAL
= (1 << 22), /* eSATA/external port */
261 /* struct ata_queued_cmd flags */
262 ATA_QCFLAG_ACTIVE
= (1 << 0), /* cmd not yet ack'd to scsi lyer */
263 ATA_QCFLAG_DMAMAP
= (1 << 1), /* SG table is DMA mapped */
264 ATA_QCFLAG_IO
= (1 << 3), /* standard IO command */
265 ATA_QCFLAG_RESULT_TF
= (1 << 4), /* result TF requested */
266 ATA_QCFLAG_CLEAR_EXCL
= (1 << 5), /* clear excl_link on completion */
267 ATA_QCFLAG_QUIET
= (1 << 6), /* don't report device error */
268 ATA_QCFLAG_RETRY
= (1 << 7), /* retry after failure */
270 ATA_QCFLAG_FAILED
= (1 << 16), /* cmd failed and is owned by EH */
271 ATA_QCFLAG_SENSE_VALID
= (1 << 17), /* sense data valid */
272 ATA_QCFLAG_EH_SCHEDULED
= (1 << 18), /* EH scheduled (obsolete) */
275 ATA_HOST_SIMPLEX
= (1 << 0), /* Host is simplex, one DMA channel per host only */
276 ATA_HOST_STARTED
= (1 << 1), /* Host started */
277 ATA_HOST_PARALLEL_SCAN
= (1 << 2), /* Ports on this host can be scanned in parallel */
278 ATA_HOST_IGNORE_ATA
= (1 << 3), /* Ignore ATA devices on this host. */
280 /* bits 24:31 of host->flags are reserved for LLD specific flags */
282 /* various lengths of time */
283 ATA_TMOUT_BOOT
= 30000, /* heuristic */
284 ATA_TMOUT_BOOT_QUICK
= 7000, /* heuristic */
285 ATA_TMOUT_INTERNAL_QUICK
= 5000,
286 ATA_TMOUT_MAX_PARK
= 30000,
289 * GoVault needs 2s and iVDR disk HHD424020F7SV00 800ms. 2s
290 * is too much without parallel probing. Use 2s if parallel
291 * probing is available, 800ms otherwise.
293 ATA_TMOUT_FF_WAIT_LONG
= 2000,
294 ATA_TMOUT_FF_WAIT
= 800,
296 /* Spec mandates to wait for ">= 2ms" before checking status
297 * after reset. We wait 150ms, because that was the magic
298 * delay used for ATAPI devices in Hale Landis's ATADRVR, for
299 * the period of time between when the ATA command register is
300 * written, and then status is checked. Because waiting for
301 * "a while" before checking status is fine, post SRST, we
302 * perform this magic delay here as well.
304 * Old drivers/ide uses the 2mS rule and then waits for ready.
306 ATA_WAIT_AFTER_RESET
= 150,
308 /* If PMP is supported, we have to do follow-up SRST. As some
309 * PMPs don't send D2H Reg FIS after hardreset, LLDs are
310 * advised to wait only for the following duration before
313 ATA_TMOUT_PMP_SRST_WAIT
= 5000,
315 /* When the LPM policy is set to ATA_LPM_MAX_POWER, there might
316 * be a spurious PHY event, so ignore the first PHY event that
317 * occurs within 10s after the policy change.
319 ATA_TMOUT_SPURIOUS_PHY
= 10000,
333 /* SATA port states */
338 /* encoding various smaller bitmaps into a single
339 * unsigned long bitmap
341 ATA_NR_PIO_MODES
= 7,
342 ATA_NR_MWDMA_MODES
= 5,
343 ATA_NR_UDMA_MODES
= 8,
346 ATA_SHIFT_MWDMA
= ATA_SHIFT_PIO
+ ATA_NR_PIO_MODES
,
347 ATA_SHIFT_UDMA
= ATA_SHIFT_MWDMA
+ ATA_NR_MWDMA_MODES
,
349 /* size of buffer to pad xfers ending on unaligned boundaries */
355 /* return values for ->qc_defer */
359 /* desc_len for ata_eh_info and context */
360 ATA_EH_DESC_LEN
= 80,
362 /* reset / recovery action types */
363 ATA_EH_REVALIDATE
= (1 << 0),
364 ATA_EH_SOFTRESET
= (1 << 1), /* meaningful only in ->prereset */
365 ATA_EH_HARDRESET
= (1 << 2), /* meaningful only in ->prereset */
366 ATA_EH_RESET
= ATA_EH_SOFTRESET
| ATA_EH_HARDRESET
,
367 ATA_EH_ENABLE_LINK
= (1 << 3),
368 ATA_EH_PARK
= (1 << 5), /* unload heads and stop I/O */
370 ATA_EH_PERDEV_MASK
= ATA_EH_REVALIDATE
| ATA_EH_PARK
,
371 ATA_EH_ALL_ACTIONS
= ATA_EH_REVALIDATE
| ATA_EH_RESET
|
374 /* ata_eh_info->flags */
375 ATA_EHI_HOTPLUGGED
= (1 << 0), /* could have been hotplugged */
376 ATA_EHI_NO_AUTOPSY
= (1 << 2), /* no autopsy */
377 ATA_EHI_QUIET
= (1 << 3), /* be quiet */
378 ATA_EHI_NO_RECOVERY
= (1 << 4), /* no recovery */
380 ATA_EHI_DID_SOFTRESET
= (1 << 16), /* already soft-reset this port */
381 ATA_EHI_DID_HARDRESET
= (1 << 17), /* already soft-reset this port */
382 ATA_EHI_PRINTINFO
= (1 << 18), /* print configuration info */
383 ATA_EHI_SETMODE
= (1 << 19), /* configure transfer mode */
384 ATA_EHI_POST_SETMODE
= (1 << 20), /* revalidating after setmode */
386 ATA_EHI_DID_RESET
= ATA_EHI_DID_SOFTRESET
| ATA_EHI_DID_HARDRESET
,
388 /* mask of flags to transfer *to* the slave link */
389 ATA_EHI_TO_SLAVE_MASK
= ATA_EHI_NO_AUTOPSY
| ATA_EHI_QUIET
,
391 /* max tries if error condition is still set after ->error_handler */
392 ATA_EH_MAX_TRIES
= 5,
394 /* sometimes resuming a link requires several retries */
395 ATA_LINK_RESUME_TRIES
= 5,
397 /* how hard are we gonna try to probe/recover devices */
398 ATA_PROBE_MAX_TRIES
= 3,
399 ATA_EH_DEV_TRIES
= 3,
400 ATA_EH_PMP_TRIES
= 5,
401 ATA_EH_PMP_LINK_TRIES
= 3,
403 SATA_PMP_RW_TIMEOUT
= 3000, /* PMP read/write timeout */
405 /* This should match the actual table size of
406 * ata_eh_cmd_timeout_table in libata-eh.c.
408 ATA_EH_CMD_TIMEOUT_TABLE_SIZE
= 6,
410 /* Horkage types. May be set by libata or controller on drives
411 (some horkage may be drive/controller pair dependent */
413 ATA_HORKAGE_DIAGNOSTIC
= (1 << 0), /* Failed boot diag */
414 ATA_HORKAGE_NODMA
= (1 << 1), /* DMA problems */
415 ATA_HORKAGE_NONCQ
= (1 << 2), /* Don't use NCQ */
416 ATA_HORKAGE_MAX_SEC_128
= (1 << 3), /* Limit max sects to 128 */
417 ATA_HORKAGE_BROKEN_HPA
= (1 << 4), /* Broken HPA */
418 ATA_HORKAGE_DISABLE
= (1 << 5), /* Disable it */
419 ATA_HORKAGE_HPA_SIZE
= (1 << 6), /* native size off by one */
420 ATA_HORKAGE_IVB
= (1 << 8), /* cbl det validity bit bugs */
421 ATA_HORKAGE_STUCK_ERR
= (1 << 9), /* stuck ERR on next PACKET */
422 ATA_HORKAGE_BRIDGE_OK
= (1 << 10), /* no bridge limits */
423 ATA_HORKAGE_ATAPI_MOD16_DMA
= (1 << 11), /* use ATAPI DMA for commands
424 not multiple of 16 bytes */
425 ATA_HORKAGE_FIRMWARE_WARN
= (1 << 12), /* firmware update warning */
426 ATA_HORKAGE_1_5_GBPS
= (1 << 13), /* force 1.5 Gbps */
427 ATA_HORKAGE_NOSETXFER
= (1 << 14), /* skip SETXFER, SATA only */
428 ATA_HORKAGE_BROKEN_FPDMA_AA
= (1 << 15), /* skip AA */
429 ATA_HORKAGE_DUMP_ID
= (1 << 16), /* dump IDENTIFY data */
430 ATA_HORKAGE_MAX_SEC_LBA48
= (1 << 17), /* Set max sects to 65535 */
431 ATA_HORKAGE_ATAPI_DMADIR
= (1 << 18), /* device requires dmadir */
432 ATA_HORKAGE_NO_NCQ_TRIM
= (1 << 19), /* don't use queued TRIM */
433 ATA_HORKAGE_NOLPM
= (1 << 20), /* don't use LPM */
434 ATA_HORKAGE_WD_BROKEN_LPM
= (1 << 21), /* some WDs have broken LPM */
435 ATA_HORKAGE_ZERO_AFTER_TRIM
= (1 << 22),/* guarantees zero after trim */
436 ATA_HORKAGE_NO_NCQ_LOG
= (1 << 23), /* don't use NCQ for log read */
437 ATA_HORKAGE_NOTRIM
= (1 << 24), /* don't use TRIM */
438 ATA_HORKAGE_MAX_SEC_1024
= (1 << 25), /* Limit max sects to 1024 */
440 /* DMA mask for user DMA control: User visible values; DO NOT
442 ATA_DMA_MASK_ATA
= (1 << 0), /* DMA on ATA Disk */
443 ATA_DMA_MASK_ATAPI
= (1 << 1), /* DMA on ATAPI */
444 ATA_DMA_MASK_CFA
= (1 << 2), /* DMA on CF Card */
446 /* ATAPI command types */
447 ATAPI_READ
= 0, /* READs */
448 ATAPI_WRITE
= 1, /* WRITEs */
449 ATAPI_READ_CD
= 2, /* READ CD [MSF] */
450 ATAPI_PASS_THRU
= 3, /* SAT pass-thru */
451 ATAPI_MISC
= 4, /* the rest */
453 /* Timing constants */
454 ATA_TIMING_SETUP
= (1 << 0),
455 ATA_TIMING_ACT8B
= (1 << 1),
456 ATA_TIMING_REC8B
= (1 << 2),
457 ATA_TIMING_CYC8B
= (1 << 3),
458 ATA_TIMING_8BIT
= ATA_TIMING_ACT8B
| ATA_TIMING_REC8B
|
460 ATA_TIMING_ACTIVE
= (1 << 4),
461 ATA_TIMING_RECOVER
= (1 << 5),
462 ATA_TIMING_DMACK_HOLD
= (1 << 6),
463 ATA_TIMING_CYCLE
= (1 << 7),
464 ATA_TIMING_UDMA
= (1 << 8),
465 ATA_TIMING_ALL
= ATA_TIMING_SETUP
| ATA_TIMING_ACT8B
|
466 ATA_TIMING_REC8B
| ATA_TIMING_CYC8B
|
467 ATA_TIMING_ACTIVE
| ATA_TIMING_RECOVER
|
468 ATA_TIMING_DMACK_HOLD
| ATA_TIMING_CYCLE
|
472 ATA_ACPI_FILTER_SETXFER
= 1 << 0,
473 ATA_ACPI_FILTER_LOCK
= 1 << 1,
474 ATA_ACPI_FILTER_DIPM
= 1 << 2,
475 ATA_ACPI_FILTER_FPDMA_OFFSET
= 1 << 3, /* FPDMA non-zero offset */
476 ATA_ACPI_FILTER_FPDMA_AA
= 1 << 4, /* FPDMA auto activate */
478 ATA_ACPI_FILTER_DEFAULT
= ATA_ACPI_FILTER_SETXFER
|
479 ATA_ACPI_FILTER_LOCK
|
480 ATA_ACPI_FILTER_DIPM
,
484 ATA_MASK_PIO
= ((1LU << ATA_NR_PIO_MODES
) - 1)
486 ATA_MASK_MWDMA
= ((1LU << ATA_NR_MWDMA_MODES
) - 1)
488 ATA_MASK_UDMA
= ((1LU << ATA_NR_UDMA_MODES
) - 1)
492 enum hsm_task_states
{
493 HSM_ST_IDLE
, /* no command on going */
494 HSM_ST_FIRST
, /* (waiting the device to)
495 write CDB or first data block */
496 HSM_ST
, /* (waiting the device to) transfer data */
497 HSM_ST_LAST
, /* (waiting the device to) complete command */
498 HSM_ST_ERR
, /* error */
501 enum ata_completion_errors
{
502 AC_ERR_DEV
= (1 << 0), /* device reported error */
503 AC_ERR_HSM
= (1 << 1), /* host state machine violation */
504 AC_ERR_TIMEOUT
= (1 << 2), /* timeout */
505 AC_ERR_MEDIA
= (1 << 3), /* media error */
506 AC_ERR_ATA_BUS
= (1 << 4), /* ATA bus error */
507 AC_ERR_HOST_BUS
= (1 << 5), /* host bus error */
508 AC_ERR_SYSTEM
= (1 << 6), /* system error */
509 AC_ERR_INVALID
= (1 << 7), /* invalid argument */
510 AC_ERR_OTHER
= (1 << 8), /* unknown */
511 AC_ERR_NODEV_HINT
= (1 << 9), /* polling device detection hint */
512 AC_ERR_NCQ
= (1 << 10), /* marker for offending NCQ qc */
516 * Link power management policy: If you alter this, you also need to
517 * alter libata-scsi.c (for the ascii descriptions)
519 enum ata_lpm_policy
{
527 ATA_LPM_EMPTY
= (1 << 0), /* port empty/probing */
528 ATA_LPM_HIPM
= (1 << 1), /* may use HIPM */
531 /* forward declarations */
533 struct ata_port_operations
;
536 struct ata_queued_cmd
;
539 typedef void (*ata_qc_cb_t
) (struct ata_queued_cmd
*qc
);
540 typedef int (*ata_prereset_fn_t
)(struct ata_link
*link
, unsigned long deadline
);
541 typedef int (*ata_reset_fn_t
)(struct ata_link
*link
, unsigned int *classes
,
542 unsigned long deadline
);
543 typedef void (*ata_postreset_fn_t
)(struct ata_link
*link
, unsigned int *classes
);
545 extern struct device_attribute dev_attr_link_power_management_policy
;
546 extern struct device_attribute dev_attr_unload_heads
;
547 extern struct device_attribute dev_attr_em_message_type
;
548 extern struct device_attribute dev_attr_em_message
;
549 extern struct device_attribute dev_attr_sw_activity
;
557 struct ata_taskfile
{
558 unsigned long flags
; /* ATA_TFLAG_xxx */
559 u8 protocol
; /* ATA_PROT_xxx */
561 u8 ctl
; /* control reg */
563 u8 hob_feature
; /* additional data */
564 u8 hob_nsect
; /* to support LBA48 */
577 u8 command
; /* IO operation */
579 u32 auxiliary
; /* auxiliary field */
580 /* from SATA 3.1 and */
584 #ifdef CONFIG_ATA_SFF
586 void __iomem
*cmd_addr
;
587 void __iomem
*data_addr
;
588 void __iomem
*error_addr
;
589 void __iomem
*feature_addr
;
590 void __iomem
*nsect_addr
;
591 void __iomem
*lbal_addr
;
592 void __iomem
*lbam_addr
;
593 void __iomem
*lbah_addr
;
594 void __iomem
*device_addr
;
595 void __iomem
*status_addr
;
596 void __iomem
*command_addr
;
597 void __iomem
*altstatus_addr
;
598 void __iomem
*ctl_addr
;
599 #ifdef CONFIG_ATA_BMDMA
600 void __iomem
*bmdma_addr
;
601 #endif /* CONFIG_ATA_BMDMA */
602 void __iomem
*scr_addr
;
604 #endif /* CONFIG_ATA_SFF */
609 void __iomem
* const *iomap
;
610 unsigned int n_ports
;
611 unsigned int n_tags
; /* nr of NCQ tags */
613 struct ata_port_operations
*ops
;
616 struct mutex eh_mutex
;
617 struct task_struct
*eh_owner
;
619 struct ata_port
*simplex_claimed
; /* channel owning the DMA */
620 struct ata_port
*ports
[0];
623 struct ata_queued_cmd
{
625 struct ata_device
*dev
;
627 struct scsi_cmnd
*scsicmd
;
628 void (*scsidone
)(struct scsi_cmnd
*);
630 struct ata_taskfile tf
;
631 u8 cdb
[ATAPI_CDB_LEN
];
633 unsigned long flags
; /* ATA_QCFLAG_xxx */
636 unsigned int orig_n_elem
;
640 unsigned int sect_size
;
643 unsigned int extrabytes
;
644 unsigned int curbytes
;
646 struct scatterlist sgent
;
648 struct scatterlist
*sg
;
650 struct scatterlist
*cursg
;
651 unsigned int cursg_ofs
;
653 unsigned int err_mask
;
654 struct ata_taskfile result_tf
;
655 ata_qc_cb_t complete_fn
;
661 struct ata_port_stats
{
662 unsigned long unhandled_irq
;
663 unsigned long idle_irq
;
664 unsigned long rw_reqbuf
;
667 struct ata_ering_entry
{
669 unsigned int err_mask
;
675 struct ata_ering_entry ring
[ATA_ERING_SIZE
];
679 struct ata_link
*link
;
680 unsigned int devno
; /* 0 or 1 */
681 unsigned int horkage
; /* List of broken features */
682 unsigned long flags
; /* ATA_DFLAG_xxx */
683 struct scsi_device
*sdev
; /* attached SCSI device */
685 #ifdef CONFIG_ATA_ACPI
686 union acpi_object
*gtf_cache
;
687 unsigned int gtf_filter
;
689 #ifdef CONFIG_SATA_ZPODD
693 /* n_sector is CLEAR_BEGIN, read comment above CLEAR_BEGIN */
694 u64 n_sectors
; /* size of device, if ATA */
695 u64 n_native_sectors
; /* native size, if ATA */
696 unsigned int class; /* ATA_DEV_xxx */
697 unsigned long unpark_deadline
;
702 unsigned int xfer_shift
; /* ATA_SHIFT_xxx */
704 unsigned int multi_count
; /* sectors count for
705 READ/WRITE MULTIPLE */
706 unsigned int max_sectors
; /* per-device max sectors */
707 unsigned int cdb_len
;
709 /* per-dev xfer mask */
710 unsigned long pio_mask
;
711 unsigned long mwdma_mask
;
712 unsigned long udma_mask
;
714 /* for CHS addressing */
715 u16 cylinders
; /* Number of cylinders */
716 u16 heads
; /* Number of heads */
717 u16 sectors
; /* Number of sectors per track */
720 u16 id
[ATA_ID_WORDS
]; /* IDENTIFY xxx DEVICE data */
721 u32 gscr
[SATA_PMP_GSCR_DWORDS
]; /* PMP GSCR block */
724 /* DEVSLP Timing Variables from Identify Device Data Log */
725 u8 devslp_timing
[ATA_LOG_DEVSLP_SIZE
];
727 /* NCQ send and receive log subcommand support */
728 u8 ncq_send_recv_cmds
[ATA_LOG_NCQ_SEND_RECV_SIZE
];
732 /* ering is CLEAR_END, read comment above CLEAR_END */
733 struct ata_ering ering
;
736 /* Fields between ATA_DEVICE_CLEAR_BEGIN and ATA_DEVICE_CLEAR_END are
737 * cleared to zero on ata_dev_init().
739 #define ATA_DEVICE_CLEAR_BEGIN offsetof(struct ata_device, n_sectors)
740 #define ATA_DEVICE_CLEAR_END offsetof(struct ata_device, ering)
743 struct ata_device
*dev
; /* offending device */
744 u32 serror
; /* SError from LLDD */
745 unsigned int err_mask
; /* port-wide err_mask */
746 unsigned int action
; /* ATA_EH_* action mask */
747 unsigned int dev_action
[ATA_MAX_DEVICES
]; /* dev EH action */
748 unsigned int flags
; /* ATA_EHI_* flags */
750 unsigned int probe_mask
;
752 char desc
[ATA_EH_DESC_LEN
];
756 struct ata_eh_context
{
757 struct ata_eh_info i
;
758 int tries
[ATA_MAX_DEVICES
];
759 int cmd_timeout_idx
[ATA_MAX_DEVICES
]
760 [ATA_EH_CMD_TIMEOUT_TABLE_SIZE
];
761 unsigned int classes
[ATA_MAX_DEVICES
];
762 unsigned int did_probe_mask
;
763 unsigned int unloaded_mask
;
764 unsigned int saved_ncq_enabled
;
765 u8 saved_xfer_mode
[ATA_MAX_DEVICES
];
766 /* timestamp for the last reset attempt or success */
767 unsigned long last_reset
;
770 struct ata_acpi_drive
776 struct ata_acpi_gtm
{
777 struct ata_acpi_drive drive
[2];
783 int pmp
; /* port multiplier port # */
786 unsigned int active_tag
; /* active tag on this link */
787 u32 sactive
; /* active NCQ commands */
789 unsigned int flags
; /* ATA_LFLAG_xxx */
791 u32 saved_scontrol
; /* SControl on probe */
792 unsigned int hw_sata_spd_limit
;
793 unsigned int sata_spd_limit
;
794 unsigned int sata_spd
; /* current SATA PHY speed */
795 enum ata_lpm_policy lpm_policy
;
797 /* record runtime error info, protected by host_set lock */
798 struct ata_eh_info eh_info
;
800 struct ata_eh_context eh_context
;
802 struct ata_device device
[ATA_MAX_DEVICES
];
804 unsigned long last_lpm_change
; /* when last LPM change happened */
806 #define ATA_LINK_CLEAR_BEGIN offsetof(struct ata_link, active_tag)
807 #define ATA_LINK_CLEAR_END offsetof(struct ata_link, device[0])
810 struct Scsi_Host
*scsi_host
; /* our co-allocated scsi host */
811 struct ata_port_operations
*ops
;
813 /* Flags owned by the EH context. Only EH should touch these once the
815 unsigned long flags
; /* ATA_FLAG_xxx */
816 /* Flags that change dynamically, protected by ap->lock */
817 unsigned int pflags
; /* ATA_PFLAG_xxx */
818 unsigned int print_id
; /* user visible unique port ID */
819 unsigned int local_port_no
; /* host local port num */
820 unsigned int port_no
; /* 0 based port no. inside the host */
822 #ifdef CONFIG_ATA_SFF
823 struct ata_ioports ioaddr
; /* ATA cmd/ctl/dma register blocks */
824 u8 ctl
; /* cache of ATA control register */
825 u8 last_ctl
; /* Cache last written value */
826 struct ata_link
* sff_pio_task_link
; /* link currently used */
827 struct delayed_work sff_pio_task
;
828 #ifdef CONFIG_ATA_BMDMA
829 struct ata_bmdma_prd
*bmdma_prd
; /* BMDMA SG list */
830 dma_addr_t bmdma_prd_dma
; /* and its DMA mapping */
831 #endif /* CONFIG_ATA_BMDMA */
832 #endif /* CONFIG_ATA_SFF */
834 unsigned int pio_mask
;
835 unsigned int mwdma_mask
;
836 unsigned int udma_mask
;
837 unsigned int cbl
; /* cable type; ATA_CBL_xxx */
839 struct ata_queued_cmd qcmd
[ATA_MAX_QUEUE
];
840 unsigned long sas_tag_allocated
; /* for sas tag allocation only */
841 unsigned int qc_active
;
842 int nr_active_links
; /* #links with active qcs */
843 unsigned int sas_last_tag
; /* track next tag hw expects */
845 struct ata_link link
; /* host default link */
846 struct ata_link
*slave_link
; /* see ata_slave_link_init() */
848 int nr_pmp_links
; /* nr of available PMP links */
849 struct ata_link
*pmp_link
; /* array of PMP links */
850 struct ata_link
*excl_link
; /* for PMP qc exclusion */
852 struct ata_port_stats stats
;
853 struct ata_host
*host
;
857 struct mutex scsi_scan_mutex
;
858 struct delayed_work hotplug_task
;
859 struct work_struct scsi_rescan_task
;
861 unsigned int hsm_task_state
;
864 struct list_head eh_done_q
;
865 wait_queue_head_t eh_wait_q
;
867 struct completion park_req_pending
;
869 pm_message_t pm_mesg
;
870 enum ata_lpm_policy target_lpm_policy
;
872 struct timer_list fastdrain_timer
;
873 unsigned long fastdrain_cnt
;
878 #ifdef CONFIG_ATA_ACPI
879 struct ata_acpi_gtm __acpi_init_gtm
; /* use ata_acpi_init_gtm() */
882 u8 sector_buf
[ATA_SECT_SIZE
] ____cacheline_aligned
;
885 /* The following initializer overrides a method to NULL whether one of
886 * its parent has the method defined or not. This is equivalent to
887 * ERR_PTR(-ENOENT). Unfortunately, ERR_PTR doesn't render a constant
888 * expression and thus can't be used as an initializer.
890 #define ATA_OP_NULL (void *)(unsigned long)(-ENOENT)
892 struct ata_port_operations
{
896 int (*qc_defer
)(struct ata_queued_cmd
*qc
);
897 int (*check_atapi_dma
)(struct ata_queued_cmd
*qc
);
898 void (*qc_prep
)(struct ata_queued_cmd
*qc
);
899 unsigned int (*qc_issue
)(struct ata_queued_cmd
*qc
);
900 bool (*qc_fill_rtf
)(struct ata_queued_cmd
*qc
);
903 * Configuration and exception handling
905 int (*cable_detect
)(struct ata_port
*ap
);
906 unsigned long (*mode_filter
)(struct ata_device
*dev
, unsigned long xfer_mask
);
907 void (*set_piomode
)(struct ata_port
*ap
, struct ata_device
*dev
);
908 void (*set_dmamode
)(struct ata_port
*ap
, struct ata_device
*dev
);
909 int (*set_mode
)(struct ata_link
*link
, struct ata_device
**r_failed_dev
);
910 unsigned int (*read_id
)(struct ata_device
*dev
, struct ata_taskfile
*tf
, u16
*id
);
912 void (*dev_config
)(struct ata_device
*dev
);
914 void (*freeze
)(struct ata_port
*ap
);
915 void (*thaw
)(struct ata_port
*ap
);
916 ata_prereset_fn_t prereset
;
917 ata_reset_fn_t softreset
;
918 ata_reset_fn_t hardreset
;
919 ata_postreset_fn_t postreset
;
920 ata_prereset_fn_t pmp_prereset
;
921 ata_reset_fn_t pmp_softreset
;
922 ata_reset_fn_t pmp_hardreset
;
923 ata_postreset_fn_t pmp_postreset
;
924 void (*error_handler
)(struct ata_port
*ap
);
925 void (*lost_interrupt
)(struct ata_port
*ap
);
926 void (*post_internal_cmd
)(struct ata_queued_cmd
*qc
);
927 void (*sched_eh
)(struct ata_port
*ap
);
928 void (*end_eh
)(struct ata_port
*ap
);
933 int (*scr_read
)(struct ata_link
*link
, unsigned int sc_reg
, u32
*val
);
934 int (*scr_write
)(struct ata_link
*link
, unsigned int sc_reg
, u32 val
);
935 void (*pmp_attach
)(struct ata_port
*ap
);
936 void (*pmp_detach
)(struct ata_port
*ap
);
937 int (*set_lpm
)(struct ata_link
*link
, enum ata_lpm_policy policy
,
941 * Start, stop, suspend and resume
943 int (*port_suspend
)(struct ata_port
*ap
, pm_message_t mesg
);
944 int (*port_resume
)(struct ata_port
*ap
);
945 int (*port_start
)(struct ata_port
*ap
);
946 void (*port_stop
)(struct ata_port
*ap
);
947 void (*host_stop
)(struct ata_host
*host
);
949 #ifdef CONFIG_ATA_SFF
951 * SFF / taskfile oriented ops
953 void (*sff_dev_select
)(struct ata_port
*ap
, unsigned int device
);
954 void (*sff_set_devctl
)(struct ata_port
*ap
, u8 ctl
);
955 u8 (*sff_check_status
)(struct ata_port
*ap
);
956 u8 (*sff_check_altstatus
)(struct ata_port
*ap
);
957 void (*sff_tf_load
)(struct ata_port
*ap
, const struct ata_taskfile
*tf
);
958 void (*sff_tf_read
)(struct ata_port
*ap
, struct ata_taskfile
*tf
);
959 void (*sff_exec_command
)(struct ata_port
*ap
,
960 const struct ata_taskfile
*tf
);
961 unsigned int (*sff_data_xfer
)(struct ata_device
*dev
,
962 unsigned char *buf
, unsigned int buflen
, int rw
);
963 void (*sff_irq_on
)(struct ata_port
*);
964 bool (*sff_irq_check
)(struct ata_port
*);
965 void (*sff_irq_clear
)(struct ata_port
*);
966 void (*sff_drain_fifo
)(struct ata_queued_cmd
*qc
);
968 #ifdef CONFIG_ATA_BMDMA
969 void (*bmdma_setup
)(struct ata_queued_cmd
*qc
);
970 void (*bmdma_start
)(struct ata_queued_cmd
*qc
);
971 void (*bmdma_stop
)(struct ata_queued_cmd
*qc
);
972 u8 (*bmdma_status
)(struct ata_port
*ap
);
973 #endif /* CONFIG_ATA_BMDMA */
974 #endif /* CONFIG_ATA_SFF */
976 ssize_t (*em_show
)(struct ata_port
*ap
, char *buf
);
977 ssize_t (*em_store
)(struct ata_port
*ap
, const char *message
,
979 ssize_t (*sw_activity_show
)(struct ata_device
*dev
, char *buf
);
980 ssize_t (*sw_activity_store
)(struct ata_device
*dev
,
981 enum sw_activity val
);
982 ssize_t (*transmit_led_message
)(struct ata_port
*ap
, u32 state
,
988 void (*phy_reset
)(struct ata_port
*ap
);
989 void (*eng_timeout
)(struct ata_port
*ap
);
992 * ->inherits must be the last field and all the preceding
993 * fields must be pointers.
995 const struct ata_port_operations
*inherits
;
998 struct ata_port_info
{
1000 unsigned long link_flags
;
1001 unsigned long pio_mask
;
1002 unsigned long mwdma_mask
;
1003 unsigned long udma_mask
;
1004 struct ata_port_operations
*port_ops
;
1009 unsigned short mode
; /* ATA mode */
1010 unsigned short setup
; /* t1 */
1011 unsigned short act8b
; /* t2 for 8-bit I/O */
1012 unsigned short rec8b
; /* t2i for 8-bit I/O */
1013 unsigned short cyc8b
; /* t0 for 8-bit I/O */
1014 unsigned short active
; /* t2 or tD */
1015 unsigned short recover
; /* t2i or tK */
1016 unsigned short dmack_hold
; /* tj */
1017 unsigned short cycle
; /* t0 */
1018 unsigned short udma
; /* t2CYCTYP/2 */
1022 * Core layer - drivers/ata/libata-core.c
1024 extern const unsigned long sata_deb_timing_normal
[];
1025 extern const unsigned long sata_deb_timing_hotplug
[];
1026 extern const unsigned long sata_deb_timing_long
[];
1028 extern struct ata_port_operations ata_dummy_port_ops
;
1029 extern const struct ata_port_info ata_dummy_port_info
;
1034 static inline unsigned int ata_prot_flags(u8 prot
)
1037 case ATA_PROT_NODATA
:
1040 return ATA_PROT_FLAG_PIO
;
1042 return ATA_PROT_FLAG_DMA
;
1044 return ATA_PROT_FLAG_DMA
| ATA_PROT_FLAG_NCQ
;
1045 case ATAPI_PROT_NODATA
:
1046 return ATA_PROT_FLAG_ATAPI
;
1047 case ATAPI_PROT_PIO
:
1048 return ATA_PROT_FLAG_ATAPI
| ATA_PROT_FLAG_PIO
;
1049 case ATAPI_PROT_DMA
:
1050 return ATA_PROT_FLAG_ATAPI
| ATA_PROT_FLAG_DMA
;
1055 static inline int ata_is_atapi(u8 prot
)
1057 return ata_prot_flags(prot
) & ATA_PROT_FLAG_ATAPI
;
1060 static inline int ata_is_nodata(u8 prot
)
1062 return !(ata_prot_flags(prot
) & ATA_PROT_FLAG_DATA
);
1065 static inline int ata_is_pio(u8 prot
)
1067 return ata_prot_flags(prot
) & ATA_PROT_FLAG_PIO
;
1070 static inline int ata_is_dma(u8 prot
)
1072 return ata_prot_flags(prot
) & ATA_PROT_FLAG_DMA
;
1075 static inline int ata_is_ncq(u8 prot
)
1077 return ata_prot_flags(prot
) & ATA_PROT_FLAG_NCQ
;
1080 static inline int ata_is_data(u8 prot
)
1082 return ata_prot_flags(prot
) & ATA_PROT_FLAG_DATA
;
1085 static inline int is_multi_taskfile(struct ata_taskfile
*tf
)
1087 return (tf
->command
== ATA_CMD_READ_MULTI
) ||
1088 (tf
->command
== ATA_CMD_WRITE_MULTI
) ||
1089 (tf
->command
== ATA_CMD_READ_MULTI_EXT
) ||
1090 (tf
->command
== ATA_CMD_WRITE_MULTI_EXT
) ||
1091 (tf
->command
== ATA_CMD_WRITE_MULTI_FUA_EXT
);
1094 static inline const unsigned long *
1095 sata_ehc_deb_timing(struct ata_eh_context
*ehc
)
1097 if (ehc
->i
.flags
& ATA_EHI_HOTPLUGGED
)
1098 return sata_deb_timing_hotplug
;
1100 return sata_deb_timing_normal
;
1103 static inline int ata_port_is_dummy(struct ata_port
*ap
)
1105 return ap
->ops
== &ata_dummy_port_ops
;
1108 extern int sata_set_spd(struct ata_link
*link
);
1109 extern int ata_std_prereset(struct ata_link
*link
, unsigned long deadline
);
1110 extern int ata_wait_after_reset(struct ata_link
*link
, unsigned long deadline
,
1111 int (*check_ready
)(struct ata_link
*link
));
1112 extern int sata_link_debounce(struct ata_link
*link
,
1113 const unsigned long *params
, unsigned long deadline
);
1114 extern int sata_link_resume(struct ata_link
*link
, const unsigned long *params
,
1115 unsigned long deadline
);
1116 extern int sata_link_scr_lpm(struct ata_link
*link
, enum ata_lpm_policy policy
,
1118 extern int sata_link_hardreset(struct ata_link
*link
,
1119 const unsigned long *timing
, unsigned long deadline
,
1120 bool *online
, int (*check_ready
)(struct ata_link
*));
1121 extern int sata_std_hardreset(struct ata_link
*link
, unsigned int *class,
1122 unsigned long deadline
);
1123 extern void ata_std_postreset(struct ata_link
*link
, unsigned int *classes
);
1125 extern struct ata_host
*ata_host_alloc(struct device
*dev
, int max_ports
);
1126 extern struct ata_host
*ata_host_alloc_pinfo(struct device
*dev
,
1127 const struct ata_port_info
* const * ppi
, int n_ports
);
1128 extern int ata_slave_link_init(struct ata_port
*ap
);
1129 extern int ata_host_start(struct ata_host
*host
);
1130 extern int ata_host_register(struct ata_host
*host
,
1131 struct scsi_host_template
*sht
);
1132 extern int ata_host_activate(struct ata_host
*host
, int irq
,
1133 irq_handler_t irq_handler
, unsigned long irq_flags
,
1134 struct scsi_host_template
*sht
);
1135 extern void ata_host_detach(struct ata_host
*host
);
1136 extern void ata_host_init(struct ata_host
*, struct device
*, struct ata_port_operations
*);
1137 extern int ata_scsi_detect(struct scsi_host_template
*sht
);
1138 extern int ata_scsi_ioctl(struct scsi_device
*dev
, int cmd
, void __user
*arg
);
1139 extern int ata_scsi_queuecmd(struct Scsi_Host
*h
, struct scsi_cmnd
*cmd
);
1140 extern int ata_sas_scsi_ioctl(struct ata_port
*ap
, struct scsi_device
*dev
,
1141 int cmd
, void __user
*arg
);
1142 extern void ata_sas_port_destroy(struct ata_port
*);
1143 extern struct ata_port
*ata_sas_port_alloc(struct ata_host
*,
1144 struct ata_port_info
*, struct Scsi_Host
*);
1145 extern void ata_sas_async_probe(struct ata_port
*ap
);
1146 extern int ata_sas_sync_probe(struct ata_port
*ap
);
1147 extern int ata_sas_port_init(struct ata_port
*);
1148 extern int ata_sas_port_start(struct ata_port
*ap
);
1149 extern void ata_sas_port_stop(struct ata_port
*ap
);
1150 extern int ata_sas_slave_configure(struct scsi_device
*, struct ata_port
*);
1151 extern int ata_sas_queuecmd(struct scsi_cmnd
*cmd
, struct ata_port
*ap
);
1152 extern int sata_scr_valid(struct ata_link
*link
);
1153 extern int sata_scr_read(struct ata_link
*link
, int reg
, u32
*val
);
1154 extern int sata_scr_write(struct ata_link
*link
, int reg
, u32 val
);
1155 extern int sata_scr_write_flush(struct ata_link
*link
, int reg
, u32 val
);
1156 extern bool ata_link_online(struct ata_link
*link
);
1157 extern bool ata_link_offline(struct ata_link
*link
);
1159 extern int ata_host_suspend(struct ata_host
*host
, pm_message_t mesg
);
1160 extern void ata_host_resume(struct ata_host
*host
);
1161 extern void ata_sas_port_suspend(struct ata_port
*ap
);
1162 extern void ata_sas_port_resume(struct ata_port
*ap
);
1164 static inline void ata_sas_port_suspend(struct ata_port
*ap
)
1167 static inline void ata_sas_port_resume(struct ata_port
*ap
)
1171 extern int ata_ratelimit(void);
1172 extern void ata_msleep(struct ata_port
*ap
, unsigned int msecs
);
1173 extern u32
ata_wait_register(struct ata_port
*ap
, void __iomem
*reg
, u32 mask
,
1174 u32 val
, unsigned long interval
, unsigned long timeout
);
1175 extern int atapi_cmd_type(u8 opcode
);
1176 extern void ata_tf_to_fis(const struct ata_taskfile
*tf
,
1177 u8 pmp
, int is_cmd
, u8
*fis
);
1178 extern void ata_tf_from_fis(const u8
*fis
, struct ata_taskfile
*tf
);
1179 extern unsigned long ata_pack_xfermask(unsigned long pio_mask
,
1180 unsigned long mwdma_mask
, unsigned long udma_mask
);
1181 extern void ata_unpack_xfermask(unsigned long xfer_mask
,
1182 unsigned long *pio_mask
, unsigned long *mwdma_mask
,
1183 unsigned long *udma_mask
);
1184 extern u8
ata_xfer_mask2mode(unsigned long xfer_mask
);
1185 extern unsigned long ata_xfer_mode2mask(u8 xfer_mode
);
1186 extern int ata_xfer_mode2shift(unsigned long xfer_mode
);
1187 extern const char *ata_mode_string(unsigned long xfer_mask
);
1188 extern unsigned long ata_id_xfermask(const u16
*id
);
1189 extern int ata_std_qc_defer(struct ata_queued_cmd
*qc
);
1190 extern void ata_noop_qc_prep(struct ata_queued_cmd
*qc
);
1191 extern void ata_sg_init(struct ata_queued_cmd
*qc
, struct scatterlist
*sg
,
1192 unsigned int n_elem
);
1193 extern unsigned int ata_dev_classify(const struct ata_taskfile
*tf
);
1194 extern void ata_dev_disable(struct ata_device
*adev
);
1195 extern void ata_id_string(const u16
*id
, unsigned char *s
,
1196 unsigned int ofs
, unsigned int len
);
1197 extern void ata_id_c_string(const u16
*id
, unsigned char *s
,
1198 unsigned int ofs
, unsigned int len
);
1199 extern unsigned int ata_do_dev_read_id(struct ata_device
*dev
,
1200 struct ata_taskfile
*tf
, u16
*id
);
1201 extern void ata_qc_complete(struct ata_queued_cmd
*qc
);
1202 extern int ata_qc_complete_multiple(struct ata_port
*ap
, u32 qc_active
);
1203 extern void ata_scsi_simulate(struct ata_device
*dev
, struct scsi_cmnd
*cmd
);
1204 extern int ata_std_bios_param(struct scsi_device
*sdev
,
1205 struct block_device
*bdev
,
1206 sector_t capacity
, int geom
[]);
1207 extern void ata_scsi_unlock_native_capacity(struct scsi_device
*sdev
);
1208 extern int ata_scsi_slave_config(struct scsi_device
*sdev
);
1209 extern void ata_scsi_slave_destroy(struct scsi_device
*sdev
);
1210 extern int ata_scsi_change_queue_depth(struct scsi_device
*sdev
,
1212 extern int __ata_change_queue_depth(struct ata_port
*ap
, struct scsi_device
*sdev
,
1214 extern struct ata_device
*ata_dev_pair(struct ata_device
*adev
);
1215 extern int ata_do_set_mode(struct ata_link
*link
, struct ata_device
**r_failed_dev
);
1216 extern void ata_scsi_port_error_handler(struct Scsi_Host
*host
, struct ata_port
*ap
);
1217 extern void ata_scsi_cmd_error_handler(struct Scsi_Host
*host
, struct ata_port
*ap
, struct list_head
*eh_q
);
1218 extern bool sata_lpm_ignore_phy_events(struct ata_link
*link
);
1220 extern int ata_cable_40wire(struct ata_port
*ap
);
1221 extern int ata_cable_80wire(struct ata_port
*ap
);
1222 extern int ata_cable_sata(struct ata_port
*ap
);
1223 extern int ata_cable_ignore(struct ata_port
*ap
);
1224 extern int ata_cable_unknown(struct ata_port
*ap
);
1226 /* Timing helpers */
1227 extern unsigned int ata_pio_need_iordy(const struct ata_device
*);
1228 extern const struct ata_timing
*ata_timing_find_mode(u8 xfer_mode
);
1229 extern int ata_timing_compute(struct ata_device
*, unsigned short,
1230 struct ata_timing
*, int, int);
1231 extern void ata_timing_merge(const struct ata_timing
*,
1232 const struct ata_timing
*, struct ata_timing
*,
1234 extern u8
ata_timing_cycle2mode(unsigned int xfer_shift
, int cycle
);
1241 unsigned int reg
; /* PCI config register to read */
1242 unsigned int width
; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
1247 extern int pci_test_config_bits(struct pci_dev
*pdev
, const struct pci_bits
*bits
);
1248 extern void ata_pci_remove_one(struct pci_dev
*pdev
);
1251 extern void ata_pci_device_do_suspend(struct pci_dev
*pdev
, pm_message_t mesg
);
1252 extern int __must_check
ata_pci_device_do_resume(struct pci_dev
*pdev
);
1253 extern int ata_pci_device_suspend(struct pci_dev
*pdev
, pm_message_t mesg
);
1254 extern int ata_pci_device_resume(struct pci_dev
*pdev
);
1255 #endif /* CONFIG_PM */
1256 #endif /* CONFIG_PCI */
1258 struct platform_device
;
1260 extern int ata_platform_remove_one(struct platform_device
*pdev
);
1263 * ACPI - drivers/ata/libata-acpi.c
1265 #ifdef CONFIG_ATA_ACPI
1266 static inline const struct ata_acpi_gtm
*ata_acpi_init_gtm(struct ata_port
*ap
)
1268 if (ap
->pflags
& ATA_PFLAG_INIT_GTM_VALID
)
1269 return &ap
->__acpi_init_gtm
;
1272 int ata_acpi_stm(struct ata_port
*ap
, const struct ata_acpi_gtm
*stm
);
1273 int ata_acpi_gtm(struct ata_port
*ap
, struct ata_acpi_gtm
*stm
);
1274 unsigned long ata_acpi_gtm_xfermask(struct ata_device
*dev
,
1275 const struct ata_acpi_gtm
*gtm
);
1276 int ata_acpi_cbl_80wire(struct ata_port
*ap
, const struct ata_acpi_gtm
*gtm
);
1278 static inline const struct ata_acpi_gtm
*ata_acpi_init_gtm(struct ata_port
*ap
)
1283 static inline int ata_acpi_stm(const struct ata_port
*ap
,
1284 struct ata_acpi_gtm
*stm
)
1289 static inline int ata_acpi_gtm(const struct ata_port
*ap
,
1290 struct ata_acpi_gtm
*stm
)
1295 static inline unsigned int ata_acpi_gtm_xfermask(struct ata_device
*dev
,
1296 const struct ata_acpi_gtm
*gtm
)
1301 static inline int ata_acpi_cbl_80wire(struct ata_port
*ap
,
1302 const struct ata_acpi_gtm
*gtm
)
1309 * EH - drivers/ata/libata-eh.c
1311 extern void ata_port_schedule_eh(struct ata_port
*ap
);
1312 extern void ata_port_wait_eh(struct ata_port
*ap
);
1313 extern int ata_link_abort(struct ata_link
*link
);
1314 extern int ata_port_abort(struct ata_port
*ap
);
1315 extern int ata_port_freeze(struct ata_port
*ap
);
1316 extern int sata_async_notification(struct ata_port
*ap
);
1318 extern void ata_eh_freeze_port(struct ata_port
*ap
);
1319 extern void ata_eh_thaw_port(struct ata_port
*ap
);
1321 extern void ata_eh_qc_complete(struct ata_queued_cmd
*qc
);
1322 extern void ata_eh_qc_retry(struct ata_queued_cmd
*qc
);
1323 extern void ata_eh_analyze_ncq_error(struct ata_link
*link
);
1325 extern void ata_do_eh(struct ata_port
*ap
, ata_prereset_fn_t prereset
,
1326 ata_reset_fn_t softreset
, ata_reset_fn_t hardreset
,
1327 ata_postreset_fn_t postreset
);
1328 extern void ata_std_error_handler(struct ata_port
*ap
);
1329 extern void ata_std_sched_eh(struct ata_port
*ap
);
1330 extern void ata_std_end_eh(struct ata_port
*ap
);
1331 extern int ata_link_nr_enabled(struct ata_link
*link
);
1334 * Base operations to inherit from and initializers for sht
1338 * base : Common to all libata drivers.
1339 * sata : SATA controllers w/ native interface.
1340 * pmp : SATA controllers w/ PMP support.
1341 * sff : SFF ATA controllers w/o BMDMA support.
1342 * bmdma : SFF ATA controllers w/ BMDMA support.
1346 * BASE : Common to all libata drivers. The user must set
1347 * sg_tablesize and dma_boundary.
1348 * PIO : SFF ATA controllers w/ only PIO support.
1349 * BMDMA : SFF ATA controllers w/ BMDMA support. sg_tablesize and
1350 * dma_boundary are set to BMDMA limits.
1351 * NCQ : SATA controllers supporting NCQ. The user must set
1352 * sg_tablesize, dma_boundary and can_queue.
1354 extern const struct ata_port_operations ata_base_port_ops
;
1355 extern const struct ata_port_operations sata_port_ops
;
1356 extern struct device_attribute
*ata_common_sdev_attrs
[];
1359 * All sht initializers (BASE, PIO, BMDMA, NCQ) must be instantiated
1360 * by the edge drivers. Because the 'module' field of sht must be the
1361 * edge driver's module reference, otherwise the driver can be unloaded
1362 * even if the scsi_device is being accessed.
1364 #define ATA_BASE_SHT(drv_name) \
1365 .module = THIS_MODULE, \
1367 .ioctl = ata_scsi_ioctl, \
1368 .queuecommand = ata_scsi_queuecmd, \
1369 .can_queue = ATA_DEF_QUEUE, \
1370 .tag_alloc_policy = BLK_TAG_ALLOC_RR, \
1371 .this_id = ATA_SHT_THIS_ID, \
1372 .emulated = ATA_SHT_EMULATED, \
1373 .use_clustering = ATA_SHT_USE_CLUSTERING, \
1374 .proc_name = drv_name, \
1375 .slave_configure = ata_scsi_slave_config, \
1376 .slave_destroy = ata_scsi_slave_destroy, \
1377 .bios_param = ata_std_bios_param, \
1378 .unlock_native_capacity = ata_scsi_unlock_native_capacity, \
1379 .sdev_attrs = ata_common_sdev_attrs
1381 #define ATA_NCQ_SHT(drv_name) \
1382 ATA_BASE_SHT(drv_name), \
1383 .change_queue_depth = ata_scsi_change_queue_depth
1388 #ifdef CONFIG_SATA_PMP
1389 static inline bool sata_pmp_supported(struct ata_port
*ap
)
1391 return ap
->flags
& ATA_FLAG_PMP
;
1394 static inline bool sata_pmp_attached(struct ata_port
*ap
)
1396 return ap
->nr_pmp_links
!= 0;
1399 static inline int ata_is_host_link(const struct ata_link
*link
)
1401 return link
== &link
->ap
->link
|| link
== link
->ap
->slave_link
;
1403 #else /* CONFIG_SATA_PMP */
1404 static inline bool sata_pmp_supported(struct ata_port
*ap
)
1409 static inline bool sata_pmp_attached(struct ata_port
*ap
)
1414 static inline int ata_is_host_link(const struct ata_link
*link
)
1418 #endif /* CONFIG_SATA_PMP */
1420 static inline int sata_srst_pmp(struct ata_link
*link
)
1422 if (sata_pmp_supported(link
->ap
) && ata_is_host_link(link
))
1423 return SATA_PMP_CTRL_PORT
;
1431 void ata_port_printk(const struct ata_port
*ap
, const char *level
,
1432 const char *fmt
, ...);
1434 void ata_link_printk(const struct ata_link
*link
, const char *level
,
1435 const char *fmt
, ...);
1437 void ata_dev_printk(const struct ata_device
*dev
, const char *level
,
1438 const char *fmt
, ...);
1440 #define ata_port_err(ap, fmt, ...) \
1441 ata_port_printk(ap, KERN_ERR, fmt, ##__VA_ARGS__)
1442 #define ata_port_warn(ap, fmt, ...) \
1443 ata_port_printk(ap, KERN_WARNING, fmt, ##__VA_ARGS__)
1444 #define ata_port_notice(ap, fmt, ...) \
1445 ata_port_printk(ap, KERN_NOTICE, fmt, ##__VA_ARGS__)
1446 #define ata_port_info(ap, fmt, ...) \
1447 ata_port_printk(ap, KERN_INFO, fmt, ##__VA_ARGS__)
1448 #define ata_port_dbg(ap, fmt, ...) \
1449 ata_port_printk(ap, KERN_DEBUG, fmt, ##__VA_ARGS__)
1451 #define ata_link_err(link, fmt, ...) \
1452 ata_link_printk(link, KERN_ERR, fmt, ##__VA_ARGS__)
1453 #define ata_link_warn(link, fmt, ...) \
1454 ata_link_printk(link, KERN_WARNING, fmt, ##__VA_ARGS__)
1455 #define ata_link_notice(link, fmt, ...) \
1456 ata_link_printk(link, KERN_NOTICE, fmt, ##__VA_ARGS__)
1457 #define ata_link_info(link, fmt, ...) \
1458 ata_link_printk(link, KERN_INFO, fmt, ##__VA_ARGS__)
1459 #define ata_link_dbg(link, fmt, ...) \
1460 ata_link_printk(link, KERN_DEBUG, fmt, ##__VA_ARGS__)
1462 #define ata_dev_err(dev, fmt, ...) \
1463 ata_dev_printk(dev, KERN_ERR, fmt, ##__VA_ARGS__)
1464 #define ata_dev_warn(dev, fmt, ...) \
1465 ata_dev_printk(dev, KERN_WARNING, fmt, ##__VA_ARGS__)
1466 #define ata_dev_notice(dev, fmt, ...) \
1467 ata_dev_printk(dev, KERN_NOTICE, fmt, ##__VA_ARGS__)
1468 #define ata_dev_info(dev, fmt, ...) \
1469 ata_dev_printk(dev, KERN_INFO, fmt, ##__VA_ARGS__)
1470 #define ata_dev_dbg(dev, fmt, ...) \
1471 ata_dev_printk(dev, KERN_DEBUG, fmt, ##__VA_ARGS__)
1473 void ata_print_version(const struct device
*dev
, const char *version
);
1476 * ata_eh_info helpers
1478 extern __printf(2, 3)
1479 void __ata_ehi_push_desc(struct ata_eh_info
*ehi
, const char *fmt
, ...);
1480 extern __printf(2, 3)
1481 void ata_ehi_push_desc(struct ata_eh_info
*ehi
, const char *fmt
, ...);
1482 extern void ata_ehi_clear_desc(struct ata_eh_info
*ehi
);
1484 static inline void ata_ehi_hotplugged(struct ata_eh_info
*ehi
)
1486 ehi
->probe_mask
|= (1 << ATA_MAX_DEVICES
) - 1;
1487 ehi
->flags
|= ATA_EHI_HOTPLUGGED
;
1488 ehi
->action
|= ATA_EH_RESET
| ATA_EH_ENABLE_LINK
;
1489 ehi
->err_mask
|= AC_ERR_ATA_BUS
;
1493 * port description helpers
1495 extern __printf(2, 3)
1496 void ata_port_desc(struct ata_port
*ap
, const char *fmt
, ...);
1498 extern void ata_port_pbar_desc(struct ata_port
*ap
, int bar
, ssize_t offset
,
1502 static inline unsigned int ata_tag_valid(unsigned int tag
)
1504 return (tag
< ATA_MAX_QUEUE
) ? 1 : 0;
1507 static inline unsigned int ata_tag_internal(unsigned int tag
)
1509 return tag
== ATA_TAG_INTERNAL
;
1515 static inline unsigned int ata_class_enabled(unsigned int class)
1517 return class == ATA_DEV_ATA
|| class == ATA_DEV_ATAPI
||
1518 class == ATA_DEV_PMP
|| class == ATA_DEV_SEMB
||
1519 class == ATA_DEV_ZAC
;
1522 static inline unsigned int ata_class_disabled(unsigned int class)
1524 return class == ATA_DEV_ATA_UNSUP
|| class == ATA_DEV_ATAPI_UNSUP
||
1525 class == ATA_DEV_PMP_UNSUP
|| class == ATA_DEV_SEMB_UNSUP
;
1528 static inline unsigned int ata_class_absent(unsigned int class)
1530 return !ata_class_enabled(class) && !ata_class_disabled(class);
1533 static inline unsigned int ata_dev_enabled(const struct ata_device
*dev
)
1535 return ata_class_enabled(dev
->class);
1538 static inline unsigned int ata_dev_disabled(const struct ata_device
*dev
)
1540 return ata_class_disabled(dev
->class);
1543 static inline unsigned int ata_dev_absent(const struct ata_device
*dev
)
1545 return ata_class_absent(dev
->class);
1551 static inline int ata_link_max_devices(const struct ata_link
*link
)
1553 if (ata_is_host_link(link
) && link
->ap
->flags
& ATA_FLAG_SLAVE_POSS
)
1558 static inline int ata_link_active(struct ata_link
*link
)
1560 return ata_tag_valid(link
->active_tag
) || link
->sactive
;
1566 * ATA_LITER_* constants are used to select link iteration mode and
1567 * ATA_DITER_* device iteration mode.
1569 * For a custom iteration directly using ata_{link|dev}_next(), if
1570 * @link or @dev, respectively, is NULL, the first element is
1571 * returned. @dev and @link can be any valid device or link and the
1572 * next element according to the iteration mode will be returned.
1573 * After the last element, NULL is returned.
1575 enum ata_link_iter_mode
{
1576 ATA_LITER_EDGE
, /* if present, PMP links only; otherwise,
1577 * host link. no slave link */
1578 ATA_LITER_HOST_FIRST
, /* host link followed by PMP or slave links */
1579 ATA_LITER_PMP_FIRST
, /* PMP links followed by host link,
1580 * slave link still comes after host link */
1583 enum ata_dev_iter_mode
{
1585 ATA_DITER_ENABLED_REVERSE
,
1587 ATA_DITER_ALL_REVERSE
,
1590 extern struct ata_link
*ata_link_next(struct ata_link
*link
,
1591 struct ata_port
*ap
,
1592 enum ata_link_iter_mode mode
);
1594 extern struct ata_device
*ata_dev_next(struct ata_device
*dev
,
1595 struct ata_link
*link
,
1596 enum ata_dev_iter_mode mode
);
1599 * Shortcut notation for iterations
1601 * ata_for_each_link() iterates over each link of @ap according to
1602 * @mode. @link points to the current link in the loop. @link is
1603 * NULL after loop termination. ata_for_each_dev() works the same way
1604 * except that it iterates over each device of @link.
1606 * Note that the mode prefixes ATA_{L|D}ITER_ shouldn't need to be
1607 * specified when using the following shorthand notations. Only the
1608 * mode itself (EDGE, HOST_FIRST, ENABLED, etc...) should be
1609 * specified. This not only increases brevity but also makes it
1610 * impossible to use ATA_LITER_* for device iteration or vice-versa.
1612 #define ata_for_each_link(link, ap, mode) \
1613 for ((link) = ata_link_next(NULL, (ap), ATA_LITER_##mode); (link); \
1614 (link) = ata_link_next((link), (ap), ATA_LITER_##mode))
1616 #define ata_for_each_dev(dev, link, mode) \
1617 for ((dev) = ata_dev_next(NULL, (link), ATA_DITER_##mode); (dev); \
1618 (dev) = ata_dev_next((dev), (link), ATA_DITER_##mode))
1621 * ata_ncq_enabled - Test whether NCQ is enabled
1622 * @dev: ATA device to test for
1625 * spin_lock_irqsave(host lock)
1628 * 1 if NCQ is enabled for @dev, 0 otherwise.
1630 static inline int ata_ncq_enabled(struct ata_device
*dev
)
1632 return (dev
->flags
& (ATA_DFLAG_PIO
| ATA_DFLAG_NCQ_OFF
|
1633 ATA_DFLAG_NCQ
)) == ATA_DFLAG_NCQ
;
1636 static inline bool ata_fpdma_dsm_supported(struct ata_device
*dev
)
1638 return (dev
->flags
& ATA_DFLAG_NCQ_SEND_RECV
) &&
1639 (dev
->ncq_send_recv_cmds
[ATA_LOG_NCQ_SEND_RECV_DSM_OFFSET
] &
1640 ATA_LOG_NCQ_SEND_RECV_DSM_TRIM
);
1643 static inline void ata_qc_set_polling(struct ata_queued_cmd
*qc
)
1645 qc
->tf
.ctl
|= ATA_NIEN
;
1648 static inline struct ata_queued_cmd
*__ata_qc_from_tag(struct ata_port
*ap
,
1651 if (likely(ata_tag_valid(tag
)))
1652 return &ap
->qcmd
[tag
];
1656 static inline struct ata_queued_cmd
*ata_qc_from_tag(struct ata_port
*ap
,
1659 struct ata_queued_cmd
*qc
= __ata_qc_from_tag(ap
, tag
);
1661 if (unlikely(!qc
) || !ap
->ops
->error_handler
)
1664 if ((qc
->flags
& (ATA_QCFLAG_ACTIVE
|
1665 ATA_QCFLAG_FAILED
)) == ATA_QCFLAG_ACTIVE
)
1671 static inline unsigned int ata_qc_raw_nbytes(struct ata_queued_cmd
*qc
)
1673 return qc
->nbytes
- min(qc
->extrabytes
, qc
->nbytes
);
1676 static inline void ata_tf_init(struct ata_device
*dev
, struct ata_taskfile
*tf
)
1678 memset(tf
, 0, sizeof(*tf
));
1680 #ifdef CONFIG_ATA_SFF
1681 tf
->ctl
= dev
->link
->ap
->ctl
;
1683 tf
->ctl
= ATA_DEVCTL_OBS
;
1685 if (dev
->devno
== 0)
1686 tf
->device
= ATA_DEVICE_OBS
;
1688 tf
->device
= ATA_DEVICE_OBS
| ATA_DEV1
;
1691 static inline void ata_qc_reinit(struct ata_queued_cmd
*qc
)
1693 qc
->dma_dir
= DMA_NONE
;
1698 qc
->nbytes
= qc
->extrabytes
= qc
->curbytes
= 0;
1701 qc
->sect_size
= ATA_SECT_SIZE
;
1703 ata_tf_init(qc
->dev
, &qc
->tf
);
1705 /* init result_tf such that it indicates normal completion */
1706 qc
->result_tf
.command
= ATA_DRDY
;
1707 qc
->result_tf
.feature
= 0;
1710 static inline int ata_try_flush_cache(const struct ata_device
*dev
)
1712 return ata_id_wcache_enabled(dev
->id
) ||
1713 ata_id_has_flush(dev
->id
) ||
1714 ata_id_has_flush_ext(dev
->id
);
1717 static inline unsigned int ac_err_mask(u8 status
)
1719 if (status
& (ATA_BUSY
| ATA_DRQ
))
1721 if (status
& (ATA_ERR
| ATA_DF
))
1726 static inline unsigned int __ac_err_mask(u8 status
)
1728 unsigned int mask
= ac_err_mask(status
);
1730 return AC_ERR_OTHER
;
1734 static inline struct ata_port
*ata_shost_to_port(struct Scsi_Host
*host
)
1736 return *(struct ata_port
**)&host
->hostdata
[0];
1739 static inline int ata_check_ready(u8 status
)
1741 if (!(status
& ATA_BUSY
))
1744 /* 0xff indicates either no device or device not ready */
1751 static inline unsigned long ata_deadline(unsigned long from_jiffies
,
1752 unsigned long timeout_msecs
)
1754 return from_jiffies
+ msecs_to_jiffies(timeout_msecs
);
1757 /* Don't open code these in drivers as there are traps. Firstly the range may
1758 change in future hardware and specs, secondly 0xFF means 'no DMA' but is
1759 > UDMA_0. Dyma ddreigiau */
1761 static inline int ata_using_mwdma(struct ata_device
*adev
)
1763 if (adev
->dma_mode
>= XFER_MW_DMA_0
&& adev
->dma_mode
<= XFER_MW_DMA_4
)
1768 static inline int ata_using_udma(struct ata_device
*adev
)
1770 if (adev
->dma_mode
>= XFER_UDMA_0
&& adev
->dma_mode
<= XFER_UDMA_7
)
1775 static inline int ata_dma_enabled(struct ata_device
*adev
)
1777 return (adev
->dma_mode
== 0xFF ? 0 : 1);
1780 /**************************************************************************
1781 * PMP - drivers/ata/libata-pmp.c
1783 #ifdef CONFIG_SATA_PMP
1785 extern const struct ata_port_operations sata_pmp_port_ops
;
1787 extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd
*qc
);
1788 extern void sata_pmp_error_handler(struct ata_port
*ap
);
1790 #else /* CONFIG_SATA_PMP */
1792 #define sata_pmp_port_ops sata_port_ops
1793 #define sata_pmp_qc_defer_cmd_switch ata_std_qc_defer
1794 #define sata_pmp_error_handler ata_std_error_handler
1796 #endif /* CONFIG_SATA_PMP */
1799 /**************************************************************************
1800 * SFF - drivers/ata/libata-sff.c
1802 #ifdef CONFIG_ATA_SFF
1804 extern const struct ata_port_operations ata_sff_port_ops
;
1805 extern const struct ata_port_operations ata_bmdma32_port_ops
;
1807 /* PIO only, sg_tablesize and dma_boundary limits can be removed */
1808 #define ATA_PIO_SHT(drv_name) \
1809 ATA_BASE_SHT(drv_name), \
1810 .sg_tablesize = LIBATA_MAX_PRD, \
1811 .dma_boundary = ATA_DMA_BOUNDARY
1813 extern void ata_sff_dev_select(struct ata_port
*ap
, unsigned int device
);
1814 extern u8
ata_sff_check_status(struct ata_port
*ap
);
1815 extern void ata_sff_pause(struct ata_port
*ap
);
1816 extern void ata_sff_dma_pause(struct ata_port
*ap
);
1817 extern int ata_sff_busy_sleep(struct ata_port
*ap
,
1818 unsigned long timeout_pat
, unsigned long timeout
);
1819 extern int ata_sff_wait_ready(struct ata_link
*link
, unsigned long deadline
);
1820 extern void ata_sff_tf_load(struct ata_port
*ap
, const struct ata_taskfile
*tf
);
1821 extern void ata_sff_tf_read(struct ata_port
*ap
, struct ata_taskfile
*tf
);
1822 extern void ata_sff_exec_command(struct ata_port
*ap
,
1823 const struct ata_taskfile
*tf
);
1824 extern unsigned int ata_sff_data_xfer(struct ata_device
*dev
,
1825 unsigned char *buf
, unsigned int buflen
, int rw
);
1826 extern unsigned int ata_sff_data_xfer32(struct ata_device
*dev
,
1827 unsigned char *buf
, unsigned int buflen
, int rw
);
1828 extern unsigned int ata_sff_data_xfer_noirq(struct ata_device
*dev
,
1829 unsigned char *buf
, unsigned int buflen
, int rw
);
1830 extern void ata_sff_irq_on(struct ata_port
*ap
);
1831 extern void ata_sff_irq_clear(struct ata_port
*ap
);
1832 extern int ata_sff_hsm_move(struct ata_port
*ap
, struct ata_queued_cmd
*qc
,
1833 u8 status
, int in_wq
);
1834 extern void ata_sff_queue_work(struct work_struct
*work
);
1835 extern void ata_sff_queue_delayed_work(struct delayed_work
*dwork
,
1836 unsigned long delay
);
1837 extern void ata_sff_queue_pio_task(struct ata_link
*link
, unsigned long delay
);
1838 extern unsigned int ata_sff_qc_issue(struct ata_queued_cmd
*qc
);
1839 extern bool ata_sff_qc_fill_rtf(struct ata_queued_cmd
*qc
);
1840 extern unsigned int ata_sff_port_intr(struct ata_port
*ap
,
1841 struct ata_queued_cmd
*qc
);
1842 extern irqreturn_t
ata_sff_interrupt(int irq
, void *dev_instance
);
1843 extern void ata_sff_lost_interrupt(struct ata_port
*ap
);
1844 extern void ata_sff_freeze(struct ata_port
*ap
);
1845 extern void ata_sff_thaw(struct ata_port
*ap
);
1846 extern int ata_sff_prereset(struct ata_link
*link
, unsigned long deadline
);
1847 extern unsigned int ata_sff_dev_classify(struct ata_device
*dev
, int present
,
1849 extern int ata_sff_wait_after_reset(struct ata_link
*link
, unsigned int devmask
,
1850 unsigned long deadline
);
1851 extern int ata_sff_softreset(struct ata_link
*link
, unsigned int *classes
,
1852 unsigned long deadline
);
1853 extern int sata_sff_hardreset(struct ata_link
*link
, unsigned int *class,
1854 unsigned long deadline
);
1855 extern void ata_sff_postreset(struct ata_link
*link
, unsigned int *classes
);
1856 extern void ata_sff_drain_fifo(struct ata_queued_cmd
*qc
);
1857 extern void ata_sff_error_handler(struct ata_port
*ap
);
1858 extern void ata_sff_std_ports(struct ata_ioports
*ioaddr
);
1860 extern int ata_pci_sff_init_host(struct ata_host
*host
);
1861 extern int ata_pci_sff_prepare_host(struct pci_dev
*pdev
,
1862 const struct ata_port_info
* const * ppi
,
1863 struct ata_host
**r_host
);
1864 extern int ata_pci_sff_activate_host(struct ata_host
*host
,
1865 irq_handler_t irq_handler
,
1866 struct scsi_host_template
*sht
);
1867 extern int ata_pci_sff_init_one(struct pci_dev
*pdev
,
1868 const struct ata_port_info
* const * ppi
,
1869 struct scsi_host_template
*sht
, void *host_priv
, int hflags
);
1870 #endif /* CONFIG_PCI */
1872 #ifdef CONFIG_ATA_BMDMA
1874 extern const struct ata_port_operations ata_bmdma_port_ops
;
1876 #define ATA_BMDMA_SHT(drv_name) \
1877 ATA_BASE_SHT(drv_name), \
1878 .sg_tablesize = LIBATA_MAX_PRD, \
1879 .dma_boundary = ATA_DMA_BOUNDARY
1881 extern void ata_bmdma_qc_prep(struct ata_queued_cmd
*qc
);
1882 extern unsigned int ata_bmdma_qc_issue(struct ata_queued_cmd
*qc
);
1883 extern void ata_bmdma_dumb_qc_prep(struct ata_queued_cmd
*qc
);
1884 extern unsigned int ata_bmdma_port_intr(struct ata_port
*ap
,
1885 struct ata_queued_cmd
*qc
);
1886 extern irqreturn_t
ata_bmdma_interrupt(int irq
, void *dev_instance
);
1887 extern void ata_bmdma_error_handler(struct ata_port
*ap
);
1888 extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd
*qc
);
1889 extern void ata_bmdma_irq_clear(struct ata_port
*ap
);
1890 extern void ata_bmdma_setup(struct ata_queued_cmd
*qc
);
1891 extern void ata_bmdma_start(struct ata_queued_cmd
*qc
);
1892 extern void ata_bmdma_stop(struct ata_queued_cmd
*qc
);
1893 extern u8
ata_bmdma_status(struct ata_port
*ap
);
1894 extern int ata_bmdma_port_start(struct ata_port
*ap
);
1895 extern int ata_bmdma_port_start32(struct ata_port
*ap
);
1898 extern int ata_pci_bmdma_clear_simplex(struct pci_dev
*pdev
);
1899 extern void ata_pci_bmdma_init(struct ata_host
*host
);
1900 extern int ata_pci_bmdma_prepare_host(struct pci_dev
*pdev
,
1901 const struct ata_port_info
* const * ppi
,
1902 struct ata_host
**r_host
);
1903 extern int ata_pci_bmdma_init_one(struct pci_dev
*pdev
,
1904 const struct ata_port_info
* const * ppi
,
1905 struct scsi_host_template
*sht
,
1906 void *host_priv
, int hflags
);
1907 #endif /* CONFIG_PCI */
1908 #endif /* CONFIG_ATA_BMDMA */
1911 * ata_sff_busy_wait - Wait for a port status register
1912 * @ap: Port to wait for.
1913 * @bits: bits that must be clear
1914 * @max: number of 10uS waits to perform
1916 * Waits up to max*10 microseconds for the selected bits in the port's
1917 * status register to be cleared.
1918 * Returns final value of status register.
1921 * Inherited from caller.
1923 static inline u8
ata_sff_busy_wait(struct ata_port
*ap
, unsigned int bits
,
1930 status
= ap
->ops
->sff_check_status(ap
);
1932 } while (status
!= 0xff && (status
& bits
) && (max
> 0));
1938 * ata_wait_idle - Wait for a port to be idle.
1939 * @ap: Port to wait for.
1941 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
1942 * Returns final value of status register.
1945 * Inherited from caller.
1947 static inline u8
ata_wait_idle(struct ata_port
*ap
)
1949 u8 status
= ata_sff_busy_wait(ap
, ATA_BUSY
| ATA_DRQ
, 1000);
1952 if (status
!= 0xff && (status
& (ATA_BUSY
| ATA_DRQ
)))
1953 ata_port_printk(ap
, KERN_DEBUG
, "abnormal Status 0x%X\n",
1959 #endif /* CONFIG_ATA_SFF */
1961 #endif /* __LINUX_LIBATA_H__ */