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