mpi.h revision 102595
1/* $FreeBSD: head/sys/dev/mpt/mpilib/mpi.h 102595 2002-08-30 02:34:19Z mjacob $ */ 2/* 3 * Copyright (c) 2000-2001 LSI Logic Corporation. 4 * 5 * 6 * Name: MPI.H 7 * Title: MPI Message independent structures and definitions 8 * Creation Date: July 27, 2000 9 * 10 * MPI Version: 01.02.03 11 * 12 * Version History 13 * --------------- 14 * 15 * Date Version Description 16 * -------- -------- ------------------------------------------------------ 17 * 05-08-00 00.10.01 Original release for 0.10 spec dated 4/26/2000. 18 * 05-24-00 00.10.02 Added MPI_IOCSTATUS_SCSI_RESIDUAL_MISMATCH definition. 19 * 06-06-00 01.00.01 Update MPI_VERSION_MAJOR and MPI_VERSION_MINOR. 20 * 06-22-00 01.00.02 Added MPI_IOCSTATUS_LAN_ definitions. 21 * Removed LAN_SUSPEND function definition. 22 * Added MPI_MSGFLAGS_CONTINUATION_REPLY definition. 23 * 06-30-00 01.00.03 Added MPI_CONTEXT_REPLY_TYPE_LAN definition. 24 * Added MPI_GET/SET_CONTEXT_REPLY_TYPE macros. 25 * 07-27-00 01.00.04 Added MPI_FAULT_ definitions. 26 * Removed MPI_IOCSTATUS_MSG/DATA_XFER_ERROR definitions. 27 * Added MPI_IOCSTATUS_INTERNAL_ERROR definition. 28 * Added MPI_IOCSTATUS_TARGET_XFER_COUNT_MISMATCH. 29 * 11-02-00 01.01.01 Original release for post 1.0 work. 30 * 12-04-00 01.01.02 Added new function codes. 31 * 01-09-01 01.01.03 Added more definitions to the system interface section 32 * Added MPI_IOCSTATUS_TARGET_STS_DATA_NOT_SENT. 33 * 01-25-01 01.01.04 Changed MPI_VERSION_MINOR from 0x00 to 0x01. 34 * 02-20-01 01.01.05 Started using MPI_POINTER. 35 * Fixed value for MPI_DIAG_RW_ENABLE. 36 * Added defines for MPI_DIAG_PREVENT_IOC_BOOT and 37 * MPI_DIAG_CLEAR_FLASH_BAD_SIG. 38 * Obsoleted MPI_IOCSTATUS_TARGET_FC_ defines. 39 * 02-27-01 01.01.06 Removed MPI_HOST_INDEX_REGISTER define. 40 * Added function codes for RAID. 41 * 04-09-01 01.01.07 Added alternate define for MPI_DOORBELL_ACTIVE, 42 * MPI_DOORBELL_USED, to better match the spec. 43 * 08-08-01 01.02.01 Original release for v1.2 work. 44 * Changed MPI_VERSION_MINOR from 0x01 to 0x02. 45 * Added define MPI_FUNCTION_TOOLBOX. 46 * 09-28-01 01.02.02 New function code MPI_SCSI_ENCLOSURE_PROCESSOR. 47 * 11-01-01 01.02.03 Changed name to MPI_FUNCTION_SCSI_ENCLOSURE_PROCESSOR. 48 * -------------------------------------------------------------------------- 49 */ 50/* 51 * Copyright (c) 2002 by Matthew Jacob 52 * 53 * Redistribution and use in source and binary forms, with or without 54 * modification, are permitted provided that the following conditions 55 * are met: 56 * 1. Redistributions of source code must retain the original LSI Logic 57 * copyright notice at the beginning of the file and the above copyright 58 * notice immediately after it, both without modification, this list of 59 * conditions, and the following disclaimer and note. 60 * 2. The name of the author or LSI Logic may not be used to endorse or 61 * promote products derived from this software without specific prior 62 * written permission. 63 * 64 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND LSI LOGIC AND CONTRIBUTORS 65 *``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 66 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 67 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE 68 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 69 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 70 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 71 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 72 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 73 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 74 * POSSIBILITY OF SUCH DAMAGE. 75 * 76 * Note: this copyright information has been added with the express written 77 * consent of LSI Logic (available upon request) in order to clarify the 78 * original LSI Logic copyright in order to allow for unencumbered binary 79 * and source redistribution of the MPI API definitions. 80 */ 81 82#ifndef MPI_H 83#define MPI_H 84 85 86/***************************************************************************** 87* 88* M P I V e r s i o n D e f i n i t i o n s 89* 90*****************************************************************************/ 91 92#define MPI_VERSION_MAJOR (0x01) 93#define MPI_VERSION_MINOR (0x02) 94#define MPI_VERSION ((MPI_VERSION_MAJOR << 8) | MPI_VERSION_MINOR) 95 96/* Note: The major versions of 0xe0 through 0xff are reserved */ 97 98/***************************************************************************** 99* 100* I O C S t a t e D e f i n i t i o n s 101* 102*****************************************************************************/ 103 104#define MPI_IOC_STATE_RESET (0x00000000) 105#define MPI_IOC_STATE_READY (0x10000000) 106#define MPI_IOC_STATE_OPERATIONAL (0x20000000) 107#define MPI_IOC_STATE_FAULT (0x40000000) 108 109#define MPI_IOC_STATE_MASK (0xF0000000) 110#define MPI_IOC_STATE_SHIFT (28) 111 112/* Fault state codes (product independent range 0x8000-0xFFFF) */ 113 114#define MPI_FAULT_REQUEST_MESSAGE_PCI_PARITY_ERROR (0x8111) 115#define MPI_FAULT_REQUEST_MESSAGE_PCI_BUS_FAULT (0x8112) 116#define MPI_FAULT_REPLY_MESSAGE_PCI_PARITY_ERROR (0x8113) 117#define MPI_FAULT_REPLY_MESSAGE_PCI_BUS_FAULT (0x8114) 118#define MPI_FAULT_DATA_SEND_PCI_PARITY_ERROR (0x8115) 119#define MPI_FAULT_DATA_SEND_PCI_BUS_FAULT (0x8116) 120#define MPI_FAULT_DATA_RECEIVE_PCI_PARITY_ERROR (0x8117) 121#define MPI_FAULT_DATA_RECEIVE_PCI_BUS_FAULT (0x8118) 122 123 124/***************************************************************************** 125* 126* 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 127* 128*****************************************************************************/ 129 130/* S y s t e m D o o r b e l l */ 131#define MPI_DOORBELL_OFFSET (0x00000000) 132#define MPI_DOORBELL_ACTIVE (0x08000000) /* DoorbellUsed */ 133#define MPI_DOORBELL_USED (MPI_DOORBELL_ACTIVE) 134#define MPI_DOORBELL_ACTIVE_SHIFT (27) 135#define MPI_DOORBELL_WHO_INIT_MASK (0x07000000) 136#define MPI_DOORBELL_WHO_INIT_SHIFT (24) 137#define MPI_DOORBELL_FUNCTION_MASK (0xFF000000) 138#define MPI_DOORBELL_FUNCTION_SHIFT (24) 139#define MPI_DOORBELL_ADD_DWORDS_MASK (0x00FF0000) 140#define MPI_DOORBELL_ADD_DWORDS_SHIFT (16) 141#define MPI_DOORBELL_DATA_MASK (0x0000FFFF) 142 143 144#define MPI_WRITE_SEQUENCE_OFFSET (0x00000004) 145#define MPI_WRSEQ_KEY_VALUE_MASK (0x0000000F) 146#define MPI_WRSEQ_1ST_KEY_VALUE (0x04) 147#define MPI_WRSEQ_2ND_KEY_VALUE (0x0B) 148#define MPI_WRSEQ_3RD_KEY_VALUE (0x02) 149#define MPI_WRSEQ_4TH_KEY_VALUE (0x07) 150#define MPI_WRSEQ_5TH_KEY_VALUE (0x0D) 151 152#define MPI_DIAGNOSTIC_OFFSET (0x00000008) 153#define MPI_DIAG_CLEAR_FLASH_BAD_SIG (0x00000400) 154#define MPI_DIAG_PREVENT_IOC_BOOT (0x00000200) 155#define MPI_DIAG_DRWE (0x00000080) 156#define MPI_DIAG_FLASH_BAD_SIG (0x00000040) 157#define MPI_DIAG_RESET_HISTORY (0x00000020) 158#define MPI_DIAG_RW_ENABLE (0x00000010) 159#define MPI_DIAG_RESET_ADAPTER (0x00000004) 160#define MPI_DIAG_DISABLE_ARM (0x00000002) 161#define MPI_DIAG_MEM_ENABLE (0x00000001) 162 163#define MPI_TEST_BASE_ADDRESS_OFFSET (0x0000000C) 164 165#define MPI_DIAG_RW_DATA_OFFSET (0x00000010) 166 167#define MPI_DIAG_RW_ADDRESS_OFFSET (0x00000014) 168 169#define MPI_HOST_INTERRUPT_STATUS_OFFSET (0x00000030) 170#define MPI_HIS_IOP_DOORBELL_STATUS (0x80000000) 171#define MPI_HIS_REPLY_MESSAGE_INTERRUPT (0x00000008) 172#define MPI_HIS_DOORBELL_INTERRUPT (0x00000001) 173 174#define MPI_HOST_INTERRUPT_MASK_OFFSET (0x00000034) 175#define MPI_HIM_RIM (0x00000008) 176#define MPI_HIM_DIM (0x00000001) 177 178#define MPI_REQUEST_QUEUE_OFFSET (0x00000040) 179#define MPI_REQUEST_POST_FIFO_OFFSET (0x00000040) 180 181#define MPI_REPLY_QUEUE_OFFSET (0x00000044) 182#define MPI_REPLY_POST_FIFO_OFFSET (0x00000044) 183#define MPI_REPLY_FREE_FIFO_OFFSET (0x00000044) 184 185 186 187/***************************************************************************** 188* 189* M e s s a g e F r a m e D e s c r i p t o r s 190* 191*****************************************************************************/ 192 193#define MPI_REQ_MF_DESCRIPTOR_NB_MASK (0x00000003) 194#define MPI_REQ_MF_DESCRIPTOR_F_BIT (0x00000004) 195#define MPI_REQ_MF_DESCRIPTOR_ADDRESS_MASK (0xFFFFFFF8) 196 197#define MPI_ADDRESS_REPLY_A_BIT (0x80000000) 198#define MPI_ADDRESS_REPLY_ADDRESS_MASK (0x7FFFFFFF) 199 200#define MPI_CONTEXT_REPLY_A_BIT (0x80000000) 201#define MPI_CONTEXT_REPLY_TYPE_MASK (0x60000000) 202#define MPI_CONTEXT_REPLY_TYPE_SCSI_INIT (0x00) 203#define MPI_CONTEXT_REPLY_TYPE_SCSI_TARGET (0x01) 204#define MPI_CONTEXT_REPLY_TYPE_LAN (0x02) 205#define MPI_CONTEXT_REPLY_TYPE_SHIFT (29) 206#define MPI_CONTEXT_REPLY_CONTEXT_MASK (0x1FFFFFFF) 207 208 209/****************************************************************************/ 210/* Context Reply macros */ 211/****************************************************************************/ 212 213#define MPI_GET_CONTEXT_REPLY_TYPE(x) (((x) & MPI_CONTEXT_REPLY_TYPE_MASK) \ 214 >> MPI_CONTEXT_REPLY_TYPE_SHIFT) 215 216#define MPI_SET_CONTEXT_REPLY_TYPE(x, typ) \ 217 ((x) = ((x) & ~MPI_CONTEXT_REPLY_TYPE_MASK) | \ 218 (((typ) << MPI_CONTEXT_REPLY_TYPE_SHIFT) & \ 219 MPI_CONTEXT_REPLY_TYPE_MASK)) 220 221 222/***************************************************************************** 223* 224* M e s s a g e F u n c t i o n s 225* 0x80 -> 0x8F reserved for private message use per product 226* 227* 228*****************************************************************************/ 229 230#define MPI_FUNCTION_SCSI_IO_REQUEST (0x00) 231#define MPI_FUNCTION_SCSI_TASK_MGMT (0x01) 232#define MPI_FUNCTION_IOC_INIT (0x02) 233#define MPI_FUNCTION_IOC_FACTS (0x03) 234#define MPI_FUNCTION_CONFIG (0x04) 235#define MPI_FUNCTION_PORT_FACTS (0x05) 236#define MPI_FUNCTION_PORT_ENABLE (0x06) 237#define MPI_FUNCTION_EVENT_NOTIFICATION (0x07) 238#define MPI_FUNCTION_EVENT_ACK (0x08) 239#define MPI_FUNCTION_FW_DOWNLOAD (0x09) 240#define MPI_FUNCTION_TARGET_CMD_BUFFER_POST (0x0A) 241#define MPI_FUNCTION_TARGET_ASSIST (0x0B) 242#define MPI_FUNCTION_TARGET_STATUS_SEND (0x0C) 243#define MPI_FUNCTION_TARGET_MODE_ABORT (0x0D) 244#define MPI_FUNCTION_TARGET_FC_BUF_POST_LINK_SRVC (0x0E) /* obsolete name */ 245#define MPI_FUNCTION_TARGET_FC_RSP_LINK_SRVC (0x0F) /* obsolete name */ 246#define MPI_FUNCTION_TARGET_FC_EX_SEND_LINK_SRVC (0x10) /* obsolete name */ 247#define MPI_FUNCTION_TARGET_FC_ABORT (0x11) /* obsolete name */ 248#define MPI_FUNCTION_FC_LINK_SRVC_BUF_POST (0x0E) 249#define MPI_FUNCTION_FC_LINK_SRVC_RSP (0x0F) 250#define MPI_FUNCTION_FC_EX_LINK_SRVC_SEND (0x10) 251#define MPI_FUNCTION_FC_ABORT (0x11) 252#define MPI_FUNCTION_FW_UPLOAD (0x12) 253#define MPI_FUNCTION_FC_COMMON_TRANSPORT_SEND (0x13) 254#define MPI_FUNCTION_FC_PRIMITIVE_SEND (0x14) 255 256#define MPI_FUNCTION_RAID_ACTION (0x15) 257#define MPI_FUNCTION_RAID_SCSI_IO_PASSTHROUGH (0x16) 258 259#define MPI_FUNCTION_TOOLBOX (0x17) 260 261#define MPI_FUNCTION_SCSI_ENCLOSURE_PROCESSOR (0x18) 262 263#define MPI_FUNCTION_LAN_SEND (0x20) 264#define MPI_FUNCTION_LAN_RECEIVE (0x21) 265#define MPI_FUNCTION_LAN_RESET (0x22) 266 267#define MPI_FUNCTION_IOC_MESSAGE_UNIT_RESET (0x40) 268#define MPI_FUNCTION_IO_UNIT_RESET (0x41) 269#define MPI_FUNCTION_HANDSHAKE (0x42) 270#define MPI_FUNCTION_REPLY_FRAME_REMOVAL (0x43) 271 272 273 274/***************************************************************************** 275* 276* S c a t t e r G a t h e r E l e m e n t s 277* 278*****************************************************************************/ 279 280/****************************************************************************/ 281/* Simple element structures */ 282/****************************************************************************/ 283 284typedef struct _SGE_SIMPLE32 285{ 286 U32 FlagsLength; 287 U32 Address; 288} SGE_SIMPLE32, MPI_POINTER PTR_SGE_SIMPLE32, 289 SGESimple32_t, MPI_POINTER pSGESimple32_t; 290 291typedef struct _SGE_SIMPLE64 292{ 293 U32 FlagsLength; 294 U64 Address; 295} SGE_SIMPLE64, MPI_POINTER PTR_SGE_SIMPLE64, 296 SGESimple64_t, MPI_POINTER pSGESimple64_t; 297 298typedef struct _SGE_SIMPLE_UNION 299{ 300 U32 FlagsLength; 301 union 302 { 303 U32 Address32; 304 U64 Address64; 305 } _u; 306} SGESimpleUnion_t, MPI_POINTER pSGESimpleUnion_t, 307 SGE_SIMPLE_UNION, MPI_POINTER PTR_SGE_SIMPLE_UNION; 308 309/****************************************************************************/ 310/* Chain element structures */ 311/****************************************************************************/ 312 313typedef struct _SGE_CHAIN32 314{ 315 U16 Length; 316 U8 NextChainOffset; 317 U8 Flags; 318 U32 Address; 319} SGE_CHAIN32, MPI_POINTER PTR_SGE_CHAIN32, 320 SGEChain32_t, MPI_POINTER pSGEChain32_t; 321 322typedef struct _SGE_CHAIN64 323{ 324 U16 Length; 325 U8 NextChainOffset; 326 U8 Flags; 327 U64 Address; 328} SGE_CHAIN64, MPI_POINTER PTR_SGE_CHAIN64, 329 SGEChain64_t, MPI_POINTER pSGEChain64_t; 330 331typedef struct _SGE_CHAIN_UNION 332{ 333 U16 Length; 334 U8 NextChainOffset; 335 U8 Flags; 336 union 337 { 338 U32 Address32; 339 U64 Address64; 340 } _u; 341} SGE_CHAIN_UNION, MPI_POINTER PTR_SGE_CHAIN_UNION, 342 SGEChainUnion_t, MPI_POINTER pSGEChainUnion_t; 343 344/****************************************************************************/ 345/* Transaction Context element */ 346/****************************************************************************/ 347 348typedef struct _SGE_TRANSACTION32 349{ 350 U8 Reserved; 351 U8 ContextSize; 352 U8 DetailsLength; 353 U8 Flags; 354 U32 TransactionContext[1]; 355 U32 TransactionDetails[1]; 356} SGE_TRANSACTION32, MPI_POINTER PTR_SGE_TRANSACTION32, 357 SGETransaction32_t, MPI_POINTER pSGETransaction32_t; 358 359typedef struct _SGE_TRANSACTION64 360{ 361 U8 Reserved; 362 U8 ContextSize; 363 U8 DetailsLength; 364 U8 Flags; 365 U32 TransactionContext[2]; 366 U32 TransactionDetails[1]; 367} SGE_TRANSACTION64, MPI_POINTER PTR_SGE_TRANSACTION64, 368 SGETransaction64_t, MPI_POINTER pSGETransaction64_t; 369 370typedef struct _SGE_TRANSACTION96 371{ 372 U8 Reserved; 373 U8 ContextSize; 374 U8 DetailsLength; 375 U8 Flags; 376 U32 TransactionContext[3]; 377 U32 TransactionDetails[1]; 378} SGE_TRANSACTION96, MPI_POINTER PTR_SGE_TRANSACTION96, 379 SGETransaction96_t, MPI_POINTER pSGETransaction96_t; 380 381typedef struct _SGE_TRANSACTION128 382{ 383 U8 Reserved; 384 U8 ContextSize; 385 U8 DetailsLength; 386 U8 Flags; 387 U32 TransactionContext[4]; 388 U32 TransactionDetails[1]; 389} SGE_TRANSACTION128, MPI_POINTER PTR_SGE_TRANSACTION128, 390 SGETransaction_t128, MPI_POINTER pSGETransaction_t128; 391 392typedef struct _SGE_TRANSACTION_UNION 393{ 394 U8 Reserved; 395 U8 ContextSize; 396 U8 DetailsLength; 397 U8 Flags; 398 union 399 { 400 U32 TransactionContext32[1]; 401 U32 TransactionContext64[2]; 402 U32 TransactionContext96[3]; 403 U32 TransactionContext128[4]; 404 } _u; 405 U32 TransactionDetails[1]; 406} SGE_TRANSACTION_UNION, MPI_POINTER PTR_SGE_TRANSACTION_UNION, 407 SGETransactionUnion_t, MPI_POINTER pSGETransactionUnion_t; 408 409 410/****************************************************************************/ 411/* SGE IO types union for IO SGL's */ 412/****************************************************************************/ 413 414typedef struct _SGE_IO_UNION 415{ 416 union 417 { 418 SGE_SIMPLE_UNION Simple; 419 SGE_CHAIN_UNION Chain; 420 } _u; 421} SGE_IO_UNION, MPI_POINTER PTR_SGE_IO_UNION, 422 SGEIOUnion_t, MPI_POINTER pSGEIOUnion_t; 423 424/****************************************************************************/ 425/* SGE union for SGL's with Simple and Transaction elements */ 426/****************************************************************************/ 427 428typedef struct _SGE_TRANS_SIMPLE_UNION 429{ 430 union 431 { 432 SGE_SIMPLE_UNION Simple; 433 SGE_TRANSACTION_UNION Transaction; 434 } _u; 435} SGE_TRANS_SIMPLE_UNION, MPI_POINTER PTR_SGE_TRANS_SIMPLE_UNION, 436 SGETransSimpleUnion_t, MPI_POINTER pSGETransSimpleUnion_t; 437 438/****************************************************************************/ 439/* All SGE types union */ 440/****************************************************************************/ 441 442typedef struct _SGE_MPI_UNION 443{ 444 union 445 { 446 SGE_SIMPLE_UNION Simple; 447 SGE_CHAIN_UNION Chain; 448 SGE_TRANSACTION_UNION Transaction; 449 } _u; 450} SGE_MPI_UNION, MPI_POINTER PTR_SGE_MPI_UNION, 451 MPI_SGE_UNION_t, MPI_POINTER pMPI_SGE_UNION_t, 452 SGEAllUnion_t, MPI_POINTER pSGEAllUnion_t; 453 454 455/****************************************************************************/ 456/* SGE field definition and masks */ 457/****************************************************************************/ 458 459/* Flags field bit definitions */ 460 461#define MPI_SGE_FLAGS_LAST_ELEMENT (0x80) 462#define MPI_SGE_FLAGS_END_OF_BUFFER (0x40) 463#define MPI_SGE_FLAGS_ELEMENT_TYPE_MASK (0x30) 464#define MPI_SGE_FLAGS_LOCAL_ADDRESS (0x08) 465#define MPI_SGE_FLAGS_DIRECTION (0x04) 466#define MPI_SGE_FLAGS_ADDRESS_SIZE (0x02) 467#define MPI_SGE_FLAGS_END_OF_LIST (0x01) 468 469#define MPI_SGE_FLAGS_SHIFT (24) 470 471#define MPI_SGE_LENGTH_MASK (0x00FFFFFF) 472#define MPI_SGE_CHAIN_LENGTH_MASK (0x0000FFFF) 473 474/* Element Type */ 475 476#define MPI_SGE_FLAGS_TRANSACTION_ELEMENT (0x00) 477#define MPI_SGE_FLAGS_SIMPLE_ELEMENT (0x10) 478#define MPI_SGE_FLAGS_CHAIN_ELEMENT (0x30) 479#define MPI_SGE_FLAGS_ELEMENT_MASK (0x30) 480 481/* Address location */ 482 483#define MPI_SGE_FLAGS_SYSTEM_ADDRESS (0x00) 484 485/* Direction */ 486 487#define MPI_SGE_FLAGS_IOC_TO_HOST (0x00) 488#define MPI_SGE_FLAGS_HOST_TO_IOC (0x04) 489 490/* Address Size */ 491 492#define MPI_SGE_FLAGS_32_BIT_ADDRESSING (0x00) 493#define MPI_SGE_FLAGS_64_BIT_ADDRESSING (0x02) 494 495/* Context Size */ 496 497#define MPI_SGE_FLAGS_32_BIT_CONTEXT (0x00) 498#define MPI_SGE_FLAGS_64_BIT_CONTEXT (0x02) 499#define MPI_SGE_FLAGS_96_BIT_CONTEXT (0x04) 500#define MPI_SGE_FLAGS_128_BIT_CONTEXT (0x06) 501 502#define MPI_SGE_CHAIN_OFFSET_MASK (0x00FF0000) 503#define MPI_SGE_CHAIN_OFFSET_SHIFT (16) 504 505 506/****************************************************************************/ 507/* SGE operation Macros */ 508/****************************************************************************/ 509 510 /* SIMPLE FlagsLength manipulations... */ 511#define MPI_SGE_SET_FLAGS(f) ((U32)(f) << MPI_SGE_FLAGS_SHIFT) 512#define MPI_SGE_GET_FLAGS(fl) (((fl) & ~MPI_SGE_LENGTH_MASK) >> MPI_SGE_FLAGS_SHIFT) 513#define MPI_SGE_LENGTH(fl) ((fl) & MPI_SGE_LENGTH_MASK) 514#define MPI_SGE_CHAIN_LENGTH(fl) ((fl) & MPI_SGE_CHAIN_LENGTH_MASK) 515 516#define MPI_SGE_SET_FLAGS_LENGTH(f,l) (MPI_SGE_SET_FLAGS(f) | MPI_SGE_LENGTH(l)) 517 518#define MPI_pSGE_GET_FLAGS(psg) MPI_SGE_GET_FLAGS((psg)->FlagsLength) 519#define MPI_pSGE_GET_LENGTH(psg) MPI_SGE_LENGTH((psg)->FlagsLength) 520#define MPI_pSGE_SET_FLAGS_LENGTH(psg,f,l) (psg)->FlagsLength = MPI_SGE_SET_FLAGS_LENGTH(f,l) 521 /* CAUTION - The following are READ-MODIFY-WRITE! */ 522#define MPI_pSGE_SET_FLAGS(psg,f) (psg)->FlagsLength |= MPI_SGE_SET_FLAGS(f) 523#define MPI_pSGE_SET_LENGTH(psg,l) (psg)->FlagsLength |= MPI_SGE_LENGTH(l) 524 525#define MPI_GET_CHAIN_OFFSET(x) ((x&MPI_SGE_CHAIN_OFFSET_MASK)>>MPI_SGE_CHAIN_OFFSET_SHIFT) 526 527 528 529/***************************************************************************** 530* 531* 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 532* 533*****************************************************************************/ 534 535/****************************************************************************/ 536/* Standard message request header for all request messages */ 537/****************************************************************************/ 538 539typedef struct _MSG_REQUEST_HEADER 540{ 541 U8 Reserved[2]; /* function specific */ 542 U8 ChainOffset; 543 U8 Function; 544 U8 Reserved1[3]; /* function specific */ 545 U8 MsgFlags; 546 U32 MsgContext; 547} MSG_REQUEST_HEADER, MPI_POINTER PTR_MSG_REQUEST_HEADER, 548 MPIHeader_t, MPI_POINTER pMPIHeader_t; 549 550 551/****************************************************************************/ 552/* Default Reply */ 553/****************************************************************************/ 554 555typedef struct _MSG_DEFAULT_REPLY 556{ 557 U8 Reserved[2]; /* function specific */ 558 U8 MsgLength; 559 U8 Function; 560 U8 Reserved1[3]; /* function specific */ 561 U8 MsgFlags; 562 U32 MsgContext; 563 U8 Reserved2[2]; /* function specific */ 564 U16 IOCStatus; 565 U32 IOCLogInfo; 566} MSG_DEFAULT_REPLY, MPI_POINTER PTR_MSG_DEFAULT_REPLY, 567 MPIDefaultReply_t, MPI_POINTER pMPIDefaultReply_t; 568 569 570/* MsgFlags definition for all replies */ 571 572#define MPI_MSGFLAGS_CONTINUATION_REPLY (0x80) 573 574 575/***************************************************************************** 576* 577* I O C S t a t u s V a l u e s 578* 579*****************************************************************************/ 580 581/****************************************************************************/ 582/* Common IOCStatus values for all replies */ 583/****************************************************************************/ 584 585#define MPI_IOCSTATUS_SUCCESS (0x0000) 586#define MPI_IOCSTATUS_INVALID_FUNCTION (0x0001) 587#define MPI_IOCSTATUS_BUSY (0x0002) 588#define MPI_IOCSTATUS_INVALID_SGL (0x0003) 589#define MPI_IOCSTATUS_INTERNAL_ERROR (0x0004) 590#define MPI_IOCSTATUS_RESERVED (0x0005) 591#define MPI_IOCSTATUS_INSUFFICIENT_RESOURCES (0x0006) 592#define MPI_IOCSTATUS_INVALID_FIELD (0x0007) 593#define MPI_IOCSTATUS_INVALID_STATE (0x0008) 594 595/****************************************************************************/ 596/* Config IOCStatus values */ 597/****************************************************************************/ 598 599#define MPI_IOCSTATUS_CONFIG_INVALID_ACTION (0x0020) 600#define MPI_IOCSTATUS_CONFIG_INVALID_TYPE (0x0021) 601#define MPI_IOCSTATUS_CONFIG_INVALID_PAGE (0x0022) 602#define MPI_IOCSTATUS_CONFIG_INVALID_DATA (0x0023) 603#define MPI_IOCSTATUS_CONFIG_NO_DEFAULTS (0x0024) 604#define MPI_IOCSTATUS_CONFIG_CANT_COMMIT (0x0025) 605 606/****************************************************************************/ 607/* SCSIIO Reply (SPI & FCP) initiator values */ 608/****************************************************************************/ 609 610#define MPI_IOCSTATUS_SCSI_RECOVERED_ERROR (0x0040) 611#define MPI_IOCSTATUS_SCSI_INVALID_BUS (0x0041) 612#define MPI_IOCSTATUS_SCSI_INVALID_TARGETID (0x0042) 613#define MPI_IOCSTATUS_SCSI_DEVICE_NOT_THERE (0x0043) 614#define MPI_IOCSTATUS_SCSI_DATA_OVERRUN (0x0044) 615#define MPI_IOCSTATUS_SCSI_DATA_UNDERRUN (0x0045) 616#define MPI_IOCSTATUS_SCSI_IO_DATA_ERROR (0x0046) 617#define MPI_IOCSTATUS_SCSI_PROTOCOL_ERROR (0x0047) 618#define MPI_IOCSTATUS_SCSI_TASK_TERMINATED (0x0048) 619#define MPI_IOCSTATUS_SCSI_RESIDUAL_MISMATCH (0x0049) 620#define MPI_IOCSTATUS_SCSI_TASK_MGMT_FAILED (0x004A) 621#define MPI_IOCSTATUS_SCSI_IOC_TERMINATED (0x004B) 622#define MPI_IOCSTATUS_SCSI_EXT_TERMINATED (0x004C) 623 624/****************************************************************************/ 625/* SCSI (SPI & FCP) target values */ 626/****************************************************************************/ 627 628#define MPI_IOCSTATUS_TARGET_PRIORITY_IO (0x0060) 629#define MPI_IOCSTATUS_TARGET_INVALID_PORT (0x0061) 630#define MPI_IOCSTATUS_TARGET_INVALID_IOCINDEX (0x0062) 631#define MPI_IOCSTATUS_TARGET_ABORTED (0x0063) 632#define MPI_IOCSTATUS_TARGET_NO_CONN_RETRYABLE (0x0064) 633#define MPI_IOCSTATUS_TARGET_NO_CONNECTION (0x0065) 634#define MPI_IOCSTATUS_TARGET_XFER_COUNT_MISMATCH (0x006A) 635#define MPI_IOCSTATUS_TARGET_STS_DATA_NOT_SENT (0x006B) 636 637/****************************************************************************/ 638/* Additional FCP target values */ 639/****************************************************************************/ 640 641#define MPI_IOCSTATUS_TARGET_FC_ABORTED (0x0066) /* obsolete */ 642#define MPI_IOCSTATUS_TARGET_FC_RX_ID_INVALID (0x0067) /* obsolete */ 643#define MPI_IOCSTATUS_TARGET_FC_DID_INVALID (0x0068) /* obsolete */ 644#define MPI_IOCSTATUS_TARGET_FC_NODE_LOGGED_OUT (0x0069) /* obsolete */ 645 646/****************************************************************************/ 647/* Fibre Channel Direct Access values */ 648/****************************************************************************/ 649 650#define MPI_IOCSTATUS_FC_ABORTED (0x0066) 651#define MPI_IOCSTATUS_FC_RX_ID_INVALID (0x0067) 652#define MPI_IOCSTATUS_FC_DID_INVALID (0x0068) 653#define MPI_IOCSTATUS_FC_NODE_LOGGED_OUT (0x0069) 654 655/****************************************************************************/ 656/* LAN values */ 657/****************************************************************************/ 658 659#define MPI_IOCSTATUS_LAN_DEVICE_NOT_FOUND (0x0080) 660#define MPI_IOCSTATUS_LAN_DEVICE_FAILURE (0x0081) 661#define MPI_IOCSTATUS_LAN_TRANSMIT_ERROR (0x0082) 662#define MPI_IOCSTATUS_LAN_TRANSMIT_ABORTED (0x0083) 663#define MPI_IOCSTATUS_LAN_RECEIVE_ERROR (0x0084) 664#define MPI_IOCSTATUS_LAN_RECEIVE_ABORTED (0x0085) 665#define MPI_IOCSTATUS_LAN_PARTIAL_PACKET (0x0086) 666#define MPI_IOCSTATUS_LAN_CANCELED (0x0087) 667 668 669/****************************************************************************/ 670/* IOCStatus flag to indicate that log info is available */ 671/****************************************************************************/ 672 673#define MPI_IOCSTATUS_FLAG_LOG_INFO_AVAILABLE (0x8000) 674#define MPI_IOCSTATUS_MASK (0x7FFF) 675 676/****************************************************************************/ 677/* LogInfo Types */ 678/****************************************************************************/ 679 680#define MPI_IOCLOGINFO_TYPE_MASK (0xF0000000) 681#define MPI_IOCLOGINFO_TYPE_NONE (0x0) 682#define MPI_IOCLOGINFO_TYPE_SCSI (0x1) 683#define MPI_IOCLOGINFO_TYPE_FC (0x2) 684#define MPI_IOCLOGINFO_LOG_DATA_MASK (0x0FFFFFFF) 685 686 687#endif 688