ispvar.h revision 291188
150477Speter/* $FreeBSD: head/sys/dev/isp/ispvar.h 291188 2015-11-23 10:06:19Z mav $ */ 2139749Simp/*- 3196008Smjacob * Copyright (c) 1997-2009 by Matthew Jacob 4167403Smjacob * All rights reserved. 5196008Smjacob * 6167403Smjacob * Redistribution and use in source and binary forms, with or without 7167403Smjacob * modification, are permitted provided that the following conditions 8167403Smjacob * are met: 9196008Smjacob * 10167403Smjacob * 1. Redistributions of source code must retain the above copyright 11167403Smjacob * notice, this list of conditions and the following disclaimer. 12167403Smjacob * 2. Redistributions in binary form must reproduce the above copyright 13167403Smjacob * notice, this list of conditions and the following disclaimer in the 14167403Smjacob * documentation and/or other materials provided with the distribution. 15196008Smjacob * 16167403Smjacob * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17167403Smjacob * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18167403Smjacob * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19167403Smjacob * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE 20167403Smjacob * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21167403Smjacob * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22167403Smjacob * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23167403Smjacob * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24167403Smjacob * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25167403Smjacob * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26167403Smjacob * SUCH DAMAGE. 27196008Smjacob * 28167403Smjacob */ 29167403Smjacob/* 3035388Smjacob * Soft Definitions for for Qlogic ISP SCSI adapters. 3135388Smjacob */ 3235388Smjacob 3335388Smjacob#ifndef _ISPVAR_H 3435388Smjacob#define _ISPVAR_H 3535388Smjacob 3644819Smjacob#if defined(__NetBSD__) || defined(__OpenBSD__) 37163899Smjacob#include <dev/ic/isp_stds.h> 3835388Smjacob#include <dev/ic/ispmbox.h> 3935388Smjacob#endif 4035388Smjacob#ifdef __FreeBSD__ 41163899Smjacob#include <dev/isp/isp_stds.h> 4235388Smjacob#include <dev/isp/ispmbox.h> 4335388Smjacob#endif 4435388Smjacob#ifdef __linux__ 45163899Smjacob#include "isp_stds.h" 4642131Smjacob#include "ispmbox.h" 4735388Smjacob#endif 48155704Smjacob#ifdef __svr4__ 49163899Smjacob#include "isp_stds.h" 50155704Smjacob#include "ispmbox.h" 5153487Smjacob#endif 5235388Smjacob 53203444Smjacob#define ISP_CORE_VERSION_MAJOR 7 54163899Smjacob#define ISP_CORE_VERSION_MINOR 0 5539235Sgibbs 5635388Smjacob/* 5743420Smjacob * Vector for bus specific code to provide specific services. 5835388Smjacob */ 59155704Smjacobtypedef struct ispsoftc ispsoftc_t; 6035388Smjacobstruct ispmdvec { 61289812Smav int (*dv_rd_isr) (ispsoftc_t *, uint16_t *, uint16_t *, uint16_t *); 62163899Smjacob uint32_t (*dv_rd_reg) (ispsoftc_t *, int); 63163899Smjacob void (*dv_wr_reg) (ispsoftc_t *, int, uint32_t); 64155704Smjacob int (*dv_mbxdma) (ispsoftc_t *); 65196008Smjacob int (*dv_dmaset) (ispsoftc_t *, XS_T *, void *); 66163899Smjacob void (*dv_dmaclr) (ispsoftc_t *, XS_T *, uint32_t); 67155704Smjacob void (*dv_reset0) (ispsoftc_t *); 68155704Smjacob void (*dv_reset1) (ispsoftc_t *); 69155704Smjacob void (*dv_dregs) (ispsoftc_t *, const char *); 70167821Smjacob const void * dv_ispfw; /* ptr to f/w */ 71155704Smjacob uint16_t dv_conf1; 72155704Smjacob uint16_t dv_clock; /* clock frequency */ 7335388Smjacob}; 7435388Smjacob 7564087Smjacob/* 7664087Smjacob * Overall parameters 7764087Smjacob */ 7882689Smjacob#define MAX_TARGETS 16 79196008Smjacob#ifndef MAX_FC_TARG 80238869Smjacob#define MAX_FC_TARG 256 81196008Smjacob#endif 8249909Smjacob#define ISP_MAX_TARGETS(isp) (IS_FC(isp)? MAX_FC_TARG : MAX_TARGETS) 8361772Smjacob#define ISP_MAX_LUNS(isp) (isp)->isp_maxluns 8449909Smjacob 8582689Smjacob/* 8664087Smjacob * Macros to access ISP registers through bus specific layers- 8764087Smjacob * mostly wrappers to vector through the mdvec structure. 8853487Smjacob */ 89289812Smav#define ISP_READ_ISR(isp, isrp, semap, info) \ 90289812Smav (*(isp)->isp_mdvec->dv_rd_isr)(isp, isrp, semap, info) 9153487Smjacob 9253487Smjacob#define ISP_READ(isp, reg) \ 9353487Smjacob (*(isp)->isp_mdvec->dv_rd_reg)((isp), (reg)) 9453487Smjacob 9553487Smjacob#define ISP_WRITE(isp, reg, val) \ 9653487Smjacob (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), (val)) 9753487Smjacob 9853487Smjacob#define ISP_MBOXDMASETUP(isp) \ 9953487Smjacob (*(isp)->isp_mdvec->dv_mbxdma)((isp)) 10053487Smjacob 101196008Smjacob#define ISP_DMASETUP(isp, xs, req) \ 102196008Smjacob (*(isp)->isp_mdvec->dv_dmaset)((isp), (xs), (req)) 10353487Smjacob 104155704Smjacob#define ISP_DMAFREE(isp, xs, hndl) \ 105155704Smjacob if ((isp)->isp_mdvec->dv_dmaclr) \ 10653487Smjacob (*(isp)->isp_mdvec->dv_dmaclr)((isp), (xs), (hndl)) 10753487Smjacob 10853487Smjacob#define ISP_RESET0(isp) \ 10953487Smjacob if ((isp)->isp_mdvec->dv_reset0) (*(isp)->isp_mdvec->dv_reset0)((isp)) 11053487Smjacob#define ISP_RESET1(isp) \ 11153487Smjacob if ((isp)->isp_mdvec->dv_reset1) (*(isp)->isp_mdvec->dv_reset1)((isp)) 11264087Smjacob#define ISP_DUMPREGS(isp, m) \ 11364087Smjacob if ((isp)->isp_mdvec->dv_dregs) (*(isp)->isp_mdvec->dv_dregs)((isp),(m)) 11453487Smjacob 11553487Smjacob#define ISP_SETBITS(isp, reg, val) \ 11653487Smjacob (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), ISP_READ((isp), (reg)) | (val)) 11753487Smjacob 11853487Smjacob#define ISP_CLRBITS(isp, reg, val) \ 11953487Smjacob (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), ISP_READ((isp), (reg)) & ~(val)) 12053487Smjacob 12164087Smjacob/* 12264087Smjacob * The MEMORYBARRIER macro is defined per platform (to provide synchronization 12364087Smjacob * on Request and Response Queues, Scratch DMA areas, and Registers) 12464087Smjacob * 12564087Smjacob * Defined Memory Barrier Synchronization Types 12664087Smjacob */ 12764087Smjacob#define SYNC_REQUEST 0 /* request queue synchronization */ 12864087Smjacob#define SYNC_RESULT 1 /* result queue synchronization */ 12964087Smjacob#define SYNC_SFORDEV 2 /* scratch, sync for ISP */ 13064087Smjacob#define SYNC_SFORCPU 3 /* scratch, sync for CPU */ 13164087Smjacob#define SYNC_REG 4 /* for registers */ 132163899Smjacob#define SYNC_ATIOQ 5 /* atio result queue (24xx) */ 13364087Smjacob 13464087Smjacob/* 13564087Smjacob * Request/Response Queue defines and macros. 13664087Smjacob * The maximum is defined per platform (and can be based on board type). 13764087Smjacob */ 13864087Smjacob/* This is the size of a queue entry (request and response) */ 13939235Sgibbs#define QENTRY_LEN 64 14064087Smjacob/* Both request and result queue length must be a power of two */ 14164087Smjacob#define RQUEST_QUEUE_LEN(x) MAXISPREQUEST(x) 14293706Smjacob#ifdef ISP_TARGET_MODE 14393706Smjacob#define RESULT_QUEUE_LEN(x) MAXISPREQUEST(x) 14493706Smjacob#else 14564087Smjacob#define RESULT_QUEUE_LEN(x) \ 14664087Smjacob (((MAXISPREQUEST(x) >> 2) < 64)? 64 : MAXISPREQUEST(x) >> 2) 14793706Smjacob#endif 148155704Smjacob#define ISP_QUEUE_ENTRY(q, idx) (((uint8_t *)q) + ((idx) * QENTRY_LEN)) 14939235Sgibbs#define ISP_QUEUE_SIZE(n) ((n) * QENTRY_LEN) 15039235Sgibbs#define ISP_NXT_QENTRY(idx, qlen) (((idx) + 1) & ((qlen)-1)) 15165140Smjacob#define ISP_QFREE(in, out, qlen) \ 15239235Sgibbs ((in == out)? (qlen - 1) : ((in > out)? \ 15352347Smjacob ((qlen - 1) - (in - out)) : (out - in - 1))) 15465140Smjacob#define ISP_QAVAIL(isp) \ 15565140Smjacob ISP_QFREE(isp->isp_reqidx, isp->isp_reqodx, RQUEST_QUEUE_LEN(isp)) 15653487Smjacob 157218691Smarius#define ISP_ADD_REQUEST(isp, nxti) \ 158218691Smarius MEMORYBARRIER(isp, SYNC_REQUEST, isp->isp_reqidx, QENTRY_LEN, -1); \ 159218691Smarius ISP_WRITE(isp, isp->isp_rqstinrp, nxti); \ 16087635Smjacob isp->isp_reqidx = nxti 16153487Smjacob 162196008Smjacob#define ISP_SYNC_REQUEST(isp) \ 163218691Smarius MEMORYBARRIER(isp, SYNC_REQUEST, isp->isp_reqidx, QENTRY_LEN, -1); \ 164196008Smjacob isp->isp_reqidx = ISP_NXT_QENTRY(isp->isp_reqidx, RQUEST_QUEUE_LEN(isp)); \ 165196008Smjacob ISP_WRITE(isp, isp->isp_rqstinrp, isp->isp_reqidx) 166196008Smjacob 16735388Smjacob/* 16846968Smjacob * SCSI Specific Host Adapter Parameters- per bus, per target 16935388Smjacob */ 17035388Smjacobtypedef struct { 171196008Smjacob uint32_t : 8, 172196008Smjacob update : 1, 173196008Smjacob sendmarker : 1, 17452347Smjacob isp_req_ack_active_neg : 1, 17552347Smjacob isp_data_line_active_neg: 1, 17635388Smjacob isp_cmd_dma_burst_enable: 1, 17735388Smjacob isp_data_dma_burst_enabl: 1, 17842461Smjacob isp_fifo_threshold : 3, 179163899Smjacob isp_ptisp : 1, 18043420Smjacob isp_ultramode : 1, 18135388Smjacob isp_diffmode : 1, 18245040Smjacob isp_lvdmode : 1, 18365140Smjacob isp_fast_mttr : 1, /* fast sram */ 18435388Smjacob isp_initiator_id : 4, 18552347Smjacob isp_async_data_setup : 4; 186155704Smjacob uint16_t isp_selection_timeout; 187155704Smjacob uint16_t isp_max_queue_depth; 188155704Smjacob uint8_t isp_tag_aging; 189155704Smjacob uint8_t isp_bus_reset_delay; 190155704Smjacob uint8_t isp_retry_count; 191155704Smjacob uint8_t isp_retry_delay; 19235388Smjacob struct { 193196008Smjacob uint32_t 19480582Smjacob exc_throttle : 8, 19546968Smjacob : 1, 19680582Smjacob dev_enable : 1, /* ignored */ 19743420Smjacob dev_update : 1, 19843420Smjacob dev_refresh : 1, 19980582Smjacob actv_offset : 4, 20080582Smjacob goal_offset : 4, 20180582Smjacob nvrm_offset : 4; 202155704Smjacob uint8_t actv_period; /* current sync period */ 203155704Smjacob uint8_t goal_period; /* goal sync period */ 204155704Smjacob uint8_t nvrm_period; /* nvram sync period */ 205155704Smjacob uint16_t actv_flags; /* current device flags */ 206155704Smjacob uint16_t goal_flags; /* goal device flags */ 207155704Smjacob uint16_t nvrm_flags; /* nvram device flags */ 20835388Smjacob } isp_devparam[MAX_TARGETS]; 20946968Smjacob} sdparam; 21035388Smjacob 21135388Smjacob/* 21235388Smjacob * Device Flags 21335388Smjacob */ 21439235Sgibbs#define DPARM_DISC 0x8000 21539235Sgibbs#define DPARM_PARITY 0x4000 21639235Sgibbs#define DPARM_WIDE 0x2000 21739235Sgibbs#define DPARM_SYNC 0x1000 21839235Sgibbs#define DPARM_TQING 0x0800 21939235Sgibbs#define DPARM_ARQ 0x0400 22039235Sgibbs#define DPARM_QFRZ 0x0200 22139235Sgibbs#define DPARM_RENEG 0x0100 22265140Smjacob#define DPARM_NARROW 0x0080 22365140Smjacob#define DPARM_ASYNC 0x0040 22465140Smjacob#define DPARM_PPR 0x0020 22543793Smjacob#define DPARM_DEFAULT (0xFF00 & ~DPARM_QFRZ) 22639235Sgibbs#define DPARM_SAFE_DFLT (DPARM_DEFAULT & ~(DPARM_WIDE|DPARM_SYNC|DPARM_TQING)) 22735388Smjacob 22845040Smjacob/* technically, not really correct, as they need to be rated based upon clock */ 22965140Smjacob#define ISP_80M_SYNCPARMS 0x0c09 23065140Smjacob#define ISP_40M_SYNCPARMS 0x0c0a 23165140Smjacob#define ISP_20M_SYNCPARMS 0x0c0c 23265140Smjacob#define ISP_20M_SYNCPARMS_1040 0x080c 23352347Smjacob#define ISP_10M_SYNCPARMS 0x0c19 23452347Smjacob#define ISP_08M_SYNCPARMS 0x0c25 23552347Smjacob#define ISP_05M_SYNCPARMS 0x0c32 23652347Smjacob#define ISP_04M_SYNCPARMS 0x0c41 23735388Smjacob 23835388Smjacob/* 23935388Smjacob * Fibre Channel Specifics 24035388Smjacob */ 241164909Smjacob/* These are for non-2K Login Firmware cards */ 242163899Smjacob#define FL_ID 0x7e /* FL_Port Special ID */ 243163899Smjacob#define SNS_ID 0x80 /* SNS Server Special ID */ 244163899Smjacob#define NPH_MAX 0xfe 24552347Smjacob 246164909Smjacob/* These are for 2K Login Firmware cards */ 247163899Smjacob#define NPH_RESERVED 0x7F0 /* begin of reserved N-port handles */ 248163899Smjacob#define NPH_MGT_ID 0x7FA /* Management Server Special ID */ 249163899Smjacob#define NPH_SNS_ID 0x7FC /* SNS Server Special ID */ 250196008Smjacob#define NPH_FABRIC_CTLR 0x7FD /* Fabric Controller (0xFFFFFD) */ 251196008Smjacob#define NPH_FL_ID 0x7FE /* F Port Special ID (0xFFFFFE) */ 252289890Smav#define NPH_IP_BCST 0x7FF /* IP Broadcast Special ID (0xFFFFFF) */ 253164909Smjacob#define NPH_MAX_2K 0x800 25493837Smjacob 255163899Smjacob/* 256164909Smjacob * "Unassigned" handle to be used internally 257164909Smjacob */ 258164909Smjacob#define NIL_HANDLE 0xffff 259164909Smjacob 260164909Smjacob/* 261163899Smjacob * Limit for devices on an arbitrated loop. 262163899Smjacob */ 263163899Smjacob#define LOCAL_LOOP_LIM 126 264163899Smjacob 265163899Smjacob/* 266196008Smjacob * Limit for (2K login) N-port handle amounts 267196008Smjacob */ 268196008Smjacob#define MAX_NPORT_HANDLE 2048 269196008Smjacob 270196008Smjacob/* 271196008Smjacob * Special Constants 272196008Smjacob */ 273196008Smjacob#define INI_NONE ((uint64_t) 0) 274196008Smjacob#define ISP_NOCHAN 0xff 275196008Smjacob 276196008Smjacob/* 277163899Smjacob * Special Port IDs 278163899Smjacob */ 279163899Smjacob#define MANAGEMENT_PORT_ID 0xFFFFFA 280163899Smjacob#define SNS_PORT_ID 0xFFFFFC 281163899Smjacob#define FABRIC_PORT_ID 0xFFFFFE 282196008Smjacob#define PORT_ANY 0xFFFFFF 283196008Smjacob#define PORT_NONE 0 284291144Smav#define VALID_PORT(port) (port != PORT_NONE && port != PORT_ANY) 285196008Smjacob#define DOMAIN_CONTROLLER_BASE 0xFFFC00 286196008Smjacob#define DOMAIN_CONTROLLER_END 0xFFFCFF 287163899Smjacob 288203444Smjacob/* 289203444Smjacob * Command Handles 290203444Smjacob * 291203444Smjacob * Most QLogic initiator or target have 32 bit handles associated with them. 292203444Smjacob * We want to have a quick way to index back and forth between a local SCSI 293203444Smjacob * command context and what the firmware is passing back to us. We also 294203444Smjacob * want to avoid working on stale information. This structure handles both 295203444Smjacob * at the expense of some local memory. 296203444Smjacob * 297203444Smjacob * The handle is architected thusly: 298203444Smjacob * 299203444Smjacob * 0 means "free handle" 300203444Smjacob * bits 0..12 index commands 301203444Smjacob * bits 13..15 bits index usage 302203444Smjacob * bits 16..31 contain a rolling sequence 303203444Smjacob * 304203444Smjacob * 305203444Smjacob */ 306203444Smjacobtypedef struct { 307203444Smjacob void * cmd; /* associated command context */ 308203444Smjacob uint32_t handle; /* handle associated with this command */ 309203444Smjacob} isp_hdl_t; 310203444Smjacob#define ISP_HANDLE_FREE 0x00000000 311203444Smjacob#define ISP_HANDLE_CMD_MASK 0x00001fff 312203444Smjacob#define ISP_HANDLE_USAGE_MASK 0x0000e000 313203444Smjacob#define ISP_HANDLE_USAGE_SHIFT 13 314203444Smjacob#define ISP_H2HT(hdl) ((hdl & ISP_HANDLE_USAGE_MASK) >> ISP_HANDLE_USAGE_SHIFT) 315203444Smjacob# define ISP_HANDLE_NONE 0 316203444Smjacob# define ISP_HANDLE_INITIATOR 1 317203444Smjacob# define ISP_HANDLE_TARGET 2 318203444Smjacob#define ISP_HANDLE_SEQ_MASK 0xffff0000 319203444Smjacob#define ISP_HANDLE_SEQ_SHIFT 16 320203444Smjacob#define ISP_H2SEQ(hdl) ((hdl & ISP_HANDLE_SEQ_MASK) >> ISP_HANDLE_SEQ_SHIFT) 321203444Smjacob#define ISP_VALID_INI_HANDLE(c, hdl) \ 322203444Smjacob (ISP_H2HT(hdl) == ISP_HANDLE_INITIATOR && (hdl & ISP_HANDLE_CMD_MASK) < (c)->isp_maxcmds && \ 323203444Smjacob ISP_H2SEQ(hdl) == ISP_H2SEQ((c)->isp_xflist[hdl & ISP_HANDLE_CMD_MASK].handle)) 324203444Smjacob#ifdef ISP_TARGET_MODE 325203444Smjacob#define ISP_VALID_TGT_HANDLE(c, hdl) \ 326203444Smjacob (ISP_H2HT(hdl) == ISP_HANDLE_TARGET && (hdl & ISP_HANDLE_CMD_MASK) < (c)->isp_maxcmds && \ 327203444Smjacob ISP_H2SEQ(hdl) == ISP_H2SEQ((c)->isp_tgtlist[hdl & ISP_HANDLE_CMD_MASK].handle)) 328203444Smjacob#define ISP_VALID_HANDLE(c, hdl) \ 329203444Smjacob (ISP_VALID_INI_HANDLE((c), hdl) || ISP_VALID_TGT_HANDLE((c), hdl)) 330203444Smjacob#else 331203444Smjacob#define ISP_VALID_HANDLE ISP_VALID_INI_HANDLE 332203444Smjacob#endif 333203444Smjacob#define ISP_BAD_HANDLE_INDEX 0xffffffff 334163899Smjacob 335203444Smjacob 336163899Smjacob/* 337163899Smjacob * FC Port Database entry. 338163899Smjacob * 339163899Smjacob * It has a handle that the f/w uses to address commands to a device. 340163899Smjacob * This handle's value may be assigned by the firmware (e.g., for local loop 341163899Smjacob * devices) or by the driver (e.g., for fabric devices). 342163899Smjacob * 343163899Smjacob * It has a state. If the state if VALID, that means that we've logged into 344285154Smav * the device. 345163899Smjacob * 346163899Smjacob * Local loop devices the firmware automatically performs PLOGI on for us 347163899Smjacob * (which is why that handle is imposed upon us). Fabric devices we assign 348163899Smjacob * a handle to and perform the PLOGI on. 349163899Smjacob * 350163899Smjacob * When a PORT DATABASE CHANGED asynchronous event occurs, we mark all VALID 351163899Smjacob * entries as PROBATIONAL. This allows us, if policy says to, just keep track 352163899Smjacob * of devices whose handles change but are otherwise the same device (and 353163899Smjacob * thus keep 'target' constant). 354163899Smjacob * 355163899Smjacob * In any case, we search all possible local loop handles. For each one that 356163899Smjacob * has a port database entity returned, we search for any PROBATIONAL entry 357163899Smjacob * that matches it and update as appropriate. Otherwise, as a new entry, we 358163899Smjacob * find room for it in the Port Database. We *try* and use the handle as the 359163899Smjacob * index to put it into the Database, but that's just an optimization. We mark 360163899Smjacob * the entry VALID and make sure that the target index is updated and correct. 361163899Smjacob * 362163899Smjacob * When we get done searching the local loop, we then search similarily for 363163899Smjacob * a list of devices we've gotten from the fabric name controller (if we're 364163899Smjacob * on a fabric). VALID marking is also done similarily. 365163899Smjacob * 366163899Smjacob * When all of this is done, we can march through the database and clean up 367163899Smjacob * any entry that is still PROBATIONAL (these represent devices which have 368163899Smjacob * departed). Then we're done and can resume normal operations. 369163899Smjacob * 370163899Smjacob * Negative invariants that we try and test for are: 371163899Smjacob * 372163899Smjacob * + There can never be two non-NIL entries with the same { Port, Node } WWN 373163899Smjacob * duples. 374163899Smjacob * 375163899Smjacob * + There can never be two non-NIL entries with the same handle. 376163899Smjacob */ 37735388Smjacobtypedef struct { 378164272Smjacob /* 379164272Smjacob * This is the handle that the firmware needs in order for us to 380164272Smjacob * send commands to the device. For pre-24XX cards, this would be 381164272Smjacob * the 'loopid'. 382164272Smjacob */ 383163899Smjacob uint16_t handle; 384196008Smjacob 385164272Smjacob /* 386164272Smjacob * A device is 'autologin' if the firmware automatically logs into 387164272Smjacob * it (re-logins as needed). Basically, local private loop devices. 388164272Smjacob * 389238869Smjacob * PRLI word 3 parameters contains role as well as other things. 390238869Smjacob * 391196008Smjacob * The state is the current state of this entry. 392164272Smjacob * 393285459Smav * The is_target is the current state of target on this port. 394285459Smav * 395285459Smav * The is_initiator is the current state of initiator on this port. 396285459Smav * 397196008Smjacob * Portid is obvious, as are node && port WWNs. The new_role and 398164272Smjacob * new_portid is for when we are pending a change. 399164272Smjacob */ 400238869Smjacob uint16_t prli_word3; /* PRLI parameters */ 401238869Smjacob uint16_t new_prli_word3; /* Incoming new PRLI parameters */ 402291080Smav uint16_t : 11, 403163899Smjacob autologin : 1, /* F/W does PLOGI/PLOGO */ 404291080Smav probational : 1, 405163899Smjacob state : 3; 406285459Smav uint32_t : 6, 407285459Smav is_target : 1, 408285459Smav is_initiator : 1, 409163899Smjacob portid : 24; 410196008Smjacob uint32_t 411285459Smav : 8, 412163899Smjacob new_portid : 24; 413163899Smjacob uint64_t node_wwn; 414163899Smjacob uint64_t port_wwn; 415208119Smjacob uint32_t gone_timer; 416163899Smjacob} fcportdb_t; 417163899Smjacob 418291080Smav#define FC_PORTDB_STATE_NIL 0 /* Empty DB slot */ 419291080Smav#define FC_PORTDB_STATE_DEAD 1 /* Was valid, but no more. */ 420291080Smav#define FC_PORTDB_STATE_CHANGED 2 /* Was valid, but changed. */ 421291080Smav#define FC_PORTDB_STATE_NEW 3 /* Logged in, not announced. */ 422291080Smav#define FC_PORTDB_STATE_ZOMBIE 4 /* Invalid, but announced. */ 423291080Smav#define FC_PORTDB_STATE_VALID 5 /* Valid */ 424163899Smjacob 425285459Smav#define FC_PORTDB_TGT(isp, bus, pdb) (int)(lp - FCPARAM(isp, bus)->portdb) 426285459Smav 427163899Smjacob/* 428163899Smjacob * FC card specific information 429196008Smjacob * 430196008Smjacob * This structure is replicated across multiple channels for multi-id 431196008Smjacob * capapble chipsets, with some entities different on a per-channel basis. 432163899Smjacob */ 433196008Smjacob 434163899Smjacobtypedef struct { 435289219Smav int isp_gbspeed; /* Connection speed */ 436289219Smav int isp_linkstate; /* Link state */ 437289219Smav int isp_fwstate; /* ISP F/W state */ 438289219Smav int isp_loopstate; /* Loop State */ 439289219Smav int isp_topo; /* Connection Type */ 440289219Smav 441289219Smav uint32_t : 3, 442238869Smjacob fctape_enabled : 1, 443196008Smjacob sendmarker : 1, 444289219Smav loop_seen_once : 1, 445196008Smjacob role : 2, 446154704Smjacob isp_portid : 24; /* S_ID */ 447196008Smjacob 448155704Smjacob uint16_t isp_fwoptions; 449160080Smjacob uint16_t isp_xfwoptions; 450160080Smjacob uint16_t isp_zfwoptions; 451196008Smjacob uint16_t isp_loopid; /* hard loop id */ 452196008Smjacob uint16_t isp_sns_hdl; /* N-port handle for SNS */ 453196008Smjacob uint16_t isp_lasthdl; /* only valid for channel 0 */ 454196008Smjacob uint16_t isp_maxalloc; 455237210Smjacob uint16_t isp_fabric_params; 456155704Smjacob uint8_t isp_retry_delay; 457155704Smjacob uint8_t isp_retry_count; 458196008Smjacob 459196008Smjacob /* 460196008Smjacob * Current active WWNN/WWPN 461196008Smjacob */ 462196008Smjacob uint64_t isp_wwnn; 463196008Smjacob uint64_t isp_wwpn; 464196008Smjacob 465196008Smjacob /* 466196008Smjacob * NVRAM WWNN/WWPN 467196008Smjacob */ 468166120Smjacob uint64_t isp_wwnn_nvram; 469166120Smjacob uint64_t isp_wwpn_nvram; 470164272Smjacob 471164272Smjacob /* 472164272Smjacob * Our Port Data Base 473164272Smjacob */ 474163899Smjacob fcportdb_t portdb[MAX_FC_TARG]; 475164272Smjacob 47635388Smjacob /* 47735388Smjacob * Scratch DMA mapped in area to fetch Port Database stuff, etc. 47835388Smjacob */ 479155704Smjacob void * isp_scratch; 480155704Smjacob XS_DMA_ADDR_T isp_scdma; 48135388Smjacob} fcparam; 48235388Smjacob 48348484Smjacob#define FW_CONFIG_WAIT 0 484290993Smav#define FW_WAIT_LINK 1 48548484Smjacob#define FW_WAIT_LOGIN 2 48648484Smjacob#define FW_READY 3 48748484Smjacob#define FW_LOSS_OF_SYNC 4 48848484Smjacob#define FW_ERROR 5 48948484Smjacob#define FW_REINIT 6 49048484Smjacob#define FW_NON_PART 7 49135388Smjacob 49248484Smjacob#define LOOP_NIL 0 493290993Smav#define LOOP_TESTING_LINK 1 494290993Smav#define LOOP_LTEST_DONE 2 495163899Smjacob#define LOOP_SCANNING_LOOP 3 496163899Smjacob#define LOOP_LSCAN_DONE 4 497163899Smjacob#define LOOP_SCANNING_FABRIC 5 498163899Smjacob#define LOOP_FSCAN_DONE 6 49977776Smjacob#define LOOP_SYNCING_PDB 7 50077776Smjacob#define LOOP_READY 8 50135388Smjacob 50259454Smjacob#define TOPO_NL_PORT 0 50359454Smjacob#define TOPO_FL_PORT 1 50459454Smjacob#define TOPO_N_PORT 2 50559454Smjacob#define TOPO_F_PORT 3 50659454Smjacob#define TOPO_PTP_STUB 4 50759454Smjacob 508291080Smav#define TOPO_IS_FABRIC(x) ((x) == TOPO_FL_PORT || (x) == TOPO_F_PORT) 509291080Smav 51042131Smjacob/* 51135388Smjacob * Soft Structure per host adapter 51235388Smjacob */ 513155704Smjacobstruct ispsoftc { 51435388Smjacob /* 51535388Smjacob * Platform (OS) specific data 51635388Smjacob */ 51735388Smjacob struct isposinfo isp_osinfo; 51835388Smjacob 51935388Smjacob /* 52053487Smjacob * Pointer to bus specific functions and data 52135388Smjacob */ 52235388Smjacob struct ispmdvec * isp_mdvec; 52335388Smjacob 52435388Smjacob /* 52553487Smjacob * (Mostly) nonvolatile state. Board specific parameters 52653487Smjacob * may contain some volatile state (e.g., current loop state). 52735388Smjacob */ 52835388Smjacob 52953487Smjacob void * isp_param; /* type specific */ 530237210Smjacob uint64_t isp_fwattr; /* firmware attributes */ 531155704Smjacob uint16_t isp_fwrev[3]; /* Loaded F/W revision */ 532155704Smjacob uint16_t isp_maxcmds; /* max possible I/O cmds */ 533155704Smjacob uint8_t isp_type; /* HBA Chip Type */ 534155704Smjacob uint8_t isp_revision; /* HBA Chip H/W Revision */ 535237210Smjacob uint16_t isp_nchan; /* number of channels */ 536155704Smjacob uint32_t isp_maxluns; /* maximum luns supported */ 53735388Smjacob 538155704Smjacob uint32_t isp_clock : 8, /* input clock */ 53990224Smjacob : 4, 540163899Smjacob isp_port : 1, /* 23XX/24XX only */ 54187635Smjacob isp_open : 1, /* opened (ioctl) */ 54253487Smjacob isp_bustype : 1, /* SBus or PCI */ 54365140Smjacob isp_loaded_fw : 1, /* loaded firmware */ 544196008Smjacob isp_dblev : 16; /* debug log mask */ 54571079Smjacob 54671079Smjacob 547196008Smjacob uint32_t isp_confopts; /* config options */ 548196008Smjacob 549163899Smjacob uint32_t isp_rqstinrp; /* register for REQINP */ 550163899Smjacob uint32_t isp_rqstoutrp; /* register for REQOUTP */ 551163899Smjacob uint32_t isp_respinrp; /* register for RESINP */ 552163899Smjacob uint32_t isp_respoutrp; /* register for RESOUTP */ 55382689Smjacob 55469522Smjacob /* 55569522Smjacob * Instrumentation 55669522Smjacob */ 557155704Smjacob uint64_t isp_intcnt; /* total int count */ 558155704Smjacob uint64_t isp_intbogus; /* spurious int count */ 559155704Smjacob uint64_t isp_intmboxc; /* mbox completions */ 560155704Smjacob uint64_t isp_intoasync; /* other async */ 561155704Smjacob uint64_t isp_rsltccmplt; /* CMDs on result q */ 562155704Smjacob uint64_t isp_fphccmplt; /* CMDs via fastpost */ 563155704Smjacob uint16_t isp_rscchiwater; 564155704Smjacob uint16_t isp_fpcchiwater; 565196008Smjacob NANOTIME_T isp_init_time; /* time were last initialized */ 56639235Sgibbs 56735388Smjacob /* 56839235Sgibbs * Volatile state 56935388Smjacob */ 57035388Smjacob 571160080Smjacob volatile uint32_t : 8, 572196008Smjacob : 2, 573196008Smjacob isp_dead : 1, 574196008Smjacob : 1, 57587635Smjacob isp_mboxbsy : 1, /* mailbox command active */ 57639235Sgibbs isp_state : 3, 57752347Smjacob isp_nactive : 16; /* how many commands active */ 578203444Smjacob volatile mbreg_t isp_curmbx; /* currently active mailbox command */ 579163899Smjacob volatile uint32_t isp_reqodx; /* index of last ISP pickup */ 580163899Smjacob volatile uint32_t isp_reqidx; /* index of next request */ 581256705Smav volatile uint32_t isp_residx; /* index of last ISP write */ 582163899Smjacob volatile uint32_t isp_resodx; /* index of next result */ 583256705Smav volatile uint32_t isp_atioodx; /* index of next ATIO */ 584163899Smjacob volatile uint32_t isp_obits; /* mailbox command output */ 585196008Smjacob volatile uint32_t isp_serno; /* rolling serial number */ 586237210Smjacob volatile uint16_t isp_mboxtmp[MAX_MAILBOX]; 587155704Smjacob volatile uint16_t isp_lastmbxcmd; /* last mbox command sent */ 588155704Smjacob volatile uint16_t isp_mbxwrk0; 589155704Smjacob volatile uint16_t isp_mbxwrk1; 590155704Smjacob volatile uint16_t isp_mbxwrk2; 591160080Smjacob volatile uint16_t isp_mbxwrk8; 592203444Smjacob volatile uint16_t isp_seqno; /* running sequence number */ 59390224Smjacob void * isp_mbxworkp; 59435388Smjacob 59535388Smjacob /* 59653487Smjacob * Active commands are stored here, indexed by handle functions. 59735388Smjacob */ 598203444Smjacob isp_hdl_t *isp_xflist; 599203444Smjacob isp_hdl_t *isp_xffree; 60035388Smjacob 601129643Snjl#ifdef ISP_TARGET_MODE 60235388Smjacob /* 603196008Smjacob * Active target commands are stored here, indexed by handle functions. 604129643Snjl */ 605203444Smjacob isp_hdl_t *isp_tgtlist; 606203444Smjacob isp_hdl_t *isp_tgtfree; 607129643Snjl#endif 608129643Snjl 609129643Snjl /* 610120018Smjacob * request/result queue pointers and DMA handles for them. 61135388Smjacob */ 612155704Smjacob void * isp_rquest; 613155704Smjacob void * isp_result; 614155704Smjacob XS_DMA_ADDR_T isp_rquest_dma; 615155704Smjacob XS_DMA_ADDR_T isp_result_dma; 616163899Smjacob#ifdef ISP_TARGET_MODE 617163899Smjacob /* for 24XX only */ 618163899Smjacob void * isp_atioq; 619163899Smjacob XS_DMA_ADDR_T isp_atioq_dma; 620163899Smjacob#endif 621155704Smjacob}; 62235388Smjacob 623196008Smjacob#define SDPARAM(isp, chan) (&((sdparam *)(isp)->isp_param)[(chan)]) 624196008Smjacob#define FCPARAM(isp, chan) (&((fcparam *)(isp)->isp_param)[(chan)]) 62549909Smjacob 626196008Smjacob#define ISP_SET_SENDMARKER(isp, chan, val) \ 627196008Smjacob if (IS_FC(isp)) { \ 628196008Smjacob FCPARAM(isp, chan)->sendmarker = val; \ 629196008Smjacob } else { \ 630196008Smjacob SDPARAM(isp, chan)->sendmarker = val; \ 631196008Smjacob } 632196008Smjacob 633196008Smjacob#define ISP_TST_SENDMARKER(isp, chan) \ 634196008Smjacob (IS_FC(isp)? \ 635196008Smjacob FCPARAM(isp, chan)->sendmarker != 0 : \ 636196008Smjacob SDPARAM(isp, chan)->sendmarker != 0) 637196008Smjacob 63835388Smjacob/* 63964087Smjacob * ISP Driver Run States 64035388Smjacob */ 64135388Smjacob#define ISP_NILSTATE 0 642160080Smjacob#define ISP_CRASHED 1 643160080Smjacob#define ISP_RESETSTATE 2 644160080Smjacob#define ISP_INITSTATE 3 645160080Smjacob#define ISP_RUNSTATE 4 64635388Smjacob 64735388Smjacob/* 648237537Smjacob * ISP Runtime Configuration Options 64935388Smjacob */ 65053487Smjacob#define ISP_CFG_FULL_DUPLEX 0x01 /* Full Duplex (Fibre Channel only) */ 651238869Smjacob#define ISP_CFG_PORT_PREF 0x0c /* Mask for Port Prefs (all FC except 2100) */ 65269522Smjacob#define ISP_CFG_LPORT 0x00 /* prefer {N/F}L-Port connection */ 65369522Smjacob#define ISP_CFG_NPORT 0x04 /* prefer {N/F}-Port connection */ 65469522Smjacob#define ISP_CFG_NPORT_ONLY 0x08 /* insist on {N/F}-Port connection */ 655238869Smjacob#define ISP_CFG_LPORT_ONLY 0x0c /* insist on {N/F}L-Port connection */ 656238869Smjacob#define ISP_CFG_ONEGB 0x10 /* force 1GB connection (23XX only) */ 657238869Smjacob#define ISP_CFG_TWOGB 0x20 /* force 2GB connection (23XX only) */ 658238869Smjacob#define ISP_CFG_NORELOAD 0x80 /* don't download f/w */ 659238869Smjacob#define ISP_CFG_NONVRAM 0x40 /* ignore NVRAM */ 660238869Smjacob#define ISP_CFG_NOFCTAPE 0x100 /* disable FC-Tape */ 661238869Smjacob#define ISP_CFG_FCTAPE 0x200 /* enable FC-Tape */ 66298281Smjacob#define ISP_CFG_OWNFSZ 0x400 /* override NVRAM frame size */ 66398281Smjacob#define ISP_CFG_OWNLOOPID 0x800 /* override NVRAM loopid */ 66498281Smjacob#define ISP_CFG_OWNEXCTHROTTLE 0x1000 /* override NVRAM execution throttle */ 665163899Smjacob#define ISP_CFG_FOURGB 0x2000 /* force 4GB connection (24XX only) */ 666237210Smjacob#define ISP_CFG_EIGHTGB 0x4000 /* force 8GB connection (25XX only) */ 667238869Smjacob#define ISP_CFG_SIXTEENGB 0x8000 /* force 16GB connection (82XX only) */ 66835388Smjacob 66964087Smjacob/* 670196008Smjacob * For each channel, the outer layers should know what role that channel 671196008Smjacob * will take: ISP_ROLE_NONE, ISP_ROLE_INITIATOR, ISP_ROLE_TARGET, 672196008Smjacob * ISP_ROLE_BOTH. 67371079Smjacob * 67471079Smjacob * If you set ISP_ROLE_NONE, the cards will be reset, new firmware loaded, 67571079Smjacob * NVRAM read, and defaults set, but any further initialization (e.g. 67671079Smjacob * INITIALIZE CONTROL BLOCK commands for 2X00 cards) won't be done. 67771079Smjacob * 67871079Smjacob * If INITIATOR MODE isn't set, attempts to run commands will be stopped 679196008Smjacob * at isp_start and completed with the equivalent of SELECTION TIMEOUT. 68071079Smjacob * 68171079Smjacob * If TARGET MODE is set, it doesn't mean that the rest of target mode support 68271079Smjacob * needs to be enabled, or will even work. What happens with the 2X00 cards 68371079Smjacob * here is that if you have enabled it with TARGET MODE as part of the ICB 68471079Smjacob * options, but you haven't given the f/w any ram resources for ATIOs or 68571079Smjacob * Immediate Notifies, the f/w just handles what it can and you never see 68671079Smjacob * anything. Basically, it sends a single byte of data (the first byte, 68771079Smjacob * which you can set as part of the INITIALIZE CONTROL BLOCK command) for 68871079Smjacob * INQUIRY, and sends back QUEUE FULL status for any other command. 68979235Smjacob * 69071079Smjacob */ 69171079Smjacob#define ISP_ROLE_NONE 0x0 692125544Smjacob#define ISP_ROLE_TARGET 0x1 693125544Smjacob#define ISP_ROLE_INITIATOR 0x2 69471079Smjacob#define ISP_ROLE_BOTH (ISP_ROLE_TARGET|ISP_ROLE_INITIATOR) 69571079Smjacob#define ISP_ROLE_EITHER ISP_ROLE_BOTH 69671079Smjacob#ifndef ISP_DEFAULT_ROLES 697236427Smjacob/* 698236427Smjacob * Counterintuitively, we prefer to default to role 'none' 699236427Smjacob * if we are enable target mode support. This gives us the 700236427Smjacob * maximum flexibility as to which port will do what. 701236427Smjacob */ 702236427Smjacob#ifdef ISP_TARGET_MODE 703236427Smjacob#define ISP_DEFAULT_ROLES ISP_ROLE_NONE 704236427Smjacob#else 70571079Smjacob#define ISP_DEFAULT_ROLES ISP_ROLE_INITIATOR 70671079Smjacob#endif 707236427Smjacob#endif 70871079Smjacob 70971079Smjacob 71071079Smjacob/* 71164087Smjacob * Firmware related defines 71264087Smjacob */ 71371079Smjacob#define ISP_CODE_ORG 0x1000 /* default f/w code start */ 71482689Smjacob#define ISP_CODE_ORG_2300 0x0800 /* ..except for 2300s */ 715163899Smjacob#define ISP_CODE_ORG_2400 0x100000 /* ..and 2400s */ 71645282Smjacob#define ISP_FW_REV(maj, min, mic) ((maj << 24) | (min << 16) | mic) 71782841Smjacob#define ISP_FW_MAJOR(code) ((code >> 24) & 0xff) 71882841Smjacob#define ISP_FW_MINOR(code) ((code >> 16) & 0xff) 71982841Smjacob#define ISP_FW_MICRO(code) ((code >> 8) & 0xff) 72071079Smjacob#define ISP_FW_REVX(xp) ((xp[0]<<24) | (xp[1] << 16) | xp[2]) 72182841Smjacob#define ISP_FW_MAJORX(xp) (xp[0]) 72282841Smjacob#define ISP_FW_MINORX(xp) (xp[1]) 72382841Smjacob#define ISP_FW_MICROX(xp) (xp[2]) 724102012Smjacob#define ISP_FW_NEWER_THAN(i, major, minor, micro) \ 725102012Smjacob (ISP_FW_REVX((i)->isp_fwrev) > ISP_FW_REV(major, minor, micro)) 726163899Smjacob#define ISP_FW_OLDER_THAN(i, major, minor, micro) \ 727163899Smjacob (ISP_FW_REVX((i)->isp_fwrev) < ISP_FW_REV(major, minor, micro)) 72839235Sgibbs 72935388Smjacob/* 73039235Sgibbs * Bus (implementation) types 73135388Smjacob */ 73239235Sgibbs#define ISP_BT_PCI 0 /* PCI Implementations */ 73339235Sgibbs#define ISP_BT_SBUS 1 /* SBus Implementations */ 73439235Sgibbs 73539235Sgibbs/* 73687635Smjacob * If we have not otherwise defined SBus support away make sure 73787635Smjacob * it is defined here such that the code is included as default 73887635Smjacob */ 73987635Smjacob#ifndef ISP_SBUS_SUPPORTED 74087635Smjacob#define ISP_SBUS_SUPPORTED 1 74187635Smjacob#endif 74287635Smjacob 74387635Smjacob/* 74439235Sgibbs * Chip Types 74539235Sgibbs */ 74635388Smjacob#define ISP_HA_SCSI 0xf 74739235Sgibbs#define ISP_HA_SCSI_UNKNOWN 0x1 74839235Sgibbs#define ISP_HA_SCSI_1020 0x2 74939235Sgibbs#define ISP_HA_SCSI_1020A 0x3 75039235Sgibbs#define ISP_HA_SCSI_1040 0x4 75139235Sgibbs#define ISP_HA_SCSI_1040A 0x5 75239235Sgibbs#define ISP_HA_SCSI_1040B 0x6 75345282Smjacob#define ISP_HA_SCSI_1040C 0x7 75454671Smjacob#define ISP_HA_SCSI_1240 0x8 75554671Smjacob#define ISP_HA_SCSI_1080 0x9 75654671Smjacob#define ISP_HA_SCSI_1280 0xa 757104916Smjacob#define ISP_HA_SCSI_10160 0xb 758104916Smjacob#define ISP_HA_SCSI_12160 0xc 75935388Smjacob#define ISP_HA_FC 0xf0 76035388Smjacob#define ISP_HA_FC_2100 0x10 76148484Smjacob#define ISP_HA_FC_2200 0x20 76277365Smjacob#define ISP_HA_FC_2300 0x30 76388855Smjacob#define ISP_HA_FC_2312 0x40 764154704Smjacob#define ISP_HA_FC_2322 0x50 765154704Smjacob#define ISP_HA_FC_2400 0x60 766196008Smjacob#define ISP_HA_FC_2500 0x70 76735388Smjacob 76844819Smjacob#define IS_SCSI(isp) (isp->isp_type & ISP_HA_SCSI) 769196008Smjacob#define IS_1020(isp) (isp->isp_type < ISP_HA_SCSI_1240) 77054671Smjacob#define IS_1240(isp) (isp->isp_type == ISP_HA_SCSI_1240) 77144819Smjacob#define IS_1080(isp) (isp->isp_type == ISP_HA_SCSI_1080) 77254671Smjacob#define IS_1280(isp) (isp->isp_type == ISP_HA_SCSI_1280) 773104916Smjacob#define IS_10160(isp) (isp->isp_type == ISP_HA_SCSI_10160) 77457145Smjacob#define IS_12160(isp) (isp->isp_type == ISP_HA_SCSI_12160) 77557145Smjacob 77657145Smjacob#define IS_12X0(isp) (IS_1240(isp) || IS_1280(isp)) 777104916Smjacob#define IS_1X160(isp) (IS_10160(isp) || IS_12160(isp)) 77857145Smjacob#define IS_DUALBUS(isp) (IS_12X0(isp) || IS_12160(isp)) 779104916Smjacob#define IS_ULTRA2(isp) (IS_1080(isp) || IS_1280(isp) || IS_1X160(isp)) 780104916Smjacob#define IS_ULTRA3(isp) (IS_1X160(isp)) 78157145Smjacob 78277365Smjacob#define IS_FC(isp) ((isp)->isp_type & ISP_HA_FC) 78377365Smjacob#define IS_2100(isp) ((isp)->isp_type == ISP_HA_FC_2100) 78477365Smjacob#define IS_2200(isp) ((isp)->isp_type == ISP_HA_FC_2200) 785163899Smjacob#define IS_23XX(isp) ((isp)->isp_type >= ISP_HA_FC_2300 && \ 786163899Smjacob (isp)->isp_type < ISP_HA_FC_2400) 78788855Smjacob#define IS_2300(isp) ((isp)->isp_type == ISP_HA_FC_2300) 78888855Smjacob#define IS_2312(isp) ((isp)->isp_type == ISP_HA_FC_2312) 789154704Smjacob#define IS_2322(isp) ((isp)->isp_type == ISP_HA_FC_2322) 790154704Smjacob#define IS_24XX(isp) ((isp)->isp_type >= ISP_HA_FC_2400) 791196008Smjacob#define IS_25XX(isp) ((isp)->isp_type >= ISP_HA_FC_2500) 79244819Smjacob 79364087Smjacob/* 794155704Smjacob * DMA related macros 79564087Smjacob */ 796163899Smjacob#define DMA_WD3(x) (((uint16_t)(((uint64_t)x) >> 48)) & 0xffff) 797163899Smjacob#define DMA_WD2(x) (((uint16_t)(((uint64_t)x) >> 32)) & 0xffff) 798163899Smjacob#define DMA_WD1(x) ((uint16_t)((x) >> 16) & 0xffff) 799163899Smjacob#define DMA_WD0(x) ((uint16_t)((x) & 0xffff)) 80057145Smjacob 801155704Smjacob#define DMA_LO32(x) ((uint32_t) (x)) 802155704Smjacob#define DMA_HI32(x) ((uint32_t)(((uint64_t)x) >> 32)) 803155704Smjacob 80435388Smjacob/* 80564087Smjacob * Core System Function Prototypes 80635388Smjacob */ 80735388Smjacob 80835388Smjacob/* 809196008Smjacob * Reset Hardware. Totally. Assumes that you'll follow this with a call to isp_init. 81035388Smjacob */ 811196008Smjacobvoid isp_reset(ispsoftc_t *, int); 81235388Smjacob 81335388Smjacob/* 81435388Smjacob * Initialize Hardware to known state 81535388Smjacob */ 816155704Smjacobvoid isp_init(ispsoftc_t *); 81735388Smjacob 81835388Smjacob/* 81939235Sgibbs * Reset the ISP and call completion for any orphaned commands. 82039235Sgibbs */ 821285459Smavint isp_reinit(ispsoftc_t *, int); 82239235Sgibbs 82339235Sgibbs/* 82482689Smjacob * Internal Interrupt Service Routine 82582689Smjacob * 82682689Smjacob * The outer layers do the spade work to get the appropriate status register, 82782689Smjacob * semaphore register and first mailbox register (if appropriate). This also 82882689Smjacob * means that most spurious/bogus interrupts not for us can be filtered first. 82935388Smjacob */ 830289812Smavvoid isp_intr(ispsoftc_t *, uint16_t, uint16_t, uint16_t); 83135388Smjacob 83282689Smjacob 83335388Smjacob/* 83464087Smjacob * Command Entry Point- Platform Dependent layers call into this 83535388Smjacob */ 83674229Smjacobint isp_start(XS_T *); 837155704Smjacob 83864087Smjacob/* these values are what isp_start returns */ 83964087Smjacob#define CMD_COMPLETE 101 /* command completed */ 84064087Smjacob#define CMD_EAGAIN 102 /* busy- maybe retry later */ 84164087Smjacob#define CMD_QUEUED 103 /* command has been queued for execution */ 84264087Smjacob#define CMD_RQLATER 104 /* requeue this command later */ 84335388Smjacob 84439235Sgibbs/* 84564087Smjacob * Command Completion Point- Core layers call out from this with completed cmds 84664087Smjacob */ 84774229Smjacobvoid isp_done(XS_T *); 84864087Smjacob 84964087Smjacob/* 85043420Smjacob * Platform Dependent to External to Internal Control Function 85139235Sgibbs * 85272355Smjacob * Assumes locks are held on entry. You should note that with many of 853196008Smjacob * these commands locks may be released while this function is called. 85439235Sgibbs * 855196008Smjacob * ... ISPCTL_RESET_BUS, int channel); 856196008Smjacob * Reset BUS on this channel 857196008Smjacob * ... ISPCTL_RESET_DEV, int channel, int target); 858196008Smjacob * Reset Device on this channel at this target. 859196008Smjacob * ... ISPCTL_ABORT_CMD, XS_T *xs); 860196008Smjacob * Abort active transaction described by xs. 861196008Smjacob * ... IPCTL_UPDATE_PARAMS); 862196008Smjacob * Update any operating parameters (speed, etc.) 863196008Smjacob * ... ISPCTL_FCLINK_TEST, int channel); 864196008Smjacob * Test FC link status on this channel 865290993Smav * ... ISPCTL_SCAN_LOOP, int channel); 866290993Smav * Scan local loop on this channel 867196008Smjacob * ... ISPCTL_SCAN_FABRIC, int channel); 868196008Smjacob * Scan fabric on this channel 869196008Smjacob * ... ISPCTL_PDB_SYNC, int channel); 870196008Smjacob * Synchronize port database on this channel 871196008Smjacob * ... ISPCTL_SEND_LIP, int channel); 872196008Smjacob * Send a LIP on this channel 873196008Smjacob * ... ISPCTL_GET_NAMES, int channel, int np, uint64_t *wwnn, uint64_t *wwpn) 874196008Smjacob * Get a WWNN/WWPN for this N-port handle on this channel 875196008Smjacob * ... ISPCTL_RUN_MBOXCMD, mbreg_t *mbp) 876196008Smjacob * Run this mailbox command 877196008Smjacob * ... ISPCTL_GET_PDB, int channel, int nphandle, isp_pdb_t *pdb) 878196008Smjacob * Get PDB on this channel for this N-port handle 879196008Smjacob * ... ISPCTL_PLOGX, isp_plcmd_t *) 880196008Smjacob * Performa a port login/logout 881285146Smav * ... ISPCTL_CHANGE_ROLE, int channel, int role); 882285146Smav * Change role of specified channel 88372355Smjacob * 88472355Smjacob * ISPCTL_PDB_SYNC is somewhat misnamed. It actually is the final step, in 885290993Smav * order, of ISPCTL_FCLINK_TEST, ISPCTL_SCAN_LOOP, and ISPCTL_SCAN_FABRIC. 88672355Smjacob * The main purpose of ISPCTL_PDB_SYNC is to complete management of logging 88772355Smjacob * and logging out of fabric devices (if one is on a fabric) and then marking 88872355Smjacob * the 'loop state' as being ready to now be used for sending commands to 889290993Smav * devices. 89039235Sgibbs */ 89139235Sgibbstypedef enum { 892196008Smjacob ISPCTL_RESET_BUS, 893196008Smjacob ISPCTL_RESET_DEV, 894196008Smjacob ISPCTL_ABORT_CMD, 895196008Smjacob ISPCTL_UPDATE_PARAMS, 896196008Smjacob ISPCTL_FCLINK_TEST, 897196008Smjacob ISPCTL_SCAN_FABRIC, 898196008Smjacob ISPCTL_SCAN_LOOP, 899196008Smjacob ISPCTL_PDB_SYNC, 900196008Smjacob ISPCTL_SEND_LIP, 901196008Smjacob ISPCTL_GET_NAMES, 902196008Smjacob ISPCTL_RUN_MBOXCMD, 903196008Smjacob ISPCTL_GET_PDB, 904285146Smav ISPCTL_PLOGX, 905285146Smav ISPCTL_CHANGE_ROLE 90639235Sgibbs} ispctl_t; 907196008Smjacobint isp_control(ispsoftc_t *, ispctl_t, ...); 90839235Sgibbs 90939235Sgibbs/* 91043420Smjacob * Platform Dependent to Internal to External Control Function 91143420Smjacob */ 91243420Smjacob 91343420Smjacobtypedef enum { 914196008Smjacob ISPASYNC_NEW_TGT_PARAMS, /* SPI New Target Parameters */ 915196008Smjacob ISPASYNC_BUS_RESET, /* All Bus Was Reset */ 91648484Smjacob ISPASYNC_LOOP_DOWN, /* FC Loop Down */ 91748484Smjacob ISPASYNC_LOOP_UP, /* FC Loop Up */ 918196008Smjacob ISPASYNC_LIP, /* FC LIP Received */ 919196008Smjacob ISPASYNC_LOOP_RESET, /* FC Loop Reset Received */ 92072355Smjacob ISPASYNC_CHANGE_NOTIFY, /* FC Change Notification */ 921196008Smjacob ISPASYNC_DEV_ARRIVED, /* FC Device Arrived */ 922196008Smjacob ISPASYNC_DEV_CHANGED, /* FC Device Changed */ 923196008Smjacob ISPASYNC_DEV_STAYED, /* FC Device Stayed */ 924196008Smjacob ISPASYNC_DEV_GONE, /* FC Device Departure */ 925196008Smjacob ISPASYNC_TARGET_NOTIFY, /* All target async notification */ 926238869Smjacob ISPASYNC_TARGET_NOTIFY_ACK, /* All target notify ack required */ 927196008Smjacob ISPASYNC_TARGET_ACTION, /* All target action requested */ 928196008Smjacob ISPASYNC_FW_CRASH, /* All Firmware has crashed */ 929196008Smjacob ISPASYNC_FW_RESTARTED /* All Firmware has been restarted */ 93043420Smjacob} ispasync_t; 931196008Smjacobvoid isp_async(ispsoftc_t *, ispasync_t, ...); 93243420Smjacob 933196008Smjacob#define ISPASYNC_CHANGE_PDB 0 934196008Smjacob#define ISPASYNC_CHANGE_SNS 1 935196008Smjacob#define ISPASYNC_CHANGE_OTHER 2 93672355Smjacob 93743420Smjacob/* 938224856Smjacob * Platform Independent Error Prinout 939224856Smjacob */ 940224856Smjacobvoid isp_prt_endcmd(ispsoftc_t *, XS_T *); 941224856Smjacob 942224856Smjacob/* 94364087Smjacob * Platform Dependent Error and Debug Printout 944146073Smjacob * 945205698Smjacob * Two required functions for each platform must be provided: 946146073Smjacob * 947155704Smjacob * void isp_prt(ispsoftc_t *, int level, const char *, ...) 948205698Smjacob * void isp_xs_prt(ispsoftc_t *, XS_T *, int level, const char *, ...) 949146073Smjacob * 950146073Smjacob * but due to compiler differences on different platforms this won't be 951205698Smjacob * formally defined here. Instead, they go in each platform definition file. 95239235Sgibbs */ 95370490Smjacob 95464087Smjacob#define ISP_LOGALL 0x0 /* log always */ 95564087Smjacob#define ISP_LOGCONFIG 0x1 /* log configuration messages */ 95664087Smjacob#define ISP_LOGINFO 0x2 /* log informational messages */ 95764087Smjacob#define ISP_LOGWARN 0x4 /* log warning messages */ 95864087Smjacob#define ISP_LOGERR 0x8 /* log error messages */ 95964087Smjacob#define ISP_LOGDEBUG0 0x10 /* log simple debug messages */ 96064087Smjacob#define ISP_LOGDEBUG1 0x20 /* log intermediate debug messages */ 96164087Smjacob#define ISP_LOGDEBUG2 0x40 /* log most debug messages */ 96279235Smjacob#define ISP_LOGDEBUG3 0x80 /* log high frequency debug messages */ 963238869Smjacob#define ISP_LOG_SANCFG 0x100 /* log SAN configuration */ 964205698Smjacob#define ISP_LOG_CWARN 0x200 /* log SCSI command "warnings" (e.g., check conditions) */ 965238869Smjacob#define ISP_LOG_WARN1 0x400 /* log WARNS we might be interested at some time */ 966196008Smjacob#define ISP_LOGTINFO 0x1000 /* log informational messages (target mode) */ 967196008Smjacob#define ISP_LOGTDEBUG0 0x2000 /* log simple debug messages (target mode) */ 968196008Smjacob#define ISP_LOGTDEBUG1 0x4000 /* log intermediate debug messages (target) */ 969196008Smjacob#define ISP_LOGTDEBUG2 0x8000 /* log all debug messages (target) */ 97039235Sgibbs 97164087Smjacob/* 97264087Smjacob * Each Platform provides it's own isposinfo substructure of the ispsoftc 97364087Smjacob * defined above. 97464087Smjacob * 97564087Smjacob * Each platform must also provide the following macros/defines: 97664087Smjacob * 97764087Smjacob * 978196008Smjacob * ISP_FC_SCRLEN FC scratch area DMA length 97964087Smjacob * 980196008Smjacob * ISP_MEMZERO(dst, src) platform zeroing function 981196008Smjacob * ISP_MEMCPY(dst, src, count) platform copying function 982196008Smjacob * ISP_SNPRINTF(buf, bufsize, fmt, ...) snprintf 983196008Smjacob * ISP_DELAY(usecs) microsecond spindelay function 984196008Smjacob * ISP_SLEEP(isp, usecs) microsecond sleep function 98564087Smjacob * 986196008Smjacob * ISP_INLINE ___inline or not- depending on how 987196008Smjacob * good your debugger is 988219098Smjacob * ISP_MIN shorthand for ((a) < (b))? (a) : (b) 989196008Smjacob * 99064087Smjacob * NANOTIME_T nanosecond time type 99164087Smjacob * 99264087Smjacob * GET_NANOTIME(NANOTIME_T *) get current nanotime. 99364087Smjacob * 994155704Smjacob * GET_NANOSEC(NANOTIME_T *) get uint64_t from NANOTIME_T 99564087Smjacob * 99664087Smjacob * NANOTIME_SUB(NANOTIME_T *, NANOTIME_T *) 99764087Smjacob * subtract two NANOTIME_T values 99864087Smjacob * 999196008Smjacob * MAXISPREQUEST(ispsoftc_t *) maximum request queue size 100064087Smjacob * for this particular board type 100164087Smjacob * 1002218691Smarius * MEMORYBARRIER(ispsoftc_t *, barrier_type, offset, size, chan) 100364087Smjacob * 100464087Smjacob * Function/Macro the provides memory synchronization on 100564087Smjacob * various objects so that the ISP's and the system's view 100664087Smjacob * of the same object is consistent. 100764087Smjacob * 1008155704Smjacob * MBOX_ACQUIRE(ispsoftc_t *) acquire lock on mailbox regs 1009163899Smjacob * MBOX_WAIT_COMPLETE(ispsoftc_t *, mbreg_t *) wait for cmd to be done 1010155704Smjacob * MBOX_NOTIFY_COMPLETE(ispsoftc_t *) notification of mbox cmd donee 1011155704Smjacob * MBOX_RELEASE(ispsoftc_t *) release lock on mailbox regs 101264087Smjacob * 1013196008Smjacob * FC_SCRATCH_ACQUIRE(ispsoftc_t *, chan) acquire lock on FC scratch area 1014196008Smjacob * return -1 if you cannot 1015196008Smjacob * FC_SCRATCH_RELEASE(ispsoftc_t *, chan) acquire lock on FC scratch area 101672355Smjacob * 1017237210Smjacob * FCP_NEXT_CRN(ispsoftc_t *, XS_T *, rslt, channel, target, lun) generate the next command reference number. XS_T * may be null. 1018237210Smjacob * 101964087Smjacob * SCSI_GOOD SCSI 'Good' Status 102064087Smjacob * SCSI_CHECK SCSI 'Check Condition' Status 102164087Smjacob * SCSI_BUSY SCSI 'Busy' Status 102264087Smjacob * SCSI_QFULL SCSI 'Queue Full' Status 102364087Smjacob * 1024196008Smjacob * XS_T Platform SCSI transaction type (i.e., command for HBA) 1025196008Smjacob * XS_DMA_ADDR_T Platform PCI DMA Address Type 1026196008Smjacob * XS_GET_DMA_SEG(..) Get 32 bit dma segment list value 1027196008Smjacob * XS_GET_DMA64_SEG(..) Get 64 bit dma segment list value 1028196008Smjacob * XS_ISP(xs) gets an instance out of an XS_T 1029196008Smjacob * XS_CHANNEL(xs) gets the channel (bus # for DUALBUS cards) "" 1030196008Smjacob * XS_TGT(xs) gets the target "" 1031196008Smjacob * XS_LUN(xs) gets the lun "" 1032196008Smjacob * XS_CDBP(xs) gets a pointer to the scsi CDB "" 1033196008Smjacob * XS_CDBLEN(xs) gets the CDB's length "" 1034196008Smjacob * XS_XFRLEN(xs) gets the associated data transfer length "" 1035196008Smjacob * XS_TIME(xs) gets the time (in milliseconds) for this command 1036196008Smjacob * XS_GET_RESID(xs) gets the current residual count 1037196008Smjacob * XS_GET_RESID(xs, resid) sets the current residual count 1038196008Smjacob * XS_STSP(xs) gets a pointer to the SCSI status byte "" 1039196008Smjacob * XS_SNSP(xs) gets a pointer to the associate sense data 1040238869Smjacob * XS_TOT_SNSLEN(xs) gets the total length of sense data storage 1041238869Smjacob * XS_CUR_SNSLEN(xs) gets the currently used lenght of sense data storage 1042196008Smjacob * XS_SNSKEY(xs) dereferences XS_SNSP to get the current stored Sense Key 1043205698Smjacob * XS_SNSASC(xs) dereferences XS_SNSP to get the current stored Additional Sense Code 1044205698Smjacob * XS_SNSASCQ(xs) dereferences XS_SNSP to get the current stored Additional Sense Code Qualifier 1045196008Smjacob * XS_TAG_P(xs) predicate of whether this command should be tagged 1046196008Smjacob * XS_TAG_TYPE(xs) which type of tag to use 1047196008Smjacob * XS_SETERR(xs) set error state 104864087Smjacob * 104964087Smjacob * HBA_NOERROR command has no erros 105064087Smjacob * HBA_BOTCH hba botched something 105164087Smjacob * HBA_CMDTIMEOUT command timed out 105264087Smjacob * HBA_SELTIMEOUT selection timed out (also port logouts for FC) 105364087Smjacob * HBA_TGTBSY target returned a BUSY status 105464087Smjacob * HBA_BUSRESET bus reset destroyed command 105564087Smjacob * HBA_ABORTED command was aborted (by request) 105664087Smjacob * HBA_DATAOVR a data overrun was detected 105764087Smjacob * HBA_ARQFAIL Automatic Request Sense failed 105864087Smjacob * 105964087Smjacob * XS_ERR(xs) return current error state 106064087Smjacob * XS_NOERR(xs) there is no error currently set 106164087Smjacob * XS_INITERR(xs) initialize error state 106264087Smjacob * 1063238869Smjacob * XS_SAVE_SENSE(xs, sp, total_len, this_len) save sense data (total and current amount) 106464087Smjacob * 1065238869Smjacob * XS_APPEND_SENSE(xs, sp, len) append more sense data 1066238869Smjacob * 1067205698Smjacob * XS_SENSE_VALID(xs) indicates whether sense is valid 1068205698Smjacob * 1069196008Smjacob * DEFAULT_FRAMESIZE(ispsoftc_t *) Default Frame Size 1070196008Smjacob * DEFAULT_EXEC_THROTTLE(ispsoftc_t *) Default Execution Throttle 107164087Smjacob * 1072291188Smav * DEFAULT_ROLE(ispsoftc_t *, int) Get Default Role for a channel 1073196008Smjacob * DEFAULT_IID(ispsoftc_t *, int) Default SCSI initiator ID 1074196008Smjacob * DEFAULT_LOOPID(ispsoftc_t *, int) Default FC Loop ID 107564087Smjacob * 107667047Smjacob * These establish reasonable defaults for each platform. 107767047Smjacob * These must be available independent of card NVRAM and are 107867047Smjacob * to be used should NVRAM not be readable. 107964087Smjacob * 1080196008Smjacob * DEFAULT_NODEWWN(ispsoftc_t *, chan) Default FC Node WWN to use 1081196008Smjacob * DEFAULT_PORTWWN(ispsoftc_t *, chan) Default FC Port WWN to use 108264087Smjacob * 1083196008Smjacob * These defines are hooks to allow the setting of node and 1084196008Smjacob * port WWNs when NVRAM cannot be read or is to be overriden. 108564087Smjacob * 1086196008Smjacob * ACTIVE_NODEWWN(ispsoftc_t *, chan) FC Node WWN to use 1087196008Smjacob * ACTIVE_PORTWWN(ispsoftc_t *, chan) FC Port WWN to use 108887635Smjacob * 1089196008Smjacob * After NVRAM is read, these will be invoked to get the 1090196008Smjacob * node and port WWNs that will actually be used for this 1091196008Smjacob * channel. 1092196008Smjacob * 1093196008Smjacob * 1094155704Smjacob * ISP_IOXPUT_8(ispsoftc_t *, uint8_t srcval, uint8_t *dstptr) 1095155704Smjacob * ISP_IOXPUT_16(ispsoftc_t *, uint16_t srcval, uint16_t *dstptr) 1096155704Smjacob * ISP_IOXPUT_32(ispsoftc_t *, uint32_t srcval, uint32_t *dstptr) 109787635Smjacob * 1098155704Smjacob * ISP_IOXGET_8(ispsoftc_t *, uint8_t *srcptr, uint8_t dstrval) 1099155704Smjacob * ISP_IOXGET_16(ispsoftc_t *, uint16_t *srcptr, uint16_t dstrval) 1100155704Smjacob * ISP_IOXGET_32(ispsoftc_t *, uint32_t *srcptr, uint32_t dstrval) 110187635Smjacob * 1102155704Smjacob * ISP_SWIZZLE_NVRAM_WORD(ispsoftc_t *, uint16_t *) 1103171159Smjacob * ISP_SWIZZLE_NVRAM_LONG(ispsoftc_t *, uint32_t *) 1104171159Smjacob * ISP_SWAP16(ispsoftc_t *, uint16_t srcval) 1105171159Smjacob * ISP_SWAP32(ispsoftc_t *, uint32_t srcval) 110664087Smjacob */ 110777365Smjacob 1108196008Smjacob#ifdef ISP_TARGET_MODE 1109196008Smjacob/* 1110196008Smjacob * The functions below are for the publicly available 1111196008Smjacob * target mode functions that are internal to the Qlogic driver. 1112196008Smjacob */ 1113196008Smjacob 1114196008Smjacob/* 1115196008Smjacob * This function handles new response queue entry appropriate for target mode. 1116196008Smjacob */ 1117196008Smjacobint isp_target_notify(ispsoftc_t *, void *, uint32_t *); 1118196008Smjacob 1119196008Smjacob/* 1120196008Smjacob * This function externalizes the ability to acknowledge an Immediate Notify request. 1121196008Smjacob */ 1122196008Smjacobint isp_notify_ack(ispsoftc_t *, void *); 1123196008Smjacob 1124196008Smjacob/* 1125196008Smjacob * This function externalized acknowledging (success/fail) an ABTS frame 1126196008Smjacob */ 1127196008Smjacobint isp_acknak_abts(ispsoftc_t *, void *, int); 1128196008Smjacob 1129196008Smjacob/* 1130196008Smjacob * General request queue 'put' routine for target mode entries. 1131196008Smjacob */ 1132196008Smjacobint isp_target_put_entry(ispsoftc_t *isp, void *); 1133196008Smjacob 1134196008Smjacob/* 1135196008Smjacob * General routine to put back an ATIO entry- 1136196008Smjacob * used for replenishing f/w resource counts. 1137196008Smjacob * The argument is a pointer to a source ATIO 1138196008Smjacob * or ATIO2. 1139196008Smjacob */ 1140196008Smjacobint isp_target_put_atio(ispsoftc_t *, void *); 1141196008Smjacob 1142196008Smjacob/* 1143196008Smjacob * General routine to send a final CTIO for a command- used mostly for 1144196008Smjacob * local responses. 1145196008Smjacob */ 1146196008Smjacobint isp_endcmd(ispsoftc_t *, ...); 1147196008Smjacob#define ECMD_SVALID 0x100 1148196008Smjacob#define ECMD_TERMINATE 0x200 1149196008Smjacob 1150196008Smjacob/* 1151196008Smjacob * Handle an asynchronous event 1152196008Smjacob * 1153196008Smjacob * Return nonzero if the interrupt that generated this event has been dismissed. 1154196008Smjacob */ 1155196008Smjacobint isp_target_async(ispsoftc_t *, int, int); 1156196008Smjacob#endif 115735388Smjacob#endif /* _ISPVAR_H */ 1158