ispvar.h revision 79235
1/* $FreeBSD: head/sys/dev/isp/ispvar.h 79235 2001-07-04 18:46:50Z mjacob $ */ 2/* 3 * Soft Definitions for for Qlogic ISP SCSI adapters. 4 * 5 * Copyright (c) 1997, 1998, 1999, 2000 by Matthew Jacob 6 * All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice immediately at the beginning of the file, without modification, 13 * this list of conditions, and the following disclaimer. 14 * 2. The name of the author may not be used to endorse or promote products 15 * derived from this software without specific prior written permission. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE 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 THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR 21 * 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#ifndef _ISPVAR_H 32#define _ISPVAR_H 33 34#if defined(__NetBSD__) || defined(__OpenBSD__) 35#include <dev/ic/ispmbox.h> 36#ifdef ISP_TARGET_MODE 37#include <dev/ic/isp_target.h> 38#include <dev/ic/isp_tpublic.h> 39#endif 40#endif 41#ifdef __FreeBSD__ 42#include <dev/isp/ispmbox.h> 43#ifdef ISP_TARGET_MODE 44#include <dev/isp/isp_target.h> 45#include <dev/isp/isp_tpublic.h> 46#endif 47#endif 48#ifdef __linux__ 49#include "ispmbox.h" 50#ifdef ISP_TARGET_MODE 51#include "isp_target.h" 52#include "isp_tpublic.h" 53#endif 54#endif 55 56#define ISP_CORE_VERSION_MAJOR 2 57#define ISP_CORE_VERSION_MINOR 1 58 59/* 60 * Vector for bus specific code to provide specific services. 61 */ 62struct ispsoftc; 63struct ispmdvec { 64 u_int16_t (*dv_rd_reg) (struct ispsoftc *, int); 65 void (*dv_wr_reg) (struct ispsoftc *, int, u_int16_t); 66 int (*dv_mbxdma) (struct ispsoftc *); 67 int (*dv_dmaset) (struct ispsoftc *, 68 XS_T *, ispreq_t *, u_int16_t *, u_int16_t); 69 void (*dv_dmaclr) 70 (struct ispsoftc *, XS_T *, u_int16_t); 71 void (*dv_reset0) (struct ispsoftc *); 72 void (*dv_reset1) (struct ispsoftc *); 73 void (*dv_dregs) (struct ispsoftc *, const char *); 74 const u_int16_t *dv_ispfw; /* ptr to f/w */ 75 u_int16_t dv_conf1; 76 u_int16_t dv_clock; /* clock frequency */ 77}; 78 79/* 80 * Overall parameters 81 */ 82#define MAX_TARGETS 16 83#define MAX_FC_TARG 256 84#define ISP_MAX_TARGETS(isp) (IS_FC(isp)? MAX_FC_TARG : MAX_TARGETS) 85#define ISP_MAX_LUNS(isp) (isp)->isp_maxluns 86 87 88/* 89 * Macros to access ISP registers through bus specific layers- 90 * mostly wrappers to vector through the mdvec structure. 91 */ 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, iptrp, optr) \ 103 (*(isp)->isp_mdvec->dv_dmaset)((isp), (xs), (req), (iptrp), (optr)) 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_RESET0(isp) \ 110 if ((isp)->isp_mdvec->dv_reset0) (*(isp)->isp_mdvec->dv_reset0)((isp)) 111#define ISP_RESET1(isp) \ 112 if ((isp)->isp_mdvec->dv_reset1) (*(isp)->isp_mdvec->dv_reset1)((isp)) 113#define ISP_DUMPREGS(isp, m) \ 114 if ((isp)->isp_mdvec->dv_dregs) (*(isp)->isp_mdvec->dv_dregs)((isp),(m)) 115 116#define ISP_SETBITS(isp, reg, val) \ 117 (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), ISP_READ((isp), (reg)) | (val)) 118 119#define ISP_CLRBITS(isp, reg, val) \ 120 (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), ISP_READ((isp), (reg)) & ~(val)) 121 122/* 123 * The MEMORYBARRIER macro is defined per platform (to provide synchronization 124 * on Request and Response Queues, Scratch DMA areas, and Registers) 125 * 126 * Defined Memory Barrier Synchronization Types 127 */ 128#define SYNC_REQUEST 0 /* request queue synchronization */ 129#define SYNC_RESULT 1 /* result queue synchronization */ 130#define SYNC_SFORDEV 2 /* scratch, sync for ISP */ 131#define SYNC_SFORCPU 3 /* scratch, sync for CPU */ 132#define SYNC_REG 4 /* for registers */ 133 134/* 135 * Request/Response Queue defines and macros. 136 * The maximum is defined per platform (and can be based on board type). 137 */ 138/* This is the size of a queue entry (request and response) */ 139#define QENTRY_LEN 64 140/* Both request and result queue length must be a power of two */ 141#define RQUEST_QUEUE_LEN(x) MAXISPREQUEST(x) 142#define RESULT_QUEUE_LEN(x) \ 143 (((MAXISPREQUEST(x) >> 2) < 64)? 64 : MAXISPREQUEST(x) >> 2) 144#define ISP_QUEUE_ENTRY(q, idx) ((q) + ((idx) * QENTRY_LEN)) 145#define ISP_QUEUE_SIZE(n) ((n) * QENTRY_LEN) 146#define ISP_NXT_QENTRY(idx, qlen) (((idx) + 1) & ((qlen)-1)) 147#define ISP_QFREE(in, out, qlen) \ 148 ((in == out)? (qlen - 1) : ((in > out)? \ 149 ((qlen - 1) - (in - out)) : (out - in - 1))) 150#define ISP_QAVAIL(isp) \ 151 ISP_QFREE(isp->isp_reqidx, isp->isp_reqodx, RQUEST_QUEUE_LEN(isp)) 152 153#define ISP_ADD_REQUEST(isp, iptr) \ 154 MEMORYBARRIER(isp, SYNC_REQUEST, iptr, QENTRY_LEN); \ 155 ISP_WRITE(isp, INMAILBOX4, iptr); \ 156 isp->isp_reqidx = iptr 157 158/* 159 * SCSI Specific Host Adapter Parameters- per bus, per target 160 */ 161 162typedef struct { 163 u_int isp_gotdparms : 1, 164 isp_req_ack_active_neg : 1, 165 isp_data_line_active_neg: 1, 166 isp_cmd_dma_burst_enable: 1, 167 isp_data_dma_burst_enabl: 1, 168 isp_fifo_threshold : 3, 169 isp_ultramode : 1, 170 isp_diffmode : 1, 171 isp_lvdmode : 1, 172 isp_fast_mttr : 1, /* fast sram */ 173 isp_initiator_id : 4, 174 isp_async_data_setup : 4; 175 u_int16_t isp_selection_timeout; 176 u_int16_t isp_max_queue_depth; 177 u_int8_t isp_tag_aging; 178 u_int8_t isp_bus_reset_delay; 179 u_int8_t isp_retry_count; 180 u_int8_t isp_retry_delay; 181 struct { 182 u_int dev_enable : 1, /* ignored */ 183 : 1, 184 dev_update : 1, 185 dev_refresh : 1, 186 exc_throttle : 8, 187 cur_offset : 4, 188 sync_offset : 4; 189 u_int8_t cur_period; /* current sync period */ 190 u_int8_t sync_period; /* goal sync period */ 191 u_int16_t dev_flags; /* goal device flags */ 192 u_int16_t cur_dflags; /* current device flags */ 193 } isp_devparam[MAX_TARGETS]; 194} sdparam; 195 196/* 197 * Device Flags 198 */ 199#define DPARM_DISC 0x8000 200#define DPARM_PARITY 0x4000 201#define DPARM_WIDE 0x2000 202#define DPARM_SYNC 0x1000 203#define DPARM_TQING 0x0800 204#define DPARM_ARQ 0x0400 205#define DPARM_QFRZ 0x0200 206#define DPARM_RENEG 0x0100 207#define DPARM_NARROW 0x0080 208#define DPARM_ASYNC 0x0040 209#define DPARM_PPR 0x0020 210#define DPARM_DEFAULT (0xFF00 & ~DPARM_QFRZ) 211#define DPARM_SAFE_DFLT (DPARM_DEFAULT & ~(DPARM_WIDE|DPARM_SYNC|DPARM_TQING)) 212 213 214/* technically, not really correct, as they need to be rated based upon clock */ 215#define ISP_80M_SYNCPARMS 0x0c09 216#define ISP_40M_SYNCPARMS 0x0c0a 217#define ISP_20M_SYNCPARMS 0x0c0c 218#define ISP_20M_SYNCPARMS_1040 0x080c 219#define ISP_10M_SYNCPARMS 0x0c19 220#define ISP_08M_SYNCPARMS 0x0c25 221#define ISP_05M_SYNCPARMS 0x0c32 222#define ISP_04M_SYNCPARMS 0x0c41 223 224/* 225 * Fibre Channel Specifics 226 */ 227#define FL_PORT_ID 0x7e /* FL_Port Special ID */ 228#define FC_PORT_ID 0x7f /* Fabric Controller Special ID */ 229#define FC_SNS_ID 0x80 /* SNS Server Special ID */ 230 231typedef struct { 232 u_int32_t isp_fwoptions : 16, 233 : 2, 234 isp_iid_set : 1, 235 loop_seen_once : 1, 236 isp_loopstate : 4, /* Current Loop State */ 237 isp_fwstate : 3, /* ISP F/W state */ 238 isp_gotdparms : 1, 239 isp_topo : 3, 240 isp_onfabric : 1; 241 u_int8_t isp_iid; /* 'initiator' id */ 242 u_int8_t isp_loopid; /* hard loop id */ 243 u_int8_t isp_alpa; /* ALPA */ 244 u_int32_t isp_portid; 245 volatile u_int16_t isp_lipseq; /* LIP sequence # */ 246 u_int16_t isp_xxxxxx; 247 u_int8_t isp_execthrottle; 248 u_int8_t isp_retry_delay; 249 u_int8_t isp_retry_count; 250 u_int8_t isp_reserved; 251 u_int16_t isp_maxalloc; 252 u_int16_t isp_maxfrmlen; 253 u_int64_t isp_nodewwn; 254 u_int64_t isp_portwwn; 255 /* 256 * Port Data Base. This is indexed by 'target', which is invariate. 257 * However, elements within can move around due to loop changes, 258 * so the actual loop ID passed to the F/W is in this structure. 259 * The first time the loop is seen up, loopid will match the index 260 * (except for fabric nodes which are above mapped above FC_SNS_ID 261 * and are completely virtual), but subsequent LIPs can cause things 262 * to move around. 263 */ 264 struct lportdb { 265 u_int 266 loopid : 8, 267 : 1, 268 force_logout : 1, 269 was_fabric_dev : 1, 270 fabric_dev : 1, 271 loggedin : 1, 272 roles : 2, 273 valid : 1; 274 u_int32_t portid; 275 u_int64_t node_wwn; 276 u_int64_t port_wwn; 277 } portdb[MAX_FC_TARG], tport[FC_PORT_ID]; 278 279 /* 280 * Scratch DMA mapped in area to fetch Port Database stuff, etc. 281 */ 282 caddr_t isp_scratch; 283 u_int32_t isp_scdma; 284} fcparam; 285 286#define FW_CONFIG_WAIT 0 287#define FW_WAIT_AL_PA 1 288#define FW_WAIT_LOGIN 2 289#define FW_READY 3 290#define FW_LOSS_OF_SYNC 4 291#define FW_ERROR 5 292#define FW_REINIT 6 293#define FW_NON_PART 7 294 295#define LOOP_NIL 0 296#define LOOP_LIP_RCVD 1 297#define LOOP_PDB_RCVD 2 298#define LOOP_SCANNING_FABRIC 3 299#define LOOP_FSCAN_DONE 4 300#define LOOP_SCANNING_LOOP 5 301#define LOOP_LSCAN_DONE 6 302#define LOOP_SYNCING_PDB 7 303#define LOOP_READY 8 304 305#define TOPO_NL_PORT 0 306#define TOPO_FL_PORT 1 307#define TOPO_N_PORT 2 308#define TOPO_F_PORT 3 309#define TOPO_PTP_STUB 4 310 311/* 312 * Soft Structure per host adapter 313 */ 314typedef struct ispsoftc { 315 /* 316 * Platform (OS) specific data 317 */ 318 struct isposinfo isp_osinfo; 319 320 /* 321 * Pointer to bus specific functions and data 322 */ 323 struct ispmdvec * isp_mdvec; 324 325 /* 326 * (Mostly) nonvolatile state. Board specific parameters 327 * may contain some volatile state (e.g., current loop state). 328 */ 329 330 void * isp_param; /* type specific */ 331 u_int16_t isp_fwrev[3]; /* Loaded F/W revision */ 332 u_int16_t isp_romfw_rev[3]; /* PROM F/W revision */ 333 u_int16_t isp_maxcmds; /* max possible I/O cmds */ 334 u_int8_t isp_type; /* HBA Chip Type */ 335 u_int8_t isp_revision; /* HBA Chip H/W Revision */ 336 u_int32_t isp_maxluns; /* maximum luns supported */ 337 338 u_int32_t isp_clock : 8, /* input clock */ 339 : 6, 340 isp_role : 2, 341 : 1, 342 isp_touched : 1, /* board ever seen? */ 343 isp_bustype : 1, /* SBus or PCI */ 344 isp_loaded_fw : 1, /* loaded firmware */ 345 isp_dblev : 12; /* debug log mask */ 346 347 u_int32_t isp_confopts; /* config options */ 348 349 /* 350 * Instrumentation 351 */ 352 u_int64_t isp_intcnt; /* total int count */ 353 u_int64_t isp_intbogus; /* spurious int count */ 354 355 /* 356 * Volatile state 357 */ 358 359 volatile u_int32_t 360 isp_mboxbsy : 8, /* mailbox command active */ 361 : 1, 362 isp_state : 3, 363 isp_sendmarker : 2, /* send a marker entry */ 364 isp_update : 2, /* update parameters */ 365 isp_nactive : 16; /* how many commands active */ 366 volatile u_int16_t isp_reqodx; /* index of last ISP pickup */ 367 volatile u_int16_t isp_reqidx; /* index of next request */ 368 volatile u_int16_t isp_residx; /* index of next result */ 369 volatile u_int16_t isp_lasthdls; /* last handle seed */ 370 volatile u_int16_t isp_mboxtmp[MAX_MAILBOX]; 371 volatile u_int16_t isp_lastmbxcmd; /* last mbox command sent */ 372 373 /* 374 * Active commands are stored here, indexed by handle functions. 375 */ 376 XS_T **isp_xflist; 377 378 /* 379 * request/result queue pointers and dma handles for them. 380 */ 381 caddr_t isp_rquest; 382 caddr_t isp_result; 383 u_int32_t isp_rquest_dma; 384 u_int32_t isp_result_dma; 385} ispsoftc_t; 386 387#define SDPARAM(isp) ((sdparam *) (isp)->isp_param) 388#define FCPARAM(isp) ((fcparam *) (isp)->isp_param) 389 390/* 391 * ISP Driver Run States 392 */ 393#define ISP_NILSTATE 0 394#define ISP_RESETSTATE 1 395#define ISP_INITSTATE 2 396#define ISP_RUNSTATE 3 397 398/* 399 * ISP Configuration Options 400 */ 401#define ISP_CFG_NORELOAD 0x80 /* don't download f/w */ 402#define ISP_CFG_NONVRAM 0x40 /* ignore NVRAM */ 403#define ISP_CFG_FULL_DUPLEX 0x01 /* Full Duplex (Fibre Channel only) */ 404#define ISP_CFG_OWNWWN 0x02 /* override NVRAM wwn */ 405#define ISP_CFG_PORT_PREF 0x0C /* Mask for Port Prefs (2200 only) */ 406#define ISP_CFG_LPORT 0x00 /* prefer {N/F}L-Port connection */ 407#define ISP_CFG_NPORT 0x04 /* prefer {N/F}-Port connection */ 408#define ISP_CFG_NPORT_ONLY 0x08 /* insist on {N/F}-Port connection */ 409#define ISP_CFG_LPORT_ONLY 0x0C /* insist on {N/F}L-Port connection */ 410 411/* 412 * Prior to calling isp_reset for the first time, the outer layer 413 * should set isp_role to one of NONE, INITIATOR, TARGET, BOTH. 414 * 415 * If you set ISP_ROLE_NONE, the cards will be reset, new firmware loaded, 416 * NVRAM read, and defaults set, but any further initialization (e.g. 417 * INITIALIZE CONTROL BLOCK commands for 2X00 cards) won't be done. 418 * 419 * If INITIATOR MODE isn't set, attempts to run commands will be stopped 420 * at isp_start and completed with the moral equivalent of SELECTION TIMEOUT. 421 * 422 * If TARGET MODE is set, it doesn't mean that the rest of target mode support 423 * needs to be enabled, or will even work. What happens with the 2X00 cards 424 * here is that if you have enabled it with TARGET MODE as part of the ICB 425 * options, but you haven't given the f/w any ram resources for ATIOs or 426 * Immediate Notifies, the f/w just handles what it can and you never see 427 * anything. Basically, it sends a single byte of data (the first byte, 428 * which you can set as part of the INITIALIZE CONTROL BLOCK command) for 429 * INQUIRY, and sends back QUEUE FULL status for any other command. 430 * 431 */ 432#define ISP_ROLE_NONE 0x0 433#define ISP_ROLE_INITIATOR 0x1 434#define ISP_ROLE_TARGET 0x2 435#define ISP_ROLE_BOTH (ISP_ROLE_TARGET|ISP_ROLE_INITIATOR) 436#define ISP_ROLE_EITHER ISP_ROLE_BOTH 437#ifndef ISP_DEFAULT_ROLES 438#define ISP_DEFAULT_ROLES ISP_ROLE_INITIATOR 439#endif 440 441 442/* 443 * Firmware related defines 444 */ 445#define ISP_CODE_ORG 0x1000 /* default f/w code start */ 446#define ISP_FW_REV(maj, min, mic) ((maj << 24) | (min << 16) | mic) 447#define ISP_FW_REVX(xp) ((xp[0]<<24) | (xp[1] << 16) | xp[2]) 448 449/* 450 * Bus (implementation) types 451 */ 452#define ISP_BT_PCI 0 /* PCI Implementations */ 453#define ISP_BT_SBUS 1 /* SBus Implementations */ 454 455/* 456 * Chip Types 457 */ 458#define ISP_HA_SCSI 0xf 459#define ISP_HA_SCSI_UNKNOWN 0x1 460#define ISP_HA_SCSI_1020 0x2 461#define ISP_HA_SCSI_1020A 0x3 462#define ISP_HA_SCSI_1040 0x4 463#define ISP_HA_SCSI_1040A 0x5 464#define ISP_HA_SCSI_1040B 0x6 465#define ISP_HA_SCSI_1040C 0x7 466#define ISP_HA_SCSI_1240 0x8 467#define ISP_HA_SCSI_1080 0x9 468#define ISP_HA_SCSI_1280 0xa 469#define ISP_HA_SCSI_12160 0xb 470#define ISP_HA_FC 0xf0 471#define ISP_HA_FC_2100 0x10 472#define ISP_HA_FC_2200 0x20 473#define ISP_HA_FC_2300 0x30 474 475#define IS_SCSI(isp) (isp->isp_type & ISP_HA_SCSI) 476#define IS_1240(isp) (isp->isp_type == ISP_HA_SCSI_1240) 477#define IS_1080(isp) (isp->isp_type == ISP_HA_SCSI_1080) 478#define IS_1280(isp) (isp->isp_type == ISP_HA_SCSI_1280) 479#define IS_12160(isp) (isp->isp_type == ISP_HA_SCSI_12160) 480 481#define IS_12X0(isp) (IS_1240(isp) || IS_1280(isp)) 482#define IS_DUALBUS(isp) (IS_12X0(isp) || IS_12160(isp)) 483#define IS_ULTRA2(isp) (IS_1080(isp) || IS_1280(isp) || IS_12160(isp)) 484#define IS_ULTRA3(isp) (IS_12160(isp)) 485 486#define IS_FC(isp) ((isp)->isp_type & ISP_HA_FC) 487#define IS_2100(isp) ((isp)->isp_type == ISP_HA_FC_2100) 488#define IS_2200(isp) ((isp)->isp_type == ISP_HA_FC_2200) 489#define IS_2300(isp) ((isp)->isp_type == ISP_HA_FC_2300) 490 491/* 2300 Support isn't ready yet */ 492#define ISP_DISABLE_2300_SUPPORT 1 493 494/* 495 * DMA cookie macros 496 */ 497#define DMA_MSW(x) (((x) >> 16) & 0xffff) 498#define DMA_LSW(x) (((x) & 0xffff)) 499 500/* 501 * Core System Function Prototypes 502 */ 503 504/* 505 * Reset Hardware. Totally. Assumes that you'll follow this with 506 * a call to isp_init. 507 */ 508void isp_reset(struct ispsoftc *); 509 510/* 511 * Initialize Hardware to known state 512 */ 513void isp_init(struct ispsoftc *); 514 515/* 516 * Reset the ISP and call completion for any orphaned commands. 517 */ 518void isp_reinit(struct ispsoftc *); 519 520/* 521 * Interrupt Service Routine 522 */ 523int isp_intr(void *); 524 525/* 526 * Command Entry Point- Platform Dependent layers call into this 527 */ 528int isp_start(XS_T *); 529/* these values are what isp_start returns */ 530#define CMD_COMPLETE 101 /* command completed */ 531#define CMD_EAGAIN 102 /* busy- maybe retry later */ 532#define CMD_QUEUED 103 /* command has been queued for execution */ 533#define CMD_RQLATER 104 /* requeue this command later */ 534 535/* 536 * Command Completion Point- Core layers call out from this with completed cmds 537 */ 538void isp_done(XS_T *); 539 540/* 541 * Platform Dependent to External to Internal Control Function 542 * 543 * Assumes locks are held on entry. You should note that with many of 544 * these commands and locks may be released while this is occurring. 545 * 546 * A few notes about some of these functions: 547 * 548 * ISPCTL_FCLINK_TEST tests to make sure we have good fibre channel link. 549 * The argument is a pointer to an integer which is the time, in microseconds, 550 * we should wait to see whether we have good link. This test, if successful, 551 * lets us know our connection topology and our Loop ID/AL_PA and so on. 552 * You can't get anywhere without this. 553 * 554 * ISPCTL_SCAN_FABRIC queries the name server (if we're on a fabric) for 555 * all entities using the FC Generic Services subcommand GET ALL NEXT. 556 * For each found entity, an ISPASYNC_FABRICDEV event is generated (see 557 * below). 558 * 559 * ISPCTL_SCAN_LOOP does a local loop scan. This is only done if the connection 560 * topology is NL or FL port (private or public loop). Since the Qlogic f/w 561 * 'automatically' manages local loop connections, this function essentially 562 * notes the arrival, departure, and possible shuffling around of local loop 563 * entities. Thus for each arrival and departure this generates an isp_async 564 * event of ISPASYNC_PROMENADE (see below). 565 * 566 * ISPCTL_PDB_SYNC is somewhat misnamed. It actually is the final step, in 567 * order, of ISPCTL_FCLINK_TEST, ISPCTL_SCAN_FABRIC, and ISPCTL_SCAN_LOOP. 568 * The main purpose of ISPCTL_PDB_SYNC is to complete management of logging 569 * and logging out of fabric devices (if one is on a fabric) and then marking 570 * the 'loop state' as being ready to now be used for sending commands to 571 * devices. Originally fabric name server and local loop scanning were 572 * part of this function. It's now been seperated to allow for finer control. 573 */ 574typedef enum { 575 ISPCTL_RESET_BUS, /* Reset Bus */ 576 ISPCTL_RESET_DEV, /* Reset Device */ 577 ISPCTL_ABORT_CMD, /* Abort Command */ 578 ISPCTL_UPDATE_PARAMS, /* Update Operating Parameters (SCSI) */ 579 ISPCTL_FCLINK_TEST, /* Test FC Link Status */ 580 ISPCTL_SCAN_FABRIC, /* (Re)scan Fabric Name Server */ 581 ISPCTL_SCAN_LOOP, /* (Re)scan Local Loop */ 582 ISPCTL_PDB_SYNC, /* Synchronize Port Database */ 583 ISPCTL_SEND_LIP, /* Send a LIP */ 584 ISPCTL_GET_POSMAP, /* Get FC-AL position map */ 585 ISPCTL_RUN_MBOXCMD, /* run a mailbox command */ 586 ISPCTL_TOGGLE_TMODE /* toggle target mode */ 587} ispctl_t; 588int isp_control(struct ispsoftc *, ispctl_t, void *); 589 590 591/* 592 * Platform Dependent to Internal to External Control Function 593 * (each platform must provide such a function) 594 * 595 * Assumes locks are held. 596 * 597 * A few notes about some of these functions: 598 * 599 * ISPASYNC_CHANGE_NOTIFY notifies the outer layer that a change has 600 * occurred that invalidates the list of fabric devices known and/or 601 * the list of known loop devices. The argument passed is a pointer 602 * whose values are defined below (local loop change, name server 603 * change, other). 'Other' may simply be a LIP, or a change in 604 * connection topology. 605 * 606 * ISPASYNC_FABRIC_DEV announces the next element in a list of 607 * fabric device names we're getting out of the name server. The 608 * argument points to a GET ALL NEXT response structure. The list 609 * is known to terminate with an entry that refers to ourselves. 610 * One of the main purposes of this function is to allow outer 611 * layers, which are OS dependent, to set policy as to which fabric 612 * devices might actually be logged into (and made visible) later 613 * at ISPCTL_PDB_SYNC time. Since there's a finite number of fabric 614 * devices that we can log into (256 less 3 'reserved' for F-port 615 * topologies), and fabrics can grow up to 8 million or so entries 616 * (24 bits of Port Address, less a wad of reserved spaces), clearly 617 * we had better let the OS determine login policy. 618 * 619 * ISPASYNC_PROMENADE has an argument that is a pointer to an integer which 620 * is an index into the portdb in the softc ('target'). Whether that entrie's 621 * valid tag is set or not says whether something has arrived or departed. 622 * The name refers to a favorite pastime of many city dwellers- watching 623 * people come and go, talking of Michaelangelo, and so on.. 624 * 625 * ISPASYNC_UNHANDLED_RESPONSE gives outer layers a chance to parse a 626 * response queue entry not otherwise handled. The outer layer should 627 * return non-zero if it handled it. The 'arg' points to a (possibly only 628 * partially) massaged response queue entry (see the platform's 629 * ISP_UNSWIZZLE_RESPONSE macro). 630 */ 631 632typedef enum { 633 ISPASYNC_NEW_TGT_PARAMS, /* New Target Parameters Negotiated */ 634 ISPASYNC_BUS_RESET, /* Bus Was Reset */ 635 ISPASYNC_LOOP_DOWN, /* FC Loop Down */ 636 ISPASYNC_LOOP_UP, /* FC Loop Up */ 637 ISPASYNC_LIP, /* LIP Received */ 638 ISPASYNC_LOOP_RESET, /* Loop Reset Received */ 639 ISPASYNC_CHANGE_NOTIFY, /* FC Change Notification */ 640 ISPASYNC_FABRIC_DEV, /* FC Fabric Device Arrival */ 641 ISPASYNC_PROMENADE, /* FC Objects coming && going */ 642 ISPASYNC_TARGET_MESSAGE, /* target message */ 643 ISPASYNC_TARGET_EVENT, /* target asynchronous event */ 644 ISPASYNC_TARGET_ACTION, /* other target command action */ 645 ISPASYNC_CONF_CHANGE, /* Platform Configuration Change */ 646 ISPASYNC_UNHANDLED_RESPONSE, /* Unhandled Response Entry */ 647 ISPASYNC_FW_CRASH /* Firmware has crashed */ 648} ispasync_t; 649int isp_async(struct ispsoftc *, ispasync_t, void *); 650 651#define ISPASYNC_CHANGE_PDB ((void *) 0) 652#define ISPASYNC_CHANGE_SNS ((void *) 1) 653#define ISPASYNC_CHANGE_OTHER ((void *) 2) 654 655/* 656 * Platform Dependent Error and Debug Printout 657 */ 658#ifdef __GNUC__ 659void isp_prt(struct ispsoftc *, int level, const char *, ...) 660 __attribute__((__format__(__printf__,3,4))); 661#else 662void isp_prt(struct ispsoftc *, int level, const char *, ...); 663#endif 664 665#define ISP_LOGALL 0x0 /* log always */ 666#define ISP_LOGCONFIG 0x1 /* log configuration messages */ 667#define ISP_LOGINFO 0x2 /* log informational messages */ 668#define ISP_LOGWARN 0x4 /* log warning messages */ 669#define ISP_LOGERR 0x8 /* log error messages */ 670#define ISP_LOGDEBUG0 0x10 /* log simple debug messages */ 671#define ISP_LOGDEBUG1 0x20 /* log intermediate debug messages */ 672#define ISP_LOGDEBUG2 0x40 /* log most debug messages */ 673#define ISP_LOGDEBUG3 0x80 /* log high frequency debug messages */ 674#define ISP_LOGDEBUG4 0x100 /* log high frequency debug messages */ 675#define ISP_LOGTDEBUG0 0x200 /* log simple debug messages (target mode) */ 676#define ISP_LOGTDEBUG1 0x400 /* log intermediate debug messages (target) */ 677#define ISP_LOGTDEBUG2 0x800 /* log all debug messages (target) */ 678 679/* 680 * Each Platform provides it's own isposinfo substructure of the ispsoftc 681 * defined above. 682 * 683 * Each platform must also provide the following macros/defines: 684 * 685 * 686 * INLINE - platform specific define for 'inline' functions 687 * 688 * ISP2100_SCRLEN - length for the Fibre Channel scratch DMA area 689 * 690 * MEMZERO(dst, src) platform zeroing function 691 * MEMCPY(dst, src, count) platform copying function 692 * SNPRINTF(buf, bufsize, fmt, ...) snprintf 693 * STRNCAT(dstbuf, size, srcbuf) strncat 694 * USEC_DELAY(usecs) microsecond spindelay function 695 * USEC_SLEEP(isp, usecs) microsecond sleep function 696 * 697 * NANOTIME_T nanosecond time type 698 * 699 * GET_NANOTIME(NANOTIME_T *) get current nanotime. 700 * 701 * GET_NANOSEC(NANOTIME_T *) get u_int64_t from NANOTIME_T 702 * 703 * NANOTIME_SUB(NANOTIME_T *, NANOTIME_T *) 704 * subtract two NANOTIME_T values 705 * 706 * 707 * MAXISPREQUEST(struct ispsoftc *) maximum request queue size 708 * for this particular board type 709 * 710 * MEMORYBARRIER(struct ispsoftc *, barrier_type, offset, size) 711 * 712 * Function/Macro the provides memory synchronization on 713 * various objects so that the ISP's and the system's view 714 * of the same object is consistent. 715 * 716 * MBOX_ACQUIRE(struct ispsoftc *) acquire lock on mailbox regs 717 * MBOX_WAIT_COMPLETE(struct ispsoftc *) wait for mailbox cmd to be done 718 * MBOX_NOTIFY_COMPLETE(struct ispsoftc *) notification of mbox cmd donee 719 * MBOX_RELEASE(struct ispsoftc *) release lock on mailbox regs 720 * 721 * 722 * SCSI_GOOD SCSI 'Good' Status 723 * SCSI_CHECK SCSI 'Check Condition' Status 724 * SCSI_BUSY SCSI 'Busy' Status 725 * SCSI_QFULL SCSI 'Queue Full' Status 726 * 727 * XS_T Platform SCSI transaction type (i.e., command for HBA) 728 * XS_ISP(xs) gets an instance out of an XS_T 729 * XS_CHANNEL(xs) gets the channel (bus # for DUALBUS cards) "" 730 * XS_TGT(xs) gets the target "" 731 * XS_LUN(xs) gets the lun "" 732 * XS_CDBP(xs) gets a pointer to the scsi CDB "" 733 * XS_CDBLEN(xs) gets the CDB's length "" 734 * XS_XFRLEN(xs) gets the associated data transfer length "" 735 * XS_TIME(xs) gets the time (in milliseconds) for this command 736 * XS_RESID(xs) gets the current residual count 737 * XS_STSP(xs) gets a pointer to the SCSI status byte "" 738 * XS_SNSP(xs) gets a pointer to the associate sense data 739 * XS_SNSLEN(xs) gets the length of sense data storage 740 * XS_SNSKEY(xs) dereferences XS_SNSP to get the current stored Sense Key 741 * XS_TAG_P(xs) predicate of whether this command should be tagged 742 * XS_TAG_TYPE(xs) which type of tag to use 743 * XS_SETERR(xs) set error state 744 * 745 * HBA_NOERROR command has no erros 746 * HBA_BOTCH hba botched something 747 * HBA_CMDTIMEOUT command timed out 748 * HBA_SELTIMEOUT selection timed out (also port logouts for FC) 749 * HBA_TGTBSY target returned a BUSY status 750 * HBA_BUSRESET bus reset destroyed command 751 * HBA_ABORTED command was aborted (by request) 752 * HBA_DATAOVR a data overrun was detected 753 * HBA_ARQFAIL Automatic Request Sense failed 754 * 755 * XS_ERR(xs) return current error state 756 * XS_NOERR(xs) there is no error currently set 757 * XS_INITERR(xs) initialize error state 758 * 759 * XS_SAVE_SENSE(xs, sp) save sense data 760 * 761 * XS_SET_STATE_STAT(isp, sp, xs) platform dependent interpreter of 762 * response queue entry status bits 763 * 764 * 765 * DEFAULT_IID(struct ispsoftc *) Default SCSI initiator ID 766 * DEFAULT_LOOPID(struct ispsoftc *) Default FC Loop ID 767 * DEFAULT_NODEWWN(struct ispsoftc *) Default Node WWN 768 * DEFAULT_PORTWWN(struct ispsoftc *) Default Port WWN 769 * These establish reasonable defaults for each platform. 770 * These must be available independent of card NVRAM and are 771 * to be used should NVRAM not be readable. 772 * 773 * ISP_NODEWWN(struct ispsoftc *) FC Node WWN to use 774 * ISP_PORTWWN(struct ispsoftc *) FC Port WWN to use 775 * 776 * These are to be used after NVRAM is read. The tags 777 * in fcparam.isp_{node,port}wwn reflect the values 778 * read from NVRAM (possibly corrected for card botches). 779 * Each platform can take that information and override 780 * it or ignore and return the Node and Port WWNs to be 781 * used when sending the Qlogic f/w the Initialization Control 782 * Block. 783 * 784 * (XXX these do endian specific transformations- in transition XXX) 785 * ISP_SWIZZLE_ICB 786 * ISP_UNSWIZZLE_AND_COPY_PDBP 787 * ISP_SWIZZLE_CONTINUATION 788 * ISP_SWIZZLE_REQUEST 789 * ISP_UNSWIZZLE_RESPONSE 790 * ISP_SWIZZLE_SNS_REQ 791 * ISP_UNSWIZZLE_SNS_RSP 792 * ISP_SWIZZLE_NVRAM_WORD 793 */ 794 795#endif /* _ISPVAR_H */ 796