wd33c93var.h revision 1.1 1 /* $NetBSD: wd33c93var.h,v 1.1 2006/08/26 22:06:37 bjh21 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 int avail; /* where to start scanning */
92 u_char state;
93 #define L_STATE_IDLE 0
94 #define L_STATE_BUSY 1
95 #define L_STATE_ESTAT 2
96 struct wd33c93_acb *untagged;
97 struct wd33c93_acb *queued[SBIC_NTAGS];
98 };
99
100 struct wd33c93_tinfo {
101 int cmds; /* # of commands processed */
102 int dconns; /* # of disconnects */
103
104 u_char flags;
105 #define T_NEED_RESET 0x01 /* Should send a BUS_DEV_RESET */
106 #define T_NEGOTIATE 0x02 /* (Re)Negotiate synchronous options */
107 #define T_BUSY 0x04 /* Target is busy */
108 #define T_SYNCMODE 0x08 /* SYNC mode has been negotiated */
109 #define T_NOSYNC 0x10 /* Force ASYNC mode */
110 #define T_NODISC 0x20 /* Don't allow disconnect */
111 #define T_TAG 0x40 /* Turn on TAG QUEUEs */
112 u_char period; /* Period suggestion */
113 u_char offset; /* Offset suggestion */
114 u_char nextag; /* Next available tag */
115 struct wd33c93_linfo *lun[SBIC_NLUN]; /* LUN list for this target */
116 } tinfo_t;
117
118 /* Look up a lun in a tinfo */
119 #define TINFO_LUN(t, l) ((t)->lun[(l)])
120
121 struct wd33c93_softc {
122 struct device sc_dev;
123
124 struct scsipi_channel sc_channel; /* proto for sub devices */
125 struct scsipi_adapter sc_adapter;
126 struct device *sc_child; /* attached scsibus, if any */
127 struct callout sc_watchdog;
128 void *sc_driver; /* driver specific field */
129
130 int target; /* Currently active target */
131 int lun; /* Currently active LUN */
132
133 /* WD33c93 registers */
134 bus_space_tag_t sc_regt;
135 bus_space_handle_t sc_regh;
136
137
138 /* Data about the current nexus (updated for every cmd switch) */
139 caddr_t 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 */
166 int sc_id; /* SCSI ID for controller */
167 int sc_clkfreq; /* wd33c93 clk freq * 10 MHz */
168 int sc_chip; /* Chip variation */
169 int sc_rev; /* Chip revision */
170 int sc_cfflags; /* Copy of config flags */
171 int sc_maxxfer; /* Maximum transfer size */
172 int sc_minsync; /* Minimum sync period (4ns units) */
173 int sc_maxoffset; /* Maximum sync ofset (bytes) */
174
175 int (*sc_dmasetup) (struct wd33c93_softc *, caddr_t *,
176 size_t *, int, size_t *);
177 int (*sc_dmago) (struct wd33c93_softc *);
178 void (*sc_dmastop) (struct wd33c93_softc *);
179 void (*sc_reset) (struct wd33c93_softc *);
180 };
181
182 /* values for sc_flags */
183 #define SBICF_SELECTED 0x01 /* bus is in selected state. */
184 #define SBICF_NODMA 0x02 /* Polled transfer */
185 #define SBICF_INDMA 0x04 /* DMA I/O in progress */
186 #define SBICF_SYNCNEGO 0x08 /* Sync negotiation in progress */
187 #define SBICF_ABORTING 0x10 /* Aborting */
188
189 /* values for sc_state */
190 #define SBIC_UNINITIALIZED 0 /* Driver not initialized */
191 #define SBIC_IDLE 1 /* waiting for something to do */
192 #define SBIC_SELECTING 2 /* SCSI command is arbiting */
193 #define SBIC_RESELECTED 3 /* Has been reselected */
194 #define SBIC_IDENTIFIED 4 /* Has gotten IFY but not TAG */
195 #define SBIC_CONNECTED 5 /* Actively using the SCSI bus */
196 #define SBIC_DISCONNECT 6 /* MSG_DISCONNECT received */
197 #define SBIC_CMDCOMPLETE 7 /* MSG_CMDCOMPLETE received */
198 #define SBIC_ERROR 8 /* Error has occurred */
199 #define SBIC_SELTIMEOUT 9 /* Select Timeout */
200 #define SBIC_CLEANING 10 /* Scrubbing ACB's */
201 #define SBIC_BUSRESET 11 /* SCSI RST has been issued */
202
203 /* values for sc_msgout */
204 #define SEND_DEV_RESET 0x0001
205 #define SEND_PARITY_ERROR 0x0002
206 #define SEND_INIT_DET_ERR 0x0004
207 #define SEND_REJECT 0x0008
208 #define SEND_IDENTIFY 0x0010
209 #define SEND_ABORT 0x0020
210 #define SEND_WDTR 0x0040
211 #define SEND_SDTR 0x0080
212 #define SEND_TAG 0x0100
213
214 /* WD33c93 chipset revisions - values for sc_rev */
215 #define SBIC_CHIP_UNKNOWN 0
216 #define SBIC_CHIP_WD33C93 1
217 #define SBIC_CHIP_WD33C93A 2
218 #define SBIC_CHIP_WD33C93B 3
219
220 #define SBIC_CHIP_LIST {"UNKNOWN", "WD33C93", "WD33C93A", "WD33C93B"}
221
222 /*
223 * States returned by our state machine
224 */
225 #define SBIC_STATE_ERROR -1
226 #define SBIC_STATE_DONE 0
227 #define SBIC_STATE_RUNNING 1
228 #define SBIC_STATE_DISCONNECT 2
229
230 #define DEBUG_ACBS 0x01
231 #define DEBUG_INTS 0x02
232 #define DEBUG_CMDS 0x04
233 #define DEBUG_MISC 0x08
234 #define DEBUG_TRAC 0x10
235 #define DEBUG_RSEL 0x20
236 #define DEBUG_PHASE 0x40
237 #define DEBUG_DMA 0x80
238 #define DEBUG_CCMDS 0x100
239 #define DEBUG_MSGS 0x200
240 #define DEBUG_TAGS 0x400
241 #define DEBUG_SYNC 0x800
242
243 #ifdef DEBUG
244 extern int wd33c93_debug_flags;
245 #define SBIC_DEBUG(level, str) \
246 do { \
247 if (wd33c93_debug & __CONCAT(DEBUG_,level)) \
248 printf str; \
249 } while (0)
250 #else
251 #define SBIC_DEBUG(level, str)
252 #endif
253
254 struct buf;
255 struct scsipi_xfer;
256
257 void wd33c93_minphys (struct buf *);
258 void wd33c93_scsi_request (struct scsipi_channel *,
259 scsipi_adapter_req_t, void *);
260 void wd33c93_attach (struct wd33c93_softc *);
261 int wd33c93_intr (struct wd33c93_softc *);
262
263 #endif /* _SBICVAR_H_ */
264