wdcvar.h revision 1.85
1 /* $NetBSD: wdcvar.h,v 1.85 2006/09/07 12:46:47 itohy Exp $ */ 2 3 /*- 4 * Copyright (c) 1998, 2003, 2004 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Charles M. Hannum, by Onno van der Linden and by Manuel Bouyer. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 3. All advertising materials mentioning features or use of this software 19 * must display the following acknowledgement: 20 * This product includes software developed by the NetBSD 21 * Foundation, Inc. and its contributors. 22 * 4. Neither the name of The NetBSD Foundation nor the names of its 23 * contributors may be used to endorse or promote products derived 24 * from this software without specific prior written permission. 25 * 26 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 27 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 28 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 29 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 30 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 31 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 32 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 33 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 34 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 35 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 36 * POSSIBILITY OF SUCH DAMAGE. 37 */ 38 39 #ifndef _DEV_IC_WDCVAR_H_ 40 #define _DEV_IC_WDCVAR_H_ 41 42 #include <sys/callout.h> 43 44 #include <dev/ata/ataconf.h> 45 #include <dev/ic/wdcreg.h> 46 47 #define WAITTIME (10 * hz) /* time to wait for a completion */ 48 /* this is a lot for hard drives, but not for cdroms */ 49 50 #define WDC_NREG 8 /* number of command registers */ 51 #define WDC_NSHADOWREG 2 /* number of command "shadow" registers */ 52 53 struct wdc_regs { 54 /* Our registers */ 55 bus_space_tag_t cmd_iot; 56 bus_space_handle_t cmd_baseioh; 57 bus_space_handle_t cmd_iohs[WDC_NREG+WDC_NSHADOWREG]; 58 bus_space_tag_t ctl_iot; 59 bus_space_handle_t ctl_ioh; 60 61 /* data32{iot,ioh} are only used for 32-bit data xfers */ 62 bus_space_tag_t data32iot; 63 bus_space_handle_t data32ioh; 64 }; 65 66 /* 67 * Per-controller data 68 */ 69 struct wdc_softc { 70 struct atac_softc sc_atac; /* generic ATA controller info */ 71 72 struct wdc_regs *regs; /* register array (per-channel) */ 73 74 int cap; /* controller capabilities */ 75 #define WDC_CAPABILITY_NO_EXTRA_RESETS 0x0100 /* only reset once */ 76 #define WDC_CAPABILITY_PREATA 0x0200 /* ctrl can be a pre-ata one */ 77 #define WDC_CAPABILITY_WIDEREGS 0x0400 /* Ctrl has wide (16bit) registers */ 78 79 /* if WDC_CAPABILITY_DMA set in 'cap' */ 80 void *dma_arg; 81 int (*dma_init)(void *, int, int, void *, size_t, int); 82 void (*dma_start)(void *, int, int); 83 int (*dma_finish)(void *, int, int, int); 84 #if NATA_PIOBM 85 void (*piobm_start)(void *, int, int, int, int, int); 86 void (*piobm_done)(void *, int, int); 87 #endif 88 /* flags passed to dma_init */ 89 #define WDC_DMA_READ 0x01 90 #define WDC_DMA_IRQW 0x02 91 #define WDC_DMA_LBA48 0x04 92 #define WDC_DMA_PIOBM_ATA 0x08 93 #define WDC_DMA_PIOBM_ATAPI 0x10 94 #if NATA_PIOBM 95 /* flags passed to piobm_start */ 96 #define WDC_PIOBM_XFER_IRQ 0x01 97 #endif 98 99 /* values passed to dma_finish */ 100 #define WDC_DMAEND_END 0 /* check for proper end of a DMA xfer */ 101 #define WDC_DMAEND_ABRT 1 /* abort a DMA xfer, verbose */ 102 #define WDC_DMAEND_ABRT_QUIET 2 /* abort a DMA xfer, quiet */ 103 104 int dma_status; /* status returned from dma_finish() */ 105 #define WDC_DMAST_NOIRQ 0x01 /* missing IRQ */ 106 #define WDC_DMAST_ERR 0x02 /* DMA error */ 107 #define WDC_DMAST_UNDER 0x04 /* DMA underrun */ 108 109 /* Optional callback to select drive. */ 110 void (*select)(struct ata_channel *,int); 111 112 /* Optional callback to ack IRQ. */ 113 void (*irqack)(struct ata_channel *); 114 115 /* Optional callback to perform a bus reset */ 116 void (*reset)(struct ata_channel *, int); 117 118 /* overridden if the backend has a different data transfer method */ 119 void (*datain_pio)(struct ata_channel *, int, void *, size_t); 120 void (*dataout_pio)(struct ata_channel *, int, void *, size_t); 121 }; 122 123 /* Given an ata_channel, get the wdc_softc. */ 124 #define CHAN_TO_WDC(chp) ((struct wdc_softc *)(chp)->ch_atac) 125 126 /* Given an ata_channel, get the wdc_regs. */ 127 #define CHAN_TO_WDC_REGS(chp) (&CHAN_TO_WDC(chp)->regs[(chp)->ch_channel]) 128 129 /* 130 * Public functions which can be called by ATA or ATAPI specific parts, 131 * or bus-specific backends. 132 */ 133 134 void wdc_allocate_regs(struct wdc_softc *); 135 void wdc_init_shadow_regs(struct ata_channel *); 136 137 int wdcprobe(struct ata_channel *); 138 void wdcattach(struct ata_channel *); 139 int wdcdetach(struct device *, int); 140 int wdcactivate(struct device *, enum devact); 141 int wdcintr(void *); 142 143 void wdcrestart(void*); 144 145 int wdcwait(struct ata_channel *, int, int, int, int); 146 #define WDCWAIT_OK 0 /* we have what we asked */ 147 #define WDCWAIT_TOUT -1 /* timed out */ 148 #define WDCWAIT_THR 1 /* return, the kernel thread has been awakened */ 149 150 void wdcbit_bucket(struct ata_channel *, int); 151 152 int wdc_dmawait(struct ata_channel *, struct ata_xfer *, int); 153 void wdccommand(struct ata_channel *, u_int8_t, u_int8_t, u_int16_t, 154 u_int8_t, u_int8_t, u_int8_t, u_int8_t); 155 void wdccommandext(struct ata_channel *, u_int8_t, u_int8_t, u_int64_t, 156 u_int16_t); 157 void wdccommandshort(struct ata_channel *, int, int); 158 void wdctimeout(void *arg); 159 void wdc_reset_drive(struct ata_drive_datas *, int); 160 void wdc_reset_channel(struct ata_channel *, int); 161 void wdc_do_reset(struct ata_channel *, int); 162 163 int wdc_exec_command(struct ata_drive_datas *, struct ata_command*); 164 165 /* 166 * ST506 spec says that if READY or SEEKCMPLT go off, then the read or write 167 * command is aborted. 168 */ 169 #define wdc_wait_for_drq(chp, timeout, flags) \ 170 wdcwait((chp), WDCS_DRQ, WDCS_DRQ, (timeout), (flags)) 171 #define wdc_wait_for_unbusy(chp, timeout, flags) \ 172 wdcwait((chp), 0, 0, (timeout), (flags)) 173 #define wdc_wait_for_ready(chp, timeout, flags) \ 174 wdcwait((chp), WDCS_DRDY, WDCS_DRDY, (timeout), (flags)) 175 176 /* ATA/ATAPI specs says a device can take 31s to reset */ 177 #define WDC_RESET_WAIT 31000 178 179 void wdc_atapibus_attach(struct atabus_softc *); 180 181 #endif /* _DEV_IC_WDCVAR_H_ */ 182
Indexes created Sun Oct 19 02:09:48 GMT 2025