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