Add log retrieval info to readme

microsoft · Nov 9, 2023 · 4dba637 · 4dba637
1 parent a3d53ef
commit 4dba637
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/AdvLoggerPkg/Docs/ReadMe.md b/AdvLoggerPkg/Docs/ReadMe.md
@@ -242,6 +242,15 @@ and the follow change is needed in the .fdf:
   INF AdvLoggerPkg/AdvancedFileLogger/AdvancedFileLogger.inf
 ```
 
+## Advanced Logger Retrieval From Windows
+
+The Advanced Logger can be retrieved from Windows using the [DecodeUefiLog](../Application/DecodeUefiLog/README.md)
+python utility. The utility runs under windows and retrieves the log through the `AdvLoggerAccessLib` instance
+provided by the platform.
+
+If reading of the log fails, please verify that the `AdvLoggerAccessLib` instance in the platform is either the
+`AdvLoggerMmAccessLib` or the `AdvLoggerSmmAccessLib` and not the NULL instance provided by MdeModulePkg.
+
 ## Hardware Logging Level
 
 The v3 data header supports a new field of hardware debugging level to support setting the serial print configurable