MdeModulePkg[all]  0.98
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
IpmiProtocol.h File Reference

Data Structures

struct  _IPMI_PROTOCOL
 

Macros

#define IPMI_PROTOCOL_GUID
 
#define SMM_IPMI_PROTOCOL_GUID
 

Typedefs

typedef struct _IPMI_PROTOCOL IPMI_PROTOCOL
 
typedef IN UINT8 NetFunction
 
typedef IN UINT8 IN UINT8 Command
 
typedef IN UINT8 IN UINT8 IN
UINT8 * 
RequestData
 
typedef IN UINT8 IN UINT8 IN
UINT8 IN UINT32 
RequestDataSize
 
typedef IN UINT8 IN UINT8 IN
UINT8 IN UINT32 OUT UINT8 * 
ResponseData
 
typedef IN UINT8 IN UINT8 IN
UINT8 IN UINT32 OUT UINT8 IN
OUT UINT32
ResponseDataSize
 

Functions

typedef EFI_STATUS (EFIAPI *IPMI_SUBMIT_COMMAND)(IN IPMI_PROTOCOL *This
 

Variables

EFI_GUID gIpmiProtocolGuid
 
EFI_GUID gSmmIpmiProtocolGuid
 

Detailed Description

Protocol of Ipmi for both SMS and SMM.

Copyright (c) 2009 - 2015, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Macro Definition Documentation

#define IPMI_PROTOCOL_GUID
Value:
{ \
0xdbc6381f, 0x5554, 0x4d14, 0x8f, 0xfd, 0x76, 0xd7, 0x87, 0xb8, 0xac, 0xbf \
}
#define SMM_IPMI_PROTOCOL_GUID
Value:
{ \
0x5169af60, 0x8c5a, 0x4243, 0xb3, 0xe9, 0x56, 0xc5, 0x6d, 0x18, 0xee, 0x26 \
}

Typedef Documentation

typedef IN UINT8 IN UINT8 Command
typedef struct _IPMI_PROTOCOL IPMI_PROTOCOL
typedef IN UINT8 NetFunction
typedef IN UINT8 IN UINT8 IN UINT8* RequestData
typedef IN UINT8 IN UINT8 IN UINT8 IN UINT32 RequestDataSize
typedef IN UINT8 IN UINT8 IN UINT8 IN UINT32 OUT UINT8* ResponseData
typedef IN UINT8 IN UINT8 IN UINT8 IN UINT32 OUT UINT8 IN OUT UINT32* ResponseDataSize

Function Documentation

typedef EFI_STATUS ( EFIAPI *  IPMI_SUBMIT_COMMAND)

This service enables submitting commands via Ipmi.

Parameters
[in]ThisThis point for IPMI_PROTOCOL structure.
[in]NetFunctionNet function of the command.
[in]CommandIPMI Command.
[in]RequestDataCommand Request Data.
[in]RequestDataSizeSize of Command Request Data.
[out]ResponseDataCommand Response Data. The completion code is the first byte of response data.
[in,out]ResponseDataSizeSize of Command Response Data.
Return values
EFI_SUCCESSThe command byte stream was successfully submit to the device and a response was successfully received.
EFI_NOT_FOUNDThe command was not successfully sent to the device or a response was not successfully received from the device.
EFI_NOT_READYIpmi Device is not ready for Ipmi command access.
EFI_DEVICE_ERRORIpmi Device hardware error.
EFI_TIMEOUTThe command time out.
EFI_UNSUPPORTEDThe command was not successfully sent to the device.
EFI_OUT_OF_RESOURCESThe resource allcation is out of resource or data size error.

Variable Documentation

EFI_GUID gIpmiProtocolGuid
EFI_GUID gSmmIpmiProtocolGuid