IpmiCommandLib.h File Reference

#include <Uefi.h>
#include <IndustryStandard/Ipmi.h>

Go to the source code of this file.

Functions
EFI_STATUS EFIAPI	IpmiGetDeviceId (OUT IPMI_GET_DEVICE_ID_RESPONSE *DeviceId)
EFI_STATUS EFIAPI	IpmiGetSelfTestResult (OUT IPMI_SELF_TEST_RESULT_RESPONSE *SelfTestResult)
EFI_STATUS EFIAPI	IpmiResetWatchdogTimer (OUT UINT8 *CompletionCode)
EFI_STATUS EFIAPI	IpmiSetWatchdogTimer (IN IPMI_SET_WATCHDOG_TIMER_REQUEST *SetWatchdogTimer, OUT UINT8 *CompletionCode)
EFI_STATUS EFIAPI	IpmiGetWatchdogTimer (OUT IPMI_GET_WATCHDOG_TIMER_RESPONSE *GetWatchdogTimer)
EFI_STATUS EFIAPI	IpmiSetBmcGlobalEnables (IN IPMI_SET_BMC_GLOBAL_ENABLES_REQUEST *SetBmcGlobalEnables, OUT UINT8 *CompletionCode)
EFI_STATUS EFIAPI	IpmiGetBmcGlobalEnables (OUT IPMI_GET_BMC_GLOBAL_ENABLES_RESPONSE *GetBmcGlobalEnables)
EFI_STATUS EFIAPI	IpmiClearMessageFlags (IN IPMI_CLEAR_MESSAGE_FLAGS_REQUEST *ClearMessageFlagsRequest, OUT UINT8 *CompletionCode)
EFI_STATUS EFIAPI	IpmiGetMessageFlags (OUT IPMI_GET_MESSAGE_FLAGS_RESPONSE *GetMessageFlagsResponse)
EFI_STATUS EFIAPI	IpmiGetMessage (OUT IPMI_GET_MESSAGE_RESPONSE *GetMessageResponse, IN OUT UINT32 *GetMessageResponseSize)
EFI_STATUS EFIAPI	IpmiSendMessage (IN IPMI_SEND_MESSAGE_REQUEST *SendMessageRequest, IN UINT32 SendMessageRequestSize, OUT IPMI_SEND_MESSAGE_RESPONSE *SendMessageResponse, IN OUT UINT32 *SendMessageResponseSize)
EFI_STATUS EFIAPI	IpmiGetSystemUuid (OUT EFI_GUID *SystemGuid)
EFI_STATUS EFIAPI	IpmiGetChannelInfo (IN IPMI_GET_CHANNEL_INFO_REQUEST *GetChannelInfoRequest, OUT IPMI_GET_CHANNEL_INFO_RESPONSE *GetChannelInfoResponse, OUT UINT32 *GetChannelInfoResponseSize)
EFI_STATUS EFIAPI	IpmiGetSystemInterfaceCapability (IN IPMI_GET_SYSTEM_INTERFACE_CAPABILITIES_REQUEST *InterfaceCapabilityRequest, OUT IPMI_GET_SYSTEM_INTERFACE_CAPABILITIES_RESPONSE *InterfaceCapabilityResponse)
EFI_STATUS EFIAPI	IpmiSolActivating (IN IPMI_SOL_ACTIVATING_REQUEST *SolActivatingRequest, OUT UINT8 *CompletionCode)
EFI_STATUS EFIAPI	IpmiSetSolConfigurationParameters (IN IPMI_SET_SOL_CONFIGURATION_PARAMETERS_REQUEST *SetConfigurationParametersRequest, IN UINT32 SetConfigurationParametersRequestSize, OUT UINT8 *CompletionCode)
EFI_STATUS EFIAPI	IpmiGetSolConfigurationParameters (IN IPMI_GET_SOL_CONFIGURATION_PARAMETERS_REQUEST *GetConfigurationParametersRequest, OUT IPMI_GET_SOL_CONFIGURATION_PARAMETERS_RESPONSE *GetConfigurationParametersResponse, IN OUT UINT32 *GetConfigurationParametersResponseSize)
EFI_STATUS EFIAPI	IpmiGetLanConfigurationParameters (IN IPMI_GET_LAN_CONFIGURATION_PARAMETERS_REQUEST *GetLanConfigurationParametersRequest, OUT IPMI_GET_LAN_CONFIGURATION_PARAMETERS_RESPONSE *GetLanConfigurationParametersResponse, IN OUT UINT32 *GetLanConfigurationParametersSize)
EFI_STATUS EFIAPI	IpmiGetChassisCapabilities (OUT IPMI_GET_CHASSIS_CAPABILITIES_RESPONSE *GetChassisCapabilitiesResponse)
EFI_STATUS EFIAPI	IpmiGetChassisStatus (OUT IPMI_GET_CHASSIS_STATUS_RESPONSE *GetChassisStatusResponse)
EFI_STATUS EFIAPI	IpmiChassisControl (IN IPMI_CHASSIS_CONTROL_REQUEST *ChassisControlRequest, OUT UINT8 *CompletionCode)
EFI_STATUS EFIAPI	IpmiSetPowerRestorePolicy (IN IPMI_SET_POWER_RESTORE_POLICY_REQUEST *SetPowerRestireRequest, OUT IPMI_SET_POWER_RESTORE_POLICY_RESPONSE *SetPowerRestireResponse)
EFI_STATUS EFIAPI	IpmiSetSystemBootOptions (IN IPMI_SET_BOOT_OPTIONS_REQUEST *BootOptionsRequest, OUT IPMI_SET_BOOT_OPTIONS_RESPONSE *BootOptionsResponse)
EFI_STATUS EFIAPI	IpmiGetSystemBootOptions (IN IPMI_GET_BOOT_OPTIONS_REQUEST *BootOptionsRequest, OUT IPMI_GET_BOOT_OPTIONS_RESPONSE *BootOptionsResponse)
EFI_STATUS EFIAPI	IpmiGetFruInventoryAreaInfo (IN IPMI_GET_FRU_INVENTORY_AREA_INFO_REQUEST *GetFruInventoryAreaInfoRequest, OUT IPMI_GET_FRU_INVENTORY_AREA_INFO_RESPONSE *GetFruInventoryAreaInfoResponse)
EFI_STATUS EFIAPI	IpmiReadFruData (IN IPMI_READ_FRU_DATA_REQUEST *ReadFruDataRequest, OUT IPMI_READ_FRU_DATA_RESPONSE *ReadFruDataResponse, IN OUT UINT32 *ReadFruDataResponseSize)
EFI_STATUS EFIAPI	IpmiWriteFruData (IN IPMI_WRITE_FRU_DATA_REQUEST *WriteFruDataRequest, IN UINT32 WriteFruDataRequestSize, OUT IPMI_WRITE_FRU_DATA_RESPONSE *WriteFruDataResponse)
EFI_STATUS EFIAPI	IpmiGetSelInfo (OUT IPMI_GET_SEL_INFO_RESPONSE *GetSelInfoResponse)
EFI_STATUS EFIAPI	IpmiGetSelEntry (IN IPMI_GET_SEL_ENTRY_REQUEST *GetSelEntryRequest, OUT IPMI_GET_SEL_ENTRY_RESPONSE *GetSelEntryResponse, IN OUT UINT32 *GetSelEntryResponseSize)
EFI_STATUS EFIAPI	IpmiAddSelEntry (IN IPMI_ADD_SEL_ENTRY_REQUEST *AddSelEntryRequest, OUT IPMI_ADD_SEL_ENTRY_RESPONSE *AddSelEntryResponse)
EFI_STATUS EFIAPI	IpmiPartialAddSelEntry (IN IPMI_PARTIAL_ADD_SEL_ENTRY_REQUEST *PartialAddSelEntryRequest, IN UINT32 PartialAddSelEntryRequestSize, OUT IPMI_PARTIAL_ADD_SEL_ENTRY_RESPONSE *PartialAddSelEntryResponse)
EFI_STATUS EFIAPI	IpmiClearSel (IN IPMI_CLEAR_SEL_REQUEST *ClearSelRequest, OUT IPMI_CLEAR_SEL_RESPONSE *ClearSelResponse)
EFI_STATUS EFIAPI	IpmiGetSelTime (OUT IPMI_GET_SEL_TIME_RESPONSE *GetSelTimeResponse)
EFI_STATUS EFIAPI	IpmiSetSelTime (IN IPMI_SET_SEL_TIME_REQUEST *SetSelTimeRequest, OUT UINT8 *CompletionCode)
EFI_STATUS EFIAPI	IpmiGetSdrRepositoryInfo (OUT IPMI_GET_SDR_REPOSITORY_INFO_RESPONSE *GetSdrRepositoryInfoResp)
EFI_STATUS EFIAPI	IpmiGetSdr (IN IPMI_GET_SDR_REQUEST *GetSdrRequest, OUT IPMI_GET_SDR_RESPONSE *GetSdrResponse, IN OUT UINT32 *GetSdrResponseSize)

