2 This protocol manages the legacy memory regions between 0xc0000 - 0xfffff
4 Copyright (c) 2007 - 2009, Intel Corporation
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
13 @par Revision Reference:
14 This protocol is defined in Framework for EFI Compatibility Support Module spec
19 #ifndef _EFI_LEGACY_REGION_H_
20 #define _EFI_LEGACY_REGION_H_
23 #define EFI_LEGACY_REGION_PROTOCOL_GUID \
25 0xfc9013a, 0x568, 0x4ba9, {0x9b, 0x7e, 0xc9, 0xc3, 0x90, 0xa6, 0x60, 0x9b } \
28 typedef struct _EFI_LEGACY_REGION_PROTOCOL EFI_LEGACY_REGION_PROTOCOL
;
31 Sets hardware to decode or not decode a region.
33 @param This Indicates the EFI_LEGACY_REGION_PROTOCOL instance
34 @param Start Start of region to decode.
35 @param Length Size in bytes of the region.
36 @param On Decode/nondecode flag.
38 @retval EFI_SUCCESS Decode range successfully changed.
43 (EFIAPI
*EFI_LEGACY_REGION_DECODE
)(
44 IN EFI_LEGACY_REGION_PROTOCOL
*This
,
51 Sets a region to read only.
53 @param This Indicates the EFI_LEGACY_REGION_PROTOCOL instance
54 @param Start Start of region to lock.
55 @param Length Size in bytes of the region.
56 @param Granularity Lock attribute affects this granularity in bytes.
58 @retval EFI_SUCCESS The region was made read only.
63 (EFIAPI
*EFI_LEGACY_REGION_LOCK
)(
64 IN EFI_LEGACY_REGION_PROTOCOL
*This
,
67 OUT UINT32
*Granularity OPTIONAL
71 Sets a region to read only and ensures that flash is locked from being
72 inadvertently modified.
74 @param This Indicates the EFI_LEGACY_REGION_PROTOCOL instance
75 @param Start Start of region to lock.
76 @param Length Size in bytes of the region.
77 @param Granularity Lock attribute affects this granularity in bytes.
79 @retval EFI_SUCCESS The region was made read only and flash is locked.
84 (EFIAPI
*EFI_LEGACY_REGION_BOOT_LOCK
)(
85 IN EFI_LEGACY_REGION_PROTOCOL
*This
,
88 OUT UINT32
*Granularity OPTIONAL
92 Sets a region to read-write.
94 @param This Indicates the EFI_LEGACY_REGION_PROTOCOL instance
95 @param Start Start of region to lock.
96 @param Length Size in bytes of the region.
97 @param Granularity Lock attribute affects this granularity in bytes.
99 @retval EFI_SUCCESS The region was successfully made read-write.
104 (EFIAPI
*EFI_LEGACY_REGION_UNLOCK
)(
105 IN EFI_LEGACY_REGION_PROTOCOL
*This
,
108 OUT UINT32
*Granularity OPTIONAL
112 Abstracts the hardware control of the physical address region 0xC0000-C0xFFFFF
113 for the traditional BIOS.
115 struct _EFI_LEGACY_REGION_PROTOCOL
{
116 EFI_LEGACY_REGION_DECODE Decode
; ///< Specifies a region for the chipset to decode
117 EFI_LEGACY_REGION_LOCK Lock
; ///< Makes the specified OpROM region read only or locked.
118 EFI_LEGACY_REGION_BOOT_LOCK BootLock
; ///< Sets a region to read only and ensures tat flash is locked from
119 ///< inadvertent modification.
120 EFI_LEGACY_REGION_UNLOCK UnLock
; ///< Makes the specified OpROM region read-write or unlocked.
123 extern EFI_GUID gEfiLegacyRegionProtocolGuid
;