]> git.proxmox.com Git - mirror_edk2.git/commitdiff
DynamicTablesPkg: Change OPTIONAL keyword usage style
authorMichael D Kinney <michael.d.kinney@intel.com>
Fri, 3 Dec 2021 02:00:40 +0000 (18:00 -0800)
committermergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Tue, 7 Dec 2021 17:24:28 +0000 (17:24 +0000)
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>
DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h
DynamicTablesPkg/Library/Common/AmlLib/AmlCoreInterface.h
DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c
DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlResourceDataCodeGen.c
DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlResourceDataCodeGen.h
DynamicTablesPkg/Library/Common/AmlLib/Serialize/AmlSerialize.c
DynamicTablesPkg/Library/Common/AmlLib/Tree/AmlNodeInterface.c
DynamicTablesPkg/Library/Common/AmlLib/Tree/AmlTreeEnumerator.c

index 4932f6fd9c8b1c87e0e9ddecb357fc4840752af6..f3a52dc3e0f595a582eefe7f9e5752f883f6a45f 100644 (file)
@@ -462,7 +462,7 @@ AmlCodeGenRdInterrupt (
   IN  BOOLEAN                 Shared,\r
   IN  UINT32                  *IrqList,\r
   IN  UINT8                   IrqCount,\r
-  IN  AML_OBJECT_NODE_HANDLE  NameOpNode, OPTIONAL\r
+  IN  AML_OBJECT_NODE_HANDLE  NameOpNode  OPTIONAL,\r
   OUT AML_DATA_NODE_HANDLE    *NewRdNode  OPTIONAL\r
   );\r
 \r
@@ -529,7 +529,7 @@ EFIAPI
 AmlCodeGenNameString (\r
   IN  CONST CHAR8                   * NameString,\r
   IN        CHAR8                   * String,\r
-  IN        AML_NODE_HANDLE           ParentNode,     OPTIONAL\r
+  IN        AML_NODE_HANDLE           ParentNode      OPTIONAL,\r
   OUT       AML_OBJECT_NODE_HANDLE  * NewObjectNode   OPTIONAL\r
   );\r
 \r
@@ -559,7 +559,7 @@ EFIAPI
 AmlCodeGenNameInteger (\r
   IN  CONST CHAR8                   * NameString,\r
   IN        UINT64                    Integer,\r
-  IN        AML_NODE_HANDLE           ParentNode,     OPTIONAL\r
+  IN        AML_NODE_HANDLE           ParentNode      OPTIONAL,\r
   OUT       AML_OBJECT_NODE_HANDLE  * NewObjectNode   OPTIONAL\r
   );\r
 \r
@@ -587,7 +587,7 @@ EFI_STATUS
 EFIAPI\r
 AmlCodeGenDevice (\r
   IN  CONST CHAR8                   * NameString,\r
-  IN        AML_NODE_HANDLE           ParentNode,     OPTIONAL\r
+  IN        AML_NODE_HANDLE           ParentNode      OPTIONAL,\r
   OUT       AML_OBJECT_NODE_HANDLE  * NewObjectNode   OPTIONAL\r
   );\r
 \r
@@ -615,7 +615,7 @@ EFI_STATUS
 EFIAPI\r
 AmlCodeGenScope (\r
   IN  CONST CHAR8                   * NameString,\r
-  IN        AML_NODE_HANDLE           ParentNode,     OPTIONAL\r
+  IN        AML_NODE_HANDLE           ParentNode      OPTIONAL,\r
   OUT       AML_OBJECT_NODE_HANDLE  * NewObjectNode   OPTIONAL\r
   );\r
 \r
