ispvar.h revision 316398
1114902Sscottl/* $FreeBSD: stable/11/sys/dev/isp/ispvar.h 316398 2017-04-02 10:50:49Z mav $ */ 2119418Sobrien/*- 3114902Sscottl * Copyright (c) 1997-2009 by Matthew Jacob 4114902Sscottl * All rights reserved. 5114902Sscottl * 6114902Sscottl * Redistribution and use in source and binary forms, with or without 7114902Sscottl * modification, are permitted provided that the following conditions 8114902Sscottl * are met: 9114902Sscottl * 10114902Sscottl * 1. Redistributions of source code must retain the above copyright 11114902Sscottl * notice, this list of conditions and the following disclaimer. 12114902Sscottl * 2. Redistributions in binary form must reproduce the above copyright 13114902Sscottl * notice, this list of conditions and the following disclaimer in the 14114902Sscottl * documentation and/or other materials provided with the distribution. 15114902Sscottl * 16114902Sscottl * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17114902Sscottl * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18114902Sscottl * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19114902Sscottl * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE 20114902Sscottl * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21114902Sscottl * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22114902Sscottl * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23114902Sscottl * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24114902Sscottl * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25114902Sscottl * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26114902Sscottl * SUCH DAMAGE. 27114902Sscottl * 28119418Sobrien */ 29119418Sobrien/* 30114902Sscottl * Soft Definitions for for Qlogic ISP SCSI adapters. 31152919Sscottl */ 32114902Sscottl 33114902Sscottl#ifndef _ISPVAR_H 34114902Sscottl#define _ISPVAR_H 35114902Sscottl 36114902Sscottl#if defined(__NetBSD__) || defined(__OpenBSD__) 37114902Sscottl#include <dev/ic/isp_stds.h> 38114902Sscottl#include <dev/ic/ispmbox.h> 39114902Sscottl#endif 40114902Sscottl#ifdef __FreeBSD__ 41114902Sscottl#include <dev/isp/isp_stds.h> 42114902Sscottl#include <dev/isp/ispmbox.h> 43114902Sscottl#endif 44114902Sscottl#ifdef __linux__ 45140923Sscottl#include "isp_stds.h" 46114902Sscottl#include "ispmbox.h" 47114902Sscottl#endif 48114902Sscottl#ifdef __svr4__ 49114902Sscottl#include "isp_stds.h" 50114902Sscottl#include "ispmbox.h" 51114902Sscottl#endif 52114902Sscottl 53114902Sscottl#define ISP_CORE_VERSION_MAJOR 7 54114902Sscottl#define ISP_CORE_VERSION_MINOR 0 55114902Sscottl 56114902Sscottl/* 57114902Sscottl * Vector for bus specific code to provide specific services. 58114902Sscottl */ 59114902Sscottltypedef struct ispsoftc ispsoftc_t; 60114902Sscottlstruct ispmdvec { 61114902Sscottl void (*dv_run_isr) (ispsoftc_t *); 62114902Sscottl uint32_t (*dv_rd_reg) (ispsoftc_t *, int); 63150535Sscottl void (*dv_wr_reg) (ispsoftc_t *, int, uint32_t); 64114902Sscottl int (*dv_mbxdma) (ispsoftc_t *); 65114902Sscottl int (*dv_dmaset) (ispsoftc_t *, XS_T *, void *); 66150611Sglebius void (*dv_dmaclr) (ispsoftc_t *, XS_T *, uint32_t); 67114902Sscottl int (*dv_irqsetup) (ispsoftc_t *); 68114902Sscottl void (*dv_dregs) (ispsoftc_t *, const char *); 69114902Sscottl const void * dv_ispfw; /* ptr to f/w */ 70114902Sscottl uint16_t dv_conf1; 71114902Sscottl uint16_t dv_clock; /* clock frequency */ 72114902Sscottl}; 73114902Sscottl 74114902Sscottl/* 75114902Sscottl * Overall parameters 76114902Sscottl */ 77114902Sscottl#define MAX_TARGETS 16 78114902Sscottl#ifndef MAX_FC_TARG 79114902Sscottl#define MAX_FC_TARG 1024 80114902Sscottl#endif 81114902Sscottl#define ISP_MAX_TARGETS(isp) (IS_FC(isp)? MAX_FC_TARG : MAX_TARGETS) 82114902Sscottl#define ISP_MAX_LUNS(isp) (isp)->isp_maxluns 83114902Sscottl#define ISP_MAX_IRQS 3 84114902Sscottl 85114902Sscottl/* 86114902Sscottl * Macros to access ISP registers through bus specific layers- 87114902Sscottl * mostly wrappers to vector through the mdvec structure. 88114902Sscottl */ 89114902Sscottl#define ISP_RUN_ISR(isp) \ 90114902Sscottl (*(isp)->isp_mdvec->dv_run_isr)(isp) 91114902Sscottl 92114902Sscottl#define ISP_READ(isp, reg) \ 93114902Sscottl (*(isp)->isp_mdvec->dv_rd_reg)((isp), (reg)) 94116931Speter 95114902Sscottl#define ISP_WRITE(isp, reg, val) \ 96114902Sscottl (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), (val)) 97114902Sscottl 98114902Sscottl#define ISP_MBOXDMASETUP(isp) \ 99114902Sscottl (*(isp)->isp_mdvec->dv_mbxdma)((isp)) 100114902Sscottl 101114902Sscottl#define ISP_DMASETUP(isp, xs, req) \ 102114902Sscottl (*(isp)->isp_mdvec->dv_dmaset)((isp), (xs), (req)) 103114902Sscottl 104114902Sscottl#define ISP_DMAFREE(isp, xs, hndl) \ 105114902Sscottl if ((isp)->isp_mdvec->dv_dmaclr) \ 106114902Sscottl (*(isp)->isp_mdvec->dv_dmaclr)((isp), (xs), (hndl)) 107114902Sscottl 108114902Sscottl#define ISP_IRQSETUP(isp) \ 109114902Sscottl (((isp)->isp_mdvec->dv_irqsetup) ? (*(isp)->isp_mdvec->dv_irqsetup)(isp) : 0) 110114902Sscottl#define ISP_DUMPREGS(isp, m) \ 111114902Sscottl if ((isp)->isp_mdvec->dv_dregs) (*(isp)->isp_mdvec->dv_dregs)((isp),(m)) 112114902Sscottl 113114902Sscottl#define ISP_SETBITS(isp, reg, val) \ 114114902Sscottl (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), ISP_READ((isp), (reg)) | (val)) 115114902Sscottl 116114902Sscottl#define ISP_CLRBITS(isp, reg, val) \ 117114902Sscottl (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), ISP_READ((isp), (reg)) & ~(val)) 118114902Sscottl 119114902Sscottl/* 120114902Sscottl * The MEMORYBARRIER macro is defined per platform (to provide synchronization 121114902Sscottl * on Request and Response Queues, Scratch DMA areas, and Registers) 122114902Sscottl * 123114902Sscottl * Defined Memory Barrier Synchronization Types 124114902Sscottl */ 125114902Sscottl#define SYNC_REQUEST 0 /* request queue synchronization */ 126114902Sscottl#define SYNC_RESULT 1 /* result queue synchronization */ 127114902Sscottl#define SYNC_SFORDEV 2 /* scratch, sync for ISP */ 128114902Sscottl#define SYNC_SFORCPU 3 /* scratch, sync for CPU */ 129114902Sscottl#define SYNC_REG 4 /* for registers */ 130114902Sscottl#define SYNC_ATIOQ 5 /* atio result queue (24xx) */ 131121211Sphk#define SYNC_IFORDEV 6 /* synchrounous IOCB, sync for ISP */ 132114902Sscottl#define SYNC_IFORCPU 7 /* synchrounous IOCB, sync for CPU */ 133121211Sphk 134114902Sscottl/* 135114902Sscottl * Request/Response Queue defines and macros. 136114902Sscottl * The maximum is defined per platform (and can be based on board type). 137114902Sscottl */ 138114902Sscottl/* This is the size of a queue entry (request and response) */ 139114902Sscottl#define QENTRY_LEN 64 140140923Sscottl/* Both request and result queue length must be a power of two */ 141114902Sscottl#define RQUEST_QUEUE_LEN(x) MAXISPREQUEST(x) 142114902Sscottl#ifdef ISP_TARGET_MODE 143140923Sscottl#define RESULT_QUEUE_LEN(x) MAXISPREQUEST(x) 144114902Sscottl#else 145114902Sscottl#define RESULT_QUEUE_LEN(x) \ 146114902Sscottl (((MAXISPREQUEST(x) >> 2) < 64)? 64 : MAXISPREQUEST(x) >> 2) 147114902Sscottl#endif 148114902Sscottl#define ISP_QUEUE_ENTRY(q, idx) (((uint8_t *)q) + ((idx) * QENTRY_LEN)) 149114902Sscottl#define ISP_QUEUE_SIZE(n) ((n) * QENTRY_LEN) 150114902Sscottl#define ISP_NXT_QENTRY(idx, qlen) (((idx) + 1) & ((qlen)-1)) 151126364Sscottl#define ISP_QFREE(in, out, qlen) \ 152114902Sscottl ((in == out)? (qlen - 1) : ((in > out)? \ 153126364Sscottl ((qlen - 1) - (in - out)) : (out - in - 1))) 154140923Sscottl#define ISP_QAVAIL(isp) \ 155126364Sscottl ISP_QFREE(isp->isp_reqidx, isp->isp_reqodx, RQUEST_QUEUE_LEN(isp)) 156126364Sscottl 157140923Sscottl#define ISP_ADD_REQUEST(isp, nxti) \ 158114902Sscottl MEMORYBARRIER(isp, SYNC_REQUEST, isp->isp_reqidx, QENTRY_LEN, -1); \ 159126364Sscottl ISP_WRITE(isp, isp->isp_rqstinrp, nxti); \ 160140923Sscottl isp->isp_reqidx = nxti 161126364Sscottl 162126364Sscottl#define ISP_SYNC_REQUEST(isp) \ 163126364Sscottl MEMORYBARRIER(isp, SYNC_REQUEST, isp->isp_reqidx, QENTRY_LEN, -1); \ 164140923Sscottl isp->isp_reqidx = ISP_NXT_QENTRY(isp->isp_reqidx, RQUEST_QUEUE_LEN(isp)); \ 165114902Sscottl ISP_WRITE(isp, isp->isp_rqstinrp, isp->isp_reqidx) 166114902Sscottl 167114902Sscottl/* 168114902Sscottl * SCSI Specific Host Adapter Parameters- per bus, per target 169114902Sscottl */ 170114902Sscottltypedef struct { 171114902Sscottl uint32_t : 8, 172114902Sscottl update : 1, 173114902Sscottl sendmarker : 1, 174114902Sscottl isp_req_ack_active_neg : 1, 175114902Sscottl isp_data_line_active_neg: 1, 176114902Sscottl isp_cmd_dma_burst_enable: 1, 177114902Sscottl isp_data_dma_burst_enabl: 1, 178114902Sscottl isp_fifo_threshold : 3, 179150535Sscottl isp_ptisp : 1, 180114902Sscottl isp_ultramode : 1, 181114902Sscottl isp_diffmode : 1, 182114902Sscottl isp_lvdmode : 1, 183114902Sscottl isp_fast_mttr : 1, /* fast sram */ 184114902Sscottl isp_initiator_id : 4, 185114902Sscottl isp_async_data_setup : 4; 186114902Sscottl uint16_t isp_selection_timeout; 187114902Sscottl uint16_t isp_max_queue_depth; 188114902Sscottl uint8_t isp_tag_aging; 189114902Sscottl uint8_t isp_bus_reset_delay; 190114902Sscottl uint8_t isp_retry_count; 191114902Sscottl uint8_t isp_retry_delay; 192114902Sscottl struct { 193150535Sscottl uint32_t 194150535Sscottl exc_throttle : 8, 195150535Sscottl : 1, 196150535Sscottl dev_enable : 1, /* ignored */ 197150535Sscottl dev_update : 1, 198150535Sscottl dev_refresh : 1, 199150535Sscottl actv_offset : 4, 200150535Sscottl goal_offset : 4, 201114902Sscottl nvrm_offset : 4; 202114902Sscottl uint8_t actv_period; /* current sync period */ 203114902Sscottl uint8_t goal_period; /* goal sync period */ 204114902Sscottl uint8_t nvrm_period; /* nvram sync period */ 205114902Sscottl uint16_t actv_flags; /* current device flags */ 206114902Sscottl uint16_t goal_flags; /* goal device flags */ 207114902Sscottl uint16_t nvrm_flags; /* nvram device flags */ 208114902Sscottl } isp_devparam[MAX_TARGETS]; 209114902Sscottl} sdparam; 210114902Sscottl 211114902Sscottl/* 212114902Sscottl * Device Flags 213114902Sscottl */ 214114902Sscottl#define DPARM_DISC 0x8000 215114902Sscottl#define DPARM_PARITY 0x4000 216114902Sscottl#define DPARM_WIDE 0x2000 217114902Sscottl#define DPARM_SYNC 0x1000 218114902Sscottl#define DPARM_TQING 0x0800 219114902Sscottl#define DPARM_ARQ 0x0400 220114902Sscottl#define DPARM_QFRZ 0x0200 221140923Sscottl#define DPARM_RENEG 0x0100 222140923Sscottl#define DPARM_NARROW 0x0080 223114902Sscottl#define DPARM_ASYNC 0x0040 224114902Sscottl#define DPARM_PPR 0x0020 225114902Sscottl#define DPARM_DEFAULT (0xFF00 & ~DPARM_QFRZ) 226114902Sscottl#define DPARM_SAFE_DFLT (DPARM_DEFAULT & ~(DPARM_WIDE|DPARM_SYNC|DPARM_TQING)) 227114902Sscottl 228114902Sscottl/* technically, not really correct, as they need to be rated based upon clock */ 229114902Sscottl#define ISP_80M_SYNCPARMS 0x0c09 230114902Sscottl#define ISP_40M_SYNCPARMS 0x0c0a 231114902Sscottl#define ISP_20M_SYNCPARMS 0x0c0c 232114902Sscottl#define ISP_20M_SYNCPARMS_1040 0x080c 233114902Sscottl#define ISP_10M_SYNCPARMS 0x0c19 234150535Sscottl#define ISP_08M_SYNCPARMS 0x0c25 235150535Sscottl#define ISP_05M_SYNCPARMS 0x0c32 236150535Sscottl#define ISP_04M_SYNCPARMS 0x0c41 237150535Sscottl 238114902Sscottl/* 239150535Sscottl * Fibre Channel Specifics 240150535Sscottl */ 241114902Sscottl/* These are for non-2K Login Firmware cards */ 242114902Sscottl#define FL_ID 0x7e /* FL_Port Special ID */ 243114902Sscottl#define SNS_ID 0x80 /* SNS Server Special ID */ 244114902Sscottl#define NPH_MAX 0xfe 245114902Sscottl 246114902Sscottl/* These are for 2K Login Firmware cards */ 247114902Sscottl#define NPH_RESERVED 0x7F0 /* begin of reserved N-port handles */ 248114902Sscottl#define NPH_MGT_ID 0x7FA /* Management Server Special ID */ 249114902Sscottl#define NPH_SNS_ID 0x7FC /* SNS Server Special ID */ 250114902Sscottl#define NPH_FABRIC_CTLR 0x7FD /* Fabric Controller (0xFFFFFD) */ 251114902Sscottl#define NPH_FL_ID 0x7FE /* F Port Special ID (0xFFFFFE) */ 252114902Sscottl#define NPH_IP_BCST 0x7FF /* IP Broadcast Special ID (0xFFFFFF) */ 253140923Sscottl#define NPH_MAX_2K 0x800 254114902Sscottl 255140923Sscottl/* 256140923Sscottl * "Unassigned" handle to be used internally 257114902Sscottl */ 258114902Sscottl#define NIL_HANDLE 0xffff 259114902Sscottl 260140923Sscottl/* 261150535Sscottl * Limit for devices on an arbitrated loop. 262114902Sscottl */ 263114902Sscottl#define LOCAL_LOOP_LIM 126 264114902Sscottl 265114902Sscottl/* 266114902Sscottl * Limit for (2K login) N-port handle amounts 267114902Sscottl */ 268114902Sscottl#define MAX_NPORT_HANDLE 2048 269114902Sscottl 270114902Sscottl/* 271114902Sscottl * Special Constants 272114902Sscottl */ 273114902Sscottl#define INI_NONE ((uint64_t) 0) 274114902Sscottl#define ISP_NOCHAN 0xff 275114902Sscottl 276150535Sscottl/* 277150535Sscottl * Special Port IDs 278114902Sscottl */ 279114902Sscottl#define MANAGEMENT_PORT_ID 0xFFFFFA 280150535Sscottl#define SNS_PORT_ID 0xFFFFFC 281114902Sscottl#define FABRIC_PORT_ID 0xFFFFFE 282114902Sscottl#define PORT_ANY 0xFFFFFF 283114902Sscottl#define PORT_NONE 0 284114902Sscottl#define VALID_PORT(port) (port != PORT_NONE && port != PORT_ANY) 285114902Sscottl#define DOMAIN_CONTROLLER_BASE 0xFFFC00 286114902Sscottl#define DOMAIN_CONTROLLER_END 0xFFFCFF 287114902Sscottl 288114902Sscottl/* 289114902Sscottl * Command Handles 290114902Sscottl * 291114902Sscottl * Most QLogic initiator or target have 32 bit handles associated with them. 292114902Sscottl * We want to have a quick way to index back and forth between a local SCSI 293114902Sscottl * command context and what the firmware is passing back to us. We also 294150535Sscottl * want to avoid working on stale information. This structure handles both 295150535Sscottl * at the expense of some local memory. 296150535Sscottl * 297150535Sscottl * The handle is architected thusly: 298150535Sscottl * 299150535Sscottl * 0 means "free handle" 300150535Sscottl * bits 0..12 index commands 301150535Sscottl * bits 13..15 bits index usage 302150535Sscottl * bits 16..31 contain a rolling sequence 303150535Sscottl * 304150535Sscottl * 305114902Sscottl */ 306114902Sscottltypedef struct { 307114902Sscottl void * cmd; /* associated command context */ 308114902Sscottl uint32_t handle; /* handle associated with this command */ 309114902Sscottl} isp_hdl_t; 310114902Sscottl#define ISP_HANDLE_FREE 0x00000000 311114902Sscottl#define ISP_HANDLE_CMD_MASK 0x00001fff 312114902Sscottl#define ISP_HANDLE_USAGE_MASK 0x0000e000 313114902Sscottl#define ISP_HANDLE_USAGE_SHIFT 13 314114902Sscottl#define ISP_H2HT(hdl) ((hdl & ISP_HANDLE_USAGE_MASK) >> ISP_HANDLE_USAGE_SHIFT) 315114902Sscottl# define ISP_HANDLE_NONE 0 316114902Sscottl# define ISP_HANDLE_INITIATOR 1 317114902Sscottl# define ISP_HANDLE_TARGET 2 318114902Sscottl# define ISP_HANDLE_CTRL 3 319114902Sscottl#define ISP_HANDLE_SEQ_MASK 0xffff0000 320114902Sscottl#define ISP_HANDLE_SEQ_SHIFT 16 321114902Sscottl#define ISP_H2SEQ(hdl) ((hdl & ISP_HANDLE_SEQ_MASK) >> ISP_HANDLE_SEQ_SHIFT) 322114902Sscottl#define ISP_VALID_HANDLE(c, hdl) \ 323140923Sscottl ((ISP_H2HT(hdl) == ISP_HANDLE_INITIATOR || \ 324140923Sscottl ISP_H2HT(hdl) == ISP_HANDLE_TARGET || \ 325114902Sscottl ISP_H2HT(hdl) == ISP_HANDLE_CTRL) && \ 326114902Sscottl ((hdl) & ISP_HANDLE_CMD_MASK) < (c)->isp_maxcmds && \ 327114902Sscottl (hdl) == ((c)->isp_xflist[(hdl) & ISP_HANDLE_CMD_MASK].handle)) 328114902Sscottl#define ISP_BAD_HANDLE_INDEX 0xffffffff 329114902Sscottl 330114902Sscottl 331114902Sscottl/* 332114902Sscottl * FC Port Database entry. 333114902Sscottl * 334114902Sscottl * It has a handle that the f/w uses to address commands to a device. 335114902Sscottl * This handle's value may be assigned by the firmware (e.g., for local loop 336150535Sscottl * devices) or by the driver (e.g., for fabric devices). 337150535Sscottl * 338150535Sscottl * It has a state. If the state if VALID, that means that we've logged into 339150535Sscottl * the device. 340150535Sscottl * 341150535Sscottl * Local loop devices the firmware automatically performs PLOGI on for us 342114902Sscottl * (which is why that handle is imposed upon us). Fabric devices we assign 343114902Sscottl * a handle to and perform the PLOGI on. 344114902Sscottl * 345114902Sscottl * When a PORT DATABASE CHANGED asynchronous event occurs, we mark all VALID 346114902Sscottl * entries as PROBATIONAL. This allows us, if policy says to, just keep track 347114902Sscottl * of devices whose handles change but are otherwise the same device (and 348114902Sscottl * thus keep 'target' constant). 349114902Sscottl * 350114902Sscottl * In any case, we search all possible local loop handles. For each one that 351114902Sscottl * has a port database entity returned, we search for any PROBATIONAL entry 352114902Sscottl * that matches it and update as appropriate. Otherwise, as a new entry, we 353114902Sscottl * find room for it in the Port Database. We *try* and use the handle as the 354114902Sscottl * index to put it into the Database, but that's just an optimization. We mark 355140923Sscottl * the entry VALID and make sure that the target index is updated and correct. 356140923Sscottl * 357140923Sscottl * When we get done searching the local loop, we then search similarly for 358114902Sscottl * a list of devices we've gotten from the fabric name controller (if we're 359114902Sscottl * on a fabric). VALID marking is also done similarly. 360114902Sscottl * 361140923Sscottl * When all of this is done, we can march through the database and clean up 362150535Sscottl * any entry that is still PROBATIONAL (these represent devices which have 363114902Sscottl * departed). Then we're done and can resume normal operations. 364114902Sscottl * 365114902Sscottl * Negative invariants that we try and test for are: 366114902Sscottl * 367114902Sscottl * + There can never be two non-NIL entries with the same { Port, Node } WWN 368114902Sscottl * duples. 369114902Sscottl * 370114902Sscottl * + There can never be two non-NIL entries with the same handle. 371114902Sscottl */ 372114902Sscottltypedef struct { 373114902Sscottl /* 374114902Sscottl * This is the handle that the firmware needs in order for us to 375114902Sscottl * send commands to the device. For pre-24XX cards, this would be 376114902Sscottl * the 'loopid'. 377114902Sscottl */ 378114902Sscottl uint16_t handle; 379114902Sscottl 380114902Sscottl /* 381114902Sscottl * PRLI word 3 parameters contains role as well as other things. 382114902Sscottl * 383150535Sscottl * The state is the current state of this entry. 384140923Sscottl * 385114902Sscottl * The is_target is the current state of target on this port. 386114902Sscottl * 387114902Sscottl * The is_initiator is the current state of initiator on this port. 388114902Sscottl * 389114902Sscottl * Portid is obvious, as are node && port WWNs. The new_role and 390114902Sscottl * new_portid is for when we are pending a change. 391140923Sscottl */ 392140923Sscottl uint16_t prli_word3; /* PRLI parameters */ 393114902Sscottl uint16_t new_prli_word3; /* Incoming new PRLI parameters */ 394140923Sscottl uint16_t : 12, 395114902Sscottl probational : 1, 396114902Sscottl state : 3; 397140923Sscottl uint32_t : 6, 398150535Sscottl is_target : 1, 399114902Sscottl is_initiator : 1, 400114902Sscottl portid : 24; 401114902Sscottl uint32_t 402114902Sscottl : 8, 403114902Sscottl new_portid : 24; 404122999Smbr uint64_t node_wwn; 405122999Smbr uint64_t port_wwn; 406122999Smbr uint32_t gone_timer; 407122999Smbr} fcportdb_t; 408122999Smbr 409122999Smbr#define FC_PORTDB_STATE_NIL 0 /* Empty DB slot */ 410122999Smbr#define FC_PORTDB_STATE_DEAD 1 /* Was valid, but no more. */ 411122999Smbr#define FC_PORTDB_STATE_CHANGED 2 /* Was valid, but changed. */ 412122999Smbr#define FC_PORTDB_STATE_NEW 3 /* Logged in, not announced. */ 413122999Smbr#define FC_PORTDB_STATE_ZOMBIE 4 /* Invalid, but announced. */ 414122999Smbr#define FC_PORTDB_STATE_VALID 5 /* Valid */ 415122999Smbr 416122999Smbr#define FC_PORTDB_TGT(isp, bus, pdb) (int)(lp - FCPARAM(isp, bus)->portdb) 417122999Smbr 418122999Smbr/* 419122999Smbr * FC card specific information 420122999Smbr * 421122999Smbr * This structure is replicated across multiple channels for multi-id 422122999Smbr * capapble chipsets, with some entities different on a per-channel basis. 423122999Smbr */ 424122999Smbr 425122999Smbrtypedef struct { 426122999Smbr int isp_gbspeed; /* Connection speed */ 427122999Smbr int isp_linkstate; /* Link state */ 428122999Smbr int isp_fwstate; /* ISP F/W state */ 429122999Smbr int isp_loopstate; /* Loop State */ 430122999Smbr int isp_topo; /* Connection Type */ 431122999Smbr 432122999Smbr uint32_t : 4, 433122999Smbr fctape_enabled : 1, 434122999Smbr sendmarker : 1, 435122999Smbr role : 2, 436122999Smbr isp_portid : 24; /* S_ID */ 437122999Smbr 438122999Smbr uint16_t isp_fwoptions; 439122999Smbr uint16_t isp_xfwoptions; 440122999Smbr uint16_t isp_zfwoptions; 441122999Smbr uint16_t isp_loopid; /* hard loop id */ 442122999Smbr uint16_t isp_sns_hdl; /* N-port handle for SNS */ 443122999Smbr uint16_t isp_lasthdl; /* only valid for channel 0 */ 444122999Smbr uint16_t isp_maxalloc; 445122999Smbr uint16_t isp_fabric_params; 446122999Smbr uint16_t isp_login_hdl; /* Logging in handle */ 447122999Smbr uint8_t isp_retry_delay; 448122999Smbr uint8_t isp_retry_count; 449122999Smbr 450122999Smbr /* 451122999Smbr * Current active WWNN/WWPN 452122999Smbr */ 453122999Smbr uint64_t isp_wwnn; 454122999Smbr uint64_t isp_wwpn; 455122999Smbr 456122999Smbr /* 457122999Smbr * NVRAM WWNN/WWPN 458124040Smbr */ 459122999Smbr uint64_t isp_wwnn_nvram; 460122999Smbr uint64_t isp_wwpn_nvram; 461122999Smbr 462122999Smbr /* 463122999Smbr * Our Port Data Base 464150535Sscottl */ 465140923Sscottl fcportdb_t portdb[MAX_FC_TARG]; 466122999Smbr 467122999Smbr /* 468122999Smbr * Scratch DMA mapped in area to fetch Port Database stuff, etc. 469122999Smbr */ 470122999Smbr void * isp_scratch; 471122999Smbr XS_DMA_ADDR_T isp_scdma; 472140923Sscottl 473140923Sscottl uint8_t isp_scanscratch[ISP_FC_SCRLEN]; 474140923Sscottl} fcparam; 475122999Smbr 476122999Smbr#define FW_CONFIG_WAIT 0 477140923Sscottl#define FW_WAIT_LINK 1 478150535Sscottl#define FW_WAIT_LOGIN 2 479122999Smbr#define FW_READY 3 480122999Smbr#define FW_LOSS_OF_SYNC 4 481122999Smbr#define FW_ERROR 5 482122999Smbr#define FW_REINIT 6 483122999Smbr#define FW_NON_PART 7 484114902Sscottl 485114902Sscottl#define LOOP_NIL 0 486114902Sscottl#define LOOP_HAVE_LINK 1 487114902Sscottl#define LOOP_HAVE_ADDR 2 488114902Sscottl#define LOOP_TESTING_LINK 3 489114902Sscottl#define LOOP_LTEST_DONE 4 490114902Sscottl#define LOOP_SCANNING_LOOP 5 491114902Sscottl#define LOOP_LSCAN_DONE 6 492114902Sscottl#define LOOP_SCANNING_FABRIC 7 493114902Sscottl#define LOOP_FSCAN_DONE 8 494114902Sscottl#define LOOP_SYNCING_PDB 9 495114902Sscottl#define LOOP_READY 10 496114902Sscottl 497114902Sscottl#define TOPO_NL_PORT 0 498114902Sscottl#define TOPO_FL_PORT 1 499122999Smbr#define TOPO_N_PORT 2 500122999Smbr#define TOPO_F_PORT 3 501122999Smbr#define TOPO_PTP_STUB 4 502114902Sscottl 503114902Sscottl#define TOPO_IS_FABRIC(x) ((x) == TOPO_FL_PORT || (x) == TOPO_F_PORT) 504114902Sscottl 505114902Sscottl/* 506114902Sscottl * Soft Structure per host adapter 507114902Sscottl */ 508114902Sscottlstruct ispsoftc { 509114902Sscottl /* 510114902Sscottl * Platform (OS) specific data 511114902Sscottl */ 512114902Sscottl struct isposinfo isp_osinfo; 513114902Sscottl 514114902Sscottl /* 515114902Sscottl * Pointer to bus specific functions and data 516114902Sscottl */ 517150535Sscottl struct ispmdvec * isp_mdvec; 518114902Sscottl 519114902Sscottl /* 520114902Sscottl * (Mostly) nonvolatile state. Board specific parameters 521114902Sscottl * may contain some volatile state (e.g., current loop state). 522114902Sscottl */ 523114902Sscottl 524114902Sscottl void * isp_param; /* type specific */ 525114902Sscottl uint64_t isp_fwattr; /* firmware attributes */ 526114902Sscottl uint16_t isp_fwrev[3]; /* Loaded F/W revision */ 527114902Sscottl uint16_t isp_maxcmds; /* max possible I/O cmds */ 528114902Sscottl uint8_t isp_type; /* HBA Chip Type */ 529114902Sscottl uint8_t isp_revision; /* HBA Chip H/W Revision */ 530114902Sscottl uint8_t isp_nirq; /* number of IRQs */ 531114902Sscottl uint16_t isp_nchan; /* number of channels */ 532114902Sscottl uint32_t isp_maxluns; /* maximum luns supported */ 533150535Sscottl 534150535Sscottl uint32_t isp_clock : 8, /* input clock */ 535150535Sscottl : 4, 536150535Sscottl isp_port : 1, /* 23XX/24XX only */ 537150535Sscottl isp_open : 1, /* opened (ioctl) */ 538150535Sscottl isp_bustype : 1, /* SBus or PCI */ 539114902Sscottl isp_loaded_fw : 1, /* loaded firmware */ 540114902Sscottl isp_dblev : 16; /* debug log mask */ 541140923Sscottl 542140923Sscottl 543114902Sscottl uint32_t isp_confopts; /* config options */ 544114902Sscottl 545114902Sscottl uint32_t isp_rqstinrp; /* register for REQINP */ 546114902Sscottl uint32_t isp_rqstoutrp; /* register for REQOUTP */ 547114902Sscottl uint32_t isp_respinrp; /* register for RESINP */ 548114902Sscottl uint32_t isp_respoutrp; /* register for RESOUTP */ 549114902Sscottl 550114902Sscottl /* 551114902Sscottl * Volatile state 552114902Sscottl */ 553114902Sscottl 554114902Sscottl volatile u_int isp_mboxbsy; /* mailbox command active */ 555114902Sscottl volatile u_int isp_state; 556114902Sscottl volatile u_int isp_nactive; /* how many commands active */ 557140923Sscottl volatile mbreg_t isp_curmbx; /* currently active mailbox command */ 558140923Sscottl volatile uint32_t isp_reqodx; /* index of last ISP pickup */ 559114902Sscottl volatile uint32_t isp_reqidx; /* index of next request */ 560114902Sscottl volatile uint32_t isp_residx; /* index of last ISP write */ 561114902Sscottl volatile uint32_t isp_resodx; /* index of next result */ 562114902Sscottl volatile uint32_t isp_atioodx; /* index of next ATIO */ 563114902Sscottl volatile uint32_t isp_obits; /* mailbox command output */ 564114902Sscottl volatile uint32_t isp_serno; /* rolling serial number */ 565114902Sscottl volatile uint16_t isp_mboxtmp[MAX_MAILBOX]; 566114902Sscottl volatile uint16_t isp_lastmbxcmd; /* last mbox command sent */ 567114902Sscottl volatile uint16_t isp_seqno; /* running sequence number */ 568114902Sscottl 569114902Sscottl /* 570150535Sscottl * Active commands are stored here, indexed by handle functions. 571150535Sscottl */ 572150535Sscottl isp_hdl_t *isp_xflist; 573150535Sscottl isp_hdl_t *isp_xffree; 574150535Sscottl 575150535Sscottl /* 576114902Sscottl * DMA mapped in area for synchronous IOCB requests. 577114902Sscottl */ 578114902Sscottl void * isp_iocb; 579114902Sscottl XS_DMA_ADDR_T isp_iocb_dma; 580114902Sscottl 581114902Sscottl /* 582114902Sscottl * request/result queue pointers and DMA handles for them. 583114902Sscottl */ 584114902Sscottl void * isp_rquest; 585114902Sscottl void * isp_result; 586114902Sscottl XS_DMA_ADDR_T isp_rquest_dma; 587140923Sscottl XS_DMA_ADDR_T isp_result_dma; 588140923Sscottl#ifdef ISP_TARGET_MODE 589140923Sscottl /* for 24XX only */ 590114902Sscottl void * isp_atioq; 591114902Sscottl XS_DMA_ADDR_T isp_atioq_dma; 592114902Sscottl#endif 593140923Sscottl}; 594150535Sscottl 595114902Sscottl#define SDPARAM(isp, chan) (&((sdparam *)(isp)->isp_param)[(chan)]) 596114902Sscottl#define FCPARAM(isp, chan) (&((fcparam *)(isp)->isp_param)[(chan)]) 597114902Sscottl 598114902Sscottl#define ISP_SET_SENDMARKER(isp, chan, val) \ 599114902Sscottl if (IS_FC(isp)) { \ 600114902Sscottl FCPARAM(isp, chan)->sendmarker = val; \ 601114902Sscottl } else { \ 602114902Sscottl SDPARAM(isp, chan)->sendmarker = val; \ 603114902Sscottl } 604114902Sscottl 605114902Sscottl#define ISP_TST_SENDMARKER(isp, chan) \ 606114902Sscottl (IS_FC(isp)? \ 607114902Sscottl FCPARAM(isp, chan)->sendmarker != 0 : \ 608114902Sscottl SDPARAM(isp, chan)->sendmarker != 0) 609114902Sscottl 610114902Sscottl/* 611114902Sscottl * ISP Driver Run States 612114902Sscottl */ 613114902Sscottl#define ISP_NILSTATE 0 614114902Sscottl#define ISP_CRASHED 1 615114902Sscottl#define ISP_RESETSTATE 2 616114902Sscottl#define ISP_INITSTATE 3 617150535Sscottl#define ISP_RUNSTATE 4 618140923Sscottl 619114902Sscottl/* 620114902Sscottl * ISP Runtime Configuration Options 621114902Sscottl */ 622114902Sscottl#define ISP_CFG_FULL_DUPLEX 0x01 /* Full Duplex (Fibre Channel only) */ 623114902Sscottl#define ISP_CFG_PORT_PREF 0x0e /* Mask for Port Prefs (all FC except 2100) */ 624114902Sscottl#define ISP_CFG_PORT_DEF 0x00 /* prefer connection type from NVRAM */ 625114902Sscottl#define ISP_CFG_LPORT_ONLY 0x02 /* insist on {N/F}L-Port connection */ 626114902Sscottl#define ISP_CFG_NPORT_ONLY 0x04 /* insist on {N/F}-Port connection */ 627114902Sscottl#define ISP_CFG_LPORT 0x06 /* prefer {N/F}L-Port connection */ 628114902Sscottl#define ISP_CFG_NPORT 0x08 /* prefer {N/F}-Port connection */ 629114902Sscottl#define ISP_CFG_1GB 0x10 /* force 1GB connection (23XX only) */ 630114902Sscottl#define ISP_CFG_2GB 0x20 /* force 2GB connection (23XX only) */ 631114902Sscottl#define ISP_CFG_NORELOAD 0x80 /* don't download f/w */ 632114902Sscottl#define ISP_CFG_NONVRAM 0x40 /* ignore NVRAM */ 633114902Sscottl#define ISP_CFG_NOFCTAPE 0x100 /* disable FC-Tape */ 634114902Sscottl#define ISP_CFG_FCTAPE 0x200 /* enable FC-Tape */ 635114902Sscottl#define ISP_CFG_OWNFSZ 0x400 /* override NVRAM frame size */ 636114902Sscottl#define ISP_CFG_OWNLOOPID 0x800 /* override NVRAM loopid */ 637150535Sscottl#define ISP_CFG_OWNEXCTHROTTLE 0x1000 /* override NVRAM execution throttle */ 638140923Sscottl#define ISP_CFG_4GB 0x2000 /* force 4GB connection (24XX only) */ 639114902Sscottl#define ISP_CFG_8GB 0x4000 /* force 8GB connection (25XX only) */ 640114902Sscottl#define ISP_CFG_16GB 0x8000 /* force 16GB connection (82XX only) */ 641114902Sscottl 642114902Sscottl/* 643114902Sscottl * For each channel, the outer layers should know what role that channel 644114902Sscottl * will take: ISP_ROLE_NONE, ISP_ROLE_INITIATOR, ISP_ROLE_TARGET, 645114902Sscottl * ISP_ROLE_BOTH. 646140923Sscottl * 647140923Sscottl * If you set ISP_ROLE_NONE, the cards will be reset, new firmware loaded, 648114902Sscottl * NVRAM read, and defaults set, but any further initialization (e.g. 649140923Sscottl * INITIALIZE CONTROL BLOCK commands for 2X00 cards) won't be done. 650114902Sscottl * 651114902Sscottl * If INITIATOR MODE isn't set, attempts to run commands will be stopped 652114902Sscottl * at isp_start and completed with the equivalent of SELECTION TIMEOUT. 653140923Sscottl * 654150535Sscottl * If TARGET MODE is set, it doesn't mean that the rest of target mode support 655114902Sscottl * needs to be enabled, or will even work. What happens with the 2X00 cards 656114902Sscottl * here is that if you have enabled it with TARGET MODE as part of the ICB 657114902Sscottl * options, but you haven't given the f/w any ram resources for ATIOs or 658114902Sscottl * Immediate Notifies, the f/w just handles what it can and you never see 659114902Sscottl * anything. Basically, it sends a single byte of data (the first byte, 660140923Sscottl * which you can set as part of the INITIALIZE CONTROL BLOCK command) for 661114902Sscottl * INQUIRY, and sends back QUEUE FULL status for any other command. 662114902Sscottl * 663114902Sscottl */ 664140923Sscottl#define ISP_ROLE_NONE 0x0 665150535Sscottl#define ISP_ROLE_TARGET 0x1 666114902Sscottl#define ISP_ROLE_INITIATOR 0x2 667114902Sscottl#define ISP_ROLE_BOTH (ISP_ROLE_TARGET|ISP_ROLE_INITIATOR) 668114902Sscottl#define ISP_ROLE_EITHER ISP_ROLE_BOTH 669114902Sscottl#ifndef ISP_DEFAULT_ROLES 670114902Sscottl/* 671114902Sscottl * Counterintuitively, we prefer to default to role 'none' 672 * if we are enable target mode support. This gives us the 673 * maximum flexibility as to which port will do what. 674 */ 675#ifdef ISP_TARGET_MODE 676#define ISP_DEFAULT_ROLES ISP_ROLE_NONE 677#else 678#define ISP_DEFAULT_ROLES ISP_ROLE_INITIATOR 679#endif 680#endif 681 682 683/* 684 * Firmware related defines 685 */ 686#define ISP_CODE_ORG 0x1000 /* default f/w code start */ 687#define ISP_CODE_ORG_2300 0x0800 /* ..except for 2300s */ 688#define ISP_CODE_ORG_2400 0x100000 /* ..and 2400s */ 689#define ISP_FW_REV(maj, min, mic) ((maj << 24) | (min << 16) | mic) 690#define ISP_FW_MAJOR(code) ((code >> 24) & 0xff) 691#define ISP_FW_MINOR(code) ((code >> 16) & 0xff) 692#define ISP_FW_MICRO(code) ((code >> 8) & 0xff) 693#define ISP_FW_REVX(xp) ((xp[0]<<24) | (xp[1] << 16) | xp[2]) 694#define ISP_FW_MAJORX(xp) (xp[0]) 695#define ISP_FW_MINORX(xp) (xp[1]) 696#define ISP_FW_MICROX(xp) (xp[2]) 697#define ISP_FW_NEWER_THAN(i, major, minor, micro) \ 698 (ISP_FW_REVX((i)->isp_fwrev) > ISP_FW_REV(major, minor, micro)) 699#define ISP_FW_OLDER_THAN(i, major, minor, micro) \ 700 (ISP_FW_REVX((i)->isp_fwrev) < ISP_FW_REV(major, minor, micro)) 701 702/* 703 * Bus (implementation) types 704 */ 705#define ISP_BT_PCI 0 /* PCI Implementations */ 706#define ISP_BT_SBUS 1 /* SBus Implementations */ 707 708/* 709 * If we have not otherwise defined SBus support away make sure 710 * it is defined here such that the code is included as default 711 */ 712#ifndef ISP_SBUS_SUPPORTED 713#define ISP_SBUS_SUPPORTED 1 714#endif 715 716/* 717 * Chip Types 718 */ 719#define ISP_HA_SCSI 0xf 720#define ISP_HA_SCSI_UNKNOWN 0x1 721#define ISP_HA_SCSI_1020 0x2 722#define ISP_HA_SCSI_1020A 0x3 723#define ISP_HA_SCSI_1040 0x4 724#define ISP_HA_SCSI_1040A 0x5 725#define ISP_HA_SCSI_1040B 0x6 726#define ISP_HA_SCSI_1040C 0x7 727#define ISP_HA_SCSI_1240 0x8 728#define ISP_HA_SCSI_1080 0x9 729#define ISP_HA_SCSI_1280 0xa 730#define ISP_HA_SCSI_10160 0xb 731#define ISP_HA_SCSI_12160 0xc 732#define ISP_HA_FC 0xf0 733#define ISP_HA_FC_2100 0x10 734#define ISP_HA_FC_2200 0x20 735#define ISP_HA_FC_2300 0x30 736#define ISP_HA_FC_2312 0x40 737#define ISP_HA_FC_2322 0x50 738#define ISP_HA_FC_2400 0x60 739#define ISP_HA_FC_2500 0x70 740#define ISP_HA_FC_2600 0x80 741 742#define IS_SCSI(isp) (isp->isp_type & ISP_HA_SCSI) 743#define IS_1020(isp) (isp->isp_type < ISP_HA_SCSI_1240) 744#define IS_1240(isp) (isp->isp_type == ISP_HA_SCSI_1240) 745#define IS_1080(isp) (isp->isp_type == ISP_HA_SCSI_1080) 746#define IS_1280(isp) (isp->isp_type == ISP_HA_SCSI_1280) 747#define IS_10160(isp) (isp->isp_type == ISP_HA_SCSI_10160) 748#define IS_12160(isp) (isp->isp_type == ISP_HA_SCSI_12160) 749 750#define IS_12X0(isp) (IS_1240(isp) || IS_1280(isp)) 751#define IS_1X160(isp) (IS_10160(isp) || IS_12160(isp)) 752#define IS_DUALBUS(isp) (IS_12X0(isp) || IS_12160(isp)) 753#define IS_ULTRA2(isp) (IS_1080(isp) || IS_1280(isp) || IS_1X160(isp)) 754#define IS_ULTRA3(isp) (IS_1X160(isp)) 755 756#define IS_FC(isp) ((isp)->isp_type & ISP_HA_FC) 757#define IS_2100(isp) ((isp)->isp_type == ISP_HA_FC_2100) 758#define IS_2200(isp) ((isp)->isp_type == ISP_HA_FC_2200) 759#define IS_23XX(isp) ((isp)->isp_type >= ISP_HA_FC_2300 && \ 760 (isp)->isp_type < ISP_HA_FC_2400) 761#define IS_2300(isp) ((isp)->isp_type == ISP_HA_FC_2300) 762#define IS_2312(isp) ((isp)->isp_type == ISP_HA_FC_2312) 763#define IS_2322(isp) ((isp)->isp_type == ISP_HA_FC_2322) 764#define IS_24XX(isp) ((isp)->isp_type >= ISP_HA_FC_2400) 765#define IS_25XX(isp) ((isp)->isp_type >= ISP_HA_FC_2500) 766#define IS_26XX(isp) ((isp)->isp_type >= ISP_HA_FC_2600) 767 768/* 769 * DMA related macros 770 */ 771#define DMA_WD3(x) (((uint16_t)(((uint64_t)x) >> 48)) & 0xffff) 772#define DMA_WD2(x) (((uint16_t)(((uint64_t)x) >> 32)) & 0xffff) 773#define DMA_WD1(x) ((uint16_t)((x) >> 16) & 0xffff) 774#define DMA_WD0(x) ((uint16_t)((x) & 0xffff)) 775 776#define DMA_LO32(x) ((uint32_t) (x)) 777#define DMA_HI32(x) ((uint32_t)(((uint64_t)x) >> 32)) 778 779/* 780 * Core System Function Prototypes 781 */ 782 783/* 784 * Reset Hardware. Totally. Assumes that you'll follow this with a call to isp_init. 785 */ 786void isp_reset(ispsoftc_t *, int); 787 788/* 789 * Initialize Hardware to known state 790 */ 791void isp_init(ispsoftc_t *); 792 793/* 794 * Reset the ISP and call completion for any orphaned commands. 795 */ 796int isp_reinit(ispsoftc_t *, int); 797 798/* 799 * Shutdown hardware after use. 800 */ 801void isp_shutdown(ispsoftc_t *); 802 803/* 804 * Internal Interrupt Service Routine 805 */ 806#ifdef ISP_TARGET_MODE 807void isp_intr_atioq(ispsoftc_t *); 808#endif 809void isp_intr_async(ispsoftc_t *, uint16_t event); 810void isp_intr_mbox(ispsoftc_t *, uint16_t mbox0); 811void isp_intr_respq(ispsoftc_t *); 812 813 814/* 815 * Command Entry Point- Platform Dependent layers call into this 816 */ 817int isp_start(XS_T *); 818 819/* these values are what isp_start returns */ 820#define CMD_COMPLETE 101 /* command completed */ 821#define CMD_EAGAIN 102 /* busy- maybe retry later */ 822#define CMD_QUEUED 103 /* command has been queued for execution */ 823#define CMD_RQLATER 104 /* requeue this command later */ 824 825/* 826 * Command Completion Point- Core layers call out from this with completed cmds 827 */ 828void isp_done(XS_T *); 829 830/* 831 * Platform Dependent to External to Internal Control Function 832 * 833 * Assumes locks are held on entry. You should note that with many of 834 * these commands locks may be released while this function is called. 835 * 836 * ... ISPCTL_RESET_BUS, int channel); 837 * Reset BUS on this channel 838 * ... ISPCTL_RESET_DEV, int channel, int target); 839 * Reset Device on this channel at this target. 840 * ... ISPCTL_ABORT_CMD, XS_T *xs); 841 * Abort active transaction described by xs. 842 * ... IPCTL_UPDATE_PARAMS); 843 * Update any operating parameters (speed, etc.) 844 * ... ISPCTL_FCLINK_TEST, int channel); 845 * Test FC link status on this channel 846 * ... ISPCTL_SCAN_LOOP, int channel); 847 * Scan local loop on this channel 848 * ... ISPCTL_SCAN_FABRIC, int channel); 849 * Scan fabric on this channel 850 * ... ISPCTL_PDB_SYNC, int channel); 851 * Synchronize port database on this channel 852 * ... ISPCTL_SEND_LIP, int channel); 853 * Send a LIP on this channel 854 * ... ISPCTL_GET_NAMES, int channel, int np, uint64_t *wwnn, uint64_t *wwpn) 855 * Get a WWNN/WWPN for this N-port handle on this channel 856 * ... ISPCTL_RUN_MBOXCMD, mbreg_t *mbp) 857 * Run this mailbox command 858 * ... ISPCTL_GET_PDB, int channel, int nphandle, isp_pdb_t *pdb) 859 * Get PDB on this channel for this N-port handle 860 * ... ISPCTL_PLOGX, isp_plcmd_t *) 861 * Performa a port login/logout 862 * ... ISPCTL_CHANGE_ROLE, int channel, int role); 863 * Change role of specified channel 864 * 865 * ISPCTL_PDB_SYNC is somewhat misnamed. It actually is the final step, in 866 * order, of ISPCTL_FCLINK_TEST, ISPCTL_SCAN_LOOP, and ISPCTL_SCAN_FABRIC. 867 * The main purpose of ISPCTL_PDB_SYNC is to complete management of logging 868 * and logging out of fabric devices (if one is on a fabric) and then marking 869 * the 'loop state' as being ready to now be used for sending commands to 870 * devices. 871 */ 872typedef enum { 873 ISPCTL_RESET_BUS, 874 ISPCTL_RESET_DEV, 875 ISPCTL_ABORT_CMD, 876 ISPCTL_UPDATE_PARAMS, 877 ISPCTL_FCLINK_TEST, 878 ISPCTL_SCAN_FABRIC, 879 ISPCTL_SCAN_LOOP, 880 ISPCTL_PDB_SYNC, 881 ISPCTL_SEND_LIP, 882 ISPCTL_GET_NAMES, 883 ISPCTL_RUN_MBOXCMD, 884 ISPCTL_GET_PDB, 885 ISPCTL_PLOGX, 886 ISPCTL_CHANGE_ROLE 887} ispctl_t; 888int isp_control(ispsoftc_t *, ispctl_t, ...); 889 890/* 891 * Platform Dependent to Internal to External Control Function 892 */ 893 894typedef enum { 895 ISPASYNC_NEW_TGT_PARAMS, /* SPI New Target Parameters */ 896 ISPASYNC_BUS_RESET, /* All Bus Was Reset */ 897 ISPASYNC_LOOP_DOWN, /* FC Loop Down */ 898 ISPASYNC_LOOP_UP, /* FC Loop Up */ 899 ISPASYNC_LIP, /* FC LIP Received */ 900 ISPASYNC_LOOP_RESET, /* FC Loop Reset Received */ 901 ISPASYNC_CHANGE_NOTIFY, /* FC Change Notification */ 902 ISPASYNC_DEV_ARRIVED, /* FC Device Arrived */ 903 ISPASYNC_DEV_CHANGED, /* FC Device Changed */ 904 ISPASYNC_DEV_STAYED, /* FC Device Stayed */ 905 ISPASYNC_DEV_GONE, /* FC Device Departure */ 906 ISPASYNC_TARGET_NOTIFY, /* All target async notification */ 907 ISPASYNC_TARGET_NOTIFY_ACK, /* All target notify ack required */ 908 ISPASYNC_TARGET_ACTION, /* All target action requested */ 909 ISPASYNC_FW_CRASH, /* All Firmware has crashed */ 910 ISPASYNC_FW_RESTARTED /* All Firmware has been restarted */ 911} ispasync_t; 912void isp_async(ispsoftc_t *, ispasync_t, ...); 913 914#define ISPASYNC_CHANGE_PDB 0 915#define ISPASYNC_CHANGE_SNS 1 916#define ISPASYNC_CHANGE_OTHER 2 917 918/* 919 * Platform Independent Error Prinout 920 */ 921void isp_prt_endcmd(ispsoftc_t *, XS_T *); 922 923/* 924 * Platform Dependent Error and Debug Printout 925 * 926 * Two required functions for each platform must be provided: 927 * 928 * void isp_prt(ispsoftc_t *, int level, const char *, ...) 929 * void isp_xs_prt(ispsoftc_t *, XS_T *, int level, const char *, ...) 930 * 931 * but due to compiler differences on different platforms this won't be 932 * formally defined here. Instead, they go in each platform definition file. 933 */ 934 935#define ISP_LOGALL 0x0 /* log always */ 936#define ISP_LOGCONFIG 0x1 /* log configuration messages */ 937#define ISP_LOGINFO 0x2 /* log informational messages */ 938#define ISP_LOGWARN 0x4 /* log warning messages */ 939#define ISP_LOGERR 0x8 /* log error messages */ 940#define ISP_LOGDEBUG0 0x10 /* log simple debug messages */ 941#define ISP_LOGDEBUG1 0x20 /* log intermediate debug messages */ 942#define ISP_LOGDEBUG2 0x40 /* log most debug messages */ 943#define ISP_LOGDEBUG3 0x80 /* log high frequency debug messages */ 944#define ISP_LOG_SANCFG 0x100 /* log SAN configuration */ 945#define ISP_LOG_CWARN 0x200 /* log SCSI command "warnings" (e.g., check conditions) */ 946#define ISP_LOG_WARN1 0x400 /* log WARNS we might be interested at some time */ 947#define ISP_LOGTINFO 0x1000 /* log informational messages (target mode) */ 948#define ISP_LOGTDEBUG0 0x2000 /* log simple debug messages (target mode) */ 949#define ISP_LOGTDEBUG1 0x4000 /* log intermediate debug messages (target) */ 950#define ISP_LOGTDEBUG2 0x8000 /* log all debug messages (target) */ 951 952/* 953 * Each Platform provides it's own isposinfo substructure of the ispsoftc 954 * defined above. 955 * 956 * Each platform must also provide the following macros/defines: 957 * 958 * 959 * ISP_FC_SCRLEN FC scratch area DMA length 960 * 961 * ISP_MEMZERO(dst, src) platform zeroing function 962 * ISP_MEMCPY(dst, src, count) platform copying function 963 * ISP_SNPRINTF(buf, bufsize, fmt, ...) snprintf 964 * ISP_DELAY(usecs) microsecond spindelay function 965 * ISP_SLEEP(isp, usecs) microsecond sleep function 966 * 967 * ISP_INLINE ___inline or not- depending on how 968 * good your debugger is 969 * ISP_MIN shorthand for ((a) < (b))? (a) : (b) 970 * 971 * NANOTIME_T nanosecond time type 972 * 973 * GET_NANOTIME(NANOTIME_T *) get current nanotime. 974 * 975 * GET_NANOSEC(NANOTIME_T *) get uint64_t from NANOTIME_T 976 * 977 * NANOTIME_SUB(NANOTIME_T *, NANOTIME_T *) 978 * subtract two NANOTIME_T values 979 * 980 * MAXISPREQUEST(ispsoftc_t *) maximum request queue size 981 * for this particular board type 982 * 983 * MEMORYBARRIER(ispsoftc_t *, barrier_type, offset, size, chan) 984 * 985 * Function/Macro the provides memory synchronization on 986 * various objects so that the ISP's and the system's view 987 * of the same object is consistent. 988 * 989 * MBOX_ACQUIRE(ispsoftc_t *) acquire lock on mailbox regs 990 * MBOX_WAIT_COMPLETE(ispsoftc_t *, mbreg_t *) wait for cmd to be done 991 * MBOX_NOTIFY_COMPLETE(ispsoftc_t *) notification of mbox cmd donee 992 * MBOX_RELEASE(ispsoftc_t *) release lock on mailbox regs 993 * 994 * FC_SCRATCH_ACQUIRE(ispsoftc_t *, chan) acquire lock on FC scratch area 995 * return -1 if you cannot 996 * FC_SCRATCH_RELEASE(ispsoftc_t *, chan) acquire lock on FC scratch area 997 * 998 * FCP_NEXT_CRN(ispsoftc_t *, XS_T *, rslt, channel, target, lun) generate the next command reference number. XS_T * may be null. 999 * 1000 * SCSI_GOOD SCSI 'Good' Status 1001 * SCSI_CHECK SCSI 'Check Condition' Status 1002 * SCSI_BUSY SCSI 'Busy' Status 1003 * SCSI_QFULL SCSI 'Queue Full' Status 1004 * 1005 * XS_T Platform SCSI transaction type (i.e., command for HBA) 1006 * XS_DMA_ADDR_T Platform PCI DMA Address Type 1007 * XS_GET_DMA_SEG(..) Get 32 bit dma segment list value 1008 * XS_GET_DMA64_SEG(..) Get 64 bit dma segment list value 1009 * XS_ISP(xs) gets an instance out of an XS_T 1010 * XS_CHANNEL(xs) gets the channel (bus # for DUALBUS cards) "" 1011 * XS_TGT(xs) gets the target "" 1012 * XS_LUN(xs) gets the lun "" 1013 * XS_CDBP(xs) gets a pointer to the scsi CDB "" 1014 * XS_CDBLEN(xs) gets the CDB's length "" 1015 * XS_XFRLEN(xs) gets the associated data transfer length "" 1016 * XS_TIME(xs) gets the time (in milliseconds) for this command 1017 * XS_GET_RESID(xs) gets the current residual count 1018 * XS_GET_RESID(xs, resid) sets the current residual count 1019 * XS_STSP(xs) gets a pointer to the SCSI status byte "" 1020 * XS_SNSP(xs) gets a pointer to the associate sense data 1021 * XS_TOT_SNSLEN(xs) gets the total length of sense data storage 1022 * XS_CUR_SNSLEN(xs) gets the currently used length of sense data storage 1023 * XS_SNSKEY(xs) dereferences XS_SNSP to get the current stored Sense Key 1024 * XS_SNSASC(xs) dereferences XS_SNSP to get the current stored Additional Sense Code 1025 * XS_SNSASCQ(xs) dereferences XS_SNSP to get the current stored Additional Sense Code Qualifier 1026 * XS_TAG_P(xs) predicate of whether this command should be tagged 1027 * XS_TAG_TYPE(xs) which type of tag to use 1028 * XS_SETERR(xs) set error state 1029 * 1030 * HBA_NOERROR command has no erros 1031 * HBA_BOTCH hba botched something 1032 * HBA_CMDTIMEOUT command timed out 1033 * HBA_SELTIMEOUT selection timed out (also port logouts for FC) 1034 * HBA_TGTBSY target returned a BUSY status 1035 * HBA_BUSRESET bus reset destroyed command 1036 * HBA_ABORTED command was aborted (by request) 1037 * HBA_DATAOVR a data overrun was detected 1038 * HBA_ARQFAIL Automatic Request Sense failed 1039 * 1040 * XS_ERR(xs) return current error state 1041 * XS_NOERR(xs) there is no error currently set 1042 * XS_INITERR(xs) initialize error state 1043 * 1044 * XS_SAVE_SENSE(xs, sp, total_len, this_len) save sense data (total and current amount) 1045 * 1046 * XS_APPEND_SENSE(xs, sp, len) append more sense data 1047 * 1048 * XS_SENSE_VALID(xs) indicates whether sense is valid 1049 * 1050 * DEFAULT_FRAMESIZE(ispsoftc_t *) Default Frame Size 1051 * DEFAULT_EXEC_THROTTLE(ispsoftc_t *) Default Execution Throttle 1052 * 1053 * DEFAULT_ROLE(ispsoftc_t *, int) Get Default Role for a channel 1054 * DEFAULT_IID(ispsoftc_t *, int) Default SCSI initiator ID 1055 * DEFAULT_LOOPID(ispsoftc_t *, int) Default FC Loop ID 1056 * 1057 * These establish reasonable defaults for each platform. 1058 * These must be available independent of card NVRAM and are 1059 * to be used should NVRAM not be readable. 1060 * 1061 * DEFAULT_NODEWWN(ispsoftc_t *, chan) Default FC Node WWN to use 1062 * DEFAULT_PORTWWN(ispsoftc_t *, chan) Default FC Port WWN to use 1063 * 1064 * These defines are hooks to allow the setting of node and 1065 * port WWNs when NVRAM cannot be read or is to be overriden. 1066 * 1067 * ACTIVE_NODEWWN(ispsoftc_t *, chan) FC Node WWN to use 1068 * ACTIVE_PORTWWN(ispsoftc_t *, chan) FC Port WWN to use 1069 * 1070 * After NVRAM is read, these will be invoked to get the 1071 * node and port WWNs that will actually be used for this 1072 * channel. 1073 * 1074 * 1075 * ISP_IOXPUT_8(ispsoftc_t *, uint8_t srcval, uint8_t *dstptr) 1076 * ISP_IOXPUT_16(ispsoftc_t *, uint16_t srcval, uint16_t *dstptr) 1077 * ISP_IOXPUT_32(ispsoftc_t *, uint32_t srcval, uint32_t *dstptr) 1078 * 1079 * ISP_IOXGET_8(ispsoftc_t *, uint8_t *srcptr, uint8_t dstrval) 1080 * ISP_IOXGET_16(ispsoftc_t *, uint16_t *srcptr, uint16_t dstrval) 1081 * ISP_IOXGET_32(ispsoftc_t *, uint32_t *srcptr, uint32_t dstrval) 1082 * 1083 * ISP_SWIZZLE_NVRAM_WORD(ispsoftc_t *, uint16_t *) 1084 * ISP_SWIZZLE_NVRAM_LONG(ispsoftc_t *, uint32_t *) 1085 * ISP_SWAP16(ispsoftc_t *, uint16_t srcval) 1086 * ISP_SWAP32(ispsoftc_t *, uint32_t srcval) 1087 */ 1088 1089#ifdef ISP_TARGET_MODE 1090/* 1091 * The functions below are for the publicly available 1092 * target mode functions that are internal to the Qlogic driver. 1093 */ 1094 1095/* 1096 * This function handles new response queue entry appropriate for target mode. 1097 */ 1098int isp_target_notify(ispsoftc_t *, void *, uint32_t *); 1099 1100/* 1101 * This function externalizes the ability to acknowledge an Immediate Notify request. 1102 */ 1103int isp_notify_ack(ispsoftc_t *, void *); 1104 1105/* 1106 * This function externalized acknowledging (success/fail) an ABTS frame 1107 */ 1108int isp_acknak_abts(ispsoftc_t *, void *, int); 1109 1110/* 1111 * General request queue 'put' routine for target mode entries. 1112 */ 1113int isp_target_put_entry(ispsoftc_t *isp, void *); 1114 1115/* 1116 * General routine to put back an ATIO entry- 1117 * used for replenishing f/w resource counts. 1118 * The argument is a pointer to a source ATIO 1119 * or ATIO2. 1120 */ 1121int isp_target_put_atio(ispsoftc_t *, void *); 1122 1123/* 1124 * General routine to send a final CTIO for a command- used mostly for 1125 * local responses. 1126 */ 1127int isp_endcmd(ispsoftc_t *, ...); 1128#define ECMD_SVALID 0x100 1129#define ECMD_RVALID 0x200 1130#define ECMD_TERMINATE 0x400 1131 1132/* 1133 * Handle an asynchronous event 1134 */ 1135void isp_target_async(ispsoftc_t *, int, int); 1136#endif 1137#endif /* _ISPVAR_H */ 1138