DynamicTablesPkg: 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: Sami Mujawar <sami.mujawar@arm.com>

8 files changed, 53 insertions, 53 deletions

diff --git a/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h b/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h
index 4932f6fd9c..f3a52dc3e0 100644
--- a/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h
+++ b/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h
@@ -462,7 +462,7 @@ AmlCodeGenRdInterrupt (
   IN  BOOLEAN                 Shared,

   IN  UINT32                  *IrqList,

   IN  UINT8                   IrqCount,

-  IN  AML_OBJECT_NODE_HANDLE  NameOpNode, OPTIONAL

+  IN  AML_OBJECT_NODE_HANDLE  NameOpNode  OPTIONAL,

   OUT AML_DATA_NODE_HANDLE    *NewRdNode  OPTIONAL

   );

 

@@ -529,7 +529,7 @@ EFIAPI
 AmlCodeGenNameString (

   IN  CONST CHAR8                   * NameString,

   IN        CHAR8                   * String,

-  IN        AML_NODE_HANDLE           ParentNode,     OPTIONAL

+  IN        AML_NODE_HANDLE           ParentNode      OPTIONAL,

   OUT       AML_OBJECT_NODE_HANDLE  * NewObjectNode   OPTIONAL

   );

 

@@ -559,7 +559,7 @@ EFIAPI
 AmlCodeGenNameInteger (

   IN  CONST CHAR8                   * NameString,

   IN        UINT64                    Integer,

-  IN        AML_NODE_HANDLE           ParentNode,     OPTIONAL

+  IN        AML_NODE_HANDLE           ParentNode      OPTIONAL,

   OUT       AML_OBJECT_NODE_HANDLE  * NewObjectNode   OPTIONAL

   );

 

@@ -587,7 +587,7 @@ EFI_STATUS
 EFIAPI

 AmlCodeGenDevice (

   IN  CONST CHAR8                   * NameString,

-  IN        AML_NODE_HANDLE           ParentNode,     OPTIONAL

+  IN        AML_NODE_HANDLE           ParentNode      OPTIONAL,

   OUT       AML_OBJECT_NODE_HANDLE  * NewObjectNode   OPTIONAL

   );

 

@@ -615,7 +615,7 @@ EFI_STATUS
 EFIAPI

 AmlCodeGenScope (

   IN  CONST CHAR8                   * NameString,

-  IN        AML_NODE_HANDLE           ParentNode,     OPTIONAL

+  IN        AML_NODE_HANDLE           ParentNode      OPTIONAL,

   OUT       AML_OBJECT_NODE_HANDLE  * NewObjectNode   OPTIONAL

   );

 

@@ -664,11 +664,11 @@ EFI_STATUS
 EFIAPI

 AmlCodeGenMethodRetNameString (

   IN  CONST CHAR8                   * MethodNameString,

-  IN  CONST CHAR8                   * ReturnedNameString,  OPTIONAL

+  IN  CONST CHAR8                   * ReturnedNameString   OPTIONAL,

   IN        UINT8                     NumArgs,

   IN        BOOLEAN                   IsSerialized,

   IN        UINT8                     SyncLevel,

-  IN        AML_NODE_HANDLE           ParentNode,          OPTIONAL

+  IN        AML_NODE_HANDLE           ParentNode           OPTIONAL,

   OUT       AML_OBJECT_NODE_HANDLE  * NewObjectNode        OPTIONAL

   );

 

@@ -712,7 +712,7 @@ AmlCreateLpiNode (
   IN  CONST CHAR8                   * LpiNameString,

   IN        UINT16                    Revision,

   IN        UINT64                    LevelId,

-  IN        AML_NODE_HANDLE           ParentNode,  OPTIONAL

+  IN        AML_NODE_HANDLE           ParentNode   OPTIONAL,

   OUT       AML_OBJECT_NODE_HANDLE  * NewLpiNode   OPTIONAL

   );

 

