diff options
| author | Gua Guo <gua.guo@intel.com> | 2023-05-10 10:15:35 +0800 |
|---|---|---|
| committer | mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> | 2023-05-11 07:26:38 +0000 |
| commit | 0f0422cedc752d305d8d12a25b11e1dff4d8ff8b (patch) | |
| tree | 613581c4ff815a4d87a68a3830a26517247a9888 /MdeModulePkg/Library/TraceHubDebugSysTLib/Readme.md | |
| parent | 3d50fdc5c6878b865a4b244430c3f26b77943996 (diff) | |
| download | edk2-0f0422cedc752d305d8d12a25b11e1dff4d8ff8b.tar.gz edk2-0f0422cedc752d305d8d12a25b11e1dff4d8ff8b.tar.bz2 edk2-0f0422cedc752d305d8d12a25b11e1dff4d8ff8b.zip | |
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 <michael.d.kinney@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>
Cc: Jian J Wang <jian.j.wang@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
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 'MdeModulePkg/Library/TraceHubDebugSysTLib/Readme.md')
| -rw-r--r-- | MdeModulePkg/Library/TraceHubDebugSysTLib/Readme.md | 26 |
1 files changed, 26 insertions, 0 deletions
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.
|