From: Sami Mujawar <sami.mujawar@arm.com>
To: edk2-devel@lists.01.org
Cc: leif.lindholm@linaro.org, evan.lloyd@arm.com,
Matteo.Carlini@arm.com, Stephanie.Hughes-Fitt@arm.com,
nd@arm.com
Subject: [staging/dynamictables PATCH v1 2/5] DynamicTablesPkg: Fix function documentation
Date: Wed, 27 Jun 2018 17:47:43 +0100 [thread overview]
Message-ID: <20180627164746.36188-3-sami.mujawar@arm.com> (raw)
In-Reply-To: <20180627164746.36188-1-sami.mujawar@arm.com>
Fixed function documentation issues reported by ecc tool.
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Sami Mujawar <sami.mujawar@arm.com>
---
Notes:
v1:
- Fix ecc tool reported issues [SAMI]
DynamicTablesPkg/Drivers/DynamicTableFactoryDxe/AcpiTableFactory/AcpiTableFactory.c | 6 +-
DynamicTablesPkg/Drivers/DynamicTableFactoryDxe/DeviceTreeTableFactory/DeviceTreeTableFactory.c | 6 +-
DynamicTablesPkg/Drivers/DynamicTableFactoryDxe/DynamicTableFactory.h | 6 +-
DynamicTablesPkg/Drivers/DynamicTableFactoryDxe/DynamicTableFactoryDxe.c | 2 +-
DynamicTablesPkg/Drivers/DynamicTableFactoryDxe/SmbiosTableFactory/SmbiosTableFactory.c | 6 +-
DynamicTablesPkg/Drivers/DynamicTableManagerDxe/DynamicTableManagerDxe.c | 8 +--
DynamicTablesPkg/Include/AcpiTableGenerator.h | 30 ++++-----
DynamicTablesPkg/Include/ConfigurationManagerHelper.h | 2 +-
DynamicTablesPkg/Include/ConfigurationManagerObject.h | 12 ++--
DynamicTablesPkg/Include/DeviceTreeTableGenerator.h | 24 +++----
DynamicTablesPkg/Include/Library/TableHelperLib.h | 4 +-
DynamicTablesPkg/Include/Protocol/ConfigurationManagerProtocol.h | 4 +-
DynamicTablesPkg/Include/Protocol/DynamicTableFactoryProtocol.h | 6 +-
DynamicTablesPkg/Include/SmbiosTableGenerator.h | 24 +++----
DynamicTablesPkg/Include/StandardNameSpaceObjects.h | 2 +-
DynamicTablesPkg/Include/TableGenerator.h | 32 ++++-----
DynamicTablesPkg/Library/Acpi/Arm/AcpiDbg2LibArm/Dbg2Generator.c | 10 +--
DynamicTablesPkg/Library/Acpi/Arm/AcpiFadtLibArm/FadtGenerator.c | 14 ++--
DynamicTablesPkg/Library/Acpi/Arm/AcpiGtdtLibArm/GtdtGenerator.c | 16 ++---
DynamicTablesPkg/Library/Acpi/Arm/AcpiIortLibArm/IortGenerator.c | 69 +++++++++++---------
DynamicTablesPkg/Library/Acpi/Arm/AcpiMadtLibArm/MadtGenerator.c | 26 ++++----
DynamicTablesPkg/Library/Acpi/Arm/AcpiMcfgLibArm/McfgGenerator.c | 10 +--
DynamicTablesPkg/Library/Acpi/Arm/AcpiRawLibArm/RawGenerator.c | 7 +-
DynamicTablesPkg/Library/Acpi/Arm/AcpiSpcrLibArm/SpcrGenerator.c | 6 +-
DynamicTablesPkg/Library/Common/TableHelperLib/TableHelper.c | 4 +-
25 files changed, 171 insertions(+), 165 deletions(-)
diff --git a/DynamicTablesPkg/Drivers/DynamicTableFactoryDxe/AcpiTableFactory/AcpiTableFactory.c b/DynamicTablesPkg/Drivers/DynamicTableFactoryDxe/AcpiTableFactory/AcpiTableFactory.c
index 425b2f2d8feb959493214d545aaa9b59a0fbeba2..973e62a478bcc1c6baeb93cacb0a71dbf739e0ca 100644
--- a/DynamicTablesPkg/Drivers/DynamicTableFactoryDxe/AcpiTableFactory/AcpiTableFactory.c
+++ b/DynamicTablesPkg/Drivers/DynamicTableFactoryDxe/AcpiTableFactory/AcpiTableFactory.c
@@ -42,7 +42,7 @@ extern EFI_DYNAMIC_TABLE_FACTORY_INFO TableFactoryInfo;
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_NOT_FOUND The requested generator is not found
in the list of registered generators.
-*/
+**/
EFI_STATUS
EFIAPI
GetAcpiTableGenerator (
@@ -107,7 +107,7 @@ GetAcpiTableGenerator (
the Generator pointer is NULL.
@retval EFI_ALREADY_STARTED The Generator for the Table ID is
already registered.
-*/
+**/
EFI_STATUS
EFIAPI
RegisterAcpiTableGenerator (
@@ -168,7 +168,7 @@ RegisterAcpiTableGenerator (
@retval EFI_INVALID_PARAMETER The generator is invalid.
@retval EFI_NOT_FOUND The requested generator is not found
in the list of registered generators.
-*/
+**/
EFI_STATUS
EFIAPI
DeregisterAcpiTableGenerator (
diff --git a/DynamicTablesPkg/Drivers/DynamicTableFactoryDxe/DeviceTreeTableFactory/DeviceTreeTableFactory.c b/DynamicTablesPkg/Drivers/DynamicTableFactoryDxe/DeviceTreeTableFactory/DeviceTreeTableFactory.c
index 9e4fa3f8ffce390f3aa85136f3508e139cca3326..7141ca739d6bda9baddb9025b343b5392ef39d32 100644
--- a/DynamicTablesPkg/Drivers/DynamicTableFactoryDxe/DeviceTreeTableFactory/DeviceTreeTableFactory.c
+++ b/DynamicTablesPkg/Drivers/DynamicTableFactoryDxe/DeviceTreeTableFactory/DeviceTreeTableFactory.c
@@ -41,7 +41,7 @@ extern EFI_DYNAMIC_TABLE_FACTORY_INFO TableFactoryInfo;
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_NOT_FOUND The requested generator is not found
in the list of registered generators.
-*/
+**/
EFI_STATUS
EFIAPI
GetDtTableGenerator (
@@ -106,7 +106,7 @@ GetDtTableGenerator (
the Generator pointer is NULL.
@retval EFI_ALREADY_STARTED The Generator for the Table ID is
already registered.
-*/
+**/
EFI_STATUS
EFIAPI
RegisterDtTableGenerator (
@@ -167,7 +167,7 @@ RegisterDtTableGenerator (
@retval EFI_INVALID_PARAMETER The generator is invalid.
@retval EFI_NOT_FOUND The requested generator is not found
in the list of registered generators.
-*/
+**/
EFI_STATUS
EFIAPI
DeregisterDtTableGenerator (
diff --git a/DynamicTablesPkg/Drivers/DynamicTableFactoryDxe/DynamicTableFactory.h b/DynamicTablesPkg/Drivers/DynamicTableFactoryDxe/DynamicTableFactory.h
index c0b4a2a11457933b1c86950338f5619111747dc3..660d06725a742fb25e4fde8a6273489be738a006 100644
--- a/DynamicTablesPkg/Drivers/DynamicTableFactoryDxe/DynamicTableFactory.h
+++ b/DynamicTablesPkg/Drivers/DynamicTableFactoryDxe/DynamicTableFactory.h
@@ -69,7 +69,7 @@ typedef struct DynamicTableFactoryInfo {
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_NOT_FOUND The requested generator is not found
in the list of registered generators.
-*/
+**/
EFI_STATUS
EFIAPI
GetAcpiTableGenerator (
@@ -90,7 +90,7 @@ GetAcpiTableGenerator (
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_NOT_FOUND The requested generator is not found
in the list of registered generators.
-*/
+**/
EFI_STATUS
EFIAPI
GetSmbiosTableGenerator (
@@ -111,7 +111,7 @@ GetSmbiosTableGenerator (
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_NOT_FOUND The requested generator is not found
in the list of registered generators.
-*/
+**/
EFI_STATUS
EFIAPI
GetDtTableGenerator (
diff --git a/DynamicTablesPkg/Drivers/DynamicTableFactoryDxe/DynamicTableFactoryDxe.c b/DynamicTablesPkg/Drivers/DynamicTableFactoryDxe/DynamicTableFactoryDxe.c
index 6ac291ab29a8f44ed91845f5e6f65e0e5248f80b..943299ef8d0213ca7cb6ed79f5f33eb454e0c7d5 100644
--- a/DynamicTablesPkg/Drivers/DynamicTableFactoryDxe/DynamicTableFactoryDxe.c
+++ b/DynamicTablesPkg/Drivers/DynamicTableFactoryDxe/DynamicTableFactoryDxe.c
@@ -56,7 +56,7 @@ EFI_DYNAMIC_TABLE_FACTORY_PROTOCOL DynamicTableFactoryProtocol = {
@retval EFI_OUT_OF_RESOURCES Memory allocation failed.
@retval EFI_NOT_FOUND Required interface/object was not found.
@retval EFI_INVALID_PARAMETER Some parameter is incorrect/invalid.
-*/
+**/
EFI_STATUS
EFIAPI
DynamicTableFactoryDxeInitialize (
diff --git a/DynamicTablesPkg/Drivers/DynamicTableFactoryDxe/SmbiosTableFactory/SmbiosTableFactory.c b/DynamicTablesPkg/Drivers/DynamicTableFactoryDxe/SmbiosTableFactory/SmbiosTableFactory.c
index 01be8cd1ca5371770d179ca1ec12de387bd49cd7..c72541056c6ddc40fa4b8aab93a00a78c79898c5 100644
--- a/DynamicTablesPkg/Drivers/DynamicTableFactoryDxe/SmbiosTableFactory/SmbiosTableFactory.c
+++ b/DynamicTablesPkg/Drivers/DynamicTableFactoryDxe/SmbiosTableFactory/SmbiosTableFactory.c
@@ -42,7 +42,7 @@ extern EFI_DYNAMIC_TABLE_FACTORY_INFO TableFactoryInfo;
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_NOT_FOUND The requested generator is not found
in the list of registered generators.
-*/
+**/
EFI_STATUS
EFIAPI
GetSmbiosTableGenerator (
@@ -107,7 +107,7 @@ GetSmbiosTableGenerator (
the Generator pointer is NULL.
@retval EFI_ALREADY_STARTED The Generator for the Table ID is
already registered.
-*/
+**/
EFI_STATUS
EFIAPI
RegisterSmbiosTableGenerator (
@@ -168,7 +168,7 @@ RegisterSmbiosTableGenerator (
@retval EFI_INVALID_PARAMETER The generator is invalid.
@retval EFI_NOT_FOUND The requested generator is not found
in the list of registered generators.
-*/
+**/
EFI_STATUS
EFIAPI
DeregisterSmbiosTableGenerator (
diff --git a/DynamicTablesPkg/Drivers/DynamicTableManagerDxe/DynamicTableManagerDxe.c b/DynamicTablesPkg/Drivers/DynamicTableManagerDxe/DynamicTableManagerDxe.c
index 5a3ad21220bd924babab3ca2a28c87c5a91efa0c..43c750aa9b3b99cb7d721e96d641bbbef1033a85 100644
--- a/DynamicTablesPkg/Drivers/DynamicTableManagerDxe/DynamicTableManagerDxe.c
+++ b/DynamicTablesPkg/Drivers/DynamicTableManagerDxe/DynamicTableManagerDxe.c
@@ -56,7 +56,7 @@ GET_OBJECT_LIST (
@retval EFI_BAD_BUFFER_SIZE Size returned by the Configuration Manager
is less than the Object size for the
requested object.
-*/
+**/
STATIC
EFI_STATUS
EFIAPI
@@ -205,7 +205,7 @@ exit_handler:
@retval EFI_SUCCESS Success.
@retval EFI_NOT_FOUND If mandatory table is not found.
-*/
+**/
STATIC
EFI_STATUS
EFIAPI
@@ -288,7 +288,7 @@ VerifyMandatoryTablesArePresent (
@retval EFI_SUCCESS Success.
@retval EFI_NOT_FOUND If a mandatory table or a generator is not found.
-*/
+**/
STATIC
EFI_STATUS
EFIAPI
@@ -455,7 +455,7 @@ ProcessAcpiTables (
@retval EFI_OUT_OF_RESOURCES Memory allocation failed.
@retval EFI_NOT_FOUND Required interface/object was not found.
@retval EFI_INVALID_PARAMETER Some parameter is incorrect/invalid.
-*/
+**/
EFI_STATUS
EFIAPI
DynamicTableManagerDxeInitialize (
diff --git a/DynamicTablesPkg/Include/AcpiTableGenerator.h b/DynamicTablesPkg/Include/AcpiTableGenerator.h
index 89fa713134857e22640b7a6f1f63a485048b7a72..ffe1da084a27b93bd69708d81ae958d19334a502 100644
--- a/DynamicTablesPkg/Include/AcpiTableGenerator.h
+++ b/DynamicTablesPkg/Include/AcpiTableGenerator.h
@@ -85,9 +85,9 @@ typedef enum StdAcpiTableId {
@param [in] TableGeneratorId The table generator ID.
- @returns TRUE if the table generator ID is for an ACPI Table
+ @return TRUE if the table generator ID is for an ACPI Table
Generator.
-*/
+**/
#define IS_GENERATOR_TYPE_ACPI(TableGeneratorId) \
(GET_TABLE_TYPE (TableGeneratorId) == ETableGeneratorTypeAcpi)
@@ -96,9 +96,9 @@ typedef enum StdAcpiTableId {
@param [in] TableGeneratorId The table generator ID.
- @returns TRUE if the table generator ID is for a standard ACPI
+ @return TRUE if the table generator ID is for a standard ACPI
Table Generator.
-*/
+**/
#define IS_VALID_STD_ACPI_GENERATOR_ID(TableGeneratorId) \
( \
IS_GENERATOR_NAMESPACE_STD (TableGeneratorId) && \
@@ -111,8 +111,8 @@ typedef enum StdAcpiTableId {
@param [in] TableId The table generator ID.
- @returns a standard ACPI table generator ID.
-*/
+ @return a standard ACPI table generator ID.
+**/
#define CREATE_STD_ACPI_TABLE_GEN_ID(TableId) \
CREATE_TABLE_GEN_ID ( \
ETableGeneratorTypeAcpi, \
@@ -131,7 +131,7 @@ typedef enum StdAcpiTableId {
@param [in] Signature The ACPI table signature.
@param [in] Type The ACPI table structure.
@param [in] Revision The ACPI table revision.
-*/
+**/
#define ACPI_HEADER(Signature, Type, Revision) { \
Signature, /* UINT32 Signature */ \
sizeof (Type), /* UINT32 Length */ \
@@ -148,7 +148,7 @@ typedef enum StdAcpiTableId {
defined by the EFI_ACPI_DESCRIPTION_HEADER structure.
@param [in] AcpiHeader The pointer to the ACPI table header.
-*/
+**/
#define DUMP_ACPI_TABLE_HEADER(AcpiHeader) \
DEBUG (( \
DEBUG_INFO, \
@@ -177,9 +177,9 @@ typedef struct AcpiTableGenerator ACPI_TABLE_GENERATOR;
Protocol interface.
@param [out] Table Pointer to the generated ACPI table.
- @returns EFI_SUCCESS If the table is generated successfully or other
+ @return EFI_SUCCESS If the table is generated successfully or other
failure codes as returned by the generator.
-*/
+**/
typedef EFI_STATUS (*ACPI_TABLE_GENERATOR_BUILD_TABLE) (
IN CONST ACPI_TABLE_GENERATOR * This,
IN CONST CM_STD_OBJ_ACPI_TABLE_INFO * CONST AcpiTableInfo,
@@ -197,9 +197,9 @@ typedef EFI_STATUS (*ACPI_TABLE_GENERATOR_BUILD_TABLE) (
Protocol Interface.
@param [in, out] Table Pointer to the ACPI Table.
- @returns EFI_SUCCESS If freed successfully or other failure codes
+ @return EFI_SUCCESS If freed successfully or other failure codes
as returned by the generator.
-*/
+**/
typedef EFI_STATUS (*ACPI_TABLE_GENERATOR_FREE_TABLE) (
IN CONST ACPI_TABLE_GENERATOR * CONST This,
IN CONST CM_STD_OBJ_ACPI_TABLE_INFO * CONST AcpiTableInfo,
@@ -209,7 +209,7 @@ typedef EFI_STATUS (*ACPI_TABLE_GENERATOR_FREE_TABLE) (
/** The ACPI_TABLE_GENERATOR structure provides an interface that the
Table Manager can use to invoke the functions to build ACPI tables.
-*/
+**/
typedef struct AcpiTableGenerator {
/// The ACPI table generator ID.
ACPI_TABLE_GENERATOR_ID GeneratorID;
@@ -251,7 +251,7 @@ typedef struct AcpiTableGenerator {
the Generator pointer is NULL.
@retval EFI_ALREADY_STARTED The Generator for the Table ID is
already registered.
-*/
+**/
EFI_STATUS
EFIAPI
RegisterAcpiTableGenerator (
@@ -269,7 +269,7 @@ RegisterAcpiTableGenerator (
@retval EFI_INVALID_PARAMETER The generator is invalid.
@retval EFI_NOT_FOUND The requested generator is not found
in the list of registered generators.
-*/
+**/
EFI_STATUS
EFIAPI
DeregisterAcpiTableGenerator (
diff --git a/DynamicTablesPkg/Include/ConfigurationManagerHelper.h b/DynamicTablesPkg/Include/ConfigurationManagerHelper.h
index 7f39e2167166e1ea0e895a535d85ddaf231bf394..324f96b91a7f4750e01476a7d451719814acd4aa 100644
--- a/DynamicTablesPkg/Include/ConfigurationManagerHelper.h
+++ b/DynamicTablesPkg/Include/ConfigurationManagerHelper.h
@@ -52,7 +52,7 @@
@retval EFI_BAD_BUFFER_SIZE The size returned by the Configuration
Manager is less than the Object size for the
requested object.
-*/
+**/
#define GET_OBJECT_LIST(CmObjectNameSpace, CmObjectId, Type) \
STATIC \
EFI_STATUS \
diff --git a/DynamicTablesPkg/Include/ConfigurationManagerObject.h b/DynamicTablesPkg/Include/ConfigurationManagerObject.h
index 98329133a67f6ba4771ceb98c8cd30d1f470bd19..d1682c7066365bee6206f7de2b801be53a971750 100644
--- a/DynamicTablesPkg/Include/ConfigurationManagerObject.h
+++ b/DynamicTablesPkg/Include/ConfigurationManagerObject.h
@@ -118,7 +118,7 @@ typedef struct CmObjDescriptor {
@param [in] CmObjectId The Configuration Manager Object ID.
@retval Returns the Namespace ID corresponding to the CmObjectID.
-*/
+**/
#define GET_CM_NAMESPACE_ID(CmObjectId) \
(((CmObjectId) >> NAMESPACE_ID_BIT_SHIFT) & \
NAMESPACE_ID_MASK)
@@ -128,7 +128,7 @@ typedef struct CmObjDescriptor {
@param [in] CmObjectId The Configuration Manager Object ID.
@retval Returns the Object ID corresponding to the CmObjectID.
-*/
+**/
#define GET_CM_OBJECT_ID(CmObjectId) ((CmObjectId) & OBJECT_ID_MASK)
/** This macro returns a Configuration Manager Object ID
@@ -138,7 +138,7 @@ typedef struct CmObjDescriptor {
@param [in] ObjectId The Object ID.
@retval Returns the Configuration Manager Object ID.
-*/
+**/
#define CREATE_CM_OBJECT_ID(NameSpaceId, ObjectId) \
((((NameSpaceId) & NAMESPACE_ID_MASK) << NAMESPACE_ID_BIT_SHIFT) | \
((ObjectId) & OBJECT_ID_MASK))
@@ -149,7 +149,7 @@ typedef struct CmObjDescriptor {
@param [in] ObjectId The Object ID.
@retval Returns a Standard Configuration Manager Object ID.
-*/
+**/
#define CREATE_CM_STD_OBJECT_ID(ObjectId) \
(CREATE_CM_OBJECT_ID (EObjNameSpaceStandard, ObjectId))
@@ -159,7 +159,7 @@ typedef struct CmObjDescriptor {
@param [in] ObjectId The Object ID.
@retval Returns an ARM Configuration Manager Object ID.
-*/
+**/
#define CREATE_CM_ARM_OBJECT_ID(ObjectId) \
(CREATE_CM_OBJECT_ID (EObjNameSpaceArm, ObjectId))
@@ -169,7 +169,7 @@ typedef struct CmObjDescriptor {
@param [in] ObjectId The Object ID.
@retval Returns an OEM Configuration Manager Object ID.
-*/
+**/
#define CREATE_CM_OEM_OBJECT_ID(ObjectId) \
(CREATE_CM_OBJECT_ID (EObjNameSpaceOem, ObjectId))
diff --git a/DynamicTablesPkg/Include/DeviceTreeTableGenerator.h b/DynamicTablesPkg/Include/DeviceTreeTableGenerator.h
index 767a62d383e6d530e551b69a0a7146359f6fd093..ca7ab18e2b6254eced107d82ee3bfdba5517b261 100644
--- a/DynamicTablesPkg/Include/DeviceTreeTableGenerator.h
+++ b/DynamicTablesPkg/Include/DeviceTreeTableGenerator.h
@@ -40,9 +40,9 @@ typedef enum StdDtTableId {
@param [in] TableGeneratorId The table generator ID.
- @returns TRUE if the table generator ID is for an DT Table
+ @return TRUE if the table generator ID is for an DT Table
Generator.
-*/
+**/
#define IS_GENERATOR_TYPE_DT(TableGeneratorId) \
(GET_TABLE_TYPE(TableGeneratorId) == ETableGeneratorTypeDt)
@@ -51,9 +51,9 @@ typedef enum StdDtTableId {
@param [in] TableGeneratorId The table generator ID.
- @returns TRUE if the table generator ID is for a standard DT
+ @return TRUE if the table generator ID is for a standard DT
Table Generator.
-*/
+**/
#define IS_VALID_STD_DT_GENERATOR_ID(TableGeneratorId) \
( \
IS_GENERATOR_NAMESPACE_STD(TableGeneratorId) && \
@@ -66,8 +66,8 @@ typedef enum StdDtTableId {
@param [in] TableId The table generator ID.
- @returns a standard DT table generator ID.
-*/
+ @return a standard DT table generator ID.
+**/
#define CREATE_STD_DT_TABLE_GEN_ID(TableId) \
CREATE_TABLE_GEN_ID ( \
ETableGeneratorTypeDt, \
@@ -91,9 +91,9 @@ typedef struct DtTableGenerator DT_TABLE_GENERATOR;
Protocol interface.
@param [out] Table Pointer to the generated DT table.
- @returns EFI_SUCCESS If the table is generated successfully or other
+ @return EFI_SUCCESS If the table is generated successfully or other
failure codes as returned by the generator.
-*/
+**/
typedef EFI_STATUS (*DT_TABLE_GENERATOR_BUILD_TABLE) (
IN CONST DT_TABLE_GENERATOR * Generator,
IN CONST CM_STD_OBJ_DT_TABLE_INFO * CONST DtTableInfo,
@@ -111,9 +111,9 @@ typedef EFI_STATUS (*DT_TABLE_GENERATOR_BUILD_TABLE) (
Protocol interface.
@param [in] Table Pointer to the generated DT table.
- @returns EFI_SUCCESS If freed successfully or other failure codes
+ @return EFI_SUCCESS If freed successfully or other failure codes
as returned by the generator.
-*/
+**/
typedef EFI_STATUS (*DT_TABLE_GENERATOR_FREE_TABLE) (
IN CONST DT_TABLE_GENERATOR * Generator,
IN CONST CM_STD_OBJ_DT_TABLE_INFO * CONST DtTableInfo,
@@ -151,7 +151,7 @@ typedef struct DtTableGenerator {
the Generator pointer is NULL.
@retval EFI_ALREADY_STARTED The Generator for the Table ID is
already registered.
-*/
+**/
EFI_STATUS
EFIAPI
RegisterDtTableGenerator (
@@ -169,7 +169,7 @@ RegisterDtTableGenerator (
@retval EFI_INVALID_PARAMETER The generator is invalid.
@retval EFI_NOT_FOUND The requested generator is not found
in the list of registered generators.
-*/
+**/
EFI_STATUS
EFIAPI
DeregisterDtTableGenerator (
diff --git a/DynamicTablesPkg/Include/Library/TableHelperLib.h b/DynamicTablesPkg/Include/Library/TableHelperLib.h
index 71efd2e7b94d072feeba39921e19a2460641e1d1..b358223434af76820d34c29c67325919a2283aa7 100644
--- a/DynamicTablesPkg/Include/Library/TableHelperLib.h
+++ b/DynamicTablesPkg/Include/Library/TableHelperLib.h
@@ -32,7 +32,7 @@
@retval EFI_NOT_FOUND The requested Object is not found.
@retval EFI_BAD_BUFFER_SIZE The size returned by the Configuration
Manager is less than the Object size.
-*/
+**/
EFI_STATUS
EFIAPI
GetCgfMgrInfo (
@@ -57,7 +57,7 @@ GetCgfMgrInfo (
@retval EFI_BAD_BUFFER_SIZE The size returned by the Configuration
Manager is less than the Object size for the
requested object.
-*/
+**/
EFI_STATUS
EFIAPI
AddAcpiHeader (
diff --git a/DynamicTablesPkg/Include/Protocol/ConfigurationManagerProtocol.h b/DynamicTablesPkg/Include/Protocol/ConfigurationManagerProtocol.h
index 15ca0a22aac5129e5b291f1385f058113e186070..19e85fc99cff04bf6eeffe6527fa3e4f550cfd46 100644
--- a/DynamicTablesPkg/Include/Protocol/ConfigurationManagerProtocol.h
+++ b/DynamicTablesPkg/Include/Protocol/ConfigurationManagerProtocol.h
@@ -58,7 +58,7 @@ typedef struct PlatformRepositoryInfo EFI_PLATFORM_REPOSITORY_INFO;
@retval EFI_BAD_BUFFER_SIZE The size returned by the Configuration Manager
is less than the Object size for the requested
object.
-*/
+**/
typedef
EFI_STATUS
(EFIAPI * EFI_CONFIGURATION_MANAGER_GET_OBJECT) (
@@ -86,7 +86,7 @@ EFI_STATUS
is less than the Object size for the requested
object.
@retval EFI_UNSUPPORTED This operation is not supported.
-*/
+**/
typedef
EFI_STATUS
(EFIAPI * EFI_CONFIGURATION_MANAGER_SET_OBJECT) (
diff --git a/DynamicTablesPkg/Include/Protocol/DynamicTableFactoryProtocol.h b/DynamicTablesPkg/Include/Protocol/DynamicTableFactoryProtocol.h
index 8688d0a40900c9dcd90c76bfb38911ccd6b4add6..f2a78a527580bd10c8755a15732d82a8d179fdf4 100644
--- a/DynamicTablesPkg/Include/Protocol/DynamicTableFactoryProtocol.h
+++ b/DynamicTablesPkg/Include/Protocol/DynamicTableFactoryProtocol.h
@@ -56,7 +56,7 @@ typedef struct DynamicTableFactoryInfo EFI_DYNAMIC_TABLE_FACTORY_INFO;
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_NOT_FOUND The requested generator is not found
in the list of registered generators.
-*/
+**/
typedef
EFI_STATUS
EFIAPI
@@ -78,7 +78,7 @@ EFIAPI
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_NOT_FOUND The requested generator is not found
in the list of registered generators.
-*/
+**/
typedef
EFI_STATUS
EFIAPI
@@ -100,7 +100,7 @@ EFIAPI
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_NOT_FOUND The requested generator is not found
in the list of registered generators.
-*/
+**/
typedef
EFI_STATUS
EFIAPI
diff --git a/DynamicTablesPkg/Include/SmbiosTableGenerator.h b/DynamicTablesPkg/Include/SmbiosTableGenerator.h
index 139d31464db473da9df427e1848835f3d693c41b..c8e8303b0b8628753f98339b78bce6c217ec8815 100644
--- a/DynamicTablesPkg/Include/SmbiosTableGenerator.h
+++ b/DynamicTablesPkg/Include/SmbiosTableGenerator.h
@@ -90,9 +90,9 @@ typedef enum StdSmbiosTableGeneratorId {
@param [in] TableGeneratorId The table generator ID.
- @returns TRUE if the table generator ID is for an SMBIOS Table
+ @return TRUE if the table generator ID is for an SMBIOS Table
Generator.
-*/
+**/
#define IS_GENERATOR_TYPE_SMBIOS(TableGeneratorId) \
( \
GET_TABLE_TYPE (TableGeneratorId) == \
@@ -104,9 +104,9 @@ typedef enum StdSmbiosTableGeneratorId {
@param [in] TableGeneratorId The table generator ID.
- @returns TRUE if the table generator ID is for a standard SMBIOS
+ @return TRUE if the table generator ID is for a standard SMBIOS
Table Generator.
-*/
+**/
#define IS_VALID_STD_SMBIOS_GENERATOR_ID(TableGeneratorId) \
( \
IS_GENERATOR_NAMESPACE_STD(TableGeneratorId) && \
@@ -119,8 +119,8 @@ typedef enum StdSmbiosTableGeneratorId {
@param [in] TableId The table generator ID.
- @returns a standard SMBIOS table generator ID.
-*/
+ @return a standard SMBIOS table generator ID.
+**/
#define CREATE_STD_SMBIOS_TABLE_GEN_ID(TableId) \
CREATE_TABLE_GEN_ID ( \
ETableGeneratorTypeSmbios, \
@@ -144,9 +144,9 @@ typedef struct SmbiosTableGenerator SMBIOS_TABLE_GENERATOR;
Protocol interface.
@param [out] Table Pointer to the generated SMBIOS table.
- @returns EFI_SUCCESS If the table is generated successfully or other
+ @return EFI_SUCCESS If the table is generated successfully or other
failure codes as returned by the generator.
-*/
+**/
typedef EFI_STATUS (*SMBIOS_TABLE_GENERATOR_BUILD_TABLE) (
IN CONST SMBIOS_TABLE_GENERATOR * Generator,
IN CM_STD_OBJ_SMBIOS_TABLE_INFO * CONST SmbiosTableInfo,
@@ -164,9 +164,9 @@ typedef EFI_STATUS (*SMBIOS_TABLE_GENERATOR_BUILD_TABLE) (
Protocol interface.
@param [in] Table Pointer to the generated SMBIOS table.
- @returns EFI_SUCCESS If freed successfully or other failure codes
+ @return EFI_SUCCESS If freed successfully or other failure codes
as returned by the generator.
-*/
+**/
typedef EFI_STATUS (*SMBIOS_TABLE_GENERATOR_FREE_TABLE) (
IN CONST SMBIOS_TABLE_GENERATOR * Generator,
IN CONST CM_STD_OBJ_SMBIOS_TABLE_INFO * CONST SmbiosTableInfo,
@@ -210,7 +210,7 @@ typedef struct SmbiosTableGenerator {
the Generator pointer is NULL.
@retval EFI_ALREADY_STARTED The Generator for the Table ID is
already registered.
-*/
+**/
EFI_STATUS
EFIAPI
RegisterSmbiosTableGenerator (
@@ -228,7 +228,7 @@ RegisterSmbiosTableGenerator (
@retval EFI_INVALID_PARAMETER The generator is invalid.
@retval EFI_NOT_FOUND The requested generator is not found
in the list of registered generators.
-*/
+**/
EFI_STATUS
EFIAPI
DeregisterSmbiosTableGenerator (
diff --git a/DynamicTablesPkg/Include/StandardNameSpaceObjects.h b/DynamicTablesPkg/Include/StandardNameSpaceObjects.h
index bcc9287527da4cdbc32a929ec6f68773a88a74f6..4f682a52dad4059b0d768d7765c4dbd875cc5d53 100644
--- a/DynamicTablesPkg/Include/StandardNameSpaceObjects.h
+++ b/DynamicTablesPkg/Include/StandardNameSpaceObjects.h
@@ -43,7 +43,7 @@
Note: The token value 0 is reserved for a NULL token and does
not identify any object.
-*/
+**/
typedef UINTN CM_OBJECT_TOKEN;
/** The ESTD_OBJECT_ID enum describes the Object IDs
diff --git a/DynamicTablesPkg/Include/TableGenerator.h b/DynamicTablesPkg/Include/TableGenerator.h
index 171609f1b73736596dedff906ef8de275f2c8cca..ea996085683ff6a783ec9a676efce6604b956d8e 100644
--- a/DynamicTablesPkg/Include/TableGenerator.h
+++ b/DynamicTablesPkg/Include/TableGenerator.h
@@ -154,8 +154,8 @@ typedef enum TableGeneratorNameSpace {
@param [in] TableGeneratorId The table generator ID.
- @returns the Table ID described by the TableGeneratorId.
-*/
+ @return the Table ID described by the TableGeneratorId.
+**/
#define GET_TABLE_ID(TableGeneratorId) \
((TableGeneratorId) & TABLE_ID_MASK)
@@ -163,8 +163,8 @@ typedef enum TableGeneratorNameSpace {
@param [in] TableGeneratorId The table generator ID.
- @returns the Table type described by the TableGeneratorId.
-*/
+ @return the Table type described by the TableGeneratorId.
+**/
#define GET_TABLE_TYPE(TableGeneratorId) \
(((TableGeneratorId) & TABLE_TYPE_MASK) >> TABLE_TYPE_BIT_SHIFT)
@@ -172,8 +172,8 @@ typedef enum TableGeneratorNameSpace {
@param [in] TableGeneratorId The table generator ID.
- @returns the Namespace described by the TableGeneratorId.
-*/
+ @return the Namespace described by the TableGeneratorId.
+**/
#define GET_TABLE_NAMESPACEID(TableGeneratorId) \
(((TableGeneratorId) & TABLE_NAMESPACEID_MASK) >> \
TABLE_NAMESPACE_ID_BIT_SHIFT)
@@ -182,8 +182,8 @@ typedef enum TableGeneratorNameSpace {
@param [in] TableGeneratorId The table generator ID.
- @returns TRUE if the TableGeneratorId is in the Standard Namespace.
-*/
+ @return TRUE if the TableGeneratorId is in the Standard Namespace.
+**/
#define IS_GENERATOR_NAMESPACE_STD(TableGeneratorId) \
( \
GET_TABLE_NAMESPACEID(TableGeneratorId) == \
@@ -196,8 +196,8 @@ typedef enum TableGeneratorNameSpace {
@param [in] TableNameSpaceId The namespace ID for the table.
@param [in] TableId The table ID.
- @returns a TableGeneratorId calculated from the inputs.
-*/
+ @return a TableGeneratorId calculated from the inputs.
+**/
#define CREATE_TABLE_GEN_ID(TableType, TableNameSpaceId, TableId) \
((((TableType) << TABLE_TYPE_BIT_SHIFT) & TABLE_TYPE_MASK) | \
(((TableNameSpaceId) << TABLE_NAMESPACE_ID_BIT_SHIFT) & \
@@ -221,8 +221,8 @@ typedef enum TableGeneratorNameSpace {
@param [in] Major The Major revision.
@param [in] Minor The Minor revision.
- @returns a 32 bit representation of the type Major.Minor.
-*/
+ @return a 32 bit representation of the type Major.Minor.
+**/
#define CREATE_REVISION(Major, Minor) \
((((Major) & MAJOR_REVISION_MASK) << MAJOR_REVISION_BIT_SHIFT) | \
((Minor) & MINOR_REVISION_MASK))
@@ -233,8 +233,8 @@ typedef enum TableGeneratorNameSpace {
@param [in] Revision The Revision value which is 32 bit.
- @returns the Major part of the revision.
-*/
+ @return the Major part of the revision.
+**/
#define GET_MAJOR_REVISION(Revision) \
(((Revision) >> MAJOR_REVISION_BIT_SHIFT) & MAJOR_REVISION_MASK)
@@ -244,8 +244,8 @@ typedef enum TableGeneratorNameSpace {
@param [in] Revision The Revision value which is 32 bit.
- @returns the Minor part of the revision.
-*/
+ @return the Minor part of the revision.
+**/
#define GET_MINOR_REVISION(Revision) ((Revision) & MINOR_REVISION_MASK)
#endif // TABLE_GENERATOR_H_
diff --git a/DynamicTablesPkg/Library/Acpi/Arm/AcpiDbg2LibArm/Dbg2Generator.c b/DynamicTablesPkg/Library/Acpi/Arm/AcpiDbg2LibArm/Dbg2Generator.c
index 910b9b68f43b4a9e7d0d8e9a8c879abb172a9678..b8301753d518b71264683c8f863e23bb2d86c1d8 100644
--- a/DynamicTablesPkg/Library/Acpi/Arm/AcpiDbg2LibArm/Dbg2Generator.c
+++ b/DynamicTablesPkg/Library/Acpi/Arm/AcpiDbg2LibArm/Dbg2Generator.c
@@ -102,7 +102,7 @@ typedef struct {
@param [in] UartBase The UART port base address.
@param [in] UartAddrLen The UART port address range length.
@param [in] UartNameStr The UART port name string.
-*/
+**/
#define DBG2_DEBUG_PORT_DDI( \
NumReg, \
SubType, \
@@ -192,7 +192,7 @@ GET_OBJECT_LIST (
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER The parameters for serial port initialization
are invalid.
-*/
+**/
STATIC
EFI_STATUS
SetupDebugUart (
@@ -260,7 +260,7 @@ SetupDebugUart (
@retval EFI_BAD_BUFFER_SIZE The size returned by the Configuration
Manager is less than the Object size for the
requested object.
-*/
+**/
STATIC
EFI_STATUS
EFIAPI
@@ -402,7 +402,7 @@ ACPI_TABLE_GENERATOR Dbg2Generator = {
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_ALREADY_STARTED The Generator for the Table ID
is already registered.
-*/
+**/
EFI_STATUS
EFIAPI
AcpiDbg2LibConstructor (
@@ -425,7 +425,7 @@ AcpiDbg2LibConstructor (
@retval EFI_SUCCESS The Generator is deregistered.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_NOT_FOUND The Generator is not registered.
-*/
+**/
EFI_STATUS
EFIAPI
AcpiDbg2LibDestructor (
diff --git a/DynamicTablesPkg/Library/Acpi/Arm/AcpiFadtLibArm/FadtGenerator.c b/DynamicTablesPkg/Library/Acpi/Arm/AcpiFadtLibArm/FadtGenerator.c
index f33c3ef9a77cd980ff268a21c933026bdde7ccf7..7ef6e3a1d7987d20fc4fe4d8b3ea66e3303f8cc6 100644
--- a/DynamicTablesPkg/Library/Acpi/Arm/AcpiFadtLibArm/FadtGenerator.c
+++ b/DynamicTablesPkg/Library/Acpi/Arm/AcpiFadtLibArm/FadtGenerator.c
@@ -251,7 +251,7 @@ GET_OBJECT_LIST (
@retval EFI_BAD_BUFFER_SIZE The size returned by the Configuration
Manager is less than the Object size for the
requested object.
-*/
+**/
STATIC
EFI_STATUS
EFIAPI
@@ -304,7 +304,7 @@ error_handler:
@retval EFI_BAD_BUFFER_SIZE The size returned by the Configuration
Manager is less than the Object size for the
requested object.
-*/
+**/
STATIC
EFI_STATUS
EFIAPI
@@ -356,7 +356,7 @@ error_handler:
@retval EFI_BAD_BUFFER_SIZE The size returned by the Configuration
Manager is less than the Object size for the
requested object.
-*/
+**/
STATIC
EFI_STATUS
EFIAPI
@@ -417,7 +417,7 @@ error_handler:
@retval EFI_BAD_BUFFER_SIZE The size returned by the Configuration
Manager is less than the Object size for the
requested object.
-*/
+**/
STATIC
EFI_STATUS
EFIAPI
@@ -498,7 +498,7 @@ error_handler:
@retval EFI_BAD_BUFFER_SIZE The size returned by the Configuration
Manager is less than the Object size for the
requested object.
-*/
+**/
STATIC
EFI_STATUS
EFIAPI
@@ -629,7 +629,7 @@ ACPI_TABLE_GENERATOR FadtGenerator = {
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_ALREADY_STARTED The Generator for the Table ID
is already registered.
-*/
+**/
EFI_STATUS
EFIAPI
AcpiFadtLibConstructor (
@@ -651,7 +651,7 @@ AcpiFadtLibConstructor (
@retval EFI_SUCCESS The Generator is deregistered.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_NOT_FOUND The Generator is not registered.
-*/
+**/
EFI_STATUS
EFIAPI
AcpiFadtLibDestructor (
diff --git a/DynamicTablesPkg/Library/Acpi/Arm/AcpiGtdtLibArm/GtdtGenerator.c b/DynamicTablesPkg/Library/Acpi/Arm/AcpiGtdtLibArm/GtdtGenerator.c
index 3bc34769346eeedb9c75ce76148d187b61b6fac1..e5b0dfa3ed11ea4cc3098d6d0a811012e9dc284e 100644
--- a/DynamicTablesPkg/Library/Acpi/Arm/AcpiGtdtLibArm/GtdtGenerator.c
+++ b/DynamicTablesPkg/Library/Acpi/Arm/AcpiGtdtLibArm/GtdtGenerator.c
@@ -90,7 +90,7 @@ GET_OBJECT_LIST (
@retval EFI_BAD_BUFFER_SIZE The size returned by the Configuration
Manager is less than the Object size for the
requested object.
-*/
+**/
STATIC
EFI_STATUS
EFIAPI
@@ -149,7 +149,7 @@ AddGenericTimerInfo (
GTDT Table.
@param [in] WatchdogInfoList Pointer to the watchdog information list.
@param [in] WatchdogCount Platform timer count.
-*/
+**/
STATIC
VOID
AddGenericWatchdogList (
@@ -195,7 +195,7 @@ AddGenericWatchdogList (
@retval EFI_SUCCESS Table generated successfully.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
-*/
+**/
STATIC
EFI_STATUS
AddGTBlockTimerFrames (
@@ -262,7 +262,7 @@ AddGTBlockTimerFrames (
@retval EFI_SUCCESS Table generated successfully.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
-*/
+**/
STATIC
EFI_STATUS
AddGTBlockList (
@@ -363,7 +363,7 @@ AddGTBlockList (
Manager is less than the Object size for the
requested object.
@retval EFI_OUT_OF_RESOURCES Memory allocation failed.
-*/
+**/
STATIC
EFI_STATUS
EFIAPI
@@ -570,7 +570,7 @@ error_handler:
@retval EFI_SUCCESS The resources were freed successfully.
@retval EFI_INVALID_PARAMETER The table pointer is NULL or invalid.
-*/
+**/
STATIC
EFI_STATUS
FreeGtdtTableResources (
@@ -633,7 +633,7 @@ ACPI_TABLE_GENERATOR GtdtGenerator = {
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_ALREADY_STARTED The Generator for the Table ID
is already registered.
-*/
+**/
EFI_STATUS
EFIAPI
AcpiGtdtLibConstructor (
@@ -655,7 +655,7 @@ AcpiGtdtLibConstructor (
@retval EFI_SUCCESS The Generator is deregistered.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_NOT_FOUND The Generator is not registered.
-*/
+**/
EFI_STATUS
EFIAPI
AcpiGtdtLibDestructor (
diff --git a/DynamicTablesPkg/Library/Acpi/Arm/AcpiIortLibArm/IortGenerator.c b/DynamicTablesPkg/Library/Acpi/Arm/AcpiIortLibArm/IortGenerator.c
index 2b43066245d5dc225a9942677540f01fddec7ddc..ba33f0edc1a3e16c5ffe62d94e1a9b3c400b9281 100644
--- a/DynamicTablesPkg/Library/Acpi/Arm/AcpiIortLibArm/IortGenerator.c
+++ b/DynamicTablesPkg/Library/Acpi/Arm/AcpiIortLibArm/IortGenerator.c
@@ -134,7 +134,7 @@ GET_OBJECT_LIST (
@param [in] Node Pointer to ITS Group node.
@retval Size of the ITS Group Node.
-*/
+**/
STATIC
UINT32
GetItsGroupNodeSize (
@@ -165,7 +165,7 @@ GetItsGroupNodeSize (
@param [in, out] NodeIndexer Pointer to the next Node Indexer.
@retval Total size of the ITS Group Nodes.
-*/
+**/
STATIC
UINT32
GetSizeofItsGroupNodes (
@@ -204,7 +204,7 @@ GetSizeofItsGroupNodes (
@param [in] Node Pointer to Named Component node.
@retval Size of the Named Component node.
-*/
+**/
STATIC
UINT32
GetNamedComponentNodeSize (
@@ -240,7 +240,7 @@ GetNamedComponentNodeSize (
@param [in, out] NodeIndexer Pointer to the next Node Indexer.
@retval Total size of the Named Component nodes.
-*/
+**/
STATIC
UINT32
GetSizeofNamedComponentNodes (
@@ -280,7 +280,7 @@ GetSizeofNamedComponentNodes (
@param [in] Node Pointer to Root Complex node.
@retval Size of the Root Complex node.
-*/
+**/
STATIC
UINT32
GetRootComplexNodeSize (
@@ -312,7 +312,7 @@ GetRootComplexNodeSize (
@param [in, out] NodeIndexer Pointer to the next Node Indexer.
@retval Total size of the Root Complex nodes.
-*/
+**/
STATIC
UINT32
GetSizeofRootComplexNodes (
@@ -352,7 +352,7 @@ GetSizeofRootComplexNodes (
@param [in] Node Pointer to SMMUv1/SMMUv2 node list.
@retval Size of the SMMUv1/SMMUv2 node.
-*/
+**/
STATIC
UINT32
GetSmmuV1V2NodeSize (
@@ -392,7 +392,7 @@ GetSmmuV1V2NodeSize (
@param [in, out] NodeIndexer Pointer to the next Node Indexer.
@retval Total size of the SMMUv1/SMMUv2 nodes.
-*/
+**/
STATIC
UINT32
GetSizeofSmmuV1V2Nodes (
@@ -431,7 +431,7 @@ GetSizeofSmmuV1V2Nodes (
@param [in] Node Pointer to SMMUv3 node list.
@retval Total size of the SMMUv3 nodes.
-*/
+**/
STATIC
UINT32
GetSmmuV3NodeSize (
@@ -463,7 +463,7 @@ GetSmmuV3NodeSize (
@param [in, out] NodeIndexer Pointer to the next Node Indexer.
@retval Total size of the SMMUv3 nodes.
-*/
+**/
STATIC
UINT32
GetSizeofSmmuV3Nodes (
@@ -502,7 +502,7 @@ GetSizeofSmmuV3Nodes (
@param [in] Node Pointer to PMCG node.
@retval Size of the PMCG node.
-*/
+**/
STATIC
UINT32
GetPmcgNodeSize (
@@ -534,7 +534,7 @@ GetPmcgNodeSize (
@param [in, out] NodeIndexer Pointer to the next Node Indexer.
@retval Total size of the PMCG nodes.
-*/
+**/
STATIC
UINT32
GetSizeofPmcgNodes (
@@ -579,7 +579,7 @@ GetSizeofPmcgNodes (
@retval EFI_SUCCESS Success.
@retval EFI_NOT_FOUND No matching token reference
found in node indexer array.
-*/
+**/
STATIC
EFI_STATUS
GetNodeOffsetReferencedByToken (
@@ -625,6 +625,7 @@ GetNodeOffsetReferencedByToken (
This function retrieves the Id Mapping Array object referenced by the
IdMappingToken and updates the IdMapArray.
+ @param [in] This Pointer to the table Generator.
@param [in] CfgMgrProtocol Pointer to the Configuration Manager
Protocol Interface.
@param [in] IdMapArray Pointer to an array of Id Mappings.
@@ -635,7 +636,7 @@ GetNodeOffsetReferencedByToken (
@retval EFI_SUCCESS Table generated successfully.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_NOT_FOUND The required object was not found.
-*/
+**/
STATIC
EFI_STATUS
AddIdMappingArray (
@@ -711,6 +712,7 @@ AddIdMappingArray (
/** Update the ITS Group Node Information.
+ @param [in] This Pointer to the table Generator.
@param [in] CfgMgrProtocol Pointer to the Configuration Manager
Protocol Interface.
@param [in] Iort Pointer to IORT table structure.
@@ -723,7 +725,7 @@ AddIdMappingArray (
@retval EFI_SUCCESS Table generated successfully.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_NOT_FOUND The required object was not found.
-*/
+**/
STATIC
EFI_STATUS
AddItsGroupNodes (
@@ -803,6 +805,7 @@ AddItsGroupNodes (
This function updates the Named Component node information in the IORT
table.
+ @param [in] This Pointer to the table Generator.
@param [in] CfgMgrProtocol Pointer to the Configuration Manager
Protocol Interface.
@param [in] Iort Pointer to IORT table structure.
@@ -815,7 +818,7 @@ AddItsGroupNodes (
@retval EFI_SUCCESS Table generated successfully.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_NOT_FOUND The required object was not found.
-*/
+**/
STATIC
EFI_STATUS
AddNamedComponentNodes (
@@ -913,6 +916,7 @@ AddNamedComponentNodes (
This function updates the Root Complex node information in the IORT table.
+ @param [in] This Pointer to the table Generator.
@param [in] CfgMgrProtocol Pointer to the Configuration Manager
Protocol Interface.
@param [in] Iort Pointer to IORT table structure.
@@ -925,7 +929,7 @@ AddNamedComponentNodes (
@retval EFI_SUCCESS Table generated successfully.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_NOT_FOUND The required object was not found.
-*/
+**/
STATIC
EFI_STATUS
AddRootComplexNodes (
@@ -1003,17 +1007,17 @@ AddRootComplexNodes (
This function retrieves the InterruptArray object referenced by the
InterruptToken and updates the SMMU InterruptArray.
- @param [in] CfgMgrProtocol Pointer to the Configuration Manager
- Protocol Interface.
- @param [in] InterruptArray Pointer to an array of Interrupts.
- @param [in] InterruptCount Number of entries in the InterruptArray.
- @param [in] InterruptToken Reference Token for retrieving the SMMU
- InterruptArray object.
+ @param [in] CfgMgrProtocol Pointer to the Configuration Manager
+ Protocol Interface.
+ @param [in, out] InterruptArray Pointer to an array of Interrupts.
+ @param [in] InterruptCount Number of entries in the InterruptArray.
+ @param [in] InterruptToken Reference Token for retrieving the SMMU
+ InterruptArray object.
@retval EFI_SUCCESS Table generated successfully.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_NOT_FOUND The required object was not found.
-*/
+**/
STATIC
EFI_STATUS
AddSmmuInterrruptArray (
@@ -1066,6 +1070,7 @@ AddSmmuInterrruptArray (
/** Update the SMMU v1/v2 Node Information.
+ @param [in] This Pointer to the table Generator.
@param [in] CfgMgrProtocol Pointer to the Configuration Manager
Protocol Interface.
@param [in] Iort Pointer to IORT table structure.
@@ -1078,7 +1083,7 @@ AddSmmuInterrruptArray (
@retval EFI_SUCCESS Table generated successfully.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_NOT_FOUND The required object was not found.
-*/
+**/
STATIC
EFI_STATUS
AddSmmuV1V2Nodes (
@@ -1216,6 +1221,7 @@ AddSmmuV1V2Nodes (
This function updates the SMMUv3 node information in the IORT table.
+ @param [in] This Pointer to the table Generator.
@param [in] CfgMgrProtocol Pointer to the Configuration Manager
Protocol Interface.
@param [in] Iort Pointer to IORT table structure.
@@ -1226,7 +1232,7 @@ AddSmmuV1V2Nodes (
@retval EFI_SUCCESS Table generated successfully.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_NOT_FOUND The required object was not found.
-*/
+**/
STATIC
EFI_STATUS
AddSmmuV3Nodes (
@@ -1319,6 +1325,7 @@ AddSmmuV3Nodes (
This function updates the PMCG node information in the IORT table.
+ @param [in] This Pointer to the table Generator.
@param [in] CfgMgrProtocol Pointer to the Configuration Manager
Protocol Interface.
@param [in] Iort Pointer to IORT table structure.
@@ -1329,7 +1336,7 @@ AddSmmuV3Nodes (
@retval EFI_SUCCESS Table generated successfully.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_NOT_FOUND The required object was not found.
-*/
+**/
STATIC
EFI_STATUS
AddPmcgNodes (
@@ -1436,7 +1443,7 @@ AddPmcgNodes (
@retval EFI_BAD_BUFFER_SIZE The size returned by the Configuration
Manager is less than the Object size for the
requested object.
-*/
+**/
STATIC
EFI_STATUS
EFIAPI
@@ -1929,7 +1936,7 @@ error_handler:
@retval EFI_SUCCESS The resources were freed successfully.
@retval EFI_INVALID_PARAMETER The table pointer is NULL or invalid.
-*/
+**/
STATIC
EFI_STATUS
FreeIortTableResources (
@@ -2010,7 +2017,7 @@ ACPI_IORT_GENERATOR IortGenerator = {
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_ALREADY_STARTED The Generator for the Table ID
is already registered.
-*/
+**/
EFI_STATUS
EFIAPI
AcpiIortLibConstructor (
@@ -2032,7 +2039,7 @@ AcpiIortLibConstructor (
@retval EFI_SUCCESS The Generator is deregistered.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_NOT_FOUND The Generator is not registered.
-*/
+**/
EFI_STATUS
EFIAPI
AcpiIortLibDestructor (
diff --git a/DynamicTablesPkg/Library/Acpi/Arm/AcpiMadtLibArm/MadtGenerator.c b/DynamicTablesPkg/Library/Acpi/Arm/AcpiMadtLibArm/MadtGenerator.c
index a08832aa813a6df0df51f82741084f81d511b30a..6fa45357ea3c888d1fe35565a35cc074c6967478 100644
--- a/DynamicTablesPkg/Library/Acpi/Arm/AcpiMadtLibArm/MadtGenerator.c
+++ b/DynamicTablesPkg/Library/Acpi/Arm/AcpiMadtLibArm/MadtGenerator.c
@@ -92,7 +92,7 @@ GET_OBJECT_LIST (
@param [in] Gicc Pointer to GIC CPU Interface structure.
@param [in] GicCInfo Pointer to the GIC CPU Interface Information.
-*/
+**/
STATIC
VOID
AddGICC (
@@ -153,7 +153,7 @@ AddGICC (
@param [in] GicCInfo Pointer to the GIC CPU
Information list.
@param [in] GicCCount Count of GIC CPU Interfaces.
-*/
+**/
STATIC
VOID
AddGICCList (
@@ -174,7 +174,7 @@ AddGICCList (
@param [in] Gicd Pointer to GIC Distributor structure.
@param [in] GicDInfo Pointer to the GIC Distributor Information.
-*/
+**/
STATIC
VOID
AddGICD (
@@ -209,7 +209,7 @@ AddGICD (
@param [in] GicMsiFrame Pointer to GIC MSI Frame structure.
@param [in] GicMsiFrameInfo Pointer to the GIC MSI Frame Information.
-*/
+**/
STATIC
VOID
AddGICMsiFrame (
@@ -236,7 +236,7 @@ AddGICMsiFrame (
@param [in] GicMsiFrame Pointer to GIC MSI Frame structure list.
@param [in] GicMsiFrameInfo Pointer to the GIC MSI Frame info list.
@param [in] GicMsiFrameCount Count of GIC MSI Frames.
-*/
+**/
STATIC
VOID
AddGICMsiFrameInfoList (
@@ -257,7 +257,7 @@ AddGICMsiFrameInfoList (
@param [in] Gicr Pointer to GIC Redistributor structure.
@param [in] GicRedisributorInfo Pointer to the GIC Redistributor Info.
-*/
+**/
STATIC
VOID
AddGICRedistributor (
@@ -281,7 +281,7 @@ AddGICRedistributor (
@param [in] Gicr Pointer to GIC Redistributor structure list.
@param [in] GicRInfo Pointer to the GIC Distributor info list.
@param [in] GicRCount Count of GIC Distributors.
-*/
+**/
STATIC
VOID
AddGICRedistributorList (
@@ -302,7 +302,7 @@ AddGICRedistributorList (
@param [in] GicIts Pointer to GIC ITS structure.
@param [in] GicItsInfo Pointer to the GIC ITS Information.
-*/
+**/
STATIC
VOID
AddGICInterruptTranslationService (
@@ -327,7 +327,7 @@ AddGICInterruptTranslationService (
@param [in] GicIts Pointer to GIC ITS structure list.
@param [in] GicItsInfo Pointer to the GIC ITS list.
@param [in] GicItsCount Count of GIC ITS.
-*/
+**/
STATIC
VOID
AddGICItsList (
@@ -365,7 +365,7 @@ AddGICItsList (
@retval EFI_BAD_BUFFER_SIZE The size returned by the Configuration
Manager is less than the Object size for the
requested object.
-*/
+**/
STATIC
EFI_STATUS
EFIAPI
@@ -617,7 +617,7 @@ error_handler:
@retval EFI_SUCCESS The resources were freed successfully.
@retval EFI_INVALID_PARAMETER The table pointer is NULL or invalid.
-*/
+**/
STATIC
EFI_STATUS
FreeMadtTableResources (
@@ -680,7 +680,7 @@ ACPI_TABLE_GENERATOR MadtGenerator = {
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_ALREADY_STARTED The Generator for the Table ID
is already registered.
-*/
+**/
EFI_STATUS
EFIAPI
AcpiMadtLibConstructor (
@@ -702,7 +702,7 @@ AcpiMadtLibConstructor (
@retval EFI_SUCCESS The Generator is deregistered.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_NOT_FOUND The Generator is not registered.
-*/
+**/
EFI_STATUS
EFIAPI
AcpiMadtLibDestructor (
diff --git a/DynamicTablesPkg/Library/Acpi/Arm/AcpiMcfgLibArm/McfgGenerator.c b/DynamicTablesPkg/Library/Acpi/Arm/AcpiMcfgLibArm/McfgGenerator.c
index 8b95fd3d5c7f97e9cf7ccd956fcba56d46fc6cf1..8f623a3d1821e8eabc365ca4dc20e8240df40568 100644
--- a/DynamicTablesPkg/Library/Acpi/Arm/AcpiMcfgLibArm/McfgGenerator.c
+++ b/DynamicTablesPkg/Library/Acpi/Arm/AcpiMcfgLibArm/McfgGenerator.c
@@ -70,7 +70,7 @@ GET_OBJECT_LIST (
@param [in] PciCfgSpaceInfoList Pointer to the PCI Configuration Space
Info List.
@param [in] PciCfgSpaceCount Count of PCI Configuration Space Info.
-*/
+**/
STATIC
VOID
AddPciConfigurationSpaceList (
@@ -121,7 +121,7 @@ AddPciConfigurationSpaceList (
@retval EFI_BAD_BUFFER_SIZE The size returned by the Configuration
Manager is less than the Object size for the
requested object.
-*/
+**/
STATIC
EFI_STATUS
EFIAPI
@@ -242,7 +242,7 @@ error_handler:
@retval EFI_SUCCESS The resources were freed successfully.
@retval EFI_INVALID_PARAMETER The table pointer is NULL or invalid.
-*/
+**/
STATIC
EFI_STATUS
FreeMcfgTableResources (
@@ -305,7 +305,7 @@ ACPI_TABLE_GENERATOR McfgGenerator = {
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_ALREADY_STARTED The Generator for the Table ID
is already registered.
-*/
+**/
EFI_STATUS
EFIAPI
AcpiMcfgLibConstructor (
@@ -327,7 +327,7 @@ AcpiMcfgLibConstructor (
@retval EFI_SUCCESS The Generator is deregistered.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_NOT_FOUND The Generator is not registered.
-*/
+**/
EFI_STATUS
EFIAPI
AcpiMcfgLibDestructor (
diff --git a/DynamicTablesPkg/Library/Acpi/Arm/AcpiRawLibArm/RawGenerator.c b/DynamicTablesPkg/Library/Acpi/Arm/AcpiRawLibArm/RawGenerator.c
index 974b2993c24ae148eeb88342c5e32fa997a31c0e..ca43d7d7ce2b018389a4196b0a2b80621f26e464 100644
--- a/DynamicTablesPkg/Library/Acpi/Arm/AcpiRawLibArm/RawGenerator.c
+++ b/DynamicTablesPkg/Library/Acpi/Arm/AcpiRawLibArm/RawGenerator.c
@@ -39,7 +39,7 @@
@retval EFI_SUCCESS Table generated successfully.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
-*/
+**/
STATIC
EFI_STATUS
EFIAPI
@@ -104,7 +104,7 @@ ACPI_TABLE_GENERATOR RawGenerator = {
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_ALREADY_STARTED The Generator for the Table ID
is already registered.
-*/
+**/
EFI_STATUS
EFIAPI
AcpiRawLibConstructor (
@@ -126,8 +126,7 @@ AcpiRawLibConstructor (
@retval EFI_SUCCESS The Generator is deregistered.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_NOT_FOUND The Generator is not registered.
-*/
-
+**/
EFI_STATUS
EFIAPI
AcpiRawLibDestructor (
diff --git a/DynamicTablesPkg/Library/Acpi/Arm/AcpiSpcrLibArm/SpcrGenerator.c b/DynamicTablesPkg/Library/Acpi/Arm/AcpiSpcrLibArm/SpcrGenerator.c
index 04b64b2c91951d3047a01bb5a807a3adb321ca50..739784a456f23ad81ca8f3918b23adba6bb2429b 100644
--- a/DynamicTablesPkg/Library/Acpi/Arm/AcpiSpcrLibArm/SpcrGenerator.c
+++ b/DynamicTablesPkg/Library/Acpi/Arm/AcpiSpcrLibArm/SpcrGenerator.c
@@ -121,7 +121,7 @@ GET_OBJECT_LIST (
@retval EFI_BAD_BUFFER_SIZE The size returned by the Configuration
Manager is less than the Object size for the
requested object.
-*/
+**/
STATIC
EFI_STATUS
EFIAPI
@@ -287,7 +287,7 @@ ACPI_TABLE_GENERATOR SpcrGenerator = {
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_ALREADY_STARTED The Generator for the Table ID
is already registered.
-*/
+**/
EFI_STATUS
EFIAPI
AcpiSpcrLibConstructor (
@@ -309,7 +309,7 @@ AcpiSpcrLibConstructor (
@retval EFI_SUCCESS The Generator is deregistered.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_NOT_FOUND The Generator is not registered.
-*/
+**/
EFI_STATUS
EFIAPI
AcpiSpcrLibDestructor (
diff --git a/DynamicTablesPkg/Library/Common/TableHelperLib/TableHelper.c b/DynamicTablesPkg/Library/Common/TableHelperLib/TableHelper.c
index 16bce37e4c0cb2666e8f2d0895c4fa55f350f2f1..affa337ec11b6f6d3589ce8a3f3e535469ecfa9d 100644
--- a/DynamicTablesPkg/Library/Common/TableHelperLib/TableHelper.c
+++ b/DynamicTablesPkg/Library/Common/TableHelperLib/TableHelper.c
@@ -34,7 +34,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
@retval EFI_NOT_FOUND The requested Object is not found.
@retval EFI_BAD_BUFFER_SIZE The size returned by the Configuration
Manager is less than the Object size.
-*/
+**/
EFI_STATUS
EFIAPI
GetCgfMgrInfo (
@@ -98,7 +98,7 @@ GetCgfMgrInfo (
@retval EFI_BAD_BUFFER_SIZE The size returned by the Configuration
Manager is less than the Object size for the
requested object.
-*/
+**/
EFI_STATUS
EFIAPI
AddAcpiHeader (
--
'Guid(CE165669-3EF3-493F-B85D-6190EE5B9759)'
next prev parent reply other threads:[~2018-06-27 16:47 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-06-27 16:47 [staging/dynamictables PATCH v1 0/5] Fix issues reported by ecc tool Sami Mujawar
2018-06-27 16:47 ` [staging/dynamictables PATCH v1 1/5] DynamicTablesPkg: Add module info to file header Sami Mujawar
2018-06-27 16:47 ` Sami Mujawar [this message]
2018-06-27 16:47 ` [staging/dynamictables PATCH v1 3/5] DynamicTablesPkg: Fix variable naming issue Sami Mujawar
2018-06-27 16:47 ` [staging/dynamictables PATCH v1 4/5] DynamicTablesPkg: Fix macro to prevent side effect Sami Mujawar
2018-06-28 16:50 ` Leif Lindholm
2018-06-28 17:10 ` Sami Mujawar
2018-06-29 9:41 ` Leif Lindholm
2018-06-27 16:47 ` [staging/dynamictables PATCH v1 5/5] DynamicTablesPkg: Fix variable declaration Sami Mujawar
2018-06-27 16:57 ` [staging/dynamictables PATCH v1 0/5] Fix issues reported by ecc tool Evan Lloyd
2018-07-02 14:00 ` Leif Lindholm
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-list from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20180627164746.36188-3-sami.mujawar@arm.com \
--to=devel@edk2.groups.io \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox