]> git.proxmox.com Git - mirror_edk2.git/blobdiff - BaseTools/Source/C/GenVtf/GenVtf.h
Maintainers.txt: Change package maintainer of IntelFsp*Pkg
[mirror_edk2.git] / BaseTools / Source / C / GenVtf / GenVtf.h
index 8ebc8d25f3f193ad9b76d3d2bc438eda6042bb49..62c61aa84e7f26d4a19549571bcf9bbef8691a6f 100644 (file)
@@ -1,24 +1,15 @@
 /** @file\r
+This file contains the relevant declarations required to generate Boot Strap File\r
 \r
-Copyright (c) 1999 - 2008, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available \r
-under the terms and conditions of the BSD License which accompanies this \r
+Copyright (c) 1999 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available\r
+under the terms and conditions of the BSD License which accompanies this\r
 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
 \r
-\r
-Module Name:  \r
-\r
-  GenVtf.h\r
-\r
-Abstract:\r
-\r
-  This file contains the relevant declarations required\r
-  to generate Boot Strap File\r
-\r
 **/\r
 \r
 //\r
@@ -89,7 +80,7 @@ Abstract:
 #define SIZE_IA32_RESET_VECT      0x10        // 16 Bytes\r
 #define SIZE_SALE_ENTRY_POINT     0x08        // 8 Byte\r
 #define SIZE_FIT_TABLE_ADD        0x08        // 8 Byte\r
-#define SIZE_FIT_TABLE_PAL_A      0x10     \r
+#define SIZE_FIT_TABLE_PAL_A      0x10\r
 #define SIZE_RESERVED             0x10\r
 \r
 \r
@@ -125,7 +116,7 @@ static BOOLEAN VerboseMode = FALSE;
 //\r
 // Internal Data Structure\r
 //\r
-typedef enum _LOC_TYPE \r
+typedef enum _LOC_TYPE\r
 {\r
   NONE,                   // In case there is - INF file\r
   FIRST_VTF,              // First VTF\r
@@ -183,18 +174,18 @@ UpdateVtfBuffer(
 Routine Description:\r
 \r
   Update the Firmware Volume Buffer with requested buffer data\r
-  \r
+\r
 Arguments:\r
 \r
   StartAddress   - StartAddress in buffer. This number will automatically\r
-                  point to right address in buffer where data needed \r
+                  point to right address in buffer where data needed\r
                   to be updated.\r
   Buffer         - Buffer pointer from data will be copied to memory mapped buffer.\r
   DataSize       - Size of the data needed to be copied.\r
   LocType        - The type of the VTF\r
 \r
 Returns:\r
-  \r
+\r
   EFI_ABORTED  - The input parameter is error\r
   EFI_SUCCESS  - The function completed successfully\r
 \r
@@ -236,22 +227,22 @@ CalculateFitTableChecksum (
   VOID\r
   )\r
 /*++\r
-  \r
+\r
 Routine Description:\r
 \r
   This function will perform byte checksum on the FIT table, if the the checksum required\r
   field is set to CheckSum required. If the checksum is not required then checksum byte\r
   will have value as 0;.\r
-  \r
+\r
 Arguments:\r
 \r
   NONE\r
-  \r
+\r
 Returns:\r
 \r
   Status       - Value returned by call to CalculateChecksum8 ()\r
   EFI_SUCCESS  - The function completed successfully\r
-    \r
+\r
 --*/\r
 ;\r
 \r
@@ -271,22 +262,22 @@ Routine Description:
 \r
 Arguments:\r
 \r
-  StartAddress1  - The start address of the first VTF      \r
+  StartAddress1  - The start address of the first VTF\r
   Size1          - The size of the first VTF\r
-  StartAddress2  - The start address of the second VTF      \r
+  StartAddress2  - The start address of the second VTF\r
   Size2          - The size of the second VTF\r
 \r
 Returns:\r
\r
+\r
   EFI_OUT_OF_RESOURCES - Can not allocate memory\r
-  The return value can be any of the values \r
+  The return value can be any of the values\r
   returned by the calls to following functions:\r
       GetVtfRelatedInfoFromInfFile\r
       ProcessAndCreateVtf\r
       UpdateIA32ResetVector\r
       UpdateFfsHeader\r
       WriteVtfBinary\r
-  \r
+\r
 --*/\r
 ;\r
 \r
@@ -303,11 +294,11 @@ Routine Description:
 Arguments:\r
 \r
   StartAddress - StartAddress for PEIM.....\r
-    \r
+\r
 Returns:\r
\r
+\r
   EFI_SUCCESS   - The function completed successfully\r
-  EFI_ABORTED   - Error Opening File \r
+  EFI_ABORTED   - Error Opening File\r
 \r
 --*/\r
 ;\r