FirmwareVolumeShadowPpi.h File Reference

Go to the source code of this file.

Data Structures
struct	EDKII_PEI_FIRMWARE_VOLUME_SHADOW_PPI

Macros
#define	EDKII_FIRMWARE_VOLUME_SHADOW_PPI_GUID

Typedefs
typedef EFI_STATUS(EFIAPI *	EDKII_PEI_FIRMWARE_VOLUME_SHADOW) (IN EFI_PHYSICAL_ADDRESS FirmwareVolumeBase, IN VOID *Destination, IN UINTN DestinationLength)

Variables
EFI_GUID	gEdkiiPeiFirmwareVolumeShadowPpiGuid

Detailed Description

Define PPI to shadow Firmware Volume from flash to Permanent Memory.

Copyright (c) 2023, Intel Corporation. All rights reserved.

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

Definition in file FirmwareVolumeShadowPpi.h.

Macro Definition Documentation

EDKII_FIRMWARE_VOLUME_SHADOW_PPI_GUID

#define EDKII_FIRMWARE_VOLUME_SHADOW_PPI_GUID

Value:

  { \
    0x7dfe756c, 0xed8d, 0x4d77, { 0x9e, 0xc4, 0x39, 0x9a, 0x8a, 0x81, 0x51, 0x16 } \
  }

Definition at line 16 of file FirmwareVolumeShadowPpi.h.

Typedef Documentation

EDKII_PEI_FIRMWARE_VOLUME_SHADOW

typedef EFI_STATUS(EFIAPI * EDKII_PEI_FIRMWARE_VOLUME_SHADOW) (IN EFI_PHYSICAL_ADDRESS FirmwareVolumeBase, IN VOID *Destination, IN UINTN DestinationLength)

Copy FV to Destination. Length of copy is FV length from FV Header.

Parameters

[in]	FirmwareVolumeBase	Base address of FV to shadow. Length of FV is in FV Header.
[in]	Destination	Pointer to the Buffer in system memory to shadow FV.
[in]	DestinationLength	Size of Destination buffer in bytes.

Return values

EFI_SUCCESS	Shadow complete
EFI_INVALID_PARAMETER	Destination is NULL
EFI_INVALID_PARAMETER	DestinationLength = 0.
EFI_INVALID_PARAMETER	FV does not have valid FV Header.
EFI_INVALID_PARAMETER	FV overlaps Destination.
EFI_INVALID_PARAMETER	Destination + DestinationLength rolls over 4GB for 32-bit or 64-bit rollover.
EFI_BUFFER_TOO_SMALL	DestinationLength less than FV length from FV Header.
EFI_UNSUPPORTED	FirmwareVolumeBase to FVBase + FVLength does not support shadow. Caller should fallback to CopyMem().

Definition at line 45 of file FirmwareVolumeShadowPpi.h.