MdePkg: Add NULL library of TraceHubDebugSysTLib

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=4144

This Library is NULL library of TraceHubDebugSysTLib.

Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Cc: Zhiguang Liu <zhiguang.liu@intel.com>
Cc: Guo Gua <gua.guo@intel.com>
Cc: Chan Laura <laura.chan@intel.com>
Cc: Prakashan Krishnadas Veliyathuparambil <krishnadas.veliyathuparambil.prakashan@intel.com>
Cc: K N Karthik <karthik.k.n@intel.com>
Signed-off-by: Guo Gua <gua.guo@intel.com>
Reviewed-by: Michael D Kinney <michael.d.kinney@intel.com>
Reviewed-by: K N Karthik <karthik.k.n@intel.com>
Reviewed-by: Chan Laura <laura.chan@intel.com>
Acked-by: Liming Gao <gaoliming@byosoft.com.cn>

diff --git a/MdePkg/Include/Library/TraceHubDebugSysTLib.h b/MdePkg/Include/Library/TraceHubDebugSysTLib.h
new file mode 100644 (file)
index 0000000..7df20e6
--- /dev/null
+++ b/MdePkg/Include/Library/TraceHubDebugSysTLib.h
@@ -0,0 +1,81 @@
+/** @file\r
+This header file declares Trace Hub related top level APIs.\r
+\r
+Copyright (c) 2023, Intel Corporation. All rights reserved.<BR>\r
+\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
+\r
+**/\r
+\r
+#ifndef TRACE_HUB_DEBUG_SYST_LIB_H_\r
+#define TRACE_HUB_DEBUG_SYST_LIB_H_\r
+\r
+typedef enum {\r
+  SeverityNone    = 0,\r
+  SeverityFatal   = 1,\r
+  SeverityError   = 2,\r
+  SeverityWarning = 3,\r
+  SeverityNormal  = 4,\r
+  SeverityUser1   = 5,\r
+  SeverityUser2   = 6,\r
+  SeverityUser3   = 7,\r
+  SeverityMax\r
+} TRACE_HUB_SEVERITY_TYPE;\r
+\r
+/**\r
+  Write debug string to specified Trace Hub MMIO address.\r
+\r
+  @param[in]  SeverityType     Severity type of input message.\r
+  @param[in]  Buffer           A pointer to the data buffer.\r
+  @param[in]  NumberOfBytes    The size of data buffer.\r
+\r
+  @retval RETURN_SUCCESS      Data was written to Trace Hub.\r
+  @retval Other               Failed to output Trace Hub message.\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+TraceHubSysTDebugWrite (\r
+  IN TRACE_HUB_SEVERITY_TYPE  SeverityType,\r
+  IN UINT8                    *Buffer,\r
+  IN UINTN                    NumberOfBytes\r
+  );\r
+\r
+/**\r
+  Write catalog status code message to specified Trace Hub MMIO address.\r
+\r
+  @param[in]  SeverityType     Severity type of input message.\r
+  @param[in]  Id               Catalog ID.\r
+  @param[in]  Guid             Driver Guid.\r
+\r
+  @retval RETURN_SUCCESS      Data was written to Trace Hub.\r
+  @retval Other               Failed to output Trace Hub message.\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+TraceHubSysTWriteCataLog64StatusCode (\r
+  IN TRACE_HUB_SEVERITY_TYPE  SeverityType,\r
+  IN UINT64                   Id,\r
+  IN GUID                     *Guid\r
+  );\r
+\r
+/**\r
+  Write catalog message to specified Trace Hub MMIO address.\r
+\r
+  @param[in]  SeverityType   Severity type of input message.\r
+  @param[in]  Id             Catalog ID.\r
+  @param[in]  NumberOfParams Number of entries in argument list.\r
+  @param[in]  ...            Catalog message parameters.\r
+\r
+  @retval RETURN_SUCCESS      Data was written to Trace Hub.\r
+  @retval Other               Failed to output Trace Hub message.\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+TraceHubSysTWriteCataLog64 (\r
+  IN TRACE_HUB_SEVERITY_TYPE  SeverityType,\r
+  IN UINT64                   Id,\r
+  IN UINTN                    NumberOfParams,\r
+  ...\r
+  );\r
+\r
+#endif // TRACE_HUB_DEBUG_SYST_LIB_H_\r

diff --git a/MdePkg/Library/TraceHubDebugSysTLibNull/TraceHubDebugSysTLibNull.c b/MdePkg/Library/TraceHubDebugSysTLibNull/TraceHubDebugSysTLibNull.c
new file mode 100644 (file)
index 0000000..0bd14d4
--- /dev/null
+++ b/MdePkg/Library/TraceHubDebugSysTLibNull/TraceHubDebugSysTLibNull.c
@@ -0,0 +1,76 @@
+/** @file\r
+Null library of TraceHubDebugSysTLib.\r
+\r
+Copyright (c) 2023, Intel Corporation. All rights reserved.<BR>\r
+\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
+\r
+**/\r
+\r
+#include <Base.h>\r
+#include <Library/TraceHubDebugSysTLib.h>\r
+\r
+/**\r
+  Write debug string to specified Trace Hub MMIO address.\r
+\r
+  @param[in]  SeverityType     Severity type of input message.\r
+  @param[in]  Buffer           A pointer to the data buffer.\r
+  @param[in]  NumberOfBytes    The size of data buffer.\r
+\r
+  @retval RETURN_SUCCESS      Data was written to Trace Hub.\r
+  @retval Other               Failed to output Trace Hub message.\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+TraceHubSysTDebugWrite (\r
+  IN TRACE_HUB_SEVERITY_TYPE  SeverityType,\r
+  IN UINT8                    *Buffer,\r
+  IN UINTN                    NumberOfBytes\r
+  )\r
+{\r
+  return RETURN_UNSUPPORTED;\r
+}\r
+\r
+/**\r
+  Write catalog status code message to specified Trace Hub MMIO address.\r
+\r
+  @param[in]  SeverityType     Severity type of input message.\r
+  @param[in]  Id               Catalog ID.\r
+  @param[in]  Guid             Driver Guid.\r
+\r
+  @retval RETURN_SUCCESS      Data was written to Trace Hub.\r
+  @retval Other               Failed to output Trace Hub message.\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+TraceHubSysTWriteCataLog64StatusCode (\r
+  IN TRACE_HUB_SEVERITY_TYPE  SeverityType,\r
+  IN UINT64                   Id,\r
+  IN GUID                     *Guid\r
+  )\r
+{\r
+  return RETURN_UNSUPPORTED;\r
+}\r
+\r
+/**\r
+  Write catalog message to specified Trace Hub MMIO address.\r
+\r
+  @param[in]  SeverityType   Severity type of input message.\r
+  @param[in]  Id             Catalog ID.\r
+  @param[in]  NumberOfParams Number of entries in argument list.\r
+  @param[in]  ...            Catalog message parameters.\r
+\r
+  @retval RETURN_SUCCESS      Data was written to Trace Hub.\r
+  @retval Other               Failed to output Trace Hub message.\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+TraceHubSysTWriteCataLog64 (\r
+  IN TRACE_HUB_SEVERITY_TYPE  SeverityType,\r
+  IN UINT64                   Id,\r
+  IN UINTN                    NumberOfParams,\r
+  ...\r
+  )\r
+{\r
+  return RETURN_UNSUPPORTED;\r
+}\r

diff --git a/MdePkg/Library/TraceHubDebugSysTLibNull/TraceHubDebugSysTLibNull.inf b/MdePkg/Library/TraceHubDebugSysTLibNull/TraceHubDebugSysTLibNull.inf
new file mode 100644 (file)
index 0000000..ba894fc
--- /dev/null
+++ b/MdePkg/Library/TraceHubDebugSysTLibNull/TraceHubDebugSysTLibNull.inf
@@ -0,0 +1,29 @@
+## @file\r
+#  Null library of TraceHubDebugSysTLib.\r
+#\r
+#  Copyright (c) 2023, Intel Corporation. All rights reserved.<BR>\r
+#\r
+#  SPDX-License-Identifier: BSD-2-Clause-Patent\r
+#\r
+##\r
+\r
+\r
+[Defines]\r
+  INF_VERSION                    = 0x00010005\r
+  BASE_NAME                      = TraceHubDebugSysTLibNull\r
+  FILE_GUID                      = 16196A4E-4196-4AF4-9A6B-F4D2ACC430A8\r
+  MODULE_TYPE                    = BASE\r
+  VERSION_STRING                 = 1.0\r
+  LIBRARY_CLASS                  = TraceHubDebugSysTLib\r
+\r
+#\r
+# The following information is for reference only and not required by the build tools.\r
+#\r
+# VALID_ARCHITECTURES = IA32 X64\r
+#\r
+\r
+[Packages]\r
+  MdePkg/MdePkg.dec\r
+\r
+[Sources]\r
+  TraceHubDebugSysTLibNull.c\r

diff --git a/MdePkg/MdePkg.dsc b/MdePkg/MdePkg.dsc
index 902a39cffcebad9255d5453a1bb24eec52945d11..c850970b23cab804a0a1c7d7c53474d3c006145e 100644 (file)
--- a/MdePkg/MdePkg.dsc
+++ b/MdePkg/MdePkg.dsc
@@ -185,6 +185,7 @@
   MdePkg/Library/MmUnblockMemoryLib/MmUnblockMemoryLibNull.inf\r
   MdePkg/Library/TdxLib/TdxLib.inf\r
   MdePkg/Library/MipiSysTLib/MipiSysTLib.inf\r
+  MdePkg/Library/TraceHubDebugSysTLibNull/TraceHubDebugSysTLibNull.inf\r
 \r
 [Components.EBC]\r
   MdePkg/Library/BaseIoLibIntrinsic/BaseIoLibIntrinsic.inf\r