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>
42 * Define if arch has non-standard setup. This is a _PCI_ standard
43 * not a legacy or ISA standard.
45 #ifdef CONFIG_ATA_NONSTANDARD
46 #include <asm/libata-portmap.h>
48 #include <asm-generic/libata-portmap.h>
52 * compile-time options: to be removed as soon as all the drivers are
53 * converted to the new debugging mechanism
55 #undef ATA_DEBUG /* debugging output */
56 #undef ATA_VERBOSE_DEBUG /* yet more debugging output */
57 #undef ATA_IRQ_TRAP /* define to ack screaming irqs */
58 #undef ATA_NDEBUG /* define to disable quick runtime checks */
61 /* note: prints function name for you */
63 #define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __func__, ## args)
64 #ifdef ATA_VERBOSE_DEBUG
65 #define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __func__, ## args)
67 #define VPRINTK(fmt, args...)
68 #endif /* ATA_VERBOSE_DEBUG */
70 #define DPRINTK(fmt, args...)
71 #define VPRINTK(fmt, args...)
72 #endif /* ATA_DEBUG */
74 #define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __func__, ## args)
76 /* NEW: debug levels */
77 #define HAVE_LIBATA_MSG 1
81 ATA_MSG_INFO
= 0x0002,
82 ATA_MSG_PROBE
= 0x0004,
83 ATA_MSG_WARN
= 0x0008,
84 ATA_MSG_MALLOC
= 0x0010,
86 ATA_MSG_INTR
= 0x0040,
90 #define ata_msg_drv(p) ((p)->msg_enable & ATA_MSG_DRV)
91 #define ata_msg_info(p) ((p)->msg_enable & ATA_MSG_INFO)
92 #define ata_msg_probe(p) ((p)->msg_enable & ATA_MSG_PROBE)
93 #define ata_msg_warn(p) ((p)->msg_enable & ATA_MSG_WARN)
94 #define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC)
95 #define ata_msg_ctl(p) ((p)->msg_enable & ATA_MSG_CTL)
96 #define ata_msg_intr(p) ((p)->msg_enable & ATA_MSG_INTR)
97 #define ata_msg_err(p) ((p)->msg_enable & ATA_MSG_ERR)
99 static inline u32
ata_msg_init(int dval
, int default_msg_enable_bits
)
101 if (dval
< 0 || dval
>= (sizeof(u32
) * 8))
102 return default_msg_enable_bits
; /* should be 0x1 - only driver info msgs */
105 return (1 << dval
) - 1;
108 /* defines only for the constants which don't work well as enums */
109 #define ATA_TAG_POISON 0xfafbfcfdU
112 /* various global constants */
113 LIBATA_MAX_PRD
= ATA_MAX_PRD
/ 2,
114 LIBATA_DUMB_MAX_PRD
= ATA_MAX_PRD
/ 4, /* Worst case */
116 /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
118 ATA_TAG_INTERNAL
= ATA_MAX_QUEUE
- 1,
119 ATA_SHORT_PAUSE
= 16,
121 ATAPI_MAX_DRAIN
= 16 << 10,
123 ATA_ALL_DEVICES
= (1 << ATA_MAX_DEVICES
) - 1,
125 ATA_SHT_EMULATED
= 1,
126 ATA_SHT_CMD_PER_LUN
= 1,
127 ATA_SHT_THIS_ID
= -1,
128 ATA_SHT_USE_CLUSTERING
= 1,
130 /* struct ata_device stuff */
131 ATA_DFLAG_LBA
= (1 << 0), /* device supports LBA */
132 ATA_DFLAG_LBA48
= (1 << 1), /* device supports LBA48 */
133 ATA_DFLAG_CDB_INTR
= (1 << 2), /* device asserts INTRQ when ready for CDB */
134 ATA_DFLAG_NCQ
= (1 << 3), /* device supports NCQ */
135 ATA_DFLAG_FLUSH_EXT
= (1 << 4), /* do FLUSH_EXT instead of FLUSH */
136 ATA_DFLAG_ACPI_PENDING
= (1 << 5), /* ACPI resume action pending */
137 ATA_DFLAG_ACPI_FAILED
= (1 << 6), /* ACPI on devcfg has failed */
138 ATA_DFLAG_AN
= (1 << 7), /* AN configured */
139 ATA_DFLAG_HIPM
= (1 << 8), /* device supports HIPM */
140 ATA_DFLAG_DIPM
= (1 << 9), /* device supports DIPM */
141 ATA_DFLAG_DMADIR
= (1 << 10), /* device requires DMADIR */
142 ATA_DFLAG_CFG_MASK
= (1 << 12) - 1,
144 ATA_DFLAG_PIO
= (1 << 12), /* device limited to PIO mode */
145 ATA_DFLAG_NCQ_OFF
= (1 << 13), /* device limited to non-NCQ mode */
146 ATA_DFLAG_SLEEPING
= (1 << 15), /* device is sleeping */
147 ATA_DFLAG_DUBIOUS_XFER
= (1 << 16), /* data transfer not verified */
148 ATA_DFLAG_NO_UNLOAD
= (1 << 17), /* device doesn't support unload */
149 ATA_DFLAG_INIT_MASK
= (1 << 24) - 1,
151 ATA_DFLAG_DETACH
= (1 << 24),
152 ATA_DFLAG_DETACHED
= (1 << 25),
154 ATA_DEV_UNKNOWN
= 0, /* unknown device */
155 ATA_DEV_ATA
= 1, /* ATA device */
156 ATA_DEV_ATA_UNSUP
= 2, /* ATA device (unsupported) */
157 ATA_DEV_ATAPI
= 3, /* ATAPI device */
158 ATA_DEV_ATAPI_UNSUP
= 4, /* ATAPI device (unsupported) */
159 ATA_DEV_PMP
= 5, /* SATA port multiplier */
160 ATA_DEV_PMP_UNSUP
= 6, /* SATA port multiplier (unsupported) */
161 ATA_DEV_SEMB
= 7, /* SEMB */
162 ATA_DEV_SEMB_UNSUP
= 8, /* SEMB (unsupported) */
163 ATA_DEV_NONE
= 9, /* no device */
165 /* struct ata_link flags */
166 ATA_LFLAG_NO_HRST
= (1 << 1), /* avoid hardreset */
167 ATA_LFLAG_NO_SRST
= (1 << 2), /* avoid softreset */
168 ATA_LFLAG_ASSUME_ATA
= (1 << 3), /* assume ATA class */
169 ATA_LFLAG_ASSUME_SEMB
= (1 << 4), /* assume SEMB class */
170 ATA_LFLAG_ASSUME_CLASS
= ATA_LFLAG_ASSUME_ATA
| ATA_LFLAG_ASSUME_SEMB
,
171 ATA_LFLAG_NO_RETRY
= (1 << 5), /* don't retry this link */
172 ATA_LFLAG_DISABLED
= (1 << 6), /* link is disabled */
173 ATA_LFLAG_SW_ACTIVITY
= (1 << 7), /* keep activity stats */
175 /* struct ata_port flags */
176 ATA_FLAG_SLAVE_POSS
= (1 << 0), /* host supports slave dev */
177 /* (doesn't imply presence) */
178 ATA_FLAG_SATA
= (1 << 1),
179 ATA_FLAG_NO_LEGACY
= (1 << 2), /* no legacy mode check */
180 ATA_FLAG_MMIO
= (1 << 3), /* use MMIO, not PIO */
181 ATA_FLAG_SRST
= (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */
182 ATA_FLAG_SATA_RESET
= (1 << 5), /* (obsolete) use COMRESET */
183 ATA_FLAG_NO_ATAPI
= (1 << 6), /* No ATAPI support */
184 ATA_FLAG_PIO_DMA
= (1 << 7), /* PIO cmds via DMA */
185 ATA_FLAG_PIO_LBA48
= (1 << 8), /* Host DMA engine is LBA28 only */
186 ATA_FLAG_PIO_POLLING
= (1 << 9), /* use polling PIO if LLD
187 * doesn't handle PIO interrupts */
188 ATA_FLAG_NCQ
= (1 << 10), /* host supports NCQ */
189 ATA_FLAG_NO_POWEROFF_SPINDOWN
= (1 << 11), /* don't spindown before poweroff */
190 ATA_FLAG_NO_HIBERNATE_SPINDOWN
= (1 << 12), /* don't spindown before hibernation */
191 ATA_FLAG_DEBUGMSG
= (1 << 13),
192 ATA_FLAG_FPDMA_AA
= (1 << 14), /* driver supports Auto-Activate */
193 ATA_FLAG_IGN_SIMPLEX
= (1 << 15), /* ignore SIMPLEX */
194 ATA_FLAG_NO_IORDY
= (1 << 16), /* controller lacks iordy */
195 ATA_FLAG_ACPI_SATA
= (1 << 17), /* need native SATA ACPI layout */
196 ATA_FLAG_AN
= (1 << 18), /* controller supports AN */
197 ATA_FLAG_PMP
= (1 << 19), /* controller supports PMP */
198 ATA_FLAG_IPM
= (1 << 20), /* driver can handle IPM */
199 ATA_FLAG_EM
= (1 << 21), /* driver supports enclosure
201 ATA_FLAG_SW_ACTIVITY
= (1 << 22), /* driver supports sw activity
204 /* The following flag belongs to ap->pflags but is kept in
205 * ap->flags because it's referenced in many LLDs and will be
206 * removed in not-too-distant future.
208 ATA_FLAG_DISABLED
= (1 << 23), /* port is disabled, ignore it */
210 /* bits 24:31 of ap->flags are reserved for LLD specific flags */
213 /* struct ata_port pflags */
214 ATA_PFLAG_EH_PENDING
= (1 << 0), /* EH pending */
215 ATA_PFLAG_EH_IN_PROGRESS
= (1 << 1), /* EH in progress */
216 ATA_PFLAG_FROZEN
= (1 << 2), /* port is frozen */
217 ATA_PFLAG_RECOVERED
= (1 << 3), /* recovery action performed */
218 ATA_PFLAG_LOADING
= (1 << 4), /* boot/loading probe */
219 ATA_PFLAG_SCSI_HOTPLUG
= (1 << 6), /* SCSI hotplug scheduled */
220 ATA_PFLAG_INITIALIZING
= (1 << 7), /* being initialized, don't touch */
221 ATA_PFLAG_RESETTING
= (1 << 8), /* reset in progress */
222 ATA_PFLAG_UNLOADING
= (1 << 9), /* driver is being unloaded */
223 ATA_PFLAG_UNLOADED
= (1 << 10), /* driver is unloaded */
225 ATA_PFLAG_SUSPENDED
= (1 << 17), /* port is suspended (power) */
226 ATA_PFLAG_PM_PENDING
= (1 << 18), /* PM operation pending */
227 ATA_PFLAG_INIT_GTM_VALID
= (1 << 19), /* initial gtm data valid */
229 ATA_PFLAG_PIO32
= (1 << 20), /* 32bit PIO */
230 ATA_PFLAG_PIO32CHANGE
= (1 << 21), /* 32bit PIO can be turned on/off */
232 /* struct ata_queued_cmd flags */
233 ATA_QCFLAG_ACTIVE
= (1 << 0), /* cmd not yet ack'd to scsi lyer */
234 ATA_QCFLAG_DMAMAP
= (1 << 1), /* SG table is DMA mapped */
235 ATA_QCFLAG_IO
= (1 << 3), /* standard IO command */
236 ATA_QCFLAG_RESULT_TF
= (1 << 4), /* result TF requested */
237 ATA_QCFLAG_CLEAR_EXCL
= (1 << 5), /* clear excl_link on completion */
238 ATA_QCFLAG_QUIET
= (1 << 6), /* don't report device error */
239 ATA_QCFLAG_RETRY
= (1 << 7), /* retry after failure */
241 ATA_QCFLAG_FAILED
= (1 << 16), /* cmd failed and is owned by EH */
242 ATA_QCFLAG_SENSE_VALID
= (1 << 17), /* sense data valid */
243 ATA_QCFLAG_EH_SCHEDULED
= (1 << 18), /* EH scheduled (obsolete) */
246 ATA_HOST_SIMPLEX
= (1 << 0), /* Host is simplex, one DMA channel per host only */
247 ATA_HOST_STARTED
= (1 << 1), /* Host started */
248 ATA_HOST_PARALLEL_SCAN
= (1 << 2), /* Ports on this host can be scanned in parallel */
250 /* bits 24:31 of host->flags are reserved for LLD specific flags */
252 /* various lengths of time */
253 ATA_TMOUT_BOOT
= 30000, /* heuristic */
254 ATA_TMOUT_BOOT_QUICK
= 7000, /* heuristic */
255 ATA_TMOUT_INTERNAL_QUICK
= 5000,
256 ATA_TMOUT_MAX_PARK
= 30000,
258 /* FIXME: GoVault needs 2s but we can't afford that without
259 * parallel probing. 800ms is enough for iVDR disk
260 * HHD424020F7SV00. Increase to 2secs when parallel probing
263 ATA_TMOUT_FF_WAIT
= 800,
265 /* Spec mandates to wait for ">= 2ms" before checking status
266 * after reset. We wait 150ms, because that was the magic
267 * delay used for ATAPI devices in Hale Landis's ATADRVR, for
268 * the period of time between when the ATA command register is
269 * written, and then status is checked. Because waiting for
270 * "a while" before checking status is fine, post SRST, we
271 * perform this magic delay here as well.
273 * Old drivers/ide uses the 2mS rule and then waits for ready.
275 ATA_WAIT_AFTER_RESET
= 150,
277 /* If PMP is supported, we have to do follow-up SRST. As some
278 * PMPs don't send D2H Reg FIS after hardreset, LLDs are
279 * advised to wait only for the following duration before
282 ATA_TMOUT_PMP_SRST_WAIT
= 5000,
296 /* SATA port states */
301 /* encoding various smaller bitmaps into a single
302 * unsigned long bitmap
304 ATA_NR_PIO_MODES
= 7,
305 ATA_NR_MWDMA_MODES
= 5,
306 ATA_NR_UDMA_MODES
= 8,
309 ATA_SHIFT_MWDMA
= ATA_SHIFT_PIO
+ ATA_NR_PIO_MODES
,
310 ATA_SHIFT_UDMA
= ATA_SHIFT_MWDMA
+ ATA_NR_MWDMA_MODES
,
312 /* size of buffer to pad xfers ending on unaligned boundaries */
318 /* return values for ->qc_defer */
322 /* desc_len for ata_eh_info and context */
323 ATA_EH_DESC_LEN
= 80,
325 /* reset / recovery action types */
326 ATA_EH_REVALIDATE
= (1 << 0),
327 ATA_EH_SOFTRESET
= (1 << 1), /* meaningful only in ->prereset */
328 ATA_EH_HARDRESET
= (1 << 2), /* meaningful only in ->prereset */
329 ATA_EH_RESET
= ATA_EH_SOFTRESET
| ATA_EH_HARDRESET
,
330 ATA_EH_ENABLE_LINK
= (1 << 3),
331 ATA_EH_LPM
= (1 << 4), /* link power management action */
332 ATA_EH_PARK
= (1 << 5), /* unload heads and stop I/O */
334 ATA_EH_PERDEV_MASK
= ATA_EH_REVALIDATE
| ATA_EH_PARK
,
335 ATA_EH_ALL_ACTIONS
= ATA_EH_REVALIDATE
| ATA_EH_RESET
|
336 ATA_EH_ENABLE_LINK
| ATA_EH_LPM
,
338 /* ata_eh_info->flags */
339 ATA_EHI_HOTPLUGGED
= (1 << 0), /* could have been hotplugged */
340 ATA_EHI_NO_AUTOPSY
= (1 << 2), /* no autopsy */
341 ATA_EHI_QUIET
= (1 << 3), /* be quiet */
343 ATA_EHI_DID_SOFTRESET
= (1 << 16), /* already soft-reset this port */
344 ATA_EHI_DID_HARDRESET
= (1 << 17), /* already soft-reset this port */
345 ATA_EHI_PRINTINFO
= (1 << 18), /* print configuration info */
346 ATA_EHI_SETMODE
= (1 << 19), /* configure transfer mode */
347 ATA_EHI_POST_SETMODE
= (1 << 20), /* revaildating after setmode */
349 ATA_EHI_DID_RESET
= ATA_EHI_DID_SOFTRESET
| ATA_EHI_DID_HARDRESET
,
351 /* mask of flags to transfer *to* the slave link */
352 ATA_EHI_TO_SLAVE_MASK
= ATA_EHI_NO_AUTOPSY
| ATA_EHI_QUIET
,
354 /* max tries if error condition is still set after ->error_handler */
355 ATA_EH_MAX_TRIES
= 5,
357 /* sometimes resuming a link requires several retries */
358 ATA_LINK_RESUME_TRIES
= 5,
360 /* how hard are we gonna try to probe/recover devices */
361 ATA_PROBE_MAX_TRIES
= 3,
362 ATA_EH_DEV_TRIES
= 3,
363 ATA_EH_PMP_TRIES
= 5,
364 ATA_EH_PMP_LINK_TRIES
= 3,
366 SATA_PMP_RW_TIMEOUT
= 3000, /* PMP read/write timeout */
368 /* This should match the actual table size of
369 * ata_eh_cmd_timeout_table in libata-eh.c.
371 ATA_EH_CMD_TIMEOUT_TABLE_SIZE
= 5,
373 /* Horkage types. May be set by libata or controller on drives
374 (some horkage may be drive/controller pair dependant */
376 ATA_HORKAGE_DIAGNOSTIC
= (1 << 0), /* Failed boot diag */
377 ATA_HORKAGE_NODMA
= (1 << 1), /* DMA problems */
378 ATA_HORKAGE_NONCQ
= (1 << 2), /* Don't use NCQ */
379 ATA_HORKAGE_MAX_SEC_128
= (1 << 3), /* Limit max sects to 128 */
380 ATA_HORKAGE_BROKEN_HPA
= (1 << 4), /* Broken HPA */
381 ATA_HORKAGE_DISABLE
= (1 << 5), /* Disable it */
382 ATA_HORKAGE_HPA_SIZE
= (1 << 6), /* native size off by one */
383 ATA_HORKAGE_IPM
= (1 << 7), /* Link PM problems */
384 ATA_HORKAGE_IVB
= (1 << 8), /* cbl det validity bit bugs */
385 ATA_HORKAGE_STUCK_ERR
= (1 << 9), /* stuck ERR on next PACKET */
386 ATA_HORKAGE_BRIDGE_OK
= (1 << 10), /* no bridge limits */
387 ATA_HORKAGE_ATAPI_MOD16_DMA
= (1 << 11), /* use ATAPI DMA for commands
388 not multiple of 16 bytes */
389 ATA_HORKAGE_FIRMWARE_WARN
= (1 << 12), /* firmware update warning */
390 ATA_HORKAGE_1_5_GBPS
= (1 << 13), /* force 1.5 Gbps */
391 ATA_HORKAGE_NOSETXFER
= (1 << 14), /* skip SETXFER, SATA only */
392 ATA_HORKAGE_BROKEN_FPDMA_AA
= (1 << 15), /* skip AA */
394 /* DMA mask for user DMA control: User visible values; DO NOT
396 ATA_DMA_MASK_ATA
= (1 << 0), /* DMA on ATA Disk */
397 ATA_DMA_MASK_ATAPI
= (1 << 1), /* DMA on ATAPI */
398 ATA_DMA_MASK_CFA
= (1 << 2), /* DMA on CF Card */
400 /* ATAPI command types */
401 ATAPI_READ
= 0, /* READs */
402 ATAPI_WRITE
= 1, /* WRITEs */
403 ATAPI_READ_CD
= 2, /* READ CD [MSF] */
404 ATAPI_PASS_THRU
= 3, /* SAT pass-thru */
405 ATAPI_MISC
= 4, /* the rest */
407 /* Timing constants */
408 ATA_TIMING_SETUP
= (1 << 0),
409 ATA_TIMING_ACT8B
= (1 << 1),
410 ATA_TIMING_REC8B
= (1 << 2),
411 ATA_TIMING_CYC8B
= (1 << 3),
412 ATA_TIMING_8BIT
= ATA_TIMING_ACT8B
| ATA_TIMING_REC8B
|
414 ATA_TIMING_ACTIVE
= (1 << 4),
415 ATA_TIMING_RECOVER
= (1 << 5),
416 ATA_TIMING_DMACK_HOLD
= (1 << 6),
417 ATA_TIMING_CYCLE
= (1 << 7),
418 ATA_TIMING_UDMA
= (1 << 8),
419 ATA_TIMING_ALL
= ATA_TIMING_SETUP
| ATA_TIMING_ACT8B
|
420 ATA_TIMING_REC8B
| ATA_TIMING_CYC8B
|
421 ATA_TIMING_ACTIVE
| ATA_TIMING_RECOVER
|
422 ATA_TIMING_DMACK_HOLD
| ATA_TIMING_CYCLE
|
426 ATA_ACPI_FILTER_SETXFER
= 1 << 0,
427 ATA_ACPI_FILTER_LOCK
= 1 << 1,
428 ATA_ACPI_FILTER_DIPM
= 1 << 2,
429 ATA_ACPI_FILTER_FPDMA_OFFSET
= 1 << 3, /* FPDMA non-zero offset */
430 ATA_ACPI_FILTER_FPDMA_AA
= 1 << 4, /* FPDMA auto activate */
432 ATA_ACPI_FILTER_DEFAULT
= ATA_ACPI_FILTER_SETXFER
|
433 ATA_ACPI_FILTER_LOCK
|
434 ATA_ACPI_FILTER_DIPM
,
438 ATA_MASK_PIO
= ((1LU << ATA_NR_PIO_MODES
) - 1)
440 ATA_MASK_MWDMA
= ((1LU << ATA_NR_MWDMA_MODES
) - 1)
442 ATA_MASK_UDMA
= ((1LU << ATA_NR_UDMA_MODES
) - 1)
446 enum hsm_task_states
{
447 HSM_ST_IDLE
, /* no command on going */
448 HSM_ST_FIRST
, /* (waiting the device to)
449 write CDB or first data block */
450 HSM_ST
, /* (waiting the device to) transfer data */
451 HSM_ST_LAST
, /* (waiting the device to) complete command */
452 HSM_ST_ERR
, /* error */
455 enum ata_completion_errors
{
456 AC_ERR_DEV
= (1 << 0), /* device reported error */
457 AC_ERR_HSM
= (1 << 1), /* host state machine violation */
458 AC_ERR_TIMEOUT
= (1 << 2), /* timeout */
459 AC_ERR_MEDIA
= (1 << 3), /* media error */
460 AC_ERR_ATA_BUS
= (1 << 4), /* ATA bus error */
461 AC_ERR_HOST_BUS
= (1 << 5), /* host bus error */
462 AC_ERR_SYSTEM
= (1 << 6), /* system error */
463 AC_ERR_INVALID
= (1 << 7), /* invalid argument */
464 AC_ERR_OTHER
= (1 << 8), /* unknown */
465 AC_ERR_NODEV_HINT
= (1 << 9), /* polling device detection hint */
466 AC_ERR_NCQ
= (1 << 10), /* marker for offending NCQ qc */
469 /* forward declarations */
471 struct ata_port_operations
;
474 struct ata_queued_cmd
;
477 typedef void (*ata_qc_cb_t
) (struct ata_queued_cmd
*qc
);
478 typedef int (*ata_prereset_fn_t
)(struct ata_link
*link
, unsigned long deadline
);
479 typedef int (*ata_reset_fn_t
)(struct ata_link
*link
, unsigned int *classes
,
480 unsigned long deadline
);
481 typedef void (*ata_postreset_fn_t
)(struct ata_link
*link
, unsigned int *classes
);
484 * host pm policy: If you alter this, you also need to alter libata-scsi.c
485 * (for the ascii descriptions)
493 extern struct device_attribute dev_attr_link_power_management_policy
;
494 extern struct device_attribute dev_attr_unload_heads
;
495 extern struct device_attribute dev_attr_em_message_type
;
496 extern struct device_attribute dev_attr_em_message
;
497 extern struct device_attribute dev_attr_sw_activity
;
505 #ifdef CONFIG_ATA_SFF
507 void __iomem
*cmd_addr
;
508 void __iomem
*data_addr
;
509 void __iomem
*error_addr
;
510 void __iomem
*feature_addr
;
511 void __iomem
*nsect_addr
;
512 void __iomem
*lbal_addr
;
513 void __iomem
*lbam_addr
;
514 void __iomem
*lbah_addr
;
515 void __iomem
*device_addr
;
516 void __iomem
*status_addr
;
517 void __iomem
*command_addr
;
518 void __iomem
*altstatus_addr
;
519 void __iomem
*ctl_addr
;
520 void __iomem
*bmdma_addr
;
521 void __iomem
*scr_addr
;
523 #endif /* CONFIG_ATA_SFF */
528 void __iomem
* const *iomap
;
529 unsigned int n_ports
;
531 struct ata_port_operations
*ops
;
533 #ifdef CONFIG_ATA_ACPI
534 acpi_handle acpi_handle
;
536 struct ata_port
*simplex_claimed
; /* channel owning the DMA */
537 struct ata_port
*ports
[0];
540 struct ata_queued_cmd
{
542 struct ata_device
*dev
;
544 struct scsi_cmnd
*scsicmd
;
545 void (*scsidone
)(struct scsi_cmnd
*);
547 struct ata_taskfile tf
;
548 u8 cdb
[ATAPI_CDB_LEN
];
550 unsigned long flags
; /* ATA_QCFLAG_xxx */
553 unsigned int orig_n_elem
;
557 unsigned int sect_size
;
560 unsigned int extrabytes
;
561 unsigned int curbytes
;
563 struct scatterlist
*cursg
;
564 unsigned int cursg_ofs
;
566 struct scatterlist sgent
;
568 struct scatterlist
*sg
;
570 unsigned int err_mask
;
571 struct ata_taskfile result_tf
;
572 ata_qc_cb_t complete_fn
;
578 struct ata_port_stats
{
579 unsigned long unhandled_irq
;
580 unsigned long idle_irq
;
581 unsigned long rw_reqbuf
;
584 struct ata_ering_entry
{
586 unsigned int err_mask
;
592 struct ata_ering_entry ring
[ATA_ERING_SIZE
];
596 struct ata_link
*link
;
597 unsigned int devno
; /* 0 or 1 */
598 unsigned int horkage
; /* List of broken features */
599 unsigned long flags
; /* ATA_DFLAG_xxx */
600 struct scsi_device
*sdev
; /* attached SCSI device */
601 #ifdef CONFIG_ATA_ACPI
602 acpi_handle acpi_handle
;
603 union acpi_object
*gtf_cache
;
604 unsigned int gtf_filter
;
606 /* n_sector is CLEAR_BEGIN, read comment above CLEAR_BEGIN */
607 u64 n_sectors
; /* size of device, if ATA */
608 u64 n_native_sectors
; /* native size, if ATA */
609 unsigned int class; /* ATA_DEV_xxx */
610 unsigned long unpark_deadline
;
615 unsigned int xfer_shift
; /* ATA_SHIFT_xxx */
617 unsigned int multi_count
; /* sectors count for
618 READ/WRITE MULTIPLE */
619 unsigned int max_sectors
; /* per-device max sectors */
620 unsigned int cdb_len
;
622 /* per-dev xfer mask */
623 unsigned long pio_mask
;
624 unsigned long mwdma_mask
;
625 unsigned long udma_mask
;
627 /* for CHS addressing */
628 u16 cylinders
; /* Number of cylinders */
629 u16 heads
; /* Number of heads */
630 u16 sectors
; /* Number of sectors per track */
633 u16 id
[ATA_ID_WORDS
]; /* IDENTIFY xxx DEVICE data */
634 u32 gscr
[SATA_PMP_GSCR_DWORDS
]; /* PMP GSCR block */
639 /* ering is CLEAR_END, read comment above CLEAR_END */
640 struct ata_ering ering
;
643 /* Fields between ATA_DEVICE_CLEAR_BEGIN and ATA_DEVICE_CLEAR_END are
644 * cleared to zero on ata_dev_init().
646 #define ATA_DEVICE_CLEAR_BEGIN offsetof(struct ata_device, n_sectors)
647 #define ATA_DEVICE_CLEAR_END offsetof(struct ata_device, ering)
650 struct ata_device
*dev
; /* offending device */
651 u32 serror
; /* SError from LLDD */
652 unsigned int err_mask
; /* port-wide err_mask */
653 unsigned int action
; /* ATA_EH_* action mask */
654 unsigned int dev_action
[ATA_MAX_DEVICES
]; /* dev EH action */
655 unsigned int flags
; /* ATA_EHI_* flags */
657 unsigned int probe_mask
;
659 char desc
[ATA_EH_DESC_LEN
];
663 struct ata_eh_context
{
664 struct ata_eh_info i
;
665 int tries
[ATA_MAX_DEVICES
];
666 int cmd_timeout_idx
[ATA_MAX_DEVICES
]
667 [ATA_EH_CMD_TIMEOUT_TABLE_SIZE
];
668 unsigned int classes
[ATA_MAX_DEVICES
];
669 unsigned int did_probe_mask
;
670 unsigned int unloaded_mask
;
671 unsigned int saved_ncq_enabled
;
672 u8 saved_xfer_mode
[ATA_MAX_DEVICES
];
673 /* timestamp for the last reset attempt or success */
674 unsigned long last_reset
;
677 struct ata_acpi_drive
683 struct ata_acpi_gtm
{
684 struct ata_acpi_drive drive
[2];
690 int pmp
; /* port multiplier port # */
692 unsigned int active_tag
; /* active tag on this link */
693 u32 sactive
; /* active NCQ commands */
695 unsigned int flags
; /* ATA_LFLAG_xxx */
697 u32 saved_scontrol
; /* SControl on probe */
698 unsigned int hw_sata_spd_limit
;
699 unsigned int sata_spd_limit
;
700 unsigned int sata_spd
; /* current SATA PHY speed */
702 /* record runtime error info, protected by host_set lock */
703 struct ata_eh_info eh_info
;
705 struct ata_eh_context eh_context
;
707 struct ata_device device
[ATA_MAX_DEVICES
];
711 struct Scsi_Host
*scsi_host
; /* our co-allocated scsi host */
712 struct ata_port_operations
*ops
;
714 /* Flags owned by the EH context. Only EH should touch these once the
716 unsigned long flags
; /* ATA_FLAG_xxx */
717 /* Flags that change dynamically, protected by ap->lock */
718 unsigned int pflags
; /* ATA_PFLAG_xxx */
719 unsigned int print_id
; /* user visible unique port ID */
720 unsigned int port_no
; /* 0 based port no. inside the host */
722 struct ata_prd
*prd
; /* our SG list */
723 dma_addr_t prd_dma
; /* and its DMA mapping */
725 #ifdef CONFIG_ATA_SFF
726 struct ata_ioports ioaddr
; /* ATA cmd/ctl/dma register blocks */
727 #endif /* CONFIG_ATA_SFF */
729 u8 ctl
; /* cache of ATA control register */
730 u8 last_ctl
; /* Cache last written value */
731 unsigned int pio_mask
;
732 unsigned int mwdma_mask
;
733 unsigned int udma_mask
;
734 unsigned int cbl
; /* cable type; ATA_CBL_xxx */
736 struct ata_queued_cmd qcmd
[ATA_MAX_QUEUE
];
737 unsigned long qc_allocated
;
738 unsigned int qc_active
;
739 int nr_active_links
; /* #links with active qcs */
741 struct ata_link link
; /* host default link */
742 struct ata_link
*slave_link
; /* see ata_slave_link_init() */
744 int nr_pmp_links
; /* nr of available PMP links */
745 struct ata_link
*pmp_link
; /* array of PMP links */
746 struct ata_link
*excl_link
; /* for PMP qc exclusion */
748 struct ata_port_stats stats
;
749 struct ata_host
*host
;
752 void *port_task_data
;
753 struct delayed_work port_task
;
754 struct delayed_work hotplug_task
;
755 struct work_struct scsi_rescan_task
;
757 unsigned int hsm_task_state
;
760 struct list_head eh_done_q
;
761 wait_queue_head_t eh_wait_q
;
763 struct completion park_req_pending
;
765 pm_message_t pm_mesg
;
767 enum link_pm pm_policy
;
769 struct timer_list fastdrain_timer
;
770 unsigned long fastdrain_cnt
;
775 #ifdef CONFIG_ATA_ACPI
776 acpi_handle acpi_handle
;
777 struct ata_acpi_gtm __acpi_init_gtm
; /* use ata_acpi_init_gtm() */
780 u8 sector_buf
[ATA_SECT_SIZE
] ____cacheline_aligned
;
783 /* The following initializer overrides a method to NULL whether one of
784 * its parent has the method defined or not. This is equivalent to
785 * ERR_PTR(-ENOENT). Unfortunately, ERR_PTR doesn't render a constant
786 * expression and thus can't be used as an initializer.
788 #define ATA_OP_NULL (void *)(unsigned long)(-ENOENT)
790 struct ata_port_operations
{
794 int (*qc_defer
)(struct ata_queued_cmd
*qc
);
795 int (*check_atapi_dma
)(struct ata_queued_cmd
*qc
);
796 void (*qc_prep
)(struct ata_queued_cmd
*qc
);
797 unsigned int (*qc_issue
)(struct ata_queued_cmd
*qc
);
798 bool (*qc_fill_rtf
)(struct ata_queued_cmd
*qc
);
801 * Configuration and exception handling
803 int (*cable_detect
)(struct ata_port
*ap
);
804 unsigned long (*mode_filter
)(struct ata_device
*dev
, unsigned long xfer_mask
);
805 void (*set_piomode
)(struct ata_port
*ap
, struct ata_device
*dev
);
806 void (*set_dmamode
)(struct ata_port
*ap
, struct ata_device
*dev
);
807 int (*set_mode
)(struct ata_link
*link
, struct ata_device
**r_failed_dev
);
808 unsigned int (*read_id
)(struct ata_device
*dev
, struct ata_taskfile
*tf
, u16
*id
);
810 void (*dev_config
)(struct ata_device
*dev
);
812 void (*freeze
)(struct ata_port
*ap
);
813 void (*thaw
)(struct ata_port
*ap
);
814 ata_prereset_fn_t prereset
;
815 ata_reset_fn_t softreset
;
816 ata_reset_fn_t hardreset
;
817 ata_postreset_fn_t postreset
;
818 ata_prereset_fn_t pmp_prereset
;
819 ata_reset_fn_t pmp_softreset
;
820 ata_reset_fn_t pmp_hardreset
;
821 ata_postreset_fn_t pmp_postreset
;
822 void (*error_handler
)(struct ata_port
*ap
);
823 void (*lost_interrupt
)(struct ata_port
*ap
);
824 void (*post_internal_cmd
)(struct ata_queued_cmd
*qc
);
829 int (*scr_read
)(struct ata_link
*link
, unsigned int sc_reg
, u32
*val
);
830 int (*scr_write
)(struct ata_link
*link
, unsigned int sc_reg
, u32 val
);
831 void (*pmp_attach
)(struct ata_port
*ap
);
832 void (*pmp_detach
)(struct ata_port
*ap
);
833 int (*enable_pm
)(struct ata_port
*ap
, enum link_pm policy
);
834 void (*disable_pm
)(struct ata_port
*ap
);
837 * Start, stop, suspend and resume
839 int (*port_suspend
)(struct ata_port
*ap
, pm_message_t mesg
);
840 int (*port_resume
)(struct ata_port
*ap
);
841 int (*port_start
)(struct ata_port
*ap
);
842 void (*port_stop
)(struct ata_port
*ap
);
843 void (*host_stop
)(struct ata_host
*host
);
845 #ifdef CONFIG_ATA_SFF
847 * SFF / taskfile oriented ops
849 void (*sff_dev_select
)(struct ata_port
*ap
, unsigned int device
);
850 u8 (*sff_check_status
)(struct ata_port
*ap
);
851 u8 (*sff_check_altstatus
)(struct ata_port
*ap
);
852 void (*sff_tf_load
)(struct ata_port
*ap
, const struct ata_taskfile
*tf
);
853 void (*sff_tf_read
)(struct ata_port
*ap
, struct ata_taskfile
*tf
);
854 void (*sff_exec_command
)(struct ata_port
*ap
,
855 const struct ata_taskfile
*tf
);
856 unsigned int (*sff_data_xfer
)(struct ata_device
*dev
,
857 unsigned char *buf
, unsigned int buflen
, int rw
);
858 u8 (*sff_irq_on
)(struct ata_port
*);
859 void (*sff_irq_clear
)(struct ata_port
*);
861 void (*bmdma_setup
)(struct ata_queued_cmd
*qc
);
862 void (*bmdma_start
)(struct ata_queued_cmd
*qc
);
863 void (*bmdma_stop
)(struct ata_queued_cmd
*qc
);
864 u8 (*bmdma_status
)(struct ata_port
*ap
);
866 void (*drain_fifo
)(struct ata_queued_cmd
*qc
);
867 #endif /* CONFIG_ATA_SFF */
869 ssize_t (*em_show
)(struct ata_port
*ap
, char *buf
);
870 ssize_t (*em_store
)(struct ata_port
*ap
, const char *message
,
872 ssize_t (*sw_activity_show
)(struct ata_device
*dev
, char *buf
);
873 ssize_t (*sw_activity_store
)(struct ata_device
*dev
,
874 enum sw_activity val
);
878 void (*phy_reset
)(struct ata_port
*ap
);
879 void (*eng_timeout
)(struct ata_port
*ap
);
882 * ->inherits must be the last field and all the preceding
883 * fields must be pointers.
885 const struct ata_port_operations
*inherits
;
888 struct ata_port_info
{
890 unsigned long link_flags
;
891 unsigned long pio_mask
;
892 unsigned long mwdma_mask
;
893 unsigned long udma_mask
;
894 struct ata_port_operations
*port_ops
;
899 unsigned short mode
; /* ATA mode */
900 unsigned short setup
; /* t1 */
901 unsigned short act8b
; /* t2 for 8-bit I/O */
902 unsigned short rec8b
; /* t2i for 8-bit I/O */
903 unsigned short cyc8b
; /* t0 for 8-bit I/O */
904 unsigned short active
; /* t2 or tD */
905 unsigned short recover
; /* t2i or tK */
906 unsigned short dmack_hold
; /* tj */
907 unsigned short cycle
; /* t0 */
908 unsigned short udma
; /* t2CYCTYP/2 */
912 * Core layer - drivers/ata/libata-core.c
914 extern const unsigned long sata_deb_timing_normal
[];
915 extern const unsigned long sata_deb_timing_hotplug
[];
916 extern const unsigned long sata_deb_timing_long
[];
918 extern struct ata_port_operations ata_dummy_port_ops
;
919 extern const struct ata_port_info ata_dummy_port_info
;
921 static inline const unsigned long *
922 sata_ehc_deb_timing(struct ata_eh_context
*ehc
)
924 if (ehc
->i
.flags
& ATA_EHI_HOTPLUGGED
)
925 return sata_deb_timing_hotplug
;
927 return sata_deb_timing_normal
;
930 static inline int ata_port_is_dummy(struct ata_port
*ap
)
932 return ap
->ops
== &ata_dummy_port_ops
;
935 extern void ata_port_probe(struct ata_port
*);
936 extern int sata_set_spd(struct ata_link
*link
);
937 extern int ata_std_prereset(struct ata_link
*link
, unsigned long deadline
);
938 extern int ata_wait_after_reset(struct ata_link
*link
, unsigned long deadline
,
939 int (*check_ready
)(struct ata_link
*link
));
940 extern int sata_link_debounce(struct ata_link
*link
,
941 const unsigned long *params
, unsigned long deadline
);
942 extern int sata_link_resume(struct ata_link
*link
, const unsigned long *params
,
943 unsigned long deadline
);
944 extern int sata_link_hardreset(struct ata_link
*link
,
945 const unsigned long *timing
, unsigned long deadline
,
946 bool *online
, int (*check_ready
)(struct ata_link
*));
947 extern int sata_std_hardreset(struct ata_link
*link
, unsigned int *class,
948 unsigned long deadline
);
949 extern void ata_std_postreset(struct ata_link
*link
, unsigned int *classes
);
950 extern void ata_port_disable(struct ata_port
*);
952 extern struct ata_host
*ata_host_alloc(struct device
*dev
, int max_ports
);
953 extern struct ata_host
*ata_host_alloc_pinfo(struct device
*dev
,
954 const struct ata_port_info
* const * ppi
, int n_ports
);
955 extern int ata_slave_link_init(struct ata_port
*ap
);
956 extern int ata_host_start(struct ata_host
*host
);
957 extern int ata_host_register(struct ata_host
*host
,
958 struct scsi_host_template
*sht
);
959 extern int ata_host_activate(struct ata_host
*host
, int irq
,
960 irq_handler_t irq_handler
, unsigned long irq_flags
,
961 struct scsi_host_template
*sht
);
962 extern void ata_host_detach(struct ata_host
*host
);
963 extern void ata_host_init(struct ata_host
*, struct device
*,
964 unsigned long, struct ata_port_operations
*);
965 extern int ata_scsi_detect(struct scsi_host_template
*sht
);
966 extern int ata_scsi_ioctl(struct scsi_device
*dev
, int cmd
, void __user
*arg
);
967 extern int ata_scsi_queuecmd(struct scsi_cmnd
*cmd
, void (*done
)(struct scsi_cmnd
*));
968 extern int ata_sas_scsi_ioctl(struct ata_port
*ap
, struct scsi_device
*dev
,
969 int cmd
, void __user
*arg
);
970 extern void ata_sas_port_destroy(struct ata_port
*);
971 extern struct ata_port
*ata_sas_port_alloc(struct ata_host
*,
972 struct ata_port_info
*, struct Scsi_Host
*);
973 extern int ata_sas_port_init(struct ata_port
*);
974 extern int ata_sas_port_start(struct ata_port
*ap
);
975 extern void ata_sas_port_stop(struct ata_port
*ap
);
976 extern int ata_sas_slave_configure(struct scsi_device
*, struct ata_port
*);
977 extern int ata_sas_queuecmd(struct scsi_cmnd
*cmd
, void (*done
)(struct scsi_cmnd
*),
978 struct ata_port
*ap
);
979 extern int sata_scr_valid(struct ata_link
*link
);
980 extern int sata_scr_read(struct ata_link
*link
, int reg
, u32
*val
);
981 extern int sata_scr_write(struct ata_link
*link
, int reg
, u32 val
);
982 extern int sata_scr_write_flush(struct ata_link
*link
, int reg
, u32 val
);
983 extern bool ata_link_online(struct ata_link
*link
);
984 extern bool ata_link_offline(struct ata_link
*link
);
986 extern int ata_host_suspend(struct ata_host
*host
, pm_message_t mesg
);
987 extern void ata_host_resume(struct ata_host
*host
);
989 extern int ata_ratelimit(void);
990 extern u32
ata_wait_register(void __iomem
*reg
, u32 mask
, u32 val
,
991 unsigned long interval
, unsigned long timeout
);
992 extern int atapi_cmd_type(u8 opcode
);
993 extern void ata_tf_to_fis(const struct ata_taskfile
*tf
,
994 u8 pmp
, int is_cmd
, u8
*fis
);
995 extern void ata_tf_from_fis(const u8
*fis
, struct ata_taskfile
*tf
);
996 extern unsigned long ata_pack_xfermask(unsigned long pio_mask
,
997 unsigned long mwdma_mask
, unsigned long udma_mask
);
998 extern void ata_unpack_xfermask(unsigned long xfer_mask
,
999 unsigned long *pio_mask
, unsigned long *mwdma_mask
,
1000 unsigned long *udma_mask
);
1001 extern u8
ata_xfer_mask2mode(unsigned long xfer_mask
);
1002 extern unsigned long ata_xfer_mode2mask(u8 xfer_mode
);
1003 extern int ata_xfer_mode2shift(unsigned long xfer_mode
);
1004 extern const char *ata_mode_string(unsigned long xfer_mask
);
1005 extern unsigned long ata_id_xfermask(const u16
*id
);
1006 extern int ata_port_start(struct ata_port
*ap
);
1007 extern int ata_std_qc_defer(struct ata_queued_cmd
*qc
);
1008 extern void ata_noop_qc_prep(struct ata_queued_cmd
*qc
);
1009 extern void ata_sg_init(struct ata_queued_cmd
*qc
, struct scatterlist
*sg
,
1010 unsigned int n_elem
);
1011 extern unsigned int ata_dev_classify(const struct ata_taskfile
*tf
);
1012 extern void ata_dev_disable(struct ata_device
*adev
);
1013 extern void ata_id_string(const u16
*id
, unsigned char *s
,
1014 unsigned int ofs
, unsigned int len
);
1015 extern void ata_id_c_string(const u16
*id
, unsigned char *s
,
1016 unsigned int ofs
, unsigned int len
);
1017 extern unsigned int ata_do_dev_read_id(struct ata_device
*dev
,
1018 struct ata_taskfile
*tf
, u16
*id
);
1019 extern void ata_qc_complete(struct ata_queued_cmd
*qc
);
1020 extern int ata_qc_complete_multiple(struct ata_port
*ap
, u32 qc_active
);
1021 extern void ata_scsi_simulate(struct ata_device
*dev
, struct scsi_cmnd
*cmd
,
1022 void (*done
)(struct scsi_cmnd
*));
1023 extern int ata_std_bios_param(struct scsi_device
*sdev
,
1024 struct block_device
*bdev
,
1025 sector_t capacity
, int geom
[]);
1026 extern int ata_scsi_slave_config(struct scsi_device
*sdev
);
1027 extern void ata_scsi_slave_destroy(struct scsi_device
*sdev
);
1028 extern int ata_scsi_change_queue_depth(struct scsi_device
*sdev
,
1030 extern struct ata_device
*ata_dev_pair(struct ata_device
*adev
);
1031 extern int ata_do_set_mode(struct ata_link
*link
, struct ata_device
**r_failed_dev
);
1033 extern int ata_cable_40wire(struct ata_port
*ap
);
1034 extern int ata_cable_80wire(struct ata_port
*ap
);
1035 extern int ata_cable_sata(struct ata_port
*ap
);
1036 extern int ata_cable_ignore(struct ata_port
*ap
);
1037 extern int ata_cable_unknown(struct ata_port
*ap
);
1039 extern void ata_pio_queue_task(struct ata_port
*ap
, void *data
,
1040 unsigned long delay
);
1042 /* Timing helpers */
1043 extern unsigned int ata_pio_need_iordy(const struct ata_device
*);
1044 extern const struct ata_timing
*ata_timing_find_mode(u8 xfer_mode
);
1045 extern int ata_timing_compute(struct ata_device
*, unsigned short,
1046 struct ata_timing
*, int, int);
1047 extern void ata_timing_merge(const struct ata_timing
*,
1048 const struct ata_timing
*, struct ata_timing
*,
1050 extern u8
ata_timing_cycle2mode(unsigned int xfer_shift
, int cycle
);
1057 unsigned int reg
; /* PCI config register to read */
1058 unsigned int width
; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
1063 extern int pci_test_config_bits(struct pci_dev
*pdev
, const struct pci_bits
*bits
);
1064 extern void ata_pci_remove_one(struct pci_dev
*pdev
);
1067 extern void ata_pci_device_do_suspend(struct pci_dev
*pdev
, pm_message_t mesg
);
1068 extern int __must_check
ata_pci_device_do_resume(struct pci_dev
*pdev
);
1069 extern int ata_pci_device_suspend(struct pci_dev
*pdev
, pm_message_t mesg
);
1070 extern int ata_pci_device_resume(struct pci_dev
*pdev
);
1071 #endif /* CONFIG_PM */
1072 #endif /* CONFIG_PCI */
1075 * ACPI - drivers/ata/libata-acpi.c
1077 #ifdef CONFIG_ATA_ACPI
1078 static inline const struct ata_acpi_gtm
*ata_acpi_init_gtm(struct ata_port
*ap
)
1080 if (ap
->pflags
& ATA_PFLAG_INIT_GTM_VALID
)
1081 return &ap
->__acpi_init_gtm
;
1084 int ata_acpi_stm(struct ata_port
*ap
, const struct ata_acpi_gtm
*stm
);
1085 int ata_acpi_gtm(struct ata_port
*ap
, struct ata_acpi_gtm
*stm
);
1086 unsigned long ata_acpi_gtm_xfermask(struct ata_device
*dev
,
1087 const struct ata_acpi_gtm
*gtm
);
1088 int ata_acpi_cbl_80wire(struct ata_port
*ap
, const struct ata_acpi_gtm
*gtm
);
1090 static inline const struct ata_acpi_gtm
*ata_acpi_init_gtm(struct ata_port
*ap
)
1095 static inline int ata_acpi_stm(const struct ata_port
*ap
,
1096 struct ata_acpi_gtm
*stm
)
1101 static inline int ata_acpi_gtm(const struct ata_port
*ap
,
1102 struct ata_acpi_gtm
*stm
)
1107 static inline unsigned int ata_acpi_gtm_xfermask(struct ata_device
*dev
,
1108 const struct ata_acpi_gtm
*gtm
)
1113 static inline int ata_acpi_cbl_80wire(struct ata_port
*ap
,
1114 const struct ata_acpi_gtm
*gtm
)
1121 * EH - drivers/ata/libata-eh.c
1123 extern void ata_port_schedule_eh(struct ata_port
*ap
);
1124 extern int ata_link_abort(struct ata_link
*link
);
1125 extern int ata_port_abort(struct ata_port
*ap
);
1126 extern int ata_port_freeze(struct ata_port
*ap
);
1127 extern int sata_async_notification(struct ata_port
*ap
);
1129 extern void ata_eh_freeze_port(struct ata_port
*ap
);
1130 extern void ata_eh_thaw_port(struct ata_port
*ap
);
1132 extern void ata_eh_qc_complete(struct ata_queued_cmd
*qc
);
1133 extern void ata_eh_qc_retry(struct ata_queued_cmd
*qc
);
1134 extern void ata_eh_analyze_ncq_error(struct ata_link
*link
);
1136 extern void ata_do_eh(struct ata_port
*ap
, ata_prereset_fn_t prereset
,
1137 ata_reset_fn_t softreset
, ata_reset_fn_t hardreset
,
1138 ata_postreset_fn_t postreset
);
1139 extern void ata_std_error_handler(struct ata_port
*ap
);
1142 * Base operations to inherit from and initializers for sht
1146 * base : Common to all libata drivers.
1147 * sata : SATA controllers w/ native interface.
1148 * pmp : SATA controllers w/ PMP support.
1149 * sff : SFF ATA controllers w/o BMDMA support.
1150 * bmdma : SFF ATA controllers w/ BMDMA support.
1154 * BASE : Common to all libata drivers. The user must set
1155 * sg_tablesize and dma_boundary.
1156 * PIO : SFF ATA controllers w/ only PIO support.
1157 * BMDMA : SFF ATA controllers w/ BMDMA support. sg_tablesize and
1158 * dma_boundary are set to BMDMA limits.
1159 * NCQ : SATA controllers supporting NCQ. The user must set
1160 * sg_tablesize, dma_boundary and can_queue.
1162 extern const struct ata_port_operations ata_base_port_ops
;
1163 extern const struct ata_port_operations sata_port_ops
;
1164 extern struct device_attribute
*ata_common_sdev_attrs
[];
1166 #define ATA_BASE_SHT(drv_name) \
1167 .module = THIS_MODULE, \
1169 .ioctl = ata_scsi_ioctl, \
1170 .queuecommand = ata_scsi_queuecmd, \
1171 .can_queue = ATA_DEF_QUEUE, \
1172 .this_id = ATA_SHT_THIS_ID, \
1173 .cmd_per_lun = ATA_SHT_CMD_PER_LUN, \
1174 .emulated = ATA_SHT_EMULATED, \
1175 .use_clustering = ATA_SHT_USE_CLUSTERING, \
1176 .proc_name = drv_name, \
1177 .slave_configure = ata_scsi_slave_config, \
1178 .slave_destroy = ata_scsi_slave_destroy, \
1179 .bios_param = ata_std_bios_param, \
1180 .sdev_attrs = ata_common_sdev_attrs
1182 #define ATA_NCQ_SHT(drv_name) \
1183 ATA_BASE_SHT(drv_name), \
1184 .change_queue_depth = ata_scsi_change_queue_depth
1189 #ifdef CONFIG_SATA_PMP
1190 static inline bool sata_pmp_supported(struct ata_port
*ap
)
1192 return ap
->flags
& ATA_FLAG_PMP
;
1195 static inline bool sata_pmp_attached(struct ata_port
*ap
)
1197 return ap
->nr_pmp_links
!= 0;
1200 static inline int ata_is_host_link(const struct ata_link
*link
)
1202 return link
== &link
->ap
->link
|| link
== link
->ap
->slave_link
;
1204 #else /* CONFIG_SATA_PMP */
1205 static inline bool sata_pmp_supported(struct ata_port
*ap
)
1210 static inline bool sata_pmp_attached(struct ata_port
*ap
)
1215 static inline int ata_is_host_link(const struct ata_link
*link
)
1219 #endif /* CONFIG_SATA_PMP */
1221 static inline int sata_srst_pmp(struct ata_link
*link
)
1223 if (sata_pmp_supported(link
->ap
) && ata_is_host_link(link
))
1224 return SATA_PMP_CTRL_PORT
;
1231 #define ata_port_printk(ap, lv, fmt, args...) \
1232 printk("%sata%u: "fmt, lv, (ap)->print_id , ##args)
1234 #define ata_link_printk(link, lv, fmt, args...) do { \
1235 if (sata_pmp_attached((link)->ap) || (link)->ap->slave_link) \
1236 printk("%sata%u.%02u: "fmt, lv, (link)->ap->print_id, \
1237 (link)->pmp , ##args); \
1239 printk("%sata%u: "fmt, lv, (link)->ap->print_id , ##args); \
1242 #define ata_dev_printk(dev, lv, fmt, args...) \
1243 printk("%sata%u.%02u: "fmt, lv, (dev)->link->ap->print_id, \
1244 (dev)->link->pmp + (dev)->devno , ##args)
1247 * ata_eh_info helpers
1249 extern void __ata_ehi_push_desc(struct ata_eh_info
*ehi
, const char *fmt
, ...)
1250 __attribute__ ((format (printf
, 2, 3)));
1251 extern void ata_ehi_push_desc(struct ata_eh_info
*ehi
, const char *fmt
, ...)
1252 __attribute__ ((format (printf
, 2, 3)));
1253 extern void ata_ehi_clear_desc(struct ata_eh_info
*ehi
);
1255 static inline void ata_ehi_hotplugged(struct ata_eh_info
*ehi
)
1257 ehi
->probe_mask
|= (1 << ATA_MAX_DEVICES
) - 1;
1258 ehi
->flags
|= ATA_EHI_HOTPLUGGED
;
1259 ehi
->action
|= ATA_EH_RESET
| ATA_EH_ENABLE_LINK
;
1260 ehi
->err_mask
|= AC_ERR_ATA_BUS
;
1264 * port description helpers
1266 extern void ata_port_desc(struct ata_port
*ap
, const char *fmt
, ...)
1267 __attribute__ ((format (printf
, 2, 3)));
1269 extern void ata_port_pbar_desc(struct ata_port
*ap
, int bar
, ssize_t offset
,
1273 static inline unsigned int ata_tag_valid(unsigned int tag
)
1275 return (tag
< ATA_MAX_QUEUE
) ? 1 : 0;
1278 static inline unsigned int ata_tag_internal(unsigned int tag
)
1280 return tag
== ATA_TAG_INTERNAL
;
1286 static inline unsigned int ata_class_enabled(unsigned int class)
1288 return class == ATA_DEV_ATA
|| class == ATA_DEV_ATAPI
||
1289 class == ATA_DEV_PMP
|| class == ATA_DEV_SEMB
;
1292 static inline unsigned int ata_class_disabled(unsigned int class)
1294 return class == ATA_DEV_ATA_UNSUP
|| class == ATA_DEV_ATAPI_UNSUP
||
1295 class == ATA_DEV_PMP_UNSUP
|| class == ATA_DEV_SEMB_UNSUP
;
1298 static inline unsigned int ata_class_absent(unsigned int class)
1300 return !ata_class_enabled(class) && !ata_class_disabled(class);
1303 static inline unsigned int ata_dev_enabled(const struct ata_device
*dev
)
1305 return ata_class_enabled(dev
->class);
1308 static inline unsigned int ata_dev_disabled(const struct ata_device
*dev
)
1310 return ata_class_disabled(dev
->class);
1313 static inline unsigned int ata_dev_absent(const struct ata_device
*dev
)
1315 return ata_class_absent(dev
->class);
1321 static inline int ata_link_max_devices(const struct ata_link
*link
)
1323 if (ata_is_host_link(link
) && link
->ap
->flags
& ATA_FLAG_SLAVE_POSS
)
1328 static inline int ata_link_active(struct ata_link
*link
)
1330 return ata_tag_valid(link
->active_tag
) || link
->sactive
;
1336 * ATA_LITER_* constants are used to select link iteration mode and
1337 * ATA_DITER_* device iteration mode.
1339 * For a custom iteration directly using ata_{link|dev}_next(), if
1340 * @link or @dev, respectively, is NULL, the first element is
1341 * returned. @dev and @link can be any valid device or link and the
1342 * next element according to the iteration mode will be returned.
1343 * After the last element, NULL is returned.
1345 enum ata_link_iter_mode
{
1346 ATA_LITER_EDGE
, /* if present, PMP links only; otherwise,
1347 * host link. no slave link */
1348 ATA_LITER_HOST_FIRST
, /* host link followed by PMP or slave links */
1349 ATA_LITER_PMP_FIRST
, /* PMP links followed by host link,
1350 * slave link still comes after host link */
1353 enum ata_dev_iter_mode
{
1355 ATA_DITER_ENABLED_REVERSE
,
1357 ATA_DITER_ALL_REVERSE
,
1360 extern struct ata_link
*ata_link_next(struct ata_link
*link
,
1361 struct ata_port
*ap
,
1362 enum ata_link_iter_mode mode
);
1364 extern struct ata_device
*ata_dev_next(struct ata_device
*dev
,
1365 struct ata_link
*link
,
1366 enum ata_dev_iter_mode mode
);
1369 * Shortcut notation for iterations
1371 * ata_for_each_link() iterates over each link of @ap according to
1372 * @mode. @link points to the current link in the loop. @link is
1373 * NULL after loop termination. ata_for_each_dev() works the same way
1374 * except that it iterates over each device of @link.
1376 * Note that the mode prefixes ATA_{L|D}ITER_ shouldn't need to be
1377 * specified when using the following shorthand notations. Only the
1378 * mode itself (EDGE, HOST_FIRST, ENABLED, etc...) should be
1379 * specified. This not only increases brevity but also makes it
1380 * impossible to use ATA_LITER_* for device iteration or vice-versa.
1382 #define ata_for_each_link(link, ap, mode) \
1383 for ((link) = ata_link_next(NULL, (ap), ATA_LITER_##mode); (link); \
1384 (link) = ata_link_next((link), (ap), ATA_LITER_##mode))
1386 #define ata_for_each_dev(dev, link, mode) \
1387 for ((dev) = ata_dev_next(NULL, (link), ATA_DITER_##mode); (dev); \
1388 (dev) = ata_dev_next((dev), (link), ATA_DITER_##mode))
1391 * ata_ncq_enabled - Test whether NCQ is enabled
1392 * @dev: ATA device to test for
1395 * spin_lock_irqsave(host lock)
1398 * 1 if NCQ is enabled for @dev, 0 otherwise.
1400 static inline int ata_ncq_enabled(struct ata_device
*dev
)
1402 return (dev
->flags
& (ATA_DFLAG_PIO
| ATA_DFLAG_NCQ_OFF
|
1403 ATA_DFLAG_NCQ
)) == ATA_DFLAG_NCQ
;
1406 static inline void ata_qc_set_polling(struct ata_queued_cmd
*qc
)
1408 qc
->tf
.ctl
|= ATA_NIEN
;
1411 static inline struct ata_queued_cmd
*__ata_qc_from_tag(struct ata_port
*ap
,
1414 if (likely(ata_tag_valid(tag
)))
1415 return &ap
->qcmd
[tag
];
1419 static inline struct ata_queued_cmd
*ata_qc_from_tag(struct ata_port
*ap
,
1422 struct ata_queued_cmd
*qc
= __ata_qc_from_tag(ap
, tag
);
1424 if (unlikely(!qc
) || !ap
->ops
->error_handler
)
1427 if ((qc
->flags
& (ATA_QCFLAG_ACTIVE
|
1428 ATA_QCFLAG_FAILED
)) == ATA_QCFLAG_ACTIVE
)
1434 static inline unsigned int ata_qc_raw_nbytes(struct ata_queued_cmd
*qc
)
1436 return qc
->nbytes
- min(qc
->extrabytes
, qc
->nbytes
);
1439 static inline void ata_tf_init(struct ata_device
*dev
, struct ata_taskfile
*tf
)
1441 memset(tf
, 0, sizeof(*tf
));
1443 tf
->ctl
= dev
->link
->ap
->ctl
;
1444 if (dev
->devno
== 0)
1445 tf
->device
= ATA_DEVICE_OBS
;
1447 tf
->device
= ATA_DEVICE_OBS
| ATA_DEV1
;
1450 static inline void ata_qc_reinit(struct ata_queued_cmd
*qc
)
1452 qc
->dma_dir
= DMA_NONE
;
1457 qc
->nbytes
= qc
->extrabytes
= qc
->curbytes
= 0;
1460 qc
->sect_size
= ATA_SECT_SIZE
;
1462 ata_tf_init(qc
->dev
, &qc
->tf
);
1464 /* init result_tf such that it indicates normal completion */
1465 qc
->result_tf
.command
= ATA_DRDY
;
1466 qc
->result_tf
.feature
= 0;
1469 static inline int ata_try_flush_cache(const struct ata_device
*dev
)
1471 return ata_id_wcache_enabled(dev
->id
) ||
1472 ata_id_has_flush(dev
->id
) ||
1473 ata_id_has_flush_ext(dev
->id
);
1476 static inline unsigned int ac_err_mask(u8 status
)
1478 if (status
& (ATA_BUSY
| ATA_DRQ
))
1480 if (status
& (ATA_ERR
| ATA_DF
))
1485 static inline unsigned int __ac_err_mask(u8 status
)
1487 unsigned int mask
= ac_err_mask(status
);
1489 return AC_ERR_OTHER
;
1493 static inline struct ata_port
*ata_shost_to_port(struct Scsi_Host
*host
)
1495 return *(struct ata_port
**)&host
->hostdata
[0];
1498 static inline int ata_check_ready(u8 status
)
1500 if (!(status
& ATA_BUSY
))
1503 /* 0xff indicates either no device or device not ready */
1510 static inline unsigned long ata_deadline(unsigned long from_jiffies
,
1511 unsigned long timeout_msecs
)
1513 return from_jiffies
+ msecs_to_jiffies(timeout_msecs
);
1516 /* Don't open code these in drivers as there are traps. Firstly the range may
1517 change in future hardware and specs, secondly 0xFF means 'no DMA' but is
1518 > UDMA_0. Dyma ddreigiau */
1520 static inline int ata_using_mwdma(struct ata_device
*adev
)
1522 if (adev
->dma_mode
>= XFER_MW_DMA_0
&& adev
->dma_mode
<= XFER_MW_DMA_4
)
1527 static inline int ata_using_udma(struct ata_device
*adev
)
1529 if (adev
->dma_mode
>= XFER_UDMA_0
&& adev
->dma_mode
<= XFER_UDMA_7
)
1534 static inline int ata_dma_enabled(struct ata_device
*adev
)
1536 return (adev
->dma_mode
== 0xFF ? 0 : 1);
1539 /**************************************************************************
1540 * PMP - drivers/ata/libata-pmp.c
1542 #ifdef CONFIG_SATA_PMP
1544 extern const struct ata_port_operations sata_pmp_port_ops
;
1546 extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd
*qc
);
1547 extern void sata_pmp_error_handler(struct ata_port
*ap
);
1549 #else /* CONFIG_SATA_PMP */
1551 #define sata_pmp_port_ops sata_port_ops
1552 #define sata_pmp_qc_defer_cmd_switch ata_std_qc_defer
1553 #define sata_pmp_error_handler ata_std_error_handler
1555 #endif /* CONFIG_SATA_PMP */
1558 /**************************************************************************
1559 * SFF - drivers/ata/libata-sff.c
1561 #ifdef CONFIG_ATA_SFF
1563 extern const struct ata_port_operations ata_sff_port_ops
;
1564 extern const struct ata_port_operations ata_bmdma_port_ops
;
1565 extern const struct ata_port_operations ata_bmdma32_port_ops
;
1567 /* PIO only, sg_tablesize and dma_boundary limits can be removed */
1568 #define ATA_PIO_SHT(drv_name) \
1569 ATA_BASE_SHT(drv_name), \
1570 .sg_tablesize = LIBATA_MAX_PRD, \
1571 .dma_boundary = ATA_DMA_BOUNDARY
1573 #define ATA_BMDMA_SHT(drv_name) \
1574 ATA_BASE_SHT(drv_name), \
1575 .sg_tablesize = LIBATA_MAX_PRD, \
1576 .dma_boundary = ATA_DMA_BOUNDARY
1578 extern void ata_sff_qc_prep(struct ata_queued_cmd
*qc
);
1579 extern void ata_sff_dumb_qc_prep(struct ata_queued_cmd
*qc
);
1580 extern void ata_sff_dev_select(struct ata_port
*ap
, unsigned int device
);
1581 extern u8
ata_sff_check_status(struct ata_port
*ap
);
1582 extern void ata_sff_pause(struct ata_port
*ap
);
1583 extern void ata_sff_dma_pause(struct ata_port
*ap
);
1584 extern int ata_sff_busy_sleep(struct ata_port
*ap
,
1585 unsigned long timeout_pat
, unsigned long timeout
);
1586 extern int ata_sff_wait_ready(struct ata_link
*link
, unsigned long deadline
);
1587 extern void ata_sff_tf_load(struct ata_port
*ap
, const struct ata_taskfile
*tf
);
1588 extern void ata_sff_tf_read(struct ata_port
*ap
, struct ata_taskfile
*tf
);
1589 extern void ata_sff_exec_command(struct ata_port
*ap
,
1590 const struct ata_taskfile
*tf
);
1591 extern unsigned int ata_sff_data_xfer(struct ata_device
*dev
,
1592 unsigned char *buf
, unsigned int buflen
, int rw
);
1593 extern unsigned int ata_sff_data_xfer32(struct ata_device
*dev
,
1594 unsigned char *buf
, unsigned int buflen
, int rw
);
1595 extern unsigned int ata_sff_data_xfer_noirq(struct ata_device
*dev
,
1596 unsigned char *buf
, unsigned int buflen
, int rw
);
1597 extern u8
ata_sff_irq_on(struct ata_port
*ap
);
1598 extern void ata_sff_irq_clear(struct ata_port
*ap
);
1599 extern int ata_sff_hsm_move(struct ata_port
*ap
, struct ata_queued_cmd
*qc
,
1600 u8 status
, int in_wq
);
1601 extern unsigned int ata_sff_qc_issue(struct ata_queued_cmd
*qc
);
1602 extern bool ata_sff_qc_fill_rtf(struct ata_queued_cmd
*qc
);
1603 extern unsigned int ata_sff_host_intr(struct ata_port
*ap
,
1604 struct ata_queued_cmd
*qc
);
1605 extern irqreturn_t
ata_sff_interrupt(int irq
, void *dev_instance
);
1606 extern void ata_sff_lost_interrupt(struct ata_port
*ap
);
1607 extern void ata_sff_freeze(struct ata_port
*ap
);
1608 extern void ata_sff_thaw(struct ata_port
*ap
);
1609 extern int ata_sff_prereset(struct ata_link
*link
, unsigned long deadline
);
1610 extern unsigned int ata_sff_dev_classify(struct ata_device
*dev
, int present
,
1612 extern int ata_sff_wait_after_reset(struct ata_link
*link
, unsigned int devmask
,
1613 unsigned long deadline
);
1614 extern int ata_sff_softreset(struct ata_link
*link
, unsigned int *classes
,
1615 unsigned long deadline
);
1616 extern int sata_sff_hardreset(struct ata_link
*link
, unsigned int *class,
1617 unsigned long deadline
);
1618 extern void ata_sff_postreset(struct ata_link
*link
, unsigned int *classes
);
1619 extern void ata_sff_drain_fifo(struct ata_queued_cmd
*qc
);
1620 extern void ata_sff_error_handler(struct ata_port
*ap
);
1621 extern void ata_sff_post_internal_cmd(struct ata_queued_cmd
*qc
);
1622 extern int ata_sff_port_start(struct ata_port
*ap
);
1623 extern int ata_sff_port_start32(struct ata_port
*ap
);
1624 extern void ata_sff_std_ports(struct ata_ioports
*ioaddr
);
1625 extern unsigned long ata_bmdma_mode_filter(struct ata_device
*dev
,
1626 unsigned long xfer_mask
);
1627 extern void ata_bmdma_setup(struct ata_queued_cmd
*qc
);
1628 extern void ata_bmdma_start(struct ata_queued_cmd
*qc
);
1629 extern void ata_bmdma_stop(struct ata_queued_cmd
*qc
);
1630 extern u8
ata_bmdma_status(struct ata_port
*ap
);
1631 extern void ata_bus_reset(struct ata_port
*ap
);
1634 extern int ata_pci_bmdma_clear_simplex(struct pci_dev
*pdev
);
1635 extern int ata_pci_bmdma_init(struct ata_host
*host
);
1636 extern int ata_pci_sff_init_host(struct ata_host
*host
);
1637 extern int ata_pci_sff_prepare_host(struct pci_dev
*pdev
,
1638 const struct ata_port_info
* const * ppi
,
1639 struct ata_host
**r_host
);
1640 extern int ata_pci_sff_activate_host(struct ata_host
*host
,
1641 irq_handler_t irq_handler
,
1642 struct scsi_host_template
*sht
);
1643 extern int ata_pci_sff_init_one(struct pci_dev
*pdev
,
1644 const struct ata_port_info
* const * ppi
,
1645 struct scsi_host_template
*sht
, void *host_priv
);
1646 #endif /* CONFIG_PCI */
1649 * ata_sff_busy_wait - Wait for a port status register
1650 * @ap: Port to wait for.
1651 * @bits: bits that must be clear
1652 * @max: number of 10uS waits to perform
1654 * Waits up to max*10 microseconds for the selected bits in the port's
1655 * status register to be cleared.
1656 * Returns final value of status register.
1659 * Inherited from caller.
1661 static inline u8
ata_sff_busy_wait(struct ata_port
*ap
, unsigned int bits
,
1668 status
= ap
->ops
->sff_check_status(ap
);
1670 } while (status
!= 0xff && (status
& bits
) && (max
> 0));
1676 * ata_wait_idle - Wait for a port to be idle.
1677 * @ap: Port to wait for.
1679 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
1680 * Returns final value of status register.
1683 * Inherited from caller.
1685 static inline u8
ata_wait_idle(struct ata_port
*ap
)
1687 u8 status
= ata_sff_busy_wait(ap
, ATA_BUSY
| ATA_DRQ
, 1000);
1690 if (status
!= 0xff && (status
& (ATA_BUSY
| ATA_DRQ
)))
1691 ata_port_printk(ap
, KERN_DEBUG
, "abnormal Status 0x%X\n",
1697 #endif /* CONFIG_ATA_SFF */
1699 #endif /* __LINUX_LIBATA_H__ */