@@ -779,11 +779,11 @@ AmlAddLpiState (
   IN  UINT32                                    ArchFlags,

   IN  UINT32                                    ResCntFreq,

   IN  UINT32                                    EnableParentState,

-  IN  EFI_ACPI_6_3_GENERIC_ADDRESS_STRUCTURE  * GenericRegisterDescriptor,  OPTIONAL

-  IN  UINT64                                    Integer,                    OPTIONAL

-  IN  EFI_ACPI_6_3_GENERIC_ADDRESS_STRUCTURE  * ResidencyCounterRegister,   OPTIONAL

-  IN  EFI_ACPI_6_3_GENERIC_ADDRESS_STRUCTURE  * UsageCounterRegister,       OPTIONAL

-  IN  CHAR8                                   * StateName,                  OPTIONAL

+  IN  EFI_ACPI_6_3_GENERIC_ADDRESS_STRUCTURE  * GenericRegisterDescriptor   OPTIONAL,

+  IN  UINT64                                    Integer                     OPTIONAL,

+  IN  EFI_ACPI_6_3_GENERIC_ADDRESS_STRUCTURE  * ResidencyCounterRegister    OPTIONAL,

+  IN  EFI_ACPI_6_3_GENERIC_ADDRESS_STRUCTURE  * UsageCounterRegister        OPTIONAL,

+  IN  CHAR8                                   * StateName                   OPTIONAL,

   IN  AML_OBJECT_NODE_HANDLE                    LpiNode

   );

 

diff --git a/DynamicTablesPkg/Library/Common/AmlLib/AmlCoreInterface.h b/DynamicTablesPkg/Library/Common/AmlLib/AmlCoreInterface.h
index 9905cfe551..3a758fc29d 100644
--- a/DynamicTablesPkg/Library/Common/AmlLib/AmlCoreInterface.h
+++ b/DynamicTablesPkg/Library/Common/AmlLib/AmlCoreInterface.h
@@ -68,7 +68,7 @@ EFI_STATUS
 EFIAPI

 AmlSerializeTree (

   IN      AML_ROOT_NODE_HANDLE    RootNode,

-  IN      UINT8                 * Buffer,     OPTIONAL

+  IN      UINT8                 * Buffer      OPTIONAL,

   IN  OUT UINT32                * BufferSize

   );

 

@@ -334,9 +334,9 @@ EFI_STATUS
 EFIAPI

 AmlGetObjectNodeInfo (

   IN  AML_OBJECT_NODE_HANDLE    ObjectNode,

-  OUT UINT8                   * OpCode,           OPTIONAL

-  OUT UINT8                   * SubOpCode,        OPTIONAL

-  OUT UINT32                  * PkgLen,           OPTIONAL

+  OUT UINT8                   * OpCode            OPTIONAL,

+  OUT UINT8                   * SubOpCode         OPTIONAL,

+  OUT UINT32                  * PkgLen            OPTIONAL,

   OUT BOOLEAN                 * IsNameSpaceNode   OPTIONAL

   );

 

@@ -423,7 +423,7 @@ EFI_STATUS
 EFIAPI

 AmlGetDataNodeBuffer (

   IN      AML_DATA_NODE_HANDLE    DataNode,

-      OUT UINT8                 * Buffer,     OPTIONAL

+      OUT UINT8                 * Buffer      OPTIONAL,

   IN  OUT UINT32                * BufferSize

   );

 

@@ -684,7 +684,7 @@ typedef
 BOOLEAN

 (EFIAPI * EDKII_AML_TREE_ENUM_CALLBACK) (

   IN       AML_NODE_HANDLE     Node,

-  IN  OUT  VOID              * Context,    OPTIONAL

+  IN  OUT  VOID              * Context     OPTIONAL,

   IN  OUT  EFI_STATUS        * Status      OPTIONAL

   );

 

@@ -714,7 +714,7 @@ EFIAPI
 AmlEnumTree (

   IN      AML_NODE_HANDLE                 Node,

   IN      EDKII_AML_TREE_ENUM_CALLBACK    CallBack,

-  IN  OUT VOID                          * Context,  OPTIONAL

+  IN  OUT VOID                          * Context   OPTIONAL,

       OUT EFI_STATUS                    * Status    OPTIONAL

   );

 