Detailed Description

This library abstract how to send/receive IPMI command.

Copyright (c) 2018-2021, Intel Corporation. All rights reserved.
Copyright (C) 2023 Advanced Micro Devices, Inc. All rights reserved.

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file IpmiCommandLib.h.

Function Documentation

IpmiAddSelEntry()

EFI_STATUS EFIAPI IpmiAddSelEntry	(	IN IPMI_ADD_SEL_ENTRY_REQUEST *	AddSelEntryRequest,
		OUT IPMI_ADD_SEL_ENTRY_RESPONSE *	AddSelEntryResponse
	)

This function adds SEL entry.

Parameters

[in]	AddSelEntryRequest	Add SEL entry command request.
[out]	AddSelEntryResponse	Add SEL entry command response.

Return values

EFI_SUCCESS	Command is sent successfully.
EFI_NOT_AVAILABLE_YET	Transport interface is not ready yet.
Other	Failure.

This function adds SEL entry.

Parameters

[in]	AddSelEntryRequest	Add SEL entry command request.
[out]	AddSelEntryResponse	Add SEL entry command response.

Return values

EFI_UNSUPPORTED

Unsupported in the NULL lib.

Definition at line 126 of file IpmiCommandLibNetFnStorage.c.

IpmiChassisControl()

EFI_STATUS EFIAPI IpmiChassisControl	(	IN IPMI_CHASSIS_CONTROL_REQUEST *	ChassisControlRequest,
		OUT UINT8 *	CompletionCode
	)

This function sends chassis control request.

Parameters

[in]	ChassisControlRequest	The chassis control request.
[out]	CompletionCode	The command completion code.

Return values

EFI_SUCCESS	Command is sent successfully.
EFI_NOT_AVAILABLE_YET	Transport interface is not ready yet.
Other	Failure.

This function sends chassis control request.

Parameters

