ispvar.h revision 93706
1185573Srwatson/* $FreeBSD: head/sys/dev/isp/ispvar.h 93706 2002-04-02 23:36:14Z mjacob $ */ 2191270Srwatson/* 3155191Srwatson * Soft Definitions for for Qlogic ISP SCSI adapters. 4155191Srwatson * 5155191Srwatson * Copyright (c) 1997, 1998, 1999, 2000 by Matthew Jacob 6155191Srwatson * All rights reserved. 7155191Srwatson * 8155191Srwatson * Redistribution and use in source and binary forms, with or without 9155191Srwatson * modification, are permitted provided that the following conditions 10155191Srwatson * are met: 11155191Srwatson * 1. Redistributions of source code must retain the above copyright 12155191Srwatson * notice immediately at the beginning of the file, without modification, 13155191Srwatson * this list of conditions, and the following disclaimer. 14181053Srwatson * 2. The name of the author may not be used to endorse or promote products 15155191Srwatson * derived from this software without specific prior written permission. 16155191Srwatson * 17155191Srwatson * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 18155191Srwatson * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19155191Srwatson * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20155191Srwatson * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR 21155191Srwatson * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22155191Srwatson * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23155191Srwatson * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24155191Srwatson * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25155191Srwatson * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26155191Srwatson * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27155191Srwatson * SUCH DAMAGE. 28155191Srwatson * 29191270Srwatson */ 30155191Srwatson 31155191Srwatson#ifndef _ISPVAR_H 32155191Srwatson#define _ISPVAR_H 33155191Srwatson 34155191Srwatson#if defined(__NetBSD__) || defined(__OpenBSD__) 35155191Srwatson#include <dev/ic/ispmbox.h> 36160084Srwatson#ifdef ISP_TARGET_MODE 37255219Spjd#include <dev/ic/isp_target.h> 38160084Srwatson#include <dev/ic/isp_tpublic.h> 39155191Srwatson#endif 40159257Srwatson#endif 41155191Srwatson#ifdef __FreeBSD__ 42155191Srwatson#include <dev/isp/ispmbox.h> 43155191Srwatson#ifdef ISP_TARGET_MODE 44155191Srwatson#include <dev/isp/isp_target.h> 45155191Srwatson#include <dev/isp/isp_tpublic.h> 46155191Srwatson#endif 47155191Srwatson#endif 48155191Srwatson#ifdef __linux__ 49155191Srwatson#include "ispmbox.h" 50155191Srwatson#ifdef ISP_TARGET_MODE 51155191Srwatson#include "isp_target.h" 52185573Srwatson#include "isp_tpublic.h" 53155191Srwatson#endif 54155191Srwatson#endif 55155191Srwatson 56155191Srwatson#define ISP_CORE_VERSION_MAJOR 2 57155191Srwatson#define ISP_CORE_VERSION_MINOR 5 58155191Srwatson 59155191Srwatson/* 60155191Srwatson * Vector for bus specific code to provide specific services. 61155191Srwatson */ 62155191Srwatsonstruct ispsoftc; 63155191Srwatsonstruct ispmdvec { 64155191Srwatson int (*dv_rd_isr) 65155191Srwatson (struct ispsoftc *, u_int16_t *, u_int16_t *, u_int16_t *); 66155191Srwatson u_int16_t (*dv_rd_reg) (struct ispsoftc *, int); 67155191Srwatson void (*dv_wr_reg) (struct ispsoftc *, int, u_int16_t); 68185573Srwatson int (*dv_mbxdma) (struct ispsoftc *); 69155191Srwatson int (*dv_dmaset) (struct ispsoftc *, 70155191Srwatson XS_T *, ispreq_t *, u_int16_t *, u_int16_t); 71155191Srwatson void (*dv_dmaclr) 72155191Srwatson (struct ispsoftc *, XS_T *, u_int16_t); 73155191Srwatson void (*dv_reset0) (struct ispsoftc *); 74155191Srwatson void (*dv_reset1) (struct ispsoftc *); 75155191Srwatson void (*dv_dregs) (struct ispsoftc *, const char *); 76185573Srwatson u_int16_t *dv_ispfw; /* ptr to f/w */ 77155191Srwatson u_int16_t dv_conf1; 78155191Srwatson u_int16_t dv_clock; /* clock frequency */ 79155191Srwatson}; 80155191Srwatson 81185573Srwatson/* 82185573Srwatson * Overall parameters 83185573Srwatson */ 84185573Srwatson#define MAX_TARGETS 16 85185573Srwatson#define MAX_FC_TARG 256 86185573Srwatson#define ISP_MAX_TARGETS(isp) (IS_FC(isp)? MAX_FC_TARG : MAX_TARGETS) 87185573Srwatson#define ISP_MAX_LUNS(isp) (isp)->isp_maxluns 88185573Srwatson 89155191Srwatson/* 90155191Srwatson * 'Types' 91168765Scsjp */ 92185573Srwatson#ifndef ISP_DMA_ADDR_T 93155191Srwatson#define ISP_DMA_ADDR_T u_int32_t 94155191Srwatson#endif 95155191Srwatson 96155191Srwatson/* 97155191Srwatson * Macros to access ISP registers through bus specific layers- 98155191Srwatson * mostly wrappers to vector through the mdvec structure. 99155191Srwatson */ 100155191Srwatson#define ISP_READ_ISR(isp, isrp, semap, mbox0p) \ 101155191Srwatson (*(isp)->isp_mdvec->dv_rd_isr)(isp, isrp, semap, mbox0p) 102155191Srwatson 103155191Srwatson#define ISP_READ(isp, reg) \ 104155191Srwatson (*(isp)->isp_mdvec->dv_rd_reg)((isp), (reg)) 105155191Srwatson 106155191Srwatson#define ISP_WRITE(isp, reg, val) \ 107155191Srwatson (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), (val)) 108155191Srwatson 109155191Srwatson#define ISP_MBOXDMASETUP(isp) \ 110155191Srwatson (*(isp)->isp_mdvec->dv_mbxdma)((isp)) 111155191Srwatson 112155191Srwatson#define ISP_DMASETUP(isp, xs, req, iptrp, optr) \ 113155191Srwatson (*(isp)->isp_mdvec->dv_dmaset)((isp), (xs), (req), (iptrp), (optr)) 114155191Srwatson 115155191Srwatson#define ISP_DMAFREE(isp, xs, hndl) \ 116155191Srwatson if ((isp)->isp_mdvec->dv_dmaclr) \ 117155191Srwatson (*(isp)->isp_mdvec->dv_dmaclr)((isp), (xs), (hndl)) 118155191Srwatson 119155191Srwatson#define ISP_RESET0(isp) \ 120155191Srwatson if ((isp)->isp_mdvec->dv_reset0) (*(isp)->isp_mdvec->dv_reset0)((isp)) 121155191Srwatson#define ISP_RESET1(isp) \ 122155191Srwatson if ((isp)->isp_mdvec->dv_reset1) (*(isp)->isp_mdvec->dv_reset1)((isp)) 123155191Srwatson#define ISP_DUMPREGS(isp, m) \ 124155191Srwatson if ((isp)->isp_mdvec->dv_dregs) (*(isp)->isp_mdvec->dv_dregs)((isp),(m)) 125155191Srwatson 126155191Srwatson#define ISP_SETBITS(isp, reg, val) \ 127155191Srwatson (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), ISP_READ((isp), (reg)) | (val)) 128155191Srwatson 129155191Srwatson#define ISP_CLRBITS(isp, reg, val) \ 130255219Spjd (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), ISP_READ((isp), (reg)) & ~(val)) 131255219Spjd 132155191Srwatson/* 133155191Srwatson * The MEMORYBARRIER macro is defined per platform (to provide synchronization 134155191Srwatson * on Request and Response Queues, Scratch DMA areas, and Registers) 135155191Srwatson * 136155191Srwatson * Defined Memory Barrier Synchronization Types 137155191Srwatson */ 138155191Srwatson#define SYNC_REQUEST 0 /* request queue synchronization */ 139155191Srwatson#define SYNC_RESULT 1 /* result queue synchronization */ 140155191Srwatson#define SYNC_SFORDEV 2 /* scratch, sync for ISP */ 141159257Srwatson#define SYNC_SFORCPU 3 /* scratch, sync for CPU */ 142155191Srwatson#define SYNC_REG 4 /* for registers */ 143159257Srwatson 144161635Srwatson/* 145159257Srwatson * Request/Response Queue defines and macros. 146155191Srwatson * The maximum is defined per platform (and can be based on board type). 147155191Srwatson */ 148155191Srwatson/* This is the size of a queue entry (request and response) */ 149159257Srwatson#define QENTRY_LEN 64 150155191Srwatson/* Both request and result queue length must be a power of two */ 151159257Srwatson#define RQUEST_QUEUE_LEN(x) MAXISPREQUEST(x) 152159257Srwatson#ifdef ISP_TARGET_MODE 153159257Srwatson#define RESULT_QUEUE_LEN(x) MAXISPREQUEST(x) 154155191Srwatson#else 155155191Srwatson#define RESULT_QUEUE_LEN(x) \ 156155191Srwatson (((MAXISPREQUEST(x) >> 2) < 64)? 64 : MAXISPREQUEST(x) >> 2) 157155191Srwatson#endif 158155191Srwatson#define ISP_QUEUE_ENTRY(q, idx) ((q) + ((idx) * QENTRY_LEN)) 159161635Srwatson#define ISP_QUEUE_SIZE(n) ((n) * QENTRY_LEN) 160155191Srwatson#define ISP_NXT_QENTRY(idx, qlen) (((idx) + 1) & ((qlen)-1)) 161161635Srwatson#define ISP_QFREE(in, out, qlen) \ 162161635Srwatson ((in == out)? (qlen - 1) : ((in > out)? \ 163161635Srwatson ((qlen - 1) - (in - out)) : (out - in - 1))) 164161635Srwatson#define ISP_QAVAIL(isp) \ 165161635Srwatson ISP_QFREE(isp->isp_reqidx, isp->isp_reqodx, RQUEST_QUEUE_LEN(isp)) 166161635Srwatson 167161635Srwatson#define ISP_ADD_REQUEST(isp, nxti) \ 168161635Srwatson MEMORYBARRIER(isp, SYNC_REQUEST, isp->isp_reqidx, QENTRY_LEN); \ 169161635Srwatson WRITE_REQUEST_QUEUE_IN_POINTER(isp, nxti); \ 170161635Srwatson isp->isp_reqidx = nxti 171186647Srwatson 172186647Srwatson/* 173186647Srwatson * SCSI Specific Host Adapter Parameters- per bus, per target 174155191Srwatson */ 175155191Srwatson 176155191Srwatsontypedef struct { 177155191Srwatson u_int isp_gotdparms : 1, 178155191Srwatson isp_req_ack_active_neg : 1, 179155191Srwatson isp_data_line_active_neg: 1, 180155191Srwatson isp_cmd_dma_burst_enable: 1, 181155191Srwatson isp_data_dma_burst_enabl: 1, 182155191Srwatson isp_fifo_threshold : 3, 183155191Srwatson isp_ultramode : 1, 184155191Srwatson isp_diffmode : 1, 185155191Srwatson isp_lvdmode : 1, 186186647Srwatson isp_fast_mttr : 1, /* fast sram */ 187155191Srwatson isp_initiator_id : 4, 188155191Srwatson isp_async_data_setup : 4; 189155191Srwatson u_int16_t isp_selection_timeout; 190155191Srwatson u_int16_t isp_max_queue_depth; 191155191Srwatson u_int8_t isp_tag_aging; 192155191Srwatson u_int8_t isp_bus_reset_delay; 193155191Srwatson u_int8_t isp_retry_count; 194155191Srwatson u_int8_t isp_retry_delay; 195155191Srwatson struct { 196155191Srwatson u_int32_t 197155191Srwatson exc_throttle : 8, 198159257Srwatson : 1, 199155191Srwatson dev_enable : 1, /* ignored */ 200185573Srwatson dev_update : 1, 201155191Srwatson dev_refresh : 1, 202159257Srwatson actv_offset : 4, 203155191Srwatson goal_offset : 4, 204184856Scsjp nvrm_offset : 4; 205184856Scsjp u_int8_t actv_period; /* current sync period */ 206168782Srwatson u_int8_t goal_period; /* goal sync period */ 207168782Srwatson u_int8_t nvrm_period; /* nvram sync period */ 208159257Srwatson u_int16_t actv_flags; /* current device flags */ 209155191Srwatson u_int16_t goal_flags; /* goal device flags */ 210184856Scsjp u_int16_t nvrm_flags; /* nvram device flags */ 211155191Srwatson } isp_devparam[MAX_TARGETS]; 212159257Srwatson} sdparam; 213186647Srwatson 214155191Srwatson/* 215155191Srwatson * Device Flags 216155191Srwatson */ 217185573Srwatson#define DPARM_DISC 0x8000 218185573Srwatson#define DPARM_PARITY 0x4000 219185573Srwatson#define DPARM_WIDE 0x2000 220155191Srwatson#define DPARM_SYNC 0x1000 221155191Srwatson#define DPARM_TQING 0x0800 222155191Srwatson#define DPARM_ARQ 0x0400 223155191Srwatson#define DPARM_QFRZ 0x0200 224155191Srwatson#define DPARM_RENEG 0x0100 225155191Srwatson#define DPARM_NARROW 0x0080 226155191Srwatson#define DPARM_ASYNC 0x0040 227155191Srwatson#define DPARM_PPR 0x0020 228185573Srwatson#define DPARM_DEFAULT (0xFF00 & ~DPARM_QFRZ) 229155191Srwatson#define DPARM_SAFE_DFLT (DPARM_DEFAULT & ~(DPARM_WIDE|DPARM_SYNC|DPARM_TQING)) 230155191Srwatson 231155191Srwatson 232155191Srwatson/* technically, not really correct, as they need to be rated based upon clock */ 233155191Srwatson#define ISP_80M_SYNCPARMS 0x0c09 234155191Srwatson#define ISP_40M_SYNCPARMS 0x0c0a 235155191Srwatson#define ISP_20M_SYNCPARMS 0x0c0c 236155191Srwatson#define ISP_20M_SYNCPARMS_1040 0x080c 237155191Srwatson#define ISP_10M_SYNCPARMS 0x0c19 238185573Srwatson#define ISP_08M_SYNCPARMS 0x0c25 239185573Srwatson#define ISP_05M_SYNCPARMS 0x0c32 240243751Srwatson#define ISP_04M_SYNCPARMS 0x0c41 241155191Srwatson 242155191Srwatson/* 243155191Srwatson * Fibre Channel Specifics 244155191Srwatson */ 245155191Srwatson#define FL_PORT_ID 0x7e /* FL_Port Special ID */ 246155191Srwatson#define FC_PORT_ID 0x7f /* Fabric Controller Special ID */ 247155191Srwatson#define FC_SNS_ID 0x80 /* SNS Server Special ID */ 248155191Srwatson 249155191Srwatsontypedef struct { 250155191Srwatson u_int32_t isp_fwoptions : 16, 251155191Srwatson isp_gbspeed : 2, 252155191Srwatson isp_iid_set : 1, 253155191Srwatson loop_seen_once : 1, 254255219Spjd isp_loopstate : 4, /* Current Loop State */ 255155191Srwatson isp_fwstate : 3, /* ISP F/W state */ 256155191Srwatson isp_gotdparms : 1, 257155191Srwatson isp_topo : 3, 258155191Srwatson isp_onfabric : 1; 259186647Srwatson u_int8_t isp_iid; /* 'initiator' id */ 260186647Srwatson u_int8_t isp_loopid; /* hard loop id */ 261155191Srwatson u_int8_t isp_alpa; /* ALPA */ 262155191Srwatson u_int32_t isp_portid; 263155191Srwatson volatile u_int16_t isp_lipseq; /* LIP sequence # */ 264155191Srwatson u_int16_t isp_fwattr; /* firmware attributes */ 265155191Srwatson u_int8_t isp_execthrottle; 266155191Srwatson u_int8_t isp_retry_delay; 267155191Srwatson u_int8_t isp_retry_count; 268155191Srwatson u_int8_t isp_reserved; 269155191Srwatson u_int16_t isp_maxalloc; 270155191Srwatson u_int16_t isp_maxfrmlen; 271155191Srwatson u_int64_t isp_nodewwn; 272155191Srwatson u_int64_t isp_portwwn; 273155191Srwatson /* 274155191Srwatson * Port Data Base. This is indexed by 'target', which is invariate. 275155191Srwatson * However, elements within can move around due to loop changes, 276155191Srwatson * so the actual loop ID passed to the F/W is in this structure. 277161813Swsalamon * The first time the loop is seen up, loopid will match the index 278161813Swsalamon * (except for fabric nodes which are above mapped above FC_SNS_ID 279161813Swsalamon * and are completely virtual), but subsequent LIPs can cause things 280161813Swsalamon * to move around. 281161813Swsalamon */ 282161813Swsalamon struct lportdb { 283161813Swsalamon u_int 284185573Srwatson loopid : 8, 285155191Srwatson : 1, 286155191Srwatson force_logout : 1, 287243751Srwatson was_fabric_dev : 1, 288185573Srwatson fabric_dev : 1, 289155191Srwatson loggedin : 1, 290186647Srwatson roles : 2, 291187214Srwatson valid : 1; 292186647Srwatson u_int32_t portid; 293187214Srwatson u_int64_t node_wwn; 294186647Srwatson u_int64_t port_wwn; 295191270Srwatson } portdb[MAX_FC_TARG], tport[FC_PORT_ID]; 296187214Srwatson 297187214Srwatson /* 298187214Srwatson * Scratch DMA mapped in area to fetch Port Database stuff, etc. 299187214Srwatson */ 300191270Srwatson caddr_t isp_scratch; 301187214Srwatson ISP_DMA_ADDR_T isp_scdma; 302186647Srwatson#ifdef ISP_FW_CRASH_DUMP 303155191Srwatson u_int16_t *isp_dump_data; 304155191Srwatson#endif 305155191Srwatson} fcparam; 306 307#define FW_CONFIG_WAIT 0 308#define FW_WAIT_AL_PA 1 309#define FW_WAIT_LOGIN 2 310#define FW_READY 3 311#define FW_LOSS_OF_SYNC 4 312#define FW_ERROR 5 313#define FW_REINIT 6 314#define FW_NON_PART 7 315 316#define LOOP_NIL 0 317#define LOOP_LIP_RCVD 1 318#define LOOP_PDB_RCVD 2 319#define LOOP_SCANNING_FABRIC 3 320#define LOOP_FSCAN_DONE 4 321#define LOOP_SCANNING_LOOP 5 322#define LOOP_LSCAN_DONE 6 323#define LOOP_SYNCING_PDB 7 324#define LOOP_READY 8 325 326#define TOPO_NL_PORT 0 327#define TOPO_FL_PORT 1 328#define TOPO_N_PORT 2 329#define TOPO_F_PORT 3 330#define TOPO_PTP_STUB 4 331 332/* 333 * Soft Structure per host adapter 334 */ 335typedef struct ispsoftc { 336 /* 337 * Platform (OS) specific data 338 */ 339 struct isposinfo isp_osinfo; 340 341 /* 342 * Pointer to bus specific functions and data 343 */ 344 struct ispmdvec * isp_mdvec; 345 346 /* 347 * (Mostly) nonvolatile state. Board specific parameters 348 * may contain some volatile state (e.g., current loop state). 349 */ 350 351 void * isp_param; /* type specific */ 352 u_int16_t isp_fwrev[3]; /* Loaded F/W revision */ 353 u_int16_t isp_romfw_rev[3]; /* PROM F/W revision */ 354 u_int16_t isp_maxcmds; /* max possible I/O cmds */ 355 u_int8_t isp_type; /* HBA Chip Type */ 356 u_int8_t isp_revision; /* HBA Chip H/W Revision */ 357 u_int32_t isp_maxluns; /* maximum luns supported */ 358 359 u_int32_t isp_clock : 8, /* input clock */ 360 : 4, 361 isp_port : 1, /* 23XX only */ 362 isp_failed : 1, /* board failed */ 363 isp_open : 1, /* opened (ioctl) */ 364 isp_touched : 1, /* board ever seen? */ 365 isp_bustype : 1, /* SBus or PCI */ 366 isp_loaded_fw : 1, /* loaded firmware */ 367 isp_role : 2, /* roles supported */ 368 isp_dblev : 12; /* debug log mask */ 369 370 u_int32_t isp_confopts; /* config options */ 371 372 u_int16_t isp_rqstinrp; /* register for REQINP */ 373 u_int16_t isp_rqstoutrp; /* register for REQOUTP */ 374 u_int16_t isp_respinrp; /* register for RESINP */ 375 u_int16_t isp_respoutrp; /* register for RESOUTP */ 376 377 /* 378 * Instrumentation 379 */ 380 u_int64_t isp_intcnt; /* total int count */ 381 u_int64_t isp_intbogus; /* spurious int count */ 382 u_int64_t isp_intmboxc; /* mbox completions */ 383 u_int64_t isp_intoasync; /* other async */ 384 u_int64_t isp_rsltccmplt; /* CMDs on result q */ 385 u_int64_t isp_fphccmplt; /* CMDs via fastpost */ 386 u_int16_t isp_rscchiwater; 387 u_int16_t isp_fpcchiwater; 388 389 /* 390 * Volatile state 391 */ 392 393 volatile u_int32_t 394 isp_obits : 8, /* mailbox command output */ 395 isp_mboxbsy : 1, /* mailbox command active */ 396 isp_state : 3, 397 isp_sendmarker : 2, /* send a marker entry */ 398 isp_update : 2, /* update parameters */ 399 isp_nactive : 16; /* how many commands active */ 400 volatile u_int16_t isp_reqodx; /* index of last ISP pickup */ 401 volatile u_int16_t isp_reqidx; /* index of next request */ 402 volatile u_int16_t isp_residx; /* index of next result */ 403 volatile u_int16_t isp_resodx; /* index of next result */ 404 volatile u_int16_t isp_rspbsy; 405 volatile u_int16_t isp_lasthdls; /* last handle seed */ 406 volatile u_int16_t isp_mboxtmp[MAX_MAILBOX]; 407 volatile u_int16_t isp_lastmbxcmd; /* last mbox command sent */ 408 volatile u_int16_t isp_mbxwrk0; 409 volatile u_int16_t isp_mbxwrk1; 410 volatile u_int16_t isp_mbxwrk2; 411 void * isp_mbxworkp; 412 413 /* 414 * Active commands are stored here, indexed by handle functions. 415 */ 416 XS_T **isp_xflist; 417 418 /* 419 * request/result queue pointers and dma handles for them. 420 */ 421 caddr_t isp_rquest; 422 caddr_t isp_result; 423 ISP_DMA_ADDR_T isp_rquest_dma; 424 ISP_DMA_ADDR_T isp_result_dma; 425} ispsoftc_t; 426 427#define SDPARAM(isp) ((sdparam *) (isp)->isp_param) 428#define FCPARAM(isp) ((fcparam *) (isp)->isp_param) 429 430/* 431 * ISP Driver Run States 432 */ 433#define ISP_NILSTATE 0 434#define ISP_RESETSTATE 1 435#define ISP_INITSTATE 2 436#define ISP_RUNSTATE 3 437 438/* 439 * ISP Configuration Options 440 */ 441#define ISP_CFG_NORELOAD 0x80 /* don't download f/w */ 442#define ISP_CFG_NONVRAM 0x40 /* ignore NVRAM */ 443#define ISP_CFG_TWOGB 0x20 /* force 2GB connection (23XX only) */ 444#define ISP_CFG_ONEGB 0x10 /* force 1GB connection (23XX only) */ 445#define ISP_CFG_FULL_DUPLEX 0x01 /* Full Duplex (Fibre Channel only) */ 446#define ISP_CFG_PORT_PREF 0x0C /* Mask for Port Prefs (2200 only) */ 447#define ISP_CFG_LPORT 0x00 /* prefer {N/F}L-Port connection */ 448#define ISP_CFG_NPORT 0x04 /* prefer {N/F}-Port connection */ 449#define ISP_CFG_NPORT_ONLY 0x08 /* insist on {N/F}-Port connection */ 450#define ISP_CFG_LPORT_ONLY 0x0C /* insist on {N/F}L-Port connection */ 451#define ISP_CFG_OWNWWPN 0x100 /* override NVRAM wwpn */ 452#define ISP_CFG_OWNWWNN 0x200 /* override NVRAM wwnn */ 453 454/* 455 * Prior to calling isp_reset for the first time, the outer layer 456 * should set isp_role to one of NONE, INITIATOR, TARGET, BOTH. 457 * 458 * If you set ISP_ROLE_NONE, the cards will be reset, new firmware loaded, 459 * NVRAM read, and defaults set, but any further initialization (e.g. 460 * INITIALIZE CONTROL BLOCK commands for 2X00 cards) won't be done. 461 * 462 * If INITIATOR MODE isn't set, attempts to run commands will be stopped 463 * at isp_start and completed with the moral equivalent of SELECTION TIMEOUT. 464 * 465 * If TARGET MODE is set, it doesn't mean that the rest of target mode support 466 * needs to be enabled, or will even work. What happens with the 2X00 cards 467 * here is that if you have enabled it with TARGET MODE as part of the ICB 468 * options, but you haven't given the f/w any ram resources for ATIOs or 469 * Immediate Notifies, the f/w just handles what it can and you never see 470 * anything. Basically, it sends a single byte of data (the first byte, 471 * which you can set as part of the INITIALIZE CONTROL BLOCK command) for 472 * INQUIRY, and sends back QUEUE FULL status for any other command. 473 * 474 */ 475#define ISP_ROLE_NONE 0x0 476#define ISP_ROLE_INITIATOR 0x1 477#define ISP_ROLE_TARGET 0x2 478#define ISP_ROLE_BOTH (ISP_ROLE_TARGET|ISP_ROLE_INITIATOR) 479#define ISP_ROLE_EITHER ISP_ROLE_BOTH 480#ifndef ISP_DEFAULT_ROLES 481#define ISP_DEFAULT_ROLES ISP_ROLE_INITIATOR 482#endif 483 484 485/* 486 * Firmware related defines 487 */ 488#define ISP_CODE_ORG 0x1000 /* default f/w code start */ 489#define ISP_CODE_ORG_2300 0x0800 /* ..except for 2300s */ 490#define ISP_FW_REV(maj, min, mic) ((maj << 24) | (min << 16) | mic) 491#define ISP_FW_MAJOR(code) ((code >> 24) & 0xff) 492#define ISP_FW_MINOR(code) ((code >> 16) & 0xff) 493#define ISP_FW_MICRO(code) ((code >> 8) & 0xff) 494#define ISP_FW_REVX(xp) ((xp[0]<<24) | (xp[1] << 16) | xp[2]) 495#define ISP_FW_MAJORX(xp) (xp[0]) 496#define ISP_FW_MINORX(xp) (xp[1]) 497#define ISP_FW_MICROX(xp) (xp[2]) 498 499/* 500 * Bus (implementation) types 501 */ 502#define ISP_BT_PCI 0 /* PCI Implementations */ 503#define ISP_BT_SBUS 1 /* SBus Implementations */ 504 505/* 506 * If we have not otherwise defined SBus support away make sure 507 * it is defined here such that the code is included as default 508 */ 509#ifndef ISP_SBUS_SUPPORTED 510#define ISP_SBUS_SUPPORTED 1 511#endif 512 513/* 514 * Chip Types 515 */ 516#define ISP_HA_SCSI 0xf 517#define ISP_HA_SCSI_UNKNOWN 0x1 518#define ISP_HA_SCSI_1020 0x2 519#define ISP_HA_SCSI_1020A 0x3 520#define ISP_HA_SCSI_1040 0x4 521#define ISP_HA_SCSI_1040A 0x5 522#define ISP_HA_SCSI_1040B 0x6 523#define ISP_HA_SCSI_1040C 0x7 524#define ISP_HA_SCSI_1240 0x8 525#define ISP_HA_SCSI_1080 0x9 526#define ISP_HA_SCSI_1280 0xa 527#define ISP_HA_SCSI_12160 0xb 528#define ISP_HA_FC 0xf0 529#define ISP_HA_FC_2100 0x10 530#define ISP_HA_FC_2200 0x20 531#define ISP_HA_FC_2300 0x30 532#define ISP_HA_FC_2312 0x40 533 534#define IS_SCSI(isp) (isp->isp_type & ISP_HA_SCSI) 535#define IS_1240(isp) (isp->isp_type == ISP_HA_SCSI_1240) 536#define IS_1080(isp) (isp->isp_type == ISP_HA_SCSI_1080) 537#define IS_1280(isp) (isp->isp_type == ISP_HA_SCSI_1280) 538#define IS_12160(isp) (isp->isp_type == ISP_HA_SCSI_12160) 539 540#define IS_12X0(isp) (IS_1240(isp) || IS_1280(isp)) 541#define IS_DUALBUS(isp) (IS_12X0(isp) || IS_12160(isp)) 542#define IS_ULTRA2(isp) (IS_1080(isp) || IS_1280(isp) || IS_12160(isp)) 543#define IS_ULTRA3(isp) (IS_12160(isp)) 544 545#define IS_FC(isp) ((isp)->isp_type & ISP_HA_FC) 546#define IS_2100(isp) ((isp)->isp_type == ISP_HA_FC_2100) 547#define IS_2200(isp) ((isp)->isp_type == ISP_HA_FC_2200) 548#define IS_23XX(isp) ((isp)->isp_type >= ISP_HA_FC_2300) 549#define IS_2300(isp) ((isp)->isp_type == ISP_HA_FC_2300) 550#define IS_2312(isp) ((isp)->isp_type == ISP_HA_FC_2312) 551 552/* 553 * DMA cookie macros 554 */ 555#define DMA_WD3(x) 0 556#define DMA_WD2(x) 0 557#define DMA_WD1(x) (((x) >> 16) & 0xffff) 558#define DMA_WD0(x) (((x) & 0xffff)) 559 560/* 561 * Core System Function Prototypes 562 */ 563 564/* 565 * Reset Hardware. Totally. Assumes that you'll follow this with 566 * a call to isp_init. 567 */ 568void isp_reset(struct ispsoftc *); 569 570/* 571 * Initialize Hardware to known state 572 */ 573void isp_init(struct ispsoftc *); 574 575/* 576 * Reset the ISP and call completion for any orphaned commands. 577 */ 578void isp_reinit(struct ispsoftc *); 579 580#ifdef ISP_FW_CRASH_DUMP 581/* 582 * Dump firmware entry point. 583 */ 584void isp_fw_dump(struct ispsoftc *isp); 585#endif 586 587/* 588 * Internal Interrupt Service Routine 589 * 590 * The outer layers do the spade work to get the appropriate status register, 591 * semaphore register and first mailbox register (if appropriate). This also 592 * means that most spurious/bogus interrupts not for us can be filtered first. 593 */ 594void isp_intr(struct ispsoftc *, u_int16_t, u_int16_t, u_int16_t); 595 596 597/* 598 * Command Entry Point- Platform Dependent layers call into this 599 */ 600int isp_start(XS_T *); 601/* these values are what isp_start returns */ 602#define CMD_COMPLETE 101 /* command completed */ 603#define CMD_EAGAIN 102 /* busy- maybe retry later */ 604#define CMD_QUEUED 103 /* command has been queued for execution */ 605#define CMD_RQLATER 104 /* requeue this command later */ 606 607/* 608 * Command Completion Point- Core layers call out from this with completed cmds 609 */ 610void isp_done(XS_T *); 611 612/* 613 * Platform Dependent to External to Internal Control Function 614 * 615 * Assumes locks are held on entry. You should note that with many of 616 * these commands and locks may be released while this is occurring. 617 * 618 * A few notes about some of these functions: 619 * 620 * ISPCTL_FCLINK_TEST tests to make sure we have good fibre channel link. 621 * The argument is a pointer to an integer which is the time, in microseconds, 622 * we should wait to see whether we have good link. This test, if successful, 623 * lets us know our connection topology and our Loop ID/AL_PA and so on. 624 * You can't get anywhere without this. 625 * 626 * ISPCTL_SCAN_FABRIC queries the name server (if we're on a fabric) for 627 * all entities using the FC Generic Services subcommand GET ALL NEXT. 628 * For each found entity, an ISPASYNC_FABRICDEV event is generated (see 629 * below). 630 * 631 * ISPCTL_SCAN_LOOP does a local loop scan. This is only done if the connection 632 * topology is NL or FL port (private or public loop). Since the Qlogic f/w 633 * 'automatically' manages local loop connections, this function essentially 634 * notes the arrival, departure, and possible shuffling around of local loop 635 * entities. Thus for each arrival and departure this generates an isp_async 636 * event of ISPASYNC_PROMENADE (see below). 637 * 638 * ISPCTL_PDB_SYNC is somewhat misnamed. It actually is the final step, in 639 * order, of ISPCTL_FCLINK_TEST, ISPCTL_SCAN_FABRIC, and ISPCTL_SCAN_LOOP. 640 * The main purpose of ISPCTL_PDB_SYNC is to complete management of logging 641 * and logging out of fabric devices (if one is on a fabric) and then marking 642 * the 'loop state' as being ready to now be used for sending commands to 643 * devices. Originally fabric name server and local loop scanning were 644 * part of this function. It's now been separated to allow for finer control. 645 */ 646typedef enum { 647 ISPCTL_RESET_BUS, /* Reset Bus */ 648 ISPCTL_RESET_DEV, /* Reset Device */ 649 ISPCTL_ABORT_CMD, /* Abort Command */ 650 ISPCTL_UPDATE_PARAMS, /* Update Operating Parameters (SCSI) */ 651 ISPCTL_FCLINK_TEST, /* Test FC Link Status */ 652 ISPCTL_SCAN_FABRIC, /* (Re)scan Fabric Name Server */ 653 ISPCTL_SCAN_LOOP, /* (Re)scan Local Loop */ 654 ISPCTL_PDB_SYNC, /* Synchronize Port Database */ 655 ISPCTL_SEND_LIP, /* Send a LIP */ 656 ISPCTL_GET_POSMAP, /* Get FC-AL position map */ 657 ISPCTL_RUN_MBOXCMD, /* run a mailbox command */ 658 ISPCTL_TOGGLE_TMODE /* toggle target mode */ 659} ispctl_t; 660int isp_control(struct ispsoftc *, ispctl_t, void *); 661 662 663/* 664 * Platform Dependent to Internal to External Control Function 665 * (each platform must provide such a function) 666 * 667 * Assumes locks are held. 668 * 669 * A few notes about some of these functions: 670 * 671 * ISPASYNC_CHANGE_NOTIFY notifies the outer layer that a change has 672 * occurred that invalidates the list of fabric devices known and/or 673 * the list of known loop devices. The argument passed is a pointer 674 * whose values are defined below (local loop change, name server 675 * change, other). 'Other' may simply be a LIP, or a change in 676 * connection topology. 677 * 678 * ISPASYNC_FABRIC_DEV announces the next element in a list of 679 * fabric device names we're getting out of the name server. The 680 * argument points to a GET ALL NEXT response structure. The list 681 * is known to terminate with an entry that refers to ourselves. 682 * One of the main purposes of this function is to allow outer 683 * layers, which are OS dependent, to set policy as to which fabric 684 * devices might actually be logged into (and made visible) later 685 * at ISPCTL_PDB_SYNC time. Since there's a finite number of fabric 686 * devices that we can log into (256 less 3 'reserved' for F-port 687 * topologies), and fabrics can grow up to 8 million or so entries 688 * (24 bits of Port Address, less a wad of reserved spaces), clearly 689 * we had better let the OS determine login policy. 690 * 691 * ISPASYNC_PROMENADE has an argument that is a pointer to an integer which 692 * is an index into the portdb in the softc ('target'). Whether that entrie's 693 * valid tag is set or not says whether something has arrived or departed. 694 * The name refers to a favorite pastime of many city dwellers- watching 695 * people come and go, talking of Michaelangelo, and so on.. 696 * 697 * ISPASYNC_UNHANDLED_RESPONSE gives outer layers a chance to parse a 698 * response queue entry not otherwise handled. The outer layer should 699 * return non-zero if it handled it. The 'arg' points to an unmassaged 700 * response queue entry. 701 */ 702 703typedef enum { 704 ISPASYNC_NEW_TGT_PARAMS, /* New Target Parameters Negotiated */ 705 ISPASYNC_BUS_RESET, /* Bus Was Reset */ 706 ISPASYNC_LOOP_DOWN, /* FC Loop Down */ 707 ISPASYNC_LOOP_UP, /* FC Loop Up */ 708 ISPASYNC_LIP, /* LIP Received */ 709 ISPASYNC_LOOP_RESET, /* Loop Reset Received */ 710 ISPASYNC_CHANGE_NOTIFY, /* FC Change Notification */ 711 ISPASYNC_FABRIC_DEV, /* FC Fabric Device Arrival */ 712 ISPASYNC_PROMENADE, /* FC Objects coming && going */ 713 ISPASYNC_TARGET_MESSAGE, /* target message */ 714 ISPASYNC_TARGET_EVENT, /* target asynchronous event */ 715 ISPASYNC_TARGET_ACTION, /* other target command action */ 716 ISPASYNC_CONF_CHANGE, /* Platform Configuration Change */ 717 ISPASYNC_UNHANDLED_RESPONSE, /* Unhandled Response Entry */ 718 ISPASYNC_FW_CRASH /* Firmware has crashed */ 719} ispasync_t; 720int isp_async(struct ispsoftc *, ispasync_t, void *); 721 722#define ISPASYNC_CHANGE_PDB ((void *) 0) 723#define ISPASYNC_CHANGE_SNS ((void *) 1) 724#define ISPASYNC_CHANGE_OTHER ((void *) 2) 725 726/* 727 * Platform Dependent Error and Debug Printout 728 */ 729#ifdef __GNUC__ 730void isp_prt(struct ispsoftc *, int level, const char *, ...) 731 __attribute__((__format__(__printf__,3,4))); 732#else 733void isp_prt(struct ispsoftc *, int level, const char *, ...); 734#endif 735 736#define ISP_LOGALL 0x0 /* log always */ 737#define ISP_LOGCONFIG 0x1 /* log configuration messages */ 738#define ISP_LOGINFO 0x2 /* log informational messages */ 739#define ISP_LOGWARN 0x4 /* log warning messages */ 740#define ISP_LOGERR 0x8 /* log error messages */ 741#define ISP_LOGDEBUG0 0x10 /* log simple debug messages */ 742#define ISP_LOGDEBUG1 0x20 /* log intermediate debug messages */ 743#define ISP_LOGDEBUG2 0x40 /* log most debug messages */ 744#define ISP_LOGDEBUG3 0x80 /* log high frequency debug messages */ 745#define ISP_LOGDEBUG4 0x100 /* log high frequency debug messages */ 746#define ISP_LOGTDEBUG0 0x200 /* log simple debug messages (target mode) */ 747#define ISP_LOGTDEBUG1 0x400 /* log intermediate debug messages (target) */ 748#define ISP_LOGTDEBUG2 0x800 /* log all debug messages (target) */ 749 750/* 751 * Each Platform provides it's own isposinfo substructure of the ispsoftc 752 * defined above. 753 * 754 * Each platform must also provide the following macros/defines: 755 * 756 * 757 * INLINE - platform specific define for 'inline' functions 758 * 759 * ISP_DMA_ADDR_T - platform specific dma address coookie- basically 760 * the largest integer that can hold the 32 or 761 * 64 bit value appropriate for the QLogic's DMA 762 * addressing. Defaults to u_int32_t. 763 * 764 * ISP2100_SCRLEN - length for the Fibre Channel scratch DMA area 765 * 766 * MEMZERO(dst, src) platform zeroing function 767 * MEMCPY(dst, src, count) platform copying function 768 * SNPRINTF(buf, bufsize, fmt, ...) snprintf 769 * STRNCAT(dstbuf, size, srcbuf) strncat 770 * USEC_DELAY(usecs) microsecond spindelay function 771 * USEC_SLEEP(isp, usecs) microsecond sleep function 772 * 773 * NANOTIME_T nanosecond time type 774 * 775 * GET_NANOTIME(NANOTIME_T *) get current nanotime. 776 * 777 * GET_NANOSEC(NANOTIME_T *) get u_int64_t from NANOTIME_T 778 * 779 * NANOTIME_SUB(NANOTIME_T *, NANOTIME_T *) 780 * subtract two NANOTIME_T values 781 * 782 * 783 * MAXISPREQUEST(struct ispsoftc *) maximum request queue size 784 * for this particular board type 785 * 786 * MEMORYBARRIER(struct ispsoftc *, barrier_type, offset, size) 787 * 788 * Function/Macro the provides memory synchronization on 789 * various objects so that the ISP's and the system's view 790 * of the same object is consistent. 791 * 792 * MBOX_ACQUIRE(struct ispsoftc *) acquire lock on mailbox regs 793 * MBOX_WAIT_COMPLETE(struct ispsoftc *) wait for mailbox cmd to be done 794 * MBOX_NOTIFY_COMPLETE(struct ispsoftc *) notification of mbox cmd donee 795 * MBOX_RELEASE(struct ispsoftc *) release lock on mailbox regs 796 * 797 * FC_SCRATCH_ACQUIRE(struct ispsoftc *) acquire lock on FC scratch area 798 * FC_SCRATCH_RELEASE(struct ispsoftc *) acquire lock on FC scratch area 799 * 800 * SCSI_GOOD SCSI 'Good' Status 801 * SCSI_CHECK SCSI 'Check Condition' Status 802 * SCSI_BUSY SCSI 'Busy' Status 803 * SCSI_QFULL SCSI 'Queue Full' Status 804 * 805 * XS_T Platform SCSI transaction type (i.e., command for HBA) 806 * XS_ISP(xs) gets an instance out of an XS_T 807 * XS_CHANNEL(xs) gets the channel (bus # for DUALBUS cards) "" 808 * XS_TGT(xs) gets the target "" 809 * XS_LUN(xs) gets the lun "" 810 * XS_CDBP(xs) gets a pointer to the scsi CDB "" 811 * XS_CDBLEN(xs) gets the CDB's length "" 812 * XS_XFRLEN(xs) gets the associated data transfer length "" 813 * XS_TIME(xs) gets the time (in milliseconds) for this command 814 * XS_RESID(xs) gets the current residual count 815 * XS_STSP(xs) gets a pointer to the SCSI status byte "" 816 * XS_SNSP(xs) gets a pointer to the associate sense data 817 * XS_SNSLEN(xs) gets the length of sense data storage 818 * XS_SNSKEY(xs) dereferences XS_SNSP to get the current stored Sense Key 819 * XS_TAG_P(xs) predicate of whether this command should be tagged 820 * XS_TAG_TYPE(xs) which type of tag to use 821 * XS_SETERR(xs) set error state 822 * 823 * HBA_NOERROR command has no erros 824 * HBA_BOTCH hba botched something 825 * HBA_CMDTIMEOUT command timed out 826 * HBA_SELTIMEOUT selection timed out (also port logouts for FC) 827 * HBA_TGTBSY target returned a BUSY status 828 * HBA_BUSRESET bus reset destroyed command 829 * HBA_ABORTED command was aborted (by request) 830 * HBA_DATAOVR a data overrun was detected 831 * HBA_ARQFAIL Automatic Request Sense failed 832 * 833 * XS_ERR(xs) return current error state 834 * XS_NOERR(xs) there is no error currently set 835 * XS_INITERR(xs) initialize error state 836 * 837 * XS_SAVE_SENSE(xs, sp) save sense data 838 * 839 * XS_SET_STATE_STAT(isp, sp, xs) platform dependent interpreter of 840 * response queue entry status bits 841 * 842 * 843 * DEFAULT_IID(struct ispsoftc *) Default SCSI initiator ID 844 * DEFAULT_LOOPID(struct ispsoftc *) Default FC Loop ID 845 * DEFAULT_NODEWWN(struct ispsoftc *) Default Node WWN 846 * DEFAULT_PORTWWN(struct ispsoftc *) Default Port WWN 847 * These establish reasonable defaults for each platform. 848 * These must be available independent of card NVRAM and are 849 * to be used should NVRAM not be readable. 850 * 851 * ISP_NODEWWN(struct ispsoftc *) FC Node WWN to use 852 * ISP_PORTWWN(struct ispsoftc *) FC Port WWN to use 853 * 854 * These are to be used after NVRAM is read. The tags 855 * in fcparam.isp_{node,port}wwn reflect the values 856 * read from NVRAM (possibly corrected for card botches). 857 * Each platform can take that information and override 858 * it or ignore and return the Node and Port WWNs to be 859 * used when sending the Qlogic f/w the Initialization Control 860 * Block. 861 * 862 * (XXX these do endian specific transformations- in transition XXX) 863 * 864 * ISP_IOXPUT_8(struct ispsoftc *, u_int8_t srcval, u_int8_t *dstptr) 865 * ISP_IOXPUT_16(struct ispsoftc *, u_int16_t srcval, u_int16_t *dstptr) 866 * ISP_IOXPUT_32(struct ispsoftc *, u_int32_t srcval, u_int32_t *dstptr) 867 * 868 * ISP_IOXGET_8(struct ispsoftc *, u_int8_t *srcptr, u_int8_t dstrval) 869 * ISP_IOXGET_16(struct ispsoftc *, u_int16_t *srcptr, u_int16_t dstrval) 870 * ISP_IOXGET_32(struct ispsoftc *, u_int32_t *srcptr, u_int32_t dstrval) 871 * 872 * ISP_SWIZZLE_NVRAM_WORD(struct ispsoftc *, u_int16_t *) 873 */ 874 875#endif /* _ISPVAR_H */ 876