mpi.h revision 156000
1/* $FreeBSD: head/sys/dev/mpt/mpilib/mpi.h 156000 2006-02-25 07:45:54Z mjacob $ */ 2/*- 3 * Copyright (c) 2000-2005, LSI Logic Corporation and its contributors. 4 * All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions are 8 * met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 12 * substantially similar to the "NO WARRANTY" disclaimer below 13 * ("Disclaimer") and any redistribution must be conditioned upon including 14 * a substantially similar Disclaimer requirement for further binary 15 * redistribution. 16 * 3. Neither the name of the LSI Logic Corporation nor the names of its 17 * contributors may be used to endorse or promote products derived from 18 * this software without specific prior written permission. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF THE COPYRIGHT 30 * OWNER OR CONTRIBUTOR IS ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 31 * 32 * Name: mpi.h 33 * Title: MPI Message independent structures and definitions 34 * Creation Date: July 27, 2000 35 * 36 * mpi.h Version: 01.05.10 37 * 38 * Version History 39 * --------------- 40 * 41 * Date Version Description 42 * -------- -------- ------------------------------------------------------ 43 * 05-08-00 00.10.01 Original release for 0.10 spec dated 4/26/2000. 44 * 05-24-00 00.10.02 Added MPI_IOCSTATUS_SCSI_RESIDUAL_MISMATCH definition. 45 * 06-06-00 01.00.01 Update MPI_VERSION_MAJOR and MPI_VERSION_MINOR. 46 * 06-22-00 01.00.02 Added MPI_IOCSTATUS_LAN_ definitions. 47 * Removed LAN_SUSPEND function definition. 48 * Added MPI_MSGFLAGS_CONTINUATION_REPLY definition. 49 * 06-30-00 01.00.03 Added MPI_CONTEXT_REPLY_TYPE_LAN definition. 50 * Added MPI_GET/SET_CONTEXT_REPLY_TYPE macros. 51 * 07-27-00 01.00.04 Added MPI_FAULT_ definitions. 52 * Removed MPI_IOCSTATUS_MSG/DATA_XFER_ERROR definitions. 53 * Added MPI_IOCSTATUS_INTERNAL_ERROR definition. 54 * Added MPI_IOCSTATUS_TARGET_XFER_COUNT_MISMATCH. 55 * 11-02-00 01.01.01 Original release for post 1.0 work. 56 * 12-04-00 01.01.02 Added new function codes. 57 * 01-09-01 01.01.03 Added more definitions to the system interface section 58 * Added MPI_IOCSTATUS_TARGET_STS_DATA_NOT_SENT. 59 * 01-25-01 01.01.04 Changed MPI_VERSION_MINOR from 0x00 to 0x01. 60 * 02-20-01 01.01.05 Started using MPI_POINTER. 61 * Fixed value for MPI_DIAG_RW_ENABLE. 62 * Added defines for MPI_DIAG_PREVENT_IOC_BOOT and 63 * MPI_DIAG_CLEAR_FLASH_BAD_SIG. 64 * Obsoleted MPI_IOCSTATUS_TARGET_FC_ defines. 65 * 02-27-01 01.01.06 Removed MPI_HOST_INDEX_REGISTER define. 66 * Added function codes for RAID. 67 * 04-09-01 01.01.07 Added alternate define for MPI_DOORBELL_ACTIVE, 68 * MPI_DOORBELL_USED, to better match the spec. 69 * 08-08-01 01.02.01 Original release for v1.2 work. 70 * Changed MPI_VERSION_MINOR from 0x01 to 0x02. 71 * Added define MPI_FUNCTION_TOOLBOX. 72 * 09-28-01 01.02.02 New function code MPI_SCSI_ENCLOSURE_PROCESSOR. 73 * 11-01-01 01.02.03 Changed name to MPI_FUNCTION_SCSI_ENCLOSURE_PROCESSOR. 74 * 03-14-02 01.02.04 Added MPI_HEADER_VERSION_ defines. 75 * 05-31-02 01.02.05 Bumped MPI_HEADER_VERSION_UNIT. 76 * 07-12-02 01.02.06 Added define for MPI_FUNCTION_MAILBOX. 77 * 09-16-02 01.02.07 Bumped value for MPI_HEADER_VERSION_UNIT. 78 * 11-15-02 01.02.08 Added define MPI_IOCSTATUS_TARGET_INVALID_IO_INDEX and 79 * obsoleted define MPI_IOCSTATUS_TARGET_INVALID_IOCINDEX. 80 * 04-01-03 01.02.09 New IOCStatus code: MPI_IOCSTATUS_FC_EXCHANGE_CANCELED 81 * 06-26-03 01.02.10 Bumped MPI_HEADER_VERSION_UNIT value. 82 * 01-16-04 01.02.11 Added define for MPI_IOCLOGINFO_TYPE_SHIFT. 83 * 04-29-04 01.02.12 Added function codes for MPI_FUNCTION_DIAG_BUFFER_POST 84 * and MPI_FUNCTION_DIAG_RELEASE. 85 * Added MPI_IOCSTATUS_DIAGNOSTIC_RELEASED define. 86 * Bumped MPI_HEADER_VERSION_UNIT value. 87 * 05-11-04 01.03.01 Bumped MPI_VERSION_MINOR for MPI v1.3. 88 * Added codes for Inband. 89 * 08-19-04 01.05.01 Added defines for Host Buffer Access Control doorbell. 90 * Added define for offset of High Priority Request Queue. 91 * Added new function codes and new IOCStatus codes. 92 * Added a IOCLogInfo type of SAS. 93 * 12-07-04 01.05.02 Bumped MPI_HEADER_VERSION_UNIT. 94 * 12-09-04 01.05.03 Bumped MPI_HEADER_VERSION_UNIT. 95 * 01-15-05 01.05.04 Bumped MPI_HEADER_VERSION_UNIT. 96 * 02-09-05 01.05.05 Bumped MPI_HEADER_VERSION_UNIT. 97 * 02-22-05 01.05.06 Bumped MPI_HEADER_VERSION_UNIT. 98 * 03-11-05 01.05.07 Removed function codes for SCSI IO 32 and 99 * TargetAssistExtended requests. 100 * Removed EEDP IOCStatus codes. 101 * 06-24-05 01.05.08 Added function codes for SCSI IO 32 and 102 * TargetAssistExtended requests. 103 * Added EEDP IOCStatus codes. 104 * 08-03-05 01.05.09 Bumped MPI_HEADER_VERSION_UNIT. 105 * 08-30-05 01.05.10 Added 2 new IOCStatus codes for Target. 106 * -------------------------------------------------------------------------- 107 */ 108 109#ifndef MPI_H 110#define MPI_H 111 112 113/***************************************************************************** 114* 115* M P I V e r s i o n D e f i n i t i o n s 116* 117*****************************************************************************/ 118 119#define MPI_VERSION_MAJOR (0x01) 120#define MPI_VERSION_MINOR (0x05) 121#define MPI_VERSION_MAJOR_MASK (0xFF00) 122#define MPI_VERSION_MAJOR_SHIFT (8) 123#define MPI_VERSION_MINOR_MASK (0x00FF) 124#define MPI_VERSION_MINOR_SHIFT (0) 125#define MPI_VERSION ((MPI_VERSION_MAJOR << MPI_VERSION_MAJOR_SHIFT) | \ 126 MPI_VERSION_MINOR) 127 128#define MPI_VERSION_01_00 (0x0100) 129#define MPI_VERSION_01_01 (0x0101) 130#define MPI_VERSION_01_02 (0x0102) 131#define MPI_VERSION_01_03 (0x0103) 132#define MPI_VERSION_01_05 (0x0105) 133/* Note: The major versions of 0xe0 through 0xff are reserved */ 134 135/* versioning for this MPI header set */ 136#define MPI_HEADER_VERSION_UNIT (0x0C) 137#define MPI_HEADER_VERSION_DEV (0x00) 138#define MPI_HEADER_VERSION_UNIT_MASK (0xFF00) 139#define MPI_HEADER_VERSION_UNIT_SHIFT (8) 140#define MPI_HEADER_VERSION_DEV_MASK (0x00FF) 141#define MPI_HEADER_VERSION_DEV_SHIFT (0) 142#define MPI_HEADER_VERSION ((MPI_HEADER_VERSION_UNIT << 8) | MPI_HEADER_VERSION_DEV) 143 144/***************************************************************************** 145* 146* I O C S t a t e D e f i n i t i o n s 147* 148*****************************************************************************/ 149 150#define MPI_IOC_STATE_RESET (0x00000000) 151#define MPI_IOC_STATE_READY (0x10000000) 152#define MPI_IOC_STATE_OPERATIONAL (0x20000000) 153#define MPI_IOC_STATE_FAULT (0x40000000) 154 155#define MPI_IOC_STATE_MASK (0xF0000000) 156#define MPI_IOC_STATE_SHIFT (28) 157 158/* Fault state codes (product independent range 0x8000-0xFFFF) */ 159 160#define MPI_FAULT_REQUEST_MESSAGE_PCI_PARITY_ERROR (0x8111) 161#define MPI_FAULT_REQUEST_MESSAGE_PCI_BUS_FAULT (0x8112) 162#define MPI_FAULT_REPLY_MESSAGE_PCI_PARITY_ERROR (0x8113) 163#define MPI_FAULT_REPLY_MESSAGE_PCI_BUS_FAULT (0x8114) 164#define MPI_FAULT_DATA_SEND_PCI_PARITY_ERROR (0x8115) 165#define MPI_FAULT_DATA_SEND_PCI_BUS_FAULT (0x8116) 166#define MPI_FAULT_DATA_RECEIVE_PCI_PARITY_ERROR (0x8117) 167#define MPI_FAULT_DATA_RECEIVE_PCI_BUS_FAULT (0x8118) 168 169 170/***************************************************************************** 171* 172* P C I S y s t e m I n t e r f a c e R e g i s t e r s 173* 174*****************************************************************************/ 175 176/* 177 * Defines for working with the System Doorbell register. 178 * Values for doorbell function codes are included in the section that defines 179 * all the function codes (further on in this file). 180 */ 181#define MPI_DOORBELL_OFFSET (0x00000000) 182#define MPI_DOORBELL_ACTIVE (0x08000000) /* DoorbellUsed */ 183#define MPI_DOORBELL_USED (MPI_DOORBELL_ACTIVE) 184#define MPI_DOORBELL_ACTIVE_SHIFT (27) 185#define MPI_DOORBELL_WHO_INIT_MASK (0x07000000) 186#define MPI_DOORBELL_WHO_INIT_SHIFT (24) 187#define MPI_DOORBELL_FUNCTION_MASK (0xFF000000) 188#define MPI_DOORBELL_FUNCTION_SHIFT (24) 189#define MPI_DOORBELL_ADD_DWORDS_MASK (0x00FF0000) 190#define MPI_DOORBELL_ADD_DWORDS_SHIFT (16) 191#define MPI_DOORBELL_DATA_MASK (0x0000FFFF) 192#define MPI_DOORBELL_FUNCTION_SPECIFIC_MASK (0x0000FFFF) 193 194/* values for Host Buffer Access Control doorbell function */ 195#define MPI_DB_HPBAC_VALUE_MASK (0x0000F000) 196#define MPI_DB_HPBAC_ENABLE_ACCESS (0x01) 197#define MPI_DB_HPBAC_DISABLE_ACCESS (0x02) 198#define MPI_DB_HPBAC_FREE_BUFFER (0x03) 199 200 201#define MPI_WRITE_SEQUENCE_OFFSET (0x00000004) 202#define MPI_WRSEQ_KEY_VALUE_MASK (0x0000000F) 203#define MPI_WRSEQ_1ST_KEY_VALUE (0x04) 204#define MPI_WRSEQ_2ND_KEY_VALUE (0x0B) 205#define MPI_WRSEQ_3RD_KEY_VALUE (0x02) 206#define MPI_WRSEQ_4TH_KEY_VALUE (0x07) 207#define MPI_WRSEQ_5TH_KEY_VALUE (0x0D) 208 209#define MPI_DIAGNOSTIC_OFFSET (0x00000008) 210#define MPI_DIAG_CLEAR_FLASH_BAD_SIG (0x00000400) 211#define MPI_DIAG_PREVENT_IOC_BOOT (0x00000200) 212#define MPI_DIAG_DRWE (0x00000080) 213#define MPI_DIAG_FLASH_BAD_SIG (0x00000040) 214#define MPI_DIAG_RESET_HISTORY (0x00000020) 215#define MPI_DIAG_RW_ENABLE (0x00000010) 216#define MPI_DIAG_RESET_ADAPTER (0x00000004) 217#define MPI_DIAG_DISABLE_ARM (0x00000002) 218#define MPI_DIAG_MEM_ENABLE (0x00000001) 219 220#define MPI_TEST_BASE_ADDRESS_OFFSET (0x0000000C) 221 222#define MPI_DIAG_RW_DATA_OFFSET (0x00000010) 223 224#define MPI_DIAG_RW_ADDRESS_OFFSET (0x00000014) 225 226#define MPI_HOST_INTERRUPT_STATUS_OFFSET (0x00000030) 227#define MPI_HIS_IOP_DOORBELL_STATUS (0x80000000) 228#define MPI_HIS_REPLY_MESSAGE_INTERRUPT (0x00000008) 229#define MPI_HIS_DOORBELL_INTERRUPT (0x00000001) 230 231#define MPI_HOST_INTERRUPT_MASK_OFFSET (0x00000034) 232#define MPI_HIM_RIM (0x00000008) 233#define MPI_HIM_DIM (0x00000001) 234 235#define MPI_REQUEST_QUEUE_OFFSET (0x00000040) 236#define MPI_REQUEST_POST_FIFO_OFFSET (0x00000040) 237 238#define MPI_REPLY_QUEUE_OFFSET (0x00000044) 239#define MPI_REPLY_POST_FIFO_OFFSET (0x00000044) 240#define MPI_REPLY_FREE_FIFO_OFFSET (0x00000044) 241 242#define MPI_HI_PRI_REQUEST_QUEUE_OFFSET (0x00000048) 243 244 245 246/***************************************************************************** 247* 248* M e s s a g e F r a m e D e s c r i p t o r s 249* 250*****************************************************************************/ 251 252#define MPI_REQ_MF_DESCRIPTOR_NB_MASK (0x00000003) 253#define MPI_REQ_MF_DESCRIPTOR_F_BIT (0x00000004) 254#define MPI_REQ_MF_DESCRIPTOR_ADDRESS_MASK (0xFFFFFFF8) 255 256#define MPI_ADDRESS_REPLY_A_BIT (0x80000000) 257#define MPI_ADDRESS_REPLY_ADDRESS_MASK (0x7FFFFFFF) 258 259#define MPI_CONTEXT_REPLY_A_BIT (0x80000000) 260#define MPI_CONTEXT_REPLY_TYPE_MASK (0x60000000) 261#define MPI_CONTEXT_REPLY_TYPE_SCSI_INIT (0x00) 262#define MPI_CONTEXT_REPLY_TYPE_SCSI_TARGET (0x01) 263#define MPI_CONTEXT_REPLY_TYPE_LAN (0x02) 264#define MPI_CONTEXT_REPLY_TYPE_SHIFT (29) 265#define MPI_CONTEXT_REPLY_CONTEXT_MASK (0x1FFFFFFF) 266 267 268/****************************************************************************/ 269/* Context Reply macros */ 270/****************************************************************************/ 271 272#define MPI_GET_CONTEXT_REPLY_TYPE(x) (((x) & MPI_CONTEXT_REPLY_TYPE_MASK) \ 273 >> MPI_CONTEXT_REPLY_TYPE_SHIFT) 274 275#define MPI_SET_CONTEXT_REPLY_TYPE(x, typ) \ 276 ((x) = ((x) & ~MPI_CONTEXT_REPLY_TYPE_MASK) | \ 277 (((typ) << MPI_CONTEXT_REPLY_TYPE_SHIFT) & \ 278 MPI_CONTEXT_REPLY_TYPE_MASK)) 279 280 281/***************************************************************************** 282* 283* M e s s a g e F u n c t i o n s 284* 0x80 -> 0x8F reserved for private message use per product 285* 286* 287*****************************************************************************/ 288 289#define MPI_FUNCTION_SCSI_IO_REQUEST (0x00) 290#define MPI_FUNCTION_SCSI_TASK_MGMT (0x01) 291#define MPI_FUNCTION_IOC_INIT (0x02) 292#define MPI_FUNCTION_IOC_FACTS (0x03) 293#define MPI_FUNCTION_CONFIG (0x04) 294#define MPI_FUNCTION_PORT_FACTS (0x05) 295#define MPI_FUNCTION_PORT_ENABLE (0x06) 296#define MPI_FUNCTION_EVENT_NOTIFICATION (0x07) 297#define MPI_FUNCTION_EVENT_ACK (0x08) 298#define MPI_FUNCTION_FW_DOWNLOAD (0x09) 299#define MPI_FUNCTION_TARGET_CMD_BUFFER_POST (0x0A) 300#define MPI_FUNCTION_TARGET_ASSIST (0x0B) 301#define MPI_FUNCTION_TARGET_STATUS_SEND (0x0C) 302#define MPI_FUNCTION_TARGET_MODE_ABORT (0x0D) 303#define MPI_FUNCTION_FC_LINK_SRVC_BUF_POST (0x0E) 304#define MPI_FUNCTION_FC_LINK_SRVC_RSP (0x0F) 305#define MPI_FUNCTION_FC_EX_LINK_SRVC_SEND (0x10) 306#define MPI_FUNCTION_FC_ABORT (0x11) 307#define MPI_FUNCTION_FW_UPLOAD (0x12) 308#define MPI_FUNCTION_FC_COMMON_TRANSPORT_SEND (0x13) 309#define MPI_FUNCTION_FC_PRIMITIVE_SEND (0x14) 310 311#define MPI_FUNCTION_RAID_ACTION (0x15) 312#define MPI_FUNCTION_RAID_SCSI_IO_PASSTHROUGH (0x16) 313 314#define MPI_FUNCTION_TOOLBOX (0x17) 315 316#define MPI_FUNCTION_SCSI_ENCLOSURE_PROCESSOR (0x18) 317 318#define MPI_FUNCTION_MAILBOX (0x19) 319 320#define MPI_FUNCTION_SMP_PASSTHROUGH (0x1A) 321#define MPI_FUNCTION_SAS_IO_UNIT_CONTROL (0x1B) 322#define MPI_FUNCTION_SATA_PASSTHROUGH (0x1C) 323 324#define MPI_FUNCTION_DIAG_BUFFER_POST (0x1D) 325#define MPI_FUNCTION_DIAG_RELEASE (0x1E) 326 327#define MPI_FUNCTION_SCSI_IO_32 (0x1F) 328 329#define MPI_FUNCTION_LAN_SEND (0x20) 330#define MPI_FUNCTION_LAN_RECEIVE (0x21) 331#define MPI_FUNCTION_LAN_RESET (0x22) 332 333#define MPI_FUNCTION_TARGET_ASSIST_EXTENDED (0x23) 334#define MPI_FUNCTION_TARGET_CMD_BUF_BASE_POST (0x24) 335#define MPI_FUNCTION_TARGET_CMD_BUF_LIST_POST (0x25) 336 337#define MPI_FUNCTION_INBAND_BUFFER_POST (0x28) 338#define MPI_FUNCTION_INBAND_SEND (0x29) 339#define MPI_FUNCTION_INBAND_RSP (0x2A) 340#define MPI_FUNCTION_INBAND_ABORT (0x2B) 341 342#define MPI_FUNCTION_IOC_MESSAGE_UNIT_RESET (0x40) 343#define MPI_FUNCTION_IO_UNIT_RESET (0x41) 344#define MPI_FUNCTION_HANDSHAKE (0x42) 345#define MPI_FUNCTION_REPLY_FRAME_REMOVAL (0x43) 346#define MPI_FUNCTION_HOST_PAGEBUF_ACCESS_CONTROL (0x44) 347 348 349/* standard version format */ 350typedef struct _MPI_VERSION_STRUCT 351{ 352 U8 Dev; /* 00h */ 353 U8 Unit; /* 01h */ 354 U8 Minor; /* 02h */ 355 U8 Major; /* 03h */ 356} MPI_VERSION_STRUCT, MPI_POINTER PTR_MPI_VERSION_STRUCT, 357 MpiVersionStruct_t, MPI_POINTER pMpiVersionStruct; 358 359typedef union _MPI_VERSION_FORMAT 360{ 361 MPI_VERSION_STRUCT Struct; 362 U32 Word; 363} MPI_VERSION_FORMAT, MPI_POINTER PTR_MPI_VERSION_FORMAT, 364 MpiVersionFormat_t, MPI_POINTER pMpiVersionFormat_t; 365 366 367/***************************************************************************** 368* 369* S c a t t e r G a t h e r E l e m e n t s 370* 371*****************************************************************************/ 372 373/****************************************************************************/ 374/* Simple element structures */ 375/****************************************************************************/ 376 377typedef struct _SGE_SIMPLE32 378{ 379 U32 FlagsLength; 380 U32 Address; 381} SGE_SIMPLE32, MPI_POINTER PTR_SGE_SIMPLE32, 382 SGESimple32_t, MPI_POINTER pSGESimple32_t; 383 384typedef struct _SGE_SIMPLE64 385{ 386 U32 FlagsLength; 387 U64 Address; 388} SGE_SIMPLE64, MPI_POINTER PTR_SGE_SIMPLE64, 389 SGESimple64_t, MPI_POINTER pSGESimple64_t; 390 391typedef struct _SGE_SIMPLE_UNION 392{ 393 U32 FlagsLength; 394 union 395 { 396 U32 Address32; 397 U64 Address64; 398 }u; 399} SGE_SIMPLE_UNION, MPI_POINTER PTR_SGE_SIMPLE_UNION, 400 SGESimpleUnion_t, MPI_POINTER pSGESimpleUnion_t; 401 402/****************************************************************************/ 403/* Chain element structures */ 404/****************************************************************************/ 405 406typedef struct _SGE_CHAIN32 407{ 408 U16 Length; 409 U8 NextChainOffset; 410 U8 Flags; 411 U32 Address; 412} SGE_CHAIN32, MPI_POINTER PTR_SGE_CHAIN32, 413 SGEChain32_t, MPI_POINTER pSGEChain32_t; 414 415typedef struct _SGE_CHAIN64 416{ 417 U16 Length; 418 U8 NextChainOffset; 419 U8 Flags; 420 U64 Address; 421} SGE_CHAIN64, MPI_POINTER PTR_SGE_CHAIN64, 422 SGEChain64_t, MPI_POINTER pSGEChain64_t; 423 424typedef struct _SGE_CHAIN_UNION 425{ 426 U16 Length; 427 U8 NextChainOffset; 428 U8 Flags; 429 union 430 { 431 U32 Address32; 432 U64 Address64; 433 }u; 434} SGE_CHAIN_UNION, MPI_POINTER PTR_SGE_CHAIN_UNION, 435 SGEChainUnion_t, MPI_POINTER pSGEChainUnion_t; 436 437/****************************************************************************/ 438/* Transaction Context element */ 439/****************************************************************************/ 440 441typedef struct _SGE_TRANSACTION32 442{ 443 U8 Reserved; 444 U8 ContextSize; 445 U8 DetailsLength; 446 U8 Flags; 447 U32 TransactionContext[1]; 448 U32 TransactionDetails[1]; 449} SGE_TRANSACTION32, MPI_POINTER PTR_SGE_TRANSACTION32, 450 SGETransaction32_t, MPI_POINTER pSGETransaction32_t; 451 452typedef struct _SGE_TRANSACTION64 453{ 454 U8 Reserved; 455 U8 ContextSize; 456 U8 DetailsLength; 457 U8 Flags; 458 U32 TransactionContext[2]; 459 U32 TransactionDetails[1]; 460} SGE_TRANSACTION64, MPI_POINTER PTR_SGE_TRANSACTION64, 461 SGETransaction64_t, MPI_POINTER pSGETransaction64_t; 462 463typedef struct _SGE_TRANSACTION96 464{ 465 U8 Reserved; 466 U8 ContextSize; 467 U8 DetailsLength; 468 U8 Flags; 469 U32 TransactionContext[3]; 470 U32 TransactionDetails[1]; 471} SGE_TRANSACTION96, MPI_POINTER PTR_SGE_TRANSACTION96, 472 SGETransaction96_t, MPI_POINTER pSGETransaction96_t; 473 474typedef struct _SGE_TRANSACTION128 475{ 476 U8 Reserved; 477 U8 ContextSize; 478 U8 DetailsLength; 479 U8 Flags; 480 U32 TransactionContext[4]; 481 U32 TransactionDetails[1]; 482} SGE_TRANSACTION128, MPI_POINTER PTR_SGE_TRANSACTION128, 483 SGETransaction_t128, MPI_POINTER pSGETransaction_t128; 484 485typedef struct _SGE_TRANSACTION_UNION 486{ 487 U8 Reserved; 488 U8 ContextSize; 489 U8 DetailsLength; 490 U8 Flags; 491 union 492 { 493 U32 TransactionContext32[1]; 494 U32 TransactionContext64[2]; 495 U32 TransactionContext96[3]; 496 U32 TransactionContext128[4]; 497 }u; 498 U32 TransactionDetails[1]; 499} SGE_TRANSACTION_UNION, MPI_POINTER PTR_SGE_TRANSACTION_UNION, 500 SGETransactionUnion_t, MPI_POINTER pSGETransactionUnion_t; 501 502 503/****************************************************************************/ 504/* SGE IO types union for IO SGL's */ 505/****************************************************************************/ 506 507typedef struct _SGE_IO_UNION 508{ 509 union 510 { 511 SGE_SIMPLE_UNION Simple; 512 SGE_CHAIN_UNION Chain; 513 } u; 514} SGE_IO_UNION, MPI_POINTER PTR_SGE_IO_UNION, 515 SGEIOUnion_t, MPI_POINTER pSGEIOUnion_t; 516 517/****************************************************************************/ 518/* SGE union for SGL's with Simple and Transaction elements */ 519/****************************************************************************/ 520 521typedef struct _SGE_TRANS_SIMPLE_UNION 522{ 523 union 524 { 525 SGE_SIMPLE_UNION Simple; 526 SGE_TRANSACTION_UNION Transaction; 527 } u; 528} SGE_TRANS_SIMPLE_UNION, MPI_POINTER PTR_SGE_TRANS_SIMPLE_UNION, 529 SGETransSimpleUnion_t, MPI_POINTER pSGETransSimpleUnion_t; 530 531/****************************************************************************/ 532/* All SGE types union */ 533/****************************************************************************/ 534 535typedef struct _SGE_MPI_UNION 536{ 537 union 538 { 539 SGE_SIMPLE_UNION Simple; 540 SGE_CHAIN_UNION Chain; 541 SGE_TRANSACTION_UNION Transaction; 542 } u; 543} SGE_MPI_UNION, MPI_POINTER PTR_SGE_MPI_UNION, 544 MPI_SGE_UNION_t, MPI_POINTER pMPI_SGE_UNION_t, 545 SGEAllUnion_t, MPI_POINTER pSGEAllUnion_t; 546 547 548/****************************************************************************/ 549/* SGE field definition and masks */ 550/****************************************************************************/ 551 552/* Flags field bit definitions */ 553 554#define MPI_SGE_FLAGS_LAST_ELEMENT (0x80) 555#define MPI_SGE_FLAGS_END_OF_BUFFER (0x40) 556#define MPI_SGE_FLAGS_ELEMENT_TYPE_MASK (0x30) 557#define MPI_SGE_FLAGS_LOCAL_ADDRESS (0x08) 558#define MPI_SGE_FLAGS_DIRECTION (0x04) 559#define MPI_SGE_FLAGS_ADDRESS_SIZE (0x02) 560#define MPI_SGE_FLAGS_END_OF_LIST (0x01) 561 562#define MPI_SGE_FLAGS_SHIFT (24) 563 564#define MPI_SGE_LENGTH_MASK (0x00FFFFFF) 565#define MPI_SGE_CHAIN_LENGTH_MASK (0x0000FFFF) 566 567/* Element Type */ 568 569#define MPI_SGE_FLAGS_TRANSACTION_ELEMENT (0x00) 570#define MPI_SGE_FLAGS_SIMPLE_ELEMENT (0x10) 571#define MPI_SGE_FLAGS_CHAIN_ELEMENT (0x30) 572#define MPI_SGE_FLAGS_ELEMENT_MASK (0x30) 573 574/* Address location */ 575 576#define MPI_SGE_FLAGS_SYSTEM_ADDRESS (0x00) 577 578/* Direction */ 579 580#define MPI_SGE_FLAGS_IOC_TO_HOST (0x00) 581#define MPI_SGE_FLAGS_HOST_TO_IOC (0x04) 582 583/* Address Size */ 584 585#define MPI_SGE_FLAGS_32_BIT_ADDRESSING (0x00) 586#define MPI_SGE_FLAGS_64_BIT_ADDRESSING (0x02) 587 588/* Context Size */ 589 590#define MPI_SGE_FLAGS_32_BIT_CONTEXT (0x00) 591#define MPI_SGE_FLAGS_64_BIT_CONTEXT (0x02) 592#define MPI_SGE_FLAGS_96_BIT_CONTEXT (0x04) 593#define MPI_SGE_FLAGS_128_BIT_CONTEXT (0x06) 594 595#define MPI_SGE_CHAIN_OFFSET_MASK (0x00FF0000) 596#define MPI_SGE_CHAIN_OFFSET_SHIFT (16) 597 598 599/****************************************************************************/ 600/* SGE operation Macros */ 601/****************************************************************************/ 602 603 /* SIMPLE FlagsLength manipulations... */ 604#define MPI_SGE_SET_FLAGS(f) ((U32)(f) << MPI_SGE_FLAGS_SHIFT) 605#define MPI_SGE_GET_FLAGS(fl) (((fl) & ~MPI_SGE_LENGTH_MASK) >> MPI_SGE_FLAGS_SHIFT) 606#define MPI_SGE_LENGTH(fl) ((fl) & MPI_SGE_LENGTH_MASK) 607#define MPI_SGE_CHAIN_LENGTH(fl) ((fl) & MPI_SGE_CHAIN_LENGTH_MASK) 608 609#define MPI_SGE_SET_FLAGS_LENGTH(f,l) (MPI_SGE_SET_FLAGS(f) | MPI_SGE_LENGTH(l)) 610 611#define MPI_pSGE_GET_FLAGS(psg) MPI_SGE_GET_FLAGS((psg)->FlagsLength) 612#define MPI_pSGE_GET_LENGTH(psg) MPI_SGE_LENGTH((psg)->FlagsLength) 613#define MPI_pSGE_SET_FLAGS_LENGTH(psg,f,l) (psg)->FlagsLength = MPI_SGE_SET_FLAGS_LENGTH(f,l) 614 /* CAUTION - The following are READ-MODIFY-WRITE! */ 615#define MPI_pSGE_SET_FLAGS(psg,f) (psg)->FlagsLength |= MPI_SGE_SET_FLAGS(f) 616#define MPI_pSGE_SET_LENGTH(psg,l) (psg)->FlagsLength |= MPI_SGE_LENGTH(l) 617 618#define MPI_GET_CHAIN_OFFSET(x) ((x&MPI_SGE_CHAIN_OFFSET_MASK)>>MPI_SGE_CHAIN_OFFSET_SHIFT) 619 620 621 622/***************************************************************************** 623* 624* S t a n d a r d M e s s a g e S t r u c t u r e s 625* 626*****************************************************************************/ 627 628/****************************************************************************/ 629/* Standard message request header for all request messages */ 630/****************************************************************************/ 631 632typedef struct _MSG_REQUEST_HEADER 633{ 634 U8 Reserved[2]; /* function specific */ 635 U8 ChainOffset; 636 U8 Function; 637 U8 Reserved1[3]; /* function specific */ 638 U8 MsgFlags; 639 U32 MsgContext; 640} MSG_REQUEST_HEADER, MPI_POINTER PTR_MSG_REQUEST_HEADER, 641 MPIHeader_t, MPI_POINTER pMPIHeader_t; 642 643 644/****************************************************************************/ 645/* Default Reply */ 646/****************************************************************************/ 647 648typedef struct _MSG_DEFAULT_REPLY 649{ 650 U8 Reserved[2]; /* function specific */ 651 U8 MsgLength; 652 U8 Function; 653 U8 Reserved1[3]; /* function specific */ 654 U8 MsgFlags; 655 U32 MsgContext; 656 U8 Reserved2[2]; /* function specific */ 657 U16 IOCStatus; 658 U32 IOCLogInfo; 659} MSG_DEFAULT_REPLY, MPI_POINTER PTR_MSG_DEFAULT_REPLY, 660 MPIDefaultReply_t, MPI_POINTER pMPIDefaultReply_t; 661 662 663/* MsgFlags definition for all replies */ 664 665#define MPI_MSGFLAGS_CONTINUATION_REPLY (0x80) 666 667 668/***************************************************************************** 669* 670* I O C S t a t u s V a l u e s 671* 672*****************************************************************************/ 673 674/****************************************************************************/ 675/* Common IOCStatus values for all replies */ 676/****************************************************************************/ 677 678#define MPI_IOCSTATUS_SUCCESS (0x0000) 679#define MPI_IOCSTATUS_INVALID_FUNCTION (0x0001) 680#define MPI_IOCSTATUS_BUSY (0x0002) 681#define MPI_IOCSTATUS_INVALID_SGL (0x0003) 682#define MPI_IOCSTATUS_INTERNAL_ERROR (0x0004) 683#define MPI_IOCSTATUS_RESERVED (0x0005) 684#define MPI_IOCSTATUS_INSUFFICIENT_RESOURCES (0x0006) 685#define MPI_IOCSTATUS_INVALID_FIELD (0x0007) 686#define MPI_IOCSTATUS_INVALID_STATE (0x0008) 687#define MPI_IOCSTATUS_OP_STATE_NOT_SUPPORTED (0x0009) 688 689/****************************************************************************/ 690/* Config IOCStatus values */ 691/****************************************************************************/ 692 693#define MPI_IOCSTATUS_CONFIG_INVALID_ACTION (0x0020) 694#define MPI_IOCSTATUS_CONFIG_INVALID_TYPE (0x0021) 695#define MPI_IOCSTATUS_CONFIG_INVALID_PAGE (0x0022) 696#define MPI_IOCSTATUS_CONFIG_INVALID_DATA (0x0023) 697#define MPI_IOCSTATUS_CONFIG_NO_DEFAULTS (0x0024) 698#define MPI_IOCSTATUS_CONFIG_CANT_COMMIT (0x0025) 699 700/****************************************************************************/ 701/* SCSIIO Reply (SPI & FCP) initiator values */ 702/****************************************************************************/ 703 704#define MPI_IOCSTATUS_SCSI_RECOVERED_ERROR (0x0040) 705#define MPI_IOCSTATUS_SCSI_INVALID_BUS (0x0041) 706#define MPI_IOCSTATUS_SCSI_INVALID_TARGETID (0x0042) 707#define MPI_IOCSTATUS_SCSI_DEVICE_NOT_THERE (0x0043) 708#define MPI_IOCSTATUS_SCSI_DATA_OVERRUN (0x0044) 709#define MPI_IOCSTATUS_SCSI_DATA_UNDERRUN (0x0045) 710#define MPI_IOCSTATUS_SCSI_IO_DATA_ERROR (0x0046) 711#define MPI_IOCSTATUS_SCSI_PROTOCOL_ERROR (0x0047) 712#define MPI_IOCSTATUS_SCSI_TASK_TERMINATED (0x0048) 713#define MPI_IOCSTATUS_SCSI_RESIDUAL_MISMATCH (0x0049) 714#define MPI_IOCSTATUS_SCSI_TASK_MGMT_FAILED (0x004A) 715#define MPI_IOCSTATUS_SCSI_IOC_TERMINATED (0x004B) 716#define MPI_IOCSTATUS_SCSI_EXT_TERMINATED (0x004C) 717 718/****************************************************************************/ 719/* For use by SCSI Initiator and SCSI Target end-to-end data protection */ 720/****************************************************************************/ 721 722#define MPI_IOCSTATUS_EEDP_GUARD_ERROR (0x004D) 723#define MPI_IOCSTATUS_EEDP_REF_TAG_ERROR (0x004E) 724#define MPI_IOCSTATUS_EEDP_APP_TAG_ERROR (0x004F) 725 726 727/****************************************************************************/ 728/* SCSI Target values */ 729/****************************************************************************/ 730 731#define MPI_IOCSTATUS_TARGET_PRIORITY_IO (0x0060) 732#define MPI_IOCSTATUS_TARGET_INVALID_PORT (0x0061) 733#define MPI_IOCSTATUS_TARGET_INVALID_IOCINDEX (0x0062) /* obsolete name */ 734#define MPI_IOCSTATUS_TARGET_INVALID_IO_INDEX (0x0062) 735#define MPI_IOCSTATUS_TARGET_ABORTED (0x0063) 736#define MPI_IOCSTATUS_TARGET_NO_CONN_RETRYABLE (0x0064) 737#define MPI_IOCSTATUS_TARGET_NO_CONNECTION (0x0065) 738#define MPI_IOCSTATUS_TARGET_XFER_COUNT_MISMATCH (0x006A) 739#define MPI_IOCSTATUS_TARGET_STS_DATA_NOT_SENT (0x006B) 740#define MPI_IOCSTATUS_TARGET_DATA_OFFSET_ERROR (0x006D) 741#define MPI_IOCSTATUS_TARGET_TOO_MUCH_WRITE_DATA (0x006E) 742#define MPI_IOCSTATUS_TARGET_IU_TOO_SHORT (0x006F) 743#define MPI_IOCSTATUS_TARGET_ACK_NAK_TIMEOUT (0x0070) 744#define MPI_IOCSTATUS_TARGET_NAK_RECEIVED (0x0071) 745 746/****************************************************************************/ 747/* Additional FCP target values (obsolete) */ 748/****************************************************************************/ 749 750#define MPI_IOCSTATUS_TARGET_FC_ABORTED (0x0066) /* obsolete */ 751#define MPI_IOCSTATUS_TARGET_FC_RX_ID_INVALID (0x0067) /* obsolete */ 752#define MPI_IOCSTATUS_TARGET_FC_DID_INVALID (0x0068) /* obsolete */ 753#define MPI_IOCSTATUS_TARGET_FC_NODE_LOGGED_OUT (0x0069) /* obsolete */ 754 755/****************************************************************************/ 756/* Fibre Channel Direct Access values */ 757/****************************************************************************/ 758 759#define MPI_IOCSTATUS_FC_ABORTED (0x0066) 760#define MPI_IOCSTATUS_FC_RX_ID_INVALID (0x0067) 761#define MPI_IOCSTATUS_FC_DID_INVALID (0x0068) 762#define MPI_IOCSTATUS_FC_NODE_LOGGED_OUT (0x0069) 763#define MPI_IOCSTATUS_FC_EXCHANGE_CANCELED (0x006C) 764 765/****************************************************************************/ 766/* LAN values */ 767/****************************************************************************/ 768 769#define MPI_IOCSTATUS_LAN_DEVICE_NOT_FOUND (0x0080) 770#define MPI_IOCSTATUS_LAN_DEVICE_FAILURE (0x0081) 771#define MPI_IOCSTATUS_LAN_TRANSMIT_ERROR (0x0082) 772#define MPI_IOCSTATUS_LAN_TRANSMIT_ABORTED (0x0083) 773#define MPI_IOCSTATUS_LAN_RECEIVE_ERROR (0x0084) 774#define MPI_IOCSTATUS_LAN_RECEIVE_ABORTED (0x0085) 775#define MPI_IOCSTATUS_LAN_PARTIAL_PACKET (0x0086) 776#define MPI_IOCSTATUS_LAN_CANCELED (0x0087) 777 778/****************************************************************************/ 779/* Serial Attached SCSI values */ 780/****************************************************************************/ 781 782#define MPI_IOCSTATUS_SAS_SMP_REQUEST_FAILED (0x0090) 783#define MPI_IOCSTATUS_SAS_SMP_DATA_OVERRUN (0x0091) 784 785/****************************************************************************/ 786/* Inband values */ 787/****************************************************************************/ 788 789#define MPI_IOCSTATUS_INBAND_ABORTED (0x0098) 790#define MPI_IOCSTATUS_INBAND_NO_CONNECTION (0x0099) 791 792/****************************************************************************/ 793/* Diagnostic Tools values */ 794/****************************************************************************/ 795 796#define MPI_IOCSTATUS_DIAGNOSTIC_RELEASED (0x00A0) 797 798 799/****************************************************************************/ 800/* IOCStatus flag to indicate that log info is available */ 801/****************************************************************************/ 802 803#define MPI_IOCSTATUS_FLAG_LOG_INFO_AVAILABLE (0x8000) 804#define MPI_IOCSTATUS_MASK (0x7FFF) 805 806/****************************************************************************/ 807/* LogInfo Types */ 808/****************************************************************************/ 809 810#define MPI_IOCLOGINFO_TYPE_MASK (0xF0000000) 811#define MPI_IOCLOGINFO_TYPE_SHIFT (28) 812#define MPI_IOCLOGINFO_TYPE_NONE (0x0) 813#define MPI_IOCLOGINFO_TYPE_SCSI (0x1) 814#define MPI_IOCLOGINFO_TYPE_FC (0x2) 815#define MPI_IOCLOGINFO_TYPE_SAS (0x3) 816#define MPI_IOCLOGINFO_TYPE_ISCSI (0x4) 817#define MPI_IOCLOGINFO_LOG_DATA_MASK (0x0FFFFFFF) 818 819 820#endif 821