IntelFrameworkPkg: Clean up source files

[mirror_edk2.git] / IntelFrameworkPkg / Include / Framework / PeiCis.h

diff --git a/IntelFrameworkPkg/Include/Framework/PeiCis.h b/IntelFrameworkPkg/Include/Framework/PeiCis.h
index d823339eee9db16d4b9235a0706360fbebb7adc3..b41819cf09a824e6a175b23dc7ea1feb638705c4 100644 (file)
--- a/IntelFrameworkPkg/Include/Framework/PeiCis.h
+++ b/IntelFrameworkPkg/Include/Framework/PeiCis.h
@@ -2,14 +2,14 @@
   The Include file for definitions in the Intel Platform Innovation Framework for EFI\r
   Pre-EFI Initialization Core Interface Specification (PEI CIS) Version 0.91.\r
 \r
   The Include file for definitions in the Intel Platform Innovation Framework for EFI\r
   Pre-EFI Initialization Core Interface Specification (PEI CIS) Version 0.91.\r
 \r

-Copyright (c) 2006 - 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
+Copyright (c) 2006 - 2018, 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
 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
+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
 \r
 \r
 **/\r
 \r


@@ -35,8 +35,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 typedef struct _FRAMEWORK_EFI_PEI_SERVICES FRAMEWORK_EFI_PEI_SERVICES;\r
 \r
 /**\r
 typedef struct _FRAMEWORK_EFI_PEI_SERVICES FRAMEWORK_EFI_PEI_SERVICES;\r
 \r
 /**\r

-  The PEI Dispatcher will invoke each PEIM one time.  During this pass, the PEI \r
-  Dispatcher will pass control to the PEIM at the AddressOfEntryPoint in the PE Header. \r
+  The PEI Dispatcher will invoke each PEIM one time.  During this pass, the PEI\r
+  Dispatcher will pass control to the PEIM at the AddressOfEntryPoint in the PE Header.\r

 \r
   @param  FfsHeader        The pointer to the FFS file header.\r
   @param  PeiServices      Describes the list of possible PEI Services.\r
 \r
   @param  FfsHeader        The pointer to the FFS file header.\r
   @param  PeiServices      Describes the list of possible PEI Services.\r


@@ -50,11 +50,11 @@ EFI_STATUS
   IN EFI_FFS_FILE_HEADER            *FfsHeader,\r
   IN EFI_PEI_SERVICES               **PeiServices\r
   );\r
   IN EFI_FFS_FILE_HEADER            *FfsHeader,\r
   IN EFI_PEI_SERVICES               **PeiServices\r
   );\r

-  \r
+\r

 /**\r
 /**\r

-  This service abstracts the capability of the PEI \r
-  Foundation to discover instances of firmware volumes in the system. \r
-  Given the input file pointer, this service searches for the next \r
+  This service abstracts the capability of the PEI\r
+  Foundation to discover instances of firmware volumes in the system.\r
+  Given the input file pointer, this service searches for the next\r

   matching file in the Firmware File System (FFS) volume.\r
 \r
   @param  PeiServices      An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
   matching file in the Firmware File System (FFS) volume.\r
 \r
   @param  PeiServices      An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r


@@ -73,18 +73,18 @@ EFI_STATUS
   IN UINTN                          Instance,\r
   IN OUT EFI_FIRMWARE_VOLUME_HEADER **FwVolHeader\r
   );\r
   IN UINTN                          Instance,\r
   IN OUT EFI_FIRMWARE_VOLUME_HEADER **FwVolHeader\r
   );\r

-    \r
+\r

 /**\r
 /**\r

-  This service abstracts the capability of the PEI \r
-  Foundation to discover instances of firmware files in the system. \r
-  Given the input file pointer, this service searches for the next matching \r
+  This service abstracts the capability of the PEI\r
+  Foundation to discover instances of firmware files in the system.\r
+  Given the input file pointer, this service searches for the next matching\r

   file in the Firmware File System (FFS) volume.\r
 \r
   @param  PeiServices      An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
   @param  SearchType       A filter to find files only of this type.\r
   file in the Firmware File System (FFS) volume.\r
 \r
   @param  PeiServices      An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
   @param  SearchType       A filter to find files only of this type.\r

-  @param  FwVolHeader      The pointer to the firmware volume header of the volume to search. This parameter \r
+  @param  FwVolHeader      The pointer to the firmware volume header of the volume to search. This parameter\r

                            must point to a valid FFS volume.\r
                            must point to a valid FFS volume.\r

-  @param  FileHeader       The pointer to the current file from which to begin searching. Upon return this pointer will be \r
+  @param  FileHeader       The pointer to the current file from which to begin searching. Upon return this pointer will be\r

                            updated to reflect the file found.\r
 \r
   @retval EFI_SUCCESS      The file was found.\r
                            updated to reflect the file found.\r
 \r
   @retval EFI_SUCCESS      The file was found.\r


@@ -102,8 +102,8 @@ EFI_STATUS
   );\r
 \r
 /**\r
   );\r
 \r
 /**\r

-  Given the input file pointer, this service searches for the next \r
-  matching file in the Firmware File System (FFS) volume. \r
+  Given the input file pointer, this service searches for the next\r
+  matching file in the Firmware File System (FFS) volume.\r

 \r
   @param  PeiServices      An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
   @param  SectionType      The value of the section type to find.\r
 \r
   @param  PeiServices      An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
   @param  SectionType      The value of the section type to find.\r


@@ -125,16 +125,16 @@ EFI_STATUS
 \r
 ///\r
 ///  FRAMEWORK_EFI_PEI_SERVICES is a collection of functions whose implementation is provided by the PEI\r
 \r
 ///\r
 ///  FRAMEWORK_EFI_PEI_SERVICES is a collection of functions whose implementation is provided by the PEI\r

-///  Foundation. The table may be located in the temporary or permanent memory, depending upon the capabilities \r
+///  Foundation. The table may be located in the temporary or permanent memory, depending upon the capabilities\r

 ///  and phase of execution of PEI.\r
 ///  and phase of execution of PEI.\r

-///  \r
+///\r

 ///  These services fall into various classes, including the following:\r
 ///  - Managing the boot mode.\r
 ///  - Allocating both early and permanent memory.\r
 ///  - Supporting the Firmware File System (FFS).\r
 ///  - Abstracting the PPI database abstraction.\r
 ///  - Creating Hand-Off Blocks (HOBs).\r
 ///  These services fall into various classes, including the following:\r
 ///  - Managing the boot mode.\r
 ///  - Allocating both early and permanent memory.\r
 ///  - Supporting the Firmware File System (FFS).\r
 ///  - Abstracting the PPI database abstraction.\r
 ///  - Creating Hand-Off Blocks (HOBs).\r

-///        \r
+///\r

 struct _FRAMEWORK_EFI_PEI_SERVICES {\r
   EFI_TABLE_HEADER                  Hdr;\r
   //\r
 struct _FRAMEWORK_EFI_PEI_SERVICES {\r
   EFI_TABLE_HEADER                  Hdr;\r
   //\r


@@ -178,10 +178,10 @@ struct _FRAMEWORK_EFI_PEI_SERVICES {
   //\r
   EFI_PEI_RESET_SYSTEM              ResetSystem;\r
   ///\r
   //\r
   EFI_PEI_RESET_SYSTEM              ResetSystem;\r
   ///\r

-  /// Inconsistent with specification here: \r
-  /// In Framework Spec, PeiCis0.91, CpuIo and PciCfg are NOT pointers. \r
+  /// Inconsistent with specification here:\r
+  /// In Framework Spec, PeiCis0.91, CpuIo and PciCfg are NOT pointers.\r

   ///\r
   ///\r

-  \r
+\r

   //\r
   // I/O Abstractions\r
   //\r
   //\r
   // I/O Abstractions\r
   //\r


@@ -193,19 +193,19 @@ struct _FRAMEWORK_EFI_PEI_SERVICES {
 ///\r
 typedef enum {\r
   ///\r
 ///\r
 typedef enum {\r
   ///\r

-  /// Used to induce a system-wide reset. This sets all circuitry within the \r
+  /// Used to induce a system-wide reset. This sets all circuitry within the\r

   /// system to its initial state.  This type of reset is asynchronous to system\r
   /// system to its initial state.  This type of reset is asynchronous to system\r

-  /// operation and operates withgout regard to cycle boundaries.  EfiColdReset \r
+  /// operation and operates withgout regard to cycle boundaries.  EfiColdReset\r

   /// is tantamount to a system power cycle.\r
   ///\r
   EfiPeiResetCold,\r
   ///\r
   /// Used to induce a system-wide initialization. The processors are set to their\r
   /// is tantamount to a system power cycle.\r
   ///\r
   EfiPeiResetCold,\r
   ///\r
   /// Used to induce a system-wide initialization. The processors are set to their\r

-  /// initial state, and pending cycles are not corrupted.  If the system does \r
+  /// initial state, and pending cycles are not corrupted.  If the system does\r

   /// not support this reset type, then an EfiResetCold must be performed.\r
   ///\r
   EfiPeiResetWarm,\r
 } EFI_PEI_RESET_TYPE;\r
 \r
   /// not support this reset type, then an EfiResetCold must be performed.\r
   ///\r
   EfiPeiResetWarm,\r
 } EFI_PEI_RESET_TYPE;\r
 \r

-#endif  \r
+#endif\r

 \r
 \r