MdePkg/Include/IndustryStandard/IpmiNetFnApp.h

   1 /** @file
   2   IPMI 2.0 definitions from the IPMI Specification Version 2.0, Revision 1.1.
   3
   4   This file contains all NetFn App commands, including:
   5     IPM Device "Global" Commands (Chapter 20)
   6     Firmware Firewall & Command Discovery Commands (Chapter 21)
   7     BMC Watchdog Timer Commands (Chapter 27)
   8     IPMI Messaging Support Commands (Chapter 22)
   9     RMCP+ Support and Payload Commands (Chapter 24)
  10
  11   See IPMI specification, Appendix G, Command Assignments
  12   and Appendix H, Sub-function Assignments.
  13
  14   Copyright (c) 1999 - 2018, Intel Corporation. All rights reserved.<BR>
  15   This program and the accompanying materials
  16   are licensed and made available under the terms and conditions of the BSD License
  17   which accompanies this distribution.  The full text of the license may be found at
  18   http://opensource.org/licenses/bsd-license.php
  19
  20   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  21   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  22 **/
  23
  24 #ifndef _IPMI_NET_FN_APP_H_
  25 #define _IPMI_NET_FN_APP_H_
  26
  27 #pragma pack(1)
  28 //
  29 // Net function definition for App command
  30 //
  31 #define IPMI_NETFN_APP  0x06
  32
  33 //
  34 //  Below is Definitions for IPM Device "Global" Commands  (Chapter 20)
  35 //
  36
  37 //
  38 //  Definitions for Get Device ID command
  39 //
  40 #define IPMI_APP_GET_DEVICE_ID 0x1
  41
  42 //
  43 //  Constants and Structure definitions for "Get Device ID" command to follow here
  44 //
  45 typedef struct {
  46   UINT8   CompletionCode;
  47   UINT8   DeviceId;
  48   UINT8   DeviceRevision : 4;
  49   UINT8   Reserved : 3;
  50   UINT8   DeviceSdr : 1;
  51   UINT8   MajorFirmwareRev : 7;
  52   UINT8   UpdateMode : 1;
  53   UINT8   MinorFirmwareRev;
  54   UINT8   SpecificationVersion;
  55   UINT8   SensorDeviceSupport : 1;
  56   UINT8   SdrRepositorySupport : 1;
  57   UINT8   SelDeviceSupport : 1;
  58   UINT8   FruInventorySupport : 1;
  59   UINT8   IpmbMessageReceiver : 1;
  60   UINT8   IpmbMessageGenerator : 1;
  61   UINT8   BridgeSupport : 1;
  62   UINT8   ChassisSupport : 1;
  63   UINT8   ManufacturerId[3];
  64   UINT16  ProductId;
  65   UINT32  AuxFirmwareRevInfo;
  66 } IPMI_GET_DEVICE_ID_RESPONSE;
  67
  68
  69 //
  70 //  Definitions for Cold Reset command
  71 //
  72 #define IPMI_APP_COLD_RESET  0x2
  73
  74 //
  75 //  Constants and Structure definitions for "Cold Reset" command to follow here
  76 //
  77
  78 //
  79 //  Definitions for Warm Reset command
  80 //
  81 #define IPMI_APP_WARM_RESET  0x3
  82
  83 //
  84 //  Constants and Structure definitions for "Warm Reset" command to follow here
  85 //
  86
  87 //
  88 //  Definitions for Get Self Results command
  89 //
  90 #define IPMI_APP_GET_SELFTEST_RESULTS  0x4
  91
  92 //
  93 //  Constants and Structure definitions for "Get Self Test Results" command to follow here
  94 //
  95 typedef struct {
  96   UINT8  CompletionCode;
  97   UINT8  Result;
  98   UINT8  Param;
  99 } IPMI_SELF_TEST_RESULT_RESPONSE;
 100
 101 #define IPMI_APP_SELFTEST_NO_ERROR             0x55
 102 #define IPMI_APP_SELFTEST_NOT_IMPLEMENTED      0x56
 103 #define IPMI_APP_SELFTEST_ERROR                0x57
 104 #define IPMI_APP_SELFTEST_FATAL_HW_ERROR       0x58
 105 #define IPMI_APP_SELFTEST_INACCESSIBLE_SEL     0x80
 106 #define IPMI_APP_SELFTEST_INACCESSIBLE_SDR     0x40
 107 #define IPMI_APP_SELFTEST_INACCESSIBLE_FRU     0x20
 108 #define IPMI_APP_SELFTEST_IPMB_SIGNAL_FAIL     0x10
 109 #define IPMI_APP_SELFTEST_SDR_REPOSITORY_EMPTY 0x08
 110 #define IPMI_APP_SELFTEST_FRU_CORRUPT          0x04
 111 #define IPMI_APP_SELFTEST_FW_BOOTBLOCK_CORRUPT 0x02
 112 #define IPMI_APP_SELFTEST_FW_CORRUPT           0x01
 113
 114 //
 115 //  Definitions for Manufacturing Test ON command
 116 //
 117 #define IPMI_APP_MANUFACTURING_TEST_ON 0x5
 118
 119 //
 120 //  Constants and Structure definitions for "Manufacturing Test ON" command to follow here
 121 //
 122
 123 //
 124 //  Definitions for Set ACPI Power State command
 125 //
 126 #define IPMI_APP_SET_ACPI_POWERSTATE 0x6
 127
 128 //
 129 //  Constants and Structure definitions for "Set ACPI Power State" command to follow here
 130 //
 131
 132 //
 133 //  Definitions for System Power State
 134 //
 135 // Working
 136 #define IPMI_SYSTEM_POWER_STATE_S0_G0        0x0
 137 #define IPMI_SYSTEM_POWER_STATE_S1           0x1
 138 #define IPMI_SYSTEM_POWER_STATE_S2           0x2
 139 #define IPMI_SYSTEM_POWER_STATE_S3           0x3
 140 #define IPMI_SYSTEM_POWER_STATE_S4           0x4
 141 // Soft off
 142 #define IPMI_SYSTEM_POWER_STATE_S5_G2        0x5
 143 // Sent when message source cannot differentiate between S4 and S5
 144 #define IPMI_SYSTEM_POWER_STATE_S4_S5        0x6
 145 // Mechanical off
 146 #define IPMI_SYSTEM_POWER_STATE_G3           0x7
 147 // Sleeping - cannot differentiate between S1-S3
 148 #define IPMI_SYSTEM_POWER_STATE_SLEEPING     0x8
 149 // Sleeping - cannot differentiate between S1-S4
 150 #define IPMI_SYSTEM_POWER_STATE_G1_SLEEPING  0x9
 151 // S5 entered by override
 152 #define IPMI_SYSTEM_POWER_STATE_OVERRIDE     0xA
 153 #define IPMI_SYSTEM_POWER_STATE_LEGACY_ON    0x20
 154 #define IPMI_SYSTEM_POWER_STATE_LEGACY_OFF   0x21
 155 #define IPMI_SYSTEM_POWER_STATE_UNKNOWN      0x2A
 156 #define IPMI_SYSTEM_POWER_STATE_NO_CHANGE    0x7F
 157
 158 //
 159 //  Definitions for Device Power State
 160 //
 161 #define IPMI_DEVICE_POWER_STATE_D0           0x0
 162 #define IPMI_DEVICE_POWER_STATE_D1           0x1
 163 #define IPMI_DEVICE_POWER_STATE_D2           0x2
 164 #define IPMI_DEVICE_POWER_STATE_D3           0x3
 165 #define IPMI_DEVICE_POWER_STATE_UNKNOWN      0x2A
 166 #define IPMI_DEVICE_POWER_STATE_NO_CHANGE    0x7F
 167
 168 typedef struct {
 169   UINT8  AcpiSystemPowerState  : 7;
 170   UINT8  AcpiSystemStateChange : 1;
 171   UINT8  AcpiDevicePowerState  : 7;
 172   UINT8  AcpiDeviceStateChange : 1;
 173 } IPMI_SET_ACPI_POWER_STATE_REQUEST;
 174
 175 //
 176 //  Definitions for Get ACPI Power State command
 177 //
 178 #define IPMI_APP_GET_ACPI_POWERSTATE 0x7
 179
 180 //
 181 //  Constants and Structure definitions for "Get ACPI Power State" command to follow here
 182 //
 183
 184 //
 185 //  Definitions for Get Device GUID command
 186 //
 187 #define IPMI_APP_GET_DEVICE_GUID 0x8
 188
 189 //
 190 //  Constants and Structure definitions for "Get Device GUID" command to follow here
 191 //
 192 //
 193 //  Message structure definition for "Get Device Guid" IPMI command
 194 //
 195 typedef struct {
 196   UINT8  CompletionCode;
 197   UINT8  Guid[16];
 198 } IPMI_GET_DEVICE_GUID_RESPONSE;
 199
 200 //
 201 //  Below is Definitions for BMC Watchdog Timer Commands (Chapter 27)
 202 //
 203
 204 //
 205 //  Definitions for Reset WatchDog Timer command
 206 //
 207 #define IPMI_APP_RESET_WATCHDOG_TIMER  0x22
 208
 209 //
 210 //  Definitions for Set WatchDog Timer command
 211 //
 212 #define IPMI_APP_SET_WATCHDOG_TIMER  0x24
 213
 214 //
 215 //  Constants and Structure definitions for "Set WatchDog Timer" command to follow here
 216 //
 217
 218 //
 219 // Definitions for watchdog timer use
 220 //
 221 #define IPMI_WATCHDOG_TIMER_BIOS_FRB2  0x1
 222 #define IPMI_WATCHDOG_TIMER_BIOS_POST  0x2
 223 #define IPMI_WATCHDOG_TIMER_OS_LOADER  0x3
 224 #define IPMI_WATCHDOG_TIMER_SMS        0x4
 225 #define IPMI_WATCHDOG_TIMER_OEM        0x5
 226
 227 //
 228 //  Structure definition for timer Use
 229 //
 230 typedef struct {
 231   UINT8 TimerUse : 3;
 232   UINT8 Reserved : 3;
 233   UINT8 TimerRunning : 1;
 234   UINT8 TimerUseExpirationFlagLog : 1;
 235 } IPMI_WATCHDOG_TIMER_USE;
 236
 237 //
 238 //  Definitions for watchdog timeout action
 239 //
 240 #define IPMI_WATCHDOG_TIMER_ACTION_NO_ACTION    0x0
 241 #define IPMI_WATCHDOG_TIMER_ACTION_HARD_RESET   0x1
 242 #define IPMI_WATCHDOG_TIMER_ACTION_POWER_DONW   0x2
 243 #define IPMI_WATCHDOG_TIMER_ACTION_POWER_CYCLE  0x3
 244
 245 //
 246 //  Definitions for watchdog pre-timeout interrupt
 247 //
 248 #define IPMI_WATCHDOG_PRE_TIMEOUT_INTERRUPT_NONE       0x0
 249 #define IPMI_WATCHDOG_PRE_TIMEOUT_INTERRUPT_SMI        0x1
 250 #define IPMI_WATCHDOG_PRE_TIMEOUT_INTERRUPT_NMI        0x2
 251 #define IPMI_WATCHDOG_PRE_TIMEOUT_INTERRUPT_MESSAGING  0x3
 252
 253 //
 254 //  Structure definitions for Timer Actions
 255 //
 256 typedef struct {
 257   UINT8  TimeoutAction : 3;
 258   UINT8  Reserved1 : 1;
 259   UINT8  PreTimeoutInterrupt : 3;
 260   UINT8  Reserved2 : 1;
 261 } IPMI_WATCHDOG_TIMER_ACTIONS;
 262
 263 //
 264 //  Bit definitions for Timer use expiration flags
 265 //
 266 #define IPMI_WATCHDOG_TIMER_EXPIRATION_FLAG_BIOS_FRB2  BIT1
 267 #define IPMI_WATCHDOG_TIMER_EXPIRATION_FLAG_BIOS_POST  BIT2
 268 #define IPMI_WATCHDOG_TIMER_EXPIRATION_FLAG_OS_LOAD    BIT3
 269 #define IPMI_WATCHDOG_TIMER_EXPIRATION_FLAG_SMS_OS     BIT4
 270 #define IPMI_WATCHDOG_TIMER_EXPIRATION_FLAG_OEM        BIT5
 271
 272 typedef struct {
 273   IPMI_WATCHDOG_TIMER_USE         TimerUse;
 274   IPMI_WATCHDOG_TIMER_ACTIONS     TimerActions;
 275   UINT8                           PretimeoutInterval;
 276   UINT8                           TimerUseExpirationFlagsClear;
 277   UINT16                          InitialCountdownValue;
 278 } IPMI_SET_WATCHDOG_TIMER_REQUEST;
 279
 280 //
 281 //  Definitions for Get WatchDog Timer command
 282 //
 283 #define IPMI_APP_GET_WATCHDOG_TIMER  0x25
 284
 285 //
 286 //  Constants and Structure definitions for "Get WatchDog Timer" command to follow here
 287 //
 288 typedef struct {
 289   UINT8                           CompletionCode;
 290   IPMI_WATCHDOG_TIMER_USE         TimerUse;
 291   IPMI_WATCHDOG_TIMER_ACTIONS     TimerActions;
 292   UINT8                           PretimeoutInterval;
 293   UINT8                           TimerUseExpirationFlagsClear;
 294   UINT16                          InitialCountdownValue;
 295   UINT16                          PresentCountdownValue;
 296 } IPMI_GET_WATCHDOG_TIMER_RESPONSE;
 297
 298 //
 299 //  Below is Definitions for IPMI Messaging Support Commands (Chapter 22)
 300 //
 301
 302 //
 303 //  Definitions for Set BMC Global Enables command
 304 //
 305 #define IPMI_APP_SET_BMC_GLOBAL_ENABLES  0x2E
 306
 307 //
 308 //  Constants and Structure definitions for "Set BMC Global Enables " command to follow here
 309 //
 310 typedef struct {
 311   UINT8  EnableReceiveMessageQueueInterrupt : 1;
 312   UINT8  EnableEventMessageBufferFullInterrupt : 1;
 313   UINT8  EnableEventMessageBuffer : 1;
 314   UINT8  EnableSystemEventLogging : 1;
 315   UINT8  Reserved : 1;
 316   UINT8  Oem0Enable : 1;
 317   UINT8  Oem1Enable : 1;
 318   UINT8  Oem2Enable : 1;
 319 } IPMI_SET_BMC_GLOBAL_ENABLES_REQUEST;
 320
 321 //
 322 //  Definitions for Get BMC Global Enables command
 323 //
 324 #define IPMI_APP_GET_BMC_GLOBAL_ENABLES  0x2F
 325
 326 //
 327 //  Constants and Structure definitions for "Get BMC Global Enables " command to follow here
 328 //
 329 typedef struct {
 330   UINT8  CompletionCode;
 331   UINT8  ReceiveMessageQueueInterrupt : 1;
 332   UINT8  EventMessageBufferFullInterrupt : 1;
 333   UINT8  EventMessageBuffer : 1;
 334   UINT8  SystemEventLogging : 1;
 335   UINT8  Reserved : 1;
 336   UINT8  Oem0Enable : 1;
 337   UINT8  Oem1Enable : 1;
 338   UINT8  Oem2Enable : 1;
 339 } IPMI_GET_BMC_GLOBAL_ENABLES_RESPONSE;
 340
 341 //
 342 //  Definitions for Clear Message Flags command
 343 //
 344 #define IPMI_APP_CLEAR_MESSAGE_FLAGS 0x30
 345
 346 //
 347 //  Constants and Structure definitions for "Clear Message Flags" command to follow here
 348 //
 349 typedef struct {
 350   UINT8  ClearReceiveMessageQueue : 1;
 351   UINT8  ClearEventMessageBuffer : 1;
 352   UINT8  Reserved0 : 1;
 353   UINT8  ClearWatchdogPerTimeoutInterruptFlag : 1;
 354   UINT8  Reserved : 1;
 355   UINT8  ClearOem0Enable : 1;
 356   UINT8  ClearOem1Enable : 1;
 357   UINT8  ClearOem2Enable : 1;
 358 } IPMI_CLEAR_MESSAGE_FLAGS_REQUEST;
 359
 360 //
 361 //  Definitions for Get Message Flags command
 362 //
 363 #define IPMI_APP_GET_MESSAGE_FLAGS 0x31
 364
 365 //
 366 //  Constants and Structure definitions for "Get Message Flags" command to follow here
 367 //
 368 typedef struct {
 369   UINT8  CompletionCode;
 370   UINT8  ReceiveMessageAvailable : 1;
 371   UINT8  EventMessageBufferFull : 1;
 372   UINT8  Reserved0 : 1;
 373   UINT8  WatchdogPerTimeoutInterruptOccurred : 1;
 374   UINT8  Reserved : 1;
 375   UINT8  Oem0DataAvailable : 1;
 376   UINT8  Oem1DataAvailable : 1;
 377   UINT8  Oem2DataAvailable : 1;
 378 } IPMI_GET_MESSAGE_FLAGS_RESPONSE;
 379
 380 //
 381 //  Definitions for Enable Message Channel Receive command
 382 //
 383 #define IPMI_APP_ENABLE_MESSAGE_CHANNEL_RECEIVE  0x32
 384
 385 //
 386 //  Constants and Structure definitions for "Enable Message Channel Receive" command to follow here
 387 //
 388
 389 //
 390 //  Definitions for Get Message command
 391 //
 392 #define IPMI_APP_GET_MESSAGE 0x33
 393
 394 //
 395 //  Constants and Structure definitions for "Get Message" command to follow here
 396 //
 397 typedef struct {
 398   UINT8  CompletionCode;
 399   UINT8  ChannelNumber : 4;
 400   UINT8  InferredPrivilegeLevel : 4;
 401   UINT8  MessageData[0];
 402 } IPMI_GET_MESSAGE_RESPONSE;
 403
 404 //
 405 //  Definitions for Send Message command
 406 //
 407 #define IPMI_APP_SEND_MESSAGE  0x34
 408
 409 //
 410 //  Constants and Structure definitions for "Send Message" command to follow here
 411 //
 412 typedef struct {
 413   UINT8  CompletionCode;
 414   UINT8  ChannelNumber : 4;
 415   UINT8  Authentication : 1;
 416   UINT8  Encryption : 1;
 417   UINT8  Tracking : 2;
 418   UINT8  MessageData[0];
 419 } IPMI_SEND_MESSAGE_REQUEST;
 420
 421 typedef struct {
 422   UINT8  CompletionCode;
 423   UINT8  ResponseData[0];
 424 } IPMI_SEND_MESSAGE_RESPONSE;
 425
 426 //
 427 //  Definitions for Read Event Message Buffer command
 428 //
 429 #define IPMI_APP_READ_EVENT_MSG_BUFFER 0x35
 430
 431 //
 432 //  Constants and Structure definitions for "Read Event Message Buffer" command to follow here
 433 //
 434
 435 //
 436 //  Definitions for Get BT Interface Capabilities command
 437 //
 438 #define IPMI_APP_GET_BT_INTERFACE_CAPABILITY 0x36
 439
 440 //
 441 //  Constants and Structure definitions for "Get BT Interface Capabilities" command to follow here
 442 //
 443
 444 //
 445 //  Definitions for Get System GUID command
 446 //
 447 #define IPMI_APP_GET_SYSTEM_GUID 0x37
 448
 449 //
 450 //  Constants and Structure definitions for "Get System GUID" command to follow here
 451 //
 452
 453 //
 454 //  Definitions for Get Channel Authentication Capabilities command
 455 //
 456 #define IPMI_APP_GET_CHANNEL_AUTHENTICATION_CAPABILITIES 0x38
 457
 458 //
 459 //  Constants and Structure definitions for "Get Channel Authentication Capabilities" command to follow here
 460 //
 461
 462 //
 463 //  Definitions for Get Session Challenge command
 464 //
 465 #define IPMI_APP_GET_SESSION_CHALLENGE 0x39
 466
 467 //
 468 //  Constants and Structure definitions for "Get Session Challenge" command to follow here
 469 //
 470
 471 //
 472 //  Definitions for Activate Session command
 473 //
 474 #define IPMI_APP_ACTIVATE_SESSION  0x3A
 475
 476 //
 477 //  Constants and Structure definitions for "Activate Session" command to follow here
 478 //
 479
 480 //
 481 //  Definitions for Set Session Privelege Level command
 482 //
 483 #define IPMI_APP_SET_SESSION_PRIVELEGE_LEVEL 0x3B
 484
 485 //
 486 //  Constants and Structure definitions for "Set Session Privelege Level" command to follow here
 487 //
 488
 489 //
 490 //  Definitions for Close Session command
 491 //
 492 #define IPMI_APP_CLOSE_SESSION 0x3C
 493
 494 //
 495 //  Constants and Structure definitions for "Close Session" command to follow here
 496 //
 497
 498 //
 499 //  Definitions for Get Session Info command
 500 //
 501 #define IPMI_APP_GET_SESSION_INFO  0x3D
 502
 503 //
 504 //  Constants and Structure definitions for "Get Session Info" command to follow here
 505 //
 506
 507 //
 508 //  Definitions for Get Auth Code command
 509 //
 510 #define IPMI_APP_GET_AUTHCODE  0x3F
 511
 512 //
 513 //  Constants and Structure definitions for "Get AuthCode" command to follow here
 514 //
 515
 516 //
 517 //  Definitions for Set Channel Access command
 518 //
 519 #define IPMI_APP_SET_CHANNEL_ACCESS  0x40
 520
 521 //
 522 //  Constants and Structure definitions for "Set Channel Access" command to follow here
 523 //
 524
 525 //
 526 //  Definitions for Get Channel Access command
 527 //
 528 #define IPMI_APP_GET_CHANNEL_ACCESS  0x41
 529
 530 //
 531 //  Constants and Structure definitions for "Get Channel Access" command to follow here
 532 //
 533
 534 //
 535 //  Definitions for channel access memory type in Get Channel Access command request
 536 //
 537 #define IPMI_CHANNEL_ACCESS_MEMORY_TYPE_NON_VOLATILE              0x1
 538 #define IPMI_CHANNEL_ACCESS_MEMORY_TYPE_PRESENT_VOLATILE_SETTING  0x2
 539
 540 //
 541 //  Definitions for channel access modes in Get Channel Access command response
 542 //
 543 #define IPMI_CHANNEL_ACCESS_MODES_DISABLED          0x0
 544 #define IPMI_CHANNEL_ACCESS_MODES_PRE_BOOT_ONLY     0x1
 545 #define IPMI_CHANNEL_ACCESS_MODES_ALWAYS_AVAILABLE  0x2
 546 #define IPMI_CHANNEL_ACCESS_MODES_SHARED            0x3
 547
 548 typedef struct {
 549   UINT8  ChannelNo : 4;
 550   UINT8  Reserve1 : 4;
 551   UINT8  Reserve2 : 6;
 552   UINT8  MemoryType : 2;
 553 } IPMI_GET_CHANNEL_ACCESS_REQUEST;
 554
 555 typedef struct {
 556   UINT8  CompletionCode;
 557   UINT8  AccessMode : 3;
 558   UINT8  UserLevelAuthEnabled : 1;
 559   UINT8  MessageAuthEnable : 1;
 560   UINT8  Alert : 1;
 561   UINT8  Reserve1 : 2;
 562   UINT8  ChannelPriviledgeLimit : 4;
 563   UINT8  Reserve2 : 4;
 564 } IPMI_GET_CHANNEL_ACCESS_RESPONSE;
 565
 566 //
 567 //  Definitions for Get Channel Info command
 568 //
 569 #define IPMI_APP_GET_CHANNEL_INFO  0x42
 570
 571 //
 572 //  Constants and Structure definitions for "Get Channel Info" command to follow here
 573 //
 574
 575 //
 576 //  Definitions for channel media type
 577 //
 578 // IPMB (I2C)
 579 #define IPMI_CHANNEL_MEDIA_TYPE_IPMB              0x1
 580 // ICMB v1.0
 581 #define IPMI_CHANNEL_MEDIA_TYPE_ICMB_1_0          0x2
 582 // ICMB v0.9
 583 #define IPMI_CHANNEL_MEDIA_TYPE_ICMB_0_9          0x3
 584 // 802.3 LAN
 585 #define IPMI_CHANNEL_MEDIA_TYPE_802_3_LAN         0x4
 586 // Asynch. Serial/Modem (RS-232)
 587 #define IPMI_CHANNEL_MEDIA_TYPE_RS_232            0x5
 588 // Other LAN
 589 #define IPMI_CHANNEL_MEDIA_TYPE_OTHER_LAN         0x6
 590 // PCI SMBus
 591 #define IPMI_CHANNEL_MEDIA_TYPE_PCI_SM_BUS        0x7
 592 // SMBus v1.0/1.1
 593 #define IPMI_CHANNEL_MEDIA_TYPE_SM_BUS_V1         0x8
 594 // SMBus v2.0
 595 #define IPMI_CHANNEL_MEDIA_TYPE_SM_BUS_V2         0x9
 596 // USB 1.x
 597 #define IPMI_CHANNEL_MEDIA_TYPE_USB1              0xA
 598 // USB 2.x
 599 #define IPMI_CHANNEL_MEDIA_TYPE_USB2              0xB
 600 // System Interface (KCS, SMIC, or BT)
 601 #define IPMI_CHANNEL_MEDIA_TYPE_SYSTEM_INTERFACE  0xC
 602 // OEM
 603 #define IPMI_CHANNEL_MEDIA_TYPE_OEM_START         0x60
 604 #define IPMI_CHANNEL_MEDIA_TYPE_OEM_END           0x7F
 605
 606 typedef struct {
 607   UINT8   CompletionCode;
 608   UINT8   ChannelNo : 4;
 609   UINT8   Reserve1 : 4;
 610   UINT8   ChannelMediumType : 7;
 611   UINT8   Reserve2 : 1;
 612   UINT8   ChannelProtocolType : 5;
 613   UINT8   Reserve3 : 3;
 614   UINT8   ActiveSessionCount : 6;
 615   UINT8   SessionSupport : 2;
 616   UINT8   VendorId[3];
 617   UINT16  AuxChannelInfo;
 618 } IPMI_GET_CHANNEL_INFO_RESPONSE;
 619
 620 //
 621 //  Definitions for Get Channel Info command
 622 //
 623 #define IPMI_APP_GET_CHANNEL_INFO  0x42
 624
 625 //
 626 //  Constants and Structure definitions for "Get Channel Info" command to follow here
 627 //
 628
 629 //
 630 //  Definitions for Set User Access command
 631 //
 632 #define IPMI_APP_SET_USER_ACCESS 0x43
 633
 634 //
 635 //  Constants and Structure definitions for "Set User Access" command to follow here
 636 //
 637
 638 //
 639 //  Definitions for Get User Access command
 640 //
 641 #define IPMI_APP_GET_USER_ACCESS 0x44
 642
 643 //
 644 //  Constants and Structure definitions for "Get User Access" command to follow here
 645 //
 646 typedef struct {
 647   UINT8   ChannelNo : 4;
 648   UINT8   Reserved1 : 4;
 649   UINT8   UserId : 6;
 650   UINT8   Reserved2 : 2;
 651 } IPMI_GET_USER_ACCESS_REQUEST;
 652
 653 typedef struct {
 654   UINT8   CompletionCode;
 655   UINT8   MaxUserId : 6;
 656   UINT8   Reserved1 : 2;
 657   UINT8   CurrentUserId : 6;
 658   UINT8   UserIdEnableStatus : 2;
 659   UINT8   FixedUserId : 6;
 660   UINT8   Reserved2 : 2;
 661   UINT8   UserPrivilegeLimit : 4;
 662   UINT8   EnableIpmiMessaging : 1;
 663   UINT8   EnableUserLinkAuthetication : 1;
 664   UINT8   UserAccessAvailable : 1;
 665   UINT8   Reserved3 : 1;
 666 } IPMI_GET_USER_ACCESS_RESPONSE;
 667
 668 //
 669 //  Definitions for Set User Name command
 670 //
 671 #define IPMI_APP_SET_USER_NAME 0x45
 672
 673 //
 674 //  Constants and Structure definitions for "Set User Name" command to follow here
 675 //
 676 typedef struct {
 677   UINT8  UserId : 6;
 678   UINT8  Reserved : 2;
 679   UINT8  UserName[16];
 680 } IPMI_SET_USER_NAME_REQUEST;
 681
 682 //
 683 //  Definitions for Get User Name command
 684 //
 685 #define IPMI_APP_GET_USER_NAME 0x46
 686
 687 //
 688 //  Constants and Structure definitions for "Get User Name" command to follow here
 689 //
 690 typedef struct {
 691   UINT8  UserId : 6;
 692   UINT8  Reserved : 2;
 693 } IPMI_GET_USER_NAME_REQUEST;
 694
 695 typedef struct {
 696   UINT8  CompletionCode;
 697   UINT8  UserName[16];
 698 } IPMI_GET_USER_NAME_RESPONSE;
 699
 700 //
 701 //  Definitions for Set User Password command
 702 //
 703 #define IPMI_APP_SET_USER_PASSWORD 0x47
 704
 705 //
 706 //  Constants and Structure definitions for "Set User Password" command to follow here
 707 //
 708
 709 //
 710 //  Definitions for Set User password command operation type
 711 //
 712 #define IPMI_SET_USER_PASSWORD_OPERATION_TYPE_DISABLE_USER   0x0
 713 #define IPMI_SET_USER_PASSWORD_OPERATION_TYPE_ENABLE_USER    0x1
 714 #define IPMI_SET_USER_PASSWORD_OPERATION_TYPE_SET_PASSWORD   0x2
 715 #define IPMI_SET_USER_PASSWORD_OPERATION_TYPE_TEST_PASSWORD  0x3
 716
 717 //
 718 //  Definitions for Set user password command password size
 719 //
 720 #define IPMI_SET_USER_PASSWORD_PASSWORD_SIZE_16  0x0
 721 #define IPMI_SET_USER_PASSWORD_PASSWORD_SIZE_20  0x1
 722
 723 typedef struct {
 724   UINT8   UserId : 6;
 725   UINT8   Reserved1 : 1;
 726   UINT8   PasswordSize : 1;
 727   UINT8   Operation : 2;
 728   UINT8   Reserved2 : 6;
 729   UINT8   PasswordData[0];  // 16 or 20 bytes, depending on the 'PasswordSize' field
 730 } IPMI_SET_USER_PASSWORD_REQUEST;
 731
 732 //
 733 //  Below is Definitions for RMCP+ Support and Payload Commands (Chapter 24)
 734 //
 735
 736 //
 737 //  Definitions for Activate Payload command
 738 //
 739 #define IPMI_APP_ACTIVATE_PAYLOAD  0x48
 740
 741 //
 742 //  Constants and Structure definitions for "Activate Payload" command to follow here
 743 //
 744
 745 //
 746 //  Definitions for De-Activate Payload command
 747 //
 748 #define IPMI_APP_DEACTIVATE_PAYLOAD  0x49
 749
 750 //
 751 //  Constants and Structure definitions for "DeActivate Payload" command to follow here
 752 //
 753
 754 //
 755 //  Definitions for Get Payload activation Status command
 756 //
 757 #define IPMI_APP_GET_PAYLOAD_ACTIVATION_STATUS 0x4a
 758
 759 //
 760 //  Constants and Structure definitions for "Get Payload activation Status" command to follow here
 761 //
 762
 763 //
 764 //  Definitions for Get Payload Instance Info command
 765 //
 766 #define IPMI_APP_GET_PAYLOAD_INSTANCE_INFO 0x4b
 767
 768 //
 769 //  Constants and Structure definitions for "Get Payload Instance Info" command to follow here
 770 //
 771
 772 //
 773 //  Definitions for Set User Payload Access command
 774 //
 775 #define IPMI_APP_SET_USER_PAYLOAD_ACCESS 0x4C
 776
 777 //
 778 //  Constants and Structure definitions for "Set User Payload Access" command to follow here
 779 //
 780
 781 //
 782 //  Definitions for Get User Payload Access command
 783 //
 784 #define IPMI_APP_GET_USER_PAYLOAD_ACCESS 0x4D
 785
 786 //
 787 //  Constants and Structure definitions for "Get User Payload Access" command to follow here
 788 //
 789
 790 //
 791 //  Definitions for Get Channel Payload Support command
 792 //
 793 #define IPMI_APP_GET_CHANNEL_PAYLOAD_SUPPORT 0x4E
 794
 795 //
 796 //  Constants and Structure definitions for "Get Channel Payload Support" command to follow here
 797 //
 798
 799 //
 800 //  Definitions for Get Channel Payload Version command
 801 //
 802 #define IPMI_APP_GET_CHANNEL_PAYLOAD_VERSION 0x4F
 803
 804 //
 805 //  Constants and Structure definitions for "Get Channel Payload Version" command to follow here
 806 //
 807
 808 //
 809 //  Definitions for Get Channel OEM Payload Info command
 810 //
 811 #define IPMI_APP_GET_CHANNEL_OEM_PAYLOAD_INFO  0x50
 812
 813 //
 814 //  Constants and Structure definitions for "Get Channel OEM Payload Info" command to follow here
 815 //
 816
 817 //
 818 //  Definitions for  Master Write-Read command
 819 //
 820 #define IPMI_APP_MASTER_WRITE_READ 0x52
 821
 822 //
 823 //  Constants and Structure definitions for "Master Write Read" command to follow here
 824 //
 825
 826 //
 827 //  Definitions for  Get Channel Cipher Suites command
 828 //
 829 #define IPMI_APP_GET_CHANNEL_CIPHER_SUITES 0x54
 830
 831 //
 832 //  Constants and Structure definitions for "Get Channel Cipher Suites" command to follow here
 833 //
 834
 835 //
 836 //  Below is Definitions for RMCP+ Support and Payload Commands (Chapter 24, Section 3)
 837 //
 838
 839 //
 840 //  Definitions for  Suspend-Resume Payload Encryption command
 841 //
 842 #define IPMI_APP_SUSPEND_RESUME_PAYLOAD_ENCRYPTION 0x55
 843
 844 //
 845 //  Constants and Structure definitions for "Suspend-Resume Payload Encryption" command to follow here
 846 //
 847
 848 //
 849 //  Below is Definitions for IPMI Messaging Support Commands (Chapter 22, Section 25 and 9)
 850 //
 851
 852 //
 853 //  Definitions for  Set Channel Security Keys command
 854 //
 855 #define IPMI_APP_SET_CHANNEL_SECURITY_KEYS 0x56
 856
 857 //
 858 //  Constants and Structure definitions for "Set Channel Security Keys" command to follow here
 859 //
 860
 861 //
 862 //  Definitions for  Get System Interface Capabilities command
 863 //
 864 #define IPMI_APP_GET_SYSTEM_INTERFACE_CAPABILITIES 0x57
 865
 866 //
 867 //  Constants and Structure definitions for "Get System Interface Capabilities" command to follow here
 868 //
 869
 870 //
 871 //  Definitions for Get System Interface Capabilities command SSIF transaction support
 872 //
 873 #define IPMI_GET_SYSTEM_INTERFACE_CAPABILITIES_SSIF_TRANSACTION_SUPPORT_SINGLE_PARTITION_RW             0x0
 874 #define IPMI_GET_SYSTEM_INTERFACE_CAPABILITIES_SSIF_TRANSACTION_SUPPORT_MULTI_PARTITION_RW              0x1
 875 #define IPMI_GET_SYSTEM_INTERFACE_CAPABILITIES_SSIF_TRANSACTION_SUPPORT_MULTI_PARTITION_RW_WITH_MIDDLE  0x2
 876
 877 #pragma pack()
 878 #endif