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/pci.h>
32 #include <linux/dma-mapping.h>
33 #include <asm/scatterlist.h>
35 #include <linux/ata.h>
36 #include <linux/workqueue.h>
37 #include <scsi/scsi_host.h>
40 * compile-time options: to be removed as soon as all the drivers are
41 * converted to the new debugging mechanism
43 #undef ATA_DEBUG /* debugging output */
44 #undef ATA_VERBOSE_DEBUG /* yet more debugging output */
45 #undef ATA_IRQ_TRAP /* define to ack screaming irqs */
46 #undef ATA_NDEBUG /* define to disable quick runtime checks */
47 #undef ATA_ENABLE_PATA /* define to enable PATA support in some
48 * low-level drivers */
51 /* note: prints function name for you */
53 #define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
54 #ifdef ATA_VERBOSE_DEBUG
55 #define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
57 #define VPRINTK(fmt, args...)
58 #endif /* ATA_VERBOSE_DEBUG */
60 #define DPRINTK(fmt, args...)
61 #define VPRINTK(fmt, args...)
62 #endif /* ATA_DEBUG */
64 #define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
66 /* NEW: debug levels */
67 #define HAVE_LIBATA_MSG 1
71 ATA_MSG_INFO
= 0x0002,
72 ATA_MSG_PROBE
= 0x0004,
73 ATA_MSG_WARN
= 0x0008,
74 ATA_MSG_MALLOC
= 0x0010,
76 ATA_MSG_INTR
= 0x0040,
80 #define ata_msg_drv(p) ((p)->msg_enable & ATA_MSG_DRV)
81 #define ata_msg_info(p) ((p)->msg_enable & ATA_MSG_INFO)
82 #define ata_msg_probe(p) ((p)->msg_enable & ATA_MSG_PROBE)
83 #define ata_msg_warn(p) ((p)->msg_enable & ATA_MSG_WARN)
84 #define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC)
85 #define ata_msg_ctl(p) ((p)->msg_enable & ATA_MSG_CTL)
86 #define ata_msg_intr(p) ((p)->msg_enable & ATA_MSG_INTR)
87 #define ata_msg_err(p) ((p)->msg_enable & ATA_MSG_ERR)
89 static inline u32
ata_msg_init(int dval
, int default_msg_enable_bits
)
91 if (dval
< 0 || dval
>= (sizeof(u32
) * 8))
92 return default_msg_enable_bits
; /* should be 0x1 - only driver info msgs */
95 return (1 << dval
) - 1;
98 /* defines only for the constants which don't work well as enums */
99 #define ATA_TAG_POISON 0xfafbfcfdU
101 /* move to PCI layer? */
102 static inline struct device
*pci_dev_to_dev(struct pci_dev
*pdev
)
108 /* various global constants */
109 LIBATA_MAX_PRD
= ATA_MAX_PRD
/ 2,
112 /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
114 ATA_TAG_INTERNAL
= ATA_MAX_QUEUE
- 1,
115 ATA_MAX_SECTORS
= 200, /* FIXME */
116 ATA_MAX_SECTORS_LBA48
= 65535,
118 ATA_DEF_BUSY_WAIT
= 10000,
119 ATA_SHORT_PAUSE
= (HZ
>> 6) + 1,
121 ATA_SHT_EMULATED
= 1,
122 ATA_SHT_CMD_PER_LUN
= 1,
123 ATA_SHT_THIS_ID
= -1,
124 ATA_SHT_USE_CLUSTERING
= 1,
126 /* struct ata_device stuff */
127 ATA_DFLAG_LBA
= (1 << 0), /* device supports LBA */
128 ATA_DFLAG_LBA48
= (1 << 1), /* device supports LBA48 */
129 ATA_DFLAG_CDB_INTR
= (1 << 2), /* device asserts INTRQ when ready for CDB */
130 ATA_DFLAG_NCQ
= (1 << 3), /* device supports NCQ */
131 ATA_DFLAG_CFG_MASK
= (1 << 8) - 1,
133 ATA_DFLAG_PIO
= (1 << 8), /* device currently in PIO mode */
134 ATA_DFLAG_INIT_MASK
= (1 << 16) - 1,
136 ATA_DFLAG_DETACH
= (1 << 16),
137 ATA_DFLAG_DETACHED
= (1 << 17),
139 ATA_DEV_UNKNOWN
= 0, /* unknown device */
140 ATA_DEV_ATA
= 1, /* ATA device */
141 ATA_DEV_ATA_UNSUP
= 2, /* ATA device (unsupported) */
142 ATA_DEV_ATAPI
= 3, /* ATAPI device */
143 ATA_DEV_ATAPI_UNSUP
= 4, /* ATAPI device (unsupported) */
144 ATA_DEV_NONE
= 5, /* no device */
146 /* struct ata_port flags */
147 ATA_FLAG_SLAVE_POSS
= (1 << 0), /* host supports slave dev */
148 /* (doesn't imply presence) */
149 ATA_FLAG_SATA
= (1 << 1),
150 ATA_FLAG_NO_LEGACY
= (1 << 2), /* no legacy mode check */
151 ATA_FLAG_MMIO
= (1 << 3), /* use MMIO, not PIO */
152 ATA_FLAG_SRST
= (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */
153 ATA_FLAG_SATA_RESET
= (1 << 5), /* (obsolete) use COMRESET */
154 ATA_FLAG_NO_ATAPI
= (1 << 6), /* No ATAPI support */
155 ATA_FLAG_PIO_DMA
= (1 << 7), /* PIO cmds via DMA */
156 ATA_FLAG_PIO_LBA48
= (1 << 8), /* Host DMA engine is LBA28 only */
157 ATA_FLAG_PIO_POLLING
= (1 << 9), /* use polling PIO if LLD
158 * doesn't handle PIO interrupts */
159 ATA_FLAG_NCQ
= (1 << 10), /* host supports NCQ */
160 ATA_FLAG_HRST_TO_RESUME
= (1 << 11), /* hardreset to resume phy */
161 ATA_FLAG_SKIP_D2H_BSY
= (1 << 12), /* can't wait for the first D2H
162 * Register FIS clearing BSY */
163 ATA_FLAG_DEBUGMSG
= (1 << 13),
165 /* The following flag belongs to ap->pflags but is kept in
166 * ap->flags because it's referenced in many LLDs and will be
167 * removed in not-too-distant future.
169 ATA_FLAG_DISABLED
= (1 << 23), /* port is disabled, ignore it */
171 /* bits 24:31 of ap->flags are reserved for LLD specific flags */
173 /* struct ata_port pflags */
174 ATA_PFLAG_EH_PENDING
= (1 << 0), /* EH pending */
175 ATA_PFLAG_EH_IN_PROGRESS
= (1 << 1), /* EH in progress */
176 ATA_PFLAG_FROZEN
= (1 << 2), /* port is frozen */
177 ATA_PFLAG_RECOVERED
= (1 << 3), /* recovery action performed */
178 ATA_PFLAG_LOADING
= (1 << 4), /* boot/loading probe */
179 ATA_PFLAG_UNLOADING
= (1 << 5), /* module is unloading */
180 ATA_PFLAG_SCSI_HOTPLUG
= (1 << 6), /* SCSI hotplug scheduled */
182 ATA_PFLAG_FLUSH_PORT_TASK
= (1 << 16), /* flush port task */
183 ATA_PFLAG_SUSPENDED
= (1 << 17), /* port is suspended (power) */
185 /* struct ata_queued_cmd flags */
186 ATA_QCFLAG_ACTIVE
= (1 << 0), /* cmd not yet ack'd to scsi lyer */
187 ATA_QCFLAG_SG
= (1 << 1), /* have s/g table? */
188 ATA_QCFLAG_SINGLE
= (1 << 2), /* no s/g, just a single buffer */
189 ATA_QCFLAG_DMAMAP
= ATA_QCFLAG_SG
| ATA_QCFLAG_SINGLE
,
190 ATA_QCFLAG_IO
= (1 << 3), /* standard IO command */
191 ATA_QCFLAG_RESULT_TF
= (1 << 4), /* result TF requested */
193 ATA_QCFLAG_FAILED
= (1 << 16), /* cmd failed and is owned by EH */
194 ATA_QCFLAG_SENSE_VALID
= (1 << 17), /* sense data valid */
195 ATA_QCFLAG_EH_SCHEDULED
= (1 << 18), /* EH scheduled (obsolete) */
198 ATA_HOST_SIMPLEX
= (1 << 0), /* Host is simplex, one DMA channel per host_set only */
200 /* various lengths of time */
201 ATA_TMOUT_BOOT
= 30 * HZ
, /* heuristic */
202 ATA_TMOUT_BOOT_QUICK
= 7 * HZ
, /* heuristic */
203 ATA_TMOUT_INTERNAL
= 30 * HZ
,
204 ATA_TMOUT_INTERNAL_QUICK
= 5 * HZ
,
218 /* SATA port states */
223 /* encoding various smaller bitmaps into a single
224 * unsigned int bitmap
231 ATA_SHIFT_MWDMA
= ATA_SHIFT_PIO
+ ATA_BITS_PIO
,
232 ATA_SHIFT_UDMA
= ATA_SHIFT_MWDMA
+ ATA_BITS_MWDMA
,
234 ATA_MASK_PIO
= ((1 << ATA_BITS_PIO
) - 1) << ATA_SHIFT_PIO
,
235 ATA_MASK_MWDMA
= ((1 << ATA_BITS_MWDMA
) - 1) << ATA_SHIFT_MWDMA
,
236 ATA_MASK_UDMA
= ((1 << ATA_BITS_UDMA
) - 1) << ATA_SHIFT_UDMA
,
238 /* size of buffer to pad xfers ending on unaligned boundaries */
240 ATA_DMA_PAD_BUF_SZ
= ATA_DMA_PAD_SZ
* ATA_MAX_QUEUE
,
242 /* masks for port functions */
243 ATA_PORT_PRIMARY
= (1 << 0),
244 ATA_PORT_SECONDARY
= (1 << 1),
249 /* desc_len for ata_eh_info and context */
250 ATA_EH_DESC_LEN
= 80,
252 /* reset / recovery action types */
253 ATA_EH_REVALIDATE
= (1 << 0),
254 ATA_EH_SOFTRESET
= (1 << 1),
255 ATA_EH_HARDRESET
= (1 << 2),
257 ATA_EH_RESET_MASK
= ATA_EH_SOFTRESET
| ATA_EH_HARDRESET
,
258 ATA_EH_PERDEV_MASK
= ATA_EH_REVALIDATE
,
260 /* ata_eh_info->flags */
261 ATA_EHI_HOTPLUGGED
= (1 << 0), /* could have been hotplugged */
262 ATA_EHI_RESUME_LINK
= (1 << 1), /* need to resume link */
264 ATA_EHI_DID_RESET
= (1 << 16), /* already reset this port */
266 /* max repeat if error condition is still set after ->error_handler */
267 ATA_EH_MAX_REPEAT
= 5,
269 /* how hard are we gonna try to probe/recover devices */
270 ATA_PROBE_MAX_TRIES
= 3,
271 ATA_EH_RESET_TRIES
= 3,
272 ATA_EH_DEV_TRIES
= 3,
274 /* Drive spinup time (time from power-on to the first D2H FIS)
275 * in msecs - 8s currently. Failing to get ready in this time
276 * isn't critical. It will result in reset failure for
277 * controllers which can't wait for the first D2H FIS. libata
278 * will retry, so it just has to be long enough to spin up
281 ATA_SPINUP_WAIT
= 8000,
284 enum hsm_task_states
{
285 HSM_ST_UNKNOWN
, /* state unknown */
286 HSM_ST_IDLE
, /* no command on going */
287 HSM_ST
, /* (waiting the device to) transfer data */
288 HSM_ST_LAST
, /* (waiting the device to) complete command */
289 HSM_ST_ERR
, /* error */
290 HSM_ST_FIRST
, /* (waiting the device to)
291 write CDB or first data block */
294 enum ata_completion_errors
{
295 AC_ERR_DEV
= (1 << 0), /* device reported error */
296 AC_ERR_HSM
= (1 << 1), /* host state machine violation */
297 AC_ERR_TIMEOUT
= (1 << 2), /* timeout */
298 AC_ERR_MEDIA
= (1 << 3), /* media error */
299 AC_ERR_ATA_BUS
= (1 << 4), /* ATA bus error */
300 AC_ERR_HOST_BUS
= (1 << 5), /* host bus error */
301 AC_ERR_SYSTEM
= (1 << 6), /* system error */
302 AC_ERR_INVALID
= (1 << 7), /* invalid argument */
303 AC_ERR_OTHER
= (1 << 8), /* unknown */
306 /* forward declarations */
308 struct ata_port_operations
;
310 struct ata_queued_cmd
;
313 typedef void (*ata_qc_cb_t
) (struct ata_queued_cmd
*qc
);
314 typedef int (*ata_prereset_fn_t
)(struct ata_port
*ap
);
315 typedef int (*ata_reset_fn_t
)(struct ata_port
*ap
, unsigned int *classes
);
316 typedef void (*ata_postreset_fn_t
)(struct ata_port
*ap
, unsigned int *classes
);
319 unsigned long cmd_addr
;
320 unsigned long data_addr
;
321 unsigned long error_addr
;
322 unsigned long feature_addr
;
323 unsigned long nsect_addr
;
324 unsigned long lbal_addr
;
325 unsigned long lbam_addr
;
326 unsigned long lbah_addr
;
327 unsigned long device_addr
;
328 unsigned long status_addr
;
329 unsigned long command_addr
;
330 unsigned long altstatus_addr
;
331 unsigned long ctl_addr
;
332 unsigned long bmdma_addr
;
333 unsigned long scr_addr
;
336 struct ata_probe_ent
{
337 struct list_head node
;
339 const struct ata_port_operations
*port_ops
;
340 struct scsi_host_template
*sht
;
341 struct ata_ioports port
[ATA_MAX_PORTS
];
342 unsigned int n_ports
;
343 unsigned int hard_port_no
;
344 unsigned int pio_mask
;
345 unsigned int mwdma_mask
;
346 unsigned int udma_mask
;
347 unsigned int legacy_mode
;
349 unsigned int irq_flags
;
350 unsigned long host_flags
;
351 unsigned long host_set_flags
;
352 void __iomem
*mmio_base
;
356 struct ata_host_set
{
360 void __iomem
*mmio_base
;
361 unsigned int n_ports
;
363 const struct ata_port_operations
*ops
;
365 int simplex_claimed
; /* Keep seperate in case we
366 ever need to do this locked */
367 struct ata_host_set
*next
; /* for legacy mode */
368 struct ata_port
*ports
[0];
371 struct ata_queued_cmd
{
373 struct ata_device
*dev
;
375 struct scsi_cmnd
*scsicmd
;
376 void (*scsidone
)(struct scsi_cmnd
*);
378 struct ata_taskfile tf
;
379 u8 cdb
[ATAPI_CDB_LEN
];
381 unsigned long flags
; /* ATA_QCFLAG_xxx */
384 unsigned int orig_n_elem
;
388 unsigned int pad_len
;
391 unsigned int cursect
;
394 unsigned int curbytes
;
397 unsigned int cursg_ofs
;
399 struct scatterlist sgent
;
400 struct scatterlist pad_sgent
;
403 /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
404 struct scatterlist
*__sg
;
406 unsigned int err_mask
;
407 struct ata_taskfile result_tf
;
408 ata_qc_cb_t complete_fn
;
413 struct ata_host_stats
{
414 unsigned long unhandled_irq
;
415 unsigned long idle_irq
;
416 unsigned long rw_reqbuf
;
419 struct ata_ering_entry
{
421 unsigned int err_mask
;
427 struct ata_ering_entry ring
[ATA_ERING_SIZE
];
432 unsigned int devno
; /* 0 or 1 */
433 unsigned long flags
; /* ATA_DFLAG_xxx */
434 struct scsi_device
*sdev
; /* attached SCSI device */
435 /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */
436 u64 n_sectors
; /* size of device, if ATA */
437 unsigned int class; /* ATA_DEV_xxx */
438 u16 id
[ATA_ID_WORDS
]; /* IDENTIFY xxx DEVICE data */
442 unsigned int xfer_shift
; /* ATA_SHIFT_xxx */
444 unsigned int multi_count
; /* sectors count for
445 READ/WRITE MULTIPLE */
446 unsigned int max_sectors
; /* per-device max sectors */
447 unsigned int cdb_len
;
449 /* per-dev xfer mask */
450 unsigned int pio_mask
;
451 unsigned int mwdma_mask
;
452 unsigned int udma_mask
;
454 /* for CHS addressing */
455 u16 cylinders
; /* Number of cylinders */
456 u16 heads
; /* Number of heads */
457 u16 sectors
; /* Number of sectors per track */
460 struct ata_ering ering
;
463 /* Offset into struct ata_device. Fields above it are maintained
464 * acress device init. Fields below are zeroed.
466 #define ATA_DEVICE_CLEAR_OFFSET offsetof(struct ata_device, n_sectors)
469 struct ata_device
*dev
; /* offending device */
470 u32 serror
; /* SError from LLDD */
471 unsigned int err_mask
; /* port-wide err_mask */
472 unsigned int action
; /* ATA_EH_* action mask */
473 unsigned int dev_action
[ATA_MAX_DEVICES
]; /* dev EH action */
474 unsigned int flags
; /* ATA_EHI_* flags */
476 unsigned long hotplug_timestamp
;
477 unsigned int probe_mask
;
479 char desc
[ATA_EH_DESC_LEN
];
483 struct ata_eh_context
{
484 struct ata_eh_info i
;
485 int tries
[ATA_MAX_DEVICES
];
486 unsigned int classes
[ATA_MAX_DEVICES
];
487 unsigned int did_probe_mask
;
491 struct Scsi_Host
*host
; /* our co-allocated scsi host */
492 const struct ata_port_operations
*ops
;
494 unsigned long flags
; /* ATA_FLAG_xxx */
495 unsigned int pflags
; /* ATA_PFLAG_xxx */
496 unsigned int id
; /* unique id req'd by scsi midlyr */
497 unsigned int port_no
; /* unique port #; from zero */
498 unsigned int hard_port_no
; /* hardware port #; from zero */
500 struct ata_prd
*prd
; /* our SG list */
501 dma_addr_t prd_dma
; /* and its DMA mapping */
503 void *pad
; /* array of DMA pad buffers */
506 struct ata_ioports ioaddr
; /* ATA cmd/ctl/dma register blocks */
508 u8 ctl
; /* cache of ATA control register */
509 u8 last_ctl
; /* Cache last written value */
510 unsigned int pio_mask
;
511 unsigned int mwdma_mask
;
512 unsigned int udma_mask
;
513 unsigned int cbl
; /* cable type; ATA_CBL_xxx */
514 unsigned int hw_sata_spd_limit
;
515 unsigned int sata_spd_limit
; /* SATA PHY speed limit */
517 /* record runtime error info, protected by host_set lock */
518 struct ata_eh_info eh_info
;
519 /* EH context owned by EH */
520 struct ata_eh_context eh_context
;
522 struct ata_device device
[ATA_MAX_DEVICES
];
524 struct ata_queued_cmd qcmd
[ATA_MAX_QUEUE
];
525 unsigned long qc_allocated
;
526 unsigned int qc_active
;
528 unsigned int active_tag
;
531 struct ata_host_stats stats
;
532 struct ata_host_set
*host_set
;
535 struct work_struct port_task
;
536 struct work_struct hotplug_task
;
537 struct work_struct scsi_rescan_task
;
539 unsigned int hsm_task_state
;
542 struct list_head eh_done_q
;
543 wait_queue_head_t eh_wait_q
;
547 u8 sector_buf
[ATA_SECT_SIZE
]; /* owned by EH */
550 struct ata_port_operations
{
551 void (*port_disable
) (struct ata_port
*);
553 void (*dev_config
) (struct ata_port
*, struct ata_device
*);
555 void (*set_piomode
) (struct ata_port
*, struct ata_device
*);
556 void (*set_dmamode
) (struct ata_port
*, struct ata_device
*);
557 unsigned long (*mode_filter
) (const struct ata_port
*, struct ata_device
*, unsigned long);
559 void (*tf_load
) (struct ata_port
*ap
, const struct ata_taskfile
*tf
);
560 void (*tf_read
) (struct ata_port
*ap
, struct ata_taskfile
*tf
);
562 void (*exec_command
)(struct ata_port
*ap
, const struct ata_taskfile
*tf
);
563 u8 (*check_status
)(struct ata_port
*ap
);
564 u8 (*check_altstatus
)(struct ata_port
*ap
);
565 void (*dev_select
)(struct ata_port
*ap
, unsigned int device
);
567 void (*phy_reset
) (struct ata_port
*ap
); /* obsolete */
568 void (*set_mode
) (struct ata_port
*ap
);
570 void (*post_set_mode
) (struct ata_port
*ap
);
572 int (*check_atapi_dma
) (struct ata_queued_cmd
*qc
);
574 void (*bmdma_setup
) (struct ata_queued_cmd
*qc
);
575 void (*bmdma_start
) (struct ata_queued_cmd
*qc
);
577 void (*data_xfer
) (struct ata_device
*, unsigned char *, unsigned int, int);
579 void (*qc_prep
) (struct ata_queued_cmd
*qc
);
580 unsigned int (*qc_issue
) (struct ata_queued_cmd
*qc
);
582 /* Error handlers. ->error_handler overrides ->eng_timeout and
583 * indicates that new-style EH is in place.
585 void (*eng_timeout
) (struct ata_port
*ap
); /* obsolete */
587 void (*freeze
) (struct ata_port
*ap
);
588 void (*thaw
) (struct ata_port
*ap
);
589 void (*error_handler
) (struct ata_port
*ap
);
590 void (*post_internal_cmd
) (struct ata_queued_cmd
*qc
);
592 irqreturn_t (*irq_handler
)(int, void *, struct pt_regs
*);
593 void (*irq_clear
) (struct ata_port
*);
595 u32 (*scr_read
) (struct ata_port
*ap
, unsigned int sc_reg
);
596 void (*scr_write
) (struct ata_port
*ap
, unsigned int sc_reg
,
599 int (*port_start
) (struct ata_port
*ap
);
600 void (*port_stop
) (struct ata_port
*ap
);
602 void (*host_stop
) (struct ata_host_set
*host_set
);
604 void (*bmdma_stop
) (struct ata_queued_cmd
*qc
);
605 u8 (*bmdma_status
) (struct ata_port
*ap
);
608 struct ata_port_info
{
609 struct scsi_host_template
*sht
;
610 unsigned long host_flags
;
611 unsigned long pio_mask
;
612 unsigned long mwdma_mask
;
613 unsigned long udma_mask
;
614 const struct ata_port_operations
*port_ops
;
619 unsigned short mode
; /* ATA mode */
620 unsigned short setup
; /* t1 */
621 unsigned short act8b
; /* t2 for 8-bit I/O */
622 unsigned short rec8b
; /* t2i for 8-bit I/O */
623 unsigned short cyc8b
; /* t0 for 8-bit I/O */
624 unsigned short active
; /* t2 or tD */
625 unsigned short recover
; /* t2i or tK */
626 unsigned short cycle
; /* t0 */
627 unsigned short udma
; /* t2CYCTYP/2 */
630 #define FIT(v,vmin,vmax) max_t(short,min_t(short,v,vmax),vmin)
632 extern const unsigned long sata_deb_timing_boot
[];
633 extern const unsigned long sata_deb_timing_eh
[];
634 extern const unsigned long sata_deb_timing_before_fsrst
[];
636 extern void ata_port_probe(struct ata_port
*);
637 extern void __sata_phy_reset(struct ata_port
*ap
);
638 extern void sata_phy_reset(struct ata_port
*ap
);
639 extern void ata_bus_reset(struct ata_port
*ap
);
640 extern int sata_set_spd(struct ata_port
*ap
);
641 extern int sata_phy_debounce(struct ata_port
*ap
, const unsigned long *param
);
642 extern int sata_phy_resume(struct ata_port
*ap
, const unsigned long *param
);
643 extern int ata_std_prereset(struct ata_port
*ap
);
644 extern int ata_std_softreset(struct ata_port
*ap
, unsigned int *classes
);
645 extern int sata_std_hardreset(struct ata_port
*ap
, unsigned int *class);
646 extern void ata_std_postreset(struct ata_port
*ap
, unsigned int *classes
);
647 extern int ata_dev_revalidate(struct ata_device
*dev
, int post_reset
);
648 extern void ata_port_disable(struct ata_port
*);
649 extern void ata_std_ports(struct ata_ioports
*ioaddr
);
651 extern int ata_pci_init_one (struct pci_dev
*pdev
, struct ata_port_info
**port_info
,
652 unsigned int n_ports
);
653 extern void ata_pci_remove_one (struct pci_dev
*pdev
);
654 extern int ata_pci_device_suspend(struct pci_dev
*pdev
, pm_message_t state
);
655 extern int ata_pci_device_resume(struct pci_dev
*pdev
);
656 extern int ata_pci_clear_simplex(struct pci_dev
*pdev
);
657 #endif /* CONFIG_PCI */
658 extern int ata_device_add(const struct ata_probe_ent
*ent
);
659 extern void ata_port_detach(struct ata_port
*ap
);
660 extern void ata_host_set_remove(struct ata_host_set
*host_set
);
661 extern int ata_scsi_detect(struct scsi_host_template
*sht
);
662 extern int ata_scsi_ioctl(struct scsi_device
*dev
, int cmd
, void __user
*arg
);
663 extern int ata_scsi_queuecmd(struct scsi_cmnd
*cmd
, void (*done
)(struct scsi_cmnd
*));
664 extern int ata_scsi_release(struct Scsi_Host
*host
);
665 extern unsigned int ata_host_intr(struct ata_port
*ap
, struct ata_queued_cmd
*qc
);
666 extern int sata_scr_valid(struct ata_port
*ap
);
667 extern int sata_scr_read(struct ata_port
*ap
, int reg
, u32
*val
);
668 extern int sata_scr_write(struct ata_port
*ap
, int reg
, u32 val
);
669 extern int sata_scr_write_flush(struct ata_port
*ap
, int reg
, u32 val
);
670 extern int ata_port_online(struct ata_port
*ap
);
671 extern int ata_port_offline(struct ata_port
*ap
);
672 extern int ata_scsi_device_resume(struct scsi_device
*);
673 extern int ata_scsi_device_suspend(struct scsi_device
*, pm_message_t state
);
674 extern int ata_device_resume(struct ata_device
*);
675 extern int ata_device_suspend(struct ata_device
*, pm_message_t state
);
676 extern int ata_ratelimit(void);
677 extern unsigned int ata_busy_sleep(struct ata_port
*ap
,
678 unsigned long timeout_pat
,
679 unsigned long timeout
);
680 extern void ata_port_queue_task(struct ata_port
*ap
, void (*fn
)(void *),
681 void *data
, unsigned long delay
);
682 extern u32
ata_wait_register(void __iomem
*reg
, u32 mask
, u32 val
,
683 unsigned long interval_msec
,
684 unsigned long timeout_msec
);
687 * Default driver ops implementations
689 extern void ata_tf_load(struct ata_port
*ap
, const struct ata_taskfile
*tf
);
690 extern void ata_tf_read(struct ata_port
*ap
, struct ata_taskfile
*tf
);
691 extern void ata_tf_to_fis(const struct ata_taskfile
*tf
, u8
*fis
, u8 pmp
);
692 extern void ata_tf_from_fis(const u8
*fis
, struct ata_taskfile
*tf
);
693 extern void ata_noop_dev_select (struct ata_port
*ap
, unsigned int device
);
694 extern void ata_std_dev_select (struct ata_port
*ap
, unsigned int device
);
695 extern u8
ata_check_status(struct ata_port
*ap
);
696 extern u8
ata_altstatus(struct ata_port
*ap
);
697 extern void ata_exec_command(struct ata_port
*ap
, const struct ata_taskfile
*tf
);
698 extern int ata_port_start (struct ata_port
*ap
);
699 extern void ata_port_stop (struct ata_port
*ap
);
700 extern void ata_host_stop (struct ata_host_set
*host_set
);
701 extern irqreturn_t
ata_interrupt (int irq
, void *dev_instance
, struct pt_regs
*regs
);
702 extern void ata_mmio_data_xfer(struct ata_device
*adev
, unsigned char *buf
,
703 unsigned int buflen
, int write_data
);
704 extern void ata_pio_data_xfer(struct ata_device
*adev
, unsigned char *buf
,
705 unsigned int buflen
, int write_data
);
706 extern void ata_pio_data_xfer_noirq(struct ata_device
*adev
, unsigned char *buf
,
707 unsigned int buflen
, int write_data
);
708 extern void ata_qc_prep(struct ata_queued_cmd
*qc
);
709 extern void ata_noop_qc_prep(struct ata_queued_cmd
*qc
);
710 extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd
*qc
);
711 extern void ata_sg_init_one(struct ata_queued_cmd
*qc
, void *buf
,
712 unsigned int buflen
);
713 extern void ata_sg_init(struct ata_queued_cmd
*qc
, struct scatterlist
*sg
,
714 unsigned int n_elem
);
715 extern unsigned int ata_dev_classify(const struct ata_taskfile
*tf
);
716 extern void ata_id_string(const u16
*id
, unsigned char *s
,
717 unsigned int ofs
, unsigned int len
);
718 extern void ata_id_c_string(const u16
*id
, unsigned char *s
,
719 unsigned int ofs
, unsigned int len
);
720 extern void ata_bmdma_setup (struct ata_queued_cmd
*qc
);
721 extern void ata_bmdma_start (struct ata_queued_cmd
*qc
);
722 extern void ata_bmdma_stop(struct ata_queued_cmd
*qc
);
723 extern u8
ata_bmdma_status(struct ata_port
*ap
);
724 extern void ata_bmdma_irq_clear(struct ata_port
*ap
);
725 extern void ata_bmdma_freeze(struct ata_port
*ap
);
726 extern void ata_bmdma_thaw(struct ata_port
*ap
);
727 extern void ata_bmdma_drive_eh(struct ata_port
*ap
, ata_prereset_fn_t prereset
,
728 ata_reset_fn_t softreset
,
729 ata_reset_fn_t hardreset
,
730 ata_postreset_fn_t postreset
);
731 extern void ata_bmdma_error_handler(struct ata_port
*ap
);
732 extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd
*qc
);
733 extern int ata_hsm_move(struct ata_port
*ap
, struct ata_queued_cmd
*qc
,
734 u8 status
, int in_wq
);
735 extern void ata_qc_complete(struct ata_queued_cmd
*qc
);
736 extern int ata_qc_complete_multiple(struct ata_port
*ap
, u32 qc_active
,
737 void (*finish_qc
)(struct ata_queued_cmd
*));
738 extern void ata_scsi_simulate(struct ata_device
*dev
, struct scsi_cmnd
*cmd
,
739 void (*done
)(struct scsi_cmnd
*));
740 extern int ata_std_bios_param(struct scsi_device
*sdev
,
741 struct block_device
*bdev
,
742 sector_t capacity
, int geom
[]);
743 extern int ata_scsi_slave_config(struct scsi_device
*sdev
);
744 extern void ata_scsi_slave_destroy(struct scsi_device
*sdev
);
745 extern int ata_scsi_change_queue_depth(struct scsi_device
*sdev
,
747 extern struct ata_device
*ata_dev_pair(struct ata_device
*adev
);
753 extern unsigned int ata_pio_need_iordy(const struct ata_device
*);
754 extern int ata_timing_compute(struct ata_device
*, unsigned short,
755 struct ata_timing
*, int, int);
756 extern void ata_timing_merge(const struct ata_timing
*,
757 const struct ata_timing
*, struct ata_timing
*,
761 ATA_TIMING_SETUP
= (1 << 0),
762 ATA_TIMING_ACT8B
= (1 << 1),
763 ATA_TIMING_REC8B
= (1 << 2),
764 ATA_TIMING_CYC8B
= (1 << 3),
765 ATA_TIMING_8BIT
= ATA_TIMING_ACT8B
| ATA_TIMING_REC8B
|
767 ATA_TIMING_ACTIVE
= (1 << 4),
768 ATA_TIMING_RECOVER
= (1 << 5),
769 ATA_TIMING_CYCLE
= (1 << 6),
770 ATA_TIMING_UDMA
= (1 << 7),
771 ATA_TIMING_ALL
= ATA_TIMING_SETUP
| ATA_TIMING_ACT8B
|
772 ATA_TIMING_REC8B
| ATA_TIMING_CYC8B
|
773 ATA_TIMING_ACTIVE
| ATA_TIMING_RECOVER
|
774 ATA_TIMING_CYCLE
| ATA_TIMING_UDMA
,
780 unsigned int reg
; /* PCI config register to read */
781 unsigned int width
; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
786 extern void ata_pci_host_stop (struct ata_host_set
*host_set
);
787 extern struct ata_probe_ent
*
788 ata_pci_init_native_mode(struct pci_dev
*pdev
, struct ata_port_info
**port
, int portmask
);
789 extern int pci_test_config_bits(struct pci_dev
*pdev
, const struct pci_bits
*bits
);
790 extern unsigned long ata_pci_default_filter(const struct ata_port
*, struct ata_device
*, unsigned long);
791 #endif /* CONFIG_PCI */
796 extern void ata_eng_timeout(struct ata_port
*ap
);
798 extern void ata_port_schedule_eh(struct ata_port
*ap
);
799 extern int ata_port_abort(struct ata_port
*ap
);
800 extern int ata_port_freeze(struct ata_port
*ap
);
802 extern void ata_eh_freeze_port(struct ata_port
*ap
);
803 extern void ata_eh_thaw_port(struct ata_port
*ap
);
805 extern void ata_eh_qc_complete(struct ata_queued_cmd
*qc
);
806 extern void ata_eh_qc_retry(struct ata_queued_cmd
*qc
);
808 extern void ata_do_eh(struct ata_port
*ap
, ata_prereset_fn_t prereset
,
809 ata_reset_fn_t softreset
, ata_reset_fn_t hardreset
,
810 ata_postreset_fn_t postreset
);
815 #define ata_port_printk(ap, lv, fmt, args...) \
816 printk(lv"ata%u: "fmt, (ap)->id , ##args)
818 #define ata_dev_printk(dev, lv, fmt, args...) \
819 printk(lv"ata%u.%02u: "fmt, (dev)->ap->id, (dev)->devno , ##args)
822 * ata_eh_info helpers
824 #define ata_ehi_push_desc(ehi, fmt, args...) do { \
825 (ehi)->desc_len += scnprintf((ehi)->desc + (ehi)->desc_len, \
826 ATA_EH_DESC_LEN - (ehi)->desc_len, \
830 #define ata_ehi_clear_desc(ehi) do { \
831 (ehi)->desc[0] = '\0'; \
832 (ehi)->desc_len = 0; \
835 static inline void ata_ehi_hotplugged(struct ata_eh_info
*ehi
)
837 if (ehi
->flags
& ATA_EHI_HOTPLUGGED
)
840 ehi
->flags
|= ATA_EHI_HOTPLUGGED
| ATA_EHI_RESUME_LINK
;
841 ehi
->hotplug_timestamp
= jiffies
;
843 ehi
->err_mask
|= AC_ERR_ATA_BUS
;
844 ehi
->action
|= ATA_EH_SOFTRESET
;
845 ehi
->probe_mask
|= (1 << ATA_MAX_DEVICES
) - 1;
852 ata_sg_is_last(struct scatterlist
*sg
, struct ata_queued_cmd
*qc
)
854 if (sg
== &qc
->pad_sgent
)
858 if (((sg
- qc
->__sg
) + 1) == qc
->n_elem
)
863 static inline struct scatterlist
*
864 ata_qc_first_sg(struct ata_queued_cmd
*qc
)
869 return &qc
->pad_sgent
;
873 static inline struct scatterlist
*
874 ata_qc_next_sg(struct scatterlist
*sg
, struct ata_queued_cmd
*qc
)
876 if (sg
== &qc
->pad_sgent
)
878 if (++sg
- qc
->__sg
< qc
->n_elem
)
881 return &qc
->pad_sgent
;
885 #define ata_for_each_sg(sg, qc) \
886 for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
888 static inline unsigned int ata_tag_valid(unsigned int tag
)
890 return (tag
< ATA_MAX_QUEUE
) ? 1 : 0;
893 static inline unsigned int ata_tag_internal(unsigned int tag
)
895 return tag
== ATA_MAX_QUEUE
- 1;
901 static inline unsigned int ata_class_enabled(unsigned int class)
903 return class == ATA_DEV_ATA
|| class == ATA_DEV_ATAPI
;
906 static inline unsigned int ata_class_disabled(unsigned int class)
908 return class == ATA_DEV_ATA_UNSUP
|| class == ATA_DEV_ATAPI_UNSUP
;
911 static inline unsigned int ata_class_absent(unsigned int class)
913 return !ata_class_enabled(class) && !ata_class_disabled(class);
916 static inline unsigned int ata_dev_enabled(const struct ata_device
*dev
)
918 return ata_class_enabled(dev
->class);
921 static inline unsigned int ata_dev_disabled(const struct ata_device
*dev
)
923 return ata_class_disabled(dev
->class);
926 static inline unsigned int ata_dev_absent(const struct ata_device
*dev
)
928 return ata_class_absent(dev
->class);
934 static inline int ata_port_max_devices(const struct ata_port
*ap
)
936 if (ap
->flags
& ATA_FLAG_SLAVE_POSS
)
942 static inline u8
ata_chk_status(struct ata_port
*ap
)
944 return ap
->ops
->check_status(ap
);
949 * ata_pause - Flush writes and pause 400 nanoseconds.
950 * @ap: Port to wait for.
953 * Inherited from caller.
956 static inline void ata_pause(struct ata_port
*ap
)
964 * ata_busy_wait - Wait for a port status register
965 * @ap: Port to wait for.
967 * Waits up to max*10 microseconds for the selected bits in the port's
968 * status register to be cleared.
969 * Returns final value of status register.
972 * Inherited from caller.
975 static inline u8
ata_busy_wait(struct ata_port
*ap
, unsigned int bits
,
982 status
= ata_chk_status(ap
);
984 } while ((status
& bits
) && (max
> 0));
991 * ata_wait_idle - Wait for a port to be idle.
992 * @ap: Port to wait for.
994 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
995 * Returns final value of status register.
998 * Inherited from caller.
1001 static inline u8
ata_wait_idle(struct ata_port
*ap
)
1003 u8 status
= ata_busy_wait(ap
, ATA_BUSY
| ATA_DRQ
, 1000);
1005 if (status
& (ATA_BUSY
| ATA_DRQ
)) {
1006 unsigned long l
= ap
->ioaddr
.status_addr
;
1007 if (ata_msg_warn(ap
))
1008 printk(KERN_WARNING
"ATA: abnormal status 0x%X on port 0x%lX\n",
1015 static inline void ata_qc_set_polling(struct ata_queued_cmd
*qc
)
1017 qc
->tf
.ctl
|= ATA_NIEN
;
1020 static inline struct ata_queued_cmd
*__ata_qc_from_tag(struct ata_port
*ap
,
1023 if (likely(ata_tag_valid(tag
)))
1024 return &ap
->qcmd
[tag
];
1028 static inline struct ata_queued_cmd
*ata_qc_from_tag(struct ata_port
*ap
,
1031 struct ata_queued_cmd
*qc
= __ata_qc_from_tag(ap
, tag
);
1033 if (unlikely(!qc
) || !ap
->ops
->error_handler
)
1036 if ((qc
->flags
& (ATA_QCFLAG_ACTIVE
|
1037 ATA_QCFLAG_FAILED
)) == ATA_QCFLAG_ACTIVE
)
1043 static inline void ata_tf_init(struct ata_device
*dev
, struct ata_taskfile
*tf
)
1045 memset(tf
, 0, sizeof(*tf
));
1047 tf
->ctl
= dev
->ap
->ctl
;
1048 if (dev
->devno
== 0)
1049 tf
->device
= ATA_DEVICE_OBS
;
1051 tf
->device
= ATA_DEVICE_OBS
| ATA_DEV1
;
1054 static inline void ata_qc_reinit(struct ata_queued_cmd
*qc
)
1058 qc
->cursect
= qc
->cursg
= qc
->cursg_ofs
= 0;
1060 qc
->nbytes
= qc
->curbytes
= 0;
1063 ata_tf_init(qc
->dev
, &qc
->tf
);
1065 /* init result_tf such that it indicates normal completion */
1066 qc
->result_tf
.command
= ATA_DRDY
;
1067 qc
->result_tf
.feature
= 0;
1071 * ata_irq_on - Enable interrupts on a port.
1072 * @ap: Port on which interrupts are enabled.
1074 * Enable interrupts on a legacy IDE device using MMIO or PIO,
1075 * wait for idle, clear any pending interrupts.
1078 * Inherited from caller.
1081 static inline u8
ata_irq_on(struct ata_port
*ap
)
1083 struct ata_ioports
*ioaddr
= &ap
->ioaddr
;
1086 ap
->ctl
&= ~ATA_NIEN
;
1087 ap
->last_ctl
= ap
->ctl
;
1089 if (ap
->flags
& ATA_FLAG_MMIO
)
1090 writeb(ap
->ctl
, (void __iomem
*) ioaddr
->ctl_addr
);
1092 outb(ap
->ctl
, ioaddr
->ctl_addr
);
1093 tmp
= ata_wait_idle(ap
);
1095 ap
->ops
->irq_clear(ap
);
1102 * ata_irq_ack - Acknowledge a device interrupt.
1103 * @ap: Port on which interrupts are enabled.
1105 * Wait up to 10 ms for legacy IDE device to become idle (BUSY
1106 * or BUSY+DRQ clear). Obtain dma status and port status from
1107 * device. Clear the interrupt. Return port status.
1112 static inline u8
ata_irq_ack(struct ata_port
*ap
, unsigned int chk_drq
)
1114 unsigned int bits
= chk_drq
? ATA_BUSY
| ATA_DRQ
: ATA_BUSY
;
1115 u8 host_stat
, post_stat
, status
;
1117 status
= ata_busy_wait(ap
, bits
, 1000);
1119 if (ata_msg_err(ap
))
1120 printk(KERN_ERR
"abnormal status 0x%X\n", status
);
1122 /* get controller status; clear intr, err bits */
1123 if (ap
->flags
& ATA_FLAG_MMIO
) {
1124 void __iomem
*mmio
= (void __iomem
*) ap
->ioaddr
.bmdma_addr
;
1125 host_stat
= readb(mmio
+ ATA_DMA_STATUS
);
1126 writeb(host_stat
| ATA_DMA_INTR
| ATA_DMA_ERR
,
1127 mmio
+ ATA_DMA_STATUS
);
1129 post_stat
= readb(mmio
+ ATA_DMA_STATUS
);
1131 host_stat
= inb(ap
->ioaddr
.bmdma_addr
+ ATA_DMA_STATUS
);
1132 outb(host_stat
| ATA_DMA_INTR
| ATA_DMA_ERR
,
1133 ap
->ioaddr
.bmdma_addr
+ ATA_DMA_STATUS
);
1135 post_stat
= inb(ap
->ioaddr
.bmdma_addr
+ ATA_DMA_STATUS
);
1138 if (ata_msg_intr(ap
))
1139 printk(KERN_INFO
"%s: irq ack: host_stat 0x%X, new host_stat 0x%X, drv_stat 0x%X\n",
1141 host_stat
, post_stat
, status
);
1146 static inline int ata_try_flush_cache(const struct ata_device
*dev
)
1148 return ata_id_wcache_enabled(dev
->id
) ||
1149 ata_id_has_flush(dev
->id
) ||
1150 ata_id_has_flush_ext(dev
->id
);
1153 static inline unsigned int ac_err_mask(u8 status
)
1155 if (status
& (ATA_BUSY
| ATA_DRQ
))
1157 if (status
& (ATA_ERR
| ATA_DF
))
1162 static inline unsigned int __ac_err_mask(u8 status
)
1164 unsigned int mask
= ac_err_mask(status
);
1166 return AC_ERR_OTHER
;
1170 static inline int ata_pad_alloc(struct ata_port
*ap
, struct device
*dev
)
1173 ap
->pad
= dma_alloc_coherent(dev
, ATA_DMA_PAD_BUF_SZ
,
1174 &ap
->pad_dma
, GFP_KERNEL
);
1175 return (ap
->pad
== NULL
) ? -ENOMEM
: 0;
1178 static inline void ata_pad_free(struct ata_port
*ap
, struct device
*dev
)
1180 dma_free_coherent(dev
, ATA_DMA_PAD_BUF_SZ
, ap
->pad
, ap
->pad_dma
);
1183 static inline struct ata_port
*ata_shost_to_port(struct Scsi_Host
*host
)
1185 return (struct ata_port
*) &host
->hostdata
[0];
1188 #endif /* __LINUX_LIBATA_H__ */