sys/dev/raid/asr/i2omsg.h

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