MdeModulePkg: 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: Liming Gao <gaoliming@byosoft.com.cn>

10 files changed, 60 insertions, 62 deletions

diff --git a/MdeModulePkg/Core/Dxe/DxeMain.h b/MdeModulePkg/Core/Dxe/DxeMain.h
index 9bd3c0d084..7779e2d4e3 100644
--- a/MdeModulePkg/Core/Dxe/DxeMain.h
+++ b/MdeModulePkg/Core/Dxe/DxeMain.h
@@ -1545,8 +1545,8 @@ EFIAPI
 CoreCreateEvent (

   IN UINT32                   Type,

   IN EFI_TPL                  NotifyTpl,

-  IN EFI_EVENT_NOTIFY         NotifyFunction, OPTIONAL

-  IN VOID                     *NotifyContext, OPTIONAL

+  IN EFI_EVENT_NOTIFY         NotifyFunction  OPTIONAL,

+  IN VOID                     *NotifyContext  OPTIONAL,

   OUT EFI_EVENT               *Event

   );

 

@@ -1577,9 +1577,9 @@ EFIAPI
 CoreCreateEventEx (

   IN UINT32                   Type,

   IN EFI_TPL                  NotifyTpl,

-  IN EFI_EVENT_NOTIFY         NotifyFunction, OPTIONAL

-  IN CONST VOID               *NotifyContext, OPTIONAL

-  IN CONST EFI_GUID           *EventGroup,    OPTIONAL

+  IN EFI_EVENT_NOTIFY         NotifyFunction  OPTIONAL,

+  IN CONST VOID               *NotifyContext  OPTIONAL,

+  IN CONST EFI_GUID           *EventGroup     OPTIONAL,

   OUT EFI_EVENT               *Event

   );

 

@@ -1608,9 +1608,9 @@ EFIAPI
 CoreCreateEventInternal (

   IN UINT32                   Type,

   IN EFI_TPL                  NotifyTpl,

-  IN EFI_EVENT_NOTIFY         NotifyFunction, OPTIONAL

-  IN CONST VOID               *NotifyContext, OPTIONAL

-  IN CONST EFI_GUID           *EventGroup,    OPTIONAL

+  IN EFI_EVENT_NOTIFY         NotifyFunction  OPTIONAL,

+  IN CONST VOID               *NotifyContext  OPTIONAL,

+  IN CONST EFI_GUID           *EventGroup     OPTIONAL,

   OUT EFI_EVENT               *Event

   );

 

