tyler.durden/audk
1
0
Fork 0
mirror of https://github.com/acidanthera/audk.git synced 2025-07-31 01:24:12 +02:00
Code Issues Packages Projects Releases Wiki Activity

UefiCpuPkg/RegisterCpuFeaturesLib: Fix the function header issues

Browse Source 
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>
This commit is contained in:
Jeff Fan 2017-03-27 09:14:30 +08:00
parent 2d12048958
commit 8d5df9d78f
6 changed files with 67 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
UefiCpuPkg/Include/Library/RegisterCpuFeaturesLib.h
View File

@ -257,35 +257,37 @@ RETURN_STATUS
/** /**
Registers a CPU Feature. Registers a CPU Feature.
@param GetConfigDataFunc CPU feature get configuration data function. This @param[in] FeatureName A Null-terminated Ascii string indicates CPU feature
is an optional parameter that may be NULL. If NULL, name.
then the most recently registered function for the @param[in] GetConfigDataFunc CPU feature get configuration data function. This
CPU feature is used. If no functions are registered is an optional parameter that may be NULL. If NULL,
for a CPU feature, then the CPU configuration data then the most recently registered function for the
for the registered feature is NULL. CPU feature is used. If no functions are registered
@param SupportFunc CPU feature support function. This is an optional for a CPU feature, then the CPU configuration data
parameter that may be NULL. If NULL, then the most for the registered feature is NULL.
recently registered function for the CPU feature is @param[in] SupportFunc CPU feature support function. This is an optional
used. If no functions are registered for a CPU parameter that may be NULL. If NULL, then the most
feature, then the CPU feature is assumed to be recently registered function for the CPU feature is
supported by all CPUs. used. If no functions are registered for a CPU
@param InitializeFunc CPU feature initialize function. This is an optional feature, then the CPU feature is assumed to be
parameter that may be NULL. If NULL, then the most supported by all CPUs.
recently registered function for the CPU feature is @param[in] InitializeFunc CPU feature initialize function. This is an optional
used. If no functions are registered for a CPU parameter that may be NULL. If NULL, then the most
feature, then the CPU feature initialization is recently registered function for the CPU feature is
skipped. used. If no functions are registered for a CPU
@param ... Variable argument list of UINT32 CPU feature value. feature, then the CPU feature initialization is
Values with no modifiers are the features provided skipped.
by the registered functions. @param[in] ... Variable argument list of UINT32 CPU feature value.
Values with CPU_FEATURE_BEFORE modifier are features Values with no modifiers are the features provided
that must be initialized after the features provided by the registered functions.
by the registered functions are used. Values with CPU_FEATURE_BEFORE modifier are features
Values with CPU_FEATURE_AFTER modifier are features that must be initialized after the features provided
that must be initialized before the features provided by the registered functions are used.
by the registered functions are used. Values with CPU_FEATURE_AFTER modifier are features
The last argument in this variable argument list must that must be initialized before the features provided
always be CPU_FEATURE_END. 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_SUCCESS The CPU feature was successfully registered.
@retval RETURN_OUT_OF_RESOURCES There are not enough resources to register @retval RETURN_OUT_OF_RESOURCES There are not enough resources to register

2
UefiCpuPkg/Library/RegisterCpuFeaturesLib/CpuFeaturesInitialize.c
View File

@ -18,7 +18,7 @@
Worker function to save PcdCpuFeaturesCapability. Worker function to save PcdCpuFeaturesCapability.
@param[in] SupportedFeatureMask The pointer to CPU feature bits mask buffer @param[in] SupportedFeatureMask The pointer to CPU feature bits mask buffer
*/ **/
VOID VOID
SetCapabilityPcd ( SetCapabilityPcd (
IN UINT8 *SupportedFeatureMask IN UINT8 *SupportedFeatureMask

2
UefiCpuPkg/Library/RegisterCpuFeaturesLib/DxeRegisterCpuFeaturesLib.c
View File

@ -168,7 +168,7 @@ SwitchNewBsp (
/** /**
Worker function to retrieve the number of logical processor in the platform. 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 processors in the system, including the BSP
and disabled APs. and disabled APs.
@param[out] NumberOfEnabledProcessors Pointer to the number of enabled logical @param[out] NumberOfEnabledProcessors Pointer to the number of enabled logical

2
UefiCpuPkg/Library/RegisterCpuFeaturesLib/PeiRegisterCpuFeaturesLib.c
View File

@ -219,7 +219,7 @@ SwitchNewBsp (
/** /**
Worker function to retrieve the number of logical processor in the platform. 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 processors in the system, including the BSP
and disabled APs. and disabled APs.
@param[out] NumberOfEnabledProcessors Pointer to the number of enabled logical @param[out] NumberOfEnabledProcessors Pointer to the number of enabled logical

2
UefiCpuPkg/Library/RegisterCpuFeaturesLib/RegisterCpuFeatures.h
View File

@ -147,7 +147,7 @@ StartupAPsWorker (
/** /**
Worker function to retrieve the number of logical processor in the platform. 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 processors in the system, including the BSP
and disabled APs. and disabled APs.
@param[out] NumberOfEnabledProcessors Pointer to the number of enabled logical @param[out] NumberOfEnabledProcessors Pointer to the number of enabled logical

62
UefiCpuPkg/Library/RegisterCpuFeaturesLib/RegisterCpuFeaturesLib.c
View File

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