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