diff --git a/MdeModulePkg/Core/Dxe/Event/Event.c b/MdeModulePkg/Core/Dxe/Event/Event.c
index c83c572c8f..6f96e12815 100644
--- a/MdeModulePkg/Core/Dxe/Event/Event.c
+++ b/MdeModulePkg/Core/Dxe/Event/Event.c
@@ -294,8 +294,8 @@ EFIAPI
 CoreCreateEvent (

   IN UINT32                   Type,

   IN EFI_TPL                  NotifyTpl,

-  IN EFI_EVENT_NOTIFY         NotifyFunction, OPTIONAL

-  IN VOID                     *NotifyContext, OPTIONAL

+  IN EFI_EVENT_NOTIFY         NotifyFunction  OPTIONAL,

+  IN VOID                     *NotifyContext  OPTIONAL,

   OUT EFI_EVENT               *Event

   )

 {

@@ -329,9 +329,9 @@ EFIAPI
 CoreCreateEventEx (

   IN UINT32                   Type,

   IN EFI_TPL                  NotifyTpl,

-  IN EFI_EVENT_NOTIFY         NotifyFunction, OPTIONAL

-  IN CONST VOID               *NotifyContext, OPTIONAL

-  IN CONST EFI_GUID           *EventGroup,    OPTIONAL

+  IN EFI_EVENT_NOTIFY         NotifyFunction  OPTIONAL,

+  IN CONST VOID               *NotifyContext  OPTIONAL,

+  IN CONST EFI_GUID           *EventGroup     OPTIONAL,

   OUT EFI_EVENT               *Event

   )

 {

@@ -374,9 +374,9 @@ EFIAPI
 CoreCreateEventInternal (

   IN UINT32                   Type,

   IN EFI_TPL                  NotifyTpl,

-  IN EFI_EVENT_NOTIFY         NotifyFunction, OPTIONAL

-  IN CONST VOID               *NotifyContext, OPTIONAL

-  IN CONST EFI_GUID           *EventGroup,    OPTIONAL

+  IN EFI_EVENT_NOTIFY         NotifyFunction  OPTIONAL,

+  IN CONST VOID               *NotifyContext  OPTIONAL,

+  IN CONST EFI_GUID           *EventGroup     OPTIONAL,

   OUT EFI_EVENT               *Event

   )

 {

@@ -781,4 +781,3 @@ CoreCloseEvent (
 

   return Status;

 }

-

diff --git a/MdeModulePkg/Core/Pei/FwVol/FwVol.c b/MdeModulePkg/Core/Pei/FwVol/FwVol.c
index bf8dbd3763..8f9a41d21b 100644
--- a/MdeModulePkg/Core/Pei/FwVol/FwVol.c
+++ b/MdeModulePkg/Core/Pei/FwVol/FwVol.c
@@ -264,7 +264,7 @@ FileHandleToVolume (
 EFI_STATUS

 FindFileEx (

   IN  CONST EFI_PEI_FV_HANDLE        FvHandle,

-  IN  CONST EFI_GUID                 *FileName,   OPTIONAL

+  IN  CONST EFI_GUID                 *FileName    OPTIONAL,

   IN        EFI_FV_FILETYPE          SearchType,

   IN OUT    EFI_PEI_FILE_HANDLE      *FileHandle,

   IN OUT    EFI_PEI_FILE_HANDLE      *AprioriFile  OPTIONAL

diff --git a/MdeModulePkg/Core/Pei/FwVol/FwVol.h b/MdeModulePkg/Core/Pei/FwVol/FwVol.h
index 7241c01b8c..f4a0568068 100644
--- a/MdeModulePkg/Core/Pei/FwVol/FwVol.h
+++ b/MdeModulePkg/Core/Pei/FwVol/FwVol.h
@@ -296,7 +296,7 @@ FvHandleToCoreHandle (
 EFI_STATUS

 FindFileEx (

   IN  CONST EFI_PEI_FV_HANDLE        FvHandle,

-  IN  CONST EFI_GUID                 *FileName,   OPTIONAL

+  IN  CONST EFI_GUID                 *FileName    OPTIONAL,

   IN        EFI_FV_FILETYPE          SearchType,

   IN OUT    EFI_PEI_FILE_HANDLE      *FileHandle,

   IN OUT    EFI_PEI_FILE_HANDLE      *AprioriFile  OPTIONAL

diff --git a/MdeModulePkg/Core/Pei/Image/Image.c b/MdeModulePkg/Core/Pei/Image/Image.c
index 92fe798cd6..d8f4525c3f 100644
--- a/MdeModulePkg/Core/Pei/Image/Image.c
+++ b/MdeModulePkg/Core/Pei/Image/Image.c
@@ -590,8 +590,8 @@ EFI_STATUS
 PeiLoadImageLoadImage (

   IN     CONST EFI_PEI_SERVICES       **PeiServices,

   IN     EFI_PEI_FILE_HANDLE          FileHandle,

-  OUT    EFI_PHYSICAL_ADDRESS         *ImageAddressArg,  OPTIONAL

-  OUT    UINT64                       *ImageSizeArg,     OPTIONAL

+  OUT    EFI_PHYSICAL_ADDRESS         *ImageAddressArg   OPTIONAL,

+  OUT    UINT64                       *ImageSizeArg      OPTIONAL,

   OUT    EFI_PHYSICAL_ADDRESS         *EntryPoint,

   OUT    UINT32                       *AuthenticationState

   )

@@ -771,8 +771,8 @@ EFIAPI
 PeiLoadImageLoadImageWrapper (

   IN     CONST EFI_PEI_LOAD_FILE_PPI  *This,

   IN     EFI_PEI_FILE_HANDLE          FileHandle,

-  OUT    EFI_PHYSICAL_ADDRESS         *ImageAddressArg,  OPTIONAL

-  OUT    UINT64                       *ImageSizeArg,     OPTIONAL

+  OUT    EFI_PHYSICAL_ADDRESS         *ImageAddressArg   OPTIONAL,

+  OUT    UINT64                       *ImageSizeArg      OPTIONAL,

   OUT    EFI_PHYSICAL_ADDRESS         *EntryPoint,

   OUT    UINT32                       *AuthenticationState

   )

diff --git a/MdeModulePkg/Core/Pei/PeiMain.h b/MdeModulePkg/Core/Pei/PeiMain.h
index 0046f19447..196944ca21 100644
--- a/MdeModulePkg/Core/Pei/PeiMain.h
+++ b/MdeModulePkg/Core/Pei/PeiMain.h
@@ -1437,8 +1437,8 @@ EFIAPI
 PeiLoadImageLoadImageWrapper (

   IN     CONST EFI_PEI_LOAD_FILE_PPI  *This,

   IN     EFI_PEI_FILE_HANDLE          FileHandle,

-  OUT    EFI_PHYSICAL_ADDRESS         *ImageAddressArg,  OPTIONAL

-  OUT    UINT64                       *ImageSizeArg,     OPTIONAL

+  OUT    EFI_PHYSICAL_ADDRESS         *ImageAddressArg   OPTIONAL,

+  OUT    UINT64                       *ImageSizeArg      OPTIONAL,

   OUT    EFI_PHYSICAL_ADDRESS         *EntryPoint,

   OUT    UINT32                       *AuthenticationState

   );

diff --git a/MdeModulePkg/Core/PiSmmCore/Dispatcher.c b/MdeModulePkg/Core/PiSmmCore/Dispatcher.c
index 6d669bd1be..1736edb8d0 100644
--- a/MdeModulePkg/Core/PiSmmCore/Dispatcher.c
+++ b/MdeModulePkg/Core/PiSmmCore/Dispatcher.c
@@ -1248,8 +1248,8 @@ EFI_STATUS
 EFIAPI

 SmmDriverDispatchHandler (

   IN     EFI_HANDLE  DispatchHandle,

-  IN     CONST VOID  *Context,        OPTIONAL

-  IN OUT VOID        *CommBuffer,     OPTIONAL

+  IN     CONST VOID  *Context         OPTIONAL,

+  IN OUT VOID        *CommBuffer      OPTIONAL,

   IN OUT UINTN       *CommBufferSize  OPTIONAL

   )

 {

diff --git a/MdeModulePkg/Core/PiSmmCore/PiSmmCore.c b/MdeModulePkg/Core/PiSmmCore/PiSmmCore.c
index c460805148..2e6d7913f4 100644
--- a/MdeModulePkg/Core/PiSmmCore/PiSmmCore.c
+++ b/MdeModulePkg/Core/PiSmmCore/PiSmmCore.c
@@ -158,8 +158,8 @@ EFI_STATUS
 EFIAPI

 SmmLegacyBootHandler (

   IN     EFI_HANDLE  DispatchHandle,

-  IN     CONST VOID  *Context,        OPTIONAL

-  IN OUT VOID        *CommBuffer,     OPTIONAL

+  IN     CONST VOID  *Context         OPTIONAL,

+  IN OUT VOID        *CommBuffer      OPTIONAL,

   IN OUT UINTN       *CommBufferSize  OPTIONAL

   )

 {

@@ -213,8 +213,8 @@ EFI_STATUS
 EFIAPI

 SmmExitBootServicesHandler (

   IN     EFI_HANDLE  DispatchHandle,

-  IN     CONST VOID  *Context,        OPTIONAL

-  IN OUT VOID        *CommBuffer,     OPTIONAL

+  IN     CONST VOID  *Context         OPTIONAL,

+  IN OUT VOID        *CommBuffer      OPTIONAL,

   IN OUT UINTN       *CommBufferSize  OPTIONAL

   )

 {

@@ -297,8 +297,8 @@ EFI_STATUS
 EFIAPI

 SmmReadyToBootHandler (

   IN     EFI_HANDLE  DispatchHandle,

-  IN     CONST VOID  *Context,        OPTIONAL

-  IN OUT VOID        *CommBuffer,     OPTIONAL

+  IN     CONST VOID  *Context         OPTIONAL,

+  IN OUT VOID        *CommBuffer      OPTIONAL,

   IN OUT UINTN       *CommBufferSize  OPTIONAL

   )

 {

@@ -342,8 +342,8 @@ EFI_STATUS
 EFIAPI

 SmmReadyToLockHandler (

   IN     EFI_HANDLE  DispatchHandle,

-  IN     CONST VOID  *Context,        OPTIONAL

-  IN OUT VOID        *CommBuffer,     OPTIONAL

+  IN     CONST VOID  *Context         OPTIONAL,

+  IN OUT VOID        *CommBuffer      OPTIONAL,

   IN OUT UINTN       *CommBufferSize  OPTIONAL

   )

 {

@@ -428,8 +428,8 @@ EFI_STATUS
 EFIAPI

 SmmEndOfDxeHandler (

   IN     EFI_HANDLE  DispatchHandle,

-  IN     CONST VOID  *Context,        OPTIONAL

-  IN OUT VOID        *CommBuffer,     OPTIONAL

+  IN     CONST VOID  *Context         OPTIONAL,

+  IN OUT VOID        *CommBuffer      OPTIONAL,

   IN OUT UINTN       *CommBufferSize  OPTIONAL

   )

 {

@@ -499,8 +499,8 @@ EFI_STATUS
 EFIAPI

 SmmS3SmmInitDoneHandler (

   IN     EFI_HANDLE  DispatchHandle,

-  IN     CONST VOID  *Context,        OPTIONAL

-  IN OUT VOID        *CommBuffer,     OPTIONAL

+  IN     CONST VOID  *Context         OPTIONAL,

+  IN OUT VOID        *CommBuffer      OPTIONAL,

   IN OUT UINTN       *CommBufferSize  OPTIONAL

   )

 {

@@ -558,8 +558,8 @@ EFI_STATUS
 EFIAPI

 SmmEndOfS3ResumeHandler (

   IN     EFI_HANDLE  DispatchHandle,

-  IN     CONST VOID  *Context,        OPTIONAL

-  IN OUT VOID        *CommBuffer,     OPTIONAL

+  IN     CONST VOID  *Context         OPTIONAL,

+  IN OUT VOID        *CommBuffer      OPTIONAL,

   IN OUT UINTN       *CommBufferSize  OPTIONAL

   )

 {

diff --git a/MdeModulePkg/Core/PiSmmCore/PiSmmCore.h b/MdeModulePkg/Core/PiSmmCore/PiSmmCore.h
index 50a7fc0000..19ce69f5e8 100644
--- a/MdeModulePkg/Core/PiSmmCore/PiSmmCore.h
+++ b/MdeModulePkg/Core/PiSmmCore/PiSmmCore.h
@@ -689,8 +689,8 @@ EFI_STATUS
 EFIAPI

 SmmDriverDispatchHandler (

   IN     EFI_HANDLE               DispatchHandle,

-  IN     CONST VOID               *Context,        OPTIONAL

-  IN OUT VOID                     *CommBuffer,     OPTIONAL

+  IN     CONST VOID               *Context         OPTIONAL,

+  IN OUT VOID                     *CommBuffer      OPTIONAL,

   IN OUT UINTN                    *CommBufferSize  OPTIONAL

   );

 

@@ -711,8 +711,8 @@ EFI_STATUS
 EFIAPI

 SmmLegacyBootHandler (

   IN     EFI_HANDLE               DispatchHandle,

-  IN     CONST VOID               *Context,        OPTIONAL

-  IN OUT VOID                     *CommBuffer,     OPTIONAL

+  IN     CONST VOID               *Context         OPTIONAL,

+  IN OUT VOID                     *CommBuffer      OPTIONAL,

   IN OUT UINTN                    *CommBufferSize  OPTIONAL

   );

 

@@ -733,8 +733,8 @@ EFI_STATUS
 EFIAPI

 SmmReadyToLockHandler (

   IN     EFI_HANDLE               DispatchHandle,

-  IN     CONST VOID               *Context,        OPTIONAL

-  IN OUT VOID                     *CommBuffer,     OPTIONAL

+  IN     CONST VOID               *Context         OPTIONAL,

+  IN OUT VOID                     *CommBuffer      OPTIONAL,

   IN OUT UINTN                    *CommBufferSize  OPTIONAL

   );

 

@@ -755,8 +755,8 @@ EFI_STATUS
 EFIAPI

 SmmEndOfDxeHandler (

   IN     EFI_HANDLE               DispatchHandle,

-  IN     CONST VOID               *Context,        OPTIONAL

-  IN OUT VOID                     *CommBuffer,     OPTIONAL

+  IN     CONST VOID               *Context         OPTIONAL,

+  IN OUT VOID                     *CommBuffer      OPTIONAL,

   IN OUT UINTN                    *CommBufferSize  OPTIONAL

   );

 

@@ -777,8 +777,8 @@ EFI_STATUS
 EFIAPI

 SmmExitBootServicesHandler (

   IN     EFI_HANDLE               DispatchHandle,

-  IN     CONST VOID               *Context,        OPTIONAL

-  IN OUT VOID                     *CommBuffer,     OPTIONAL

+  IN     CONST VOID               *Context         OPTIONAL,

+  IN OUT VOID                     *CommBuffer      OPTIONAL,

   IN OUT UINTN                    *CommBufferSize  OPTIONAL

   );

 

@@ -799,8 +799,8 @@ EFI_STATUS
 EFIAPI

 SmmReadyToBootHandler (

   IN     EFI_HANDLE               DispatchHandle,

-  IN     CONST VOID               *Context,        OPTIONAL

-  IN OUT VOID                     *CommBuffer,     OPTIONAL

+  IN     CONST VOID               *Context         OPTIONAL,

+  IN OUT VOID                     *CommBuffer      OPTIONAL,

   IN OUT UINTN                    *CommBufferSize  OPTIONAL

   );

 

@@ -822,8 +822,8 @@ EFI_STATUS
 EFIAPI

 SmmS3SmmInitDoneHandler (

   IN     EFI_HANDLE  DispatchHandle,

-  IN     CONST VOID  *Context,        OPTIONAL

-  IN OUT VOID        *CommBuffer,     OPTIONAL

+  IN     CONST VOID  *Context         OPTIONAL,

+  IN OUT VOID        *CommBuffer      OPTIONAL,

   IN OUT UINTN       *CommBufferSize  OPTIONAL

   );

 

@@ -845,8 +845,8 @@ EFI_STATUS
 EFIAPI

 SmmEndOfS3ResumeHandler (

   IN     EFI_HANDLE  DispatchHandle,

-  IN     CONST VOID  *Context,        OPTIONAL

-  IN OUT VOID        *CommBuffer,     OPTIONAL

+  IN     CONST VOID  *Context         OPTIONAL,

+  IN OUT VOID        *CommBuffer      OPTIONAL,

   IN OUT UINTN       *CommBufferSize  OPTIONAL

   );

 

@@ -1175,7 +1175,7 @@ SmiHandlerProfileRegisterHandler (
   IN EFI_GUID                       *HandlerGuid,

   IN EFI_SMM_HANDLER_ENTRY_POINT2   Handler,

   IN PHYSICAL_ADDRESS               CallerAddress,

-  IN VOID                           *Context, OPTIONAL

+  IN VOID                           *Context  OPTIONAL,

   IN UINTN                          ContextSize OPTIONAL

   );

 

@@ -1202,7 +1202,7 @@ SmiHandlerProfileUnregisterHandler (
   IN SMI_HANDLER_PROFILE_PROTOCOL   *This,

   IN EFI_GUID                       *HandlerGuid,

   IN EFI_SMM_HANDLER_ENTRY_POINT2   Handler,

-  IN VOID                           *Context, OPTIONAL

+  IN VOID                           *Context  OPTIONAL,

   IN UINTN                          ContextSize OPTIONAL

   );

 

diff --git a/MdeModulePkg/Core/PiSmmCore/SmiHandlerProfile.c b/MdeModulePkg/Core/PiSmmCore/SmiHandlerProfile.c
index 0323617dcb..50d092d05d 100644
--- a/MdeModulePkg/Core/PiSmmCore/SmiHandlerProfile.c
+++ b/MdeModulePkg/Core/PiSmmCore/SmiHandlerProfile.c
@@ -1185,7 +1185,7 @@ SmiHandlerProfileRegisterHandler (
   IN EFI_GUID                       *HandlerGuid,

   IN EFI_SMM_HANDLER_ENTRY_POINT2   Handler,

   IN PHYSICAL_ADDRESS               CallerAddress,

-  IN VOID                           *Context, OPTIONAL

+  IN VOID                           *Context  OPTIONAL,

   IN UINTN                          ContextSize OPTIONAL

   )

 {

@@ -1262,7 +1262,7 @@ SmiHandlerProfileUnregisterHandler (
   IN SMI_HANDLER_PROFILE_PROTOCOL   *This,

   IN EFI_GUID                       *HandlerGuid,

   IN EFI_SMM_HANDLER_ENTRY_POINT2   Handler,

-  IN VOID                           *Context, OPTIONAL

+  IN VOID                           *Context  OPTIONAL,

   IN UINTN                          ContextSize OPTIONAL

   )

 {

@@ -1364,4 +1364,3 @@ SmmCoreInitializeSmiHandlerProfile (
     ASSERT_EFI_ERROR (Status);

   }

 }

-