4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The Legacy Region Protocol controls the read, write and boot-lock attributes for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the region 0xC0000 to 0xFFFFF.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @par Revision Reference:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This Protocol is defined in UEFI Platform Initialization Specification 1.2
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Volume 5: Standards
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 0x70101eaf, 0x85, 0x440c, {0xb3, 0x56, 0x8e, 0xe3, 0x6f, 0xef, 0x24, 0xf0 } \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _EFI_LEGACY_REGION2_PROTOCOL EFI_LEGACY_REGION2_PROTOCOL;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Modify the hardware to allow (decode) or disallow (not decode) memory reads in a region.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the On parameter evaluates to TRUE, this function enables memory reads in the address range
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Start to (Start + Length - 1).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the On parameter evaluates to FALSE, this function disables memory reads in the address range
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Start to (Start + Length - 1).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This[in] Indicates the EFI_LEGACY_REGION2_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Start[in] The beginning of the physical address of the region whose attributes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync should be modified.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Length[in] The number of bytes of memory whose attributes should be modified.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The actual number of bytes modified may be greater than the number
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Granularity[out] The number of bytes in the last region affected. This may be less
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync than the total number of bytes affected if the starting address
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync was not aligned to a region's starting address or if the length
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync was greater than the number of bytes in the first region.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param On[in] Decode / Non-Decode flag.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The region's attributes were successfully modified.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER If Start or Length describe an address not in the Legacy Region.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Modify the hardware to disallow memory writes in a region.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function changes the attributes of a memory range to not allow writes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This[in] Indicates the EFI_LEGACY_REGION2_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Start[in] The beginning of the physical address of the region whose
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync attributes should be modified.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Length[in] The number of bytes of memory whose attributes should be modified.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The actual number of bytes modified may be greater than the number
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Granularity[out] The number of bytes in the last region affected. This may be less
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync than the total number of bytes affected if the starting address was
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync not aligned to a region's starting address or if the length was
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync greater than the number of bytes in the first region.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The region's attributes were successfully modified.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER If Start or Length describe an address not in the Legacy Region.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Modify the hardware to disallow memory attribute changes in a region.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function makes the attributes of a region read only. Once a region is boot-locked with this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync function, the read and write attributes of that region cannot be changed until a power cycle has
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync reset the boot-lock attribute. Calls to Decode(), Lock() and Unlock() will have no effect.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This[in] Indicates the EFI_LEGACY_REGION2_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Start[in] The beginning of the physical address of the region whose
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync attributes should be modified.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Length[in] The number of bytes of memory whose attributes should be modified.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The actual number of bytes modified may be greater than the number
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Granularity[out] The number of bytes in the last region affected. This may be less
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync than the total number of bytes affected if the starting address was
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync not aligned to a region's starting address or if the length was
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync greater than the number of bytes in the first region.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The region's attributes were successfully modified.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER If Start or Length describe an address not in the Legacy Region.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The chipset does not support locking the configuration registers in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync a way that will not affect memory regions outside the legacy memory
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Modify the hardware to allow memory writes in a region.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function changes the attributes of a memory range to allow writes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This[in] Indicates the EFI_LEGACY_REGION2_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Start[in] The beginning of the physical address of the region whose
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync attributes should be modified.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Length[in] The number of bytes of memory whose attributes should be modified.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The actual number of bytes modified may be greater than the number
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Granularity[out] The number of bytes in the last region affected. This may be less
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync than the total number of bytes affected if the starting address was
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync not aligned to a region's starting address or if the length was
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync greater than the number of bytes in the first region.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The region's attributes were successfully modified.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER If Start or Length describe an address not in the Legacy Region.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef enum {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync LegacyRegionDecoded, ///< This region is currently set to allow reads.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync LegacyRegionNotDecoded, ///< This region is currently set to not allow reads.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync LegacyRegionWriteEnabled, ///< This region is currently set to allow writes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync LegacyRegionWriteDisabled, ///< This region is currently set to write protected.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync LegacyRegionBootLocked, ///< This region's attributes are locked, cannot be modified until
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///< after a power cycle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync LegacyRegionNotLocked ///< This region's attributes are not locked.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The beginning of the physical address of this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// region.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The number of bytes in this region.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Attribute of the Legacy Region Descriptor that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// describes the capabilities for that memory region.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Describes the byte length programmability
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// associated with the Start address and the specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Attribute setting.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Get region information for the attributes of the Legacy Region.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function is used to discover the granularity of the attributes for the memory in the legacy
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync region. Each attribute may have a different granularity and the granularity may not be the same
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for all memory ranges in the legacy region.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This[in] Indicates the EFI_LEGACY_REGION2_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DescriptorCount[out] The number of region descriptor entries returned in the Descriptor
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Descriptor[out] A pointer to a pointer used to return a buffer where the legacy
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync region information is deposited. This buffer will contain a list of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DescriptorCount number of region descriptors. This function will
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync provide the memory for the buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The information structure was returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED This function is not supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The EFI_LEGACY_REGION2_PROTOCOL is used to abstract the hardware control of the memory
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// attributes of the Option ROM shadowing region, 0xC0000 to 0xFFFFF.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// There are three memory attributes that can be modified through this protocol: read, write and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// boot-lock. These protocols may be set in any combination.