3 * Copyright (c) 1997-2009 by Matthew Jacob
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
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.
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
30 * Soft Definitions for for Qlogic ISP SCSI adapters.
36 #if defined(__NetBSD__) || defined(__OpenBSD__)
37 #include <dev/ic/isp_stds.h>
38 #include <dev/ic/ispmbox.h>
41 #include <dev/isp/isp_stds.h>
42 #include <dev/isp/ispmbox.h>
53 #define ISP_CORE_VERSION_MAJOR 7
54 #define ISP_CORE_VERSION_MINOR 0
57 * Vector for bus specific code to provide specific services.
59 typedef struct ispsoftc ispsoftc_t;
61 void (*dv_run_isr) (ispsoftc_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 int (*dv_irqsetup) (ispsoftc_t *);
68 void (*dv_dregs) (ispsoftc_t *, const char *);
69 const void * dv_ispfw; /* ptr to f/w */
71 uint16_t dv_clock; /* clock frequency */
77 #define MAX_TARGETS 16
79 #define MAX_FC_TARG 1024
81 #define ISP_MAX_TARGETS(isp) (IS_FC(isp)? MAX_FC_TARG : MAX_TARGETS)
82 #define ISP_MAX_LUNS(isp) (isp)->isp_maxluns
83 #define ISP_MAX_IRQS 3
86 * Macros to access ISP registers through bus specific layers-
87 * mostly wrappers to vector through the mdvec structure.
89 #define ISP_RUN_ISR(isp) \
90 (*(isp)->isp_mdvec->dv_run_isr)(isp)
92 #define ISP_READ(isp, reg) \
93 (*(isp)->isp_mdvec->dv_rd_reg)((isp), (reg))
95 #define ISP_WRITE(isp, reg, val) \
96 (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), (val))
98 #define ISP_MBOXDMASETUP(isp) \
99 (*(isp)->isp_mdvec->dv_mbxdma)((isp))
101 #define ISP_DMASETUP(isp, xs, req) \
102 (*(isp)->isp_mdvec->dv_dmaset)((isp), (xs), (req))
104 #define ISP_DMAFREE(isp, xs, hndl) \
105 if ((isp)->isp_mdvec->dv_dmaclr) \
106 (*(isp)->isp_mdvec->dv_dmaclr)((isp), (xs), (hndl))
108 #define ISP_IRQSETUP(isp) \
109 (((isp)->isp_mdvec->dv_irqsetup) ? (*(isp)->isp_mdvec->dv_irqsetup)(isp) : 0)
110 #define ISP_DUMPREGS(isp, m) \
111 if ((isp)->isp_mdvec->dv_dregs) (*(isp)->isp_mdvec->dv_dregs)((isp),(m))
113 #define ISP_SETBITS(isp, reg, val) \
114 (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), ISP_READ((isp), (reg)) | (val))
116 #define ISP_CLRBITS(isp, reg, val) \
117 (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), ISP_READ((isp), (reg)) & ~(val))
120 * The MEMORYBARRIER macro is defined per platform (to provide synchronization
121 * on Request and Response Queues, Scratch DMA areas, and Registers)
123 * Defined Memory Barrier Synchronization Types
125 #define SYNC_REQUEST 0 /* request queue synchronization */
126 #define SYNC_RESULT 1 /* result queue synchronization */
127 #define SYNC_SFORDEV 2 /* scratch, sync for ISP */
128 #define SYNC_SFORCPU 3 /* scratch, sync for CPU */
129 #define SYNC_REG 4 /* for registers */
130 #define SYNC_ATIOQ 5 /* atio result queue (24xx) */
131 #define SYNC_IFORDEV 6 /* synchrounous IOCB, sync for ISP */
132 #define SYNC_IFORCPU 7 /* synchrounous IOCB, sync for CPU */
135 * Request/Response Queue defines and macros.
136 * The maximum is defined per platform (and can be based on board type).
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)
145 #define RESULT_QUEUE_LEN(x) \
146 (((MAXISPREQUEST(x) >> 2) < 64)? 64 : MAXISPREQUEST(x) >> 2)
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))
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
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)
168 * SCSI Specific Host Adapter Parameters- per bus, per target
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,
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;
196 dev_enable : 1, /* ignored */
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];
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))
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
239 * Fibre Channel Specifics
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 */
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
256 * "Unassigned" handle to be used internally
258 #define NIL_HANDLE 0xffff
261 * Limit for devices on an arbitrated loop.
263 #define LOCAL_LOOP_LIM 126
266 * Limit for (2K login) N-port handle amounts
268 #define MAX_NPORT_HANDLE 2048
273 #define INI_NONE ((uint64_t) 0)
274 #define ISP_NOCHAN 0xff
279 #define MANAGEMENT_PORT_ID 0xFFFFFA
280 #define SNS_PORT_ID 0xFFFFFC
281 #define FABRIC_PORT_ID 0xFFFFFE
282 #define PORT_ANY 0xFFFFFF
284 #define VALID_PORT(port) (port != PORT_NONE && port != PORT_ANY)
285 #define DOMAIN_CONTROLLER_BASE 0xFFFC00
286 #define DOMAIN_CONTROLLER_END 0xFFFCFF
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.
297 * The handle is architected thusly:
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
307 void * cmd; /* associated command context */
308 uint32_t handle; /* handle associated with this command */
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
332 * FC Port Database entry.
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).
338 * It has a state. If the state if VALID, that means that we've logged into
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.
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).
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.
357 * When we get done searching the local loop, we then search similarly 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 similarly.
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.
365 * Negative invariants that we try and test for are:
367 * + There can never be two non-NIL entries with the same { Port, Node } WWN
370 * + There can never be two non-NIL entries with the same handle.
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
381 * PRLI word 3 parameters contains role as well as other things.
383 * The state is the current state of this entry.
385 * The is_target is the current state of target on this port.
387 * The is_initiator is the current state of initiator on this port.
389 * Portid is obvious, as are node && port WWNs. The new_role and
390 * new_portid is for when we are pending a change.
392 uint16_t prli_word3; /* PRLI parameters */
393 uint16_t new_prli_word3; /* Incoming new PRLI parameters */
409 #define FC_PORTDB_STATE_NIL 0 /* Empty DB slot */
410 #define FC_PORTDB_STATE_DEAD 1 /* Was valid, but no more. */
411 #define FC_PORTDB_STATE_CHANGED 2 /* Was valid, but changed. */
412 #define FC_PORTDB_STATE_NEW 3 /* Logged in, not announced. */
413 #define FC_PORTDB_STATE_ZOMBIE 4 /* Invalid, but announced. */
414 #define FC_PORTDB_STATE_VALID 5 /* Valid */
416 #define FC_PORTDB_TGT(isp, bus, pdb) (int)(lp - FCPARAM(isp, bus)->portdb)
419 * FC card specific information
421 * This structure is replicated across multiple channels for multi-id
422 * capapble chipsets, with some entities different on a per-channel basis.
426 int isp_gbspeed; /* Connection speed */
427 int isp_linkstate; /* Link state */
428 int isp_fwstate; /* ISP F/W state */
429 int isp_loopstate; /* Loop State */
430 int isp_topo; /* Connection Type */
436 isp_portid : 24; /* S_ID */
438 uint16_t isp_fwoptions;
439 uint16_t isp_xfwoptions;
440 uint16_t isp_zfwoptions;
441 uint16_t isp_loopid; /* hard loop id */
442 uint16_t isp_sns_hdl; /* N-port handle for SNS */
443 uint16_t isp_lasthdl; /* only valid for channel 0 */
444 uint16_t isp_maxalloc;
445 uint16_t isp_fabric_params;
446 uint16_t isp_login_hdl; /* Logging in handle */
447 uint8_t isp_retry_delay;
448 uint8_t isp_retry_count;
451 * Current active WWNN/WWPN
459 uint64_t isp_wwnn_nvram;
460 uint64_t isp_wwpn_nvram;
465 fcportdb_t portdb[MAX_FC_TARG];
468 * Scratch DMA mapped in area to fetch Port Database stuff, etc.
471 XS_DMA_ADDR_T isp_scdma;
473 uint8_t isp_scanscratch[ISP_FC_SCRLEN];
476 #define FW_CONFIG_WAIT 0
477 #define FW_WAIT_LINK 1
478 #define FW_WAIT_LOGIN 2
480 #define FW_LOSS_OF_SYNC 4
483 #define FW_NON_PART 7
486 #define LOOP_HAVE_LINK 1
487 #define LOOP_HAVE_ADDR 2
488 #define LOOP_TESTING_LINK 3
489 #define LOOP_LTEST_DONE 4
490 #define LOOP_SCANNING_LOOP 5
491 #define LOOP_LSCAN_DONE 6
492 #define LOOP_SCANNING_FABRIC 7
493 #define LOOP_FSCAN_DONE 8
494 #define LOOP_SYNCING_PDB 9
495 #define LOOP_READY 10
497 #define TOPO_NL_PORT 0
498 #define TOPO_FL_PORT 1
499 #define TOPO_N_PORT 2
500 #define TOPO_F_PORT 3
501 #define TOPO_PTP_STUB 4
503 #define TOPO_IS_FABRIC(x) ((x) == TOPO_FL_PORT || (x) == TOPO_F_PORT)
505 #define FCP_AL_DA_ALL 0xFF
506 #define FCP_AL_PA(fcp) ((uint8_t)(fcp->isp_portid))
507 #define FCP_IS_DEST_ALPD(fcp, alpd) (FCP_AL_PA((fcp)) == FCP_AL_DA_ALL || FCP_AL_PA((fcp)) == alpd)
510 * Soft Structure per host adapter
514 * Platform (OS) specific data
516 struct isposinfo isp_osinfo;
519 * Pointer to bus specific functions and data
521 struct ispmdvec * isp_mdvec;
524 * (Mostly) nonvolatile state. Board specific parameters
525 * may contain some volatile state (e.g., current loop state).
528 void * isp_param; /* type specific */
529 uint64_t isp_fwattr; /* firmware attributes */
530 uint16_t isp_fwrev[3]; /* Loaded F/W revision */
531 uint16_t isp_maxcmds; /* max possible I/O cmds */
532 uint8_t isp_type; /* HBA Chip Type */
533 uint8_t isp_revision; /* HBA Chip H/W Revision */
534 uint8_t isp_nirq; /* number of IRQs */
535 uint16_t isp_nchan; /* number of channels */
536 uint32_t isp_maxluns; /* maximum luns supported */
538 uint32_t isp_clock : 8, /* input clock */
540 isp_port : 1, /* 23XX/24XX only */
541 isp_bustype : 1, /* SBus or PCI */
542 isp_loaded_fw : 1, /* loaded firmware */
543 isp_dblev : 16; /* debug log mask */
546 uint32_t isp_confopts; /* config options */
548 uint32_t isp_rqstinrp; /* register for REQINP */
549 uint32_t isp_rqstoutrp; /* register for REQOUTP */
550 uint32_t isp_respinrp; /* register for RESINP */
551 uint32_t isp_respoutrp; /* register for RESOUTP */
557 volatile u_int isp_mboxbsy; /* mailbox command active */
558 volatile u_int isp_state;
559 volatile mbreg_t isp_curmbx; /* currently active mailbox command */
560 volatile uint32_t isp_reqodx; /* index of last ISP pickup */
561 volatile uint32_t isp_reqidx; /* index of next request */
562 volatile uint32_t isp_residx; /* index of last ISP write */
563 volatile uint32_t isp_resodx; /* index of next result */
564 volatile uint32_t isp_atioodx; /* index of next ATIO */
565 volatile uint32_t isp_obits; /* mailbox command output */
566 volatile uint32_t isp_serno; /* rolling serial number */
567 volatile uint16_t isp_mboxtmp[MAX_MAILBOX];
568 volatile uint16_t isp_lastmbxcmd; /* last mbox command sent */
569 volatile uint16_t isp_seqno; /* running sequence number */
572 * Active commands are stored here, indexed by handle functions.
574 isp_hdl_t *isp_xflist;
575 isp_hdl_t *isp_xffree;
578 * DMA mapped in area for synchronous IOCB requests.
581 XS_DMA_ADDR_T isp_iocb_dma;
584 * request/result queue pointers and DMA handles for them.
588 XS_DMA_ADDR_T isp_rquest_dma;
589 XS_DMA_ADDR_T isp_result_dma;
590 #ifdef ISP_TARGET_MODE
593 XS_DMA_ADDR_T isp_atioq_dma;
597 #define SDPARAM(isp, chan) (&((sdparam *)(isp)->isp_param)[(chan)])
598 #define FCPARAM(isp, chan) (&((fcparam *)(isp)->isp_param)[(chan)])
600 #define ISP_SET_SENDMARKER(isp, chan, val) \
602 FCPARAM(isp, chan)->sendmarker = val; \
604 SDPARAM(isp, chan)->sendmarker = val; \
607 #define ISP_TST_SENDMARKER(isp, chan) \
609 FCPARAM(isp, chan)->sendmarker != 0 : \
610 SDPARAM(isp, chan)->sendmarker != 0)
613 * ISP Driver Run States
615 #define ISP_NILSTATE 0
616 #define ISP_CRASHED 1
617 #define ISP_RESETSTATE 2
618 #define ISP_INITSTATE 3
619 #define ISP_RUNSTATE 4
622 * ISP Runtime Configuration Options
624 #define ISP_CFG_FULL_DUPLEX 0x01 /* Full Duplex (Fibre Channel only) */
625 #define ISP_CFG_PORT_PREF 0x0e /* Mask for Port Prefs (all FC except 2100) */
626 #define ISP_CFG_PORT_DEF 0x00 /* prefer connection type from NVRAM */
627 #define ISP_CFG_LPORT_ONLY 0x02 /* insist on {N/F}L-Port connection */
628 #define ISP_CFG_NPORT_ONLY 0x04 /* insist on {N/F}-Port connection */
629 #define ISP_CFG_LPORT 0x06 /* prefer {N/F}L-Port connection */
630 #define ISP_CFG_NPORT 0x08 /* prefer {N/F}-Port connection */
631 #define ISP_CFG_1GB 0x10 /* force 1GB connection (23XX only) */
632 #define ISP_CFG_2GB 0x20 /* force 2GB connection (23XX only) */
633 #define ISP_CFG_NORELOAD 0x80 /* don't download f/w */
634 #define ISP_CFG_NONVRAM 0x40 /* ignore NVRAM */
635 #define ISP_CFG_NOFCTAPE 0x100 /* disable FC-Tape */
636 #define ISP_CFG_FCTAPE 0x200 /* enable FC-Tape */
637 #define ISP_CFG_OWNFSZ 0x400 /* override NVRAM frame size */
638 #define ISP_CFG_OWNLOOPID 0x800 /* override NVRAM loopid */
639 #define ISP_CFG_OWNEXCTHROTTLE 0x1000 /* override NVRAM execution throttle */
640 #define ISP_CFG_4GB 0x2000 /* force 4GB connection (24XX only) */
641 #define ISP_CFG_8GB 0x4000 /* force 8GB connection (25XX only) */
642 #define ISP_CFG_16GB 0x8000 /* force 16GB connection (82XX only) */
645 * For each channel, the outer layers should know what role that channel
646 * will take: ISP_ROLE_NONE, ISP_ROLE_INITIATOR, ISP_ROLE_TARGET,
649 * If you set ISP_ROLE_NONE, the cards will be reset, new firmware loaded,
650 * NVRAM read, and defaults set, but any further initialization (e.g.
651 * INITIALIZE CONTROL BLOCK commands for 2X00 cards) won't be done.
653 * If INITIATOR MODE isn't set, attempts to run commands will be stopped
654 * at isp_start and completed with the equivalent of SELECTION TIMEOUT.
656 * If TARGET MODE is set, it doesn't mean that the rest of target mode support
657 * needs to be enabled, or will even work. What happens with the 2X00 cards
658 * here is that if you have enabled it with TARGET MODE as part of the ICB
659 * options, but you haven't given the f/w any ram resources for ATIOs or
660 * Immediate Notifies, the f/w just handles what it can and you never see
661 * anything. Basically, it sends a single byte of data (the first byte,
662 * which you can set as part of the INITIALIZE CONTROL BLOCK command) for
663 * INQUIRY, and sends back QUEUE FULL status for any other command.
666 #define ISP_ROLE_NONE 0x0
667 #define ISP_ROLE_TARGET 0x1
668 #define ISP_ROLE_INITIATOR 0x2
669 #define ISP_ROLE_BOTH (ISP_ROLE_TARGET|ISP_ROLE_INITIATOR)
670 #define ISP_ROLE_EITHER ISP_ROLE_BOTH
671 #ifndef ISP_DEFAULT_ROLES
673 * Counterintuitively, we prefer to default to role 'none'
674 * if we are enable target mode support. This gives us the
675 * maximum flexibility as to which port will do what.
677 #ifdef ISP_TARGET_MODE
678 #define ISP_DEFAULT_ROLES ISP_ROLE_NONE
680 #define ISP_DEFAULT_ROLES ISP_ROLE_INITIATOR
686 * Firmware related defines
688 #define ISP_CODE_ORG 0x1000 /* default f/w code start */
689 #define ISP_CODE_ORG_2300 0x0800 /* ..except for 2300s */
690 #define ISP_CODE_ORG_2400 0x100000 /* ..and 2400s */
691 #define ISP_FW_REV(maj, min, mic) ((maj << 24) | (min << 16) | mic)
692 #define ISP_FW_MAJOR(code) ((code >> 24) & 0xff)
693 #define ISP_FW_MINOR(code) ((code >> 16) & 0xff)
694 #define ISP_FW_MICRO(code) ((code >> 8) & 0xff)
695 #define ISP_FW_REVX(xp) ((xp[0]<<24) | (xp[1] << 16) | xp[2])
696 #define ISP_FW_MAJORX(xp) (xp[0])
697 #define ISP_FW_MINORX(xp) (xp[1])
698 #define ISP_FW_MICROX(xp) (xp[2])
699 #define ISP_FW_NEWER_THAN(i, major, minor, micro) \
700 (ISP_FW_REVX((i)->isp_fwrev) > ISP_FW_REV(major, minor, micro))
701 #define ISP_FW_OLDER_THAN(i, major, minor, micro) \
702 (ISP_FW_REVX((i)->isp_fwrev) < ISP_FW_REV(major, minor, micro))
705 * Bus (implementation) types
707 #define ISP_BT_PCI 0 /* PCI Implementations */
708 #define ISP_BT_SBUS 1 /* SBus Implementations */
711 * If we have not otherwise defined SBus support away make sure
712 * it is defined here such that the code is included as default
714 #ifndef ISP_SBUS_SUPPORTED
715 #define ISP_SBUS_SUPPORTED 1
721 #define ISP_HA_SCSI 0xf
722 #define ISP_HA_SCSI_UNKNOWN 0x1
723 #define ISP_HA_SCSI_1020 0x2
724 #define ISP_HA_SCSI_1020A 0x3
725 #define ISP_HA_SCSI_1040 0x4
726 #define ISP_HA_SCSI_1040A 0x5
727 #define ISP_HA_SCSI_1040B 0x6
728 #define ISP_HA_SCSI_1040C 0x7
729 #define ISP_HA_SCSI_1240 0x8
730 #define ISP_HA_SCSI_1080 0x9
731 #define ISP_HA_SCSI_1280 0xa
732 #define ISP_HA_SCSI_10160 0xb
733 #define ISP_HA_SCSI_12160 0xc
734 #define ISP_HA_FC 0xf0
735 #define ISP_HA_FC_2100 0x10
736 #define ISP_HA_FC_2200 0x20
737 #define ISP_HA_FC_2300 0x30
738 #define ISP_HA_FC_2312 0x40
739 #define ISP_HA_FC_2322 0x50
740 #define ISP_HA_FC_2400 0x60
741 #define ISP_HA_FC_2500 0x70
742 #define ISP_HA_FC_2600 0x80
744 #define IS_SCSI(isp) (isp->isp_type & ISP_HA_SCSI)
745 #define IS_1020(isp) (isp->isp_type < ISP_HA_SCSI_1240)
746 #define IS_1240(isp) (isp->isp_type == ISP_HA_SCSI_1240)
747 #define IS_1080(isp) (isp->isp_type == ISP_HA_SCSI_1080)
748 #define IS_1280(isp) (isp->isp_type == ISP_HA_SCSI_1280)
749 #define IS_10160(isp) (isp->isp_type == ISP_HA_SCSI_10160)
750 #define IS_12160(isp) (isp->isp_type == ISP_HA_SCSI_12160)
752 #define IS_12X0(isp) (IS_1240(isp) || IS_1280(isp))
753 #define IS_1X160(isp) (IS_10160(isp) || IS_12160(isp))
754 #define IS_DUALBUS(isp) (IS_12X0(isp) || IS_12160(isp))
755 #define IS_ULTRA2(isp) (IS_1080(isp) || IS_1280(isp) || IS_1X160(isp))
756 #define IS_ULTRA3(isp) (IS_1X160(isp))
758 #define IS_FC(isp) ((isp)->isp_type & ISP_HA_FC)
759 #define IS_2100(isp) ((isp)->isp_type == ISP_HA_FC_2100)
760 #define IS_2200(isp) ((isp)->isp_type == ISP_HA_FC_2200)
761 #define IS_23XX(isp) ((isp)->isp_type >= ISP_HA_FC_2300 && \
762 (isp)->isp_type < ISP_HA_FC_2400)
763 #define IS_2300(isp) ((isp)->isp_type == ISP_HA_FC_2300)
764 #define IS_2312(isp) ((isp)->isp_type == ISP_HA_FC_2312)
765 #define IS_2322(isp) ((isp)->isp_type == ISP_HA_FC_2322)
766 #define IS_24XX(isp) ((isp)->isp_type >= ISP_HA_FC_2400)
767 #define IS_25XX(isp) ((isp)->isp_type >= ISP_HA_FC_2500)
768 #define IS_26XX(isp) ((isp)->isp_type >= ISP_HA_FC_2600)
773 #define DMA_WD3(x) (((uint16_t)(((uint64_t)x) >> 48)) & 0xffff)
774 #define DMA_WD2(x) (((uint16_t)(((uint64_t)x) >> 32)) & 0xffff)
775 #define DMA_WD1(x) ((uint16_t)((x) >> 16) & 0xffff)
776 #define DMA_WD0(x) ((uint16_t)((x) & 0xffff))
778 #define DMA_LO32(x) ((uint32_t) (x))
779 #define DMA_HI32(x) ((uint32_t)(((uint64_t)x) >> 32))
782 * Core System Function Prototypes
786 * Reset Hardware. Totally. Assumes that you'll follow this with a call to isp_init.
788 void isp_reset(ispsoftc_t *, int);
791 * Initialize Hardware to known state
793 void isp_init(ispsoftc_t *);
796 * Reset the ISP and call completion for any orphaned commands.
798 int isp_reinit(ispsoftc_t *, int);
801 * Shutdown hardware after use.
803 void isp_shutdown(ispsoftc_t *);
806 * Internal Interrupt Service Routine
808 #ifdef ISP_TARGET_MODE
809 void isp_intr_atioq(ispsoftc_t *);
811 void isp_intr_async(ispsoftc_t *, uint16_t event);
812 void isp_intr_mbox(ispsoftc_t *, uint16_t mbox0);
813 void isp_intr_respq(ispsoftc_t *);
817 * Command Entry Point- Platform Dependent layers call into this
819 int isp_start(XS_T *);
821 /* these values are what isp_start returns */
822 #define CMD_COMPLETE 101 /* command completed */
823 #define CMD_EAGAIN 102 /* busy- maybe retry later */
824 #define CMD_QUEUED 103 /* command has been queued for execution */
825 #define CMD_RQLATER 104 /* requeue this command later */
828 * Command Completion Point- Core layers call out from this with completed cmds
830 void isp_done(XS_T *);
833 * Platform Dependent to External to Internal Control Function
835 * Assumes locks are held on entry. You should note that with many of
836 * these commands locks may be released while this function is called.
838 * ... ISPCTL_RESET_BUS, int channel);
839 * Reset BUS on this channel
840 * ... ISPCTL_RESET_DEV, int channel, int target);
841 * Reset Device on this channel at this target.
842 * ... ISPCTL_ABORT_CMD, XS_T *xs);
843 * Abort active transaction described by xs.
844 * ... IPCTL_UPDATE_PARAMS);
845 * Update any operating parameters (speed, etc.)
846 * ... ISPCTL_FCLINK_TEST, int channel);
847 * Test FC link status on this channel
848 * ... ISPCTL_SCAN_LOOP, int channel);
849 * Scan local loop on this channel
850 * ... ISPCTL_SCAN_FABRIC, int channel);
851 * Scan fabric on this channel
852 * ... ISPCTL_PDB_SYNC, int channel);
853 * Synchronize port database on this channel
854 * ... ISPCTL_SEND_LIP, int channel);
855 * Send a LIP on this channel
856 * ... ISPCTL_GET_NAMES, int channel, int np, uint64_t *wwnn, uint64_t *wwpn)
857 * Get a WWNN/WWPN for this N-port handle on this channel
858 * ... ISPCTL_RUN_MBOXCMD, mbreg_t *mbp)
859 * Run this mailbox command
860 * ... ISPCTL_GET_PDB, int channel, int nphandle, isp_pdb_t *pdb)
861 * Get PDB on this channel for this N-port handle
862 * ... ISPCTL_PLOGX, isp_plcmd_t *)
863 * Performa a port login/logout
864 * ... ISPCTL_CHANGE_ROLE, int channel, int role);
865 * Change role of specified channel
867 * ISPCTL_PDB_SYNC is somewhat misnamed. It actually is the final step, in
868 * order, of ISPCTL_FCLINK_TEST, ISPCTL_SCAN_LOOP, and ISPCTL_SCAN_FABRIC.
869 * The main purpose of ISPCTL_PDB_SYNC is to complete management of logging
870 * and logging out of fabric devices (if one is on a fabric) and then marking
871 * the 'loop state' as being ready to now be used for sending commands to
878 ISPCTL_UPDATE_PARAMS,
890 int isp_control(ispsoftc_t *, ispctl_t, ...);
893 * Platform Dependent to Internal to External Control Function
897 ISPASYNC_NEW_TGT_PARAMS, /* SPI New Target Parameters */
898 ISPASYNC_BUS_RESET, /* All Bus Was Reset */
899 ISPASYNC_LOOP_DOWN, /* FC Loop Down */
900 ISPASYNC_LOOP_UP, /* FC Loop Up */
901 ISPASYNC_LIP, /* FC LIP Received */
902 ISPASYNC_LOOP_RESET, /* FC Loop Reset Received */
903 ISPASYNC_CHANGE_NOTIFY, /* FC Change Notification */
904 ISPASYNC_DEV_ARRIVED, /* FC Device Arrived */
905 ISPASYNC_DEV_CHANGED, /* FC Device Changed */
906 ISPASYNC_DEV_STAYED, /* FC Device Stayed */
907 ISPASYNC_DEV_GONE, /* FC Device Departure */
908 ISPASYNC_TARGET_NOTIFY, /* All target async notification */
909 ISPASYNC_TARGET_NOTIFY_ACK, /* All target notify ack required */
910 ISPASYNC_TARGET_ACTION, /* All target action requested */
911 ISPASYNC_FW_CRASH, /* All Firmware has crashed */
912 ISPASYNC_FW_RESTARTED /* All Firmware has been restarted */
914 void isp_async(ispsoftc_t *, ispasync_t, ...);
916 #define ISPASYNC_CHANGE_PDB 0
917 #define ISPASYNC_CHANGE_SNS 1
918 #define ISPASYNC_CHANGE_OTHER 2
921 * Platform Dependent Error and Debug Printout
923 * Two required functions for each platform must be provided:
925 * void isp_prt(ispsoftc_t *, int level, const char *, ...)
926 * void isp_xs_prt(ispsoftc_t *, XS_T *, int level, const char *, ...)
928 * but due to compiler differences on different platforms this won't be
929 * formally defined here. Instead, they go in each platform definition file.
932 #define ISP_LOGALL 0x0 /* log always */
933 #define ISP_LOGCONFIG 0x1 /* log configuration messages */
934 #define ISP_LOGINFO 0x2 /* log informational messages */
935 #define ISP_LOGWARN 0x4 /* log warning messages */
936 #define ISP_LOGERR 0x8 /* log error messages */
937 #define ISP_LOGDEBUG0 0x10 /* log simple debug messages */
938 #define ISP_LOGDEBUG1 0x20 /* log intermediate debug messages */
939 #define ISP_LOGDEBUG2 0x40 /* log most debug messages */
940 #define ISP_LOGDEBUG3 0x80 /* log high frequency debug messages */
941 #define ISP_LOG_SANCFG 0x100 /* log SAN configuration */
942 #define ISP_LOG_CWARN 0x200 /* log SCSI command "warnings" (e.g., check conditions) */
943 #define ISP_LOG_WARN1 0x400 /* log WARNS we might be interested at some time */
944 #define ISP_LOGTINFO 0x1000 /* log informational messages (target mode) */
945 #define ISP_LOGTDEBUG0 0x2000 /* log simple debug messages (target mode) */
946 #define ISP_LOGTDEBUG1 0x4000 /* log intermediate debug messages (target) */
947 #define ISP_LOGTDEBUG2 0x8000 /* log all debug messages (target) */
950 * Each Platform provides it's own isposinfo substructure of the ispsoftc
953 * Each platform must also provide the following macros/defines:
956 * ISP_FC_SCRLEN FC scratch area DMA length
958 * ISP_MEMZERO(dst, src) platform zeroing function
959 * ISP_MEMCPY(dst, src, count) platform copying function
960 * ISP_SNPRINTF(buf, bufsize, fmt, ...) snprintf
961 * ISP_DELAY(usecs) microsecond spindelay function
962 * ISP_SLEEP(isp, usecs) microsecond sleep function
964 * ISP_INLINE ___inline or not- depending on how
965 * good your debugger is
966 * ISP_MIN shorthand for ((a) < (b))? (a) : (b)
968 * NANOTIME_T nanosecond time type
970 * GET_NANOTIME(NANOTIME_T *) get current nanotime.
972 * GET_NANOSEC(NANOTIME_T *) get uint64_t from NANOTIME_T
974 * NANOTIME_SUB(NANOTIME_T *, NANOTIME_T *)
975 * subtract two NANOTIME_T values
977 * MAXISPREQUEST(ispsoftc_t *) maximum request queue size
978 * for this particular board type
980 * MEMORYBARRIER(ispsoftc_t *, barrier_type, offset, size, chan)
982 * Function/Macro the provides memory synchronization on
983 * various objects so that the ISP's and the system's view
984 * of the same object is consistent.
986 * MBOX_ACQUIRE(ispsoftc_t *) acquire lock on mailbox regs
987 * MBOX_WAIT_COMPLETE(ispsoftc_t *, mbreg_t *) wait for cmd to be done
988 * MBOX_NOTIFY_COMPLETE(ispsoftc_t *) notification of mbox cmd donee
989 * MBOX_RELEASE(ispsoftc_t *) release lock on mailbox regs
991 * FC_SCRATCH_ACQUIRE(ispsoftc_t *, chan) acquire lock on FC scratch area
992 * return -1 if you cannot
993 * FC_SCRATCH_RELEASE(ispsoftc_t *, chan) acquire lock on FC scratch area
995 * FCP_NEXT_CRN(ispsoftc_t *, XS_T *, rslt, channel, target, lun) generate the next command reference number. XS_T * may be null.
997 * SCSI_GOOD SCSI 'Good' Status
998 * SCSI_CHECK SCSI 'Check Condition' Status
999 * SCSI_BUSY SCSI 'Busy' Status
1000 * SCSI_QFULL SCSI 'Queue Full' Status
1002 * XS_T Platform SCSI transaction type (i.e., command for HBA)
1003 * XS_DMA_ADDR_T Platform PCI DMA Address Type
1004 * XS_GET_DMA_SEG(..) Get 32 bit dma segment list value
1005 * XS_GET_DMA64_SEG(..) Get 64 bit dma segment list value
1006 * XS_NEED_DMA64_SEG(..) dma segment needs 64 bit storage
1007 * XS_ISP(xs) gets an instance out of an XS_T
1008 * XS_CHANNEL(xs) gets the channel (bus # for DUALBUS cards) ""
1009 * XS_TGT(xs) gets the target ""
1010 * XS_LUN(xs) gets the lun ""
1011 * XS_CDBP(xs) gets a pointer to the scsi CDB ""
1012 * XS_CDBLEN(xs) gets the CDB's length ""
1013 * XS_XFRLEN(xs) gets the associated data transfer length ""
1014 * XS_TIME(xs) gets the time (in seconds) for this command
1015 * XS_GET_RESID(xs) gets the current residual count
1016 * XS_GET_RESID(xs, resid) sets the current residual count
1017 * XS_STSP(xs) gets a pointer to the SCSI status byte ""
1018 * XS_SNSP(xs) gets a pointer to the associate sense data
1019 * XS_TOT_SNSLEN(xs) gets the total length of sense data storage
1020 * XS_CUR_SNSLEN(xs) gets the currently used length of sense data storage
1021 * XS_SNSKEY(xs) dereferences XS_SNSP to get the current stored Sense Key
1022 * XS_SNSASC(xs) dereferences XS_SNSP to get the current stored Additional Sense Code
1023 * XS_SNSASCQ(xs) dereferences XS_SNSP to get the current stored Additional Sense Code Qualifier
1024 * XS_TAG_P(xs) predicate of whether this command should be tagged
1025 * XS_TAG_TYPE(xs) which type of tag to use
1026 * XS_SETERR(xs) set error state
1028 * HBA_NOERROR command has no erros
1029 * HBA_BOTCH hba botched something
1030 * HBA_CMDTIMEOUT command timed out
1031 * HBA_SELTIMEOUT selection timed out (also port logouts for FC)
1032 * HBA_TGTBSY target returned a BUSY status
1033 * HBA_BUSRESET bus reset destroyed command
1034 * HBA_ABORTED command was aborted (by request)
1035 * HBA_DATAOVR a data overrun was detected
1036 * HBA_ARQFAIL Automatic Request Sense failed
1038 * XS_ERR(xs) return current error state
1039 * XS_NOERR(xs) there is no error currently set
1040 * XS_INITERR(xs) initialize error state
1042 * XS_SAVE_SENSE(xs, sp, len) save sense data
1043 * XS_APPEND_SENSE(xs, sp, len) append more sense data
1045 * XS_SENSE_VALID(xs) indicates whether sense is valid
1047 * DEFAULT_FRAMESIZE(ispsoftc_t *) Default Frame Size
1048 * DEFAULT_EXEC_THROTTLE(ispsoftc_t *) Default Execution Throttle
1050 * DEFAULT_ROLE(ispsoftc_t *, int) Get Default Role for a channel
1051 * DEFAULT_IID(ispsoftc_t *, int) Default SCSI initiator ID
1052 * DEFAULT_LOOPID(ispsoftc_t *, int) Default FC Loop ID
1054 * These establish reasonable defaults for each platform.
1055 * These must be available independent of card NVRAM and are
1056 * to be used should NVRAM not be readable.
1058 * DEFAULT_NODEWWN(ispsoftc_t *, chan) Default FC Node WWN to use
1059 * DEFAULT_PORTWWN(ispsoftc_t *, chan) Default FC Port WWN to use
1061 * These defines are hooks to allow the setting of node and
1062 * port WWNs when NVRAM cannot be read or is to be overriden.
1064 * ACTIVE_NODEWWN(ispsoftc_t *, chan) FC Node WWN to use
1065 * ACTIVE_PORTWWN(ispsoftc_t *, chan) FC Port WWN to use
1067 * After NVRAM is read, these will be invoked to get the
1068 * node and port WWNs that will actually be used for this
1072 * ISP_IOXPUT_8(ispsoftc_t *, uint8_t srcval, uint8_t *dstptr)
1073 * ISP_IOXPUT_16(ispsoftc_t *, uint16_t srcval, uint16_t *dstptr)
1074 * ISP_IOXPUT_32(ispsoftc_t *, uint32_t srcval, uint32_t *dstptr)
1076 * ISP_IOXGET_8(ispsoftc_t *, uint8_t *srcptr, uint8_t dstrval)
1077 * ISP_IOXGET_16(ispsoftc_t *, uint16_t *srcptr, uint16_t dstrval)
1078 * ISP_IOXGET_32(ispsoftc_t *, uint32_t *srcptr, uint32_t dstrval)
1080 * ISP_SWIZZLE_NVRAM_WORD(ispsoftc_t *, uint16_t *)
1081 * ISP_SWIZZLE_NVRAM_LONG(ispsoftc_t *, uint32_t *)
1082 * ISP_SWAP16(ispsoftc_t *, uint16_t srcval)
1083 * ISP_SWAP32(ispsoftc_t *, uint32_t srcval)
1086 #ifdef ISP_TARGET_MODE
1088 * The functions below are for the publicly available
1089 * target mode functions that are internal to the Qlogic driver.
1093 * This function handles new response queue entry appropriate for target mode.
1095 int isp_target_notify(ispsoftc_t *, void *, uint32_t *);
1098 * This function externalizes the ability to acknowledge an Immediate Notify request.
1100 int isp_notify_ack(ispsoftc_t *, void *);
1103 * This function externalized acknowledging (success/fail) an ABTS frame
1105 int isp_acknak_abts(ispsoftc_t *, void *, int);
1108 * General request queue 'put' routine for target mode entries.
1110 int isp_target_put_entry(ispsoftc_t *isp, void *);
1113 * General routine to put back an ATIO entry-
1114 * used for replenishing f/w resource counts.
1115 * The argument is a pointer to a source ATIO
1118 int isp_target_put_atio(ispsoftc_t *, void *);
1121 * General routine to send a final CTIO for a command- used mostly for
1124 int isp_endcmd(ispsoftc_t *, ...);
1125 #define ECMD_SVALID 0x100
1126 #define ECMD_RVALID 0x200
1127 #define ECMD_TERMINATE 0x400
1130 * Handle an asynchronous event
1132 void isp_target_async(ispsoftc_t *, int, int);
1134 #endif /* _ISPVAR_H */