ispvar.h revision 1.67.24.1 1 1.67.24.1 keiichi /* $NetBSD: ispvar.h,v 1.67.24.1 2008/03/24 07:15:17 keiichi Exp $ */
2 1.34 mjacob /*
3 1.66 mjacob * Copyright (C) 1999 National Aeronautics & Space Administration
4 1.66 mjacob * All rights reserved.
5 1.34 mjacob *
6 1.66 mjacob * Additional Copyright (C) 2000-2007 by Matthew Jacob
7 1.23 mjacob * All rights reserved.
8 1.1 cgd *
9 1.1 cgd * Redistribution and use in source and binary forms, with or without
10 1.1 cgd * modification, are permitted provided that the following conditions
11 1.1 cgd * are met:
12 1.1 cgd * 1. Redistributions of source code must retain the above copyright
13 1.23 mjacob * notice, this list of conditions and the following disclaimer.
14 1.1 cgd * 2. Redistributions in binary form must reproduce the above copyright
15 1.1 cgd * notice, this list of conditions and the following disclaimer in the
16 1.1 cgd * documentation and/or other materials provided with the distribution.
17 1.1 cgd * 3. The name of the author may not be used to endorse or promote products
18 1.23 mjacob * derived from this software without specific prior written permission
19 1.9 mjacob *
20 1.23 mjacob * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
21 1.23 mjacob * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
22 1.23 mjacob * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
23 1.23 mjacob * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
24 1.23 mjacob * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
25 1.23 mjacob * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 1.23 mjacob * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 1.23 mjacob * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 1.23 mjacob * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
29 1.23 mjacob * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 1.1 cgd */
31 1.66 mjacob /*
32 1.66 mjacob * Additional Copyright (c) 1997-2006 by Matthew Jacob
33 1.66 mjacob * All rights reserved.
34 1.66 mjacob *
35 1.66 mjacob * Redistribution and use in source and binary forms, with or without
36 1.66 mjacob * modification, are permitted provided that the following conditions
37 1.66 mjacob * are met:
38 1.66 mjacob *
39 1.66 mjacob * 1. Redistributions of source code must retain the above copyright
40 1.66 mjacob * notice, this list of conditions, and the following disclaimer,
41 1.66 mjacob * without modification, immediately at the beginning of the file.
42 1.66 mjacob * 2. The name of the author may not be used to endorse or promote products
43 1.66 mjacob * derived from this software without specific prior written permission.
44 1.66 mjacob *
45 1.66 mjacob * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
46 1.66 mjacob * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
47 1.66 mjacob * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
48 1.66 mjacob * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
49 1.66 mjacob * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
50 1.66 mjacob * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
51 1.66 mjacob * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
52 1.66 mjacob * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
53 1.66 mjacob * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
54 1.66 mjacob * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
55 1.66 mjacob * SUCH DAMAGE.
56 1.66 mjacob */
57 1.23 mjacob /*
58 1.23 mjacob * Soft Definitions for for Qlogic ISP SCSI adapters.
59 1.23 mjacob */
60 1.66 mjacob
61 1.1 cgd #ifndef _ISPVAR_H
62 1.1 cgd #define _ISPVAR_H
63 1.1 cgd
64 1.19 mjacob #if defined(__NetBSD__) || defined(__OpenBSD__)
65 1.66 mjacob #include <dev/ic/isp_stds.h>
66 1.1 cgd #include <dev/ic/ispmbox.h>
67 1.9 mjacob #endif
68 1.9 mjacob #ifdef __FreeBSD__
69 1.66 mjacob #include <dev/isp/isp_stds.h>
70 1.9 mjacob #include <dev/isp/ispmbox.h>
71 1.9 mjacob #endif
72 1.9 mjacob #ifdef __linux__
73 1.66 mjacob #include "isp_stds.h"
74 1.15 mjacob #include "ispmbox.h"
75 1.26 mjacob #endif
76 1.66 mjacob #ifdef __svr4__
77 1.66 mjacob #include "isp_stds.h"
78 1.66 mjacob #include "ispmbox.h"
79 1.9 mjacob #endif
80 1.1 cgd
81 1.67.24.1 keiichi #define ISP_CORE_VERSION_MAJOR 5
82 1.66 mjacob #define ISP_CORE_VERSION_MINOR 0
83 1.10 mjacob
84 1.1 cgd /*
85 1.17 mjacob * Vector for bus specific code to provide specific services.
86 1.1 cgd */
87 1.66 mjacob typedef struct ispsoftc ispsoftc_t;
88 1.1 cgd struct ispmdvec {
89 1.48 mjacob int (*dv_rd_isr)
90 1.66 mjacob (ispsoftc_t *, uint32_t *, uint16_t *, uint16_t *);
91 1.66 mjacob uint32_t (*dv_rd_reg) (ispsoftc_t *, int);
92 1.66 mjacob void (*dv_wr_reg) (ispsoftc_t *, int, uint32_t);
93 1.66 mjacob int (*dv_mbxdma) (ispsoftc_t *);
94 1.66 mjacob int (*dv_dmaset)
95 1.66 mjacob (ispsoftc_t *, XS_T *, ispreq_t *, uint32_t *, uint32_t);
96 1.66 mjacob void (*dv_dmaclr) (ispsoftc_t *, XS_T *, uint32_t);
97 1.66 mjacob void (*dv_reset0) (ispsoftc_t *);
98 1.66 mjacob void (*dv_reset1) (ispsoftc_t *);
99 1.66 mjacob void (*dv_dregs) (ispsoftc_t *, const char *);
100 1.66 mjacob const void * dv_ispfw; /* ptr to f/w */
101 1.66 mjacob uint16_t dv_conf1;
102 1.66 mjacob uint16_t dv_clock; /* clock frequency */
103 1.1 cgd };
104 1.1 cgd
105 1.32 mjacob /*
106 1.32 mjacob * Overall parameters
107 1.32 mjacob */
108 1.48 mjacob #define MAX_TARGETS 16
109 1.66 mjacob #define MAX_FC_TARG 512
110 1.24 mjacob #define ISP_MAX_TARGETS(isp) (IS_FC(isp)? MAX_FC_TARG : MAX_TARGETS)
111 1.31 mjacob #define ISP_MAX_LUNS(isp) (isp)->isp_maxluns
112 1.24 mjacob
113 1.48 mjacob /*
114 1.32 mjacob * Macros to access ISP registers through bus specific layers-
115 1.32 mjacob * mostly wrappers to vector through the mdvec structure.
116 1.26 mjacob */
117 1.48 mjacob #define ISP_READ_ISR(isp, isrp, semap, mbox0p) \
118 1.48 mjacob (*(isp)->isp_mdvec->dv_rd_isr)(isp, isrp, semap, mbox0p)
119 1.26 mjacob
120 1.26 mjacob #define ISP_READ(isp, reg) \
121 1.26 mjacob (*(isp)->isp_mdvec->dv_rd_reg)((isp), (reg))
122 1.26 mjacob
123 1.26 mjacob #define ISP_WRITE(isp, reg, val) \
124 1.26 mjacob (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), (val))
125 1.26 mjacob
126 1.26 mjacob #define ISP_MBOXDMASETUP(isp) \
127 1.26 mjacob (*(isp)->isp_mdvec->dv_mbxdma)((isp))
128 1.26 mjacob
129 1.26 mjacob #define ISP_DMASETUP(isp, xs, req, iptrp, optr) \
130 1.26 mjacob (*(isp)->isp_mdvec->dv_dmaset)((isp), (xs), (req), (iptrp), (optr))
131 1.26 mjacob
132 1.66 mjacob #define ISP_DMAFREE(isp, xs, hndl) \
133 1.66 mjacob if ((isp)->isp_mdvec->dv_dmaclr) \
134 1.26 mjacob (*(isp)->isp_mdvec->dv_dmaclr)((isp), (xs), (hndl))
135 1.26 mjacob
136 1.26 mjacob #define ISP_RESET0(isp) \
137 1.26 mjacob if ((isp)->isp_mdvec->dv_reset0) (*(isp)->isp_mdvec->dv_reset0)((isp))
138 1.26 mjacob #define ISP_RESET1(isp) \
139 1.26 mjacob if ((isp)->isp_mdvec->dv_reset1) (*(isp)->isp_mdvec->dv_reset1)((isp))
140 1.32 mjacob #define ISP_DUMPREGS(isp, m) \
141 1.32 mjacob if ((isp)->isp_mdvec->dv_dregs) (*(isp)->isp_mdvec->dv_dregs)((isp),(m))
142 1.26 mjacob
143 1.26 mjacob #define ISP_SETBITS(isp, reg, val) \
144 1.26 mjacob (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), ISP_READ((isp), (reg)) | (val))
145 1.26 mjacob
146 1.26 mjacob #define ISP_CLRBITS(isp, reg, val) \
147 1.26 mjacob (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), ISP_READ((isp), (reg)) & ~(val))
148 1.26 mjacob
149 1.32 mjacob /*
150 1.32 mjacob * The MEMORYBARRIER macro is defined per platform (to provide synchronization
151 1.32 mjacob * on Request and Response Queues, Scratch DMA areas, and Registers)
152 1.32 mjacob *
153 1.32 mjacob * Defined Memory Barrier Synchronization Types
154 1.32 mjacob */
155 1.32 mjacob #define SYNC_REQUEST 0 /* request queue synchronization */
156 1.32 mjacob #define SYNC_RESULT 1 /* result queue synchronization */
157 1.32 mjacob #define SYNC_SFORDEV 2 /* scratch, sync for ISP */
158 1.32 mjacob #define SYNC_SFORCPU 3 /* scratch, sync for CPU */
159 1.32 mjacob #define SYNC_REG 4 /* for registers */
160 1.66 mjacob #define SYNC_ATIOQ 5 /* atio result queue (24xx) */
161 1.32 mjacob
162 1.32 mjacob /*
163 1.32 mjacob * Request/Response Queue defines and macros.
164 1.32 mjacob * The maximum is defined per platform (and can be based on board type).
165 1.32 mjacob */
166 1.32 mjacob /* This is the size of a queue entry (request and response) */
167 1.11 mjacob #define QENTRY_LEN 64
168 1.32 mjacob /* Both request and result queue length must be a power of two */
169 1.32 mjacob #define RQUEST_QUEUE_LEN(x) MAXISPREQUEST(x)
170 1.55 mjacob #ifdef ISP_TARGET_MODE
171 1.55 mjacob #define RESULT_QUEUE_LEN(x) MAXISPREQUEST(x)
172 1.55 mjacob #else
173 1.32 mjacob #define RESULT_QUEUE_LEN(x) \
174 1.32 mjacob (((MAXISPREQUEST(x) >> 2) < 64)? 64 : MAXISPREQUEST(x) >> 2)
175 1.55 mjacob #endif
176 1.66 mjacob #define ISP_QUEUE_ENTRY(q, idx) (((uint8_t *)q) + ((idx) * QENTRY_LEN))
177 1.11 mjacob #define ISP_QUEUE_SIZE(n) ((n) * QENTRY_LEN)
178 1.11 mjacob #define ISP_NXT_QENTRY(idx, qlen) (((idx) + 1) & ((qlen)-1))
179 1.34 mjacob #define ISP_QFREE(in, out, qlen) \
180 1.13 mjacob ((in == out)? (qlen - 1) : ((in > out)? \
181 1.25 mjacob ((qlen - 1) - (in - out)) : (out - in - 1)))
182 1.34 mjacob #define ISP_QAVAIL(isp) \
183 1.34 mjacob ISP_QFREE(isp->isp_reqidx, isp->isp_reqodx, RQUEST_QUEUE_LEN(isp))
184 1.26 mjacob
185 1.51 mjacob #define ISP_ADD_REQUEST(isp, nxti) \
186 1.51 mjacob MEMORYBARRIER(isp, SYNC_REQUEST, isp->isp_reqidx, QENTRY_LEN); \
187 1.66 mjacob ISP_WRITE(isp, isp->isp_rqstinrp, nxti); \
188 1.51 mjacob isp->isp_reqidx = nxti
189 1.26 mjacob
190 1.1 cgd /*
191 1.22 mjacob * SCSI Specific Host Adapter Parameters- per bus, per target
192 1.6 mjacob */
193 1.6 mjacob typedef struct {
194 1.67.24.1 keiichi uint32_t : 8,
195 1.67.24.1 keiichi update : 1,
196 1.67.24.1 keiichi sendmarker : 1,
197 1.67.24.1 keiichi role : 2,
198 1.25 mjacob isp_req_ack_active_neg : 1,
199 1.25 mjacob isp_data_line_active_neg: 1,
200 1.6 mjacob isp_cmd_dma_burst_enable: 1,
201 1.6 mjacob isp_data_dma_burst_enabl: 1,
202 1.16 mjacob isp_fifo_threshold : 3,
203 1.66 mjacob isp_ptisp : 1,
204 1.17 mjacob isp_ultramode : 1,
205 1.6 mjacob isp_diffmode : 1,
206 1.20 mjacob isp_lvdmode : 1,
207 1.33 mjacob isp_fast_mttr : 1, /* fast sram */
208 1.6 mjacob isp_initiator_id : 4,
209 1.25 mjacob isp_async_data_setup : 4;
210 1.66 mjacob uint16_t isp_selection_timeout;
211 1.66 mjacob uint16_t isp_max_queue_depth;
212 1.66 mjacob uint8_t isp_tag_aging;
213 1.66 mjacob uint8_t isp_bus_reset_delay;
214 1.66 mjacob uint8_t isp_retry_count;
215 1.66 mjacob uint8_t isp_retry_delay;
216 1.6 mjacob struct {
217 1.66 mjacob uint32_t
218 1.48 mjacob exc_throttle : 8,
219 1.22 mjacob : 1,
220 1.48 mjacob dev_enable : 1, /* ignored */
221 1.17 mjacob dev_update : 1,
222 1.17 mjacob dev_refresh : 1,
223 1.48 mjacob actv_offset : 4,
224 1.48 mjacob goal_offset : 4,
225 1.48 mjacob nvrm_offset : 4;
226 1.66 mjacob uint8_t actv_period; /* current sync period */
227 1.66 mjacob uint8_t goal_period; /* goal sync period */
228 1.66 mjacob uint8_t nvrm_period; /* nvram sync period */
229 1.66 mjacob uint16_t actv_flags; /* current device flags */
230 1.66 mjacob uint16_t goal_flags; /* goal device flags */
231 1.66 mjacob uint16_t nvrm_flags; /* nvram device flags */
232 1.6 mjacob } isp_devparam[MAX_TARGETS];
233 1.22 mjacob } sdparam;
234 1.6 mjacob
235 1.6 mjacob /*
236 1.6 mjacob * Device Flags
237 1.6 mjacob */
238 1.11 mjacob #define DPARM_DISC 0x8000
239 1.11 mjacob #define DPARM_PARITY 0x4000
240 1.11 mjacob #define DPARM_WIDE 0x2000
241 1.11 mjacob #define DPARM_SYNC 0x1000
242 1.11 mjacob #define DPARM_TQING 0x0800
243 1.11 mjacob #define DPARM_ARQ 0x0400
244 1.11 mjacob #define DPARM_QFRZ 0x0200
245 1.11 mjacob #define DPARM_RENEG 0x0100
246 1.33 mjacob #define DPARM_NARROW 0x0080
247 1.33 mjacob #define DPARM_ASYNC 0x0040
248 1.33 mjacob #define DPARM_PPR 0x0020
249 1.18 mjacob #define DPARM_DEFAULT (0xFF00 & ~DPARM_QFRZ)
250 1.11 mjacob #define DPARM_SAFE_DFLT (DPARM_DEFAULT & ~(DPARM_WIDE|DPARM_SYNC|DPARM_TQING))
251 1.11 mjacob
252 1.20 mjacob /* technically, not really correct, as they need to be rated based upon clock */
253 1.33 mjacob #define ISP_80M_SYNCPARMS 0x0c09
254 1.33 mjacob #define ISP_40M_SYNCPARMS 0x0c0a
255 1.33 mjacob #define ISP_20M_SYNCPARMS 0x0c0c
256 1.33 mjacob #define ISP_20M_SYNCPARMS_1040 0x080c
257 1.25 mjacob #define ISP_10M_SYNCPARMS 0x0c19
258 1.25 mjacob #define ISP_08M_SYNCPARMS 0x0c25
259 1.25 mjacob #define ISP_05M_SYNCPARMS 0x0c32
260 1.25 mjacob #define ISP_04M_SYNCPARMS 0x0c41
261 1.6 mjacob
262 1.6 mjacob /*
263 1.6 mjacob * Fibre Channel Specifics
264 1.6 mjacob */
265 1.66 mjacob /* These are for non-2K Login Firmware cards */
266 1.66 mjacob #define FL_ID 0x7e /* FL_Port Special ID */
267 1.66 mjacob #define SNS_ID 0x80 /* SNS Server Special ID */
268 1.66 mjacob #define NPH_MAX 0xfe
269 1.66 mjacob
270 1.67.24.1 keiichi /* Use this handle for the base for multi-id firmware SNS logins */
271 1.67.24.1 keiichi #define NPH_SNS_HDLBASE 0x400
272 1.67.24.1 keiichi
273 1.66 mjacob /* These are for 2K Login Firmware cards */
274 1.66 mjacob #define NPH_RESERVED 0x7F0 /* begin of reserved N-port handles */
275 1.66 mjacob #define NPH_MGT_ID 0x7FA /* Management Server Special ID */
276 1.66 mjacob #define NPH_SNS_ID 0x7FC /* SNS Server Special ID */
277 1.67.24.1 keiichi #define NPH_FABRIC_CTLR 0x7FD /* Fabric Controller (0xFFFFFD) */
278 1.67.24.1 keiichi #define NPH_FL_ID 0x7FE /* F Port Special ID (0xFFFFFE) */
279 1.67.24.1 keiichi #define NPH_IP_BCST 0x7ff /* IP Broadcast Special ID (0xFFFFFF) */
280 1.66 mjacob #define NPH_MAX_2K 0x800
281 1.66 mjacob
282 1.66 mjacob /*
283 1.66 mjacob * "Unassigned" handle to be used internally
284 1.66 mjacob */
285 1.66 mjacob #define NIL_HANDLE 0xffff
286 1.66 mjacob
287 1.66 mjacob /*
288 1.66 mjacob * Limit for devices on an arbitrated loop.
289 1.66 mjacob */
290 1.66 mjacob #define LOCAL_LOOP_LIM 126
291 1.66 mjacob
292 1.66 mjacob /*
293 1.67.24.1 keiichi * Special Constants
294 1.67.24.1 keiichi */
295 1.67.24.1 keiichi #define INI_NONE ((uint64_t) 0)
296 1.67.24.1 keiichi #define INI_ANY ((uint64_t) -1)
297 1.67.24.1 keiichi #define VALID_INI(ini) (ini != INI_NONE && ini != INI_ANY)
298 1.67.24.1 keiichi
299 1.67.24.1 keiichi /*
300 1.66 mjacob * Special Port IDs
301 1.66 mjacob */
302 1.66 mjacob #define MANAGEMENT_PORT_ID 0xFFFFFA
303 1.66 mjacob #define SNS_PORT_ID 0xFFFFFC
304 1.66 mjacob #define FABRIC_PORT_ID 0xFFFFFE
305 1.67.24.1 keiichi #define PORT_ANY 0xFFFFFF
306 1.67.24.1 keiichi #define PORT_NONE 0
307 1.67.24.1 keiichi #define DOMAIN_CONTROLLER_BASE 0xFFFC00
308 1.67.24.1 keiichi #define DOMAIN_CONTROLLER_END 0xFFFCFF
309 1.66 mjacob
310 1.66 mjacob
311 1.66 mjacob /*
312 1.66 mjacob * FC Port Database entry.
313 1.66 mjacob *
314 1.66 mjacob * It has a handle that the f/w uses to address commands to a device.
315 1.66 mjacob * This handle's value may be assigned by the firmware (e.g., for local loop
316 1.66 mjacob * devices) or by the driver (e.g., for fabric devices).
317 1.66 mjacob *
318 1.66 mjacob * It has a state. If the state if VALID, that means that we've logged into
319 1.66 mjacob * the device. We also *may* have a initiator map index entry. This is a value
320 1.66 mjacob * from 0..MAX_FC_TARG that is used to index into the isp_ini_map array. If
321 1.66 mjacob * the value therein is non-zero, then that value minus one is used to index
322 1.66 mjacob * into the Port Database to find the handle for forming commands. There is
323 1.66 mjacob * back-index minus one value within to Port Database entry that tells us
324 1.66 mjacob * which entry in isp_ini_map points to us (to avoid searching).
325 1.66 mjacob *
326 1.66 mjacob * Local loop devices the firmware automatically performs PLOGI on for us
327 1.66 mjacob * (which is why that handle is imposed upon us). Fabric devices we assign
328 1.66 mjacob * a handle to and perform the PLOGI on.
329 1.66 mjacob *
330 1.66 mjacob * When a PORT DATABASE CHANGED asynchronous event occurs, we mark all VALID
331 1.66 mjacob * entries as PROBATIONAL. This allows us, if policy says to, just keep track
332 1.66 mjacob * of devices whose handles change but are otherwise the same device (and
333 1.66 mjacob * thus keep 'target' constant).
334 1.66 mjacob *
335 1.66 mjacob * In any case, we search all possible local loop handles. For each one that
336 1.66 mjacob * has a port database entity returned, we search for any PROBATIONAL entry
337 1.66 mjacob * that matches it and update as appropriate. Otherwise, as a new entry, we
338 1.66 mjacob * find room for it in the Port Database. We *try* and use the handle as the
339 1.66 mjacob * index to put it into the Database, but that's just an optimization. We mark
340 1.66 mjacob * the entry VALID and make sure that the target index is updated and correct.
341 1.66 mjacob *
342 1.66 mjacob * When we get done searching the local loop, we then search similarily for
343 1.66 mjacob * a list of devices we've gotten from the fabric name controller (if we're
344 1.66 mjacob * on a fabric). VALID marking is also done similarily.
345 1.66 mjacob *
346 1.66 mjacob * When all of this is done, we can march through the database and clean up
347 1.66 mjacob * any entry that is still PROBATIONAL (these represent devices which have
348 1.66 mjacob * departed). Then we're done and can resume normal operations.
349 1.66 mjacob *
350 1.66 mjacob * Negative invariants that we try and test for are:
351 1.66 mjacob *
352 1.66 mjacob * + There can never be two non-NIL entries with the same { Port, Node } WWN
353 1.66 mjacob * duples.
354 1.66 mjacob *
355 1.66 mjacob * + There can never be two non-NIL entries with the same handle.
356 1.66 mjacob *
357 1.66 mjacob * + There can never be two non-NIL entries which have the same ini_map_idx
358 1.66 mjacob * value.
359 1.66 mjacob */
360 1.66 mjacob typedef struct {
361 1.66 mjacob /*
362 1.66 mjacob * This is the handle that the firmware needs in order for us to
363 1.66 mjacob * send commands to the device. For pre-24XX cards, this would be
364 1.66 mjacob * the 'loopid'.
365 1.66 mjacob */
366 1.66 mjacob uint16_t handle;
367 1.67.24.1 keiichi
368 1.66 mjacob /*
369 1.66 mjacob * The ini_map_idx, if nonzero, is the system virtual target ID (+1)
370 1.66 mjacob * as a cross-reference with the isp_ini_map.
371 1.66 mjacob *
372 1.66 mjacob * A device is 'autologin' if the firmware automatically logs into
373 1.66 mjacob * it (re-logins as needed). Basically, local private loop devices.
374 1.66 mjacob *
375 1.67.24.1 keiichi * The state is the current state of this entry.
376 1.66 mjacob *
377 1.66 mjacob * Role is Initiator, Target, Both
378 1.66 mjacob *
379 1.67.24.1 keiichi * Portid is obvious, as are node && port WWNs. The new_role and
380 1.66 mjacob * new_portid is for when we are pending a change.
381 1.67.24.1 keiichi *
382 1.67.24.1 keiichi * The 'target_mode' tag means that this entry arrived via a
383 1.67.24.1 keiichi * target mode command and is immune from normal flushing rules.
384 1.67.24.1 keiichi * You should also never see anything with no initiator role
385 1.67.24.1 keiichi * with this set.
386 1.66 mjacob */
387 1.66 mjacob uint16_t ini_map_idx : 12,
388 1.66 mjacob autologin : 1, /* F/W does PLOGI/PLOGO */
389 1.66 mjacob state : 3;
390 1.67.24.1 keiichi uint32_t reserved : 5,
391 1.67.24.1 keiichi target_mode : 1,
392 1.66 mjacob roles : 2,
393 1.66 mjacob portid : 24;
394 1.66 mjacob uint32_t new_reserved : 6,
395 1.66 mjacob new_roles : 2,
396 1.66 mjacob new_portid : 24;
397 1.66 mjacob uint64_t node_wwn;
398 1.66 mjacob uint64_t port_wwn;
399 1.66 mjacob } fcportdb_t;
400 1.66 mjacob
401 1.66 mjacob #define FC_PORTDB_STATE_NIL 0
402 1.66 mjacob #define FC_PORTDB_STATE_PROBATIONAL 1
403 1.66 mjacob #define FC_PORTDB_STATE_DEAD 2
404 1.66 mjacob #define FC_PORTDB_STATE_CHANGED 3
405 1.66 mjacob #define FC_PORTDB_STATE_NEW 4
406 1.66 mjacob #define FC_PORTDB_STATE_PENDING_VALID 5
407 1.66 mjacob #define FC_PORTDB_STATE_ZOMBIE 6
408 1.66 mjacob #define FC_PORTDB_STATE_VALID 7
409 1.55 mjacob
410 1.66 mjacob /*
411 1.66 mjacob * FC card specific information
412 1.67.24.1 keiichi *
413 1.67.24.1 keiichi * This structure is replicated across multiple channels for multi-id
414 1.67.24.1 keiichi * capapble chipsets, with some entities different on a per-channel basis.
415 1.66 mjacob */
416 1.67.24.1 keiichi
417 1.6 mjacob typedef struct {
418 1.67.24.1 keiichi uint32_t : 11,
419 1.67.24.1 keiichi npiv_fabric : 1,
420 1.67.24.1 keiichi inorder : 1,
421 1.67.24.1 keiichi sendmarker : 1,
422 1.67.24.1 keiichi role : 2,
423 1.67.24.1 keiichi isp_gbspeed : 4,
424 1.46 mjacob isp_loopstate : 4, /* Current Loop State */
425 1.66 mjacob isp_fwstate : 4, /* ISP F/W state */
426 1.67.24.1 keiichi isp_topo : 3, /* Connection Type */
427 1.66 mjacob loop_seen_once : 1;
428 1.67.24.1 keiichi
429 1.66 mjacob uint32_t : 8,
430 1.66 mjacob isp_portid : 24; /* S_ID */
431 1.67.24.1 keiichi
432 1.67.24.1 keiichi
433 1.66 mjacob uint16_t isp_fwoptions;
434 1.66 mjacob uint16_t isp_xfwoptions;
435 1.66 mjacob uint16_t isp_zfwoptions;
436 1.67.24.1 keiichi uint16_t isp_loopid; /* hard loop id */
437 1.67.24.1 keiichi uint16_t isp_sns_hdl; /* N-port handle for SNS */
438 1.67.24.1 keiichi uint16_t isp_lasthdl; /* only valid for channel 0 */
439 1.67.24.1 keiichi uint16_t isp_maxalloc;
440 1.66 mjacob uint8_t isp_retry_delay;
441 1.66 mjacob uint8_t isp_retry_count;
442 1.67.24.1 keiichi
443 1.67.24.1 keiichi /*
444 1.67.24.1 keiichi * Current active WWNN/WWPN
445 1.67.24.1 keiichi */
446 1.67.24.1 keiichi uint64_t isp_wwnn;
447 1.67.24.1 keiichi uint64_t isp_wwpn;
448 1.67.24.1 keiichi
449 1.67.24.1 keiichi /*
450 1.67.24.1 keiichi * NVRAM WWNN/WWPN
451 1.67.24.1 keiichi */
452 1.66 mjacob uint64_t isp_wwnn_nvram;
453 1.66 mjacob uint64_t isp_wwpn_nvram;
454 1.66 mjacob
455 1.66 mjacob /*
456 1.66 mjacob * Our Port Data Base
457 1.66 mjacob */
458 1.66 mjacob fcportdb_t portdb[MAX_FC_TARG];
459 1.66 mjacob
460 1.66 mjacob /*
461 1.66 mjacob * This maps system virtual 'target' id to a portdb entry.
462 1.66 mjacob *
463 1.66 mjacob * The mapping function is to take any non-zero entry and
464 1.66 mjacob * subtract one to get the portdb index. This means that
465 1.66 mjacob * entries which are zero are unmapped (i.e., don't exist).
466 1.66 mjacob */
467 1.66 mjacob uint16_t isp_ini_map[MAX_FC_TARG];
468 1.19 mjacob
469 1.19 mjacob /*
470 1.6 mjacob * Scratch DMA mapped in area to fetch Port Database stuff, etc.
471 1.6 mjacob */
472 1.65 christos void * isp_scratch;
473 1.66 mjacob XS_DMA_ADDR_T isp_scdma;
474 1.6 mjacob } fcparam;
475 1.6 mjacob
476 1.23 mjacob #define FW_CONFIG_WAIT 0
477 1.23 mjacob #define FW_WAIT_AL_PA 1
478 1.23 mjacob #define FW_WAIT_LOGIN 2
479 1.23 mjacob #define FW_READY 3
480 1.23 mjacob #define FW_LOSS_OF_SYNC 4
481 1.23 mjacob #define FW_ERROR 5
482 1.23 mjacob #define FW_REINIT 6
483 1.23 mjacob #define FW_NON_PART 7
484 1.23 mjacob
485 1.23 mjacob #define LOOP_NIL 0
486 1.23 mjacob #define LOOP_LIP_RCVD 1
487 1.23 mjacob #define LOOP_PDB_RCVD 2
488 1.66 mjacob #define LOOP_SCANNING_LOOP 3
489 1.66 mjacob #define LOOP_LSCAN_DONE 4
490 1.66 mjacob #define LOOP_SCANNING_FABRIC 5
491 1.66 mjacob #define LOOP_FSCAN_DONE 6
492 1.46 mjacob #define LOOP_SYNCING_PDB 7
493 1.46 mjacob #define LOOP_READY 8
494 1.30 he
495 1.30 he #define TOPO_NL_PORT 0
496 1.30 he #define TOPO_FL_PORT 1
497 1.30 he #define TOPO_N_PORT 2
498 1.30 he #define TOPO_F_PORT 3
499 1.30 he #define TOPO_PTP_STUB 4
500 1.23 mjacob
501 1.6 mjacob /*
502 1.1 cgd * Soft Structure per host adapter
503 1.1 cgd */
504 1.66 mjacob struct ispsoftc {
505 1.9 mjacob /*
506 1.9 mjacob * Platform (OS) specific data
507 1.9 mjacob */
508 1.9 mjacob struct isposinfo isp_osinfo;
509 1.9 mjacob
510 1.9 mjacob /*
511 1.26 mjacob * Pointer to bus specific functions and data
512 1.9 mjacob */
513 1.1 cgd struct ispmdvec * isp_mdvec;
514 1.9 mjacob
515 1.9 mjacob /*
516 1.26 mjacob * (Mostly) nonvolatile state. Board specific parameters
517 1.26 mjacob * may contain some volatile state (e.g., current loop state).
518 1.9 mjacob */
519 1.9 mjacob
520 1.66 mjacob void * isp_param; /* type specific */
521 1.66 mjacob uint16_t isp_fwrev[3]; /* Loaded F/W revision */
522 1.66 mjacob uint16_t isp_maxcmds; /* max possible I/O cmds */
523 1.66 mjacob uint8_t isp_type; /* HBA Chip Type */
524 1.66 mjacob uint8_t isp_revision; /* HBA Chip H/W Revision */
525 1.66 mjacob uint32_t isp_maxluns; /* maximum luns supported */
526 1.26 mjacob
527 1.66 mjacob uint32_t isp_clock : 8, /* input clock */
528 1.53 mjacob : 4,
529 1.66 mjacob isp_port : 1, /* 23XX/24XX only */
530 1.51 mjacob isp_open : 1, /* opened (ioctl) */
531 1.26 mjacob isp_bustype : 1, /* SBus or PCI */
532 1.33 mjacob isp_loaded_fw : 1, /* loaded firmware */
533 1.67.24.1 keiichi isp_dblev : 16; /* debug log mask */
534 1.41 mjacob
535 1.67.24.1 keiichi uint16_t isp_fwattr; /* firmware attributes */
536 1.67.24.1 keiichi uint16_t isp_nchan; /* number of channels */
537 1.67.24.1 keiichi
538 1.67.24.1 keiichi uint32_t isp_confopts; /* config options */
539 1.41 mjacob
540 1.66 mjacob uint32_t isp_rqstinrp; /* register for REQINP */
541 1.66 mjacob uint32_t isp_rqstoutrp; /* register for REQOUTP */
542 1.66 mjacob uint32_t isp_respinrp; /* register for RESINP */
543 1.66 mjacob uint32_t isp_respoutrp; /* register for RESOUTP */
544 1.48 mjacob
545 1.36 mjacob /*
546 1.36 mjacob * Instrumentation
547 1.36 mjacob */
548 1.66 mjacob uint64_t isp_intcnt; /* total int count */
549 1.66 mjacob uint64_t isp_intbogus; /* spurious int count */
550 1.66 mjacob uint64_t isp_intmboxc; /* mbox completions */
551 1.66 mjacob uint64_t isp_intoasync; /* other async */
552 1.66 mjacob uint64_t isp_rsltccmplt; /* CMDs on result q */
553 1.66 mjacob uint64_t isp_fphccmplt; /* CMDs via fastpost */
554 1.66 mjacob uint16_t isp_rscchiwater;
555 1.66 mjacob uint16_t isp_fpcchiwater;
556 1.6 mjacob
557 1.1 cgd /*
558 1.11 mjacob * Volatile state
559 1.1 cgd */
560 1.11 mjacob
561 1.66 mjacob volatile uint32_t : 8,
562 1.67.24.1 keiichi : 2,
563 1.67.24.1 keiichi isp_dead : 1,
564 1.67.24.1 keiichi isp_in_intr : 1,
565 1.51 mjacob isp_mboxbsy : 1, /* mailbox command active */
566 1.11 mjacob isp_state : 3,
567 1.24 mjacob isp_nactive : 16; /* how many commands active */
568 1.66 mjacob volatile uint32_t isp_reqodx; /* index of last ISP pickup */
569 1.66 mjacob volatile uint32_t isp_reqidx; /* index of next request */
570 1.66 mjacob volatile uint32_t isp_residx; /* index of next result */
571 1.66 mjacob volatile uint32_t isp_resodx; /* index of next result */
572 1.66 mjacob volatile uint32_t isp_lasthdls; /* last handle seed */
573 1.66 mjacob volatile uint32_t isp_obits; /* mailbox command output */
574 1.66 mjacob volatile uint16_t isp_mboxtmp[MAILBOX_STORAGE];
575 1.66 mjacob volatile uint16_t isp_lastmbxcmd; /* last mbox command sent */
576 1.66 mjacob volatile uint16_t isp_mbxwrk0;
577 1.66 mjacob volatile uint16_t isp_mbxwrk1;
578 1.66 mjacob volatile uint16_t isp_mbxwrk2;
579 1.66 mjacob volatile uint16_t isp_mbxwrk8;
580 1.66 mjacob void * isp_mbxworkp;
581 1.6 mjacob
582 1.1 cgd /*
583 1.26 mjacob * Active commands are stored here, indexed by handle functions.
584 1.1 cgd */
585 1.32 mjacob XS_T **isp_xflist;
586 1.6 mjacob
587 1.66 mjacob #ifdef ISP_TARGET_MODE
588 1.66 mjacob /*
589 1.67.24.1 keiichi * Active target commands are stored here, indexed by handle functions.
590 1.66 mjacob */
591 1.66 mjacob void **isp_tgtlist;
592 1.66 mjacob #endif
593 1.66 mjacob
594 1.1 cgd /*
595 1.60 wiz * request/result queue pointers and DMA handles for them.
596 1.1 cgd */
597 1.65 christos void * isp_rquest;
598 1.65 christos void * isp_result;
599 1.66 mjacob XS_DMA_ADDR_T isp_rquest_dma;
600 1.66 mjacob XS_DMA_ADDR_T isp_result_dma;
601 1.66 mjacob #ifdef ISP_TARGET_MODE
602 1.66 mjacob /* for 24XX only */
603 1.66 mjacob void * isp_atioq;
604 1.66 mjacob XS_DMA_ADDR_T isp_atioq_dma;
605 1.66 mjacob #endif
606 1.66 mjacob };
607 1.14 mjacob
608 1.67.24.1 keiichi #define SDPARAM(isp, chan) (&((sdparam *)(isp)->isp_param)[(chan)])
609 1.67.24.1 keiichi #define FCPARAM(isp, chan) (&((fcparam *)(isp)->isp_param)[(chan)])
610 1.67.24.1 keiichi
611 1.67.24.1 keiichi #define ISP_SET_SENDMARKER(isp, chan, val) \
612 1.67.24.1 keiichi if (IS_FC(isp)) { \
613 1.67.24.1 keiichi FCPARAM(isp, chan)->sendmarker = val; \
614 1.67.24.1 keiichi } else { \
615 1.67.24.1 keiichi SDPARAM(isp, chan)->sendmarker = val; \
616 1.67.24.1 keiichi }
617 1.67.24.1 keiichi
618 1.67.24.1 keiichi #define ISP_TST_SENDMARKER(isp, chan) \
619 1.67.24.1 keiichi (IS_FC(isp)? \
620 1.67.24.1 keiichi FCPARAM(isp, chan)->sendmarker != 0 : \
621 1.67.24.1 keiichi SDPARAM(isp, chan)->sendmarker != 0)
622 1.1 cgd
623 1.1 cgd /*
624 1.32 mjacob * ISP Driver Run States
625 1.9 mjacob */
626 1.9 mjacob #define ISP_NILSTATE 0
627 1.66 mjacob #define ISP_CRASHED 1
628 1.66 mjacob #define ISP_RESETSTATE 2
629 1.66 mjacob #define ISP_INITSTATE 3
630 1.66 mjacob #define ISP_RUNSTATE 4
631 1.9 mjacob
632 1.9 mjacob /*
633 1.9 mjacob * ISP Configuration Options
634 1.9 mjacob */
635 1.9 mjacob #define ISP_CFG_NORELOAD 0x80 /* don't download f/w */
636 1.18 mjacob #define ISP_CFG_NONVRAM 0x40 /* ignore NVRAM */
637 1.50 mjacob #define ISP_CFG_TWOGB 0x20 /* force 2GB connection (23XX only) */
638 1.50 mjacob #define ISP_CFG_ONEGB 0x10 /* force 1GB connection (23XX only) */
639 1.26 mjacob #define ISP_CFG_FULL_DUPLEX 0x01 /* Full Duplex (Fibre Channel only) */
640 1.36 mjacob #define ISP_CFG_PORT_PREF 0x0C /* Mask for Port Prefs (2200 only) */
641 1.36 mjacob #define ISP_CFG_LPORT 0x00 /* prefer {N/F}L-Port connection */
642 1.36 mjacob #define ISP_CFG_NPORT 0x04 /* prefer {N/F}-Port connection */
643 1.36 mjacob #define ISP_CFG_NPORT_ONLY 0x08 /* insist on {N/F}-Port connection */
644 1.36 mjacob #define ISP_CFG_LPORT_ONLY 0x0C /* insist on {N/F}L-Port connection */
645 1.56 mjacob #define ISP_CFG_OWNFSZ 0x400 /* override NVRAM frame size */
646 1.56 mjacob #define ISP_CFG_OWNLOOPID 0x800 /* override NVRAM loopid */
647 1.56 mjacob #define ISP_CFG_OWNEXCTHROTTLE 0x1000 /* override NVRAM execution throttle */
648 1.66 mjacob #define ISP_CFG_FOURGB 0x2000 /* force 4GB connection (24XX only) */
649 1.9 mjacob
650 1.32 mjacob /*
651 1.67.24.1 keiichi * For each channel, the outer layers should know what role that channel
652 1.67.24.1 keiichi * will take: ISP_ROLE_NONE, ISP_ROLE_INITIATOR, ISP_ROLE_TARGET,
653 1.67.24.1 keiichi * ISP_ROLE_BOTH.
654 1.41 mjacob *
655 1.41 mjacob * If you set ISP_ROLE_NONE, the cards will be reset, new firmware loaded,
656 1.41 mjacob * NVRAM read, and defaults set, but any further initialization (e.g.
657 1.41 mjacob * INITIALIZE CONTROL BLOCK commands for 2X00 cards) won't be done.
658 1.41 mjacob *
659 1.41 mjacob * If INITIATOR MODE isn't set, attempts to run commands will be stopped
660 1.67.24.1 keiichi * at isp_start and completed with the equivalent of SELECTION TIMEOUT.
661 1.41 mjacob *
662 1.41 mjacob * If TARGET MODE is set, it doesn't mean that the rest of target mode support
663 1.41 mjacob * needs to be enabled, or will even work. What happens with the 2X00 cards
664 1.41 mjacob * here is that if you have enabled it with TARGET MODE as part of the ICB
665 1.41 mjacob * options, but you haven't given the f/w any ram resources for ATIOs or
666 1.41 mjacob * Immediate Notifies, the f/w just handles what it can and you never see
667 1.41 mjacob * anything. Basically, it sends a single byte of data (the first byte,
668 1.41 mjacob * which you can set as part of the INITIALIZE CONTROL BLOCK command) for
669 1.41 mjacob * INQUIRY, and sends back QUEUE FULL status for any other command.
670 1.46 mjacob *
671 1.41 mjacob */
672 1.41 mjacob #define ISP_ROLE_NONE 0x0
673 1.66 mjacob #define ISP_ROLE_TARGET 0x1
674 1.66 mjacob #define ISP_ROLE_INITIATOR 0x2
675 1.41 mjacob #define ISP_ROLE_BOTH (ISP_ROLE_TARGET|ISP_ROLE_INITIATOR)
676 1.41 mjacob #define ISP_ROLE_EITHER ISP_ROLE_BOTH
677 1.41 mjacob #ifndef ISP_DEFAULT_ROLES
678 1.41 mjacob #define ISP_DEFAULT_ROLES ISP_ROLE_INITIATOR
679 1.41 mjacob #endif
680 1.41 mjacob
681 1.41 mjacob
682 1.41 mjacob /*
683 1.32 mjacob * Firmware related defines
684 1.32 mjacob */
685 1.41 mjacob #define ISP_CODE_ORG 0x1000 /* default f/w code start */
686 1.48 mjacob #define ISP_CODE_ORG_2300 0x0800 /* ..except for 2300s */
687 1.66 mjacob #define ISP_CODE_ORG_2400 0x100000 /* ..and 2400s */
688 1.21 mjacob #define ISP_FW_REV(maj, min, mic) ((maj << 24) | (min << 16) | mic)
689 1.49 mjacob #define ISP_FW_MAJOR(code) ((code >> 24) & 0xff)
690 1.49 mjacob #define ISP_FW_MINOR(code) ((code >> 16) & 0xff)
691 1.49 mjacob #define ISP_FW_MICRO(code) ((code >> 8) & 0xff)
692 1.41 mjacob #define ISP_FW_REVX(xp) ((xp[0]<<24) | (xp[1] << 16) | xp[2])
693 1.49 mjacob #define ISP_FW_MAJORX(xp) (xp[0])
694 1.49 mjacob #define ISP_FW_MINORX(xp) (xp[1])
695 1.49 mjacob #define ISP_FW_MICROX(xp) (xp[2])
696 1.58 mjacob #define ISP_FW_NEWER_THAN(i, major, minor, micro) \
697 1.58 mjacob (ISP_FW_REVX((i)->isp_fwrev) > ISP_FW_REV(major, minor, micro))
698 1.66 mjacob #define ISP_FW_OLDER_THAN(i, major, minor, micro) \
699 1.66 mjacob (ISP_FW_REVX((i)->isp_fwrev) < ISP_FW_REV(major, minor, micro))
700 1.11 mjacob
701 1.9 mjacob /*
702 1.11 mjacob * Bus (implementation) types
703 1.11 mjacob */
704 1.11 mjacob #define ISP_BT_PCI 0 /* PCI Implementations */
705 1.11 mjacob #define ISP_BT_SBUS 1 /* SBus Implementations */
706 1.11 mjacob
707 1.11 mjacob /*
708 1.51 mjacob * If we have not otherwise defined SBus support away make sure
709 1.51 mjacob * it is defined here such that the code is included as default
710 1.51 mjacob */
711 1.51 mjacob #ifndef ISP_SBUS_SUPPORTED
712 1.51 mjacob #define ISP_SBUS_SUPPORTED 1
713 1.51 mjacob #endif
714 1.51 mjacob
715 1.51 mjacob /*
716 1.11 mjacob * Chip Types
717 1.6 mjacob */
718 1.6 mjacob #define ISP_HA_SCSI 0xf
719 1.11 mjacob #define ISP_HA_SCSI_UNKNOWN 0x1
720 1.11 mjacob #define ISP_HA_SCSI_1020 0x2
721 1.11 mjacob #define ISP_HA_SCSI_1020A 0x3
722 1.11 mjacob #define ISP_HA_SCSI_1040 0x4
723 1.11 mjacob #define ISP_HA_SCSI_1040A 0x5
724 1.11 mjacob #define ISP_HA_SCSI_1040B 0x6
725 1.21 mjacob #define ISP_HA_SCSI_1040C 0x7
726 1.27 mjacob #define ISP_HA_SCSI_1240 0x8
727 1.27 mjacob #define ISP_HA_SCSI_1080 0x9
728 1.27 mjacob #define ISP_HA_SCSI_1280 0xa
729 1.59 mjacob #define ISP_HA_SCSI_10160 0xb
730 1.59 mjacob #define ISP_HA_SCSI_12160 0xc
731 1.6 mjacob #define ISP_HA_FC 0xf0
732 1.6 mjacob #define ISP_HA_FC_2100 0x10
733 1.23 mjacob #define ISP_HA_FC_2200 0x20
734 1.44 mjacob #define ISP_HA_FC_2300 0x30
735 1.52 mjacob #define ISP_HA_FC_2312 0x40
736 1.66 mjacob #define ISP_HA_FC_2322 0x50
737 1.66 mjacob #define ISP_HA_FC_2400 0x60
738 1.6 mjacob
739 1.19 mjacob #define IS_SCSI(isp) (isp->isp_type & ISP_HA_SCSI)
740 1.27 mjacob #define IS_1240(isp) (isp->isp_type == ISP_HA_SCSI_1240)
741 1.19 mjacob #define IS_1080(isp) (isp->isp_type == ISP_HA_SCSI_1080)
742 1.27 mjacob #define IS_1280(isp) (isp->isp_type == ISP_HA_SCSI_1280)
743 1.59 mjacob #define IS_10160(isp) (isp->isp_type == ISP_HA_SCSI_10160)
744 1.29 mjacob #define IS_12160(isp) (isp->isp_type == ISP_HA_SCSI_12160)
745 1.29 mjacob
746 1.29 mjacob #define IS_12X0(isp) (IS_1240(isp) || IS_1280(isp))
747 1.59 mjacob #define IS_1X160(isp) (IS_10160(isp) || IS_12160(isp))
748 1.29 mjacob #define IS_DUALBUS(isp) (IS_12X0(isp) || IS_12160(isp))
749 1.59 mjacob #define IS_ULTRA2(isp) (IS_1080(isp) || IS_1280(isp) || IS_1X160(isp))
750 1.59 mjacob #define IS_ULTRA3(isp) (IS_1X160(isp))
751 1.29 mjacob
752 1.44 mjacob #define IS_FC(isp) ((isp)->isp_type & ISP_HA_FC)
753 1.44 mjacob #define IS_2100(isp) ((isp)->isp_type == ISP_HA_FC_2100)
754 1.44 mjacob #define IS_2200(isp) ((isp)->isp_type == ISP_HA_FC_2200)
755 1.66 mjacob #define IS_23XX(isp) ((isp)->isp_type >= ISP_HA_FC_2300 && \
756 1.66 mjacob (isp)->isp_type < ISP_HA_FC_2400)
757 1.52 mjacob #define IS_2300(isp) ((isp)->isp_type == ISP_HA_FC_2300)
758 1.52 mjacob #define IS_2312(isp) ((isp)->isp_type == ISP_HA_FC_2312)
759 1.66 mjacob #define IS_2322(isp) ((isp)->isp_type == ISP_HA_FC_2322)
760 1.66 mjacob #define IS_24XX(isp) ((isp)->isp_type >= ISP_HA_FC_2400)
761 1.29 mjacob
762 1.32 mjacob /*
763 1.66 mjacob * DMA related macros
764 1.32 mjacob */
765 1.66 mjacob #define DMA_WD3(x) (((uint16_t)(((uint64_t)x) >> 48)) & 0xffff)
766 1.66 mjacob #define DMA_WD2(x) (((uint16_t)(((uint64_t)x) >> 32)) & 0xffff)
767 1.66 mjacob #define DMA_WD1(x) ((uint16_t)((x) >> 16) & 0xffff)
768 1.66 mjacob #define DMA_WD0(x) ((uint16_t)((x) & 0xffff))
769 1.66 mjacob
770 1.66 mjacob #define DMA_LO32(x) ((uint32_t) (x))
771 1.66 mjacob #define DMA_HI32(x) ((uint32_t)(((uint64_t)x) >> 32))
772 1.19 mjacob
773 1.6 mjacob /*
774 1.32 mjacob * Core System Function Prototypes
775 1.1 cgd */
776 1.9 mjacob
777 1.1 cgd /*
778 1.9 mjacob * Reset Hardware. Totally. Assumes that you'll follow this with
779 1.9 mjacob * a call to isp_init.
780 1.1 cgd */
781 1.66 mjacob void isp_reset(ispsoftc_t *);
782 1.1 cgd
783 1.1 cgd /*
784 1.1 cgd * Initialize Hardware to known state
785 1.1 cgd */
786 1.66 mjacob void isp_init(ispsoftc_t *);
787 1.1 cgd
788 1.1 cgd /*
789 1.10 mjacob * Reset the ISP and call completion for any orphaned commands.
790 1.10 mjacob */
791 1.66 mjacob void isp_reinit(ispsoftc_t *);
792 1.1 cgd
793 1.1 cgd /*
794 1.48 mjacob * Internal Interrupt Service Routine
795 1.48 mjacob *
796 1.48 mjacob * The outer layers do the spade work to get the appropriate status register,
797 1.48 mjacob * semaphore register and first mailbox register (if appropriate). This also
798 1.48 mjacob * means that most spurious/bogus interrupts not for us can be filtered first.
799 1.1 cgd */
800 1.66 mjacob void isp_intr(ispsoftc_t *, uint32_t, uint16_t, uint16_t);
801 1.48 mjacob
802 1.9 mjacob
803 1.9 mjacob /*
804 1.32 mjacob * Command Entry Point- Platform Dependent layers call into this
805 1.32 mjacob */
806 1.43 mjacob int isp_start(XS_T *);
807 1.66 mjacob
808 1.32 mjacob /* these values are what isp_start returns */
809 1.32 mjacob #define CMD_COMPLETE 101 /* command completed */
810 1.32 mjacob #define CMD_EAGAIN 102 /* busy- maybe retry later */
811 1.32 mjacob #define CMD_QUEUED 103 /* command has been queued for execution */
812 1.32 mjacob #define CMD_RQLATER 104 /* requeue this command later */
813 1.32 mjacob
814 1.32 mjacob /*
815 1.32 mjacob * Command Completion Point- Core layers call out from this with completed cmds
816 1.9 mjacob */
817 1.43 mjacob void isp_done(XS_T *);
818 1.1 cgd
819 1.9 mjacob /*
820 1.17 mjacob * Platform Dependent to External to Internal Control Function
821 1.9 mjacob *
822 1.41 mjacob * Assumes locks are held on entry. You should note that with many of
823 1.67.24.1 keiichi * these commands locks may be released while this function is called.
824 1.9 mjacob *
825 1.67.24.1 keiichi * ... ISPCTL_RESET_BUS, int channel);
826 1.67.24.1 keiichi * Reset BUS on this channel
827 1.67.24.1 keiichi * ... ISPCTL_RESET_DEV, int channel, int target);
828 1.67.24.1 keiichi * Reset Device on this channel at this target.
829 1.67.24.1 keiichi * ... ISPCTL_ABORT_CMD, XS_T *xs);
830 1.67.24.1 keiichi * Abort active transaction described by xs.
831 1.67.24.1 keiichi * ... IPCTL_UPDATE_PARAMS);
832 1.67.24.1 keiichi * Update any operating parameters (speed, etc.)
833 1.67.24.1 keiichi * ... ISPCTL_FCLINK_TEST, int channel);
834 1.67.24.1 keiichi * Test FC link status on this channel
835 1.67.24.1 keiichi * ... ISPCTL_SCAN_FABRIC, int channel);
836 1.67.24.1 keiichi * Scan fabric on this channel
837 1.67.24.1 keiichi * ... ISPCTL_SCAN_LOOP, int channel);
838 1.67.24.1 keiichi * Scan local loop on this channel
839 1.67.24.1 keiichi * ... ISPCTL_PDB_SYNC, int channel);
840 1.67.24.1 keiichi * Synchronize port database on this channel
841 1.67.24.1 keiichi * ... ISPCTL_SEND_LIP, int channel);
842 1.67.24.1 keiichi * Send a LIP on this channel
843 1.67.24.1 keiichi * ... ISPCTL_GET_NAMES, int channel, int np, uint64_t *wwnn, uint64_t *wwpn)
844 1.67.24.1 keiichi * Get a WWNN/WWPN for this N-port handle on this channel
845 1.67.24.1 keiichi * ... ISPCTL_RUN_MBOXCMD, mbreg_t *mbp)
846 1.67.24.1 keiichi * Run this mailbox command
847 1.67.24.1 keiichi * ... ISPCTL_GET_PDB, int channel, int nphandle, isp_pdb_t *pdb)
848 1.67.24.1 keiichi * Get PDB on this channel for this N-port handle
849 1.67.24.1 keiichi * ... ISPCTL_PLOGX, isp_plcmd_t *)
850 1.67.24.1 keiichi * Performa a port login/logout
851 1.41 mjacob *
852 1.41 mjacob * ISPCTL_PDB_SYNC is somewhat misnamed. It actually is the final step, in
853 1.41 mjacob * order, of ISPCTL_FCLINK_TEST, ISPCTL_SCAN_FABRIC, and ISPCTL_SCAN_LOOP.
854 1.41 mjacob * The main purpose of ISPCTL_PDB_SYNC is to complete management of logging
855 1.41 mjacob * and logging out of fabric devices (if one is on a fabric) and then marking
856 1.41 mjacob * the 'loop state' as being ready to now be used for sending commands to
857 1.41 mjacob * devices. Originally fabric name server and local loop scanning were
858 1.47 wiz * part of this function. It's now been separated to allow for finer control.
859 1.9 mjacob */
860 1.9 mjacob typedef enum {
861 1.67.24.1 keiichi ISPCTL_RESET_BUS,
862 1.67.24.1 keiichi ISPCTL_RESET_DEV,
863 1.67.24.1 keiichi ISPCTL_ABORT_CMD,
864 1.67.24.1 keiichi ISPCTL_UPDATE_PARAMS,
865 1.67.24.1 keiichi ISPCTL_FCLINK_TEST,
866 1.67.24.1 keiichi ISPCTL_SCAN_FABRIC,
867 1.67.24.1 keiichi ISPCTL_SCAN_LOOP,
868 1.67.24.1 keiichi ISPCTL_PDB_SYNC,
869 1.67.24.1 keiichi ISPCTL_SEND_LIP,
870 1.67.24.1 keiichi ISPCTL_GET_NAMES,
871 1.67.24.1 keiichi ISPCTL_RUN_MBOXCMD,
872 1.67.24.1 keiichi ISPCTL_GET_PDB,
873 1.67.24.1 keiichi ISPCTL_PLOGX
874 1.9 mjacob } ispctl_t;
875 1.67.24.1 keiichi int isp_control(ispsoftc_t *, ispctl_t, ...);
876 1.17 mjacob
877 1.17 mjacob /*
878 1.17 mjacob * Platform Dependent to Internal to External Control Function
879 1.17 mjacob */
880 1.17 mjacob
881 1.17 mjacob typedef enum {
882 1.67.24.1 keiichi ISPASYNC_NEW_TGT_PARAMS, /* SPI New Target Parameters */
883 1.67.24.1 keiichi ISPASYNC_BUS_RESET, /* All Bus Was Reset */
884 1.23 mjacob ISPASYNC_LOOP_DOWN, /* FC Loop Down */
885 1.23 mjacob ISPASYNC_LOOP_UP, /* FC Loop Up */
886 1.67.24.1 keiichi ISPASYNC_LIP, /* FC LIP Received */
887 1.67.24.1 keiichi ISPASYNC_LOOP_RESET, /* FC Loop Reset Received */
888 1.41 mjacob ISPASYNC_CHANGE_NOTIFY, /* FC Change Notification */
889 1.67.24.1 keiichi ISPASYNC_DEV_ARRIVED, /* FC Device Arrived */
890 1.67.24.1 keiichi ISPASYNC_DEV_CHANGED, /* FC Device Changed */
891 1.67.24.1 keiichi ISPASYNC_DEV_STAYED, /* FC Device Stayed */
892 1.67.24.1 keiichi ISPASYNC_DEV_GONE, /* FC Device Departure */
893 1.67.24.1 keiichi ISPASYNC_TARGET_NOTIFY, /* All target async notification */
894 1.67.24.1 keiichi ISPASYNC_TARGET_ACTION, /* All target action requested */
895 1.67.24.1 keiichi ISPASYNC_FW_CRASH, /* All Firmware has crashed */
896 1.67.24.1 keiichi ISPASYNC_FW_RESTARTED /* All Firmware has been restarted */
897 1.17 mjacob } ispasync_t;
898 1.67.24.1 keiichi void isp_async(ispsoftc_t *, ispasync_t, ...);
899 1.1 cgd
900 1.67.24.1 keiichi #define ISPASYNC_CHANGE_PDB 0
901 1.67.24.1 keiichi #define ISPASYNC_CHANGE_SNS 1
902 1.67.24.1 keiichi #define ISPASYNC_CHANGE_OTHER 2
903 1.41 mjacob
904 1.9 mjacob /*
905 1.32 mjacob * Platform Dependent Error and Debug Printout
906 1.66 mjacob *
907 1.66 mjacob * Generally this is:
908 1.66 mjacob *
909 1.66 mjacob * void isp_prt(ispsoftc_t *, int level, const char *, ...)
910 1.66 mjacob *
911 1.66 mjacob * but due to compiler differences on different platforms this won't be
912 1.66 mjacob * formally done here. Instead, it goes in each platform definition file.
913 1.9 mjacob */
914 1.39 mjacob
915 1.32 mjacob #define ISP_LOGALL 0x0 /* log always */
916 1.32 mjacob #define ISP_LOGCONFIG 0x1 /* log configuration messages */
917 1.32 mjacob #define ISP_LOGINFO 0x2 /* log informational messages */
918 1.32 mjacob #define ISP_LOGWARN 0x4 /* log warning messages */
919 1.32 mjacob #define ISP_LOGERR 0x8 /* log error messages */
920 1.32 mjacob #define ISP_LOGDEBUG0 0x10 /* log simple debug messages */
921 1.32 mjacob #define ISP_LOGDEBUG1 0x20 /* log intermediate debug messages */
922 1.32 mjacob #define ISP_LOGDEBUG2 0x40 /* log most debug messages */
923 1.46 mjacob #define ISP_LOGDEBUG3 0x80 /* log high frequency debug messages */
924 1.66 mjacob #define ISP_LOGSANCFG 0x100 /* log SAN configuration */
925 1.67.24.1 keiichi #define ISP_LOGTINFO 0x1000 /* log informational messages (target mode) */
926 1.67.24.1 keiichi #define ISP_LOGTDEBUG0 0x2000 /* log simple debug messages (target mode) */
927 1.67.24.1 keiichi #define ISP_LOGTDEBUG1 0x4000 /* log intermediate debug messages (target) */
928 1.67.24.1 keiichi #define ISP_LOGTDEBUG2 0x8000 /* log all debug messages (target) */
929 1.1 cgd
930 1.32 mjacob /*
931 1.32 mjacob * Each Platform provides it's own isposinfo substructure of the ispsoftc
932 1.32 mjacob * defined above.
933 1.32 mjacob *
934 1.32 mjacob * Each platform must also provide the following macros/defines:
935 1.32 mjacob *
936 1.32 mjacob *
937 1.67.24.1 keiichi * ISP_FC_SCRLEN FC scratch area DMA length
938 1.32 mjacob *
939 1.32 mjacob * MEMZERO(dst, src) platform zeroing function
940 1.32 mjacob * MEMCPY(dst, src, count) platform copying function
941 1.32 mjacob * SNPRINTF(buf, bufsize, fmt, ...) snprintf
942 1.32 mjacob * USEC_DELAY(usecs) microsecond spindelay function
943 1.36 mjacob * USEC_SLEEP(isp, usecs) microsecond sleep function
944 1.32 mjacob *
945 1.32 mjacob * NANOTIME_T nanosecond time type
946 1.32 mjacob *
947 1.32 mjacob * GET_NANOTIME(NANOTIME_T *) get current nanotime.
948 1.32 mjacob *
949 1.66 mjacob * GET_NANOSEC(NANOTIME_T *) get uint64_t from NANOTIME_T
950 1.32 mjacob *
951 1.32 mjacob * NANOTIME_SUB(NANOTIME_T *, NANOTIME_T *)
952 1.32 mjacob * subtract two NANOTIME_T values
953 1.32 mjacob *
954 1.67.24.1 keiichi * MAXISPREQUEST(ispsoftc_t *) maximum request queue size
955 1.32 mjacob * for this particular board type
956 1.32 mjacob *
957 1.66 mjacob * MEMORYBARRIER(ispsoftc_t *, barrier_type, offset, size)
958 1.32 mjacob *
959 1.32 mjacob * Function/Macro the provides memory synchronization on
960 1.32 mjacob * various objects so that the ISP's and the system's view
961 1.32 mjacob * of the same object is consistent.
962 1.32 mjacob *
963 1.66 mjacob * MBOX_ACQUIRE(ispsoftc_t *) acquire lock on mailbox regs
964 1.66 mjacob * MBOX_WAIT_COMPLETE(ispsoftc_t *, mbreg_t *) wait for cmd to be done
965 1.66 mjacob * MBOX_NOTIFY_COMPLETE(ispsoftc_t *) notification of mbox cmd donee
966 1.66 mjacob * MBOX_RELEASE(ispsoftc_t *) release lock on mailbox regs
967 1.41 mjacob *
968 1.67.24.1 keiichi * FC_SCRATCH_ACQUIRE(ispsoftc_t *, chan) acquire lock on FC scratch area
969 1.67.24.1 keiichi * FC_SCRATCH_RELEASE(ispsoftc_t *, chan) acquire lock on FC scratch area
970 1.32 mjacob *
971 1.32 mjacob * SCSI_GOOD SCSI 'Good' Status
972 1.32 mjacob * SCSI_CHECK SCSI 'Check Condition' Status
973 1.32 mjacob * SCSI_BUSY SCSI 'Busy' Status
974 1.32 mjacob * SCSI_QFULL SCSI 'Queue Full' Status
975 1.32 mjacob *
976 1.32 mjacob * XS_T Platform SCSI transaction type (i.e., command for HBA)
977 1.66 mjacob * XS_DMA_ADDR_T Platform PCI DMA Address Type
978 1.32 mjacob * XS_ISP(xs) gets an instance out of an XS_T
979 1.32 mjacob * XS_CHANNEL(xs) gets the channel (bus # for DUALBUS cards) ""
980 1.32 mjacob * XS_TGT(xs) gets the target ""
981 1.32 mjacob * XS_LUN(xs) gets the lun ""
982 1.32 mjacob * XS_CDBP(xs) gets a pointer to the scsi CDB ""
983 1.32 mjacob * XS_CDBLEN(xs) gets the CDB's length ""
984 1.32 mjacob * XS_XFRLEN(xs) gets the associated data transfer length ""
985 1.32 mjacob * XS_TIME(xs) gets the time (in milliseconds) for this command
986 1.32 mjacob * XS_RESID(xs) gets the current residual count
987 1.32 mjacob * XS_STSP(xs) gets a pointer to the SCSI status byte ""
988 1.32 mjacob * XS_SNSP(xs) gets a pointer to the associate sense data
989 1.32 mjacob * XS_SNSLEN(xs) gets the length of sense data storage
990 1.32 mjacob * XS_SNSKEY(xs) dereferences XS_SNSP to get the current stored Sense Key
991 1.32 mjacob * XS_TAG_P(xs) predicate of whether this command should be tagged
992 1.32 mjacob * XS_TAG_TYPE(xs) which type of tag to use
993 1.32 mjacob * XS_SETERR(xs) set error state
994 1.32 mjacob *
995 1.32 mjacob * HBA_NOERROR command has no erros
996 1.32 mjacob * HBA_BOTCH hba botched something
997 1.32 mjacob * HBA_CMDTIMEOUT command timed out
998 1.32 mjacob * HBA_SELTIMEOUT selection timed out (also port logouts for FC)
999 1.32 mjacob * HBA_TGTBSY target returned a BUSY status
1000 1.32 mjacob * HBA_BUSRESET bus reset destroyed command
1001 1.32 mjacob * HBA_ABORTED command was aborted (by request)
1002 1.32 mjacob * HBA_DATAOVR a data overrun was detected
1003 1.32 mjacob * HBA_ARQFAIL Automatic Request Sense failed
1004 1.32 mjacob *
1005 1.32 mjacob * XS_ERR(xs) return current error state
1006 1.32 mjacob * XS_NOERR(xs) there is no error currently set
1007 1.32 mjacob * XS_INITERR(xs) initialize error state
1008 1.32 mjacob *
1009 1.66 mjacob * XS_SAVE_SENSE(xs, sp, len) save sense data
1010 1.32 mjacob *
1011 1.32 mjacob * XS_SET_STATE_STAT(isp, sp, xs) platform dependent interpreter of
1012 1.32 mjacob * response queue entry status bits
1013 1.32 mjacob *
1014 1.32 mjacob *
1015 1.66 mjacob * DEFAULT_FRAMESIZE(ispsoftc_t *) Default Frame Size
1016 1.67.24.1 keiichi * DEFAULT_EXEC_THROTTLE(ispsoftc_t *) Default Execution Throttle
1017 1.67.24.1 keiichi *
1018 1.67.24.1 keiichi * GET_DEFAULT_ROLE(ispsoftc_t *, int) Get Default Role for a channel
1019 1.67.24.1 keiichi * SET_DEFAULT_ROLE(ispsoftc_t *, int, int) Set Default Role for a channel
1020 1.67.24.1 keiichi * DEFAULT_IID(ispsoftc_t *, int) Default SCSI initiator ID
1021 1.67.24.1 keiichi * DEFAULT_LOOPID(ispsoftc_t *, int) Default FC Loop ID
1022 1.67.24.1 keiichi *
1023 1.35 mjacob * These establish reasonable defaults for each platform.
1024 1.35 mjacob * These must be available independent of card NVRAM and are
1025 1.35 mjacob * to be used should NVRAM not be readable.
1026 1.35 mjacob *
1027 1.67.24.1 keiichi * DEFAULT_NODEWWN(ispsoftc_t *, chan) Default FC Node WWN to use
1028 1.67.24.1 keiichi * DEFAULT_PORTWWN(ispsoftc_t *, chan) Default FC Port WWN to use
1029 1.67.24.1 keiichi *
1030 1.67.24.1 keiichi * These defines are hooks to allow the setting of node and
1031 1.67.24.1 keiichi * port WWNs when NVRAM cannot be read or is to be overriden.
1032 1.67.24.1 keiichi *
1033 1.67.24.1 keiichi * ACTIVE_NODEWWN(ispsoftc_t *, chan) FC Node WWN to use
1034 1.67.24.1 keiichi * ACTIVE_PORTWWN(ispsoftc_t *, chan) FC Port WWN to use
1035 1.35 mjacob *
1036 1.67.24.1 keiichi * After NVRAM is read, these will be invoked to get the
1037 1.67.24.1 keiichi * node and port WWNs that will actually be used for this
1038 1.67.24.1 keiichi * channel.
1039 1.32 mjacob *
1040 1.51 mjacob *
1041 1.66 mjacob * ISP_IOXPUT_8(ispsoftc_t *, uint8_t srcval, uint8_t *dstptr)
1042 1.66 mjacob * ISP_IOXPUT_16(ispsoftc_t *, uint16_t srcval, uint16_t *dstptr)
1043 1.66 mjacob * ISP_IOXPUT_32(ispsoftc_t *, uint32_t srcval, uint32_t *dstptr)
1044 1.66 mjacob *
1045 1.66 mjacob * ISP_IOXGET_8(ispsoftc_t *, uint8_t *srcptr, uint8_t dstrval)
1046 1.66 mjacob * ISP_IOXGET_16(ispsoftc_t *, uint16_t *srcptr, uint16_t dstrval)
1047 1.66 mjacob * ISP_IOXGET_32(ispsoftc_t *, uint32_t *srcptr, uint32_t dstrval)
1048 1.51 mjacob *
1049 1.66 mjacob * ISP_SWIZZLE_NVRAM_WORD(ispsoftc_t *, uint16_t *)
1050 1.67 mjacob * ISP_SWIZZLE_NVRAM_LONG(ispsoftc_t *, uint32_t *)
1051 1.67 mjacob * ISP_SWAP16(ispsoftc_t *, uint16_t srcval)
1052 1.67 mjacob * ISP_SWAP32(ispsoftc_t *, uint32_t srcval)
1053 1.32 mjacob */
1054 1.44 mjacob
1055 1.1 cgd #endif /* _ISPVAR_H */
1056