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