EdkIIRedfishPlatformConfig.h File Reference

Go to the source code of this file.

Data Structures
union	EDKII_REDFISH_TYPE_VALUE
struct	EDKII_REDFISH_VALUE
struct	EDKII_REDFISH_ATTRIBUTE_VALUE
struct	EDKII_REDFISH_POSSIBLE_VALUES
struct	EDKII_REDFISH_ATTRIBUTE
struct	_EDKII_REDFISH_PLATFORM_CONFIG_PROTOCOL

Macros
#define	REDFISH_PLATFORM_CONFIG_VERSION   0x00010000
#define	EDKII_REDFISH_DEFAULT_CLASS_STANDARD   EFI_HII_DEFAULT_CLASS_STANDARD

Typedefs
typedef struct _EDKII_REDFISH_PLATFORM_CONFIG_PROTOCOL	EDKII_REDFISH_PLATFORM_CONFIG_PROTOCOL
typedef EFI_STATUS(EFIAPI *	EDKII_REDFISH_PLATFORM_CONFIG_GET_VALUE) (IN EDKII_REDFISH_PLATFORM_CONFIG_PROTOCOL *This, IN CHAR8 *Schema, IN CHAR8 *Version, IN EFI_STRING ConfigureLang, OUT EDKII_REDFISH_VALUE *Value)
typedef EFI_STATUS(EFIAPI *	EDKII_REDFISH_PLATFORM_CONFIG_GET_DEFAULT_VALUE) (IN EDKII_REDFISH_PLATFORM_CONFIG_PROTOCOL *This, IN CHAR8 *Schema, IN CHAR8 *Version, IN EFI_STRING ConfigureLang, IN UINT16 DefaultClass, OUT EDKII_REDFISH_VALUE *Value)
typedef EFI_STATUS(EFIAPI *	EDKII_REDFISH_PLATFORM_CONFIG_SET_VALUE) (IN EDKII_REDFISH_PLATFORM_CONFIG_PROTOCOL *This, IN CHAR8 *Schema, IN CHAR8 *Version, IN EFI_STRING ConfigureLang, IN EDKII_REDFISH_VALUE Value)
typedef EFI_STATUS(EFIAPI *	EDKII_REDFISH_PLATFORM_CONFIG_GET_ATTRIBUTE) (IN EDKII_REDFISH_PLATFORM_CONFIG_PROTOCOL *This, IN CHAR8 *Schema, IN CHAR8 *Version, IN EFI_STRING ConfigureLang, OUT EDKII_REDFISH_ATTRIBUTE *AttributeValue)
typedef EFI_STATUS(EFIAPI *	EDKII_REDFISH_PLATFORM_CONFIG_GET_CONFIG_LANG) (IN EDKII_REDFISH_PLATFORM_CONFIG_PROTOCOL *This, IN CHAR8 *Schema, IN CHAR8 *Version, IN EFI_STRING RegexPattern, OUT EFI_STRING **ConfigureLangList, OUT UINTN *Count)
typedef EFI_STATUS(EFIAPI *	EDKII_REDFISH_PLATFORM_CONFIG_GET_SUPPORTED_SCHEMA) (IN EDKII_REDFISH_PLATFORM_CONFIG_PROTOCOL *This, OUT CHAR8 **SupportedSchema)

Enumerations
enum	EDKII_REDFISH_VALUE_TYPES {   RedfishValueTypeUnknown = 0 , RedfishValueTypeInteger , RedfishValueTypeBoolean , RedfishValueTypeString ,   RedfishValueTypeStringArray , RedfishValueTypeIntegerArray , RedfishValueTypeBooleanArray , RedfishValueTypeMax }
enum	EDKII_REDFISH_ATTRIBUTE_TYPES {   RedfishAttributeTypeUnknown = 0 , RedfishAttributeTypeEnumeration , RedfishAttributeTypeString , RedfishAttributeTypeInteger ,   RedfishAttributeTypeBoolean , RedfishAttributeTypePassword }

Variables
EFI_GUID	gEdkIIRedfishPlatformConfigProtocolGuid

Detailed Description

This file defines the EDKII_REDFISH_PLATFORM_CONFIG_PROTOCOL interface.

(C) Copyright 2021-2022 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 EdkIIRedfishPlatformConfig.h.

Macro Definition Documentation

EDKII_REDFISH_DEFAULT_CLASS_STANDARD

#define EDKII_REDFISH_DEFAULT_CLASS_STANDARD   EFI_HII_DEFAULT_CLASS_STANDARD

Definition at line 131 of file EdkIIRedfishPlatformConfig.h.

REDFISH_PLATFORM_CONFIG_VERSION

#define REDFISH_PLATFORM_CONFIG_VERSION   0x00010000

Definition at line 19 of file EdkIIRedfishPlatformConfig.h.

