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