boot-block: update README with new feature
Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
Change-Id: Ib9ec6a669ea5c31913ef60d0b2e5e67bfd7caaf2
diff --git a/README.md b/README.md
index 5cc15ef..9de14b2 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,7 @@
* [Event Logs](#event-logs)
* [Application Specific Error YAML](#adding-application-specific-error-yaml)
* [Event Log Extensions](#event-log-extensions)
+* [Boot Fail on Hardware Errors](#boot-fail-on-hardware-errors)
## To Build
```
@@ -562,3 +563,26 @@
* Enabled with --enable-openpower-pel-extension
* Detailed information can be found
[here](extensions/openpower-pels/README.md)
+
+## Boot Fail on Hardware Errors
+
+phosphor-logging supports a setting, which when set, will result in the
+software looking at new phosphor-logging entries being created, and if a
+CALLOUT* is found within the entry, ensuring the system will not power
+on.
+
+The full design for this can be found
+[here](https://github.com/openbmc/docs/blob/master/designs/fail-boot-on-hw-error.md)
+
+To enable this function:
+
+```
+busctl set-property xyz.openbmc_project.Settings /xyz/openbmc_project/logging/settings xyz.openbmc_project.Logging.Settings QuiesceOnHwError b true
+```
+
+To check if an entry is blocking the boot:
+```
+obmcutil listbootblock
+```
+
+Resolve or clear the corresponding entry to allow the system to boot.