ispvar.h revision 164272
150477Speter/* $FreeBSD: head/sys/dev/isp/ispvar.h 164272 2006-11-14 08:45:48Z mjacob $ */ 2139749Simp/*- 335388Smjacob * Soft Definitions for for Qlogic ISP SCSI adapters. 435388Smjacob * 5154704Smjacob * Copyright (c) 1997-2006 by Matthew Jacob 635388Smjacob * All rights reserved. 752347Smjacob * 835388Smjacob * Redistribution and use in source and binary forms, with or without 935388Smjacob * modification, are permitted provided that the following conditions 1035388Smjacob * are met: 1135388Smjacob * 1. Redistributions of source code must retain the above copyright 1235388Smjacob * notice immediately at the beginning of the file, without modification, 1335388Smjacob * this list of conditions, and the following disclaimer. 1466189Smjacob * 2. The name of the author may not be used to endorse or promote products 1535388Smjacob * derived from this software without specific prior written permission. 1635388Smjacob * 1735388Smjacob * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 1835388Smjacob * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 1935388Smjacob * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 2035388Smjacob * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR 2135388Smjacob * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 2235388Smjacob * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2335388Smjacob * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2435388Smjacob * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2535388Smjacob * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2635388Smjacob * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 2735388Smjacob * SUCH DAMAGE. 2835388Smjacob */ 2935388Smjacob 3035388Smjacob#ifndef _ISPVAR_H 3135388Smjacob#define _ISPVAR_H 3235388Smjacob 3344819Smjacob#if defined(__NetBSD__) || defined(__OpenBSD__) 34163899Smjacob#include <dev/ic/isp_stds.h> 3535388Smjacob#include <dev/ic/ispmbox.h> 3635388Smjacob#endif 3735388Smjacob#ifdef __FreeBSD__ 38163899Smjacob#include <dev/isp/isp_stds.h> 3935388Smjacob#include <dev/isp/ispmbox.h> 4035388Smjacob#endif 4135388Smjacob#ifdef __linux__ 42163899Smjacob#include "isp_stds.h" 4342131Smjacob#include "ispmbox.h" 4435388Smjacob#endif 45155704Smjacob#ifdef __svr4__ 46163899Smjacob#include "isp_stds.h" 47155704Smjacob#include "ispmbox.h" 4853487Smjacob#endif 4935388Smjacob 50163899Smjacob#define ISP_CORE_VERSION_MAJOR 3 51163899Smjacob#define ISP_CORE_VERSION_MINOR 0 5239235Sgibbs 5335388Smjacob/* 5443420Smjacob * Vector for bus specific code to provide specific services. 5535388Smjacob */ 56155704Smjacobtypedef struct ispsoftc ispsoftc_t; 5735388Smjacobstruct ispmdvec { 5882689Smjacob int (*dv_rd_isr) 59163899Smjacob (ispsoftc_t *, uint32_t *, uint16_t *, uint16_t *); 60163899Smjacob uint32_t (*dv_rd_reg) (ispsoftc_t *, int); 61163899Smjacob void (*dv_wr_reg) (ispsoftc_t *, int, uint32_t); 62155704Smjacob int (*dv_mbxdma) (ispsoftc_t *); 63155704Smjacob int (*dv_dmaset) 64163899Smjacob (ispsoftc_t *, XS_T *, ispreq_t *, uint32_t *, uint32_t); 65163899Smjacob void (*dv_dmaclr) (ispsoftc_t *, XS_T *, uint32_t); 66155704Smjacob void (*dv_reset0) (ispsoftc_t *); 67155704Smjacob void (*dv_reset1) (ispsoftc_t *); 68155704Smjacob void (*dv_dregs) (ispsoftc_t *, const char *); 69163899Smjacob void * dv_ispfw; /* ptr to f/w */ 70155704Smjacob uint16_t dv_conf1; 71155704Smjacob uint16_t dv_clock; /* clock frequency */ 7235388Smjacob}; 7335388Smjacob 7464087Smjacob/* 7564087Smjacob * Overall parameters 7664087Smjacob */ 7782689Smjacob#define MAX_TARGETS 16 78164272Smjacob#define MAX_FC_TARG 512 7949909Smjacob#define ISP_MAX_TARGETS(isp) (IS_FC(isp)? MAX_FC_TARG : MAX_TARGETS) 8061772Smjacob#define ISP_MAX_LUNS(isp) (isp)->isp_maxluns 8149909Smjacob 8282689Smjacob/* 8364087Smjacob * Macros to access ISP registers through bus specific layers- 8464087Smjacob * mostly wrappers to vector through the mdvec structure. 8553487Smjacob */ 8682689Smjacob#define ISP_READ_ISR(isp, isrp, semap, mbox0p) \ 8782689Smjacob (*(isp)->isp_mdvec->dv_rd_isr)(isp, isrp, semap, mbox0p) 8853487Smjacob 8953487Smjacob#define ISP_READ(isp, reg) \ 9053487Smjacob (*(isp)->isp_mdvec->dv_rd_reg)((isp), (reg)) 9153487Smjacob 9253487Smjacob#define ISP_WRITE(isp, reg, val) \ 9353487Smjacob (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), (val)) 9453487Smjacob 9553487Smjacob#define ISP_MBOXDMASETUP(isp) \ 9653487Smjacob (*(isp)->isp_mdvec->dv_mbxdma)((isp)) 9753487Smjacob 9853487Smjacob#define ISP_DMASETUP(isp, xs, req, iptrp, optr) \ 9953487Smjacob (*(isp)->isp_mdvec->dv_dmaset)((isp), (xs), (req), (iptrp), (optr)) 10053487Smjacob 101155704Smjacob#define ISP_DMAFREE(isp, xs, hndl) \ 102155704Smjacob if ((isp)->isp_mdvec->dv_dmaclr) \ 10353487Smjacob (*(isp)->isp_mdvec->dv_dmaclr)((isp), (xs), (hndl)) 10453487Smjacob 10553487Smjacob#define ISP_RESET0(isp) \ 10653487Smjacob if ((isp)->isp_mdvec->dv_reset0) (*(isp)->isp_mdvec->dv_reset0)((isp)) 10753487Smjacob#define ISP_RESET1(isp) \ 10853487Smjacob if ((isp)->isp_mdvec->dv_reset1) (*(isp)->isp_mdvec->dv_reset1)((isp)) 10964087Smjacob#define ISP_DUMPREGS(isp, m) \ 11064087Smjacob if ((isp)->isp_mdvec->dv_dregs) (*(isp)->isp_mdvec->dv_dregs)((isp),(m)) 11153487Smjacob 11253487Smjacob#define ISP_SETBITS(isp, reg, val) \ 11353487Smjacob (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), ISP_READ((isp), (reg)) | (val)) 11453487Smjacob 11553487Smjacob#define ISP_CLRBITS(isp, reg, val) \ 11653487Smjacob (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), ISP_READ((isp), (reg)) & ~(val)) 11753487Smjacob 11864087Smjacob/* 11964087Smjacob * The MEMORYBARRIER macro is defined per platform (to provide synchronization 12064087Smjacob * on Request and Response Queues, Scratch DMA areas, and Registers) 12164087Smjacob * 12264087Smjacob * Defined Memory Barrier Synchronization Types 12364087Smjacob */ 12464087Smjacob#define SYNC_REQUEST 0 /* request queue synchronization */ 12564087Smjacob#define SYNC_RESULT 1 /* result queue synchronization */ 12664087Smjacob#define SYNC_SFORDEV 2 /* scratch, sync for ISP */ 12764087Smjacob#define SYNC_SFORCPU 3 /* scratch, sync for CPU */ 12864087Smjacob#define SYNC_REG 4 /* for registers */ 129163899Smjacob#define SYNC_ATIOQ 5 /* atio result queue (24xx) */ 13064087Smjacob 13164087Smjacob/* 13264087Smjacob * Request/Response Queue defines and macros. 13364087Smjacob * The maximum is defined per platform (and can be based on board type). 13464087Smjacob */ 13564087Smjacob/* This is the size of a queue entry (request and response) */ 13639235Sgibbs#define QENTRY_LEN 64 13764087Smjacob/* Both request and result queue length must be a power of two */ 13864087Smjacob#define RQUEST_QUEUE_LEN(x) MAXISPREQUEST(x) 13993706Smjacob#ifdef ISP_TARGET_MODE 14093706Smjacob#define RESULT_QUEUE_LEN(x) MAXISPREQUEST(x) 14193706Smjacob#else 14264087Smjacob#define RESULT_QUEUE_LEN(x) \ 14364087Smjacob (((MAXISPREQUEST(x) >> 2) < 64)? 64 : MAXISPREQUEST(x) >> 2) 14493706Smjacob#endif 145155704Smjacob#define ISP_QUEUE_ENTRY(q, idx) (((uint8_t *)q) + ((idx) * QENTRY_LEN)) 14639235Sgibbs#define ISP_QUEUE_SIZE(n) ((n) * QENTRY_LEN) 14739235Sgibbs#define ISP_NXT_QENTRY(idx, qlen) (((idx) + 1) & ((qlen)-1)) 14865140Smjacob#define ISP_QFREE(in, out, qlen) \ 14939235Sgibbs ((in == out)? (qlen - 1) : ((in > out)? \ 15052347Smjacob ((qlen - 1) - (in - out)) : (out - in - 1))) 15165140Smjacob#define ISP_QAVAIL(isp) \ 15265140Smjacob ISP_QFREE(isp->isp_reqidx, isp->isp_reqodx, RQUEST_QUEUE_LEN(isp)) 15353487Smjacob 15487635Smjacob#define ISP_ADD_REQUEST(isp, nxti) \ 15587635Smjacob MEMORYBARRIER(isp, SYNC_REQUEST, isp->isp_reqidx, QENTRY_LEN); \ 156163899Smjacob ISP_WRITE(isp, isp->isp_rqstinrp, nxti); \ 15787635Smjacob isp->isp_reqidx = nxti 15853487Smjacob 15935388Smjacob/* 16046968Smjacob * SCSI Specific Host Adapter Parameters- per bus, per target 16135388Smjacob */ 16235388Smjacobtypedef struct { 163155704Smjacob uint32_t isp_gotdparms : 1, 16452347Smjacob isp_req_ack_active_neg : 1, 16552347Smjacob isp_data_line_active_neg: 1, 16635388Smjacob isp_cmd_dma_burst_enable: 1, 16735388Smjacob isp_data_dma_burst_enabl: 1, 16842461Smjacob isp_fifo_threshold : 3, 169163899Smjacob isp_ptisp : 1, 17043420Smjacob isp_ultramode : 1, 17135388Smjacob isp_diffmode : 1, 17245040Smjacob isp_lvdmode : 1, 17365140Smjacob isp_fast_mttr : 1, /* fast sram */ 17435388Smjacob isp_initiator_id : 4, 17552347Smjacob isp_async_data_setup : 4; 176155704Smjacob uint16_t isp_selection_timeout; 177155704Smjacob uint16_t isp_max_queue_depth; 178155704Smjacob uint8_t isp_tag_aging; 179155704Smjacob uint8_t isp_bus_reset_delay; 180155704Smjacob uint8_t isp_retry_count; 181155704Smjacob uint8_t isp_retry_delay; 18235388Smjacob struct { 183155704Smjacob uint32_t 18480582Smjacob exc_throttle : 8, 18546968Smjacob : 1, 18680582Smjacob dev_enable : 1, /* ignored */ 18743420Smjacob dev_update : 1, 18843420Smjacob dev_refresh : 1, 18980582Smjacob actv_offset : 4, 19080582Smjacob goal_offset : 4, 19180582Smjacob nvrm_offset : 4; 192155704Smjacob uint8_t actv_period; /* current sync period */ 193155704Smjacob uint8_t goal_period; /* goal sync period */ 194155704Smjacob uint8_t nvrm_period; /* nvram sync period */ 195155704Smjacob uint16_t actv_flags; /* current device flags */ 196155704Smjacob uint16_t goal_flags; /* goal device flags */ 197155704Smjacob uint16_t nvrm_flags; /* nvram device flags */ 19835388Smjacob } isp_devparam[MAX_TARGETS]; 19946968Smjacob} sdparam; 20035388Smjacob 20135388Smjacob/* 20235388Smjacob * Device Flags 20335388Smjacob */ 20439235Sgibbs#define DPARM_DISC 0x8000 20539235Sgibbs#define DPARM_PARITY 0x4000 20639235Sgibbs#define DPARM_WIDE 0x2000 20739235Sgibbs#define DPARM_SYNC 0x1000 20839235Sgibbs#define DPARM_TQING 0x0800 20939235Sgibbs#define DPARM_ARQ 0x0400 21039235Sgibbs#define DPARM_QFRZ 0x0200 21139235Sgibbs#define DPARM_RENEG 0x0100 21265140Smjacob#define DPARM_NARROW 0x0080 21365140Smjacob#define DPARM_ASYNC 0x0040 21465140Smjacob#define DPARM_PPR 0x0020 21543793Smjacob#define DPARM_DEFAULT (0xFF00 & ~DPARM_QFRZ) 21639235Sgibbs#define DPARM_SAFE_DFLT (DPARM_DEFAULT & ~(DPARM_WIDE|DPARM_SYNC|DPARM_TQING)) 21735388Smjacob 21845040Smjacob/* technically, not really correct, as they need to be rated based upon clock */ 21965140Smjacob#define ISP_80M_SYNCPARMS 0x0c09 22065140Smjacob#define ISP_40M_SYNCPARMS 0x0c0a 22165140Smjacob#define ISP_20M_SYNCPARMS 0x0c0c 22265140Smjacob#define ISP_20M_SYNCPARMS_1040 0x080c 22352347Smjacob#define ISP_10M_SYNCPARMS 0x0c19 22452347Smjacob#define ISP_08M_SYNCPARMS 0x0c25 22552347Smjacob#define ISP_05M_SYNCPARMS 0x0c32 22652347Smjacob#define ISP_04M_SYNCPARMS 0x0c41 22735388Smjacob 22835388Smjacob/* 22935388Smjacob * Fibre Channel Specifics 23035388Smjacob */ 231163899Smjacob/* These are for 2100/2200/2300 cards */ 232163899Smjacob#define FL_ID 0x7e /* FL_Port Special ID */ 233163899Smjacob#define SNS_ID 0x80 /* SNS Server Special ID */ 234163899Smjacob#define NPH_MAX 0xfe 23552347Smjacob 236163899Smjacob/* These are for 24XX cards */ 237163899Smjacob#define NPH_RESERVED 0x7F0 /* begin of reserved N-port handles */ 238163899Smjacob#define NPH_MGT_ID 0x7FA /* Management Server Special ID */ 239163899Smjacob#define NPH_SNS_ID 0x7FC /* SNS Server Special ID */ 240163899Smjacob#define NPH_FL_ID 0x7FE /* FL Port Special ID */ 241163899Smjacob#define NPH_MAX_24XX 0x800 24293837Smjacob 243163899Smjacob/* 244163899Smjacob * Limit for devices on an arbitrated loop. 245163899Smjacob */ 246163899Smjacob#define LOCAL_LOOP_LIM 126 247163899Smjacob 248163899Smjacob/* 249163899Smjacob * Special Port IDs 250163899Smjacob */ 251163899Smjacob#define MANAGEMENT_PORT_ID 0xFFFFFA 252163899Smjacob#define SNS_PORT_ID 0xFFFFFC 253163899Smjacob#define FABRIC_PORT_ID 0xFFFFFE 254163899Smjacob 255163899Smjacob 256163899Smjacob/* 257163899Smjacob * FC Port Database entry. 258163899Smjacob * 259163899Smjacob * It has a handle that the f/w uses to address commands to a device. 260163899Smjacob * This handle's value may be assigned by the firmware (e.g., for local loop 261163899Smjacob * devices) or by the driver (e.g., for fabric devices). 262163899Smjacob * 263163899Smjacob * It has a state. If the state if VALID, that means that we've logged into 264163899Smjacob * the device. We also *may* have a initiator map index entry. This is a value 265163899Smjacob * from 0..MAX_FC_TARG that is used to index into the isp_ini_map array. If 266163899Smjacob * the value therein is non-zero, then that value minus one is used to index 267163899Smjacob * into the Port Database to find the handle for forming commands. There is 268163899Smjacob * back-index minus one value within to Port Database entry that tells us 269163899Smjacob * which entry in isp_ini_map points to us (to avoid searching). 270163899Smjacob * 271163899Smjacob * Local loop devices the firmware automatically performs PLOGI on for us 272163899Smjacob * (which is why that handle is imposed upon us). Fabric devices we assign 273163899Smjacob * a handle to and perform the PLOGI on. 274163899Smjacob * 275163899Smjacob * When a PORT DATABASE CHANGED asynchronous event occurs, we mark all VALID 276163899Smjacob * entries as PROBATIONAL. This allows us, if policy says to, just keep track 277163899Smjacob * of devices whose handles change but are otherwise the same device (and 278163899Smjacob * thus keep 'target' constant). 279163899Smjacob * 280163899Smjacob * In any case, we search all possible local loop handles. For each one that 281163899Smjacob * has a port database entity returned, we search for any PROBATIONAL entry 282163899Smjacob * that matches it and update as appropriate. Otherwise, as a new entry, we 283163899Smjacob * find room for it in the Port Database. We *try* and use the handle as the 284163899Smjacob * index to put it into the Database, but that's just an optimization. We mark 285163899Smjacob * the entry VALID and make sure that the target index is updated and correct. 286163899Smjacob * 287163899Smjacob * When we get done searching the local loop, we then search similarily for 288163899Smjacob * a list of devices we've gotten from the fabric name controller (if we're 289163899Smjacob * on a fabric). VALID marking is also done similarily. 290163899Smjacob * 291163899Smjacob * When all of this is done, we can march through the database and clean up 292163899Smjacob * any entry that is still PROBATIONAL (these represent devices which have 293163899Smjacob * departed). Then we're done and can resume normal operations. 294163899Smjacob * 295163899Smjacob * Negative invariants that we try and test for are: 296163899Smjacob * 297163899Smjacob * + There can never be two non-NIL entries with the same { Port, Node } WWN 298163899Smjacob * duples. 299163899Smjacob * 300163899Smjacob * + There can never be two non-NIL entries with the same handle. 301163899Smjacob * 302163899Smjacob * + There can never be two non-NIL entries which have the same ini_map_idx 303163899Smjacob * value. 304163899Smjacob */ 30535388Smjacobtypedef struct { 306164272Smjacob /* 307164272Smjacob * This is the handle that the firmware needs in order for us to 308164272Smjacob * send commands to the device. For pre-24XX cards, this would be 309164272Smjacob * the 'loopid'. 310164272Smjacob */ 311163899Smjacob uint16_t handle; 312164272Smjacob /* 313164272Smjacob * The ini_map_idx, if nonzero, is the system virtual target ID (+1) 314164272Smjacob * as a cross-reference with the isp_ini_map. 315164272Smjacob * 316164272Smjacob * A device is 'autologin' if the firmware automatically logs into 317164272Smjacob * it (re-logins as needed). Basically, local private loop devices. 318164272Smjacob * 319164272Smjacob * The state is the current state of thsi entry. 320164272Smjacob * 321164272Smjacob * Role is Initiator, Target, Both 322164272Smjacob * 323164272Smjacob * Portid is obvious, as or node && port WWNs. The new_role and 324164272Smjacob * new_portid is for when we are pending a change. 325164272Smjacob */ 326163899Smjacob uint16_t ini_map_idx : 12, 327163899Smjacob autologin : 1, /* F/W does PLOGI/PLOGO */ 328163899Smjacob state : 3; 329164272Smjacob uint32_t reserved : 6, 330163899Smjacob roles : 2, 331163899Smjacob portid : 24; 332164272Smjacob uint32_t new_reserved : 6, 333163899Smjacob new_roles : 2, 334163899Smjacob new_portid : 24; 335163899Smjacob uint64_t node_wwn; 336163899Smjacob uint64_t port_wwn; 337163899Smjacob} fcportdb_t; 338163899Smjacob 339163899Smjacob#define FC_PORTDB_STATE_NIL 0 340163899Smjacob#define FC_PORTDB_STATE_PROBATIONAL 1 341163899Smjacob#define FC_PORTDB_STATE_DEAD 2 342163899Smjacob#define FC_PORTDB_STATE_CHANGED 3 343163899Smjacob#define FC_PORTDB_STATE_NEW 4 344163899Smjacob#define FC_PORTDB_STATE_PENDING_VALID 5 345164272Smjacob#define FC_PORTDB_STATE_ZOMBIE 6 346163899Smjacob#define FC_PORTDB_STATE_VALID 7 347163899Smjacob 348163899Smjacob/* 349163899Smjacob * FC card specific information 350163899Smjacob */ 351163899Smjacobtypedef struct { 352163899Smjacob uint32_t : 10, 353163899Smjacob isp_tmode : 1, 354163899Smjacob isp_2klogin : 1, 355163899Smjacob isp_sccfw : 1, 356154704Smjacob isp_gbspeed : 3, 357160080Smjacob : 1, 358163899Smjacob : 1, 359163899Smjacob : 1, 36077776Smjacob isp_loopstate : 4, /* Current Loop State */ 361160080Smjacob isp_fwstate : 4, /* ISP F/W state */ 36248484Smjacob isp_gotdparms : 1, 36359454Smjacob isp_topo : 3, 364163899Smjacob loop_seen_once : 1; 365155704Smjacob uint32_t : 8, 366154704Smjacob isp_portid : 24; /* S_ID */ 367155704Smjacob uint16_t isp_fwoptions; 368160080Smjacob uint16_t isp_xfwoptions; 369160080Smjacob uint16_t isp_zfwoptions; 370155704Smjacob uint16_t isp_loopid; /* hard loop id */ 371155704Smjacob uint16_t isp_fwattr; /* firmware attributes */ 372158813Smjacob uint16_t isp_execthrottle; 373155704Smjacob uint8_t isp_retry_delay; 374155704Smjacob uint8_t isp_retry_count; 375155704Smjacob uint8_t isp_reserved; 376155704Smjacob uint16_t isp_maxalloc; 377155704Smjacob uint16_t isp_maxfrmlen; 378155704Smjacob uint64_t isp_nodewwn; 379155704Smjacob uint64_t isp_portwwn; 380164272Smjacob 381164272Smjacob /* 382164272Smjacob * Our Port Data Base 383164272Smjacob */ 384163899Smjacob fcportdb_t portdb[MAX_FC_TARG]; 385164272Smjacob 386164272Smjacob /* 387164272Smjacob * This maps system virtual 'target' id to a portdb entry. 388164272Smjacob * 389164272Smjacob * The mapping function is to take any non-zero entry and 390164272Smjacob * subtract one to get the portdb index. This means that 391164272Smjacob * entries which are zero are unmapped (i.e., don't exist). 392164272Smjacob */ 393163899Smjacob uint16_t isp_ini_map[MAX_FC_TARG]; 394164272Smjacob 39535388Smjacob /* 39635388Smjacob * Scratch DMA mapped in area to fetch Port Database stuff, etc. 39735388Smjacob */ 398155704Smjacob void * isp_scratch; 399155704Smjacob XS_DMA_ADDR_T isp_scdma; 40090752Smjacob#ifdef ISP_FW_CRASH_DUMP 401155704Smjacob uint16_t * isp_dump_data; 40290752Smjacob#endif 40335388Smjacob} fcparam; 40435388Smjacob 40548484Smjacob#define FW_CONFIG_WAIT 0 40648484Smjacob#define FW_WAIT_AL_PA 1 40748484Smjacob#define FW_WAIT_LOGIN 2 40848484Smjacob#define FW_READY 3 40948484Smjacob#define FW_LOSS_OF_SYNC 4 41048484Smjacob#define FW_ERROR 5 41148484Smjacob#define FW_REINIT 6 41248484Smjacob#define FW_NON_PART 7 41335388Smjacob 41448484Smjacob#define LOOP_NIL 0 41548484Smjacob#define LOOP_LIP_RCVD 1 41648484Smjacob#define LOOP_PDB_RCVD 2 417163899Smjacob#define LOOP_SCANNING_LOOP 3 418163899Smjacob#define LOOP_LSCAN_DONE 4 419163899Smjacob#define LOOP_SCANNING_FABRIC 5 420163899Smjacob#define LOOP_FSCAN_DONE 6 42177776Smjacob#define LOOP_SYNCING_PDB 7 42277776Smjacob#define LOOP_READY 8 42335388Smjacob 42459454Smjacob#define TOPO_NL_PORT 0 42559454Smjacob#define TOPO_FL_PORT 1 42659454Smjacob#define TOPO_N_PORT 2 42759454Smjacob#define TOPO_F_PORT 3 42859454Smjacob#define TOPO_PTP_STUB 4 42959454Smjacob 43042131Smjacob/* 43135388Smjacob * Soft Structure per host adapter 43235388Smjacob */ 433155704Smjacobstruct ispsoftc { 43435388Smjacob /* 43535388Smjacob * Platform (OS) specific data 43635388Smjacob */ 43735388Smjacob struct isposinfo isp_osinfo; 43835388Smjacob 43935388Smjacob /* 44053487Smjacob * Pointer to bus specific functions and data 44135388Smjacob */ 44235388Smjacob struct ispmdvec * isp_mdvec; 44335388Smjacob 44435388Smjacob /* 44553487Smjacob * (Mostly) nonvolatile state. Board specific parameters 44653487Smjacob * may contain some volatile state (e.g., current loop state). 44735388Smjacob */ 44835388Smjacob 44953487Smjacob void * isp_param; /* type specific */ 450155704Smjacob uint16_t isp_fwrev[3]; /* Loaded F/W revision */ 451155704Smjacob uint16_t isp_romfw_rev[3]; /* PROM F/W revision */ 452155704Smjacob uint16_t isp_maxcmds; /* max possible I/O cmds */ 453155704Smjacob uint8_t isp_type; /* HBA Chip Type */ 454155704Smjacob uint8_t isp_revision; /* HBA Chip H/W Revision */ 455155704Smjacob uint32_t isp_maxluns; /* maximum luns supported */ 45635388Smjacob 457155704Smjacob uint32_t isp_clock : 8, /* input clock */ 45890224Smjacob : 4, 459163899Smjacob isp_port : 1, /* 23XX/24XX only */ 46087635Smjacob isp_failed : 1, /* board failed */ 46187635Smjacob isp_open : 1, /* opened (ioctl) */ 46253487Smjacob isp_touched : 1, /* board ever seen? */ 46353487Smjacob isp_bustype : 1, /* SBus or PCI */ 46465140Smjacob isp_loaded_fw : 1, /* loaded firmware */ 46587635Smjacob isp_role : 2, /* roles supported */ 46671079Smjacob isp_dblev : 12; /* debug log mask */ 46771079Smjacob 468155704Smjacob uint32_t isp_confopts; /* config options */ 46971079Smjacob 470163899Smjacob uint32_t isp_rqstinrp; /* register for REQINP */ 471163899Smjacob uint32_t isp_rqstoutrp; /* register for REQOUTP */ 472163899Smjacob uint32_t isp_respinrp; /* register for RESINP */ 473163899Smjacob uint32_t isp_respoutrp; /* register for RESOUTP */ 474163899Smjacob uint32_t isp_atioinrp; /* register for ATIOINP */ 475163899Smjacob uint32_t isp_atiooutrp; /* register for ATIOOUTP */ 47682689Smjacob 47769522Smjacob /* 47869522Smjacob * Instrumentation 47969522Smjacob */ 480155704Smjacob uint64_t isp_intcnt; /* total int count */ 481155704Smjacob uint64_t isp_intbogus; /* spurious int count */ 482155704Smjacob uint64_t isp_intmboxc; /* mbox completions */ 483155704Smjacob uint64_t isp_intoasync; /* other async */ 484155704Smjacob uint64_t isp_rsltccmplt; /* CMDs on result q */ 485155704Smjacob uint64_t isp_fphccmplt; /* CMDs via fastpost */ 486155704Smjacob uint16_t isp_rscchiwater; 487155704Smjacob uint16_t isp_fpcchiwater; 48839235Sgibbs 48935388Smjacob /* 49039235Sgibbs * Volatile state 49135388Smjacob */ 49235388Smjacob 493160080Smjacob volatile uint32_t : 8, 49487635Smjacob isp_mboxbsy : 1, /* mailbox command active */ 49539235Sgibbs isp_state : 3, 49646968Smjacob isp_sendmarker : 2, /* send a marker entry */ 49746968Smjacob isp_update : 2, /* update parameters */ 49852347Smjacob isp_nactive : 16; /* how many commands active */ 499163899Smjacob volatile uint32_t isp_reqodx; /* index of last ISP pickup */ 500163899Smjacob volatile uint32_t isp_reqidx; /* index of next request */ 501163899Smjacob volatile uint32_t isp_residx; /* index of next result */ 502163899Smjacob volatile uint32_t isp_resodx; /* index of next result */ 503163899Smjacob volatile uint32_t isp_rspbsy; 504163899Smjacob volatile uint32_t isp_lasthdls; /* last handle seed */ 505163899Smjacob volatile uint32_t isp_obits; /* mailbox command output */ 506155704Smjacob volatile uint16_t isp_mboxtmp[MAILBOX_STORAGE]; 507155704Smjacob volatile uint16_t isp_lastmbxcmd; /* last mbox command sent */ 508155704Smjacob volatile uint16_t isp_mbxwrk0; 509155704Smjacob volatile uint16_t isp_mbxwrk1; 510155704Smjacob volatile uint16_t isp_mbxwrk2; 511160080Smjacob volatile uint16_t isp_mbxwrk8; 51290224Smjacob void * isp_mbxworkp; 51335388Smjacob 51435388Smjacob /* 51553487Smjacob * Active commands are stored here, indexed by handle functions. 51635388Smjacob */ 51764087Smjacob XS_T **isp_xflist; 51835388Smjacob 519129643Snjl#ifdef ISP_TARGET_MODE 52035388Smjacob /* 521129643Snjl * Active target commands are stored here, indexed by handle function. 522129643Snjl */ 523129643Snjl void **isp_tgtlist; 524129643Snjl#endif 525129643Snjl 526129643Snjl /* 527120018Smjacob * request/result queue pointers and DMA handles for them. 52835388Smjacob */ 529155704Smjacob void * isp_rquest; 530155704Smjacob void * isp_result; 531155704Smjacob XS_DMA_ADDR_T isp_rquest_dma; 532155704Smjacob XS_DMA_ADDR_T isp_result_dma; 533163899Smjacob#ifdef ISP_TARGET_MODE 534163899Smjacob /* for 24XX only */ 535163899Smjacob void * isp_atioq; 536163899Smjacob XS_DMA_ADDR_T isp_atioq_dma; 537163899Smjacob#endif 538155704Smjacob}; 53935388Smjacob 54049909Smjacob#define SDPARAM(isp) ((sdparam *) (isp)->isp_param) 54149909Smjacob#define FCPARAM(isp) ((fcparam *) (isp)->isp_param) 54249909Smjacob 54335388Smjacob/* 54464087Smjacob * ISP Driver Run States 54535388Smjacob */ 54635388Smjacob#define ISP_NILSTATE 0 547160080Smjacob#define ISP_CRASHED 1 548160080Smjacob#define ISP_RESETSTATE 2 549160080Smjacob#define ISP_INITSTATE 3 550160080Smjacob#define ISP_RUNSTATE 4 55135388Smjacob 55235388Smjacob/* 55335388Smjacob * ISP Configuration Options 55435388Smjacob */ 55535388Smjacob#define ISP_CFG_NORELOAD 0x80 /* don't download f/w */ 55643793Smjacob#define ISP_CFG_NONVRAM 0x40 /* ignore NVRAM */ 55784241Smjacob#define ISP_CFG_TWOGB 0x20 /* force 2GB connection (23XX only) */ 55884241Smjacob#define ISP_CFG_ONEGB 0x10 /* force 1GB connection (23XX only) */ 55953487Smjacob#define ISP_CFG_FULL_DUPLEX 0x01 /* Full Duplex (Fibre Channel only) */ 56069522Smjacob#define ISP_CFG_PORT_PREF 0x0C /* Mask for Port Prefs (2200 only) */ 56169522Smjacob#define ISP_CFG_LPORT 0x00 /* prefer {N/F}L-Port connection */ 56269522Smjacob#define ISP_CFG_NPORT 0x04 /* prefer {N/F}-Port connection */ 56369522Smjacob#define ISP_CFG_NPORT_ONLY 0x08 /* insist on {N/F}-Port connection */ 56469522Smjacob#define ISP_CFG_LPORT_ONLY 0x0C /* insist on {N/F}L-Port connection */ 56590752Smjacob#define ISP_CFG_OWNWWPN 0x100 /* override NVRAM wwpn */ 56690752Smjacob#define ISP_CFG_OWNWWNN 0x200 /* override NVRAM wwnn */ 56798281Smjacob#define ISP_CFG_OWNFSZ 0x400 /* override NVRAM frame size */ 56898281Smjacob#define ISP_CFG_OWNLOOPID 0x800 /* override NVRAM loopid */ 56998281Smjacob#define ISP_CFG_OWNEXCTHROTTLE 0x1000 /* override NVRAM execution throttle */ 570163899Smjacob#define ISP_CFG_FOURGB 0x2000 /* force 4GB connection (24XX only) */ 57135388Smjacob 57264087Smjacob/* 57371079Smjacob * Prior to calling isp_reset for the first time, the outer layer 57471079Smjacob * should set isp_role to one of NONE, INITIATOR, TARGET, BOTH. 57571079Smjacob * 57671079Smjacob * If you set ISP_ROLE_NONE, the cards will be reset, new firmware loaded, 57771079Smjacob * NVRAM read, and defaults set, but any further initialization (e.g. 57871079Smjacob * INITIALIZE CONTROL BLOCK commands for 2X00 cards) won't be done. 57971079Smjacob * 58071079Smjacob * If INITIATOR MODE isn't set, attempts to run commands will be stopped 58171079Smjacob * at isp_start and completed with the moral equivalent of SELECTION TIMEOUT. 58271079Smjacob * 58371079Smjacob * If TARGET MODE is set, it doesn't mean that the rest of target mode support 58471079Smjacob * needs to be enabled, or will even work. What happens with the 2X00 cards 58571079Smjacob * here is that if you have enabled it with TARGET MODE as part of the ICB 58671079Smjacob * options, but you haven't given the f/w any ram resources for ATIOs or 58771079Smjacob * Immediate Notifies, the f/w just handles what it can and you never see 58871079Smjacob * anything. Basically, it sends a single byte of data (the first byte, 58971079Smjacob * which you can set as part of the INITIALIZE CONTROL BLOCK command) for 59071079Smjacob * INQUIRY, and sends back QUEUE FULL status for any other command. 59179235Smjacob * 59271079Smjacob */ 59371079Smjacob#define ISP_ROLE_NONE 0x0 594125544Smjacob#define ISP_ROLE_TARGET 0x1 595125544Smjacob#define ISP_ROLE_INITIATOR 0x2 59671079Smjacob#define ISP_ROLE_BOTH (ISP_ROLE_TARGET|ISP_ROLE_INITIATOR) 59771079Smjacob#define ISP_ROLE_EITHER ISP_ROLE_BOTH 59871079Smjacob#ifndef ISP_DEFAULT_ROLES 59971079Smjacob#define ISP_DEFAULT_ROLES ISP_ROLE_INITIATOR 60071079Smjacob#endif 60171079Smjacob 60271079Smjacob 60371079Smjacob/* 60464087Smjacob * Firmware related defines 60564087Smjacob */ 60671079Smjacob#define ISP_CODE_ORG 0x1000 /* default f/w code start */ 60782689Smjacob#define ISP_CODE_ORG_2300 0x0800 /* ..except for 2300s */ 608163899Smjacob#define ISP_CODE_ORG_2400 0x100000 /* ..and 2400s */ 60945282Smjacob#define ISP_FW_REV(maj, min, mic) ((maj << 24) | (min << 16) | mic) 61082841Smjacob#define ISP_FW_MAJOR(code) ((code >> 24) & 0xff) 61182841Smjacob#define ISP_FW_MINOR(code) ((code >> 16) & 0xff) 61282841Smjacob#define ISP_FW_MICRO(code) ((code >> 8) & 0xff) 61371079Smjacob#define ISP_FW_REVX(xp) ((xp[0]<<24) | (xp[1] << 16) | xp[2]) 61482841Smjacob#define ISP_FW_MAJORX(xp) (xp[0]) 61582841Smjacob#define ISP_FW_MINORX(xp) (xp[1]) 61682841Smjacob#define ISP_FW_MICROX(xp) (xp[2]) 617102012Smjacob#define ISP_FW_NEWER_THAN(i, major, minor, micro) \ 618102012Smjacob (ISP_FW_REVX((i)->isp_fwrev) > ISP_FW_REV(major, minor, micro)) 619163899Smjacob#define ISP_FW_OLDER_THAN(i, major, minor, micro) \ 620163899Smjacob (ISP_FW_REVX((i)->isp_fwrev) < ISP_FW_REV(major, minor, micro)) 62139235Sgibbs 62235388Smjacob/* 62339235Sgibbs * Bus (implementation) types 62435388Smjacob */ 62539235Sgibbs#define ISP_BT_PCI 0 /* PCI Implementations */ 62639235Sgibbs#define ISP_BT_SBUS 1 /* SBus Implementations */ 62739235Sgibbs 62839235Sgibbs/* 62987635Smjacob * If we have not otherwise defined SBus support away make sure 63087635Smjacob * it is defined here such that the code is included as default 63187635Smjacob */ 63287635Smjacob#ifndef ISP_SBUS_SUPPORTED 63387635Smjacob#define ISP_SBUS_SUPPORTED 1 63487635Smjacob#endif 63587635Smjacob 63687635Smjacob/* 63739235Sgibbs * Chip Types 63839235Sgibbs */ 63935388Smjacob#define ISP_HA_SCSI 0xf 64039235Sgibbs#define ISP_HA_SCSI_UNKNOWN 0x1 64139235Sgibbs#define ISP_HA_SCSI_1020 0x2 64239235Sgibbs#define ISP_HA_SCSI_1020A 0x3 64339235Sgibbs#define ISP_HA_SCSI_1040 0x4 64439235Sgibbs#define ISP_HA_SCSI_1040A 0x5 64539235Sgibbs#define ISP_HA_SCSI_1040B 0x6 64645282Smjacob#define ISP_HA_SCSI_1040C 0x7 64754671Smjacob#define ISP_HA_SCSI_1240 0x8 64854671Smjacob#define ISP_HA_SCSI_1080 0x9 64954671Smjacob#define ISP_HA_SCSI_1280 0xa 650104916Smjacob#define ISP_HA_SCSI_10160 0xb 651104916Smjacob#define ISP_HA_SCSI_12160 0xc 65235388Smjacob#define ISP_HA_FC 0xf0 65335388Smjacob#define ISP_HA_FC_2100 0x10 65448484Smjacob#define ISP_HA_FC_2200 0x20 65577365Smjacob#define ISP_HA_FC_2300 0x30 65688855Smjacob#define ISP_HA_FC_2312 0x40 657154704Smjacob#define ISP_HA_FC_2322 0x50 658154704Smjacob#define ISP_HA_FC_2400 0x60 65935388Smjacob 66044819Smjacob#define IS_SCSI(isp) (isp->isp_type & ISP_HA_SCSI) 66154671Smjacob#define IS_1240(isp) (isp->isp_type == ISP_HA_SCSI_1240) 66244819Smjacob#define IS_1080(isp) (isp->isp_type == ISP_HA_SCSI_1080) 66354671Smjacob#define IS_1280(isp) (isp->isp_type == ISP_HA_SCSI_1280) 664104916Smjacob#define IS_10160(isp) (isp->isp_type == ISP_HA_SCSI_10160) 66557145Smjacob#define IS_12160(isp) (isp->isp_type == ISP_HA_SCSI_12160) 66657145Smjacob 66757145Smjacob#define IS_12X0(isp) (IS_1240(isp) || IS_1280(isp)) 668104916Smjacob#define IS_1X160(isp) (IS_10160(isp) || IS_12160(isp)) 66957145Smjacob#define IS_DUALBUS(isp) (IS_12X0(isp) || IS_12160(isp)) 670104916Smjacob#define IS_ULTRA2(isp) (IS_1080(isp) || IS_1280(isp) || IS_1X160(isp)) 671104916Smjacob#define IS_ULTRA3(isp) (IS_1X160(isp)) 67257145Smjacob 67377365Smjacob#define IS_FC(isp) ((isp)->isp_type & ISP_HA_FC) 67477365Smjacob#define IS_2100(isp) ((isp)->isp_type == ISP_HA_FC_2100) 67577365Smjacob#define IS_2200(isp) ((isp)->isp_type == ISP_HA_FC_2200) 676163899Smjacob#define IS_23XX(isp) ((isp)->isp_type >= ISP_HA_FC_2300 && \ 677163899Smjacob (isp)->isp_type < ISP_HA_FC_2400) 67888855Smjacob#define IS_2300(isp) ((isp)->isp_type == ISP_HA_FC_2300) 67988855Smjacob#define IS_2312(isp) ((isp)->isp_type == ISP_HA_FC_2312) 680154704Smjacob#define IS_2322(isp) ((isp)->isp_type == ISP_HA_FC_2322) 681154704Smjacob#define IS_24XX(isp) ((isp)->isp_type >= ISP_HA_FC_2400) 68244819Smjacob 68364087Smjacob/* 684155704Smjacob * DMA related macros 68564087Smjacob */ 686163899Smjacob#define DMA_WD3(x) (((uint16_t)(((uint64_t)x) >> 48)) & 0xffff) 687163899Smjacob#define DMA_WD2(x) (((uint16_t)(((uint64_t)x) >> 32)) & 0xffff) 688163899Smjacob#define DMA_WD1(x) ((uint16_t)((x) >> 16) & 0xffff) 689163899Smjacob#define DMA_WD0(x) ((uint16_t)((x) & 0xffff)) 69057145Smjacob 691155704Smjacob#define DMA_LO32(x) ((uint32_t) (x)) 692155704Smjacob#define DMA_HI32(x) ((uint32_t)(((uint64_t)x) >> 32)) 693155704Smjacob 69435388Smjacob/* 69564087Smjacob * Core System Function Prototypes 69635388Smjacob */ 69735388Smjacob 69835388Smjacob/* 69939235Sgibbs * Reset Hardware. Totally. Assumes that you'll follow this with 70039235Sgibbs * a call to isp_init. 70135388Smjacob */ 702155704Smjacobvoid isp_reset(ispsoftc_t *); 70335388Smjacob 70435388Smjacob/* 70535388Smjacob * Initialize Hardware to known state 70635388Smjacob */ 707155704Smjacobvoid isp_init(ispsoftc_t *); 70835388Smjacob 70935388Smjacob/* 71039235Sgibbs * Reset the ISP and call completion for any orphaned commands. 71139235Sgibbs */ 712155704Smjacobvoid isp_reinit(ispsoftc_t *); 71339235Sgibbs 71490752Smjacob#ifdef ISP_FW_CRASH_DUMP 71539235Sgibbs/* 71690752Smjacob * Dump firmware entry point. 71790752Smjacob */ 718155704Smjacobvoid isp_fw_dump(ispsoftc_t *isp); 71990752Smjacob#endif 72090752Smjacob 72190752Smjacob/* 72282689Smjacob * Internal Interrupt Service Routine 72382689Smjacob * 72482689Smjacob * The outer layers do the spade work to get the appropriate status register, 72582689Smjacob * semaphore register and first mailbox register (if appropriate). This also 72682689Smjacob * means that most spurious/bogus interrupts not for us can be filtered first. 72735388Smjacob */ 728163899Smjacobvoid isp_intr(ispsoftc_t *, uint32_t, uint16_t, uint16_t); 72935388Smjacob 73082689Smjacob 73135388Smjacob/* 73264087Smjacob * Command Entry Point- Platform Dependent layers call into this 73335388Smjacob */ 73474229Smjacobint isp_start(XS_T *); 735155704Smjacob 73664087Smjacob/* these values are what isp_start returns */ 73764087Smjacob#define CMD_COMPLETE 101 /* command completed */ 73864087Smjacob#define CMD_EAGAIN 102 /* busy- maybe retry later */ 73964087Smjacob#define CMD_QUEUED 103 /* command has been queued for execution */ 74064087Smjacob#define CMD_RQLATER 104 /* requeue this command later */ 74135388Smjacob 74239235Sgibbs/* 74364087Smjacob * Command Completion Point- Core layers call out from this with completed cmds 74464087Smjacob */ 74574229Smjacobvoid isp_done(XS_T *); 74664087Smjacob 74764087Smjacob/* 74843420Smjacob * Platform Dependent to External to Internal Control Function 74939235Sgibbs * 75072355Smjacob * Assumes locks are held on entry. You should note that with many of 75172355Smjacob * these commands and locks may be released while this is occurring. 75239235Sgibbs * 75372355Smjacob * A few notes about some of these functions: 75472355Smjacob * 75572355Smjacob * ISPCTL_FCLINK_TEST tests to make sure we have good fibre channel link. 75672355Smjacob * The argument is a pointer to an integer which is the time, in microseconds, 75772355Smjacob * we should wait to see whether we have good link. This test, if successful, 75872355Smjacob * lets us know our connection topology and our Loop ID/AL_PA and so on. 75972355Smjacob * You can't get anywhere without this. 76072355Smjacob * 76172355Smjacob * ISPCTL_SCAN_FABRIC queries the name server (if we're on a fabric) for 76272355Smjacob * all entities using the FC Generic Services subcommand GET ALL NEXT. 76372355Smjacob * For each found entity, an ISPASYNC_FABRICDEV event is generated (see 76472355Smjacob * below). 76572355Smjacob * 76672355Smjacob * ISPCTL_SCAN_LOOP does a local loop scan. This is only done if the connection 76772355Smjacob * topology is NL or FL port (private or public loop). Since the Qlogic f/w 76872355Smjacob * 'automatically' manages local loop connections, this function essentially 76972355Smjacob * notes the arrival, departure, and possible shuffling around of local loop 77072355Smjacob * entities. Thus for each arrival and departure this generates an isp_async 77172355Smjacob * event of ISPASYNC_PROMENADE (see below). 77272355Smjacob * 77372355Smjacob * ISPCTL_PDB_SYNC is somewhat misnamed. It actually is the final step, in 77472355Smjacob * order, of ISPCTL_FCLINK_TEST, ISPCTL_SCAN_FABRIC, and ISPCTL_SCAN_LOOP. 77572355Smjacob * The main purpose of ISPCTL_PDB_SYNC is to complete management of logging 77672355Smjacob * and logging out of fabric devices (if one is on a fabric) and then marking 77772355Smjacob * the 'loop state' as being ready to now be used for sending commands to 77872355Smjacob * devices. Originally fabric name server and local loop scanning were 77981794Smjacob * part of this function. It's now been separated to allow for finer control. 78039235Sgibbs */ 78139235Sgibbstypedef enum { 78248484Smjacob ISPCTL_RESET_BUS, /* Reset Bus */ 78348484Smjacob ISPCTL_RESET_DEV, /* Reset Device */ 78448484Smjacob ISPCTL_ABORT_CMD, /* Abort Command */ 78572355Smjacob ISPCTL_UPDATE_PARAMS, /* Update Operating Parameters (SCSI) */ 78655364Smjacob ISPCTL_FCLINK_TEST, /* Test FC Link Status */ 78772355Smjacob ISPCTL_SCAN_FABRIC, /* (Re)scan Fabric Name Server */ 78872355Smjacob ISPCTL_SCAN_LOOP, /* (Re)scan Local Loop */ 78955364Smjacob ISPCTL_PDB_SYNC, /* Synchronize Port Database */ 79072355Smjacob ISPCTL_SEND_LIP, /* Send a LIP */ 791163899Smjacob ISPCTL_GET_PORTNAME, /* get portname from an N-port handle */ 79272938Smjacob ISPCTL_RUN_MBOXCMD, /* run a mailbox command */ 793125544Smjacob ISPCTL_TOGGLE_TMODE, /* toggle target mode */ 794125544Smjacob ISPCTL_GET_PDB /* get a single port database entry */ 79539235Sgibbs} ispctl_t; 796155704Smjacobint isp_control(ispsoftc_t *, ispctl_t, void *); 79739235Sgibbs 79843420Smjacob 79939235Sgibbs/* 80043420Smjacob * Platform Dependent to Internal to External Control Function 80143420Smjacob * (each platform must provide such a function) 80243420Smjacob * 80372355Smjacob * Assumes locks are held. 80472355Smjacob * 80572355Smjacob * A few notes about some of these functions: 80672355Smjacob * 80772355Smjacob * ISPASYNC_CHANGE_NOTIFY notifies the outer layer that a change has 80872355Smjacob * occurred that invalidates the list of fabric devices known and/or 80972355Smjacob * the list of known loop devices. The argument passed is a pointer 81072355Smjacob * whose values are defined below (local loop change, name server 81172355Smjacob * change, other). 'Other' may simply be a LIP, or a change in 81272355Smjacob * connection topology. 81372355Smjacob * 81472355Smjacob * ISPASYNC_FABRIC_DEV announces the next element in a list of 81572355Smjacob * fabric device names we're getting out of the name server. The 81672355Smjacob * argument points to a GET ALL NEXT response structure. The list 81772355Smjacob * is known to terminate with an entry that refers to ourselves. 81872355Smjacob * One of the main purposes of this function is to allow outer 81972355Smjacob * layers, which are OS dependent, to set policy as to which fabric 82072355Smjacob * devices might actually be logged into (and made visible) later 82172355Smjacob * at ISPCTL_PDB_SYNC time. Since there's a finite number of fabric 82272355Smjacob * devices that we can log into (256 less 3 'reserved' for F-port 82372355Smjacob * topologies), and fabrics can grow up to 8 million or so entries 82472355Smjacob * (24 bits of Port Address, less a wad of reserved spaces), clearly 82572355Smjacob * we had better let the OS determine login policy. 82672355Smjacob * 82772355Smjacob * ISPASYNC_PROMENADE has an argument that is a pointer to an integer which 828103826Smjacob * is an index into the portdb in the softc ('target'). Whether that entry's 82972355Smjacob * valid tag is set or not says whether something has arrived or departed. 83072355Smjacob * The name refers to a favorite pastime of many city dwellers- watching 83172355Smjacob * people come and go, talking of Michaelangelo, and so on.. 83272938Smjacob * 83372938Smjacob * ISPASYNC_UNHANDLED_RESPONSE gives outer layers a chance to parse a 83472938Smjacob * response queue entry not otherwise handled. The outer layer should 83587635Smjacob * return non-zero if it handled it. The 'arg' points to an unmassaged 83687635Smjacob * response queue entry. 83743420Smjacob */ 83843420Smjacob 83943420Smjacobtypedef enum { 84072355Smjacob ISPASYNC_NEW_TGT_PARAMS, /* New Target Parameters Negotiated */ 84148484Smjacob ISPASYNC_BUS_RESET, /* Bus Was Reset */ 84248484Smjacob ISPASYNC_LOOP_DOWN, /* FC Loop Down */ 84348484Smjacob ISPASYNC_LOOP_UP, /* FC Loop Up */ 84477365Smjacob ISPASYNC_LIP, /* LIP Received */ 84577365Smjacob ISPASYNC_LOOP_RESET, /* Loop Reset Received */ 84672355Smjacob ISPASYNC_CHANGE_NOTIFY, /* FC Change Notification */ 847163899Smjacob ISPASYNC_DEV_ARRIVED, /* FC Device Arrival */ 848163899Smjacob ISPASYNC_DEV_CHANGED, /* FC Device Change */ 849163899Smjacob ISPASYNC_DEV_STAYED, /* FC Device Stayed the Same */ 850163899Smjacob ISPASYNC_DEV_GONE, /* FC Device Depart */ 851154704Smjacob ISPASYNC_TARGET_NOTIFY, /* target asynchronous notification event */ 852154704Smjacob ISPASYNC_TARGET_ACTION, /* target action requested */ 85372938Smjacob ISPASYNC_CONF_CHANGE, /* Platform Configuration Change */ 85479235Smjacob ISPASYNC_UNHANDLED_RESPONSE, /* Unhandled Response Entry */ 85598281Smjacob ISPASYNC_FW_CRASH, /* Firmware has crashed */ 856102012Smjacob ISPASYNC_FW_DUMPED, /* Firmware crashdump taken */ 85798281Smjacob ISPASYNC_FW_RESTARTED /* Firmware has been restarted */ 85843420Smjacob} ispasync_t; 859155704Smjacobint isp_async(ispsoftc_t *, ispasync_t, void *); 86043420Smjacob 86172355Smjacob#define ISPASYNC_CHANGE_PDB ((void *) 0) 86272355Smjacob#define ISPASYNC_CHANGE_SNS ((void *) 1) 86372355Smjacob#define ISPASYNC_CHANGE_OTHER ((void *) 2) 86472355Smjacob 86543420Smjacob/* 86664087Smjacob * Platform Dependent Error and Debug Printout 867146073Smjacob * 868146073Smjacob * Generally this is: 869146073Smjacob * 870155704Smjacob * void isp_prt(ispsoftc_t *, int level, const char *, ...) 871146073Smjacob * 872146073Smjacob * but due to compiler differences on different platforms this won't be 873146073Smjacob * formally done here. Instead, it goes in each platform definition file. 87439235Sgibbs */ 87570490Smjacob 87664087Smjacob#define ISP_LOGALL 0x0 /* log always */ 87764087Smjacob#define ISP_LOGCONFIG 0x1 /* log configuration messages */ 87864087Smjacob#define ISP_LOGINFO 0x2 /* log informational messages */ 87964087Smjacob#define ISP_LOGWARN 0x4 /* log warning messages */ 88064087Smjacob#define ISP_LOGERR 0x8 /* log error messages */ 88164087Smjacob#define ISP_LOGDEBUG0 0x10 /* log simple debug messages */ 88264087Smjacob#define ISP_LOGDEBUG1 0x20 /* log intermediate debug messages */ 88364087Smjacob#define ISP_LOGDEBUG2 0x40 /* log most debug messages */ 88479235Smjacob#define ISP_LOGDEBUG3 0x80 /* log high frequency debug messages */ 885164272Smjacob#define ISP_LOGSANCFG 0x100 /* log SAN configuration */ 88664087Smjacob#define ISP_LOGTDEBUG0 0x200 /* log simple debug messages (target mode) */ 88764087Smjacob#define ISP_LOGTDEBUG1 0x400 /* log intermediate debug messages (target) */ 88864087Smjacob#define ISP_LOGTDEBUG2 0x800 /* log all debug messages (target) */ 88939235Sgibbs 89064087Smjacob/* 89164087Smjacob * Each Platform provides it's own isposinfo substructure of the ispsoftc 89264087Smjacob * defined above. 89364087Smjacob * 89464087Smjacob * Each platform must also provide the following macros/defines: 89564087Smjacob * 89664087Smjacob * 89764087Smjacob * ISP2100_SCRLEN - length for the Fibre Channel scratch DMA area 89864087Smjacob * 89964087Smjacob * MEMZERO(dst, src) platform zeroing function 90064087Smjacob * MEMCPY(dst, src, count) platform copying function 90164087Smjacob * SNPRINTF(buf, bufsize, fmt, ...) snprintf 90264087Smjacob * USEC_DELAY(usecs) microsecond spindelay function 90369522Smjacob * USEC_SLEEP(isp, usecs) microsecond sleep function 90464087Smjacob * 90564087Smjacob * NANOTIME_T nanosecond time type 90664087Smjacob * 90764087Smjacob * GET_NANOTIME(NANOTIME_T *) get current nanotime. 90864087Smjacob * 909155704Smjacob * GET_NANOSEC(NANOTIME_T *) get uint64_t from NANOTIME_T 91064087Smjacob * 91164087Smjacob * NANOTIME_SUB(NANOTIME_T *, NANOTIME_T *) 91264087Smjacob * subtract two NANOTIME_T values 91364087Smjacob * 91464087Smjacob * 915155704Smjacob * MAXISPREQUEST(ispsoftc_t *) maximum request queue size 91664087Smjacob * for this particular board type 91764087Smjacob * 918155704Smjacob * MEMORYBARRIER(ispsoftc_t *, barrier_type, offset, size) 91964087Smjacob * 92064087Smjacob * Function/Macro the provides memory synchronization on 92164087Smjacob * various objects so that the ISP's and the system's view 92264087Smjacob * of the same object is consistent. 92364087Smjacob * 924155704Smjacob * MBOX_ACQUIRE(ispsoftc_t *) acquire lock on mailbox regs 925163899Smjacob * MBOX_WAIT_COMPLETE(ispsoftc_t *, mbreg_t *) wait for cmd to be done 926155704Smjacob * MBOX_NOTIFY_COMPLETE(ispsoftc_t *) notification of mbox cmd donee 927155704Smjacob * MBOX_RELEASE(ispsoftc_t *) release lock on mailbox regs 92864087Smjacob * 929155704Smjacob * FC_SCRATCH_ACQUIRE(ispsoftc_t *) acquire lock on FC scratch area 930155704Smjacob * FC_SCRATCH_RELEASE(ispsoftc_t *) acquire lock on FC scratch area 93172355Smjacob * 93264087Smjacob * SCSI_GOOD SCSI 'Good' Status 93364087Smjacob * SCSI_CHECK SCSI 'Check Condition' Status 93464087Smjacob * SCSI_BUSY SCSI 'Busy' Status 93564087Smjacob * SCSI_QFULL SCSI 'Queue Full' Status 93664087Smjacob * 93764087Smjacob * XS_T Platform SCSI transaction type (i.e., command for HBA) 938155704Smjacob * XS_DMA_ADDR_T Platform PCI DMA Address Type 93964087Smjacob * XS_ISP(xs) gets an instance out of an XS_T 94064087Smjacob * XS_CHANNEL(xs) gets the channel (bus # for DUALBUS cards) "" 94164087Smjacob * XS_TGT(xs) gets the target "" 94264087Smjacob * XS_LUN(xs) gets the lun "" 94364087Smjacob * XS_CDBP(xs) gets a pointer to the scsi CDB "" 94464087Smjacob * XS_CDBLEN(xs) gets the CDB's length "" 94564087Smjacob * XS_XFRLEN(xs) gets the associated data transfer length "" 94664087Smjacob * XS_TIME(xs) gets the time (in milliseconds) for this command 94764087Smjacob * XS_RESID(xs) gets the current residual count 94864087Smjacob * XS_STSP(xs) gets a pointer to the SCSI status byte "" 94964087Smjacob * XS_SNSP(xs) gets a pointer to the associate sense data 95064087Smjacob * XS_SNSLEN(xs) gets the length of sense data storage 95164087Smjacob * XS_SNSKEY(xs) dereferences XS_SNSP to get the current stored Sense Key 95264087Smjacob * XS_TAG_P(xs) predicate of whether this command should be tagged 95364087Smjacob * XS_TAG_TYPE(xs) which type of tag to use 95464087Smjacob * XS_SETERR(xs) set error state 95564087Smjacob * 95664087Smjacob * HBA_NOERROR command has no erros 95764087Smjacob * HBA_BOTCH hba botched something 95864087Smjacob * HBA_CMDTIMEOUT command timed out 95964087Smjacob * HBA_SELTIMEOUT selection timed out (also port logouts for FC) 96064087Smjacob * HBA_TGTBSY target returned a BUSY status 96164087Smjacob * HBA_BUSRESET bus reset destroyed command 96264087Smjacob * HBA_ABORTED command was aborted (by request) 96364087Smjacob * HBA_DATAOVR a data overrun was detected 96464087Smjacob * HBA_ARQFAIL Automatic Request Sense failed 96564087Smjacob * 96664087Smjacob * XS_ERR(xs) return current error state 96764087Smjacob * XS_NOERR(xs) there is no error currently set 96864087Smjacob * XS_INITERR(xs) initialize error state 96964087Smjacob * 970164272Smjacob * XS_SAVE_SENSE(xs, sp, len) save sense data 97164087Smjacob * 97264087Smjacob * XS_SET_STATE_STAT(isp, sp, xs) platform dependent interpreter of 97364087Smjacob * response queue entry status bits 97464087Smjacob * 97564087Smjacob * 976155704Smjacob * DEFAULT_IID(ispsoftc_t *) Default SCSI initiator ID 977155704Smjacob * DEFAULT_LOOPID(ispsoftc_t *) Default FC Loop ID 978155704Smjacob * DEFAULT_NODEWWN(ispsoftc_t *) Default Node WWN 979155704Smjacob * DEFAULT_PORTWWN(ispsoftc_t *) Default Port WWN 980155704Smjacob * DEFAULT_FRAMESIZE(ispsoftc_t *) Default Frame Size 981155704Smjacob * DEFAULT_EXEC_THROTTLE(ispsoftc_t *) Default Execution Throttle 98267047Smjacob * These establish reasonable defaults for each platform. 98367047Smjacob * These must be available independent of card NVRAM and are 98467047Smjacob * to be used should NVRAM not be readable. 98564087Smjacob * 986155704Smjacob * ISP_NODEWWN(ispsoftc_t *) FC Node WWN to use 987155704Smjacob * ISP_PORTWWN(ispsoftc_t *) FC Port WWN to use 98864087Smjacob * 98967047Smjacob * These are to be used after NVRAM is read. The tags 99067047Smjacob * in fcparam.isp_{node,port}wwn reflect the values 99167047Smjacob * read from NVRAM (possibly corrected for card botches). 99267047Smjacob * Each platform can take that information and override 99367047Smjacob * it or ignore and return the Node and Port WWNs to be 99467047Smjacob * used when sending the Qlogic f/w the Initialization Control 99567047Smjacob * Block. 99664087Smjacob * 99764087Smjacob * (XXX these do endian specific transformations- in transition XXX) 99887635Smjacob * 999155704Smjacob * ISP_IOXPUT_8(ispsoftc_t *, uint8_t srcval, uint8_t *dstptr) 1000155704Smjacob * ISP_IOXPUT_16(ispsoftc_t *, uint16_t srcval, uint16_t *dstptr) 1001155704Smjacob * ISP_IOXPUT_32(ispsoftc_t *, uint32_t srcval, uint32_t *dstptr) 100287635Smjacob * 1003155704Smjacob * ISP_IOXGET_8(ispsoftc_t *, uint8_t *srcptr, uint8_t dstrval) 1004155704Smjacob * ISP_IOXGET_16(ispsoftc_t *, uint16_t *srcptr, uint16_t dstrval) 1005155704Smjacob * ISP_IOXGET_32(ispsoftc_t *, uint32_t *srcptr, uint32_t dstrval) 100687635Smjacob * 1007155704Smjacob * ISP_SWIZZLE_NVRAM_WORD(ispsoftc_t *, uint16_t *) 100864087Smjacob */ 100977365Smjacob 101035388Smjacob#endif /* _ISPVAR_H */ 1011