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