1 /* $FreeBSD: src/sys/dev/isp/ispvar.h,v 1.25.2.17 2002/10/11 18:51:49 mjacob Exp $ */
2 /* $DragonFly: src/sys/dev/disk/isp/ispvar.h,v 1.5 2006/12/20 18:14:38 dillon Exp $ */
4 * Soft Definitions for for Qlogic ISP SCSI adapters.
6 * Copyright (c) 1997, 1998, 1999, 2000 by Matthew Jacob
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice immediately at the beginning of the file, without modification,
14 * this list of conditions, and the following disclaimer.
15 * 2. The name of the author may not be used to endorse or promote products
16 * derived from this software without specific prior written permission.
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
22 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 #if defined(__NetBSD__) || defined(__OpenBSD__)
36 #include <dev/ic/ispmbox.h>
37 #ifdef ISP_TARGET_MODE
38 #include <dev/ic/isp_target.h>
39 #include <dev/ic/isp_tpublic.h>
42 #if defined(__DragonFly__) || defined(__FreeBSD__)
44 #ifdef ISP_TARGET_MODE
45 #include "isp_target.h"
46 #include "isp_tpublic.h"
51 #ifdef ISP_TARGET_MODE
52 #include "isp_target.h"
53 #include "isp_tpublic.h"
57 #define ISP_CORE_VERSION_MAJOR 2
58 #define ISP_CORE_VERSION_MINOR 7
61 * Vector for bus specific code to provide specific services.
66 (struct ispsoftc *, u_int16_t *, u_int16_t *, u_int16_t *);
67 u_int16_t (*dv_rd_reg) (struct ispsoftc *, int);
68 void (*dv_wr_reg) (struct ispsoftc *, int, u_int16_t);
69 int (*dv_mbxdma) (struct ispsoftc *);
70 int (*dv_dmaset) (struct ispsoftc *,
71 XS_T *, ispreq_t *, u_int16_t *, u_int16_t);
73 (struct ispsoftc *, XS_T *, u_int16_t);
74 void (*dv_reset0) (struct ispsoftc *);
75 void (*dv_reset1) (struct ispsoftc *);
76 void (*dv_dregs) (struct ispsoftc *, const char *);
77 u_int16_t *dv_ispfw; /* ptr to f/w */
79 u_int16_t dv_clock; /* clock frequency */
85 #define MAX_TARGETS 16
86 #define MAX_FC_TARG 256
87 #define ISP_MAX_TARGETS(isp) (IS_FC(isp)? MAX_FC_TARG : MAX_TARGETS)
88 #define ISP_MAX_LUNS(isp) (isp)->isp_maxluns
93 #ifdef ISP_DAC_SUPPORTED
94 typedef u_int64_t isp_dma_addr_t;
96 typedef u_int32_t isp_dma_addr_t;
100 * Macros to access ISP registers through bus specific layers-
101 * mostly wrappers to vector through the mdvec structure.
103 #define ISP_READ_ISR(isp, isrp, semap, mbox0p) \
104 (*(isp)->isp_mdvec->dv_rd_isr)(isp, isrp, semap, mbox0p)
106 #define ISP_READ(isp, reg) \
107 (*(isp)->isp_mdvec->dv_rd_reg)((isp), (reg))
109 #define ISP_WRITE(isp, reg, val) \
110 (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), (val))
112 #define ISP_MBOXDMASETUP(isp) \
113 (*(isp)->isp_mdvec->dv_mbxdma)((isp))
115 #define ISP_DMASETUP(isp, xs, req, iptrp, optr) \
116 (*(isp)->isp_mdvec->dv_dmaset)((isp), (xs), (req), (iptrp), (optr))
118 #define ISP_DMAFREE(isp, xs, hndl) \
119 if ((isp)->isp_mdvec->dv_dmaclr) \
120 (*(isp)->isp_mdvec->dv_dmaclr)((isp), (xs), (hndl))
122 #define ISP_RESET0(isp) \
123 if ((isp)->isp_mdvec->dv_reset0) (*(isp)->isp_mdvec->dv_reset0)((isp))
124 #define ISP_RESET1(isp) \
125 if ((isp)->isp_mdvec->dv_reset1) (*(isp)->isp_mdvec->dv_reset1)((isp))
126 #define ISP_DUMPREGS(isp, m) \
127 if ((isp)->isp_mdvec->dv_dregs) (*(isp)->isp_mdvec->dv_dregs)((isp),(m))
129 #define ISP_SETBITS(isp, reg, val) \
130 (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), ISP_READ((isp), (reg)) | (val))
132 #define ISP_CLRBITS(isp, reg, val) \
133 (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), ISP_READ((isp), (reg)) & ~(val))
136 * The MEMORYBARRIER macro is defined per platform (to provide synchronization
137 * on Request and Response Queues, Scratch DMA areas, and Registers)
139 * Defined Memory Barrier Synchronization Types
141 #define SYNC_REQUEST 0 /* request queue synchronization */
142 #define SYNC_RESULT 1 /* result queue synchronization */
143 #define SYNC_SFORDEV 2 /* scratch, sync for ISP */
144 #define SYNC_SFORCPU 3 /* scratch, sync for CPU */
145 #define SYNC_REG 4 /* for registers */
148 * Request/Response Queue defines and macros.
149 * The maximum is defined per platform (and can be based on board type).
151 /* This is the size of a queue entry (request and response) */
152 #define QENTRY_LEN 64
153 /* Both request and result queue length must be a power of two */
154 #define RQUEST_QUEUE_LEN(x) MAXISPREQUEST(x)
155 #ifdef ISP_TARGET_MODE
156 #define RESULT_QUEUE_LEN(x) MAXISPREQUEST(x)
158 #define RESULT_QUEUE_LEN(x) \
159 (((MAXISPREQUEST(x) >> 2) < 64)? 64 : MAXISPREQUEST(x) >> 2)
161 #define ISP_QUEUE_ENTRY(q, idx) ((q) + ((idx) * QENTRY_LEN))
162 #define ISP_QUEUE_SIZE(n) ((n) * QENTRY_LEN)
163 #define ISP_NXT_QENTRY(idx, qlen) (((idx) + 1) & ((qlen)-1))
164 #define ISP_QFREE(in, out, qlen) \
165 ((in == out)? (qlen - 1) : ((in > out)? \
166 ((qlen - 1) - (in - out)) : (out - in - 1)))
167 #define ISP_QAVAIL(isp) \
168 ISP_QFREE(isp->isp_reqidx, isp->isp_reqodx, RQUEST_QUEUE_LEN(isp))
170 #define ISP_ADD_REQUEST(isp, nxti) \
171 MEMORYBARRIER(isp, SYNC_REQUEST, isp->isp_reqidx, QENTRY_LEN); \
172 WRITE_REQUEST_QUEUE_IN_POINTER(isp, nxti); \
173 isp->isp_reqidx = nxti
176 * SCSI Specific Host Adapter Parameters- per bus, per target
180 u_int isp_gotdparms : 1,
181 isp_req_ack_active_neg : 1,
182 isp_data_line_active_neg: 1,
183 isp_cmd_dma_burst_enable: 1,
184 isp_data_dma_burst_enabl: 1,
185 isp_fifo_threshold : 3,
189 isp_fast_mttr : 1, /* fast sram */
190 isp_initiator_id : 4,
191 isp_async_data_setup : 4;
192 u_int16_t isp_selection_timeout;
193 u_int16_t isp_max_queue_depth;
194 u_int8_t isp_tag_aging;
195 u_int8_t isp_bus_reset_delay;
196 u_int8_t isp_retry_count;
197 u_int8_t isp_retry_delay;
202 dev_enable : 1, /* ignored */
208 u_int8_t actv_period; /* current sync period */
209 u_int8_t goal_period; /* goal sync period */
210 u_int8_t nvrm_period; /* nvram sync period */
211 u_int16_t actv_flags; /* current device flags */
212 u_int16_t goal_flags; /* goal device flags */
213 u_int16_t nvrm_flags; /* nvram device flags */
214 } isp_devparam[MAX_TARGETS];
220 #define DPARM_DISC 0x8000
221 #define DPARM_PARITY 0x4000
222 #define DPARM_WIDE 0x2000
223 #define DPARM_SYNC 0x1000
224 #define DPARM_TQING 0x0800
225 #define DPARM_ARQ 0x0400
226 #define DPARM_QFRZ 0x0200
227 #define DPARM_RENEG 0x0100
228 #define DPARM_NARROW 0x0080
229 #define DPARM_ASYNC 0x0040
230 #define DPARM_PPR 0x0020
231 #define DPARM_DEFAULT (0xFF00 & ~DPARM_QFRZ)
232 #define DPARM_SAFE_DFLT (DPARM_DEFAULT & ~(DPARM_WIDE|DPARM_SYNC|DPARM_TQING))
235 /* technically, not really correct, as they need to be rated based upon clock */
236 #define ISP_80M_SYNCPARMS 0x0c09
237 #define ISP_40M_SYNCPARMS 0x0c0a
238 #define ISP_20M_SYNCPARMS 0x0c0c
239 #define ISP_20M_SYNCPARMS_1040 0x080c
240 #define ISP_10M_SYNCPARMS 0x0c19
241 #define ISP_08M_SYNCPARMS 0x0c25
242 #define ISP_05M_SYNCPARMS 0x0c32
243 #define ISP_04M_SYNCPARMS 0x0c41
246 * Fibre Channel Specifics
248 #define FL_PORT_ID 0x7e /* FL_Port Special ID */
249 #define FC_PORT_ID 0x7f /* Fabric Controller Special ID */
250 #define FC_SNS_ID 0x80 /* SNS Server Special ID */
252 /* #define ISP_USE_GA_NXT 1 */ /* Use GA_NXT with switches */
254 #define GA_NXT_MAX 256
258 u_int32_t isp_fwoptions : 16,
262 isp_loopstate : 4, /* Current Loop State */
263 isp_fwstate : 3, /* ISP F/W state */
267 u_int8_t isp_iid; /* 'initiator' id */
268 u_int8_t isp_loopid; /* hard loop id */
269 u_int8_t isp_alpa; /* ALPA */
270 u_int32_t isp_portid;
271 volatile u_int16_t isp_lipseq; /* LIP sequence # */
272 u_int16_t isp_fwattr; /* firmware attributes */
273 u_int8_t isp_execthrottle;
274 u_int8_t isp_retry_delay;
275 u_int8_t isp_retry_count;
276 u_int8_t isp_reserved;
277 u_int16_t isp_maxalloc;
278 u_int16_t isp_maxfrmlen;
279 u_int64_t isp_nodewwn;
280 u_int64_t isp_portwwn;
282 * Port Data Base. This is indexed by 'target', which is invariate.
283 * However, elements within can move around due to loop changes,
284 * so the actual loop ID passed to the F/W is in this structure.
285 * The first time the loop is seen up, loopid will match the index
286 * (except for fabric nodes which are above mapped above FC_SNS_ID
287 * and are completely virtual), but subsequent LIPs can cause things
307 } portdb[MAX_FC_TARG], tport[FC_PORT_ID];
310 * Scratch DMA mapped in area to fetch Port Database stuff, etc.
313 isp_dma_addr_t isp_scdma;
314 #ifdef ISP_FW_CRASH_DUMP
315 u_int16_t *isp_dump_data;
319 #define FW_CONFIG_WAIT 0
320 #define FW_WAIT_AL_PA 1
321 #define FW_WAIT_LOGIN 2
323 #define FW_LOSS_OF_SYNC 4
326 #define FW_NON_PART 7
329 #define LOOP_LIP_RCVD 1
330 #define LOOP_PDB_RCVD 2
331 #define LOOP_SCANNING_FABRIC 3
332 #define LOOP_FSCAN_DONE 4
333 #define LOOP_SCANNING_LOOP 5
334 #define LOOP_LSCAN_DONE 6
335 #define LOOP_SYNCING_PDB 7
338 #define TOPO_NL_PORT 0
339 #define TOPO_FL_PORT 1
340 #define TOPO_N_PORT 2
341 #define TOPO_F_PORT 3
342 #define TOPO_PTP_STUB 4
345 * Soft Structure per host adapter
347 typedef struct ispsoftc {
349 * Platform (OS) specific data
351 struct isposinfo isp_osinfo;
354 * Pointer to bus specific functions and data
356 struct ispmdvec * isp_mdvec;
359 * (Mostly) nonvolatile state. Board specific parameters
360 * may contain some volatile state (e.g., current loop state).
363 void * isp_param; /* type specific */
364 u_int16_t isp_fwrev[3]; /* Loaded F/W revision */
365 u_int16_t isp_romfw_rev[3]; /* PROM F/W revision */
366 u_int16_t isp_maxcmds; /* max possible I/O cmds */
367 u_int8_t isp_type; /* HBA Chip Type */
368 u_int8_t isp_revision; /* HBA Chip H/W Revision */
369 u_int32_t isp_maxluns; /* maximum luns supported */
371 u_int32_t isp_clock : 8, /* input clock */
373 isp_port : 1, /* 23XX only */
374 isp_failed : 1, /* board failed */
375 isp_open : 1, /* opened (ioctl) */
376 isp_touched : 1, /* board ever seen? */
377 isp_bustype : 1, /* SBus or PCI */
378 isp_loaded_fw : 1, /* loaded firmware */
379 isp_role : 2, /* roles supported */
380 isp_dblev : 12; /* debug log mask */
382 u_int32_t isp_confopts; /* config options */
384 u_int16_t isp_rqstinrp; /* register for REQINP */
385 u_int16_t isp_rqstoutrp; /* register for REQOUTP */
386 u_int16_t isp_respinrp; /* register for RESINP */
387 u_int16_t isp_respoutrp; /* register for RESOUTP */
392 u_int64_t isp_intcnt; /* total int count */
393 u_int64_t isp_intbogus; /* spurious int count */
394 u_int64_t isp_intmboxc; /* mbox completions */
395 u_int64_t isp_intoasync; /* other async */
396 u_int64_t isp_rsltccmplt; /* CMDs on result q */
397 u_int64_t isp_fphccmplt; /* CMDs via fastpost */
398 u_int16_t isp_rscchiwater;
399 u_int16_t isp_fpcchiwater;
406 isp_obits : 8, /* mailbox command output */
407 isp_mboxbsy : 1, /* mailbox command active */
409 isp_sendmarker : 2, /* send a marker entry */
410 isp_update : 2, /* update parameters */
411 isp_nactive : 16; /* how many commands active */
412 volatile u_int16_t isp_reqodx; /* index of last ISP pickup */
413 volatile u_int16_t isp_reqidx; /* index of next request */
414 volatile u_int16_t isp_residx; /* index of next result */
415 volatile u_int16_t isp_resodx; /* index of next result */
416 volatile u_int16_t isp_rspbsy;
417 volatile u_int16_t isp_lasthdls; /* last handle seed */
418 volatile u_int16_t isp_mboxtmp[MAX_MAILBOX];
419 volatile u_int16_t isp_lastmbxcmd; /* last mbox command sent */
420 volatile u_int16_t isp_mbxwrk0;
421 volatile u_int16_t isp_mbxwrk1;
422 volatile u_int16_t isp_mbxwrk2;
426 * Active commands are stored here, indexed by handle functions.
431 * request/result queue pointers and dma handles for them.
435 isp_dma_addr_t isp_rquest_dma;
436 isp_dma_addr_t isp_result_dma;
439 #define SDPARAM(isp) ((sdparam *) (isp)->isp_param)
440 #define FCPARAM(isp) ((fcparam *) (isp)->isp_param)
443 * ISP Driver Run States
445 #define ISP_NILSTATE 0
446 #define ISP_RESETSTATE 1
447 #define ISP_INITSTATE 2
448 #define ISP_RUNSTATE 3
451 * ISP Configuration Options
453 #define ISP_CFG_NORELOAD 0x80 /* don't download f/w */
454 #define ISP_CFG_NONVRAM 0x40 /* ignore NVRAM */
455 #define ISP_CFG_TWOGB 0x20 /* force 2GB connection (23XX only) */
456 #define ISP_CFG_ONEGB 0x10 /* force 1GB connection (23XX only) */
457 #define ISP_CFG_FULL_DUPLEX 0x01 /* Full Duplex (Fibre Channel only) */
458 #define ISP_CFG_PORT_PREF 0x0C /* Mask for Port Prefs (2200 only) */
459 #define ISP_CFG_LPORT 0x00 /* prefer {N/F}L-Port connection */
460 #define ISP_CFG_NPORT 0x04 /* prefer {N/F}-Port connection */
461 #define ISP_CFG_NPORT_ONLY 0x08 /* insist on {N/F}-Port connection */
462 #define ISP_CFG_LPORT_ONLY 0x0C /* insist on {N/F}L-Port connection */
463 #define ISP_CFG_OWNWWPN 0x100 /* override NVRAM wwpn */
464 #define ISP_CFG_OWNWWNN 0x200 /* override NVRAM wwnn */
465 #define ISP_CFG_OWNFSZ 0x400 /* override NVRAM frame size */
466 #define ISP_CFG_OWNLOOPID 0x800 /* override NVRAM loopid */
467 #define ISP_CFG_OWNEXCTHROTTLE 0x1000 /* override NVRAM execution throttle */
470 * Prior to calling isp_reset for the first time, the outer layer
471 * should set isp_role to one of NONE, INITIATOR, TARGET, BOTH.
473 * If you set ISP_ROLE_NONE, the cards will be reset, new firmware loaded,
474 * NVRAM read, and defaults set, but any further initialization (e.g.
475 * INITIALIZE CONTROL BLOCK commands for 2X00 cards) won't be done.
477 * If INITIATOR MODE isn't set, attempts to run commands will be stopped
478 * at isp_start and completed with the moral equivalent of SELECTION TIMEOUT.
480 * If TARGET MODE is set, it doesn't mean that the rest of target mode support
481 * needs to be enabled, or will even work. What happens with the 2X00 cards
482 * here is that if you have enabled it with TARGET MODE as part of the ICB
483 * options, but you haven't given the f/w any ram resources for ATIOs or
484 * Immediate Notifies, the f/w just handles what it can and you never see
485 * anything. Basically, it sends a single byte of data (the first byte,
486 * which you can set as part of the INITIALIZE CONTROL BLOCK command) for
487 * INQUIRY, and sends back QUEUE FULL status for any other command.
490 #define ISP_ROLE_NONE 0x0
491 #define ISP_ROLE_INITIATOR 0x1
492 #define ISP_ROLE_TARGET 0x2
493 #define ISP_ROLE_BOTH (ISP_ROLE_TARGET|ISP_ROLE_INITIATOR)
494 #define ISP_ROLE_EITHER ISP_ROLE_BOTH
495 #ifndef ISP_DEFAULT_ROLES
496 #define ISP_DEFAULT_ROLES ISP_ROLE_INITIATOR
501 * Firmware related defines
503 #define ISP_CODE_ORG 0x1000 /* default f/w code start */
504 #define ISP_CODE_ORG_2300 0x0800 /* ..except for 2300s */
505 #define ISP_FW_REV(maj, min, mic) ((maj << 24) | (min << 16) | mic)
506 #define ISP_FW_MAJOR(code) ((code >> 24) & 0xff)
507 #define ISP_FW_MINOR(code) ((code >> 16) & 0xff)
508 #define ISP_FW_MICRO(code) ((code >> 8) & 0xff)
509 #define ISP_FW_REVX(xp) ((xp[0]<<24) | (xp[1] << 16) | xp[2])
510 #define ISP_FW_MAJORX(xp) (xp[0])
511 #define ISP_FW_MINORX(xp) (xp[1])
512 #define ISP_FW_MICROX(xp) (xp[2])
513 #define ISP_FW_NEWER_THAN(i, major, minor, micro) \
514 (ISP_FW_REVX((i)->isp_fwrev) > ISP_FW_REV(major, minor, micro))
517 * Bus (implementation) types
519 #define ISP_BT_PCI 0 /* PCI Implementations */
520 #define ISP_BT_SBUS 1 /* SBus Implementations */
523 * If we have not otherwise defined SBus support away make sure
524 * it is defined here such that the code is included as default
526 #ifndef ISP_SBUS_SUPPORTED
527 #define ISP_SBUS_SUPPORTED 1
533 #define ISP_HA_SCSI 0xf
534 #define ISP_HA_SCSI_UNKNOWN 0x1
535 #define ISP_HA_SCSI_1020 0x2
536 #define ISP_HA_SCSI_1020A 0x3
537 #define ISP_HA_SCSI_1040 0x4
538 #define ISP_HA_SCSI_1040A 0x5
539 #define ISP_HA_SCSI_1040B 0x6
540 #define ISP_HA_SCSI_1040C 0x7
541 #define ISP_HA_SCSI_1240 0x8
542 #define ISP_HA_SCSI_1080 0x9
543 #define ISP_HA_SCSI_1280 0xa
544 #define ISP_HA_SCSI_10160 0xb
545 #define ISP_HA_SCSI_12160 0xc
546 #define ISP_HA_FC 0xf0
547 #define ISP_HA_FC_2100 0x10
548 #define ISP_HA_FC_2200 0x20
549 #define ISP_HA_FC_2300 0x30
550 #define ISP_HA_FC_2312 0x40
552 #define IS_SCSI(isp) (isp->isp_type & ISP_HA_SCSI)
553 #define IS_1240(isp) (isp->isp_type == ISP_HA_SCSI_1240)
554 #define IS_1080(isp) (isp->isp_type == ISP_HA_SCSI_1080)
555 #define IS_1280(isp) (isp->isp_type == ISP_HA_SCSI_1280)
556 #define IS_10160(isp) (isp->isp_type == ISP_HA_SCSI_10160)
557 #define IS_12160(isp) (isp->isp_type == ISP_HA_SCSI_12160)
559 #define IS_12X0(isp) (IS_1240(isp) || IS_1280(isp))
560 #define IS_1X160(isp) (IS_10160(isp) || IS_12160(isp))
561 #define IS_DUALBUS(isp) (IS_12X0(isp) || IS_12160(isp))
562 #define IS_ULTRA2(isp) (IS_1080(isp) || IS_1280(isp) || IS_1X160(isp))
563 #define IS_ULTRA3(isp) (IS_1X160(isp))
565 #define IS_FC(isp) ((isp)->isp_type & ISP_HA_FC)
566 #define IS_2100(isp) ((isp)->isp_type == ISP_HA_FC_2100)
567 #define IS_2200(isp) ((isp)->isp_type == ISP_HA_FC_2200)
568 #define IS_23XX(isp) ((isp)->isp_type >= ISP_HA_FC_2300)
569 #define IS_2300(isp) ((isp)->isp_type == ISP_HA_FC_2300)
570 #define IS_2312(isp) ((isp)->isp_type == ISP_HA_FC_2312)
575 #ifdef ISP_DAC_SUPPORTRED
576 #define DMA_WD3(x) (((x) >> 48) & 0xffff)
577 #define DMA_WD2(x) (((x) >> 32) & 0xffff)
582 #define DMA_WD1(x) (((x) >> 16) & 0xffff)
583 #define DMA_WD0(x) (((x) & 0xffff))
586 * Core System Function Prototypes
590 * Reset Hardware. Totally. Assumes that you'll follow this with
591 * a call to isp_init.
593 void isp_reset(struct ispsoftc *);
596 * Initialize Hardware to known state
598 void isp_init(struct ispsoftc *);
601 * Reset the ISP and call completion for any orphaned commands.
603 void isp_reinit(struct ispsoftc *);
605 #ifdef ISP_FW_CRASH_DUMP
607 * Dump firmware entry point.
609 void isp_fw_dump(struct ispsoftc *isp);
613 * Internal Interrupt Service Routine
615 * The outer layers do the spade work to get the appropriate status register,
616 * semaphore register and first mailbox register (if appropriate). This also
617 * means that most spurious/bogus interrupts not for us can be filtered first.
619 void isp_intr(struct ispsoftc *, u_int16_t, u_int16_t, u_int16_t);
623 * Command Entry Point- Platform Dependent layers call into this
625 int isp_start(XS_T *);
626 /* these values are what isp_start returns */
627 #define CMD_COMPLETE 101 /* command completed */
628 #define CMD_EAGAIN 102 /* busy- maybe retry later */
629 #define CMD_QUEUED 103 /* command has been queued for execution */
630 #define CMD_RQLATER 104 /* requeue this command later */
633 * Command Completion Point- Core layers call out from this with completed cmds
635 void isp_done(XS_T *);
638 * Platform Dependent to External to Internal Control Function
640 * Assumes locks are held on entry. You should note that with many of
641 * these commands and locks may be released while this is occurring.
643 * A few notes about some of these functions:
645 * ISPCTL_FCLINK_TEST tests to make sure we have good fibre channel link.
646 * The argument is a pointer to an integer which is the time, in microseconds,
647 * we should wait to see whether we have good link. This test, if successful,
648 * lets us know our connection topology and our Loop ID/AL_PA and so on.
649 * You can't get anywhere without this.
651 * ISPCTL_SCAN_FABRIC queries the name server (if we're on a fabric) for
652 * all entities using the FC Generic Services subcommand GET ALL NEXT.
653 * For each found entity, an ISPASYNC_FABRICDEV event is generated (see
656 * ISPCTL_SCAN_LOOP does a local loop scan. This is only done if the connection
657 * topology is NL or FL port (private or public loop). Since the Qlogic f/w
658 * 'automatically' manages local loop connections, this function essentially
659 * notes the arrival, departure, and possible shuffling around of local loop
660 * entities. Thus for each arrival and departure this generates an isp_async
661 * event of ISPASYNC_PROMENADE (see below).
663 * ISPCTL_PDB_SYNC is somewhat misnamed. It actually is the final step, in
664 * order, of ISPCTL_FCLINK_TEST, ISPCTL_SCAN_FABRIC, and ISPCTL_SCAN_LOOP.
665 * The main purpose of ISPCTL_PDB_SYNC is to complete management of logging
666 * and logging out of fabric devices (if one is on a fabric) and then marking
667 * the 'loop state' as being ready to now be used for sending commands to
668 * devices. Originally fabric name server and local loop scanning were
669 * part of this function. It's now been separated to allow for finer control.
672 ISPCTL_RESET_BUS, /* Reset Bus */
673 ISPCTL_RESET_DEV, /* Reset Device */
674 ISPCTL_ABORT_CMD, /* Abort Command */
675 ISPCTL_UPDATE_PARAMS, /* Update Operating Parameters (SCSI) */
676 ISPCTL_FCLINK_TEST, /* Test FC Link Status */
677 ISPCTL_SCAN_FABRIC, /* (Re)scan Fabric Name Server */
678 ISPCTL_SCAN_LOOP, /* (Re)scan Local Loop */
679 ISPCTL_PDB_SYNC, /* Synchronize Port Database */
680 ISPCTL_SEND_LIP, /* Send a LIP */
681 ISPCTL_GET_POSMAP, /* Get FC-AL position map */
682 ISPCTL_RUN_MBOXCMD, /* run a mailbox command */
683 ISPCTL_TOGGLE_TMODE /* toggle target mode */
685 int isp_control(struct ispsoftc *, ispctl_t, void *);
689 * Platform Dependent to Internal to External Control Function
690 * (each platform must provide such a function)
692 * Assumes locks are held.
694 * A few notes about some of these functions:
696 * ISPASYNC_CHANGE_NOTIFY notifies the outer layer that a change has
697 * occurred that invalidates the list of fabric devices known and/or
698 * the list of known loop devices. The argument passed is a pointer
699 * whose values are defined below (local loop change, name server
700 * change, other). 'Other' may simply be a LIP, or a change in
701 * connection topology.
703 * ISPASYNC_FABRIC_DEV announces the next element in a list of
704 * fabric device names we're getting out of the name server. The
705 * argument points to a GET ALL NEXT response structure. The list
706 * is known to terminate with an entry that refers to ourselves.
707 * One of the main purposes of this function is to allow outer
708 * layers, which are OS dependent, to set policy as to which fabric
709 * devices might actually be logged into (and made visible) later
710 * at ISPCTL_PDB_SYNC time. Since there's a finite number of fabric
711 * devices that we can log into (256 less 3 'reserved' for F-port
712 * topologies), and fabrics can grow up to 8 million or so entries
713 * (24 bits of Port Address, less a wad of reserved spaces), clearly
714 * we had better let the OS determine login policy.
716 * ISPASYNC_PROMENADE has an argument that is a pointer to an integer which
717 * is an index into the portdb in the softc ('target'). Whether that entry's
718 * valid tag is set or not says whether something has arrived or departed.
719 * The name refers to a favorite pastime of many city dwellers- watching
720 * people come and go, talking of Michaelangelo, and so on..
722 * ISPASYNC_UNHANDLED_RESPONSE gives outer layers a chance to parse a
723 * response queue entry not otherwise handled. The outer layer should
724 * return non-zero if it handled it. The 'arg' points to an unmassaged
725 * response queue entry.
729 ISPASYNC_NEW_TGT_PARAMS, /* New Target Parameters Negotiated */
730 ISPASYNC_BUS_RESET, /* Bus Was Reset */
731 ISPASYNC_LOOP_DOWN, /* FC Loop Down */
732 ISPASYNC_LOOP_UP, /* FC Loop Up */
733 ISPASYNC_LIP, /* LIP Received */
734 ISPASYNC_LOOP_RESET, /* Loop Reset Received */
735 ISPASYNC_CHANGE_NOTIFY, /* FC Change Notification */
736 ISPASYNC_FABRIC_DEV, /* FC Fabric Device Arrival */
737 ISPASYNC_PROMENADE, /* FC Objects coming && going */
738 ISPASYNC_TARGET_MESSAGE, /* target message */
739 ISPASYNC_TARGET_EVENT, /* target asynchronous event */
740 ISPASYNC_TARGET_ACTION, /* other target command action */
741 ISPASYNC_CONF_CHANGE, /* Platform Configuration Change */
742 ISPASYNC_UNHANDLED_RESPONSE, /* Unhandled Response Entry */
743 ISPASYNC_FW_CRASH, /* Firmware has crashed */
744 ISPASYNC_FW_DUMPED, /* Firmware crashdump taken */
745 ISPASYNC_FW_RESTARTED /* Firmware has been restarted */
747 int isp_async(struct ispsoftc *, ispasync_t, void *);
749 #define ISPASYNC_CHANGE_PDB ((void *) 0)
750 #define ISPASYNC_CHANGE_SNS ((void *) 1)
751 #define ISPASYNC_CHANGE_OTHER ((void *) 2)
754 * Platform Dependent Error and Debug Printout
757 void isp_prt(struct ispsoftc *, int level, const char *, ...)
758 __attribute__((__format__(__printf__,3,4)));
760 void isp_prt(struct ispsoftc *, int level, const char *, ...);
763 #define ISP_LOGALL 0x0 /* log always */
764 #define ISP_LOGCONFIG 0x1 /* log configuration messages */
765 #define ISP_LOGINFO 0x2 /* log informational messages */
766 #define ISP_LOGWARN 0x4 /* log warning messages */
767 #define ISP_LOGERR 0x8 /* log error messages */
768 #define ISP_LOGDEBUG0 0x10 /* log simple debug messages */
769 #define ISP_LOGDEBUG1 0x20 /* log intermediate debug messages */
770 #define ISP_LOGDEBUG2 0x40 /* log most debug messages */
771 #define ISP_LOGDEBUG3 0x80 /* log high frequency debug messages */
772 #define ISP_LOGDEBUG4 0x100 /* log high frequency debug messages */
773 #define ISP_LOGTDEBUG0 0x200 /* log simple debug messages (target mode) */
774 #define ISP_LOGTDEBUG1 0x400 /* log intermediate debug messages (target) */
775 #define ISP_LOGTDEBUG2 0x800 /* log all debug messages (target) */
778 * Each Platform provides it's own isposinfo substructure of the ispsoftc
781 * Each platform must also provide the following macros/defines:
784 * INLINE - platform specific define for 'inline' functions
786 * ISP_DAC_SUPPORTED - Is DAC (Dual Address Cycle) is supported?
787 * Basically means whether or not DMA for PCI
788 * PCI cards (Ultra2 or better or FC) works
791 * ISP2100_SCRLEN - length for the Fibre Channel scratch DMA area
793 * MEMZERO(dst, src) platform zeroing function
794 * MEMCPY(dst, src, count) platform copying function
795 * SNPRINTF(buf, bufsize, fmt, ...) ksnprintf
796 * USEC_DELAY(usecs) microsecond spindelay function
797 * USEC_SLEEP(isp, usecs) microsecond sleep function
799 * NANOTIME_T nanosecond time type
801 * GET_NANOTIME(NANOTIME_T *) get current nanotime.
803 * GET_NANOSEC(NANOTIME_T *) get u_int64_t from NANOTIME_T
805 * NANOTIME_SUB(NANOTIME_T *, NANOTIME_T *)
806 * subtract two NANOTIME_T values
809 * MAXISPREQUEST(struct ispsoftc *) maximum request queue size
810 * for this particular board type
812 * MEMORYBARRIER(struct ispsoftc *, barrier_type, offset, size)
814 * Function/Macro the provides memory synchronization on
815 * various objects so that the ISP's and the system's view
816 * of the same object is consistent.
818 * MBOX_ACQUIRE(struct ispsoftc *) acquire lock on mailbox regs
819 * MBOX_WAIT_COMPLETE(struct ispsoftc *) wait for mailbox cmd to be done
820 * MBOX_NOTIFY_COMPLETE(struct ispsoftc *) notification of mbox cmd donee
821 * MBOX_RELEASE(struct ispsoftc *) release lock on mailbox regs
823 * FC_SCRATCH_ACQUIRE(struct ispsoftc *) acquire lock on FC scratch area
824 * FC_SCRATCH_RELEASE(struct ispsoftc *) acquire lock on FC scratch area
826 * SCSI_GOOD SCSI 'Good' Status
827 * SCSI_CHECK SCSI 'Check Condition' Status
828 * SCSI_BUSY SCSI 'Busy' Status
829 * SCSI_QFULL SCSI 'Queue Full' Status
831 * XS_T Platform SCSI transaction type (i.e., command for HBA)
832 * XS_ISP(xs) gets an instance out of an XS_T
833 * XS_CHANNEL(xs) gets the channel (bus # for DUALBUS cards) ""
834 * XS_TGT(xs) gets the target ""
835 * XS_LUN(xs) gets the lun ""
836 * XS_CDBP(xs) gets a pointer to the scsi CDB ""
837 * XS_CDBLEN(xs) gets the CDB's length ""
838 * XS_XFRLEN(xs) gets the associated data transfer length ""
839 * XS_TIME(xs) gets the time (in milliseconds) for this command
840 * XS_RESID(xs) gets the current residual count
841 * XS_STSP(xs) gets a pointer to the SCSI status byte ""
842 * XS_SNSP(xs) gets a pointer to the associate sense data
843 * XS_SNSLEN(xs) gets the length of sense data storage
844 * XS_SNSKEY(xs) dereferences XS_SNSP to get the current stored Sense Key
845 * XS_TAG_P(xs) predicate of whether this command should be tagged
846 * XS_TAG_TYPE(xs) which type of tag to use
847 * XS_SETERR(xs) set error state
849 * HBA_NOERROR command has no erros
850 * HBA_BOTCH hba botched something
851 * HBA_CMDTIMEOUT command timed out
852 * HBA_SELTIMEOUT selection timed out (also port logouts for FC)
853 * HBA_TGTBSY target returned a BUSY status
854 * HBA_BUSRESET bus reset destroyed command
855 * HBA_ABORTED command was aborted (by request)
856 * HBA_DATAOVR a data overrun was detected
857 * HBA_ARQFAIL Automatic Request Sense failed
859 * XS_ERR(xs) return current error state
860 * XS_NOERR(xs) there is no error currently set
861 * XS_INITERR(xs) initialize error state
863 * XS_SAVE_SENSE(xs, sp) save sense data
865 * XS_SET_STATE_STAT(isp, sp, xs) platform dependent interpreter of
866 * response queue entry status bits
869 * DEFAULT_IID(struct ispsoftc *) Default SCSI initiator ID
870 * DEFAULT_LOOPID(struct ispsoftc *) Default FC Loop ID
871 * DEFAULT_NODEWWN(struct ispsoftc *) Default Node WWN
872 * DEFAULT_PORTWWN(struct ispsoftc *) Default Port WWN
873 * DEFAULT_FRAMESIZE(struct ispsoftc *) Default Frame Size
874 * DEFAULT_EXEC_THROTTLE(struct ispsoftc *) Default Execution Throttle
875 * These establish reasonable defaults for each platform.
876 * These must be available independent of card NVRAM and are
877 * to be used should NVRAM not be readable.
879 * ISP_NODEWWN(struct ispsoftc *) FC Node WWN to use
880 * ISP_PORTWWN(struct ispsoftc *) FC Port WWN to use
882 * These are to be used after NVRAM is read. The tags
883 * in fcparam.isp_{node,port}wwn reflect the values
884 * read from NVRAM (possibly corrected for card botches).
885 * Each platform can take that information and override
886 * it or ignore and return the Node and Port WWNs to be
887 * used when sending the Qlogic f/w the Initialization Control
890 * (XXX these do endian specific transformations- in transition XXX)
892 * ISP_IOXPUT_8(struct ispsoftc *, u_int8_t srcval, u_int8_t *dstptr)
893 * ISP_IOXPUT_16(struct ispsoftc *, u_int16_t srcval, u_int16_t *dstptr)
894 * ISP_IOXPUT_32(struct ispsoftc *, u_int32_t srcval, u_int32_t *dstptr)
896 * ISP_IOXGET_8(struct ispsoftc *, u_int8_t *srcptr, u_int8_t dstrval)
897 * ISP_IOXGET_16(struct ispsoftc *, u_int16_t *srcptr, u_int16_t dstrval)
898 * ISP_IOXGET_32(struct ispsoftc *, u_int32_t *srcptr, u_int32_t dstrval)
900 * ISP_SWIZZLE_NVRAM_WORD(struct ispsoftc *, u_int16_t *)
903 #endif /* _ISPVAR_H */