MdePkg/Include/IndustryStandard/IpmiNetFnAppDefinitions.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 - 2015, 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 _IPMINETFNAPPDEFINITIONS_H_
  25 #define _IPMINETFNAPPDEFINITIONS_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   DeviceId;
  47   UINT8   DeviceRevision : 4;
  48   UINT8   Reserved : 3;
  49   UINT8   DeviceSdr : 1;
  50   UINT8   MajorFirmwareRev : 7;
  51   UINT8   UpdateMode : 1;
  52   UINT8   MinorFirmwareRev;
  53   UINT8   SpecificationVersion;
  54   UINT8   SensorDeviceSupport : 1;
  55   UINT8   SdrRepositorySupport : 1;
  56   UINT8   SelDeviceSupport : 1;
  57   UINT8   FruInventorySupport : 1;
  58   UINT8   IpmbMessageReceiver : 1;
  59   UINT8   IpmbMessageGenerator : 1;
  60   UINT8   BridgeSupport : 1;
  61   UINT8   ChassisSupport : 1;
  62   UINT8   ManufacturerId[3];
  63   UINT16  ProductId;
  64   UINT32  AuxFirmwareRevInfo;
  65 } IPMI_MSG_GET_DEVICE_ID_RSP;
  66
  67
  68 //
  69 //  Definitions for Cold Reset command
  70 //
  71 #define IPMI_APP_COLD_RESET  0x2
  72
  73 //
  74 //  Constants and Structure definitions for "Cold Reset" command to follow here
  75 //
  76
  77 //
  78 //  Definitions for Warm Reset command
  79 //
  80 #define IPMI_APP_WARM_RESET  0x3
  81
  82 //
  83 //  Constants and Structure definitions for "Warm Reset" command to follow here
  84 //
  85
  86 //
  87 //  Definitions for Get Self Results command
  88 //
  89 #define IPMI_APP_GET_SELFTEST_RESULTS  0x4
  90
  91 //
  92 //  Constants and Structure definitions for "Get Self Results" command to follow here
  93 //
  94 typedef struct {
  95   UINT8  Result;
  96   UINT8  Param;
  97 } IPMI_MSG_SELFTEST_RESULT_RSP;
  98
  99 #define IPMI_APP_SELFTEST_NO_ERROR             0x55
 100 #define IPMI_APP_SELFTEST_NOT_IMPLEMENTED      0x56
 101 #define IPMI_APP_SELFTEST_ERROR                0x57
 102 #define IPMI_APP_SELFTEST_FATAL_HW_ERROR       0x58
 103 #define IPMI_APP_SELFTEST_INACCESSIBLE_SEL     0x80
 104 #define IPMI_APP_SELFTEST_INACCESSIBLE_SDR     0x40
 105 #define IPMI_APP_SELFTEST_INACCESSIBLE_FRU     0x20
 106 #define IPMI_APP_SELFTEST_IPMB_SIGNAL_FAIL     0x10
 107 #define IPMI_APP_SELFTEST_SDR_REPOSITORY_EMPTY 0x08
 108 #define IPMI_APP_SELFTEST_FRU_CORRUPT          0x04
 109 #define IPMI_APP_SELFTEST_FW_BOOTBLOCK_CORRUPT 0x02
 110 #define IPMI_APP_SELFTEST_FW_CORRUPT           0x01
 111
 112 //
 113 //  Definitions for Manufacturing Test ON command
 114 //
 115 #define IPMI_APP_MANUFACTURING_TEST_ON 0x5
 116
 117 //
 118 //  Constants and Structure definitions for "Manufacturing Test ON" command to follow here
 119 //
 120
 121 //
 122 //  Definitions for Set ACPI Power State command
 123 //
 124 #define IPMI_APP_SET_ACPI_POWERSTATE 0x6
 125
 126 //
 127 //  Constants and Structure definitions for "Set ACPI Power State" command to follow here
 128 //
 129 typedef struct {
 130   UINT8 SystemPowerState : 7;
 131   UINT8 SystemStateChange : 1;
 132   UINT8 DevicePowerState : 7;
 133   UINT8 DeviceStateChange : 1;
 134 } IPMI_ACPI_POWER_STATE;
 135
 136 //
 137 //  Definitions for Get ACPI Power State command
 138 //
 139 #define IPMI_APP_GET_ACPI_POWERSTATE 0x7
 140
 141 //
 142 //  Constants and Structure definitions for "Get ACPI Power State" command to follow here
 143 //
 144
 145 //
 146 //  Definitions for Get Device GUID command
 147 //
 148 #define IPMI_APP_GET_DEVICE_GUID 0x8
 149
 150 //
 151 //  Constants and Structure definitions for "Get Device GUID" command to follow here
 152 //
 153 //
 154 //  Message structure definition for "Get Device Guid" IPMI command
 155 //
 156 typedef struct {
 157   UINT8 Guid[16];
 158 } IPMI_MSG_GET_DEVICE_GUID_RSP;
 159
 160 //
 161 //  Below is Definitions for BMC Watchdog Timer Commands (Chapter 27)
 162 //
 163
 164 //
 165 //  Definitions for Reset WatchDog Timer command
 166 //
 167 #define IPMI_APP_RESET_WATCHDOG_TIMER  0x22
 168
 169 //
 170 //  Constants and Structure definitions for "Reset WatchDog Timer" command to follow here
 171 //
 172 typedef struct {
 173   UINT8 TimerUse : 3;
 174   UINT8 Reserved : 3;
 175   UINT8 TimerRunning : 1;
 176   UINT8 TimerUseExpirationFlagLog : 1;
 177 } IPMI_WATCHDOG_TIMER_USE;
 178
 179 //
 180 //  Definitions for Set WatchDog Timer command
 181 //
 182 #define IPMI_APP_SET_WATCHDOG_TIMER  0x24
 183
 184 //
 185 //  Constants and Structure definitions for "Set WatchDog Timer" command to follow here
 186 //
 187 typedef struct {
 188   IPMI_WATCHDOG_TIMER_USE         TimerUse;
 189   UINT8                           TimerActions;
 190   UINT8                           PretimeoutInterval;
 191   UINT8                           TimerUseExpirationFlagsClear;
 192   UINT16                          InitialCountdownValue;
 193 } IPMI_SET_WATCHDOG_TIMER;
 194
 195 //
 196 //  Definitions for Get WatchDog Timer command
 197 //
 198 #define IPMI_APP_GET_WATCHDOG_TIMER  0x25
 199
 200 //
 201 //  Constants and Structure definitions for "Get WatchDog Timer" command to follow here
 202 //
 203 typedef struct {
 204   IPMI_WATCHDOG_TIMER_USE         TimerUse;
 205   UINT8                           TimerActions;
 206   UINT8                           PretimeoutInterval;
 207   UINT8                           TimerUseExpirationFlagsClear;
 208   UINT16                          InitialCountdownValue;
 209   UINT16                          PresentCountdownValue;
 210 } IPMI_WATCHDOG_TIMER;
 211
 212 //
 213 // The following srucure is temporary, need to be removed later
 214 //
 215 typedef struct {
 216   UINT8 TimerUse : 3;
 217   UINT8 Reserved1 : 3;
 218   UINT8 StartTimer : 1;
 219   UINT8 DontLog : 1;
 220   union {
 221     struct {
 222       UINT8 TimeoutAction : 3;
 223       UINT8 Reserved2 : 1;
 224       UINT8 PreTimeoutIntr : 3;
 225       UINT8 Reserved3 : 1;
 226     } Byte2Bmp;
 227     UINT8 Data8;
 228   } Byte2;
 229
 230   UINT8   PreTimeoutInterval;
 231   UINT8   ExpirationReserved1 : 1;
 232   UINT8   BiosFrb2TimerExpirationFlag : 1;
 233   UINT8   BiosPostTimerExpirationFlag : 1;
 234   UINT8   OsLoadTimerExpirationFlag : 1;
 235   UINT8   ExpirationReserved2 : 4;
 236   UINT16  Timeout;
 237   UINT16  CurrCountdown;
 238   UINT16  Reserved4;
 239 } IPMI_FRB_TIMER;
 240
 241 //
 242 //  Below is Definitions for IPMI Messaging Support Commands (Chapter 22)
 243 //
 244
 245 //
 246 //  Definitions for Set BMC Global Enables command
 247 //
 248 #define IPMI_APP_SET_BMC_GLOBAL_ENABLES  0x2E
 249
 250 //
 251 //  Constants and Structure definitions for "Set BMC Global Enables " command to follow here
 252 //
 253
 254 //
 255 //  Definitions for Get BMC Global Enables command
 256 //
 257 #define IPMI_APP_GET_BMC_GLOBAL_ENABLES  0x2F
 258
 259 //
 260 //  Constants and Structure definitions for "Get BMC Global Enables " command to follow here
 261 //
 262
 263 //
 264 //  Definitions for Clear Message Flags command
 265 //
 266 #define IPMI_APP_CLEAR_MESSAGE_FLAGS 0x30
 267
 268 //
 269 //  Constants and Structure definitions for "Clear Message Flags" command to follow here
 270 //
 271
 272 //
 273 //  Definitions for Get Message Flags command
 274 //
 275 #define IPMI_APP_GET_MESSAGE_FLAGS 0x31
 276
 277 //
 278 //  Constants and Structure definitions for "Get Message Flags" command to follow here
 279 //
 280
 281 //
 282 //  Definitions for Enable Message Channel Receive command
 283 //
 284 #define IPMI_APP_ENABLE_MESSAGE_CHANNEL_RECEIVE  0x32
 285
 286 //
 287 //  Constants and Structure definitions for "Enable Message Channel Receive" command to follow here
 288 //
 289
 290 //
 291 //  Definitions for Get Message command
 292 //
 293 #define IPMI_APP_GET_MESSAGE 0x33
 294
 295 //
 296 //  Constants and Structure definitions for "Get Message" command to follow here
 297 //
 298
 299 //
 300 //  Definitions for Send Message command
 301 //
 302 #define IPMI_APP_SEND_MESSAGE  0x34
 303
 304 //
 305 //  Constants and Structure definitions for "Send Message" command to follow here
 306 //
 307
 308 //
 309 //  Definitions for Read Event Message Buffer command
 310 //
 311 #define IPMI_APP_READ_EVENT_MSG_BUFFER 0x35
 312
 313 //
 314 //  Constants and Structure definitions for "Read Event Message Buffer" command to follow here
 315 //
 316
 317 //
 318 //  Definitions for Get BT Interface Capabilities command
 319 //
 320 #define IPMI_APP_GET_BT_INTERFACE_CAPABILITY 0x36
 321
 322 //
 323 //  Constants and Structure definitions for "Get BT Interface Capabilities" command to follow here
 324 //
 325
 326 //
 327 //  Definitions for Get System GUID command
 328 //
 329 #define IPMI_APP_GET_SYSTEM_GUID 0x37
 330
 331 //
 332 //  Constants and Structure definitions for "Get System GUID" command to follow here
 333 //
 334
 335 //
 336 //  Definitions for Get Channel Authentication Capabilities command
 337 //
 338 #define IPMI_APP_GET_CHANNEL_AUTHENTICATION_CAPABILITIES 0x38
 339
 340 //
 341 //  Constants and Structure definitions for "Get Channel Authentication Capabilities" command to follow here
 342 //
 343
 344 //
 345 //  Definitions for Get Session Challenge command
 346 //
 347 #define IPMI_APP_GET_SESSION_CHALLENGE 0x39
 348
 349 //
 350 //  Constants and Structure definitions for "Get Session Challenge" command to follow here
 351 //
 352
 353 //
 354 //  Definitions for Activate Session command
 355 //
 356 #define IPMI_APP_ACTIVATE_SESSION  0x3A
 357
 358 //
 359 //  Constants and Structure definitions for "Activate Session" command to follow here
 360 //
 361
 362 //
 363 //  Definitions for Set Session Privelege Level command
 364 //
 365 #define IPMI_APP_SET_SESSION_PRIVELEGE_LEVEL 0x3B
 366
 367 //
 368 //  Constants and Structure definitions for "Set Session Privelege Level" command to follow here
 369 //
 370
 371 //
 372 //  Definitions for Close Session command
 373 //
 374 #define IPMI_APP_CLOSE_SESSION 0x3C
 375
 376 //
 377 //  Constants and Structure definitions for "Close Session" command to follow here
 378 //
 379
 380 //
 381 //  Definitions for Get Session Info command
 382 //
 383 #define IPMI_APP_GET_SESSION_INFO  0x3D
 384
 385 //
 386 //  Constants and Structure definitions for "Get Session Info" command to follow here
 387 //
 388
 389 //
 390 //  Definitions for Get Auth Code command
 391 //
 392 #define IPMI_APP_GET_AUTHCODE  0x3F
 393
 394 //
 395 //  Constants and Structure definitions for "Get AuthCode" command to follow here
 396 //
 397
 398 //
 399 //  Definitions for Set Channel Access command
 400 //
 401 #define IPMI_APP_SET_CHANNEL_ACCESS  0x40
 402
 403 //
 404 //  Constants and Structure definitions for "Set Channel Access" command to follow here
 405 //
 406
 407 //
 408 //  Definitions for Get Channel Access command
 409 //
 410 #define IPMI_APP_GET_CHANNEL_ACCESS  0x41
 411
 412 //
 413 //  Constants and Structure definitions for "Get Channel Access" command to follow here
 414 //
 415 typedef struct {
 416   UINT8 ChannelNo : 4;
 417   UINT8 Reserve1 : 4;
 418   UINT8 Reserve2 : 6;
 419   UINT8 MemoryType : 2;
 420 } IPMI_GET_CHANNEL_ACCESS_COMMAND;
 421
 422 typedef struct {
 423   UINT8 AccessMode : 3;
 424   UINT8 UserLevelAuthEnabled : 1;
 425   UINT8 MessageAuthEnable : 1;
 426   UINT8 Alert : 1;
 427   UINT8 Reserve1 : 2;
 428   UINT8 ChannelPriviledgeLimit : 4;
 429   UINT8 Reserve2 : 4;
 430 } IPMI_GET_CHANNEL_ACCESS_RESPONSE;
 431
 432 //
 433 //  Definitions for Get Channel Info command
 434 //
 435 #define IPMI_APP_GET_CHANNEL_INFO  0x42
 436
 437 //
 438 //  Constants and Structure definitions for "Get Channel Info" command to follow here
 439 //
 440 typedef struct {
 441   UINT8   ChannelNo : 4;
 442   UINT8   Reserve1 : 4;
 443   UINT8   ChannelMediumType : 7;
 444   UINT8   Reserve2 : 1;
 445   UINT8   ChannelProtocolType : 5;
 446   UINT8   Reserve3 : 3;
 447   UINT8   ActiveSessionCount : 6;
 448   UINT8   SessionSupport : 2;
 449   UINT32  VendorId : 24;
 450   UINT16  AuxChannelInfo : 16;
 451   UINT8   Dummy;
 452 } IPMI_CHANNEL_INFO;
 453
 454 //
 455 //  Definitions for Get Channel Info command
 456 //
 457 #define IPMI_APP_GET_CHANNEL_INFO  0x42
 458
 459 //
 460 //  Constants and Structure definitions for "Get Channel Info" command to follow here
 461 //
 462
 463 //
 464 //  Definitions for Set User Access command
 465 //
 466 #define IPMI_APP_SET_USER_ACCESS 0x43
 467
 468 //
 469 //  Constants and Structure definitions for "Set User Access" command to follow here
 470 //
 471
 472 //
 473 //  Definitions for Get User Access command
 474 //
 475 #define IPMI_APP_GET_USER_ACCESS 0x44
 476
 477 //
 478 //  Constants and Structure definitions for "Get User Access" command to follow here
 479 //
 480
 481 //
 482 //  Definitions for Set User Name command
 483 //
 484 #define IPMI_APP_SET_USER_NAME 0x45
 485
 486 //
 487 //  Constants and Structure definitions for "Set User Name" command to follow here
 488 //
 489
 490 //
 491 //  Definitions for Get User Name command
 492 //
 493 #define IPMI_APP_GET_USER_NAME 0x46
 494
 495 //
 496 //  Constants and Structure definitions for "Get User Name" command to follow here
 497 //
 498
 499 //
 500 //  Definitions for Set User Password command
 501 //
 502 #define IPMI_APP_SET_USER_PASSWORD 0x47
 503
 504 //
 505 //  Constants and Structure definitions for "Set User Password" command to follow here
 506 //
 507
 508 //
 509 //  Below is Definitions for RMCP+ Support and Payload Commands (Chapter 24)
 510 //
 511
 512 //
 513 //  Definitions for Activate Payload command
 514 //
 515 #define IPMI_APP_ACTIVATE_PAYLOAD  0x48
 516
 517 //
 518 //  Constants and Structure definitions for "Activate Payload" command to follow here
 519 //
 520
 521 //
 522 //  Definitions for De-Activate Payload command
 523 //
 524 #define IPMI_APP_DEACTIVATE_PAYLOAD  0x49
 525
 526 //
 527 //  Constants and Structure definitions for "DeActivate Payload" command to follow here
 528 //
 529
 530 //
 531 //  Definitions for Get Payload activation Status command
 532 //
 533 #define IPMI_APP_GET_PAYLOAD_ACTIVATION_STATUS 0x4a
 534
 535 //
 536 //  Constants and Structure definitions for "Get Payload activation Status" command to follow here
 537 //
 538
 539 //
 540 //  Definitions for Get Payload Instance Info command
 541 //
 542 #define IPMI_APP_GET_PAYLOAD_INSTANCE_INFO 0x4b
 543
 544 //
 545 //  Constants and Structure definitions for "Get Payload Instance Info" command to follow here
 546 //
 547
 548 //
 549 //  Definitions for Set User Payload Access command
 550 //
 551 #define IPMI_APP_SET_USER_PAYLOAD_ACCESS 0x4C
 552
 553 //
 554 //  Constants and Structure definitions for "Set User Payload Access" command to follow here
 555 //
 556
 557 //
 558 //  Definitions for Get User Payload Access command
 559 //
 560 #define IPMI_APP_GET_USER_PAYLOAD_ACCESS 0x4D
 561
 562 //
 563 //  Constants and Structure definitions for "Get User Payload Access" command to follow here
 564 //
 565
 566 //
 567 //  Definitions for Get Channel Payload Support command
 568 //
 569 #define IPMI_APP_GET_CHANNEL_PAYLOAD_SUPPORT 0x4E
 570
 571 //
 572 //  Constants and Structure definitions for "Get Channel Payload Support" command to follow here
 573 //
 574
 575 //
 576 //  Definitions for Get Channel Payload Version command
 577 //
 578 #define IPMI_APP_GET_CHANNEL_PAYLOAD_VERSION 0x4F
 579
 580 //
 581 //  Constants and Structure definitions for "Get Channel Payload Version" command to follow here
 582 //
 583
 584 //
 585 //  Definitions for Get Channel OEM Payload Info command
 586 //
 587 #define IPMI_APP_GET_CHANNEL_OEM_PAYLOAD_INFO  0x50
 588
 589 //
 590 //  Constants and Structure definitions for "Get Channel OEM Payload Info" command to follow here
 591 //
 592
 593 //
 594 //  Definitions for  Master Write-Read command
 595 //
 596 #define IPMI_APP_MASTER_WRITE_READ 0x52
 597
 598 //
 599 //  Constants and Structure definitions for "Master Write Read" command to follow here
 600 //
 601
 602 //
 603 //  Definitions for  Get Channel Cipher Suites command
 604 //
 605 #define IPMI_APP_GET_CHANNEL_CIPHER_SUITES 0x54
 606
 607 //
 608 //  Constants and Structure definitions for "Get Channel Cipher Suites" command to follow here
 609 //
 610
 611 //
 612 //  Below is Definitions for RMCP+ Support and Payload Commands (Chapter 24, Section 3)
 613 //
 614
 615 //
 616 //  Definitions for  Suspend-Resume Payload Encryption command
 617 //
 618 #define IPMI_APP_SUSPEND_RESUME_PAYLOAD_ENCRYPTION 0x55
 619
 620 //
 621 //  Constants and Structure definitions for "Suspend-Resume Payload Encryption" command to follow here
 622 //
 623
 624 //
 625 //  Below is Definitions for IPMI Messaging Support Commands (Chapter 22, Section 25 and 9)
 626 //
 627
 628 //
 629 //  Definitions for  Set Channel Security Keys command
 630 //
 631 #define IPMI_APP_SET_CHANNEL_SECURITY_KEYS 0x56
 632
 633 //
 634 //  Constants and Structure definitions for "Set Channel Security Keys" command to follow here
 635 //
 636
 637 //
 638 //  Definitions for  Get System Interface Capabilities command
 639 //
 640 #define IPMI_APP_GET_SYSTEM_INTERFACE_CAPABILITIES 0x57
 641
 642 //
 643 //  Constants and Structure definitions for "Get System Interface Capabilities" command to follow here
 644 //
 645
 646 #pragma pack()
 647 #endif