Deleted Added
full compact
ispvar.h (59454) ispvar.h (60221)
1/* $FreeBSD: head/sys/dev/isp/ispvar.h 59454 2000-04-21 02:06:30Z mjacob $ */
1/* $FreeBSD: head/sys/dev/isp/ispvar.h 60221 2000-05-09 01:09:23Z mjacob $ */
2/*
3 * Soft Definitions for for Qlogic ISP SCSI adapters.
4 *
5 * Copyright (c) 1997, 1998, 1999 by Matthew Jacob
6 * NASA/Ames Research Center
7 * All rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
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. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. The name of the author may not be used to endorse or promote products
19 * derived from this software without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
25 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * SUCH DAMAGE.
32 *
33 */
34
35#ifndef _ISPVAR_H
36#define _ISPVAR_H
37
38#if defined(__NetBSD__) || defined(__OpenBSD__)
39#include <dev/ic/ispmbox.h>
40#ifdef ISP_TARGET_MODE
41#include <dev/ic/isp_target.h>
42#include <dev/ic/isp_tpublic.h>
43#endif
44#endif
45#ifdef __FreeBSD__
46#include <dev/isp/ispmbox.h>
47#ifdef ISP_TARGET_MODE
48#include <dev/isp/isp_target.h>
49#include <dev/isp/isp_tpublic.h>
50#endif
51#endif
52#ifdef __linux__
53#include "ispmbox.h"
54#ifdef ISP_TARGET_MODE
55#include "isp_target.h"
56#include "isp_tpublic.h"
57#endif
58#endif
59
60#define ISP_CORE_VERSION_MAJOR 1
2/*
3 * Soft Definitions for for Qlogic ISP SCSI adapters.
4 *
5 * Copyright (c) 1997, 1998, 1999 by Matthew Jacob
6 * NASA/Ames Research Center
7 * All rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
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. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. The name of the author may not be used to endorse or promote products
19 * derived from this software without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
25 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * SUCH DAMAGE.
32 *
33 */
34
35#ifndef _ISPVAR_H
36#define _ISPVAR_H
37
38#if defined(__NetBSD__) || defined(__OpenBSD__)
39#include <dev/ic/ispmbox.h>
40#ifdef ISP_TARGET_MODE
41#include <dev/ic/isp_target.h>
42#include <dev/ic/isp_tpublic.h>
43#endif
44#endif
45#ifdef __FreeBSD__
46#include <dev/isp/ispmbox.h>
47#ifdef ISP_TARGET_MODE
48#include <dev/isp/isp_target.h>
49#include <dev/isp/isp_tpublic.h>
50#endif
51#endif
52#ifdef __linux__
53#include "ispmbox.h"
54#ifdef ISP_TARGET_MODE
55#include "isp_target.h"
56#include "isp_tpublic.h"
57#endif
58#endif
59
60#define ISP_CORE_VERSION_MAJOR 1
61#define ISP_CORE_VERSION_MINOR 13
61#define ISP_CORE_VERSION_MINOR 14
62
63/*
64 * Vector for bus specific code to provide specific services.
65 */
66struct ispsoftc;
67struct ispmdvec {
68 u_int16_t (*dv_rd_reg) __P((struct ispsoftc *, int));
69 void (*dv_wr_reg) __P((struct ispsoftc *, int, u_int16_t));
70 int (*dv_mbxdma) __P((struct ispsoftc *));
71 int (*dv_dmaset) __P((struct ispsoftc *,
72 ISP_SCSI_XFER_T *, ispreq_t *, u_int16_t *, u_int16_t));
73 void (*dv_dmaclr)
74 __P((struct ispsoftc *, ISP_SCSI_XFER_T *, u_int32_t));
75 void (*dv_reset0) __P((struct ispsoftc *));
76 void (*dv_reset1) __P((struct ispsoftc *));
77 void (*dv_dregs) __P((struct ispsoftc *));
78 const u_int16_t *dv_ispfw; /* ptr to f/w */
79 u_int16_t dv_fwlen; /* length of f/w */
80 u_int16_t dv_codeorg; /* code ORG for f/w */
81 u_int32_t dv_fwrev; /* f/w revision */
82 /*
83 * Initial values for conf1 register
84 */
85 u_int16_t dv_conf1;
86 u_int16_t dv_clock; /* clock frequency */
87};
88
89#define MAX_TARGETS 16
90#ifdef ISP2100_FABRIC
91#define MAX_FC_TARG 256
92#else
93#define MAX_FC_TARG 126
94#endif
95
96#define ISP_MAX_TARGETS(isp) (IS_FC(isp)? MAX_FC_TARG : MAX_TARGETS)
97#ifdef ISP2100_SCCLUN
98#define _ISP_FC_LUN(isp) 65536
99#else
100#define _ISP_FC_LUN(isp) 16
101#endif
102#define _ISP_SCSI_LUN(isp) \
103 ((ISP_FW_REVX(isp->isp_fwrev) >= ISP_FW_REV(7, 55, 0))? 32 : 8)
104#define ISP_MAX_LUNS(isp) \
105 (IS_FC(isp)? _ISP_FC_LUN(isp) : _ISP_SCSI_LUN(isp))
106
107
108/*
109 * Macros to read, write ISP registers through bus specific code.
110 */
111
112#define ISP_READ(isp, reg) \
113 (*(isp)->isp_mdvec->dv_rd_reg)((isp), (reg))
114
115#define ISP_WRITE(isp, reg, val) \
116 (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), (val))
117
118#define ISP_MBOXDMASETUP(isp) \
119 (*(isp)->isp_mdvec->dv_mbxdma)((isp))
120
121#define ISP_DMASETUP(isp, xs, req, iptrp, optr) \
122 (*(isp)->isp_mdvec->dv_dmaset)((isp), (xs), (req), (iptrp), (optr))
123
124#define ISP_DMAFREE(isp, xs, hndl) \
125 if ((isp)->isp_mdvec->dv_dmaclr) \
126 (*(isp)->isp_mdvec->dv_dmaclr)((isp), (xs), (hndl))
127
128#define ISP_RESET0(isp) \
129 if ((isp)->isp_mdvec->dv_reset0) (*(isp)->isp_mdvec->dv_reset0)((isp))
130#define ISP_RESET1(isp) \
131 if ((isp)->isp_mdvec->dv_reset1) (*(isp)->isp_mdvec->dv_reset1)((isp))
132#define ISP_DUMPREGS(isp) \
133 if ((isp)->isp_mdvec->dv_dregs) (*(isp)->isp_mdvec->dv_dregs)((isp))
134
135#define ISP_SETBITS(isp, reg, val) \
136 (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), ISP_READ((isp), (reg)) | (val))
137
138#define ISP_CLRBITS(isp, reg, val) \
139 (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), ISP_READ((isp), (reg)) & ~(val))
140
141/* this is the size of a queue entry (request and response) */
142#define QENTRY_LEN 64
143/* both request and result queue length must be a power of two */
144#define RQUEST_QUEUE_LEN MAXISPREQUEST
145/* I've seen wierdnesses with the result queue < 64 */
146#if MAXISPREQUEST > 64
147#define RESULT_QUEUE_LEN (MAXISPREQUEST/2)
148#else
149#define RESULT_QUEUE_LEN MAXISPREQUEST
150#endif
151#define ISP_QUEUE_ENTRY(q, idx) ((q) + ((idx) * QENTRY_LEN))
152#define ISP_QUEUE_SIZE(n) ((n) * QENTRY_LEN)
153#define ISP_NXT_QENTRY(idx, qlen) (((idx) + 1) & ((qlen)-1))
154#define ISP_QAVAIL(in, out, qlen) \
155 ((in == out)? (qlen - 1) : ((in > out)? \
156 ((qlen - 1) - (in - out)) : (out - in - 1)))
157
158#define ISP_ADD_REQUEST(isp, iptr) \
159 ISP_WRITE(isp, INMAILBOX4, iptr), isp->isp_reqidx = iptr
160
161/*
162 * SCSI Specific Host Adapter Parameters- per bus, per target
163 */
164
165typedef struct {
166 u_int isp_gotdparms : 1,
167 isp_req_ack_active_neg : 1,
168 isp_data_line_active_neg: 1,
169 isp_cmd_dma_burst_enable: 1,
170 isp_data_dma_burst_enabl: 1,
171 isp_fifo_threshold : 3,
172 isp_ultramode : 1,
173 isp_diffmode : 1,
174 isp_lvdmode : 1,
175 : 1,
176 isp_initiator_id : 4,
177 isp_async_data_setup : 4;
178 u_int16_t isp_selection_timeout;
179 u_int16_t isp_max_queue_depth;
180 u_int8_t isp_tag_aging;
181 u_int8_t isp_bus_reset_delay;
182 u_int8_t isp_retry_count;
183 u_int8_t isp_retry_delay;
184 struct {
185 u_int dev_enable : 1, /* ignored */
186 : 1,
187 dev_update : 1,
188 dev_refresh : 1,
189 exc_throttle : 8,
190 cur_offset : 4,
191 sync_offset : 4;
192 u_int8_t cur_period; /* current sync period */
193 u_int8_t sync_period; /* goal sync period */
194 u_int16_t dev_flags; /* goal device flags */
195 u_int16_t cur_dflags; /* current device flags */
196 } isp_devparam[MAX_TARGETS];
197} sdparam;
198
199/*
200 * Device Flags
201 */
202#define DPARM_DISC 0x8000
203#define DPARM_PARITY 0x4000
204#define DPARM_WIDE 0x2000
205#define DPARM_SYNC 0x1000
206#define DPARM_TQING 0x0800
207#define DPARM_ARQ 0x0400
208#define DPARM_QFRZ 0x0200
209#define DPARM_RENEG 0x0100
210#define DPARM_NARROW 0x0080 /* Possibly only available with >= 7.55 fw */
211#define DPARM_ASYNC 0x0040 /* Possibly only available with >= 7.55 fw */
212#define DPARM_DEFAULT (0xFF00 & ~DPARM_QFRZ)
213#define DPARM_SAFE_DFLT (DPARM_DEFAULT & ~(DPARM_WIDE|DPARM_SYNC|DPARM_TQING))
214
215
216/* technically, not really correct, as they need to be rated based upon clock */
217#define ISP_40M_SYNCPARMS 0x080a
218#define ISP_20M_SYNCPARMS 0x080c
219#define ISP_10M_SYNCPARMS 0x0c19
220#define ISP_08M_SYNCPARMS 0x0c25
221#define ISP_05M_SYNCPARMS 0x0c32
222#define ISP_04M_SYNCPARMS 0x0c41
223
224/*
225 * Fibre Channel Specifics
226 */
227#define FL_PORT_ID 0x7e /* FL_Port Special ID */
228#define FC_PORT_ID 0x7f /* Fabric Controller Special ID */
229#define FC_SNS_ID 0x80 /* SNS Server Special ID */
230
231typedef struct {
232 u_int32_t isp_fwoptions : 16,
233 : 4,
234 loop_seen_once : 1,
235 isp_loopstate : 3, /* Current Loop State */
236 isp_fwstate : 3, /* ISP F/W state */
237 isp_gotdparms : 1,
238 isp_topo : 3,
239 isp_onfabric : 1;
240 u_int8_t isp_loopid; /* hard loop id */
241 u_int8_t isp_alpa; /* ALPA */
242 volatile u_int16_t isp_lipseq; /* LIP sequence # */
243 u_int32_t isp_portid;
244 u_int8_t isp_execthrottle;
245 u_int8_t isp_retry_delay;
246 u_int8_t isp_retry_count;
247 u_int8_t isp_reserved;
248 u_int16_t isp_maxalloc;
249 u_int16_t isp_maxfrmlen;
250 u_int64_t isp_nodewwn;
251 u_int64_t isp_portwwn;
252 /*
253 * Port Data Base. This is indexed by 'target', which is invariate.
254 * However, elements within can move around due to loop changes,
255 * so the actual loop ID passed to the F/W is in this structure.
256 * The first time the loop is seen up, loopid will match the index
257 * (except for fabric nodes which are above mapped above FC_SNS_ID
258 * and are completely virtual), but subsequent LIPs can cause things
259 * to move around.
260 */
261 struct lportdb {
262 u_int
62
63/*
64 * Vector for bus specific code to provide specific services.
65 */
66struct ispsoftc;
67struct ispmdvec {
68 u_int16_t (*dv_rd_reg) __P((struct ispsoftc *, int));
69 void (*dv_wr_reg) __P((struct ispsoftc *, int, u_int16_t));
70 int (*dv_mbxdma) __P((struct ispsoftc *));
71 int (*dv_dmaset) __P((struct ispsoftc *,
72 ISP_SCSI_XFER_T *, ispreq_t *, u_int16_t *, u_int16_t));
73 void (*dv_dmaclr)
74 __P((struct ispsoftc *, ISP_SCSI_XFER_T *, u_int32_t));
75 void (*dv_reset0) __P((struct ispsoftc *));
76 void (*dv_reset1) __P((struct ispsoftc *));
77 void (*dv_dregs) __P((struct ispsoftc *));
78 const u_int16_t *dv_ispfw; /* ptr to f/w */
79 u_int16_t dv_fwlen; /* length of f/w */
80 u_int16_t dv_codeorg; /* code ORG for f/w */
81 u_int32_t dv_fwrev; /* f/w revision */
82 /*
83 * Initial values for conf1 register
84 */
85 u_int16_t dv_conf1;
86 u_int16_t dv_clock; /* clock frequency */
87};
88
89#define MAX_TARGETS 16
90#ifdef ISP2100_FABRIC
91#define MAX_FC_TARG 256
92#else
93#define MAX_FC_TARG 126
94#endif
95
96#define ISP_MAX_TARGETS(isp) (IS_FC(isp)? MAX_FC_TARG : MAX_TARGETS)
97#ifdef ISP2100_SCCLUN
98#define _ISP_FC_LUN(isp) 65536
99#else
100#define _ISP_FC_LUN(isp) 16
101#endif
102#define _ISP_SCSI_LUN(isp) \
103 ((ISP_FW_REVX(isp->isp_fwrev) >= ISP_FW_REV(7, 55, 0))? 32 : 8)
104#define ISP_MAX_LUNS(isp) \
105 (IS_FC(isp)? _ISP_FC_LUN(isp) : _ISP_SCSI_LUN(isp))
106
107
108/*
109 * Macros to read, write ISP registers through bus specific code.
110 */
111
112#define ISP_READ(isp, reg) \
113 (*(isp)->isp_mdvec->dv_rd_reg)((isp), (reg))
114
115#define ISP_WRITE(isp, reg, val) \
116 (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), (val))
117
118#define ISP_MBOXDMASETUP(isp) \
119 (*(isp)->isp_mdvec->dv_mbxdma)((isp))
120
121#define ISP_DMASETUP(isp, xs, req, iptrp, optr) \
122 (*(isp)->isp_mdvec->dv_dmaset)((isp), (xs), (req), (iptrp), (optr))
123
124#define ISP_DMAFREE(isp, xs, hndl) \
125 if ((isp)->isp_mdvec->dv_dmaclr) \
126 (*(isp)->isp_mdvec->dv_dmaclr)((isp), (xs), (hndl))
127
128#define ISP_RESET0(isp) \
129 if ((isp)->isp_mdvec->dv_reset0) (*(isp)->isp_mdvec->dv_reset0)((isp))
130#define ISP_RESET1(isp) \
131 if ((isp)->isp_mdvec->dv_reset1) (*(isp)->isp_mdvec->dv_reset1)((isp))
132#define ISP_DUMPREGS(isp) \
133 if ((isp)->isp_mdvec->dv_dregs) (*(isp)->isp_mdvec->dv_dregs)((isp))
134
135#define ISP_SETBITS(isp, reg, val) \
136 (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), ISP_READ((isp), (reg)) | (val))
137
138#define ISP_CLRBITS(isp, reg, val) \
139 (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), ISP_READ((isp), (reg)) & ~(val))
140
141/* this is the size of a queue entry (request and response) */
142#define QENTRY_LEN 64
143/* both request and result queue length must be a power of two */
144#define RQUEST_QUEUE_LEN MAXISPREQUEST
145/* I've seen wierdnesses with the result queue < 64 */
146#if MAXISPREQUEST > 64
147#define RESULT_QUEUE_LEN (MAXISPREQUEST/2)
148#else
149#define RESULT_QUEUE_LEN MAXISPREQUEST
150#endif
151#define ISP_QUEUE_ENTRY(q, idx) ((q) + ((idx) * QENTRY_LEN))
152#define ISP_QUEUE_SIZE(n) ((n) * QENTRY_LEN)
153#define ISP_NXT_QENTRY(idx, qlen) (((idx) + 1) & ((qlen)-1))
154#define ISP_QAVAIL(in, out, qlen) \
155 ((in == out)? (qlen - 1) : ((in > out)? \
156 ((qlen - 1) - (in - out)) : (out - in - 1)))
157
158#define ISP_ADD_REQUEST(isp, iptr) \
159 ISP_WRITE(isp, INMAILBOX4, iptr), isp->isp_reqidx = iptr
160
161/*
162 * SCSI Specific Host Adapter Parameters- per bus, per target
163 */
164
165typedef struct {
166 u_int isp_gotdparms : 1,
167 isp_req_ack_active_neg : 1,
168 isp_data_line_active_neg: 1,
169 isp_cmd_dma_burst_enable: 1,
170 isp_data_dma_burst_enabl: 1,
171 isp_fifo_threshold : 3,
172 isp_ultramode : 1,
173 isp_diffmode : 1,
174 isp_lvdmode : 1,
175 : 1,
176 isp_initiator_id : 4,
177 isp_async_data_setup : 4;
178 u_int16_t isp_selection_timeout;
179 u_int16_t isp_max_queue_depth;
180 u_int8_t isp_tag_aging;
181 u_int8_t isp_bus_reset_delay;
182 u_int8_t isp_retry_count;
183 u_int8_t isp_retry_delay;
184 struct {
185 u_int dev_enable : 1, /* ignored */
186 : 1,
187 dev_update : 1,
188 dev_refresh : 1,
189 exc_throttle : 8,
190 cur_offset : 4,
191 sync_offset : 4;
192 u_int8_t cur_period; /* current sync period */
193 u_int8_t sync_period; /* goal sync period */
194 u_int16_t dev_flags; /* goal device flags */
195 u_int16_t cur_dflags; /* current device flags */
196 } isp_devparam[MAX_TARGETS];
197} sdparam;
198
199/*
200 * Device Flags
201 */
202#define DPARM_DISC 0x8000
203#define DPARM_PARITY 0x4000
204#define DPARM_WIDE 0x2000
205#define DPARM_SYNC 0x1000
206#define DPARM_TQING 0x0800
207#define DPARM_ARQ 0x0400
208#define DPARM_QFRZ 0x0200
209#define DPARM_RENEG 0x0100
210#define DPARM_NARROW 0x0080 /* Possibly only available with >= 7.55 fw */
211#define DPARM_ASYNC 0x0040 /* Possibly only available with >= 7.55 fw */
212#define DPARM_DEFAULT (0xFF00 & ~DPARM_QFRZ)
213#define DPARM_SAFE_DFLT (DPARM_DEFAULT & ~(DPARM_WIDE|DPARM_SYNC|DPARM_TQING))
214
215
216/* technically, not really correct, as they need to be rated based upon clock */
217#define ISP_40M_SYNCPARMS 0x080a
218#define ISP_20M_SYNCPARMS 0x080c
219#define ISP_10M_SYNCPARMS 0x0c19
220#define ISP_08M_SYNCPARMS 0x0c25
221#define ISP_05M_SYNCPARMS 0x0c32
222#define ISP_04M_SYNCPARMS 0x0c41
223
224/*
225 * Fibre Channel Specifics
226 */
227#define FL_PORT_ID 0x7e /* FL_Port Special ID */
228#define FC_PORT_ID 0x7f /* Fabric Controller Special ID */
229#define FC_SNS_ID 0x80 /* SNS Server Special ID */
230
231typedef struct {
232 u_int32_t isp_fwoptions : 16,
233 : 4,
234 loop_seen_once : 1,
235 isp_loopstate : 3, /* Current Loop State */
236 isp_fwstate : 3, /* ISP F/W state */
237 isp_gotdparms : 1,
238 isp_topo : 3,
239 isp_onfabric : 1;
240 u_int8_t isp_loopid; /* hard loop id */
241 u_int8_t isp_alpa; /* ALPA */
242 volatile u_int16_t isp_lipseq; /* LIP sequence # */
243 u_int32_t isp_portid;
244 u_int8_t isp_execthrottle;
245 u_int8_t isp_retry_delay;
246 u_int8_t isp_retry_count;
247 u_int8_t isp_reserved;
248 u_int16_t isp_maxalloc;
249 u_int16_t isp_maxfrmlen;
250 u_int64_t isp_nodewwn;
251 u_int64_t isp_portwwn;
252 /*
253 * Port Data Base. This is indexed by 'target', which is invariate.
254 * However, elements within can move around due to loop changes,
255 * so the actual loop ID passed to the F/W is in this structure.
256 * The first time the loop is seen up, loopid will match the index
257 * (except for fabric nodes which are above mapped above FC_SNS_ID
258 * and are completely virtual), but subsequent LIPs can cause things
259 * to move around.
260 */
261 struct lportdb {
262 u_int
263 loopid : 8,
264 : 4,
265 fabdev : 1,
266 roles : 2,
267 valid : 1;
263 loopid : 8,
264 : 4,
265 loggedin : 1,
266 roles : 2,
267 valid : 1;
268 u_int32_t portid;
269 u_int64_t node_wwn;
270 u_int64_t port_wwn;
271 } portdb[MAX_FC_TARG], tport[FL_PORT_ID];
272
273 /*
274 * Scratch DMA mapped in area to fetch Port Database stuff, etc.
275 */
276 caddr_t isp_scratch;
277 u_int32_t isp_scdma;
278} fcparam;
279
280#define FW_CONFIG_WAIT 0
281#define FW_WAIT_AL_PA 1
282#define FW_WAIT_LOGIN 2
283#define FW_READY 3
284#define FW_LOSS_OF_SYNC 4
285#define FW_ERROR 5
286#define FW_REINIT 6
287#define FW_NON_PART 7
288
289#define LOOP_NIL 0
290#define LOOP_LIP_RCVD 1
291#define LOOP_PDB_RCVD 2
292#define LOOP_READY 7
293
294#define TOPO_NL_PORT 0
295#define TOPO_FL_PORT 1
296#define TOPO_N_PORT 2
297#define TOPO_F_PORT 3
298#define TOPO_PTP_STUB 4
299
300/*
301 * Soft Structure per host adapter
302 */
303struct ispsoftc {
304 /*
305 * Platform (OS) specific data
306 */
307 struct isposinfo isp_osinfo;
308
309 /*
310 * Pointer to bus specific functions and data
311 */
312 struct ispmdvec * isp_mdvec;
313
314 /*
315 * (Mostly) nonvolatile state. Board specific parameters
316 * may contain some volatile state (e.g., current loop state).
317 */
318
319 void * isp_param; /* type specific */
320 u_int16_t isp_fwrev[3]; /* Loaded F/W revision */
321 u_int16_t isp_romfw_rev[3]; /* PROM F/W revision */
322 u_int16_t isp_maxcmds; /* max possible I/O cmds */
323 u_int8_t isp_type; /* HBA Chip Type */
324 u_int8_t isp_revision; /* HBA Chip H/W Revision */
325
326 u_int32_t : 4,
327 isp_touched : 1, /* board ever seen? */
328 isp_fast_mttr : 1, /* fast sram */
329 isp_bustype : 1, /* SBus or PCI */
330 isp_dogactive : 1, /* watchdog running */
331 isp_dblev : 8, /* debug level */
332 isp_clock : 8, /* input clock */
333 isp_confopts : 8; /* config options */
334
335 /*
336 * Volatile state
337 */
338
339 volatile u_int32_t : 9,
340 isp_state : 3,
341 isp_sendmarker : 2, /* send a marker entry */
342 isp_update : 2, /* update parameters */
343 isp_nactive : 16; /* how many commands active */
344
345 volatile u_int16_t isp_reqodx; /* index of last ISP pickup */
346 volatile u_int16_t isp_reqidx; /* index of next request */
347 volatile u_int16_t isp_residx; /* index of next result */
348 volatile u_int16_t isp_lasthdls; /* last handle seed */
349
350 /*
351 * Active commands are stored here, indexed by handle functions.
352 */
353 ISP_SCSI_XFER_T **isp_xflist;
354
355 /*
356 * request/result queue pointers and dma handles for them.
357 */
358 caddr_t isp_rquest;
359 caddr_t isp_result;
360 u_int32_t isp_rquest_dma;
361 u_int32_t isp_result_dma;
362};
363
364#define SDPARAM(isp) ((sdparam *) (isp)->isp_param)
365#define FCPARAM(isp) ((fcparam *) (isp)->isp_param)
366
367/*
368 * ISP States
369 */
370#define ISP_NILSTATE 0
371#define ISP_RESETSTATE 1
372#define ISP_INITSTATE 2
373#define ISP_RUNSTATE 3
374
375/*
376 * ISP Configuration Options
377 */
378#define ISP_CFG_NORELOAD 0x80 /* don't download f/w */
379#define ISP_CFG_NONVRAM 0x40 /* ignore NVRAM */
380#define ISP_CFG_FULL_DUPLEX 0x01 /* Full Duplex (Fibre Channel only) */
381#define ISP_CFG_OWNWWN 0x02 /* override NVRAM wwn */
382#define ISP_CFG_NPORT 0x04 /* try to force N- instead of L-Port */
383
384#define ISP_FW_REV(maj, min, mic) ((maj << 24) | (min << 16) | mic)
385#define ISP_FW_REVX(xp) ((xp[0]<<24) | (xp[1] << 16) | xp[2])
386
387/*
388 * Bus (implementation) types
389 */
390#define ISP_BT_PCI 0 /* PCI Implementations */
391#define ISP_BT_SBUS 1 /* SBus Implementations */
392
393/*
394 * Chip Types
395 */
396#define ISP_HA_SCSI 0xf
397#define ISP_HA_SCSI_UNKNOWN 0x1
398#define ISP_HA_SCSI_1020 0x2
399#define ISP_HA_SCSI_1020A 0x3
400#define ISP_HA_SCSI_1040 0x4
401#define ISP_HA_SCSI_1040A 0x5
402#define ISP_HA_SCSI_1040B 0x6
403#define ISP_HA_SCSI_1040C 0x7
404#define ISP_HA_SCSI_1240 0x8
405#define ISP_HA_SCSI_1080 0x9
406#define ISP_HA_SCSI_1280 0xa
407#define ISP_HA_SCSI_12160 0xb
408#define ISP_HA_FC 0xf0
409#define ISP_HA_FC_2100 0x10
410#define ISP_HA_FC_2200 0x20
411
412#define IS_SCSI(isp) (isp->isp_type & ISP_HA_SCSI)
413#define IS_1240(isp) (isp->isp_type == ISP_HA_SCSI_1240)
414#define IS_1080(isp) (isp->isp_type == ISP_HA_SCSI_1080)
415#define IS_1280(isp) (isp->isp_type == ISP_HA_SCSI_1280)
416#define IS_12160(isp) (isp->isp_type == ISP_HA_SCSI_12160)
417
418#define IS_12X0(isp) (IS_1240(isp) || IS_1280(isp))
419#define IS_DUALBUS(isp) (IS_12X0(isp) || IS_12160(isp))
420#define IS_ULTRA2(isp) (IS_1080(isp) || IS_1280(isp) || IS_12160(isp))
421#define IS_ULTRA3(isp) (IS_12160(isp))
422
423#define IS_FC(isp) (isp->isp_type & ISP_HA_FC)
424#define IS_2100(isp) (isp->isp_type == ISP_HA_FC_2100)
425#define IS_2200(isp) (isp->isp_type == ISP_HA_FC_2200)
426
427
428/*
429 * Function Prototypes
430 */
431
432/*
433 * Reset Hardware. Totally. Assumes that you'll follow this with
434 * a call to isp_init.
435 */
436void isp_reset __P((struct ispsoftc *));
437
438/*
439 * Initialize Hardware to known state
440 */
441void isp_init __P((struct ispsoftc *));
442
443/*
444 * Reset the ISP and call completion for any orphaned commands.
445 */
446void isp_restart __P((struct ispsoftc *));
447
448/*
449 * Interrupt Service Routine
450 */
451int isp_intr __P((void *));
452
453/*
454 * Command Entry Point
455 */
456int32_t ispscsicmd __P((ISP_SCSI_XFER_T *));
457
458/*
459 * Platform Dependent to External to Internal Control Function
460 *
461 * Assumes all locks are held and that no reentrancy issues need be dealt with.
462 *
463 */
464typedef enum {
465 ISPCTL_RESET_BUS, /* Reset Bus */
466 ISPCTL_RESET_DEV, /* Reset Device */
467 ISPCTL_ABORT_CMD, /* Abort Command */
468 ISPCTL_UPDATE_PARAMS, /* Update Operating Parameters */
469 ISPCTL_FCLINK_TEST, /* Test FC Link Status */
470 ISPCTL_PDB_SYNC, /* Synchronize Port Database */
471 ISPCTL_TOGGLE_TMODE /* toggle target mode */
472} ispctl_t;
473int isp_control __P((struct ispsoftc *, ispctl_t, void *));
474
475
476/*
477 * Platform Dependent to Internal to External Control Function
478 * (each platform must provide such a function)
479 *
480 * Assumes all locks are held and that no reentrancy issues need be dealt with.
481 *
482 */
483
484typedef enum {
485 ISPASYNC_NEW_TGT_PARAMS,
486 ISPASYNC_BUS_RESET, /* Bus Was Reset */
487 ISPASYNC_LOOP_DOWN, /* FC Loop Down */
488 ISPASYNC_LOOP_UP, /* FC Loop Up */
489 ISPASYNC_PDB_CHANGED, /* FC Port Data Base Changed */
490 ISPASYNC_CHANGE_NOTIFY, /* FC SNS Change Notification */
491 ISPASYNC_FABRIC_DEV, /* FC New Fabric Device */
492 ISPASYNC_TARGET_MESSAGE, /* target message */
493 ISPASYNC_TARGET_EVENT, /* target asynchronous event */
494 ISPASYNC_TARGET_ACTION /* other target command action */
495} ispasync_t;
496int isp_async __P((struct ispsoftc *, ispasync_t, void *));
497
498/*
499 * lost command routine (XXXX IN TRANSITION XXXX)
500 */
501void isp_lostcmd __P((struct ispsoftc *, ISP_SCSI_XFER_T *));
502
503#endif /* _ISPVAR_H */
268 u_int32_t portid;
269 u_int64_t node_wwn;
270 u_int64_t port_wwn;
271 } portdb[MAX_FC_TARG], tport[FL_PORT_ID];
272
273 /*
274 * Scratch DMA mapped in area to fetch Port Database stuff, etc.
275 */
276 caddr_t isp_scratch;
277 u_int32_t isp_scdma;
278} fcparam;
279
280#define FW_CONFIG_WAIT 0
281#define FW_WAIT_AL_PA 1
282#define FW_WAIT_LOGIN 2
283#define FW_READY 3
284#define FW_LOSS_OF_SYNC 4
285#define FW_ERROR 5
286#define FW_REINIT 6
287#define FW_NON_PART 7
288
289#define LOOP_NIL 0
290#define LOOP_LIP_RCVD 1
291#define LOOP_PDB_RCVD 2
292#define LOOP_READY 7
293
294#define TOPO_NL_PORT 0
295#define TOPO_FL_PORT 1
296#define TOPO_N_PORT 2
297#define TOPO_F_PORT 3
298#define TOPO_PTP_STUB 4
299
300/*
301 * Soft Structure per host adapter
302 */
303struct ispsoftc {
304 /*
305 * Platform (OS) specific data
306 */
307 struct isposinfo isp_osinfo;
308
309 /*
310 * Pointer to bus specific functions and data
311 */
312 struct ispmdvec * isp_mdvec;
313
314 /*
315 * (Mostly) nonvolatile state. Board specific parameters
316 * may contain some volatile state (e.g., current loop state).
317 */
318
319 void * isp_param; /* type specific */
320 u_int16_t isp_fwrev[3]; /* Loaded F/W revision */
321 u_int16_t isp_romfw_rev[3]; /* PROM F/W revision */
322 u_int16_t isp_maxcmds; /* max possible I/O cmds */
323 u_int8_t isp_type; /* HBA Chip Type */
324 u_int8_t isp_revision; /* HBA Chip H/W Revision */
325
326 u_int32_t : 4,
327 isp_touched : 1, /* board ever seen? */
328 isp_fast_mttr : 1, /* fast sram */
329 isp_bustype : 1, /* SBus or PCI */
330 isp_dogactive : 1, /* watchdog running */
331 isp_dblev : 8, /* debug level */
332 isp_clock : 8, /* input clock */
333 isp_confopts : 8; /* config options */
334
335 /*
336 * Volatile state
337 */
338
339 volatile u_int32_t : 9,
340 isp_state : 3,
341 isp_sendmarker : 2, /* send a marker entry */
342 isp_update : 2, /* update parameters */
343 isp_nactive : 16; /* how many commands active */
344
345 volatile u_int16_t isp_reqodx; /* index of last ISP pickup */
346 volatile u_int16_t isp_reqidx; /* index of next request */
347 volatile u_int16_t isp_residx; /* index of next result */
348 volatile u_int16_t isp_lasthdls; /* last handle seed */
349
350 /*
351 * Active commands are stored here, indexed by handle functions.
352 */
353 ISP_SCSI_XFER_T **isp_xflist;
354
355 /*
356 * request/result queue pointers and dma handles for them.
357 */
358 caddr_t isp_rquest;
359 caddr_t isp_result;
360 u_int32_t isp_rquest_dma;
361 u_int32_t isp_result_dma;
362};
363
364#define SDPARAM(isp) ((sdparam *) (isp)->isp_param)
365#define FCPARAM(isp) ((fcparam *) (isp)->isp_param)
366
367/*
368 * ISP States
369 */
370#define ISP_NILSTATE 0
371#define ISP_RESETSTATE 1
372#define ISP_INITSTATE 2
373#define ISP_RUNSTATE 3
374
375/*
376 * ISP Configuration Options
377 */
378#define ISP_CFG_NORELOAD 0x80 /* don't download f/w */
379#define ISP_CFG_NONVRAM 0x40 /* ignore NVRAM */
380#define ISP_CFG_FULL_DUPLEX 0x01 /* Full Duplex (Fibre Channel only) */
381#define ISP_CFG_OWNWWN 0x02 /* override NVRAM wwn */
382#define ISP_CFG_NPORT 0x04 /* try to force N- instead of L-Port */
383
384#define ISP_FW_REV(maj, min, mic) ((maj << 24) | (min << 16) | mic)
385#define ISP_FW_REVX(xp) ((xp[0]<<24) | (xp[1] << 16) | xp[2])
386
387/*
388 * Bus (implementation) types
389 */
390#define ISP_BT_PCI 0 /* PCI Implementations */
391#define ISP_BT_SBUS 1 /* SBus Implementations */
392
393/*
394 * Chip Types
395 */
396#define ISP_HA_SCSI 0xf
397#define ISP_HA_SCSI_UNKNOWN 0x1
398#define ISP_HA_SCSI_1020 0x2
399#define ISP_HA_SCSI_1020A 0x3
400#define ISP_HA_SCSI_1040 0x4
401#define ISP_HA_SCSI_1040A 0x5
402#define ISP_HA_SCSI_1040B 0x6
403#define ISP_HA_SCSI_1040C 0x7
404#define ISP_HA_SCSI_1240 0x8
405#define ISP_HA_SCSI_1080 0x9
406#define ISP_HA_SCSI_1280 0xa
407#define ISP_HA_SCSI_12160 0xb
408#define ISP_HA_FC 0xf0
409#define ISP_HA_FC_2100 0x10
410#define ISP_HA_FC_2200 0x20
411
412#define IS_SCSI(isp) (isp->isp_type & ISP_HA_SCSI)
413#define IS_1240(isp) (isp->isp_type == ISP_HA_SCSI_1240)
414#define IS_1080(isp) (isp->isp_type == ISP_HA_SCSI_1080)
415#define IS_1280(isp) (isp->isp_type == ISP_HA_SCSI_1280)
416#define IS_12160(isp) (isp->isp_type == ISP_HA_SCSI_12160)
417
418#define IS_12X0(isp) (IS_1240(isp) || IS_1280(isp))
419#define IS_DUALBUS(isp) (IS_12X0(isp) || IS_12160(isp))
420#define IS_ULTRA2(isp) (IS_1080(isp) || IS_1280(isp) || IS_12160(isp))
421#define IS_ULTRA3(isp) (IS_12160(isp))
422
423#define IS_FC(isp) (isp->isp_type & ISP_HA_FC)
424#define IS_2100(isp) (isp->isp_type == ISP_HA_FC_2100)
425#define IS_2200(isp) (isp->isp_type == ISP_HA_FC_2200)
426
427
428/*
429 * Function Prototypes
430 */
431
432/*
433 * Reset Hardware. Totally. Assumes that you'll follow this with
434 * a call to isp_init.
435 */
436void isp_reset __P((struct ispsoftc *));
437
438/*
439 * Initialize Hardware to known state
440 */
441void isp_init __P((struct ispsoftc *));
442
443/*
444 * Reset the ISP and call completion for any orphaned commands.
445 */
446void isp_restart __P((struct ispsoftc *));
447
448/*
449 * Interrupt Service Routine
450 */
451int isp_intr __P((void *));
452
453/*
454 * Command Entry Point
455 */
456int32_t ispscsicmd __P((ISP_SCSI_XFER_T *));
457
458/*
459 * Platform Dependent to External to Internal Control Function
460 *
461 * Assumes all locks are held and that no reentrancy issues need be dealt with.
462 *
463 */
464typedef enum {
465 ISPCTL_RESET_BUS, /* Reset Bus */
466 ISPCTL_RESET_DEV, /* Reset Device */
467 ISPCTL_ABORT_CMD, /* Abort Command */
468 ISPCTL_UPDATE_PARAMS, /* Update Operating Parameters */
469 ISPCTL_FCLINK_TEST, /* Test FC Link Status */
470 ISPCTL_PDB_SYNC, /* Synchronize Port Database */
471 ISPCTL_TOGGLE_TMODE /* toggle target mode */
472} ispctl_t;
473int isp_control __P((struct ispsoftc *, ispctl_t, void *));
474
475
476/*
477 * Platform Dependent to Internal to External Control Function
478 * (each platform must provide such a function)
479 *
480 * Assumes all locks are held and that no reentrancy issues need be dealt with.
481 *
482 */
483
484typedef enum {
485 ISPASYNC_NEW_TGT_PARAMS,
486 ISPASYNC_BUS_RESET, /* Bus Was Reset */
487 ISPASYNC_LOOP_DOWN, /* FC Loop Down */
488 ISPASYNC_LOOP_UP, /* FC Loop Up */
489 ISPASYNC_PDB_CHANGED, /* FC Port Data Base Changed */
490 ISPASYNC_CHANGE_NOTIFY, /* FC SNS Change Notification */
491 ISPASYNC_FABRIC_DEV, /* FC New Fabric Device */
492 ISPASYNC_TARGET_MESSAGE, /* target message */
493 ISPASYNC_TARGET_EVENT, /* target asynchronous event */
494 ISPASYNC_TARGET_ACTION /* other target command action */
495} ispasync_t;
496int isp_async __P((struct ispsoftc *, ispasync_t, void *));
497
498/*
499 * lost command routine (XXXX IN TRANSITION XXXX)
500 */
501void isp_lostcmd __P((struct ispsoftc *, ISP_SCSI_XFER_T *));
502
503#endif /* _ISPVAR_H */