#include "RedfishPlatformConfigInternal.h"

Functions
EFI_STATUS	RedfishPlatformConfigGetValue (IN CHAR8 Schema, IN CHAR8 Version, IN EFI_STRING ConfigureLang, OUT EDKII_REDFISH_VALUE *Value)

EFI_STATUS	RedfishPlatformConfigGetAttribute (IN CHAR8 Schema, IN CHAR8 Version, IN EFI_STRING ConfigureLang, OUT EDKII_REDFISH_ATTRIBUTE *AttributeValue)

EFI_STATUS	RedfishPlatformConfigGetDefaultValue (IN CHAR8 Schema, IN CHAR8 Version, IN EFI_STRING ConfigureLang, IN UINT16 DefaultClass, OUT EDKII_REDFISH_VALUE *Value)

EFI_STATUS	RedfishPlatformConfigSetValue (IN CHAR8 Schema, IN CHAR8 Version, IN EFI_STRING ConfigureLang, IN EDKII_REDFISH_VALUE Value)

EFI_STATUS	RedfishPlatformConfigGetConfigureLang (IN CHAR8 Schema, IN CHAR8 Version, IN EFI_STRING Pattern, OUT EFI_STRING *ConfigureLangList, OUT UINTN Count)

EFI_STATUS EFIAPI	RedfishPlatformConfigGetSupportedSchema (OUT CHAR8 **SupportedSchema)

VOID EFIAPI	RedfishPlatformConfigProtocolInstalled (IN EFI_EVENT Event, IN VOID *Context)