@@ -664,11 +664,11 @@ EFI_STATUS
 EFIAPI\r
 AmlCodeGenMethodRetNameString (\r
   IN  CONST CHAR8                   * MethodNameString,\r
-  IN  CONST CHAR8                   * ReturnedNameString,  OPTIONAL\r
+  IN  CONST CHAR8                   * ReturnedNameString   OPTIONAL,\r
   IN        UINT8                     NumArgs,\r
   IN        BOOLEAN                   IsSerialized,\r
   IN        UINT8                     SyncLevel,\r
-  IN        AML_NODE_HANDLE           ParentNode,          OPTIONAL\r
+  IN        AML_NODE_HANDLE           ParentNode           OPTIONAL,\r
   OUT       AML_OBJECT_NODE_HANDLE  * NewObjectNode        OPTIONAL\r
   );\r
 \r
@@ -712,7 +712,7 @@ AmlCreateLpiNode (
   IN  CONST CHAR8                   * LpiNameString,\r
   IN        UINT16                    Revision,\r
   IN        UINT64                    LevelId,\r
-  IN        AML_NODE_HANDLE           ParentNode,  OPTIONAL\r
+  IN        AML_NODE_HANDLE           ParentNode   OPTIONAL,\r
   OUT       AML_OBJECT_NODE_HANDLE  * NewLpiNode   OPTIONAL\r
   );\r
 \r
@@ -779,11 +779,11 @@ AmlAddLpiState (
   IN  UINT32                                    ArchFlags,\r
   IN  UINT32                                    ResCntFreq,\r
   IN  UINT32                                    EnableParentState,\r
-  IN  EFI_ACPI_6_3_GENERIC_ADDRESS_STRUCTURE  * GenericRegisterDescriptor,  OPTIONAL\r
-  IN  UINT64                                    Integer,                    OPTIONAL\r
-  IN  EFI_ACPI_6_3_GENERIC_ADDRESS_STRUCTURE  * ResidencyCounterRegister,   OPTIONAL\r
-  IN  EFI_ACPI_6_3_GENERIC_ADDRESS_STRUCTURE  * UsageCounterRegister,       OPTIONAL\r
-  IN  CHAR8                                   * StateName,                  OPTIONAL\r
+  IN  EFI_ACPI_6_3_GENERIC_ADDRESS_STRUCTURE  * GenericRegisterDescriptor   OPTIONAL,\r
+  IN  UINT64                                    Integer                     OPTIONAL,\r
+  IN  EFI_ACPI_6_3_GENERIC_ADDRESS_STRUCTURE  * ResidencyCounterRegister    OPTIONAL,\r
+  IN  EFI_ACPI_6_3_GENERIC_ADDRESS_STRUCTURE  * UsageCounterRegister        OPTIONAL,\r
+  IN  CHAR8                                   * StateName                   OPTIONAL,\r
   IN  AML_OBJECT_NODE_HANDLE                    LpiNode\r
   );\r
 \r
index 9905cfe551b50eccb3576ff9bdb6a1b582199601..3a758fc29d76cd37e7fdcbb16a70125551c18664 100644 (file)
@@ -68,7 +68,7 @@ EFI_STATUS
 EFIAPI\r
 AmlSerializeTree (\r
   IN      AML_ROOT_NODE_HANDLE    RootNode,\r
-  IN      UINT8                 * Buffer,     OPTIONAL\r
+  IN      UINT8                 * Buffer      OPTIONAL,\r
   IN  OUT UINT32                * BufferSize\r
   );\r
 \r
@@ -334,9 +334,9 @@ EFI_STATUS
 EFIAPI\r
 AmlGetObjectNodeInfo (\r
   IN  AML_OBJECT_NODE_HANDLE    ObjectNode,\r
-  OUT UINT8                   * OpCode,           OPTIONAL\r
-  OUT UINT8                   * SubOpCode,        OPTIONAL\r
-  OUT UINT32                  * PkgLen,           OPTIONAL\r
+  OUT UINT8                   * OpCode            OPTIONAL,\r
+  OUT UINT8                   * SubOpCode         OPTIONAL,\r
+  OUT UINT32                  * PkgLen            OPTIONAL,\r
   OUT BOOLEAN                 * IsNameSpaceNode   OPTIONAL\r
   );\r
 \r
