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