UefiCpuPkg: Change OPTIONAL keyword usage style

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3760

Update all use of ', OPTIONAL' to ' OPTIONAL,' for function params.

Cc: Andrew Fish <afish@apple.com>
Cc: Leif Lindholm <leif@nuviainc.com>
Cc: Michael Kubacki <michael.kubacki@microsoft.com>
Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com>
Reviewed-by: Ray Ni <ray.ni@intel.com>
This commit is contained in:
Michael D Kinney 2021-12-02 18:01:00 -08:00 committed by mergify[bot]
parent 902e76de19
commit 4ec586b9f6
27 changed files with 64 additions and 69 deletions

View File

@ -691,7 +691,7 @@ ConvertMemoryPageAttributes (
IN UINT64 Attributes,
IN PAGE_ACTION PageAction,
IN PAGE_TABLE_LIB_ALLOCATE_PAGES AllocatePagesFunc OPTIONAL,
OUT BOOLEAN *IsSplitted, OPTIONAL
OUT BOOLEAN *IsSplitted OPTIONAL,
OUT BOOLEAN *IsModified OPTIONAL
)
{
@ -1379,4 +1379,3 @@ InitializePageTableLib (
return ;
}

View File

@ -54,7 +54,7 @@ MpInitLibInitialize (
EFI_STATUS
EFIAPI
MpInitLibGetNumberOfProcessors (
OUT UINTN *NumberOfProcessors, OPTIONAL
OUT UINTN *NumberOfProcessors OPTIONAL,
OUT UINTN *NumberOfEnabledProcessors OPTIONAL
);

View File

@ -252,7 +252,7 @@ RETURN_STATUS
(EFIAPI *CPU_FEATURE_INITIALIZE)(
IN UINTN ProcessorNumber,
IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
IN VOID *ConfigData, OPTIONAL
IN VOID *ConfigData OPTIONAL,
IN BOOLEAN State
);
@ -303,10 +303,10 @@ RETURN_STATUS
RETURN_STATUS
EFIAPI
RegisterCpuFeature (
IN CHAR8 *FeatureName, OPTIONAL
IN CPU_FEATURE_GET_CONFIG_DATA GetConfigDataFunc, OPTIONAL
IN CPU_FEATURE_SUPPORT SupportFunc, OPTIONAL
IN CPU_FEATURE_INITIALIZE InitializeFunc, OPTIONAL
IN CHAR8 *FeatureName OPTIONAL,
IN CPU_FEATURE_GET_CONFIG_DATA GetConfigDataFunc OPTIONAL,
IN CPU_FEATURE_SUPPORT SupportFunc OPTIONAL,
IN CPU_FEATURE_INITIALIZE InitializeFunc OPTIONAL,
...
);

View File

@ -87,7 +87,7 @@ EFIAPI
AesniInitialize (
IN UINTN ProcessorNumber,
IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
IN VOID *ConfigData, OPTIONAL
IN VOID *ConfigData OPTIONAL,
IN BOOLEAN State
)
{

View File

@ -57,7 +57,7 @@ EFIAPI
C1eInitialize (
IN UINTN ProcessorNumber,
IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
IN VOID *ConfigData, OPTIONAL
IN VOID *ConfigData OPTIONAL,
IN BOOLEAN State
)
{

View File

@ -99,7 +99,7 @@ EFIAPI
ClockModulationInitialize (
IN UINTN ProcessorNumber,
IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
IN VOID *ConfigData, OPTIONAL
IN VOID *ConfigData OPTIONAL,
IN BOOLEAN State
)
{

View File

@ -83,7 +83,7 @@ EFIAPI
AesniInitialize (
IN UINTN ProcessorNumber,
IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
IN VOID *ConfigData, OPTIONAL
IN VOID *ConfigData OPTIONAL,
IN BOOLEAN State
);
@ -148,7 +148,7 @@ EFIAPI
ClockModulationInitialize (
IN UINTN ProcessorNumber,
IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
IN VOID *ConfigData, OPTIONAL
IN VOID *ConfigData OPTIONAL,
IN BOOLEAN State
);
@ -200,7 +200,7 @@ EFIAPI
EistInitialize (
IN UINTN ProcessorNumber,
IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
IN VOID *ConfigData, OPTIONAL
IN VOID *ConfigData OPTIONAL,
IN BOOLEAN State
);
@ -250,7 +250,7 @@ EFIAPI
ExecuteDisableInitialize (
IN UINTN ProcessorNumber,
IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
IN VOID *ConfigData, OPTIONAL
IN VOID *ConfigData OPTIONAL,
IN BOOLEAN State
);
@ -276,7 +276,7 @@ EFIAPI
FastStringsInitialize (
IN UINTN ProcessorNumber,
IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
IN VOID *ConfigData, OPTIONAL
IN VOID *ConfigData OPTIONAL,
IN BOOLEAN State
);
@ -326,7 +326,7 @@ EFIAPI
MonitorMwaitInitialize (
IN UINTN ProcessorNumber,
IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
IN VOID *ConfigData, OPTIONAL
IN VOID *ConfigData OPTIONAL,
IN BOOLEAN State
);
@ -376,7 +376,7 @@ EFIAPI
VmxInitialize (
IN UINTN ProcessorNumber,
IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
IN VOID *ConfigData, OPTIONAL
IN VOID *ConfigData OPTIONAL,
IN BOOLEAN State
);
@ -426,7 +426,7 @@ EFIAPI
LockFeatureControlRegisterInitialize (
IN UINTN ProcessorNumber,
IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
IN VOID *ConfigData, OPTIONAL
IN VOID *ConfigData OPTIONAL,
IN BOOLEAN State
);
@ -477,7 +477,7 @@ EFIAPI
SmxInitialize (
IN UINTN ProcessorNumber,
IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
IN VOID *ConfigData, OPTIONAL
IN VOID *ConfigData OPTIONAL,
IN BOOLEAN State
);
@ -527,7 +527,7 @@ EFIAPI
LimitCpuidMaxvalInitialize (
IN UINTN ProcessorNumber,
IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
IN VOID *ConfigData, OPTIONAL
IN VOID *ConfigData OPTIONAL,
IN BOOLEAN State
);
@ -577,7 +577,7 @@ EFIAPI
MceInitialize (
IN UINTN ProcessorNumber,
IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
IN VOID *ConfigData, OPTIONAL
IN VOID *ConfigData OPTIONAL,
IN BOOLEAN State
);
@ -627,7 +627,7 @@ EFIAPI
McaInitialize (
IN UINTN ProcessorNumber,
IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
IN VOID *ConfigData, OPTIONAL
IN VOID *ConfigData OPTIONAL,
IN BOOLEAN State
);
@ -677,7 +677,7 @@ EFIAPI
McgCtlInitialize (
IN UINTN ProcessorNumber,
IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
IN VOID *ConfigData, OPTIONAL
IN VOID *ConfigData OPTIONAL,
IN BOOLEAN State
);
@ -727,7 +727,7 @@ EFIAPI
PendingBreakInitialize (
IN UINTN ProcessorNumber,
IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
IN VOID *ConfigData, OPTIONAL
IN VOID *ConfigData OPTIONAL,
IN BOOLEAN State
);
@ -777,7 +777,7 @@ EFIAPI
C1eInitialize (
IN UINTN ProcessorNumber,
IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
IN VOID *ConfigData, OPTIONAL
IN VOID *ConfigData OPTIONAL,
IN BOOLEAN State
);
@ -844,7 +844,7 @@ EFIAPI
X2ApicInitialize (
IN UINTN ProcessorNumber,
IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
IN VOID *ConfigData, OPTIONAL
IN VOID *ConfigData OPTIONAL,
IN BOOLEAN State
);
@ -914,7 +914,7 @@ EFIAPI
PpinInitialize (
IN UINTN ProcessorNumber,
IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
IN VOID *ConfigData, OPTIONAL
IN VOID *ConfigData OPTIONAL,
IN BOOLEAN State
);
@ -966,7 +966,7 @@ EFIAPI
LmceInitialize (
IN UINTN ProcessorNumber,
IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
IN VOID *ConfigData, OPTIONAL
IN VOID *ConfigData OPTIONAL,
IN BOOLEAN State
);
@ -1032,7 +1032,7 @@ EFIAPI
ProcTraceInitialize (
IN UINTN ProcessorNumber,
IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
IN VOID *ConfigData, OPTIONAL
IN VOID *ConfigData OPTIONAL,
IN BOOLEAN State
);

View File

@ -59,7 +59,7 @@ EFIAPI
EistInitialize (
IN UINTN ProcessorNumber,
IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
IN VOID *ConfigData, OPTIONAL
IN VOID *ConfigData OPTIONAL,
IN BOOLEAN State
)
{

View File

@ -30,7 +30,7 @@ EFIAPI
FastStringsInitialize (
IN UINTN ProcessorNumber,
IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
IN VOID *ConfigData, OPTIONAL
IN VOID *ConfigData OPTIONAL,
IN BOOLEAN State
)
{

View File

@ -57,7 +57,7 @@ EFIAPI
VmxInitialize (
IN UINTN ProcessorNumber,
IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
IN VOID *ConfigData, OPTIONAL
IN VOID *ConfigData OPTIONAL,
IN BOOLEAN State
)
{
@ -135,7 +135,7 @@ EFIAPI
LockFeatureControlRegisterInitialize (
IN UINTN ProcessorNumber,
IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
IN VOID *ConfigData, OPTIONAL
IN VOID *ConfigData OPTIONAL,
IN BOOLEAN State
)
{
@ -214,7 +214,7 @@ EFIAPI
SmxInitialize (
IN UINTN ProcessorNumber,
IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
IN VOID *ConfigData, OPTIONAL
IN VOID *ConfigData OPTIONAL,
IN BOOLEAN State
)
{

View File

@ -60,7 +60,7 @@ EFIAPI
LimitCpuidMaxvalInitialize (
IN UINTN ProcessorNumber,
IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
IN VOID *ConfigData, OPTIONAL
IN VOID *ConfigData OPTIONAL,
IN BOOLEAN State
)
{

View File

@ -57,7 +57,7 @@ EFIAPI
MceInitialize (
IN UINTN ProcessorNumber,
IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
IN VOID *ConfigData, OPTIONAL
IN VOID *ConfigData OPTIONAL,
IN BOOLEAN State
)
{
@ -127,7 +127,7 @@ EFIAPI
McaInitialize (
IN UINTN ProcessorNumber,
IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
IN VOID *ConfigData, OPTIONAL
IN VOID *ConfigData OPTIONAL,
IN BOOLEAN State
)
{
@ -241,7 +241,7 @@ EFIAPI
McgCtlInitialize (
IN UINTN ProcessorNumber,
IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
IN VOID *ConfigData, OPTIONAL
IN VOID *ConfigData OPTIONAL,
IN BOOLEAN State
)
{
@ -315,7 +315,7 @@ EFIAPI
LmceInitialize (
IN UINTN ProcessorNumber,
IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
IN VOID *ConfigData, OPTIONAL
IN VOID *ConfigData OPTIONAL,
IN BOOLEAN State
)
{

View File

@ -57,7 +57,7 @@ EFIAPI
MonitorMwaitInitialize (
IN UINTN ProcessorNumber,
IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
IN VOID *ConfigData, OPTIONAL
IN VOID *ConfigData OPTIONAL,
IN BOOLEAN State
)
{

View File

@ -64,7 +64,7 @@ EFIAPI
PendingBreakInitialize (
IN UINTN ProcessorNumber,
IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
IN VOID *ConfigData, OPTIONAL
IN VOID *ConfigData OPTIONAL,
IN BOOLEAN State
)
{

View File

@ -108,7 +108,7 @@ EFIAPI
PpinInitialize (
IN UINTN ProcessorNumber,
IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
IN VOID *ConfigData, OPTIONAL
IN VOID *ConfigData OPTIONAL,
IN BOOLEAN State
)
{

View File

@ -166,7 +166,7 @@ EFIAPI
ProcTraceInitialize (
IN UINTN ProcessorNumber,
IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
IN VOID *ConfigData, OPTIONAL
IN VOID *ConfigData OPTIONAL,
IN BOOLEAN State
)
{

View File

@ -90,7 +90,7 @@ EFIAPI
X2ApicInitialize (
IN UINTN ProcessorNumber,
IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
IN VOID *ConfigData, OPTIONAL
IN VOID *ConfigData OPTIONAL,
IN BOOLEAN State
)
{

View File

@ -219,7 +219,7 @@ GetPerformanceCounter (
UINT64
EFIAPI
GetPerformanceCounterProperties (
OUT UINT64 *StartValue, OPTIONAL
OUT UINT64 *StartValue OPTIONAL,
OUT UINT64 *EndValue OPTIONAL
)
{
@ -276,4 +276,3 @@ GetTimeInNanoSecond (
return NanoSeconds;
}

View File

@ -1333,8 +1333,8 @@ WakeUpAP (
IN CPU_MP_DATA *CpuMpData,
IN BOOLEAN Broadcast,
IN UINTN ProcessorNumber,
IN EFI_AP_PROCEDURE Procedure, OPTIONAL
IN VOID *ProcedureArgument, OPTIONAL
IN EFI_AP_PROCEDURE Procedure OPTIONAL,
IN VOID *ProcedureArgument OPTIONAL,
IN BOOLEAN WakeUpDisabledAps
)
{
@ -2534,7 +2534,7 @@ MpInitLibWhoAmI (
EFI_STATUS
EFIAPI
MpInitLibGetNumberOfProcessors (
OUT UINTN *NumberOfProcessors, OPTIONAL
OUT UINTN *NumberOfProcessors OPTIONAL,
OUT UINTN *NumberOfEnabledProcessors OPTIONAL
)
{

View File

@ -466,8 +466,8 @@ WakeUpAP (
IN CPU_MP_DATA *CpuMpData,
IN BOOLEAN Broadcast,
IN UINTN ProcessorNumber,
IN EFI_AP_PROCEDURE Procedure, OPTIONAL
IN VOID *ProcedureArgument, OPTIONAL
IN EFI_AP_PROCEDURE Procedure OPTIONAL,
IN VOID *ProcedureArgument OPTIONAL,
IN BOOLEAN WakeUpDisabledAps OPTIONAL
);
@ -742,4 +742,3 @@ PlatformShadowMicrocode (
);
#endif

View File

@ -63,7 +63,7 @@ MpInitLibInitialize (
EFI_STATUS
EFIAPI
MpInitLibGetNumberOfProcessors (
OUT UINTN *NumberOfProcessors, OPTIONAL
OUT UINTN *NumberOfProcessors OPTIONAL,
OUT UINTN *NumberOfEnabledProcessors OPTIONAL
)
{

View File

@ -1287,8 +1287,8 @@ MtrrLibCalculateSubtractivePath (
IN UINT16 Stop,
IN UINT8 Types,
IN UINT8 TypeCount,
IN OUT MTRR_MEMORY_RANGE *Mtrrs, OPTIONAL
IN UINT32 MtrrCapacity, OPTIONAL
IN OUT MTRR_MEMORY_RANGE *Mtrrs OPTIONAL,
IN UINT32 MtrrCapacity OPTIONAL,
IN OUT UINT32 *MtrrCount OPTIONAL
)
{

View File

@ -129,7 +129,7 @@ VOID
GenerateRandomMtrrPair (
IN UINT32 PhysicalAddressBits,
IN MTRR_MEMORY_CACHE_TYPE CacheType,
OUT MTRR_VARIABLE_SETTING *MtrrPair, OPTIONAL
OUT MTRR_VARIABLE_SETTING *MtrrPair OPTIONAL,
OUT MTRR_MEMORY_RANGE *MtrrMemoryRange OPTIONAL
);

View File

@ -113,9 +113,9 @@ UINT32
EFIAPI
UnitTestMtrrLibAsmCpuid (
IN UINT32 Index,
OUT UINT32 *Eax, OPTIONAL
OUT UINT32 *Ebx, OPTIONAL
OUT UINT32 *Ecx, OPTIONAL
OUT UINT32 *Eax OPTIONAL,
OUT UINT32 *Ebx OPTIONAL,
OUT UINT32 *Ecx OPTIONAL,
OUT UINT32 *Edx OPTIONAL
)
{
@ -423,7 +423,7 @@ VOID
GenerateRandomMtrrPair (
IN UINT32 PhysicalAddressBits,
IN MTRR_MEMORY_CACHE_TYPE CacheType,
OUT MTRR_VARIABLE_SETTING *MtrrPair, OPTIONAL
OUT MTRR_VARIABLE_SETTING *MtrrPair OPTIONAL,
OUT MTRR_MEMORY_RANGE *MtrrMemoryRange OPTIONAL
)
{

View File

@ -803,10 +803,10 @@ SetCpuFeaturesBitMask (
RETURN_STATUS
EFIAPI
RegisterCpuFeature (
IN CHAR8 *FeatureName, OPTIONAL
IN CPU_FEATURE_GET_CONFIG_DATA GetConfigDataFunc, OPTIONAL
IN CPU_FEATURE_SUPPORT SupportFunc, OPTIONAL
IN CPU_FEATURE_INITIALIZE InitializeFunc, OPTIONAL
IN CHAR8 *FeatureName OPTIONAL,
IN CPU_FEATURE_GET_CONFIG_DATA GetConfigDataFunc OPTIONAL,
IN CPU_FEATURE_SUPPORT SupportFunc OPTIONAL,
IN CPU_FEATURE_INITIALIZE InitializeFunc OPTIONAL,
...
)
{
@ -1288,4 +1288,3 @@ SwitchBspAfterFeaturesInitialize (
CpuFeaturesData = GetCpuFeaturesData ();
CpuFeaturesData->BspNumber = ProcessorNumber;
}

View File

@ -200,7 +200,7 @@ GetPerformanceCounter (
UINT64
EFIAPI
GetPerformanceCounterProperties (
OUT UINT64 *StartValue, OPTIONAL
OUT UINT64 *StartValue OPTIONAL,
OUT UINT64 *EndValue OPTIONAL
)
{

View File

@ -405,7 +405,7 @@ ConvertMemoryPageAttributes (
IN UINT64 Length,
IN UINT64 Attributes,
IN BOOLEAN IsSet,
OUT BOOLEAN *IsSplitted, OPTIONAL
OUT BOOLEAN *IsSplitted OPTIONAL,
OUT BOOLEAN *IsModified OPTIONAL
)
{
@ -1568,4 +1568,3 @@ EdkiiSmmGetMemoryAttributes (
return EFI_SUCCESS;
}