UefiCpuPkg/RegisterCpuFeaturesLib: Fix the function header issues

Cc: Feng Tian <feng.tian@intel.com>
Cc: Michael Kinney <michael.d.kinney@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Jeff Fan <jeff.fan@intel.com>
Reviewed-by: Feng Tian <feng.tian@intel.com>

diff --git a/UefiCpuPkg/Include/Library/RegisterCpuFeaturesLib.h b/UefiCpuPkg/Include/Library/RegisterCpuFeaturesLib.h
index 3fb82090f3c7aca5ae23168a373506ff579a176d..81a1f4bc38d0fa6d42cbe4ee48f9383d7d159c51 100644 (file)
--- a/UefiCpuPkg/Include/Library/RegisterCpuFeaturesLib.h
+++ b/UefiCpuPkg/Include/Library/RegisterCpuFeaturesLib.h
@@ -257,35 +257,37 @@ RETURN_STATUS
 /**
   Registers a CPU Feature.
 
-  @param  GetConfigDataFunc  CPU feature get configuration data function.  This
-                             is an optional parameter that may be NULL.  If NULL,
-                             then the most recently registered function for the
-                             CPU feature is used.  If no functions are registered
-                             for a CPU feature, then the CPU configuration data
-                             for the registered feature is NULL.
-  @param  SupportFunc        CPU feature support function.  This is an optional
-                             parameter that may be NULL.  If NULL, then the most
-                             recently registered function for the CPU feature is
-                             used. If no functions are registered for a CPU
-                             feature, then the CPU feature is assumed to be
-                             supported by all CPUs.
-  @param  InitializeFunc     CPU feature initialize function.  This is an optional
-                             parameter that may be NULL.  If NULL, then the most
-                             recently registered function for the CPU feature is
-                             used. If no functions are registered for a CPU
-                             feature, then the CPU feature initialization is
-                             skipped.
-  @param  ...                Variable argument list of UINT32 CPU feature value.
-                             Values with no modifiers are the features provided
-                             by the registered functions.
-                             Values with CPU_FEATURE_BEFORE modifier are features
-                             that must be initialized after the features provided
-                             by the registered functions are used.
-                             Values with CPU_FEATURE_AFTER modifier are features
-                             that must be initialized before the features provided
-                             by the registered functions are used.
-                             The last argument in this variable argument list must
-                             always be CPU_FEATURE_END.
+  @param[in]  FeatureName        A Null-terminated Ascii string indicates CPU feature
+                                 name.
+  @param[in]  GetConfigDataFunc  CPU feature get configuration data function.  This
+                                 is an optional parameter that may be NULL.  If NULL,
+                                 then the most recently registered function for the
+                                 CPU feature is used.  If no functions are registered
+                                 for a CPU feature, then the CPU configuration data
+                                 for the registered feature is NULL.
+  @param[in]  SupportFunc        CPU feature support function.  This is an optional
+                                 parameter that may be NULL.  If NULL, then the most
+                                 recently registered function for the CPU feature is
+                                 used. If no functions are registered for a CPU
+                                 feature, then the CPU feature is assumed to be
+                                 supported by all CPUs.
+  @param[in]  InitializeFunc     CPU feature initialize function.  This is an optional
+                                 parameter that may be NULL.  If NULL, then the most
+                                 recently registered function for the CPU feature is
+                                 used. If no functions are registered for a CPU
+                                 feature, then the CPU feature initialization is
+                                 skipped.
+  @param[in]  ...                Variable argument list of UINT32 CPU feature value.
+                                 Values with no modifiers are the features provided
+                                 by the registered functions.
+                                 Values with CPU_FEATURE_BEFORE modifier are features
+                                 that must be initialized after the features provided
+                                 by the registered functions are used.
+                                 Values with CPU_FEATURE_AFTER modifier are features
+                                 that must be initialized before the features provided
+                                 by the registered functions are used.
+                                 The last argument in this variable argument list must
+                                 always be CPU_FEATURE_END.
 
   @retval  RETURN_SUCCESS           The CPU feature was successfully registered.
   @retval  RETURN_OUT_OF_RESOURCES  There are not enough resources to register

diff --git a/UefiCpuPkg/Library/RegisterCpuFeaturesLib/CpuFeaturesInitialize.c b/UefiCpuPkg/Library/RegisterCpuFeaturesLib/CpuFeaturesInitialize.c
index cd689af43f0b179feea2388c64cbcaefd56894c6..e0fe38c9352138c8e2e37d3397b0cf57d0770f69 100644 (file)
--- a/UefiCpuPkg/Library/RegisterCpuFeaturesLib/CpuFeaturesInitialize.c
+++ b/UefiCpuPkg/Library/RegisterCpuFeaturesLib/CpuFeaturesInitialize.c
@@ -18,7 +18,7 @@
   Worker function to save PcdCpuFeaturesCapability.
 
   @param[in]  SupportedFeatureMask  The pointer to CPU feature bits mask buffer
-*/
+**/
 VOID
 SetCapabilityPcd (
   IN UINT8               *SupportedFeatureMask

diff --git a/UefiCpuPkg/Library/RegisterCpuFeaturesLib/DxeRegisterCpuFeaturesLib.c b/UefiCpuPkg/Library/RegisterCpuFeaturesLib/DxeRegisterCpuFeaturesLib.c
index b5a1de771965fb92960030f80da5868a5da4c49d..c49f556947e2a2928cb7f13ff0d656ff224ecf28 100644 (file)
--- a/UefiCpuPkg/Library/RegisterCpuFeaturesLib/DxeRegisterCpuFeaturesLib.c
+++ b/UefiCpuPkg/Library/RegisterCpuFeaturesLib/DxeRegisterCpuFeaturesLib.c
@@ -168,7 +168,7 @@ SwitchNewBsp (
 /**
   Worker function to retrieve the number of logical processor in the platform.
 
-  @param[out] NumberOfProcessors          Pointer to the total number of logical
+  @param[out] NumberOfCpus                Pointer to the total number of logical
                                           processors in the system, including the BSP
                                           and disabled APs.
   @param[out] NumberOfEnabledProcessors   Pointer to the number of enabled logical

diff --git a/UefiCpuPkg/Library/RegisterCpuFeaturesLib/PeiRegisterCpuFeaturesLib.c b/UefiCpuPkg/Library/RegisterCpuFeaturesLib/PeiRegisterCpuFeaturesLib.c
index 12a516a107207eb7799999636d7b5c54ddfa956f..8fde742dce3719e0e4531a28785dfa800db5fca0 100644 (file)
--- a/UefiCpuPkg/Library/RegisterCpuFeaturesLib/PeiRegisterCpuFeaturesLib.c
+++ b/UefiCpuPkg/Library/RegisterCpuFeaturesLib/PeiRegisterCpuFeaturesLib.c
@@ -219,7 +219,7 @@ SwitchNewBsp (
 /**
   Worker function to retrieve the number of logical processor in the platform.
 
-  @param[out] NumberOfProcessors          Pointer to the total number of logical
+  @param[out] NumberOfCpus                Pointer to the total number of logical
                                           processors in the system, including the BSP
                                           and disabled APs.
   @param[out] NumberOfEnabledProcessors   Pointer to the number of enabled logical

diff --git a/UefiCpuPkg/Library/RegisterCpuFeaturesLib/RegisterCpuFeatures.h b/UefiCpuPkg/Library/RegisterCpuFeaturesLib/RegisterCpuFeatures.h
index 2b136b6eccb13a35e2d94cfe57841f5a096820f5..11f8eb794def293e40009e3e4a9c9c84457d5d3a 100644 (file)
--- a/UefiCpuPkg/Library/RegisterCpuFeaturesLib/RegisterCpuFeatures.h
+++ b/UefiCpuPkg/Library/RegisterCpuFeaturesLib/RegisterCpuFeatures.h
@@ -147,7 +147,7 @@ StartupAPsWorker (
 /**
   Worker function to retrieve the number of logical processor in the platform.
 
-  @param[out] NumberOfProcessors          Pointer to the total number of logical
+  @param[out] NumberOfCpus                Pointer to the total number of logical
                                           processors in the system, including the BSP
                                           and disabled APs.
   @param[out] NumberOfEnabledProcessors   Pointer to the number of enabled logical

diff --git a/UefiCpuPkg/Library/RegisterCpuFeaturesLib/RegisterCpuFeaturesLib.c b/UefiCpuPkg/Library/RegisterCpuFeaturesLib/RegisterCpuFeaturesLib.c
index 3fec2e6ca30230b99e5a1a139c64fad0f054f392..7ef015537401b52e77fdcefa0aabbac447414c42 100644 (file)
--- a/UefiCpuPkg/Library/RegisterCpuFeaturesLib/RegisterCpuFeaturesLib.c
+++ b/UefiCpuPkg/Library/RegisterCpuFeaturesLib/RegisterCpuFeaturesLib.c
@@ -240,7 +240,7 @@ CheckCpuFeaturesDependency (
 /**
   Worker function to register CPU Feature.
 
-  @param[in]  CpuFeature                Pointer to CPU feature entry
+  @param[in]  CpuFeature            Pointer to CPU feature entry
 
   @retval  RETURN_SUCCESS           The CPU feature was successfully registered.
   @retval  RETURN_OUT_OF_RESOURCES  There are not enough resources to register
@@ -372,35 +372,37 @@ SetCpuFeaturesBitMask (
 /**
   Registers a CPU Feature.
 
-  @param  GetConfigDataFunc  CPU feature get configuration data function.  This
-                             is an optional parameter that may be NULL.  If NULL,
-                             then the most recently registered function for the
-                             CPU feature is used.  If no functions are registered
-                             for a CPU feature, then the CPU configuration data
-                             for the registered feature is NULL.
-  @param  SupportFunc        CPU feature support function.  This is an optional
-                             parameter that may be NULL.  If NULL, then the most
-                             recently registered function for the CPU feature is
-                             used. If no functions are registered for a CPU
-                             feature, then the CPU feature is assumed to be
-                             supported by all CPUs.
-  @param  InitializeFunc     CPU feature initialize function.  This is an optional
-                             parameter that may be NULL.  If NULL, then the most
-                             recently registered function for the CPU feature is
-                             used. If no functions are registered for a CPU
-                             feature, then the CPU feature initialization is
-                             skipped.
-  @param  ...                Variable argument list of UINT32 CPU feature value.
-                             Values with no modifiers are the features provided
-                             by the registered functions.
-                             Values with CPU_FEATURE_BEFORE modifier are features
-                             that must be initialized after the features provided
-                             by the registered functions are used.
-                             Values with CPU_FEATURE_AFTER modifier are features
-                             that must be initialized before the features provided
-                             by the registered functions are used.
-                             The last argument in this variable argument list must
-                             always be CPU_FEATURE_END.
+  @param[in]  FeatureName        A Null-terminated Ascii string indicates CPU feature
+                                 name.
+  @param[in]  GetConfigDataFunc  CPU feature get configuration data function.  This
+                                 is an optional parameter that may be NULL.  If NULL,
+                                 then the most recently registered function for the
+                                 CPU feature is used.  If no functions are registered
+                                 for a CPU feature, then the CPU configuration data
+                                 for the registered feature is NULL.
+  @param[in]  SupportFunc        CPU feature support function.  This is an optional
+                                 parameter that may be NULL.  If NULL, then the most
+                                 recently registered function for the CPU feature is
+                                 used. If no functions are registered for a CPU
+                                 feature, then the CPU feature is assumed to be
+                                 supported by all CPUs.
+  @param[in]  InitializeFunc     CPU feature initialize function.  This is an optional
+                                 parameter that may be NULL.  If NULL, then the most
+                                 recently registered function for the CPU feature is
+                                 used. If no functions are registered for a CPU
+                                 feature, then the CPU feature initialization is
+                                 skipped.
+  @param[in]  ...                Variable argument list of UINT32 CPU feature value.
+                                 Values with no modifiers are the features provided
+                                 by the registered functions.
+                                 Values with CPU_FEATURE_BEFORE modifier are features
+                                 that must be initialized after the features provided
+                                 by the registered functions are used.
+                                 Values with CPU_FEATURE_AFTER modifier are features
+                                 that must be initialized before the features provided
+                                 by the registered functions are used.
+                                 The last argument in this variable argument list must
+                                 always be CPU_FEATURE_END.
 
   @retval  RETURN_SUCCESS           The CPU feature was successfully registered.
   @retval  RETURN_OUT_OF_RESOURCES  There are not enough resources to register