[in]	ChassisControlRequest	The chassis control request.
[out]	CompletionCode	The command completion code.

Return values

EFI_UNSUPPORTED

Unsupported in the NULL lib.

Definition at line 57 of file IpmiCommandLibNetFnChassis.c.

IpmiClearMessageFlags()

EFI_STATUS EFIAPI IpmiClearMessageFlags	(	IN IPMI_CLEAR_MESSAGE_FLAGS_REQUEST *	ClearMessageFlagsRequest,
		OUT UINT8 *	CompletionCode
	)

This function clears message flag.

Parameters

[in]	ClearMessageFlagsRequest	Clear message flags command request.
[out]	CompletionCode	The command completion code.

Return values

EFI_SUCCESS	Command is sent successfully.
EFI_NOT_AVAILABLE_YET	Transport interface is not ready yet.
Other	Failure.

This function clears message flag.

Parameters

[in]	ClearMessageFlagsRequest	Clear message flags command Request.
[out]	CompletionCode	The command completion code.

Return values

EFI_UNSUPPORTED

Unsupported in the NULL lib.

Definition at line 146 of file IpmiCommandLibNetFnApp.c.

IpmiClearSel()

EFI_STATUS EFIAPI IpmiClearSel	(	IN IPMI_CLEAR_SEL_REQUEST *	ClearSelRequest,
		OUT IPMI_CLEAR_SEL_RESPONSE *	ClearSelResponse
	)

This function clears SEL entry.

Parameters

[in]	ClearSelRequest	Clear SEL command request.
[out]	ClearSelResponse	Clear SEL command response.

Return values

EFI_SUCCESS	Command is sent successfully.
EFI_NOT_AVAILABLE_YET	Transport interface is not ready yet.
Other	Failure.

This function clears SEL entry.

Parameters

[in]	ClearSelRequest	Clear SEL command request.
[out]	ClearSelResponse	Clear SEL command response.

Return values

EFI_UNSUPPORTED

Unsupported in the NULL lib.

Definition at line 166 of file IpmiCommandLibNetFnStorage.c.

IpmiGetBmcGlobalEnables()

EFI_STATUS EFIAPI IpmiGetBmcGlobalEnables

(

OUT IPMI_GET_BMC_GLOBAL_ENABLES_RESPONSE *

GetBmcGlobalEnables

)

This function gets BMC global enables.

Parameters

[out]

GetBmcGlobalEnables

Get BMC global enables command response.

Return values

EFI_SUCCESS	Command is sent successfully.
EFI_NOT_AVAILABLE_YET	Transport interface is not ready yet.
Other	Failure.

This function gets BMC global enables.

Parameters

[out]

GetBmcGlobalEnables

Get BMC global enables command response.

Return values

EFI_UNSUPPORTED

Unsupported in the NULL lib.

Definition at line 128 of file IpmiCommandLibNetFnApp.c.

IpmiGetChannelInfo()

EFI_STATUS EFIAPI IpmiGetChannelInfo	(	IN IPMI_GET_CHANNEL_INFO_REQUEST *	GetChannelInfoRequest,
		OUT IPMI_GET_CHANNEL_INFO_RESPONSE *	GetChannelInfoResponse,
		OUT UINT32 *	GetChannelInfoResponseSize
	)

This function gets the channel information.

Parameters

[in]	GetChannelInfoRequest	The get channel information request.
[in]	GetChannelInfoResponse	The get channel information response.
[in,out]	GetChannelInfoResponseSize	When input, the expected size of response. When output, the exact size of the returned response.

Return values

EFI_SUCCESS	Command is sent successfully.
EFI_NOT_AVAILABLE_YET	Transport interface is not ready yet.
Other	Failure.

This function gets the channel information.

Parameters

[in]	GetChannelInfoRequest	The get channel information request.
[out]	GetChannelInfoResponse	The get channel information response.
[out]	GetChannelInfoResponseSize	When input, the expected size of response. When output, the exact size of the returned response.

Return values

EFI_UNSUPPORTED

Unsupported in the NULL lib.

Definition at line 245 of file IpmiCommandLibNetFnApp.c.

IpmiGetChassisCapabilities()

EFI_STATUS EFIAPI IpmiGetChassisCapabilities

(

OUT IPMI_GET_CHASSIS_CAPABILITIES_RESPONSE *

GetChassisCapabilitiesResponse

)

This function gets chassis capability.

Parameters

[out]

GetChassisCapabilitiesResponse

Gets chassis capability command response.

Return values

EFI_SUCCESS	Command is sent successfully.
EFI_NOT_AVAILABLE_YET	Transport interface is not ready yet.
Other	Failure.

This function gets chassis capability.

Parameters

[out]

GetChassisCapabilitiesResponse

Gets chassis capability command response.

Return values

EFI_UNSUPPORTED

Unsupported in the NULL lib.

Definition at line 22 of file IpmiCommandLibNetFnChassis.c.

IpmiGetChassisStatus()

EFI_STATUS EFIAPI IpmiGetChassisStatus

(

OUT IPMI_GET_CHASSIS_STATUS_RESPONSE *

GetChassisStatusResponse

)

This function gets chassis status.

Parameters

[out]

GetChassisCapabilitiesResponse

The get chassis status command response.

Return values

EFI_SUCCESS	Command is sent successfully.
EFI_NOT_AVAILABLE_YET	Transport interface is not ready yet.
Other	Failure.

This function gets chassis status.

Parameters

[out]

GetChassisStatusResponse

The get chassis status command response.

Return values

EFI_UNSUPPORTED

