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