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