Fix the following ECC reported errors in AmlLib. - [1008] File has invalid Non-ACSII char. - [9002] The function headers should follow Doxygen special documentation blocks in section 2.3.5 Comment does NOT have tail **/
Signed-off-by: Sami Mujawar <sami.muja...@arm.com> --- DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c | 4 ++-- DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlResourceDataCodeGen.c | 2 +- DynamicTablesPkg/Library/Common/AmlLib/NameSpace/AmlNameSpace.c | 2 +- DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlFieldListParser.c | 4 ++-- DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlMethodParser.c | 6 +++--- DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlParser.c | 6 +++--- DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlResourceDataParser.c | 2 +- DynamicTablesPkg/Library/Common/AmlLib/Stream/AmlStream.c | 4 ++-- DynamicTablesPkg/Library/Common/AmlLib/Tree/AmlNode.c | 6 +++--- DynamicTablesPkg/Library/Common/AmlLib/Tree/AmlTree.c | 2 +- 10 files changed, 19 insertions(+), 19 deletions(-) diff --git a/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c b/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c index d6d9f5dfe839aa8ef79153459ec9d2c2ffe72316..5d310f201319d94ffe6405aeeec65a7038a76c57 100644 --- a/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c +++ b/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c @@ -33,7 +33,7 @@ EFIAPI LinkNode ( IN AML_OBJECT_NODE * Node, IN AML_NODE_HEADER * ParentNode, - IN AML_OBJECT_NODE ** NewObjectNode + OUT AML_OBJECT_NODE ** NewObjectNode ) { EFI_STATUS Status; @@ -71,7 +71,7 @@ LinkNode ( @param[in] OemId 6-character string OEM identifier. @param[in] OemTableId 8-character string OEM table identifier. @param[in] OemRevision OEM revision number. - @param[out] DefinitionBlockTerm The ASL Term handle representing a + @param[out] NewRootNode Pointer to the root node representing a Definition Block. @retval EFI_SUCCESS Success. diff --git a/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlResourceDataCodeGen.c b/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlResourceDataCodeGen.c index 9e7a508e60721558ab59b375dbd526c7066d7329..d40a27410dd6fee8264b9c53e67f7ea67d97fcf0 100644 --- a/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlResourceDataCodeGen.c +++ b/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlResourceDataCodeGen.c @@ -40,7 +40,7 @@ EFIAPI LinkRdNode ( IN AML_DATA_NODE * RdNode, IN AML_OBJECT_NODE * ParentNode, - IN AML_DATA_NODE ** NewRdNode + OUT AML_DATA_NODE ** NewRdNode ) { EFI_STATUS Status; diff --git a/DynamicTablesPkg/Library/Common/AmlLib/NameSpace/AmlNameSpace.c b/DynamicTablesPkg/Library/Common/AmlLib/NameSpace/AmlNameSpace.c index dc373748903dd55fa4492874329f2b433c698c02..30d31572d379028a28d532c17092bef585959a50 100644 --- a/DynamicTablesPkg/Library/Common/AmlLib/NameSpace/AmlNameSpace.c +++ b/DynamicTablesPkg/Library/Common/AmlLib/NameSpace/AmlNameSpace.c @@ -674,7 +674,7 @@ AmlAddPrefix ( @retval EFI_SUCCESS The function completed successfully. @retval EFI_INVALID_PARAMETER Invalid parameter. -*/ +**/ STATIC EFI_STATUS EFIAPI diff --git a/DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlFieldListParser.c b/DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlFieldListParser.c index c25ee22dc7c4b22b1448e11cf9bbd4e5e77c4316..b9403efe3ca6f44712c91203c27410ec15eb3011 100644 --- a/DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlFieldListParser.c +++ b/DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlFieldListParser.c @@ -41,7 +41,7 @@ @retval EFI_BUFFER_TOO_SMALL No space left in the buffer. @retval EFI_INVALID_PARAMETER Invalid parameter. @retval EFI_OUT_OF_RESOURCES Could not allocate memory. -*/ +**/ STATIC EFI_STATUS EFIAPI @@ -177,7 +177,7 @@ AmlParseFieldElement ( @retval EFI_BUFFER_TOO_SMALL No space left in the buffer. @retval EFI_INVALID_PARAMETER Invalid parameter. @retval EFI_OUT_OF_RESOURCES Could not allocate memory. -*/ +**/ STATIC EFI_STATUS EFIAPI diff --git a/DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlMethodParser.c b/DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlMethodParser.c index bc98d950b579dec3243dab355a711a56dca978ea..4797fa11edebc35628ef9c07a1feffff6b14a204 100644 --- a/DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlMethodParser.c +++ b/DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlMethodParser.c @@ -1320,7 +1320,7 @@ AmlCreateMethodInvocationNode ( // DefExternal := ExternalOp NameString ObjectType ArgumentCount // ExternalOp := 0x15 // ObjectType := ByteData - // ArgumentCount := ByteData (0 – 7) + // ArgumentCount := ByteData (0 - 7) // Read the ArgumentCount. ArgCountNode = (AML_DATA_NODE*)FixedArgs[EAmlParseIndexTerm2]; @@ -1334,7 +1334,7 @@ AmlCreateMethodInvocationNode ( // MethodInvocation := MethodInvocationOp NameString ArgumentCount // MethodInvocationOp := Pseudo Opcode for Method Invocation // NameString := Method Name - // ArgumentCount := ByteData (0 – 7) + // ArgumentCount := ByteData (0 - 7) Status = AmlCreateObjectNode ( AmlGetByteEncodingByOpCode (AML_METHOD_INVOC_OP, 0), 0, @@ -1411,7 +1411,7 @@ error_handler: @retval EFI_BUFFER_TOO_SMALL No space left in the buffer. @retval EFI_INVALID_PARAMETER Invalid parameter. @retval EFI_OUT_OF_RESOURCES Could not allocate memory. -*/ +**/ EFI_STATUS EFIAPI AmlGetMethodInvocationArgCount ( diff --git a/DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlParser.c b/DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlParser.c index 380ac9bbcebef01d1d1f5dbd01971992aaf66d89..4f6623de02d519e5345955603d0ce3f1056e4f17 100644 --- a/DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlParser.c +++ b/DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlParser.c @@ -1134,7 +1134,7 @@ AmlParseVariableArguments ( @retval EFI_BUFFER_TOO_SMALL No space left in the buffer. @retval EFI_INVALID_PARAMETER Invalid parameter. @retval EFI_OUT_OF_RESOURCES Could not allocate memory. -*/ +**/ STATIC EFI_STATUS EFIAPI @@ -1179,7 +1179,7 @@ AmlPopulateRootNode ( @retval EFI_BUFFER_TOO_SMALL No space left in the buffer. @retval EFI_INVALID_PARAMETER Invalid parameter. @retval EFI_OUT_OF_RESOURCES Could not allocate memory. -*/ +**/ STATIC EFI_STATUS EFIAPI @@ -1287,7 +1287,7 @@ AmlPopulateObjectNode ( @retval EFI_BUFFER_TOO_SMALL No space left in the buffer. @retval EFI_INVALID_PARAMETER Invalid parameter. @retval EFI_OUT_OF_RESOURCES Could not allocate memory. -*/ +**/ STATIC EFI_STATUS EFIAPI diff --git a/DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlResourceDataParser.c b/DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlResourceDataParser.c index 09fb3e72586c3f31ce6d90f049e77a041330ba18..0f41c68b283794a577c551b0320afc5b6dcf55d7 100644 --- a/DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlResourceDataParser.c +++ b/DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlResourceDataParser.c @@ -213,7 +213,7 @@ AmlRdIsResourceDataBuffer ( return TRUE; } - // TODO Might want to check the CRC when available. + // @todo Might want to check the CRC when available. // An end tag resource data element must be the last element of the list. // Thus the function should have already returned. if (AmlRdCompareDescId ( diff --git a/DynamicTablesPkg/Library/Common/AmlLib/Stream/AmlStream.c b/DynamicTablesPkg/Library/Common/AmlLib/Stream/AmlStream.c index 419e796e50cbe29e62234916c6e39c2c625a2951..08ee959475dd26b72c90598daa53db639b075928 100644 --- a/DynamicTablesPkg/Library/Common/AmlLib/Stream/AmlStream.c +++ b/DynamicTablesPkg/Library/Common/AmlLib/Stream/AmlStream.c @@ -52,7 +52,7 @@ AmlStreamInit ( in the ClonedStream. @param [in] Stream Pointer to the stream to clone. - @param [in] ClonedStream Pointer to the stream to initialize. + @param [out] ClonedStream Pointer to the stream to initialize. @retval EFI_SUCCESS The function completed successfully. @retval EFI_INVALID_PARAMETER Invalid parameter. @@ -97,7 +97,7 @@ AmlStreamClone ( @param [in] Stream Pointer to the stream from which a sub-stream is created. - @param [in] SubStream Pointer to the stream to initialize. + @param [out] SubStream Pointer to the stream to initialize. @retval EFI_SUCCESS The function completed successfully. @retval EFI_INVALID_PARAMETER Invalid parameter. diff --git a/DynamicTablesPkg/Library/Common/AmlLib/Tree/AmlNode.c b/DynamicTablesPkg/Library/Common/AmlLib/Tree/AmlNode.c index 2c80440a447ad261290a2cf84a8edd3434cf9e5e..3740c0ac7bb8d2697bc1597dc1030d8276e6f565 100644 --- a/DynamicTablesPkg/Library/Common/AmlLib/Tree/AmlNode.c +++ b/DynamicTablesPkg/Library/Common/AmlLib/Tree/AmlNode.c @@ -464,7 +464,7 @@ AmlNodeCompareOpCode ( @retval TRUE The Node is an integer node. @retval FALSE Otherwise. -*/ +**/ BOOLEAN EFIAPI IsIntegerNode ( @@ -499,7 +499,7 @@ IsIntegerNode ( @retval TRUE The Node is a ZeroOp or OneOp. @retval FALSE Otherwise. -*/ +**/ BOOLEAN EFIAPI IsSpecialIntegerNode ( @@ -556,7 +556,7 @@ AmlIsMethodDefinitionNode ( // DefExternal := ExternalOp NameString ObjectType ArgumentCount // ExternalOp := 0x15 // ObjectType := ByteData - // ArgumentCount := ByteData (0 – 7) + // ArgumentCount := ByteData (0 - 7) ObjectType = (AML_DATA_NODE*)AmlGetFixedArgument ( (AML_OBJECT_NODE*)Node, EAmlParseIndexTerm1 diff --git a/DynamicTablesPkg/Library/Common/AmlLib/Tree/AmlTree.c b/DynamicTablesPkg/Library/Common/AmlLib/Tree/AmlTree.c index 65dad95da2760c512563a5152ba4acf42d555019..0931e751709e27ad4f0b4c583d8b058ce06f5bf7 100644 --- a/DynamicTablesPkg/Library/Common/AmlLib/Tree/AmlTree.c +++ b/DynamicTablesPkg/Library/Common/AmlLib/Tree/AmlTree.c @@ -41,7 +41,7 @@ AmlGetParent ( @return The root node of the tree. NULL if error. -*/ +**/ AML_ROOT_NODE * EFIAPI AmlGetRootNode ( -- 'Guid(CE165669-3EF3-493F-B85D-6190EE5B9759)' -=-=-=-=-=-=-=-=-=-=-=- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#65448): https://edk2.groups.io/g/devel/message/65448 Mute This Topic: https://groups.io/mt/77014344/21656 Group Owner: devel+ow...@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [arch...@mail-archive.com] -=-=-=-=-=-=-=-=-=-=-=-