1 /* $FreeBSD$ */ 2 /*- 3 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 4 * 5 * Copyright (c) 2009-2020 Alexander Motin <mav@FreeBSD.org> 6 * Copyright (c) 1997-2009 by Matthew Jacob 7 * All rights reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 19 * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22 * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE 23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29 * SUCH DAMAGE. 30 * 31 */ 32 /* 33 * Soft Definitions for for Qlogic ISP SCSI adapters. 34 */ 35 36 #ifndef _ISPVAR_H 37 #define _ISPVAR_H 38 39 #if defined(__NetBSD__) || defined(__OpenBSD__) 40 #include <dev/ic/isp_stds.h> 41 #include <dev/ic/ispmbox.h> 42 #endif 43 #ifdef __FreeBSD__ 44 #include <dev/isp/isp_stds.h> 45 #include <dev/isp/ispmbox.h> 46 #endif 47 #ifdef __linux__ 48 #include "isp_stds.h" 49 #include "ispmbox.h" 50 #endif 51 #ifdef __svr4__ 52 #include "isp_stds.h" 53 #include "ispmbox.h" 54 #endif 55 56 #define ISP_CORE_VERSION_MAJOR 7 57 #define ISP_CORE_VERSION_MINOR 0 58 59 /* 60 * Vector for bus specific code to provide specific services. 61 */ 62 typedef struct ispsoftc ispsoftc_t; 63 struct ispmdvec { 64 void (*dv_run_isr) (ispsoftc_t *); 65 uint32_t (*dv_rd_reg) (ispsoftc_t *, int); 66 void (*dv_wr_reg) (ispsoftc_t *, int, uint32_t); 67 int (*dv_mbxdma) (ispsoftc_t *); 68 int (*dv_dmaset) (ispsoftc_t *, XS_T *, void *); 69 void (*dv_dmaclr) (ispsoftc_t *, XS_T *, uint32_t); 70 int (*dv_irqsetup) (ispsoftc_t *); 71 void (*dv_dregs) (ispsoftc_t *, const char *); 72 const void * dv_ispfw; /* ptr to f/w */ 73 }; 74 75 /* 76 * Overall parameters 77 */ 78 #define MAX_TARGETS 16 79 #ifndef MAX_FC_TARG 80 #define MAX_FC_TARG 1024 81 #endif 82 #define ISP_MAX_TARGETS(isp) MAX_FC_TARG 83 #define ISP_MAX_IRQS 3 84 85 /* 86 * Macros to access ISP registers through bus specific layers- 87 * mostly wrappers to vector through the mdvec structure. 88 */ 89 #define ISP_RUN_ISR(isp) \ 90 (*(isp)->isp_mdvec->dv_run_isr)(isp) 91 92 #define ISP_READ(isp, reg) \ 93 (*(isp)->isp_mdvec->dv_rd_reg)((isp), (reg)) 94 95 #define ISP_WRITE(isp, reg, val) \ 96 (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), (val)) 97 98 #define ISP_MBOXDMASETUP(isp) \ 99 (*(isp)->isp_mdvec->dv_mbxdma)((isp)) 100 101 #define ISP_DMASETUP(isp, xs, req) \ 102 (*(isp)->isp_mdvec->dv_dmaset)((isp), (xs), (req)) 103 104 #define ISP_DMAFREE(isp, xs, hndl) \ 105 if ((isp)->isp_mdvec->dv_dmaclr) \ 106 (*(isp)->isp_mdvec->dv_dmaclr)((isp), (xs), (hndl)) 107 108 #define ISP_IRQSETUP(isp) \ 109 (((isp)->isp_mdvec->dv_irqsetup) ? (*(isp)->isp_mdvec->dv_irqsetup)(isp) : 0) 110 #define ISP_DUMPREGS(isp, m) \ 111 if ((isp)->isp_mdvec->dv_dregs) (*(isp)->isp_mdvec->dv_dregs)((isp),(m)) 112 113 #define ISP_SETBITS(isp, reg, val) \ 114 (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), ISP_READ((isp), (reg)) | (val)) 115 116 #define ISP_CLRBITS(isp, reg, val) \ 117 (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), ISP_READ((isp), (reg)) & ~(val)) 118 119 /* 120 * The MEMORYBARRIER macro is defined per platform (to provide synchronization 121 * on Request and Response Queues, Scratch DMA areas, and Registers) 122 * 123 * Defined Memory Barrier Synchronization Types 124 */ 125 #define SYNC_REQUEST 0 /* request queue synchronization */ 126 #define SYNC_RESULT 1 /* result queue synchronization */ 127 #define SYNC_SFORDEV 2 /* scratch, sync for ISP */ 128 #define SYNC_SFORCPU 3 /* scratch, sync for CPU */ 129 #define SYNC_REG 4 /* for registers */ 130 #define SYNC_ATIOQ 5 /* atio result queue (24xx) */ 131 #define SYNC_IFORDEV 6 /* synchrounous IOCB, sync for ISP */ 132 #define SYNC_IFORCPU 7 /* synchrounous IOCB, sync for CPU */ 133 134 /* 135 * Request/Response Queue defines and macros. 136 * The maximum is defined per platform (and can be based on board type). 137 */ 138 /* This is the size of a queue entry (request and response) */ 139 #define QENTRY_LEN 64 140 /* Both request and result queue length must be a power of two */ 141 #define RQUEST_QUEUE_LEN(x) MAXISPREQUEST(x) 142 #ifdef ISP_TARGET_MODE 143 #define RESULT_QUEUE_LEN(x) MAXISPREQUEST(x) 144 #else 145 #define RESULT_QUEUE_LEN(x) \ 146 (((MAXISPREQUEST(x) >> 2) < 64)? 64 : MAXISPREQUEST(x) >> 2) 147 #endif 148 #define ISP_QUEUE_ENTRY(q, idx) (((uint8_t *)q) + ((idx) * QENTRY_LEN)) 149 #define ISP_QUEUE_SIZE(n) ((n) * QENTRY_LEN) 150 #define ISP_NXT_QENTRY(idx, qlen) (((idx) + 1) & ((qlen)-1)) 151 #define ISP_QFREE(in, out, qlen) \ 152 ((in == out)? (qlen - 1) : ((in > out)? \ 153 ((qlen - 1) - (in - out)) : (out - in - 1))) 154 #define ISP_QAVAIL(isp) \ 155 ISP_QFREE(isp->isp_reqidx, isp->isp_reqodx, RQUEST_QUEUE_LEN(isp)) 156 157 #define ISP_ADD_REQUEST(isp, nxti) \ 158 MEMORYBARRIER(isp, SYNC_REQUEST, isp->isp_reqidx, QENTRY_LEN, -1); \ 159 ISP_WRITE(isp, BIU2400_REQINP, nxti); \ 160 isp->isp_reqidx = nxti 161 162 #define ISP_SYNC_REQUEST(isp) \ 163 MEMORYBARRIER(isp, SYNC_REQUEST, isp->isp_reqidx, QENTRY_LEN, -1); \ 164 isp->isp_reqidx = ISP_NXT_QENTRY(isp->isp_reqidx, RQUEST_QUEUE_LEN(isp)); \ 165 ISP_WRITE(isp, BIU2400_REQINP, isp->isp_reqidx) 166 167 /* 168 * Fibre Channel Specifics 169 */ 170 #define NPH_RESERVED 0x7F0 /* begin of reserved N-port handles */ 171 #define NPH_MGT_ID 0x7FA /* Management Server Special ID */ 172 #define NPH_SNS_ID 0x7FC /* SNS Server Special ID */ 173 #define NPH_FABRIC_CTLR 0x7FD /* Fabric Controller (0xFFFFFD) */ 174 #define NPH_FL_ID 0x7FE /* F Port Special ID (0xFFFFFE) */ 175 #define NPH_IP_BCST 0x7FF /* IP Broadcast Special ID (0xFFFFFF) */ 176 #define NPH_MAX_2K 0x800 177 178 /* 179 * "Unassigned" handle to be used internally 180 */ 181 #define NIL_HANDLE 0xffff 182 183 /* 184 * Limit for devices on an arbitrated loop. 185 */ 186 #define LOCAL_LOOP_LIM 126 187 188 /* 189 * Limit for (2K login) N-port handle amounts 190 */ 191 #define MAX_NPORT_HANDLE 2048 192 193 /* 194 * Special Constants 195 */ 196 #define INI_NONE ((uint64_t) 0) 197 #define ISP_NOCHAN 0xff 198 199 /* 200 * Special Port IDs 201 */ 202 #define MANAGEMENT_PORT_ID 0xFFFFFA 203 #define SNS_PORT_ID 0xFFFFFC 204 #define FABRIC_PORT_ID 0xFFFFFE 205 #define PORT_ANY 0xFFFFFF 206 #define PORT_NONE 0 207 #define VALID_PORT(port) (port != PORT_NONE && port != PORT_ANY) 208 #define DOMAIN_CONTROLLER_BASE 0xFFFC00 209 #define DOMAIN_CONTROLLER_END 0xFFFCFF 210 211 /* 212 * Command Handles 213 * 214 * Most QLogic initiator or target have 32 bit handles associated with them. 215 * We want to have a quick way to index back and forth between a local SCSI 216 * command context and what the firmware is passing back to us. We also 217 * want to avoid working on stale information. This structure handles both 218 * at the expense of some local memory. 219 * 220 * The handle is architected thusly: 221 * 222 * 0 means "free handle" 223 * bits 0..12 index commands 224 * bits 13..15 bits index usage 225 * bits 16..31 contain a rolling sequence 226 * 227 * 228 */ 229 typedef struct { 230 void * cmd; /* associated command context */ 231 uint32_t handle; /* handle associated with this command */ 232 } isp_hdl_t; 233 #define ISP_HANDLE_FREE 0x00000000 234 #define ISP_HANDLE_CMD_MASK 0x00001fff 235 #define ISP_HANDLE_USAGE_MASK 0x0000e000 236 #define ISP_HANDLE_USAGE_SHIFT 13 237 #define ISP_H2HT(hdl) ((hdl & ISP_HANDLE_USAGE_MASK) >> ISP_HANDLE_USAGE_SHIFT) 238 # define ISP_HANDLE_NONE 0 239 # define ISP_HANDLE_INITIATOR 1 240 # define ISP_HANDLE_TARGET 2 241 # define ISP_HANDLE_CTRL 3 242 #define ISP_HANDLE_SEQ_MASK 0xffff0000 243 #define ISP_HANDLE_SEQ_SHIFT 16 244 #define ISP_H2SEQ(hdl) ((hdl & ISP_HANDLE_SEQ_MASK) >> ISP_HANDLE_SEQ_SHIFT) 245 #define ISP_VALID_HANDLE(c, hdl) \ 246 ((ISP_H2HT(hdl) == ISP_HANDLE_INITIATOR || \ 247 ISP_H2HT(hdl) == ISP_HANDLE_TARGET || \ 248 ISP_H2HT(hdl) == ISP_HANDLE_CTRL) && \ 249 ((hdl) & ISP_HANDLE_CMD_MASK) < (c)->isp_maxcmds && \ 250 (hdl) == ((c)->isp_xflist[(hdl) & ISP_HANDLE_CMD_MASK].handle)) 251 #define ISP_BAD_HANDLE_INDEX 0xffffffff 252 253 254 /* 255 * FC Port Database entry. 256 * 257 * It has a handle that the f/w uses to address commands to a device. 258 * This handle's value may be assigned by the firmware (e.g., for local loop 259 * devices) or by the driver (e.g., for fabric devices). 260 * 261 * It has a state. If the state if VALID, that means that we've logged into 262 * the device. 263 * 264 * Local loop devices the firmware automatically performs PLOGI on for us 265 * (which is why that handle is imposed upon us). Fabric devices we assign 266 * a handle to and perform the PLOGI on. 267 * 268 * When a PORT DATABASE CHANGED asynchronous event occurs, we mark all VALID 269 * entries as PROBATIONAL. This allows us, if policy says to, just keep track 270 * of devices whose handles change but are otherwise the same device (and 271 * thus keep 'target' constant). 272 * 273 * In any case, we search all possible local loop handles. For each one that 274 * has a port database entity returned, we search for any PROBATIONAL entry 275 * that matches it and update as appropriate. Otherwise, as a new entry, we 276 * find room for it in the Port Database. We *try* and use the handle as the 277 * index to put it into the Database, but that's just an optimization. We mark 278 * the entry VALID and make sure that the target index is updated and correct. 279 * 280 * When we get done searching the local loop, we then search similarly for 281 * a list of devices we've gotten from the fabric name controller (if we're 282 * on a fabric). VALID marking is also done similarly. 283 * 284 * When all of this is done, we can march through the database and clean up 285 * any entry that is still PROBATIONAL (these represent devices which have 286 * departed). Then we're done and can resume normal operations. 287 * 288 * Negative invariants that we try and test for are: 289 * 290 * + There can never be two non-NIL entries with the same { Port, Node } WWN 291 * duples. 292 * 293 * + There can never be two non-NIL entries with the same handle. 294 */ 295 typedef struct { 296 /* 297 * This is the handle that the firmware needs in order for us to 298 * send commands to the device. For pre-24XX cards, this would be 299 * the 'loopid'. 300 */ 301 uint16_t handle; 302 303 /* 304 * PRLI word 0 contains the Establish Image Pair bit, which is 305 * important for knowing when to reset the CRN. 306 * 307 * PRLI word 3 parameters contains role as well as other things. 308 * 309 * The state is the current state of this entry. 310 * 311 * The is_target is the current state of target on this port. 312 * 313 * The is_initiator is the current state of initiator on this port. 314 * 315 * Portid is obvious, as are node && port WWNs. The new_role and 316 * new_portid is for when we are pending a change. 317 */ 318 uint16_t prli_word0; /* PRLI parameters */ 319 uint16_t prli_word3; /* PRLI parameters */ 320 uint16_t new_prli_word0; /* Incoming new PRLI parameters */ 321 uint16_t new_prli_word3; /* Incoming new PRLI parameters */ 322 uint16_t : 12, 323 probational : 1, 324 state : 3; 325 uint32_t : 6, 326 is_target : 1, 327 is_initiator : 1, 328 portid : 24; 329 uint32_t 330 : 8, 331 new_portid : 24; 332 uint64_t node_wwn; 333 uint64_t port_wwn; 334 uint32_t gone_timer; 335 } fcportdb_t; 336 337 #define FC_PORTDB_STATE_NIL 0 /* Empty DB slot */ 338 #define FC_PORTDB_STATE_DEAD 1 /* Was valid, but no more. */ 339 #define FC_PORTDB_STATE_CHANGED 2 /* Was valid, but changed. */ 340 #define FC_PORTDB_STATE_NEW 3 /* Logged in, not announced. */ 341 #define FC_PORTDB_STATE_ZOMBIE 4 /* Invalid, but announced. */ 342 #define FC_PORTDB_STATE_VALID 5 /* Valid */ 343 344 #define FC_PORTDB_TGT(isp, bus, pdb) (int)(lp - FCPARAM(isp, bus)->portdb) 345 346 /* 347 * FC card specific information 348 * 349 * This structure is replicated across multiple channels for multi-id 350 * capapble chipsets, with some entities different on a per-channel basis. 351 */ 352 353 typedef struct { 354 int isp_gbspeed; /* Connection speed */ 355 int isp_linkstate; /* Link state */ 356 int isp_fwstate; /* ISP F/W state */ 357 int isp_loopstate; /* Loop State */ 358 int isp_topo; /* Connection Type */ 359 360 uint32_t : 4, 361 fctape_enabled : 1, 362 sendmarker : 1, 363 role : 2, 364 isp_portid : 24; /* S_ID */ 365 366 uint16_t isp_fwoptions; 367 uint16_t isp_xfwoptions; 368 uint16_t isp_zfwoptions; 369 uint16_t isp_loopid; /* hard loop id */ 370 uint16_t isp_sns_hdl; /* N-port handle for SNS */ 371 uint16_t isp_lasthdl; /* only valid for channel 0 */ 372 uint16_t isp_maxalloc; 373 uint16_t isp_fabric_params; 374 uint16_t isp_login_hdl; /* Logging in handle */ 375 uint8_t isp_retry_delay; 376 uint8_t isp_retry_count; 377 int isp_use_gft_id; /* Use GFT_ID */ 378 int isp_use_gff_id; /* Use GFF_ID */ 379 380 /* 381 * Current active WWNN/WWPN 382 */ 383 uint64_t isp_wwnn; 384 uint64_t isp_wwpn; 385 386 /* 387 * NVRAM WWNN/WWPN 388 */ 389 uint64_t isp_wwnn_nvram; 390 uint64_t isp_wwpn_nvram; 391 392 /* 393 * Our Port Data Base 394 */ 395 fcportdb_t portdb[MAX_FC_TARG]; 396 397 /* 398 * Scratch DMA mapped in area to fetch Port Database stuff, etc. 399 */ 400 void * isp_scratch; 401 XS_DMA_ADDR_T isp_scdma; 402 403 uint8_t isp_scanscratch[ISP_FC_SCRLEN]; 404 } fcparam; 405 406 #define FW_CONFIG_WAIT 0 407 #define FW_WAIT_LINK 1 408 #define FW_WAIT_LOGIN 2 409 #define FW_READY 3 410 #define FW_LOSS_OF_SYNC 4 411 #define FW_ERROR 5 412 #define FW_REINIT 6 413 #define FW_NON_PART 7 414 415 #define LOOP_NIL 0 416 #define LOOP_HAVE_LINK 1 417 #define LOOP_HAVE_ADDR 2 418 #define LOOP_TESTING_LINK 3 419 #define LOOP_LTEST_DONE 4 420 #define LOOP_SCANNING_LOOP 5 421 #define LOOP_LSCAN_DONE 6 422 #define LOOP_SCANNING_FABRIC 7 423 #define LOOP_FSCAN_DONE 8 424 #define LOOP_SYNCING_PDB 9 425 #define LOOP_READY 10 426 427 #define TOPO_NL_PORT 0 428 #define TOPO_FL_PORT 1 429 #define TOPO_N_PORT 2 430 #define TOPO_F_PORT 3 431 #define TOPO_PTP_STUB 4 432 433 #define TOPO_IS_FABRIC(x) ((x) == TOPO_FL_PORT || (x) == TOPO_F_PORT) 434 435 #define FCP_AL_DA_ALL 0xFF 436 #define FCP_AL_PA(fcp) ((uint8_t)(fcp->isp_portid)) 437 #define FCP_IS_DEST_ALPD(fcp, alpd) (FCP_AL_PA((fcp)) == FCP_AL_DA_ALL || FCP_AL_PA((fcp)) == alpd) 438 439 /* 440 * Soft Structure per host adapter 441 */ 442 struct ispsoftc { 443 /* 444 * Platform (OS) specific data 445 */ 446 struct isposinfo isp_osinfo; 447 448 /* 449 * Pointer to bus specific functions and data 450 */ 451 struct ispmdvec * isp_mdvec; 452 453 /* 454 * (Mostly) nonvolatile state. Board specific parameters 455 * may contain some volatile state (e.g., current loop state). 456 */ 457 458 void * isp_param; /* type specific */ 459 uint64_t isp_fwattr; /* firmware attributes */ 460 uint16_t isp_fwrev[3]; /* Loaded F/W revision */ 461 uint16_t isp_maxcmds; /* max possible I/O cmds */ 462 uint8_t isp_type; /* HBA Chip Type */ 463 uint8_t isp_revision; /* HBA Chip H/W Revision */ 464 uint8_t isp_nirq; /* number of IRQs */ 465 uint16_t isp_nchan; /* number of channels */ 466 467 uint32_t isp_clock : 8, /* input clock */ 468 : 5, 469 isp_port : 1, /* 23XX/24XX only */ 470 isp_loaded_fw : 1, /* loaded firmware */ 471 isp_dblev : 16; /* debug log mask */ 472 473 474 uint32_t isp_confopts; /* config options */ 475 476 /* 477 * Volatile state 478 */ 479 volatile u_int isp_mboxbsy; /* mailbox command active */ 480 volatile u_int isp_state; 481 volatile mbreg_t isp_curmbx; /* currently active mailbox command */ 482 volatile uint32_t isp_reqodx; /* index of last ISP pickup */ 483 volatile uint32_t isp_reqidx; /* index of next request */ 484 volatile uint32_t isp_residx; /* index of last ISP write */ 485 volatile uint32_t isp_resodx; /* index of next result */ 486 volatile uint32_t isp_atioodx; /* index of next ATIO */ 487 volatile uint32_t isp_obits; /* mailbox command output */ 488 volatile uint32_t isp_serno; /* rolling serial number */ 489 volatile uint16_t isp_mboxtmp[MAX_MAILBOX]; 490 volatile uint16_t isp_lastmbxcmd; /* last mbox command sent */ 491 volatile uint16_t isp_seqno; /* running sequence number */ 492 493 /* 494 * Active commands are stored here, indexed by handle functions. 495 */ 496 isp_hdl_t *isp_xflist; 497 isp_hdl_t *isp_xffree; 498 499 /* 500 * DMA mapped in area for synchronous IOCB requests. 501 */ 502 void * isp_iocb; 503 XS_DMA_ADDR_T isp_iocb_dma; 504 505 /* 506 * request/result queue pointers and DMA handles for them. 507 */ 508 void * isp_rquest; 509 void * isp_result; 510 XS_DMA_ADDR_T isp_rquest_dma; 511 XS_DMA_ADDR_T isp_result_dma; 512 #ifdef ISP_TARGET_MODE 513 /* for 24XX only */ 514 void * isp_atioq; 515 XS_DMA_ADDR_T isp_atioq_dma; 516 #endif 517 }; 518 519 #define FCPARAM(isp, chan) (&((fcparam *)(isp)->isp_param)[(chan)]) 520 521 #define ISP_SET_SENDMARKER(isp, chan, val) \ 522 FCPARAM(isp, chan)->sendmarker = val \ 523 524 #define ISP_TST_SENDMARKER(isp, chan) \ 525 (FCPARAM(isp, chan)->sendmarker != 0) 526 527 /* 528 * ISP Driver Run States 529 */ 530 #define ISP_NILSTATE 0 531 #define ISP_CRASHED 1 532 #define ISP_RESETSTATE 2 533 #define ISP_INITSTATE 3 534 #define ISP_RUNSTATE 4 535 536 /* 537 * ISP Runtime Configuration Options 538 */ 539 #define ISP_CFG_FULL_DUPLEX 0x01 /* Full Duplex (Fibre Channel only) */ 540 #define ISP_CFG_PORT_PREF 0x0e /* Mask for Port Prefs (all FC except 2100) */ 541 #define ISP_CFG_PORT_DEF 0x00 /* prefer connection type from NVRAM */ 542 #define ISP_CFG_LPORT_ONLY 0x02 /* insist on {N/F}L-Port connection */ 543 #define ISP_CFG_NPORT_ONLY 0x04 /* insist on {N/F}-Port connection */ 544 #define ISP_CFG_LPORT 0x06 /* prefer {N/F}L-Port connection */ 545 #define ISP_CFG_NPORT 0x08 /* prefer {N/F}-Port connection */ 546 #define ISP_CFG_1GB 0x10 /* force 1Gb connection (23XX only) */ 547 #define ISP_CFG_2GB 0x20 /* force 2Gb connection (23XX only) */ 548 #define ISP_CFG_NORELOAD 0x80 /* don't download f/w */ 549 #define ISP_CFG_NONVRAM 0x40 /* ignore NVRAM */ 550 #define ISP_CFG_NOFCTAPE 0x100 /* disable FC-Tape */ 551 #define ISP_CFG_FCTAPE 0x200 /* enable FC-Tape */ 552 #define ISP_CFG_OWNFSZ 0x400 /* override NVRAM frame size */ 553 #define ISP_CFG_OWNLOOPID 0x800 /* override NVRAM loopid */ 554 #define ISP_CFG_OWNEXCTHROTTLE 0x1000 /* override NVRAM execution throttle */ 555 #define ISP_CFG_4GB 0x2000 /* force 4Gb connection (24XX only) */ 556 #define ISP_CFG_8GB 0x4000 /* force 8Gb connection (25XX only) */ 557 #define ISP_CFG_16GB 0x8000 /* force 16Gb connection (26XX only) */ 558 #define ISP_CFG_32GB 0x10000 /* force 32Gb connection (27XX only) */ 559 560 /* 561 * For each channel, the outer layers should know what role that channel 562 * will take: ISP_ROLE_NONE, ISP_ROLE_INITIATOR, ISP_ROLE_TARGET, 563 * ISP_ROLE_BOTH. 564 * 565 * If you set ISP_ROLE_NONE, the cards will be reset, new firmware loaded, 566 * NVRAM read, and defaults set, but any further initialization (e.g. 567 * INITIALIZE CONTROL BLOCK commands for 2X00 cards) won't be done. 568 * 569 * If INITIATOR MODE isn't set, attempts to run commands will be stopped 570 * at isp_start and completed with the equivalent of SELECTION TIMEOUT. 571 * 572 * If TARGET MODE is set, it doesn't mean that the rest of target mode support 573 * needs to be enabled, or will even work. What happens with the 2X00 cards 574 * here is that if you have enabled it with TARGET MODE as part of the ICB 575 * options, but you haven't given the f/w any ram resources for ATIOs or 576 * Immediate Notifies, the f/w just handles what it can and you never see 577 * anything. Basically, it sends a single byte of data (the first byte, 578 * which you can set as part of the INITIALIZE CONTROL BLOCK command) for 579 * INQUIRY, and sends back QUEUE FULL status for any other command. 580 * 581 */ 582 #define ISP_ROLE_NONE 0x0 583 #define ISP_ROLE_TARGET 0x1 584 #define ISP_ROLE_INITIATOR 0x2 585 #define ISP_ROLE_BOTH (ISP_ROLE_TARGET|ISP_ROLE_INITIATOR) 586 #define ISP_ROLE_EITHER ISP_ROLE_BOTH 587 #ifndef ISP_DEFAULT_ROLES 588 /* 589 * Counterintuitively, we prefer to default to role 'none' 590 * if we are enable target mode support. This gives us the 591 * maximum flexibility as to which port will do what. 592 */ 593 #ifdef ISP_TARGET_MODE 594 #define ISP_DEFAULT_ROLES ISP_ROLE_NONE 595 #else 596 #define ISP_DEFAULT_ROLES ISP_ROLE_INITIATOR 597 #endif 598 #endif 599 600 601 /* 602 * Firmware related defines 603 */ 604 #define ISP_CODE_ORG 0x1000 /* default f/w code start */ 605 #define ISP_CODE_ORG_2300 0x0800 /* ..except for 2300s */ 606 #define ISP_CODE_ORG_2400 0x100000 /* ..and 2400s */ 607 #define ISP_FW_REV(maj, min, mic) ((maj << 24) | (min << 16) | mic) 608 #define ISP_FW_MAJOR(code) ((code >> 24) & 0xff) 609 #define ISP_FW_MINOR(code) ((code >> 16) & 0xff) 610 #define ISP_FW_MICRO(code) ((code >> 8) & 0xff) 611 #define ISP_FW_REVX(xp) ((xp[0]<<24) | (xp[1] << 16) | xp[2]) 612 #define ISP_FW_MAJORX(xp) (xp[0]) 613 #define ISP_FW_MINORX(xp) (xp[1]) 614 #define ISP_FW_MICROX(xp) (xp[2]) 615 #define ISP_FW_NEWER_THAN(i, major, minor, micro) \ 616 (ISP_FW_REVX((i)->isp_fwrev) > ISP_FW_REV(major, minor, micro)) 617 #define ISP_FW_OLDER_THAN(i, major, minor, micro) \ 618 (ISP_FW_REVX((i)->isp_fwrev) < ISP_FW_REV(major, minor, micro)) 619 620 /* 621 * Chip Types 622 */ 623 #define ISP_HA_FC_2400 0x04 624 #define ISP_HA_FC_2500 0x05 625 #define ISP_HA_FC_2600 0x06 626 #define ISP_HA_FC_2700 0x07 627 628 #define IS_25XX(isp) ((isp)->isp_type >= ISP_HA_FC_2500) 629 #define IS_26XX(isp) ((isp)->isp_type >= ISP_HA_FC_2600) 630 #define IS_27XX(isp) ((isp)->isp_type >= ISP_HA_FC_2700) 631 632 /* 633 * DMA related macros 634 */ 635 #define DMA_WD3(x) (((uint16_t)(((uint64_t)x) >> 48)) & 0xffff) 636 #define DMA_WD2(x) (((uint16_t)(((uint64_t)x) >> 32)) & 0xffff) 637 #define DMA_WD1(x) ((uint16_t)((x) >> 16) & 0xffff) 638 #define DMA_WD0(x) ((uint16_t)((x) & 0xffff)) 639 640 #define DMA_LO32(x) ((uint32_t) (x)) 641 #define DMA_HI32(x) ((uint32_t)(((uint64_t)x) >> 32)) 642 643 /* 644 * Core System Function Prototypes 645 */ 646 647 /* 648 * Reset Hardware. Totally. Assumes that you'll follow this with a call to isp_init. 649 */ 650 void isp_reset(ispsoftc_t *, int); 651 652 /* 653 * Initialize Hardware to known state 654 */ 655 void isp_init(ispsoftc_t *); 656 657 /* 658 * Reset the ISP and call completion for any orphaned commands. 659 */ 660 int isp_reinit(ispsoftc_t *, int); 661 662 /* 663 * Shutdown hardware after use. 664 */ 665 void isp_shutdown(ispsoftc_t *); 666 667 /* 668 * Internal Interrupt Service Routine 669 */ 670 #ifdef ISP_TARGET_MODE 671 void isp_intr_atioq(ispsoftc_t *); 672 #endif 673 void isp_intr_async(ispsoftc_t *, uint16_t event); 674 void isp_intr_mbox(ispsoftc_t *, uint16_t mbox0); 675 void isp_intr_respq(ispsoftc_t *); 676 677 678 /* 679 * Command Entry Point- Platform Dependent layers call into this 680 */ 681 int isp_start(XS_T *); 682 683 /* these values are what isp_start returns */ 684 #define CMD_COMPLETE 101 /* command completed */ 685 #define CMD_EAGAIN 102 /* busy- maybe retry later */ 686 #define CMD_QUEUED 103 /* command has been queued for execution */ 687 #define CMD_RQLATER 104 /* requeue this command later */ 688 689 /* 690 * Command Completion Point- Core layers call out from this with completed cmds 691 */ 692 void isp_done(XS_T *); 693 694 /* 695 * Platform Dependent to External to Internal Control Function 696 * 697 * Assumes locks are held on entry. You should note that with many of 698 * these commands locks may be released while this function is called. 699 * 700 * ... ISPCTL_RESET_BUS, int channel); 701 * Reset BUS on this channel 702 * ... ISPCTL_RESET_DEV, int channel, int target); 703 * Reset Device on this channel at this target. 704 * ... ISPCTL_ABORT_CMD, XS_T *xs); 705 * Abort active transaction described by xs. 706 * ... IPCTL_UPDATE_PARAMS); 707 * Update any operating parameters (speed, etc.) 708 * ... ISPCTL_FCLINK_TEST, int channel); 709 * Test FC link status on this channel 710 * ... ISPCTL_SCAN_LOOP, int channel); 711 * Scan local loop on this channel 712 * ... ISPCTL_SCAN_FABRIC, int channel); 713 * Scan fabric on this channel 714 * ... ISPCTL_PDB_SYNC, int channel); 715 * Synchronize port database on this channel 716 * ... ISPCTL_SEND_LIP, int channel); 717 * Send a LIP on this channel 718 * ... ISPCTL_GET_NAMES, int channel, int np, uint64_t *wwnn, uint64_t *wwpn) 719 * Get a WWNN/WWPN for this N-port handle on this channel 720 * ... ISPCTL_GET_PDB, int channel, int nphandle, isp_pdb_t *pdb) 721 * Get PDB on this channel for this N-port handle 722 * ... ISPCTL_PLOGX, isp_plcmd_t *) 723 * Performa a port login/logout 724 * ... ISPCTL_CHANGE_ROLE, int channel, int role); 725 * Change role of specified channel 726 * 727 * ISPCTL_PDB_SYNC is somewhat misnamed. It actually is the final step, in 728 * order, of ISPCTL_FCLINK_TEST, ISPCTL_SCAN_LOOP, and ISPCTL_SCAN_FABRIC. 729 * The main purpose of ISPCTL_PDB_SYNC is to complete management of logging 730 * and logging out of fabric devices (if one is on a fabric) and then marking 731 * the 'loop state' as being ready to now be used for sending commands to 732 * devices. 733 */ 734 typedef enum { 735 ISPCTL_RESET_BUS, 736 ISPCTL_RESET_DEV, 737 ISPCTL_ABORT_CMD, 738 ISPCTL_UPDATE_PARAMS, 739 ISPCTL_FCLINK_TEST, 740 ISPCTL_SCAN_FABRIC, 741 ISPCTL_SCAN_LOOP, 742 ISPCTL_PDB_SYNC, 743 ISPCTL_SEND_LIP, 744 ISPCTL_GET_NAMES, 745 ISPCTL_GET_PDB, 746 ISPCTL_PLOGX, 747 ISPCTL_CHANGE_ROLE 748 } ispctl_t; 749 int isp_control(ispsoftc_t *, ispctl_t, ...); 750 751 /* 752 * Platform Dependent to Internal to External Control Function 753 */ 754 755 typedef enum { 756 ISPASYNC_BUS_RESET, /* All Bus Was Reset */ 757 ISPASYNC_LOOP_DOWN, /* FC Loop Down */ 758 ISPASYNC_LOOP_UP, /* FC Loop Up */ 759 ISPASYNC_LIP, /* FC LIP Received */ 760 ISPASYNC_LOOP_RESET, /* FC Loop Reset Received */ 761 ISPASYNC_CHANGE_NOTIFY, /* FC Change Notification */ 762 ISPASYNC_DEV_ARRIVED, /* FC Device Arrived */ 763 ISPASYNC_DEV_CHANGED, /* FC Device Changed */ 764 ISPASYNC_DEV_STAYED, /* FC Device Stayed */ 765 ISPASYNC_DEV_GONE, /* FC Device Departure */ 766 ISPASYNC_TARGET_NOTIFY, /* All target async notification */ 767 ISPASYNC_TARGET_NOTIFY_ACK, /* All target notify ack required */ 768 ISPASYNC_TARGET_ACTION, /* All target action requested */ 769 ISPASYNC_FW_CRASH, /* All Firmware has crashed */ 770 ISPASYNC_FW_RESTARTED /* All Firmware has been restarted */ 771 } ispasync_t; 772 void isp_async(ispsoftc_t *, ispasync_t, ...); 773 774 #define ISPASYNC_CHANGE_PDB 0 775 #define ISPASYNC_CHANGE_SNS 1 776 #define ISPASYNC_CHANGE_OTHER 2 777 778 /* 779 * Platform Dependent Error and Debug Printout 780 * 781 * Two required functions for each platform must be provided: 782 * 783 * void isp_prt(ispsoftc_t *, int level, const char *, ...) 784 * void isp_xs_prt(ispsoftc_t *, XS_T *, int level, const char *, ...) 785 * 786 * but due to compiler differences on different platforms this won't be 787 * formally defined here. Instead, they go in each platform definition file. 788 */ 789 790 #define ISP_LOGALL 0x0 /* log always */ 791 #define ISP_LOGCONFIG 0x1 /* log configuration messages */ 792 #define ISP_LOGINFO 0x2 /* log informational messages */ 793 #define ISP_LOGWARN 0x4 /* log warning messages */ 794 #define ISP_LOGERR 0x8 /* log error messages */ 795 #define ISP_LOGDEBUG0 0x10 /* log simple debug messages */ 796 #define ISP_LOGDEBUG1 0x20 /* log intermediate debug messages */ 797 #define ISP_LOGDEBUG2 0x40 /* log most debug messages */ 798 #define ISP_LOGDEBUG3 0x80 /* log high frequency debug messages */ 799 #define ISP_LOG_SANCFG 0x100 /* log SAN configuration */ 800 #define ISP_LOG_CWARN 0x200 /* log SCSI command "warnings" (e.g., check conditions) */ 801 #define ISP_LOG_WARN1 0x400 /* log WARNS we might be interested at some time */ 802 #define ISP_LOGTINFO 0x1000 /* log informational messages (target mode) */ 803 #define ISP_LOGTDEBUG0 0x2000 /* log simple debug messages (target mode) */ 804 #define ISP_LOGTDEBUG1 0x4000 /* log intermediate debug messages (target) */ 805 #define ISP_LOGTDEBUG2 0x8000 /* log all debug messages (target) */ 806 807 /* 808 * Each Platform provides it's own isposinfo substructure of the ispsoftc 809 * defined above. 810 * 811 * Each platform must also provide the following macros/defines: 812 * 813 * 814 * ISP_FC_SCRLEN FC scratch area DMA length 815 * 816 * ISP_MEMZERO(dst, src) platform zeroing function 817 * ISP_MEMCPY(dst, src, count) platform copying function 818 * ISP_SNPRINTF(buf, bufsize, fmt, ...) snprintf 819 * ISP_DELAY(usecs) microsecond spindelay function 820 * ISP_SLEEP(isp, usecs) microsecond sleep function 821 * 822 * ISP_INLINE ___inline or not- depending on how 823 * good your debugger is 824 * ISP_MIN shorthand for ((a) < (b))? (a) : (b) 825 * 826 * NANOTIME_T nanosecond time type 827 * 828 * GET_NANOTIME(NANOTIME_T *) get current nanotime. 829 * 830 * GET_NANOSEC(NANOTIME_T *) get uint64_t from NANOTIME_T 831 * 832 * NANOTIME_SUB(NANOTIME_T *, NANOTIME_T *) 833 * subtract two NANOTIME_T values 834 * 835 * MAXISPREQUEST(ispsoftc_t *) maximum request queue size 836 * for this particular board type 837 * 838 * MEMORYBARRIER(ispsoftc_t *, barrier_type, offset, size, chan) 839 * 840 * Function/Macro the provides memory synchronization on 841 * various objects so that the ISP's and the system's view 842 * of the same object is consistent. 843 * 844 * MBOX_ACQUIRE(ispsoftc_t *) acquire lock on mailbox regs 845 * MBOX_WAIT_COMPLETE(ispsoftc_t *, mbreg_t *) wait for cmd to be done 846 * MBOX_NOTIFY_COMPLETE(ispsoftc_t *) notification of mbox cmd donee 847 * MBOX_RELEASE(ispsoftc_t *) release lock on mailbox regs 848 * 849 * FC_SCRATCH_ACQUIRE(ispsoftc_t *, chan) acquire lock on FC scratch area 850 * return -1 if you cannot 851 * FC_SCRATCH_RELEASE(ispsoftc_t *, chan) acquire lock on FC scratch area 852 * 853 * FCP_NEXT_CRN(ispsoftc_t *, XS_T *, rslt, channel, target, lun) generate the next command reference number. XS_T * may be null. 854 * 855 * SCSI_GOOD SCSI 'Good' Status 856 * SCSI_CHECK SCSI 'Check Condition' Status 857 * SCSI_BUSY SCSI 'Busy' Status 858 * SCSI_QFULL SCSI 'Queue Full' Status 859 * 860 * XS_T Platform SCSI transaction type (i.e., command for HBA) 861 * XS_DMA_ADDR_T Platform PCI DMA Address Type 862 * XS_GET_DMA64_SEG(..) Get 64 bit dma segment list value 863 * XS_ISP(xs) gets an instance out of an XS_T 864 * XS_CHANNEL(xs) gets the channel (bus # for DUALBUS cards) "" 865 * XS_TGT(xs) gets the target "" 866 * XS_LUN(xs) gets the lun "" 867 * XS_CDBP(xs) gets a pointer to the scsi CDB "" 868 * XS_CDBLEN(xs) gets the CDB's length "" 869 * XS_XFRLEN(xs) gets the associated data transfer length "" 870 * XS_TIME(xs) gets the time (in seconds) for this command 871 * XS_GET_RESID(xs) gets the current residual count 872 * XS_GET_RESID(xs, resid) sets the current residual count 873 * XS_STSP(xs) gets a pointer to the SCSI status byte "" 874 * XS_SNSP(xs) gets a pointer to the associate sense data 875 * XS_TOT_SNSLEN(xs) gets the total length of sense data storage 876 * XS_CUR_SNSLEN(xs) gets the currently used length of sense data storage 877 * XS_SNSKEY(xs) dereferences XS_SNSP to get the current stored Sense Key 878 * XS_SNSASC(xs) dereferences XS_SNSP to get the current stored Additional Sense Code 879 * XS_SNSASCQ(xs) dereferences XS_SNSP to get the current stored Additional Sense Code Qualifier 880 * XS_TAG_P(xs) predicate of whether this command should be tagged 881 * XS_TAG_TYPE(xs) which type of tag to use 882 * XS_PRIORITY(xs) command priority for SIMPLE tag 883 * XS_SETERR(xs) set error state 884 * 885 * HBA_NOERROR command has no erros 886 * HBA_BOTCH hba botched something 887 * HBA_CMDTIMEOUT command timed out 888 * HBA_SELTIMEOUT selection timed out (also port logouts for FC) 889 * HBA_TGTBSY target returned a BUSY status 890 * HBA_BUSRESET bus reset destroyed command 891 * HBA_ABORTED command was aborted (by request) 892 * HBA_DATAOVR a data overrun was detected 893 * HBA_ARQFAIL Automatic Request Sense failed 894 * 895 * XS_ERR(xs) return current error state 896 * XS_NOERR(xs) there is no error currently set 897 * XS_INITERR(xs) initialize error state 898 * 899 * XS_SAVE_SENSE(xs, sp, len) save sense data 900 * XS_APPEND_SENSE(xs, sp, len) append more sense data 901 * 902 * XS_SENSE_VALID(xs) indicates whether sense is valid 903 * 904 * DEFAULT_FRAMESIZE(ispsoftc_t *) Default Frame Size 905 * DEFAULT_EXEC_THROTTLE(ispsoftc_t *) Default Execution Throttle 906 * 907 * DEFAULT_ROLE(ispsoftc_t *, int) Get Default Role for a channel 908 * DEFAULT_LOOPID(ispsoftc_t *, int) Default FC Loop ID 909 * 910 * These establish reasonable defaults for each platform. 911 * These must be available independent of card NVRAM and are 912 * to be used should NVRAM not be readable. 913 * 914 * DEFAULT_NODEWWN(ispsoftc_t *, chan) Default FC Node WWN to use 915 * DEFAULT_PORTWWN(ispsoftc_t *, chan) Default FC Port WWN to use 916 * 917 * These defines are hooks to allow the setting of node and 918 * port WWNs when NVRAM cannot be read or is to be overriden. 919 * 920 * ACTIVE_NODEWWN(ispsoftc_t *, chan) FC Node WWN to use 921 * ACTIVE_PORTWWN(ispsoftc_t *, chan) FC Port WWN to use 922 * 923 * After NVRAM is read, these will be invoked to get the 924 * node and port WWNs that will actually be used for this 925 * channel. 926 * 927 * 928 * ISP_IOXPUT_8(ispsoftc_t *, uint8_t srcval, uint8_t *dstptr) 929 * ISP_IOXPUT_16(ispsoftc_t *, uint16_t srcval, uint16_t *dstptr) 930 * ISP_IOXPUT_32(ispsoftc_t *, uint32_t srcval, uint32_t *dstptr) 931 * 932 * ISP_IOXGET_8(ispsoftc_t *, uint8_t *srcptr, uint8_t dstrval) 933 * ISP_IOXGET_16(ispsoftc_t *, uint16_t *srcptr, uint16_t dstrval) 934 * ISP_IOXGET_32(ispsoftc_t *, uint32_t *srcptr, uint32_t dstrval) 935 * 936 * ISP_SWIZZLE_NVRAM_WORD(ispsoftc_t *, uint16_t *) 937 * ISP_SWIZZLE_NVRAM_LONG(ispsoftc_t *, uint32_t *) 938 * ISP_SWAP16(ispsoftc_t *, uint16_t srcval) 939 * ISP_SWAP32(ispsoftc_t *, uint32_t srcval) 940 */ 941 942 #ifdef ISP_TARGET_MODE 943 /* 944 * The functions below are for the publicly available 945 * target mode functions that are internal to the Qlogic driver. 946 */ 947 948 /* 949 * This function handles new response queue entry appropriate for target mode. 950 */ 951 int isp_target_notify(ispsoftc_t *, void *, uint32_t *); 952 953 /* 954 * This function externalizes the ability to acknowledge an Immediate Notify request. 955 */ 956 int isp_notify_ack(ispsoftc_t *, void *); 957 958 /* 959 * This function externalized acknowledging (success/fail) an ABTS frame 960 */ 961 int isp_acknak_abts(ispsoftc_t *, void *, int); 962 963 /* 964 * General request queue 'put' routine for target mode entries. 965 */ 966 int isp_target_put_entry(ispsoftc_t *isp, void *); 967 968 /* 969 * General routine to send a final CTIO for a command- used mostly for 970 * local responses. 971 */ 972 int isp_endcmd(ispsoftc_t *, ...); 973 #define ECMD_SVALID 0x100 974 #define ECMD_RVALID 0x200 975 #define ECMD_TERMINATE 0x400 976 977 /* 978 * Handle an asynchronous event 979 */ 980 void isp_target_async(ispsoftc_t *, int, int); 981 #endif 982 #endif /* _ISPVAR_H */ 983