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