git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10404 6f19259b-4bc3-4df7-8a09-765794883524
		
			
				
	
	
		
			126 lines
		
	
	
		
			4.5 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			126 lines
		
	
	
		
			4.5 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
| /** @file
 | |
|   This protocol manages the legacy memory regions between 0xc0000 - 0xfffff.
 | |
| 
 | |
| Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>
 | |
| 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.
 | |
| 
 | |
|   @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
 |