1 /*- 2 **************************************************************** 3 * Copyright (c) 1996-2000 Distributed Processing Technology Corporation 4 * Copyright (c) 2000 Adaptec Corporation. 5 * All rights reserved. 6 * 7 * Copyright 1999 I2O Special Interest Group (I2O SIG). All rights reserved. 8 * All rights reserved 9 * 10 * TERMS AND CONDITIONS OF USE 11 * 12 * Redistribution and use in source form, with or without modification, are 13 * permitted provided that redistributions of source code must retain the 14 * above copyright notice, this list of conditions and the following disclaimer. 15 * 16 * This software is provided `as is' by Distributed Processing Technology and 17 * any express or implied warranties, including, but not limited to, the 18 * implied warranties of merchantability and fitness for a particular purpose, 19 * are disclaimed. In no event shall Distributed Processing Technology be 20 * liable for any direct, indirect, incidental, special, exemplary or 21 * consequential damages (including, but not limited to, procurement of 22 * substitute goods or services; loss of use, data, or profits; or business 23 * interruptions) however caused and on any theory of liability, whether in 24 * contract, strict liability, or tort (including negligence or otherwise) 25 * arising in any way out of the use of this driver software, even if advised 26 * of the possibility of such damage. 27 * 28 * This header file, and any modifications of this header file, are provided 29 * contingent upon your agreement and adherence to the here-listed terms and 30 * conditions. By accepting and/or using this header file, you agree to abide 31 * by these terms and conditions and that these terms and conditions will be 32 * construed and governed in accordance with the laws of the State of California, 33 * without reference to conflict-of-law provisions. If you do not agree 34 * to these terms and conditions, please delete this file, and any copies, 35 * permanently, without making any use thereof. 36 * 37 * THIS HEADER FILE IS PROVIDED FREE OF CHARGE ON AN AS-IS BASIS WITHOUT 38 * WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED 39 * TO IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 40 * PURPOSE. I2O SIG DOES NOT WARRANT THAT THIS HEADER FILE WILL MEET THE 41 * USER'S REQUIREMENTS OR THAT ITS OPERATION WILL BE UNINTERRUPTED OR 42 * ERROR-FREE. 43 * 44 * I2O SIG DISCLAIMS ALL LIABILITY, INCLUDING LIABILITY FOR INFRINGEMENT OF 45 * ANY PROPRIETARY RIGHTS, RELATING TO THE IMPLEMENTATION OF THE I2O 46 * SPECIFICATIONS. I2O SIG DOES NOT WARRANT OR REPRESENT THAT SUCH 47 * IMPLEMENTATIONS WILL NOT INFRINGE SUCH RIGHTS. 48 * 49 * THE USER OF THIS HEADER FILE SHALL HAVE NO RECOURSE TO I2O SIG FOR ANY 50 * ACTUAL OR CONSEQUENTIAL DAMAGES INCLUDING, BUT NOT LIMITED TO, LOST DATA 51 * OR LOST PROFITS ARISING OUT OF THE USE OR INABILITY TO USE THIS PROGRAM. 52 * 53 * I2O SIG grants the user of this header file a license to copy, distribute, 54 * and modify it, for any purpose, under the following terms. Any copying, 55 * distribution, or modification of this header file must not delete or alter 56 * the copyright notice of I2O SIG or any of these Terms and Conditions. 57 * 58 * Any distribution of this header file must not include a charge for the 59 * header file (unless such charges are strictly for the physical acts of 60 * copying or transferring copies). However, distribution of a product in 61 * which this header file is embedded may include a charge so long as any 62 * such charge does not include any charge for the header file itself. 63 * 64 * Any modification of this header file constitutes a derivative work based 65 * on this header file. Any distribution of such derivative work: (1) must 66 * include prominent notices that the header file has been changed from the 67 * original, together with the dates of any changes; (2) automatically includes 68 * this same license to the original header file from I2O SIG, without any 69 * restriction thereon from the distributing user; and (3) must include a 70 * grant of license of the modified file under the same terms and conditions 71 * as these Terms and Conditions. 72 * 73 * The I2O SIG Web site can be found at: http://www.i2osig.org 74 * 75 * The I2O SIG encourages you to deposit derivative works based on this 76 * header file at the I2O SIG Web site. Furthermore, to become a Registered 77 * Developer of the I2O SIG, sign up at the Web site or call 415.750.8352 78 * (United States). 79 * 80 * $FreeBSD: src/sys/dev/asr/i2omsg.h,v 1.8 2011/02/21 09:01:34 brucec Exp $ 81 * 82 ****************************************************************/ 83 84 /********************************************************************* 85 * I2OMsg.h -- I2O Message defintion file 86 * 87 * This file contains information presented in Chapter 3, 4 and 6 of 88 * the I2O(tm) Specification and most of the I2O Global defines and 89 * Typedefs. 90 **********************************************************************/ 91 92 #if !defined(I2O_MESSAGE_HDR) 93 #define I2O_MESSAGE_HDR 94 95 #define I2OMSG_REV 1_5_4 /* I2OMsg header file revision string */ 96 97 /* 98 99 NOTES: 100 101 Gets, reads, receives, etc. are all even numbered functions. 102 Sets, writes, sends, etc. are all odd numbered functions. 103 Functions that both send and receive data can be either but an attempt is 104 made to use the function number that indicates the greater transfer amount. 105 Functions that do not send or receive data use odd function numbers. 106 107 Some functions are synonyms like read, receive and send, write. 108 109 All common functions will have a code of less than 0x80. 110 Unique functions to a class will start at 0x80. 111 Executive Functions start at 0xA0. 112 113 Utility Message function codes range from 0 - 0x1f 114 Base Message function codes range from 0x20 - 0xfe 115 Private Message function code is 0xff. 116 */ 117 118 119 120 #if ((defined(KERNEL) || defined(_KERNEL)) && defined(__FreeBSD__)) 121 # if (KERN_VERSION < 3) 122 # include "i386/pci/i2otypes.h" 123 # else 124 # include "dev/asr/i2otypes.h" 125 # endif 126 #else 127 # include "i2otypes.h" 128 #endif 129 130 131 PRAGMA_ALIGN_PUSH 132 133 PRAGMA_PACK_PUSH 134 135 /* Set to 1 for 64 bit Context Fields */ 136 #define I2O_64BIT_CONTEXT 0 137 138 /****************************************************************************/ 139 140 /* Common functions accross all classes. */ 141 142 #define I2O_PRIVATE_MESSAGE 0xFF 143 144 /****************************************************************************/ 145 /* Class ID and Code Assignments */ 146 147 148 #define I2O_CLASS_VERSION_10 0x00 149 #define I2O_CLASS_VERSION_11 0x01 150 151 /* Class Code Names: Table 6-1 Class Code Assignments. */ 152 #define I2O_CLASS_EXECUTIVE 0x000 153 #define I2O_CLASS_DDM 0x001 154 #define I2O_CLASS_RANDOM_BLOCK_STORAGE 0x010 155 #define I2O_CLASS_SEQUENTIAL_STORAGE 0x011 156 #define I2O_CLASS_LAN 0x020 157 #define I2O_CLASS_WAN 0x030 158 #define I2O_CLASS_FIBRE_CHANNEL_PORT 0x040 159 #define I2O_CLASS_FIBRE_CHANNEL_PERIPHERAL 0x041 160 #define I2O_CLASS_SCSI_PERIPHERAL 0x051 161 #define I2O_CLASS_ATE_PORT 0x060 162 #define I2O_CLASS_ATE_PERIPHERAL 0x061 163 #define I2O_CLASS_FLOPPY_CONTROLLER 0x070 164 #define I2O_CLASS_FLOPPY_DEVICE 0x071 165 #define I2O_CLASS_BUS_ADAPTER_PORT 0x080 166 /* Class Codes 0x090 - 0x09f are reserved for Peer-to-Peer classes */ 167 #define I2O_CLASS_MATCH_ANYCLASS 0xffffffff 168 169 #define I2O_SUBCLASS_i960 0x001 170 #define I2O_SUBCLASS_HDM 0x020 171 #define I2O_SUBCLASS_ISM 0x021 172 173 174 /****************************************************************************/ 175 /* Message Frame defines and structures */ 176 177 /* Defines for the Version_Status field. */ 178 179 #define I2O_VERSION_10 0x00 180 #define I2O_VERSION_11 0x01 181 182 #define I2O_VERSION_OFFSET_NUMBER_MASK 0x07 183 #define I2O_VERSION_OFFSET_SGL_TRL_OFFSET_MASK 0xF0 184 185 /* Defines for the Message Flags Field. */ 186 /* Please Note the FAIL bit is only set in the Transport Fail Message. */ 187 #define I2O_MESSAGE_FLAGS_STATIC 0x01 188 #define I2O_MESSAGE_FLAGS_64BIT_CONTEXT 0x02 189 #define I2O_MESSAGE_FLAGS_MULTIPLE 0x10 190 #define I2O_MESSAGE_FLAGS_FAIL 0x20 191 #define I2O_MESSAGE_FLAGS_LAST 0x40 192 #define I2O_MESSAGE_FLAGS_REPLY 0x80 193 194 /* Defines for Request Status Codes: Table 3-1 Reply Status Codes. */ 195 196 #define I2O_REPLY_STATUS_SUCCESS 0x00 197 #define I2O_REPLY_STATUS_ABORT_DIRTY 0x01 198 #define I2O_REPLY_STATUS_ABORT_NO_DATA_TRANSFER 0x02 199 #define I2O_REPLY_STATUS_ABORT_PARTIAL_TRANSFER 0x03 200 #define I2O_REPLY_STATUS_ERROR_DIRTY 0x04 201 #define I2O_REPLY_STATUS_ERROR_NO_DATA_TRANSFER 0x05 202 #define I2O_REPLY_STATUS_ERROR_PARTIAL_TRANSFER 0x06 203 #define I2O_REPLY_STATUS_PROCESS_ABORT_DIRTY 0x08 204 #define I2O_REPLY_STATUS_PROCESS_ABORT_NO_DATA_TRANSFER 0x09 205 #define I2O_REPLY_STATUS_PROCESS_ABORT_PARTIAL_TRANSFER 0x0A 206 #define I2O_REPLY_STATUS_TRANSACTION_ERROR 0x0B 207 #define I2O_REPLY_STATUS_PROGRESS_REPORT 0x80 208 209 /* DetailedStatusCode defines for ALL messages: Table 3-2 Detailed Status Codes. */ 210 211 #define I2O_DETAIL_STATUS_SUCCESS 0x0000 212 #define I2O_DETAIL_STATUS_BAD_KEY 0x0002 213 #define I2O_DETAIL_STATUS_TCL_ERROR 0x0003 214 #define I2O_DETAIL_STATUS_REPLY_BUFFER_FULL 0x0004 215 #define I2O_DETAIL_STATUS_NO_SUCH_PAGE 0x0005 216 #define I2O_DETAIL_STATUS_INSUFFICIENT_RESOURCE_SOFT 0x0006 217 #define I2O_DETAIL_STATUS_INSUFFICIENT_RESOURCE_HARD 0x0007 218 #define I2O_DETAIL_STATUS_CHAIN_BUFFER_TOO_LARGE 0x0009 219 #define I2O_DETAIL_STATUS_UNSUPPORTED_FUNCTION 0x000A 220 #define I2O_DETAIL_STATUS_DEVICE_LOCKED 0x000B 221 #define I2O_DETAIL_STATUS_DEVICE_RESET 0x000C 222 #define I2O_DETAIL_STATUS_INAPPROPRIATE_FUNCTION 0x000D 223 #define I2O_DETAIL_STATUS_INVALID_INITIATOR_ADDRESS 0x000E 224 #define I2O_DETAIL_STATUS_INVALID_MESSAGE_FLAGS 0x000F 225 #define I2O_DETAIL_STATUS_INVALID_OFFSET 0x0010 226 #define I2O_DETAIL_STATUS_INVALID_PARAMETER 0x0011 227 #define I2O_DETAIL_STATUS_INVALID_REQUEST 0x0012 228 #define I2O_DETAIL_STATUS_INVALID_TARGET_ADDRESS 0x0013 229 #define I2O_DETAIL_STATUS_MESSAGE_TOO_LARGE 0x0014 230 #define I2O_DETAIL_STATUS_MESSAGE_TOO_SMALL 0x0015 231 #define I2O_DETAIL_STATUS_MISSING_PARAMETER 0x0016 232 #define I2O_DETAIL_STATUS_TIMEOUT 0x0017 233 #define I2O_DETAIL_STATUS_UNKNOWN_ERROR 0x0018 234 #define I2O_DETAIL_STATUS_UNKNOWN_FUNCTION 0x0019 235 #define I2O_DETAIL_STATUS_UNSUPPORTED_VERSION 0x001A 236 #define I2O_DEATIL_STATUS_DEVICE_BUSY 0x001B 237 #define I2O_DETAIL_STATUS_DEVICE_NOT_AVAILABLE 0x001C 238 239 /* Common I2O Field sizes */ 240 241 #define I2O_TID_SZ 12 242 #define I2O_FUNCTION_SZ 8 243 #define I2O_UNIT_ID_SZ 16 244 #define I2O_SEGMENT_NUMBER_SZ 12 245 246 #define I2O_IOP_ID_SZ 12 247 #define I2O_GROUP_ID_SZ 16 248 #define I2O_IOP_STATE_SZ 8 249 #define I2O_MESSENGER_TYPE_SZ 8 250 251 #define I2O_CLASS_ID_SZ 12 252 #define I2O_CLASS_ORGANIZATION_ID_SZ 16 253 254 #define I2O_4BIT_VERSION_SZ 4 255 #define I2O_8BIT_FLAGS_SZ 8 256 #define I2O_COMMON_LENGTH_FIELD_SZ 16 257 258 #define I2O_DEVID_DESCRIPTION_SZ 16 259 #define I2O_DEVID_VENDOR_INFO_SZ 16 260 #define I2O_DEVID_PRODUCT_INFO_SZ 16 261 #define I2O_DEVID_REV_LEVEL_SZ 8 262 #define I2O_MODULE_NAME_SZ 24 263 264 #define I2O_BIOS_INFO_SZ 8 265 266 #define I2O_RESERVED_4BITS 4 267 #define I2O_RESERVED_8BITS 8 268 #define I2O_RESERVED_12BITS 12 269 #define I2O_RESERVED_16BITS 16 270 #define I2O_RESERVED_20BITS 20 271 #define I2O_RESERVED_24BITS 24 272 #define I2O_RESERVED_28BITS 28 273 274 275 typedef U32 I2O_PARAMETER_TID; 276 277 278 #if I2O_64BIT_CONTEXT 279 typedef U64 I2O_INITIATOR_CONTEXT; 280 typedef U64 I2O_TRANSACTION_CONTEXT; 281 #else 282 typedef U32 I2O_INITIATOR_CONTEXT; 283 typedef U32 I2O_TRANSACTION_CONTEXT; 284 #endif 285 286 /* Serial Number format defines */ 287 288 #define I2O_SERIAL_FORMAT_UNKNOWN 0 289 #define I2O_SERIAL_FORMAT_BINARY 1 290 #define I2O_SERIAL_FORMAT_ASCII 2 291 #define I2O_SERIAL_FORMAT_UNICODE 3 292 #define I2O_SERIAL_FORMAT_LAN_MAC 4 293 #define I2O_SERIAL_FORMAT_WAN 5 294 295 /* Special TID Assignments */ 296 297 #define I2O_IOP_TID 0 298 #define I2O_HOST_TID 1 299 300 301 /****************************************************************************/ 302 303 /* I2O Message Frame common for all messages */ 304 305 typedef struct _I2O_MESSAGE_FRAME { 306 U8 VersionOffset; 307 U8 MsgFlags; 308 U16 MessageSize; 309 #if (defined(__BORLANDC__)) || defined(_DPT_BIG_ENDIAN) || (defined(sparc)) 310 U32 TargetAddress; 311 #else 312 BF TargetAddress:I2O_TID_SZ; 313 BF InitiatorAddress:I2O_TID_SZ; 314 BF Function:I2O_FUNCTION_SZ; 315 #endif 316 I2O_INITIATOR_CONTEXT InitiatorContext; 317 } I2O_MESSAGE_FRAME, *PI2O_MESSAGE_FRAME; 318 319 320 /****************************************************************************/ 321 322 /* Transaction Reply Lists (TRL) Control Word structure */ 323 324 #define I2O_TRL_FLAGS_SINGLE_FIXED_LENGTH 0x00 325 #define I2O_TRL_FLAGS_SINGLE_VARIABLE_LENGTH 0x40 326 #define I2O_TRL_FLAGS_MULTIPLE_FIXED_LENGTH 0x80 327 328 typedef struct _I2O_TRL_CONTROL_WORD { 329 U8 TrlCount; 330 U8 TrlElementSize; 331 U8 reserved; 332 U8 TrlFlags; 333 #if I2O_64BIT_CONTEXT 334 U32 Padding; /* Padding for 64 bit */ 335 #endif 336 } I2O_TRL_CONTROL_WORD, *PI2O_TRL_CONTROL_WORD; 337 338 /****************************************************************************/ 339 340 /* I2O Successful Single Transaction Reply Message Frame structure. */ 341 342 typedef struct _I2O_SINGLE_REPLY_MESSAGE_FRAME { 343 I2O_MESSAGE_FRAME StdMessageFrame; 344 I2O_TRANSACTION_CONTEXT TransactionContext; 345 U16 DetailedStatusCode; 346 U8 reserved; 347 U8 ReqStatus; 348 /* ReplyPayload */ 349 } I2O_SINGLE_REPLY_MESSAGE_FRAME, *PI2O_SINGLE_REPLY_MESSAGE_FRAME; 350 351 352 /****************************************************************************/ 353 354 /* I2O Successful Multiple Transaction Reply Message Frame structure. */ 355 356 typedef struct _I2O_MULTIPLE_REPLY_MESSAGE_FRAME { 357 I2O_MESSAGE_FRAME StdMessageFrame; 358 I2O_TRL_CONTROL_WORD TrlControlWord; 359 U16 DetailedStatusCode; 360 U8 reserved; 361 U8 ReqStatus; 362 /* TransactionDetails[] */ 363 } I2O_MULTIPLE_REPLY_MESSAGE_FRAME, *PI2O_MULTIPLE_REPLY_MESSAGE_FRAME; 364 365 366 /****************************************************************************/ 367 368 /* I2O Private Message Frame structure. */ 369 370 typedef struct _I2O_PRIVATE_MESSAGE_FRAME { 371 I2O_MESSAGE_FRAME StdMessageFrame; 372 I2O_TRANSACTION_CONTEXT TransactionContext; 373 U16 XFunctionCode; 374 U16 OrganizationID; 375 /* PrivatePayload[] */ 376 } I2O_PRIVATE_MESSAGE_FRAME, *PI2O_PRIVATE_MESSAGE_FRAME; 377 378 379 /****************************************************************************/ 380 381 /* Message Failure Severity Codes */ 382 383 #define I2O_SEVERITY_FORMAT_ERROR 0x1 384 #define I2O_SEVERITY_PATH_ERROR 0x2 385 #define I2O_SEVERITY_PATH_STATE 0x4 386 #define I2O_SEVERITY_CONGESTION 0x8 387 388 /* Transport Failure Codes: Table 3-3 Mesasge Failure Codes */ 389 390 #define I2O_FAILURE_CODE_TRANSPORT_SERVICE_SUSPENDED 0x81 391 #define I2O_FAILURE_CODE_TRANSPORT_SERVICE_TERMINATED 0x82 392 #define I2O_FAILURE_CODE_TRANSPORT_CONGESTION 0x83 393 #define I2O_FAILURE_CODE_TRANSPORT_FAIL 0x84 394 #define I2O_FAILURE_CODE_TRANSPORT_STATE_ERROR 0x85 395 #define I2O_FAILURE_CODE_TRANSPORT_TIME_OUT 0x86 396 #define I2O_FAILURE_CODE_TRANSPORT_ROUTING_FAILURE 0x87 397 #define I2O_FAILURE_CODE_TRANSPORT_INVALID_VERSION 0x88 398 #define I2O_FAILURE_CODE_TRANSPORT_INVALID_OFFSET 0x89 399 #define I2O_FAILURE_CODE_TRANSPORT_INVALID_MSG_FLAGS 0x8A 400 #define I2O_FAILURE_CODE_TRANSPORT_FRAME_TOO_SMALL 0x8B 401 #define I2O_FAILURE_CODE_TRANSPORT_FRAME_TOO_LARGE 0x8C 402 #define I2O_FAILURE_CODE_TRANSPORT_INVALID_TARGET_ID 0x8D 403 #define I2O_FAILURE_CODE_TRANSPORT_INVALID_INITIATOR_ID 0x8E 404 #define I2O_FAILURE_CODE_TRANSPORT_INVALID_INITIATOR_CONTEXT 0x8F 405 #define I2O_FAILURE_CODE_TRANSPORT_UNKNOWN_FAILURE 0xFF 406 407 /* IOP_ID and Severity sizes */ 408 409 #define I2O_FAILCODE_SEVERITY_SZ 8 410 #define I2O_FAILCODE_CODE_SZ 8 411 412 /* I2O Transport Message Reply for Message Failure. */ 413 414 typedef struct _I2O_FAILURE_REPLY_MESSAGE_FRAME { 415 I2O_MESSAGE_FRAME StdMessageFrame; 416 I2O_TRANSACTION_CONTEXT TransactionContext; 417 # if (defined(_DPT_BIG_ENDIAN) || defined(sparc) || defined(__BORLANDC__)) 418 U32 LowestVersion; 419 U32 reserved; 420 # else 421 U8 LowestVersion; 422 U8 HighestVersion; 423 /* BF Severity:I2O_FAILCODE_SEVERITY_SZ; */ 424 /* BF FailureCode:I2O_FAILCODE_CODE_SZ; */ 425 /* Due to our compiler padding this structure and making it larger than 426 * it really is (4 bytes larger), we are re-defining these two fields 427 */ 428 U8 Severity; 429 U8 FailureCode; 430 BF reserved:I2O_RESERVED_4BITS; 431 BF FailingHostUnitID:I2O_UNIT_ID_SZ; 432 BF reserved1:12; 433 # endif 434 U32 AgeLimit; 435 U32 PreservedMFA; 436 } I2O_FAILURE_REPLY_MESSAGE_FRAME, *PI2O_FAILURE_REPLY_MESSAGE_FRAME; 437 438 /* I2O Transport Message Reply for Transaction Error. */ 439 440 typedef struct _I2O_TRANSACTION_ERROR_REPLY_MESSAGE_FRAME { 441 I2O_MESSAGE_FRAME StdMessageFrame; 442 I2O_TRANSACTION_CONTEXT TransactionContext; 443 U16 DetailedStatusCode; 444 U8 reserved; 445 U8 ReqStatus; /* Should always be Transaction Error */ 446 U32 ErrorOffset; 447 U8 BitOffset; 448 U8 reserved1; 449 U16 reserved2; 450 } I2O_TRANSACTION_ERROR_REPLY_MESSAGE_FRAME, *PI2O_TRANSACTION_ERROR_REPLY_MESSAGE_FRAME; 451 452 /****************************************************************************/ 453 454 /* Misc. commonly used structures */ 455 456 /* Class ID Block */ 457 458 typedef struct _I2O_CLASS_ID { 459 #if (defined(_DPT_BIG_ENDIAN) || defined(sparc)) 460 U32 Class; 461 #else 462 BF Class:I2O_CLASS_ID_SZ; 463 BF Version:I2O_4BIT_VERSION_SZ; 464 BF OrganizationID:I2O_CLASS_ORGANIZATION_ID_SZ; 465 #endif 466 } I2O_CLASS_ID, *PI2O_CLASS_ID; 467 468 469 #define I2O_MAX_SERIAL_NUMBER_SZ 256 470 471 typedef struct _I2O_SERIAL_INFO { 472 U8 SerialNumberLength; 473 U8 SerialNumberFormat; 474 U8 SerialNumber[I2O_MAX_SERIAL_NUMBER_SZ]; 475 } I2O_SERIAL_INFO, *PI2O_SERIAL_INFO; 476 477 478 /****************************************************************************/ 479 /* Hardware Resource Table (HRT) and Logical Configuration Table (LCT) */ 480 /****************************************************************************/ 481 482 /* Bus Type Code defines */ 483 484 #define I2O_LOCAL_BUS 0 485 #define I2O_ISA_BUS 1 486 #define I2O_EISA_BUS 2 487 #define I2O_MCA_BUS 3 488 #define I2O_PCI_BUS 4 489 #define I2O_PCMCIA_BUS 5 490 #define I2O_NUBUS_BUS 6 491 #define I2O_CARDBUS_BUS 7 492 #define I2O_OTHER_BUS 0x80 493 494 #define I2O_HRT_STATE_SZ 4 495 #define I2O_HRT_BUS_NUMBER_SZ 8 496 #define I2O_HRT_BUS_TYPE_SZ 8 497 498 499 /* Bus Structures */ 500 501 /* PCI Bus */ 502 typedef struct _I2O_PCI_BUS_INFO { 503 U8 PciFunctionNumber; 504 U8 PciDeviceNumber; 505 U8 PciBusNumber; 506 U8 reserved; 507 U16 PciVendorID; 508 U16 PciDeviceID; 509 } I2O_PCI_BUS_INFO, *PI2O_PCI_BUS_INFO; 510 511 /* Local Bus */ 512 typedef struct _I2O_LOCAL_BUS_INFO { 513 U16 LbBaseIOPort; 514 U16 reserved; 515 U32 LbBaseMemoryAddress; 516 } I2O_LOCAL_BUS_INFO, *PI2O_LOCAL_BUS_INFO; 517 518 /* ISA Bus */ 519 typedef struct _I2O_ISA_BUS_INFO { 520 U16 IsaBaseIOPort; 521 U8 CSN; 522 U8 reserved; 523 U32 IsaBaseMemoryAddress; 524 } I2O_ISA_BUS_INFO, *PI2O_ISA_BUS_INFO; 525 526 /* EISA Bus */ 527 typedef struct _I2O_EISA_BUS_INFO { 528 U16 EisaBaseIOPort; 529 U8 reserved; 530 U8 EisaSlotNumber; 531 U32 EisaBaseMemoryAddress; 532 } I2O_EISA_BUS_INFO, *PI2O_EISA_BUS_INFO; 533 534 /* MCA Bus */ 535 typedef struct _I2O_MCA_BUS_INFO { 536 U16 McaBaseIOPort; 537 U8 reserved; 538 U8 McaSlotNumber; 539 U32 McaBaseMemoryAddress; 540 } I2O_MCA_BUS_INFO, *PI2O_MCA_BUS_INFO; 541 542 /* Other Bus */ 543 typedef struct _I2O_OTHER_BUS_INFO { 544 U16 BaseIOPort; 545 U16 reserved; 546 U32 BaseMemoryAddress; 547 } I2O_OTHER_BUS_INFO, *PI2O_OTHER_BUS_INFO; 548 549 550 /* HRT Entry Block */ 551 552 typedef struct _I2O_HRT_ENTRY { 553 U32 AdapterID; 554 #if (defined(_DPT_BIG_ENDIAN) || defined(sparc)) 555 U32 ControllingTID; 556 #else 557 BF ControllingTID:I2O_TID_SZ; 558 BF AdapterState:I2O_HRT_STATE_SZ; 559 BF BusNumber:I2O_HRT_BUS_NUMBER_SZ; 560 BF BusType:I2O_HRT_BUS_TYPE_SZ; 561 #endif 562 union { 563 /* PCI Bus */ 564 I2O_PCI_BUS_INFO PCIBus; 565 566 /* Local Bus */ 567 I2O_LOCAL_BUS_INFO LocalBus; 568 569 /* ISA Bus */ 570 I2O_ISA_BUS_INFO ISABus; 571 572 /* EISA Bus */ 573 I2O_EISA_BUS_INFO EISABus; 574 575 /* MCA Bus */ 576 I2O_MCA_BUS_INFO MCABus; 577 578 /* Other. */ 579 I2O_OTHER_BUS_INFO OtherBus; 580 }uBus; 581 } I2O_HRT_ENTRY, *PI2O_HRT_ENTRY; 582 583 584 /* I2O Hardware Resource Table structure. */ 585 586 typedef struct _I2O_HRT { 587 U16 NumberEntries; 588 U8 EntryLength; 589 U8 HRTVersion; 590 U32 CurrentChangeIndicator; 591 I2O_HRT_ENTRY HRTEntry[1]; 592 } I2O_HRT, *PI2O_HRT; 593 594 595 /****************************************************************************/ 596 /* Logical Configuration Table */ 597 /****************************************************************************/ 598 599 /* I2O Logical Configuration Table structures. */ 600 601 #define I2O_IDENTITY_TAG_SZ 8 602 603 /* I2O Logical Configuration Table Device Flags */ 604 605 #define I2O_LCT_DEVICE_FLAGS_CONF_DIALOG_REQUEST 0x01 606 #define I2O_LCT_DEVICE_FLAGS_MORE_THAN_1_USER 0x02 607 #define I2O_LCT_DEVICE_FLAGS_PEER_SERVICE_DISABLED 0x10 608 #define I2O_LCT_DEVICE_FLAGS_MANAGEMENT_SERVICE_DISABLED 0x20 609 610 /* LCT Entry Block */ 611 612 typedef struct _I2O_LCT_ENTRY { 613 #if (defined(_DPT_BIG_ENDIAN) || defined(sparc)) 614 U32 TableEntrySize; 615 #else 616 BF TableEntrySize:I2O_COMMON_LENGTH_FIELD_SZ; 617 BF LocalTID:I2O_TID_SZ; 618 BF reserved:I2O_4BIT_VERSION_SZ; 619 #endif 620 U32 ChangeIndicator; 621 U32 DeviceFlags; 622 I2O_CLASS_ID ClassID; 623 U32 SubClassInfo; 624 #if (defined(__BORLANDC__)) || defined(_DPT_BIG_ENDIAN) || (defined(sparc)) 625 U32 UserTID; 626 #else 627 BF UserTID:I2O_TID_SZ; 628 BF ParentTID:I2O_TID_SZ; 629 BF BiosInfo:I2O_BIOS_INFO_SZ; 630 #endif 631 U8 IdentityTag[I2O_IDENTITY_TAG_SZ]; 632 U32 EventCapabilities; 633 } I2O_LCT_ENTRY, *PI2O_LCT_ENTRY; 634 635 636 /* I2O Logical Configuration Table structure. */ 637 638 typedef struct _I2O_LCT { 639 #if (defined(_DPT_BIG_ENDIAN) || defined(sparc)) 640 U32 TableSize; 641 #else 642 BF TableSize:I2O_COMMON_LENGTH_FIELD_SZ; 643 BF BootDeviceTID:I2O_TID_SZ; 644 BF LctVer:I2O_4BIT_VERSION_SZ; 645 #endif 646 U32 IopFlags; 647 U32 CurrentChangeIndicator; 648 I2O_LCT_ENTRY LCTEntry[1]; 649 } I2O_LCT, *PI2O_LCT; 650 651 652 /****************************************************************************/ 653 654 /* Memory Addressing structures and defines. */ 655 656 /* SglFlags defines. */ 657 658 #define I2O_SGL_FLAGS_LAST_ELEMENT 0x80 659 #define I2O_SGL_FLAGS_END_OF_BUFFER 0x40 660 661 #define I2O_SGL_FLAGS_IGNORE_ELEMENT 0x00 662 #define I2O_SGL_FLAGS_TRANSPORT_ELEMENT 0x04 663 #define I2O_SGL_FLAGS_BIT_BUCKET_ELEMENT 0x08 664 #define I2O_SGL_FLAGS_IMMEDIATE_DATA_ELEMENT 0x0C 665 #define I2O_SGL_FLAGS_SIMPLE_ADDRESS_ELEMENT 0x10 666 #define I2O_SGL_FLAGS_PAGE_LIST_ADDRESS_ELEMENT 0x20 667 #define I2O_SGL_FLAGS_CHAIN_POINTER_ELEMENT 0x30 668 #define I2O_SGL_FLAGS_LONG_TRANSACTION_ELEMENT 0x40 669 #define I2O_SGL_FLAGS_SHORT_TRANSACTION_ELEMENT 0x70 670 #define I2O_SGL_FLAGS_SGL_ATTRIBUTES_ELEMENT 0x7C 671 672 #define I2O_SGL_FLAGS_BC0 0x01 673 #define I2O_SGL_FLAGS_BC1 0x02 674 #define I2O_SGL_FLAGS_DIR 0x04 675 #define I2O_SGL_FLAGS_LOCAL_ADDRESS 0x08 676 677 #define I2O_SGL_FLAGS_CONTEXT_COUNT_MASK 0x03 678 #define I2O_SGL_FLAGS_ADDRESS_MODE_MASK 0x3C 679 #define I2O_SGL_FLAGS_NO_CONTEXT 0x00 680 681 /* Scatter/Gather Truth Table */ 682 683 /* 684 685 typedef enum _SG_TYPE { 686 INVALID, 687 Ignore, 688 TransportDetails, 689 BitBucket, 690 ImmediateData, 691 Simple, 692 PageList, 693 ChainPointer, 694 ShortTransaction, 695 LongTransaction, 696 SGLAttributes, 697 INVALID/ReservedLongFormat, 698 INVALID/ReservedShortFormat 699 } SG_TYPE, *PSG_TYPE; 700 701 702 0x00 Ignore; 703 0x04 TransportDetails; 704 0x08 BitBucket; 705 0x0C ImmediateData; 706 0x10 Simple; 707 0x14 Simple; 708 0x18 Simple; 709 0x1C Simple; 710 0x20 PageList; 711 0x24 PageList; 712 0x28 PageList; 713 0x2C PageList; 714 0x30 ChainPointer; 715 0x34 INVALID; 716 0x38 ChainPointer; 717 0x3C INVALID; 718 0x40 LongTransaction; 719 0x44 INVALID/ReservedLongFormat; 720 0x48 BitBucket; 721 0x4C ImmediateData; 722 0x50 Simple; 723 0x54 Simple; 724 0x58 Simple; 725 0x5C Simple; 726 0x60 PageList; 727 0x64 PageList; 728 0x68 PageList; 729 0x6C PageList; 730 0x70 ShortTransaction; 731 0x74 INVALID/ReservedShortFormat; 732 0x78 INVALID/ReservedShortFormat; 733 0x7C SGLAttributes; 734 */ 735 736 737 /* 32 Bit Context Field defines */ 738 739 #define I2O_SGL_FLAGS_CONTEXT32_NULL 0x00 740 #define I2O_SGL_FLAGS_CONTEXT32_U32 0x01 741 #define I2O_SGL_FLAGS_CONTEXT32_U64 0x02 742 #define I2O_SGL_FLAGS_CONTEXT32_U96 0x03 743 744 #define I2O_SGL_FLAGS_CONTEXT32_NULL_SZ 0x00 745 #define I2O_SGL_FLAGS_CONTEXT32_U32_SZ 0x04 746 #define I2O_SGL_FLAGS_CONTEXT32_U64_SZ 0x08 747 #define I2O_SGL_FLAGS_CONTEXT32_U96_SZ 0x0C 748 749 /* 64 Bit Context Field defines */ 750 751 #define I2O_SGL_FLAGS_CONTEXT64_NULL 0x00 752 #define I2O_SGL_FLAGS_CONTEXT64_U64 0x01 753 #define I2O_SGL_FLAGS_CONTEXT64_U128 0x02 754 #define I2O_SGL_FLAGS_CONTEXT64_U192 0x03 755 756 #define I2O_SGL_FLAGS_CONTEXT64_NULL_SZ 0x00 757 #define I2O_SGL_FLAGS_CONTEXT64_U64_SZ 0x08 758 #define I2O_SGL_FLAGS_CONTEXT64_U128_SZ 0x10 759 #define I2O_SGL_FLAGS_CONTEXT64_U192_SZ 0x18 760 761 /* SGL Attribute Element defines */ 762 763 #define I2O_SGL_ATTRIBUTE_FLAGS_BIT_BUCKET_HINT 0x0400 764 #define I2O_SGL_ATTRIBUTE_FLAGS_IMMEDIATE_DATA_HINT 0x0200 765 #define I2O_SGL_ATTRIBUTE_FLAGS_LOCAL_ADDRESS_HINT 0x0100 766 #define I2O_SGL_ATTRIBUTE_FLAGS_32BIT_TRANSACTION 0x0000 767 #define I2O_SGL_ATTRIBUTE_FLAGS_64BIT_TRANSACTION 0x0004 768 #define I2O_SGL_ATTRIBUTE_FLAGS_32BIT_LOCAL_ADDRESS 0x0000 769 770 /* SG Size defines */ 771 772 #define I2O_SG_COUNT_SZ 24 773 #define I2O_SG_FLAGS_SZ 8 774 775 /* Standard Flags and Count fields for SG Elements */ 776 777 typedef struct _I2O_FLAGS_COUNT { 778 #if (defined(__BORLANDC__)) || defined(_DPT_BIG_ENDIAN) || (defined(sparc)) 779 U32 Count; 780 #else 781 BF Count:I2O_SG_COUNT_SZ; 782 BF Flags:I2O_SG_FLAGS_SZ; 783 #endif 784 } I2O_FLAGS_COUNT, *PI2O_FLAGS_COUNT; 785 786 /* Bit Bucket Element */ 787 788 typedef struct _I2O_SGE_BIT_BUCKET_ELEMENT { 789 I2O_FLAGS_COUNT FlagsCount; 790 U32 BufferContext; 791 } I2O_SGE_BIT_BUCKET_ELEMENT, *PI2O_SGE_BIT_BUCKET_ELEMENT; 792 793 /* Chain Addressing Scatter-Gather Element */ 794 795 typedef struct _I2O_SGE_CHAIN_ELEMENT { 796 I2O_FLAGS_COUNT FlagsCount; 797 U32 PhysicalAddress; 798 } I2O_SGE_CHAIN_ELEMENT, *PI2O_SGE_CHAIN_ELEMENT; 799 800 /* Chain Addressing with Context Scatter-Gather Element */ 801 802 typedef struct _I2O_SGE_CHAIN_CONTEXT_ELEMENT { 803 I2O_FLAGS_COUNT FlagsCount; 804 U32 Context[1]; 805 U32 PhysicalAddress; 806 } I2O_SGE_CHAIN_CONTEXT_ELEMENT, *PI2O_SGE_CHAIN_CONTEXT_ELEMENT; 807 808 /* Ignore Scatter-Gather Element */ 809 810 typedef struct _I2O_SGE_IGNORE_ELEMENT { 811 I2O_FLAGS_COUNT FlagsCount; 812 } I2O_SGE_IGNORE_ELEMENT, *PI2O_SGE_IGNORE_ELEMENT; 813 814 /* Immediate Data Element */ 815 816 typedef struct _I2O_SGE_IMMEDIATE_DATA_ELEMENT { 817 I2O_FLAGS_COUNT FlagsCount; 818 } I2O_SGE_IMMEDIATE_DATA_ELEMENT, *PI2O_SGE_IMMEDIATE_DATA_ELEMENT; 819 820 /* Immediate Data with Context Element */ 821 822 typedef struct _I2O_SGE_IMMEDIATE_DATA_CONTEXT_ELEMENT { 823 I2O_FLAGS_COUNT FlagsCount; 824 U32 BufferContext; 825 } I2O_SGE_IMMEDIATE_DATA_CONTEXT_ELEMENT, *PI2O_SGE_IMMEDIATE_DATA_CONTEXT_ELEMENT; 826 827 /* Long Transaction Parameters Element */ 828 829 typedef struct _I2O_SGE_LONG_TRANSACTION_ELEMENT { 830 #if (defined(__BORLANDC__)) 831 U32 LongElementLength; 832 #else 833 BF LongElementLength:I2O_SG_COUNT_SZ; 834 BF Flags:I2O_SG_FLAGS_SZ; 835 #endif 836 U32 BufferContext; 837 } I2O_SGE_LONG_TRANSACTION_ELEMENT, *PI2O_SGE_LONG_TRANSACTION_ELEMENT; 838 839 /* Page List Scatter-Gather Element */ 840 841 typedef struct _I2O_SGE_PAGE_ELEMENT { 842 I2O_FLAGS_COUNT FlagsCount; 843 U32 PhysicalAddress[1]; 844 } I2O_SGE_PAGE_ELEMENT , *PI2O_SGE_PAGE_ELEMENT ; 845 846 /* Page List with Context Scatter-Gather Element */ 847 848 typedef struct _I2O_SGE_PAGE_CONTEXT_ELEMENT { 849 I2O_FLAGS_COUNT FlagsCount; 850 U32 BufferContext[1]; 851 U32 PhysicalAddress[1]; 852 } I2O_SGE_PAGE_CONTEXT_ELEMENT, *PI2O_SGE_PAGE_CONTEXT_ELEMENT; 853 854 /* SGL Attribute Element */ 855 856 typedef struct _I2O_SGE_SGL_ATTRIBUTES_ELEMENT { 857 U16 SglAttributeFlags; 858 U8 ElementLength; 859 U8 Flags; 860 U32 PageFrameSize; 861 } I2O_SGE_SGL_ATTRIBUTES_ELEMENT, *PI2O_SGE_SGL_ATTRIBUTES_ELEMENT; 862 863 /* Short Transaction Parameters Element */ 864 865 typedef struct _I2O_SGE_SHORT_TRANSACTION_ELEMENT { 866 U16 ClassFields; 867 U8 ElementLength; 868 U8 Flags; 869 U32 BufferContext; 870 } I2O_SGE_SHORT_TRANSACTION_ELEMENT, *PI2O_SGE_SHORT_TRANSACTION_ELEMENT; 871 872 /* Simple Addressing Scatter-Gather Element */ 873 874 typedef struct _I2O_SGE_SIMPLE_ELEMENT { 875 I2O_FLAGS_COUNT FlagsCount; 876 U32 PhysicalAddress; 877 } I2O_SGE_SIMPLE_ELEMENT, *PI2O_SGE_SIMPLE_ELEMENT; 878 879 /* Simple Addressing with Context Scatter-Gather Element */ 880 881 typedef struct _I2O_SGE_SIMPLE_CONTEXT_ELEMENT { 882 I2O_FLAGS_COUNT FlagsCount; 883 U32 BufferContext[1]; 884 U32 PhysicalAddress; 885 } I2O_SGE_SIMPLE_CONTEXT_ELEMENT, *PI2O_SGE_SIMPLE_CONTEXT_ELEMENT; 886 887 /* Transport Detail Element */ 888 889 typedef struct _I2O_SGE_TRANSPORT_ELEMENT { 890 #if (defined(__BORLANDC__)) 891 U32 LongElementLength; 892 #else 893 BF LongElementLength:I2O_SG_COUNT_SZ; 894 BF Flags:I2O_SG_FLAGS_SZ; 895 #endif 896 } I2O_SGE_TRANSPORT_ELEMENT, *PI2O_SGE_TRANSPORT_ELEMENT; 897 898 typedef struct _I2O_SG_ELEMENT { 899 union { 900 /* Bit Bucket Element */ 901 I2O_SGE_BIT_BUCKET_ELEMENT BitBucket; 902 903 /* Chain Addressing Element */ 904 I2O_SGE_CHAIN_ELEMENT Chain; 905 906 /* Chain Addressing with Context Element */ 907 I2O_SGE_CHAIN_CONTEXT_ELEMENT ChainContext; 908 909 /* Ignore Scatter-Gather Element */ 910 I2O_SGE_IGNORE_ELEMENT Ignore; 911 912 /* Immediate Data Element */ 913 I2O_SGE_IMMEDIATE_DATA_ELEMENT ImmediateData; 914 915 /* Immediate Data with Context Element */ 916 I2O_SGE_IMMEDIATE_DATA_CONTEXT_ELEMENT ImmediateDataContext; 917 918 /* Long Transaction Parameters Element */ 919 I2O_SGE_LONG_TRANSACTION_ELEMENT LongTransaction; 920 921 /* Page List Element */ 922 I2O_SGE_PAGE_ELEMENT Page; 923 924 /* Page List with Context Element */ 925 I2O_SGE_PAGE_CONTEXT_ELEMENT PageContext; 926 927 /* SGL Attribute Element */ 928 I2O_SGE_SGL_ATTRIBUTES_ELEMENT SGLAttribute; 929 930 /* Short Transaction Parameters Element */ 931 I2O_SGE_SHORT_TRANSACTION_ELEMENT ShortTransaction; 932 933 /* Simple Addressing Element */ 934 /* (variable, as with others, use '2' to avoid gcc warning) */ 935 I2O_SGE_SIMPLE_ELEMENT Simple[2]; 936 937 /* Simple Addressing with Context Element */ 938 I2O_SGE_SIMPLE_CONTEXT_ELEMENT SimpleContext[1]; 939 940 /* Transport Detail Element */ 941 I2O_SGE_TRANSPORT_ELEMENT Transport; 942 #if (defined(sun) && defined(u)) 943 /* there is a macro defined in Solaris sys/user.h for u, rename this to uSG */ 944 } uSG ; 945 #else 946 } u ; 947 #endif 948 } I2O_SG_ELEMENT, *PI2O_SG_ELEMENT; 949 950 /****************************************************************************/ 951 /* Basic Parameter Group Access */ 952 /****************************************************************************/ 953 954 /* Operation Function Numbers */ 955 956 #define I2O_PARAMS_OPERATION_FIELD_GET 0x0001 957 #define I2O_PARAMS_OPERATION_LIST_GET 0x0002 958 #define I2O_PARAMS_OPERATION_MORE_GET 0x0003 959 #define I2O_PARAMS_OPERATION_SIZE_GET 0x0004 960 #define I2O_PARAMS_OPERATION_TABLE_GET 0x0005 961 #define I2O_PARAMS_OPERATION_FIELD_SET 0x0006 962 #define I2O_PARAMS_OPERATION_LIST_SET 0x0007 963 #define I2O_PARAMS_OPERATION_ROW_ADD 0x0008 964 #define I2O_PARAMS_OPERATION_ROW_DELETE 0x0009 965 #define I2O_PARAMS_OPERATION_TABLE_CLEAR 0x000A 966 967 /* Operations List Header */ 968 969 typedef struct _I2O_PARAM_OPERATIONS_LIST_HEADER { 970 U16 OperationCount; 971 U16 Reserved; 972 } I2O_PARAM_OPERATIONS_LIST_HEADER, *PI2O_PARAM_OPERATIONS_LIST_HEADER; 973 974 /* Results List Header */ 975 976 typedef struct _I2O_PARAM_RESULTS_LIST_HEADER { 977 U16 ResultCount; 978 U16 Reserved; 979 } I2O_PARAM_RESULTS_LIST_HEADER, *PI2O_PARAM_RESULTS_LIST_HEADER; 980 981 /* Read Operation Result Block Template Structure */ 982 983 typedef struct _I2O_PARAM_READ_OPERATION_RESULT { 984 U16 BlockSize; 985 U8 BlockStatus; 986 U8 ErrorInfoSize; 987 /* Operations Results */ 988 /* Pad (if any) */ 989 /* ErrorInformation (if any) */ 990 } I2O_PARAM_READ_OPERATION_RESULT, *PI2O_PARAM_READ_OPERATION_RESULT; 991 992 typedef struct _I2O_TABLE_READ_OPERATION_RESULT { 993 U16 BlockSize; 994 U8 BlockStatus; 995 U8 ErrorInfoSize; 996 U16 RowCount; 997 U16 MoreFlag; 998 /* Operations Results */ 999 /* Pad (if any) */ 1000 /* ErrorInformation (if any) */ 1001 } I2O_TABLE_READ_OPERATION_RESULT, *PI2O_TABLE_READ_OPERATION_RESULT; 1002 1003 /* Error Information Template Structure */ 1004 1005 typedef struct _I2O_PARAM_ERROR_INFO_TEMPLATE { 1006 U16 OperationCode; 1007 U16 GroupNumber; 1008 U16 FieldIdx; 1009 U8 AdditionalStatus; 1010 U8 NumberKeys; 1011 /* List of Key Values (variable) */ 1012 /* Pad (if any) */ 1013 } I2O_PARAM_ERROR_INFO_TEMPLATE, *PI2O_PARAM_ERROR_INFO_TEMPLATE; 1014 1015 /* Operation Template for Specific Fields */ 1016 1017 typedef struct _I2O_PARAM_OPERATION_SPECIFIC_TEMPLATE { 1018 U16 Operation; 1019 U16 GroupNumber; 1020 U16 FieldCount; 1021 U16 FieldIdx[1]; 1022 /* Pad (if any) */ 1023 } I2O_PARAM_OPERATION_SPECIFIC_TEMPLATE, *PI2O_PARAM_OPERATION_SPECIFIC_TEMPLATE; 1024 1025 /* Operation Template for All Fields */ 1026 1027 typedef struct _I2O_PARAM_OPERATION_ALL_TEMPLATE { 1028 U16 Operation; 1029 U16 GroupNumber; 1030 U16 FieldCount; 1031 /* Pad (if any) */ 1032 } I2O_PARAM_OPERATION_ALL_TEMPLATE, *PI2O_PARAM_OPERATION_ALL_TEMPLATE; 1033 1034 /* Operation Template for All List Fields */ 1035 1036 typedef struct _I2O_PARAM_OPERATION_ALL_LIST_TEMPLATE { 1037 U16 Operation; 1038 U16 GroupNumber; 1039 U16 FieldCount; 1040 U16 KeyCount; 1041 U8 KeyValue; 1042 /* Pad (if any) */ 1043 } I2O_PARAM_OPERATION_ALL_LIST_TEMPLATE, *PI2O_PARAM_OPERATION_ALL_LIST_TEMPLATE; 1044 1045 /* Modify Operation Result Block Template Structure */ 1046 1047 typedef struct _I2O_PARAM_MODIFY_OPERATION_RESULT { 1048 U16 BlockSize; 1049 U8 BlockStatus; 1050 U8 ErrorInfoSize; 1051 /* ErrorInformation (if any) */ 1052 } I2O_PARAM_MODIFY_OPERATION_RESULT, *PI2O_PARAM_MODIFY_OPERATION_RESULT; 1053 1054 /* Operation Template for Row Delete */ 1055 1056 typedef struct _I2O_PARAM_OPERATION_ROW_DELETE_TEMPLATE { 1057 U16 Operation; 1058 U16 GroupNumber; 1059 U16 RowCount; 1060 U8 KeyValue; 1061 } I2O_PARAM_OPERATION_ROW_DELETE_TEMPLATE, *PI2O_PARAM_OPERATION_ROW_DELETE_TEMPLATE; 1062 1063 /* Operation Template for Table Clear */ 1064 1065 typedef struct _I2O_PARAM_OPERATION_TABLE_CLEAR_TEMPLATE { 1066 U16 Operation; 1067 U16 GroupNumber; 1068 } I2O_PARAM_OPERATION_TABLE_CLEAR_TEMPLATE, *PI2O_PARAM_OPERATION_TABLE_CLEAR_TEMPLATE; 1069 1070 /* Status codes and Error Information for Parameter functions */ 1071 1072 #define I2O_PARAMS_STATUS_SUCCESS 0x00 1073 #define I2O_PARAMS_STATUS_BAD_KEY_ABORT 0x01 1074 #define I2O_PARAMS_STATUS_BAD_KEY_CONTINUE 0x02 1075 #define I2O_PARAMS_STATUS_BUFFER_FULL 0x03 1076 #define I2O_PARAMS_STATUS_BUFFER_TOO_SMALL 0x04 1077 #define I2O_PARAMS_STATUS_FIELD_UNREADABLE 0x05 1078 #define I2O_PARAMS_STATUS_FIELD_UNWRITEABLE 0x06 1079 #define I2O_PARAMS_STATUS_INSUFFICIENT_FIELDS 0x07 1080 #define I2O_PARAMS_STATUS_INVALID_GROUP_ID 0x08 1081 #define I2O_PARAMS_STATUS_INVALID_OPERATION 0x09 1082 #define I2O_PARAMS_STATUS_NO_KEY_FIELD 0x0A 1083 #define I2O_PARAMS_STATUS_NO_SUCH_FIELD 0x0B 1084 #define I2O_PARAMS_STATUS_NON_DYNAMIC_GROUP 0x0C 1085 #define I2O_PARAMS_STATUS_OPERATION_ERROR 0x0D 1086 #define I2O_PARAMS_STATUS_SCALAR_ERROR 0x0E 1087 #define I2O_PARAMS_STATUS_TABLE_ERROR 0x0F 1088 #define I2O_PARAMS_STATUS_WRONG_GROUP_TYPE 0x10 1089 1090 1091 /****************************************************************************/ 1092 /* GROUP Parameter Groups */ 1093 /****************************************************************************/ 1094 1095 /* GROUP Configuration and Operating Structures and Defines */ 1096 1097 /* Groups Numbers */ 1098 1099 #define I2O_UTIL_PARAMS_DESCRIPTOR_GROUP_NO 0xF000 1100 #define I2O_UTIL_PHYSICAL_DEVICE_TABLE_GROUP_NO 0xF001 1101 #define I2O_UTIL_CLAIMED_TABLE_GROUP_NO 0xF002 1102 #define I2O_UTIL_USER_TABLE_GROUP_NO 0xF003 1103 #define I2O_UTIL_PRIVATE_MESSAGE_EXTENSIONS_GROUP_NO 0xF005 1104 #define I2O_UTIL_AUTHORIZED_USER_TABLE_GROUP_NO 0xF006 1105 #define I2O_UTIL_DEVICE_IDENTITY_GROUP_NO 0xF100 1106 #define I2O_UTIL_DDM_IDENTITY_GROUP_NO 0xF101 1107 #define I2O_UTIL_USER_INFORMATION_GROUP_NO 0xF102 1108 #define I2O_UTIL_SGL_OPERATING_LIMITS_GROUP_NO 0xF103 1109 #define I2O_UTIL_SENSORS_GROUP_NO 0xF200 1110 1111 /* UTIL Group F000h - GROUP DESCRIPTORS Parameter Group */ 1112 1113 #define I2O_UTIL_GROUP_PROPERTIES_GROUP_TABLE 0x01 1114 #define I2O_UTIL_GROUP_PROPERTIES_ROW_ADDITION 0x02 1115 #define I2O_UTIL_GROUP_PROPERTIES_ROW_DELETION 0x04 1116 #define I2O_UTIL_GROUP_PROPERTIES_CLEAR_OPERATION 0x08 1117 1118 typedef struct _I2O_UTIL_GROUP_DESCRIPTOR_TABLE { 1119 U16 GroupNumber; 1120 U16 FieldCount; 1121 U16 RowCount; 1122 U8 Properties; 1123 U8 reserved; 1124 } I2O_UTIL_GROUP_DESCRIPTOR_TABLE, *PI2O_UTIL_GROUP_DESCRIPTOR_TABLE; 1125 1126 /* UTIL Group F001h - Physical Device Table Parameter Group */ 1127 1128 typedef struct _I2O_UTIL_PHYSICAL_DEVICE_TABLE { 1129 U32 AdapterID; 1130 } I2O_UTIL_PHYSICAL_DEVICE_TABLE, *PI2O_UTIL_PHYSICAL_DEVICE_TABLE; 1131 1132 /* UTIL Group F002h - Claimed Table Parameter Group */ 1133 1134 typedef struct _I2O_UTIL_CLAIMED_TABLE { 1135 U16 ClaimedTID; 1136 } I2O_UTIL_CLAIMED_TABLE, *PI2O_UTIL_CLAIMED_TABLE; 1137 1138 /* UTIL Group F003h - User Table Parameter Group */ 1139 1140 typedef struct _I2O_UTIL_USER_TABLE { 1141 U16 Instance; 1142 U16 UserTID; 1143 U8 ClaimType; 1144 U8 reserved1; 1145 U16 reserved2; 1146 } I2O_UTIL_USER_TABLE, *PI2O_UTIL_USER_TABLE; 1147 1148 /* UTIL Group F005h - Private Message Extensions Parameter Group */ 1149 1150 typedef struct _I2O_UTIL_PRIVATE_MESSAGE_EXTENSIONS_TABLE { 1151 U16 ExtInstance; 1152 U16 OrganizationID; 1153 U16 XFunctionCode; 1154 } I2O_UTIL_PRIVATE_MESSAGE_EXTENSIONS_TABLE, *PI2O_UTIL_PRIVATE_MESSAGE_EXTENSIONS_TABLE; 1155 1156 /* UTIL Group F006h - Authorized User Table Parameter Group */ 1157 1158 typedef struct _I2O_UTIL_AUTHORIZED_USER_TABLE { 1159 U16 AlternateTID; 1160 } I2O_UTIL_AUTHORIZED_USER_TABLE, *PI2O_UTIL_AUTHORIZED_USER_TABLE; 1161 1162 /* UTIL Group F100h - Device Identity Parameter Group */ 1163 1164 typedef struct _I2O_UTIL_DEVICE_IDENTITY_SCALAR { 1165 U32 ClassID; 1166 U16 OwnerTID; 1167 U16 ParentTID; 1168 U8 VendorInfo[I2O_DEVID_VENDOR_INFO_SZ]; 1169 U8 ProductInfo[I2O_DEVID_PRODUCT_INFO_SZ]; 1170 U8 Description[I2O_DEVID_DESCRIPTION_SZ]; 1171 U8 ProductRevLevel[I2O_DEVID_REV_LEVEL_SZ]; 1172 U8 SNFormat; 1173 U8 SerialNumber[I2O_MAX_SERIAL_NUMBER_SZ]; 1174 } I2O_UTIL_DEVICE_IDENTITY_SCALAR, *PI2O_UTIL_DEVICE_IDENTITY_SCALAR; 1175 1176 /* UTIL Group F101h - DDM Identity Parameter Group */ 1177 1178 typedef struct _I2O_UTIL_DDM_IDENTITY_SCALAR { 1179 U16 DdmTID; 1180 U8 ModuleName[I2O_MODULE_NAME_SZ]; 1181 U8 ModuleRevLevel[I2O_DEVID_REV_LEVEL_SZ]; 1182 U8 SNFormat; 1183 U8 SerialNumber[I2O_MAX_SERIAL_NUMBER_SZ]; 1184 } I2O_UTIL_DDM_IDENTITY_SCALAR, *PI2O_UTIL_DDM_IDENTITY_SCALAR; 1185 1186 /* UTIL Group F102h - User Information Parameter Group */ 1187 1188 #define I2O_USER_DEVICE_NAME_SZ 64 1189 #define I2O_USER_SERVICE_NAME_SZ 64 1190 #define I2O_USER_PHYSICAL_LOCATION_SZ 64 1191 1192 typedef struct _I2O_UTIL_USER_INFORMATION_SCALAR { 1193 U8 DeviceName[I2O_USER_DEVICE_NAME_SZ]; 1194 U8 ServiceName[I2O_USER_SERVICE_NAME_SZ]; 1195 U8 PhysicalLocation[I2O_USER_PHYSICAL_LOCATION_SZ]; 1196 U32 InstanceNumber; 1197 } I2O_UTIL_USER_INFORMATION_SCALAR, *PI2O_UTIL_USER_INFORMATION_SCALAR; 1198 1199 /* UTIL Group F103h - SGL Operating Limits Parameter Group */ 1200 1201 typedef struct _I2O_UTIL_SGL_OPERATING_LIMITS_SCALAR { 1202 U32 SglChainSize; 1203 U32 SglChainSizeMax; 1204 U32 SglChainSizeTarget; 1205 U16 SglFragCount; 1206 U16 SglFragCountMax; 1207 U16 SglFragCountTarget; 1208 } I2O_UTIL_SGL_OPERATING_LIMITS_SCALAR, *PI2O_UTIL_SGL_OPERATING_LIMITS_SCALAR; 1209 1210 /* UTIL Group F200h - Sensors Parameter Group */ 1211 1212 #define I2O_SENSOR_COMPONENT_OTHER 0x00 1213 #define I2O_SENSOR_COMPONENT_PLANAR_LOGIC_BOARD 0x01 1214 #define I2O_SENSOR_COMPONENT_CPU 0x02 1215 #define I2O_SENSOR_COMPONENT_CHASSIS 0x03 1216 #define I2O_SENSOR_COMPONENT_POWER_SUPPLY 0x04 1217 #define I2O_SENSOR_COMPONENT_STORAGE 0x05 1218 #define I2O_SENSOR_COMPONENT_EXTERNAL 0x06 1219 1220 #define I2O_SENSOR_SENSOR_CLASS_ANALOG 0x00 1221 #define I2O_SENSOR_SENSOR_CLASS_DIGITAL 0x01 1222 1223 #define I2O_SENSOR_SENSOR_TYPE_OTHER 0x00 1224 #define I2O_SENSOR_SENSOR_TYPE_THERMAL 0x01 1225 #define I2O_SENSOR_SENSOR_TYPE_DC_VOLTAGE 0x02 1226 #define I2O_SENSOR_SENSOR_TYPE_AC_VOLTAGE 0x03 1227 #define I2O_SENSOR_SENSOR_TYPE_DC_CURRENT 0x04 1228 #define I2O_SENSOR_SENSOR_TYPE_AC_CURRENT 0x05 1229 #define I2O_SENSOR_SENSOR_TYPE_DOOR_OPEN 0x06 1230 #define I2O_SENSOR_SENSOR_TYPE_FAN_OPERATIONAL 0x07 1231 1232 #define I2O_SENSOR_SENSOR_STATE_NORMAL 0x00 1233 #define I2O_SENSOR_SENSOR_STATE_ABNORMAL 0x01 1234 #define I2O_SENSOR_SENSOR_STATE_UNKNOWN 0x02 1235 #define I2O_SENSOR_SENSOR_STATE_LOW_CAT 0x03 1236 #define I2O_SENSOR_SENSOR_STATE_LOW 0x04 1237 #define I2O_SENSOR_SENSOR_STATE_LOW_WARNING 0x05 1238 #define I2O_SENSOR_SENSOR_STATE_HIGH_WARNING 0x06 1239 #define I2O_SENSOR_SENSOR_STATE_HIGH 0x07 1240 #define I2O_SENSOR_SENSOR_STATE_HIGH_CAT 0x08 1241 1242 #define I2O_SENSOR_EVENT_ENABLE_STATE_CHANGE 0x0001 1243 #define I2O_SENSOR_EVENT_ENABLE_LOW_CATASTROPHIC 0x0002 1244 #define I2O_SENSOR_EVENT_ENABLE_LOW_READING 0x0004 1245 #define I2O_SENSOR_EVENT_ENABLE_LOW_WARNING 0x0008 1246 #define I2O_SENSOR_EVENT_ENABLE_CHANGE_TO_NORMAL 0x0010 1247 #define I2O_SENSOR_EVENT_ENABLE_HIGH_WARNING 0x0020 1248 #define I2O_SENSOR_EVENT_ENABLE_HIGH_READING 0x0040 1249 #define I2O_SENSOR_EVENT_ENABLE_HIGH_CATASTROPHIC 0x0080 1250 1251 1252 typedef struct _I2O_UTIL_SENSORS_TABLE { 1253 U16 SensorInstance; 1254 U8 Component; 1255 U16 ComponentInstance; 1256 U8 SensorClass; 1257 U8 SensorType; 1258 S8 ScalingExponent; 1259 S32 ActualReading; 1260 S32 MinimumReading; 1261 S32 Low2LowCatThreshold; 1262 S32 LowCat2LowThreshold; 1263 S32 LowWarn2LowThreshold; 1264 S32 Low2LowWarnThreshold; 1265 S32 Norm2LowWarnThreshold; 1266 S32 LowWarn2NormThreshold; 1267 S32 NominalReading; 1268 S32 HiWarn2NormThreshold; 1269 S32 Norm2HiWarnThreshold; 1270 S32 High2HiWarnThreshold; 1271 S32 HiWarn2HighThreshold; 1272 S32 HiCat2HighThreshold; 1273 S32 Hi2HiCatThreshold; 1274 S32 MaximumReading; 1275 U8 SensorState; 1276 U16 EventEnable; 1277 } I2O_UTIL_SENSORS_TABLE, *PI2O_UTIL_SENSORS_TABLE; 1278 1279 1280 PRAGMA_PACK_POP 1281 1282 PRAGMA_ALIGN_POP 1283 1284 #endif /* I2O_MESSAGE_HDR */ 1285