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