ispvar.h revision 84241
1/* $FreeBSD: head/sys/dev/isp/ispvar.h 84241 2001-10-01 03:45:54Z mjacob $ */ 2/* 3 * Soft Definitions for for Qlogic ISP SCSI adapters. 4 * 5 * Copyright (c) 1997, 1998, 1999, 2000 by Matthew Jacob 6 * All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice immediately at the beginning of the file, without modification, 13 * this list of conditions, and the following disclaimer. 14 * 2. The name of the author may not be used to endorse or promote products 15 * derived from this software without specific prior written permission. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR 21 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27 * SUCH DAMAGE. 28 * 29 */ 30 31#ifndef _ISPVAR_H 32#define _ISPVAR_H 33 34#if defined(__NetBSD__) || defined(__OpenBSD__) 35#include <dev/ic/ispmbox.h> 36#ifdef ISP_TARGET_MODE 37#include <dev/ic/isp_target.h> 38#include <dev/ic/isp_tpublic.h> 39#endif 40#endif 41#ifdef __FreeBSD__ 42#include <dev/isp/ispmbox.h> 43#ifdef ISP_TARGET_MODE 44#include <dev/isp/isp_target.h> 45#include <dev/isp/isp_tpublic.h> 46#endif 47#endif 48#ifdef __linux__ 49#include "ispmbox.h" 50#ifdef ISP_TARGET_MODE 51#include "isp_target.h" 52#include "isp_tpublic.h" 53#endif 54#endif 55 56#define ISP_CORE_VERSION_MAJOR 2 57#define ISP_CORE_VERSION_MINOR 4 58 59/* 60 * Vector for bus specific code to provide specific services. 61 */ 62struct ispsoftc; 63struct ispmdvec { 64 int (*dv_rd_isr) 65 (struct ispsoftc *, u_int16_t *, u_int16_t *, u_int16_t *); 66 u_int16_t (*dv_rd_reg) (struct ispsoftc *, int); 67 void (*dv_wr_reg) (struct ispsoftc *, int, u_int16_t); 68 int (*dv_mbxdma) (struct ispsoftc *); 69 int (*dv_dmaset) (struct ispsoftc *, 70 XS_T *, ispreq_t *, u_int16_t *, u_int16_t); 71 void (*dv_dmaclr) 72 (struct ispsoftc *, XS_T *, u_int16_t); 73 void (*dv_reset0) (struct ispsoftc *); 74 void (*dv_reset1) (struct ispsoftc *); 75 void (*dv_dregs) (struct ispsoftc *, const char *); 76 const u_int16_t *dv_ispfw; /* ptr to f/w */ 77 u_int16_t dv_conf1; 78 u_int16_t dv_clock; /* clock frequency */ 79}; 80 81/* 82 * Overall parameters 83 */ 84#define MAX_TARGETS 16 85#define MAX_FC_TARG 256 86#define ISP_MAX_TARGETS(isp) (IS_FC(isp)? MAX_FC_TARG : MAX_TARGETS) 87#define ISP_MAX_LUNS(isp) (isp)->isp_maxluns 88 89/* 90 * 'Types' 91 */ 92#ifndef ISP_DMA_ADDR_T 93#define ISP_DMA_ADDR_T u_int32_t 94#endif 95 96/* 97 * Macros to access ISP registers through bus specific layers- 98 * mostly wrappers to vector through the mdvec structure. 99 */ 100#define ISP_READ_ISR(isp, isrp, semap, mbox0p) \ 101 (*(isp)->isp_mdvec->dv_rd_isr)(isp, isrp, semap, mbox0p) 102 103#define ISP_READ(isp, reg) \ 104 (*(isp)->isp_mdvec->dv_rd_reg)((isp), (reg)) 105 106#define ISP_WRITE(isp, reg, val) \ 107 (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), (val)) 108 109#define ISP_MBOXDMASETUP(isp) \ 110 (*(isp)->isp_mdvec->dv_mbxdma)((isp)) 111 112#define ISP_DMASETUP(isp, xs, req, iptrp, optr) \ 113 (*(isp)->isp_mdvec->dv_dmaset)((isp), (xs), (req), (iptrp), (optr)) 114 115#define ISP_DMAFREE(isp, xs, hndl) \ 116 if ((isp)->isp_mdvec->dv_dmaclr) \ 117 (*(isp)->isp_mdvec->dv_dmaclr)((isp), (xs), (hndl)) 118 119#define ISP_RESET0(isp) \ 120 if ((isp)->isp_mdvec->dv_reset0) (*(isp)->isp_mdvec->dv_reset0)((isp)) 121#define ISP_RESET1(isp) \ 122 if ((isp)->isp_mdvec->dv_reset1) (*(isp)->isp_mdvec->dv_reset1)((isp)) 123#define ISP_DUMPREGS(isp, m) \ 124 if ((isp)->isp_mdvec->dv_dregs) (*(isp)->isp_mdvec->dv_dregs)((isp),(m)) 125 126#define ISP_SETBITS(isp, reg, val) \ 127 (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), ISP_READ((isp), (reg)) | (val)) 128 129#define ISP_CLRBITS(isp, reg, val) \ 130 (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), ISP_READ((isp), (reg)) & ~(val)) 131 132/* 133 * The MEMORYBARRIER macro is defined per platform (to provide synchronization 134 * on Request and Response Queues, Scratch DMA areas, and Registers) 135 * 136 * Defined Memory Barrier Synchronization Types 137 */ 138#define SYNC_REQUEST 0 /* request queue synchronization */ 139#define SYNC_RESULT 1 /* result queue synchronization */ 140#define SYNC_SFORDEV 2 /* scratch, sync for ISP */ 141#define SYNC_SFORCPU 3 /* scratch, sync for CPU */ 142#define SYNC_REG 4 /* for registers */ 143 144/* 145 * Request/Response Queue defines and macros. 146 * The maximum is defined per platform (and can be based on board type). 147 */ 148/* This is the size of a queue entry (request and response) */ 149#define QENTRY_LEN 64 150/* Both request and result queue length must be a power of two */ 151#define RQUEST_QUEUE_LEN(x) MAXISPREQUEST(x) 152#define RESULT_QUEUE_LEN(x) \ 153 (((MAXISPREQUEST(x) >> 2) < 64)? 64 : MAXISPREQUEST(x) >> 2) 154#define ISP_QUEUE_ENTRY(q, idx) ((q) + ((idx) * QENTRY_LEN)) 155#define ISP_QUEUE_SIZE(n) ((n) * QENTRY_LEN) 156#define ISP_NXT_QENTRY(idx, qlen) (((idx) + 1) & ((qlen)-1)) 157#define ISP_QFREE(in, out, qlen) \ 158 ((in == out)? (qlen - 1) : ((in > out)? \ 159 ((qlen - 1) - (in - out)) : (out - in - 1))) 160#define ISP_QAVAIL(isp) \ 161 ISP_QFREE(isp->isp_reqidx, isp->isp_reqodx, RQUEST_QUEUE_LEN(isp)) 162 163#define ISP_ADD_REQUEST(isp, iptr) \ 164 MEMORYBARRIER(isp, SYNC_REQUEST, iptr, QENTRY_LEN); \ 165 WRITE_REQUEST_QUEUE_IN_POINTER(isp, iptr); \ 166 isp->isp_reqidx = iptr 167 168/* 169 * SCSI Specific Host Adapter Parameters- per bus, per target 170 */ 171 172typedef struct { 173 u_int isp_gotdparms : 1, 174 isp_req_ack_active_neg : 1, 175 isp_data_line_active_neg: 1, 176 isp_cmd_dma_burst_enable: 1, 177 isp_data_dma_burst_enabl: 1, 178 isp_fifo_threshold : 3, 179 isp_ultramode : 1, 180 isp_diffmode : 1, 181 isp_lvdmode : 1, 182 isp_fast_mttr : 1, /* fast sram */ 183 isp_initiator_id : 4, 184 isp_async_data_setup : 4; 185 u_int16_t isp_selection_timeout; 186 u_int16_t isp_max_queue_depth; 187 u_int8_t isp_tag_aging; 188 u_int8_t isp_bus_reset_delay; 189 u_int8_t isp_retry_count; 190 u_int8_t isp_retry_delay; 191 struct { 192 u_int32_t 193 exc_throttle : 8, 194 : 1, 195 dev_enable : 1, /* ignored */ 196 dev_update : 1, 197 dev_refresh : 1, 198 actv_offset : 4, 199 goal_offset : 4, 200 nvrm_offset : 4; 201 u_int8_t actv_period; /* current sync period */ 202 u_int8_t goal_period; /* goal sync period */ 203 u_int8_t nvrm_period; /* nvram sync period */ 204 u_int16_t actv_flags; /* current device flags */ 205 u_int16_t goal_flags; /* goal device flags */ 206 u_int16_t nvrm_flags; /* nvram device flags */ 207 } isp_devparam[MAX_TARGETS]; 208} sdparam; 209 210/* 211 * Device Flags 212 */ 213#define DPARM_DISC 0x8000 214#define DPARM_PARITY 0x4000 215#define DPARM_WIDE 0x2000 216#define DPARM_SYNC 0x1000 217#define DPARM_TQING 0x0800 218#define DPARM_ARQ 0x0400 219#define DPARM_QFRZ 0x0200 220#define DPARM_RENEG 0x0100 221#define DPARM_NARROW 0x0080 222#define DPARM_ASYNC 0x0040 223#define DPARM_PPR 0x0020 224#define DPARM_DEFAULT (0xFF00 & ~DPARM_QFRZ) 225#define DPARM_SAFE_DFLT (DPARM_DEFAULT & ~(DPARM_WIDE|DPARM_SYNC|DPARM_TQING)) 226 227 228/* technically, not really correct, as they need to be rated based upon clock */ 229#define ISP_80M_SYNCPARMS 0x0c09 230#define ISP_40M_SYNCPARMS 0x0c0a 231#define ISP_20M_SYNCPARMS 0x0c0c 232#define ISP_20M_SYNCPARMS_1040 0x080c 233#define ISP_10M_SYNCPARMS 0x0c19 234#define ISP_08M_SYNCPARMS 0x0c25 235#define ISP_05M_SYNCPARMS 0x0c32 236#define ISP_04M_SYNCPARMS 0x0c41 237 238/* 239 * Fibre Channel Specifics 240 */ 241#define FL_PORT_ID 0x7e /* FL_Port Special ID */ 242#define FC_PORT_ID 0x7f /* Fabric Controller Special ID */ 243#define FC_SNS_ID 0x80 /* SNS Server Special ID */ 244 245typedef struct { 246 u_int32_t isp_fwoptions : 16, 247 isp_gbspeed : 2, 248 isp_iid_set : 1, 249 loop_seen_once : 1, 250 isp_loopstate : 4, /* Current Loop State */ 251 isp_fwstate : 3, /* ISP F/W state */ 252 isp_gotdparms : 1, 253 isp_topo : 3, 254 isp_onfabric : 1; 255 u_int8_t isp_iid; /* 'initiator' id */ 256 u_int8_t isp_loopid; /* hard loop id */ 257 u_int8_t isp_alpa; /* ALPA */ 258 u_int32_t isp_portid; 259 volatile u_int16_t isp_lipseq; /* LIP sequence # */ 260 u_int16_t isp_fwattr; /* firmware attributes */ 261 u_int8_t isp_execthrottle; 262 u_int8_t isp_retry_delay; 263 u_int8_t isp_retry_count; 264 u_int8_t isp_reserved; 265 u_int16_t isp_maxalloc; 266 u_int16_t isp_maxfrmlen; 267 u_int64_t isp_nodewwn; 268 u_int64_t isp_portwwn; 269 /* 270 * Port Data Base. This is indexed by 'target', which is invariate. 271 * However, elements within can move around due to loop changes, 272 * so the actual loop ID passed to the F/W is in this structure. 273 * The first time the loop is seen up, loopid will match the index 274 * (except for fabric nodes which are above mapped above FC_SNS_ID 275 * and are completely virtual), but subsequent LIPs can cause things 276 * to move around. 277 */ 278 struct lportdb { 279 u_int 280 loopid : 8, 281 : 1, 282 force_logout : 1, 283 was_fabric_dev : 1, 284 fabric_dev : 1, 285 loggedin : 1, 286 roles : 2, 287 valid : 1; 288 u_int32_t portid; 289 u_int64_t node_wwn; 290 u_int64_t port_wwn; 291 } portdb[MAX_FC_TARG], tport[FC_PORT_ID]; 292 293 /* 294 * Scratch DMA mapped in area to fetch Port Database stuff, etc. 295 */ 296 caddr_t isp_scratch; 297 ISP_DMA_ADDR_T isp_scdma; 298} fcparam; 299 300#define FW_CONFIG_WAIT 0 301#define FW_WAIT_AL_PA 1 302#define FW_WAIT_LOGIN 2 303#define FW_READY 3 304#define FW_LOSS_OF_SYNC 4 305#define FW_ERROR 5 306#define FW_REINIT 6 307#define FW_NON_PART 7 308 309#define LOOP_NIL 0 310#define LOOP_LIP_RCVD 1 311#define LOOP_PDB_RCVD 2 312#define LOOP_SCANNING_FABRIC 3 313#define LOOP_FSCAN_DONE 4 314#define LOOP_SCANNING_LOOP 5 315#define LOOP_LSCAN_DONE 6 316#define LOOP_SYNCING_PDB 7 317#define LOOP_READY 8 318 319#define TOPO_NL_PORT 0 320#define TOPO_FL_PORT 1 321#define TOPO_N_PORT 2 322#define TOPO_F_PORT 3 323#define TOPO_PTP_STUB 4 324 325/* 326 * Soft Structure per host adapter 327 */ 328typedef struct ispsoftc { 329 /* 330 * Platform (OS) specific data 331 */ 332 struct isposinfo isp_osinfo; 333 334 /* 335 * Pointer to bus specific functions and data 336 */ 337 struct ispmdvec * isp_mdvec; 338 339 /* 340 * (Mostly) nonvolatile state. Board specific parameters 341 * may contain some volatile state (e.g., current loop state). 342 */ 343 344 void * isp_param; /* type specific */ 345 u_int16_t isp_fwrev[3]; /* Loaded F/W revision */ 346 u_int16_t isp_romfw_rev[3]; /* PROM F/W revision */ 347 u_int16_t isp_maxcmds; /* max possible I/O cmds */ 348 u_int8_t isp_type; /* HBA Chip Type */ 349 u_int8_t isp_revision; /* HBA Chip H/W Revision */ 350 u_int32_t isp_maxluns; /* maximum luns supported */ 351 352 u_int32_t isp_clock : 8, /* input clock */ 353 : 6, 354 isp_role : 2, 355 : 1, 356 isp_touched : 1, /* board ever seen? */ 357 isp_bustype : 1, /* SBus or PCI */ 358 isp_loaded_fw : 1, /* loaded firmware */ 359 isp_dblev : 12; /* debug log mask */ 360 361 u_int32_t isp_confopts; /* config options */ 362 363 u_int16_t isp_rqstinrp; /* register for REQINP */ 364 u_int16_t isp_rqstoutrp; /* register for REQOUTP */ 365 u_int16_t isp_respinrp; /* register for RESINP */ 366 u_int16_t isp_respoutrp; /* register for RESOUTP */ 367 368 /* 369 * Instrumentation 370 */ 371 u_int64_t isp_intcnt; /* total int count */ 372 u_int64_t isp_intbogus; /* spurious int count */ 373 374 /* 375 * Volatile state 376 */ 377 378 volatile u_int32_t 379 isp_mboxbsy : 8, /* mailbox command active */ 380 : 1, 381 isp_state : 3, 382 isp_sendmarker : 2, /* send a marker entry */ 383 isp_update : 2, /* update parameters */ 384 isp_nactive : 16; /* how many commands active */ 385 volatile u_int16_t isp_reqodx; /* index of last ISP pickup */ 386 volatile u_int16_t isp_reqidx; /* index of next request */ 387 volatile u_int16_t isp_residx; /* index of next result */ 388 volatile u_int16_t isp_lasthdls; /* last handle seed */ 389 volatile u_int16_t isp_mboxtmp[MAX_MAILBOX]; 390 volatile u_int16_t isp_lastmbxcmd; /* last mbox command sent */ 391 392 /* 393 * Active commands are stored here, indexed by handle functions. 394 */ 395 XS_T **isp_xflist; 396 397 /* 398 * request/result queue pointers and dma handles for them. 399 */ 400 caddr_t isp_rquest; 401 caddr_t isp_result; 402 ISP_DMA_ADDR_T isp_rquest_dma; 403 ISP_DMA_ADDR_T isp_result_dma; 404} ispsoftc_t; 405 406#define SDPARAM(isp) ((sdparam *) (isp)->isp_param) 407#define FCPARAM(isp) ((fcparam *) (isp)->isp_param) 408 409/* 410 * ISP Driver Run States 411 */ 412#define ISP_NILSTATE 0 413#define ISP_RESETSTATE 1 414#define ISP_INITSTATE 2 415#define ISP_RUNSTATE 3 416 417/* 418 * ISP Configuration Options 419 */ 420#define ISP_CFG_NORELOAD 0x80 /* don't download f/w */ 421#define ISP_CFG_NONVRAM 0x40 /* ignore NVRAM */ 422#define ISP_CFG_TWOGB 0x20 /* force 2GB connection (23XX only) */ 423#define ISP_CFG_ONEGB 0x10 /* force 1GB connection (23XX only) */ 424#define ISP_CFG_FULL_DUPLEX 0x01 /* Full Duplex (Fibre Channel only) */ 425#define ISP_CFG_OWNWWN 0x02 /* override NVRAM wwn */ 426#define ISP_CFG_PORT_PREF 0x0C /* Mask for Port Prefs (2200 only) */ 427#define ISP_CFG_LPORT 0x00 /* prefer {N/F}L-Port connection */ 428#define ISP_CFG_NPORT 0x04 /* prefer {N/F}-Port connection */ 429#define ISP_CFG_NPORT_ONLY 0x08 /* insist on {N/F}-Port connection */ 430#define ISP_CFG_LPORT_ONLY 0x0C /* insist on {N/F}L-Port connection */ 431 432/* 433 * Prior to calling isp_reset for the first time, the outer layer 434 * should set isp_role to one of NONE, INITIATOR, TARGET, BOTH. 435 * 436 * If you set ISP_ROLE_NONE, the cards will be reset, new firmware loaded, 437 * NVRAM read, and defaults set, but any further initialization (e.g. 438 * INITIALIZE CONTROL BLOCK commands for 2X00 cards) won't be done. 439 * 440 * If INITIATOR MODE isn't set, attempts to run commands will be stopped 441 * at isp_start and completed with the moral equivalent of SELECTION TIMEOUT. 442 * 443 * If TARGET MODE is set, it doesn't mean that the rest of target mode support 444 * needs to be enabled, or will even work. What happens with the 2X00 cards 445 * here is that if you have enabled it with TARGET MODE as part of the ICB 446 * options, but you haven't given the f/w any ram resources for ATIOs or 447 * Immediate Notifies, the f/w just handles what it can and you never see 448 * anything. Basically, it sends a single byte of data (the first byte, 449 * which you can set as part of the INITIALIZE CONTROL BLOCK command) for 450 * INQUIRY, and sends back QUEUE FULL status for any other command. 451 * 452 */ 453#define ISP_ROLE_NONE 0x0 454#define ISP_ROLE_INITIATOR 0x1 455#define ISP_ROLE_TARGET 0x2 456#define ISP_ROLE_BOTH (ISP_ROLE_TARGET|ISP_ROLE_INITIATOR) 457#define ISP_ROLE_EITHER ISP_ROLE_BOTH 458#ifndef ISP_DEFAULT_ROLES 459#define ISP_DEFAULT_ROLES ISP_ROLE_INITIATOR 460#endif 461 462 463/* 464 * Firmware related defines 465 */ 466#define ISP_CODE_ORG 0x1000 /* default f/w code start */ 467#define ISP_CODE_ORG_2300 0x0800 /* ..except for 2300s */ 468#define ISP_FW_REV(maj, min, mic) ((maj << 24) | (min << 16) | mic) 469#define ISP_FW_MAJOR(code) ((code >> 24) & 0xff) 470#define ISP_FW_MINOR(code) ((code >> 16) & 0xff) 471#define ISP_FW_MICRO(code) ((code >> 8) & 0xff) 472#define ISP_FW_REVX(xp) ((xp[0]<<24) | (xp[1] << 16) | xp[2]) 473#define ISP_FW_MAJORX(xp) (xp[0]) 474#define ISP_FW_MINORX(xp) (xp[1]) 475#define ISP_FW_MICROX(xp) (xp[2]) 476 477/* 478 * Bus (implementation) types 479 */ 480#define ISP_BT_PCI 0 /* PCI Implementations */ 481#define ISP_BT_SBUS 1 /* SBus Implementations */ 482 483/* 484 * Chip Types 485 */ 486#define ISP_HA_SCSI 0xf 487#define ISP_HA_SCSI_UNKNOWN 0x1 488#define ISP_HA_SCSI_1020 0x2 489#define ISP_HA_SCSI_1020A 0x3 490#define ISP_HA_SCSI_1040 0x4 491#define ISP_HA_SCSI_1040A 0x5 492#define ISP_HA_SCSI_1040B 0x6 493#define ISP_HA_SCSI_1040C 0x7 494#define ISP_HA_SCSI_1240 0x8 495#define ISP_HA_SCSI_1080 0x9 496#define ISP_HA_SCSI_1280 0xa 497#define ISP_HA_SCSI_12160 0xb 498#define ISP_HA_FC 0xf0 499#define ISP_HA_FC_2100 0x10 500#define ISP_HA_FC_2200 0x20 501#define ISP_HA_FC_2300 0x30 502 503#define IS_SCSI(isp) (isp->isp_type & ISP_HA_SCSI) 504#define IS_1240(isp) (isp->isp_type == ISP_HA_SCSI_1240) 505#define IS_1080(isp) (isp->isp_type == ISP_HA_SCSI_1080) 506#define IS_1280(isp) (isp->isp_type == ISP_HA_SCSI_1280) 507#define IS_12160(isp) (isp->isp_type == ISP_HA_SCSI_12160) 508 509#define IS_12X0(isp) (IS_1240(isp) || IS_1280(isp)) 510#define IS_DUALBUS(isp) (IS_12X0(isp) || IS_12160(isp)) 511#define IS_ULTRA2(isp) (IS_1080(isp) || IS_1280(isp) || IS_12160(isp)) 512#define IS_ULTRA3(isp) (IS_12160(isp)) 513 514#define IS_FC(isp) ((isp)->isp_type & ISP_HA_FC) 515#define IS_2100(isp) ((isp)->isp_type == ISP_HA_FC_2100) 516#define IS_2200(isp) ((isp)->isp_type == ISP_HA_FC_2200) 517#define IS_2300(isp) ((isp)->isp_type >= ISP_HA_FC_2300) 518 519/* 520 * DMA cookie macros 521 */ 522#define DMA_WD3(x) 0 523#define DMA_WD2(x) 0 524#define DMA_WD1(x) (((x) >> 16) & 0xffff) 525#define DMA_WD0(x) (((x) & 0xffff)) 526 527/* 528 * Core System Function Prototypes 529 */ 530 531/* 532 * Reset Hardware. Totally. Assumes that you'll follow this with 533 * a call to isp_init. 534 */ 535void isp_reset(struct ispsoftc *); 536 537/* 538 * Initialize Hardware to known state 539 */ 540void isp_init(struct ispsoftc *); 541 542/* 543 * Reset the ISP and call completion for any orphaned commands. 544 */ 545void isp_reinit(struct ispsoftc *); 546 547/* 548 * Internal Interrupt Service Routine 549 * 550 * The outer layers do the spade work to get the appropriate status register, 551 * semaphore register and first mailbox register (if appropriate). This also 552 * means that most spurious/bogus interrupts not for us can be filtered first. 553 */ 554void isp_intr(struct ispsoftc *, u_int16_t, u_int16_t, u_int16_t); 555 556 557/* 558 * Command Entry Point- Platform Dependent layers call into this 559 */ 560int isp_start(XS_T *); 561/* these values are what isp_start returns */ 562#define CMD_COMPLETE 101 /* command completed */ 563#define CMD_EAGAIN 102 /* busy- maybe retry later */ 564#define CMD_QUEUED 103 /* command has been queued for execution */ 565#define CMD_RQLATER 104 /* requeue this command later */ 566 567/* 568 * Command Completion Point- Core layers call out from this with completed cmds 569 */ 570void isp_done(XS_T *); 571 572/* 573 * Platform Dependent to External to Internal Control Function 574 * 575 * Assumes locks are held on entry. You should note that with many of 576 * these commands and locks may be released while this is occurring. 577 * 578 * A few notes about some of these functions: 579 * 580 * ISPCTL_FCLINK_TEST tests to make sure we have good fibre channel link. 581 * The argument is a pointer to an integer which is the time, in microseconds, 582 * we should wait to see whether we have good link. This test, if successful, 583 * lets us know our connection topology and our Loop ID/AL_PA and so on. 584 * You can't get anywhere without this. 585 * 586 * ISPCTL_SCAN_FABRIC queries the name server (if we're on a fabric) for 587 * all entities using the FC Generic Services subcommand GET ALL NEXT. 588 * For each found entity, an ISPASYNC_FABRICDEV event is generated (see 589 * below). 590 * 591 * ISPCTL_SCAN_LOOP does a local loop scan. This is only done if the connection 592 * topology is NL or FL port (private or public loop). Since the Qlogic f/w 593 * 'automatically' manages local loop connections, this function essentially 594 * notes the arrival, departure, and possible shuffling around of local loop 595 * entities. Thus for each arrival and departure this generates an isp_async 596 * event of ISPASYNC_PROMENADE (see below). 597 * 598 * ISPCTL_PDB_SYNC is somewhat misnamed. It actually is the final step, in 599 * order, of ISPCTL_FCLINK_TEST, ISPCTL_SCAN_FABRIC, and ISPCTL_SCAN_LOOP. 600 * The main purpose of ISPCTL_PDB_SYNC is to complete management of logging 601 * and logging out of fabric devices (if one is on a fabric) and then marking 602 * the 'loop state' as being ready to now be used for sending commands to 603 * devices. Originally fabric name server and local loop scanning were 604 * part of this function. It's now been separated to allow for finer control. 605 */ 606typedef enum { 607 ISPCTL_RESET_BUS, /* Reset Bus */ 608 ISPCTL_RESET_DEV, /* Reset Device */ 609 ISPCTL_ABORT_CMD, /* Abort Command */ 610 ISPCTL_UPDATE_PARAMS, /* Update Operating Parameters (SCSI) */ 611 ISPCTL_FCLINK_TEST, /* Test FC Link Status */ 612 ISPCTL_SCAN_FABRIC, /* (Re)scan Fabric Name Server */ 613 ISPCTL_SCAN_LOOP, /* (Re)scan Local Loop */ 614 ISPCTL_PDB_SYNC, /* Synchronize Port Database */ 615 ISPCTL_SEND_LIP, /* Send a LIP */ 616 ISPCTL_GET_POSMAP, /* Get FC-AL position map */ 617 ISPCTL_RUN_MBOXCMD, /* run a mailbox command */ 618 ISPCTL_TOGGLE_TMODE /* toggle target mode */ 619} ispctl_t; 620int isp_control(struct ispsoftc *, ispctl_t, void *); 621 622 623/* 624 * Platform Dependent to Internal to External Control Function 625 * (each platform must provide such a function) 626 * 627 * Assumes locks are held. 628 * 629 * A few notes about some of these functions: 630 * 631 * ISPASYNC_CHANGE_NOTIFY notifies the outer layer that a change has 632 * occurred that invalidates the list of fabric devices known and/or 633 * the list of known loop devices. The argument passed is a pointer 634 * whose values are defined below (local loop change, name server 635 * change, other). 'Other' may simply be a LIP, or a change in 636 * connection topology. 637 * 638 * ISPASYNC_FABRIC_DEV announces the next element in a list of 639 * fabric device names we're getting out of the name server. The 640 * argument points to a GET ALL NEXT response structure. The list 641 * is known to terminate with an entry that refers to ourselves. 642 * One of the main purposes of this function is to allow outer 643 * layers, which are OS dependent, to set policy as to which fabric 644 * devices might actually be logged into (and made visible) later 645 * at ISPCTL_PDB_SYNC time. Since there's a finite number of fabric 646 * devices that we can log into (256 less 3 'reserved' for F-port 647 * topologies), and fabrics can grow up to 8 million or so entries 648 * (24 bits of Port Address, less a wad of reserved spaces), clearly 649 * we had better let the OS determine login policy. 650 * 651 * ISPASYNC_PROMENADE has an argument that is a pointer to an integer which 652 * is an index into the portdb in the softc ('target'). Whether that entrie's 653 * valid tag is set or not says whether something has arrived or departed. 654 * The name refers to a favorite pastime of many city dwellers- watching 655 * people come and go, talking of Michaelangelo, and so on.. 656 * 657 * ISPASYNC_UNHANDLED_RESPONSE gives outer layers a chance to parse a 658 * response queue entry not otherwise handled. The outer layer should 659 * return non-zero if it handled it. The 'arg' points to a (possibly only 660 * partially) massaged response queue entry (see the platform's 661 * ISP_UNSWIZZLE_RESPONSE macro). 662 */ 663 664typedef enum { 665 ISPASYNC_NEW_TGT_PARAMS, /* New Target Parameters Negotiated */ 666 ISPASYNC_BUS_RESET, /* Bus Was Reset */ 667 ISPASYNC_LOOP_DOWN, /* FC Loop Down */ 668 ISPASYNC_LOOP_UP, /* FC Loop Up */ 669 ISPASYNC_LIP, /* LIP Received */ 670 ISPASYNC_LOOP_RESET, /* Loop Reset Received */ 671 ISPASYNC_CHANGE_NOTIFY, /* FC Change Notification */ 672 ISPASYNC_FABRIC_DEV, /* FC Fabric Device Arrival */ 673 ISPASYNC_PROMENADE, /* FC Objects coming && going */ 674 ISPASYNC_TARGET_MESSAGE, /* target message */ 675 ISPASYNC_TARGET_EVENT, /* target asynchronous event */ 676 ISPASYNC_TARGET_ACTION, /* other target command action */ 677 ISPASYNC_CONF_CHANGE, /* Platform Configuration Change */ 678 ISPASYNC_UNHANDLED_RESPONSE, /* Unhandled Response Entry */ 679 ISPASYNC_FW_CRASH /* Firmware has crashed */ 680} ispasync_t; 681int isp_async(struct ispsoftc *, ispasync_t, void *); 682 683#define ISPASYNC_CHANGE_PDB ((void *) 0) 684#define ISPASYNC_CHANGE_SNS ((void *) 1) 685#define ISPASYNC_CHANGE_OTHER ((void *) 2) 686 687/* 688 * Platform Dependent Error and Debug Printout 689 */ 690#ifdef __GNUC__ 691void isp_prt(struct ispsoftc *, int level, const char *, ...) 692 __attribute__((__format__(__printf__,3,4))); 693#else 694void isp_prt(struct ispsoftc *, int level, const char *, ...); 695#endif 696 697#define ISP_LOGALL 0x0 /* log always */ 698#define ISP_LOGCONFIG 0x1 /* log configuration messages */ 699#define ISP_LOGINFO 0x2 /* log informational messages */ 700#define ISP_LOGWARN 0x4 /* log warning messages */ 701#define ISP_LOGERR 0x8 /* log error messages */ 702#define ISP_LOGDEBUG0 0x10 /* log simple debug messages */ 703#define ISP_LOGDEBUG1 0x20 /* log intermediate debug messages */ 704#define ISP_LOGDEBUG2 0x40 /* log most debug messages */ 705#define ISP_LOGDEBUG3 0x80 /* log high frequency debug messages */ 706#define ISP_LOGDEBUG4 0x100 /* log high frequency debug messages */ 707#define ISP_LOGTDEBUG0 0x200 /* log simple debug messages (target mode) */ 708#define ISP_LOGTDEBUG1 0x400 /* log intermediate debug messages (target) */ 709#define ISP_LOGTDEBUG2 0x800 /* log all debug messages (target) */ 710 711/* 712 * Each Platform provides it's own isposinfo substructure of the ispsoftc 713 * defined above. 714 * 715 * Each platform must also provide the following macros/defines: 716 * 717 * 718 * INLINE - platform specific define for 'inline' functions 719 * 720 * ISP_DMA_ADDR_T - platform specific dma address coookie- basically 721 * the largest integer that can hold the 32 or 722 * 64 bit value appropriate for the QLogic's DMA 723 * addressing. Defaults to u_int32_t. 724 * 725 * ISP2100_SCRLEN - length for the Fibre Channel scratch DMA area 726 * 727 * MEMZERO(dst, src) platform zeroing function 728 * MEMCPY(dst, src, count) platform copying function 729 * SNPRINTF(buf, bufsize, fmt, ...) snprintf 730 * STRNCAT(dstbuf, size, srcbuf) strncat 731 * USEC_DELAY(usecs) microsecond spindelay function 732 * USEC_SLEEP(isp, usecs) microsecond sleep function 733 * 734 * NANOTIME_T nanosecond time type 735 * 736 * GET_NANOTIME(NANOTIME_T *) get current nanotime. 737 * 738 * GET_NANOSEC(NANOTIME_T *) get u_int64_t from NANOTIME_T 739 * 740 * NANOTIME_SUB(NANOTIME_T *, NANOTIME_T *) 741 * subtract two NANOTIME_T values 742 * 743 * 744 * MAXISPREQUEST(struct ispsoftc *) maximum request queue size 745 * for this particular board type 746 * 747 * MEMORYBARRIER(struct ispsoftc *, barrier_type, offset, size) 748 * 749 * Function/Macro the provides memory synchronization on 750 * various objects so that the ISP's and the system's view 751 * of the same object is consistent. 752 * 753 * MBOX_ACQUIRE(struct ispsoftc *) acquire lock on mailbox regs 754 * MBOX_WAIT_COMPLETE(struct ispsoftc *) wait for mailbox cmd to be done 755 * MBOX_NOTIFY_COMPLETE(struct ispsoftc *) notification of mbox cmd donee 756 * MBOX_RELEASE(struct ispsoftc *) release lock on mailbox regs 757 * 758 * 759 * SCSI_GOOD SCSI 'Good' Status 760 * SCSI_CHECK SCSI 'Check Condition' Status 761 * SCSI_BUSY SCSI 'Busy' Status 762 * SCSI_QFULL SCSI 'Queue Full' Status 763 * 764 * XS_T Platform SCSI transaction type (i.e., command for HBA) 765 * XS_ISP(xs) gets an instance out of an XS_T 766 * XS_CHANNEL(xs) gets the channel (bus # for DUALBUS cards) "" 767 * XS_TGT(xs) gets the target "" 768 * XS_LUN(xs) gets the lun "" 769 * XS_CDBP(xs) gets a pointer to the scsi CDB "" 770 * XS_CDBLEN(xs) gets the CDB's length "" 771 * XS_XFRLEN(xs) gets the associated data transfer length "" 772 * XS_TIME(xs) gets the time (in milliseconds) for this command 773 * XS_RESID(xs) gets the current residual count 774 * XS_STSP(xs) gets a pointer to the SCSI status byte "" 775 * XS_SNSP(xs) gets a pointer to the associate sense data 776 * XS_SNSLEN(xs) gets the length of sense data storage 777 * XS_SNSKEY(xs) dereferences XS_SNSP to get the current stored Sense Key 778 * XS_TAG_P(xs) predicate of whether this command should be tagged 779 * XS_TAG_TYPE(xs) which type of tag to use 780 * XS_SETERR(xs) set error state 781 * 782 * HBA_NOERROR command has no erros 783 * HBA_BOTCH hba botched something 784 * HBA_CMDTIMEOUT command timed out 785 * HBA_SELTIMEOUT selection timed out (also port logouts for FC) 786 * HBA_TGTBSY target returned a BUSY status 787 * HBA_BUSRESET bus reset destroyed command 788 * HBA_ABORTED command was aborted (by request) 789 * HBA_DATAOVR a data overrun was detected 790 * HBA_ARQFAIL Automatic Request Sense failed 791 * 792 * XS_ERR(xs) return current error state 793 * XS_NOERR(xs) there is no error currently set 794 * XS_INITERR(xs) initialize error state 795 * 796 * XS_SAVE_SENSE(xs, sp) save sense data 797 * 798 * XS_SET_STATE_STAT(isp, sp, xs) platform dependent interpreter of 799 * response queue entry status bits 800 * 801 * 802 * DEFAULT_IID(struct ispsoftc *) Default SCSI initiator ID 803 * DEFAULT_LOOPID(struct ispsoftc *) Default FC Loop ID 804 * DEFAULT_NODEWWN(struct ispsoftc *) Default Node WWN 805 * DEFAULT_PORTWWN(struct ispsoftc *) Default Port WWN 806 * These establish reasonable defaults for each platform. 807 * These must be available independent of card NVRAM and are 808 * to be used should NVRAM not be readable. 809 * 810 * ISP_NODEWWN(struct ispsoftc *) FC Node WWN to use 811 * ISP_PORTWWN(struct ispsoftc *) FC Port WWN to use 812 * 813 * These are to be used after NVRAM is read. The tags 814 * in fcparam.isp_{node,port}wwn reflect the values 815 * read from NVRAM (possibly corrected for card botches). 816 * Each platform can take that information and override 817 * it or ignore and return the Node and Port WWNs to be 818 * used when sending the Qlogic f/w the Initialization Control 819 * Block. 820 * 821 * (XXX these do endian specific transformations- in transition XXX) 822 * ISP_SWIZZLE_ICB 823 * ISP_UNSWIZZLE_AND_COPY_PDBP 824 * ISP_SWIZZLE_CONTINUATION 825 * ISP_SWIZZLE_REQUEST 826 * ISP_UNSWIZZLE_RESPONSE 827 * ISP_SWIZZLE_SNS_REQ 828 * ISP_UNSWIZZLE_SNS_RSP 829 * ISP_SWIZZLE_NVRAM_WORD 830 */ 831 832#endif /* _ISPVAR_H */ 833