[mirror_edk2.git] / MdePkg / Include / IndustryStandard / IpmiNetFnTransport.h

/** @file\r
  IPMI 2.0 definitions from the IPMI Specification Version 2.0, Revision 1.1.\r
\r
  This file contains all NetFn Transport commands, including:\r
    IPM LAN Commands (Chapter 23)\r
    IPMI Serial/Modem Commands (Chapter 25)\r
    SOL Commands (Chapter 26)\r
    Command Forwarding Commands (Chapter 35b)\r
\r
  See IPMI specification, Appendix G, Command Assignments\r
  and Appendix H, Sub-function Assignments.\r
\r
  Copyright (c) 1999 - 2018, Intel Corporation. All rights reserved.<BR>\r
  This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
**/\r
\r
#ifndef _IPMI_NET_FN_TRANSPORT_H_\r
#define _IPMI_NET_FN_TRANSPORT_H_\r
\r
#pragma pack(1)\r
//\r
// Net function definition for Transport command\r
//\r
#define IPMI_NETFN_TRANSPORT  0x0C\r
\r
//\r
//  Below is Definitions for IPM LAN Commands (Chapter 23)\r
//\r
\r
//\r
//  Definitions for Set Lan Configuration Parameters command\r
//\r
#define IPMI_TRANSPORT_SET_LAN_CONFIG_PARAMETERS 0x01\r
\r
//\r
//  Constants and Structure definitions for "Set Lan Configuration Parameters" command to follow here\r
//\r
\r
//\r
// LAN Management Structure\r
//\r
typedef enum {\r
  IpmiLanReserved1,\r
  IpmiLanReserved2,\r
  IpmiLanAuthType,\r
  IpmiLanIpAddress,\r
  IpmiLanIpAddressSource,\r
  IpmiLanMacAddress,\r
  IpmiLanSubnetMask,\r
  IpmiLanIpv4HeaderParam,\r
  IpmiLanPrimaryRcmpPort,\r
  IpmiLanSecondaryRcmpPort,\r
  IpmiLanBmcGeneratedArpCtrl,\r
  IpmiLanArpInterval,\r
  IpmiLanDefaultGateway,\r
  IpmiLanDefaultGatewayMac,\r
  IpmiLanBackupGateway,\r
  IpmiLanBackupGatewayMac,\r
  IpmiLanCommunityString,\r
  IpmiLanReserved3,\r
  IpmiLanDestinationType,\r
  IpmiLanDestinationAddress,\r
  IpmiIpv4OrIpv6Support = 0x32,\r
  IpmiIpv4OrIpv6AddressEnable,\r
  IpmiIpv6HdrStatTrafficClass,\r
  IpmiIpv6HdrStatHopLimit,\r
  IpmiIpv6HdrFlowLabel,\r
  IpmiIpv6Status,\r
  IpmiIpv6StaticAddress,\r
  IpmiIpv6DhcpStaticDuidLen,\r
  IpmiIpv6DhcpStaticDuid,\r
  IpmiIpv6DhcpAddress,\r
  IpmiIpv6DhcpDynamicDuidLen,\r
  IpmiIpv6DhcpDynamicDuid,\r
  IpmiIpv6RouterConfig = 0x40,\r
  IpmiIpv6StaticRouter1IpAddr,\r
  IpmiIpv6DynamicRouterIpAddr = 0x4a\r
} IPMI_LAN_OPTION_TYPE;\r
\r
//\r
// IP Address Source\r
//\r
typedef enum {\r
  IpmiUnspecified,\r
  IpmiStaticAddrsss,\r
  IpmiDynamicAddressBmcDhcp,\r
  IpmiDynamicAddressBiosDhcp,\r
  IpmiDynamicAddressBmcNonDhcp\r
} IPMI_IP_ADDRESS_SRC;\r
\r
//\r
// Destination Type\r
//\r
typedef enum {\r
  IpmiPetTrapDestination,\r
  IpmiDirectedEventDestination,\r
  IpmiReserved1,\r
  IpmiReserved2,\r
  IpmiReserved3,\r
  IpmiReserved4,\r
  IpmiReserved5,\r
  IpmiOem1,\r
  IpmiOem2\r
} IPMI_LAN_DEST_TYPE_DEST_TYPE;\r
\r
typedef union {\r
  struct {\r
    UINT8  NoAuth : 1;\r
    UINT8  MD2Auth : 1;\r
    UINT8  MD5Auth : 1;\r
    UINT8  Reserved1 : 1;\r
    UINT8  StraightPswd : 1;\r
    UINT8  OemType : 1;\r
    UINT8  Reserved2 : 2;\r
  } Bits;\r
  UINT8  Uint8;\r
} IPMI_LAN_AUTH_TYPE;\r
\r
typedef struct {\r
  UINT8 IpAddress[4];\r
} IPMI_LAN_IP_ADDRESS;\r
\r
typedef union {\r
  struct {\r
    UINT8  AddressSrc : 4;\r
    UINT8  Reserved : 4;\r
  } Bits;\r
  UINT8  Uint8;\r
} IPMI_LAN_IP_ADDRESS_SRC;\r
\r
typedef struct {\r
  UINT8 MacAddress[6];\r
} IPMI_LAN_MAC_ADDRESS;\r
\r
typedef struct {\r
  UINT8 IpAddress[4];\r
} IPMI_LAN_SUBNET_MASK;\r
\r
typedef union {\r
  struct {\r
    UINT8  IpFlag : 3;\r
    UINT8  Reserved : 5;\r
  } Bits;\r
  UINT8  Uint8;\r
} IPMI_LAN_IPV4_HDR_PARAM_DATA_2;\r
\r
typedef union {\r
  struct {\r
    UINT8  Precedence : 3;\r
    UINT8  Reserved : 1;\r
    UINT8  ServiceType : 4;\r
  } Bits;\r
  UINT8  Uint8;\r
} IPMI_LAN_IPV4_HDR_PARAM_DATA_3;\r
\r
typedef struct {\r
  UINT8                           TimeToLive;\r
  IPMI_LAN_IPV4_HDR_PARAM_DATA_2  Data2;\r
  IPMI_LAN_IPV4_HDR_PARAM_DATA_3  Data3;\r
} IPMI_LAN_IPV4_HDR_PARAM;\r
\r
typedef struct {\r
  UINT8 RcmpPortMsb;\r
  UINT8 RcmpPortLsb;\r
} IPMI_LAN_RCMP_PORT;\r
\r
typedef union {\r
  struct {\r
    UINT8  EnableBmcArpResponse : 1;\r
    UINT8  EnableBmcGratuitousArp : 1;\r
    UINT8  Reserved : 6;\r
  } Bits;\r
  UINT8  Uint8;\r
} IPMI_LAN_BMC_GENERATED_ARP_CONTROL;\r
\r
typedef struct {\r
  UINT8 ArpInterval;\r
} IPMI_LAN_ARP_INTERVAL;\r
\r
typedef struct {\r
  UINT8 Data[18];\r
} IPMI_LAN_COMMUNITY_STRING;\r
\r
typedef union {\r
  struct {\r
    UINT8  DestinationSelector : 4;\r
    UINT8  Reserved : 4;\r
  } Bits;\r
  UINT8  Uint8;\r
} IPMI_LAN_SET_SELECTOR;\r
\r
typedef union {\r
  struct {\r
    UINT8  DestinationType : 3;\r
    UINT8  Reserved : 4;\r
    UINT8  AlertAcknowledged : 1;\r
  } Bits;\r
  UINT8  Uint8;\r
} IPMI_LAN_DEST_TYPE_DESTINATION_TYPE;\r
\r
typedef struct {\r
  IPMI_LAN_SET_SELECTOR                SetSelector;\r
  IPMI_LAN_DEST_TYPE_DESTINATION_TYPE  DestinationType;\r
} IPMI_LAN_DEST_TYPE;\r
\r
typedef union {\r
  struct {\r
    UINT8  AlertingIpAddressSelector : 4;\r
    UINT8  AddressFormat : 4;\r
  } Bits;\r
  UINT8  Uint8;\r
} IPMI_LAN_ADDRESS_FORMAT;\r
\r
typedef union {\r
  struct {\r
    UINT8  UseDefaultGateway : 1;\r
    UINT8  Reserved2 : 7;\r
  } Bits;\r
  UINT8  Uint8;\r
} IPMI_LAN_GATEWAY_SELECTOR;\r
\r
typedef struct {\r
  IPMI_LAN_SET_SELECTOR      SetSelector;\r
  IPMI_LAN_ADDRESS_FORMAT    AddressFormat;\r
  IPMI_LAN_GATEWAY_SELECTOR  GatewaySelector;\r
  IPMI_LAN_IP_ADDRESS        AlertingIpAddress;\r
  IPMI_LAN_MAC_ADDRESS       AlertingMacAddress;\r
} IPMI_LAN_DEST_ADDRESS;\r
\r
typedef union {\r
  IPMI_LAN_AUTH_TYPE                 IpmiLanAuthType;\r
  IPMI_LAN_IP_ADDRESS                IpmiLanIpAddress;\r
  IPMI_LAN_IP_ADDRESS_SRC            IpmiLanIpAddressSrc;\r
  IPMI_LAN_MAC_ADDRESS               IpmiLanMacAddress;\r
  IPMI_LAN_SUBNET_MASK               IpmiLanSubnetMask;\r
  IPMI_LAN_IPV4_HDR_PARAM            IpmiLanIpv4HdrParam;\r
  IPMI_LAN_RCMP_PORT                 IpmiLanPrimaryRcmpPort;\r
  IPMI_LAN_BMC_GENERATED_ARP_CONTROL IpmiLanArpControl;\r
  IPMI_LAN_ARP_INTERVAL              IpmiLanArpInterval;\r
  IPMI_LAN_COMMUNITY_STRING          IpmiLanCommunityString;\r
  IPMI_LAN_DEST_TYPE                 IpmiLanDestType;\r
  IPMI_LAN_DEST_ADDRESS              IpmiLanDestAddress;\r
} IPMI_LAN_OPTIONS;\r
\r
typedef union {\r
  struct {\r
    UINT8  AddressSourceType : 4;\r
    UINT8  Reserved : 3;\r
    UINT8  EnableStatus : 1;\r
  } Bits;\r
  UINT8  Uint8;\r
} IPMI_LAN_IPV6_ADDRESS_SOURCE_TYPE;\r
\r
typedef struct {\r
  UINT8                              SetSelector;\r
  IPMI_LAN_IPV6_ADDRESS_SOURCE_TYPE  AddressSourceType;\r
  UINT8                              Ipv6Address[16];\r
  UINT8                              AddressPrefixLen;\r
  UINT8                              AddressStatus;\r
} IPMI_LAN_IPV6_STATIC_ADDRESS;\r
\r
//\r
//  Set in progress parameter\r
//\r
typedef union {\r
  struct {\r
    UINT8  SetInProgress:2;\r
    UINT8  Reserved:6;\r
  } Bits;\r
  UINT8  Uint8;\r
} IPMI_LAN_SET_IN_PROGRESS;\r
\r
typedef union {\r
  struct {\r
    UINT8  ChannelNo : 4;\r
    UINT8  Reserved : 4;\r
  } Bits;\r
  UINT8  Uint8;\r
} IPMI_SET_LAN_CONFIG_CHANNEL_NUM;\r
\r
typedef struct {\r
  IPMI_SET_LAN_CONFIG_CHANNEL_NUM  ChannelNumber;\r
  UINT8                            ParameterSelector;\r
  UINT8                            ParameterData[0];\r
} IPMI_SET_LAN_CONFIGURATION_PARAMETERS_COMMAND_REQUEST;\r
\r
//\r
//  Definitions for Get Lan Configuration Parameters command\r
//\r
#define IPMI_TRANSPORT_GET_LAN_CONFIG_PARAMETERS 0x02\r
\r
//\r
//  Constants and Structure definitions for "Get Lan Configuration Parameters" command to follow here\r
//\r
typedef union {\r
  struct {\r
    UINT8  ChannelNo : 4;\r
    UINT8  Reserved : 3;\r
    UINT8  GetParameter : 1;\r
  } Bits;\r
  UINT8  Uint8;\r
} IPMI_GET_LAN_CONFIG_CHANNEL_NUM;\r
\r
typedef struct {\r
  IPMI_GET_LAN_CONFIG_CHANNEL_NUM  ChannelNumber;\r
  UINT8                            ParameterSelector;\r
  UINT8                            SetSelector;\r
  UINT8                            BlockSelector;\r
} IPMI_GET_LAN_CONFIGURATION_PARAMETERS_REQUEST;\r
\r
typedef struct {\r
  UINT8  CompletionCode;\r
  UINT8  ParameterRevision;\r
  UINT8  ParameterData[0];\r
} IPMI_GET_LAN_CONFIGURATION_PARAMETERS_RESPONSE;\r
\r
//\r
//  Definitions for Suspend BMC ARPs command\r
//\r
#define IPMI_TRANSPORT_SUSPEND_BMC_ARPS  0x03\r
\r
//\r
//  Constants and Structure definitions for "Suspend BMC ARPs" command to follow here\r
//\r
\r
//\r
//  Definitions for Get IP-UDP-RMCP Statistics command\r
//\r
#define IPMI_TRANSPORT_GET_PACKET_STATISTICS 0x04\r
\r
//\r
//  Constants and Structure definitions for "Get IP-UDP-RMCP Statistics" command to follow here\r
//\r
\r
//\r
//  Below is Definitions for IPMI Serial/Modem Commands (Chapter 25)\r
//\r
\r
//\r
//  Definitions for Set Serial/Modem Configuration command\r
//\r
#define IPMI_TRANSPORT_SET_SERIAL_CONFIGURATION  0x10\r
\r
//\r
//  Constants and Structure definitions for "Set Serial/Modem Configuration" command to follow here\r
//\r
\r
//\r
// EMP OPTION DATA\r
//\r
typedef union {\r
  struct {\r
    UINT8  NoAuthentication : 1;\r
    UINT8  MD2Authentication : 1;\r
    UINT8  MD5Authentication : 1;\r
    UINT8  Reserved1 : 1;\r
    UINT8  StraightPassword : 1;\r
    UINT8  OemProprietary : 1;\r
    UINT8  Reservd2 : 2;\r
  } Bits;\r
  UINT8  Uint8;\r
} IPMI_EMP_AUTH_TYPE;\r
\r
typedef union {\r
  struct {\r
    UINT8  EnableBasicMode : 1;\r
    UINT8  EnablePPPMode : 1;\r
    UINT8  EnableTerminalMode : 1;\r
    UINT8  Reserved1 : 2;\r
    UINT8  SnoopOsPPPNegotiation : 1;\r
    UINT8  Reserved2 : 1;\r
    UINT8  DirectConnect : 1;\r
  } Bits;\r
  UINT8  Uint8;\r
} IPMI_EMP_CONNECTION_TYPE;\r
\r
typedef union {\r
  struct {\r
    UINT8  InactivityTimeout : 4;\r
    UINT8  Reserved : 4;\r
  } Bits;\r
  UINT8  Uint8;\r
} IPMI_EMP_INACTIVITY_TIMEOUT;\r
\r
typedef union {\r
  struct {\r
    UINT8  IpmiCallback : 1;\r
    UINT8  CBCPCallback : 1;\r
    UINT8  Reserved : 6;\r
  } Bits;\r
  UINT8  Uint8;\r
} IPMI_CHANNEL_CALLBACK_CONTROL_ENABLE;\r
\r
typedef union {\r
  struct {\r
    UINT8  CbcpEnableNoCallback : 1;\r
    UINT8  CbcpEnablePreSpecifiedNumber : 1;\r
    UINT8  CbcpEnableUserSpecifiedNumber : 1;\r
    UINT8  CbcpEnableCallbackFromList : 1;\r
    UINT8  Reserved : 4;\r
  } Bits;\r
  UINT8  Uint8;\r
} IPMI_CHANNEL_CALLBACK_CONTROL_CBCP;\r
\r
typedef struct {\r
  IPMI_CHANNEL_CALLBACK_CONTROL_ENABLE  CallbackEnable;\r
  IPMI_CHANNEL_CALLBACK_CONTROL_CBCP    CBCPNegotiation;\r
  UINT8                                 CallbackDestination1;\r
  UINT8                                 CallbackDestination2;\r
  UINT8                                 CallbackDestination3;\r
} IPMI_EMP_CHANNEL_CALLBACK_CONTROL;\r
\r
typedef union {\r
  struct {\r
    UINT8  CloseSessionOnDCDLoss : 1;\r
    UINT8  EnableSessionInactivityTimeout : 1;\r
    UINT8  Reserved : 6;\r
  } Bits;\r
  UINT8  Uint8;\r
} IPMI_EMP_SESSION_TERMINATION;\r
\r
typedef union {\r
  struct {\r
    UINT8  Reserved1 : 5;\r
    UINT8  EnableDtrHangup : 1;\r
    UINT8  FlowControl : 2;\r
    UINT8  BitRate : 4;\r
    UINT8  Reserved2 : 4;\r
    UINT8  SaveSetting : 1;\r
    UINT8  SetComPort : 1;\r
    UINT8  Reserved3 : 6;\r
  } Bits;\r
  UINT8   Uint8;\r
  UINT16  Uint16;\r
} IPMI_EMP_MESSAGING_COM_SETTING;\r
\r
typedef union {\r
  struct {\r
    UINT8  RingDurationInterval : 6;\r
    UINT8  Reserved1 : 2;\r
    UINT8  RingDeadTime : 4;\r
    UINT8  Reserved2 : 4;\r
  } Bits;\r
  UINT8  Uint8;\r
} IPMI_EMP_MODEM_RING_TIME;\r
\r
typedef struct {\r
  UINT8 Reserved;\r
  UINT8 InitString[48];\r
} IPMI_EMP_MODEM_INIT_STRING;\r
\r
typedef struct {\r
  UINT8 EscapeSequence[5];\r
} IPMI_EMP_MODEM_ESC_SEQUENCE;\r
\r
typedef struct {\r
  UINT8 HangupSequence[8];\r
} IPMI_EMP_MODEM_HANGUP_SEQUENCE;\r
\r
typedef struct {\r
  UINT8 ModelDialCommend[8];\r
} IPMI_MODEM_DIALUP_COMMAND;\r
\r
typedef struct {\r
  UINT8 PageBlackoutInterval;\r
} IPMI_PAGE_BLACKOUT_INTERVAL;\r
\r
typedef struct {\r
  UINT8 CommunityString[18];\r
} IPMI_EMP_COMMUNITY_STRING;\r
\r
typedef union {\r
  struct {\r
    UINT8  Reserved : 4;\r
    UINT8  DialStringSelector : 4;\r
  } Bits;\r
  UINT8  Uint8;\r
} IPMI_DIAL_PAGE_DESTINATION;\r
\r
typedef union {\r
  struct {\r
    UINT8  TapAccountSelector : 4;\r
    UINT8  Reserved : 4;\r
  } Bits;\r
  UINT8  Uint8;\r
} IPMI_TAP_PAGE_DESTINATION;\r
\r
typedef struct {\r
  UINT8 PPPAccountSetSelector;\r
  UINT8 DialStringSelector;\r
} IPMI_PPP_ALERT_DESTINATION;\r
\r
typedef union {\r
  IPMI_DIAL_PAGE_DESTINATION    DialPageDestination;\r
  IPMI_TAP_PAGE_DESTINATION     TapPageDestination;\r
  IPMI_PPP_ALERT_DESTINATION    PppAlertDestination;\r
} IPMI_DEST_TYPE_SPECIFIC;\r
\r
typedef union {\r
  struct {\r
    UINT8 DestinationSelector : 4;\r
    UINT8 Reserved : 4;\r
  } Bits;\r
  UINT8  Uint8;\r
} IPMI_EMP_DESTINATION_SELECTOR;\r
\r
typedef union {\r
  struct {\r
    UINT8  DestinationType : 4;\r
    UINT8  Reserved : 3;\r
    UINT8  AlertAckRequired : 1;\r
  } Bits;\r
  UINT8  Uint8;\r
} IPMI_EMP_DESTINATION_TYPE;\r
\r
typedef union {\r
  struct {\r
    UINT8  NumRetriesCall : 3;\r
    UINT8  Reserved1 : 1;\r
    UINT8  NumRetryAlert : 3;\r
    UINT8  Reserved2 : 1;\r
  } Bits;\r
  UINT8  Uint8;\r
} IPMI_EMP_RETRIES;\r
\r
typedef struct {\r
  IPMI_EMP_DESTINATION_SELECTOR  DestinationSelector;\r
  IPMI_EMP_DESTINATION_TYPE      DestinationType;\r
  UINT8                          AlertAckTimeoutSeconds;\r
  IPMI_EMP_RETRIES               Retries;\r
  IPMI_DEST_TYPE_SPECIFIC        DestinationTypeSpecific;\r
} IPMI_EMP_DESTINATION_INFO;\r
\r
typedef union {\r
  struct {\r
    UINT8  Parity : 3;\r
    UINT8  CharacterSize : 1;\r
    UINT8  StopBit : 1;\r
    UINT8  DtrHangup : 1;\r
    UINT8  FlowControl : 2;\r
  } Bits;\r
  UINT8  Uint8;\r
} IPMI_EMP_DESTINATION_COM_SETTING_DATA_2;\r
\r
typedef union {\r
  struct {\r
    UINT8  BitRate : 4;\r
    UINT8  Reserved : 4;\r
  } Bits;\r
  UINT8  Uint8;\r
} IPMI_EMP_BIT_RATE;\r
\r
typedef struct {\r
  IPMI_EMP_DESTINATION_SELECTOR            DestinationSelector;\r
  IPMI_EMP_DESTINATION_COM_SETTING_DATA_2  Data2;\r
  IPMI_EMP_BIT_RATE                        BitRate;\r
} IPMI_EMP_DESTINATION_COM_SETTING;\r
\r
typedef union {\r
  struct {\r
    UINT8  DialStringSelector : 4;\r
    UINT8  Reserved : 4;\r
  } Bits;\r
  UINT8  Uint8;\r
} IPMI_DIAL_STRING_SELECTOR;\r
\r
typedef struct {\r
  IPMI_DIAL_STRING_SELECTOR  DestinationSelector;\r
  UINT8                      Reserved;\r
  UINT8                      DialString[48];\r
} IPMI_DESTINATION_DIAL_STRING;\r
\r
typedef union {\r
  UINT32  IpAddressLong;\r
  UINT8   IpAddress[4];\r
} IPMI_PPP_IP_ADDRESS;\r
\r
typedef union {\r
  struct {\r
    UINT8  IpAddressSelector : 4;\r
    UINT8  Reserved : 4;\r
  } Bits;\r
  UINT8  Uint8;\r
} IPMI_DESTINATION_IP_ADDRESS_SELECTOR;\r
\r
typedef struct {\r
  IPMI_DESTINATION_IP_ADDRESS_SELECTOR  DestinationSelector;\r
  IPMI_PPP_IP_ADDRESS                   PppIpAddress;\r
} IPMI_DESTINATION_IP_ADDRESS;\r
\r
typedef union {\r
  struct {\r
    UINT8  TapServiceSelector : 4;\r
    UINT8  TapDialStringSelector : 4;\r
  } Bits;\r
  UINT8  Uint8;\r
} IPMI_TAP_DIAL_STRING_SERVICE_SELECTOR;\r
\r
\r
typedef struct {\r
  UINT8                                  TapSelector;\r
  IPMI_TAP_DIAL_STRING_SERVICE_SELECTOR  TapDialStringServiceSelector;\r
} IPMI_DESTINATION_TAP_ACCOUNT;\r
\r
typedef struct {\r
  UINT8 TapSelector;\r
  UINT8 PagerIdString[16];\r
} IPMI_TAP_PAGER_ID_STRING;\r
\r
typedef union {\r
  UINT8                              OptionData;\r
  IPMI_EMP_AUTH_TYPE                 EmpAuthType;\r
  IPMI_EMP_CONNECTION_TYPE           EmpConnectionType;\r
  IPMI_EMP_INACTIVITY_TIMEOUT        EmpInactivityTimeout;\r
  IPMI_EMP_CHANNEL_CALLBACK_CONTROL  EmpCallbackControl;\r
  IPMI_EMP_SESSION_TERMINATION       EmpSessionTermination;\r
  IPMI_EMP_MESSAGING_COM_SETTING     EmpMessagingComSetting;\r
  IPMI_EMP_MODEM_RING_TIME           EmpModemRingTime;\r
  IPMI_EMP_MODEM_INIT_STRING         EmpModemInitString;\r
  IPMI_EMP_MODEM_ESC_SEQUENCE        EmpModemEscSequence;\r
  IPMI_EMP_MODEM_HANGUP_SEQUENCE     EmpModemHangupSequence;\r
  IPMI_MODEM_DIALUP_COMMAND          EmpModemDialupCommand;\r
  IPMI_PAGE_BLACKOUT_INTERVAL        EmpPageBlackoutInterval;\r
  IPMI_EMP_COMMUNITY_STRING          EmpCommunityString;\r
  IPMI_EMP_DESTINATION_INFO          EmpDestinationInfo;\r
  IPMI_EMP_DESTINATION_COM_SETTING   EmpDestinationComSetting;\r
  UINT8                              CallRetryBusySignalInterval;\r
  IPMI_DESTINATION_DIAL_STRING       DestinationDialString;\r
  IPMI_DESTINATION_IP_ADDRESS        DestinationIpAddress;\r
  IPMI_DESTINATION_TAP_ACCOUNT       DestinationTapAccount;\r
  IPMI_TAP_PAGER_ID_STRING           TapPagerIdString;\r
} IPMI_EMP_OPTIONS;\r
\r
//\r
//  Definitions for Get Serial/Modem Configuration command\r
//\r
#define IPMI_TRANSPORT_GET_SERIAL_CONFIGURATION  0x11\r
\r
//\r
//  Constants and Structure definitions for "Get Serial/Modem Configuration" command to follow here\r
//\r
\r
//\r
//  Definitions for Set Serial/Modem Mux command\r
//\r
#define IPMI_TRANSPORT_SET_SERIAL_MUX  0x12\r
\r
//\r
//  Constants and Structure definitions for "Set Serial/Modem Mux" command to follow here\r
//\r
\r
//\r
// Set Serial/Modem Mux command request return status\r
//\r
#define IPMI_MUX_SETTING_REQUEST_REJECTED  0x00\r
#define IPMI_MUX_SETTING_REQUEST_ACCEPTED  0x01\r
\r
//\r
//  Definitions for serial multiplex settings\r
//\r
#define IPMI_MUX_SETTING_GET_MUX_SETTING              0x0\r
#define IPMI_MUX_SETTING_REQUEST_MUX_TO_SYSTEM        0x1\r
#define IPMI_MUX_SETTING_REQUEST_MUX_TO_BMC           0x2\r
#define IPMI_MUX_SETTING_FORCE_MUX_TO_SYSTEM          0x3\r
#define IPMI_MUX_SETTING_FORCE_MUX_TO_BMC             0x4\r
#define IPMI_MUX_SETTING_BLOCK_REQUEST_MUX_TO_SYSTEM  0x5\r
#define IPMI_MUX_SETTING_ALLOW_REQUEST_MUX_TO_SYSTEM  0x6\r
#define IPMI_MUX_SETTING_BLOCK_REQUEST_MUX_TO_BMC     0x7\r
#define IPMI_MUX_SETTING_ALLOW_REQUEST_MUX_TO_BMC     0x8\r
\r
typedef union {\r
  struct {\r
    UINT8  ChannelNo : 4;\r
    UINT8  Reserved : 4;\r
  } Bits;\r
  UINT8  Uint8;\r
} IPMI_MUX_CHANNEL_NUM;\r
\r
typedef union {\r
  struct {\r
    UINT8  MuxSetting : 4;\r
    UINT8  Reserved : 4;\r
  } Bits;\r
  UINT8  Uint8;\r
} IPMI_MUX_SETTING_REQUEST;\r
\r
typedef struct {\r
  IPMI_MUX_CHANNEL_NUM      ChannelNumber;\r
  IPMI_MUX_SETTING_REQUEST  MuxSetting;\r
} IPMI_SET_SERIAL_MODEM_MUX_COMMAND_REQUEST;\r
\r
typedef union {\r
  struct {\r
    UINT8  MuxSetToBmc : 1;\r
    UINT8  CommandStatus : 1;\r
    UINT8  MessagingSessionActive : 1;\r
    UINT8  AlertInProgress : 1;\r
    UINT8  Reserved : 2;\r
    UINT8  MuxToBmcAllowed : 1;\r
    UINT8  MuxToSystemBlocked : 1;\r
  } Bits;\r
  UINT8  Uint8;\r
} IPMI_MUX_SETTING_PRESENT_STATE;\r
\r
typedef struct {\r
  UINT8                           CompletionCode;\r
  IPMI_MUX_SETTING_PRESENT_STATE  MuxSetting;\r
} IPMI_SET_SERIAL_MODEM_MUX_COMMAND_RESPONSE;\r
\r
//\r
//  Definitions for Get TAP Response Code command\r
//\r
#define IPMI_TRANSPORT_GET_TAP_RESPONSE_CODE 0x13\r
\r
//\r
//  Constants and Structure definitions for "Get TAP Response Code" command to follow here\r
//\r
\r
//\r
//  Definitions for Set PPP UDP Proxy Transmit Data command\r
//\r
#define IPMI_TRANSPORT_SET_PPP_UDP_PROXY_TXDATA  0x14\r
\r
//\r
//  Constants and Structure definitions for "Set PPP UDP Proxy Transmit Data" command to follow here\r
//\r
\r
//\r
//  Definitions for Get PPP UDP Proxy Transmit Data command\r
//\r
#define IPMI_TRANSPORT_GET_PPP_UDP_PROXY_TXDATA  0x15\r
\r
//\r
//  Constants and Structure definitions for "Get PPP UDP Proxy Transmit Data" command to follow here\r
//\r
\r
//\r
//  Definitions for Send PPP UDP Proxy Packet command\r
//\r
#define IPMI_TRANSPORT_SEND_PPP_UDP_PROXY_PACKET 0x16\r
\r
//\r
//  Constants and Structure definitions for "Send PPP UDP Proxy Packet" command to follow here\r
//\r
\r
//\r
//  Definitions for Get PPP UDP Proxy Receive Data command\r
//\r
#define IPMI_TRANSPORT_GET_PPP_UDP_PROXY_RX  0x17\r
\r
//\r
//  Constants and Structure definitions for "Get PPP UDP Proxy Receive Data" command to follow here\r
//\r
\r
//\r
//  Definitions for Serial/Modem connection active command\r
//\r
#define IPMI_TRANSPORT_SERIAL_CONNECTION_ACTIVE  0x18\r
\r
//\r
//  Constants and Structure definitions for "Serial/Modem connection active" command to follow here\r
//\r
\r
//\r
//  Definitions for Callback command\r
//\r
#define IPMI_TRANSPORT_CALLBACK  0x19\r
\r
//\r
//  Constants and Structure definitions for "Callback" command to follow here\r
//\r
\r
//\r
//  Definitions for Set user Callback Options command\r
//\r
#define IPMI_TRANSPORT_SET_USER_CALLBACK_OPTIONS 0x1A\r
\r
//\r
//  Constants and Structure definitions for "Set user Callback Options" command to follow here\r
//\r
\r
//\r
//  Definitions for Get user Callback Options command\r
//\r
#define IPMI_TRANSPORT_GET_USER_CALLBACK_OPTIONS 0x1B\r
\r
//\r
//  Constants and Structure definitions for "Get user Callback Options" command to follow here\r
//\r
\r
//\r
//  Below is Definitions for SOL Commands (Chapter 26)\r
//\r
\r
//\r
//  Definitions for SOL activating command\r
//\r
#define IPMI_TRANSPORT_SOL_ACTIVATING  0x20\r
\r
//\r
//  Constants and Structure definitions for "SOL activating" command to follow here\r
//\r
typedef union {\r
  struct {\r
    UINT8  SessionState : 4;\r
    UINT8  Reserved : 4;\r
  } Bits;\r
  UINT8  Uint8;\r
} IPMI_SOL_SESSION_STATE;\r
\r
typedef struct {\r
  IPMI_SOL_SESSION_STATE  SessionState;\r
  UINT8                   PayloadInstance;\r
  UINT8                   FormatVersionMajor; // 1\r
  UINT8                   FormatVersionMinor; // 0\r
} IPMI_SOL_ACTIVATING_REQUEST;\r
\r
//\r
//  Definitions for Set SOL Configuration Parameters command\r
//\r
#define IPMI_TRANSPORT_SET_SOL_CONFIG_PARAM  0x21\r
\r
//\r
//  Constants and Structure definitions for "Set SOL Configuration Parameters" command to follow here\r
//\r
\r
//\r
// SOL Configuration Parameters selector\r
//\r
#define IPMI_SOL_CONFIGURATION_PARAMETER_SET_IN_PROGRESS       0\r
#define IPMI_SOL_CONFIGURATION_PARAMETER_SOL_ENABLE            1\r
#define IPMI_SOL_CONFIGURATION_PARAMETER_SOL_AUTHENTICATION    2\r
#define IPMI_SOL_CONFIGURATION_PARAMETER_SOL_CHARACTER_PARAM   3\r
#define IPMI_SOL_CONFIGURATION_PARAMETER_SOL_RETRY             4\r
#define IPMI_SOL_CONFIGURATION_PARAMETER_SOL_NV_BIT_RATE       5\r
#define IPMI_SOL_CONFIGURATION_PARAMETER_SOL_VOLATILE_BIT_RATE 6\r
#define IPMI_SOL_CONFIGURATION_PARAMETER_SOL_PAYLOAD_CHANNEL   7\r
#define IPMI_SOL_CONFIGURATION_PARAMETER_SOL_PAYLOAD_PORT      8\r
\r
typedef union {\r
  struct {\r
    UINT8  ChannelNumber : 4;\r
    UINT8  Reserved : 4;\r
  } Bits;\r
  UINT8  Uint8;\r
} IPMI_SET_SOL_CONFIG_PARAM_CHANNEL_NUM;\r
\r
typedef struct {\r
  IPMI_SET_SOL_CONFIG_PARAM_CHANNEL_NUM  ChannelNumber;\r
  UINT8                                  ParameterSelector;\r
  UINT8                                  ParameterData[0];\r
} IPMI_SET_SOL_CONFIGURATION_PARAMETERS_REQUEST;\r
\r
//\r
//  Definitions for Get SOL Configuration Parameters command\r
//\r
#define IPMI_TRANSPORT_GET_SOL_CONFIG_PARAM  0x22\r
\r
//\r
//  Constants and Structure definitions for "Get SOL Configuration Parameters" command to follow here\r
//\r
typedef union {\r
  struct {\r
    UINT8  ChannelNumber : 4;\r
    UINT8  Reserved : 3;\r
    UINT8  GetParameter : 1;\r
  } Bits;\r
  UINT8  Uint8;\r
} IPMI_GET_SOL_CONFIG_PARAM_CHANNEL_NUM;\r
\r
typedef struct {\r
  IPMI_GET_SOL_CONFIG_PARAM_CHANNEL_NUM  ChannelNumber;\r
  UINT8                                  ParameterSelector;\r
  UINT8                                  SetSelector;\r
  UINT8                                  BlockSelector;\r
} IPMI_GET_SOL_CONFIGURATION_PARAMETERS_REQUEST;\r
\r
typedef struct {\r
  UINT8  CompletionCode;\r
  UINT8  ParameterRevision;\r
  UINT8  ParameterData[0];\r
} IPMI_GET_SOL_CONFIGURATION_PARAMETERS_RESPONSE;\r
\r
#pragma pack()\r
#endif\r