Grammatical and disclaimer changes (does not follow internal C coding stds.)

[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / LegacyRegion.h

diff --git a/IntelFrameworkPkg/Include/Protocol/LegacyRegion.h b/IntelFrameworkPkg/Include/Protocol/LegacyRegion.h
index 033da20bd4375eb860ee74fb73da5c8d4883cd1a..4f0ff543abbb59ccda361d2a602644c2f3e204bc 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/LegacyRegion.h
+++ b/IntelFrameworkPkg/Include/Protocol/LegacyRegion.h
@@ -1,14 +1,14 @@
 /** @file\r
-  This protocol manages the legacy memory regions between 0xc0000 - 0xfffff\r
+  This protocol manages the legacy memory regions between 0xc0000 - 0xfffff.\r
 \r
-  Copyright (c) 2007 - 2009, Intel Corporation\r
-  All rights reserved. This program and the accompanying materials\r
-  are licensed and made available under the terms and conditions of the BSD License\r
-  which accompanies this distribution.  The full text of the license may be found at\r
-  http://opensource.org/licenses/bsd-license.php\r
-\r
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+Copyright (c) 2007 - 2010, Intel Corporation.  All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php.                                          \r
+    \r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
   @par Revision Reference:\r
   This protocol is defined in Framework for EFI Compatibility Support Module spec\r
@@ -31,11 +31,11 @@ typedef struct _EFI_LEGACY_REGION_PROTOCOL EFI_LEGACY_REGION_PROTOCOL;
   Sets hardware to decode or not decode a region.\r
 \r
   @param  This                  Indicates the EFI_LEGACY_REGION_PROTOCOL instance\r
-  @param  Start                 Start of region to decode.\r
-  @param  Length                Size in bytes of the region.\r
-  @param  On                    Decode/nondecode flag.\r
+  @param  Start                 The start of the region to decode.\r
+  @param  Length                The size in bytes of the region.\r
+  @param  On                    The decode/nondecode flag.\r
 \r
-  @retval EFI_SUCCESS           Decode range successfully changed.\r
+  @retval EFI_SUCCESS           The decode range successfully changed.\r
 \r
 **/\r
 typedef\r
@@ -50,9 +50,9 @@ EFI_STATUS
 /**\r
   Sets a region to read only.\r
 \r
-  @param  This                  Indicates the EFI_LEGACY_REGION_PROTOCOL instance\r
-  @param  Start                 Start of region to lock.\r
-  @param  Length                Size in bytes of the region.\r
+  @param  This                  Indicates the EFI_LEGACY_REGION_PROTOCOL instance.\r
+  @param  Start                 The start of region to lock.\r
+  @param  Length                The size in bytes of the region.\r
   @param  Granularity           Lock attribute affects this granularity in bytes.\r
 \r
   @retval EFI_SUCCESS           The region was made read only.\r
@@ -72,8 +72,8 @@ EFI_STATUS
   inadvertently modified.\r
 \r
   @param  This                  Indicates the EFI_LEGACY_REGION_PROTOCOL instance\r
-  @param  Start                 Start of region to lock.\r
-  @param  Length                Size in bytes of the region.\r
+  @param  Start                 The start of region to lock.\r
+  @param  Length                The size in bytes of the region.\r
   @param  Granularity           Lock attribute affects this granularity in bytes.\r
 \r
   @retval EFI_SUCCESS           The region was made read only and flash is locked.\r
@@ -92,8 +92,8 @@ EFI_STATUS
   Sets a region to read-write.\r
 \r
   @param  This                  Indicates the EFI_LEGACY_REGION_PROTOCOL instance\r
-  @param  Start                 Start of region to lock.\r
-  @param  Length                Size in bytes of the region.\r
+  @param  Start                 The start of region to lock.\r
+  @param  Length                The size in bytes of the region.\r
   @param  Granularity           Lock attribute affects this granularity in bytes.\r
 \r
   @retval EFI_SUCCESS           The region was successfully made read-write.\r
@@ -113,9 +113,9 @@ EFI_STATUS
   for the traditional BIOS.\r
 **/\r
 struct _EFI_LEGACY_REGION_PROTOCOL {\r
-  EFI_LEGACY_REGION_DECODE    Decode;     ///< Specifies a region for the chipset to decode\r
+  EFI_LEGACY_REGION_DECODE    Decode;     ///< Specifies a region for the chipset to decode.\r
   EFI_LEGACY_REGION_LOCK      Lock;       ///< Makes the specified OpROM region read only or locked.\r
-  EFI_LEGACY_REGION_BOOT_LOCK BootLock;   ///< Sets a region to read only and ensures tat flash is locked from\r
+  EFI_LEGACY_REGION_BOOT_LOCK BootLock;   ///< Sets a region to read only and ensures tat flash is locked from.\r
                                           ///< inadvertent modification.\r
   EFI_LEGACY_REGION_UNLOCK    UnLock;     ///< Makes the specified OpROM region read-write or unlocked.\r
 };\r