summaryrefslogtreecommitdiffstats
path: root/MdePkg/Include
diff options
context:
space:
mode:
authorGua Guo <gua.guo@intel.com>2023-05-11 04:42:57 +0800
committermergify[bot] <37929162+mergify[bot]@users.noreply.github.com>2023-05-11 07:26:38 +0000
commitc6bb7d54beb05ac85a29b38fc0e5d63bf6001840 (patch)
tree48e7b71dc3c479f354c332753004cc9c6fccd1ff /MdePkg/Include
parent782948c1a7314389311f51414bf1940c4cb6b592 (diff)
downloadedk2-c6bb7d54beb05ac85a29b38fc0e5d63bf6001840.tar.gz
edk2-c6bb7d54beb05ac85a29b38fc0e5d63bf6001840.tar.bz2
edk2-c6bb7d54beb05ac85a29b38fc0e5d63bf6001840.zip
MdePkg: Add MipiSysTLib library
REF: https://bugzilla.tianocore.org/show_bug.cgi?id=4144 This Library provides functions consuming MIPI SYS-T submodule. 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>
Diffstat (limited to 'MdePkg/Include')
-rw-r--r--MdePkg/Include/Library/MipiSysTLib.h66
1 files changed, 66 insertions, 0 deletions
diff --git a/MdePkg/Include/Library/MipiSysTLib.h b/MdePkg/Include/Library/MipiSysTLib.h
new file mode 100644
index 0000000000..4ced1c02cd
--- /dev/null
+++ b/MdePkg/Include/Library/MipiSysTLib.h
@@ -0,0 +1,66 @@
+/** @file
+This header file declares functions consuming MIPI Sys-T submodule.
+
+Copyright (c) 2023, Intel Corporation. All rights reserved.<BR>
+
+SPDX-License-Identifier: BSD-2-Clause-Patent
+
+**/
+
+#ifndef MIPI_SYST_LIB_H_
+#define MIPI_SYST_LIB_H_
+
+/**
+ Invoke initialization function in Mipi Sys-T module to initialize Mipi Sys-T handle.
+
+ @param[in, out] MipiSystHandle A pointer to MIPI_SYST_HANDLE structure.
+
+ @retval RETURN_SUCCESS MIPI_SYST_HANDLE instance was initialized.
+ @retval Other MIPI_SYST_HANDLE instance was not initialized.
+**/
+RETURN_STATUS
+EFIAPI
+InitMipiSystHandle (
+ IN OUT VOID *MipiSystHandle
+ );
+
+/**
+ Invoke write_debug_string function in Mipi Sys-T module.
+
+ @param[in] MipiSystHandle A pointer to MIPI_SYST_HANDLE structure.
+ @param[in] Severity Severity type of input message.
+ @param[in] Len Length of data buffer.
+ @param[in] Str A pointer to data buffer.
+
+ @retval RETURN_SUCCESS Data in buffer was processed.
+ @retval RETURN_ABORTED No data need to be written to Trace Hub.
+ @retval RETURN_INVALID_PARAMETER On entry, MipiSystHandle or Str is a NULL pointer.
+**/
+RETURN_STATUS
+EFIAPI
+MipiSystWriteDebug (
+ IN VOID *MipiSystHandle,
+ IN UINT32 Severity,
+ IN UINT16 Len,
+ IN CONST CHAR8 *Str
+ );
+
+/**
+ Invoke catalog_write_message function in Mipi Sys-T module.
+
+ @param[in] MipiSystHandle A pointer to MIPI_SYST_HANDLE structure.
+ @param[in] Severity Severity type of input message.
+ @param[in] CatId Catalog Id.
+
+ @retval RETURN_SUCCESS Data in buffer was processed.
+ @retval RETURN_INVALID_PARAMETER On entry, MipiSystHandle is a NULL pointer.
+**/
+RETURN_STATUS
+EFIAPI
+MipiSystWriteCatalog (
+ IN VOID *MipiSystHandle,
+ IN UINT32 Severity,
+ IN UINT64 CatId
+ );
+
+#endif // MIPI_SYST_LIB_H_