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