isp_netbsd.h revision 1.13 1 /* $NetBSD: isp_netbsd.h,v 1.13 1999/04/04 02:29:51 mjacob Exp $ */
2 /* release_4_3_99 */
3 /*
4 * NetBSD Specific definitions for the Qlogic ISP Host Adapter
5 *
6 *---------------------------------------
7 * Copyright (c) 1997, 1998 by Matthew Jacob
8 * NASA/Ames Research Center
9 * All rights reserved.
10 *---------------------------------------
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
15 * 1. Redistributions of source code must retain the above copyright
16 * notice immediately at the beginning of the file, without modification,
17 * this list of conditions, and the following disclaimer.
18 * 2. Redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution.
21 * 3. The name of the author may not be used to endorse or promote products
22 * derived from this software without specific prior written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
28 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * SUCH DAMAGE.
35 *
36 */
37
38 #ifndef _ISP_NETBSD_H
39 #define _ISP_NETBSD_H
40
41 #include <sys/types.h>
42 #include <sys/param.h>
43 #include <sys/systm.h>
44 #include <sys/kernel.h>
45 #include <sys/errno.h>
46 #include <sys/ioctl.h>
47 #include <sys/device.h>
48 #include <sys/malloc.h>
49 #include <sys/buf.h>
50 #include <sys/proc.h>
51 #include <sys/user.h>
52
53
54 #include <dev/scsipi/scsi_all.h>
55 #include <dev/scsipi/scsipi_all.h>
56 #include <dev/scsipi/scsiconf.h>
57
58 #include <dev/scsipi/scsi_message.h>
59 #include <dev/scsipi/scsipi_debug.h>
60
61 #include <vm/vm.h>
62 #include <vm/vm_param.h>
63 #include <vm/pmap.h>
64
65 #define ISP_PLATFORM_VERSION_MAJOR 0
66 #define ISP_PLATFORM_VERSION_MINOR 994
67
68 #define ISP_SCSI_XFER_T struct scsipi_xfer
69 struct isposinfo {
70 struct device _dev;
71 struct scsipi_link _link;
72 struct scsipi_adapter _adapter;
73 int blocked;
74 TAILQ_HEAD(, scsipi_xfer) waitq;
75 };
76 #define MAXISPREQUEST 256
77
78 #include <dev/ic/ispreg.h>
79 #include <dev/ic/ispvar.h>
80 #include <dev/ic/ispmbox.h>
81
82 #define PRINTF printf
83 #define IDPRINTF(lev, x) if (isp->isp_dblev >= lev) printf x
84
85 #define MEMZERO bzero
86 #define MEMCPY(dst, src, count) bcopy((src), (dst), (count))
87 #ifdef __alpha__
88 #define MemoryBarrier alpha_mb
89 #else
90 #define MemoryBarrier()
91 #endif
92
93 #define DMA_MSW(x) (((x) >> 16) & 0xffff)
94 #define DMA_LSW(x) (((x) & 0xffff))
95
96 #if defined(SCSIDEBUG)
97 #define DFLT_DBLEVEL 3
98 #else
99 #if defined(DEBUG)
100 #define DFLT_DBLEVEL 2
101 #else
102 #define DFLT_DBLEVEL 1
103 #endif
104 #endif
105
106 #define ISP_LOCKVAL_DECL int isp_spl_save
107 #define ISP_ILOCKVAL_DECL ISP_LOCKVAL_DECL
108 #define ISP_LOCK(x) isp_spl_save = splbio()
109 #define ISP_UNLOCK(x) (void) splx(isp_spl_save)
110 #define ISP_ILOCK ISP_LOCK
111 #define ISP_IUNLOCK ISP_UNLOCK
112
113
114 #define XS_NULL(xs) xs == NULL || xs->sc_link == NULL
115 #define XS_ISP(xs) (xs)->sc_link->adapter_softc
116 #define XS_LUN(xs) ((int) (xs)->sc_link->scsipi_scsi.lun)
117 #define XS_TGT(xs) ((int) (xs)->sc_link->scsipi_scsi.target)
118 #define XS_RESID(xs) (xs)->resid
119 #define XS_XFRLEN(xs) (xs)->datalen
120 #define XS_CDBLEN(xs) (xs)->cmdlen
121 #define XS_CDBP(xs) (xs)->cmd
122 #define XS_STS(xs) (xs)->status
123 #define XS_TIME(xs) (xs)->timeout
124 #define XS_SNSP(xs) (&(xs)->sense.scsi_sense)
125 #define XS_SNSLEN(xs) (sizeof (xs)->sense.scsi_sense)
126 #define XS_SNSKEY(xs) ((xs)->sense.scsi_sense.flags)
127
128 #define HBA_NOERROR XS_NOERROR
129 #define HBA_BOTCH XS_DRIVER_STUFFUP
130 #define HBA_CMDTIMEOUT XS_TIMEOUT
131 #define HBA_SELTIMEOUT XS_SELTIMEOUT
132 #define HBA_TGTBSY XS_BUSY
133 #ifdef XS_RESET
134 #define HBA_BUSRESET XS_RESET
135 #else
136 #define HBA_BUSRESET XS_DRIVER_STUFFUP
137 #endif
138 #define HBA_ABORTED XS_DRIVER_STUFFUP
139 #define HBA_DATAOVR XS_DRIVER_STUFFUP
140 #define HBA_ARQFAIL XS_DRIVER_STUFFUP
141
142 #define XS_SNS_IS_VALID(xs) (xs)->error = XS_SENSE
143 #define XS_IS_SNS_VALID(xs) ((xs)->error == XS_SENSE)
144
145 #define XS_INITERR(xs) (xs)->error = 0
146 #define XS_SETERR(xs, v) (xs)->error = v
147 #define XS_ERR(xs) (xs)->error
148 #define XS_NOERR(xs) (xs)->error == XS_NOERROR
149
150 #define XS_CMD_DONE(xs) (xs)->flags |= ITSDONE, scsipi_done(xs)
151 #define XS_IS_CMD_DONE(xs) (((xs)->flags & ITSDONE) != 0)
152
153 /*
154 * We use whether or not we're a polled command to decide about tagging.
155 */
156 #define XS_CANTAG(xs) (((xs)->flags & SCSI_POLL) != 0)
157
158 /*
159 * This is our default tag (ordered).
160 */
161 #define XS_KINDOF_TAG(xs) \
162 (((xs)->flags & SCSI_URGENT)? REQFLAG_HTAG : REQFLAG_STAG)
163
164 #define CMD_COMPLETE COMPLETE
165 #define CMD_EAGAIN TRY_AGAIN_LATER
166 #define CMD_QUEUED SUCCESSFULLY_QUEUED
167
168
169
170 #define isp_name isp_osinfo._dev.dv_xname
171
172
173 #define SYS_DELAY(x) delay(x)
174
175 #define WATCH_INTERVAL 30
176
177 #define FC_FW_READY_DELAY (12 * 1000000)
178
179 extern void isp_attach __P((struct ispsoftc *));
180 extern void isp_uninit __P((struct ispsoftc *));
181
182 static inline void isp_prtstst(ispstatusreq_t *sp)
183 {
184 char buf[128];
185 sprintf(buf, "states->");
186 if (sp->req_state_flags & RQSF_GOT_BUS)
187 sprintf(buf, "%s%s", buf, "GOT_BUS ");
188 if (sp->req_state_flags & RQSF_GOT_TARGET)
189 sprintf(buf, "%s%s", buf, "GOT_TGT ");
190 if (sp->req_state_flags & RQSF_SENT_CDB)
191 sprintf(buf, "%s%s", buf, "SENT_CDB ");
192 if (sp->req_state_flags & RQSF_XFRD_DATA)
193 sprintf(buf, "%s%s", buf, "XFRD_DATA ");
194 if (sp->req_state_flags & RQSF_GOT_STATUS)
195 sprintf(buf, "%s%s", buf, "GOT_STS ");
196 if (sp->req_state_flags & RQSF_GOT_SENSE)
197 sprintf(buf, "%s%s", buf, "GOT_SNS ");
198 if (sp->req_state_flags & RQSF_XFER_COMPLETE)
199 sprintf(buf, "%s%s", buf, "XFR_CMPLT ");
200 sprintf(buf, "%s%s", buf, "\n");
201 sprintf(buf, "%s%s", buf, "status->");
202 if (sp->req_status_flags & RQSTF_DISCONNECT)
203 sprintf(buf, "%s%s", buf, "Disconnect ");
204 if (sp->req_status_flags & RQSTF_SYNCHRONOUS)
205 sprintf(buf, "%s%s", buf, "Sync_xfr ");
206 if (sp->req_status_flags & RQSTF_PARITY_ERROR)
207 sprintf(buf, "%s%s", buf, "Parity ");
208 if (sp->req_status_flags & RQSTF_BUS_RESET)
209 sprintf(buf, "%s%s", buf, "Bus_Reset ");
210 if (sp->req_status_flags & RQSTF_DEVICE_RESET)
211 sprintf(buf, "%s%s", buf, "Device_Reset ");
212 if (sp->req_status_flags & RQSTF_ABORTED)
213 sprintf(buf, "%s%s", buf, "Aborted ");
214 if (sp->req_status_flags & RQSTF_TIMEOUT)
215 sprintf(buf, "%s%s", buf, "Timeout ");
216 if (sp->req_status_flags & RQSTF_NEGOTIATION)
217 sprintf(buf, "%s%s", buf, "Negotiation ");
218 sprintf(buf, "%s%s", buf, "\n");
219 }
220
221 static inline const char *isp2100_fw_statename(int state)
222 {
223 static char buf[16];
224 switch(state) {
225 case FW_CONFIG_WAIT: return "Config Wait";
226 case FW_WAIT_AL_PA: return "Waiting for AL_PA";
227 case FW_WAIT_LOGIN: return "Wait Login";
228 case FW_READY: return "Ready";
229 case FW_LOSS_OF_SYNC: return "Loss Of Sync";
230 case FW_ERROR: return "Error";
231 case FW_REINIT: return "Re-Init";
232 case FW_NON_PART: return "Nonparticipating";
233 default:
234 sprintf(buf, "?0x%x?", state);
235 return buf;
236 }
237 }
238
239 static inline const char *isp2100_pdb_statename(int pdb_state)
240 {
241 static char buf[16];
242 switch(pdb_state) {
243 case PDB_STATE_DISCOVERY: return "Port Discovery";
244 case PDB_STATE_WDISC_ACK: return "Waiting Port Discovery ACK";
245 case PDB_STATE_PLOGI: return "Port Login";
246 case PDB_STATE_PLOGI_ACK: return "Wait Port Login ACK";
247 case PDB_STATE_PRLI: return "Process Login";
248 case PDB_STATE_PRLI_ACK: return "Wait Process Login ACK";
249 case PDB_STATE_LOGGED_IN: return "Logged In";
250 case PDB_STATE_PORT_UNAVAIL: return "Port Unavailable";
251 case PDB_STATE_PRLO: return "Process Logout";
252 case PDB_STATE_PRLO_ACK: return "Wait Process Logout ACK";
253 case PDB_STATE_PLOGO: return "Port Logout";
254 case PDB_STATE_PLOG_ACK: return "Wait Port Logout ACK";
255 default:
256 sprintf(buf, "?0x%x?", pdb_state);
257 return buf;
258 }
259 }
260
261 /*
262 * Keep these off for now...
263 */
264
265 #define ISP_NO_FASTPOST_SCSI 1
266 #define ISP_NO_FASTPOST_FC 1
267
268 #endif /* _ISP_NETBSD_H */
269