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