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 - 2015, 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
  42 //
  43 //  Definitions for Get Chassis Status command
  44 //
  45 #define IPMI_CHASSIS_GET_STATUS  0x01
  46
  47 //
  48 //  Constants and Structure definitions for "Get Chassis Status" command to follow here
  49 //
  50
  51 //
  52 //  Definitions for Chassis Control command
  53 //
  54 #define IPMI_CHASSIS_CONTROL 0x02
  55
  56 //
  57 //  Constants and Structure definitions for "Chassis Control" command to follow here
  58 //
  59
  60 //
  61 //  Definitions for Chassis Reset command
  62 //
  63 #define IPMI_CHASSIS_RESET 0x03
  64
  65 //
  66 //  Constants and Structure definitions for "Chassis Reset" command to follow here
  67 //
  68
  69 //
  70 //  Definitions for Chassis Identify command
  71 //
  72 #define IPMI_CHASSIS_IDENTIFY  0x04
  73
  74 //
  75 //  Constants and Structure definitions for "Chassis Identify" command to follow here
  76 //
  77
  78 //
  79 //  Definitions for Set Chassis Capabilities command
  80 //
  81 #define IPMI_CHASSIS_SET_CAPABILITIES  0x05
  82
  83 //
  84 //  Constants and Structure definitions for "Set Chassis Capabilities" command to follow here
  85 //
  86
  87 //
  88 //  Definitions for Set Power Restore Policy command
  89 //
  90 #define IPMI_CHASSIS_SET_POWER_RESTORE_POLICY  0x06
  91
  92 //
  93 //  Constants and Structure definitions for "Set Power Restore Policy" command to follow here
  94 //
  95
  96 //
  97 //  Definitions for Get System Restart Cause command
  98 //
  99 #define IPMI_CHASSIS_GET_SYSTEM_RESTART_CAUSE  0x07
 100
 101 //
 102 //  Constants and Structure definitions for "Get System Restart Cause" command to follow here
 103 //
 104 typedef enum {
 105   Unknown,
 106   ChassisControlCommand,
 107   ResetViaPushButton,
 108   PowerupViaPowerButton,
 109   WatchdogExpiration,
 110   Oem,
 111   AutoPowerOnAlwaysRestore,
 112   AutoPowerOnRestorePrevious,
 113   ResetViaPef,
 114   PowerCycleViaPef,
 115   SoftReset,
 116   PowerUpViaRtc
 117 } IPMI_SYSTEM_RESTART_CAUSE;
 118
 119 typedef struct {
 120   UINT8   Cause:4;
 121   UINT8   Reserved:4;
 122   UINT8   ChannelNumber;
 123 } GET_SYSTEM_RESTART_CAUSE_RESPONSE;
 124
 125 //
 126 //  Definitions for Set System BOOT options command
 127 //
 128 #define IPMI_CHASSIS_SET_SYSTEM_BOOT_OPTIONS 0x08
 129
 130 //
 131 //  Constants and Structure definitions for "Set System boot options" command to follow here
 132 //
 133 typedef struct {
 134   UINT8    ParameterSelector:7;
 135   UINT8    MarkParameterInvalid:1;
 136   UINT8    ParameterData[1];
 137 } IPMI_SET_BOOT_OPTIONS_REQUEST;
 138
 139 typedef struct {
 140   UINT8   CompletionCode:8;
 141 } IPMI_SET_BOOT_OPTIONS_RESPONSE;
 142
 143 //
 144 //  Definitions for Get System BOOT options command
 145 //
 146 #define IPMI_CHASSIS_GET_SYSTEM_BOOT_OPTIONS 0x09
 147
 148 //
 149 //  Constants and Structure definitions for "Get System boot options" command to follow here
 150 //
 151 typedef struct {
 152   UINT8 Parameter;
 153   UINT8 Valid;
 154   UINT8 Data1;
 155   UINT8 Data2;
 156   UINT8 Data3;
 157   UINT8 Data4;
 158   UINT8 Data5;
 159 } IPMI_GET_THE_SYSTEM_BOOT_OPTIONS;
 160
 161 typedef struct {
 162   UINT8   ParameterVersion;
 163   UINT8   ParameterValid;
 164   UINT8   ChannelNumber;
 165   UINT32  SessionId;
 166   UINT32  TimeStamp;
 167   UINT8   Reserved[3];
 168 } IPMI_BOOT_INITIATOR;
 169
 170 typedef struct {
 171   UINT8    ParameterSelector;
 172   UINT8    SetSelector;
 173   UINT8    BlockSelector;
 174 } IPMI_GET_BOOT_OPTIONS_REQUEST;
 175
 176 //
 177 // Response Parameters for IPMI Get Boot Options
 178 //
 179 typedef struct {
 180   UINT8   SetInProgress: 2;
 181   UINT8   Reserved: 6;
 182 } IPMI_BOOT_OPTIONS_RESPONSE_PARAMETER_0;
 183
 184 typedef struct {
 185   UINT8   ServicePartitionSelector;
 186 } IPMI_BOOT_OPTIONS_RESPONSE_PARAMETER_1;
 187
 188 typedef struct {
 189   UINT8   ServicePartitionDiscovered:1;
 190   UINT8   ServicePartitionScanRequest:1;
 191   UINT8   Reserved: 5;
 192 } IPMI_BOOT_OPTIONS_RESPONSE_PARAMETER_2;
 193
 194 typedef struct {
 195   UINT8   BmcBootFlagValid: 5;
 196   UINT8   Reserved: 3;
 197 } IPMI_BOOT_OPTIONS_RESPONSE_PARAMETER_3;
 198
 199 typedef struct {
 200   UINT8   WriteMask;
 201   UINT8   BootInitiatorAcknowledgeData;
 202 } IPMI_BOOT_OPTIONS_RESPONSE_PARAMETER_4;
 203
 204 #define BOOT_OPTION_HANDLED_BY_BIOS 0x01
 205
 206 typedef struct {
 207   //
 208   // Data 1
 209   //
 210   UINT8   Reserved0:6;
 211   UINT8   PersistentOptions:1;
 212   UINT8   BootFlagValid:1;
 213   //
 214   // Data 2
 215   //
 216   UINT8   LockReset:1;
 217   UINT8   ScreenBlank:1;
 218   UINT8   BootDeviceSelector:4;
 219   UINT8   LockKeyboard:1;
 220   UINT8   CmosClear:1;
 221   //
 222   //
 223   // Data 3
 224   UINT8   ConsoleRedirection:2;
 225   UINT8   LockSleep:1;
 226   UINT8   UserPasswordBypass:1;
 227   UINT8   ForceProgressEventTrap:1;
 228   UINT8   BiosVerbosity:2;
 229   UINT8   LockPower:1;
 230   //
 231   // Data 4
 232   //
 233   UINT8   BiosMuxControlOverride:2;
 234   UINT8   BiosSharedModeOverride:1;
 235   UINT8   Reserved1:4;
 236 } IPMI_BOOT_OPTIONS_RESPONSE_PARAMETER_5;
 237
 238 typedef struct {
 239   UINT8   ChannelNumber:4;
 240   UINT8   Reserved:4;
 241   UINT8   SessionId[4];
 242   UINT8   BootInfoTimeStamp[4];
 243 } IPMI_BOOT_OPTIONS_RESPONSE_PARAMETER_6;
 244
 245 typedef struct {
 246   UINT8   SetSelector;
 247   UINT8   BlockData[16];
 248 } IPMI_BOOT_OPTIONS_RESPONSE_PARAMETER_7;
 249
 250 typedef union {
 251   IPMI_BOOT_OPTIONS_RESPONSE_PARAMETER_0   Parm0;
 252   IPMI_BOOT_OPTIONS_RESPONSE_PARAMETER_1   Parm1;
 253   IPMI_BOOT_OPTIONS_RESPONSE_PARAMETER_2   Parm2;
 254   IPMI_BOOT_OPTIONS_RESPONSE_PARAMETER_3   Parm3;
 255   IPMI_BOOT_OPTIONS_RESPONSE_PARAMETER_4   Parm4;
 256   IPMI_BOOT_OPTIONS_RESPONSE_PARAMETER_5   Parm5;
 257   IPMI_BOOT_OPTIONS_RESPONSE_PARAMETER_6   Parm6;
 258   IPMI_BOOT_OPTIONS_RESPONSE_PARAMETER_7   Parm7;
 259 } IPMI_BOOT_OPTIONS_PARAMETERS;
 260
 261 typedef struct {
 262   UINT8    ParameterVersion:4;
 263   UINT8    Reserved:4;
 264   UINT8    ParameterSelector:7;
 265   UINT8    ParameterValid:1;
 266   UINT8    ParameterData[1];
 267 } IPMI_GET_BOOT_OPTIONS_RESPONSE;
 268
 269 //
 270 //  Definitions for Set front panel button enables command
 271 //
 272 #define IPMI_CHASSIS_SET_FP_BUTTON_ENABLES 0x0A
 273
 274 typedef struct {
 275   UINT8    DisablePoweroffButton:1;
 276   UINT8    DisableResetButton:1;
 277   UINT8    DisableDiagnosticInterruptButton:1;
 278   UINT8    DisableStandbyButton:1;
 279   UINT8    Reserved:4;
 280 } IPMI_SET_FRONT_PANEL_BUTTON_ENABLES_REQUEST;
 281
 282 //
 283 //  Constants and Structure definitions for "Set front panel button enables" command to follow here
 284 //
 285
 286 //
 287 //  Definitions for Set Power Cycle Interval command
 288 //
 289 #define IPMI_CHASSIS_SET_POWER_CYCLE_INTERVALS 0x0B
 290
 291 //
 292 //  Constants and Structure definitions for "Set Power Cycle Interval" command to follow here
 293 //
 294
 295 //
 296 //  Definitions for Get POH Counter command
 297 //
 298 #define IPMI_CHASSIS_GET_POH_COUNTER 0x0F
 299
 300 //
 301 //  Constants and Structure definitions for "Get POH Counter" command to follow here
 302 //
 303 #pragma pack()
 304 #endif