From 0f0422cedc752d305d8d12a25b11e1dff4d8ff8b Mon Sep 17 00:00:00 2001 From: Gua Guo Date: Wed, 10 May 2023 10:15:35 +0800 Subject: MdeModulePkg: Add TraceHubDebugSysTLib library REF: https://bugzilla.tianocore.org/show_bug.cgi?id=4144 This Library provides API to dump Trace Hub message. Cc: Michael D Kinney Cc: Guo Gua Cc: Chan Laura Cc: Prakashan Krishnadas Veliyathuparambil Cc: K N Karthik Cc: Jian J Wang Cc: Liming Gao Signed-off-by: Guo Gua Reviewed-by: Michael D Kinney Reviewed-by: K N Karthik Reviewed-by: Chan Laura Acked-by: Liming Gao --- .../Library/TraceHubDebugSysTLib/Readme.md | 26 ++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 MdeModulePkg/Library/TraceHubDebugSysTLib/Readme.md (limited to 'MdeModulePkg/Library/TraceHubDebugSysTLib/Readme.md') diff --git a/MdeModulePkg/Library/TraceHubDebugSysTLib/Readme.md b/MdeModulePkg/Library/TraceHubDebugSysTLib/Readme.md new file mode 100644 index 0000000000..9e798a41bf --- /dev/null +++ b/MdeModulePkg/Library/TraceHubDebugSysTLib/Readme.md @@ -0,0 +1,26 @@ +## Introduction of TrcaceHubDebugSysTLib ## +TrcaceHubDebugSysTLib library is a top level library for dumping Trace Hub messages. +It provides Trace Hub related APIs to dump Trace Hub message via MIPI SYS-T submodule. +User need to properly configure following Trace Hub related PCDs and HOB. + (See MdeModulePkg.dec to get detailed definition for PCDs below) + - PcdTraceHubDebugLevel + - PcdEnableTraceHubDebugMsg + - PcdTraceHubDebugMmioAddress + (See TraceHubDebugInfoHob.h to get detailed definition for HOB below) + - gTraceHubDebugInfoHobGuid + +## BaseTraceHubDebugSysTLib.inf ## +System prints Trace Hub message in SEC/PEI/DXE/SMM based on fixed PCDs. +Only support single Trace Hub debug instance. + +## PeiTraceHubDebugSysTLib.inf ## +System prints Trace Hub message in PEI based on fixed PCDs and HOB. +System applies Trace Hub HOB once it detect gTraceHubDebugInfoHobGuid HOB. +Trace Hub PCDs will be applied if no HOB exist. + +## DxeSmmTraceHubDebugSysTLib.inf ## +System prints Trace Hub message in DXE/SMM based on fixed PCDs and HOB. +Trace Hub PCDs will be applied if no HOB exist. + +## Note ## +Trace Hub debug library not support DXE_RUNTIME_DRIVER type of module currently. -- cgit v1.2.3