EFI_STATUS EFIAPI	RedfishPlatformConfigLibConstructor (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

EFI_STATUS EFIAPI	RedfishPlatformConfigLibDestructor (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

Variables
REDFISH_PLATFORM_CONFIG_LIB_PRIVATE	mRedfishPlatformConfigLibPrivate

Detailed Description

Wrapper function to support Redfish Platform Config protocol.

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

Definition in file RedfishPlatformConfigLib.c.

Function Documentation

◆ RedfishPlatformConfigGetAttribute()

EFI_STATUS RedfishPlatformConfigGetAttribute	(	IN CHAR8 *	Schema,
		IN CHAR8 *	Version,
		IN EFI_STRING	ConfigureLang,
		OUT EDKII_REDFISH_ATTRIBUTE *	AttributeValue
	)

Get Redfish attribute value with the given Schema and Configure Language.

Parameters

[in]	Schema	The Redfish schema to query.
[in]	Version	The Redfish version to query.
[in]	ConfigureLang	The target value which match this configure Language.
[out]	AttributeValue	The attribute value.

Return values

EFI_SUCCESS	Value is returned successfully.
Others	Some error happened.

Definition at line 62 of file RedfishPlatformConfigLib.c.

◆ RedfishPlatformConfigGetConfigureLang()

EFI_STATUS RedfishPlatformConfigGetConfigureLang	(	IN CHAR8 *	Schema,
		IN CHAR8 *	Version,
		IN EFI_STRING	Pattern,
		OUT EFI_STRING **	ConfigureLangList,
		OUT UINTN *	Count
	)

Get the list of Configure Language from platform configuration by the given Schema and Pattern.

Parameters

[in]	Schema	The Redfish schema to query.
[in]	Version	The Redfish version to query.
[in]	Pattern	The target Configure Language pattern.
[out]	ConfigureLangList	The list of Configure Language.
[out]	Count	The number of Configure Language in ConfigureLangList.

Return values

EFI_SUCCESS	ConfigureLangList is returned successfully.
EFI_NOT_READY	Redfish Platform Config protocol is not ready.
Others	Some error happened.

Definition at line 168 of file RedfishPlatformConfigLib.c.

◆ RedfishPlatformConfigGetDefaultValue()

EFI_STATUS RedfishPlatformConfigGetDefaultValue	(	IN CHAR8 *	Schema,
		IN CHAR8 *	Version,
		IN EFI_STRING	ConfigureLang,
		IN UINT16	DefaultClass,
		OUT EDKII_REDFISH_VALUE *	Value
	)

Get Redfish default value with the given Schema and Configure Language.

Parameters

[in]	Schema	The Redfish schema to query.
[in]	Version	The Redfish version to query.
[in]	ConfigureLang	The target value which match this configure Language.
[in]	DefaultClass	The UEFI defined default class. Please refer to UEFI spec. 33.2.5.8 "defaults" for details.
[out]	Value	The returned value.

Return values

EFI_SUCCESS	Value is returned successfully.
Others	Some error happened.

Definition at line 97 of file RedfishPlatformConfigLib.c.

◆ RedfishPlatformConfigGetSupportedSchema()

EFI_STATUS EFIAPI RedfishPlatformConfigGetSupportedSchema ( OUT CHAR8 ** SupportedSchema )

Get the list of supported Redfish schema from platform configuration.

Parameters

[out] SupportedSchema The supported schema list which is separated by ';'. For example: "x-UEFI-redfish-Memory.v1_7_1;x-UEFI-redfish-Boot.v1_0_1" The SupportedSchema is allocated by the callee. It's caller's responsibility to free this buffer using FreePool().

Return values

EFI_SUCCESS	Schema is returned successfully.
EFI_NOT_READY	Redfish Platform Config protocol is not ready.
Others	Some error happened.

Definition at line 205 of file RedfishPlatformConfigLib.c.

◆ RedfishPlatformConfigGetValue()

EFI_STATUS RedfishPlatformConfigGetValue	(	IN CHAR8 *	Schema,
		IN CHAR8 *	Version,
		IN EFI_STRING	ConfigureLang,
		OUT EDKII_REDFISH_VALUE *	Value
	)

Get Redfish value with the given Schema and Configure Language.

Parameters

[in]	Schema	The Redfish schema to query.
[in]	Version	The Redfish version to query.
[in]	ConfigureLang	The target value which match this configure Language.
[out]	Value	The returned value.

Return values

EFI_SUCCESS	Value is returned successfully.
EFI_NOT_READY	Redfish Platform Config protocol is not ready.
Others	Some error happened.

Definition at line 29 of file RedfishPlatformConfigLib.c.

◆ RedfishPlatformConfigLibConstructor()

EFI_STATUS EFIAPI RedfishPlatformConfigLibConstructor	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

Create protocol listener and wait for Redfish Platform Config protocol.

Parameters

ImageHandle	The image handle.
SystemTable	The system table.

Return values

EFI_SUCCESS Protocol listener is registered successfully.

Definition at line 266 of file RedfishPlatformConfigLib.c.

◆ RedfishPlatformConfigLibDestructor()

EFI_STATUS EFIAPI RedfishPlatformConfigLibDestructor	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

Unloads the application and its installed protocol.

Parameters

ImageHandle	Handle that identifies the image to be unloaded.
SystemTable	The system table.

Return values

EFI_SUCCESS The image has been unloaded.

Definition at line 297 of file RedfishPlatformConfigLib.c.

◆ RedfishPlatformConfigProtocolInstalled()

VOID EFIAPI RedfishPlatformConfigProtocolInstalled	(	IN EFI_EVENT	Event,
		IN VOID *	Context
	)

This is a EFI_REDFISH_PLATFORM_CONFIG_PROTOCOL notification event handler.

Install HII package notification.

Parameters

[in]	Event	Event whose notification function is being invoked.
[in]	Context	Pointer to the notification function's context.

Definition at line 230 of file RedfishPlatformConfigLib.c.

◆ RedfishPlatformConfigSetValue()

EFI_STATUS RedfishPlatformConfigSetValue	(	IN CHAR8 *	Schema,
		IN CHAR8 *	Version,
		IN EFI_STRING	ConfigureLang,
		IN EDKII_REDFISH_VALUE	Value
	)

Set Redfish value with the given Schema and Configure Language.

Parameters

[in]	Schema	The Redfish schema to query.
[in]	Version	The Redfish version to query.
[in]	ConfigureLang	The target value which match this configure Language.
[in]	Value	The value to set.

Return values

EFI_SUCCESS	Value is returned successfully.
EFI_NOT_READY	Redfish Platform Config protocol is not ready.
Others	Some error happened.

Definition at line 133 of file RedfishPlatformConfigLib.c.

Variable Documentation

◆ mRedfishPlatformConfigLibPrivate

REDFISH_PLATFORM_CONFIG_LIB_PRIVATE mRedfishPlatformConfigLibPrivate

Definition at line 13 of file RedfishPlatformConfigLib.c.

Functions

Variables

Detailed Description

Function Documentation

◆ RedfishPlatformConfigGetAttribute()

◆ RedfishPlatformConfigGetConfigureLang()

◆ RedfishPlatformConfigGetDefaultValue()

◆ RedfishPlatformConfigGetSupportedSchema()

◆ RedfishPlatformConfigGetValue()

◆ RedfishPlatformConfigLibConstructor()

◆ RedfishPlatformConfigLibDestructor()

◆ RedfishPlatformConfigProtocolInstalled()

◆ RedfishPlatformConfigSetValue()

Variable Documentation

◆ mRedfishPlatformConfigLibPrivate