mirror of
https://github.com/acidanthera/audk.git
synced 2025-04-08 17:05:09 +02:00
Add LegacyRegion 2 protocol definition in MdePkg
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9459 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
qhuang8
parent
aaa2cc19dd
commit
23bb88ecb5
242
MdePkg/Include/Protocol/LegacyRegion2.h
Normal file
242
MdePkg/Include/Protocol/LegacyRegion2.h
Normal file
@ -0,0 +1,242 @@
|
||||
/** @file
|
||||
The Legacy Region Protocol controls the read, write and boot-lock attributes for
|
||||
the region 0xC0000 to 0xFFFFF.
|
||||
|
||||
Copyright (c) 2009, 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
|
||||
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.
|
||||
|
||||
@par Revision Reference:
|
||||
This Protocol is defined in UEFI Platform Initialization Specification 1.2
|
||||
Volume 5: Standards
|
||||
|
||||
@attention This protocol appears to be 'EFI_LEGACY_REGION_PROTOCOL' in current PI 1.2
|
||||
public spec. Therefore, some names are different from public PI 1.2 spec and we should
|
||||
remove this attention when they appear in public PI 1.2 spec in the future.
|
||||
|
||||
**/
|
||||
|
||||
#ifndef __LEGACY_REGION2_H__
|
||||
#define __LEGACY_REGION2_H__
|
||||
|
||||
|
||||
#define EFI_LEGACY_REGION2_PROTOCOL_GUID \
|
||||
{ \
|
||||
0x70101eaf, 0x85, 0x440c, {0xb3, 0x56, 0x8e, 0xe3, 0x6f, 0xef, 0x24, 0xf0 } \
|
||||
}
|
||||
|
||||
typedef struct _EFI_LEGACY_REGION2_PROTOCOL EFI_LEGACY_REGION2_PROTOCOL;
|
||||
|
||||
/**
|
||||
Modify the hardware to allow (decode) or disallow (not decode) memory reads in a region.
|
||||
|
||||
If the On parameter evaluates to TRUE, this function enables memory reads in the address range
|
||||
Start to (Start + Length - 1).
|
||||
If the On parameter evaluates to FALSE, this function disables memory reads in the address range
|
||||
Start to (Start + Length - 1).
|
||||
|
||||
@param This[in] Indicates the EFI_LEGACY_REGION2_PROTOCOL instance.
|
||||
@param Start[in] The beginning of the physical address of the region whose attributes
|
||||
should be modified.
|
||||
@param Length[in] The number of bytes of memory whose attributes should be modified.
|
||||
The actual number of bytes modified may be greater than the number
|
||||
specified.
|
||||
@param Granularity[out] The number of bytes in the last region affected. This may be less
|
||||
than the total number of bytes affected if the starting address
|
||||
was not aligned to a region's starting address or if the length
|
||||
was greater than the number of bytes in the first region.
|
||||
@param On[in] Decode / Non-Decode flag.
|
||||
|
||||
@retval EFI_SUCCESS The region's attributes were successfully modified.
|
||||
@retval EFI_INVALID_PARAMETER If Start or Length describe an address not in the Legacy Region.
|
||||
|
||||
**/
|
||||
typedef
|
||||
EFI_STATUS
|
||||
(EFIAPI *EFI_LEGACY_REGION2_DECODE) (
|
||||
IN EFI_LEGACY_REGION2_PROTOCOL *This,
|
||||
IN UINT32 Start,
|
||||
IN UINT32 Length,
|
||||
OUT UINT32 *Granularity,
|
||||
IN BOOLEAN *On
|
||||
);
|
||||
|
||||
|
||||
/**
|
||||
Modify the hardware to disallow memory writes in a region.
|
||||
|
||||
This function changes the attributes of a memory range to not allow writes.
|
||||
|
||||
@param This[in] Indicates the EFI_LEGACY_REGION2_PROTOCOL instance.
|
||||
@param Start[in] The beginning of the physical address of the region whose
|
||||
attributes should be modified.
|
||||
@param Length[in] The number of bytes of memory whose attributes should be modified.
|
||||
The actual number of bytes modified may be greater than the number
|
||||
specified.
|
||||
@param Granularity[out] The number of bytes in the last region affected. This may be less
|
||||
than the total number of bytes affected if the starting address was
|
||||
not aligned to a region's starting address or if the length was
|
||||
greater than the number of bytes in the first region.
|
||||
|
||||
@retval EFI_SUCCESS The region's attributes were successfully modified.
|
||||
@retval EFI_INVALID_PARAMETER If Start or Length describe an address not in the Legacy Region.
|
||||
|
||||
**/
|
||||
typedef
|
||||
EFI_STATUS
|
||||
(EFIAPI *EFI_LEGACY_REGION2_LOCK) (
|
||||
IN EFI_LEGACY_REGION2_PROTOCOL *This,
|
||||
IN UINT32 Start,
|
||||
IN UINT32 Length,
|
||||
OUT UINT32 *Granularity
|
||||
);
|
||||
|
||||
|
||||
/**
|
||||
Modify the hardware to disallow memory attribute changes in a region.
|
||||
|
||||
This function makes the attributes of a region read only. Once a region is boot-locked with this
|
||||
function, the read and write attributes of that region cannot be changed until a power cycle has
|
||||
reset the boot-lock attribute. Calls to Decode(), Lock() and Unlock() will have no effect.
|
||||
|
||||
@param This[in] Indicates the EFI_LEGACY_REGION2_PROTOCOL instance.
|
||||
@param Start[in] The beginning of the physical address of the region whose
|
||||
attributes should be modified.
|
||||
@param Length[in] The number of bytes of memory whose attributes should be modified.
|
||||
The actual number of bytes modified may be greater than the number
|
||||
specified.
|
||||
@param Granularity[out] The number of bytes in the last region affected. This may be less
|
||||
than the total number of bytes affected if the starting address was
|
||||
not aligned to a region's starting address or if the length was
|
||||
greater than the number of bytes in the first region.
|
||||
|
||||
@retval EFI_SUCCESS The region's attributes were successfully modified.
|
||||
@retval EFI_INVALID_PARAMETER If Start or Length describe an address not in the Legacy Region.
|
||||
@retval EFI_UNSUPPORTED The chipset does not support locking the configuration registers in
|
||||
a way that will not affect memory regions outside the legacy memory
|
||||
region.
|
||||
|
||||
**/
|
||||
typedef
|
||||
EFI_STATUS
|
||||
(EFIAPI *EFI_LEGACY_REGION2_BOOT_LOCK)(
|
||||
IN EFI_LEGACY_REGION2_PROTOCOL *This,
|
||||
IN UINT32 Start,
|
||||
IN UINT32 Length,
|
||||
OUT UINT32 *Granularity OPTIONAL
|
||||
);
|
||||
|
||||
|
||||
/**
|
||||
Modify the hardware to allow memory writes in a region.
|
||||
|
||||
This function changes the attributes of a memory range to allow writes.
|
||||
|
||||
@param This[in] Indicates the EFI_LEGACY_REGION2_PROTOCOL instance.
|
||||
@param Start[in] The beginning of the physical address of the region whose
|
||||
attributes should be modified.
|
||||
@param Length[in] The number of bytes of memory whose attributes should be modified.
|
||||
The actual number of bytes modified may be greater than the number
|
||||
specified.
|
||||
@param Granularity[out] The number of bytes in the last region affected. This may be less
|
||||
than the total number of bytes affected if the starting address was
|
||||
not aligned to a region's starting address or if the length was
|
||||
greater than the number of bytes in the first region.
|
||||
|
||||
@retval EFI_SUCCESS The region's attributes were successfully modified.
|
||||
@retval EFI_INVALID_PARAMETER If Start or Length describe an address not in the Legacy Region.
|
||||
|
||||
**/
|
||||
typedef
|
||||
EFI_STATUS
|
||||
(EFIAPI *EFI_LEGACY_REGION2_UNLOCK) (
|
||||
IN EFI_LEGACY_REGION2_PROTOCOL *This,
|
||||
IN UINT32 Start,
|
||||
IN UINT32 Length,
|
||||
OUT UINT32 *Granularity
|
||||
);
|
||||
|
||||
|
||||
typedef enum {
|
||||
LegacyRegionDecoded, ///< This region is currently set to allow reads.
|
||||
LegacyRegionNotDecoded, ///< This region is currently set to not allow reads.
|
||||
LegacyRegionWriteEnabled, ///< This region is currently set to allow writes.
|
||||
LegacyRegionWriteDisabled, ///< This region is currently set to write protected.
|
||||
LegacyRegionBootLocked, ///< This region's attributes are locked, cannot be modified until
|
||||
///< after a power cycle.
|
||||
LegacyRegionNotLocked ///< This region's attributes are not locked.
|
||||
} EFI_LEGACY_REGION_ATTRIBUTE;
|
||||
|
||||
|
||||
typedef struct {
|
||||
UINT32 Start; ///< The beginning of the physical address of this
|
||||
///< region.
|
||||
UINT32 Length; ///< The number of bytes in this region.
|
||||
EFI_LEGACY_REGION_ATTRIBUTE Attribute; ///< Attribute of the Legacy Region Descriptor that
|
||||
///< describes the capabilities for that memory region.
|
||||
UINT32 Granularity; ///< Describes the byte length programmability
|
||||
///< associated with the Start address and the specified
|
||||
///< Attribute setting.
|
||||
} EFI_LEGACY_REGION_DESCRIPTOR;
|
||||
|
||||
|
||||
/**
|
||||
Get region information for the attributes of the Legacy Region.
|
||||
|
||||
This function is used to discover the granularity of the attributes for the memory in the legacy
|
||||
region. Each attribute may have a different granularity and the granularity may not be the same
|
||||
for all memory ranges in the legacy region.
|
||||
|
||||
@param This[in] Indicates the EFI_LEGACY_REGION2_PROTOCOL instance.
|
||||
@param DescriptorCount[out] The number of region descriptor entries returned in the Descriptor
|
||||
buffer.
|
||||
@param Descriptor[out] A pointer to a pointer used to return a buffer where the legacy
|
||||
region information is deposited. This buffer will contain a list of
|
||||
DescriptorCount number of region descriptors. This function will
|
||||
provide the memory for the buffer.
|
||||
|
||||
@retval EFI_SUCCESS The information structure was returned.
|
||||
@retval EFI_UNSUPPORTED This function is not supported.
|
||||
|
||||
**/
|
||||
typedef
|
||||
EFI_STATUS
|
||||
(EFIAPI *EFI_LEGACY_REGION_GET_INFO) (
|
||||
IN EFI_LEGACY_REGION2_PROTOCOL *This,
|
||||
OUT UINT32 *DescriptorCount,
|
||||
OUT EFI_LEGACY_REGION_DESCRIPTOR **Descriptor
|
||||
);
|
||||
|
||||
|
||||
/**
|
||||
Abstracts the hardware control of the physical address region 0xC0000-0xFFFFF.
|
||||
|
||||
The EFI_LEGACY_REGION2_PROTOCOL is used to abstract the hardware control of the memory
|
||||
attributes of the Option ROM shadowing region, 0xC0000 to 0xFFFFF.
|
||||
|
||||
There are three memory attributes that can be modified through this protocol: read, write and
|
||||
boot-lock. These protocols may be set in any combination.
|
||||
|
||||
**/
|
||||
struct _EFI_LEGACY_REGION2_PROTOCOL {
|
||||
EFI_LEGACY_REGION2_DECODE Decode; ///< Modify the read attribute of a memory region. See
|
||||
///< the Decode() function description.
|
||||
EFI_LEGACY_REGION2_LOCK Lock; ///< Modify the write attribute of a memory region to
|
||||
///< prevent writes. See the Lock() function description.
|
||||
EFI_LEGACY_REGION2_BOOT_LOCK BootLock; ///< Modify the boot-lock attribute of a memory region to
|
||||
///< prevent future changes to the memory attributes for
|
||||
///< this region. See the BootLock() function description.
|
||||
EFI_LEGACY_REGION2_UNLOCK UnLock; ///< Modify the write attribute of a memory region to
|
||||
///< allow writes. See the Unlock() function description.
|
||||
EFI_LEGACY_REGION_GET_INFO GetInfo; ///< Modify the write attribute of a memory region to
|
||||
///< allow writes. See the GetInfo() function description.
|
||||
};
|
||||
|
||||
extern EFI_GUID gEfiLegacyRegion2ProtocolGuid;
|
||||
|
||||
#endif
|
||||
@ -687,6 +687,9 @@
|
||||
## Include/Protocol/CpuIo2.h
|
||||
gEfiCpuIo2ProtocolGuid = {0xad61f191, 0xae5f, 0x4c0e, {0xb9, 0xfa, 0xe8, 0x69, 0xd2, 0x88, 0xc6, 0x4f } }
|
||||
|
||||
## Include/Protocol/LegacyRegion2.h
|
||||
gEfiLegacyRegion2ProtocolGuid = {0x70101eaf, 0x85, 0x440c, {0xb3, 0x56, 0x8e, 0xe3, 0x6f, 0xef, 0x24, 0xf0 } }
|
||||
|
||||
#
|
||||
# Protocols defined in UEFI2.1/UEFI2.0/EFI1.1
|
||||
#
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user