MdePkg/Include/IndustryStandard/IpmiNetFnChassis.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 Chassis commands, including:
   5     Chassis Commands (Chapter 28)
   6
   7   See IPMI specification, Appendix G, Command Assignments
   8   and Appendix H, Sub-function Assignments.
   9
  10   Copyright (c) 1999 - 2018, Intel Corporation. All rights reserved.<BR>
  11   This program and the accompanying materials
  12   are licensed and made available under the terms and conditions of the BSD License
  13   which accompanies this distribution.  The full text of the license may be found at
  14   http://opensource.org/licenses/bsd-license.php
  15
  16   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  17   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  18 **/
  19
  20 #ifndef _IPMI_NET_FN_CHASSIS_H_
  21 #define _IPMI_NET_FN_CHASSIS_H_
  22
  23 #pragma pack (1)
  24 //
  25 // Net function definition for Chassis command
  26 //
  27 #define IPMI_NETFN_CHASSIS  0x00
  28
  29 //
  30 //  Below is Definitions for Chassis commands (Chapter 28)
  31 //
  32
  33 //
  34 //  Definitions for Get Chassis Capabilities command
  35 //
  36 #define IPMI_CHASSIS_GET_CAPABILITIES  0x00
  37
  38 //
  39 //  Constants and Structure definitions for "Get Chassis Capabilities" command to follow here
  40 //
  41 typedef struct {
  42   UINT8   CompletionCode;
  43   UINT8   CapabilitiesFlags;
  44   UINT8   ChassisFruInfoDeviceAddress;
  45   UINT8   ChassisSDRDeviceAddress;
  46   UINT8   ChassisSELDeviceAddress;
  47   UINT8   ChassisSystemManagementDeviceAddress;
  48   UINT8   ChassisBridgeDeviceAddress;
  49 } IPMI_GET_CHASSIS_CAPABILITIES_RESPONSE;
  50
  51 //
  52 //  Definitions for Get Chassis Status command
  53 //
  54 #define IPMI_CHASSIS_GET_STATUS  0x01
  55
  56 //
  57 //  Constants and Structure definitions for "Get Chassis Status" command to follow here
  58 //
  59 typedef struct {
  60   UINT8   CompletionCode;
  61   UINT8   CurrentPowerState;
  62   UINT8   LastPowerEvent;
  63   UINT8   MiscChassisState;
  64   UINT8   FrontPanelButtonCapabilities;
  65 } IPMI_GET_CHASSIS_STATUS_RESPONSE;
  66
  67 //
  68 //  Definitions for Chassis Control command
  69 //
  70 #define IPMI_CHASSIS_CONTROL 0x02
  71
  72 //
  73 //  Constants and Structure definitions for "Chassis Control" command to follow here
  74 //
  75 typedef union {
  76   struct {
  77     UINT8  ChassisControl:4;
  78     UINT8  Reserved:4;
  79   } Bits;
  80   UINT8  Uint8;
  81 } IPMI_CHASSIS_CONTROL_CHASSIS_CONTROL;
  82
  83 typedef struct {
  84   IPMI_CHASSIS_CONTROL_CHASSIS_CONTROL  ChassisControl;
  85 } IPMI_CHASSIS_CONTROL_REQUEST;
  86
  87 //
  88 //  Definitions for Chassis Reset command
  89 //
  90 #define IPMI_CHASSIS_RESET 0x03
  91
  92 //
  93 //  Constants and Structure definitions for "Chassis Reset" command to follow here
  94 //
  95
  96 //
  97 //  Definitions for Chassis Identify command
  98 //
  99 #define IPMI_CHASSIS_IDENTIFY  0x04
 100
 101 //
 102 //  Constants and Structure definitions for "Chassis Identify" command to follow here
 103 //
 104
 105 //
 106 //  Definitions for Set Chassis Capabilities command
 107 //
 108 #define IPMI_CHASSIS_SET_CAPABILITIES  0x05
 109
 110 //
 111 //  Constants and Structure definitions for "Set Chassis Capabilities" command to follow here
 112 //
 113
 114 //
 115 //  Definitions for Set Power Restore Policy command
 116 //
 117 #define IPMI_CHASSIS_SET_POWER_RESTORE_POLICY  0x06
 118
 119 //
 120 //  Constants and Structure definitions for "Set Power Restore Policy" command to follow here
 121 //
 122 typedef union {
 123   struct {
 124     UINT8  PowerRestorePolicy : 3;
 125     UINT8  Reserved : 5;
 126   } Bits;
 127   UINT8  Uint8;
 128 } IPMI_POWER_RESTORE_POLICY;
 129
 130 typedef struct {
 131   IPMI_POWER_RESTORE_POLICY  PowerRestorePolicy;
 132 } IPMI_SET_POWER_RESTORE_POLICY_REQUEST;
 133
 134 typedef struct {
 135   UINT8   CompletionCode;
 136   UINT8   PowerRestorePolicySupport;
 137 } IPMI_SET_POWER_RESTORE_POLICY_RESPONSE;
 138
 139 //
 140 //  Definitions for Get System Restart Cause command
 141 //
 142 #define IPMI_CHASSIS_GET_SYSTEM_RESTART_CAUSE  0x07
 143
 144 //
 145 //  Constants and Structure definitions for "Get System Restart Cause" command to follow here
 146 //
 147 #define IPMI_SYSTEM_RESTART_CAUSE_UNKNOWN                    0x0
 148 #define IPMI_SYSTEM_RESTART_CAUSE_CHASSIS_CONTROL_COMMAND    0x1
 149 #define IPMI_SYSTEM_RESTART_CAUSE_PUSHBUTTON_RESET           0x2
 150 #define IPMI_SYSTEM_RESTART_CAUSE_PUSHBUTTON_POWERUP         0x3
 151 #define IPMI_SYSTEM_RESTART_CAUSE_WATCHDOG_EXPIRE            0x4
 152 #define IPMI_SYSTEM_RESTART_CAUSE_OEM                        0x5
 153 #define IPMI_SYSTEM_RESTART_CAUSE_AUTO_POWER_ALWAYS_RESTORE  0x6
 154 #define IPMI_SYSTEM_RESTART_CAUSE_AUTO_POWER_RESTORE_PREV    0x7
 155 #define IPMI_SYSTEM_RESTART_CAUSE_PEF_RESET                  0x8
 156 #define IPMI_SYSTEM_RESTART_CAUSE_PEF_POWERCYCLE             0x9
 157 #define IPMI_SYSTEM_RESTART_CAUSE_SOFT_RESET                 0xA
 158 #define IPMI_SYSTEM_RESTART_CAUSE_RTC_POWERUP                0xB
 159
 160 typedef union {
 161   struct {
 162     UINT8  Cause:4;
 163     UINT8  Reserved:4;
 164   } Bits;
 165   UINT8  Uint8;
 166 } IPMI_SYSTEM_RESTART_CAUSE;
 167
 168 typedef struct {
 169   UINT8                      CompletionCode;
 170   IPMI_SYSTEM_RESTART_CAUSE  RestartCause;
 171   UINT8                      ChannelNumber;
 172 } IPMI_GET_SYSTEM_RESTART_CAUSE_RESPONSE;
 173
 174 //
 175 //  Definitions for Set System BOOT options command
 176 //
 177 #define IPMI_CHASSIS_SET_SYSTEM_BOOT_OPTIONS 0x08
 178
 179 //
 180 //  Constants and Structure definitions for "Set System boot options" command to follow here
 181 //
 182 typedef union {
 183   struct {
 184     UINT8  ParameterSelector:7;
 185     UINT8  MarkParameterInvalid:1;
 186   } Bits;
 187   UINT8  Uint8;
 188 } IPMI_SET_BOOT_OPTIONS_PARAMETER_VALID;
 189
 190 typedef struct {
 191   IPMI_SET_BOOT_OPTIONS_PARAMETER_VALID  ParameterValid;
 192   UINT8                                  ParameterData[0];
 193 } IPMI_SET_BOOT_OPTIONS_REQUEST;
 194
 195 //
 196 //  Definitions for Get System Boot options command
 197 //
 198 #define IPMI_CHASSIS_GET_SYSTEM_BOOT_OPTIONS 0x09
 199
 200 //
 201 //  Constants and Structure definitions for "Get System boot options" command to follow here
 202 //
 203 typedef union {
 204   struct {
 205     UINT8  ParameterSelector:7;
 206     UINT8  Reserved:1;
 207   } Bits;
 208   UINT8  Uint8;
 209 } IPMI_GET_BOOT_OPTIONS_PARAMETER_SELECTOR;
 210
 211 typedef struct {
 212   IPMI_GET_BOOT_OPTIONS_PARAMETER_SELECTOR  ParameterSelector;
 213   UINT8                                     SetSelector;
 214   UINT8                                     BlockSelector;
 215 } IPMI_GET_BOOT_OPTIONS_REQUEST;
 216
 217 typedef struct {
 218   UINT8 Parameter;
 219   UINT8 Valid;
 220   UINT8 Data1;
 221   UINT8 Data2;
 222   UINT8 Data3;
 223   UINT8 Data4;
 224   UINT8 Data5;
 225 } IPMI_GET_THE_SYSTEM_BOOT_OPTIONS;
 226
 227 typedef struct {
 228   UINT8   ParameterVersion;
 229   UINT8   ParameterValid;
 230   UINT8   ChannelNumber;
 231   UINT32  SessionId;
 232   UINT32  TimeStamp;
 233   UINT8   Reserved[3];
 234 } IPMI_BOOT_INITIATOR;
 235
 236 //
 237 // Definitions for boot option parameter selector
 238 //
 239 #define IPMI_BOOT_OPTIONS_PARAMETER_SELECTOR_SET_IN_PROGRESS             0x0
 240 #define IPMI_BOOT_OPTIONS_PARAMETER_SELECTOR_SERVICE_PARTITION_SELECTOR  0x1
 241 #define IPMI_BOOT_OPTIONS_PARAMETER_SELECTOR_SERVICE_PARTITION_SCAN      0x2
 242 #define IPMI_BOOT_OPTIONS_PARAMETER_SELECTOR_BMC_BOOT_FLAG               0x3
 243 #define IPMI_BOOT_OPTIONS_PARAMETER_BOOT_INFO_ACK                        0x4
 244 #define IPMI_BOOT_OPTIONS_PARAMETER_BOOT_FLAGS                           0x5
 245 #define IPMI_BOOT_OPTIONS_PARAMETER_BOOT_INITIATOR_INFO                  0x6
 246 #define IPMI_BOOT_OPTIONS_PARAMETER_BOOT_INITIATOR_MAILBOX               0x7
 247 #define IPMI_BOOT_OPTIONS_PARAMETER_OEM_BEGIN                            0x60
 248 #define IPMI_BOOT_OPTIONS_PARAMETER_OEM_END                              0x7F
 249
 250 //
 251 // Response Parameters for IPMI Get Boot Options
 252 //
 253 typedef union {
 254   struct {
 255     UINT8  SetInProgress : 2;
 256     UINT8  Reserved : 6;
 257   } Bits;
 258   UINT8  Uint8;
 259 } IPMI_BOOT_OPTIONS_RESPONSE_PARAMETER_0;
 260
 261 typedef struct {
 262   UINT8   ServicePartitionSelector;
 263 } IPMI_BOOT_OPTIONS_RESPONSE_PARAMETER_1;
 264
 265 typedef union {
 266   struct {
 267     UINT8  ServicePartitionDiscovered : 1;
 268     UINT8  ServicePartitionScanRequest : 1;
 269     UINT8  Reserved: 6;
 270   } Bits;
 271   UINT8  Uint8;
 272 } IPMI_BOOT_OPTIONS_RESPONSE_PARAMETER_2;
 273
 274 typedef union {
 275   struct {
 276     UINT8  BmcBootFlagValid : 5;
 277     UINT8  Reserved : 3;
 278   } Bits;
 279   UINT8  Uint8;
 280 } IPMI_BOOT_OPTIONS_RESPONSE_PARAMETER_3;
 281
 282 typedef struct {
 283   UINT8   WriteMask;
 284   UINT8   BootInitiatorAcknowledgeData;
 285 } IPMI_BOOT_OPTIONS_RESPONSE_PARAMETER_4;
 286
 287 //
 288 //  Definitions for the 'Boot device selector' field of Boot Option Parameters #5
 289 //
 290 #define IPMI_BOOT_DEVICE_SELECTOR_NO_OVERRIDE           0x0
 291 #define IPMI_BOOT_DEVICE_SELECTOR_PXE                   0x1
 292 #define IPMI_BOOT_DEVICE_SELECTOR_HARDDRIVE             0x2
 293 #define IPMI_BOOT_DEVICE_SELECTOR_HARDDRIVE_SAFE_MODE   0x3
 294 #define IPMI_BOOT_DEVICE_SELECTOR_DIAGNOSTIC_PARTITION  0x4
 295 #define IPMI_BOOT_DEVICE_SELECTOR_CD_DVD                0x5
 296 #define IPMI_BOOT_DEVICE_SELECTOR_BIOS_SETUP            0x6
 297 #define IPMI_BOOT_DEVICE_SELECTOR_REMOTE_FLOPPY         0x7
 298 #define IPMI_BOOT_DEVICE_SELECTOR_REMOTE_CD_DVD         0x8
 299 #define IPMI_BOOT_DEVICE_SELECTOR_PRIMARY_REMOTE_MEDIA  0x9
 300 #define IPMI_BOOT_DEVICE_SELECTOR_REMOTE_HARDDRIVE      0xB
 301 #define IPMI_BOOT_DEVICE_SELECTOR_FLOPPY                0xF
 302
 303 #define BOOT_OPTION_HANDLED_BY_BIOS 0x01
 304
 305 //
 306 //  Constant definitions for the 'BIOS Mux Control Override' field of Boot Option Parameters #5
 307 //
 308 #define BIOS_MUX_CONTROL_OVERRIDE_RECOMMEND_SETTING    0x00
 309 #define BIOS_MUX_CONTROL_OVERRIDE_FORCE_TO_BMC         0x01
 310 #define BIOS_MUX_CONTROL_OVERRIDE_FORCE_TO_SYSTEM      0x02
 311
 312 typedef union {
 313   struct {
 314     UINT8  Reserved:5;
 315     UINT8  BiosBootType:1;
 316     UINT8  PersistentOptions:1;
 317     UINT8  BootFlagValid:1;
 318   } Bits;
 319   UINT8  Uint8;
 320 } IPMI_BOOT_OPTIONS_RESPONSE_PARAMETER_5_DATA_1;
 321
 322 typedef union {
 323   struct {
 324     UINT8  LockReset:1;
 325     UINT8  ScreenBlank:1;
 326     UINT8  BootDeviceSelector:4;
 327     UINT8  LockKeyboard:1;
 328     UINT8  CmosClear:1;
 329   } Bits;
 330   UINT8  Uint8;
 331 } IPMI_BOOT_OPTIONS_RESPONSE_PARAMETER_5_DATA_2;
 332
 333 typedef union {
 334   struct {
 335     UINT8  ConsoleRedirection:2;
 336     UINT8  LockSleep:1;
 337     UINT8  UserPasswordBypass:1;
 338     UINT8  ForceProgressEventTrap:1;
 339     UINT8  BiosVerbosity:2;
 340     UINT8  LockPower:1;
 341   } Bits;
 342   UINT8  Uint8;
 343 } IPMI_BOOT_OPTIONS_RESPONSE_PARAMETER_5_DATA_3;
 344
 345 typedef union {
 346   struct {
 347     UINT8  BiosMuxControlOverride:3;
 348     UINT8  BiosSharedModeOverride:1;
 349     UINT8  Reserved:4;
 350   } Bits;
 351   UINT8  Uint8;
 352 } IPMI_BOOT_OPTIONS_RESPONSE_PARAMETER_5_DATA_4;
 353
 354 typedef union {
 355   struct {
 356     UINT8  DeviceInstanceSelector:5;
 357     UINT8  Reserved:3;
 358   } Bits;
 359   UINT8  Uint8;
 360 } IPMI_BOOT_OPTIONS_RESPONSE_PARAMETER_5_DATA_5;
 361
 362 typedef struct {
 363   IPMI_BOOT_OPTIONS_RESPONSE_PARAMETER_5_DATA_1  Data1;
 364   IPMI_BOOT_OPTIONS_RESPONSE_PARAMETER_5_DATA_2  Data2;
 365   IPMI_BOOT_OPTIONS_RESPONSE_PARAMETER_5_DATA_3  Data3;
 366   IPMI_BOOT_OPTIONS_RESPONSE_PARAMETER_5_DATA_4  Data4;
 367   IPMI_BOOT_OPTIONS_RESPONSE_PARAMETER_5_DATA_5  Data5;
 368 } IPMI_BOOT_OPTIONS_RESPONSE_PARAMETER_5;
 369
 370 typedef union {
 371   struct {
 372     UINT8  ChannelNumber:4;
 373     UINT8  Reserved:4;
 374   } Bits;
 375   UINT8  Uint8;
 376 } IPMI_BOOT_OPTIONS_CHANNEL_NUMBER;
 377
 378 typedef struct {
 379   IPMI_BOOT_OPTIONS_CHANNEL_NUMBER  ChannelNumber;
 380   UINT8                             SessionId[4];
 381   UINT8                             BootInfoTimeStamp[4];
 382 } IPMI_BOOT_OPTIONS_RESPONSE_PARAMETER_6;
 383
 384 typedef struct {
 385   UINT8   SetSelector;
 386   UINT8   BlockData[16];
 387 } IPMI_BOOT_OPTIONS_RESPONSE_PARAMETER_7;
 388
 389 typedef union {
 390   IPMI_BOOT_OPTIONS_RESPONSE_PARAMETER_0   Parm0;
 391   IPMI_BOOT_OPTIONS_RESPONSE_PARAMETER_1   Parm1;
 392   IPMI_BOOT_OPTIONS_RESPONSE_PARAMETER_2   Parm2;
 393   IPMI_BOOT_OPTIONS_RESPONSE_PARAMETER_3   Parm3;
 394   IPMI_BOOT_OPTIONS_RESPONSE_PARAMETER_4   Parm4;
 395   IPMI_BOOT_OPTIONS_RESPONSE_PARAMETER_5   Parm5;
 396   IPMI_BOOT_OPTIONS_RESPONSE_PARAMETER_6   Parm6;
 397   IPMI_BOOT_OPTIONS_RESPONSE_PARAMETER_7   Parm7;
 398 } IPMI_BOOT_OPTIONS_PARAMETERS;
 399
 400 typedef union {
 401   struct {
 402     UINT8  ParameterVersion:4;
 403     UINT8  Reserved:4;
 404   } Bits;
 405   UINT8  Uint8;
 406 } IPMI_GET_BOOT_OPTIONS_PARAMETER_VERSION;
 407
 408 typedef union {
 409   struct {
 410     UINT8  ParameterSelector:7;
 411     UINT8  ParameterValid:1;
 412   } Bits;
 413   UINT8  Uint8;
 414 } IPMI_GET_BOOT_OPTIONS_PARAMETER_VALID;
 415
 416 typedef struct {
 417   UINT8                                    CompletionCode;
 418   IPMI_GET_BOOT_OPTIONS_PARAMETER_VERSION  ParameterVersion;
 419   IPMI_GET_BOOT_OPTIONS_PARAMETER_VALID    ParameterValid;
 420   UINT8                                    ParameterData[0];
 421 } IPMI_GET_BOOT_OPTIONS_RESPONSE;
 422
 423 //
 424 //  Definitions for Set front panel button enables command
 425 //
 426 #define IPMI_CHASSIS_SET_FRONT_PANEL_BUTTON_ENABLES 0x0A
 427
 428 //
 429 //  Constants and Structure definitions for "Set front panel button enables" command to follow here
 430 //
 431 typedef union {
 432   struct {
 433     UINT8  DisablePoweroffButton:1;
 434     UINT8  DisableResetButton:1;
 435     UINT8  DisableDiagnosticInterruptButton:1;
 436     UINT8  DisableStandbyButton:1;
 437     UINT8  Reserved:4;
 438   } Bits;
 439   UINT8  Uint8;
 440 } IPMI_FRONT_PANEL_BUTTON_ENABLES;
 441
 442 typedef struct {
 443   IPMI_FRONT_PANEL_BUTTON_ENABLES  FrontPanelButtonEnables;
 444 } IPMI_CHASSIS_SET_FRONT_PANEL_BUTTON_ENABLES_REQUEST;
 445
 446 //
 447 //  Definitions for Set Power Cycle Interval command
 448 //
 449 #define IPMI_CHASSIS_SET_POWER_CYCLE_INTERVALS 0x0B
 450
 451 //
 452 //  Constants and Structure definitions for "Set Power Cycle Interval" command to follow here
 453 //
 454
 455 //
 456 //  Definitions for Get POH Counter command
 457 //
 458 #define IPMI_CHASSIS_GET_POH_COUNTER 0x0F
 459
 460 //
 461 //  Constants and Structure definitions for "Get POH Counter" command to follow here
 462 //
 463 #pragma pack()
 464 #endif