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