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