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