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 - 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 _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   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_GET_WATCHDOG_TIMER;
 211
 212 //
 213 //  Below is Definitions for IPMI Messaging Support Commands (Chapter 22)
 214 //
 215
 216 //
 217 //  Definitions for Set BMC Global Enables command
 218 //
 219 #define IPMI_APP_SET_BMC_GLOBAL_ENABLES  0x2E
 220
 221 //
 222 //  Constants and Structure definitions for "Set BMC Global Enables " command to follow here
 223 //
 224
 225 //
 226 //  Definitions for Get BMC Global Enables command
 227 //
 228 #define IPMI_APP_GET_BMC_GLOBAL_ENABLES  0x2F
 229
 230 //
 231 //  Constants and Structure definitions for "Get BMC Global Enables " command to follow here
 232 //
 233
 234 //
 235 //  Definitions for Clear Message Flags command
 236 //
 237 #define IPMI_APP_CLEAR_MESSAGE_FLAGS 0x30
 238
 239 //
 240 //  Constants and Structure definitions for "Clear Message Flags" command to follow here
 241 //
 242
 243 //
 244 //  Definitions for Get Message Flags command
 245 //
 246 #define IPMI_APP_GET_MESSAGE_FLAGS 0x31
 247
 248 //
 249 //  Constants and Structure definitions for "Get Message Flags" command to follow here
 250 //
 251
 252 //
 253 //  Definitions for Enable Message Channel Receive command
 254 //
 255 #define IPMI_APP_ENABLE_MESSAGE_CHANNEL_RECEIVE  0x32
 256
 257 //
 258 //  Constants and Structure definitions for "Enable Message Channel Receive" command to follow here
 259 //
 260
 261 //
 262 //  Definitions for Get Message command
 263 //
 264 #define IPMI_APP_GET_MESSAGE 0x33
 265
 266 //
 267 //  Constants and Structure definitions for "Get Message" command to follow here
 268 //
 269
 270 //
 271 //  Definitions for Send Message command
 272 //
 273 #define IPMI_APP_SEND_MESSAGE  0x34
 274
 275 //
 276 //  Constants and Structure definitions for "Send Message" command to follow here
 277 //
 278
 279 //
 280 //  Definitions for Read Event Message Buffer command
 281 //
 282 #define IPMI_APP_READ_EVENT_MSG_BUFFER 0x35
 283
 284 //
 285 //  Constants and Structure definitions for "Read Event Message Buffer" command to follow here
 286 //
 287
 288 //
 289 //  Definitions for Get BT Interface Capabilities command
 290 //
 291 #define IPMI_APP_GET_BT_INTERFACE_CAPABILITY 0x36
 292
 293 //
 294 //  Constants and Structure definitions for "Get BT Interface Capabilities" command to follow here
 295 //
 296
 297 //
 298 //  Definitions for Get System GUID command
 299 //
 300 #define IPMI_APP_GET_SYSTEM_GUID 0x37
 301
 302 //
 303 //  Constants and Structure definitions for "Get System GUID" command to follow here
 304 //
 305
 306 //
 307 //  Definitions for Get Channel Authentication Capabilities command
 308 //
 309 #define IPMI_APP_GET_CHANNEL_AUTHENTICATION_CAPABILITIES 0x38
 310
 311 //
 312 //  Constants and Structure definitions for "Get Channel Authentication Capabilities" command to follow here
 313 //
 314
 315 //
 316 //  Definitions for Get Session Challenge command
 317 //
 318 #define IPMI_APP_GET_SESSION_CHALLENGE 0x39
 319
 320 //
 321 //  Constants and Structure definitions for "Get Session Challenge" command to follow here
 322 //
 323
 324 //
 325 //  Definitions for Activate Session command
 326 //
 327 #define IPMI_APP_ACTIVATE_SESSION  0x3A
 328
 329 //
 330 //  Constants and Structure definitions for "Activate Session" command to follow here
 331 //
 332
 333 //
 334 //  Definitions for Set Session Privelege Level command
 335 //
 336 #define IPMI_APP_SET_SESSION_PRIVELEGE_LEVEL 0x3B
 337
 338 //
 339 //  Constants and Structure definitions for "Set Session Privelege Level" command to follow here
 340 //
 341
 342 //
 343 //  Definitions for Close Session command
 344 //
 345 #define IPMI_APP_CLOSE_SESSION 0x3C
 346
 347 //
 348 //  Constants and Structure definitions for "Close Session" command to follow here
 349 //
 350
 351 //
 352 //  Definitions for Get Session Info command
 353 //
 354 #define IPMI_APP_GET_SESSION_INFO  0x3D
 355
 356 //
 357 //  Constants and Structure definitions for "Get Session Info" command to follow here
 358 //
 359
 360 //
 361 //  Definitions for Get Auth Code command
 362 //
 363 #define IPMI_APP_GET_AUTHCODE  0x3F
 364
 365 //
 366 //  Constants and Structure definitions for "Get AuthCode" command to follow here
 367 //
 368
 369 //
 370 //  Definitions for Set Channel Access command
 371 //
 372 #define IPMI_APP_SET_CHANNEL_ACCESS  0x40
 373
 374 //
 375 //  Constants and Structure definitions for "Set Channel Access" command to follow here
 376 //
 377
 378 //
 379 //  Definitions for Get Channel Access command
 380 //
 381 #define IPMI_APP_GET_CHANNEL_ACCESS  0x41
 382
 383 //
 384 //  Constants and Structure definitions for "Get Channel Access" command to follow here
 385 //
 386 typedef struct {
 387   UINT8 ChannelNo : 4;
 388   UINT8 Reserve1 : 4;
 389   UINT8 Reserve2 : 6;
 390   UINT8 MemoryType : 2;
 391 } IPMI_GET_CHANNEL_ACCESS_COMMAND;
 392
 393 typedef struct {
 394   UINT8 AccessMode : 3;
 395   UINT8 UserLevelAuthEnabled : 1;
 396   UINT8 MessageAuthEnable : 1;
 397   UINT8 Alert : 1;
 398   UINT8 Reserve1 : 2;
 399   UINT8 ChannelPriviledgeLimit : 4;
 400   UINT8 Reserve2 : 4;
 401 } IPMI_GET_CHANNEL_ACCESS_RESPONSE;
 402
 403 //
 404 //  Definitions for Get Channel Info command
 405 //
 406 #define IPMI_APP_GET_CHANNEL_INFO  0x42
 407
 408 //
 409 //  Constants and Structure definitions for "Get Channel Info" command to follow here
 410 //
 411 typedef struct {
 412   UINT8   ChannelNo : 4;
 413   UINT8   Reserve1 : 4;
 414   UINT8   ChannelMediumType : 7;
 415   UINT8   Reserve2 : 1;
 416   UINT8   ChannelProtocolType : 5;
 417   UINT8   Reserve3 : 3;
 418   UINT8   ActiveSessionCount : 6;
 419   UINT8   SessionSupport : 2;
 420   UINT32  VendorId : 24;
 421   UINT16  AuxChannelInfo : 16;
 422   UINT8   Dummy;
 423 } IPMI_CHANNEL_INFO;
 424
 425 //
 426 //  Definitions for Get Channel Info command
 427 //
 428 #define IPMI_APP_GET_CHANNEL_INFO  0x42
 429
 430 //
 431 //  Constants and Structure definitions for "Get Channel Info" command to follow here
 432 //
 433
 434 //
 435 //  Definitions for Set User Access command
 436 //
 437 #define IPMI_APP_SET_USER_ACCESS 0x43
 438
 439 //
 440 //  Constants and Structure definitions for "Set User Access" command to follow here
 441 //
 442
 443 //
 444 //  Definitions for Get User Access command
 445 //
 446 #define IPMI_APP_GET_USER_ACCESS 0x44
 447
 448 //
 449 //  Constants and Structure definitions for "Get User Access" command to follow here
 450 //
 451
 452 //
 453 //  Definitions for Set User Name command
 454 //
 455 #define IPMI_APP_SET_USER_NAME 0x45
 456
 457 //
 458 //  Constants and Structure definitions for "Set User Name" command to follow here
 459 //
 460
 461 //
 462 //  Definitions for Get User Name command
 463 //
 464 #define IPMI_APP_GET_USER_NAME 0x46
 465
 466 //
 467 //  Constants and Structure definitions for "Get User Name" command to follow here
 468 //
 469
 470 //
 471 //  Definitions for Set User Password command
 472 //
 473 #define IPMI_APP_SET_USER_PASSWORD 0x47
 474
 475 //
 476 //  Constants and Structure definitions for "Set User Password" command to follow here
 477 //
 478
 479 //
 480 //  Below is Definitions for RMCP+ Support and Payload Commands (Chapter 24)
 481 //
 482
 483 //
 484 //  Definitions for Activate Payload command
 485 //
 486 #define IPMI_APP_ACTIVATE_PAYLOAD  0x48
 487
 488 //
 489 //  Constants and Structure definitions for "Activate Payload" command to follow here
 490 //
 491
 492 //
 493 //  Definitions for De-Activate Payload command
 494 //
 495 #define IPMI_APP_DEACTIVATE_PAYLOAD  0x49
 496
 497 //
 498 //  Constants and Structure definitions for "DeActivate Payload" command to follow here
 499 //
 500
 501 //
 502 //  Definitions for Get Payload activation Status command
 503 //
 504 #define IPMI_APP_GET_PAYLOAD_ACTIVATION_STATUS 0x4a
 505
 506 //
 507 //  Constants and Structure definitions for "Get Payload activation Status" command to follow here
 508 //
 509
 510 //
 511 //  Definitions for Get Payload Instance Info command
 512 //
 513 #define IPMI_APP_GET_PAYLOAD_INSTANCE_INFO 0x4b
 514
 515 //
 516 //  Constants and Structure definitions for "Get Payload Instance Info" command to follow here
 517 //
 518
 519 //
 520 //  Definitions for Set User Payload Access command
 521 //
 522 #define IPMI_APP_SET_USER_PAYLOAD_ACCESS 0x4C
 523
 524 //
 525 //  Constants and Structure definitions for "Set User Payload Access" command to follow here
 526 //
 527
 528 //
 529 //  Definitions for Get User Payload Access command
 530 //
 531 #define IPMI_APP_GET_USER_PAYLOAD_ACCESS 0x4D
 532
 533 //
 534 //  Constants and Structure definitions for "Get User Payload Access" command to follow here
 535 //
 536
 537 //
 538 //  Definitions for Get Channel Payload Support command
 539 //
 540 #define IPMI_APP_GET_CHANNEL_PAYLOAD_SUPPORT 0x4E
 541
 542 //
 543 //  Constants and Structure definitions for "Get Channel Payload Support" command to follow here
 544 //
 545
 546 //
 547 //  Definitions for Get Channel Payload Version command
 548 //
 549 #define IPMI_APP_GET_CHANNEL_PAYLOAD_VERSION 0x4F
 550
 551 //
 552 //  Constants and Structure definitions for "Get Channel Payload Version" command to follow here
 553 //
 554
 555 //
 556 //  Definitions for Get Channel OEM Payload Info command
 557 //
 558 #define IPMI_APP_GET_CHANNEL_OEM_PAYLOAD_INFO  0x50
 559
 560 //
 561 //  Constants and Structure definitions for "Get Channel OEM Payload Info" command to follow here
 562 //
 563
 564 //
 565 //  Definitions for  Master Write-Read command
 566 //
 567 #define IPMI_APP_MASTER_WRITE_READ 0x52
 568
 569 //
 570 //  Constants and Structure definitions for "Master Write Read" command to follow here
 571 //
 572
 573 //
 574 //  Definitions for  Get Channel Cipher Suites command
 575 //
 576 #define IPMI_APP_GET_CHANNEL_CIPHER_SUITES 0x54
 577
 578 //
 579 //  Constants and Structure definitions for "Get Channel Cipher Suites" command to follow here
 580 //
 581
 582 //
 583 //  Below is Definitions for RMCP+ Support and Payload Commands (Chapter 24, Section 3)
 584 //
 585
 586 //
 587 //  Definitions for  Suspend-Resume Payload Encryption command
 588 //
 589 #define IPMI_APP_SUSPEND_RESUME_PAYLOAD_ENCRYPTION 0x55
 590
 591 //
 592 //  Constants and Structure definitions for "Suspend-Resume Payload Encryption" command to follow here
 593 //
 594
 595 //
 596 //  Below is Definitions for IPMI Messaging Support Commands (Chapter 22, Section 25 and 9)
 597 //
 598
 599 //
 600 //  Definitions for  Set Channel Security Keys command
 601 //
 602 #define IPMI_APP_SET_CHANNEL_SECURITY_KEYS 0x56
 603
 604 //
 605 //  Constants and Structure definitions for "Set Channel Security Keys" command to follow here
 606 //
 607
 608 //
 609 //  Definitions for  Get System Interface Capabilities command
 610 //
 611 #define IPMI_APP_GET_SYSTEM_INTERFACE_CAPABILITIES 0x57
 612
 613 //
 614 //  Constants and Structure definitions for "Get System Interface Capabilities" command to follow here
 615 //
 616
 617 #pragma pack()
 618 #endif