22a69a5efe
https://bugzilla.tianocore.org/show_bug.cgi?id=1373 Replace BSD 2-Clause License with BSD+Patent License. This change is based on the following emails: https://lists.01.org/pipermail/edk2-devel/2019-February/036260.html https://lists.01.org/pipermail/edk2-devel/2018-October/030385.html RFCs with detailed process for the license change: V3: https://lists.01.org/pipermail/edk2-devel/2019-March/038116.html V2: https://lists.01.org/pipermail/edk2-devel/2019-March/037669.html V1: https://lists.01.org/pipermail/edk2-devel/2019-March/037500.html Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com> Reviewed-by: Liming Gao <liming.gao@intel.com>
120 lines
4.1 KiB
C
120 lines
4.1 KiB
C
/** @file
|
|
This protocol manages the legacy memory regions between 0xc0000 - 0xfffff.
|
|
|
|
Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
@par Revision Reference:
|
|
This protocol is defined in Framework for EFI Compatibility Support Module spec
|
|
Version 0.97.
|
|
|
|
**/
|
|
|
|
#ifndef _EFI_LEGACY_REGION_H_
|
|
#define _EFI_LEGACY_REGION_H_
|
|
|
|
|
|
#define EFI_LEGACY_REGION_PROTOCOL_GUID \
|
|
{ \
|
|
0xfc9013a, 0x568, 0x4ba9, {0x9b, 0x7e, 0xc9, 0xc3, 0x90, 0xa6, 0x60, 0x9b } \
|
|
}
|
|
|
|
typedef struct _EFI_LEGACY_REGION_PROTOCOL EFI_LEGACY_REGION_PROTOCOL;
|
|
|
|
/**
|
|
Sets hardware to decode or not decode a region.
|
|
|
|
@param This Indicates the EFI_LEGACY_REGION_PROTOCOL instance
|
|
@param Start The start of the region to decode.
|
|
@param Length The size in bytes of the region.
|
|
@param On The decode/nondecode flag.
|
|
|
|
@retval EFI_SUCCESS The decode range successfully changed.
|
|
|
|
**/
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EFI_LEGACY_REGION_DECODE)(
|
|
IN EFI_LEGACY_REGION_PROTOCOL *This,
|
|
IN UINT32 Start,
|
|
IN UINT32 Length,
|
|
IN BOOLEAN *On
|
|
);
|
|
|
|
/**
|
|
Sets a region to read only.
|
|
|
|
@param This Indicates the EFI_LEGACY_REGION_PROTOCOL instance.
|
|
@param Start The start of region to lock.
|
|
@param Length The size in bytes of the region.
|
|
@param Granularity Lock attribute affects this granularity in bytes.
|
|
|
|
@retval EFI_SUCCESS The region was made read only.
|
|
|
|
**/
|
|
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 and ensures that flash is locked from being
|
|
inadvertently modified.
|
|
|
|
@param This Indicates the EFI_LEGACY_REGION_PROTOCOL instance
|
|
@param Start The start of region to lock.
|
|
@param Length The size in bytes of the region.
|
|
@param Granularity Lock attribute affects this granularity in bytes.
|
|
|
|
@retval EFI_SUCCESS The region was made read only and flash is locked.
|
|
|
|
**/
|
|
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-write.
|
|
|
|
@param This Indicates the EFI_LEGACY_REGION_PROTOCOL instance
|
|
@param Start The start of region to lock.
|
|
@param Length The size in bytes of the region.
|
|
@param Granularity Lock attribute affects this granularity in bytes.
|
|
|
|
@retval EFI_SUCCESS The region was successfully made read-write.
|
|
|
|
**/
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EFI_LEGACY_REGION_UNLOCK)(
|
|
IN EFI_LEGACY_REGION_PROTOCOL *This,
|
|
IN UINT32 Start,
|
|
IN UINT32 Length,
|
|
OUT UINT32 *Granularity OPTIONAL
|
|
);
|
|
|
|
/**
|
|
Abstracts the hardware control of the physical address region 0xC0000-C0xFFFFF
|
|
for the traditional BIOS.
|
|
**/
|
|
struct _EFI_LEGACY_REGION_PROTOCOL {
|
|
EFI_LEGACY_REGION_DECODE Decode; ///< Specifies a region for the chipset to decode.
|
|
EFI_LEGACY_REGION_LOCK Lock; ///< Makes the specified OpROM region read only or locked.
|
|
EFI_LEGACY_REGION_BOOT_LOCK BootLock; ///< Sets a region to read only and ensures tat flash is locked from.
|
|
///< inadvertent modification.
|
|
EFI_LEGACY_REGION_UNLOCK UnLock; ///< Makes the specified OpROM region read-write or unlocked.
|
|
};
|
|
|
|
extern EFI_GUID gEfiLegacyRegionProtocolGuid;
|
|
|
|
#endif
|