sbicvar.h revision 1.15 1 /* $NetBSD: sbicvar.h,v 1.15 2000/03/23 06:33:13 thorpej 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 #include <sys/callout.h>
44
45 /*
46 * The largest single request will be MAXPHYS bytes which will require
47 * at most MAXPHYS/NBPG+1 chain elements to describe, i.e. if none of
48 * the buffer pages are physically contiguous (MAXPHYS/NBPG) and the
49 * buffer is not page aligned (+1).
50 */
51 #define DMAMAXIO (MAXPHYS/NBPG+1)
52
53 struct dma_chain {
54 int dc_count;
55 char *dc_addr;
56 };
57
58 /*
59 * ACB. Holds additional information for each SCSI command Comments: We
60 * need a separate scsi command block because we may need to overwrite it
61 * with a request sense command. Basicly, we refrain from fiddling with
62 * the scsipi_xfer struct (except do the expected updating of return values).
63 * We'll generally update: xs->{flags,resid,error,sense,status} and
64 * occasionally xs->retries.
65 */
66 struct sbic_acb {
67 TAILQ_ENTRY(sbic_acb) chain;
68 struct scsipi_xfer *xs; /* SCSI xfer ctrl block from above */
69 int flags; /* Status */
70 #define ACB_FREE 0x00
71 #define ACB_ACTIVE 0x01
72 #define ACB_DONE 0x04
73 #define ACB_CHKSENSE 0x08
74 #define ACB_BBUF 0x10 /* DMA input needs to be copied from bounce */
75 #define ACB_DATAIN 0x20 /* DMA direction flag */
76 struct scsi_generic cmd; /* SCSI command block */
77 int clen;
78 struct dma_chain sc_kv; /* Virtual address of whole DMA */
79 struct dma_chain sc_pa; /* Physical address of DMA segment */
80 u_long sc_tcnt; /* number of bytes for this DMA */
81 u_char *sc_dmausrbuf; /* user buffer kva - for bounce copy */
82 u_long sc_dmausrlen; /* length of bounce copy */
83 u_short sc_dmacmd; /* Internal data for this DMA */
84 char *pa_addr; /* XXXX initial phys addr */
85 u_char *sc_usrbufpa; /* user buffer phys addr */
86 };
87
88 /*
89 * Some info about each (possible) target on the SCSI bus. This should
90 * probably have been a "per target+lunit" structure, but we'll leave it at
91 * this for now. Is there a way to reliably hook it up to sc->fordriver??
92 */
93 struct sbic_tinfo {
94 int cmds; /* #commands processed */
95 int dconns; /* #disconnects */
96 int touts; /* #timeouts */
97 int perrs; /* #parity errors */
98 int senses; /* #request sense commands sent */
99 u_char* bounce; /* Bounce buffer for this device */
100 ushort lubusy; /* What local units/subr. are busy? */
101 u_char flags;
102 u_char period; /* Period suggestion */
103 u_char offset; /* Offset suggestion */
104 } tinfo_t;
105
106 struct sbic_softc {
107 struct device sc_dev;
108 struct isr sc_isr;
109 struct callout sc_timo_ch;
110 struct target_sync {
111 u_char state;
112 u_char period;
113 u_char offset;
114 } sc_sync[8];
115 u_char target; /* Currently active target */
116 u_char lun;
117 struct scsipi_link sc_link; /* proto for sub devices */
118 struct scsipi_adapter sc_adapter;
119 sbic_regmap_t sc_sbic; /* the two SBIC pointers */
120 volatile void *sc_cregs; /* driver specific regs */
121
122 /* Lists of command blocks */
123 TAILQ_HEAD(acb_list, sbic_acb) free_list,
124 ready_list,
125 nexus_list;
126
127 struct sbic_acb *sc_nexus; /* current command */
128 struct sbic_acb sc_acb[8]; /* the real command blocks */
129 struct sbic_tinfo sc_tinfo[8];
130
131 struct scsipi_xfer *sc_xs; /* transfer from high level code */
132 u_char sc_flags;
133 u_char sc_scsiaddr;
134 u_char sc_stat[2];
135 u_char sc_msg[7];
136 u_long sc_clkfreq;
137 u_long sc_tcnt; /* number of bytes transfered */
138 u_short sc_dmacmd; /* used by dma drivers */
139 u_short sc_dmatimo; /* dma timeout */
140 u_long sc_dmamask; /* dma valid mem mask */
141 struct dma_chain *sc_cur;
142 struct dma_chain *sc_last;
143 int (*sc_dmago) __P((struct sbic_softc *, char *, int, int));
144 int (*sc_dmanext) __P((struct sbic_softc *));
145 void (*sc_enintr) __P((struct sbic_softc *));
146 void (*sc_dmastop) __P((struct sbic_softc *));
147 u_short gtsc_bankmask; /* GVP specific bank selected */
148 };
149
150 /* sc_flags */
151 #define SBICF_ALIVE 0x01 /* controller initialized */
152 #define SBICF_DCFLUSH 0x02 /* need flush for overlap after dma finishes */
153 #define SBICF_SELECTED 0x04 /* bus is in selected state. */
154 #define SBICF_ICMD 0x08 /* Immediate command in execution */
155 #define SBICF_BADDMA 0x10 /* controller can only DMA to ztwobus space */
156 #define SBICF_INTR 0x40 /* SBICF interrupt expected */
157 #define SBICF_INDMA 0x80 /* not used yet, DMA I/O in progress */
158
159 /* sync states */
160 #define SYNC_START 0 /* no sync handshake started */
161 #define SYNC_SENT 1 /* we sent sync request, no answer yet */
162 #define SYNC_DONE 2 /* target accepted our (or inferior) settings,
163 or it rejected the request and we stay async */
164 #ifdef DEBUG
165 #define DDB_FOLLOW 0x04
166 #define DDB_IO 0x08
167 #endif
168 extern u_char sbic_inhibit_sync[8];
169 extern int sbic_no_dma;
170 extern int sbic_clock_override;
171
172 #define PHASE 0x07 /* mask for psns/pctl phase */
173 #define DATA_OUT_PHASE 0x00
174 #define DATA_IN_PHASE 0x01
175 #define CMD_PHASE 0x02
176 #define STATUS_PHASE 0x03
177 #define BUS_FREE_PHASE 0x04
178 #define ARB_SEL_PHASE 0x05 /* Fuji chip combines arbitration with sel. */
179 #define MESG_OUT_PHASE 0x06
180 #define MESG_IN_PHASE 0x07
181
182 #define MSG_CMD_COMPLETE 0x00
183 #define MSG_EXT_MESSAGE 0x01
184 #define MSG_SAVE_DATA_PTR 0x02
185 #define MSG_RESTORE_PTR 0x03
186 #define MSG_DISCONNECT 0x04
187 #define MSG_INIT_DETECT_ERROR 0x05
188 #define MSG_ABORT 0x06
189 #define MSG_REJECT 0x07
190 #define MSG_NOOP 0x08
191 #define MSG_PARITY_ERROR 0x09
192 #define MSG_BUS_DEVICE_RESET 0x0C
193 #define MSG_IDENTIFY 0x80
194 #define MSG_IDENTIFY_DR 0xc0 /* (disconnect/reconnect allowed) */
195 #define MSG_SYNC_REQ 0x01
196
197 #define MSG_ISIDENTIFY(x) (x&MSG_IDENTIFY)
198 #define IFY_TRN 0x20
199 #define IFY_LUNTRN(x) (x&0x07)
200 #define IFY_LUN(x) (!(x&0x20))
201
202 /* Check if high bit set */
203
204 #define STS_CHECKCOND 0x02 /* Check Condition (ie., read sense) */
205 #define STS_CONDMET 0x04 /* Condition Met (ie., search worked) */
206 #define STS_BUSY 0x08
207 #define STS_INTERMED 0x10 /* Intermediate status sent */
208 #define STS_EXT 0x80 /* Extended status valid */
209
210
211 /* States returned by our state machine */
212
213 #define SBIC_STATE_ERROR -1
214 #define SBIC_STATE_DONE 0
215 #define SBIC_STATE_RUNNING 1
216 #define SBIC_STATE_DISCONNECT 2
217
218 /*
219 * XXXX
220 */
221 struct scsi_fmt_cdb {
222 int len; /* cdb length (in bytes) */
223 u_char cdb[28]; /* cdb to use on next read/write */
224 };
225
226 struct buf;
227 struct scsipi_xfer;
228
229 void sbic_minphys __P((struct buf *bp));
230 int sbic_scsicmd __P((struct scsipi_xfer *));
231 void sbicinit __P((struct sbic_softc *));
232 int sbicintr __P((struct sbic_softc *));
233 #ifdef DEBUG
234 void sbic_dump __P((struct sbic_softc *dev));
235 #endif
236
237 #endif /* _SBICVAR_H_ */
238