Unsupported in the NULL lib.

Definition at line 39 of file IpmiCommandLibNetFnChassis.c.

IpmiGetDeviceId()

EFI_STATUS EFIAPI IpmiGetDeviceId

(

OUT IPMI_GET_DEVICE_ID_RESPONSE *

DeviceId

)

This function gets the IPMI Device ID.

Parameters

[out]

DeviceId

Get device ID response.

Return values

EFI_SUCCESS	Command is sent successfully.
EFI_NOT_AVAILABLE_YET	Transport interface is not ready yet.
Other	Failure.

This function gets the IPMI Device ID.

Parameters

[out]

DeviceId

Get device ID response.

Return values

EFI_UNSUPPORTED

Unsupported in the NULL lib.

Definition at line 22 of file IpmiCommandLibNetFnApp.c.

IpmiGetFruInventoryAreaInfo()

EFI_STATUS EFIAPI IpmiGetFruInventoryAreaInfo	(	IN IPMI_GET_FRU_INVENTORY_AREA_INFO_REQUEST *	GetFruInventoryAreaInfoRequest,
		OUT IPMI_GET_FRU_INVENTORY_AREA_INFO_RESPONSE *	GetFruInventoryAreaInfoResponse
	)

This function gets FRU inventory area info.

Parameters

[in]	GetFruInventoryAreaInfoRequest	Get FRU inventory area command request.
[out]	GetFruInventoryAreaInfoResponse	get FRU inventory area command response.

Return values

EFI_SUCCESS	Command is sent successfully.
EFI_NOT_AVAILABLE_YET	Transport interface is not ready yet.
Other	Failure.

This function gets FRU inventory area info.

Parameters

[in]	GetFruInventoryAreaInfoRequest	Get FRU inventory area command request.
[out]	GetFruInventoryAreaInfoResponse	get FRU inventory area command response.

Return values

EFI_UNSUPPORTED

Unsupported in the NULL lib.

Definition at line 23 of file IpmiCommandLibNetFnStorage.c.

IpmiGetLanConfigurationParameters()

EFI_STATUS EFIAPI IpmiGetLanConfigurationParameters	(	IN IPMI_GET_LAN_CONFIGURATION_PARAMETERS_REQUEST *	GetLanConfigurationParametersRequest,
		OUT IPMI_GET_LAN_CONFIGURATION_PARAMETERS_RESPONSE *	GetLanConfigurationParametersResponse,
		IN OUT UINT32 *	GetLanConfigurationParametersSize
	)

This function gets the LAN configuration parameter.

Parameters

[in]	GetLanConfigurationParametersRequest	Get LAN configuration parameters command request.
[in]	GetLanConfigurationParametersResponse	The response of the get LAN configuration parameters.
[in,out]	GetLanConfigurationParametersSize	When input, the expected size of response data. When out, the exact size of response data.

Return values

EFI_SUCCESS	Command is sent successfully.
EFI_NOT_AVAILABLE_YET	Transport interface is not ready yet.
Other	Failure.

This function gets the LAN configuration parameter.

Parameters

[in]	GetLanConfigurationParametersRequest	Request data
[out]	GetLanConfigurationParametersResponse	Response data
[in,out]	GetLanConfigurationParametersSize	When input, the expected size of response data. When out, the exact size of response data.

Return values

EFI_SUCCESS	Lan configuration parameter is returned in the response.
Others	Other errors.

Definition at line 93 of file IpmiCommandLibNetFnTransport.c.

IpmiGetMessage()

EFI_STATUS EFIAPI IpmiGetMessage	(	OUT IPMI_GET_MESSAGE_RESPONSE *	GetMessageResponse,
		IN OUT UINT32 *	GetMessageResponseSize
	)

This function gets message.

Parameters

[out]	GetMessageResponse	Get message command response.
[in,out]	GetMessageResponseSize	The size of get message response.

Return values

EFI_SUCCESS	Command is sent successfully.
EFI_NOT_AVAILABLE_YET	Transport interface is not ready yet.
Other	Failure.

This function gets message.

Parameters

[out]	GetMessageResponse	Get message command response.
[in,out]	GetMessageResponseSize	The size of get message response.

Return values

EFI_UNSUPPORTED

Unsupported in the NULL lib.

Definition at line 182 of file IpmiCommandLibNetFnApp.c.

IpmiGetMessageFlags()

EFI_STATUS EFIAPI IpmiGetMessageFlags

(

OUT IPMI_GET_MESSAGE_FLAGS_RESPONSE *

GetMessageFlagsResponse

)

This function gets message flag.

Parameters

[out]

GetMessageFlagsResponse

Get message flags response.

Return values

EFI_SUCCESS	Command is sent successfully.
EFI_NOT_AVAILABLE_YET	Transport interface is not ready yet.
Other	Failure.

This function gets message flags.

Parameters

[out]

GetMessageFlagsResponse

Get message flags response.

Return values

EFI_UNSUPPORTED

Unsupported in the NULL lib.

Definition at line 164 of file IpmiCommandLibNetFnApp.c.

IpmiGetSdr()

EFI_STATUS EFIAPI IpmiGetSdr	(	IN IPMI_GET_SDR_REQUEST *	GetSdrRequest,
		OUT IPMI_GET_SDR_RESPONSE *	GetSdrResponse,
		IN OUT UINT32 *	GetSdrResponseSize
	)

This function gets SDR

Parameters