@@ -423,7 +423,7 @@ EFI_STATUS
 EFIAPI\r
 AmlGetDataNodeBuffer (\r
   IN      AML_DATA_NODE_HANDLE    DataNode,\r
-      OUT UINT8                 * Buffer,     OPTIONAL\r
+      OUT UINT8                 * Buffer      OPTIONAL,\r
   IN  OUT UINT32                * BufferSize\r
   );\r
 \r
@@ -684,7 +684,7 @@ typedef
 BOOLEAN\r
 (EFIAPI * EDKII_AML_TREE_ENUM_CALLBACK) (\r
   IN       AML_NODE_HANDLE     Node,\r
-  IN  OUT  VOID              * Context,    OPTIONAL\r
+  IN  OUT  VOID              * Context     OPTIONAL,\r
   IN  OUT  EFI_STATUS        * Status      OPTIONAL\r
   );\r
 \r
@@ -714,7 +714,7 @@ EFIAPI
 AmlEnumTree (\r
   IN      AML_NODE_HANDLE                 Node,\r
   IN      EDKII_AML_TREE_ENUM_CALLBACK    CallBack,\r
-  IN  OUT VOID                          * Context,  OPTIONAL\r
+  IN  OUT VOID                          * Context   OPTIONAL,\r
       OUT EFI_STATUS                    * Status    OPTIONAL\r
   );\r
 \r
