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