[in]	GetSdrRequest	Get SDR resquest.
[out]	GetSdrResponse	Get SDR response.
[in,out]	GetSdrResponseSize	The size of get SDR response. When input, the expected size of response data. When out, the exact size of response data.

Return values

EFI_SUCCESS	Command is sent successfully.
EFI_NOT_AVAILABLE_YET	Transport interface is not ready yet.
Other	Failure.

This function gets SDR

Parameters

[in]	GetSdrRequest	Get SDR resquest.
[out]	GetSdrResponse	Get SDR response.
[in,out]	GetSdrResponseSize	The size of get SDR response. When input, the expected size of response data. When out, the exact size of response data.

Return values

EFI_UNSUPPORTED

Unsupported in the NULL lib.

Definition at line 241 of file IpmiCommandLibNetFnStorage.c.

IpmiGetSdrRepositoryInfo()

EFI_STATUS EFIAPI IpmiGetSdrRepositoryInfo

(

OUT IPMI_GET_SDR_REPOSITORY_INFO_RESPONSE *

GetSdrRepositoryInfoResp

)

This function gets SDR repository information.

Parameters

[out]

GetSdrRepositoryInfoResp

Get SDR repository response.

Return values

EFI_SUCCESS	Command is sent successfully.
EFI_NOT_AVAILABLE_YET	Transport interface is not ready yet.
Other	Failure.

This function gets SDR repository information.

Parameters

[out]

GetSdrRepositoryInfoResp

Get SDR repository response.

Return values

EFI_UNSUPPORTED

Unsupported in the NULL lib.

Definition at line 220 of file IpmiCommandLibNetFnStorage.c.

IpmiGetSelEntry()

EFI_STATUS EFIAPI IpmiGetSelEntry	(	IN IPMI_GET_SEL_ENTRY_REQUEST *	GetSelEntryRequest,
		OUT IPMI_GET_SEL_ENTRY_RESPONSE *	GetSelEntryResponse,
		IN OUT UINT32 *	GetSelEntryResponseSize
	)

This function gets SEL entry.

Parameters

[in]	GetSelEntryRequest	Get SEL entry command request.
[out]	GetSelEntryResponse	Get SEL entry command response.
[in,out]	GetSelEntryResponseSize	Size of Get SEL entry request. When input, the expected size of response data. When out, the exact size of response data.

Return values

EFI_SUCCESS	Command is sent successfully.
EFI_NOT_AVAILABLE_YET	Transport interface is not ready yet.
Other	Failure.

This function gets SEL entry.

Parameters

[in]	GetSelEntryRequest	Get SEL entry command request.
[out]	GetSelEntryResponse	Get SEL entry command response.
[in,out]	GetSelEntryResponseSize	Size of Get SEL entry request. When input, the expected size of response data. When out, the exact size of response data.

Return values

EFI_UNSUPPORTED

Unsupported in the NULL lib.

Definition at line 106 of file IpmiCommandLibNetFnStorage.c.

IpmiGetSelfTestResult()

EFI_STATUS EFIAPI IpmiGetSelfTestResult

(

OUT IPMI_SELF_TEST_RESULT_RESPONSE *

SelfTestResult

)

This function gets the self-test result.

Parameters

[out]

SelfTestResult

Self test command response.

Return values

EFI_SUCCESS	Command is sent successfully.
EFI_NOT_AVAILABLE_YET	Transport interface is not ready yet.
Other	Failure.

This function gets the self-test result.

Parameters

[out]

SelfTestResult

Self test command response.

Return values

EFI_UNSUPPORTED

Unsupported in the NULL lib.

Definition at line 39 of file IpmiCommandLibNetFnApp.c.

IpmiGetSelInfo()

EFI_STATUS EFIAPI IpmiGetSelInfo

(

OUT IPMI_GET_SEL_INFO_RESPONSE *

GetSelInfoResponse

)

This function gets SEL information.

Parameters

[out]

GetSelInfoResponse

Get SEL information command response.

Return values

EFI_SUCCESS	Command is sent successfully.
EFI_NOT_AVAILABLE_YET	Transport interface is not ready yet.
Other	Failure.

This function gets SEL information.

Parameters

[out]

GetSelInfoResponse

Get SEL information command response.

Return values

EFI_UNSUPPORTED

Unsupported in the NULL lib.

Definition at line 85 of file IpmiCommandLibNetFnStorage.c.

IpmiGetSelTime()

EFI_STATUS EFIAPI IpmiGetSelTime

(

OUT IPMI_GET_SEL_TIME_RESPONSE *

GetSelTimeResponse

)

This function gets SEL time.

Parameters

[out]

GetSelTimeResponse

Get SEL time command response.

Return values

EFI_SUCCESS	Command is sent successfully.
EFI_NOT_AVAILABLE_YET	Transport interface is not ready yet.
Other	Failure.

This function gets SEL time.

Parameters

[out]

GetSelTimeResponse

Get SEL time command response.

Return values

EFI_UNSUPPORTED

Unsupported in the NULL lib.

Definition at line 184 of file IpmiCommandLibNetFnStorage.c.

IpmiGetSolConfigurationParameters()

EFI_STATUS EFIAPI IpmiGetSolConfigurationParameters	(	IN IPMI_GET_SOL_CONFIGURATION_PARAMETERS_REQUEST *	GetConfigurationParametersRequest,
		OUT IPMI_GET_SOL_CONFIGURATION_PARAMETERS_RESPONSE *	GetConfigurationParametersResponse,
		IN OUT UINT32 *	GetConfigurationParametersResponseSize
	)

This function gets SOL configuration parameters.

