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/interrupt.h>
31 #include <linux/dma-mapping.h>
32 #include <linux/scatterlist.h>
34 #include <linux/ata.h>
35 #include <linux/workqueue.h>
36 #include <scsi/scsi_host.h>
37 #include <linux/acpi.h>
38 #include <linux/cdrom.h>
41 * Define if arch has non-standard setup. This is a _PCI_ standard
42 * not a legacy or ISA standard.
44 #ifdef CONFIG_ATA_NONSTANDARD
45 #include <asm/libata-portmap.h>
47 #include <asm-generic/libata-portmap.h>
51 * compile-time options: to be removed as soon as all the drivers are
52 * converted to the new debugging mechanism
54 #undef ATA_DEBUG /* debugging output */
55 #undef ATA_VERBOSE_DEBUG /* yet more debugging output */
56 #undef ATA_IRQ_TRAP /* define to ack screaming irqs */
57 #undef ATA_NDEBUG /* define to disable quick runtime checks */
60 /* note: prints function name for you */
62 #define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
63 #ifdef ATA_VERBOSE_DEBUG
64 #define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
66 #define VPRINTK(fmt, args...)
67 #endif /* ATA_VERBOSE_DEBUG */
69 #define DPRINTK(fmt, args...)
70 #define VPRINTK(fmt, args...)
71 #endif /* ATA_DEBUG */
73 #define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
75 /* NEW: debug levels */
76 #define HAVE_LIBATA_MSG 1
80 ATA_MSG_INFO
= 0x0002,
81 ATA_MSG_PROBE
= 0x0004,
82 ATA_MSG_WARN
= 0x0008,
83 ATA_MSG_MALLOC
= 0x0010,
85 ATA_MSG_INTR
= 0x0040,
89 #define ata_msg_drv(p) ((p)->msg_enable & ATA_MSG_DRV)
90 #define ata_msg_info(p) ((p)->msg_enable & ATA_MSG_INFO)
91 #define ata_msg_probe(p) ((p)->msg_enable & ATA_MSG_PROBE)
92 #define ata_msg_warn(p) ((p)->msg_enable & ATA_MSG_WARN)
93 #define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC)
94 #define ata_msg_ctl(p) ((p)->msg_enable & ATA_MSG_CTL)
95 #define ata_msg_intr(p) ((p)->msg_enable & ATA_MSG_INTR)
96 #define ata_msg_err(p) ((p)->msg_enable & ATA_MSG_ERR)
98 static inline u32
ata_msg_init(int dval
, int default_msg_enable_bits
)
100 if (dval
< 0 || dval
>= (sizeof(u32
) * 8))
101 return default_msg_enable_bits
; /* should be 0x1 - only driver info msgs */
104 return (1 << dval
) - 1;
107 /* defines only for the constants which don't work well as enums */
108 #define ATA_TAG_POISON 0xfafbfcfdU
111 /* various global constants */
112 LIBATA_MAX_PRD
= ATA_MAX_PRD
/ 2,
113 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,
120 ATA_DEF_BUSY_WAIT
= 10000,
121 ATA_SHORT_PAUSE
= (HZ
>> 6) + 1,
123 ATAPI_MAX_DRAIN
= 16 << 10,
125 ATA_ALL_DEVICES
= (1 << ATA_MAX_DEVICES
) - 1,
127 ATA_SHT_EMULATED
= 1,
128 ATA_SHT_CMD_PER_LUN
= 1,
129 ATA_SHT_THIS_ID
= -1,
130 ATA_SHT_USE_CLUSTERING
= 1,
132 /* struct ata_device stuff */
133 ATA_DFLAG_LBA
= (1 << 0), /* device supports LBA */
134 ATA_DFLAG_LBA48
= (1 << 1), /* device supports LBA48 */
135 ATA_DFLAG_CDB_INTR
= (1 << 2), /* device asserts INTRQ when ready for CDB */
136 ATA_DFLAG_NCQ
= (1 << 3), /* device supports NCQ */
137 ATA_DFLAG_FLUSH_EXT
= (1 << 4), /* do FLUSH_EXT instead of FLUSH */
138 ATA_DFLAG_ACPI_PENDING
= (1 << 5), /* ACPI resume action pending */
139 ATA_DFLAG_ACPI_FAILED
= (1 << 6), /* ACPI on devcfg has failed */
140 ATA_DFLAG_AN
= (1 << 7), /* AN configured */
141 ATA_DFLAG_HIPM
= (1 << 8), /* device supports HIPM */
142 ATA_DFLAG_DIPM
= (1 << 9), /* device supports DIPM */
143 ATA_DFLAG_DMADIR
= (1 << 10), /* device requires DMADIR */
144 ATA_DFLAG_CFG_MASK
= (1 << 12) - 1,
146 ATA_DFLAG_PIO
= (1 << 12), /* device limited to PIO mode */
147 ATA_DFLAG_NCQ_OFF
= (1 << 13), /* device limited to non-NCQ mode */
148 ATA_DFLAG_SPUNDOWN
= (1 << 14), /* XXX: for spindown_compat */
149 ATA_DFLAG_SLEEPING
= (1 << 15), /* device is sleeping */
150 ATA_DFLAG_DUBIOUS_XFER
= (1 << 16), /* data transfer not verified */
151 ATA_DFLAG_INIT_MASK
= (1 << 24) - 1,
153 ATA_DFLAG_DETACH
= (1 << 24),
154 ATA_DFLAG_DETACHED
= (1 << 25),
156 ATA_DEV_UNKNOWN
= 0, /* unknown device */
157 ATA_DEV_ATA
= 1, /* ATA device */
158 ATA_DEV_ATA_UNSUP
= 2, /* ATA device (unsupported) */
159 ATA_DEV_ATAPI
= 3, /* ATAPI device */
160 ATA_DEV_ATAPI_UNSUP
= 4, /* ATAPI device (unsupported) */
161 ATA_DEV_PMP
= 5, /* SATA port multiplier */
162 ATA_DEV_PMP_UNSUP
= 6, /* SATA port multiplier (unsupported) */
163 ATA_DEV_SEMB
= 7, /* SEMB */
164 ATA_DEV_SEMB_UNSUP
= 8, /* SEMB (unsupported) */
165 ATA_DEV_NONE
= 9, /* no device */
167 /* struct ata_link flags */
168 ATA_LFLAG_NO_SRST
= (1 << 2), /* avoid softreset */
169 ATA_LFLAG_ASSUME_ATA
= (1 << 3), /* assume ATA class */
170 ATA_LFLAG_ASSUME_SEMB
= (1 << 4), /* assume SEMB class */
171 ATA_LFLAG_ASSUME_CLASS
= ATA_LFLAG_ASSUME_ATA
| ATA_LFLAG_ASSUME_SEMB
,
172 ATA_LFLAG_NO_RETRY
= (1 << 5), /* don't retry this link */
173 ATA_LFLAG_DISABLED
= (1 << 6), /* link is disabled */
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_DEBUGMSG
= (1 << 13),
190 ATA_FLAG_IGN_SIMPLEX
= (1 << 15), /* ignore SIMPLEX */
191 ATA_FLAG_NO_IORDY
= (1 << 16), /* controller lacks iordy */
192 ATA_FLAG_ACPI_SATA
= (1 << 17), /* need native SATA ACPI layout */
193 ATA_FLAG_AN
= (1 << 18), /* controller supports AN */
194 ATA_FLAG_PMP
= (1 << 19), /* controller supports PMP */
195 ATA_FLAG_IPM
= (1 << 20), /* driver can handle IPM */
197 /* The following flag belongs to ap->pflags but is kept in
198 * ap->flags because it's referenced in many LLDs and will be
199 * removed in not-too-distant future.
201 ATA_FLAG_DISABLED
= (1 << 23), /* port is disabled, ignore it */
203 /* bits 24:31 of ap->flags are reserved for LLD specific flags */
205 /* struct ata_port pflags */
206 ATA_PFLAG_EH_PENDING
= (1 << 0), /* EH pending */
207 ATA_PFLAG_EH_IN_PROGRESS
= (1 << 1), /* EH in progress */
208 ATA_PFLAG_FROZEN
= (1 << 2), /* port is frozen */
209 ATA_PFLAG_RECOVERED
= (1 << 3), /* recovery action performed */
210 ATA_PFLAG_LOADING
= (1 << 4), /* boot/loading probe */
211 ATA_PFLAG_UNLOADING
= (1 << 5), /* module is unloading */
212 ATA_PFLAG_SCSI_HOTPLUG
= (1 << 6), /* SCSI hotplug scheduled */
213 ATA_PFLAG_INITIALIZING
= (1 << 7), /* being initialized, don't touch */
214 ATA_PFLAG_RESETTING
= (1 << 8), /* reset in progress */
216 ATA_PFLAG_SUSPENDED
= (1 << 17), /* port is suspended (power) */
217 ATA_PFLAG_PM_PENDING
= (1 << 18), /* PM operation pending */
218 ATA_PFLAG_INIT_GTM_VALID
= (1 << 19), /* initial gtm data valid */
220 /* struct ata_queued_cmd flags */
221 ATA_QCFLAG_ACTIVE
= (1 << 0), /* cmd not yet ack'd to scsi lyer */
222 ATA_QCFLAG_DMAMAP
= (1 << 1), /* SG table is DMA mapped */
223 ATA_QCFLAG_IO
= (1 << 3), /* standard IO command */
224 ATA_QCFLAG_RESULT_TF
= (1 << 4), /* result TF requested */
225 ATA_QCFLAG_CLEAR_EXCL
= (1 << 5), /* clear excl_link on completion */
226 ATA_QCFLAG_QUIET
= (1 << 6), /* don't report device error */
227 ATA_QCFLAG_RETRY
= (1 << 7), /* retry after failure */
229 ATA_QCFLAG_FAILED
= (1 << 16), /* cmd failed and is owned by EH */
230 ATA_QCFLAG_SENSE_VALID
= (1 << 17), /* sense data valid */
231 ATA_QCFLAG_EH_SCHEDULED
= (1 << 18), /* EH scheduled (obsolete) */
234 ATA_HOST_SIMPLEX
= (1 << 0), /* Host is simplex, one DMA channel per host only */
235 ATA_HOST_STARTED
= (1 << 1), /* Host started */
237 /* bits 24:31 of host->flags are reserved for LLD specific flags */
239 /* various lengths of time */
240 ATA_TMOUT_BOOT
= 30 * HZ
, /* heuristic */
241 ATA_TMOUT_BOOT_QUICK
= 7 * HZ
, /* heuristic */
242 ATA_TMOUT_INTERNAL
= 30 * HZ
,
243 ATA_TMOUT_INTERNAL_QUICK
= 5 * HZ
,
245 /* FIXME: GoVault needs 2s but we can't afford that without
246 * parallel probing. 800ms is enough for iVDR disk
247 * HHD424020F7SV00. Increase to 2secs when parallel probing
250 ATA_TMOUT_FF_WAIT
= 4 * HZ
/ 5,
252 /* Spec mandates to wait for ">= 2ms" before checking status
253 * after reset. We wait 150ms, because that was the magic
254 * delay used for ATAPI devices in Hale Landis's ATADRVR, for
255 * the period of time between when the ATA command register is
256 * written, and then status is checked. Because waiting for
257 * "a while" before checking status is fine, post SRST, we
258 * perform this magic delay here as well.
260 * Old drivers/ide uses the 2mS rule and then waits for ready.
262 ATA_WAIT_AFTER_RESET_MSECS
= 150,
264 /* If PMP is supported, we have to do follow-up SRST. As some
265 * PMPs don't send D2H Reg FIS after hardreset, LLDs are
266 * advised to wait only for the following duration before
269 ATA_TMOUT_PMP_SRST_WAIT
= 1 * HZ
,
283 /* SATA port states */
288 /* encoding various smaller bitmaps into a single
289 * unsigned long bitmap
291 ATA_NR_PIO_MODES
= 7,
292 ATA_NR_MWDMA_MODES
= 5,
293 ATA_NR_UDMA_MODES
= 8,
296 ATA_SHIFT_MWDMA
= ATA_SHIFT_PIO
+ ATA_NR_PIO_MODES
,
297 ATA_SHIFT_UDMA
= ATA_SHIFT_MWDMA
+ ATA_NR_MWDMA_MODES
,
299 /* size of buffer to pad xfers ending on unaligned boundaries */
305 /* return values for ->qc_defer */
309 /* desc_len for ata_eh_info and context */
310 ATA_EH_DESC_LEN
= 80,
312 /* reset / recovery action types */
313 ATA_EH_REVALIDATE
= (1 << 0),
314 ATA_EH_SOFTRESET
= (1 << 1), /* meaningful only in ->prereset */
315 ATA_EH_HARDRESET
= (1 << 2), /* meaningful only in ->prereset */
316 ATA_EH_RESET
= ATA_EH_SOFTRESET
| ATA_EH_HARDRESET
,
317 ATA_EH_ENABLE_LINK
= (1 << 3),
318 ATA_EH_LPM
= (1 << 4), /* link power management action */
320 ATA_EH_PERDEV_MASK
= ATA_EH_REVALIDATE
,
322 /* ata_eh_info->flags */
323 ATA_EHI_HOTPLUGGED
= (1 << 0), /* could have been hotplugged */
324 ATA_EHI_NO_AUTOPSY
= (1 << 2), /* no autopsy */
325 ATA_EHI_QUIET
= (1 << 3), /* be quiet */
327 ATA_EHI_DID_SOFTRESET
= (1 << 16), /* already soft-reset this port */
328 ATA_EHI_DID_HARDRESET
= (1 << 17), /* already soft-reset this port */
329 ATA_EHI_PRINTINFO
= (1 << 18), /* print configuration info */
330 ATA_EHI_SETMODE
= (1 << 19), /* configure transfer mode */
331 ATA_EHI_POST_SETMODE
= (1 << 20), /* revaildating after setmode */
333 ATA_EHI_DID_RESET
= ATA_EHI_DID_SOFTRESET
| ATA_EHI_DID_HARDRESET
,
335 /* max tries if error condition is still set after ->error_handler */
336 ATA_EH_MAX_TRIES
= 5,
338 /* how hard are we gonna try to probe/recover devices */
339 ATA_PROBE_MAX_TRIES
= 3,
340 ATA_EH_DEV_TRIES
= 3,
341 ATA_EH_PMP_TRIES
= 5,
342 ATA_EH_PMP_LINK_TRIES
= 3,
344 SATA_PMP_RW_TIMEOUT
= 3000, /* PMP read/write timeout */
346 /* Horkage types. May be set by libata or controller on drives
347 (some horkage may be drive/controller pair dependant */
349 ATA_HORKAGE_DIAGNOSTIC
= (1 << 0), /* Failed boot diag */
350 ATA_HORKAGE_NODMA
= (1 << 1), /* DMA problems */
351 ATA_HORKAGE_NONCQ
= (1 << 2), /* Don't use NCQ */
352 ATA_HORKAGE_MAX_SEC_128
= (1 << 3), /* Limit max sects to 128 */
353 ATA_HORKAGE_BROKEN_HPA
= (1 << 4), /* Broken HPA */
354 ATA_HORKAGE_DISABLE
= (1 << 5), /* Disable it */
355 ATA_HORKAGE_HPA_SIZE
= (1 << 6), /* native size off by one */
356 ATA_HORKAGE_IPM
= (1 << 7), /* Link PM problems */
357 ATA_HORKAGE_IVB
= (1 << 8), /* cbl det validity bit bugs */
358 ATA_HORKAGE_STUCK_ERR
= (1 << 9), /* stuck ERR on next PACKET */
360 /* DMA mask for user DMA control: User visible values; DO NOT
362 ATA_DMA_MASK_ATA
= (1 << 0), /* DMA on ATA Disk */
363 ATA_DMA_MASK_ATAPI
= (1 << 1), /* DMA on ATAPI */
364 ATA_DMA_MASK_CFA
= (1 << 2), /* DMA on CF Card */
366 /* ATAPI command types */
367 ATAPI_READ
= 0, /* READs */
368 ATAPI_WRITE
= 1, /* WRITEs */
369 ATAPI_READ_CD
= 2, /* READ CD [MSF] */
370 ATAPI_PASS_THRU
= 3, /* SAT pass-thru */
371 ATAPI_MISC
= 4, /* the rest */
373 /* Timing constants */
374 ATA_TIMING_SETUP
= (1 << 0),
375 ATA_TIMING_ACT8B
= (1 << 1),
376 ATA_TIMING_REC8B
= (1 << 2),
377 ATA_TIMING_CYC8B
= (1 << 3),
378 ATA_TIMING_8BIT
= ATA_TIMING_ACT8B
| ATA_TIMING_REC8B
|
380 ATA_TIMING_ACTIVE
= (1 << 4),
381 ATA_TIMING_RECOVER
= (1 << 5),
382 ATA_TIMING_CYCLE
= (1 << 6),
383 ATA_TIMING_UDMA
= (1 << 7),
384 ATA_TIMING_ALL
= ATA_TIMING_SETUP
| ATA_TIMING_ACT8B
|
385 ATA_TIMING_REC8B
| ATA_TIMING_CYC8B
|
386 ATA_TIMING_ACTIVE
| ATA_TIMING_RECOVER
|
387 ATA_TIMING_CYCLE
| ATA_TIMING_UDMA
,
391 ATA_MASK_PIO
= ((1LU << ATA_NR_PIO_MODES
) - 1)
393 ATA_MASK_MWDMA
= ((1LU << ATA_NR_MWDMA_MODES
) - 1)
395 ATA_MASK_UDMA
= ((1LU << ATA_NR_UDMA_MODES
) - 1)
399 enum hsm_task_states
{
400 HSM_ST_IDLE
, /* no command on going */
401 HSM_ST_FIRST
, /* (waiting the device to)
402 write CDB or first data block */
403 HSM_ST
, /* (waiting the device to) transfer data */
404 HSM_ST_LAST
, /* (waiting the device to) complete command */
405 HSM_ST_ERR
, /* error */
408 enum ata_completion_errors
{
409 AC_ERR_DEV
= (1 << 0), /* device reported error */
410 AC_ERR_HSM
= (1 << 1), /* host state machine violation */
411 AC_ERR_TIMEOUT
= (1 << 2), /* timeout */
412 AC_ERR_MEDIA
= (1 << 3), /* media error */
413 AC_ERR_ATA_BUS
= (1 << 4), /* ATA bus error */
414 AC_ERR_HOST_BUS
= (1 << 5), /* host bus error */
415 AC_ERR_SYSTEM
= (1 << 6), /* system error */
416 AC_ERR_INVALID
= (1 << 7), /* invalid argument */
417 AC_ERR_OTHER
= (1 << 8), /* unknown */
418 AC_ERR_NODEV_HINT
= (1 << 9), /* polling device detection hint */
419 AC_ERR_NCQ
= (1 << 10), /* marker for offending NCQ qc */
422 /* forward declarations */
424 struct ata_port_operations
;
427 struct ata_queued_cmd
;
430 typedef void (*ata_qc_cb_t
) (struct ata_queued_cmd
*qc
);
431 typedef int (*ata_prereset_fn_t
)(struct ata_link
*link
, unsigned long deadline
);
432 typedef int (*ata_reset_fn_t
)(struct ata_link
*link
, unsigned int *classes
,
433 unsigned long deadline
);
434 typedef void (*ata_postreset_fn_t
)(struct ata_link
*link
, unsigned int *classes
);
437 * host pm policy: If you alter this, you also need to alter libata-scsi.c
438 * (for the ascii descriptions)
446 extern struct device_attribute dev_attr_link_power_management_policy
;
448 #ifdef CONFIG_ATA_SFF
450 void __iomem
*cmd_addr
;
451 void __iomem
*data_addr
;
452 void __iomem
*error_addr
;
453 void __iomem
*feature_addr
;
454 void __iomem
*nsect_addr
;
455 void __iomem
*lbal_addr
;
456 void __iomem
*lbam_addr
;
457 void __iomem
*lbah_addr
;
458 void __iomem
*device_addr
;
459 void __iomem
*status_addr
;
460 void __iomem
*command_addr
;
461 void __iomem
*altstatus_addr
;
462 void __iomem
*ctl_addr
;
463 void __iomem
*bmdma_addr
;
464 void __iomem
*scr_addr
;
466 #endif /* CONFIG_ATA_SFF */
471 void __iomem
* const *iomap
;
472 unsigned int n_ports
;
474 struct ata_port_operations
*ops
;
476 #ifdef CONFIG_ATA_ACPI
477 acpi_handle acpi_handle
;
479 struct ata_port
*simplex_claimed
; /* channel owning the DMA */
480 struct ata_port
*ports
[0];
483 struct ata_queued_cmd
{
485 struct ata_device
*dev
;
487 struct scsi_cmnd
*scsicmd
;
488 void (*scsidone
)(struct scsi_cmnd
*);
490 struct ata_taskfile tf
;
491 u8 cdb
[ATAPI_CDB_LEN
];
493 unsigned long flags
; /* ATA_QCFLAG_xxx */
499 unsigned int sect_size
;
502 unsigned int extrabytes
;
503 unsigned int curbytes
;
505 struct scatterlist
*cursg
;
506 unsigned int cursg_ofs
;
508 struct scatterlist sgent
;
510 struct scatterlist
*sg
;
512 unsigned int err_mask
;
513 struct ata_taskfile result_tf
;
514 ata_qc_cb_t complete_fn
;
520 struct ata_port_stats
{
521 unsigned long unhandled_irq
;
522 unsigned long idle_irq
;
523 unsigned long rw_reqbuf
;
526 struct ata_ering_entry
{
528 unsigned int err_mask
;
534 struct ata_ering_entry ring
[ATA_ERING_SIZE
];
538 struct ata_link
*link
;
539 unsigned int devno
; /* 0 or 1 */
540 unsigned long flags
; /* ATA_DFLAG_xxx */
541 unsigned int horkage
; /* List of broken features */
542 struct scsi_device
*sdev
; /* attached SCSI device */
543 #ifdef CONFIG_ATA_ACPI
544 acpi_handle acpi_handle
;
545 union acpi_object
*gtf_cache
;
547 /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */
548 u64 n_sectors
; /* size of device, if ATA */
549 unsigned int class; /* ATA_DEV_xxx */
554 unsigned int xfer_shift
; /* ATA_SHIFT_xxx */
556 unsigned int multi_count
; /* sectors count for
557 READ/WRITE MULTIPLE */
558 unsigned int max_sectors
; /* per-device max sectors */
559 unsigned int cdb_len
;
561 /* per-dev xfer mask */
562 unsigned long pio_mask
;
563 unsigned long mwdma_mask
;
564 unsigned long udma_mask
;
566 /* for CHS addressing */
567 u16 cylinders
; /* Number of cylinders */
568 u16 heads
; /* Number of heads */
569 u16 sectors
; /* Number of sectors per track */
573 struct ata_ering ering
;
576 u16 id
[ATA_ID_WORDS
]; /* IDENTIFY xxx DEVICE data */
577 u32 gscr
[SATA_PMP_GSCR_DWORDS
]; /* PMP GSCR block */
581 /* Offset into struct ata_device. Fields above it are maintained
582 * acress device init. Fields below are zeroed.
584 #define ATA_DEVICE_CLEAR_OFFSET offsetof(struct ata_device, n_sectors)
587 struct ata_device
*dev
; /* offending device */
588 u32 serror
; /* SError from LLDD */
589 unsigned int err_mask
; /* port-wide err_mask */
590 unsigned int action
; /* ATA_EH_* action mask */
591 unsigned int dev_action
[ATA_MAX_DEVICES
]; /* dev EH action */
592 unsigned int flags
; /* ATA_EHI_* flags */
594 unsigned int probe_mask
;
596 char desc
[ATA_EH_DESC_LEN
];
600 struct ata_eh_context
{
601 struct ata_eh_info i
;
602 int tries
[ATA_MAX_DEVICES
];
603 unsigned int classes
[ATA_MAX_DEVICES
];
604 unsigned int did_probe_mask
;
605 unsigned int saved_ncq_enabled
;
606 u8 saved_xfer_mode
[ATA_MAX_DEVICES
];
609 struct ata_acpi_drive
615 struct ata_acpi_gtm
{
616 struct ata_acpi_drive drive
[2];
622 int pmp
; /* port multiplier port # */
624 unsigned int active_tag
; /* active tag on this link */
625 u32 sactive
; /* active NCQ commands */
627 unsigned int flags
; /* ATA_LFLAG_xxx */
629 unsigned int hw_sata_spd_limit
;
630 unsigned int sata_spd_limit
;
631 unsigned int sata_spd
; /* current SATA PHY speed */
633 /* record runtime error info, protected by host_set lock */
634 struct ata_eh_info eh_info
;
636 struct ata_eh_context eh_context
;
638 struct ata_device device
[ATA_MAX_DEVICES
];
642 struct Scsi_Host
*scsi_host
; /* our co-allocated scsi host */
643 struct ata_port_operations
*ops
;
645 unsigned long flags
; /* ATA_FLAG_xxx */
646 unsigned int pflags
; /* ATA_PFLAG_xxx */
647 unsigned int print_id
; /* user visible unique port ID */
648 unsigned int port_no
; /* 0 based port no. inside the host */
650 struct ata_prd
*prd
; /* our SG list */
651 dma_addr_t prd_dma
; /* and its DMA mapping */
653 #ifdef CONFIG_ATA_SFF
654 struct ata_ioports ioaddr
; /* ATA cmd/ctl/dma register blocks */
655 #endif /* CONFIG_ATA_SFF */
657 u8 ctl
; /* cache of ATA control register */
658 u8 last_ctl
; /* Cache last written value */
659 unsigned int pio_mask
;
660 unsigned int mwdma_mask
;
661 unsigned int udma_mask
;
662 unsigned int cbl
; /* cable type; ATA_CBL_xxx */
664 struct ata_queued_cmd qcmd
[ATA_MAX_QUEUE
];
665 unsigned long qc_allocated
;
666 unsigned int qc_active
;
667 int nr_active_links
; /* #links with active qcs */
669 struct ata_link link
; /* host default link */
671 int nr_pmp_links
; /* nr of available PMP links */
672 struct ata_link
*pmp_link
; /* array of PMP links */
673 struct ata_link
*excl_link
; /* for PMP qc exclusion */
675 struct ata_port_stats stats
;
676 struct ata_host
*host
;
679 void *port_task_data
;
680 struct delayed_work port_task
;
681 struct delayed_work hotplug_task
;
682 struct work_struct scsi_rescan_task
;
684 unsigned int hsm_task_state
;
687 struct list_head eh_done_q
;
688 wait_queue_head_t eh_wait_q
;
691 pm_message_t pm_mesg
;
693 enum link_pm pm_policy
;
695 struct timer_list fastdrain_timer
;
696 unsigned long fastdrain_cnt
;
700 #ifdef CONFIG_ATA_ACPI
701 acpi_handle acpi_handle
;
702 struct ata_acpi_gtm __acpi_init_gtm
; /* use ata_acpi_init_gtm() */
704 u8 sector_buf
[ATA_SECT_SIZE
]; /* owned by EH */
707 /* The following initializer overrides a method to NULL whether one of
708 * its parent has the method defined or not. This is equivalent to
709 * ERR_PTR(-ENOENT). Unfortunately, ERR_PTR doesn't render a constant
710 * expression and thus can't be used as an initializer.
712 #define ATA_OP_NULL (void *)(unsigned long)(-ENOENT)
714 struct ata_port_operations
{
718 int (*qc_defer
)(struct ata_queued_cmd
*qc
);
719 int (*check_atapi_dma
)(struct ata_queued_cmd
*qc
);
720 void (*qc_prep
)(struct ata_queued_cmd
*qc
);
721 unsigned int (*qc_issue
)(struct ata_queued_cmd
*qc
);
722 bool (*qc_fill_rtf
)(struct ata_queued_cmd
*qc
);
725 * Configuration and exception handling
727 int (*cable_detect
)(struct ata_port
*ap
);
728 unsigned long (*mode_filter
)(struct ata_device
*dev
, unsigned long xfer_mask
);
729 void (*set_piomode
)(struct ata_port
*ap
, struct ata_device
*dev
);
730 void (*set_dmamode
)(struct ata_port
*ap
, struct ata_device
*dev
);
731 int (*set_mode
)(struct ata_link
*link
, struct ata_device
**r_failed_dev
);
733 void (*dev_config
)(struct ata_device
*dev
);
735 void (*freeze
)(struct ata_port
*ap
);
736 void (*thaw
)(struct ata_port
*ap
);
737 ata_prereset_fn_t prereset
;
738 ata_reset_fn_t softreset
;
739 ata_reset_fn_t hardreset
;
740 ata_postreset_fn_t postreset
;
741 ata_prereset_fn_t pmp_prereset
;
742 ata_reset_fn_t pmp_softreset
;
743 ata_reset_fn_t pmp_hardreset
;
744 ata_postreset_fn_t pmp_postreset
;
745 void (*error_handler
)(struct ata_port
*ap
);
746 void (*post_internal_cmd
)(struct ata_queued_cmd
*qc
);
751 int (*scr_read
)(struct ata_port
*ap
, unsigned int sc_reg
, u32
*val
);
752 int (*scr_write
)(struct ata_port
*ap
, unsigned int sc_reg
, u32 val
);
753 void (*pmp_attach
)(struct ata_port
*ap
);
754 void (*pmp_detach
)(struct ata_port
*ap
);
755 int (*enable_pm
)(struct ata_port
*ap
, enum link_pm policy
);
756 void (*disable_pm
)(struct ata_port
*ap
);
759 * Start, stop, suspend and resume
761 int (*port_suspend
)(struct ata_port
*ap
, pm_message_t mesg
);
762 int (*port_resume
)(struct ata_port
*ap
);
763 int (*port_start
)(struct ata_port
*ap
);
764 void (*port_stop
)(struct ata_port
*ap
);
765 void (*host_stop
)(struct ata_host
*host
);
767 #ifdef CONFIG_ATA_SFF
769 * SFF / taskfile oriented ops
771 void (*sff_dev_select
)(struct ata_port
*ap
, unsigned int device
);
772 u8 (*sff_check_status
)(struct ata_port
*ap
);
773 u8 (*sff_check_altstatus
)(struct ata_port
*ap
);
774 void (*sff_tf_load
)(struct ata_port
*ap
, const struct ata_taskfile
*tf
);
775 void (*sff_tf_read
)(struct ata_port
*ap
, struct ata_taskfile
*tf
);
776 void (*sff_exec_command
)(struct ata_port
*ap
,
777 const struct ata_taskfile
*tf
);
778 unsigned int (*sff_data_xfer
)(struct ata_device
*dev
,
779 unsigned char *buf
, unsigned int buflen
, int rw
);
780 u8 (*sff_irq_on
)(struct ata_port
*);
781 void (*sff_irq_clear
)(struct ata_port
*);
783 void (*bmdma_setup
)(struct ata_queued_cmd
*qc
);
784 void (*bmdma_start
)(struct ata_queued_cmd
*qc
);
785 void (*bmdma_stop
)(struct ata_queued_cmd
*qc
);
786 u8 (*bmdma_status
)(struct ata_port
*ap
);
787 #endif /* CONFIG_ATA_SFF */
792 void (*phy_reset
)(struct ata_port
*ap
);
793 void (*eng_timeout
)(struct ata_port
*ap
);
796 * ->inherits must be the last field and all the preceding
797 * fields must be pointers.
799 const struct ata_port_operations
*inherits
;
802 struct ata_port_info
{
804 unsigned long link_flags
;
805 unsigned long pio_mask
;
806 unsigned long mwdma_mask
;
807 unsigned long udma_mask
;
808 struct ata_port_operations
*port_ops
;
813 unsigned short mode
; /* ATA mode */
814 unsigned short setup
; /* t1 */
815 unsigned short act8b
; /* t2 for 8-bit I/O */
816 unsigned short rec8b
; /* t2i for 8-bit I/O */
817 unsigned short cyc8b
; /* t0 for 8-bit I/O */
818 unsigned short active
; /* t2 or tD */
819 unsigned short recover
; /* t2i or tK */
820 unsigned short cycle
; /* t0 */
821 unsigned short udma
; /* t2CYCTYP/2 */
825 * Core layer - drivers/ata/libata-core.c
827 extern const unsigned long sata_deb_timing_normal
[];
828 extern const unsigned long sata_deb_timing_hotplug
[];
829 extern const unsigned long sata_deb_timing_long
[];
831 extern struct ata_port_operations ata_dummy_port_ops
;
832 extern const struct ata_port_info ata_dummy_port_info
;
834 static inline const unsigned long *
835 sata_ehc_deb_timing(struct ata_eh_context
*ehc
)
837 if (ehc
->i
.flags
& ATA_EHI_HOTPLUGGED
)
838 return sata_deb_timing_hotplug
;
840 return sata_deb_timing_normal
;
843 static inline int ata_port_is_dummy(struct ata_port
*ap
)
845 return ap
->ops
== &ata_dummy_port_ops
;
848 extern void ata_port_probe(struct ata_port
*);
849 extern int sata_set_spd(struct ata_link
*link
);
850 extern int ata_std_prereset(struct ata_link
*link
, unsigned long deadline
);
851 extern int ata_wait_after_reset(struct ata_link
*link
, unsigned long deadline
,
852 int (*check_ready
)(struct ata_link
*link
));
853 extern int sata_link_debounce(struct ata_link
*link
,
854 const unsigned long *params
, unsigned long deadline
);
855 extern int sata_link_resume(struct ata_link
*link
, const unsigned long *params
,
856 unsigned long deadline
);
857 extern int sata_link_hardreset(struct ata_link
*link
,
858 const unsigned long *timing
, unsigned long deadline
,
859 bool *online
, int (*check_ready
)(struct ata_link
*));
860 extern int sata_std_hardreset(struct ata_link
*link
, unsigned int *class,
861 unsigned long deadline
);
862 extern void ata_std_postreset(struct ata_link
*link
, unsigned int *classes
);
863 extern void ata_port_disable(struct ata_port
*);
865 extern struct ata_host
*ata_host_alloc(struct device
*dev
, int max_ports
);
866 extern struct ata_host
*ata_host_alloc_pinfo(struct device
*dev
,
867 const struct ata_port_info
* const * ppi
, int n_ports
);
868 extern int ata_host_start(struct ata_host
*host
);
869 extern int ata_host_register(struct ata_host
*host
,
870 struct scsi_host_template
*sht
);
871 extern int ata_host_activate(struct ata_host
*host
, int irq
,
872 irq_handler_t irq_handler
, unsigned long irq_flags
,
873 struct scsi_host_template
*sht
);
874 extern void ata_host_detach(struct ata_host
*host
);
875 extern void ata_host_init(struct ata_host
*, struct device
*,
876 unsigned long, struct ata_port_operations
*);
877 extern int ata_scsi_detect(struct scsi_host_template
*sht
);
878 extern int ata_scsi_ioctl(struct scsi_device
*dev
, int cmd
, void __user
*arg
);
879 extern int ata_scsi_queuecmd(struct scsi_cmnd
*cmd
, void (*done
)(struct scsi_cmnd
*));
880 extern void ata_sas_port_destroy(struct ata_port
*);
881 extern struct ata_port
*ata_sas_port_alloc(struct ata_host
*,
882 struct ata_port_info
*, struct Scsi_Host
*);
883 extern int ata_sas_port_init(struct ata_port
*);
884 extern int ata_sas_port_start(struct ata_port
*ap
);
885 extern void ata_sas_port_stop(struct ata_port
*ap
);
886 extern int ata_sas_slave_configure(struct scsi_device
*, struct ata_port
*);
887 extern int ata_sas_queuecmd(struct scsi_cmnd
*cmd
, void (*done
)(struct scsi_cmnd
*),
888 struct ata_port
*ap
);
889 extern int sata_scr_valid(struct ata_link
*link
);
890 extern int sata_scr_read(struct ata_link
*link
, int reg
, u32
*val
);
891 extern int sata_scr_write(struct ata_link
*link
, int reg
, u32 val
);
892 extern int sata_scr_write_flush(struct ata_link
*link
, int reg
, u32 val
);
893 extern int ata_link_online(struct ata_link
*link
);
894 extern int ata_link_offline(struct ata_link
*link
);
896 extern int ata_host_suspend(struct ata_host
*host
, pm_message_t mesg
);
897 extern void ata_host_resume(struct ata_host
*host
);
899 extern int ata_ratelimit(void);
900 extern u32
ata_wait_register(void __iomem
*reg
, u32 mask
, u32 val
,
901 unsigned long interval_msec
,
902 unsigned long timeout_msec
);
903 extern int atapi_cmd_type(u8 opcode
);
904 extern void ata_tf_to_fis(const struct ata_taskfile
*tf
,
905 u8 pmp
, int is_cmd
, u8
*fis
);
906 extern void ata_tf_from_fis(const u8
*fis
, struct ata_taskfile
*tf
);
907 extern unsigned long ata_pack_xfermask(unsigned long pio_mask
,
908 unsigned long mwdma_mask
, unsigned long udma_mask
);
909 extern void ata_unpack_xfermask(unsigned long xfer_mask
,
910 unsigned long *pio_mask
, unsigned long *mwdma_mask
,
911 unsigned long *udma_mask
);
912 extern u8
ata_xfer_mask2mode(unsigned long xfer_mask
);
913 extern unsigned long ata_xfer_mode2mask(u8 xfer_mode
);
914 extern int ata_xfer_mode2shift(unsigned long xfer_mode
);
915 extern const char *ata_mode_string(unsigned long xfer_mask
);
916 extern unsigned long ata_id_xfermask(const u16
*id
);
917 extern int ata_port_start(struct ata_port
*ap
);
918 extern int ata_std_qc_defer(struct ata_queued_cmd
*qc
);
919 extern void ata_noop_qc_prep(struct ata_queued_cmd
*qc
);
920 extern void ata_sg_init(struct ata_queued_cmd
*qc
, struct scatterlist
*sg
,
921 unsigned int n_elem
);
922 extern unsigned int ata_dev_classify(const struct ata_taskfile
*tf
);
923 extern void ata_dev_disable(struct ata_device
*adev
);
924 extern void ata_id_string(const u16
*id
, unsigned char *s
,
925 unsigned int ofs
, unsigned int len
);
926 extern void ata_id_c_string(const u16
*id
, unsigned char *s
,
927 unsigned int ofs
, unsigned int len
);
928 extern void ata_qc_complete(struct ata_queued_cmd
*qc
);
929 extern int ata_qc_complete_multiple(struct ata_port
*ap
, u32 qc_active
);
930 extern void ata_scsi_simulate(struct ata_device
*dev
, struct scsi_cmnd
*cmd
,
931 void (*done
)(struct scsi_cmnd
*));
932 extern int ata_std_bios_param(struct scsi_device
*sdev
,
933 struct block_device
*bdev
,
934 sector_t capacity
, int geom
[]);
935 extern int ata_scsi_slave_config(struct scsi_device
*sdev
);
936 extern void ata_scsi_slave_destroy(struct scsi_device
*sdev
);
937 extern int ata_scsi_change_queue_depth(struct scsi_device
*sdev
,
939 extern struct ata_device
*ata_dev_pair(struct ata_device
*adev
);
940 extern int ata_do_set_mode(struct ata_link
*link
, struct ata_device
**r_failed_dev
);
942 extern int ata_cable_40wire(struct ata_port
*ap
);
943 extern int ata_cable_80wire(struct ata_port
*ap
);
944 extern int ata_cable_sata(struct ata_port
*ap
);
945 extern int ata_cable_ignore(struct ata_port
*ap
);
946 extern int ata_cable_unknown(struct ata_port
*ap
);
949 extern unsigned int ata_pio_need_iordy(const struct ata_device
*);
950 extern const struct ata_timing
*ata_timing_find_mode(u8 xfer_mode
);
951 extern int ata_timing_compute(struct ata_device
*, unsigned short,
952 struct ata_timing
*, int, int);
953 extern void ata_timing_merge(const struct ata_timing
*,
954 const struct ata_timing
*, struct ata_timing
*,
956 extern u8
ata_timing_cycle2mode(unsigned int xfer_shift
, int cycle
);
963 unsigned int reg
; /* PCI config register to read */
964 unsigned int width
; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
969 extern int pci_test_config_bits(struct pci_dev
*pdev
, const struct pci_bits
*bits
);
970 extern void ata_pci_remove_one(struct pci_dev
*pdev
);
973 extern void ata_pci_device_do_suspend(struct pci_dev
*pdev
, pm_message_t mesg
);
974 extern int __must_check
ata_pci_device_do_resume(struct pci_dev
*pdev
);
975 extern int ata_pci_device_suspend(struct pci_dev
*pdev
, pm_message_t mesg
);
976 extern int ata_pci_device_resume(struct pci_dev
*pdev
);
977 #endif /* CONFIG_PM */
978 #endif /* CONFIG_PCI */
981 * ACPI - drivers/ata/libata-acpi.c
983 #ifdef CONFIG_ATA_ACPI
984 static inline const struct ata_acpi_gtm
*ata_acpi_init_gtm(struct ata_port
*ap
)
986 if (ap
->pflags
& ATA_PFLAG_INIT_GTM_VALID
)
987 return &ap
->__acpi_init_gtm
;
990 int ata_acpi_stm(struct ata_port
*ap
, const struct ata_acpi_gtm
*stm
);
991 int ata_acpi_gtm(struct ata_port
*ap
, struct ata_acpi_gtm
*stm
);
992 unsigned long ata_acpi_gtm_xfermask(struct ata_device
*dev
,
993 const struct ata_acpi_gtm
*gtm
);
994 int ata_acpi_cbl_80wire(struct ata_port
*ap
, const struct ata_acpi_gtm
*gtm
);
996 static inline const struct ata_acpi_gtm
*ata_acpi_init_gtm(struct ata_port
*ap
)
1001 static inline int ata_acpi_stm(const struct ata_port
*ap
,
1002 struct ata_acpi_gtm
*stm
)
1007 static inline int ata_acpi_gtm(const struct ata_port
*ap
,
1008 struct ata_acpi_gtm
*stm
)
1013 static inline unsigned int ata_acpi_gtm_xfermask(struct ata_device
*dev
,
1014 const struct ata_acpi_gtm
*gtm
)
1019 static inline int ata_acpi_cbl_80wire(struct ata_port
*ap
,
1020 const struct ata_acpi_gtm
*gtm
)
1027 * EH - drivers/ata/libata-eh.c
1029 extern void ata_port_schedule_eh(struct ata_port
*ap
);
1030 extern int ata_link_abort(struct ata_link
*link
);
1031 extern int ata_port_abort(struct ata_port
*ap
);
1032 extern int ata_port_freeze(struct ata_port
*ap
);
1033 extern int sata_async_notification(struct ata_port
*ap
);
1035 extern void ata_eh_freeze_port(struct ata_port
*ap
);
1036 extern void ata_eh_thaw_port(struct ata_port
*ap
);
1038 extern void ata_eh_qc_complete(struct ata_queued_cmd
*qc
);
1039 extern void ata_eh_qc_retry(struct ata_queued_cmd
*qc
);
1040 extern void ata_eh_analyze_ncq_error(struct ata_link
*link
);
1042 extern void ata_do_eh(struct ata_port
*ap
, ata_prereset_fn_t prereset
,
1043 ata_reset_fn_t softreset
, ata_reset_fn_t hardreset
,
1044 ata_postreset_fn_t postreset
);
1045 extern void ata_std_error_handler(struct ata_port
*ap
);
1048 * Base operations to inherit from and initializers for sht
1052 * base : Common to all libata drivers.
1053 * sata : SATA controllers w/ native interface.
1054 * pmp : SATA controllers w/ PMP support.
1055 * sff : SFF ATA controllers w/o BMDMA support.
1056 * bmdma : SFF ATA controllers w/ BMDMA support.
1060 * BASE : Common to all libata drivers. The user must set
1061 * sg_tablesize and dma_boundary.
1062 * PIO : SFF ATA controllers w/ only PIO support.
1063 * BMDMA : SFF ATA controllers w/ BMDMA support. sg_tablesize and
1064 * dma_boundary are set to BMDMA limits.
1065 * NCQ : SATA controllers supporting NCQ. The user must set
1066 * sg_tablesize, dma_boundary and can_queue.
1068 extern const struct ata_port_operations ata_base_port_ops
;
1069 extern const struct ata_port_operations sata_port_ops
;
1071 #define ATA_BASE_SHT(drv_name) \
1072 .module = THIS_MODULE, \
1074 .ioctl = ata_scsi_ioctl, \
1075 .queuecommand = ata_scsi_queuecmd, \
1076 .can_queue = ATA_DEF_QUEUE, \
1077 .this_id = ATA_SHT_THIS_ID, \
1078 .cmd_per_lun = ATA_SHT_CMD_PER_LUN, \
1079 .emulated = ATA_SHT_EMULATED, \
1080 .use_clustering = ATA_SHT_USE_CLUSTERING, \
1081 .proc_name = drv_name, \
1082 .slave_configure = ata_scsi_slave_config, \
1083 .slave_destroy = ata_scsi_slave_destroy, \
1084 .bios_param = ata_std_bios_param
1086 #define ATA_NCQ_SHT(drv_name) \
1087 ATA_BASE_SHT(drv_name), \
1088 .change_queue_depth = ata_scsi_change_queue_depth
1093 #ifdef CONFIG_SATA_PMP
1094 static inline bool sata_pmp_supported(struct ata_port
*ap
)
1096 return ap
->flags
& ATA_FLAG_PMP
;
1099 static inline bool sata_pmp_attached(struct ata_port
*ap
)
1101 return ap
->nr_pmp_links
!= 0;
1104 static inline int ata_is_host_link(const struct ata_link
*link
)
1106 return link
== &link
->ap
->link
;
1108 #else /* CONFIG_SATA_PMP */
1109 static inline bool sata_pmp_supported(struct ata_port
*ap
)
1114 static inline bool sata_pmp_attached(struct ata_port
*ap
)
1119 static inline int ata_is_host_link(const struct ata_link
*link
)
1123 #endif /* CONFIG_SATA_PMP */
1125 static inline int sata_srst_pmp(struct ata_link
*link
)
1127 if (sata_pmp_supported(link
->ap
) && ata_is_host_link(link
))
1128 return SATA_PMP_CTRL_PORT
;
1135 #define ata_port_printk(ap, lv, fmt, args...) \
1136 printk("%sata%u: "fmt, lv, (ap)->print_id , ##args)
1138 #define ata_link_printk(link, lv, fmt, args...) do { \
1139 if (sata_pmp_attached((link)->ap)) \
1140 printk("%sata%u.%02u: "fmt, lv, (link)->ap->print_id, \
1141 (link)->pmp , ##args); \
1143 printk("%sata%u: "fmt, lv, (link)->ap->print_id , ##args); \
1146 #define ata_dev_printk(dev, lv, fmt, args...) \
1147 printk("%sata%u.%02u: "fmt, lv, (dev)->link->ap->print_id, \
1148 (dev)->link->pmp + (dev)->devno , ##args)
1151 * ata_eh_info helpers
1153 extern void __ata_ehi_push_desc(struct ata_eh_info
*ehi
, const char *fmt
, ...)
1154 __attribute__ ((format (printf
, 2, 3)));
1155 extern void ata_ehi_push_desc(struct ata_eh_info
*ehi
, const char *fmt
, ...)
1156 __attribute__ ((format (printf
, 2, 3)));
1157 extern void ata_ehi_clear_desc(struct ata_eh_info
*ehi
);
1159 static inline void ata_ehi_hotplugged(struct ata_eh_info
*ehi
)
1161 ehi
->probe_mask
|= (1 << ATA_MAX_DEVICES
) - 1;
1162 ehi
->flags
|= ATA_EHI_HOTPLUGGED
;
1163 ehi
->action
|= ATA_EH_RESET
| ATA_EH_ENABLE_LINK
;
1164 ehi
->err_mask
|= AC_ERR_ATA_BUS
;
1168 * port description helpers
1170 extern void ata_port_desc(struct ata_port
*ap
, const char *fmt
, ...)
1171 __attribute__ ((format (printf
, 2, 3)));
1173 extern void ata_port_pbar_desc(struct ata_port
*ap
, int bar
, ssize_t offset
,
1177 static inline unsigned int ata_tag_valid(unsigned int tag
)
1179 return (tag
< ATA_MAX_QUEUE
) ? 1 : 0;
1182 static inline unsigned int ata_tag_internal(unsigned int tag
)
1184 return tag
== ATA_TAG_INTERNAL
;
1190 static inline unsigned int ata_class_enabled(unsigned int class)
1192 return class == ATA_DEV_ATA
|| class == ATA_DEV_ATAPI
||
1193 class == ATA_DEV_PMP
|| class == ATA_DEV_SEMB
;
1196 static inline unsigned int ata_class_disabled(unsigned int class)
1198 return class == ATA_DEV_ATA_UNSUP
|| class == ATA_DEV_ATAPI_UNSUP
||
1199 class == ATA_DEV_PMP_UNSUP
|| class == ATA_DEV_SEMB_UNSUP
;
1202 static inline unsigned int ata_class_absent(unsigned int class)
1204 return !ata_class_enabled(class) && !ata_class_disabled(class);
1207 static inline unsigned int ata_dev_enabled(const struct ata_device
*dev
)
1209 return ata_class_enabled(dev
->class);
1212 static inline unsigned int ata_dev_disabled(const struct ata_device
*dev
)
1214 return ata_class_disabled(dev
->class);
1217 static inline unsigned int ata_dev_absent(const struct ata_device
*dev
)
1219 return ata_class_absent(dev
->class);
1225 static inline int ata_link_max_devices(const struct ata_link
*link
)
1227 if (ata_is_host_link(link
) && link
->ap
->flags
& ATA_FLAG_SLAVE_POSS
)
1232 static inline int ata_link_active(struct ata_link
*link
)
1234 return ata_tag_valid(link
->active_tag
) || link
->sactive
;
1237 static inline struct ata_link
*ata_port_first_link(struct ata_port
*ap
)
1239 if (sata_pmp_attached(ap
))
1240 return ap
->pmp_link
;
1244 static inline struct ata_link
*ata_port_next_link(struct ata_link
*link
)
1246 struct ata_port
*ap
= link
->ap
;
1248 if (ata_is_host_link(link
)) {
1249 if (!sata_pmp_attached(ap
))
1251 return ap
->pmp_link
;
1254 if (++link
< ap
->nr_pmp_links
+ ap
->pmp_link
)
1259 #define __ata_port_for_each_link(lk, ap) \
1260 for ((lk) = &(ap)->link; (lk); (lk) = ata_port_next_link(lk))
1262 #define ata_port_for_each_link(link, ap) \
1263 for ((link) = ata_port_first_link(ap); (link); \
1264 (link) = ata_port_next_link(link))
1266 #define ata_link_for_each_dev(dev, link) \
1267 for ((dev) = (link)->device; \
1268 (dev) < (link)->device + ata_link_max_devices(link) || ((dev) = NULL); \
1271 #define ata_link_for_each_dev_reverse(dev, link) \
1272 for ((dev) = (link)->device + ata_link_max_devices(link) - 1; \
1273 (dev) >= (link)->device || ((dev) = NULL); (dev)--)
1276 * ata_ncq_enabled - Test whether NCQ is enabled
1277 * @dev: ATA device to test for
1280 * spin_lock_irqsave(host lock)
1283 * 1 if NCQ is enabled for @dev, 0 otherwise.
1285 static inline int ata_ncq_enabled(struct ata_device
*dev
)
1287 return (dev
->flags
& (ATA_DFLAG_PIO
| ATA_DFLAG_NCQ_OFF
|
1288 ATA_DFLAG_NCQ
)) == ATA_DFLAG_NCQ
;
1291 static inline void ata_qc_set_polling(struct ata_queued_cmd
*qc
)
1293 qc
->tf
.ctl
|= ATA_NIEN
;
1296 static inline struct ata_queued_cmd
*__ata_qc_from_tag(struct ata_port
*ap
,
1299 if (likely(ata_tag_valid(tag
)))
1300 return &ap
->qcmd
[tag
];
1304 static inline struct ata_queued_cmd
*ata_qc_from_tag(struct ata_port
*ap
,
1307 struct ata_queued_cmd
*qc
= __ata_qc_from_tag(ap
, tag
);
1309 if (unlikely(!qc
) || !ap
->ops
->error_handler
)
1312 if ((qc
->flags
& (ATA_QCFLAG_ACTIVE
|
1313 ATA_QCFLAG_FAILED
)) == ATA_QCFLAG_ACTIVE
)
1319 static inline unsigned int ata_qc_raw_nbytes(struct ata_queued_cmd
*qc
)
1321 return qc
->nbytes
- min(qc
->extrabytes
, qc
->nbytes
);
1324 static inline void ata_tf_init(struct ata_device
*dev
, struct ata_taskfile
*tf
)
1326 memset(tf
, 0, sizeof(*tf
));
1328 tf
->ctl
= dev
->link
->ap
->ctl
;
1329 if (dev
->devno
== 0)
1330 tf
->device
= ATA_DEVICE_OBS
;
1332 tf
->device
= ATA_DEVICE_OBS
| ATA_DEV1
;
1335 static inline void ata_qc_reinit(struct ata_queued_cmd
*qc
)
1337 qc
->dma_dir
= DMA_NONE
;
1342 qc
->nbytes
= qc
->extrabytes
= qc
->curbytes
= 0;
1345 qc
->sect_size
= ATA_SECT_SIZE
;
1347 ata_tf_init(qc
->dev
, &qc
->tf
);
1349 /* init result_tf such that it indicates normal completion */
1350 qc
->result_tf
.command
= ATA_DRDY
;
1351 qc
->result_tf
.feature
= 0;
1354 static inline int ata_try_flush_cache(const struct ata_device
*dev
)
1356 return ata_id_wcache_enabled(dev
->id
) ||
1357 ata_id_has_flush(dev
->id
) ||
1358 ata_id_has_flush_ext(dev
->id
);
1361 static inline unsigned int ac_err_mask(u8 status
)
1363 if (status
& (ATA_BUSY
| ATA_DRQ
))
1365 if (status
& (ATA_ERR
| ATA_DF
))
1370 static inline unsigned int __ac_err_mask(u8 status
)
1372 unsigned int mask
= ac_err_mask(status
);
1374 return AC_ERR_OTHER
;
1378 static inline struct ata_port
*ata_shost_to_port(struct Scsi_Host
*host
)
1380 return *(struct ata_port
**)&host
->hostdata
[0];
1383 static inline int ata_check_ready(u8 status
)
1385 if (!(status
& ATA_BUSY
))
1388 /* 0xff indicates either no device or device not ready */
1396 /**************************************************************************
1397 * PMP - drivers/ata/libata-pmp.c
1399 #ifdef CONFIG_SATA_PMP
1401 extern const struct ata_port_operations sata_pmp_port_ops
;
1403 extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd
*qc
);
1404 extern void sata_pmp_error_handler(struct ata_port
*ap
);
1406 #else /* CONFIG_SATA_PMP */
1408 #define sata_pmp_port_ops sata_port_ops
1409 #define sata_pmp_qc_defer_cmd_switch ata_std_qc_defer
1410 #define sata_pmp_error_handler ata_std_error_handler
1412 #endif /* CONFIG_SATA_PMP */
1415 /**************************************************************************
1416 * SFF - drivers/ata/libata-sff.c
1418 #ifdef CONFIG_ATA_SFF
1420 extern const struct ata_port_operations ata_sff_port_ops
;
1421 extern const struct ata_port_operations ata_bmdma_port_ops
;
1423 /* PIO only, sg_tablesize and dma_boundary limits can be removed */
1424 #define ATA_PIO_SHT(drv_name) \
1425 ATA_BASE_SHT(drv_name), \
1426 .sg_tablesize = LIBATA_MAX_PRD, \
1427 .dma_boundary = ATA_DMA_BOUNDARY
1429 #define ATA_BMDMA_SHT(drv_name) \
1430 ATA_BASE_SHT(drv_name), \
1431 .sg_tablesize = LIBATA_MAX_PRD, \
1432 .dma_boundary = ATA_DMA_BOUNDARY
1434 extern void ata_sff_qc_prep(struct ata_queued_cmd
*qc
);
1435 extern void ata_sff_dumb_qc_prep(struct ata_queued_cmd
*qc
);
1436 extern void ata_sff_dev_select(struct ata_port
*ap
, unsigned int device
);
1437 extern u8
ata_sff_check_status(struct ata_port
*ap
);
1438 extern u8
ata_sff_altstatus(struct ata_port
*ap
);
1439 extern int ata_sff_busy_sleep(struct ata_port
*ap
,
1440 unsigned long timeout_pat
, unsigned long timeout
);
1441 extern int ata_sff_wait_ready(struct ata_link
*link
, unsigned long deadline
);
1442 extern void ata_sff_tf_load(struct ata_port
*ap
, const struct ata_taskfile
*tf
);
1443 extern void ata_sff_tf_read(struct ata_port
*ap
, struct ata_taskfile
*tf
);
1444 extern void ata_sff_exec_command(struct ata_port
*ap
,
1445 const struct ata_taskfile
*tf
);
1446 extern unsigned int ata_sff_data_xfer(struct ata_device
*dev
,
1447 unsigned char *buf
, unsigned int buflen
, int rw
);
1448 extern unsigned int ata_sff_data_xfer_noirq(struct ata_device
*dev
,
1449 unsigned char *buf
, unsigned int buflen
, int rw
);
1450 extern u8
ata_sff_irq_on(struct ata_port
*ap
);
1451 extern void ata_sff_irq_clear(struct ata_port
*ap
);
1452 extern int ata_sff_hsm_move(struct ata_port
*ap
, struct ata_queued_cmd
*qc
,
1453 u8 status
, int in_wq
);
1454 extern unsigned int ata_sff_qc_issue(struct ata_queued_cmd
*qc
);
1455 extern bool ata_sff_qc_fill_rtf(struct ata_queued_cmd
*qc
);
1456 extern unsigned int ata_sff_host_intr(struct ata_port
*ap
,
1457 struct ata_queued_cmd
*qc
);
1458 extern irqreturn_t
ata_sff_interrupt(int irq
, void *dev_instance
);
1459 extern void ata_sff_freeze(struct ata_port
*ap
);
1460 extern void ata_sff_thaw(struct ata_port
*ap
);
1461 extern int ata_sff_prereset(struct ata_link
*link
, unsigned long deadline
);
1462 extern unsigned int ata_sff_dev_classify(struct ata_device
*dev
, int present
,
1464 extern int ata_sff_wait_after_reset(struct ata_link
*link
, unsigned int devmask
,
1465 unsigned long deadline
);
1466 extern int ata_sff_softreset(struct ata_link
*link
, unsigned int *classes
,
1467 unsigned long deadline
);
1468 extern int sata_sff_hardreset(struct ata_link
*link
, unsigned int *class,
1469 unsigned long deadline
);
1470 extern void ata_sff_postreset(struct ata_link
*link
, unsigned int *classes
);
1471 extern void ata_sff_error_handler(struct ata_port
*ap
);
1472 extern void ata_sff_post_internal_cmd(struct ata_queued_cmd
*qc
);
1473 extern int ata_sff_port_start(struct ata_port
*ap
);
1474 extern void ata_sff_std_ports(struct ata_ioports
*ioaddr
);
1475 extern unsigned long ata_bmdma_mode_filter(struct ata_device
*dev
,
1476 unsigned long xfer_mask
);
1477 extern void ata_bmdma_setup(struct ata_queued_cmd
*qc
);
1478 extern void ata_bmdma_start(struct ata_queued_cmd
*qc
);
1479 extern void ata_bmdma_stop(struct ata_queued_cmd
*qc
);
1480 extern u8
ata_bmdma_status(struct ata_port
*ap
);
1481 extern void ata_bus_reset(struct ata_port
*ap
);
1484 extern int ata_pci_bmdma_clear_simplex(struct pci_dev
*pdev
);
1485 extern int ata_pci_bmdma_init(struct ata_host
*host
);
1486 extern int ata_pci_sff_init_host(struct ata_host
*host
);
1487 extern int ata_pci_sff_prepare_host(struct pci_dev
*pdev
,
1488 const struct ata_port_info
* const * ppi
,
1489 struct ata_host
**r_host
);
1490 extern int ata_pci_sff_activate_host(struct ata_host
*host
,
1491 irq_handler_t irq_handler
,
1492 struct scsi_host_template
*sht
);
1493 extern int ata_pci_sff_init_one(struct pci_dev
*pdev
,
1494 const struct ata_port_info
* const * ppi
,
1495 struct scsi_host_template
*sht
, void *host_priv
);
1496 #endif /* CONFIG_PCI */
1499 * ata_sff_pause - Flush writes and pause 400 nanoseconds.
1500 * @ap: Port to wait for.
1503 * Inherited from caller.
1505 static inline void ata_sff_pause(struct ata_port
*ap
)
1507 ata_sff_altstatus(ap
);
1512 * ata_sff_busy_wait - Wait for a port status register
1513 * @ap: Port to wait for.
1514 * @bits: bits that must be clear
1515 * @max: number of 10uS waits to perform
1517 * Waits up to max*10 microseconds for the selected bits in the port's
1518 * status register to be cleared.
1519 * Returns final value of status register.
1522 * Inherited from caller.
1524 static inline u8
ata_sff_busy_wait(struct ata_port
*ap
, unsigned int bits
,
1531 status
= ap
->ops
->sff_check_status(ap
);
1533 } while (status
!= 0xff && (status
& bits
) && (max
> 0));
1539 * ata_wait_idle - Wait for a port to be idle.
1540 * @ap: Port to wait for.
1542 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
1543 * Returns final value of status register.
1546 * Inherited from caller.
1548 static inline u8
ata_wait_idle(struct ata_port
*ap
)
1550 u8 status
= ata_sff_busy_wait(ap
, ATA_BUSY
| ATA_DRQ
, 1000);
1553 if (status
!= 0xff && (status
& (ATA_BUSY
| ATA_DRQ
)))
1554 ata_port_printk(ap
, KERN_DEBUG
, "abnormal Status 0x%X\n",
1560 #endif /* CONFIG_ATA_SFF */
1562 #endif /* __LINUX_LIBATA_H__ */