X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=IntelFrameworkPkg%2FInclude%2FProtocol%2FLegacyRegion.h;h=01a411d50fd3d0aa36c120cc6f0c18e67a6f3391;hb=aa7fc1c11c3d57d82842dbede50d064639671a98;hp=09a8dcb524dd040ab3678c83e8f94c1822ce22e7;hpb=0f899407a356d80ee211b181878b0b432e7c3fff;p=mirror_edk2.git

diff --git a/IntelFrameworkPkg/Include/Protocol/LegacyRegion.h b/IntelFrameworkPkg/Include/Protocol/LegacyRegion.h
index 09a8dcb524..01a411d50f 100644
--- a/IntelFrameworkPkg/Include/Protocol/LegacyRegion.h
+++ b/IntelFrameworkPkg/Include/Protocol/LegacyRegion.h
@@ -1,16 +1,8 @@
 /** @file
-  This protocol manages the legacy memory regions between 0xc0000 - 0xfffff
+  This protocol manages the legacy memory regions between 0xc0000 - 0xfffff.
 
-  Copyright (c) 2007, 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.
-
-  Module Name:  LegacyRegion.h
+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
@@ -21,7 +13,6 @@
 #ifndef _EFI_LEGACY_REGION_H_
 #define _EFI_LEGACY_REGION_H_
 
-#include <PiDxe.h>
 
 #define EFI_LEGACY_REGION_PROTOCOL_GUID \
   { \
@@ -34,11 +25,11 @@ 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                 Start of region to decode.
-  @param  Length                Size in bytes of the region.
-  @param  On                    Decode/nondecode flag.
+  @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           Decode range successfully changed.
+  @retval EFI_SUCCESS           The decode range successfully changed.
 
 **/
 typedef
@@ -53,9 +44,9 @@ EFI_STATUS
 /**
   Sets a region to read only.
 
-  @param  This                  Indicates the EFI_LEGACY_REGION_PROTOCOL instance
-  @param  Start                 Start of region to lock.
-  @param  Length                Size in bytes of the region.
+  @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.
@@ -75,8 +66,8 @@ EFI_STATUS
   inadvertently modified.
 
   @param  This                  Indicates the EFI_LEGACY_REGION_PROTOCOL instance
-  @param  Start                 Start of region to lock.
-  @param  Length                Size in bytes of the region.
+  @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.
@@ -95,8 +86,8 @@ EFI_STATUS
   Sets a region to read-write.
 
   @param  This                  Indicates the EFI_LEGACY_REGION_PROTOCOL instance
-  @param  Start                 Start of region to lock.
-  @param  Length                Size in bytes of the region.
+  @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.
@@ -112,29 +103,15 @@ EFI_STATUS
   );
 
 /**
-  @par Protocol Description:
   Abstracts the hardware control of the physical address region 0xC0000-C0xFFFFF
   for the traditional BIOS.
-
-  @param Decode
-  Specifies a region for the chipset to decode
-
-  @param Lock
-  Makes the specified OpROM region read only or locked.
-
-  @param BootLock
-  Sets a region to read only and ensures tat flash is locked from
-  inadvertent modification.
-
-  @param Unlock
-  Makes the specified OpROM region read-write or unlocked.
-
 **/
 struct _EFI_LEGACY_REGION_PROTOCOL {
-  EFI_LEGACY_REGION_DECODE    Decode;
-  EFI_LEGACY_REGION_LOCK      Lock;
-  EFI_LEGACY_REGION_BOOT_LOCK BootLock;
-  EFI_LEGACY_REGION_UNLOCK    UnLock;
+  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;