TianoCore EDK2 master
Loading...
Searching...
No Matches
PlatformConfig.h File Reference
#include <Base.h>

Go to the source code of this file.

Data Structures

struct  PLATFORM_CONFIG
 

Macros

#define PLATFORM_CONFIG_F_GRAPHICS_RESOLUTION   BIT0
 
#define PLATFORM_CONFIG_F_DOWNGRADE   BIT63
 

Functions

EFI_STATUS EFIAPI PlatformConfigSave (IN PLATFORM_CONFIG *PlatformConfig)
 
EFI_STATUS EFIAPI PlatformConfigLoad (OUT PLATFORM_CONFIG *PlatformConfig, OUT UINT64 *OptionalElements)
 

Variables

CHAR16 mVariableName []
 
CHAR16 mHiiFormName []
 

Detailed Description

Utility functions for serializing (persistently storing) and deserializing OVMF's platform configuration.

Copyright (C) 2014, Red Hat, Inc.

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

Definition in file PlatformConfig.h.

Macro Definition Documentation

◆ PLATFORM_CONFIG_F_DOWNGRADE

#define PLATFORM_CONFIG_F_DOWNGRADE   BIT63

Definition at line 51 of file PlatformConfig.h.

◆ PLATFORM_CONFIG_F_GRAPHICS_RESOLUTION

#define PLATFORM_CONFIG_F_GRAPHICS_RESOLUTION   BIT0

Definition at line 50 of file PlatformConfig.h.

Function Documentation

◆ PlatformConfigLoad()

EFI_STATUS EFIAPI PlatformConfigLoad ( OUT PLATFORM_CONFIG PlatformConfig,
OUT UINT64 *  OptionalElements 
)

Load and deserialize platform configuration.

When the function fails, output parameters are indeterminate.

Parameters
[out]PlatformConfigThe platform configuration to receive the loaded data.
[out]OptionalElementsThis bitmap describes the presence of optional configuration elements that have been loaded. PLATFORM_CONFIG_F_DOWNGRADE means that some unknown elements, present in the wire format, have been ignored.
Return values
EFI_SUCCESSLoading & deserialization successful.
Returns
Error codes returned by GetVariable2().

Definition at line 78 of file PlatformConfig.c.

◆ PlatformConfigSave()

EFI_STATUS EFIAPI PlatformConfigSave ( IN PLATFORM_CONFIG PlatformConfig)

Serialize and persistently save platform configuration.

Parameters
[in]PlatformConfigThe platform configuration to serialize and save.
Returns
Status codes returned by gRT->SetVariable().

Definition at line 36 of file PlatformConfig.c.

Variable Documentation

◆ mHiiFormName

CHAR16 mHiiFormName[]
extern

Definition at line 25 of file PlatformConfig.c.

◆ mVariableName

CHAR16 mVariableName[]
extern

Definition at line 58 of file PlatDriOverrideDxe.c.