LegacyRegion.h File Reference

Go to the source code of this file.

Data Structures
struct	_EFI_LEGACY_REGION_PROTOCOL

Macros
#define	EFI_LEGACY_REGION_PROTOCOL_GUID

Typedefs
typedef struct _EFI_LEGACY_REGION_PROTOCOL	EFI_LEGACY_REGION_PROTOCOL
typedef EFI_STATUS(EFIAPI *	EFI_LEGACY_REGION_DECODE) (IN EFI_LEGACY_REGION_PROTOCOL *This, IN UINT32 Start, IN UINT32 Length, IN BOOLEAN *On)
typedef EFI_STATUS(EFIAPI *	EFI_LEGACY_REGION_LOCK) (IN EFI_LEGACY_REGION_PROTOCOL *This, IN UINT32 Start, IN UINT32 Length, OUT UINT32 *Granularity OPTIONAL)
typedef EFI_STATUS(EFIAPI *	EFI_LEGACY_REGION_BOOT_LOCK) (IN EFI_LEGACY_REGION_PROTOCOL *This, IN UINT32 Start, IN UINT32 Length, OUT UINT32 *Granularity OPTIONAL)
typedef EFI_STATUS(EFIAPI *	EFI_LEGACY_REGION_UNLOCK) (IN EFI_LEGACY_REGION_PROTOCOL *This, IN UINT32 Start, IN UINT32 Length, OUT UINT32 *Granularity OPTIONAL)

Variables
EFI_GUID	gEfiLegacyRegionProtocolGuid

Detailed Description

This protocol manages the legacy memory regions between 0xc0000 - 0xfffff.

Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License that 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.

Revision Reference:

This protocol is defined in Framework for EFI Compatibility Support Module spec Version 0.97.

Definition in file LegacyRegion.h.

Macro Definition Documentation

EFI_LEGACY_REGION_PROTOCOL_GUID

#define EFI_LEGACY_REGION_PROTOCOL_GUID

Value:

  { \
    0xfc9013a, 0x568, 0x4ba9, {0x9b, 0x7e, 0xc9, 0xc3, 0x90, 0xa6, 0x60, 0x9b } \
  }

Definition at line 22 of file LegacyRegion.h.

Typedef Documentation

EFI_LEGACY_REGION_BOOT_LOCK

typedef EFI_STATUS(EFIAPI * EFI_LEGACY_REGION_BOOT_LOCK) (IN EFI_LEGACY_REGION_PROTOCOL *This, IN UINT32 Start, IN UINT32 Length, OUT UINT32 *Granularity OPTIONAL)

Sets a region to read only and ensures that flash is locked from being inadvertently modified.

Parameters

This	Indicates the EFI_LEGACY_REGION_PROTOCOL instance
Start	The start of region to lock.
Length	The size in bytes of the region.
Granularity	Lock attribute affects this granularity in bytes.

Return values

EFI_SUCCESS

The region was made read only and flash is locked.

Definition at line 82 of file LegacyRegion.h.

EFI_LEGACY_REGION_DECODE

typedef EFI_STATUS(EFIAPI * EFI_LEGACY_REGION_DECODE) (IN EFI_LEGACY_REGION_PROTOCOL *This, IN UINT32 Start, IN UINT32 Length, IN BOOLEAN *On)

Sets hardware to decode or not decode a region.

Parameters

This	Indicates the EFI_LEGACY_REGION_PROTOCOL instance
Start	The start of the region to decode.
Length	The size in bytes of the region.
On	The decode/nondecode flag.

Return values

EFI_SUCCESS

The decode range successfully changed.

Definition at line 41 of file LegacyRegion.h.

EFI_LEGACY_REGION_LOCK

typedef EFI_STATUS(EFIAPI * EFI_LEGACY_REGION_LOCK) (IN EFI_LEGACY_REGION_PROTOCOL *This, IN UINT32 Start, IN UINT32 Length, OUT UINT32 *Granularity OPTIONAL)

Sets a region to read only.

Parameters

This	Indicates the EFI_LEGACY_REGION_PROTOCOL instance.
Start	The start of region to lock.
Length	The size in bytes of the region.
Granularity	Lock attribute affects this granularity in bytes.

Return values

EFI_SUCCESS

The region was made read only.

Definition at line 61 of file LegacyRegion.h.

EFI_LEGACY_REGION_PROTOCOL

typedef struct _EFI_LEGACY_REGION_PROTOCOL EFI_LEGACY_REGION_PROTOCOL

Definition at line 27 of file LegacyRegion.h.

EFI_LEGACY_REGION_UNLOCK

typedef EFI_STATUS(EFIAPI * EFI_LEGACY_REGION_UNLOCK) (IN EFI_LEGACY_REGION_PROTOCOL *This, IN UINT32 Start, IN UINT32 Length, OUT UINT32 *Granularity OPTIONAL)

Sets a region to read-write.

Parameters

This	Indicates the EFI_LEGACY_REGION_PROTOCOL instance
Start	The start of region to lock.
Length	The size in bytes of the region.
Granularity	Lock attribute affects this granularity in bytes.

Return values

EFI_SUCCESS

The region was successfully made read-write.

Definition at line 102 of file LegacyRegion.h.

Variable Documentation

gEfiLegacyRegionProtocolGuid

EFI_GUID gEfiLegacyRegionProtocolGuid

extern

Definition at line 148 of file UserGlobalVar.c.