Typedef Documentation

EDKII_REDFISH_PLATFORM_CONFIG_GET_ATTRIBUTE

typedef EFI_STATUS(EFIAPI * EDKII_REDFISH_PLATFORM_CONFIG_GET_ATTRIBUTE) (IN EDKII_REDFISH_PLATFORM_CONFIG_PROTOCOL *This, 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]	This	Pointer to EDKII_REDFISH_PLATFORM_CONFIG_PROTOCOL instance.
[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 196 of file EdkIIRedfishPlatformConfig.h.

EDKII_REDFISH_PLATFORM_CONFIG_GET_CONFIG_LANG

typedef EFI_STATUS(EFIAPI * EDKII_REDFISH_PLATFORM_CONFIG_GET_CONFIG_LANG) (IN EDKII_REDFISH_PLATFORM_CONFIG_PROTOCOL *This, IN CHAR8 *Schema, IN CHAR8 *Version, IN EFI_STRING RegexPattern, OUT EFI_STRING **ConfigureLangList, OUT UINTN *Count)

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

Parameters

[in]	This	Pointer to EDKII_REDFISH_PLATFORM_CONFIG_PROTOCOL instance.
[in]	Schema	The Redfish schema to query.
[in]	Version	The Redfish version to query.
[in]	RegexPattern	The target Configure Language pattern. This is used for regular expression matching.
[out]	ConfigureLangList	The list of Configure Language.
[out]	Count	The number of Configure Language in ConfigureLangList.

Return values

EFI_SUCCESS	ConfigureLangList is returned successfully.
Others	Some error happened.

Definition at line 220 of file EdkIIRedfishPlatformConfig.h.

EDKII_REDFISH_PLATFORM_CONFIG_GET_DEFAULT_VALUE

typedef EFI_STATUS(EFIAPI * EDKII_REDFISH_PLATFORM_CONFIG_GET_DEFAULT_VALUE) (IN EDKII_REDFISH_PLATFORM_CONFIG_PROTOCOL *This, 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]	This	Pointer to EDKII_REDFISH_PLATFORM_CONFIG_PROTOCOL instance.
[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 149 of file EdkIIRedfishPlatformConfig.h.

EDKII_REDFISH_PLATFORM_CONFIG_GET_SUPPORTED_SCHEMA

typedef EFI_STATUS(EFIAPI * EDKII_REDFISH_PLATFORM_CONFIG_GET_SUPPORTED_SCHEMA) (IN EDKII_REDFISH_PLATFORM_CONFIG_PROTOCOL *This, OUT CHAR8 **SupportedSchema)

Get the list of supported Redfish schema from platform configuration.

Parameters

[in]	This	Pointer to EDKII_REDFISH_PLATFORM_CONFIG_PROTOCOL instance.
[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.
Others	Some error happened.

Definition at line 244 of file EdkIIRedfishPlatformConfig.h.

EDKII_REDFISH_PLATFORM_CONFIG_GET_VALUE

typedef EFI_STATUS(EFIAPI * EDKII_REDFISH_PLATFORM_CONFIG_GET_VALUE) (IN EDKII_REDFISH_PLATFORM_CONFIG_PROTOCOL *This, 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]	This	Pointer to EDKII_REDFISH_PLATFORM_CONFIG_PROTOCOL instance.
[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.
Others	Some error happened.

Definition at line 119 of file EdkIIRedfishPlatformConfig.h.

EDKII_REDFISH_PLATFORM_CONFIG_PROTOCOL

typedef struct _EDKII_REDFISH_PLATFORM_CONFIG_PROTOCOL EDKII_REDFISH_PLATFORM_CONFIG_PROTOCOL

Definition at line 14 of file EdkIIRedfishPlatformConfig.h.

EDKII_REDFISH_PLATFORM_CONFIG_SET_VALUE

typedef EFI_STATUS(EFIAPI * EDKII_REDFISH_PLATFORM_CONFIG_SET_VALUE) (IN EDKII_REDFISH_PLATFORM_CONFIG_PROTOCOL *This, 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]	This	Pointer to EDKII_REDFISH_PLATFORM_CONFIG_PROTOCOL instance.
[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.
Others	Some error happened.

Definition at line 173 of file EdkIIRedfishPlatformConfig.h.

Enumeration Type Documentation

EDKII_REDFISH_ATTRIBUTE_TYPES

enum EDKII_REDFISH_ATTRIBUTE_TYPES

Definition of EDKII_REDFISH_ATTRIBUTE_TYPES

Definition at line 50 of file EdkIIRedfishPlatformConfig.h.

EDKII_REDFISH_VALUE_TYPES

enum EDKII_REDFISH_VALUE_TYPES

Definition of EDKII_REDFISH_VALUE_TYPES

Definition at line 36 of file EdkIIRedfishPlatformConfig.h.