Parameters

[in]	GetConfigurationParametersRequest	Get SOL configuration parameters command request.
[out]	GetConfigurationParametersResponse	Get SOL configuration parameters response.
[in,out]	GetConfigurationParametersResponseSize	When input, the size of the expected response. When output, the exact size of expect response.

Return values

EFI_SUCCESS	Command is sent successfully.
EFI_NOT_AVAILABLE_YET	Transport interface is not ready yet.
Other	Failure.

This function gets SOL configuration parameters.

Parameters

[in]	GetConfigurationParametersRequest	Get SOL configuration parameters command request.
[out]	GetConfigurationParametersResponse	Get SOL configuration parameters response.
[in,out]	GetConfigurationParametersResponseSize	When input, the size of expect response. When output, the exact size of expect response.

Return values

EFI_UNSUPPORTED

Unsupported in the NULL lib.

Definition at line 70 of file IpmiCommandLibNetFnTransport.c.

IpmiGetSystemBootOptions()

EFI_STATUS EFIAPI IpmiGetSystemBootOptions	(	IN IPMI_GET_BOOT_OPTIONS_REQUEST *	BootOptionsRequest,
		OUT IPMI_GET_BOOT_OPTIONS_RESPONSE *	BootOptionsResponse
	)

This function gets system boot option.

Parameters

[in]	BootOptionsRequest	Get system boot option request.
[out]	BootOptionsResponse	The response of get system boot option request.

Return values

EFI_SUCCESS	Command is sent successfully.
EFI_NOT_AVAILABLE_YET	Transport interface is not ready yet.
Other	Failure.

This function gets system boot option.

Parameters

[in]	BootOptionsRequest	Get system boot option request.
[out]	BootOptionsResponse	The response of get system boot option request.

Return values

EFI_UNSUPPORTED

Unsupported in the NULL lib.

Definition at line 117 of file IpmiCommandLibNetFnChassis.c.

IpmiGetSystemInterfaceCapability()

EFI_STATUS EFIAPI IpmiGetSystemInterfaceCapability	(	IN IPMI_GET_SYSTEM_INTERFACE_CAPABILITIES_REQUEST *	InterfaceCapabilityRequest,
		OUT IPMI_GET_SYSTEM_INTERFACE_CAPABILITIES_RESPONSE *	InterfaceCapabilityResponse
	)

This function gets system interface capability

Parameters

[in]	InterfaceCapabilityRequest	Get system interface capability request.
[out]	InterfaceCapabilityResponse	The response of system interface capability.

Return values

EFI_SUCCESS	Command is sent successfully.
Other	Failure.

IpmiGetSystemUuid()

EFI_STATUS EFIAPI IpmiGetSystemUuid

(

OUT EFI_GUID *

SystemGuid

)

This function gets the system UUID.

Parameters

[out]

SystemGuid

The pointer to retrieve system UUID.

Return values

EFI_SUCCESS	Command is sent successfully.
EFI_NOT_AVAILABLE_YET	Transport interface is not ready yet.
Others	Other errors.

This function gets the system UUID.

Parameters

[out]

SystemGuid

The pointer to retrieve system UUID.

Return values

EFI_UNSUPPORTED

Unsupported in the NULL lib.

Definition at line 224 of file IpmiCommandLibNetFnApp.c.

IpmiGetWatchdogTimer()

EFI_STATUS EFIAPI IpmiGetWatchdogTimer

(

OUT IPMI_GET_WATCHDOG_TIMER_RESPONSE *

GetWatchdogTimer

)

This function gets watchdog timer.

Parameters

[out]

GetWatchdogTimer

Get watchdog timer response.

Return values

EFI_SUCCESS	Command is sent successfully.
EFI_NOT_AVAILABLE_YET	Transport interface is not ready yet.
Other	Failure.

This function gets watchdog timer.

Parameters

[out]

GetWatchdogTimer

Get watchdog timer response.

Return values

EFI_UNSUPPORTED

Unsupported in the NULL lib.

Definition at line 92 of file IpmiCommandLibNetFnApp.c.

IpmiPartialAddSelEntry()

EFI_STATUS EFIAPI IpmiPartialAddSelEntry	(	IN IPMI_PARTIAL_ADD_SEL_ENTRY_REQUEST *	PartialAddSelEntryRequest,
		IN UINT32	PartialAddSelEntryRequestSize,
		OUT IPMI_PARTIAL_ADD_SEL_ENTRY_RESPONSE *	PartialAddSelEntryResponse
	)

This function partially adds SEL entry.

Parameters

[in]	PartialAddSelEntryRequest	Partial add SEL entry command request.
[in]	PartialAddSelEntryRequestSize	Size of partial add SEL entry command request.
[out]	PartialAddSelEntryResponse	Partial add SEL entry command response.

Return values

EFI_SUCCESS	Command is sent successfully.
EFI_NOT_AVAILABLE_YET	Transport interface is not ready yet.
Other	Failure.

This function partially adds SEL entry.

Parameters

[in]	PartialAddSelEntryRequest	Partial add SEL entry command request.
[in]	PartialAddSelEntryRequestSize	Size of partial add SEL entry command request.
[out]	PartialAddSelEntryResponse	Partial add SEL entry command response.

Return values

EFI_UNSUPPORTED

Unsupported in the NULL lib.

Definition at line 146 of file IpmiCommandLibNetFnStorage.c.

IpmiReadFruData()

