1 /* $Id: ispvar.h,v 1.12 1999/03/25 22:52:45 mjacob Exp $ */ 2 /* release_4_3_99 */ 3 /* 4 * Soft Definitions for for Qlogic ISP SCSI adapters. 5 * 6 *--------------------------------------- 7 * Copyright (c) 1997, 1998 by Matthew Jacob 8 * NASA/Ames Research Center 9 * All rights reserved. 10 *--------------------------------------- 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice immediately at the beginning of the file, without modification, 16 * this list of conditions, and the following disclaimer. 17 * 2. Redistributions in binary form must reproduce the above copyright 18 * notice, this list of conditions and the following disclaimer in the 19 * documentation and/or other materials provided with the distribution. 20 * 3. The name of the author may not be used to endorse or promote products 21 * derived from this software without specific prior written permission. 22 * 23 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 26 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR 27 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 33 * SUCH DAMAGE. 34 * 35 */ 36 37 #ifndef _ISPVAR_H 38 #define _ISPVAR_H 39 40 #if defined(__NetBSD__) || defined(__OpenBSD__) 41 #include <dev/ic/ispmbox.h> 42 #endif 43 #ifdef __FreeBSD__ 44 #include <dev/isp/ispmbox.h> 45 #endif 46 #ifdef __linux__ 47 #include "ispmbox.h" 48 #endif 49 50 #define ISP_CORE_VERSION_MAJOR 1 51 #define ISP_CORE_VERSION_MINOR 7 52 53 /* 54 * Vector for bus specific code to provide specific services. 55 */ 56 struct ispsoftc; 57 struct ispmdvec { 58 u_int16_t (*dv_rd_reg) __P((struct ispsoftc *, int)); 59 void (*dv_wr_reg) __P((struct ispsoftc *, int, u_int16_t)); 60 int (*dv_mbxdma) __P((struct ispsoftc *)); 61 int (*dv_dmaset) __P((struct ispsoftc *, 62 ISP_SCSI_XFER_T *, ispreq_t *, u_int8_t *, u_int8_t)); 63 void (*dv_dmaclr) 64 __P((struct ispsoftc *, ISP_SCSI_XFER_T *, u_int32_t)); 65 void (*dv_reset0) __P((struct ispsoftc *)); 66 void (*dv_reset1) __P((struct ispsoftc *)); 67 void (*dv_dregs) __P((struct ispsoftc *)); 68 const u_int16_t *dv_ispfw; /* ptr to f/w */ 69 u_int16_t dv_fwlen; /* length of f/w */ 70 u_int16_t dv_codeorg; /* code ORG for f/w */ 71 u_int16_t dv_fwrev; /* f/w revision */ 72 /* 73 * Initial values for conf1 register 74 */ 75 u_int16_t dv_conf1; 76 u_int16_t dv_clock; /* clock frequency */ 77 }; 78 79 #define MAX_TARGETS 16 80 #ifdef ISP2100_FABRIC 81 #define MAX_FC_TARG 256 82 #else 83 #define MAX_FC_TARG 126 84 #endif 85 #define DEFAULT_LOOPID 113 86 87 /* queue length must be a power of two */ 88 #define QENTRY_LEN 64 89 #define RQUEST_QUEUE_LEN MAXISPREQUEST 90 #define RESULT_QUEUE_LEN (MAXISPREQUEST/2) 91 #define ISP_QUEUE_ENTRY(q, idx) ((q) + ((idx) * QENTRY_LEN)) 92 #define ISP_QUEUE_SIZE(n) ((n) * QENTRY_LEN) 93 #define ISP_NXT_QENTRY(idx, qlen) (((idx) + 1) & ((qlen)-1)) 94 #define ISP_QAVAIL(in, out, qlen) \ 95 ((in == out)? (qlen - 1) : ((in > out)? \ 96 ((qlen - 1) - (in - out)) : (out - in - 1))) 97 /* 98 * SCSI Specific Host Adapter Parameters 99 */ 100 101 typedef struct { 102 u_int isp_req_ack_active_neg : 1, 103 isp_data_line_active_neg: 1, 104 isp_cmd_dma_burst_enable: 1, 105 isp_data_dma_burst_enabl: 1, 106 isp_fifo_threshold : 3, 107 isp_ultramode : 1, 108 isp_diffmode : 1, 109 isp_lvdmode : 1, 110 isp_fast_mttr : 1, 111 isp_initiator_id : 4, 112 isp_async_data_setup : 4; 113 u_int16_t isp_selection_timeout; 114 u_int16_t isp_max_queue_depth; 115 u_int16_t isp_clock; 116 u_int8_t isp_tag_aging; 117 u_int8_t isp_bus_reset_delay; 118 u_int8_t isp_retry_count; 119 u_int8_t isp_retry_delay; 120 struct { 121 u_int 122 dev_enable : 1, 123 dev_announced : 1, 124 dev_update : 1, 125 dev_refresh : 1, 126 exc_throttle : 8, 127 cur_offset : 4, 128 sync_offset : 4; 129 u_int8_t cur_period; /* current sync period */ 130 u_int8_t sync_period; /* goal sync period */ 131 u_int16_t dev_flags; /* goal device flags */ 132 u_int16_t cur_dflags; /* current device flags */ 133 } isp_devparam[MAX_TARGETS]; 134 } sdparam; /* scsi device parameters */ 135 136 /* 137 * Device Flags 138 */ 139 #define DPARM_DISC 0x8000 140 #define DPARM_PARITY 0x4000 141 #define DPARM_WIDE 0x2000 142 #define DPARM_SYNC 0x1000 143 #define DPARM_TQING 0x0800 144 #define DPARM_ARQ 0x0400 145 #define DPARM_QFRZ 0x0200 146 #define DPARM_RENEG 0x0100 147 #define DPARM_NARROW 0x0080 /* Possibly only available with >= 7.55 fw */ 148 #define DPARM_ASYNC 0x0040 /* Possibly only available with >= 7.55 fw */ 149 #define DPARM_DEFAULT (0xFF00 & ~DPARM_QFRZ) 150 #define DPARM_SAFE_DFLT (DPARM_DEFAULT & ~(DPARM_WIDE|DPARM_SYNC|DPARM_TQING)) 151 152 153 /* technically, not really correct, as they need to be rated based upon clock */ 154 #define ISP_40M_SYNCPARMS 0x080a 155 #define ISP_20M_SYNCPARMS 0x080c 156 #define ISP_10M_SYNCPARMS 0x0c19 157 #define ISP_08M_SYNCPARMS 0x0c25 158 #define ISP_05M_SYNCPARMS 0x0c32 159 #define ISP_04M_SYNCPARMS 0x0c41 160 161 /* 162 * Fibre Channel Specifics 163 */ 164 typedef struct { 165 u_int64_t isp_wwn; /* WWN of adapter */ 166 u_int8_t isp_loopid; /* hard loop id */ 167 u_int8_t isp_alpa; /* ALPA */ 168 u_int8_t isp_execthrottle; 169 u_int8_t isp_retry_delay; 170 u_int8_t isp_retry_count; 171 u_int8_t isp_fwstate; /* ISP F/W state */ 172 u_int16_t isp_maxalloc; 173 u_int16_t isp_maxfrmlen; 174 u_int16_t isp_fwoptions; 175 /* 176 * Port Data Base 177 */ 178 isp_pdb_t isp_pdb[MAX_FC_TARG]; 179 180 /* 181 * Scratch DMA mapped in area to fetch Port Database stuff, etc. 182 */ 183 volatile caddr_t isp_scratch; 184 u_int32_t isp_scdma; 185 } fcparam; 186 187 #define ISP2100_SCRLEN 0x100 188 189 #define FW_CONFIG_WAIT 0x0000 190 #define FW_WAIT_AL_PA 0x0001 191 #define FW_WAIT_LOGIN 0x0002 192 #define FW_READY 0x0003 193 #define FW_LOSS_OF_SYNC 0x0004 194 #define FW_ERROR 0x0005 195 #define FW_REINIT 0x0006 196 #define FW_NON_PART 0x0007 197 198 #ifdef ISP_TARGET_MODE 199 /* 200 * Some temporary Target Mode definitions 201 */ 202 typedef struct tmd_cmd { 203 u_int8_t cd_iid; /* initiator */ 204 u_int8_t cd_tgt; /* target */ 205 u_int8_t cd_lun; /* LUN for this command */ 206 u_int8_t cd_state; 207 u_int8_t cd_cdb[16]; /* command bytes */ 208 u_int8_t cd_sensedata[20]; 209 u_int16_t cd_rxid; 210 u_int32_t cd_datalen; 211 u_int32_t cd_totbytes; 212 void * cd_hba; 213 } tmd_cmd_t; 214 215 /* 216 * Async Target Mode Event Definitions 217 */ 218 #define TMD_BUS_RESET 0 219 #define TMD_BDR 1 220 221 /* 222 * Immediate Notify data structure. 223 */ 224 #define NOTIFY_MSGLEN 5 225 typedef struct { 226 u_int8_t nt_iid; /* initiator */ 227 u_int8_t nt_tgt; /* target */ 228 u_int8_t nt_lun; /* LUN for this command */ 229 u_int8_t nt_msg[NOTIFY_MSGLEN]; /* SCSI message byte(s) */ 230 } tmd_notify_t; 231 232 #endif 233 234 /* 235 * Soft Structure per host adapter 236 */ 237 struct ispsoftc { 238 /* 239 * Platform (OS) specific data 240 */ 241 struct isposinfo isp_osinfo; 242 243 /* 244 * Pointer to bus specific data 245 */ 246 struct ispmdvec * isp_mdvec; 247 248 /* 249 * Mostly nonvolatile state, debugging, etc.. 250 */ 251 252 u_int : 8, 253 isp_confopts : 8, 254 isp_port : 1, /* for dual ported impls */ 255 isp_used : 1, 256 isp_dblev : 3, 257 isp_gotdparms : 1, 258 isp_dogactive : 1, 259 isp_bustype : 1, /* BUS Implementation */ 260 isp_type : 8; /* HBA Type and Revision */ 261 262 u_int16_t isp_fwrev[3]; /* Running F/W revision */ 263 u_int16_t isp_romfw_rev[3]; /* 'ROM' F/W revision */ 264 void * isp_param; 265 266 /* 267 * Volatile state 268 */ 269 270 volatile u_int 271 : 19, 272 isp_state : 3, 273 isp_sendmarker : 1, /* send a marker entry */ 274 isp_update : 1, /* update parameters */ 275 isp_nactive : 9; /* how many commands active */ 276 277 /* 278 * Result and Request Queue indices. 279 */ 280 volatile u_int8_t isp_reqodx; /* index of last ISP pickup */ 281 volatile u_int8_t isp_reqidx; /* index of next request */ 282 volatile u_int8_t isp_residx; /* index of next result */ 283 volatile u_int8_t isp_seqno; /* rolling sequence # */ 284 285 /* 286 * Sheer laziness, but it gets us around the problem 287 * where we don't have a clean way of remembering 288 * which transaction is bound to which ISP queue entry. 289 * 290 * There are other more clever ways to do this, but, 291 * jeez, so I blow a couple of KB per host adapter... 292 * and it *is* faster. 293 */ 294 ISP_SCSI_XFER_T *isp_xflist[RQUEST_QUEUE_LEN]; 295 296 /* 297 * request/result queues and dma handles for them. 298 */ 299 volatile caddr_t isp_rquest; 300 volatile caddr_t isp_result; 301 u_int32_t isp_rquest_dma; 302 u_int32_t isp_result_dma; 303 304 #ifdef ISP_TARGET_MODE 305 /* 306 * Vectors for handling target mode support. 307 * 308 * isp_tmd_newcmd is for feeding a newly arrived command to some 309 * upper layer. 310 * 311 * isp_tmd_event is for notifying some upper layer that an event has 312 * occurred that is not necessarily tied to any target (e.g., a SCSI 313 * Bus Reset). 314 * 315 * isp_tmd_notify is for notifying some upper layer that some 316 * event is now occurring that is either pertinent for a specific 317 * device or for a specific command (e.g., BDR or ABORT TAG). 318 * 319 * It is left undefined (for now) how pools of commands are managed. 320 */ 321 void (*isp_tmd_newcmd) __P((void *, tmd_cmd_t *)); 322 void (*isp_tmd_event) __P((void *, int)); 323 void (*isp_tmd_notify) __P((void *, tmd_notify_t *)); 324 #endif 325 }; 326 327 /* 328 * ISP States 329 */ 330 #define ISP_NILSTATE 0 331 #define ISP_RESETSTATE 1 332 #define ISP_INITSTATE 2 333 #define ISP_RUNSTATE 3 334 335 /* 336 * ISP Configuration Options 337 */ 338 #define ISP_CFG_NORELOAD 0x80 /* don't download f/w */ 339 #define ISP_CFG_NONVRAM 0x40 /* ignore NVRAM */ 340 341 #define ISP_FW_REV(maj, min, mic) ((maj << 24) | (min << 16) | mic) 342 #define ISP_FW_REVX(xp) ((xp[0 ]<< 24) | (xp[1] << 16) | xp[2]) 343 344 345 /* 346 * Bus (implementation) types 347 */ 348 #define ISP_BT_PCI 0 /* PCI Implementations */ 349 #define ISP_BT_SBUS 1 /* SBus Implementations */ 350 351 /* 352 * Chip Types 353 */ 354 #define ISP_HA_SCSI 0xf 355 #define ISP_HA_SCSI_UNKNOWN 0x1 356 #define ISP_HA_SCSI_1020 0x2 357 #define ISP_HA_SCSI_1020A 0x3 358 #define ISP_HA_SCSI_1040 0x4 359 #define ISP_HA_SCSI_1040A 0x5 360 #define ISP_HA_SCSI_1040B 0x6 361 #define ISP_HA_SCSI_1040C 0x7 362 #define ISP_HA_SCSI_1080 0xd 363 #define ISP_HA_SCSI_12X0 0xe 364 #define ISP_HA_FC 0xf0 365 #define ISP_HA_FC_2100 0x10 366 367 #define IS_SCSI(isp) (isp->isp_type & ISP_HA_SCSI) 368 #define IS_1080(isp) (isp->isp_type == ISP_HA_SCSI_1080) 369 #define IS_12X0(isp) (isp->isp_type == ISP_HA_SCSI_12X0) 370 #define IS_FC(isp) (isp->isp_type & ISP_HA_FC) 371 372 /* 373 * Macros to read, write ISP registers through bus specific code. 374 */ 375 376 #define ISP_READ(isp, reg) \ 377 (*(isp)->isp_mdvec->dv_rd_reg)((isp), (reg)) 378 379 #define ISP_WRITE(isp, reg, val) \ 380 (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), (val)) 381 382 #define ISP_MBOXDMASETUP(isp) \ 383 (*(isp)->isp_mdvec->dv_mbxdma)((isp)) 384 385 #define ISP_DMASETUP(isp, xs, req, iptrp, optr) \ 386 (*(isp)->isp_mdvec->dv_dmaset)((isp), (xs), (req), (iptrp), (optr)) 387 388 #define ISP_DMAFREE(isp, xs, seqno) \ 389 if ((isp)->isp_mdvec->dv_dmaclr) \ 390 (*(isp)->isp_mdvec->dv_dmaclr)((isp), (xs), (seqno)) 391 392 #define ISP_RESET0(isp) \ 393 if ((isp)->isp_mdvec->dv_reset0) (*(isp)->isp_mdvec->dv_reset0)((isp)) 394 #define ISP_RESET1(isp) \ 395 if ((isp)->isp_mdvec->dv_reset1) (*(isp)->isp_mdvec->dv_reset1)((isp)) 396 #define ISP_DUMPREGS(isp) \ 397 if ((isp)->isp_mdvec->dv_dregs) (*(isp)->isp_mdvec->dv_dregs)((isp)) 398 399 #define ISP_SETBITS(isp, reg, val) \ 400 (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), ISP_READ((isp), (reg)) | (val)) 401 402 #define ISP_CLRBITS(isp, reg, val) \ 403 (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), ISP_READ((isp), (reg)) & ~(val)) 404 405 /* 406 * Function Prototypes 407 */ 408 409 /* 410 * Reset Hardware. Totally. Assumes that you'll follow this with 411 * a call to isp_init. 412 */ 413 void isp_reset __P((struct ispsoftc *)); 414 415 /* 416 * Initialize Hardware to known state 417 */ 418 void isp_init __P((struct ispsoftc *)); 419 420 /* 421 * Reset the ISP and call completion for any orphaned commands. 422 */ 423 void isp_restart __P((struct ispsoftc *)); 424 425 /* 426 * Interrupt Service Routine 427 */ 428 int isp_intr __P((void *)); 429 430 /* 431 * Command Entry Point 432 */ 433 int32_t ispscsicmd __P((ISP_SCSI_XFER_T *)); 434 435 /* 436 * Platform Dependent to External to Internal Control Function 437 * 438 * For: Aborting a running command - arg is an ISP_SCSI_XFER_T * 439 * Resetting a Device - arg is target to reset 440 * Resetting a BUS - arg is ignored 441 * Updating parameters - arg is ignored 442 * 443 * First argument is this instance's softc pointer. 444 * Second argument is an index into xflist array. 445 * Assumes all locks must be held already. 446 */ 447 typedef enum { 448 ISPCTL_RESET_BUS, 449 ISPCTL_RESET_DEV, 450 ISPCTL_ABORT_CMD, 451 ISPCTL_UPDATE_PARAMS, 452 ISPCTL_FCLINK_TEST 453 } ispctl_t; 454 int isp_control __P((struct ispsoftc *, ispctl_t, void *)); 455 456 457 /* 458 * Platform Dependent to Internal to External Control Function 459 * (each platform must provide such a function) 460 * 461 * For: Announcing Target Paramter Changes (arg is target) 462 * 463 * Assumes all locks are held. 464 */ 465 466 typedef enum { 467 ISPASYNC_NEW_TGT_PARAMS, 468 ISPASYNC_BUS_RESET, /* Bus Reset */ 469 ISPASYNC_LOOP_DOWN, /* Obvious FC only */ 470 ISPASYNC_LOOP_UP, /* "" */ 471 ISPASYNC_PDB_CHANGE_COMPLETE, /* "" */ 472 ISPASYNC_CHANGE_NOTIFY /* "" */ 473 } ispasync_t; 474 int isp_async __P((struct ispsoftc *, ispasync_t, void *)); 475 476 /* 477 * lost command routine (XXXX IN TRANSITION XXXX) 478 */ 479 void isp_lostcmd __P((struct ispsoftc *, ISP_SCSI_XFER_T *)); 480 481 482 #endif /* _ISPVAR_H */ 483