index 64064018aecb6e521b14b991f44b90de3627b42c..bb739e613c76243ac07d6df898bd3b8acf937947 100644 (file)
@@ -341,8 +341,8 @@ STATIC
 EFI_STATUS\r
 EFIAPI\r
 AmlCodeGenBuffer (\r
-  IN  CONST UINT8             * Buffer,       OPTIONAL\r
-  IN        UINT32              BufferSize,   OPTIONAL\r
+  IN  CONST UINT8             * Buffer        OPTIONAL,\r
+  IN        UINT32              BufferSize    OPTIONAL,\r
   OUT       AML_OBJECT_NODE  ** NewObjectNode\r
   )\r
 {\r
@@ -528,7 +528,7 @@ EFIAPI
 AmlCodeGenName (\r
   IN  CONST CHAR8              * NameString,\r
   IN        AML_OBJECT_NODE    * Object,\r
-  IN        AML_NODE_HEADER    * ParentNode,     OPTIONAL\r
+  IN        AML_NODE_HEADER    * ParentNode      OPTIONAL,\r
   OUT       AML_OBJECT_NODE   ** NewObjectNode   OPTIONAL\r
   )\r
 {\r
@@ -655,7 +655,7 @@ EFIAPI
 AmlCodeGenNameString (\r
   IN  CONST CHAR8              * NameString,\r
   IN        CHAR8              * String,\r
-  IN        AML_NODE_HEADER    * ParentNode,     OPTIONAL\r
+  IN        AML_NODE_HEADER    * ParentNode      OPTIONAL,\r
   OUT       AML_OBJECT_NODE   ** NewObjectNode   OPTIONAL\r
   )\r
 {\r
@@ -713,7 +713,7 @@ EFIAPI
 AmlCodeGenNameInteger (\r
   IN  CONST CHAR8              * NameString,\r
   IN        UINT64               Integer,\r
-  IN        AML_NODE_HEADER    * ParentNode,     OPTIONAL\r
+  IN        AML_NODE_HEADER    * ParentNode      OPTIONAL,\r
   OUT       AML_OBJECT_NODE   ** NewObjectNode   OPTIONAL\r
   )\r
 {\r
@@ -768,7 +768,7 @@ EFI_STATUS
 EFIAPI\r
 AmlCodeGenDevice (\r
   IN  CONST CHAR8              * NameString,\r
-  IN        AML_NODE_HEADER    * ParentNode,     OPTIONAL\r
+  IN        AML_NODE_HEADER    * ParentNode      OPTIONAL,\r
   OUT       AML_OBJECT_NODE   ** NewObjectNode   OPTIONAL\r
   )\r
 {\r
@@ -881,7 +881,7 @@ EFI_STATUS
 EFIAPI\r
 AmlCodeGenScope (\r
   IN  CONST CHAR8              * NameString,\r
-  IN        AML_NODE_HEADER    * ParentNode,     OPTIONAL\r
+  IN        AML_NODE_HEADER    * ParentNode      OPTIONAL,\r
   OUT       AML_OBJECT_NODE   ** NewObjectNode   OPTIONAL\r
   )\r
 {\r
@@ -1013,7 +1013,7 @@ AmlCodeGenMethod (
   IN        UINT8                NumArgs,\r
   IN        BOOLEAN              IsSerialized,\r
   IN        UINT8                SyncLevel,\r
-  IN        AML_NODE_HEADER    * ParentNode,     OPTIONAL\r
+  IN        AML_NODE_HEADER    * ParentNode      OPTIONAL,\r
   OUT       AML_OBJECT_NODE   ** NewObjectNode   OPTIONAL\r
   )\r
 {\r
@@ -1190,7 +1190,7 @@ EFI_STATUS
 EFIAPI\r
 AmlCodeGenReturn (\r
   IN  AML_NODE_HEADER     * ReturnNode,\r
-  IN  AML_NODE_HEADER     * ParentNode,     OPTIONAL\r
+  IN  AML_NODE_HEADER     * ParentNode      OPTIONAL,\r
   OUT AML_OBJECT_NODE    ** NewObjectNode   OPTIONAL\r
   )\r
 {\r
@@ -1288,7 +1288,7 @@ EFI_STATUS
 EFIAPI\r
 AmlCodeGenReturnNameString (\r
   IN  CONST CHAR8               * NameString,\r
-  IN        AML_NODE_HEADER     * ParentNode,     OPTIONAL\r
+  IN        AML_NODE_HEADER     * ParentNode      OPTIONAL,\r
   OUT       AML_OBJECT_NODE    ** NewObjectNode   OPTIONAL\r
   )\r
 {\r
@@ -1380,11 +1380,11 @@ EFI_STATUS
 EFIAPI\r
 AmlCodeGenMethodRetNameString (\r
   IN  CONST CHAR8                   * MethodNameString,\r
-  IN  CONST CHAR8                   * ReturnedNameString,  OPTIONAL\r
+  IN  CONST CHAR8                   * ReturnedNameString   OPTIONAL,\r
   IN        UINT8                     NumArgs,\r
   IN        BOOLEAN                   IsSerialized,\r
   IN        UINT8                     SyncLevel,\r
-  IN        AML_NODE_HANDLE           ParentNode,          OPTIONAL\r
+  IN        AML_NODE_HANDLE           ParentNode           OPTIONAL,\r
   OUT       AML_OBJECT_NODE_HANDLE  * NewObjectNode        OPTIONAL\r
   )\r
 {\r
@@ -1481,7 +1481,7 @@ AmlCreateLpiNode (
   IN  CONST CHAR8                   * LpiNameString,\r
   IN        UINT16                    Revision,\r
   IN        UINT64                    LevelId,\r
-  IN        AML_NODE_HANDLE           ParentNode,  OPTIONAL\r
+  IN        AML_NODE_HANDLE           ParentNode   OPTIONAL,\r
   OUT       AML_OBJECT_NODE_HANDLE  * NewLpiNode   OPTIONAL\r
   )\r
 {\r
@@ -1637,11 +1637,11 @@ AmlAddLpiState (
   IN  UINT32                                    ArchFlags,\r
   IN  UINT32                                    ResCntFreq,\r
   IN  UINT32                                    EnableParentState,\r
-  IN  EFI_ACPI_6_3_GENERIC_ADDRESS_STRUCTURE  * GenericRegisterDescriptor,  OPTIONAL\r
-  IN  UINT64                                    Integer,                    OPTIONAL\r
-  IN  EFI_ACPI_6_3_GENERIC_ADDRESS_STRUCTURE  * ResidencyCounterRegister,   OPTIONAL\r
-  IN  EFI_ACPI_6_3_GENERIC_ADDRESS_STRUCTURE  * UsageCounterRegister,       OPTIONAL\r
-  IN  CHAR8                                   * StateName,                  OPTIONAL\r
+  IN  EFI_ACPI_6_3_GENERIC_ADDRESS_STRUCTURE  * GenericRegisterDescriptor   OPTIONAL,\r
+  IN  UINT64                                    Integer                     OPTIONAL,\r
+  IN  EFI_ACPI_6_3_GENERIC_ADDRESS_STRUCTURE  * ResidencyCounterRegister    OPTIONAL,\r
+  IN  EFI_ACPI_6_3_GENERIC_ADDRESS_STRUCTURE  * UsageCounterRegister        OPTIONAL,\r
+  IN  CHAR8                                   * StateName                   OPTIONAL,\r
   IN  AML_OBJECT_NODE_HANDLE                    LpiNode\r
   )\r
 {\r
index e9e1a85ede6330a25c27b6476fcf59b565f72f70..a7e36850bf9acec79cd71af42b3ef28ef752843f 100644 (file)
@@ -142,7 +142,7 @@ AmlCodeGenRdInterrupt (
   IN  BOOLEAN                 Shared,\r
   IN  UINT32                  *IrqList,\r
   IN  UINT8                   IrqCount,\r
-  IN  AML_OBJECT_NODE_HANDLE  NameOpNode, OPTIONAL\r
+  IN  AML_OBJECT_NODE_HANDLE  NameOpNode  OPTIONAL,\r
   OUT AML_DATA_NODE_HANDLE    *NewRdNode  OPTIONAL\r
   )\r
 {\r
@@ -238,7 +238,7 @@ AmlCodeGenRdRegister (
   IN  UINT8                   BitOffset,\r
   IN  UINT64                  Address,\r
   IN  UINT8                   AccessSize,\r
-  IN  AML_OBJECT_NODE_HANDLE  NameOpNode, OPTIONAL\r
+  IN  AML_OBJECT_NODE_HANDLE  NameOpNode  OPTIONAL,\r
   OUT AML_DATA_NODE_HANDLE    *NewRdNode  OPTIONAL\r
   )\r
 {\r
@@ -318,8 +318,8 @@ AmlCodeGenRdRegister (
 EFI_STATUS\r
 EFIAPI\r
 AmlCodeGenEndTag (\r
-  IN  UINT8               CheckSum,   OPTIONAL\r
-  IN  AML_OBJECT_NODE   * ParentNode, OPTIONAL\r
+  IN  UINT8               CheckSum    OPTIONAL,\r
+  IN  AML_OBJECT_NODE   * ParentNode  OPTIONAL,\r
   OUT AML_DATA_NODE    ** NewRdNode   OPTIONAL\r
   )\r
 {\r
index 10234049593387253b65fad56dbd7b41470beaf4..eb26192db40fbe9e7277c090992d068805a7fd01 100644 (file)
@@ -51,7 +51,7 @@ AmlCodeGenRdInterrupt (
   IN  BOOLEAN                 Shared,\r
   IN  UINT32                  *IrqList,\r
   IN  UINT8                   IrqCount,\r
-  IN  AML_OBJECT_NODE_HANDLE  NameOpNode, OPTIONAL\r
+  IN  AML_OBJECT_NODE_HANDLE  NameOpNode  OPTIONAL,\r
   OUT AML_DATA_NODE_HANDLE    *NewRdNode  OPTIONAL\r
   );\r
 \r
@@ -100,7 +100,7 @@ AmlCodeGenRdRegister (
   IN  UINT8                   BitOffset,\r
   IN  UINT64                  Address,\r
   IN  UINT8                   AccessSize,\r
-  IN  AML_OBJECT_NODE_HANDLE  NameOpNode, OPTIONAL\r
+  IN  AML_OBJECT_NODE_HANDLE  NameOpNode  OPTIONAL,\r
   OUT AML_DATA_NODE_HANDLE    *NewRdNode  OPTIONAL\r
   );\r
 \r
@@ -142,8 +142,8 @@ AmlCodeGenRdRegister (
 EFI_STATUS\r
 EFIAPI\r
 AmlCodeGenEndTag (\r
-  IN  UINT8               CheckSum,   OPTIONAL\r
-  IN  AML_OBJECT_NODE   * ParentNode, OPTIONAL\r
+  IN  UINT8               CheckSum    OPTIONAL,\r
+  IN  AML_OBJECT_NODE   * ParentNode  OPTIONAL,\r
   OUT AML_DATA_NODE    ** NewRdNode   OPTIONAL\r
   );\r
 \r
index 2a47c229d7480128ed0f782efa009c7a86f4a492..da81ec2ee909dc4ad7539cac9f6d7498759a44bf 100644 (file)
@@ -39,7 +39,7 @@ BOOLEAN
 EFIAPI\r
 AmlSerializeNodeCallback (\r
   IN       AML_NODE_HEADER   * Node,\r
-  IN  OUT  VOID              * Context,    OPTIONAL\r
+  IN  OUT  VOID              * Context     OPTIONAL,\r
   IN  OUT  EFI_STATUS        * Status      OPTIONAL\r
   )\r
 {\r
@@ -170,7 +170,7 @@ EFI_STATUS
 EFIAPI\r
 AmlSerializeTree (\r
   IN      AML_ROOT_NODE   * RootNode,\r
-  IN      UINT8           * Buffer,     OPTIONAL\r
+  IN      UINT8           * Buffer      OPTIONAL,\r
   IN  OUT UINT32          * BufferSize\r
   )\r
 {\r
index f91bc5fd55d2cf3f6a25c65c31a2a41d878595db..80145c6830723887db444932429053ddaa2069a4 100644 (file)
@@ -95,9 +95,9 @@ EFI_STATUS
 EFIAPI\r
 AmlGetObjectNodeInfo (\r
   IN  AML_OBJECT_NODE   * ObjectNode,\r
-  OUT UINT8             * OpCode,           OPTIONAL\r
-  OUT UINT8             * SubOpCode,        OPTIONAL\r
-  OUT UINT32            * PkgLen,           OPTIONAL\r
+  OUT UINT8             * OpCode            OPTIONAL,\r
+  OUT UINT8             * SubOpCode         OPTIONAL,\r
+  OUT UINT32            * PkgLen            OPTIONAL,\r
   OUT BOOLEAN           * IsNameSpaceNode   OPTIONAL\r
   )\r
 {\r
@@ -228,7 +228,7 @@ EFI_STATUS
 EFIAPI\r
 AmlGetDataNodeBuffer (\r
   IN      AML_DATA_NODE   * DataNode,\r
-      OUT UINT8           * Buffer,       OPTIONAL\r
+      OUT UINT8           * Buffer        OPTIONAL,\r
   IN  OUT UINT32          * BufferSize\r
   )\r
 {\r
index 3eeb7253bfb647f5430a89a87e8a196c453abe71..9502e4fdd7dbd12eb4eca7c665ab0f6ca883e3f8 100644 (file)
@@ -35,7 +35,7 @@ EFIAPI
 AmlEnumTree (\r
   IN      AML_NODE_HEADER               * Node,\r
   IN      EDKII_AML_TREE_ENUM_CALLBACK    CallBack,\r
-  IN  OUT VOID                          * Context,  OPTIONAL\r
+  IN  OUT VOID                          * Context   OPTIONAL,\r
       OUT EFI_STATUS                    * Status    OPTIONAL\r
   )\r
 {\r