ispvar.h revision 1.37
1 /* $NetBSD: ispvar.h,v 1.37 2000/12/23 01:38:01 wiz Exp $ */ 2 /* 3 * This driver, which is contained in NetBSD in the files: 4 * 5 * sys/dev/ic/isp.c 6 * sys/dev/ic/isp_inline.h 7 * sys/dev/ic/isp_netbsd.c 8 * sys/dev/ic/isp_netbsd.h 9 * sys/dev/ic/isp_target.c 10 * sys/dev/ic/isp_target.h 11 * sys/dev/ic/isp_tpublic.h 12 * sys/dev/ic/ispmbox.h 13 * sys/dev/ic/ispreg.h 14 * sys/dev/ic/ispvar.h 15 * sys/microcode/isp/asm_sbus.h 16 * sys/microcode/isp/asm_1040.h 17 * sys/microcode/isp/asm_1080.h 18 * sys/microcode/isp/asm_12160.h 19 * sys/microcode/isp/asm_2100.h 20 * sys/microcode/isp/asm_2200.h 21 * sys/pci/isp_pci.c 22 * sys/sbus/isp_sbus.c 23 * 24 * Is being actively maintained by Matthew Jacob (mjacob (at) netbsd.org). 25 * This driver also is shared source with FreeBSD, OpenBSD, Linux, Solaris, 26 * Linux versions. This tends to be an interesting maintenance problem. 27 * 28 * Please coordinate with Matthew Jacob on changes you wish to make here. 29 */ 30 /* 31 * Copyright (C) 1999 National Aeronautics & Space Administration 32 * All rights reserved. 33 * 34 * Redistribution and use in source and binary forms, with or without 35 * modification, are permitted provided that the following conditions 36 * are met: 37 * 1. Redistributions of source code must retain the above copyright 38 * notice, this list of conditions and the following disclaimer. 39 * 2. Redistributions in binary form must reproduce the above copyright 40 * notice, this list of conditions and the following disclaimer in the 41 * documentation and/or other materials provided with the distribution. 42 * 3. The name of the author may not be used to endorse or promote products 43 * derived from this software without specific prior written permission 44 * 45 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 46 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 47 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 48 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 49 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 50 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 51 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 52 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 53 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 54 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 55 */ 56 57 /* 58 * Soft Definitions for for Qlogic ISP SCSI adapters. 59 * Matthew Jacob <mjacob (at) nas.nasa.gov> 60 */ 61 #ifndef _ISPVAR_H 62 #define _ISPVAR_H 63 64 #if defined(__NetBSD__) || defined(__OpenBSD__) 65 #include <dev/ic/ispmbox.h> 66 #ifdef ISP_TARGET_MODE 67 #include <dev/ic/isp_target.h> 68 #include <dev/ic/isp_tpublic.h> 69 #endif 70 #endif 71 #ifdef __FreeBSD__ 72 #include <dev/isp/ispmbox.h> 73 #ifdef ISP_TARGET_MODE 74 #include <dev/isp/isp_target.h> 75 #include <dev/isp/isp_tpublic.h> 76 #endif 77 #endif 78 #ifdef __linux__ 79 #include "ispmbox.h" 80 #ifdef ISP_TARGET_MODE 81 #include "isp_target.h" 82 #include "isp_tpublic.h" 83 #endif 84 #endif 85 86 #define ISP_CORE_VERSION_MAJOR 2 87 #define ISP_CORE_VERSION_MINOR 0 88 89 /* 90 * Vector for bus specific code to provide specific services. 91 */ 92 struct ispsoftc; 93 struct ispmdvec { 94 u_int16_t (*dv_rd_reg) __P((struct ispsoftc *, int)); 95 void (*dv_wr_reg) __P((struct ispsoftc *, int, u_int16_t)); 96 int (*dv_mbxdma) __P((struct ispsoftc *)); 97 int (*dv_dmaset) __P((struct ispsoftc *, 98 XS_T *, ispreq_t *, u_int16_t *, u_int16_t)); 99 void (*dv_dmaclr) 100 __P((struct ispsoftc *, XS_T *, u_int32_t)); 101 void (*dv_reset0) __P((struct ispsoftc *)); 102 void (*dv_reset1) __P((struct ispsoftc *)); 103 void (*dv_dregs) __P((struct ispsoftc *, const char *)); 104 const u_int16_t *dv_ispfw; /* ptr to f/w */ 105 u_int16_t dv_conf1; 106 u_int16_t dv_clock; /* clock frequency */ 107 }; 108 109 /* 110 * Overall parameters 111 */ 112 #define MAX_TARGETS 16 113 #ifdef ISP2100_FABRIC 114 #define MAX_FC_TARG 256 115 #else 116 #define MAX_FC_TARG 126 117 #endif 118 119 #define ISP_MAX_TARGETS(isp) (IS_FC(isp)? MAX_FC_TARG : MAX_TARGETS) 120 #define ISP_MAX_LUNS(isp) (isp)->isp_maxluns 121 122 123 /* 124 * Macros to access ISP registers through bus specific layers- 125 * mostly wrappers to vector through the mdvec structure. 126 */ 127 128 #define ISP_READ(isp, reg) \ 129 (*(isp)->isp_mdvec->dv_rd_reg)((isp), (reg)) 130 131 #define ISP_WRITE(isp, reg, val) \ 132 (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), (val)) 133 134 #define ISP_MBOXDMASETUP(isp) \ 135 (*(isp)->isp_mdvec->dv_mbxdma)((isp)) 136 137 #define ISP_DMASETUP(isp, xs, req, iptrp, optr) \ 138 (*(isp)->isp_mdvec->dv_dmaset)((isp), (xs), (req), (iptrp), (optr)) 139 140 #define ISP_DMAFREE(isp, xs, hndl) \ 141 if ((isp)->isp_mdvec->dv_dmaclr) \ 142 (*(isp)->isp_mdvec->dv_dmaclr)((isp), (xs), (hndl)) 143 144 #define ISP_RESET0(isp) \ 145 if ((isp)->isp_mdvec->dv_reset0) (*(isp)->isp_mdvec->dv_reset0)((isp)) 146 #define ISP_RESET1(isp) \ 147 if ((isp)->isp_mdvec->dv_reset1) (*(isp)->isp_mdvec->dv_reset1)((isp)) 148 #define ISP_DUMPREGS(isp, m) \ 149 if ((isp)->isp_mdvec->dv_dregs) (*(isp)->isp_mdvec->dv_dregs)((isp),(m)) 150 151 #define ISP_SETBITS(isp, reg, val) \ 152 (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), ISP_READ((isp), (reg)) | (val)) 153 154 #define ISP_CLRBITS(isp, reg, val) \ 155 (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), ISP_READ((isp), (reg)) & ~(val)) 156 157 /* 158 * The MEMORYBARRIER macro is defined per platform (to provide synchronization 159 * on Request and Response Queues, Scratch DMA areas, and Registers) 160 * 161 * Defined Memory Barrier Synchronization Types 162 */ 163 #define SYNC_REQUEST 0 /* request queue synchronization */ 164 #define SYNC_RESULT 1 /* result queue synchronization */ 165 #define SYNC_SFORDEV 2 /* scratch, sync for ISP */ 166 #define SYNC_SFORCPU 3 /* scratch, sync for CPU */ 167 #define SYNC_REG 4 /* for registers */ 168 169 /* 170 * Request/Response Queue defines and macros. 171 * The maximum is defined per platform (and can be based on board type). 172 */ 173 /* This is the size of a queue entry (request and response) */ 174 #define QENTRY_LEN 64 175 /* Both request and result queue length must be a power of two */ 176 #define RQUEST_QUEUE_LEN(x) MAXISPREQUEST(x) 177 #define RESULT_QUEUE_LEN(x) \ 178 (((MAXISPREQUEST(x) >> 2) < 64)? 64 : MAXISPREQUEST(x) >> 2) 179 #define ISP_QUEUE_ENTRY(q, idx) ((q) + ((idx) * QENTRY_LEN)) 180 #define ISP_QUEUE_SIZE(n) ((n) * QENTRY_LEN) 181 #define ISP_NXT_QENTRY(idx, qlen) (((idx) + 1) & ((qlen)-1)) 182 #define ISP_QFREE(in, out, qlen) \ 183 ((in == out)? (qlen - 1) : ((in > out)? \ 184 ((qlen - 1) - (in - out)) : (out - in - 1))) 185 #define ISP_QAVAIL(isp) \ 186 ISP_QFREE(isp->isp_reqidx, isp->isp_reqodx, RQUEST_QUEUE_LEN(isp)) 187 188 #define ISP_ADD_REQUEST(isp, iptr) \ 189 MEMORYBARRIER(isp, SYNC_REQUEST, iptr, QENTRY_LEN); \ 190 ISP_WRITE(isp, INMAILBOX4, iptr); \ 191 isp->isp_reqidx = iptr 192 193 /* 194 * SCSI Specific Host Adapter Parameters- per bus, per target 195 */ 196 197 typedef struct { 198 u_int isp_gotdparms : 1, 199 isp_req_ack_active_neg : 1, 200 isp_data_line_active_neg: 1, 201 isp_cmd_dma_burst_enable: 1, 202 isp_data_dma_burst_enabl: 1, 203 isp_fifo_threshold : 3, 204 isp_ultramode : 1, 205 isp_diffmode : 1, 206 isp_lvdmode : 1, 207 isp_fast_mttr : 1, /* fast sram */ 208 isp_initiator_id : 4, 209 isp_async_data_setup : 4; 210 u_int16_t isp_selection_timeout; 211 u_int16_t isp_max_queue_depth; 212 u_int8_t isp_tag_aging; 213 u_int8_t isp_bus_reset_delay; 214 u_int8_t isp_retry_count; 215 u_int8_t isp_retry_delay; 216 struct { 217 u_int dev_enable : 1, /* ignored */ 218 : 1, 219 dev_update : 1, 220 dev_refresh : 1, 221 exc_throttle : 8, 222 cur_offset : 4, 223 sync_offset : 4; 224 u_int8_t cur_period; /* current sync period */ 225 u_int8_t sync_period; /* goal sync period */ 226 u_int16_t dev_flags; /* goal device flags */ 227 u_int16_t cur_dflags; /* current device flags */ 228 } isp_devparam[MAX_TARGETS]; 229 } sdparam; 230 231 /* 232 * Device Flags 233 */ 234 #define DPARM_DISC 0x8000 235 #define DPARM_PARITY 0x4000 236 #define DPARM_WIDE 0x2000 237 #define DPARM_SYNC 0x1000 238 #define DPARM_TQING 0x0800 239 #define DPARM_ARQ 0x0400 240 #define DPARM_QFRZ 0x0200 241 #define DPARM_RENEG 0x0100 242 #define DPARM_NARROW 0x0080 243 #define DPARM_ASYNC 0x0040 244 #define DPARM_PPR 0x0020 245 #define DPARM_DEFAULT (0xFF00 & ~DPARM_QFRZ) 246 #define DPARM_SAFE_DFLT (DPARM_DEFAULT & ~(DPARM_WIDE|DPARM_SYNC|DPARM_TQING)) 247 248 249 /* technically, not really correct, as they need to be rated based upon clock */ 250 #define ISP_80M_SYNCPARMS 0x0c09 251 #define ISP_40M_SYNCPARMS 0x0c0a 252 #define ISP_20M_SYNCPARMS 0x0c0c 253 #define ISP_20M_SYNCPARMS_1040 0x080c 254 #define ISP_10M_SYNCPARMS 0x0c19 255 #define ISP_08M_SYNCPARMS 0x0c25 256 #define ISP_05M_SYNCPARMS 0x0c32 257 #define ISP_04M_SYNCPARMS 0x0c41 258 259 /* 260 * Fibre Channel Specifics 261 */ 262 #define FL_PORT_ID 0x7e /* FL_Port Special ID */ 263 #define FC_PORT_ID 0x7f /* Fabric Controller Special ID */ 264 #define FC_SNS_ID 0x80 /* SNS Server Special ID */ 265 266 typedef struct { 267 u_int32_t isp_fwoptions : 16, 268 : 4, 269 loop_seen_once : 1, 270 isp_loopstate : 3, /* Current Loop State */ 271 isp_fwstate : 3, /* ISP F/W state */ 272 isp_gotdparms : 1, 273 isp_topo : 3, 274 isp_onfabric : 1; 275 u_int8_t isp_loopid; /* hard loop id */ 276 u_int8_t isp_alpa; /* ALPA */ 277 volatile u_int16_t isp_lipseq; /* LIP sequence # */ 278 u_int32_t isp_portid; 279 u_int8_t isp_execthrottle; 280 u_int8_t isp_retry_delay; 281 u_int8_t isp_retry_count; 282 u_int8_t isp_reserved; 283 u_int16_t isp_maxalloc; 284 u_int16_t isp_maxfrmlen; 285 u_int64_t isp_nodewwn; 286 u_int64_t isp_portwwn; 287 /* 288 * Port Data Base. This is indexed by 'target', which is invariate. 289 * However, elements within can move around due to loop changes, 290 * so the actual loop ID passed to the F/W is in this structure. 291 * The first time the loop is seen up, loopid will match the index 292 * (except for fabric nodes which are above mapped above FC_SNS_ID 293 * and are completely virtual), but subsequent LIPs can cause things 294 * to move around. 295 */ 296 struct lportdb { 297 u_int 298 loopid : 8, 299 : 4, 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[FL_PORT_ID]; 307 308 /* 309 * Scratch DMA mapped in area to fetch Port Database stuff, etc. 310 */ 311 caddr_t isp_scratch; 312 u_int32_t isp_scdma; 313 } fcparam; 314 315 #define FW_CONFIG_WAIT 0 316 #define FW_WAIT_AL_PA 1 317 #define FW_WAIT_LOGIN 2 318 #define FW_READY 3 319 #define FW_LOSS_OF_SYNC 4 320 #define FW_ERROR 5 321 #define FW_REINIT 6 322 #define FW_NON_PART 7 323 324 #define LOOP_NIL 0 325 #define LOOP_LIP_RCVD 1 326 #define LOOP_PDB_RCVD 2 327 #define LOOP_READY 7 328 329 #define TOPO_NL_PORT 0 330 #define TOPO_FL_PORT 1 331 #define TOPO_N_PORT 2 332 #define TOPO_F_PORT 3 333 #define TOPO_PTP_STUB 4 334 335 /* 336 * Soft Structure per host adapter 337 */ 338 typedef struct ispsoftc { 339 /* 340 * Platform (OS) specific data 341 */ 342 struct isposinfo isp_osinfo; 343 344 /* 345 * Pointer to bus specific functions and data 346 */ 347 struct ispmdvec * isp_mdvec; 348 349 /* 350 * (Mostly) nonvolatile state. Board specific parameters 351 * may contain some volatile state (e.g., current loop state). 352 */ 353 354 void * isp_param; /* type specific */ 355 u_int16_t isp_fwrev[3]; /* Loaded F/W revision */ 356 u_int16_t isp_romfw_rev[3]; /* PROM F/W revision */ 357 u_int16_t isp_maxcmds; /* max possible I/O cmds */ 358 u_int8_t isp_type; /* HBA Chip Type */ 359 u_int8_t isp_revision; /* HBA Chip H/W Revision */ 360 u_int32_t isp_maxluns; /* maximum luns supported */ 361 362 u_int32_t 363 isp_touched : 1, /* board ever seen? */ 364 : 1, 365 isp_bustype : 1, /* SBus or PCI */ 366 isp_loaded_fw : 1, /* loaded firmware */ 367 isp_dblev : 12, /* debug log mask */ 368 isp_clock : 8, /* input clock */ 369 isp_confopts : 8; /* config options */ 370 /* 371 * Instrumentation 372 */ 373 u_int64_t isp_intcnt; /* total int count */ 374 u_int64_t isp_intbogus; /* spurious int count */ 375 376 /* 377 * Volatile state 378 */ 379 380 volatile u_int32_t 381 isp_mboxbsy : 8, /* mailbox command active */ 382 : 1, 383 isp_state : 3, 384 isp_sendmarker : 2, /* send a marker entry */ 385 isp_update : 2, /* update parameters */ 386 isp_nactive : 16; /* how many commands active */ 387 volatile u_int16_t isp_reqodx; /* index of last ISP pickup */ 388 volatile u_int16_t isp_reqidx; /* index of next request */ 389 volatile u_int16_t isp_residx; /* index of next result */ 390 volatile u_int16_t isp_lasthdls; /* last handle seed */ 391 volatile u_int16_t isp_mboxtmp[MAX_MAILBOX]; 392 393 /* 394 * Active commands are stored here, indexed by handle functions. 395 */ 396 XS_T **isp_xflist; 397 398 /* 399 * request/result queue pointers and dma handles for them. 400 */ 401 caddr_t isp_rquest; 402 caddr_t isp_result; 403 u_int32_t isp_rquest_dma; 404 u_int32_t isp_result_dma; 405 } ispsoftc_t; 406 407 #define SDPARAM(isp) ((sdparam *) (isp)->isp_param) 408 #define FCPARAM(isp) ((fcparam *) (isp)->isp_param) 409 410 /* 411 * ISP Driver Run States 412 */ 413 #define ISP_NILSTATE 0 414 #define ISP_RESETSTATE 1 415 #define ISP_INITSTATE 2 416 #define ISP_RUNSTATE 3 417 418 /* 419 * ISP Configuration Options 420 */ 421 #define ISP_CFG_NORELOAD 0x80 /* don't download f/w */ 422 #define ISP_CFG_NONVRAM 0x40 /* ignore NVRAM */ 423 #define ISP_CFG_FULL_DUPLEX 0x01 /* Full Duplex (Fibre Channel only) */ 424 #define ISP_CFG_OWNWWN 0x02 /* override NVRAM wwn */ 425 #define ISP_CFG_PORT_PREF 0x0C /* Mask for Port Prefs (2200 only) */ 426 #define ISP_CFG_LPORT 0x00 /* prefer {N/F}L-Port connection */ 427 #define ISP_CFG_NPORT 0x04 /* prefer {N/F}-Port connection */ 428 #define ISP_CFG_NPORT_ONLY 0x08 /* insist on {N/F}-Port connection */ 429 #define ISP_CFG_LPORT_ONLY 0x0C /* insist on {N/F}L-Port connection */ 430 431 /* 432 * Firmware related defines 433 */ 434 #define ISP_CODE_ORG 0x1000 /* default f/w code start */ 435 #define ISP_FW_REV(maj, min, mic) ((maj << 24) | (min << 16) | mic) 436 #define ISP_FW_REVX(xp) ((xp[0]<<24) | (xp[1] << 16) | xp[2]) 437 438 /* 439 * Bus (implementation) types 440 */ 441 #define ISP_BT_PCI 0 /* PCI Implementations */ 442 #define ISP_BT_SBUS 1 /* SBus Implementations */ 443 444 /* 445 * Chip Types 446 */ 447 #define ISP_HA_SCSI 0xf 448 #define ISP_HA_SCSI_UNKNOWN 0x1 449 #define ISP_HA_SCSI_1020 0x2 450 #define ISP_HA_SCSI_1020A 0x3 451 #define ISP_HA_SCSI_1040 0x4 452 #define ISP_HA_SCSI_1040A 0x5 453 #define ISP_HA_SCSI_1040B 0x6 454 #define ISP_HA_SCSI_1040C 0x7 455 #define ISP_HA_SCSI_1240 0x8 456 #define ISP_HA_SCSI_1080 0x9 457 #define ISP_HA_SCSI_1280 0xa 458 #define ISP_HA_SCSI_12160 0xb 459 #define ISP_HA_FC 0xf0 460 #define ISP_HA_FC_2100 0x10 461 #define ISP_HA_FC_2200 0x20 462 463 #define IS_SCSI(isp) (isp->isp_type & ISP_HA_SCSI) 464 #define IS_1240(isp) (isp->isp_type == ISP_HA_SCSI_1240) 465 #define IS_1080(isp) (isp->isp_type == ISP_HA_SCSI_1080) 466 #define IS_1280(isp) (isp->isp_type == ISP_HA_SCSI_1280) 467 #define IS_12160(isp) (isp->isp_type == ISP_HA_SCSI_12160) 468 469 #define IS_12X0(isp) (IS_1240(isp) || IS_1280(isp)) 470 #define IS_DUALBUS(isp) (IS_12X0(isp) || IS_12160(isp)) 471 #define IS_ULTRA2(isp) (IS_1080(isp) || IS_1280(isp) || IS_12160(isp)) 472 #define IS_ULTRA3(isp) (IS_12160(isp)) 473 474 #define IS_FC(isp) (isp->isp_type & ISP_HA_FC) 475 #define IS_2100(isp) (isp->isp_type == ISP_HA_FC_2100) 476 #define IS_2200(isp) (isp->isp_type == ISP_HA_FC_2200) 477 478 /* 479 * DMA cookie macros 480 */ 481 #define DMA_MSW(x) (((x) >> 16) & 0xffff) 482 #define DMA_LSW(x) (((x) & 0xffff)) 483 484 /* 485 * Core System Function Prototypes 486 */ 487 488 /* 489 * Reset Hardware. Totally. Assumes that you'll follow this with 490 * a call to isp_init. 491 */ 492 void isp_reset __P((struct ispsoftc *)); 493 494 /* 495 * Initialize Hardware to known state 496 */ 497 void isp_init __P((struct ispsoftc *)); 498 499 /* 500 * Reset the ISP and call completion for any orphaned commands. 501 */ 502 void isp_reinit __P((struct ispsoftc *)); 503 504 /* 505 * Interrupt Service Routine 506 */ 507 int isp_intr __P((void *)); 508 509 /* 510 * Command Entry Point- Platform Dependent layers call into this 511 */ 512 int isp_start __P((XS_T *)); 513 /* these values are what isp_start returns */ 514 #define CMD_COMPLETE 101 /* command completed */ 515 #define CMD_EAGAIN 102 /* busy- maybe retry later */ 516 #define CMD_QUEUED 103 /* command has been queued for execution */ 517 #define CMD_RQLATER 104 /* requeue this command later */ 518 519 /* 520 * Command Completion Point- Core layers call out from this with completed cmds 521 */ 522 void isp_done __P((XS_T *)); 523 524 /* 525 * Platform Dependent to External to Internal Control Function 526 * 527 * Assumes all locks are held and that no reentrancy issues need be dealt with. 528 * 529 */ 530 typedef enum { 531 ISPCTL_RESET_BUS, /* Reset Bus */ 532 ISPCTL_RESET_DEV, /* Reset Device */ 533 ISPCTL_ABORT_CMD, /* Abort Command */ 534 ISPCTL_UPDATE_PARAMS, /* Update Operating Parameters */ 535 ISPCTL_FCLINK_TEST, /* Test FC Link Status */ 536 ISPCTL_PDB_SYNC, /* Synchronize Port Database */ 537 ISPCTL_TOGGLE_TMODE /* toggle target mode */ 538 } ispctl_t; 539 int isp_control __P((struct ispsoftc *, ispctl_t, void *)); 540 541 542 /* 543 * Platform Dependent to Internal to External Control Function 544 * (each platform must provide such a function) 545 * 546 * Assumes all locks are held and that no reentrancy issues need be dealt with. 547 * 548 */ 549 550 typedef enum { 551 ISPASYNC_NEW_TGT_PARAMS, 552 ISPASYNC_BUS_RESET, /* Bus Was Reset */ 553 ISPASYNC_LOOP_DOWN, /* FC Loop Down */ 554 ISPASYNC_LOOP_UP, /* FC Loop Up */ 555 ISPASYNC_PDB_CHANGED, /* FC Port Data Base Changed */ 556 ISPASYNC_CHANGE_NOTIFY, /* FC SNS Change Notification */ 557 ISPASYNC_FABRIC_DEV, /* FC New Fabric Device */ 558 ISPASYNC_TARGET_MESSAGE, /* target message */ 559 ISPASYNC_TARGET_EVENT, /* target asynchronous event */ 560 ISPASYNC_TARGET_ACTION /* other target command action */ 561 } ispasync_t; 562 int isp_async __P((struct ispsoftc *, ispasync_t, void *)); 563 564 /* 565 * Platform Dependent Error and Debug Printout 566 */ 567 void isp_prt __P((struct ispsoftc *, int level, const char *, ...)); 568 #define ISP_LOGALL 0x0 /* log always */ 569 #define ISP_LOGCONFIG 0x1 /* log configuration messages */ 570 #define ISP_LOGINFO 0x2 /* log informational messages */ 571 #define ISP_LOGWARN 0x4 /* log warning messages */ 572 #define ISP_LOGERR 0x8 /* log error messages */ 573 #define ISP_LOGDEBUG0 0x10 /* log simple debug messages */ 574 #define ISP_LOGDEBUG1 0x20 /* log intermediate debug messages */ 575 #define ISP_LOGDEBUG2 0x40 /* log most debug messages */ 576 #define ISP_LOGDEBUG3 0x100 /* log high frequency debug messages */ 577 #define ISP_LOGTDEBUG0 0x200 /* log simple debug messages (target mode) */ 578 #define ISP_LOGTDEBUG1 0x400 /* log intermediate debug messages (target) */ 579 #define ISP_LOGTDEBUG2 0x800 /* log all debug messages (target) */ 580 581 /* 582 * Each Platform provides it's own isposinfo substructure of the ispsoftc 583 * defined above. 584 * 585 * Each platform must also provide the following macros/defines: 586 * 587 * 588 * INLINE - platform specific define for 'inline' functions 589 * 590 * ISP2100_FABRIC - defines whether FABRIC support is enabled 591 * ISP2100_SCRLEN - length for the Fibre Channel scratch DMA area 592 * 593 * MEMZERO(dst, src) platform zeroing function 594 * MEMCPY(dst, src, count) platform copying function 595 * SNPRINTF(buf, bufsize, fmt, ...) snprintf 596 * STRNCAT(dstbuf, size, srcbuf) strncat 597 * USEC_DELAY(usecs) microsecond spindelay function 598 * USEC_SLEEP(isp, usecs) microsecond sleep function 599 * 600 * NANOTIME_T nanosecond time type 601 * 602 * GET_NANOTIME(NANOTIME_T *) get current nanotime. 603 * 604 * GET_NANOSEC(NANOTIME_T *) get u_int64_t from NANOTIME_T 605 * 606 * NANOTIME_SUB(NANOTIME_T *, NANOTIME_T *) 607 * subtract two NANOTIME_T values 608 * 609 * 610 * MAXISPREQUEST(struct ispsoftc *) maximum request queue size 611 * for this particular board type 612 * 613 * MEMORYBARRIER(struct ispsoftc *, barrier_type, offset, size) 614 * 615 * Function/Macro the provides memory synchronization on 616 * various objects so that the ISP's and the system's view 617 * of the same object is consistent. 618 * 619 * MBOX_ACQUIRE(struct ispsoftc *) acquire lock on mailbox regs 620 * MBOX_WAIT_COMPLETE(struct ispsoftc *) wait for mailbox cmd to be done 621 * MBOX_NOTIFY_COMPLETE(struct ispsoftc *) notification of mbox cmd donee 622 * MBOX_RELEASE(struct ispsoftc *) release lock on mailbox regs 623 * 624 * 625 * SCSI_GOOD SCSI 'Good' Status 626 * SCSI_CHECK SCSI 'Check Condition' Status 627 * SCSI_BUSY SCSI 'Busy' Status 628 * SCSI_QFULL SCSI 'Queue Full' Status 629 * 630 * XS_T Platform SCSI transaction type (i.e., command for HBA) 631 * XS_ISP(xs) gets an instance out of an XS_T 632 * XS_CHANNEL(xs) gets the channel (bus # for DUALBUS cards) "" 633 * XS_TGT(xs) gets the target "" 634 * XS_LUN(xs) gets the lun "" 635 * XS_CDBP(xs) gets a pointer to the scsi CDB "" 636 * XS_CDBLEN(xs) gets the CDB's length "" 637 * XS_XFRLEN(xs) gets the associated data transfer length "" 638 * XS_TIME(xs) gets the time (in milliseconds) for this command 639 * XS_RESID(xs) gets the current residual count 640 * XS_STSP(xs) gets a pointer to the SCSI status byte "" 641 * XS_SNSP(xs) gets a pointer to the associate sense data 642 * XS_SNSLEN(xs) gets the length of sense data storage 643 * XS_SNSKEY(xs) dereferences XS_SNSP to get the current stored Sense Key 644 * XS_TAG_P(xs) predicate of whether this command should be tagged 645 * XS_TAG_TYPE(xs) which type of tag to use 646 * XS_SETERR(xs) set error state 647 * 648 * HBA_NOERROR command has no erros 649 * HBA_BOTCH hba botched something 650 * HBA_CMDTIMEOUT command timed out 651 * HBA_SELTIMEOUT selection timed out (also port logouts for FC) 652 * HBA_TGTBSY target returned a BUSY status 653 * HBA_BUSRESET bus reset destroyed command 654 * HBA_ABORTED command was aborted (by request) 655 * HBA_DATAOVR a data overrun was detected 656 * HBA_ARQFAIL Automatic Request Sense failed 657 * 658 * XS_ERR(xs) return current error state 659 * XS_NOERR(xs) there is no error currently set 660 * XS_INITERR(xs) initialize error state 661 * 662 * XS_SAVE_SENSE(xs, sp) save sense data 663 * 664 * XS_SET_STATE_STAT(isp, sp, xs) platform dependent interpreter of 665 * response queue entry status bits 666 * 667 * 668 * DEFAULT_IID(struct ispsoftc *) Default SCSI initiator ID 669 * DEFAULT_LOOPID(struct ispsoftc *) Default FC Loop ID 670 * DEFAULT_NODEWWN(struct ispsoftc *) Default Node WWN 671 * DEFAULT_PORTWWN(struct ispsoftc *) Default Port WWN 672 * These establish reasonable defaults for each platform. 673 * These must be available independent of card NVRAM and are 674 * to be used should NVRAM not be readable. 675 * 676 * ISP_NODEWWN(struct ispsoftc *) FC Node WWN to use 677 * ISP_PORTWWN(struct ispsoftc *) FC Port WWN to use 678 * 679 * These are to be used after NVRAM is read. The tags 680 * in fcparam.isp_{node,port}wwn reflect the values 681 * read from NVRAM (possibly corrected for card botches). 682 * Each platform can take that information and override 683 * it or ignore and return the Node and Port WWNs to be 684 * used when sending the Qlogic f/w the Initialization Control 685 * Block. 686 * 687 * (XXX these do endian specific transformations- in transition XXX) 688 * ISP_SWIZZLE_ICB 689 * ISP_UNSWIZZLE_AND_COPY_PDBP 690 * ISP_SWIZZLE_CONTINUATION 691 * ISP_SWIZZLE_REQUEST 692 * ISP_UNSWIZZLE_RESPONSE 693 * ISP_SWIZZLE_SNS_REQ 694 * ISP_UNSWIZZLE_SNS_RSP 695 * ISP_SWIZZLE_NVRAM_WORD 696 * 697 * 698 */ 699 #endif /* _ISPVAR_H */ 700
Indexes created Fri Sep 26 08:10:20 GMT 2025