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