OcFirmwareRuntime.h File Reference

#include <Uefi.h>

Go to the source code of this file.

Data Structures
struct	OC_FWRT_CONFIG_
struct	OC_FIRMWARE_RUNTIME_PROTOCOL

Macros
#define	OC_FIRMWARE_RUNTIME_REVISION   12
#define	OC_FIRMWARE_RUNTIME_PROTOCOL_GUID

Typedefs
typedef struct OC_FWRT_CONFIG_	OC_FWRT_CONFIG
typedef VOID(EFIAPI *	OC_FWRT_GET_CURRENT_CONFIG) (OUT OC_FWRT_CONFIG *Config)
typedef VOID(EFIAPI *	OC_FWRT_SET_MAIN_CONFIG) (IN CONST OC_FWRT_CONFIG *Config)
typedef VOID(EFIAPI *	OC_FWRT_SET_OVERRIDE_CONFIG) (IN CONST OC_FWRT_CONFIG *Config OPTIONAL)
typedef EFI_STATUS(EFIAPI *	OC_FWRT_ON_GET_VARIABLE) (IN EFI_GET_VARIABLE GetVariable, OUT EFI_GET_VARIABLE *OrgGetVariable OPTIONAL)
typedef EFI_STATUS(EFIAPI *	OC_FWRT_ON_SET_ADDRESS_MAP) (IN EFI_SET_VIRTUAL_ADDRESS_MAP SetAddressMap OPTIONAL, IN BOOLEAN Enabled)
typedef EFI_STATUS(EFIAPI *	OC_FWRT_GET_EXEC_AREA) (OUT EFI_PHYSICAL_ADDRESS *BaseAddress, OUT UINTN *Pages)

Variables
EFI_GUID	gOcFirmwareRuntimeProtocolGuid

Detailed Description

Copyright (C) 2019, vit9696. All rights reserved.

All rights reserved.

This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Definition in file OcFirmwareRuntime.h.

Macro Definition Documentation

OC_FIRMWARE_RUNTIME_PROTOCOL_GUID

#define OC_FIRMWARE_RUNTIME_PROTOCOL_GUID

Value:

  { 0x570332E4, 0xFC50, 0x4B21,             \
    { 0xAB, 0xE8, 0xAE, 0x72, 0xF0, 0x5B, 0x4F, 0xF7 } }

OC_FIRMWARE_RUNTIME_PROTOCOL_GUID 570332E4-FC50-4B21-ABE8-AE72F05B4FF7

Definition at line 26 of file OcFirmwareRuntime.h.

OC_FIRMWARE_RUNTIME_REVISION

#define OC_FIRMWARE_RUNTIME_REVISION   12

Definition at line 20 of file OcFirmwareRuntime.h.

Typedef Documentation

OC_FWRT_CONFIG

typedef struct OC_FWRT_CONFIG_ OC_FWRT_CONFIG

Configuration request to change firmware runtime behaviour.

OC_FWRT_GET_CURRENT_CONFIG

typedef VOID(EFIAPI * OC_FWRT_GET_CURRENT_CONFIG) (OUT OC_FWRT_CONFIG *Config)

Get current used configuration data.

Parameters

[out]

Config

Current configuration to store.

Definition at line 77 of file OcFirmwareRuntime.h.

OC_FWRT_GET_EXEC_AREA

typedef EFI_STATUS(EFIAPI * OC_FWRT_GET_EXEC_AREA) (OUT EFI_PHYSICAL_ADDRESS *BaseAddress, OUT UINTN *Pages)

Obtain area that needs to be executable in OS runtime.

Parameters

[out]	BaseAddress	Executable area start.
[out]	Pages	Number of executable pages.

Return values

EFI_SUCCESS	on success.
EFI_UNSUPPORTED	not required.

Definition at line 147 of file OcFirmwareRuntime.h.

OC_FWRT_ON_GET_VARIABLE

typedef EFI_STATUS(EFIAPI * OC_FWRT_ON_GET_VARIABLE) (IN EFI_GET_VARIABLE GetVariable, OUT EFI_GET_VARIABLE *OrgGetVariable OPTIONAL)

Set GetVariable override for customising values.

Parameters

[in]	GetVariable	GetVariable to call on each call.
[out]	OrgGetVariable	Original GetVariable to call from GetVariable.

Return values

EFI_SUCCESS

on successful override.

Definition at line 113 of file OcFirmwareRuntime.h.

OC_FWRT_ON_SET_ADDRESS_MAP

typedef EFI_STATUS(EFIAPI * OC_FWRT_ON_SET_ADDRESS_MAP) (IN EFI_SET_VIRTUAL_ADDRESS_MAP SetAddressMap OPTIONAL, IN BOOLEAN Enabled)

Activate gRT->SetVirtualAddressMap routing.

Parameters

[in]	SetAddressMap	Custom address map handler, optional.
[in]	Enabled	Enable custom handler on call.

Return values

EFI_SUCCESS	when SetAddressMap was set for the first time.
EFI_NOT_FOUND	when calling without SetAddressMap for the first time.
EFI_ALREADY_STARTED	when SetAddressMap was already set but passed again.
EFI_SUCCESS	when Enabled was updated with new value.

Definition at line 131 of file OcFirmwareRuntime.h.

OC_FWRT_SET_MAIN_CONFIG

typedef VOID(EFIAPI * OC_FWRT_SET_MAIN_CONFIG) (IN CONST OC_FWRT_CONFIG *Config)

Set main configuration.

Parameters

[in]

Config

Runtime services configuration to apply.

Definition at line 88 of file OcFirmwareRuntime.h.

OC_FWRT_SET_OVERRIDE_CONFIG

typedef VOID(EFIAPI * OC_FWRT_SET_OVERRIDE_CONFIG) (IN CONST OC_FWRT_CONFIG *Config OPTIONAL)

Perform configuration override, NULL Config implies disable override.

Parameters

[in]

Config

Runtime services configuration to apply, optional.

Definition at line 99 of file OcFirmwareRuntime.h.

Variable Documentation

gOcFirmwareRuntimeProtocolGuid

EFI_GUID gOcFirmwareRuntimeProtocolGuid

extern

Firmware runtime protocol GUID.