RedfishPlatformConfigLib.h File Reference

#include <Protocol/EdkIIRedfishPlatformConfig.h>

Go to the source code of this file.

Functions
EFI_STATUS	RedfishPlatformConfigGetValue (IN CHAR8 *Schema, IN CHAR8 *Version, IN EFI_STRING ConfigureLang, 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)
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)

Detailed Description

Definitions of RedfishPlatformConfigLib

(C) Copyright 2021 Hewlett Packard Enterprise Development LP
Copyright (c) 2022-2024, NVIDIA CORPORATION & AFFILIATES. All rights reserved.

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

Definition in file RedfishPlatformConfigLib.h.

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.

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.