EFI_STATUS EFIAPI IpmiReadFruData	(	IN IPMI_READ_FRU_DATA_REQUEST *	ReadFruDataRequest,
		OUT IPMI_READ_FRU_DATA_RESPONSE *	ReadFruDataResponse,
		IN OUT UINT32 *	ReadFruDataResponseSize
	)

This function reads FRU data.

Parameters

[in]	ReadFruDataRequest	Read FRU data command request.
[out]	ReadFruDataResponse	Read FRU data command response.
[in,out]	ReadFruDataResponseSize	Size of the read FRU data response. When input, the expected size of response data. When out, the exact size of response data.

Return values

EFI_SUCCESS	Command is sent successfully.
EFI_NOT_AVAILABLE_YET	Transport interface is not ready yet.
Other	Failure.

This function reads FRU data.

Parameters

[in]	ReadFruDataRequest	Read FRU data command request.
[out]	ReadFruDataResponse	Read FRU data command response.
[in,out]	ReadFruDataResponseSize	Size of the read FRU data response. When input, the expected size of response data. When out, the exact size of response data.

Return values

EFI_UNSUPPORTED

Unsupported in the NULL lib.

Definition at line 45 of file IpmiCommandLibNetFnStorage.c.

IpmiResetWatchdogTimer()

EFI_STATUS EFIAPI IpmiResetWatchdogTimer

(

OUT UINT8 *

CompletionCode

)

This function resets watchdog timer.

Parameters

[out]

CompletionCode

The command completion code.

Return values

EFI_SUCCESS	Command is sent successfully.
EFI_NOT_AVAILABLE_YET	Transport interface is not ready yet.
Other	Failure.

This function resets watchdog timer.

Parameters

[out]

CompletionCode

The command completion code.

Return values

EFI_UNSUPPORTED

Unsupported in the NULL lib.

Definition at line 56 of file IpmiCommandLibNetFnApp.c.

IpmiSendMessage()

EFI_STATUS EFIAPI IpmiSendMessage	(	IN IPMI_SEND_MESSAGE_REQUEST *	SendMessageRequest,
		IN UINT32	SendMessageRequestSize,
		OUT IPMI_SEND_MESSAGE_RESPONSE *	SendMessageResponse,
		IN OUT UINT32 *	SendMessageResponseSize
	)

This function sends message.

Parameters

[in]	SendMessageRequest	The send message command request.
[in]	SendMessageRequestSize	The size of the send message command request.
[out]	SendMessageResponse	The send message command response.
[in,out]	SendMessageResponseSize	The size of the send message command response. When input, the expected size of response. When output, the actual size of response.

Return values

EFI_SUCCESS	Command is sent successfully.
EFI_NOT_AVAILABLE_YET	Transport interface is not ready yet.
Other	Failure.

This function sends message.

Parameters

[in]	SendMessageRequest	The send message command request.
[in]	SendMessageRequestSize	The size of the send message command request.
[out]	SendMessageResponse	The send message command response.
[in,out]	SendMessageResponseSize	The size of the send message command response. When input, the expected size of response. When output, the actual size of response.

Return values

EFI_UNSUPPORTED

Unsupported in the NULL lib.

Definition at line 205 of file IpmiCommandLibNetFnApp.c.

IpmiSetBmcGlobalEnables()

EFI_STATUS EFIAPI IpmiSetBmcGlobalEnables	(	IN IPMI_SET_BMC_GLOBAL_ENABLES_REQUEST *	SetBmcGlobalEnables,
		OUT UINT8 *	CompletionCode
	)

This function sets BMC global enables.

Parameters

[in]	SetBmcGlobalEnables	Set BMC global enables command request.
[out]	CompletionCode	The command completion code.

Return values

EFI_SUCCESS	Command is sent successfully.
EFI_NOT_AVAILABLE_YET	Transport interface is not ready yet.
Other	Failure.

This function sets BMC global enables.

Parameters

[in]	SetBmcGlobalEnables	Set BMC global enables command request.
[out]	CompletionCode	The command completion code.

Return values

EFI_UNSUPPORTED

Unsupported in the NULL lib.

Definition at line 110 of file IpmiCommandLibNetFnApp.c.

IpmiSetPowerRestorePolicy()

EFI_STATUS EFIAPI IpmiSetPowerRestorePolicy	(	IN IPMI_SET_POWER_RESTORE_POLICY_REQUEST *	ChassisControlRequest,
		OUT IPMI_SET_POWER_RESTORE_POLICY_RESPONSE *	ChassisControlResponse
	)

This function sets power restore policy.

Parameters

[in]	SetPowerRestireRequest	The set power restore policy control command request.
[out]	SetPowerRestireResponse	The response of power restore policy.

Return values

EFI_SUCCESS	Command is sent successfully.
EFI_NOT_AVAILABLE_YET	Transport interface is not ready yet.
Other	Failure.

This function sets power restore policy.

Parameters

[in]	ChassisControlRequest	The set power restore policy control command request.
[out]	ChassisControlResponse	The response of power restore policy.

Return values

EFI_UNSUPPORTED

Unsupported in the NULL lib.

Definition at line 77 of file IpmiCommandLibNetFnChassis.c.

IpmiSetSelTime()

EFI_STATUS EFIAPI IpmiSetSelTime	(	IN IPMI_SET_SEL_TIME_REQUEST *	SetSelTimeRequest,
		OUT UINT8 *	CompletionCode
	)

This function sets SEL time.

Parameters

[in]	SetSelTimeRequest	Set SEL time command request.
[out]	CompletionCode	Command completion code.

Return values

