ispvar.h revision 290785
168349Sobrien/* $FreeBSD: stable/10/sys/dev/isp/ispvar.h 290785 2015-11-13 19:42:55Z mav $ */ 268349Sobrien/*- 368349Sobrien * Copyright (c) 1997-2009 by Matthew Jacob 468349Sobrien * All rights reserved. 568349Sobrien * 668349Sobrien * Redistribution and use in source and binary forms, with or without 768349Sobrien * modification, are permitted provided that the following conditions 868349Sobrien * are met: 968349Sobrien * 1068349Sobrien * 1. Redistributions of source code must retain the above copyright 1168349Sobrien * notice, this list of conditions and the following disclaimer. 1268349Sobrien * 2. Redistributions in binary form must reproduce the above copyright 1368349Sobrien * notice, this list of conditions and the following disclaimer in the 1468349Sobrien * documentation and/or other materials provided with the distribution. 1568349Sobrien * 1668349Sobrien * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND 1768349Sobrien * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 1868349Sobrien * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 1968349Sobrien * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE 2068349Sobrien * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 2168349Sobrien * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2268349Sobrien * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2368349Sobrien * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2468349Sobrien * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2568349Sobrien * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 2668349Sobrien * SUCH DAMAGE. 2768349Sobrien * 2868349Sobrien */ 2968349Sobrien/* 3068349Sobrien * Soft Definitions for for Qlogic ISP SCSI adapters. 3168349Sobrien */ 3268349Sobrien 3368349Sobrien#ifndef _ISPVAR_H 3468349Sobrien#define _ISPVAR_H 3568349Sobrien 3668349Sobrien#if defined(__NetBSD__) || defined(__OpenBSD__) 3768349Sobrien#include <dev/ic/isp_stds.h> 3868349Sobrien#include <dev/ic/ispmbox.h> 3968349Sobrien#endif 4068349Sobrien#ifdef __FreeBSD__ 4168349Sobrien#include <dev/isp/isp_stds.h> 4268349Sobrien#include <dev/isp/ispmbox.h> 4368349Sobrien#endif 4468349Sobrien#ifdef __linux__ 4568349Sobrien#include "isp_stds.h" 4668349Sobrien#include "ispmbox.h" 4768349Sobrien#endif 4868349Sobrien#ifdef __svr4__ 4968349Sobrien#include "isp_stds.h" 5068349Sobrien#include "ispmbox.h" 5168349Sobrien#endif 5268349Sobrien 5368349Sobrien#define ISP_CORE_VERSION_MAJOR 7 5468349Sobrien#define ISP_CORE_VERSION_MINOR 0 5568349Sobrien 5668349Sobrien/* 5768349Sobrien * Vector for bus specific code to provide specific services. 5868349Sobrien */ 5968349Sobrientypedef struct ispsoftc ispsoftc_t; 6068349Sobrienstruct ispmdvec { 6168349Sobrien int (*dv_rd_isr) (ispsoftc_t *, uint16_t *, uint16_t *, uint16_t *); 6268349Sobrien uint32_t (*dv_rd_reg) (ispsoftc_t *, int); 6368349Sobrien void (*dv_wr_reg) (ispsoftc_t *, int, uint32_t); 6468349Sobrien int (*dv_mbxdma) (ispsoftc_t *); 6568349Sobrien int (*dv_dmaset) (ispsoftc_t *, XS_T *, void *); 6668349Sobrien void (*dv_dmaclr) (ispsoftc_t *, XS_T *, uint32_t); 6768349Sobrien void (*dv_reset0) (ispsoftc_t *); 6868349Sobrien void (*dv_reset1) (ispsoftc_t *); 6968349Sobrien void (*dv_dregs) (ispsoftc_t *, const char *); 7068349Sobrien const void * dv_ispfw; /* ptr to f/w */ 7168349Sobrien uint16_t dv_conf1; 7268349Sobrien uint16_t dv_clock; /* clock frequency */ 7368349Sobrien}; 7468349Sobrien 7568349Sobrien/* 7668349Sobrien * Overall parameters 7768349Sobrien */ 7868349Sobrien#define MAX_TARGETS 16 7968349Sobrien#ifndef MAX_FC_TARG 8068349Sobrien#define MAX_FC_TARG 256 8168349Sobrien#endif 8268349Sobrien#define ISP_MAX_TARGETS(isp) (IS_FC(isp)? MAX_FC_TARG : MAX_TARGETS) 8368349Sobrien#define ISP_MAX_LUNS(isp) (isp)->isp_maxluns 8468349Sobrien 8568349Sobrien/* 8668349Sobrien * Macros to access ISP registers through bus specific layers- 8768349Sobrien * mostly wrappers to vector through the mdvec structure. 8868349Sobrien */ 8968349Sobrien#define ISP_READ_ISR(isp, isrp, semap, info) \ 9068349Sobrien (*(isp)->isp_mdvec->dv_rd_isr)(isp, isrp, semap, info) 9168349Sobrien 9268349Sobrien#define ISP_READ(isp, reg) \ 9368349Sobrien (*(isp)->isp_mdvec->dv_rd_reg)((isp), (reg)) 9468349Sobrien 9568349Sobrien#define ISP_WRITE(isp, reg, val) \ 9668349Sobrien (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), (val)) 9768349Sobrien 9868349Sobrien#define ISP_MBOXDMASETUP(isp) \ 9968349Sobrien (*(isp)->isp_mdvec->dv_mbxdma)((isp)) 10068349Sobrien 10168349Sobrien#define ISP_DMASETUP(isp, xs, req) \ 10268349Sobrien (*(isp)->isp_mdvec->dv_dmaset)((isp), (xs), (req)) 10368349Sobrien 10468349Sobrien#define ISP_DMAFREE(isp, xs, hndl) \ 10568349Sobrien if ((isp)->isp_mdvec->dv_dmaclr) \ 10668349Sobrien (*(isp)->isp_mdvec->dv_dmaclr)((isp), (xs), (hndl)) 10768349Sobrien 10868349Sobrien#define ISP_RESET0(isp) \ 10968349Sobrien if ((isp)->isp_mdvec->dv_reset0) (*(isp)->isp_mdvec->dv_reset0)((isp)) 11068349Sobrien#define ISP_RESET1(isp) \ 11168349Sobrien if ((isp)->isp_mdvec->dv_reset1) (*(isp)->isp_mdvec->dv_reset1)((isp)) 11268349Sobrien#define ISP_DUMPREGS(isp, m) \ 11368349Sobrien if ((isp)->isp_mdvec->dv_dregs) (*(isp)->isp_mdvec->dv_dregs)((isp),(m)) 11468349Sobrien 11568349Sobrien#define ISP_SETBITS(isp, reg, val) \ 11668349Sobrien (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), ISP_READ((isp), (reg)) | (val)) 11768349Sobrien 11868349Sobrien#define ISP_CLRBITS(isp, reg, val) \ 11968349Sobrien (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), ISP_READ((isp), (reg)) & ~(val)) 12068349Sobrien 12168349Sobrien/* 12268349Sobrien * The MEMORYBARRIER macro is defined per platform (to provide synchronization 12368349Sobrien * on Request and Response Queues, Scratch DMA areas, and Registers) 12468349Sobrien * 12568349Sobrien * Defined Memory Barrier Synchronization Types 12668349Sobrien */ 12768349Sobrien#define SYNC_REQUEST 0 /* request queue synchronization */ 12868349Sobrien#define SYNC_RESULT 1 /* result queue synchronization */ 12968349Sobrien#define SYNC_SFORDEV 2 /* scratch, sync for ISP */ 13068349Sobrien#define SYNC_SFORCPU 3 /* scratch, sync for CPU */ 13168349Sobrien#define SYNC_REG 4 /* for registers */ 13268349Sobrien#define SYNC_ATIOQ 5 /* atio result queue (24xx) */ 13368349Sobrien 13468349Sobrien/* 13568349Sobrien * Request/Response Queue defines and macros. 13668349Sobrien * The maximum is defined per platform (and can be based on board type). 13768349Sobrien */ 13868349Sobrien/* This is the size of a queue entry (request and response) */ 13968349Sobrien#define QENTRY_LEN 64 14068349Sobrien/* Both request and result queue length must be a power of two */ 14168349Sobrien#define RQUEST_QUEUE_LEN(x) MAXISPREQUEST(x) 14268349Sobrien#ifdef ISP_TARGET_MODE 14368349Sobrien#define RESULT_QUEUE_LEN(x) MAXISPREQUEST(x) 14468349Sobrien#else 14568349Sobrien#define RESULT_QUEUE_LEN(x) \ 14668349Sobrien (((MAXISPREQUEST(x) >> 2) < 64)? 64 : MAXISPREQUEST(x) >> 2) 14768349Sobrien#endif 14868349Sobrien#define ISP_QUEUE_ENTRY(q, idx) (((uint8_t *)q) + ((idx) * QENTRY_LEN)) 14968349Sobrien#define ISP_QUEUE_SIZE(n) ((n) * QENTRY_LEN) 15068349Sobrien#define ISP_NXT_QENTRY(idx, qlen) (((idx) + 1) & ((qlen)-1)) 15168349Sobrien#define ISP_QFREE(in, out, qlen) \ 15268349Sobrien ((in == out)? (qlen - 1) : ((in > out)? \ 15368349Sobrien ((qlen - 1) - (in - out)) : (out - in - 1))) 15468349Sobrien#define ISP_QAVAIL(isp) \ 15568349Sobrien ISP_QFREE(isp->isp_reqidx, isp->isp_reqodx, RQUEST_QUEUE_LEN(isp)) 15668349Sobrien 15768349Sobrien#define ISP_ADD_REQUEST(isp, nxti) \ 15868349Sobrien MEMORYBARRIER(isp, SYNC_REQUEST, isp->isp_reqidx, QENTRY_LEN, -1); \ 15968349Sobrien ISP_WRITE(isp, isp->isp_rqstinrp, nxti); \ 16068349Sobrien isp->isp_reqidx = nxti 16168349Sobrien 16268349Sobrien#define ISP_SYNC_REQUEST(isp) \ 16368349Sobrien MEMORYBARRIER(isp, SYNC_REQUEST, isp->isp_reqidx, QENTRY_LEN, -1); \ 16468349Sobrien isp->isp_reqidx = ISP_NXT_QENTRY(isp->isp_reqidx, RQUEST_QUEUE_LEN(isp)); \ 16568349Sobrien ISP_WRITE(isp, isp->isp_rqstinrp, isp->isp_reqidx) 16668349Sobrien 16768349Sobrien/* 16868349Sobrien * SCSI Specific Host Adapter Parameters- per bus, per target 16968349Sobrien */ 17068349Sobrientypedef struct { 17168349Sobrien uint32_t : 8, 17268349Sobrien update : 1, 17368349Sobrien sendmarker : 1, 17468349Sobrien role : 2, 17568349Sobrien isp_req_ack_active_neg : 1, 17668349Sobrien isp_data_line_active_neg: 1, 17768349Sobrien isp_cmd_dma_burst_enable: 1, 17868349Sobrien isp_data_dma_burst_enabl: 1, 17968349Sobrien isp_fifo_threshold : 3, 18068349Sobrien isp_ptisp : 1, 18168349Sobrien isp_ultramode : 1, 18268349Sobrien isp_diffmode : 1, 18368349Sobrien isp_lvdmode : 1, 18468349Sobrien isp_fast_mttr : 1, /* fast sram */ 18568349Sobrien isp_initiator_id : 4, 18668349Sobrien isp_async_data_setup : 4; 18768349Sobrien uint16_t isp_selection_timeout; 18868349Sobrien uint16_t isp_max_queue_depth; 18968349Sobrien uint8_t isp_tag_aging; 19068349Sobrien uint8_t isp_bus_reset_delay; 19168349Sobrien uint8_t isp_retry_count; 19268349Sobrien uint8_t isp_retry_delay; 19368349Sobrien struct { 19468349Sobrien uint32_t 19568349Sobrien exc_throttle : 8, 19668349Sobrien : 1, 19768349Sobrien dev_enable : 1, /* ignored */ 19868349Sobrien dev_update : 1, 19968349Sobrien dev_refresh : 1, 20068349Sobrien actv_offset : 4, 20168349Sobrien goal_offset : 4, 20268349Sobrien nvrm_offset : 4; 20368349Sobrien uint8_t actv_period; /* current sync period */ 20468349Sobrien uint8_t goal_period; /* goal sync period */ 20568349Sobrien uint8_t nvrm_period; /* nvram sync period */ 20668349Sobrien uint16_t actv_flags; /* current device flags */ 20768349Sobrien uint16_t goal_flags; /* goal device flags */ 20868349Sobrien uint16_t nvrm_flags; /* nvram device flags */ 20968349Sobrien } isp_devparam[MAX_TARGETS]; 21068349Sobrien} sdparam; 21168349Sobrien 21268349Sobrien/* 21368349Sobrien * Device Flags 21468349Sobrien */ 21568349Sobrien#define DPARM_DISC 0x8000 21668349Sobrien#define DPARM_PARITY 0x4000 21768349Sobrien#define DPARM_WIDE 0x2000 21868349Sobrien#define DPARM_SYNC 0x1000 21968349Sobrien#define DPARM_TQING 0x0800 22068349Sobrien#define DPARM_ARQ 0x0400 22168349Sobrien#define DPARM_QFRZ 0x0200 22268349Sobrien#define DPARM_RENEG 0x0100 22368349Sobrien#define DPARM_NARROW 0x0080 22468349Sobrien#define DPARM_ASYNC 0x0040 22568349Sobrien#define DPARM_PPR 0x0020 22668349Sobrien#define DPARM_DEFAULT (0xFF00 & ~DPARM_QFRZ) 22768349Sobrien#define DPARM_SAFE_DFLT (DPARM_DEFAULT & ~(DPARM_WIDE|DPARM_SYNC|DPARM_TQING)) 22868349Sobrien 22968349Sobrien/* technically, not really correct, as they need to be rated based upon clock */ 23068349Sobrien#define ISP_80M_SYNCPARMS 0x0c09 23168349Sobrien#define ISP_40M_SYNCPARMS 0x0c0a 23268349Sobrien#define ISP_20M_SYNCPARMS 0x0c0c 23368349Sobrien#define ISP_20M_SYNCPARMS_1040 0x080c 23468349Sobrien#define ISP_10M_SYNCPARMS 0x0c19 23568349Sobrien#define ISP_08M_SYNCPARMS 0x0c25 23668349Sobrien#define ISP_05M_SYNCPARMS 0x0c32 23768349Sobrien#define ISP_04M_SYNCPARMS 0x0c41 23868349Sobrien 23968349Sobrien/* 24068349Sobrien * Fibre Channel Specifics 24168349Sobrien */ 24268349Sobrien/* These are for non-2K Login Firmware cards */ 24368349Sobrien#define FL_ID 0x7e /* FL_Port Special ID */ 24468349Sobrien#define SNS_ID 0x80 /* SNS Server Special ID */ 24568349Sobrien#define NPH_MAX 0xfe 24668349Sobrien 24768349Sobrien/* Use this handle for the base for multi-id firmware SNS logins */ 24868349Sobrien#define NPH_SNS_HDLBASE 0x400 24968349Sobrien 25068349Sobrien/* These are for 2K Login Firmware cards */ 25168349Sobrien#define NPH_RESERVED 0x7F0 /* begin of reserved N-port handles */ 25274784Sobrien#define NPH_MGT_ID 0x7FA /* Management Server Special ID */ 25374784Sobrien#define NPH_SNS_ID 0x7FC /* SNS Server Special ID */ 25474784Sobrien#define NPH_FABRIC_CTLR 0x7FD /* Fabric Controller (0xFFFFFD) */ 25574784Sobrien#define NPH_FL_ID 0x7FE /* F Port Special ID (0xFFFFFE) */ 25674784Sobrien#define NPH_IP_BCST 0x7ff /* IP Broadcast Special ID (0xFFFFFF) */ 25774784Sobrien#define NPH_MAX_2K 0x800 25874784Sobrien 25974784Sobrien/* 26074784Sobrien * "Unassigned" handle to be used internally 26174784Sobrien */ 26274784Sobrien#define NIL_HANDLE 0xffff 26374784Sobrien 26474784Sobrien/* 26574784Sobrien * Limit for devices on an arbitrated loop. 26674784Sobrien */ 26774784Sobrien#define LOCAL_LOOP_LIM 126 26874784Sobrien 26974784Sobrien/* 27074784Sobrien * Limit for (2K login) N-port handle amounts 27174784Sobrien */ 27274784Sobrien#define MAX_NPORT_HANDLE 2048 27374784Sobrien 27474784Sobrien/* 27574784Sobrien * Special Constants 27674784Sobrien */ 27774784Sobrien#define INI_NONE ((uint64_t) 0) 27874784Sobrien#define ISP_NOCHAN 0xff 27974784Sobrien 28074784Sobrien/* 28174784Sobrien * Special Port IDs 28274784Sobrien */ 28374784Sobrien#define MANAGEMENT_PORT_ID 0xFFFFFA 28474784Sobrien#define SNS_PORT_ID 0xFFFFFC 28574784Sobrien#define FABRIC_PORT_ID 0xFFFFFE 28674784Sobrien#define PORT_ANY 0xFFFFFF 28774784Sobrien#define PORT_NONE 0 28874784Sobrien#define DOMAIN_CONTROLLER_BASE 0xFFFC00 28974784Sobrien#define DOMAIN_CONTROLLER_END 0xFFFCFF 29074784Sobrien 29174784Sobrien/* 29274784Sobrien * Command Handles 29374784Sobrien * 29474784Sobrien * Most QLogic initiator or target have 32 bit handles associated with them. 29574784Sobrien * We want to have a quick way to index back and forth between a local SCSI 29674784Sobrien * command context and what the firmware is passing back to us. We also 29774784Sobrien * want to avoid working on stale information. This structure handles both 29874784Sobrien * at the expense of some local memory. 29974784Sobrien * 30074784Sobrien * The handle is architected thusly: 30174784Sobrien * 30274784Sobrien * 0 means "free handle" 30374784Sobrien * bits 0..12 index commands 30474784Sobrien * bits 13..15 bits index usage 30574784Sobrien * bits 16..31 contain a rolling sequence 30674784Sobrien * 30774784Sobrien * 30874784Sobrien */ 30974784Sobrientypedef struct { 31074784Sobrien void * cmd; /* associated command context */ 31174784Sobrien uint32_t handle; /* handle associated with this command */ 31274784Sobrien} isp_hdl_t; 31374784Sobrien#define ISP_HANDLE_FREE 0x00000000 31474784Sobrien#define ISP_HANDLE_CMD_MASK 0x00001fff 31574784Sobrien#define ISP_HANDLE_USAGE_MASK 0x0000e000 31674784Sobrien#define ISP_HANDLE_USAGE_SHIFT 13 31774784Sobrien#define ISP_H2HT(hdl) ((hdl & ISP_HANDLE_USAGE_MASK) >> ISP_HANDLE_USAGE_SHIFT) 31874784Sobrien# define ISP_HANDLE_NONE 0 31974784Sobrien# define ISP_HANDLE_INITIATOR 1 32074784Sobrien# define ISP_HANDLE_TARGET 2 32174784Sobrien#define ISP_HANDLE_SEQ_MASK 0xffff0000 32274784Sobrien#define ISP_HANDLE_SEQ_SHIFT 16 32374784Sobrien#define ISP_H2SEQ(hdl) ((hdl & ISP_HANDLE_SEQ_MASK) >> ISP_HANDLE_SEQ_SHIFT) 32474784Sobrien#define ISP_VALID_INI_HANDLE(c, hdl) \ 32574784Sobrien (ISP_H2HT(hdl) == ISP_HANDLE_INITIATOR && (hdl & ISP_HANDLE_CMD_MASK) < (c)->isp_maxcmds && \ 32674784Sobrien ISP_H2SEQ(hdl) == ISP_H2SEQ((c)->isp_xflist[hdl & ISP_HANDLE_CMD_MASK].handle)) 32774784Sobrien#ifdef ISP_TARGET_MODE 32874784Sobrien#define ISP_VALID_TGT_HANDLE(c, hdl) \ 32974784Sobrien (ISP_H2HT(hdl) == ISP_HANDLE_TARGET && (hdl & ISP_HANDLE_CMD_MASK) < (c)->isp_maxcmds && \ 33074784Sobrien ISP_H2SEQ(hdl) == ISP_H2SEQ((c)->isp_tgtlist[hdl & ISP_HANDLE_CMD_MASK].handle)) 33174784Sobrien#define ISP_VALID_HANDLE(c, hdl) \ 33274784Sobrien (ISP_VALID_INI_HANDLE((c), hdl) || ISP_VALID_TGT_HANDLE((c), hdl)) 33374784Sobrien#else 33474784Sobrien#define ISP_VALID_HANDLE ISP_VALID_INI_HANDLE 33574784Sobrien#endif 33674784Sobrien#define ISP_BAD_HANDLE_INDEX 0xffffffff 33774784Sobrien 33874784Sobrien 33974784Sobrien/* 34074784Sobrien * FC Port Database entry. 34174784Sobrien * 34274784Sobrien * It has a handle that the f/w uses to address commands to a device. 34374784Sobrien * This handle's value may be assigned by the firmware (e.g., for local loop 34474784Sobrien * devices) or by the driver (e.g., for fabric devices). 34574784Sobrien * 34674784Sobrien * It has a state. If the state if VALID, that means that we've logged into 34774784Sobrien * the device. 34874784Sobrien * 34974784Sobrien * Local loop devices the firmware automatically performs PLOGI on for us 35074784Sobrien * (which is why that handle is imposed upon us). Fabric devices we assign 35174784Sobrien * a handle to and perform the PLOGI on. 35274784Sobrien * 35374784Sobrien * When a PORT DATABASE CHANGED asynchronous event occurs, we mark all VALID 35474784Sobrien * entries as PROBATIONAL. This allows us, if policy says to, just keep track 35574784Sobrien * of devices whose handles change but are otherwise the same device (and 35674784Sobrien * thus keep 'target' constant). 35774784Sobrien * 35874784Sobrien * In any case, we search all possible local loop handles. For each one that 35974784Sobrien * has a port database entity returned, we search for any PROBATIONAL entry 36074784Sobrien * that matches it and update as appropriate. Otherwise, as a new entry, we 36174784Sobrien * find room for it in the Port Database. We *try* and use the handle as the 36274784Sobrien * index to put it into the Database, but that's just an optimization. We mark 36374784Sobrien * the entry VALID and make sure that the target index is updated and correct. 36474784Sobrien * 36574784Sobrien * When we get done searching the local loop, we then search similarily for 36674784Sobrien * a list of devices we've gotten from the fabric name controller (if we're 36774784Sobrien * on a fabric). VALID marking is also done similarily. 36874784Sobrien * 36974784Sobrien * When all of this is done, we can march through the database and clean up 37074784Sobrien * any entry that is still PROBATIONAL (these represent devices which have 37174784Sobrien * departed). Then we're done and can resume normal operations. 37274784Sobrien * 37374784Sobrien * Negative invariants that we try and test for are: 37474784Sobrien * 37574784Sobrien * + There can never be two non-NIL entries with the same { Port, Node } WWN 37674784Sobrien * duples. 37774784Sobrien * 37874784Sobrien * + There can never be two non-NIL entries with the same handle. 37974784Sobrien */ 38074784Sobrientypedef struct { 38174784Sobrien /* 38274784Sobrien * This is the handle that the firmware needs in order for us to 38374784Sobrien * send commands to the device. For pre-24XX cards, this would be 38474784Sobrien * the 'loopid'. 38574784Sobrien */ 38674784Sobrien uint16_t handle; 38774784Sobrien 38874784Sobrien /* 38974784Sobrien * A device is 'autologin' if the firmware automatically logs into 39074784Sobrien * it (re-logins as needed). Basically, local private loop devices. 39174784Sobrien * 392 * PRLI word 3 parameters contains role as well as other things. 393 * 394 * The state is the current state of this entry. 395 * 396 * The is_target is the current state of target on this port. 397 * 398 * The is_initiator is the current state of initiator on this port. 399 * 400 * Portid is obvious, as are node && port WWNs. The new_role and 401 * new_portid is for when we are pending a change. 402 */ 403 uint16_t prli_word3; /* PRLI parameters */ 404 uint16_t new_prli_word3; /* Incoming new PRLI parameters */ 405 uint16_t : 12, 406 autologin : 1, /* F/W does PLOGI/PLOGO */ 407 state : 3; 408 uint32_t : 6, 409 is_target : 1, 410 is_initiator : 1, 411 portid : 24; 412 uint32_t 413 : 8, 414 new_portid : 24; 415 uint64_t node_wwn; 416 uint64_t port_wwn; 417 uint32_t gone_timer; 418} fcportdb_t; 419 420#define FC_PORTDB_STATE_NIL 0 421#define FC_PORTDB_STATE_PROBATIONAL 1 422#define FC_PORTDB_STATE_DEAD 2 423#define FC_PORTDB_STATE_CHANGED 3 424#define FC_PORTDB_STATE_NEW 4 425#define FC_PORTDB_STATE_PENDING_VALID 5 426#define FC_PORTDB_STATE_ZOMBIE 6 427#define FC_PORTDB_STATE_VALID 7 428 429#define FC_PORTDB_TGT(isp, bus, pdb) (int)(lp - FCPARAM(isp, bus)->portdb) 430 431/* 432 * FC card specific information 433 * 434 * This structure is replicated across multiple channels for multi-id 435 * capapble chipsets, with some entities different on a per-channel basis. 436 */ 437 438typedef struct { 439 int isp_gbspeed; /* Connection speed */ 440 int isp_linkstate; /* Link state */ 441 int isp_fwstate; /* ISP F/W state */ 442 int isp_loopstate; /* Loop State */ 443 int isp_topo; /* Connection Type */ 444 445 uint32_t : 3, 446 fctape_enabled : 1, 447 sendmarker : 1, 448 loop_seen_once : 1, 449 role : 2, 450 isp_portid : 24; /* S_ID */ 451 452 uint16_t isp_fwoptions; 453 uint16_t isp_xfwoptions; 454 uint16_t isp_zfwoptions; 455 uint16_t isp_loopid; /* hard loop id */ 456 uint16_t isp_sns_hdl; /* N-port handle for SNS */ 457 uint16_t isp_lasthdl; /* only valid for channel 0 */ 458 uint16_t isp_maxalloc; 459 uint16_t isp_fabric_params; 460 uint8_t isp_retry_delay; 461 uint8_t isp_retry_count; 462 463 /* 464 * Current active WWNN/WWPN 465 */ 466 uint64_t isp_wwnn; 467 uint64_t isp_wwpn; 468 469 /* 470 * NVRAM WWNN/WWPN 471 */ 472 uint64_t isp_wwnn_nvram; 473 uint64_t isp_wwpn_nvram; 474 475 /* 476 * Our Port Data Base 477 */ 478 fcportdb_t portdb[MAX_FC_TARG]; 479 480 /* 481 * Scratch DMA mapped in area to fetch Port Database stuff, etc. 482 */ 483 void * isp_scratch; 484 XS_DMA_ADDR_T isp_scdma; 485} fcparam; 486 487#define FW_CONFIG_WAIT 0 488#define FW_WAIT_AL_PA 1 489#define FW_WAIT_LOGIN 2 490#define FW_READY 3 491#define FW_LOSS_OF_SYNC 4 492#define FW_ERROR 5 493#define FW_REINIT 6 494#define FW_NON_PART 7 495 496#define LOOP_NIL 0 497#define LOOP_LIP_RCVD 1 498#define LOOP_PDB_RCVD 2 499#define LOOP_SCANNING_LOOP 3 500#define LOOP_LSCAN_DONE 4 501#define LOOP_SCANNING_FABRIC 5 502#define LOOP_FSCAN_DONE 6 503#define LOOP_SYNCING_PDB 7 504#define LOOP_READY 8 505 506#define TOPO_NL_PORT 0 507#define TOPO_FL_PORT 1 508#define TOPO_N_PORT 2 509#define TOPO_F_PORT 3 510#define TOPO_PTP_STUB 4 511 512/* 513 * Soft Structure per host adapter 514 */ 515struct ispsoftc { 516 /* 517 * Platform (OS) specific data 518 */ 519 struct isposinfo isp_osinfo; 520 521 /* 522 * Pointer to bus specific functions and data 523 */ 524 struct ispmdvec * isp_mdvec; 525 526 /* 527 * (Mostly) nonvolatile state. Board specific parameters 528 * may contain some volatile state (e.g., current loop state). 529 */ 530 531 void * isp_param; /* type specific */ 532 uint64_t isp_fwattr; /* firmware attributes */ 533 uint16_t isp_fwrev[3]; /* Loaded F/W revision */ 534 uint16_t isp_maxcmds; /* max possible I/O cmds */ 535 uint8_t isp_type; /* HBA Chip Type */ 536 uint8_t isp_revision; /* HBA Chip H/W Revision */ 537 uint16_t isp_nchan; /* number of channels */ 538 uint32_t isp_maxluns; /* maximum luns supported */ 539 540 uint32_t isp_clock : 8, /* input clock */ 541 : 4, 542 isp_port : 1, /* 23XX/24XX only */ 543 isp_open : 1, /* opened (ioctl) */ 544 isp_bustype : 1, /* SBus or PCI */ 545 isp_loaded_fw : 1, /* loaded firmware */ 546 isp_dblev : 16; /* debug log mask */ 547 548 549 uint32_t isp_confopts; /* config options */ 550 551 uint32_t isp_rqstinrp; /* register for REQINP */ 552 uint32_t isp_rqstoutrp; /* register for REQOUTP */ 553 uint32_t isp_respinrp; /* register for RESINP */ 554 uint32_t isp_respoutrp; /* register for RESOUTP */ 555 556 /* 557 * Instrumentation 558 */ 559 uint64_t isp_intcnt; /* total int count */ 560 uint64_t isp_intbogus; /* spurious int count */ 561 uint64_t isp_intmboxc; /* mbox completions */ 562 uint64_t isp_intoasync; /* other async */ 563 uint64_t isp_rsltccmplt; /* CMDs on result q */ 564 uint64_t isp_fphccmplt; /* CMDs via fastpost */ 565 uint16_t isp_rscchiwater; 566 uint16_t isp_fpcchiwater; 567 NANOTIME_T isp_init_time; /* time were last initialized */ 568 569 /* 570 * Volatile state 571 */ 572 573 volatile uint32_t : 8, 574 : 2, 575 isp_dead : 1, 576 : 1, 577 isp_mboxbsy : 1, /* mailbox command active */ 578 isp_state : 3, 579 isp_nactive : 16; /* how many commands active */ 580 volatile mbreg_t isp_curmbx; /* currently active mailbox command */ 581 volatile uint32_t isp_reqodx; /* index of last ISP pickup */ 582 volatile uint32_t isp_reqidx; /* index of next request */ 583 volatile uint32_t isp_residx; /* index of last ISP write */ 584 volatile uint32_t isp_resodx; /* index of next result */ 585 volatile uint32_t isp_atioodx; /* index of next ATIO */ 586 volatile uint32_t isp_obits; /* mailbox command output */ 587 volatile uint32_t isp_serno; /* rolling serial number */ 588 volatile uint16_t isp_mboxtmp[MAX_MAILBOX]; 589 volatile uint16_t isp_lastmbxcmd; /* last mbox command sent */ 590 volatile uint16_t isp_mbxwrk0; 591 volatile uint16_t isp_mbxwrk1; 592 volatile uint16_t isp_mbxwrk2; 593 volatile uint16_t isp_mbxwrk8; 594 volatile uint16_t isp_seqno; /* running sequence number */ 595 void * isp_mbxworkp; 596 597 /* 598 * Active commands are stored here, indexed by handle functions. 599 */ 600 isp_hdl_t *isp_xflist; 601 isp_hdl_t *isp_xffree; 602 603#ifdef ISP_TARGET_MODE 604 /* 605 * Active target commands are stored here, indexed by handle functions. 606 */ 607 isp_hdl_t *isp_tgtlist; 608 isp_hdl_t *isp_tgtfree; 609#endif 610 611 /* 612 * request/result queue pointers and DMA handles for them. 613 */ 614 void * isp_rquest; 615 void * isp_result; 616 XS_DMA_ADDR_T isp_rquest_dma; 617 XS_DMA_ADDR_T isp_result_dma; 618#ifdef ISP_TARGET_MODE 619 /* for 24XX only */ 620 void * isp_atioq; 621 XS_DMA_ADDR_T isp_atioq_dma; 622#endif 623}; 624 625#define SDPARAM(isp, chan) (&((sdparam *)(isp)->isp_param)[(chan)]) 626#define FCPARAM(isp, chan) (&((fcparam *)(isp)->isp_param)[(chan)]) 627 628#define ISP_SET_SENDMARKER(isp, chan, val) \ 629 if (IS_FC(isp)) { \ 630 FCPARAM(isp, chan)->sendmarker = val; \ 631 } else { \ 632 SDPARAM(isp, chan)->sendmarker = val; \ 633 } 634 635#define ISP_TST_SENDMARKER(isp, chan) \ 636 (IS_FC(isp)? \ 637 FCPARAM(isp, chan)->sendmarker != 0 : \ 638 SDPARAM(isp, chan)->sendmarker != 0) 639 640/* 641 * ISP Driver Run States 642 */ 643#define ISP_NILSTATE 0 644#define ISP_CRASHED 1 645#define ISP_RESETSTATE 2 646#define ISP_INITSTATE 3 647#define ISP_RUNSTATE 4 648 649/* 650 * ISP Runtime Configuration Options 651 */ 652#define ISP_CFG_FULL_DUPLEX 0x01 /* Full Duplex (Fibre Channel only) */ 653#define ISP_CFG_PORT_PREF 0x0c /* Mask for Port Prefs (all FC except 2100) */ 654#define ISP_CFG_LPORT 0x00 /* prefer {N/F}L-Port connection */ 655#define ISP_CFG_NPORT 0x04 /* prefer {N/F}-Port connection */ 656#define ISP_CFG_NPORT_ONLY 0x08 /* insist on {N/F}-Port connection */ 657#define ISP_CFG_LPORT_ONLY 0x0c /* insist on {N/F}L-Port connection */ 658#define ISP_CFG_ONEGB 0x10 /* force 1GB connection (23XX only) */ 659#define ISP_CFG_TWOGB 0x20 /* force 2GB connection (23XX only) */ 660#define ISP_CFG_NORELOAD 0x80 /* don't download f/w */ 661#define ISP_CFG_NONVRAM 0x40 /* ignore NVRAM */ 662#define ISP_CFG_NOFCTAPE 0x100 /* disable FC-Tape */ 663#define ISP_CFG_FCTAPE 0x200 /* enable FC-Tape */ 664#define ISP_CFG_OWNFSZ 0x400 /* override NVRAM frame size */ 665#define ISP_CFG_OWNLOOPID 0x800 /* override NVRAM loopid */ 666#define ISP_CFG_OWNEXCTHROTTLE 0x1000 /* override NVRAM execution throttle */ 667#define ISP_CFG_FOURGB 0x2000 /* force 4GB connection (24XX only) */ 668#define ISP_CFG_EIGHTGB 0x4000 /* force 8GB connection (25XX only) */ 669#define ISP_CFG_SIXTEENGB 0x8000 /* force 16GB connection (82XX only) */ 670 671/* 672 * For each channel, the outer layers should know what role that channel 673 * will take: ISP_ROLE_NONE, ISP_ROLE_INITIATOR, ISP_ROLE_TARGET, 674 * ISP_ROLE_BOTH. 675 * 676 * If you set ISP_ROLE_NONE, the cards will be reset, new firmware loaded, 677 * NVRAM read, and defaults set, but any further initialization (e.g. 678 * INITIALIZE CONTROL BLOCK commands for 2X00 cards) won't be done. 679 * 680 * If INITIATOR MODE isn't set, attempts to run commands will be stopped 681 * at isp_start and completed with the equivalent of SELECTION TIMEOUT. 682 * 683 * If TARGET MODE is set, it doesn't mean that the rest of target mode support 684 * needs to be enabled, or will even work. What happens with the 2X00 cards 685 * here is that if you have enabled it with TARGET MODE as part of the ICB 686 * options, but you haven't given the f/w any ram resources for ATIOs or 687 * Immediate Notifies, the f/w just handles what it can and you never see 688 * anything. Basically, it sends a single byte of data (the first byte, 689 * which you can set as part of the INITIALIZE CONTROL BLOCK command) for 690 * INQUIRY, and sends back QUEUE FULL status for any other command. 691 * 692 */ 693#define ISP_ROLE_NONE 0x0 694#define ISP_ROLE_TARGET 0x1 695#define ISP_ROLE_INITIATOR 0x2 696#define ISP_ROLE_BOTH (ISP_ROLE_TARGET|ISP_ROLE_INITIATOR) 697#define ISP_ROLE_EITHER ISP_ROLE_BOTH 698#ifndef ISP_DEFAULT_ROLES 699/* 700 * Counterintuitively, we prefer to default to role 'none' 701 * if we are enable target mode support. This gives us the 702 * maximum flexibility as to which port will do what. 703 */ 704#ifdef ISP_TARGET_MODE 705#define ISP_DEFAULT_ROLES ISP_ROLE_NONE 706#else 707#define ISP_DEFAULT_ROLES ISP_ROLE_INITIATOR 708#endif 709#endif 710 711 712/* 713 * Firmware related defines 714 */ 715#define ISP_CODE_ORG 0x1000 /* default f/w code start */ 716#define ISP_CODE_ORG_2300 0x0800 /* ..except for 2300s */ 717#define ISP_CODE_ORG_2400 0x100000 /* ..and 2400s */ 718#define ISP_FW_REV(maj, min, mic) ((maj << 24) | (min << 16) | mic) 719#define ISP_FW_MAJOR(code) ((code >> 24) & 0xff) 720#define ISP_FW_MINOR(code) ((code >> 16) & 0xff) 721#define ISP_FW_MICRO(code) ((code >> 8) & 0xff) 722#define ISP_FW_REVX(xp) ((xp[0]<<24) | (xp[1] << 16) | xp[2]) 723#define ISP_FW_MAJORX(xp) (xp[0]) 724#define ISP_FW_MINORX(xp) (xp[1]) 725#define ISP_FW_MICROX(xp) (xp[2]) 726#define ISP_FW_NEWER_THAN(i, major, minor, micro) \ 727 (ISP_FW_REVX((i)->isp_fwrev) > ISP_FW_REV(major, minor, micro)) 728#define ISP_FW_OLDER_THAN(i, major, minor, micro) \ 729 (ISP_FW_REVX((i)->isp_fwrev) < ISP_FW_REV(major, minor, micro)) 730 731/* 732 * Bus (implementation) types 733 */ 734#define ISP_BT_PCI 0 /* PCI Implementations */ 735#define ISP_BT_SBUS 1 /* SBus Implementations */ 736 737/* 738 * If we have not otherwise defined SBus support away make sure 739 * it is defined here such that the code is included as default 740 */ 741#ifndef ISP_SBUS_SUPPORTED 742#define ISP_SBUS_SUPPORTED 1 743#endif 744 745/* 746 * Chip Types 747 */ 748#define ISP_HA_SCSI 0xf 749#define ISP_HA_SCSI_UNKNOWN 0x1 750#define ISP_HA_SCSI_1020 0x2 751#define ISP_HA_SCSI_1020A 0x3 752#define ISP_HA_SCSI_1040 0x4 753#define ISP_HA_SCSI_1040A 0x5 754#define ISP_HA_SCSI_1040B 0x6 755#define ISP_HA_SCSI_1040C 0x7 756#define ISP_HA_SCSI_1240 0x8 757#define ISP_HA_SCSI_1080 0x9 758#define ISP_HA_SCSI_1280 0xa 759#define ISP_HA_SCSI_10160 0xb 760#define ISP_HA_SCSI_12160 0xc 761#define ISP_HA_FC 0xf0 762#define ISP_HA_FC_2100 0x10 763#define ISP_HA_FC_2200 0x20 764#define ISP_HA_FC_2300 0x30 765#define ISP_HA_FC_2312 0x40 766#define ISP_HA_FC_2322 0x50 767#define ISP_HA_FC_2400 0x60 768#define ISP_HA_FC_2500 0x70 769 770#define IS_SCSI(isp) (isp->isp_type & ISP_HA_SCSI) 771#define IS_1020(isp) (isp->isp_type < ISP_HA_SCSI_1240) 772#define IS_1240(isp) (isp->isp_type == ISP_HA_SCSI_1240) 773#define IS_1080(isp) (isp->isp_type == ISP_HA_SCSI_1080) 774#define IS_1280(isp) (isp->isp_type == ISP_HA_SCSI_1280) 775#define IS_10160(isp) (isp->isp_type == ISP_HA_SCSI_10160) 776#define IS_12160(isp) (isp->isp_type == ISP_HA_SCSI_12160) 777 778#define IS_12X0(isp) (IS_1240(isp) || IS_1280(isp)) 779#define IS_1X160(isp) (IS_10160(isp) || IS_12160(isp)) 780#define IS_DUALBUS(isp) (IS_12X0(isp) || IS_12160(isp)) 781#define IS_ULTRA2(isp) (IS_1080(isp) || IS_1280(isp) || IS_1X160(isp)) 782#define IS_ULTRA3(isp) (IS_1X160(isp)) 783 784#define IS_FC(isp) ((isp)->isp_type & ISP_HA_FC) 785#define IS_2100(isp) ((isp)->isp_type == ISP_HA_FC_2100) 786#define IS_2200(isp) ((isp)->isp_type == ISP_HA_FC_2200) 787#define IS_23XX(isp) ((isp)->isp_type >= ISP_HA_FC_2300 && \ 788 (isp)->isp_type < ISP_HA_FC_2400) 789#define IS_2300(isp) ((isp)->isp_type == ISP_HA_FC_2300) 790#define IS_2312(isp) ((isp)->isp_type == ISP_HA_FC_2312) 791#define IS_2322(isp) ((isp)->isp_type == ISP_HA_FC_2322) 792#define IS_24XX(isp) ((isp)->isp_type >= ISP_HA_FC_2400) 793#define IS_25XX(isp) ((isp)->isp_type >= ISP_HA_FC_2500) 794 795/* 796 * DMA related macros 797 */ 798#define DMA_WD3(x) (((uint16_t)(((uint64_t)x) >> 48)) & 0xffff) 799#define DMA_WD2(x) (((uint16_t)(((uint64_t)x) >> 32)) & 0xffff) 800#define DMA_WD1(x) ((uint16_t)((x) >> 16) & 0xffff) 801#define DMA_WD0(x) ((uint16_t)((x) & 0xffff)) 802 803#define DMA_LO32(x) ((uint32_t) (x)) 804#define DMA_HI32(x) ((uint32_t)(((uint64_t)x) >> 32)) 805 806/* 807 * Core System Function Prototypes 808 */ 809 810/* 811 * Reset Hardware. Totally. Assumes that you'll follow this with a call to isp_init. 812 */ 813void isp_reset(ispsoftc_t *, int); 814 815/* 816 * Initialize Hardware to known state 817 */ 818void isp_init(ispsoftc_t *); 819 820/* 821 * Reset the ISP and call completion for any orphaned commands. 822 */ 823int isp_reinit(ispsoftc_t *, int); 824 825/* 826 * Internal Interrupt Service Routine 827 * 828 * The outer layers do the spade work to get the appropriate status register, 829 * semaphore register and first mailbox register (if appropriate). This also 830 * means that most spurious/bogus interrupts not for us can be filtered first. 831 */ 832void isp_intr(ispsoftc_t *, uint16_t, uint16_t, uint16_t); 833 834 835/* 836 * Command Entry Point- Platform Dependent layers call into this 837 */ 838int isp_start(XS_T *); 839 840/* these values are what isp_start returns */ 841#define CMD_COMPLETE 101 /* command completed */ 842#define CMD_EAGAIN 102 /* busy- maybe retry later */ 843#define CMD_QUEUED 103 /* command has been queued for execution */ 844#define CMD_RQLATER 104 /* requeue this command later */ 845 846/* 847 * Command Completion Point- Core layers call out from this with completed cmds 848 */ 849void isp_done(XS_T *); 850 851/* 852 * Platform Dependent to External to Internal Control Function 853 * 854 * Assumes locks are held on entry. You should note that with many of 855 * these commands locks may be released while this function is called. 856 * 857 * ... ISPCTL_RESET_BUS, int channel); 858 * Reset BUS on this channel 859 * ... ISPCTL_RESET_DEV, int channel, int target); 860 * Reset Device on this channel at this target. 861 * ... ISPCTL_ABORT_CMD, XS_T *xs); 862 * Abort active transaction described by xs. 863 * ... IPCTL_UPDATE_PARAMS); 864 * Update any operating parameters (speed, etc.) 865 * ... ISPCTL_FCLINK_TEST, int channel); 866 * Test FC link status on this channel 867 * ... ISPCTL_SCAN_FABRIC, int channel); 868 * Scan fabric on this channel 869 * ... ISPCTL_SCAN_LOOP, int channel); 870 * Scan local loop on this channel 871 * ... ISPCTL_PDB_SYNC, int channel); 872 * Synchronize port database on this channel 873 * ... ISPCTL_SEND_LIP, int channel); 874 * Send a LIP on this channel 875 * ... ISPCTL_GET_NAMES, int channel, int np, uint64_t *wwnn, uint64_t *wwpn) 876 * Get a WWNN/WWPN for this N-port handle on this channel 877 * ... ISPCTL_RUN_MBOXCMD, mbreg_t *mbp) 878 * Run this mailbox command 879 * ... ISPCTL_GET_PDB, int channel, int nphandle, isp_pdb_t *pdb) 880 * Get PDB on this channel for this N-port handle 881 * ... ISPCTL_PLOGX, isp_plcmd_t *) 882 * Performa a port login/logout 883 * ... ISPCTL_CHANGE_ROLE, int channel, int role); 884 * Change role of specified channel 885 * 886 * ISPCTL_PDB_SYNC is somewhat misnamed. It actually is the final step, in 887 * order, of ISPCTL_FCLINK_TEST, ISPCTL_SCAN_FABRIC, and ISPCTL_SCAN_LOOP. 888 * The main purpose of ISPCTL_PDB_SYNC is to complete management of logging 889 * and logging out of fabric devices (if one is on a fabric) and then marking 890 * the 'loop state' as being ready to now be used for sending commands to 891 * devices. Originally fabric name server and local loop scanning were 892 * part of this function. It's now been separated to allow for finer control. 893 */ 894typedef enum { 895 ISPCTL_RESET_BUS, 896 ISPCTL_RESET_DEV, 897 ISPCTL_ABORT_CMD, 898 ISPCTL_UPDATE_PARAMS, 899 ISPCTL_FCLINK_TEST, 900 ISPCTL_SCAN_FABRIC, 901 ISPCTL_SCAN_LOOP, 902 ISPCTL_PDB_SYNC, 903 ISPCTL_SEND_LIP, 904 ISPCTL_GET_NAMES, 905 ISPCTL_RUN_MBOXCMD, 906 ISPCTL_GET_PDB, 907 ISPCTL_PLOGX, 908 ISPCTL_CHANGE_ROLE 909} ispctl_t; 910int isp_control(ispsoftc_t *, ispctl_t, ...); 911 912/* 913 * Platform Dependent to Internal to External Control Function 914 */ 915 916typedef enum { 917 ISPASYNC_NEW_TGT_PARAMS, /* SPI New Target Parameters */ 918 ISPASYNC_BUS_RESET, /* All Bus Was Reset */ 919 ISPASYNC_LOOP_DOWN, /* FC Loop Down */ 920 ISPASYNC_LOOP_UP, /* FC Loop Up */ 921 ISPASYNC_LIP, /* FC LIP Received */ 922 ISPASYNC_LOOP_RESET, /* FC Loop Reset Received */ 923 ISPASYNC_CHANGE_NOTIFY, /* FC Change Notification */ 924 ISPASYNC_DEV_ARRIVED, /* FC Device Arrived */ 925 ISPASYNC_DEV_CHANGED, /* FC Device Changed */ 926 ISPASYNC_DEV_STAYED, /* FC Device Stayed */ 927 ISPASYNC_DEV_GONE, /* FC Device Departure */ 928 ISPASYNC_TARGET_NOTIFY, /* All target async notification */ 929 ISPASYNC_TARGET_NOTIFY_ACK, /* All target notify ack required */ 930 ISPASYNC_TARGET_ACTION, /* All target action requested */ 931 ISPASYNC_FW_CRASH, /* All Firmware has crashed */ 932 ISPASYNC_FW_RESTARTED /* All Firmware has been restarted */ 933} ispasync_t; 934void isp_async(ispsoftc_t *, ispasync_t, ...); 935 936#define ISPASYNC_CHANGE_PDB 0 937#define ISPASYNC_CHANGE_SNS 1 938#define ISPASYNC_CHANGE_OTHER 2 939 940/* 941 * Platform Independent Error Prinout 942 */ 943void isp_prt_endcmd(ispsoftc_t *, XS_T *); 944 945/* 946 * Platform Dependent Error and Debug Printout 947 * 948 * Two required functions for each platform must be provided: 949 * 950 * void isp_prt(ispsoftc_t *, int level, const char *, ...) 951 * void isp_xs_prt(ispsoftc_t *, XS_T *, int level, const char *, ...) 952 * 953 * but due to compiler differences on different platforms this won't be 954 * formally defined here. Instead, they go in each platform definition file. 955 */ 956 957#define ISP_LOGALL 0x0 /* log always */ 958#define ISP_LOGCONFIG 0x1 /* log configuration messages */ 959#define ISP_LOGINFO 0x2 /* log informational messages */ 960#define ISP_LOGWARN 0x4 /* log warning messages */ 961#define ISP_LOGERR 0x8 /* log error messages */ 962#define ISP_LOGDEBUG0 0x10 /* log simple debug messages */ 963#define ISP_LOGDEBUG1 0x20 /* log intermediate debug messages */ 964#define ISP_LOGDEBUG2 0x40 /* log most debug messages */ 965#define ISP_LOGDEBUG3 0x80 /* log high frequency debug messages */ 966#define ISP_LOG_SANCFG 0x100 /* log SAN configuration */ 967#define ISP_LOG_CWARN 0x200 /* log SCSI command "warnings" (e.g., check conditions) */ 968#define ISP_LOG_WARN1 0x400 /* log WARNS we might be interested at some time */ 969#define ISP_LOGTINFO 0x1000 /* log informational messages (target mode) */ 970#define ISP_LOGTDEBUG0 0x2000 /* log simple debug messages (target mode) */ 971#define ISP_LOGTDEBUG1 0x4000 /* log intermediate debug messages (target) */ 972#define ISP_LOGTDEBUG2 0x8000 /* log all debug messages (target) */ 973 974/* 975 * Each Platform provides it's own isposinfo substructure of the ispsoftc 976 * defined above. 977 * 978 * Each platform must also provide the following macros/defines: 979 * 980 * 981 * ISP_FC_SCRLEN FC scratch area DMA length 982 * 983 * ISP_MEMZERO(dst, src) platform zeroing function 984 * ISP_MEMCPY(dst, src, count) platform copying function 985 * ISP_SNPRINTF(buf, bufsize, fmt, ...) snprintf 986 * ISP_DELAY(usecs) microsecond spindelay function 987 * ISP_SLEEP(isp, usecs) microsecond sleep function 988 * 989 * ISP_INLINE ___inline or not- depending on how 990 * good your debugger is 991 * ISP_MIN shorthand for ((a) < (b))? (a) : (b) 992 * 993 * NANOTIME_T nanosecond time type 994 * 995 * GET_NANOTIME(NANOTIME_T *) get current nanotime. 996 * 997 * GET_NANOSEC(NANOTIME_T *) get uint64_t from NANOTIME_T 998 * 999 * NANOTIME_SUB(NANOTIME_T *, NANOTIME_T *) 1000 * subtract two NANOTIME_T values 1001 * 1002 * MAXISPREQUEST(ispsoftc_t *) maximum request queue size 1003 * for this particular board type 1004 * 1005 * MEMORYBARRIER(ispsoftc_t *, barrier_type, offset, size, chan) 1006 * 1007 * Function/Macro the provides memory synchronization on 1008 * various objects so that the ISP's and the system's view 1009 * of the same object is consistent. 1010 * 1011 * MBOX_ACQUIRE(ispsoftc_t *) acquire lock on mailbox regs 1012 * MBOX_WAIT_COMPLETE(ispsoftc_t *, mbreg_t *) wait for cmd to be done 1013 * MBOX_NOTIFY_COMPLETE(ispsoftc_t *) notification of mbox cmd donee 1014 * MBOX_RELEASE(ispsoftc_t *) release lock on mailbox regs 1015 * 1016 * FC_SCRATCH_ACQUIRE(ispsoftc_t *, chan) acquire lock on FC scratch area 1017 * return -1 if you cannot 1018 * FC_SCRATCH_RELEASE(ispsoftc_t *, chan) acquire lock on FC scratch area 1019 * 1020 * FCP_NEXT_CRN(ispsoftc_t *, XS_T *, rslt, channel, target, lun) generate the next command reference number. XS_T * may be null. 1021 * 1022 * SCSI_GOOD SCSI 'Good' Status 1023 * SCSI_CHECK SCSI 'Check Condition' Status 1024 * SCSI_BUSY SCSI 'Busy' Status 1025 * SCSI_QFULL SCSI 'Queue Full' Status 1026 * 1027 * XS_T Platform SCSI transaction type (i.e., command for HBA) 1028 * XS_DMA_ADDR_T Platform PCI DMA Address Type 1029 * XS_GET_DMA_SEG(..) Get 32 bit dma segment list value 1030 * XS_GET_DMA64_SEG(..) Get 64 bit dma segment list value 1031 * XS_ISP(xs) gets an instance out of an XS_T 1032 * XS_CHANNEL(xs) gets the channel (bus # for DUALBUS cards) "" 1033 * XS_TGT(xs) gets the target "" 1034 * XS_LUN(xs) gets the lun "" 1035 * XS_CDBP(xs) gets a pointer to the scsi CDB "" 1036 * XS_CDBLEN(xs) gets the CDB's length "" 1037 * XS_XFRLEN(xs) gets the associated data transfer length "" 1038 * XS_TIME(xs) gets the time (in milliseconds) for this command 1039 * XS_GET_RESID(xs) gets the current residual count 1040 * XS_GET_RESID(xs, resid) sets the current residual count 1041 * XS_STSP(xs) gets a pointer to the SCSI status byte "" 1042 * XS_SNSP(xs) gets a pointer to the associate sense data 1043 * XS_TOT_SNSLEN(xs) gets the total length of sense data storage 1044 * XS_CUR_SNSLEN(xs) gets the currently used lenght of sense data storage 1045 * XS_SNSKEY(xs) dereferences XS_SNSP to get the current stored Sense Key 1046 * XS_SNSASC(xs) dereferences XS_SNSP to get the current stored Additional Sense Code 1047 * XS_SNSASCQ(xs) dereferences XS_SNSP to get the current stored Additional Sense Code Qualifier 1048 * XS_TAG_P(xs) predicate of whether this command should be tagged 1049 * XS_TAG_TYPE(xs) which type of tag to use 1050 * XS_SETERR(xs) set error state 1051 * 1052 * HBA_NOERROR command has no erros 1053 * HBA_BOTCH hba botched something 1054 * HBA_CMDTIMEOUT command timed out 1055 * HBA_SELTIMEOUT selection timed out (also port logouts for FC) 1056 * HBA_TGTBSY target returned a BUSY status 1057 * HBA_BUSRESET bus reset destroyed command 1058 * HBA_ABORTED command was aborted (by request) 1059 * HBA_DATAOVR a data overrun was detected 1060 * HBA_ARQFAIL Automatic Request Sense failed 1061 * 1062 * XS_ERR(xs) return current error state 1063 * XS_NOERR(xs) there is no error currently set 1064 * XS_INITERR(xs) initialize error state 1065 * 1066 * XS_SAVE_SENSE(xs, sp, total_len, this_len) save sense data (total and current amount) 1067 * 1068 * XS_APPEND_SENSE(xs, sp, len) append more sense data 1069 * 1070 * XS_SENSE_VALID(xs) indicates whether sense is valid 1071 * 1072 * DEFAULT_FRAMESIZE(ispsoftc_t *) Default Frame Size 1073 * DEFAULT_EXEC_THROTTLE(ispsoftc_t *) Default Execution Throttle 1074 * 1075 * GET_DEFAULT_ROLE(ispsoftc_t *, int) Get Default Role for a channel 1076 * SET_DEFAULT_ROLE(ispsoftc_t *, int, int) Set Default Role for a channel 1077 * DEFAULT_IID(ispsoftc_t *, int) Default SCSI initiator ID 1078 * DEFAULT_LOOPID(ispsoftc_t *, int) Default FC Loop ID 1079 * 1080 * These establish reasonable defaults for each platform. 1081 * These must be available independent of card NVRAM and are 1082 * to be used should NVRAM not be readable. 1083 * 1084 * DEFAULT_NODEWWN(ispsoftc_t *, chan) Default FC Node WWN to use 1085 * DEFAULT_PORTWWN(ispsoftc_t *, chan) Default FC Port WWN to use 1086 * 1087 * These defines are hooks to allow the setting of node and 1088 * port WWNs when NVRAM cannot be read or is to be overriden. 1089 * 1090 * ACTIVE_NODEWWN(ispsoftc_t *, chan) FC Node WWN to use 1091 * ACTIVE_PORTWWN(ispsoftc_t *, chan) FC Port WWN to use 1092 * 1093 * After NVRAM is read, these will be invoked to get the 1094 * node and port WWNs that will actually be used for this 1095 * channel. 1096 * 1097 * 1098 * ISP_IOXPUT_8(ispsoftc_t *, uint8_t srcval, uint8_t *dstptr) 1099 * ISP_IOXPUT_16(ispsoftc_t *, uint16_t srcval, uint16_t *dstptr) 1100 * ISP_IOXPUT_32(ispsoftc_t *, uint32_t srcval, uint32_t *dstptr) 1101 * 1102 * ISP_IOXGET_8(ispsoftc_t *, uint8_t *srcptr, uint8_t dstrval) 1103 * ISP_IOXGET_16(ispsoftc_t *, uint16_t *srcptr, uint16_t dstrval) 1104 * ISP_IOXGET_32(ispsoftc_t *, uint32_t *srcptr, uint32_t dstrval) 1105 * 1106 * ISP_SWIZZLE_NVRAM_WORD(ispsoftc_t *, uint16_t *) 1107 * ISP_SWIZZLE_NVRAM_LONG(ispsoftc_t *, uint32_t *) 1108 * ISP_SWAP16(ispsoftc_t *, uint16_t srcval) 1109 * ISP_SWAP32(ispsoftc_t *, uint32_t srcval) 1110 */ 1111 1112#ifdef ISP_TARGET_MODE 1113/* 1114 * The functions below are for the publicly available 1115 * target mode functions that are internal to the Qlogic driver. 1116 */ 1117 1118/* 1119 * This function handles new response queue entry appropriate for target mode. 1120 */ 1121int isp_target_notify(ispsoftc_t *, void *, uint32_t *); 1122 1123/* 1124 * This function externalizes the ability to acknowledge an Immediate Notify request. 1125 */ 1126int isp_notify_ack(ispsoftc_t *, void *); 1127 1128/* 1129 * This function externalized acknowledging (success/fail) an ABTS frame 1130 */ 1131int isp_acknak_abts(ispsoftc_t *, void *, int); 1132 1133/* 1134 * Enable/Disable/Modify a logical unit. 1135 * (softc, cmd, bus, tgt, lun, cmd_cnt, inotify_cnt) 1136 */ 1137#define DFLT_CMND_CNT 0xff /* unmonitored */ 1138#define DFLT_INOT_CNT 0xff /* unmonitored */ 1139int isp_lun_cmd(ispsoftc_t *, int, int, int, int, int); 1140 1141/* 1142 * General request queue 'put' routine for target mode entries. 1143 */ 1144int isp_target_put_entry(ispsoftc_t *isp, void *); 1145 1146/* 1147 * General routine to put back an ATIO entry- 1148 * used for replenishing f/w resource counts. 1149 * The argument is a pointer to a source ATIO 1150 * or ATIO2. 1151 */ 1152int isp_target_put_atio(ispsoftc_t *, void *); 1153 1154/* 1155 * General routine to send a final CTIO for a command- used mostly for 1156 * local responses. 1157 */ 1158int isp_endcmd(ispsoftc_t *, ...); 1159#define ECMD_SVALID 0x100 1160#define ECMD_TERMINATE 0x200 1161 1162/* 1163 * Handle an asynchronous event 1164 * 1165 * Return nonzero if the interrupt that generated this event has been dismissed. 1166 */ 1167int isp_target_async(ispsoftc_t *, int, int); 1168#endif 1169#endif /* _ISPVAR_H */ 1170