summaryrefslogtreecommitdiffstats
path: root/src/usr/secureboot/common/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/usr/secureboot/common/README.md')
-rw-r--r--src/usr/secureboot/common/README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/src/usr/secureboot/common/README.md b/src/usr/secureboot/common/README.md
new file mode 100644
index 000000000..56ff15953
--- /dev/null
+++ b/src/usr/secureboot/common/README.md
@@ -0,0 +1,33 @@
+# **'common'** Secureboot Services in Hostboot
+This directory implements utility functions for tracing and error logging
+ that other secureboot modules in the peer directories can use.
+For example, the secureboot_base, secureboot_rt (runtime), secureboot_trusted,
+secureboot_ext, and node_comm modules use these functions.
+
+## Files
+
+* __common.mk__
+ * Makefile that other makefiles can call to include the generated .o files
+
+* __containerheader.C__
+ * Implements the ContainerHeader class's member functions
+ * Functions are defined in
+ [containerheader.H](../../../include/usr/secureboot/containerheader.H)
+
+* __errlud_secure.C, errlud_secure.H__
+ * These files define and implement custom error log user detail sections to
+ capture security information on the system
+
+* __[README.md](./README.md)__
+ * This file
+
+* __securetrace.C, securetrace.H__
+ * Defines and implements standard Hostboot trace descriptors for the
+ secureboot component
+
+## sub-directories
+* __plugins__
+ * Standard Hostboot 'plugins' directory where the errorlog parser finds the
+ information to properly parse the custom error log user detail sections
+ defined in errlud_secure.H
+
OpenPOWER on IntegriCloud