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