EFI_SUCCESS	Command is sent successfully.
EFI_NOT_AVAILABLE_YET	Transport interface is not ready yet.
Other	Failure.

This function sets SEL time.

Parameters

[in]	SetSelTimeRequest	Set SEL time command request.
[out]	CompletionCode	Command completion code.

Return values

EFI_UNSUPPORTED

Unsupported in the NULL lib.

Definition at line 202 of file IpmiCommandLibNetFnStorage.c.

IpmiSetSolConfigurationParameters()

EFI_STATUS EFIAPI IpmiSetSolConfigurationParameters	(	IN IPMI_SET_SOL_CONFIGURATION_PARAMETERS_REQUEST *	SetConfigurationParametersRequest,
		IN UINT32	SetConfigurationParametersRequestSize,
		OUT UINT8 *	CompletionCode
	)

This function sets SOL configuration parameters.

Parameters

[in]	SetConfigurationParametersRequest	Set SOL configuration parameters command request.
[in]	SetConfigurationParametersRequestSize	Size of the set SOL configuration parameters command request.
[out]	CompletionCode	The command completion code.

Return values

EFI_SUCCESS	Command is sent successfully.
EFI_NOT_AVAILABLE_YET	Transport interface is not ready yet.
Other	Failure.

This function sets SOL configuration parameters.

Parameters

[in]	SetConfigurationParametersRequest	Set SOL configuration parameters command request.
[in]	SetConfigurationParametersRequestSize	Size of set SOL configuration parameters command request.
[out]	CompletionCode	The command completion code.

Return values

EFI_UNSUPPORTED

Unsupported in the NULL lib.

Definition at line 45 of file IpmiCommandLibNetFnTransport.c.

IpmiSetSystemBootOptions()

EFI_STATUS EFIAPI IpmiSetSystemBootOptions	(	IN IPMI_SET_BOOT_OPTIONS_REQUEST *	BootOptionsRequest,
		OUT IPMI_SET_BOOT_OPTIONS_RESPONSE *	BootOptionsResponse
	)

This function sets system boot option.

Parameters

[in]	BootOptionsRequest	Set system boot option request.
[out]	BootOptionsResponse	The response of set system boot option request.

Return values

EFI_SUCCESS	Command is sent successfully.
EFI_NOT_AVAILABLE_YET	Transport interface is not ready yet.
Other	Failure.

This function sets system boot option.

Parameters

[in]	BootOptionsRequest	Set system boot option request.
[out]	BootOptionsResponse	The response of set system boot option request.

Return values

EFI_UNSUPPORTED

Unsupported in the NULL lib.

Definition at line 97 of file IpmiCommandLibNetFnChassis.c.

IpmiSetWatchdogTimer()

EFI_STATUS EFIAPI IpmiSetWatchdogTimer	(	IN IPMI_SET_WATCHDOG_TIMER_REQUEST *	SetWatchdogTimer,
		OUT UINT8 *	CompletionCode
	)

This function sets watchdog timer.

Parameters

[in]	SetWatchdogTimer	Set watchdog timer request.
[out]	CompletionCode	The command completion code.

Return values

EFI_SUCCESS	Command is sent successfully.
EFI_NOT_AVAILABLE_YET	Transport interface is not ready yet.
Other	Failure.

This function sets watchdog timer.

Parameters

[in]	SetWatchdogTimer	Set watchdog timer request.
[out]	CompletionCode	The command completion code.

Return values

EFI_UNSUPPORTED

Unsupported in the NULL lib.

Definition at line 74 of file IpmiCommandLibNetFnApp.c.

IpmiSolActivating()

EFI_STATUS EFIAPI IpmiSolActivating	(	IN IPMI_SOL_ACTIVATING_REQUEST *	SolActivatingRequest,
		OUT UINT8 *	CompletionCode
	)

This function activates SOL

Parameters

[in]	SolActivatingRequest	SOL activating request.
[out]	CompletionCode	The command completion code.

Return values

EFI_SUCCESS	Command is sent successfully.
EFI_NOT_AVAILABLE_YET	Transport interface is not ready yet.
Other	Failure.

This function activates SOL

Parameters

[in]	SolActivatingRequest	SOL activating request.
[out]	CompletionCode	The command completion code.

Return values

EFI_UNSUPPORTED

Unsupported in the NULL lib.

Definition at line 23 of file IpmiCommandLibNetFnTransport.c.

IpmiWriteFruData()

EFI_STATUS EFIAPI IpmiWriteFruData	(	IN IPMI_WRITE_FRU_DATA_REQUEST *	WriteFruDataRequest,
		IN UINT32	WriteFruDataRequestSize,
		OUT IPMI_WRITE_FRU_DATA_RESPONSE *	WriteFruDataResponse
	)

This function gets chassis capability.

Parameters

[in]	WriteFruDataRequest	Write FRU data command request.
[in]	WriteFruDataRequestSize	Size of the write FRU data command request.
[out]	WriteFruDataResponse	Write FRU data response.

Return values

EFI_SUCCESS	Command is sent successfully.
EFI_NOT_AVAILABLE_YET	Transport interface is not ready yet.
Other	Failure.

This function gets chassis capability.

Parameters

[in]	WriteFruDataRequest	Write FRU data command request.
[in]	WriteFruDataRequestSize	Size of the write FRU data command request.
[out]	WriteFruDataResponse	Write FRU data response.

Return values

EFI_UNSUPPORTED

Unsupported in the NULL lib.

Definition at line 66 of file IpmiCommandLibNetFnStorage.c.