OcVariableLib.h

Go to the documentation of this file.

 
#ifndef OC_VARIABLE_LIB_H
#define OC_VARIABLE_LIB_H
 
#include <Uefi.h>
#include <Library/OcConfigurationLib.h>
#include <Library/OcStorageLib.h>
#include <Protocol/OcFirmwareRuntime.h>
 
#define OPEN_CORE_NVRAM_ROOT_PATH  L"NVRAM"
 
#define OPEN_CORE_NVRAM_FILENAME  L"nvram.plist"
 
#define OPEN_CORE_NVRAM_FALLBACK_FILENAME  L"nvram.fallback"
 
#define OPEN_CORE_NVRAM_USED_FILENAME  L"nvram.used"
 
#define OPEN_CORE_NVRAM_ATTR  (EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS)
 
#define OPEN_CORE_NVRAM_NV_ATTR  (EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE)
 
#define OPEN_CORE_INT_NVRAM_ATTR  EFI_VARIABLE_BOOTSERVICE_ACCESS
 
VOID
OcVariableInit (
  IN BOOLEAN  ForceOcWriteFlash
  );
 
EFI_STATUS
OcSetSystemVariable (
  IN CHAR16    *VariableName,
  IN UINT32    Attributes,
  IN UINTN     DataSize,
  IN VOID      *Data,
  IN EFI_GUID  *VendorGuid  OPTIONAL
  );
 
EFI_STATUS
OcProcessVariableGuid (
  IN  CONST CHAR8            *AsciiVariableGuid,
  OUT GUID                   *VariableGuid,
  IN  OC_NVRAM_LEGACY_MAP    *Schema  OPTIONAL,
  OUT OC_NVRAM_LEGACY_ENTRY  **SchemaEntry  OPTIONAL
  );
 
BOOLEAN
OcVariableIsAllowedBySchemaEntry (
  IN OC_NVRAM_LEGACY_ENTRY  *SchemaEntry,
  IN EFI_GUID               *VariableGuid OPTIONAL,
  IN CONST VOID             *VariableName,
  IN OC_STRING_FORMAT       StringFormat
  );
 
VOID
OcSetNvramVariable (
  IN CONST CHAR8            *AsciiVariableName,
  IN EFI_GUID               *VariableGuid,
  IN UINT32                 Attributes,
  IN UINT32                 VariableSize,
  IN VOID                   *VariableData,
  IN OC_NVRAM_LEGACY_ENTRY  *SchemaEntry OPTIONAL,
  IN BOOLEAN                Overwrite
  );
 
EFI_LOAD_OPTION *
OcGetBootOptionData (
  OUT UINTN           *OptionSize,
  IN  UINT16          BootOption,
  IN  CONST EFI_GUID  *BootGuid
  );
 
EFI_STATUS
OcResetNvram (
  IN     BOOLEAN  PreserveBoot
  );
 
OC_FIRMWARE_RUNTIME_PROTOCOL *
OcDisableNvramProtection (
  VOID
  );
 
VOID
OcRestoreNvramProtection (
  IN OC_FIRMWARE_RUNTIME_PROTOCOL  *FwRuntime
  );
 
VOID
OcDeleteVariables (
  IN BOOLEAN  PreserveBoot
  );
 
typedef enum _OC_PROCESS_VARIABLE_RESULT {
  OcProcessVariableContinue,
  OcProcessVariableRestart,
  OcProcessVariableAbort
} OC_PROCESS_VARIABLE_RESULT;
 
typedef
OC_PROCESS_VARIABLE_RESULT
(EFIAPI *OC_PROCESS_VARIABLE)(
  IN EFI_GUID           *Guid,
  IN CHAR16             *Name,
  IN VOID               *Context OPTIONAL
  );
 
VOID
OcScanVariables (
  IN OC_PROCESS_VARIABLE  ProcessVariable,
  IN VOID                 *Context
  );
 
EFI_STATUS
OcGetSip (
  OUT UINT32  *CsrActiveConfig,
  OUT UINT32  *Attributes          OPTIONAL
  );
 
EFI_STATUS
OcSetSip (
  IN  UINT32  *CsrActiveConfig,
  IN  UINT32  Attributes
  );
 
BOOLEAN
OcIsSipEnabled (
  IN  EFI_STATUS  GetStatus,
  IN  UINT32      CsrActiveConfig
  );
 
EFI_STATUS
OcToggleSip (
  IN  UINT32  CsrActiveConfig
  );
 
VOID
OcLoadLegacyNvram (
  IN OC_STORAGE_CONTEXT   *Storage,
  IN OC_NVRAM_LEGACY_MAP  *LegacyMap,
  IN BOOLEAN              LegacyOverwrite,
  IN BOOLEAN              RequestBootVarRouting
  );
 
VOID
EFIAPI
OcSaveLegacyNvram (
  VOID
  );
 
VOID
EFIAPI
OcResetLegacyNvram (
  VOID
  );
 
VOID
EFIAPI
OcSwitchToFallbackLegacyNvram (
  VOID
  );
 
EFI_STATUS
OcShimRetainProtocol (
  IN BOOLEAN  Required
  );
 
#endif // OC_VARIABLE_LIB_H