1 /* $NetBSD: osiopvar.h,v 1.3 2002/05/14 02:58:35 matt Exp $ */ 2 3 /* 4 * Copyright (c) 2001 Izumi Tsutsui. All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 3. The name of the author may not be used to endorse or promote products 15 * derived from this software without specific prior written permission. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 27 */ 28 29 /* 30 * Copyright (c) 1990 The Regents of the University of California. 31 * All rights reserved. 32 * 33 * This code is derived from software contributed to Berkeley by 34 * Van Jacobson of Lawrence Berkeley Laboratory. 35 * 36 * Redistribution and use in source and binary forms, with or without 37 * modification, are permitted provided that the following conditions 38 * are met: 39 * 1. Redistributions of source code must retain the above copyright 40 * notice, this list of conditions and the following disclaimer. 41 * 2. Redistributions in binary form must reproduce the above copyright 42 * notice, this list of conditions and the following disclaimer in the 43 * documentation and/or other materials provided with the distribution. 44 * 3. All advertising materials mentioning features or use of this software 45 * must display the following acknowledgement: 46 * This product includes software developed by the University of 47 * California, Berkeley and its contributors. 48 * 4. Neither the name of the University nor the names of its contributors 49 * may be used to endorse or promote products derived from this software 50 * without specific prior written permission. 51 * 52 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 53 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 54 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 55 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 56 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 57 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 58 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 59 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 60 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 61 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 62 * SUCH DAMAGE. 63 * 64 * @(#)siopvar.h 7.1 (Berkeley) 5/8/90 65 */ 66 67 #define osiop_read_1(sc, reg) \ 68 bus_space_read_1((sc)->sc_bst, (sc)->sc_reg, reg) 69 #define osiop_write_1(sc, reg, val) \ 70 bus_space_write_1((sc)->sc_bst, (sc)->sc_reg, reg, val) 71 72 #define osiop_read_4(sc, reg) \ 73 bus_space_read_4((sc)->sc_bst, (sc)->sc_reg, reg) 74 #define osiop_write_4(sc, reg, val) \ 75 bus_space_write_4((sc)->sc_bst, (sc)->sc_reg, reg, val) 76 77 /* 78 * The largest single request will be MAXPHYS bytes which will require 79 * at most MAXPHYS/NBPG+1 chain elements to describe, i.e. if none of 80 * the buffer pages are physically contiguous (MAXPHYS/NBPG) and the 81 * buffer is not page aligned (+1). 82 */ 83 /* XXX This should be (MAXPHYS / NBPG + 1), but hardcoded in script */ 84 #define OSIOP_NSG (16 + 1) 85 #if MAXPHYS > (PAGE_SIZE * (OSIOP_NSG - 1)) 86 #define OSIOP_MAX_XFER (PAGE_SIZE * (OSIOP_NSG - 1)) 87 #else 88 #define OSIOP_MAX_XFER MAXPHYS 89 #endif 90 91 #define OSIOP_NTGT 8 92 #define OSIOP_NACB 32 /* XXX (PAGE_SIZE / sizeof(osiop_ds)) is better? */ 93 94 /* 95 * Data Structure for SCRIPTS program 96 */ 97 typedef struct buf_table { 98 u_int32_t count; 99 u_int32_t addr; 100 } buf_table_t; 101 102 struct osiop_ds { 103 u_int32_t scsi_addr; /* SCSI ID & sync */ 104 u_int32_t pad1; 105 buf_table_t id; /* Identify message */ 106 buf_table_t cmd; /* SCSI command */ 107 buf_table_t status; /* Status */ 108 buf_table_t msg; /* Message */ 109 buf_table_t msgin; /* Message in */ 110 buf_table_t extmsg; /* Extended message in */ 111 buf_table_t synmsg; /* Sync transfer request */ 112 buf_table_t data[OSIOP_NSG]; /* DMA S/G buffers */ 113 114 u_int8_t msgout[8]; 115 u_int8_t msgbuf[8]; 116 u_int8_t stat[8]; 117 } __attribute__((__packed__)); 118 119 /* status can hold the SCSI_* status values, and 2 additionnal values: */ 120 #define SCSI_OSIOP_NOCHECK 0xfe /* don't check the scsi status */ 121 #define SCSI_OSIOP_NOSTATUS 0xff /* device didn't report status */ 122 123 #define MSG_INVALID 0xff /* dummy value for message buffer */ 124 125 #define OSIOP_DSOFF(x) offsetof(struct osiop_ds, x) 126 #define OSIOP_DSIDOFF OSIOP_DSOFF(msgout[0]) 127 #define OSIOP_DSMSGOFF OSIOP_DSOFF(msgbuf[0]) 128 #define OSIOP_DSMSGINOFF OSIOP_DSOFF(msgbuf[1]) 129 #define OSIOP_DSEXTMSGOFF OSIOP_DSOFF(msgbuf[2]) 130 #define OSIOP_DSSYNMSGOFF OSIOP_DSOFF(msgbuf[3]) 131 #define OSIOP_DSSTATOFF OSIOP_DSOFF(stat[0]) 132 133 /* 134 * ACB. Holds additional information for each SCSI command Comments: 135 * Basicly, we refrain from fiddling with the scsi_xfer struct 136 * (except do the expected updating of return values). 137 * We'll generally update: xs->{flags,resid,error,status} and 138 * occasionally xs->retries. 139 */ 140 struct osiop_acb { 141 TAILQ_ENTRY(osiop_acb) chain; 142 struct scsipi_xfer *xs; /* SCSI xfer ctrl block from upper layer */ 143 struct osiop_softc *sc; /* points back to our adapter */ 144 145 bus_dmamap_t cmddma; /* DMA map for SCSI command */ 146 bus_dmamap_t datadma; /* DMA map for data transfer */ 147 148 struct osiop_ds *ds; /* data structure for this acb */ 149 bus_size_t dsoffset; /* offset of data structure for this acb */ 150 151 bus_size_t cmdlen; /* command length */ 152 bus_size_t datalen; /* transfer data length */ 153 #ifdef OSIOP_DEBUG 154 void *data; /* transfer data buffer ptr */ 155 #endif 156 157 bus_addr_t curaddr; /* current transfer data buffer */ 158 bus_size_t curlen; /* current transfer data length */ 159 160 int status; /* status of this acb */ 161 /* status defs */ 162 #define ACB_S_FREE 0 /* cmd slot is free */ 163 #define ACB_S_READY 1 /* cmd slot is waiting for processing */ 164 #define ACB_S_ACTIVE 2 /* cmd slot is being processed */ 165 #define ACB_S_DONE 3 /* cmd slot has been processed */ 166 167 int flags; /* cmd slot flags */ 168 #define ACB_F_TIMEOUT 0x01 /* command timeout */ 169 170 u_int8_t intstat; /* buffer to save sc_flags on disconnect */ 171 }; 172 173 /* 174 * Some info about each (possible) target on the SCSI bus. This should 175 * probably have been a "per target+lunit" structure, but we'll leave it at 176 * this for now. Is there a way to reliably hook it up to sc->fordriver?? 177 */ 178 struct osiop_tinfo { 179 int cmds; /* number of commands processed */ 180 int dconns; /* number of disconnects */ 181 int touts; /* number of timeouts */ 182 int perrs; /* number of parity errors */ 183 int lubusy; /* What local units/subr. are busy? */ 184 int period; /* Period suggestion */ 185 int offset; /* Offset suggestion */ 186 int flags; /* misc flags per each target */ 187 #define TI_NOSYNC 0x01 /* disable sync xfer on this target */ 188 #define TI_NODISC 0x02 /* disable disconnect on this target */ 189 int state; /* negotiation state */ 190 u_int8_t sxfer; /* value for SXFER reg */ 191 u_int8_t sbcl; /* value for SBCL reg */ 192 }; 193 194 struct osiop_softc { 195 struct device sc_dev; 196 197 bus_space_tag_t sc_bst; /* bus space tag */ 198 bus_space_handle_t sc_reg; /* register I/O handle */ 199 200 bus_dma_tag_t sc_dmat; /* bus dma tag */ 201 bus_dmamap_t sc_scrdma; /* script dma map */ 202 bus_dmamap_t sc_dsdma; /* script data dma map */ 203 204 u_int32_t *sc_script; /* ptr to script memory */ 205 struct osiop_ds *sc_ds; /* ptr to data structure memory */ 206 207 int sc_id; /* adapter SCSI id */ 208 int sc_active; /* number of active I/O's */ 209 210 struct osiop_acb *sc_nexus; /* current command */ 211 struct osiop_acb *sc_acb; /* the real command blocks */ 212 213 /* Lists of command blocks */ 214 TAILQ_HEAD(acb_list, osiop_acb) free_list, 215 ready_list, 216 nexus_list; 217 218 struct scsipi_adapter sc_adapter; 219 struct scsipi_channel sc_channel; 220 221 struct osiop_tinfo sc_tinfo[OSIOP_NTGT]; 222 223 int sc_clock_freq; 224 int sc_tcp[4]; 225 int sc_flags; 226 #define OSIOP_INTSOFF 0x80 /* Interrupts turned off */ 227 #define OSIOP_INTDEFER 0x40 /* MD interrupt has been deferred */ 228 #define OSIOP_NODMA 0x02 /* No DMA transfer */ 229 #define OSIOP_ALIVE 0x01 /* controller initialized */ 230 231 int sc_cfflags; /* copy of config flags */ 232 233 int sc_minsync; 234 235 u_int8_t sc_dstat; 236 u_int8_t sc_sstat0; 237 u_int8_t sc_sstat1; 238 u_int8_t sc_istat; 239 u_int8_t sc_dcntl; 240 u_int8_t sc_ctest7; 241 u_int8_t sc_sien; 242 u_int8_t sc_dien; 243 }; 244 245 /* negotiation states */ 246 #define NEG_INIT 0 /* Initial negotiate state */ 247 #define NEG_SYNC NEG_INIT /* Negotiate synch transfers */ 248 #define NEG_WAITS 1 /* Waiting for synch negoation response */ 249 #define NEG_DONE 2 /* Wide and/or sync negotation done */ 250 251 void osiop_attach(struct osiop_softc *); 252 void osiop_intr(struct osiop_softc *); 253