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