diff options
| author | Wei6 Xu <wei6.xu@intel.com> | 2024-05-21 10:45:17 +0800 |
|---|---|---|
| committer | mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> | 2024-07-07 10:12:36 +0000 |
| commit | 19bcc73213ba1cb280b6e455dea7e153217d579c (patch) | |
| tree | e1979692189945e2a6e0562e589ebd8c3f7164b4 | |
| parent | d5fad2176cb14283922e07ff1758118d16b17383 (diff) | |
| download | edk2-19bcc73213ba1cb280b6e455dea7e153217d579c.tar.gz edk2-19bcc73213ba1cb280b6e455dea7e153217d579c.tar.bz2 edk2-19bcc73213ba1cb280b6e455dea7e153217d579c.zip | |
MdeModulePkg: Add HobPrintLib header file
Interface PrintHobList() is added to dump all HOBs info in the HobList.
Caller could specify a custom HOB print handler to replace the default
print handler when calling the interface.
Cc: Ray Ni <ray.ni@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Signed-off-by: Wei6 Xu <wei6.xu@intel.com>
| -rw-r--r-- | MdeModulePkg/Include/Library/HobPrintLib.h | 46 | ||||
| -rw-r--r-- | MdeModulePkg/MdeModulePkg.dec | 4 |
2 files changed, 50 insertions, 0 deletions
diff --git a/MdeModulePkg/Include/Library/HobPrintLib.h b/MdeModulePkg/Include/Library/HobPrintLib.h new file mode 100644 index 0000000000..40bb035b91 --- /dev/null +++ b/MdeModulePkg/Include/Library/HobPrintLib.h @@ -0,0 +1,46 @@ +/** @file
+ The library to print all the HOBs.
+
+ Copyright (c) 2024, Intel Corporation. All rights reserved.<BR>
+ SPDX-License-Identifier: BSD-2-Clause-Patent
+
+**/
+
+#ifndef HOB_PRINT_LIB_H_
+#define HOB_PRINT_LIB_H_
+
+/**
+ HOB Print Handler to print HOB information.
+
+ @param[in] HobStart A pointer to the HOB of type EFI_HOB_TYPE_GUID_EXTENSION.
+ @param[in] HobLength The length in bytes of the HOB of type EFI_HOB_TYPE_GUID_EXTENSION.
+
+ @retval EFI_SUCCESS If it completed successfully.
+ @retval EFI_UNSUPPORTED If the HOB type is not supported.
+
+**/
+typedef
+EFI_STATUS
+(*HOB_PRINT_HANDLER)(
+ IN VOID *Hob,
+ IN UINT16 HobLength
+ );
+
+/**
+ Print all HOBs info from the HOB list.
+ If the input PrintHandler is not NULL, the PrintHandler will be processed first.
+ If PrintHandler returns EFI_SUCCESS, default HOB info print logic in PrintHobList
+ will be skipped.
+
+ @param[in] HobStart A pointer to the HOB list.
+ @param[in] PrintHandler A custom handler to print HOB info.
+
+**/
+VOID
+EFIAPI
+PrintHobList (
+ IN CONST VOID *HobStart,
+ IN HOB_PRINT_HANDLER PrintHandler OPTIONAL
+ );
+
+#endif
diff --git a/MdeModulePkg/MdeModulePkg.dec b/MdeModulePkg/MdeModulePkg.dec index 6148025085..e6e0139fdc 100644 --- a/MdeModulePkg/MdeModulePkg.dec +++ b/MdeModulePkg/MdeModulePkg.dec @@ -174,6 +174,10 @@ #
SpiHcPlatformLib|Include/Library/SpiHcPlatformLib.h
+ ## @libraryclass Provides services to prints all HOB information.
+ #
+ HobPrintLib|Include/Library/HobPrintLib.h
+
[Guids]
## MdeModule package token space guid
# Include/Guid/MdeModulePkgTokenSpace.h
|