OvmfPkg: 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: Andrew Fish <afish@apple.com>
This commit is contained in:
Michael D Kinney 2021-12-02 18:00:53 -08:00 committed by mergify[bot]
parent 8874fa199d
commit 79d49e162e
25 changed files with 86 additions and 92 deletions

View File

@ -230,9 +230,9 @@ EFI_STATUS
EFIAPI
Interrupt8259GetMask (
IN EFI_LEGACY_8259_PROTOCOL *This,
OUT UINT16 *LegacyMask, OPTIONAL
OUT UINT16 *LegacyEdgeLevel, OPTIONAL
OUT UINT16 *ProtectedMask, OPTIONAL
OUT UINT16 *LegacyMask OPTIONAL,
OUT UINT16 *LegacyEdgeLevel OPTIONAL,
OUT UINT16 *ProtectedMask OPTIONAL,
OUT UINT16 *ProtectedEdgeLevel OPTIONAL
)
{
@ -272,9 +272,9 @@ EFI_STATUS
EFIAPI
Interrupt8259SetMask (
IN EFI_LEGACY_8259_PROTOCOL *This,
IN UINT16 *LegacyMask, OPTIONAL
IN UINT16 *LegacyEdgeLevel, OPTIONAL
IN UINT16 *ProtectedMask, OPTIONAL
IN UINT16 *LegacyMask OPTIONAL,
IN UINT16 *LegacyEdgeLevel OPTIONAL,
IN UINT16 *ProtectedMask OPTIONAL,
IN UINT16 *ProtectedEdgeLevel OPTIONAL
)
{
@ -314,7 +314,7 @@ EFIAPI
Interrupt8259SetMode (
IN EFI_LEGACY_8259_PROTOCOL *This,
IN EFI_8259_MODE Mode,
IN UINT16 *Mask, OPTIONAL
IN UINT16 *Mask OPTIONAL,
IN UINT16 *EdgeLevel OPTIONAL
)
{

View File

@ -75,9 +75,9 @@ EFI_STATUS
EFIAPI
Interrupt8259GetMask (
IN EFI_LEGACY_8259_PROTOCOL *This,
OUT UINT16 *LegacyMask, OPTIONAL
OUT UINT16 *LegacyEdgeLevel, OPTIONAL
OUT UINT16 *ProtectedMask, OPTIONAL
OUT UINT16 *LegacyMask OPTIONAL,
OUT UINT16 *LegacyEdgeLevel OPTIONAL,
OUT UINT16 *ProtectedMask OPTIONAL,
OUT UINT16 *ProtectedEdgeLevel OPTIONAL
);
@ -98,9 +98,9 @@ EFI_STATUS
EFIAPI
Interrupt8259SetMask (
IN EFI_LEGACY_8259_PROTOCOL *This,
IN UINT16 *LegacyMask, OPTIONAL
IN UINT16 *LegacyEdgeLevel, OPTIONAL
IN UINT16 *ProtectedMask, OPTIONAL
IN UINT16 *LegacyMask OPTIONAL,
IN UINT16 *LegacyEdgeLevel OPTIONAL,
IN UINT16 *ProtectedMask OPTIONAL,
IN UINT16 *ProtectedEdgeLevel OPTIONAL
);
@ -121,7 +121,7 @@ EFIAPI
Interrupt8259SetMode (
IN EFI_LEGACY_8259_PROTOCOL *This,
IN EFI_8259_MODE Mode,
IN UINT16 *Mask, OPTIONAL
IN UINT16 *Mask OPTIONAL,
IN UINT16 *EdgeLevel OPTIONAL
);

View File

@ -190,7 +190,7 @@ STATIC
VOID
EFIAPI
AppendFwCfgBootScript (
IN OUT VOID *Context, OPTIONAL
IN OUT VOID *Context OPTIONAL,
IN OUT VOID *ExternalScratchBuffer
)
{

View File

@ -233,7 +233,7 @@ EFI_STATUS
EFIAPI
EmuGopBlt (
IN EFI_GRAPHICS_OUTPUT_PROTOCOL *This,
IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer, OPTIONAL
IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer OPTIONAL,
IN EFI_GRAPHICS_OUTPUT_BLT_OPERATION BltOperation,
IN UINTN SourceX,
IN UINTN SourceY,
@ -390,4 +390,3 @@ Returns:
{
EmuGopDestructor (Context);
}

View File

@ -2249,7 +2249,7 @@ CopyVideoBuffer (
EFI_STATUS
BiosVideoVbeBltWorker (
IN BIOS_VIDEO_DEV *BiosVideoPrivate,
IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer, OPTIONAL
IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer OPTIONAL,
IN EFI_GRAPHICS_OUTPUT_BLT_OPERATION BltOperation,
IN UINTN SourceX,
IN UINTN SourceY,
@ -2518,7 +2518,7 @@ EFI_STATUS
EFIAPI
BiosVideoGraphicsOutputVbeBlt (
IN EFI_GRAPHICS_OUTPUT_PROTOCOL *This,
IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer, OPTIONAL
IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer OPTIONAL,
IN EFI_GRAPHICS_OUTPUT_BLT_OPERATION BltOperation,
IN UINTN SourceX,
IN UINTN SourceY,
@ -2740,7 +2740,7 @@ EFI_STATUS
EFIAPI
BiosVideoGraphicsOutputVgaBlt (
IN EFI_GRAPHICS_OUTPUT_PROTOCOL *This,
IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer, OPTIONAL
IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer OPTIONAL,
IN EFI_GRAPHICS_OUTPUT_BLT_OPERATION BltOperation,
IN UINTN SourceX,
IN UINTN SourceY,
@ -3286,4 +3286,3 @@ BiosVideoEntryPoint(
NULL
);
}

View File

@ -334,7 +334,7 @@ EFI_STATUS
EFIAPI
BiosVideoGraphicsOutputVbeBlt (
IN EFI_GRAPHICS_OUTPUT_PROTOCOL *This,
IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer, OPTIONAL
IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer OPTIONAL,
IN EFI_GRAPHICS_OUTPUT_BLT_OPERATION BltOperation,
IN UINTN SourceX,
IN UINTN SourceY,
@ -377,7 +377,7 @@ EFI_STATUS
EFIAPI
BiosVideoGraphicsOutputVgaBlt (
IN EFI_GRAPHICS_OUTPUT_PROTOCOL *This,
IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer, OPTIONAL
IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer OPTIONAL,
IN EFI_GRAPHICS_OUTPUT_BLT_OPERATION BltOperation,
IN UINTN SourceX,
IN UINTN SourceY,

View File

@ -616,9 +616,9 @@ PlatformHooks (
IN EFI_LEGACY_BIOS_PLATFORM_PROTOCOL *This,
IN EFI_GET_PLATFORM_HOOK_MODE Mode,
IN UINT16 Type,
OUT EFI_HANDLE DeviceHandle, OPTIONAL
IN OUT UINTN *Shadowaddress, OPTIONAL
IN EFI_COMPATIBILITY16_TABLE *Compatibility16Table, OPTIONAL
OUT EFI_HANDLE DeviceHandle OPTIONAL,
IN OUT UINTN *Shadowaddress OPTIONAL,
IN EFI_COMPATIBILITY16_TABLE *Compatibility16Table OPTIONAL,
OUT VOID **AdditionalData OPTIONAL
)
{
@ -674,9 +674,9 @@ GetRoutingTable (
IN EFI_LEGACY_BIOS_PLATFORM_PROTOCOL *This,
OUT VOID **RoutingTable,
OUT UINTN *RoutingTableEntries,
OUT VOID **LocalPirqTable, OPTIONAL
OUT UINTN *PirqTableSize, OPTIONAL
OUT VOID **LocalIrqPriorityTable, OPTIONAL
OUT VOID **LocalPirqTable OPTIONAL,
OUT UINTN *PirqTableSize OPTIONAL,
OUT VOID **LocalIrqPriorityTable OPTIONAL,
OUT UINTN *IrqPriorityTableEntries OPTIONAL
)
{
@ -1057,4 +1057,3 @@ LegacyBiosPlatformInstall (
);
return Status;
}

View File

@ -1200,8 +1200,8 @@ EFI_STATUS
(EFIAPI *EFI_LEGACY_BIOS_CHECK_ROM)(
IN EFI_LEGACY_BIOS_PROTOCOL *This,
IN EFI_HANDLE PciHandle,
OUT VOID **RomImage, OPTIONAL
OUT UINTN *RomSize, OPTIONAL
OUT VOID **RomImage OPTIONAL,
OUT UINTN *RomSize OPTIONAL,
OUT UINTN *Flags
);
@ -1239,9 +1239,9 @@ EFI_STATUS
IN EFI_HANDLE PciHandle,
IN VOID **RomImage,
OUT UINTN *Flags,
OUT UINT8 *DiskStart, OPTIONAL
OUT UINT8 *DiskEnd, OPTIONAL
OUT VOID **RomShadowAddress, OPTIONAL
OUT UINT8 *DiskStart OPTIONAL,
OUT UINT8 *DiskEnd OPTIONAL,
OUT VOID **RomShadowAddress OPTIONAL,
OUT UINT32 *ShadowedRomSize OPTIONAL
);

View File

@ -629,9 +629,9 @@ EFI_STATUS
IN EFI_LEGACY_BIOS_PLATFORM_PROTOCOL *This,
IN EFI_GET_PLATFORM_HOOK_MODE Mode,
IN UINT16 Type,
IN EFI_HANDLE DeviceHandle, OPTIONAL
IN OUT UINTN *ShadowAddress, OPTIONAL
IN EFI_COMPATIBILITY16_TABLE *Compatibility16Table, OPTIONAL
IN EFI_HANDLE DeviceHandle OPTIONAL,
IN OUT UINTN *ShadowAddress OPTIONAL,
IN EFI_COMPATIBILITY16_TABLE *Compatibility16Table OPTIONAL,
OUT VOID **AdditionalData OPTIONAL
);
@ -660,9 +660,9 @@ EFI_STATUS
IN EFI_LEGACY_BIOS_PLATFORM_PROTOCOL *This,
OUT VOID **RoutingTable,
OUT UINTN *RoutingTableEntries,
OUT VOID **LocalPirqTable, OPTIONAL
OUT UINTN *PirqTableSize, OPTIONAL
OUT VOID **LocalIrqPriorityTable, OPTIONAL
OUT VOID **LocalPirqTable OPTIONAL,
OUT UINTN *PirqTableSize OPTIONAL,
OUT VOID **LocalIrqPriorityTable OPTIONAL,
OUT UINTN *IrqPriorityTableEntries OPTIONAL
);

View File

@ -750,8 +750,8 @@ EFIAPI
LegacyBiosCheckPciRom (
IN EFI_LEGACY_BIOS_PROTOCOL *This,
IN EFI_HANDLE PciHandle,
OUT VOID **RomImage, OPTIONAL
OUT UINTN *RomSize, OPTIONAL
OUT VOID **RomImage OPTIONAL,
OUT UINTN *RomSize OPTIONAL,
OUT UINTN *Flags
);
@ -838,9 +838,9 @@ LegacyBiosInstallPciRom (
IN EFI_HANDLE PciHandle,
IN VOID **RomImage,
OUT UINTN *Flags,
OUT UINT8 *DiskStart, OPTIONAL
OUT UINT8 *DiskEnd, OPTIONAL
OUT VOID **RomShadowAddress, OPTIONAL
OUT UINT8 *DiskStart OPTIONAL,
OUT UINT8 *DiskEnd OPTIONAL,
OUT VOID **RomShadowAddress OPTIONAL,
OUT UINT32 *RomShadowedSize OPTIONAL
);
@ -1388,11 +1388,11 @@ EFI_STATUS
LegacyBiosCheckPciRomEx (
IN EFI_LEGACY_BIOS_PROTOCOL *This,
IN EFI_HANDLE PciHandle,
OUT VOID **RomImage, OPTIONAL
OUT UINTN *RomSize, OPTIONAL
OUT UINTN *RuntimeImageLength, OPTIONAL
OUT UINTN *Flags, OPTIONAL
OUT UINT8 *OpromRevision, OPTIONAL
OUT VOID **RomImage OPTIONAL,
OUT UINTN *RomSize OPTIONAL,
OUT UINTN *RuntimeImageLength OPTIONAL,
OUT UINTN *Flags OPTIONAL,
OUT UINT8 *OpromRevision OPTIONAL,
OUT VOID **ConfigUtilityCodeHeader OPTIONAL
);

View File

@ -52,9 +52,9 @@ EDKII_IOMMU_PROTOCOL *mIoMmu;
EFI_STATUS
GetShadowedRomParameters (
IN EFI_HANDLE PciHandle,
OUT UINT8 *DiskStart, OPTIONAL
OUT UINT8 *DiskEnd, OPTIONAL
OUT VOID **RomShadowAddress, OPTIONAL
OUT UINT8 *DiskStart OPTIONAL,
OUT UINT8 *DiskEnd OPTIONAL,
OUT VOID **RomShadowAddress OPTIONAL,
OUT UINTN *ShadowedSize OPTIONAL
)
{
@ -276,8 +276,8 @@ GetPciLegacyRom (
IN UINT16 DeviceId,
IN OUT VOID **Rom,
IN OUT UINTN *ImageSize,
OUT UINTN *MaxRuntimeImageLength, OPTIONAL
OUT UINT8 *OpRomRevision, OPTIONAL
OUT UINTN *MaxRuntimeImageLength OPTIONAL,
OUT UINT8 *OpRomRevision OPTIONAL,
OUT VOID **ConfigUtilityCodeHeader OPTIONAL
)
{
@ -1814,8 +1814,8 @@ EFIAPI
LegacyBiosCheckPciRom (
IN EFI_LEGACY_BIOS_PROTOCOL *This,
IN EFI_HANDLE PciHandle,
OUT VOID **RomImage, OPTIONAL
OUT UINTN *RomSize, OPTIONAL
OUT VOID **RomImage OPTIONAL,
OUT UINTN *RomSize OPTIONAL,
OUT UINTN *Flags
)
{
@ -1856,11 +1856,11 @@ EFI_STATUS
LegacyBiosCheckPciRomEx (
IN EFI_LEGACY_BIOS_PROTOCOL *This,
IN EFI_HANDLE PciHandle,
OUT VOID **RomImage, OPTIONAL
OUT UINTN *RomSize, OPTIONAL
OUT UINTN *RuntimeImageLength, OPTIONAL
OUT UINTN *Flags, OPTIONAL
OUT UINT8 *OpromRevision, OPTIONAL
OUT VOID **RomImage OPTIONAL,
OUT UINTN *RomSize OPTIONAL,
OUT UINTN *RuntimeImageLength OPTIONAL,
OUT UINTN *Flags OPTIONAL,
OUT UINT8 *OpromRevision OPTIONAL,
OUT VOID **ConfigUtilityCodeHeader OPTIONAL
)
{
@ -2256,8 +2256,8 @@ LegacyBiosInstallRom (
IN VOID *RomImage,
IN UINTN ImageSize,
IN OUT UINTN *RuntimeImageLength,
OUT UINT8 *DiskStart, OPTIONAL
OUT UINT8 *DiskEnd, OPTIONAL
OUT UINT8 *DiskStart OPTIONAL,
OUT UINT8 *DiskEnd OPTIONAL,
OUT VOID **RomShadowAddress OPTIONAL
)
{
@ -2791,9 +2791,9 @@ LegacyBiosInstallPciRom (
IN EFI_HANDLE PciHandle,
IN VOID **RomImage,
OUT UINTN *Flags,
OUT UINT8 *DiskStart, OPTIONAL
OUT UINT8 *DiskEnd, OPTIONAL
OUT VOID **RomShadowAddress, OPTIONAL
OUT UINT8 *DiskStart OPTIONAL,
OUT UINT8 *DiskEnd OPTIONAL,
OUT VOID **RomShadowAddress OPTIONAL,
OUT UINT32 *RomShadowedSize OPTIONAL
)
{
@ -3080,4 +3080,3 @@ LegacyBiosInstallPciRom (
mVgaInstallationInProgress = FALSE;
return Status;
}

View File

@ -87,7 +87,7 @@ QemuFwCfgS3Enabled (
**/
typedef
VOID (EFIAPI FW_CFG_BOOT_SCRIPT_CALLBACK_FUNCTION) (
IN OUT VOID *Context, OPTIONAL
IN OUT VOID *Context OPTIONAL,
IN OUT VOID *ScratchBuffer
);
@ -153,7 +153,7 @@ RETURN_STATUS
EFIAPI
QemuFwCfgS3CallWhenBootScriptReady (
IN FW_CFG_BOOT_SCRIPT_CALLBACK_FUNCTION *Callback,
IN OUT VOID *Context, OPTIONAL
IN OUT VOID *Context OPTIONAL,
IN UINTN ScratchBufferSize
);

View File

@ -88,9 +88,9 @@ typedef
EFI_STATUS
(EFIAPI *EFI_LEGACY_8259_GET_MASK)(
IN EFI_LEGACY_8259_PROTOCOL *This,
OUT UINT16 *LegacyMask, OPTIONAL
OUT UINT16 *LegacyEdgeLevel, OPTIONAL
OUT UINT16 *ProtectedMask, OPTIONAL
OUT UINT16 *LegacyMask OPTIONAL,
OUT UINT16 *LegacyEdgeLevel OPTIONAL,
OUT UINT16 *ProtectedMask OPTIONAL,
OUT UINT16 *ProtectedEdgeLevel OPTIONAL
);
@ -114,9 +114,9 @@ typedef
EFI_STATUS
(EFIAPI *EFI_LEGACY_8259_SET_MASK)(
IN EFI_LEGACY_8259_PROTOCOL *This,
IN UINT16 *LegacyMask, OPTIONAL
IN UINT16 *LegacyEdgeLevel, OPTIONAL
IN UINT16 *ProtectedMask, OPTIONAL
IN UINT16 *LegacyMask OPTIONAL,
IN UINT16 *LegacyEdgeLevel OPTIONAL,
IN UINT16 *ProtectedMask OPTIONAL,
IN UINT16 *ProtectedEdgeLevel OPTIONAL
);
@ -143,7 +143,7 @@ EFI_STATUS
(EFIAPI *EFI_LEGACY_8259_SET_MODE)(
IN EFI_LEGACY_8259_PROTOCOL *This,
IN EFI_8259_MODE Mode,
IN UINT16 *Mask, OPTIONAL
IN UINT16 *Mask OPTIONAL,
IN UINT16 *EdgeLevel OPTIONAL
);

View File

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

View File

@ -291,7 +291,7 @@ RETURN_STATUS
EFIAPI
RestoreLockBox (
IN GUID *Guid,
IN VOID *Buffer, OPTIONAL
IN VOID *Buffer OPTIONAL,
IN OUT UINTN *Length OPTIONAL
)
{

View File

@ -96,7 +96,7 @@ RETURN_STATUS
EFIAPI
QemuFwCfgS3CallWhenBootScriptReady (
IN FW_CFG_BOOT_SCRIPT_CALLBACK_FUNCTION *Callback,
IN OUT VOID *Context, OPTIONAL
IN OUT VOID *Context OPTIONAL,
IN UINTN ScratchBufferSize
)
{

View File

@ -137,7 +137,7 @@ RETURN_STATUS
EFIAPI
QemuFwCfgS3CallWhenBootScriptReady (
IN FW_CFG_BOOT_SCRIPT_CALLBACK_FUNCTION *Callback,
IN OUT VOID *Context, OPTIONAL
IN OUT VOID *Context OPTIONAL,
IN UINTN ScratchBufferSize
)
{

View File

@ -72,7 +72,7 @@ RETURN_STATUS
EFIAPI
QemuFwCfgS3CallWhenBootScriptReady (
IN FW_CFG_BOOT_SCRIPT_CALLBACK_FUNCTION *Callback,
IN OUT VOID *Context, OPTIONAL
IN OUT VOID *Context OPTIONAL,
IN UINTN ScratchBufferSize
)
{

View File

@ -278,7 +278,7 @@ Tpm2CommandChangeEps (
STATIC
UINT32
Tcg2ExecutePhysicalPresence (
IN TPM2B_AUTH *PlatformAuth, OPTIONAL
IN TPM2B_AUTH *PlatformAuth OPTIONAL,
IN UINT32 CommandCode,
IN UINT32 CommandParameter
)

View File

@ -489,7 +489,7 @@ InitializeRootHpc (
IN EFI_PCI_HOT_PLUG_INIT_PROTOCOL *This,
IN EFI_DEVICE_PATH_PROTOCOL *HpcDevicePath,
IN UINT64 HpcPciAddress,
IN EFI_EVENT Event, OPTIONAL
IN EFI_EVENT Event OPTIONAL,
OUT EFI_HPC_STATE *HpcState
)
{

View File

@ -185,7 +185,7 @@ EFI_STATUS
EFIAPI
QemuRamfbGraphicsOutputBlt (
IN EFI_GRAPHICS_OUTPUT_PROTOCOL *This,
IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer, OPTIONAL
IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer OPTIONAL,
IN EFI_GRAPHICS_OUTPUT_BLT_OPERATION BltOperation,
IN UINTN SourceX,
IN UINTN SourceY,

View File

@ -239,7 +239,7 @@ EFI_STATUS
EFIAPI
QemuVideoGraphicsOutputBlt (
IN EFI_GRAPHICS_OUTPUT_PROTOCOL *This,
IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer, OPTIONAL
IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer OPTIONAL,
IN EFI_GRAPHICS_OUTPUT_BLT_OPERATION BltOperation,
IN UINTN SourceX,
IN UINTN SourceY,
@ -413,5 +413,3 @@ Returns:
return EFI_SUCCESS;
}

View File

@ -203,7 +203,7 @@ STATIC
VOID
EFIAPI
AppendFwCfgBootScript (
IN OUT VOID *Context, OPTIONAL
IN OUT VOID *Context OPTIONAL,
IN OUT VOID *ExternalScratchBuffer
)
{

View File

@ -438,7 +438,7 @@ EFI_STATUS
EFIAPI
GopBlt (
IN EFI_GRAPHICS_OUTPUT_PROTOCOL *This,
IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer, OPTIONAL
IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer OPTIONAL,
IN EFI_GRAPHICS_OUTPUT_BLT_OPERATION BltOperation,
IN UINTN SourceX,
IN UINTN SourceY,

View File

@ -122,7 +122,7 @@ EFI_STATUS
EFIAPI
VirtioRngGetRNG (
IN EFI_RNG_PROTOCOL *This,
IN EFI_RNG_ALGORITHM *RNGAlgorithm, OPTIONAL
IN EFI_RNG_ALGORITHM *RNGAlgorithm OPTIONAL,
IN UINTN RNGValueLength,
OUT UINT8 *RNGValue
)