diff --git a/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c b/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c
index 64064018ae..bb739e613c 100644
--- a/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c
+++ b/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c
@@ -341,8 +341,8 @@ STATIC
 EFI_STATUS

 EFIAPI

 AmlCodeGenBuffer (

-  IN  CONST UINT8             * Buffer,       OPTIONAL

-  IN        UINT32              BufferSize,   OPTIONAL

+  IN  CONST UINT8             * Buffer        OPTIONAL,

+  IN        UINT32              BufferSize    OPTIONAL,

   OUT       AML_OBJECT_NODE  ** NewObjectNode

   )

 {

@@ -528,7 +528,7 @@ EFIAPI
 AmlCodeGenName (

   IN  CONST CHAR8              * NameString,

   IN        AML_OBJECT_NODE    * Object,

-  IN        AML_NODE_HEADER    * ParentNode,     OPTIONAL

+  IN        AML_NODE_HEADER    * ParentNode      OPTIONAL,

   OUT       AML_OBJECT_NODE   ** NewObjectNode   OPTIONAL

   )

 {

@@ -655,7 +655,7 @@ EFIAPI
 AmlCodeGenNameString (

   IN  CONST CHAR8              * NameString,

   IN        CHAR8              * String,

-  IN        AML_NODE_HEADER    * ParentNode,     OPTIONAL

+  IN        AML_NODE_HEADER    * ParentNode      OPTIONAL,

   OUT       AML_OBJECT_NODE   ** NewObjectNode   OPTIONAL

   )

 {

@@ -713,7 +713,7 @@ EFIAPI
 AmlCodeGenNameInteger (

   IN  CONST CHAR8              * NameString,

   IN        UINT64               Integer,

-  IN        AML_NODE_HEADER    * ParentNode,     OPTIONAL

+  IN        AML_NODE_HEADER    * ParentNode      OPTIONAL,

   OUT       AML_OBJECT_NODE   ** NewObjectNode   OPTIONAL

   )

 {

@@ -768,7 +768,7 @@ EFI_STATUS
 EFIAPI

 AmlCodeGenDevice (

   IN  CONST CHAR8              * NameString,

-  IN        AML_NODE_HEADER    * ParentNode,     OPTIONAL

+  IN        AML_NODE_HEADER    * ParentNode      OPTIONAL,

   OUT       AML_OBJECT_NODE   ** NewObjectNode   OPTIONAL

   )

 {

@@ -881,7 +881,7 @@ EFI_STATUS
 EFIAPI

 AmlCodeGenScope (

   IN  CONST CHAR8              * NameString,

-  IN        AML_NODE_HEADER    * ParentNode,     OPTIONAL

+  IN        AML_NODE_HEADER    * ParentNode      OPTIONAL,

   OUT       AML_OBJECT_NODE   ** NewObjectNode   OPTIONAL

   )

 {

@@ -1013,7 +1013,7 @@ AmlCodeGenMethod (
   IN        UINT8                NumArgs,

   IN        BOOLEAN              IsSerialized,

   IN        UINT8                SyncLevel,

-  IN        AML_NODE_HEADER    * ParentNode,     OPTIONAL

+  IN        AML_NODE_HEADER    * ParentNode      OPTIONAL,

   OUT       AML_OBJECT_NODE   ** NewObjectNode   OPTIONAL

   )

 {

@@ -1190,7 +1190,7 @@ EFI_STATUS
 EFIAPI

 AmlCodeGenReturn (

   IN  AML_NODE_HEADER     * ReturnNode,

-  IN  AML_NODE_HEADER     * ParentNode,     OPTIONAL

+  IN  AML_NODE_HEADER     * ParentNode      OPTIONAL,

   OUT AML_OBJECT_NODE    ** NewObjectNode   OPTIONAL

   )

 {

@@ -1288,7 +1288,7 @@ EFI_STATUS
 EFIAPI

 AmlCodeGenReturnNameString (

   IN  CONST CHAR8               * NameString,

-  IN        AML_NODE_HEADER     * ParentNode,     OPTIONAL

+  IN        AML_NODE_HEADER     * ParentNode      OPTIONAL,

   OUT       AML_OBJECT_NODE    ** NewObjectNode   OPTIONAL

   )

 {

@@ -1380,11 +1380,11 @@ EFI_STATUS
 EFIAPI

 AmlCodeGenMethodRetNameString (

   IN  CONST CHAR8                   * MethodNameString,

-  IN  CONST CHAR8                   * ReturnedNameString,  OPTIONAL

+  IN  CONST CHAR8                   * ReturnedNameString   OPTIONAL,

   IN        UINT8                     NumArgs,

   IN        BOOLEAN                   IsSerialized,

   IN        UINT8                     SyncLevel,

-  IN        AML_NODE_HANDLE           ParentNode,          OPTIONAL

+  IN        AML_NODE_HANDLE           ParentNode           OPTIONAL,

   OUT       AML_OBJECT_NODE_HANDLE  * NewObjectNode        OPTIONAL

   )

 {

@@ -1481,7 +1481,7 @@ AmlCreateLpiNode (
   IN  CONST CHAR8                   * LpiNameString,

   IN        UINT16                    Revision,

   IN        UINT64                    LevelId,

-  IN        AML_NODE_HANDLE           ParentNode,  OPTIONAL

+  IN        AML_NODE_HANDLE           ParentNode   OPTIONAL,

   OUT       AML_OBJECT_NODE_HANDLE  * NewLpiNode   OPTIONAL

   )

 {

@@ -1637,11 +1637,11 @@ AmlAddLpiState (
   IN  UINT32                                    ArchFlags,

   IN  UINT32                                    ResCntFreq,

   IN  UINT32                                    EnableParentState,

-  IN  EFI_ACPI_6_3_GENERIC_ADDRESS_STRUCTURE  * GenericRegisterDescriptor,  OPTIONAL

-  IN  UINT64                                    Integer,                    OPTIONAL

-  IN  EFI_ACPI_6_3_GENERIC_ADDRESS_STRUCTURE  * ResidencyCounterRegister,   OPTIONAL

-  IN  EFI_ACPI_6_3_GENERIC_ADDRESS_STRUCTURE  * UsageCounterRegister,       OPTIONAL

-  IN  CHAR8                                   * StateName,                  OPTIONAL

+  IN  EFI_ACPI_6_3_GENERIC_ADDRESS_STRUCTURE  * GenericRegisterDescriptor   OPTIONAL,

+  IN  UINT64                                    Integer                     OPTIONAL,

+  IN  EFI_ACPI_6_3_GENERIC_ADDRESS_STRUCTURE  * ResidencyCounterRegister    OPTIONAL,

+  IN  EFI_ACPI_6_3_GENERIC_ADDRESS_STRUCTURE  * UsageCounterRegister        OPTIONAL,

+  IN  CHAR8                                   * StateName                   OPTIONAL,

   IN  AML_OBJECT_NODE_HANDLE                    LpiNode

   )

 {

diff --git a/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlResourceDataCodeGen.c b/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlResourceDataCodeGen.c
index e9e1a85ede..a7e36850bf 100644
--- a/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlResourceDataCodeGen.c
+++ b/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlResourceDataCodeGen.c
@@ -142,7 +142,7 @@ AmlCodeGenRdInterrupt (
   IN  BOOLEAN                 Shared,

   IN  UINT32                  *IrqList,

   IN  UINT8                   IrqCount,

-  IN  AML_OBJECT_NODE_HANDLE  NameOpNode, OPTIONAL

+  IN  AML_OBJECT_NODE_HANDLE  NameOpNode  OPTIONAL,

   OUT AML_DATA_NODE_HANDLE    *NewRdNode  OPTIONAL

   )

 {

@@ -238,7 +238,7 @@ AmlCodeGenRdRegister (
   IN  UINT8                   BitOffset,

   IN  UINT64                  Address,

   IN  UINT8                   AccessSize,

-  IN  AML_OBJECT_NODE_HANDLE  NameOpNode, OPTIONAL

+  IN  AML_OBJECT_NODE_HANDLE  NameOpNode  OPTIONAL,

   OUT AML_DATA_NODE_HANDLE    *NewRdNode  OPTIONAL

   )

 {

@@ -318,8 +318,8 @@ AmlCodeGenRdRegister (
 EFI_STATUS

 EFIAPI

 AmlCodeGenEndTag (

-  IN  UINT8               CheckSum,   OPTIONAL

-  IN  AML_OBJECT_NODE   * ParentNode, OPTIONAL

+  IN  UINT8               CheckSum    OPTIONAL,

+  IN  AML_OBJECT_NODE   * ParentNode  OPTIONAL,

   OUT AML_DATA_NODE    ** NewRdNode   OPTIONAL

   )

 {

diff --git a/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlResourceDataCodeGen.h b/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlResourceDataCodeGen.h
index 1023404959..eb26192db4 100644
--- a/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlResourceDataCodeGen.h
+++ b/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlResourceDataCodeGen.h
@@ -51,7 +51,7 @@ AmlCodeGenRdInterrupt (
   IN  BOOLEAN                 Shared,

   IN  UINT32                  *IrqList,

   IN  UINT8                   IrqCount,

-  IN  AML_OBJECT_NODE_HANDLE  NameOpNode, OPTIONAL

+  IN  AML_OBJECT_NODE_HANDLE  NameOpNode  OPTIONAL,

   OUT AML_DATA_NODE_HANDLE    *NewRdNode  OPTIONAL

   );

 

@@ -100,7 +100,7 @@ AmlCodeGenRdRegister (
   IN  UINT8                   BitOffset,

   IN  UINT64                  Address,

   IN  UINT8                   AccessSize,

-  IN  AML_OBJECT_NODE_HANDLE  NameOpNode, OPTIONAL

+  IN  AML_OBJECT_NODE_HANDLE  NameOpNode  OPTIONAL,

   OUT AML_DATA_NODE_HANDLE    *NewRdNode  OPTIONAL

   );

 

@@ -142,8 +142,8 @@ AmlCodeGenRdRegister (
 EFI_STATUS

 EFIAPI

 AmlCodeGenEndTag (

-  IN  UINT8               CheckSum,   OPTIONAL

-  IN  AML_OBJECT_NODE   * ParentNode, OPTIONAL

+  IN  UINT8               CheckSum    OPTIONAL,

+  IN  AML_OBJECT_NODE   * ParentNode  OPTIONAL,

   OUT AML_DATA_NODE    ** NewRdNode   OPTIONAL

   );

 

diff --git a/DynamicTablesPkg/Library/Common/AmlLib/Serialize/AmlSerialize.c b/DynamicTablesPkg/Library/Common/AmlLib/Serialize/AmlSerialize.c
index 2a47c229d7..da81ec2ee9 100644
--- a/DynamicTablesPkg/Library/Common/AmlLib/Serialize/AmlSerialize.c
+++ b/DynamicTablesPkg/Library/Common/AmlLib/Serialize/AmlSerialize.c
@@ -39,7 +39,7 @@ BOOLEAN
 EFIAPI

 AmlSerializeNodeCallback (

   IN       AML_NODE_HEADER   * Node,

-  IN  OUT  VOID              * Context,    OPTIONAL

+  IN  OUT  VOID              * Context     OPTIONAL,

   IN  OUT  EFI_STATUS        * Status      OPTIONAL

   )

 {

@@ -170,7 +170,7 @@ EFI_STATUS
 EFIAPI

 AmlSerializeTree (

   IN      AML_ROOT_NODE   * RootNode,

-  IN      UINT8           * Buffer,     OPTIONAL

+  IN      UINT8           * Buffer      OPTIONAL,

   IN  OUT UINT32          * BufferSize

   )

 {

diff --git a/DynamicTablesPkg/Library/Common/AmlLib/Tree/AmlNodeInterface.c b/DynamicTablesPkg/Library/Common/AmlLib/Tree/AmlNodeInterface.c
index f91bc5fd55..80145c6830 100644
--- a/DynamicTablesPkg/Library/Common/AmlLib/Tree/AmlNodeInterface.c
+++ b/DynamicTablesPkg/Library/Common/AmlLib/Tree/AmlNodeInterface.c
@@ -95,9 +95,9 @@ EFI_STATUS
 EFIAPI

 AmlGetObjectNodeInfo (

   IN  AML_OBJECT_NODE   * ObjectNode,

-  OUT UINT8             * OpCode,           OPTIONAL

-  OUT UINT8             * SubOpCode,        OPTIONAL

-  OUT UINT32            * PkgLen,           OPTIONAL

+  OUT UINT8             * OpCode            OPTIONAL,

+  OUT UINT8             * SubOpCode         OPTIONAL,

+  OUT UINT32            * PkgLen            OPTIONAL,

   OUT BOOLEAN           * IsNameSpaceNode   OPTIONAL

   )

 {

@@ -228,7 +228,7 @@ EFI_STATUS
 EFIAPI

 AmlGetDataNodeBuffer (

   IN      AML_DATA_NODE   * DataNode,

-      OUT UINT8           * Buffer,       OPTIONAL

+      OUT UINT8           * Buffer        OPTIONAL,

   IN  OUT UINT32          * BufferSize

   )

 {

diff --git a/DynamicTablesPkg/Library/Common/AmlLib/Tree/AmlTreeEnumerator.c b/DynamicTablesPkg/Library/Common/AmlLib/Tree/AmlTreeEnumerator.c
index 3eeb7253bf..9502e4fdd7 100644
--- a/DynamicTablesPkg/Library/Common/AmlLib/Tree/AmlTreeEnumerator.c
+++ b/DynamicTablesPkg/Library/Common/AmlLib/Tree/AmlTreeEnumerator.c
@@ -35,7 +35,7 @@ EFIAPI
 AmlEnumTree (

   IN      AML_NODE_HEADER               * Node,

   IN      EDKII_AML_TREE_ENUM_CALLBACK    CallBack,

-  IN  OUT VOID                          * Context,  OPTIONAL

+  IN  OUT VOID                          * Context   OPTIONAL,

       OUT EFI_STATUS                    * Status    OPTIONAL

   )

 {