1 /* $NetBSD: wd33c93var.h,v 1.10 2009/05/12 14:25:18 cegger Exp $ */ 2 3 /* 4 * Copyright (c) 1990 The Regents of the University of California. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to Berkeley by 8 * Van Jacobson of Lawrence Berkeley Laboratory. 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. Neither the name of the University nor the names of its contributors 19 * may be used to endorse or promote products derived from this software 20 * without specific prior written permission. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32 * SUCH DAMAGE. 33 * 34 * @(#)scsivar.h 7.1 (Berkeley) 5/8/90 35 */ 36 #ifndef _SBICVAR_H_ 37 #define _SBICVAR_H_ 38 #include <sys/callout.h> 39 #include <sys/malloc.h> 40 41 #define SBIC_NTARG 8 42 #define SBIC_NLUN 8 43 #define SBIC_NTAGS 256 44 45 #define SBIC_MAX_MSGLEN 8 46 47 #define SBIC_ABORT_TIMEOUT 2000 /* time to wait for abort */ 48 #define SBIC_SENSE_TIMEOUT 1000 /* time to wait for sense */ 49 50 /* 51 * ACB. Holds additional information for each SCSI command Comments: We 52 * need a separate scsi command block because we may need to overwrite it 53 * with a request sense command. Basically, we refrain from fiddling with 54 * the scsi_xfer struct (except do the expected updating of return values). 55 * We'll generally update: xs->{flags,resid,error,sense,status} and 56 * occasionally xs->retries. 57 */ 58 struct wd33c93_acb { 59 TAILQ_ENTRY(wd33c93_acb) chain; 60 struct scsipi_xfer *xs; /* SCSI xfer ctrl block from above */ 61 int flags; /* Status */ 62 #define ACB_FREE 0x00 63 #define ACB_ACTIVE 0x01 64 #define ACB_READY 0x02 /* ACB is on ready list */ 65 #define ACB_DONE 0x04 66 #define ACB_SENSE 0x08 /* ACB Requesting sense */ 67 #define ACB_COMPLETE 0x10 /* Disconnected at end of xfer */ 68 #define ACB_RESET 0x20 /* Require Reset */ 69 #define ACB_ABORT 0x40 /* Require Abort */ 70 71 int timeout; 72 struct scsipi_generic cmd; /* SCSI command block */ 73 int clen; 74 char *daddr; /* kva for data */ 75 size_t dleft; /* bytes remaining */ 76 u_char tag_type; /* TAG Type (0x20-0x22, 0=No Tags) */ 77 u_char tag_id; /* TAG id number */ 78 }; 79 80 /* 81 * Some info about each (possible) target on the SCSI bus. This should 82 * probably have been a "per target+lunit" structure, but we'll leave it at 83 * this for now. Is there a way to reliably hook it up to sc->fordriver?? 84 */ 85 86 struct wd33c93_linfo { 87 LIST_ENTRY(wd33c93_linfo) link; 88 time_t last_used; 89 int lun; 90 int used; /* # slots in use */ 91 u_char state; 92 #define L_STATE_IDLE 0 93 #define L_STATE_BUSY 1 94 #define L_STATE_ESTAT 2 95 struct wd33c93_acb *untagged; 96 struct wd33c93_acb *queued[SBIC_NTAGS]; 97 }; 98 99 struct wd33c93_tinfo { 100 int cmds; /* # of commands processed */ 101 int dconns; /* # of disconnects */ 102 103 u_char flags; 104 #define T_NEED_RESET 0x01 /* Should send a BUS_DEV_RESET */ 105 #define T_NEGOTIATE 0x02 /* (Re)Negotiate synchronous options */ 106 #define T_BUSY 0x04 /* Target is busy */ 107 #define T_SYNCMODE 0x08 /* SYNC mode has been negotiated */ 108 #define T_NOSYNC 0x10 /* Force ASYNC mode */ 109 #define T_NODISC 0x20 /* Don't allow disconnect */ 110 #define T_TAG 0x40 /* Turn on TAG QUEUEs */ 111 #define T_WANTSYNC 0x80 /* Negotiatious should aim for sync */ 112 u_char period; /* Period suggestion */ 113 u_char offset; /* Offset suggestion */ 114 struct wd33c93_linfo *lun[SBIC_NLUN]; /* LUN list for this target */ 115 } tinfo_t; 116 117 /* Look up a lun in a tinfo */ 118 #define TINFO_LUN(t, l) ((t)->lun[(l)]) 119 120 struct wd33c93_softc { 121 device_t sc_dev; 122 123 struct scsipi_channel sc_channel; /* proto for sub devices */ 124 struct scsipi_adapter sc_adapter; 125 device_t sc_child; /* attached scsibus, if any */ 126 struct callout sc_watchdog; 127 void *sc_driver; /* driver specific field */ 128 129 int target; /* Currently active target */ 130 int lun; /* Currently active LUN */ 131 132 /* WD33c93 registers */ 133 bus_space_tag_t sc_regt; 134 bus_space_handle_t sc_asr_regh; 135 bus_space_handle_t sc_data_regh; 136 137 138 /* Data about the current nexus (updated for every cmd switch) */ 139 void * sc_daddr; /* Current data pointer */ 140 size_t sc_dleft; /* Data left to transfer */ 141 ssize_t sc_tcnt; /* number of bytes transfered */ 142 143 /* Lists of command blocks */ 144 TAILQ_HEAD(acb_list, wd33c93_acb) ready_list; 145 146 struct wd33c93_acb *sc_nexus; /* current command */ 147 struct wd33c93_tinfo sc_tinfo[8]; 148 149 u_short sc_state; 150 u_short sc_status; 151 int sc_disc; /* current # of active nexus's */ 152 int sc_flags; 153 154 /* Message stuff */ 155 u_short sc_msgify; /* Last IDENTIFY message */ 156 u_short sc_msgout; /* Current message out */ 157 u_short sc_msgpriq; /* mesg_out queue (bitmap) */ 158 u_short sc_msgoutq; /* mesg_out queue */ 159 160 u_char sc_imsg[SBIC_MAX_MSGLEN]; 161 u_char sc_omsg[SBIC_MAX_MSGLEN]; 162 u_char sc_imsglen; 163 u_char sc_omsglen; 164 165 /* Static hardware attributes supplied by attachment */ 166 int sc_id; /* SCSI ID for controller */ 167 int sc_clkfreq; /* wd33c93 clk freq * 10 MHz */ 168 uint8_t sc_dmamode; /* One of SBIC_CTL_*DMA */ 169 170 /* Static hardware attributes derived by wd33c93_attach() */ 171 int sc_chip; /* Chip variation */ 172 int sc_rev; /* Chip revision */ 173 int sc_cfflags; /* Copy of config flags */ 174 int sc_maxxfer; /* Maximum transfer size */ 175 uint8_t sc_maxoffset; /* Maximum sync offset (bytes) */ 176 uint8_t sc_minsyncperiod; /* Minimum supported sync xfer period */ 177 uint8_t sc_syncperiods[7]; /* Sync transfer periods (4ns units) */ 178 uint8_t sc_fsyncperiods[3]; /* Sync transfer periods for Fast SCSI*/ 179 180 int (*sc_dmasetup) (struct wd33c93_softc *, void **, 181 size_t *, int, size_t *); 182 int (*sc_dmago) (struct wd33c93_softc *); 183 void (*sc_dmastop) (struct wd33c93_softc *); 184 void (*sc_reset) (struct wd33c93_softc *); 185 }; 186 187 /* values for sc_flags */ 188 #define SBICF_SELECTED 0x01 /* bus is in selected state. */ 189 #define SBICF_NODMA 0x02 /* Polled transfer */ 190 #define SBICF_INDMA 0x04 /* DMA I/O in progress */ 191 #define SBICF_SYNCNEGO 0x08 /* Sync negotiation in progress */ 192 #define SBICF_ABORTING 0x10 /* Aborting */ 193 194 /* values for sc_state */ 195 #define SBIC_UNINITIALIZED 0 /* Driver not initialized */ 196 #define SBIC_IDLE 1 /* waiting for something to do */ 197 #define SBIC_SELECTING 2 /* SCSI command is arbiting */ 198 #define SBIC_RESELECTED 3 /* Has been reselected */ 199 #define SBIC_IDENTIFIED 4 /* Has gotten IFY but not TAG */ 200 #define SBIC_CONNECTED 5 /* Actively using the SCSI bus */ 201 #define SBIC_DISCONNECT 6 /* MSG_DISCONNECT received */ 202 #define SBIC_CMDCOMPLETE 7 /* MSG_CMDCOMPLETE received */ 203 #define SBIC_ERROR 8 /* Error has occurred */ 204 #define SBIC_SELTIMEOUT 9 /* Select Timeout */ 205 #define SBIC_CLEANING 10 /* Scrubbing ACB's */ 206 #define SBIC_BUSRESET 11 /* SCSI RST has been issued */ 207 208 /* values for sc_msgout */ 209 #define SEND_DEV_RESET 0x0001 210 #define SEND_PARITY_ERROR 0x0002 211 #define SEND_INIT_DET_ERR 0x0004 212 #define SEND_REJECT 0x0008 213 #define SEND_IDENTIFY 0x0010 214 #define SEND_ABORT 0x0020 215 #define SEND_WDTR 0x0040 216 #define SEND_SDTR 0x0080 217 #define SEND_TAG 0x0100 218 219 /* WD33c93 chipset revisions - values for sc_rev */ 220 #define SBIC_CHIP_UNKNOWN 0 221 #define SBIC_CHIP_WD33C93 1 222 #define SBIC_CHIP_WD33C93A 2 223 #define SBIC_CHIP_WD33C93B 3 224 225 #define SBIC_CHIP_LIST {"UNKNOWN", "WD33C93", "WD33C93A", "WD33C93B"} 226 227 /* macros for sc_cfflags */ 228 #define CFFLAGS_NODISC(_cf, _t) ((_cf) & (1 << ( 0 + (_t)))) 229 #define CFFLAGS_NOSYNC(_cf, _t) ((_cf) & (1 << ( 8 + (_t)))) 230 #define CFFLAGS_NOTAGS(_cf, _t) ((_cf) & (1 << (16 + (_t)))) 231 232 /* 233 * States returned by our state machine 234 */ 235 #define SBIC_STATE_ERROR -1 236 #define SBIC_STATE_DONE 0 237 #define SBIC_STATE_RUNNING 1 238 #define SBIC_STATE_DISCONNECT 2 239 240 #define DEBUG_ACBS 0x01 241 #define DEBUG_INTS 0x02 242 #define DEBUG_CMDS 0x04 243 #define DEBUG_MISC 0x08 244 #define DEBUG_TRAC 0x10 245 #define DEBUG_RSEL 0x20 246 #define DEBUG_PHASE 0x40 247 #define DEBUG_DMA 0x80 248 #define DEBUG_CCMDS 0x100 249 #define DEBUG_MSGS 0x200 250 #define DEBUG_TAGS 0x400 251 #define DEBUG_SYNC 0x800 252 253 #ifdef DEBUG 254 extern int wd33c93_debug_flags; 255 #define SBIC_DEBUG(level, str) \ 256 do { \ 257 if (wd33c93_debug & __CONCAT(DEBUG_,level)) \ 258 printf str; \ 259 } while (0) 260 #else 261 #define SBIC_DEBUG(level, str) 262 #endif 263 264 struct buf; 265 struct scsipi_xfer; 266 267 void wd33c93_scsi_request (struct scsipi_channel *, 268 scsipi_adapter_req_t, void *); 269 void wd33c93_attach (struct wd33c93_softc *); 270 int wd33c93_intr (struct wd33c93_softc *); 271 272 #endif /* _SBICVAR_H_ */ 273