1 /* $NetBSD: sbicvar.h,v 1.4 1997/08/27 11:23:59 bouyer 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. All advertising materials mentioning features or use of this software 19 * must display the following acknowledgement: 20 * This product includes software developed by the University of 21 * California, Berkeley and its contributors. 22 * 4. Neither the name of the University nor the names of its contributors 23 * may be used to endorse or promote products derived from this software 24 * without specific prior written permission. 25 * 26 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 27 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 28 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 29 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 30 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 31 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 32 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 33 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 34 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 35 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 36 * SUCH DAMAGE. 37 * 38 * @(#)scsivar.h 7.1 (Berkeley) 5/8/90 39 */ 40 #ifndef _SBICVAR_H_ 41 #define _SBICVAR_H_ 42 #include <sys/malloc.h> 43 44 45 /* 46 * DMA chains are used for Scatter-Gather DMA. 47 */ 48 struct dma_chain { 49 int dc_count; 50 char *dc_addr; 51 }; 52 53 /* 54 * ACB. Holds additional information for each SCSI command Comments: We 55 * need a separate scsi command block because we may need to overwrite it 56 * with a request sense command. Basicly, we refrain from fiddling with 57 * the scsi_xfer struct (except do the expected updating of return values). 58 * We'll generally update: xs->{flags,resid,error,sense,status} and 59 * occasionally xs->retries. 60 */ 61 struct sbic_acb { 62 TAILQ_ENTRY(sbic_acb) chain; 63 struct scsipi_xfer *xs; /* SCSI xfer ctrl block from above */ 64 int flags; /* Status */ 65 #define ACB_FREE 0x00 66 #define ACB_ACTIVE 0x01 67 #define ACB_DONE 0x04 68 #define ACB_CHKSENSE 0x08 69 #define ACB_BBUF 0x10 /* DMA input needs to be copied from bounce */ 70 #define ACB_DATAIN 0x20 /* DMA direction flag */ 71 72 struct scsi_generic cmd; /* SCSI command block */ 73 int clen; 74 struct dma_chain sc_kv; /* Virtual address of whole DMA */ 75 struct dma_chain sc_pa; /* Physical address of DMA segment */ 76 u_long sc_tcnt; /* number of bytes for this DMA */ 77 u_short sc_dmacmd; /* Internal data for this DMA */ 78 char *pa_addr; /* XXXX initial phys addr */ 79 }; 80 81 /* 82 * Some info about each (possible) target on the SCSI bus. This should 83 * probably have been a "per target+lunit" structure, but we'll leave it at 84 * this for now. Is there a way to reliably hook it up to sc->fordriver?? 85 */ 86 struct sbic_tinfo { 87 int cmds; /* #commands processed */ 88 int dconns; /* #disconnects */ 89 int senses; /* #request sense commands sent */ 90 int lubusy; /* What local units/subr. are busy? */ 91 } tinfo_t; 92 93 struct sbic_softc { 94 struct device sc_dev; 95 struct target_sync { 96 u_char state; 97 u_char period; 98 u_char offset; 99 } sc_sync[8]; 100 u_char target; /* Currently active target */ 101 u_char lun; 102 struct scsipi_link sc_link; /* proto for sub devices */ 103 sbic_regmap_p sc_sbicp; /* the SBIC */ 104 volatile void *sc_cregs; /* driver specific regs */ 105 int sc_ipl; 106 107 /* Lists of command blocks */ 108 TAILQ_HEAD(acb_list, sbic_acb) free_list, 109 ready_list, 110 nexus_list; 111 112 struct sbic_acb *sc_nexus; /* current command */ 113 struct sbic_acb sc_acb[8]; /* the real command blocks */ 114 struct sbic_tinfo sc_tinfo[8]; 115 116 struct scsipi_xfer *sc_xs; /* transfer from high level code */ 117 u_char sc_flags; 118 u_char sc_stat[2]; 119 u_char sc_msg[7]; 120 u_long sc_clkfreq; 121 u_long sc_tcnt; /* number of bytes transfered */ 122 u_short sc_dmacmd; /* used by dma drivers */ 123 u_long sc_dmamask; /* dma valid mem mask */ 124 #ifdef DEBUG 125 u_short sc_dmatimo; /* dma timeout */ 126 #endif 127 struct dma_chain *sc_cur; 128 struct dma_chain *sc_last; 129 int (*sc_dmago) __P((struct sbic_softc *, char *, int, int)); 130 int (*sc_dmanext) __P((struct sbic_softc *)); 131 void (*sc_enintr) __P((struct sbic_softc *)); 132 void (*sc_dmastop) __P((struct sbic_softc *)); 133 }; 134 135 /* 136 * sc_flags 137 */ 138 #define SBICF_ALIVE 0x01 /* controller initialized */ 139 #define SBICF_DCFLUSH 0x02 /* need flush for overlap after dma finishes */ 140 #define SBICF_SELECTED 0x04 /* bus is in selected state. */ 141 #define SBICF_ICMD 0x08 /* Immediate command in execution */ 142 #define SBICF_BADDMA 0x10 /* controller can only DMA to ztwobus space */ 143 #define SBICF_INTR 0x40 /* SBICF interrupt expected */ 144 #define SBICF_INDMA 0x80 /* not used yet, DMA I/O in progress */ 145 146 /* 147 * sync states 148 */ 149 #define SYNC_START 0 /* no sync handshake started */ 150 #define SYNC_SENT 1 /* we sent sync request, no answer yet */ 151 #define SYNC_DONE 2 /* target accepted our (or inferior) settings, 152 or it rejected the request and we stay async */ 153 154 #define PHASE 0x07 /* mask for psns/pctl phase */ 155 #define DATA_OUT_PHASE 0x00 156 #define DATA_IN_PHASE 0x01 157 #define CMD_PHASE 0x02 158 #define STATUS_PHASE 0x03 159 #define BUS_FREE_PHASE 0x04 160 #define ARB_SEL_PHASE 0x05 /* Fuji chip combines arbitration with sel. */ 161 #define MESG_OUT_PHASE 0x06 162 #define MESG_IN_PHASE 0x07 163 164 #define MSG_CMD_COMPLETE 0x00 165 #define MSG_EXT_MESSAGE 0x01 166 #define MSG_SAVE_DATA_PTR 0x02 167 #define MSG_RESTORE_PTR 0x03 168 #define MSG_DISCONNECT 0x04 169 #define MSG_INIT_DETECT_ERROR 0x05 170 #define MSG_ABORT 0x06 171 #define MSG_REJECT 0x07 172 #define MSG_NOOP 0x08 173 #define MSG_PARITY_ERROR 0x09 174 #define MSG_BUS_DEVICE_RESET 0x0C 175 #define MSG_IDENTIFY 0x80 176 #define MSG_IDENTIFY_DR 0xc0 /* (disconnect/reconnect allowed) */ 177 #define MSG_SYNC_REQ 0x01 178 179 #define MSG_ISIDENTIFY(x) ((x) & MSG_IDENTIFY) 180 181 182 #define STS_CHECKCOND 0x02 /* Check Condition (ie., read sense) */ 183 #define STS_CONDMET 0x04 /* Condition Met (ie., search worked) */ 184 #define STS_BUSY 0x08 185 #define STS_INTERMED 0x10 /* Intermediate status sent */ 186 #define STS_EXT 0x80 /* Extended status valid */ 187 188 189 /* 190 * States returned by our state machine 191 */ 192 193 #define SBIC_STATE_ERROR -1 194 #define SBIC_STATE_DONE 0 195 #define SBIC_STATE_RUNNING 1 196 #define SBIC_STATE_DISCONNECT 2 197 198 199 struct buf; 200 struct scsipi_xfer; 201 202 void sbic_minphys __P((struct buf *bp)); 203 int sbic_scsicmd __P((struct scsipi_xfer *)); 204 205 #endif /* _SBICVAR_H_ */ 206