IpmiCommandLibNetFnApp.c 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)

Detailed Description

IPMI Command - NetFnApp NULL instance library.

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 IpmiCommandLibNetFnApp.c.

Function Documentation

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_UNSUPPORTED

Unsupported in the NULL lib.

Definition at line 146 of file IpmiCommandLibNetFnApp.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_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.
[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.

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_UNSUPPORTED

Unsupported in the NULL lib.

Definition at line 22 of file IpmiCommandLibNetFnApp.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_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 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.

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_UNSUPPORTED

Unsupported in the NULL lib.

Definition at line 39 of file IpmiCommandLibNetFnApp.c.

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_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_UNSUPPORTED

Unsupported in the NULL lib.

Definition at line 92 of file IpmiCommandLibNetFnApp.c.

IpmiResetWatchdogTimer()

EFI_STATUS EFIAPI IpmiResetWatchdogTimer

(

OUT UINT8 *

CompletionCode

)

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_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_UNSUPPORTED

Unsupported in the NULL lib.

Definition at line 110 of file IpmiCommandLibNetFnApp.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_UNSUPPORTED

Unsupported in the NULL lib.

Definition at line 74 of file IpmiCommandLibNetFnApp.c.