wdcvar.h revision 1.45
1 /* $NetBSD: wdcvar.h,v 1.45 2003/12/03 12:01:18 bouyer Exp $ */ 2 3 /*- 4 * Copyright (c) 1998, 2003 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 /* XXX For scsipi_adapter and scsipi_channel. */ 40 #include <dev/scsipi/scsipi_all.h> 41 #include <dev/scsipi/atapiconf.h> 42 43 #include <sys/callout.h> 44 45 #define WAITTIME (10 * hz) /* time to wait for a completion */ 46 /* this is a lot for hard drives, but not for cdroms */ 47 48 struct channel_queue { /* per channel queue (may be shared) */ 49 TAILQ_HEAD(xferhead, wdc_xfer) sc_xfer; 50 int queue_freeze; 51 }; 52 53 #define WDC_NREG 8 /* number of command registers */ 54 55 struct channel_softc { /* Per channel data */ 56 /* Our timeout callout */ 57 struct callout ch_callout; 58 /* Our location */ 59 int channel; 60 /* Our controller's softc */ 61 struct wdc_softc *wdc; 62 /* Our registers */ 63 bus_space_tag_t cmd_iot; 64 bus_space_handle_t cmd_baseioh; 65 bus_space_handle_t cmd_iohs[WDC_NREG]; 66 bus_space_tag_t ctl_iot; 67 bus_space_handle_t ctl_ioh; 68 /* data32{iot,ioh} are only used for 32 bit data xfers */ 69 bus_space_tag_t data32iot; 70 bus_space_handle_t data32ioh; 71 /* Our state */ 72 int ch_flags; 73 #define WDCF_ACTIVE 0x01 /* channel is active */ 74 #define WDCF_SHUTDOWN 0x02 /* channel is shutting down */ 75 #define WDCF_IRQ_WAIT 0x10 /* controller is waiting for irq */ 76 #define WDCF_DMA_WAIT 0x20 /* controller is waiting for DMA */ 77 #define WDCF_DISABLED 0x80 /* channel is disabled */ 78 #define WDCF_TH_RUN 0x100 /* the kenrel thread is working */ 79 #define WDCF_TH_RESET 0x200 /* someone ask the thread to reset */ 80 u_int8_t ch_status; /* copy of status register */ 81 u_int8_t ch_error; /* copy of error register */ 82 /* per-drive infos */ 83 struct ata_drive_datas ch_drive[2]; 84 85 struct device *atabus; /* self */ 86 struct device *atapibus; /* children */ 87 struct scsipi_channel ch_atapi_channel; 88 89 struct device *ata_drives[2]; /* children */ 90 91 /* 92 * channel queues. May be the same for all channels, if hw channels 93 * are not independent. 94 */ 95 struct channel_queue *ch_queue; 96 /* the channel kenrel thread */ 97 struct proc *thread; 98 }; 99 100 struct atabus_softc { /* the atabus softc */ 101 struct device sc_dev; 102 struct channel_softc *sc_chan; 103 }; 104 105 struct wdc_softc { /* Per controller state */ 106 struct device sc_dev; 107 /* mandatory fields */ 108 int cap; 109 /* Capabilities supported by the controller */ 110 #define WDC_CAPABILITY_DATA16 0x0001 /* can do 16-bit data access */ 111 #define WDC_CAPABILITY_DATA32 0x0002 /* can do 32-bit data access */ 112 #define WDC_CAPABILITY_MODE 0x0004 /* controller knows its PIO/DMA modes */ 113 #define WDC_CAPABILITY_DMA 0x0008 /* DMA */ 114 #define WDC_CAPABILITY_UDMA 0x0010 /* Ultra-DMA/33 */ 115 #define WDC_CAPABILITY_HWLOCK 0x0020 /* Needs to lock HW */ 116 #define WDC_CAPABILITY_ATA_NOSTREAM 0x0040 /* Don't use stream funcs on ATA */ 117 #define WDC_CAPABILITY_ATAPI_NOSTREAM 0x0080 /* Don't use stream f on ATAPI */ 118 #define WDC_CAPABILITY_NO_EXTRA_RESETS 0x0100 /* only reset once */ 119 #define WDC_CAPABILITY_PREATA 0x0200 /* ctrl can be a pre-ata one */ 120 #define WDC_CAPABILITY_IRQACK 0x0400 /* callback to ack interrupt */ 121 #define WDC_CAPABILITY_NOIRQ 0x1000 /* Controller never interrupts */ 122 #define WDC_CAPABILITY_SELECT 0x2000 /* Controller selects target */ 123 #define WDC_CAPABILITY_RAID 0x4000 /* Controller "supports" RAID */ 124 u_int8_t PIO_cap; /* highest PIO mode supported */ 125 u_int8_t DMA_cap; /* highest DMA mode supported */ 126 u_int8_t UDMA_cap; /* highest UDMA mode supported */ 127 int nchannels; /* Number of channels on this controller */ 128 struct channel_softc **channels; /* channels-specific datas (array) */ 129 130 /* 131 * The reference count here is used for both IDE and ATAPI devices. 132 */ 133 struct atapi_adapter sc_atapi_adapter; 134 135 /* if WDC_CAPABILITY_DMA set in 'cap' */ 136 void *dma_arg; 137 int (*dma_init) __P((void *, int, int, void *, size_t, 138 int)); 139 void (*dma_start) __P((void *, int, int)); 140 int (*dma_finish) __P((void *, int, int, int)); 141 /* flags passed to dma_init */ 142 #define WDC_DMA_READ 0x01 143 #define WDC_DMA_IRQW 0x02 144 #define WDC_DMA_LBA48 0x04 145 int dma_status; /* status returned from dma_finish() */ 146 #define WDC_DMAST_NOIRQ 0x01 /* missing IRQ */ 147 #define WDC_DMAST_ERR 0x02 /* DMA error */ 148 #define WDC_DMAST_UNDER 0x04 /* DMA underrun */ 149 150 /* if WDC_CAPABILITY_HWLOCK set in 'cap' */ 151 int (*claim_hw) __P((void *, int)); 152 void (*free_hw) __P((void *)); 153 154 /* if WDC_CAPABILITY_MODE set in 'cap' */ 155 void (*set_modes) __P((struct channel_softc *)); 156 157 /* if WDC_CAPABILITY_SELECT set in 'cap' */ 158 void (*select) __P((struct channel_softc *,int)); 159 160 /* if WDC_CAPABILITY_IRQACK set in 'cap' */ 161 void (*irqack) __P((struct channel_softc *)); 162 }; 163 164 /* 165 * Description of a command to be handled by a controller. 166 * These commands are queued in a list. 167 */ 168 struct wdc_xfer { 169 volatile u_int c_flags; 170 #define C_ATAPI 0x0001 /* xfer is ATAPI request */ 171 #define C_TIMEOU 0x0002 /* xfer processing timed out */ 172 #define C_POLL 0x0004 /* cmd is polled */ 173 #define C_DMA 0x0008 /* cmd uses DMA */ 174 175 /* Informations about our location */ 176 struct channel_softc *chp; 177 u_int8_t drive; 178 179 /* Information about the current transfer */ 180 void *cmd; /* wdc, ata or scsipi command structure */ 181 void *databuf; 182 int c_bcount; /* byte count left */ 183 int c_skip; /* bytes already transferred */ 184 int c_dscpoll; /* counter for dsc polling (ATAPI) */ 185 TAILQ_ENTRY(wdc_xfer) c_xferchain; 186 void (*c_start) __P((struct channel_softc *, struct wdc_xfer *)); 187 int (*c_intr) __P((struct channel_softc *, struct wdc_xfer *, int)); 188 void (*c_kill_xfer) __P((struct channel_softc *, struct wdc_xfer *)); 189 }; 190 191 /* 192 * Public functions which can be called by ATA or ATAPI specific parts, 193 * or bus-specific backends. 194 */ 195 196 int wdcprobe __P((struct channel_softc *)); 197 void wdcattach __P((struct channel_softc *)); 198 int wdcdetach __P((struct device *, int)); 199 int wdcactivate __P((struct device *, enum devact)); 200 int wdcintr __P((void *)); 201 void wdc_exec_xfer __P((struct channel_softc *, struct wdc_xfer *)); 202 struct wdc_xfer *wdc_get_xfer __P((int)); /* int = WDC_NOSLEEP/CANSLEEP */ 203 #define WDC_CANSLEEP 0x00 204 #define WDC_NOSLEEP 0x01 205 void wdc_free_xfer __P((struct channel_softc *, struct wdc_xfer *)); 206 void wdcstart __P((struct channel_softc *)); 207 void wdcrestart __P((void*)); 208 int wdcreset __P((struct channel_softc *, int)); 209 #define RESET_POLL 1 210 #define RESET_SLEEP 0 /* wdcreset will use tsleep() */ 211 int wdcwait __P((struct channel_softc *, int, int, int, int)); 212 #define WDCWAIT_OK 0 /* we have what we asked */ 213 #define WDCWAIT_TOUT -1 /* timed out */ 214 #define WDCWAIT_THR 1 /* return, the kernel thread has been awakened */ 215 int wdc_dmawait __P((struct channel_softc *, struct wdc_xfer *, int)); 216 void wdcbit_bucket __P(( struct channel_softc *, int)); 217 void wdccommand __P((struct channel_softc *, u_int8_t, u_int8_t, u_int16_t, 218 u_int8_t, u_int8_t, u_int8_t, u_int8_t)); 219 void wdccommandext __P((struct channel_softc *, u_int8_t, u_int8_t, u_int64_t, 220 u_int16_t)); 221 void wdccommandshort __P((struct channel_softc *, int, int)); 222 void wdctimeout __P((void *arg)); 223 void wdc_reset_channel __P((struct ata_drive_datas *, int)); 224 int wdc_exec_command __P((struct ata_drive_datas *, struct wdc_command*)); 225 #define WDC_COMPLETE 0x01 226 #define WDC_QUEUED 0x02 227 #define WDC_TRY_AGAIN 0x03 228 229 int wdc_addref __P((struct channel_softc *)); 230 void wdc_delref __P((struct channel_softc *)); 231 void wdc_kill_pending __P((struct channel_softc *)); 232 233 void wdc_print_modes (struct channel_softc *); 234 void wdc_probe_caps __P((struct ata_drive_datas*)); 235 236 /* 237 * ST506 spec says that if READY or SEEKCMPLT go off, then the read or write 238 * command is aborted. 239 */ 240 #define wait_for_drq(chp, timeout, flags) \ 241 wdcwait((chp), WDCS_DRQ, WDCS_DRQ, (timeout), (flags)) 242 #define wait_for_unbusy(chp, timeout, flags) \ 243 wdcwait((chp), 0, 0, (timeout), (flags)) 244 #define wait_for_ready(chp, timeout, flags) \ 245 wdcwait((chp), WDCS_DRDY, WDCS_DRDY, (timeout), (flags)) 246 /* ATA/ATAPI specs says a device can take 31s to reset */ 247 #define WDC_RESET_WAIT 31000 248 249 void wdc_atapibus_attach __P((struct atabus_softc *)); 250
Indexes created Sun Oct 19 02:09:48 GMT 2025