prettier: re-format
Prettier is enabled in openbmc-build-scripts on Markdown, JSON, and YAML
files to have consistent formatting for these file types. Re-run the
formatter on the whole repository.
Change-Id: I6e8d56540a30898369d7f232d900fd74de2e7bd1
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
diff --git a/README.md b/README.md
index 7c162ce..c8da8d7 100644
--- a/README.md
+++ b/README.md
@@ -1,81 +1,91 @@
# phosphor-logging
+
The phosphor logging repository provides mechanisms for event and journal
logging.
## Table Of Contents
-* [Building](#to-build)
-* [Structured Logging](#structured-logging)
-* [Event Logs](#event-logs)
-* [Application Specific Error YAML](#adding-application-specific-error-yaml)
-* [Event Log Extensions](#event-log-extensions)
-* [Remote Logging](#remote-logging-via-rsyslog)
-* [Boot Fail on Hardware Errors](#boot-fail-on-hardware-errors)
+
+- [Building](#to-build)
+- [Structured Logging](#structured-logging)
+- [Event Logs](#event-logs)
+- [Application Specific Error YAML](#adding-application-specific-error-yaml)
+- [Event Log Extensions](#event-log-extensions)
+- [Remote Logging](#remote-logging-via-rsyslog)
+- [Boot Fail on Hardware Errors](#boot-fail-on-hardware-errors)
## To Build
+
To build this package, do the following steps:
1. meson builddir
2. ninja -c builddir
## Structured Logging
-phosphor-logging provides APIs to add program logging information to the
-systemd-journal and it is preferred that this logging data is formatted in
-a structured manner (using the facilities provided by the APIs).
-See [Structured Logging](./docs/structured-logging.md) for more details on
-this API.
+phosphor-logging provides APIs to add program logging information to the
+systemd-journal and it is preferred that this logging data is formatted in a
+structured manner (using the facilities provided by the APIs).
+
+See [Structured Logging](./docs/structured-logging.md) for more details on this
+API.
## Event Logs
+
OpenBMC event logs are a collection of D-Bus interfaces owned by
phosphor-log-manager that reside at `/xyz/openbmc_project/logging/entry/X`,
where X starts at 1 and is incremented for each new log.
The interfaces are:
-* [xyz.openbmc_project.Logging.Entry]
- * The main event log interface.
-* [xyz.openbmc_project.Association.Definitions]
- * Used for specifying inventory items as the cause of the event.
- * For more information on associations, see [here][associations-doc].
-* [xyz.openbmc_project.Object.Delete]
- * Provides a Delete method to delete the event.
-* [xyz.openbmc_project.Software.Version]
- * Stores the code version that the error occurred on.
-On platforms that make use of these event logs, the intent is that they are
-the common event log representation that other types of event logs can be
-created from. For example, there is code to convert these into both Redfish
-and IPMI event logs, in addition to the event log extensions mentioned
+- [xyz.openbmc_project.Logging.Entry]
+ - The main event log interface.
+- [xyz.openbmc_project.Association.Definitions]
+ - Used for specifying inventory items as the cause of the event.
+ - For more information on associations, see [here][associations-doc].
+- [xyz.openbmc_project.Object.Delete]
+ - Provides a Delete method to delete the event.
+- [xyz.openbmc_project.Software.Version]
+ - Stores the code version that the error occurred on.
+
+On platforms that make use of these event logs, the intent is that they are the
+common event log representation that other types of event logs can be created
+from. For example, there is code to convert these into both Redfish and IPMI
+event logs, in addition to the event log extensions mentioned
[below](#event-log-extensions).
-The logging daemon has the ability to add `callout` associations to an event
-log based on text in the AdditionalData property. A callout is a link to the
+The logging daemon has the ability to add `callout` associations to an event log
+based on text in the AdditionalData property. A callout is a link to the
inventory item(s) that were the cause of the event log. See [here][callout-doc]
for details.
### Creating Event Logs In Code
-There are two approaches to creating event logs in OpenBMC code. The first
-makes use of the systemd journal to store metadata needed for the log, and the
-second is a plain D-Bus method call.
+
+There are two approaches to creating event logs in OpenBMC code. The first makes
+use of the systemd journal to store metadata needed for the log, and the second
+is a plain D-Bus method call.
#### Journal Based Event Log Creation
+
Event logs can be created by using phosphor-logging APIs to commit sdbusplus
-exceptions. These APIs write to the journal, and then call a `Commit`
-D-Bus method on the logging daemon to create the event log using the information
-it put in the journal.
+exceptions. These APIs write to the journal, and then call a `Commit` D-Bus
+method on the logging daemon to create the event log using the information it
+put in the journal.
The APIs are found in `<phosphor-logging/elog.hpp>`:
-* `elog()`: Throw an sdbusplus error.
-* `commit()`: Catch an error thrown by elog(), and commit it to create the
- event log.
-* `report()`: Create an event log from an sdbusplus error without throwing the
+
+- `elog()`: Throw an sdbusplus error.
+- `commit()`: Catch an error thrown by elog(), and commit it to create the event
+ log.
+- `report()`: Create an event log from an sdbusplus error without throwing the
exception first.
-Any errors passed into these APIs must be known to phosphor-logging, usually
-by being defined in `<phosphor-logging/elog-errors.hpp>`. The errors must
-also be known by sdbusplus, and be defined in their corresponding error.hpp.
-See below for details on how get errors into these headers.
+Any errors passed into these APIs must be known to phosphor-logging, usually by
+being defined in `<phosphor-logging/elog-errors.hpp>`. The errors must also be
+known by sdbusplus, and be defined in their corresponding error.hpp. See below
+for details on how get errors into these headers.
Example:
+
```
#include <phosphor-logging/elog-errors.hpp>
#include <phosphor-logging/elog.hpp>
@@ -90,7 +100,9 @@
}
```
+
Alternatively, to throw, catch, and then commit the error:
+
```
try
{
@@ -104,13 +116,14 @@
Metadata can be added to event logs to add debug data captured at the time of
the event. It shows up in the AdditionalData property in the
-`xyz.openbmc_project.Logging.Entry` interface. Metadata is passed in via the
+`xyz.openbmc_project.Logging.Entry` interface. Metadata is passed in via the
`elog()` or `report()` functions, which write it to the journal. The metadata
must be predefined for the error in the [metadata YAML](#event-log-definition)
-so that the daemon knows to look for it in the journal when it creates the
-event log.
+so that the daemon knows to look for it in the journal when it creates the event
+log.
Example:
+
```
#include <phosphor-logging/elog-errors.hpp>
#include <phosphor-logging/elog.hpp>
@@ -127,138 +140,158 @@
metadata::CALLOUT_DEVICE_PATH("some path"));
}
```
+
In the above example, the AdditionalData property would look like:
+
```
["CALLOUT_ERRNO=5", "CALLOUT_DEVICE_PATH=some path"]
```
+
Note that the metadata fields must be all uppercase.
##### Event Log Definition
+
As mentioned above, both sdbusplus and phosphor-logging must know about the
event logs in their header files, or the code that uses them will not even
-compile. The standard way to do this to define the event in the appropriate
+compile. The standard way to do this to define the event in the appropriate
`<error-category>.errors.yaml` file, and define any metadata in the
`<error-category>.metadata.yaml` file in the appropriate `*-dbus-interfaces`
-repository. During the build, phosphor-logging generates the elog-errors.hpp
+repository. During the build, phosphor-logging generates the elog-errors.hpp
file for use by the calling code.
In much the same way, sdbusplus uses the event log definitions to generate an
-error.hpp file that contains the specific exception. The path of the error.hpp
+error.hpp file that contains the specific exception. The path of the error.hpp
matches the path of the YAML file.
For example, if in phosphor-dbus-interfaces there is
-`xyz/openbmc_project/Control/Device.errors.yaml`, the errors that come from
-that file will be in the include:
-`xyz/openbmc_project/Control/Device/error.hpp`.
+`xyz/openbmc_project/Control/Device.errors.yaml`, the errors that come from that
+file will be in the include: `xyz/openbmc_project/Control/Device/error.hpp`.
In rare cases, one may want one to define their errors in the same repository
-that uses them. To do that, one must:
+that uses them. To do that, one must:
1. Add the error and metadata YAML files to the repository.
2. Run the sdbus++ script within the makefile to create the error.hpp and .cpp
files from the local YAML, and include the error.cpp file in the application
- that uses it. See [openpower-occ-control] for an example.
-3. Tell phosphor-logging about the error. This is done by either:
- * Following the [directions](#adding-application-specific-error-yaml)
- defined in this README, or
- * Running the script yourself:
- 1. Run phosphor-logging\'s `elog-gen.py` script on the local yaml to
- generate an elog-errors.hpp file that just contains the local errors,
- and check that into the repository and include it where the errors are
- needed.
- 2. Create a recipe that copies the local YAML files to a place that
- phosphor-logging can find it during the build. See [here][led-link]
- for an example.
+ that uses it. See [openpower-occ-control] for an example.
+3. Tell phosphor-logging about the error. This is done by either:
+ - Following the [directions](#adding-application-specific-error-yaml) defined
+ in this README, or
+ - Running the script yourself:
+ 1. Run phosphor-logging\'s `elog-gen.py` script on the local yaml to generate
+ an elog-errors.hpp file that just contains the local errors, and check
+ that into the repository and include it where the errors are needed.
+ 2. Create a recipe that copies the local YAML files to a place that
+ phosphor-logging can find it during the build. See [here][led-link] for an
+ example.
#### D-Bus Event Log Creation
+
There is also a [D-Bus method][log-create-link] to create event logs:
-* Service: xyz.openbmc_project.Logging
-* Object Path: /xyz/openbmc_project/logging
-* Interface: xyz.openbmc_project.Logging.Create
-* Method: Create
- * Method Arguments:
- * Message: The `Message` string property for the
- `xyz.openbmc_project.Logging.Entry` interface.
- * Severity: The `severity` property for the
- `xyz.openbmc_project.Logging.Entry` interface.
- An `xyz.openbmc_project.Logging.Entry.Level` enum value.
- * AdditionalData: The `AdditionalData` property for the
- `xyz.openbmc_project.Logging.Entry` interface, but in a map
- instead of in a vector of "KEY=VALUE" strings.
- Example:
+
+- Service: xyz.openbmc_project.Logging
+- Object Path: /xyz/openbmc_project/logging
+- Interface: xyz.openbmc_project.Logging.Create
+- Method: Create
+ - Method Arguments:
+ - Message: The `Message` string property for the
+ `xyz.openbmc_project.Logging.Entry` interface.
+ - Severity: The `severity` property for the
+ `xyz.openbmc_project.Logging.Entry` interface. An
+ `xyz.openbmc_project.Logging.Entry.Level` enum value.
+ - AdditionalData: The `AdditionalData` property for the
+ `xyz.openbmc_project.Logging.Entry` interface, but in a map instead of in
+ a vector of "KEY=VALUE" strings. Example:
+
```
std::map<std::string, std::string> additionalData;
additionalData["KEY"] = "VALUE";
```
-
-Unlike the previous APIs where errors could also act as exceptions that could
-be thrown across D-Bus, this API does not require that the error be defined in
-the error YAML in the D-Bus interfaces repository so that sdbusplus knows about
-it. Additionally, as this method passes in everything needed to create the
-event log, the logging daemon doesn't have to know about it ahead of time
-either.
+Unlike the previous APIs where errors could also act as exceptions that could be
+thrown across D-Bus, this API does not require that the error be defined in the
+error YAML in the D-Bus interfaces repository so that sdbusplus knows about it.
+Additionally, as this method passes in everything needed to create the event
+log, the logging daemon doesn't have to know about it ahead of time either.
That being said, it is recommended that users of this API still follow some
-guidelines for the message field, which is normally generated from a
-combination of the path to the error YAML file and the error name itself. For
-example, the `Timeout` error in `xyz/openbmc_project/Common.errors.yaml` will
-have a Message property of `xyz.openbmc_project.Common.Error.Timeout`.
+guidelines for the message field, which is normally generated from a combination
+of the path to the error YAML file and the error name itself. For example, the
+`Timeout` error in `xyz/openbmc_project/Common.errors.yaml` will have a Message
+property of `xyz.openbmc_project.Common.Error.Timeout`.
The guidelines are:
+
1. When it makes sense, one can still use an existing error that has already
been defined in an error YAML file, and use the same severity and metadata
(AdditionalData) as in the corresponding metadata YAML file.
2. If creating a new error, use the same naming scheme as other errors, which
starts with the domain, `xyz.openbmc_project`, `org.open_power`, etc,
- followed by the capitalized category values, followed by `Error`, followed
- by the capitalized error name itself, with everything separated by "."s.
- For example: `xyz.openbmc_project.Some.Category.Error.Name`.
+ followed by the capitalized category values, followed by `Error`, followed by
+ the capitalized error name itself, with everything separated by "."s. For
+ example: `xyz.openbmc_project.Some.Category.Error.Name`.
3. If creating a new common error, still add it to the appropriate error and
metadata YAML files in the appropriate D-Bus interfaces repository so that
- others can know about it and use it in the future. This can be done after
- the fact.
+ others can know about it and use it in the future. This can be done after the
+ fact.
-[xyz.openbmc_project.Logging.Entry]: https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/yaml/xyz/openbmc_project/Logging/Entry.interface.yaml
-[xyz.openbmc_project.Association.Definitions]: https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/yaml/xyz/openbmc_project/Association/Definitions.interface.yaml
-[associations-doc]: https://github.com/openbmc/docs/blob/master/architecture/object-mapper.md#associations
-[callout-doc]: https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/yaml/xyz/openbmc_project/Common/Callout/README.md
-[xyz.openbmc_project.Object.Delete]: https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/yaml/xyz/openbmc_project/Object/Delete.interface.yaml
-[xyz.openbmc_project.Software.Version]: https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/yaml/xyz/openbmc_project/Software/Version.errors.yaml
-[elog-errors.hpp]: https://github.com/openbmc/phosphor-logging/blob/master/phosphor-logging/elog.hpp
+[xyz.openbmc_project.logging.entry]:
+ https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/yaml/xyz/openbmc_project/Logging/Entry.interface.yaml
+[xyz.openbmc_project.association.definitions]:
+ https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/yaml/xyz/openbmc_project/Association/Definitions.interface.yaml
+[associations-doc]:
+ https://github.com/openbmc/docs/blob/master/architecture/object-mapper.md#associations
+[callout-doc]:
+ https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/yaml/xyz/openbmc_project/Common/Callout/README.md
+[xyz.openbmc_project.object.delete]:
+ https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/yaml/xyz/openbmc_project/Object/Delete.interface.yaml
+[xyz.openbmc_project.software.version]:
+ https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/yaml/xyz/openbmc_project/Software/Version.errors.yaml
+[elog-errors.hpp]:
+ https://github.com/openbmc/phosphor-logging/blob/master/phosphor-logging/elog.hpp
[openpower-occ-control]: https://github.com/openbmc/openpower-occ-control
-[led-link]: https://github.com/openbmc/openbmc/tree/master/meta-phosphor/recipes-phosphor/leds
-[log-create-link]: https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/yaml/xyz/openbmc_project/Logging/Create.interface.yaml
+[led-link]:
+ https://github.com/openbmc/openbmc/tree/master/meta-phosphor/recipes-phosphor/leds
+[log-create-link]:
+ https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/yaml/xyz/openbmc_project/Logging/Create.interface.yaml
## Adding application specific error YAML
-* This document captures steps for adding application specific error YAML files
+
+- This document captures steps for adding application specific error YAML files
and generating local elog-errors.hpp header file for application use.
-* Should cater for continuous integration (CI) build, bitbake image build, and
+- Should cater for continuous integration (CI) build, bitbake image build, and
local repository build.
#### Continuous Integration (CI) build
- * Make is called on the repository that is modified.
- * Dependent packages are pulled based on the dependency list specified in the
- configure.ac script.
+
+- Make is called on the repository that is modified.
+- Dependent packages are pulled based on the dependency list specified in the
+ configure.ac script.
#### Recipe build
- * Native recipes copy error YAML files to shared location.
- * phosphor-logging builds elog-errors.hpp by parsing the error YAML files from
- the shared location.
+
+- Native recipes copy error YAML files to shared location.
+- phosphor-logging builds elog-errors.hpp by parsing the error YAML files from
+ the shared location.
#### Local repository build
- * Copies local error YAML files to the shared location in SDK
- * Make generates elog-errors.hpp by parsing the error YAML files from the
- shared location.
+
+- Copies local error YAML files to the shared location in SDK
+- Make generates elog-errors.hpp by parsing the error YAML files from the shared
+ location.
#### Makefile changes
+
**Reference**
- * https://github.com/openbmc/openpower-debug-collector/blob/master/Makefile.am
+
+- https://github.com/openbmc/openpower-debug-collector/blob/master/Makefile.am
###### Export error YAML to shared location
-*Modify Makefile.am to export newly added error YAML to shared location*
+
+_Modify Makefile.am to export newly added error YAML to shared location_
+
```
yamldir = ${datadir}/phosphor-dbus-yaml/yaml
nobase_yaml_DATA = \
@@ -266,10 +299,12 @@
```
###### Generate elog-errors.hpp using elog parser from SDK location
- * Add a conditional check "GEN_ERRORS"
- * Disable the check for recipe bitbake image build
- * Enable it for local repository build
- * If "GEN_ERRORS" is enabled, build generates elog-errors.hpp header file.
+
+- Add a conditional check "GEN_ERRORS"
+- Disable the check for recipe bitbake image build
+- Enable it for local repository build
+- If "GEN_ERRORS" is enabled, build generates elog-errors.hpp header file.
+
```
# Generate phosphor-logging/elog-errors.hpp
if GEN_ERRORS
@@ -290,9 +325,11 @@
```
###### Update BUILT_SOURCES
- * Append elog-errors.hpp to BUILT_SOURCES list and put it in conditional check
- GEN_ERRORS so that the elog-errors.hpp is generated only during local
- repository build.
+
+- Append elog-errors.hpp to BUILT_SOURCES list and put it in conditional check
+ GEN_ERRORS so that the elog-errors.hpp is generated only during local
+ repository build.
+
```
if GEN_ERRORS
nobase_nodist_include_HEADERS += \
@@ -304,27 +341,33 @@
```
###### Conditional check for native build
- * As the same Makefile is used both for recipe image build and native recipe
- build, add a conditional to ensure that only installation of error yaml files
- happens during native build. It is not required to build repository during
- native build.
+
+- As the same Makefile is used both for recipe image build and native recipe
+ build, add a conditional to ensure that only installation of error yaml files
+ happens during native build. It is not required to build repository during
+ native build.
+
```
if !INSTALL_ERROR_YAML
endif
```
#### Autotools changes
+
**Reference**
- * https://github.com/openbmc/openpower-debug-collector/blob/master/configure.ac
+
+- https://github.com/openbmc/openpower-debug-collector/blob/master/configure.ac
###### Add option(argument) to enable/disable installing error yaml file
- * Install error yaml option(argument) is enabled for native recipe build
- and disabled for bitbake build.
- * When install error yaml option is disabled do not check for target specific
- packages in autotools configure script.
+- Install error yaml option(argument) is enabled for native recipe build and
+ disabled for bitbake build.
+
+- When install error yaml option is disabled do not check for target specific
+ packages in autotools configure script.
###### Add option(argument) to install error yaml files
+
```
AC_ARG_ENABLE([install_error_yaml],
AS_HELP_STRING([--enable-install_error_yaml],
@@ -338,6 +381,7 @@
```
###### Add option(argument) to enable/disable generating elog-errors header file
+
```
AC_ARG_ENABLE([gen_errors],
AS_HELP_STRING([--enable-gen_errors], [Enable elog-errors.hpp generation ]),
@@ -346,34 +390,44 @@
```
#### Recipe changes
+
**Reference**
-* https://github.com/openbmc/openbmc/blob/master/meta-openbmc-machines\
-/meta-openpower/common/recipes-phosphor/debug/openpower-debug-collector.bb
+
+- https://github.com/openbmc/openbmc/blob/master/meta-openbmc-machines\
+ /meta-openpower/common/recipes-phosphor/debug/openpower-debug-collector.bb
###### Extend recipe for native and nativesdk
-* Extend the recipe for native and native SDK builds
+
+- Extend the recipe for native and native SDK builds
+
```
BBCLASSEXTEND += "native nativesdk"
```
+
###### Remove dependencies for native and native SDK build
-* Native recipe caters only for copying error yaml files to shared location.
-* For native and native SDK build remove dependency on packages that recipe
+
+- Native recipe caters only for copying error yaml files to shared location.
+- For native and native SDK build remove dependency on packages that recipe
build depends
###### Remove dependency on phosphor-logging for native build
+
```
DEPENDS_remove_class-native = "phosphor-logging"
```
###### Remove dependency on phosphor-logging for native SDK build
+
```
DEPENDS_remove_class-nativesdk = "phosphor-logging"
```
###### Add install_error_yaml argument during native build
-* Add package config to enable/disable install_error_yaml feature.
+
+- Add package config to enable/disable install_error_yaml feature.
###### Add package config to enable/disable install_error_yaml feature
+
```
PACKAGECONFIG ??= "install_error_yaml"
PACKAGECONFIG[install_error_yaml] = " \
@@ -381,65 +435,74 @@
--disable-install_error_yaml, ,\
"
```
+
###### Enable install_error_yaml check for native build
+
```
PACKAGECONFIG_add_class-native = "install_error_yaml"
PACKAGECONFIG_add_class-nativesdk = "install_error_yaml"
```
+
###### Disable install_error_yaml during target build
+
```
PACKAGECONFIG_remove_class-target = "install_error_yaml"
```
###### Disable generating elog-errors.hpp for bitbake build
-* Disable gen_errors argument for bitbake image build as the application uses
+
+- Disable gen_errors argument for bitbake image build as the application uses
the elog-errors.hpp generated by phosphor-logging
-* Argument is enabled by default for local repository build in the configure
+- Argument is enabled by default for local repository build in the configure
script of the local repository.
+
```
XTRA_OECONF += "--disable-gen_errors"
```
#### Local build
-* During local build use --prefix=/usr for the configure script.
+
+- During local build use --prefix=/usr for the configure script.
**Reference**
-* https://github.com/openbmc/openpower-debug-collector/blob/master/README.md
+
+- https://github.com/openbmc/openpower-debug-collector/blob/master/README.md
## Event Log Extensions
-The extension concept is a way to allow code that creates other formats of
-error logs besides phosphor-logging's event logs to still reside in the
+The extension concept is a way to allow code that creates other formats of error
+logs besides phosphor-logging's event logs to still reside in the
phosphor-log-manager application.
-The extension code lives in the `extensions/<extension>` subdirectories,
-and is enabled with a `--enable-<extension>` configure flag. The
-extension code won't compile unless enabled with this flag.
+The extension code lives in the `extensions/<extension>` subdirectories, and is
+enabled with a `--enable-<extension>` configure flag. The extension code won't
+compile unless enabled with this flag.
Extensions can register themselves to have functions called at the following
points using the REGISTER_EXTENSION_FUNCTION macro.
-* On startup
- * Function type void(internal::Manager&)
-* After an event log is created
- * Function type void(args)
- * The args are:
- * const std::string& - The Message property
- * uin32_t - The event log ID
- * uint64_t - The event log timestamp
- * Level - The event level
- * const AdditionalDataArg& - the additional data
- * const AssociationEndpointsArg& - Association endpoints (callouts)
-* Before an event log is deleted, to check if it is allowed.
- * Function type void(std::uint32_t, bool&) that takes the event ID
-* After an event log is deleted
- * Function type void(std::uint32_t) that takes the event ID
+
+- On startup
+ - Function type void(internal::Manager&)
+- After an event log is created
+ - Function type void(args)
+ - The args are:
+ - const std::string& - The Message property
+ - uin32_t - The event log ID
+ - uint64_t - The event log timestamp
+ - Level - The event level
+ - const AdditionalDataArg& - the additional data
+ - const AssociationEndpointsArg& - Association endpoints (callouts)
+- Before an event log is deleted, to check if it is allowed.
+ - Function type void(std::uint32_t, bool&) that takes the event ID
+- After an event log is deleted
+ - Function type void(std::uint32_t) that takes the event ID
Using these callback points, they can create their own event log for each
OpenBMC event log that is created, and delete these logs when the corresponding
OpenBMC event log is deleted.
-In addition, an extension has the option of disabling phosphor-logging's
-default error log capping policy so that it can use its own. The macro
+In addition, an extension has the option of disabling phosphor-logging's default
+error log capping policy so that it can use its own. The macro
DISABLE_LOG_ENTRY_CAPS() is used for that.
### Motivation
@@ -448,13 +511,15 @@
daemon as opposed to just creating new daemons that listen for D-Bus signals is
to allow interactions that would be complicated or expensive if just done over
D-Bus, such as:
-* Allowing for custom old log retention algorithms.
-* Prohibiting manual deleting of certain logs based on an extension's
+
+- Allowing for custom old log retention algorithms.
+- Prohibiting manual deleting of certain logs based on an extension's
requirements.
### Creating extensions
1. Add a new flag to configure.ac to enable the extension:
+
```
AC_ARG_ENABLE([foo-extension],
AS_HELP_STRING([--enable-foo-extension],
@@ -462,20 +527,26 @@
AM_CONDITIONAL([ENABLE_FOO_EXTENSION],
[test "x$enable_foo_extension" == "xyes"])
```
+
2. Add the code in `extensions/<extension>/`.
3. Create a makefile include to add the new code to phosphor-log-manager:
+
```
phosphor_log_manager_SOURCES += \
extensions/foo/foo.cpp
```
+
4. In `extensions/extensions.mk`, add the makefile include:
+
```
if ENABLE_FOO_EXTENSION
include extensions/foo/foo.mk
endif
```
+
5. In the extension code, register the functions to call and optionally disable
log capping using the provided macros:
+
```
DISABLE_LOG_ENTRY_CAPS();
@@ -502,27 +573,30 @@
REGISTER_EXTENSION_FUNCTION(fooRemove);
```
+
### Extension List
The supported extensions are:
-* OpenPower PELs
- * Enabled with --enable-openpower-pel-extension
- * Detailed information can be found
- [here](extensions/openpower-pels/README.md)
+- OpenPower PELs
+ - Enabled with --enable-openpower-pel-extension
+ - Detailed information can be found
+ [here](extensions/openpower-pels/README.md)
## Remote Logging via Rsyslog
-The BMC has the ability to stream out local logs (that go to the systemd journal)
-via rsyslog (https://www.rsyslog.com/).
-The BMC will send everything. Any kind of filtering and appropriate storage
-will have to be managed on the rsyslog server. Various examples are available
-on the internet. Here are few pointers :
+The BMC has the ability to stream out local logs (that go to the systemd
+journal) via rsyslog (https://www.rsyslog.com/).
+
+The BMC will send everything. Any kind of filtering and appropriate storage will
+have to be managed on the rsyslog server. Various examples are available on the
+internet. Here are few pointers :
https://www.rsyslog.com/storing-and-forwarding-remote-messages/
https://www.rsyslog.com/doc/rsyslog%255Fconf%255Ffilter.html
https://www.thegeekdiary.com/understanding-rsyslog-filter-options/
#### Configuring rsyslog server for remote logging
+
The BMC is an rsyslog client. To stream out logs, it needs to talk to an rsyslog
server, to which there's connectivity over a network. REST API can be used to
set the remote server's IP address and port number.
@@ -531,6 +605,7 @@
https://github.com/openbmc/docs/blob/master/rest-api.md).
Set the IP:
+
```
curl -b cjar -k -H "Content-Type: application/json" -X PUT \
-d '{"data": <IP address>}' \
@@ -538,6 +613,7 @@
```
Set the port:
+
```
curl -b cjar -k -H "Content-Type: application/json" -X PUT \
-d '{"data": <port number>}' \
@@ -545,15 +621,18 @@
```
#### Querying the current configuration
+
```
curl -b cjar -k \
https://<BMC IP address>/xyz/openbmc_project/logging/config/remote
```
#### Setting the hostname
+
Rsyslog can store logs separately for each host. For this reason, it's useful to
provide a unique hostname to each managed BMC. Here's how that can be done via a
REST API :
+
```
curl -b cjar -k -H "Content-Type: application/json" -X PUT \
-d '{"data": "myHostName"}' \
@@ -561,20 +640,22 @@
```
#### Disabling remote logging
+
Remote logging can be disabled by writing 0 to the port, or an empty string("")
to the IP.
#### Changing the rsyslog server
+
When switching to a new server from an existing one (i.e the address, or port,
or both change), it is recommended to disable the existing configuration first.
## 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. Entries with severities of Informational or Debug will not block boots,
-even if they have callouts.
+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. Entries with
+severities of Informational or Debug will not block boots, even if they have
+callouts.
The full design for this can be found
[here](https://github.com/openbmc/docs/blob/master/designs/fail-boot-on-hw-error.md)
@@ -586,6 +667,7 @@
```
To check if an entry is blocking the boot:
+
```
obmcutil listbootblock
```
diff --git a/docs/structured-logging.md b/docs/structured-logging.md
index ba1d44c..ea70463 100644
--- a/docs/structured-logging.md
+++ b/docs/structured-logging.md
@@ -2,47 +2,47 @@
There are currently two APIs for structured logging:
[log](../lib/include/phosphor-logging/log.hpp) and
-[lg2](../lib/include/phosphor-logging/lg2.hpp). If your code is C++20 (or
-later) it is preferred to use `lg2`.
+[lg2](../lib/include/phosphor-logging/lg2.hpp). If your code is C++20 (or later)
+it is preferred to use `lg2`.
## Why structured logging?
Structured logging is a method of logging where every variable piece of data is
-tagged with some identifier for the data. This is opposite of unstructured
+tagged with some identifier for the data. This is opposite of unstructured
logging where logged events are free-form strings.
The principal logging daemon in OpenBMC (systemd-journald) natively supports
-structured logging. As a result, there are some designs in place where
-specific structured events are added to the journal and downstream these events
-can be consumed. For example, one implementation of the IPMI SEL utilizes
-specific journal structured data to stored and later retrieve SEL events.
+structured logging. As a result, there are some designs in place where specific
+structured events are added to the journal and downstream these events can be
+consumed. For example, one implementation of the IPMI SEL utilizes specific
+journal structured data to stored and later retrieve SEL events.
Even if an argument might be made against the merits of using the journal as a
-form of IPC, the value of structured logging persists. It is very common as
-part of various failure-analysis operations, either on the part of a system
+form of IPC, the value of structured logging persists. It is very common as part
+of various failure-analysis operations, either on the part of a system
manufacturer or an end-user, to need to interrogate the system logs to determine
-when/where/why a situation degraded. With unstructured logging, the
+when/where/why a situation degraded. With unstructured logging, the
implementation is left chasing message format and data changes, where as with
structured logging the format is somewhat static and easily parsed.
A specific example of where structured logging is beneficial is a service which
gathers `error` or higher log reports and creates issues when a new or unknown
-signature is discovered. If the only information available is an unstructured
+signature is discovered. If the only information available is an unstructured
string, any kind of signature identification requires creating a regular
-expression (likely). With structured log, specific identifiers can be used as
-the error signature while others are ignored. For instance, maybe a specific
+expression (likely). With structured log, specific identifiers can be used as
+the error signature while others are ignored. For instance, maybe a specific
`ERROR_RC` is critical to identifying the scenario but `FILE_PATH` is variable
and ignored.
-For deeper understanding of the OpenBMC logging subsystem, it may be useful
-to read the manpages for `man 1 journalctl` and `man 3 sd_journal_send`.
-Generally accepted log-levels and their definition is historically documented
-in `man 3 syslog`.
+For deeper understanding of the OpenBMC logging subsystem, it may be useful to
+read the manpages for `man 1 journalctl` and `man 3 sd_journal_send`. Generally
+accepted log-levels and their definition is historically documented in
+`man 3 syslog`.
## log
The pre-C++20 logging APIs presented by phosphor-logging are
-`phosphor::logging::log`. The basic format of a log call is:
+`phosphor::logging::log`. The basic format of a log call is:
```
log<level>("A message", entry("TAG0=%s", "value"), entry("TAG1=%x", 2));
@@ -53,9 +53,9 @@
of entries, which are key-value pairs of data.
The 'key' of an entry is an upper-case tag for the data along with a
-printf-style format string for the data. Journald imposes some restrictions on
+printf-style format string for the data. Journald imposes some restrictions on
the tag: it must be all capital letters, numbers, or underscores and must not
-start with an underscore. Unfortunately, if these restrictions are not followed
+start with an underscore. Unfortunately, if these restrictions are not followed
or the printf string is invalid for the data, the code will compile but journald
may silently drop the log request (or pieces of it).
@@ -64,105 +64,104 @@
## lg2
-The post-C++20 logging APIs presented by phosphor-logging are
-`lg2::log`. The basic format of a log call is:
+The post-C++20 logging APIs presented by phosphor-logging are `lg2::log`. The
+basic format of a log call is:
```
lg2::level("A {TAG0} occured.", "TAG0", "foo"s, "TAG1", lg2::hex, 2);
```
Each log call has a level or priority, but the level is indicated by the
-function call name (such as `lg2::debug(...)`). The log call also has a
-free-form message string and any number of entries indicated by 2 or 3
-argument sets:
+function call name (such as `lg2::debug(...)`). The log call also has a
+free-form message string and any number of entries indicated by 2 or 3 argument
+sets:
- key name (with the same `[_A-Z0-9]` requirements imposed by journald).
- [optional] set of format flags
- data value
-The free-form message may also optionally contain brace-wrapped key names,
-for which the message will be dynamically modified to contain the formatted
-value in place of the `{KEY}`. This enables human-friendly message strings
-to be formed without relying on verbose journald output modes.
+The free-form message may also optionally contain brace-wrapped key names, for
+which the message will be dynamically modified to contain the formatted value in
+place of the `{KEY}`. This enables human-friendly message strings to be formed
+without relying on verbose journald output modes.
Note: Since a free-form message with data can be created using the `{KEY}`
-mechanism, no other string formatting libraries are necessary or should be
-used. Avoiding the `{KEY}` feature causes the journal messages to become
-unstructured. Do not use `sstream` or `{fmt}` to format the message!
+mechanism, no other string formatting libraries are necessary or should be used.
+Avoiding the `{KEY}` feature causes the journal messages to become unstructured.
+Do not use `sstream` or `{fmt}` to format the message!
The supported format flags are:
+
- `bin`, `dec`, `hex`
- - The [integer] data should be formatted in the requested manner.
- - Decimal is the default.
- - Examples:
- + `bin, 0xabcd` -> `0b1010101111001101`
- + `hex, 1234` -> `0x4d2`
+ - The [integer] data should be formatted in the requested manner.
+ - Decimal is the default.
+ - Examples:
+ - `bin, 0xabcd` -> `0b1010101111001101`
+ - `hex, 1234` -> `0x4d2`
- `field8`, `field16`, `field32`, `field64`
- - The [integer] data should be padded as if it were a field of
- specified bit-length (useful only for `bin` or `hex` data).
- - Examples:
- + `(bin | field8), 0xff` -> `0b11111111`
- + `(hex | field16), 10` -> `0x000a`
+ - The [integer] data should be padded as if it were a field of specified
+ bit-length (useful only for `bin` or `hex` data).
+ - Examples:
+ - `(bin | field8), 0xff` -> `0b11111111`
+ - `(hex | field16), 10` -> `0x000a`
Format flags can be OR'd together as necessary: `hex | field32`.
-The APIs can handle (and format appropriately) any data of the following
-types: signed or unsigned integers, floating point numbers, booleans, strings
+The APIs can handle (and format appropriately) any data of the following types:
+signed or unsigned integers, floating point numbers, booleans, strings
(C-strings, std::strings, or std::string_views), sdbusplus enums, exceptions,
and pointers.
The APIs also perform compile-time analysis of the arguments to give descriptive
-error messages for incorrect parameters or format flags. Some examples are:
+error messages for incorrect parameters or format flags. Some examples are:
- `(dec | hex)` yields:
- - `error: static assertion failed: Conflicting flags found for value type.`
+ - `error: static assertion failed: Conflicting flags found for value type.`
- `dec` applied to a string yields:
- - `error: static assertion failed: Prohibited flag found for value type.`
+ - `error: static assertion failed: Prohibited flag found for value type.`
- Missing a key yields:
- - `error: static assertion failed: Found value without expected header
- field.`
+ - `error: static assertion failed: Found value without expected header field.`
- Missing data yields:
- - `error: static assertion failed: Found header field without expected
- data.`
+ - `error: static assertion failed: Found header field without expected data.`
- Missing a message yields:
- - `error: use of deleted function ‘lg2::debug<>::debug()’`
+ - `error: use of deleted function ‘lg2::debug<>::debug()’`
### LOG2_FMTMSG key
-The API adds an extra journald key to represent the original message prior
-to `{KEY}` replacement, which is saved with the `LOG2_FMTMSG` key. This
-is done to facilitate searching the journal with a known fixed version of
-the message (prior to the dynamic replacement).
+The API adds an extra journald key to represent the original message prior to
+`{KEY}` replacement, which is saved with the `LOG2_FMTMSG` key. This is done to
+facilitate searching the journal with a known fixed version of the message
+(prior to the dynamic replacement).
### Key format checking
The journald APIs require that keys (also called data 'headers') may only
contain underscore, uppercase letters, or numbers (`[_A-Z0-9]`) and may not
-start with underscores. If these requirements are ignored, the journal API
-silently drops journal requests. In order to prevent silent bugs, the code
+start with underscores. If these requirements are ignored, the journal API
+silently drops journal requests. In order to prevent silent bugs, the code
performs compile-time checking of these requirements.
The code that enables compile-time header checking imposes two constraints:
+
1. Keys / headers must be passed as constant C-string values.
- - `"KEY"` is valid; `"KEY"s` or `variable_key` is not.
+ - `"KEY"` is valid; `"KEY"s` or `variable_key` is not.
2. Any constant C-string may be interpreted as a key and give non-obvious
compile warnings about format violations.
- - Constant C-strings (`"a string"`) should be passed as a C++ literal
- (`"a string"s`) instead.
+ - Constant C-strings (`"a string"`) should be passed as a C++ literal
+ (`"a string"s`) instead.
### stderr output
-When running an application or daemon on a console or SSH session, it might
-not be obvious that the application is writing to the journal. The `lg2` APIs
-detect if the application is running on a TTY and additionally log to the TTY.
+When running an application or daemon on a console or SSH session, it might not
+be obvious that the application is writing to the journal. The `lg2` APIs detect
+if the application is running on a TTY and additionally log to the TTY.
Output to stderr can also be forced by setting the `LG2_FORCE_STDERR`
environment variable to any value. This is especially useful to see log output
in OpenBMC CI test verfication.
-The format of information sent to the TTY can be adjusted by setting the
-desired format string in the `LG2_FORMAT` environment variable. Supported
-fields are:
+The format of information sent to the TTY can be adjusted by setting the desired
+format string in the `LG2_FORMAT` environment variable. Supported fields are:
- `%%` : a `'%'` literal
- `%f` : the logging function's name
@@ -179,22 +178,22 @@
fixed with the existing API.
1. The mixture of template and temporary-constructed `entry` parameters is
- verbose and clumsy. `lg2` is far more succinct in this regard.
+ verbose and clumsy. `lg2` is far more succinct in this regard.
2. The printf format-strings were error prone and potentially missed in code
- reviews. `lg2` eliminates the need for printf strings by generating the
+ reviews. `lg2` eliminates the need for printf strings by generating the
formatting internally.
3. `logging::log` generates incorrect code location information (see
- openbmc/openbmc#2297). `lg2` uses C++20's `source_location` to, by default,
+ openbmc/openbmc#2297). `lg2` uses C++20's `source_location` to, by default,
generate correct code location info and can optionally be passed a
non-defaulted `source_location` for rare but appropriate cases.
4. The previous APIs had no mechanism to generate dynamic user-friendly strings
- which caused some developers to rely on external formatting libraries such
- as `{fmt}`. `{KEY}` replacement is now a core feature of the new API.
+ which caused some developers to rely on external formatting libraries such as
+ `{fmt}`. `{KEY}` replacement is now a core feature of the new API.
5. When running on a TTY, `logging::log` sent data to journal and the TTY was
- silent. This resulted in some applications creating custom code to write
- some data to `stdout` and some to `logging::log` APIs. `lg2` automatically
- detects if it is running on a TTY and duplicates logging data to the console
- and the journal.
+ silent. This resulted in some applications creating custom code to write some
+ data to `stdout` and some to `logging::log` APIs. `lg2` automatically detects
+ if it is running on a TTY and duplicates logging data to the console and the
+ journal.
It is possible #3 and #5 could be fixed with the existing APIs, but the
remainder are only possible to be resolved with changes to the API syntax.
@@ -207,9 +206,9 @@
gain this support.
Implementing much of the syntactic improvements of the `lg2` API is made
-possible by leveraging C++20's Concepts feature. Experts in C++ may argue that
+possible by leveraging C++20's Concepts feature. Experts in C++ may argue that
this could be implemented in earlier revisions of C++ using complex SFINAE
-techniques with templated-class partial-specialization and overloading. Those
+techniques with templated-class partial-specialization and overloading. Those
experts are more than welcome to implement the `lg2` API in C++17 on their own.
### Why didn't you do ...?
@@ -217,14 +216,14 @@
> Why didn't you just use `{fmt}`?
`{fmt}` is a great API for creating unstructured logging strings, but we are
-trying to create structured logging. `{fmt}` doesn't address that problem
+trying to create structured logging. `{fmt}` doesn't address that problem
domain.
> Why invent your own formatting and not use `{fmt}`?
-The formatting performed by this API is purposefully minimal. `{fmt}` is very
-capable and especially apt for human-facing string formatting. That is not the
-typical use-case for our logging. Instead we prioritized the following:
+The formatting performed by this API is purposefully minimal. `{fmt}` is very
+capable and especially apt for human-facing string formatting. That is not the
+typical use-case for our logging. Instead we prioritized the following:
1. Reasonable syntactic ergonomics so that the API can easily be adopted.
2. Simple, consistent, machine parse-able data contents.
@@ -233,25 +232,25 @@
code.
(1) The lg2 API is roughly equivalent to `printf`, `{fmt}`, `cout` in terms of
- ergonomics, but significantly better compile-time error proofing than the
- others (except on par with `{fmt}` for errors).
+ergonomics, but significantly better compile-time error proofing than the others
+(except on par with `{fmt}` for errors).
(2) Adding robust formatting would lead to less consistent structured data with
- essentially no additional benefit. Detailed field specifiers like `{.4f}`
- do not serve any purpose when the consumer is another computer program, and
- only minimal enhancement for developers. The typical utility formatting
- for hardware-facing usage is implemented (hex, binary, field-size).
+essentially no additional benefit. Detailed field specifiers like `{.4f}` do not
+serve any purpose when the consumer is another computer program, and only
+minimal enhancement for developers. The typical utility formatting for
+hardware-facing usage is implemented (hex, binary, field-size).
(3) The `{HEADER}` placeholders allow data to be placed in a human-friendly
- manner on par with `{fmt}`.
+manner on par with `{fmt}`.
(4) The call-site code generated by this API is almost identical to a `printf`
- and the journal-facing code is on similar performance footing to the
- journal_send APIs. We save some processing by using `iovec` interfaces
- and providing the source-code information, compared to the older `logging`
- APIs and have similar formatting performance to the printf-style formatting
- that journal_send used. The only difference is that this is done in our
- library rather than in `libsystemd`.
+and the journal-facing code is on similar performance footing to the
+journal_send APIs. We save some processing by using `iovec` interfaces and
+providing the source-code information, compared to the older `logging` APIs and
+have similar formatting performance to the printf-style formatting that
+journal_send used. The only difference is that this is done in our library
+rather than in `libsystemd`.
Utilizing `{fmt}` for each structured data element would impose much greater
overheads. Either we insert the `{fmt}` calls at the call-site (N calls
@@ -268,21 +267,21 @@
our community of developers.
If it is later decided that we need more robust formatting or the `lg2::format`
-flags were a bad idea they could be deprecated and replaced. The format flags
-are a unique C++ type, which makes syntax parsing easier. As long as they are
+flags were a bad idea they could be deprecated and replaced. The format flags
+are a unique C++ type, which makes syntax parsing easier. As long as they are
replaced with a similar unique C++ type both syntaxes could be supported for a
-time. Thus enhancing to support something like `fmt::arg` in the future could
-be done without impacting existing code usage. Also, an ambitious developer
-could write a Clang-Tidy code upgrader to transition from format flags to
-something else, like Abseil provides for API changes.
+time. Thus enhancing to support something like `fmt::arg` in the future could be
+done without impacting existing code usage. Also, an ambitious developer could
+write a Clang-Tidy code upgrader to transition from format flags to something
+else, like Abseil provides for API changes.
> Doesn't duplicating the structured data in the message decrease the available
> journal space?
-Far less than you might imagine. Journald keeps the messages in a compressed
-binary format. Since the data embedded in the message and the structured data
+Far less than you might imagine. Journald keeps the messages in a compressed
+binary format. Since the data embedded in the message and the structured data
are identical in content, and very near each other in the on-disk format, they
-compress exceptionally well. Likely on the order of 1-2 bytes per structured
+compress exceptionally well. Likely on the order of 1-2 bytes per structured
data element.
The lack of data in the default `journalctl` output was a serious impediment to
@@ -292,17 +291,17 @@
> Doesn't the `{HEADER}` syntax needlessly lengthen the message strings?
-Lengthen, yes. Needlessly, no?
+Lengthen, yes. Needlessly, no?
An earlier `lg2` proposal had a format flag that appended data to the message
-string instead of putting it in-place. The consensus was that this did not
+string instead of putting it in-place. The consensus was that this did not
create as human-friendly messages as developers desired so the placeholder
syntax was implemented instead.
-`{fmt}` can use shorter placeholders of `{}` or `{3}`. The non-indexed syntax
+`{fmt}` can use shorter placeholders of `{}` or `{3}`. The non-indexed syntax
would require structured data elements be in specific order and could be error
-prone with code maintenance. The indexed syntax is similarly error prone and
-harder to review. Both of them are more work for string formatting on the
+prone with code maintenance. The indexed syntax is similarly error prone and
+harder to review. Both of them are more work for string formatting on the
library.
The `{HEADER}` syntax is identical to `{fmt}`'s "Named Argument" syntax but
diff --git a/extensions/openpower-pels/README.md b/extensions/openpower-pels/README.md
index 6252003..4df81ba 100644
--- a/extensions/openpower-pels/README.md
+++ b/extensions/openpower-pels/README.md
@@ -1,42 +1,46 @@
# OpenPower Platform Event Log (PEL) extension
-This extension will create PELs for every OpenBMC event log. It is also
-possible to point to the raw PEL to use in the OpenBMC event, and then that
-will be used instead of creating one.
+This extension will create PELs for every OpenBMC event log. It is also possible
+to point to the raw PEL to use in the OpenBMC event, and then that will be used
+instead of creating one.
## Contents
-* [Passing in data when creating PELs](#passing-pel-related-data-within-an-openbmc-event-log)
-* [Default UserData sections for BMC created PELs](#default-userdata-sections-for-bmc-created-pels)
-* [The PEL Message Registry](#the-pel-message-registry)
-* [Callouts](#callouts)
-* [Action Flags and Event Type Rules](#action-flags-and-event-type-rules)
-* [D-Bus Interfaces](#d-bus-interfaces)
-* [PEL Retention](#pel-retention)
-* [Adding python3 modules for PEL UserData and SRC parsing](#adding-python3-modules-for-pel-userdata-and-src-parsing)
-* [Fail Boot on Host Errors](#fail-boot-on-host-errors)
+
+- [Passing in data when creating PELs](#passing-pel-related-data-within-an-openbmc-event-log)
+- [Default UserData sections for BMC created PELs](#default-userdata-sections-for-bmc-created-pels)
+- [The PEL Message Registry](#the-pel-message-registry)
+- [Callouts](#callouts)
+- [Action Flags and Event Type Rules](#action-flags-and-event-type-rules)
+- [D-Bus Interfaces](#d-bus-interfaces)
+- [PEL Retention](#pel-retention)
+- [Adding python3 modules for PEL UserData and SRC parsing](#adding-python3-modules-for-pel-userdata-and-src-parsing)
+- [Fail Boot on Host Errors](#fail-boot-on-host-errors)
## Passing PEL related data within an OpenBMC event log
-An error log creator can pass in data that is relevant to a PEL by using
-certain keywords in the AdditionalData property of the event log.
+An error log creator can pass in data that is relevant to a PEL by using certain
+keywords in the AdditionalData property of the event log.
### AdditionalData keywords
#### RAWPEL
-This keyword is used to point to an existing PEL in a binary file that should
-be associated with this event log. The syntax is:
+This keyword is used to point to an existing PEL in a binary file that should be
+associated with this event log. The syntax is:
+
```
RAWPEL=<path to PEL File>
e.g.
RAWPEL="/tmp/pels/pel.5"
```
+
The code will assign its own error log ID to this PEL, and also update the
commit timestamp field to the current time.
#### POWER_THERMAL_CRITICAL_FAULT
This keyword is used to set the power fault bit in PEL. The syntax is:
+
```
POWER_THERMAL_CRITICAL_FAULT=<FLAG>
e.g.
@@ -47,23 +51,26 @@
#### SEVERITY_DETAIL
-This is used when the passed in event log severity determines the PEL
-severity and a more granular PEL severity is needed beyond what the normal
-event log to PEL severity conversion could give.
+This is used when the passed in event log severity determines the PEL severity
+and a more granular PEL severity is needed beyond what the normal event log to
+PEL severity conversion could give.
The syntax is:
+
```
SEVERITY_DETAIL=<SEVERITY_TYPE>
e.g.
SEVERITY_DETAIL=SYSTEM_TERM
```
+
Option Supported:
+
- SYSTEM_TERM, changes the Severity value from 0x50 to 0x51
#### ESEL
-This keyword's data contains a full PEL in string format. This is how hostboot
-sends down PELs when it is configured in IPMI communication mode. The PEL is
+This keyword's data contains a full PEL in string format. This is how hostboot
+sends down PELs when it is configured in IPMI communication mode. The PEL is
handled just like the PEL obtained using the RAWPEL keyword.
The syntax is:
@@ -75,18 +82,18 @@
Note that there are 16 bytes of IPMI SEL data before the PEL data starts.
-#### _PID
+#### \_PID
This keyword that contains the application's PID is added automatically by the
-phosphor-logging daemon when the `commit` or `report` APIs are used to create
-an event log, but not when the `Create` D-Bus method is used. If a caller of
-the `Create` API wishes to have their PID captured in the PEL this should be
-used.
+phosphor-logging daemon when the `commit` or `report` APIs are used to create an
+event log, but not when the `Create` D-Bus method is used. If a caller of the
+`Create` API wishes to have their PID captured in the PEL this should be used.
This will be added to the PEL in a section of type User Data (UD), along with
the application name it corresponds to.
The syntax is:
+
```
_PID=<PID of application>
e.g.
@@ -95,8 +102,8 @@
#### CALLOUT_INVENTORY_PATH
-This is used to pass in an inventory item to use as a callout. See [here for
-details](#passing-callouts-in-with-the-additionaldata-property)
+This is used to pass in an inventory item to use as a callout. See
+[here for details](#passing-callouts-in-with-the-additionaldata-property)
#### CALLOUT_PRIORITY
@@ -104,6 +111,7 @@
that FRU callout. If not specified, the default priority is "H"/High Priority.
The possible values are:
+
- "H": High Priority
- "M": Medium Priority
- "L": Low Priority
@@ -112,19 +120,18 @@
#### CALLOUT_DEVICE_PATH with CALLOUT_ERRNO
-This is used to pass in a device path to create callouts from. See [here for
-details](#passing-callouts-in-with-the-additionaldata-property)
+This is used to pass in a device path to create callouts from. See
+[here for details](#passing-callouts-in-with-the-additionaldata-property)
#### CALLOUT_IIC_BUS with CALLOUT_IIC_ADDR and CALLOUT_ERRNO
-This is used to pass in an I2C bus and address to create callouts from. See
+This is used to pass in an I2C bus and address to create callouts from. See
[here for details](#passing-callouts-in-with-the-additionaldata-property)
#### PEL_SUBSYSTEM
+
This keyword is used to pass in the subsystem that should be associated with
-this event log. The syntax is:
-PEL_SUBSYSTEM=<subsystem value in hex>
-e.g.
+this event log. The syntax is: PEL_SUBSYSTEM=<subsystem value in hex> e.g.
PEL_SUBSYSTEM=0x20
### FFDC Intended For UserData PEL sections
@@ -143,28 +150,28 @@
sdbusplus::message::unix_fd>>
```
-Each entry in the vector contains a file descriptor for a file that will
-be stored in a unique UserData section. The tuple's arguments are:
+Each entry in the vector contains a file descriptor for a file that will be
+stored in a unique UserData section. The tuple's arguments are:
- enum[FFDCFormat]: The data format type, the options are:
- - 'JSON'
- - The parser will use nlohmann::json\'s pretty print
- - 'CBOR'
- - The parser will use nlohmann::json\'s pretty print
- - 'Text'
- - The parser will output ASCII text
- - 'Custom'
- - The parser will hexdump the data, unless there is a parser registered
- for this component ID and subtype.
+ - 'JSON'
+ - The parser will use nlohmann::json\'s pretty print
+ - 'CBOR'
+ - The parser will use nlohmann::json\'s pretty print
+ - 'Text'
+ - The parser will output ASCII text
+ - 'Custom'
+ - The parser will hexdump the data, unless there is a parser registered for
+ this component ID and subtype.
- uint8_t: subType
- - Useful for the 'custom' type. Not used with the other types.
+ - Useful for the 'custom' type. Not used with the other types.
- uint8_t: version
- The version of the data.
- Used for the custom type.
- Not planning on using for JSON/BSON unless a reason to do so appears.
-- unixfd - The file descriptor for the opened file that contains the
- contents. The file descriptor can be closed and the file can be deleted if
- desired after the method call.
+- unixfd - The file descriptor for the opened file that contains the contents.
+ The file descriptor can be closed and the file can be deleted if desired after
+ the method call.
An example of saving JSON data to a file and getting its file descriptor is:
@@ -182,11 +189,10 @@
entry in that vector with the following UserData fields:
- Section header component ID:
- - If the type field from the tuple is "custom", use the component ID from
- the message registry.
- - Otherwise, set the component ID to the phosphor-logging component ID so
- that the parser knows to use the built in parsers (e.g. json) for the
- type.
+ - If the type field from the tuple is "custom", use the component ID from the
+ message registry.
+ - Otherwise, set the component ID to the phosphor-logging component ID so that
+ the parser knows to use the built in parsers (e.g. json) for the type.
- Section header subtype: The subtype field from the tuple.
- Section header version: The version field from the tuple.
- Section data: The data from the file.
@@ -195,7 +201,7 @@
that will be used by peltool to print the data, otherwise it will be hexdumped.
Before adding each of these UserData sections, a check will be done to see if
-the PEL size will remain under the maximum size of 16KB. If not, the UserData
+the PEL size will remain under the maximum size of 16KB. If not, the UserData
section will be truncated down enough so that it will fit into the 16KB.
## Default UserData sections for BMC created PELs
@@ -204,12 +210,13 @@
PEL:
- The AdditionalData property contents
+
- If the AdditionalData property in the OpenBMC event log has anything in it,
it will be saved in a UserData section as a JSON string.
- System information
- - This section contains various pieces of system information, such as the
- full code level and the BMC, chassis, and host state properties.
+ - This section contains various pieces of system information, such as the full
+ code level and the BMC, chassis, and host state properties.
## The PEL Message Registry
@@ -218,98 +225,95 @@
## Callouts
-A callout points to a FRU, a symbolic FRU, or an isolation procedure. There
-can be from zero to ten of them in each PEL, where they are located in the SRC
+A callout points to a FRU, a symbolic FRU, or an isolation procedure. There can
+be from zero to ten of them in each PEL, where they are located in the SRC
section.
-There are a few different ways to add callouts to a PEL. In all cases, the
+There are a few different ways to add callouts to a PEL. In all cases, the
callouts will be sorted from highest to lowest priority within the PEL after
they are added.
### Passing callouts in with the AdditionalData property
The PEL code can add callouts based on the values of special entries in the
-AdditionalData event log property. They are:
+AdditionalData event log property. They are:
- CALLOUT_INVENTORY_PATH
- This keyword is used to call out a single FRU by passing in its D-Bus
- inventory path. When the PEL code sees this, it will create a single FRU
- callout, using the VPD properties (location code, FN, CCIN) from that
- inventory item. If that item is not a FRU itself and does not have a
- location code, it will keep searching its parents until it finds one that
- is.
+ This keyword is used to call out a single FRU by passing in its D-Bus
+ inventory path. When the PEL code sees this, it will create a single FRU
+ callout, using the VPD properties (location code, FN, CCIN) from that
+ inventory item. If that item is not a FRU itself and does not have a location
+ code, it will keep searching its parents until it finds one that is.
- The priority of the FRU callout will be high, unless the CALLOUT_PRIORITY
- keyword is also present and contains a different priority in which case it
- will be used instead. This can be useful when a maintenance procedure with
- a high priority callout is specified for this error in the message registry
- and the FRU callout needs to have a different priority.
+ The priority of the FRU callout will be high, unless the CALLOUT_PRIORITY
+ keyword is also present and contains a different priority in which case it
+ will be used instead. This can be useful when a maintenance procedure with a
+ high priority callout is specified for this error in the message registry and
+ the FRU callout needs to have a different priority.
- ```
- CALLOUT_INVENTORY_PATH=
- "/xyz/openbmc_project/inventory/system/chassis/motherboard"
- ```
+ ```
+ CALLOUT_INVENTORY_PATH=
+ "/xyz/openbmc_project/inventory/system/chassis/motherboard"
+ ```
- CALLOUT_DEVICE_PATH with CALLOUT_ERRNO
- These keywords are required as a pair to indicate faulty device
- communication, usually detected by a failure accessing a device at that
- sysfs path. The PEL code will use a data table generated by the MRW to map
- these device paths to FRU callout lists. The errno value may influence the
- callout.
+ These keywords are required as a pair to indicate faulty device communication,
+ usually detected by a failure accessing a device at that sysfs path. The PEL
+ code will use a data table generated by the MRW to map these device paths to
+ FRU callout lists. The errno value may influence the callout.
- I2C, FSI, FSI-I2C, and FSI-SPI paths are supported.
+ I2C, FSI, FSI-I2C, and FSI-SPI paths are supported.
- ```
- CALLOUT_DEVICE_PATH="/sys/bus/i2c/devices/3-0069"
- CALLOUT_ERRNO="2"
- ```
+ ```
+ CALLOUT_DEVICE_PATH="/sys/bus/i2c/devices/3-0069"
+ CALLOUT_ERRNO="2"
+ ```
- CALLOUT_IIC_BUS with CALLOUT_IIC_ADDR and CALLOUT_ERRNO
- These 3 keywords can be used to callout a failing I2C device path when the
- full device path isn't known. It is similar to CALLOUT_DEVICE_PATH in that
- it will use data tables generated by the MRW to create the callouts.
+ These 3 keywords can be used to callout a failing I2C device path when the
+ full device path isn't known. It is similar to CALLOUT_DEVICE_PATH in that it
+ will use data tables generated by the MRW to create the callouts.
- CALLOUT_IIC_BUS is in the form "/dev/i2c-X" where X is the bus number, or
- just the bus number by itself.
- CALLOUT_IIC_ADDR is the 7 bit address either as a decimal or a hex number
- if preceded with a "0x".
+ CALLOUT_IIC_BUS is in the form "/dev/i2c-X" where X is the bus number, or just
+ the bus number by itself. CALLOUT_IIC_ADDR is the 7 bit address either as a
+ decimal or a hex number if preceded with a "0x".
- ```
- CALLOUT_IIC_BUS="/dev/i2c-7"
- CALLOUT_IIC_ADDR="81"
- CALLOUT_ERRNO=62
- ```
+ ```
+ CALLOUT_IIC_BUS="/dev/i2c-7"
+ CALLOUT_IIC_ADDR="81"
+ CALLOUT_ERRNO=62
+ ```
### Defining callouts in the message registry
Callouts can be completely defined inside that error's definition in the PEL
-message registry. This method allows the callouts to vary based on the system
+message registry. This method allows the callouts to vary based on the system
type or on any AdditionalData item.
At a high level, this involves defining a callout section inside the registry
entry that contain the location codes or procedure names to use, along with
-their priority. If these can vary based on system type, the type provided by
-the entity manager will be one of the keys. If they can also depend on an
+their priority. If these can vary based on system type, the type provided by the
+entity manager will be one of the keys. If they can also depend on an
AdditionalData entry, then that will also be a key.
See the message registry [README](registry/README.md) and
[schema](registry/schema/schema.json) for the details.
-### Using the message registry along with CALLOUT_ entries
+### Using the message registry along with CALLOUT\_ entries
If the message registry entry contains a callout definition and the event log
-also contains one of aforementioned CALLOUT keys in the AdditionalData
-property, then the PEL code will first add the callouts stemming from the
-CALLOUT items, followed by the callouts from the message registry.
+also contains one of aforementioned CALLOUT keys in the AdditionalData property,
+then the PEL code will first add the callouts stemming from the CALLOUT items,
+followed by the callouts from the message registry.
### Specifying multiple callouts using JSON format FFDC files
Multiple callouts can be passed in by the creator at the time of PEL creation.
This is done by specifying them in a JSON file that is then passed in as an
-[FFDC file](#ffdc-intended-for-userdata-pel-sections). The JSON will still be
+[FFDC file](#ffdc-intended-for-userdata-pel-sections). The JSON will still be
added into a PEL UserData section for debug.
To specify that an FFDC file contains callouts, the format value for that FFDC
@@ -328,10 +332,9 @@
fd};
```
-The JSON contains an array of callouts that must be in order of highest
-priority to lowest, with a maximum of 10. Any callouts after the 10th will
-just be thrown away as there is no room for them in the PEL. The format looks
-like:
+The JSON contains an array of callouts that must be in order of highest priority
+to lowest, with a maximum of 10. Any callouts after the 10th will just be thrown
+away as there is no room for them in the PEL. The format looks like:
```
[
@@ -348,28 +351,28 @@
```
A callout entry can be a normal hardware callout, a maintenance procedure
-callout, or a symbolic FRU callout. Each callout must contain a Priority
-field, where the possible values are:
+callout, or a symbolic FRU callout. Each callout must contain a Priority field,
+where the possible values are:
-* "H" = High
-* "M" = Medium
-* "A" = Medium Group A
-* "B" = Medium Group B
-* "C" = Medium Group C
-* "L" = Low
+- "H" = High
+- "M" = Medium
+- "A" = Medium Group A
+- "B" = Medium Group B
+- "C" = Medium Group C
+- "L" = Low
Either unexpanded location codes or D-Bus inventory object paths can be used to
-specify the called out part. An unexpanded location code does not have the
+specify the called out part. An unexpanded location code does not have the
system VPD information embedded in it, and the 'Ufcs-' prefix is optional (so
can be either Ufcs-P1 or just P1).
#### Normal hardware FRU callout
Normal hardware callouts must contain either the location code or inventory
-path, and priority. Even though the PEL code doesn't do any guarding or
+path, and priority. Even though the PEL code doesn't do any guarding or
deconfiguring itself, it needs to know if either of those things occurred as
-there are status bits in the PEL to reflect them. The Guarded and Deconfigured
-fields are used for this. Those fields are optional and if omitted then their
+there are status bits in the PEL to reflect them. The Guarded and Deconfigured
+fields are used for this. Those fields are optional and if omitted then their
values will be false.
When the inventory path of a sub-FRU is passed in, the PEL code will put the
@@ -390,12 +393,11 @@
```
-MRUs (Manufacturing Replaceable Units) are 4 byte numbers that can optionally
-be added to callouts to specify failing devices on a FRU. These may be used
-during the manufacturing test process, where there may be the ability to do
-these replacements. There can be up to 15 MRUs, each with its own priority,
-embedded in a callout. The possible priority values match the FRU priority
-values.
+MRUs (Manufacturing Replaceable Units) are 4 byte numbers that can optionally be
+added to callouts to specify failing devices on a FRU. These may be used during
+the manufacturing test process, where there may be the ability to do these
+replacements. There can be up to 15 MRUs, each with its own priority, embedded
+in a callout. The possible priority values match the FRU priority values.
Note that since JSON only supports numbers in decimal and not in hex, MRU IDs
will show up as decimal when visually inspecting the JSON.
@@ -419,7 +421,7 @@
#### Maintenance procedure callout
-The LocationCode field is not used with procedure callouts. Only the first 7
+The LocationCode field is not used with procedure callouts. Only the first 7
characters of the Procedure field will be used by the PEL.
```
@@ -431,11 +433,12 @@
#### Symbolic FRU callout
-Only the first seven characters of the SymbolicFRU field will be used by the PEL.
+Only the first seven characters of the SymbolicFRU field will be used by the
+PEL.
If the TrustedLocationCode field is present and set to true, this means the
location code may be used to turn on service indicators, so the LocationCode
-field is required. If TrustedLocationCode is false or missing, then the
+field is required. If TrustedLocationCode is false or missing, then the
LocationCode field is optional.
```
@@ -450,27 +453,28 @@
## `Action Flags` and `Event Type` Rules
The `Action Flags` and `Event Type` PEL fields are optional in the message
-registry, and if not present the code will set them based on certain rules
-layed out in the PEL spec.
+registry, and if not present the code will set them based on certain rules layed
+out in the PEL spec.
These rules are:
+
1. Always set the `Report` flag, unless the `Do Not Report` flag is already on.
2. Always clear the `SP Call Home` flag, as that feature isn't supported.
3. If the severity is `Non-error Event`:
- - Clear the `Service Action` flag.
- - Clear the `Call Home` flag.
- - If the `Event Type` field is `Not Applicable`, change it to `Information
- Only`.
- - If the `Event Type` field is `Information Only` or `Tracing`, set the
- `Hidden` flag.
+ - Clear the `Service Action` flag.
+ - Clear the `Call Home` flag.
+ - If the `Event Type` field is `Not Applicable`, change it to
+ `Information Only`.
+ - If the `Event Type` field is `Information Only` or `Tracing`, set the
+ `Hidden` flag.
4. If the severity is `Recovered`:
- - Set the `Hidden` flag.
- - Clear the `Service Action` flag.
- - Clear the `Call Home` flag.
+ - Set the `Hidden` flag.
+ - Clear the `Service Action` flag.
+ - Clear the `Call Home` flag.
5. For all other severities:
- - Clear the `Hidden` flag.
- - Set the `Service Action` flag.
- - Set the `Call Home` flag.
+ - Clear the `Hidden` flag.
+ - Set the `Service Action` flag.
+ - Set the `Call Home` flag.
Additional rules may be added in the future if necessary.
@@ -481,24 +485,24 @@
## PEL Retention
-The PEL repository is allocated a set amount of space on the BMC. When that
+The PEL repository is allocated a set amount of space on the BMC. When that
space gets close to being full, the code will remove a percentage of PELs to
-make room for new ones. In addition, the code will keep a cap on the total
-number of PELs allowed. Note that removing a PEL will also remove the
+make room for new ones. In addition, the code will keep a cap on the total
+number of PELs allowed. Note that removing a PEL will also remove the
corresponding OpenBMC event log.
The disk capacity limit is set to 20MB, and the number limit is 3000.
-The rules used to remove logs are listed below. The checks will be run after a
+The rules used to remove logs are listed below. The checks will be run after a
PEL has been added and the method to create the PEL has returned to the caller,
i.e. run when control gets back to the event loop.
### Removal Algorithm
If the size used is 95% or under of the allocated space and under the limit on
-the number of PELs, nothing further needs to be done, otherwise continue and
-run all 5 of the following steps. Each step itself only deletes PELs until it
-meets its requirement and then it stops.
+the number of PELs, nothing further needs to be done, otherwise continue and run
+all 5 of the following steps. Each step itself only deletes PELs until it meets
+its requirement and then it stops.
The steps are:
@@ -517,13 +521,11 @@
5. After the previous 4 steps are complete, if there are still more than the
maximum number of PELs, remove PELs down to 80% of the maximum.
-PELs with associated guard records will never be deleted. Each step above
-makes the following 4 passes, stopping as soon as its limit is reached:
+PELs with associated guard records will never be deleted. Each step above makes
+the following 4 passes, stopping as soon as its limit is reached:
-Pass 1. Remove HMC acknowledged PELs.<br>
-Pass 2. Remove OS acknowledged PELs.<br>
-Pass 3. Remove PHYP acknowledged PELs.<br>
-Pass 4. Remove all PELs.
+Pass 1. Remove HMC acknowledged PELs.<br> Pass 2. Remove OS acknowledged
+PELs.<br> Pass 3. Remove PHYP acknowledged PELs.<br> Pass 4. Remove all PELs.
After all these steps, disk capacity will be at most 90% (15% + 30% + 15% +
30%).
@@ -533,6 +535,7 @@
In order to support python3 modules for the parsing of PEL User Data sections
and to decode SRC data, setuptools is used to import python3 packages from
external repos to be included in the OpenBMC image.
+
```
Sample layout for setuptools:
@@ -546,6 +549,7 @@
package (such as the name and version) as well as which code files to include.
The setup.py template to be used for eBMC User Data parsers:
+
```
import os.path
from setuptools import setup
@@ -581,13 +585,15 @@
package_dir=dict(get_package_dirs())
)
```
+
- User Data parser module
- - Module name: `xzzzz.py`, where `x` is the Creator Subsystem from the
- Private Header section (in ASCII) and `zzzz` is the 2 byte Component ID
- from the User Data section itself (in HEX). All should be converted to
- lowercase.
+
+ - Module name: `xzzzz.py`, where `x` is the Creator Subsystem from the Private
+ Header section (in ASCII) and `zzzz` is the 2 byte Component ID from the
+ User Data section itself (in HEX). All should be converted to lowercase.
- For example: `b0100.py` for Hostboot created UserData with CompID 0x0100
- Function to provide: `parseUDToJson`
+
- Argument list:
1. (int) Sub-section type
2. (int) Section version
@@ -606,11 +612,14 @@
jsonStr = json.dumps(d)
return jsonStr
```
+
- SRC parser module
- - Module name: `xsrc.py`, where `x` is the Creator Subsystem from the
- Private Header section (in ASCII, converted to lowercase).
+
+ - Module name: `xsrc.py`, where `x` is the Creator Subsystem from the Private
+ Header section (in ASCII, converted to lowercase).
- For example: `bsrc.py` for Hostboot generated SRCs
- Function to provide: `parseSRCToJson`
+
- Argument list:
1. (str) Refcode ASCII string
2. (str) Hexword 2
@@ -646,20 +655,20 @@
It is required that when this fail boot on hardware error setting is enabled,
that the BMC fail the boot for **any** error from the host which satisfies the
following criteria:
+
- not SeverityType::nonError
- has a callout of any kind from the `FailingComponentType` structure
## Self Boot Engine(SBE) First Failure Data Capture(FFDC) Support
-During SBE chip-op failure SBE creates FFDC with custom data format.
-SBE FFDC contains different packets, which include SBE internal failure related
-Trace and user data also Hardware procedure failure FFDC created by FAPI
-infrastructure. PEL infrastructure provides support to process SBE FFDC packets
-created by FAPI infrastructure during hardware procedure execution failures,
-also add callouts, user data section information based on FAPI processing
-in case non FAPI based failure, just keeps the raw FFDC data in the user section
-to support SBE parser plugins.
-
+During SBE chip-op failure SBE creates FFDC with custom data format. SBE FFDC
+contains different packets, which include SBE internal failure related Trace and
+user data also Hardware procedure failure FFDC created by FAPI infrastructure.
+PEL infrastructure provides support to process SBE FFDC packets created by FAPI
+infrastructure during hardware procedure execution failures, also add callouts,
+user data section information based on FAPI processing in case non FAPI based
+failure, just keeps the raw FFDC data in the user section to support SBE parser
+plugins.
CreatePELWithFFDCFiles D-Bus method on the `org.open_power.Logging.PEL`
interface must be used when creating a new event log.
@@ -678,33 +687,35 @@
0xCB, // SBE FFDC subtype
0x01, // SBE FFDC version, set to 0x01
fd};
- ```
+```
"SRC6" Keyword in the additional data section should be populated with below.
- - [0:15] chip position (hex)
- - [16:23] command class (hex)
- - [24:31] command (hex)
+- [0:15] chip position (hex)
+- [16:23] command class (hex)
+- [24:31] command (hex)
e.g for GetSCOM
- SRC6="0002A201"
+SRC6="0002A201"
Note: "phal" build-time configure option should be "enabled" to enable this
- feature.
+feature.
## PEL Archiving
-When an OpenBMC event log is deleted its corresponding PEL is moved to
-an archive folder. These archived PELs will be available in BMC dump.
-The archive path: /var/lib/phosphor-logging/extensions/pels/logs/archive.
+When an OpenBMC event log is deleted its corresponding PEL is moved to an
+archive folder. These archived PELs will be available in BMC dump. The archive
+path: /var/lib/phosphor-logging/extensions/pels/logs/archive.
Highlighted points are:
-- PELs whose corresponding event logs have been deleted will be available
- in the archive folder.
-- Archive folder size is tracked along with logs folder size and if
- combined size exceeds warning size all archived PELs will be deleted.
+
+- PELs whose corresponding event logs have been deleted will be available in the
+ archive folder.
+- Archive folder size is tracked along with logs folder size and if combined
+ size exceeds warning size all archived PELs will be deleted.
- Archived PEL logs can be viewed using peltool with flag --archive.
- If a PEL is deleted using peltool its not archived.
-[1]: https://github.com/openbmc/docs/blob/master/designs/fail-boot-on-hw-error.md
+[1]:
+ https://github.com/openbmc/docs/blob/master/designs/fail-boot-on-hw-error.md
diff --git a/extensions/openpower-pels/registry/O_component_ids.json b/extensions/openpower-pels/registry/O_component_ids.json
index 1debe3e..b3d8b52 100644
--- a/extensions/openpower-pels/registry/O_component_ids.json
+++ b/extensions/openpower-pels/registry/O_component_ids.json
@@ -16,4 +16,4 @@
"C100": "bmc system dump collector",
"D100": "bmc hw diags attention handler",
"E500": "bmc hw diags"
-}
\ No newline at end of file
+}
diff --git a/extensions/openpower-pels/registry/README.md b/extensions/openpower-pels/registry/README.md
index 6a4be33..0385ad4 100644
--- a/extensions/openpower-pels/registry/README.md
+++ b/extensions/openpower-pels/registry/README.md
@@ -1,75 +1,84 @@
# Platform Event Log Message Registry
+
On the BMC, PELs are created from the standard event logs provided by
phosphor-logging using a message registry that provides the PEL related fields.
The message registry is a JSON file.
## Contents
-* [Component IDs](#component-ids)
-* [Message Registry](#message-registry-fields)
-* [Modifying and Testing](#modifying-and-testing)
+
+- [Component IDs](#component-ids)
+- [Message Registry](#message-registry-fields)
+- [Modifying and Testing](#modifying-and-testing)
## Component IDs
+
A component ID is a 2 byte value of the form 0xYY00 used in a PEL to:
+
1. Provide the upper byte (the YY from above) of an SRC reason code in `BD`
SRCs.
-2. Reside in the section header of the Private Header PEL section to specify
- the error log creator's component ID.
+2. Reside in the section header of the Private Header PEL section to specify the
+ error log creator's component ID.
3. Reside in the section header of the User Header section to specify the error
log committer's component ID.
-4. Reside in the section header in the User Data section to specify which
- parser to call to parse that section.
+4. Reside in the section header in the User Data section to specify which parser
+ to call to parse that section.
Component IDs are specified in the message registry either as the upper byte of
the SRC reason code field for `BD` SRCs, or in the standalone `ComponentID`
field.
-Component IDs will be unique on a per-repository basis for errors unique to
-that repository. When the same errors are created by multiple repositories,
-those errors will all share the same component ID. The master list of
-component IDs is [here](O_component_ids.json). That file can used by PEL
-parsers to display a name for the component ID. The 'O' in the name is the
-creator ID value for BMC created PELs.
+Component IDs will be unique on a per-repository basis for errors unique to that
+repository. When the same errors are created by multiple repositories, those
+errors will all share the same component ID. The master list of component IDs is
+[here](O_component_ids.json). That file can used by PEL parsers to display a
+name for the component ID. The 'O' in the name is the creator ID value for BMC
+created PELs.
## Message Registry Fields
+
The message registry schema is [here](schema/schema.json), and the message
-registry itself is [here](message_registry.json). The schema will be validated
+registry itself is [here](message_registry.json). The schema will be validated
either during a bitbake build or during CI, or eventually possibly both.
In the message registry, there are fields for specifying:
### Name
-This is the key into the message registry, and is the Message property
-of the OpenBMC event log that the PEL is being created from.
+
+This is the key into the message registry, and is the Message property of the
+OpenBMC event log that the PEL is being created from.
```
"Name": "xyz.openbmc_project.Power.Fault"
```
### Subsystem
-This field is part of the PEL User Header section, and is used to specify
-the subsystem pertaining to the error. It is an enumeration that maps to the
-actual PEL value. If the subsystem isn't known ahead of time, it can be passed
-in at the time of PEL creation using the 'PEL\_SUBSYSTEM' AdditionalData field.
-In this case, 'Subsystem' isn't required, though 'PossibleSubsystems' is.
+
+This field is part of the PEL User Header section, and is used to specify the
+subsystem pertaining to the error. It is an enumeration that maps to the actual
+PEL value. If the subsystem isn't known ahead of time, it can be passed in at
+the time of PEL creation using the 'PEL_SUBSYSTEM' AdditionalData field. In this
+case, 'Subsystem' isn't required, though 'PossibleSubsystems' is.
```
"Subsystem": "power_supply"
```
### PossibleSubsystems
-This field is used by scripts that build documentation from the message
-registry to know which subsystems are possible for an error when it can't be
-hardcoded using the 'Subsystem' field. It is mutually exclusive with the
-'Subsystem' field.
+
+This field is used by scripts that build documentation from the message registry
+to know which subsystems are possible for an error when it can't be hardcoded
+using the 'Subsystem' field. It is mutually exclusive with the 'Subsystem'
+field.
```
"PossibleSubsystems": ["memory", "processor"]
```
### Severity
-This field is part of the PEL User Header section, and is used to specify
-the PEL severity. It is an optional field, if it isn't specified, then the
-severity of the OpenBMC event log will be converted into a PEL severity value.
+
+This field is part of the PEL User Header section, and is used to specify the
+PEL severity. It is an optional field, if it isn't specified, then the severity
+of the OpenBMC event log will be converted into a PEL severity value.
It can either be the plain severity value, or an array of severity values that
are based on system type, where an entry without a system type will match
@@ -91,12 +100,14 @@
}
]
```
-The above example shows that on system 'system1' the severity will be
-recovered, and on every other system it will be unrecoverable.
+
+The above example shows that on system 'system1' the severity will be recovered,
+and on every other system it will be unrecoverable.
### Mfg Severity
+
This is an optional field and is used to override the Severity field when a
-specific manufacturing isolation mode is enabled. It has the same format as
+specific manufacturing isolation mode is enabled. It has the same format as
Severity.
```
@@ -104,18 +115,20 @@
```
### Event Scope
-This field is part of the PEL User Header section, and is used to specify
-the event scope, as defined by the PEL spec. It is optional and defaults to
-"entire platform".
+
+This field is part of the PEL User Header section, and is used to specify the
+event scope, as defined by the PEL spec. It is optional and defaults to "entire
+platform".
```
"EventScope": "entire_platform"
```
### Event Type
-This field is part of the PEL User Header section, and is used to specify
-the event type, as defined by the PEL spec. It is optional and defaults to
-"not applicable" for non-informational logs, and "misc_information_only" for
+
+This field is part of the PEL User Header section, and is used to specify the
+event type, as defined by the PEL spec. It is optional and defaults to "not
+applicable" for non-informational logs, and "misc_information_only" for
informational ones.
```
@@ -123,15 +136,16 @@
```
### Action Flags
+
This field is part of the PEL User Header section, and is used to specify the
-PEL action flags, as defined by the PEL spec. It is an array of enumerations.
+PEL action flags, as defined by the PEL spec. It is an array of enumerations.
The action flags can usually be deduced from other PEL fields, such as the
-severity or if there are any callouts. As such, this is an optional field and
-if not supplied the code will fill them in based on those fields.
+severity or if there are any callouts. As such, this is an optional field and if
+not supplied the code will fill them in based on those fields.
In fact, even if supplied here, the code may still modify them to ensure they
-are correct. The rules used for this are
+are correct. The rules used for this are
[here](../README.md#action-flags-and-event-type-rules).
```
@@ -139,6 +153,7 @@
```
### Mfg Action Flags
+
This is an optional field and is used to override the Action Flags field when a
specific manufacturing isolation mode is enabled.
@@ -147,25 +162,28 @@
```
### Component ID
-This is the component ID of the PEL creator, in the form 0xYY00. For `BD`
-SRCs, this is an optional field and if not present the value will be taken from
-the upper byte of the reason code. If present for `BD` SRCs, then this byte
-must match the upper byte of the reason code.
+
+This is the component ID of the PEL creator, in the form 0xYY00. For `BD` SRCs,
+this is an optional field and if not present the value will be taken from the
+upper byte of the reason code. If present for `BD` SRCs, then this byte must
+match the upper byte of the reason code.
```
"ComponentID": "0x5500"
```
### SRC Type
-This specifies the type of SRC to create. The type is the first 2 characters
-of the 8 character ASCII string field of the PEL. The allowed types are `BD`,
-for the standard OpenBMC error, and `11`, for power related errors. It is
-optional and if not specified will default to `BD`.
+
+This specifies the type of SRC to create. The type is the first 2 characters of
+the 8 character ASCII string field of the PEL. The allowed types are `BD`, for
+the standard OpenBMC error, and `11`, for power related errors. It is optional
+and if not specified will default to `BD`.
Note: The ASCII string for BD SRCs looks like: `BDBBCCCC`, where:
-* BD = SRC type
-* BB = PEL subsystem as mentioned above
-* CCCC SRC reason code
+
+- BD = SRC type
+- BB = PEL subsystem as mentioned above
+- CCCC SRC reason code
For `11` SRCs, it looks like: `1100RRRR`, where RRRR is the SRC reason code.
@@ -174,21 +192,23 @@
```
### SRC Reason Code
-This is the 4 character value in the latter half of the SRC ASCII string. It
-is treated as a 2 byte hex value, such as 0x5678. For `BD` SRCs, the first
-byte is the same as the first byte of the component ID field in the Private
-Header section that represents the creator's component ID.
+
+This is the 4 character value in the latter half of the SRC ASCII string. It is
+treated as a 2 byte hex value, such as 0x5678. For `BD` SRCs, the first byte is
+the same as the first byte of the component ID field in the Private Header
+section that represents the creator's component ID.
```
"ReasonCode": "0x5544"
```
### SRC Symptom ID Fields
+
The symptom ID is in the Extended User Header section and is defined in the PEL
-spec as the unique event signature string. It always starts with the ASCII
-string. This field in the message registry allows one to choose which SRC words
+spec as the unique event signature string. It always starts with the ASCII
+string. This field in the message registry allows one to choose which SRC words
to use in addition to the ASCII string field to form the symptom ID. All words
-are separated by underscores. If not specified, the code will choose a default
+are separated by underscores. If not specified, the code will choose a default
format, which may depend on the SRC type.
For example: ["SRCWord3", "SRCWord9"] would be:
@@ -200,11 +220,12 @@
```
### SRC words 6 to 9
+
In a PEL, these SRC words are free format and can be filled in by the user as
-desired. On the BMC, the source of these words is the AdditionalData fields in
-the event log. The message registry provides a way for the log creator to
+desired. On the BMC, the source of these words is the AdditionalData fields in
+the event log. The message registry provides a way for the log creator to
specify which AdditionalData property field to get the data from, and also to
-define what the SRC word means for use by parsers. If not specified, these SRC
+define what the SRC word means for use by parsers. If not specified, these SRC
words will be set to zero in the PEL.
```
@@ -219,26 +240,29 @@
```
### Documentation Fields
+
The documentation fields are used by PEL parsers to display a human readable
-description of a PEL. They are also the source for the Redfish event log
+description of a PEL. They are also the source for the Redfish event log
messages.
#### Message
+
This field is used by the BMC's PEL parser as the description of the error log.
-It will also be used in Redfish event logs. It supports argument substitution
-using the %1, %2, etc placeholders allowing any of the SRC user data words 6 -
-9 to be displayed as part of the message. If the placeholders are used, then
-the `MessageArgSources` property must be present to say which SRC words to use
-for each placeholder.
+It will also be used in Redfish event logs. It supports argument substitution
+using the %1, %2, etc placeholders allowing any of the SRC user data words 6 - 9
+to be displayed as part of the message. If the placeholders are used, then the
+`MessageArgSources` property must be present to say which SRC words to use for
+each placeholder.
```
"Message": "Processor %1 had %2 errors"
```
#### MessageArgSources
+
This optional field is required when the Message field contains the %X
placeholder arguments. It is an array that says which SRC words to get the
-placeholders from. In the example below, SRC word 6 would be used for %1, and
+placeholders from. In the example below, SRC word 6 would be used for %1, and
SRC word 7 for %2.
```
@@ -249,15 +273,18 @@
```
#### Description
-A short description of the error. This is required by the Redfish schema to generate a Redfish message entry, but is not used in Redfish or PEL output.
+
+A short description of the error. This is required by the Redfish schema to
+generate a Redfish message entry, but is not used in Redfish or PEL output.
```
"Description": "A power fault"
```
#### Notes
+
This is an optional free format text field for keeping any notes for the
-registry entry, as comments are not allowed in JSON. It is an array of strings
+registry entry, as comments are not allowed in JSON. It is an array of strings
for easier readability of long fields.
```
@@ -268,13 +295,14 @@
```
### Callout Fields
-The callout fields allow one to specify the PEL callouts (either a hardware
-FRU, a symbolic FRU, or a maintenance procedure) in the entry for a particular
-error. These callouts can vary based on system type, as well as a user
-specified AdditionalData property field. Callouts will be added to the PEL in
-the order they are listed in the JSON. If a callout is passed into the error,
-say with CALLOUT_INVENTORY_PATH, then that callout will be added to the PEL
-before the callouts in the registry.
+
+The callout fields allow one to specify the PEL callouts (either a hardware FRU,
+a symbolic FRU, or a maintenance procedure) in the entry for a particular error.
+These callouts can vary based on system type, as well as a user specified
+AdditionalData property field. Callouts will be added to the PEL in the order
+they are listed in the JSON. If a callout is passed into the error, say with
+CALLOUT_INVENTORY_PATH, then that callout will be added to the PEL before the
+callouts in the registry.
There is room for up to 10 callouts in a PEL.
@@ -311,10 +339,9 @@
```
-The above example shows that on system 'system1', the FRU at location P1-C1
-will be called out with a priority of high, and the FRU at P1 with a priority
-of low. On every other system, the maintenance procedure SVCDOCS is called
-out.
+The above example shows that on system 'system1', the FRU at location P1-C1 will
+be called out with a priority of high, and the FRU at P1 with a priority of low.
+On every other system, the maintenance procedure SVCDOCS is called out.
#### Callouts example based on an AdditionalData field
@@ -360,15 +387,14 @@
```
This example shows that the callouts were selected based on the 'PROC_NUM'
-AdditionalData field. When PROC_NUM was 0, the FRU at P1-C5 was called out.
-When it was 1, P1-C6 was called out. Note that the same 'Callouts' array is
-used as in the previous example, so these callouts can also depend on the
-system type.
+AdditionalData field. When PROC_NUM was 0, the FRU at P1-C5 was called out. When
+it was 1, P1-C6 was called out. Note that the same 'Callouts' array is used as
+in the previous example, so these callouts can also depend on the system type.
-If it's desired to use a different set of callouts when there isn't a match
-on the AdditionalData field, one can use CalloutsWhenNoADMatch. In the
-following example, the 'air_mover' callout will be added if 'PROC_NUM' isn't
-0. 'CalloutsWhenNoADMatch' has the same schema as the 'Callouts' section.
+If it's desired to use a different set of callouts when there isn't a match on
+the AdditionalData field, one can use CalloutsWhenNoADMatch. In the following
+example, the 'air_mover' callout will be added if 'PROC_NUM' isn't 0.
+'CalloutsWhenNoADMatch' has the same schema as the 'Callouts' section.
```
"CalloutsUsingAD":
@@ -407,8 +433,9 @@
```
#### CalloutType
-This field can be used to modify the failing component type field in the
-callout when the default doesn\'t fit:
+
+This field can be used to modify the failing component type field in the callout
+when the default doesn\'t fit:
```
{
@@ -420,6 +447,7 @@
```
The defaults are:
+
- Normal hardware FRU: hardware_fru
- Symbolic FRU: symbolic_fru
- Procedure: maint_procedure
@@ -433,10 +461,10 @@
In this case, one should use the 'SymbolicFRUTrusted' key along with the
'UseInventoryLocCode' key, and then pass in the inventory item that has the
desired location code using the 'CALLOUT_INVENTORY_PATH' entry inside of the
-AdditionalData property. The code will then look up the location code for that
-passed in inventory FRU and place it in the symbolic FRU callout. The normal
-FRU callout with that inventory item will not be created. The symbolic FRU
-must be the first callout in the registry for this to work.
+AdditionalData property. The code will then look up the location code for that
+passed in inventory FRU and place it in the symbolic FRU callout. The normal FRU
+callout with that inventory item will not be created. The symbolic FRU must be
+the first callout in the registry for this to work.
```
{
@@ -454,10 +482,10 @@
1. Update message_registry.json to add the new errors.
2. If a new component ID is used (usually the first byte of the SRC reason
code), document it in O_component_ids.json.
-3. Validate the file. It must be valid JSON and obey the schema. The
+3. Validate the file. It must be valid JSON and obey the schema. The
`process_registry.py` script in `extensions/openpower-pels/registry/tools`
will validate both, though it requires the python-jsonschema package to do
- the schema validation. This script is also run to validate the message
+ the schema validation. This script is also run to validate the message
registry as part of CI testing.
```
@@ -466,10 +494,10 @@
4. One can test what PELs are generated from these new entries without writing
any code to create the corresponding event logs:
- 1. Copy the modified message_registry.json into `/etc/phosphor-logging/` on
- the BMC. That directory may need to be created.
- 2. Use busctl to call the Create method to create an event log
- corresponding to the message registry entry under test.
+ 1. Copy the modified message_registry.json into `/etc/phosphor-logging/` on
+ the BMC. That directory may need to be created.
+ 2. Use busctl to call the Create method to create an event log corresponding
+ to the message registry entry under test.
```
busctl call xyz.openbmc_project.Logging /xyz/openbmc_project/logging \
diff --git a/extensions/openpower-pels/registry/message_registry.json b/extensions/openpower-pels/registry/message_registry.json
index 0a7cafa..335fae7 100644
--- a/extensions/openpower-pels/registry/message_registry.json
+++ b/extensions/openpower-pels/registry/message_registry.json
@@ -1,31 +1,24 @@
{
- "PELs":
- [
+ "PELs": [
{
"Name": "xyz.openbmc_project.Common.Error.Timeout",
"Subsystem": "bmc_firmware",
"Severity": "non_error",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x1001",
- "Words6To9":
- {
- "6":
- {
+ "Words6To9": {
+ "6": {
"Description": "Timeout in ms",
"AdditionalDataPropSource": "TIMEOUT_IN_MSEC"
}
}
},
- "Documentation":
- {
+ "Documentation": {
"Description": "This is a generic timeout error",
"Message": "An operation timed out",
- "Notes": [
- "The journal should contain more information"
- ]
+ "Notes": ["The journal should contain more information"]
}
},
@@ -34,21 +27,15 @@
"Subsystem": "bmc_firmware",
"Severity": "non_error",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x1002",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
- "Documentation":
- {
+ "Documentation": {
"Description": "BMC code had a generic internal failure",
"Message": "An application had an internal failure",
- "Notes": [
- "The journal should contain more information"
- ]
+ "Notes": ["The journal should contain more information"]
}
},
@@ -57,21 +44,15 @@
"Subsystem": "user_error",
"Severity": "non_error",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x1003",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
- "Documentation":
- {
+ "Documentation": {
"Description": "BMC code was given an invalid argument",
"Message": "Code was given an invalid argument",
- "Notes": [
- "The journal should contain more information"
- ]
+ "Notes": ["The journal should contain more information"]
}
},
{
@@ -79,21 +60,15 @@
"Subsystem": "user_error",
"Severity": "non_error",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x1004",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
- "Documentation":
- {
+ "Documentation": {
"Description": "An operation failed due to insufficient permission",
"Message": "An operation failed due to unsufficient permission",
- "Notes": [
- "The journal should contain more information"
- ]
+ "Notes": ["The journal should contain more information"]
}
},
@@ -102,21 +77,15 @@
"Subsystem": "user_error",
"Severity": "non_error",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x1005",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
- "Documentation":
- {
+ "Documentation": {
"Description": "An operation failed because it isn't allowed",
"Message": "An operation failed because it isn't allowed",
- "Notes": [
- "The journal should contain more information"
- ]
+ "Notes": ["The journal should contain more information"]
}
},
@@ -125,16 +94,12 @@
"Subsystem": "user_error",
"Severity": "non_error",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x1006",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
- "Documentation":
- {
+ "Documentation": {
"Description": "The server's CA certificate has not been provided",
"Message": "The server's CA certificate has not been provided"
}
@@ -144,21 +109,17 @@
"Name": "xyz.openbmc_project.Sensor.Device.Error.ReadFailure",
"Subsystem": "cec_i2c",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x1007",
- "Words6To9":
- {
- "6":
- {
+ "Words6To9": {
+ "6": {
"Description": "errno of the failure",
"AdditionalDataPropSource": "CALLOUT_ERRNO"
}
}
},
- "Documentation":
- {
+ "Documentation": {
"Description": "Sensor device read failure",
"Message": "There was a failure when reading a sensor device",
"Notes": [
@@ -173,21 +134,17 @@
"Name": "xyz.openbmc_project.Common.Device.Error.ReadFailure",
"Subsystem": "cec_i2c",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x1008",
- "Words6To9":
- {
- "6":
- {
+ "Words6To9": {
+ "6": {
"Description": "errno of the failure",
"AdditionalDataPropSource": "CALLOUT_ERRNO"
}
}
},
- "Documentation":
- {
+ "Documentation": {
"Description": "Device read failure",
"Message": "There was a failure when reading a hardware device",
"Notes": [
@@ -202,21 +159,17 @@
"Name": "xyz.openbmc_project.Control.Device.Error.WriteFailure",
"Subsystem": "cec_i2c",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x1009",
- "Words6To9":
- {
- "6":
- {
+ "Words6To9": {
+ "6": {
"Description": "errno of the failure",
"AdditionalDataPropSource": "CALLOUT_ERRNO"
}
}
},
- "Documentation":
- {
+ "Documentation": {
"Description": "Device write failure",
"Message": "There was a failure when writing to a hardware device",
"Notes": [
@@ -231,21 +184,17 @@
"Name": "xyz.openbmc_project.Common.Device.Error.WriteFailure",
"Subsystem": "cec_i2c",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x100A",
- "Words6To9":
- {
- "6":
- {
+ "Words6To9": {
+ "6": {
"Description": "errno of the failure",
"AdditionalDataPropSource": "CALLOUT_ERRNO"
}
}
},
- "Documentation":
- {
+ "Documentation": {
"Description": "Device write failure",
"Message": "There was a failure when writing to a hardware device",
"Notes": [
@@ -260,12 +209,9 @@
"Name": "xyz.openbmc_project.Common.File.Error.Write",
"Subsystem": "bmc_firmware",
"ComponentID": "0x1000",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x100B",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
@@ -276,8 +222,7 @@
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "Failed to write to a file",
"Message": "Failed to write to a file",
"Notes": [
@@ -292,26 +237,20 @@
"Subsystem": "bmc_firmware",
"Severity": "non_error",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x2001",
- "Words6To9":
- {
- "6":
- {
+ "Words6To9": {
+ "6": {
"Description": "The bad PEL ID",
"AdditionalDataPropSource": "BAD_ID"
}
}
},
- "Documentation":
- {
+ "Documentation": {
"Description": "The BMC sent the host a malformed PEL",
"Message": "The BMC sent the host a malformed PEL",
- "Notes": [
- "The host firmware rejected that PEL."
- ]
+ "Notes": ["The host firmware rejected that PEL."]
}
},
@@ -320,23 +259,18 @@
"Subsystem": "platform_firmware",
"Severity": "unrecoverable",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x2002",
- "Words6To9":
- {
- "6":
- {
+ "Words6To9": {
+ "6": {
"Description": "The PLID of the invalid PEL",
"AdditionalDataPropSource": "PLID"
},
- "7":
- {
+ "7": {
"Description": "The corresponding OpenBMC event log ID",
"AdditionalDataPropSource": "OBMC_LOG_ID"
},
- "8":
- {
+ "8": {
"Description": "The size of the invalid PEL",
"AdditionalDataPropSource": "PEL_SIZE"
}
@@ -351,12 +285,10 @@
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "The host sent the BMC an invalid PEL",
"Message": "The host sent the BMC an invalid PEL",
- "Notes": [
- ]
+ "Notes": []
}
},
@@ -365,25 +297,21 @@
"Subsystem": "platform_firmware",
"Severity": "unrecoverable",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x2003",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
{
"CalloutList": [
- {"Priority": "high", "Procedure": "bmc_code"},
- {"Priority": "medium", "SymbolicFRU": "service_docs"}
+ { "Priority": "high", "Procedure": "bmc_code" },
+ { "Priority": "medium", "SymbolicFRU": "service_docs" }
]
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "An error for testing",
"Message": "This is a test error"
}
@@ -393,12 +321,9 @@
"Name": "xyz.openbmc_project.Logging.Error.Default",
"Subsystem": "other_na",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x2004",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
@@ -409,8 +334,7 @@
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "This entry is used when no other matching entry is found",
"Message": "Unknown (Original event not in message registry)",
"Notes": [
@@ -433,24 +357,18 @@
"Severity": "recovered",
"ActionFlags": ["report"],
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x2005",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
{
- "CalloutList": [
- { "Priority": "high", "LocCode": "P0" }
- ]
+ "CalloutList": [{ "Priority": "high", "LocCode": "P0" }]
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "An error for testing",
"Message": "This is a test recoverable error",
"Notes": [
@@ -465,16 +383,12 @@
"Subsystem": "bmc_firmware",
"Severity": "predictive",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x2006",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
- "Documentation":
- {
+ "Documentation": {
"Description": "This is an error used for testing only",
"Message": "This is a test predictive error",
"Notes": [
@@ -489,16 +403,12 @@
"Subsystem": "cec_hardware",
"ComponentID": "0x3000",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x3001",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
- "Documentation":
- {
+ "Documentation": {
"Description": "Failure occurred during boot process",
"Message": "Failure occurred during boot process",
"Notes": [
@@ -512,16 +422,12 @@
"Subsystem": "cec_hardware",
"ComponentID": "0x3000",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x3002",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
- "Documentation":
- {
+ "Documentation": {
"Description": "Failure occurred during PHAL pre-poweroff operations",
"Message": "Failure occurred during PHAL pre-poweroff operations",
"Notes": [
@@ -538,21 +444,15 @@
"ComponentID": "0x3000",
"Severity": "unrecoverable",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x3003",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
- "Documentation":
- {
+ "Documentation": {
"Description": "Failure occurred during PHAL devtree sync ",
"Message": "Failure occurred during PHAL devtree sync",
- "Notes": [
- "The journal should contain more information"
- ]
+ "Notes": ["The journal should contain more information"]
}
},
@@ -562,21 +462,15 @@
"ComponentID": "0x3000",
"Severity": "unrecoverable",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x3004",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
- "Documentation":
- {
+ "Documentation": {
"Description": "Failure occurred during PHAL devtree backup ",
"Message": "Failure occurred during PHAL devtree backup",
- "Notes": [
- "The journal should contain more information"
- ]
+ "Notes": ["The journal should contain more information"]
}
},
@@ -585,16 +479,12 @@
"Subsystem": "cec_sp_hyp_iface",
"ComponentID": "0x3000",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x3005",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
- "Documentation":
- {
+ "Documentation": {
"Description": "Host did not respond to BMC after a BMC reset",
"Message": "Host did not respond to BMC after a BMC reset but hardware indicates it is running",
"Notes": [
@@ -613,21 +503,15 @@
"ComponentID": "0x3000",
"Severity": "unrecoverable",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x3006",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
- "Documentation":
- {
+ "Documentation": {
"Description": "Failure re-initializing BMC to Host data structure",
"Message": "Failure occurred during re-initializing BMC to Host data structure",
- "Notes": [
- "The journal should contain more information"
- ]
+ "Notes": ["The journal should contain more information"]
}
},
@@ -637,16 +521,12 @@
"ComponentID": "0x3000",
"Severity": "unrecoverable",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x3007",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
- "Documentation":
- {
+ "Documentation": {
"Description": "Non functional boot processor",
"Message": "Non functional boot processor",
"Notes": [
@@ -663,43 +543,36 @@
"ComponentID": "0x3000",
"Severity": "unrecoverable",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x3008",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
{
- "CalloutList": [{"Priority": "high", "Procedure": "bmc_code" }
+ "CalloutList": [
+ { "Priority": "high", "Procedure": "bmc_code" }
]
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "Error during memory preserving reboot",
"Message": "Error during memory preserving reboot",
"Notes": [
"Software error occured during memory preserving reboot"
]
}
- }
-,
+ },
{
"Name": "org.open_power.PHAL.Error.SpareClock",
"Subsystem": "cec_hardware",
"ComponentID": "0x3000",
"Severity": "non_error",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x3009",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
@@ -731,8 +604,7 @@
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "Error during Spare clock initialisation",
"Message": "Error during Spare clock initialisation",
"Notes": [
@@ -747,18 +619,14 @@
"Subsystem": "cec_clocks",
"ComponentID": "0x3000",
"Severity": "non_error",
- "ActionFlags": [ "report", "call_home" ],
+ "ActionFlags": ["report", "call_home"],
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x300A",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
- "Documentation":
- {
+ "Documentation": {
"Description": "Informational error to house clock debug info",
"Message": "Informational error to house clock debug info",
"Notes": [
@@ -773,12 +641,9 @@
"ComponentID": "0x3000",
"Severity": "predictive",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x300B",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
@@ -789,8 +654,7 @@
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "Guard partition access failure",
"Message": "Guard partition access failure",
"Notes": [
@@ -805,12 +669,9 @@
"ComponentID": "0x2600",
"Severity": "predictive",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x2681",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
@@ -821,8 +682,7 @@
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "OCC presence mismatch",
"Message": "BMC firmware detected incorrect number of OCCs",
"Notes": [
@@ -838,16 +698,12 @@
"ComponentID": "0x2600",
"Severity": "non_error",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x2682",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
- "Documentation":
- {
+ "Documentation": {
"Description": "OCC safe state",
"Message": "OCC in safe state while active for one minute",
"Notes": [
@@ -863,16 +719,12 @@
"ComponentID": "0x2600",
"Severity": "predictive",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x2683",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
- "Documentation":
- {
+ "Documentation": {
"Description": "OCC communication failure",
"Message": "BMC failed to communicate with the OCC",
"Notes": [
@@ -887,16 +739,12 @@
"Subsystem": "cec_hardware",
"ComponentID": "0x3100",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x3101",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
- "Documentation":
- {
+ "Documentation": {
"Description": "Failure occurred during hardware isolation operations",
"Message": "Failure occurred during hardware isolation operations",
"Notes": [
@@ -910,15 +758,11 @@
"Name": "xyz.openbmc_project.State.Error.HostNotRunning",
"Subsystem": "cec_sp_hostboot_iface",
"ComponentID": "0x3400",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x3401",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
- "Documentation":
- {
+ "Documentation": {
"Description": "Host was booting or booted before BMC reset but is now unresponsive",
"Message": "Host did not respond to BMC after a BMC reset but it was booting or booted prior to the BMC reboot",
"Notes": [
@@ -935,20 +779,21 @@
"Name": "xyz.openbmc_project.State.ChassisPowerBad",
"Subsystem": "input_power_source",
"ComponentID": "0x3400",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x3402",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
{
- "CalloutList": [{"Priority": "high", "Procedure": "next_level_support"}]
+ "CalloutList": [
+ {
+ "Priority": "high",
+ "Procedure": "next_level_support"
+ }
+ ]
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "Chassis input power is in a bad state",
"Message": "Chassis input power is in a bad state, look for other logs with more details",
"Notes": [
@@ -963,15 +808,11 @@
"Name": "xyz.openbmc_project.State.PinholeReset",
"Subsystem": "cec_op_panel",
"ComponentID": "0x3400",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x3403",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
- "Documentation":
- {
+ "Documentation": {
"Description": "User initiated a pinhole reset via the op-panel",
"Message": "User initiated a pinhole reset via the op-panel",
"Notes": [
@@ -986,20 +827,21 @@
"Name": "xyz.openbmc_project.State.Error.CriticalServiceFailure",
"Subsystem": "bmc_firmware",
"ComponentID": "0x3400",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x3404",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
{
- "CalloutList": [{"Priority": "high", "Procedure": "next_level_support"}]
+ "CalloutList": [
+ {
+ "Priority": "high",
+ "Procedure": "next_level_support"
+ }
+ ]
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "A critical BMC application has failed on the system",
"Message": "A critical BMC application has failed on the system, the BMC is in an undefined state",
"Notes": [
@@ -1016,20 +858,21 @@
"Name": "xyz.openbmc_project.State.Error.SecurityCheckFail",
"Subsystem": "bmc_firmware",
"ComponentID": "0x3400",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x3405",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
{
- "CalloutList": [{"Priority": "high", "Procedure": "next_level_support"}]
+ "CalloutList": [
+ {
+ "Priority": "high",
+ "Procedure": "next_level_support"
+ }
+ ]
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "A firmware security check has failed",
"Message": "A firmware security check has failed, most likely something is not configured correctly",
"Notes": [
@@ -1045,20 +888,21 @@
"Name": "xyz.openbmc_project.State.BMC.Error.MultiUserTargetFailure",
"Subsystem": "bmc_firmware",
"ComponentID": "0x3400",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x3406",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
{
- "CalloutList": [{"Priority": "high", "Procedure": "next_level_support"}]
+ "CalloutList": [
+ {
+ "Priority": "high",
+ "Procedure": "next_level_support"
+ }
+ ]
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "The system has failed to reach BMC Ready state",
"Message": "The system has failed to reach BMC Ready state, look for other errors",
"Notes": [
@@ -1074,20 +918,21 @@
"Name": "xyz.openbmc_project.State.Chassis.Error.PowerOnFailure",
"Subsystem": "bmc_firmware",
"ComponentID": "0x3400",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x3407",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
{
- "CalloutList": [{"Priority": "high", "Procedure": "next_level_support"}]
+ "CalloutList": [
+ {
+ "Priority": "high",
+ "Procedure": "next_level_support"
+ }
+ ]
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "The system has failed to reach chassis power on state",
"Message": "The system has failed to reach chassis power on state, look for other errors",
"Notes": [
@@ -1103,20 +948,21 @@
"Name": "xyz.openbmc_project.State.Chassis.Error.PowerOffFailure",
"Subsystem": "bmc_firmware",
"ComponentID": "0x3400",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x3408",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
{
- "CalloutList": [{"Priority": "high", "Procedure": "next_level_support"}]
+ "CalloutList": [
+ {
+ "Priority": "high",
+ "Procedure": "next_level_support"
+ }
+ ]
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "The system has failed to reach chassis power off state",
"Message": "The system has failed to reach chassis power off state, look for other errors",
"Notes": [
@@ -1132,20 +978,21 @@
"Name": "xyz.openbmc_project.State.Host.Error.HostStartFailure",
"Subsystem": "bmc_firmware",
"ComponentID": "0x3400",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x3409",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
{
- "CalloutList": [{"Priority": "high", "Procedure": "next_level_support"}]
+ "CalloutList": [
+ {
+ "Priority": "high",
+ "Procedure": "next_level_support"
+ }
+ ]
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "The system has failed to start the host firmware",
"Message": "The system has failed to start the host firmware, look for other errors",
"Notes": [
@@ -1161,20 +1008,21 @@
"Name": "xyz.openbmc_project.State.Host.Error.HostStartMinFailure",
"Subsystem": "bmc_firmware",
"ComponentID": "0x3400",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x3410",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
{
- "CalloutList": [{"Priority": "high", "Procedure": "next_level_support"}]
+ "CalloutList": [
+ {
+ "Priority": "high",
+ "Procedure": "next_level_support"
+ }
+ ]
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "The system has failed to start the host firmware",
"Message": "The system has failed to start the host firmware, look for other errors",
"Notes": [
@@ -1190,20 +1038,21 @@
"Name": "xyz.openbmc_project.State.Host.Error.HostShutdownFailure",
"Subsystem": "bmc_firmware",
"ComponentID": "0x3400",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x3411",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
{
- "CalloutList": [{"Priority": "high", "Procedure": "next_level_support"}]
+ "CalloutList": [
+ {
+ "Priority": "high",
+ "Procedure": "next_level_support"
+ }
+ ]
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "The system has failed to shutdown the host firmware",
"Message": "The system has failed to shutdown the host firmware, look for other errors",
"Notes": [
@@ -1219,20 +1068,21 @@
"Name": "xyz.openbmc_project.State.Host.Error.HostStopFailure",
"Subsystem": "bmc_firmware",
"ComponentID": "0x3400",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x3412",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
{
- "CalloutList": [{"Priority": "high", "Procedure": "next_level_support"}]
+ "CalloutList": [
+ {
+ "Priority": "high",
+ "Procedure": "next_level_support"
+ }
+ ]
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "The system has failed to stop the host firmware",
"Message": "The system has failed to stop the host firmware, look for other errors",
"Notes": [
@@ -1248,20 +1098,21 @@
"Name": "xyz.openbmc_project.State.Host.Error.HostRebootFailure",
"Subsystem": "bmc_firmware",
"ComponentID": "0x3400",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x3413",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
{
- "CalloutList": [{"Priority": "high", "Procedure": "next_level_support"}]
+ "CalloutList": [
+ {
+ "Priority": "high",
+ "Procedure": "next_level_support"
+ }
+ ]
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "The system has failed to reboot the host firmware",
"Message": "The system has failed to reboot the host firmware, look for other errors",
"Notes": [
@@ -1277,20 +1128,21 @@
"Name": "xyz.openbmc_project.State.Error.HostQuiesce",
"Subsystem": "bmc_firmware",
"ComponentID": "0x3400",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x3414",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
{
- "CalloutList": [{"Priority": "high", "Procedure": "next_level_support"}]
+ "CalloutList": [
+ {
+ "Priority": "high",
+ "Procedure": "next_level_support"
+ }
+ ]
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "The host firmware has failed to boot",
"Message": "The host firmware has failed to boot and has entered a Quiesce state. Look for other errors.",
"Notes": [
@@ -1306,21 +1158,17 @@
"Subsystem": "processor_chip",
"ComponentID": "0x3500",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x3500",
- "Words6To9":
- {
- "6":
- {
+ "Words6To9": {
+ "6": {
"Description": "[0:15] chip position, [16:23] command class, [24:31] command type",
"AdditionalDataPropSource": "SRC6"
}
}
},
- "Documentation":
- {
+ "Documentation": {
"Description": "chipop failure with SBE provided FFDC",
"Message": "chipop request failure reported by SBE",
"Notes": [
@@ -1337,13 +1185,10 @@
"Subsystem": "processor_chip",
"ComponentID": "0x3500",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x3501",
- "Words6To9":
- {
- "6":
- {
+ "Words6To9": {
+ "6": {
"Description": "[0:15] chip position, [16:23] command class, [24:31] command type",
"AdditionalDataPropSource": "SRC6"
}
@@ -1353,13 +1198,15 @@
"Callouts": [
{
"CalloutList": [
- { "Priority": "high", "Procedure": "next_level_support" }
+ {
+ "Priority": "high",
+ "Procedure": "next_level_support"
+ }
]
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "SBE chipop timeout",
"Message": "chipop timeout reported during SBE communication",
"Notes": [
@@ -1374,31 +1221,24 @@
"Subsystem": "processor_chip",
"ComponentID": "0x3500",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x3502",
- "Words6To9":
- {
- "6":
- {
+ "Words6To9": {
+ "6": {
"Description": "[0:15] chip position, [16:23] command class, [24:31] command type",
"AdditionalDataPropSource": "SRC6"
},
- "7":
- {
+ "7": {
"Description": "Value of SBE state",
"AdditionalDataPropSource": "SRC7"
}
}
},
- "Documentation":
- {
+ "Documentation": {
"Description": "The SBE on this processor is not in a state where chipOps can be issued",
"Message": "SBE Chipop is not allowed due to invalid SBE state ",
- "Notes": [
- "The severity is set by the creator."
- ]
+ "Notes": ["The severity is set by the creator."]
}
},
@@ -1406,23 +1246,19 @@
"Name": "org.open_power.Processor.Error.SbeBootFailure",
"Subsystem": "processor_chip",
"ComponentID": "0x3500",
- "ActionFlags": [ "service_action", "report", "call_home" ],
+ "ActionFlags": ["service_action", "report", "call_home"],
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x3503",
- "Words6To9":
- {
- "6":
- {
+ "Words6To9": {
+ "6": {
"Description": "[0:15] chip position",
"AdditionalDataPropSource": "SRC6"
}
}
},
- "Documentation":
- {
+ "Documentation": {
"Description": "Boot failure with SBE provided FFDC",
"Message": "Boot failure reported by SBE",
"Notes": [
@@ -1439,12 +1275,9 @@
"Subsystem": "processor_chip",
"ComponentID": "0x3500",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x3504",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
@@ -1476,8 +1309,7 @@
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "SBE Boot timeout",
"Message": "timeout reported during SBE boot process",
"Notes": [
@@ -1492,17 +1324,21 @@
"Subsystem": "cec_hardware",
"Severity": "non_error",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0xD138",
- "SymptomIDFields": [ "SRCWord3", "SRCWord4", "SRCWord5", "SRCWord6", "SRCWord7", "SRCWord8", "SRCWord9" ],
- "Words6To9":
- {
- }
+ "SymptomIDFields": [
+ "SRCWord3",
+ "SRCWord4",
+ "SRCWord5",
+ "SRCWord6",
+ "SRCWord7",
+ "SRCWord8",
+ "SRCWord9"
+ ],
+ "Words6To9": {}
},
- "Documentation":
- {
+ "Documentation": {
"Description": "Status shows TI special attention active",
"Message": "TI special attention detected",
"Notes": [
@@ -1517,26 +1353,20 @@
"Subsystem": "bmc_firmware",
"Severity": "unrecoverable_loss_of_function",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0xD13E",
- "Words6To9":
- {
- "6":
- {
+ "Words6To9": {
+ "6": {
"Description": "Error code from attention handler",
"AdditionalDataPropSource": "ERROR_CODE"
}
}
},
- "Documentation":
- {
+ "Documentation": {
"Description": "The attention handler encountered an error",
- "MessageArgSources" : ["SRCWord6"],
+ "MessageArgSources": ["SRCWord6"],
"Message": "Attention handler error %1",
- "Notes": [
- "Attention handler will provide error code"
- ]
+ "Notes": ["Attention handler will provide error code"]
}
},
@@ -1545,16 +1375,12 @@
"Subsystem": "processor_chip",
"Severity": "critical",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0xD16D",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
- "Documentation":
- {
+ "Documentation": {
"Description": "Status shows SBE vital attention active",
"Message": "SBE vital attention detected",
"Notes": [
@@ -1567,38 +1393,42 @@
{
"Name": "org.open_power.HwDiags.Error.Checkstop",
"PossibleSubsystems": [
- "processor", "processor_fru", "processor_unit", "processor_bus",
- "memory_ctlr", "memory_bus", "memory_dimm", "memory_fru",
- "phb", "cec_hardware", "cec_clocks", "cec_tod", "others"
+ "processor",
+ "processor_fru",
+ "processor_unit",
+ "processor_bus",
+ "memory_ctlr",
+ "memory_bus",
+ "memory_dimm",
+ "memory_fru",
+ "phb",
+ "cec_hardware",
+ "cec_clocks",
+ "cec_tod",
+ "others"
],
"Severity": "unrecoverable",
- "ActionFlags": [ "service_action", "report", "call_home" ],
+ "ActionFlags": ["service_action", "report", "call_home"],
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0xE510",
- "SymptomIDFields": [ "SRCWord6", "SRCWord7", "SRCWord8" ],
- "Words6To9":
- {
- "6":
- {
+ "SymptomIDFields": ["SRCWord6", "SRCWord7", "SRCWord8"],
+ "Words6To9": {
+ "6": {
"AdditionalDataPropSource": "SRC6"
},
- "7":
- {
+ "7": {
"AdditionalDataPropSource": "SRC7"
},
- "8":
- {
+ "8": {
"AdditionalDataPropSource": "SRC8"
}
}
},
- "Documentation":
- {
+ "Documentation": {
"Description": "A system checkstop attention has occurred",
- "MessageArgSources" : [ "SRCWord6", "SRCWord7", "SRCWord8" ],
+ "MessageArgSources": ["SRCWord6", "SRCWord7", "SRCWord8"],
"Message": "Error Signature: %1 %2 %3"
}
},
@@ -1606,38 +1436,42 @@
{
"Name": "org.open_power.HwDiags.Error.Predictive",
"PossibleSubsystems": [
- "processor", "processor_fru", "processor_unit", "processor_bus",
- "memory_ctlr", "memory_bus", "memory_dimm", "memory_fru",
- "phb", "cec_hardware", "cec_clocks", "cec_tod", "others"
+ "processor",
+ "processor_fru",
+ "processor_unit",
+ "processor_bus",
+ "memory_ctlr",
+ "memory_bus",
+ "memory_dimm",
+ "memory_fru",
+ "phb",
+ "cec_hardware",
+ "cec_clocks",
+ "cec_tod",
+ "others"
],
"Severity": "predictive",
- "ActionFlags": [ "service_action", "report", "call_home" ],
+ "ActionFlags": ["service_action", "report", "call_home"],
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0xE511",
- "SymptomIDFields": [ "SRCWord6", "SRCWord7", "SRCWord8" ],
- "Words6To9":
- {
- "6":
- {
+ "SymptomIDFields": ["SRCWord6", "SRCWord7", "SRCWord8"],
+ "Words6To9": {
+ "6": {
"AdditionalDataPropSource": "SRC6"
},
- "7":
- {
+ "7": {
"AdditionalDataPropSource": "SRC7"
},
- "8":
- {
+ "8": {
"AdditionalDataPropSource": "SRC8"
}
}
},
- "Documentation":
- {
+ "Documentation": {
"Description": "A hardware attention requiring service has occurred",
- "MessageArgSources" : [ "SRCWord6", "SRCWord7", "SRCWord8" ],
+ "MessageArgSources": ["SRCWord6", "SRCWord7", "SRCWord8"],
"Message": "Error Signature: %1 %2 %3"
}
},
@@ -1645,38 +1479,42 @@
{
"Name": "org.open_power.HwDiags.Error.Informational",
"PossibleSubsystems": [
- "processor", "processor_fru", "processor_unit", "processor_bus",
- "memory_ctlr", "memory_bus", "memory_dimm", "memory_fru",
- "phb", "cec_hardware", "cec_clocks", "cec_tod", "others"
+ "processor",
+ "processor_fru",
+ "processor_unit",
+ "processor_bus",
+ "memory_ctlr",
+ "memory_bus",
+ "memory_dimm",
+ "memory_fru",
+ "phb",
+ "cec_hardware",
+ "cec_clocks",
+ "cec_tod",
+ "others"
],
"Severity": "non_error",
- "ActionFlags": [ "hidden", "dont_report" ],
+ "ActionFlags": ["hidden", "dont_report"],
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0xE512",
- "SymptomIDFields": [ "SRCWord6", "SRCWord7", "SRCWord8" ],
- "Words6To9":
- {
- "6":
- {
+ "SymptomIDFields": ["SRCWord6", "SRCWord7", "SRCWord8"],
+ "Words6To9": {
+ "6": {
"AdditionalDataPropSource": "SRC6"
},
- "7":
- {
+ "7": {
"AdditionalDataPropSource": "SRC7"
},
- "8":
- {
+ "8": {
"AdditionalDataPropSource": "SRC8"
}
}
},
- "Documentation":
- {
+ "Documentation": {
"Description": "Manual analysis was initiated via the command line. FFDC only.",
- "MessageArgSources" : [ "SRCWord6", "SRCWord7", "SRCWord8" ],
+ "MessageArgSources": ["SRCWord6", "SRCWord7", "SRCWord8"],
"Message": "Error Signature: %1 %2 %3"
}
},
@@ -1911,11 +1749,10 @@
{
"Name": "xyz.openbmc_project.State.Shutdown.Power.Error.Blackout",
"Subsystem": "power",
- "ActionFlags": [ "report", "service_action" ],
+ "ActionFlags": ["report", "service_action"],
"ComponentID": "0x2700",
- "SRC":
- {
+ "SRC": {
"Type": "11",
"ReasonCode": "0x00AC",
"Words6To9": {}
@@ -1924,7 +1761,7 @@
"Callouts": [
{
"CalloutList": [
- { "Priority": "high", "SymbolicFRU": "ac_module"}
+ { "Priority": "high", "SymbolicFRU": "ac_module" }
]
}
],
@@ -1940,7 +1777,7 @@
},
{
- "Name": "xyz.openbmc_project.Power.PowerSupply.Error.PSKillFault",
+ "Name": "xyz.openbmc_project.Power.PowerSupply.Error.PSKillFault",
"Subsystem": "power_supply",
"ActionFlags": ["service_action", "report", "call_home"],
"ComponentID": "0x2700",
@@ -1962,8 +1799,7 @@
"Documentation": {
"Description": "A power supply fault is potentially preventing the power supply from allowing the system to power on.",
"Message": "Power supply PSKill_fault",
- "Notes": [
- ]
+ "Notes": []
}
},
@@ -1989,8 +1825,7 @@
"Documentation": {
"Description": "A power off was issued because a power fault was detected",
"Message": "A power off was issued because a power fault was detected",
- "Notes": [
- ]
+ "Notes": []
}
},
@@ -2038,8 +1873,7 @@
"Documentation": {
"Description": "A power off was issued because a regulator for standby power faulted",
"Message": "A power off was issued because a regulator for standby power faulted",
- "Notes": [
- ]
+ "Notes": []
}
},
@@ -2055,9 +1889,11 @@
},
"CalloutsUsingAD": {
- "ADName": "INPUT_NAME", "CalloutsWithTheirADValues": [
+ "ADName": "INPUT_NAME",
+ "CalloutsWithTheirADValues": [
{
- "ADValue": "PCIE_SLOT0", "Callouts": [
+ "ADValue": "PCIE_SLOT0",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C0" },
@@ -2067,7 +1903,8 @@
]
},
{
- "ADValue": "PCIE_SLOT1", "Callouts": [
+ "ADValue": "PCIE_SLOT1",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C1" },
@@ -2077,7 +1914,8 @@
]
},
{
- "ADValue": "PCIE_SLOT2", "Callouts": [
+ "ADValue": "PCIE_SLOT2",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C2" },
@@ -2087,7 +1925,8 @@
]
},
{
- "ADValue": "PCIE_SLOT3", "Callouts": [
+ "ADValue": "PCIE_SLOT3",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C3" },
@@ -2097,7 +1936,8 @@
]
},
{
- "ADValue": "PCIE_SLOT4", "Callouts": [
+ "ADValue": "PCIE_SLOT4",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C4" },
@@ -2107,7 +1947,8 @@
]
},
{
- "ADValue": "PCIE_SLOT5", "Callouts": [
+ "ADValue": "PCIE_SLOT5",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C5" },
@@ -2117,7 +1958,8 @@
]
},
{
- "ADValue": "PCIE_SLOT6", "Callouts": [
+ "ADValue": "PCIE_SLOT6",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C6" },
@@ -2127,7 +1969,8 @@
]
},
{
- "ADValue": "PCIE_SLOT7", "Callouts": [
+ "ADValue": "PCIE_SLOT7",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C7" },
@@ -2137,7 +1980,8 @@
]
},
{
- "ADValue": "PCIE_SLOT8", "Callouts": [
+ "ADValue": "PCIE_SLOT8",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C8" },
@@ -2147,7 +1991,8 @@
]
},
{
- "ADValue": "PCIE_SLOT9", "Callouts": [
+ "ADValue": "PCIE_SLOT9",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C9" },
@@ -2157,7 +2002,8 @@
]
},
{
- "ADValue": "PCIE_SLOT10", "Callouts": [
+ "ADValue": "PCIE_SLOT10",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C10" },
@@ -2167,7 +2013,8 @@
]
},
{
- "ADValue": "PCIE_SLOT11", "Callouts": [
+ "ADValue": "PCIE_SLOT11",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C11" },
@@ -2177,241 +2024,337 @@
]
},
{
- "ADValue": "PGOOD_12A", "Callouts": [
+ "ADValue": "PGOOD_12A",
+ "Callouts": [
{
"CalloutList": [
- { "Priority": "high", "SymbolicFRU": "pgood_part" }
+ {
+ "Priority": "high",
+ "SymbolicFRU": "pgood_part"
+ }
]
}
]
},
{
- "ADValue": "PGOOD_12B", "Callouts": [
+ "ADValue": "PGOOD_12B",
+ "Callouts": [
{
"CalloutList": [
- { "Priority": "high", "SymbolicFRU": "pgood_part" }
+ {
+ "Priority": "high",
+ "SymbolicFRU": "pgood_part"
+ }
]
}
]
},
{
- "ADValue": "PGOOD_12C", "Callouts": [
+ "ADValue": "PGOOD_12C",
+ "Callouts": [
{
"CalloutList": [
- { "Priority": "high", "SymbolicFRU": "pgood_part" }
+ {
+ "Priority": "high",
+ "SymbolicFRU": "pgood_part"
+ }
]
}
]
},
{
- "ADValue": "PGOOD_12D", "Callouts": [
+ "ADValue": "PGOOD_12D",
+ "Callouts": [
{
"CalloutList": [
- { "Priority": "high", "SymbolicFRU": "pgood_part" }
+ {
+ "Priority": "high",
+ "SymbolicFRU": "pgood_part"
+ }
]
}
]
},
{
- "ADValue": "PGOOD_12L", "Callouts": [
+ "ADValue": "PGOOD_12L",
+ "Callouts": [
{
"CalloutList": [
- { "Priority": "high", "SymbolicFRU": "pgood_part" }
+ {
+ "Priority": "high",
+ "SymbolicFRU": "pgood_part"
+ }
]
}
]
},
{
- "ADValue": "PGOOD_12M", "Callouts": [
+ "ADValue": "PGOOD_12M",
+ "Callouts": [
{
"CalloutList": [
- { "Priority": "high", "SymbolicFRU": "pgood_part" }
+ {
+ "Priority": "high",
+ "SymbolicFRU": "pgood_part"
+ }
]
}
]
},
{
- "ADValue": "PGOOD_12N", "Callouts": [
+ "ADValue": "PGOOD_12N",
+ "Callouts": [
{
"CalloutList": [
- { "Priority": "high", "SymbolicFRU": "pgood_part" }
+ {
+ "Priority": "high",
+ "SymbolicFRU": "pgood_part"
+ }
]
}
]
},
{
- "ADValue": "PGOOD_12P", "Callouts": [
+ "ADValue": "PGOOD_12P",
+ "Callouts": [
{
"CalloutList": [
- { "Priority": "high", "SymbolicFRU": "pgood_part" }
+ {
+ "Priority": "high",
+ "SymbolicFRU": "pgood_part"
+ }
]
}
]
},
{
- "ADValue": "PGOOD_12PCIE", "Callouts": [
+ "ADValue": "PGOOD_12PCIE",
+ "Callouts": [
{
"CalloutList": [
- { "Priority": "high", "SymbolicFRU": "pgood_part" }
+ {
+ "Priority": "high",
+ "SymbolicFRU": "pgood_part"
+ }
]
}
]
},
{
- "ADValue": "PGOOD_12Q", "Callouts": [
+ "ADValue": "PGOOD_12Q",
+ "Callouts": [
{
"CalloutList": [
- { "Priority": "high", "SymbolicFRU": "pgood_part" }
+ {
+ "Priority": "high",
+ "SymbolicFRU": "pgood_part"
+ }
]
}
]
},
{
- "ADValue": "PGOOD_12R", "Callouts": [
+ "ADValue": "PGOOD_12R",
+ "Callouts": [
{
"CalloutList": [
- { "Priority": "high", "SymbolicFRU": "pgood_part" }
+ {
+ "Priority": "high",
+ "SymbolicFRU": "pgood_part"
+ }
]
}
]
},
{
- "ADValue": "PGOOD_VDN_DCM0", "Callouts": [
+ "ADValue": "PGOOD_VDN_DCM0",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C14" },
- { "Priority": "medium", "LocCode": "P0-C15" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C15"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "PGOOD_VDN_DCM1", "Callouts": [
+ "ADValue": "PGOOD_VDN_DCM1",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C23" },
- { "Priority": "medium", "LocCode": "P0-C24" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C24"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "PGOOD_VCS_DCM0", "Callouts": [
+ "ADValue": "PGOOD_VCS_DCM0",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C14" },
- { "Priority": "medium", "LocCode": "P0-C15" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C15"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "PGOOD_VCS_DCM1", "Callouts": [
+ "ADValue": "PGOOD_VCS_DCM1",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C23" },
- { "Priority": "medium", "LocCode": "P0-C24" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C24"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "PGOOD_VIO_DCM0", "Callouts": [
+ "ADValue": "PGOOD_VIO_DCM0",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C14" },
- { "Priority": "medium", "LocCode": "P0-C15" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C15"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "PGOOD_VIO_DCM1", "Callouts": [
+ "ADValue": "PGOOD_VIO_DCM1",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C23" },
- { "Priority": "medium", "LocCode": "P0-C24" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C24"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "PGOOD_VPCIE_DCM0", "Callouts": [
+ "ADValue": "PGOOD_VPCIE_DCM0",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C14" },
- { "Priority": "medium", "LocCode": "P0-C15" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C15"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "PGOOD_VPCIE_DCM1", "Callouts": [
+ "ADValue": "PGOOD_VPCIE_DCM1",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C23" },
- { "Priority": "medium", "LocCode": "P0-C24" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C24"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "CP0_VPCIE", "Callouts": [
+ "ADValue": "CP0_VPCIE",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C58" },
- { "Priority": "medium", "LocCode": "P0-C61" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C61"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "CP1_VPCIE", "Callouts": [
+ "ADValue": "CP1_VPCIE",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C16" },
- { "Priority": "medium", "LocCode": "P0-C14" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C14"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "CP2_VPCIE", "Callouts": [
+ "ADValue": "CP2_VPCIE",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C16" },
- { "Priority": "medium", "LocCode": "P0-C19" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C19"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "CP3_VPCIE", "Callouts": [
+ "ADValue": "CP3_VPCIE",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C58" },
- { "Priority": "medium", "LocCode": "P0-C56" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C56"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "5.0V_USB_front", "Callouts": [
+ "ADValue": "5.0V_USB_front",
+ "Callouts": [
{
"CalloutList": [
- { "Priority": "high", "SymbolicFRU": "usb_pgood" },
+ {
+ "Priority": "high",
+ "SymbolicFRU": "usb_pgood"
+ },
{ "Priority": "low", "LocCode": "P1" },
{ "Priority": "low", "LocCode": "P0" }
]
@@ -2419,95 +2362,128 @@
]
},
{
- "ADValue": "CP0_VDN", "Callouts": [
+ "ADValue": "CP0_VDN",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C63" },
- { "Priority": "medium", "LocCode": "P0-C61" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C61"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "CP1_VDN", "Callouts": [
+ "ADValue": "CP1_VDN",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C12" },
- { "Priority": "medium", "LocCode": "P0-C14" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C14"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "CP2_VDN", "Callouts": [
+ "ADValue": "CP2_VDN",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C21" },
- { "Priority": "medium", "LocCode": "P0-C19" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C19"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "CP3_VDN", "Callouts": [
+ "ADValue": "CP3_VDN",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C54" },
- { "Priority": "medium", "LocCode": "P0-C56" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C56"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "CP0_VIO", "Callouts": [
+ "ADValue": "CP0_VIO",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C63" },
- { "Priority": "medium", "LocCode": "P0-C61" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C61"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "CP1_VIO", "Callouts": [
+ "ADValue": "CP1_VIO",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C12" },
- { "Priority": "medium", "LocCode": "P0-C14" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C14"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "CP2_VIO", "Callouts": [
+ "ADValue": "CP2_VIO",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C21" },
- { "Priority": "medium", "LocCode": "P0-C19" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C19"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "CP3_VIO", "Callouts": [
+ "ADValue": "CP3_VIO",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C54" },
- { "Priority": "medium", "LocCode": "P0-C56" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C56"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "PGOOD_PSU1", "Callouts": [
+ "ADValue": "PGOOD_PSU1",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "E0" }
@@ -2516,7 +2492,8 @@
]
},
{
- "ADValue": "PGOOD_PSU2", "Callouts": [
+ "ADValue": "PGOOD_PSU2",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "E1" }
@@ -2525,7 +2502,8 @@
]
},
{
- "ADValue": "PGOOD_PSU3", "Callouts": [
+ "ADValue": "PGOOD_PSU3",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "E2" }
@@ -2534,7 +2512,8 @@
]
},
{
- "ADValue": "PGOOD_PSU4", "Callouts": [
+ "ADValue": "PGOOD_PSU4",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "E3" }
@@ -2548,8 +2527,7 @@
"Documentation": {
"Description": "The power sequencer chip detected a PGOOD fault",
"Message": "The power sequencer chip detected a PGOOD fault",
- "Notes": [
- ]
+ "Notes": []
}
},
@@ -2565,28 +2543,38 @@
},
"CalloutsUsingAD": {
- "ADName": "RAIL_NAME", "CalloutsWithTheirADValues": [
+ "ADName": "RAIL_NAME",
+ "CalloutsWithTheirADValues": [
{
- "ADValue": "12.0V", "Callouts": [
+ "ADValue": "12.0V",
+ "Callouts": [
{
"CalloutList": [
- { "Priority": "high", "SymbolicFRU": "pgood_part" }
+ {
+ "Priority": "high",
+ "SymbolicFRU": "pgood_part"
+ }
]
}
]
},
{
- "ADValue": "5.0V_USB", "Callouts": [
+ "ADValue": "5.0V_USB",
+ "Callouts": [
{
"CalloutList": [
- { "Priority": "high", "SymbolicFRU": "usb_pgood" },
+ {
+ "Priority": "high",
+ "SymbolicFRU": "usb_pgood"
+ },
{ "Priority": "medium", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "5.0V_DASD", "Callouts": [
+ "ADValue": "5.0V_DASD",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "medium", "LocCode": "P1" },
@@ -2597,7 +2585,8 @@
]
},
{
- "ADValue": "3.3VA", "Callouts": [
+ "ADValue": "3.3VA",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0" }
@@ -2606,7 +2595,8 @@
]
},
{
- "ADValue": "3.3VB", "Callouts": [
+ "ADValue": "3.3VB",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0" }
@@ -2615,20 +2605,31 @@
]
},
{
- "ADValue": "3V3IO", "Callouts": [
+ "ADValue": "3V3IO",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C17" },
- { "Priority": "medium", "LocCode": "P0-C96" },
- { "Priority": "medium", "LocCode": "P0-C0" },
- { "Priority": "medium", "SymbolicFRU": "pcie_hot_plug" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C96"
+ },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C0"
+ },
+ {
+ "Priority": "medium",
+ "SymbolicFRU": "pcie_hot_plug"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "1.5V", "Callouts": [
+ "ADValue": "1.5V",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0" }
@@ -2637,7 +2638,8 @@
]
},
{
- "ADValue": "1.1V", "Callouts": [
+ "ADValue": "1.1V",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0" }
@@ -2646,392 +2648,539 @@
]
},
{
- "ADValue": "VDDA_DCM0", "Callouts": [
+ "ADValue": "VDDA_DCM0",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C14" },
- { "Priority": "medium", "LocCode": "P0-C15" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C15"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "VDDB_DCM0", "Callouts": [
+ "ADValue": "VDDB_DCM0",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C14" },
- { "Priority": "medium", "LocCode": "P0-C15" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C15"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "VDDA_DCM1", "Callouts": [
+ "ADValue": "VDDA_DCM1",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C23" },
- { "Priority": "medium", "LocCode": "P0-C24" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C24"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "VDDB_DCM1", "Callouts": [
+ "ADValue": "VDDB_DCM1",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C23" },
- { "Priority": "medium", "LocCode": "P0-C24" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C24"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "CP03_AVDD", "Callouts": [
+ "ADValue": "CP03_AVDD",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C58" },
- { "Priority": "medium", "LocCode": "P0-C61" },
- { "Priority": "medium", "LocCode": "P0-C56" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C61"
+ },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C56"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "CP12_AVDD", "Callouts": [
+ "ADValue": "CP12_AVDD",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C16" },
- { "Priority": "medium", "LocCode": "P0-C14" },
- { "Priority": "medium", "LocCode": "P0-C19" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C14"
+ },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C19"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "CP0_VDD0", "Callouts": [
+ "ADValue": "CP0_VDD0",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C62" },
- { "Priority": "medium", "LocCode": "P0-C61" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C61"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "CP0_VDD1", "Callouts": [
+ "ADValue": "CP0_VDD1",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C60" },
- { "Priority": "medium", "LocCode": "P0-C61" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C61"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "CP1_VDD0", "Callouts": [
+ "ADValue": "CP1_VDD0",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C13" },
- { "Priority": "medium", "LocCode": "P0-C14" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C14"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "CP1_VDD1", "Callouts": [
+ "ADValue": "CP1_VDD1",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C15" },
- { "Priority": "medium", "LocCode": "P0-C14" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C14"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "CP2_VDD0", "Callouts": [
+ "ADValue": "CP2_VDD0",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C18" },
- { "Priority": "medium", "LocCode": "P0-C19" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C19"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "CP2_VDD1", "Callouts": [
+ "ADValue": "CP2_VDD1",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C20" },
- { "Priority": "medium", "LocCode": "P0-C19" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C19"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "CP3_VDD0", "Callouts": [
+ "ADValue": "CP3_VDD0",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C57" },
- { "Priority": "medium", "LocCode": "P0-C56" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C56"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "CP3_VDD1", "Callouts": [
+ "ADValue": "CP3_VDD1",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C55" },
- { "Priority": "medium", "LocCode": "P0-C56" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C56"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "CP0_VCS0", "Callouts": [
+ "ADValue": "CP0_VCS0",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C63" },
- { "Priority": "medium", "LocCode": "P0-C61" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C61"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "CP0_VCS1", "Callouts": [
+ "ADValue": "CP0_VCS1",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C59" },
- { "Priority": "medium", "LocCode": "P0-C61" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C61"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "CP1_VCS0", "Callouts": [
+ "ADValue": "CP1_VCS0",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C12" },
- { "Priority": "medium", "LocCode": "P0-C14" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C14"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "CP1_VCS1", "Callouts": [
+ "ADValue": "CP1_VCS1",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C16" },
- { "Priority": "medium", "LocCode": "P0-C14" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C14"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "CP2_VCS0", "Callouts": [
+ "ADValue": "CP2_VCS0",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C17" },
- { "Priority": "medium", "LocCode": "P0-C19" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C19"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "CP2_VCS1", "Callouts": [
+ "ADValue": "CP2_VCS1",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C21" },
- { "Priority": "medium", "LocCode": "P0-C19" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C19"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "CP3_VCS0", "Callouts": [
+ "ADValue": "CP3_VCS0",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C58" },
- { "Priority": "medium", "LocCode": "P0-C56" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C56"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "CP3_VCS1", "Callouts": [
+ "ADValue": "CP3_VCS1",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C54" },
- { "Priority": "medium", "LocCode": "P0-C56" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C56"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "CP0_VDN", "Callouts": [
+ "ADValue": "CP0_VDN",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C63" },
- { "Priority": "medium", "LocCode": "P0-C61" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C61"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "CP1_VDN", "Callouts": [
+ "ADValue": "CP1_VDN",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C12" },
- { "Priority": "medium", "LocCode": "P0-C14" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C14"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "CP2_VDN", "Callouts": [
+ "ADValue": "CP2_VDN",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C21" },
- { "Priority": "medium", "LocCode": "P0-C19" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C19"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "CP3_VDN", "Callouts": [
+ "ADValue": "CP3_VDN",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C54" },
- { "Priority": "medium", "LocCode": "P0-C56" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C56"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "CP0_VIO", "Callouts": [
+ "ADValue": "CP0_VIO",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C63" },
- { "Priority": "medium", "LocCode": "P0-C61" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C61"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "CP1_VIO", "Callouts": [
+ "ADValue": "CP1_VIO",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C12" },
- { "Priority": "medium", "LocCode": "P0-C14" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C14"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "CP2_VIO", "Callouts": [
+ "ADValue": "CP2_VIO",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C21" },
- { "Priority": "medium", "LocCode": "P0-C19" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C19"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "CP3_VIO", "Callouts": [
+ "ADValue": "CP3_VIO",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C54" },
- { "Priority": "medium", "LocCode": "P0-C56" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C56"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "CP0_VPCIE", "Callouts": [
+ "ADValue": "CP0_VPCIE",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C58" },
- { "Priority": "medium", "LocCode": "P0-C61" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C61"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "CP1_VPCIE", "Callouts": [
+ "ADValue": "CP1_VPCIE",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C16" },
- { "Priority": "medium", "LocCode": "P0-C14" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C14"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "CP2_VPCIE", "Callouts": [
+ "ADValue": "CP2_VPCIE",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C16" },
- { "Priority": "medium", "LocCode": "P0-C19" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C19"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "CP3_VPCIE", "Callouts": [
+ "ADValue": "CP3_VPCIE",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C58" },
- { "Priority": "medium", "LocCode": "P0-C56" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C56"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "12.0VCS", "Callouts": [
+ "ADValue": "12.0VCS",
+ "Callouts": [
{
"CalloutList": [
- { "Priority": "high", "SymbolicFRU": "pgood_part" }
+ {
+ "Priority": "high",
+ "SymbolicFRU": "pgood_part"
+ }
]
}
]
},
{
- "ADValue": "3.3VCS", "Callouts": [
+ "ADValue": "3.3VCS",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0" }
@@ -3040,7 +3189,8 @@
]
},
{
- "ADValue": "1.1V_Current", "Callouts": [
+ "ADValue": "1.1V_Current",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0" }
@@ -3049,17 +3199,22 @@
]
},
{
- "ADValue": "5.0V_USB_Current", "Callouts": [
+ "ADValue": "5.0V_USB_Current",
+ "Callouts": [
{
"CalloutList": [
- { "Priority": "high", "SymbolicFRU": "usb_pgood" },
+ {
+ "Priority": "high",
+ "SymbolicFRU": "usb_pgood"
+ },
{ "Priority": "medium", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "5.0V_DASD_Current", "Callouts": [
+ "ADValue": "5.0V_DASD_Current",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "medium", "LocCode": "P1" },
@@ -3070,43 +3225,60 @@
]
},
{
- "ADValue": "12.0VN", "Callouts": [
+ "ADValue": "12.0VN",
+ "Callouts": [
{
"CalloutList": [
- { "Priority": "high", "SymbolicFRU": "pgood_part" }
+ {
+ "Priority": "high",
+ "SymbolicFRU": "pgood_part"
+ }
]
}
]
},
{
- "ADValue": "12.0VP", "Callouts": [
+ "ADValue": "12.0VP",
+ "Callouts": [
{
"CalloutList": [
- { "Priority": "high", "SymbolicFRU": "pgood_part" }
+ {
+ "Priority": "high",
+ "SymbolicFRU": "pgood_part"
+ }
]
}
]
},
{
- "ADValue": "12.0VQ", "Callouts": [
+ "ADValue": "12.0VQ",
+ "Callouts": [
{
"CalloutList": [
- { "Priority": "high", "SymbolicFRU": "pgood_part" }
+ {
+ "Priority": "high",
+ "SymbolicFRU": "pgood_part"
+ }
]
}
]
},
{
- "ADValue": "12.0VR", "Callouts": [
+ "ADValue": "12.0VR",
+ "Callouts": [
{
"CalloutList": [
- { "Priority": "high", "SymbolicFRU": "pgood_part" }
+ {
+ "Priority": "high",
+ "SymbolicFRU": "pgood_part"
+ }
]
}
]
},
{
- "ADValue": "ThermalDiode1", "Callouts": [
+ "ADValue": "ThermalDiode1",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0" }
@@ -3115,7 +3287,8 @@
]
},
{
- "ADValue": "ThermalDiode2", "Callouts": [
+ "ADValue": "ThermalDiode2",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0" }
@@ -3124,7 +3297,8 @@
]
},
{
- "ADValue": "ThermalDiode3", "Callouts": [
+ "ADValue": "ThermalDiode3",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0" }
@@ -3133,7 +3307,8 @@
]
},
{
- "ADValue": "ThermalDiode4", "Callouts": [
+ "ADValue": "ThermalDiode4",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0" }
@@ -3142,88 +3317,120 @@
]
},
{
- "ADValue": "VDN_DCM0", "Callouts": [
+ "ADValue": "VDN_DCM0",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C14" },
- { "Priority": "medium", "LocCode": "P0-C15" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C15"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "VDN_DCM1", "Callouts": [
+ "ADValue": "VDN_DCM1",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C23" },
- { "Priority": "medium", "LocCode": "P0-C24" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C24"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "VCS_DCM0", "Callouts": [
+ "ADValue": "VCS_DCM0",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C14" },
- { "Priority": "medium", "LocCode": "P0-C15" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C15"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "VCS_DCM1", "Callouts": [
+ "ADValue": "VCS_DCM1",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C23" },
- { "Priority": "medium", "LocCode": "P0-C24" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C24"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "VIO_DCM0", "Callouts": [
+ "ADValue": "VIO_DCM0",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C14" },
- { "Priority": "medium", "LocCode": "P0-C15" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C15"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "VIO_DCM1", "Callouts": [
+ "ADValue": "VIO_DCM1",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C23" },
- { "Priority": "medium", "LocCode": "P0-C24" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C24"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "VPCIE_DCM0", "Callouts": [
+ "ADValue": "VPCIE_DCM0",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C14" },
- { "Priority": "medium", "LocCode": "P0-C15" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C15"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
]
},
{
- "ADValue": "VPCIE_DCM1", "Callouts": [
+ "ADValue": "VPCIE_DCM1",
+ "Callouts": [
{
"CalloutList": [
{ "Priority": "high", "LocCode": "P0-C23" },
- { "Priority": "medium", "LocCode": "P0-C24" },
+ {
+ "Priority": "medium",
+ "LocCode": "P0-C24"
+ },
{ "Priority": "low", "LocCode": "P0" }
]
}
@@ -3235,8 +3442,7 @@
"Documentation": {
"Description": "The power sequencer chip detected a voltage fault",
"Message": "The power sequencer chip detected a voltage fault",
- "Notes": [
- ]
+ "Notes": []
}
},
@@ -3332,8 +3538,7 @@
"Documentation": {
"Description": "The Uninterruptible Power Supply (UPS) battery is discharging and providing power to the system due to a utility failure",
"Message": "The Uninterruptible Power Supply (UPS) battery is discharging and providing power to the system due to a utility failure",
- "Notes": [
- ]
+ "Notes": []
}
},
@@ -3353,8 +3558,7 @@
"Documentation": {
"Description": "The Uninterruptible Power Supply (UPS) battery level is low",
"Message": "The Uninterruptible Power Supply (UPS) battery level is low",
- "Notes": [
- ]
+ "Notes": []
}
},
@@ -3432,17 +3636,14 @@
"Callouts": [
{
- "CalloutList": [
- { "Priority": "high", "LocCode": "P0" }
- ]
+ "CalloutList": [{ "Priority": "high", "LocCode": "P0" }]
}
],
"Documentation": {
"Description": "The power sequencer chip detected a fault",
"Message": "The power sequencer chip detected a fault",
- "Notes": [
- ]
+ "Notes": []
}
},
@@ -3460,17 +3661,14 @@
"Callouts": [
{
- "CalloutList": [
- { "Priority": "high", "LocCode": "P0" }
- ]
+ "CalloutList": [{ "Priority": "high", "LocCode": "P0" }]
}
],
"Documentation": {
"Description": "System power failed to turn on within timeout period",
"Message": "System power failed to turn on within timeout period",
- "Notes": [
- ]
+ "Notes": []
}
},
@@ -3488,17 +3686,14 @@
"Callouts": [
{
- "CalloutList": [
- { "Priority": "high", "LocCode": "P0" }
- ]
+ "CalloutList": [{ "Priority": "high", "LocCode": "P0" }]
}
],
"Documentation": {
"Description": "System power failed to turn off within timeout period",
"Message": "System power failed to turn off within timeout period",
- "Notes": [
- ]
+ "Notes": []
}
},
@@ -3647,9 +3842,9 @@
"System": "ibm,rainier",
"CalloutList": [
{
- "Priority": "high",
- "SymbolicFRUTrusted": "air_mover",
- "UseInventoryLocCode": true
+ "Priority": "high",
+ "SymbolicFRUTrusted": "air_mover",
+ "UseInventoryLocCode": true
},
{
"Priority": "low",
@@ -3661,9 +3856,9 @@
"System": "ibm,everest",
"CalloutList": [
{
- "Priority": "high",
- "SymbolicFRUTrusted": "air_mover",
- "UseInventoryLocCode": true
+ "Priority": "high",
+ "SymbolicFRUTrusted": "air_mover",
+ "UseInventoryLocCode": true
},
{
"Priority": "low",
@@ -3705,15 +3900,11 @@
"Callouts": [
{
"System": "ibm,rainier",
- "CalloutList": [
- {"Priority": "medium", "LocCode": "P0"}
- ]
+ "CalloutList": [{ "Priority": "medium", "LocCode": "P0" }]
},
{
"System": "ibm,everest",
- "CalloutList": [
- {"Priority": "medium", "LocCode": "P1"}
- ]
+ "CalloutList": [{ "Priority": "medium", "LocCode": "P1" }]
}
],
@@ -3748,18 +3939,26 @@
{
"System": "ibm,rainier",
"CalloutList": [
- {"Priority": "high", "LocCode": "P0-C5"},
- {"Priority": "medium_group_a", "LocCode": "P0-T12", "SymbolicFRUTrusted": "fan_cable"},
- {"Priority": "medium_group_a", "LocCode": "P0-T17", "SymbolicFRUTrusted": "cable_continued"},
- {"Priority": "low", "LocCode": "P0"}
+ { "Priority": "high", "LocCode": "P0-C5" },
+ {
+ "Priority": "medium_group_a",
+ "LocCode": "P0-T12",
+ "SymbolicFRUTrusted": "fan_cable"
+ },
+ {
+ "Priority": "medium_group_a",
+ "LocCode": "P0-T17",
+ "SymbolicFRUTrusted": "cable_continued"
+ },
+ { "Priority": "low", "LocCode": "P0" }
]
},
{
"System": "ibm,everest",
"CalloutList": [
- {"Priority": "high", "LocCode": "P0-C0"},
- {"Priority": "medium", "LocCode": "P1"},
- {"Priority": "low", "LocCode": "P0"}
+ { "Priority": "high", "LocCode": "P0-C0" },
+ { "Priority": "medium", "LocCode": "P1" },
+ { "Priority": "low", "LocCode": "P0" }
]
}
],
@@ -3777,45 +3976,53 @@
},
{
- "Name": "xyz.openbmc_project.Fan.Presence.Error.GPIODeviceUnavailable",
- "Subsystem": "power_fans",
- "ComponentID": "0x2800",
- "Severity": "unrecoverable_redundancy_loss",
- "ActionFlags": ["service_action", "report", "call_home"],
+ "Name": "xyz.openbmc_project.Fan.Presence.Error.GPIODeviceUnavailable",
+ "Subsystem": "power_fans",
+ "ComponentID": "0x2800",
+ "Severity": "unrecoverable_redundancy_loss",
+ "ActionFlags": ["service_action", "report", "call_home"],
- "SRC": {
- "Type": "11",
- "ReasonCode": "0x76F4",
- "Words6To9": {}
- },
+ "SRC": {
+ "Type": "11",
+ "ReasonCode": "0x76F4",
+ "Words6To9": {}
+ },
- "Callouts": [
- {
- "System" : "ibm,rainier",
- "CalloutList": [
- {"Priority": "high", "LocCode": "P0-C5"},
- {"Priority": "medium_group_a", "LocCode": "P0-T12","SymbolicFRUTrusted": "fan_cable"},
- {"Priority": "medium_group_a", "LocCode": "P0-T17","SymbolicFRUTrusted": "cable_continued"},
- {"Priority": "low", "LocCode": "P0"}
- ]
- },
- {
- "System" : "ibm,everest",
- "CalloutList": [
- {"Priority": "high", "LocCode": "P0-C0"},
- {"Priority": "medium", "LocCode": "P1"},
- {"Priority": "low", "LocCode": "P0"}
- ]
- }
- ],
+ "Callouts": [
+ {
+ "System": "ibm,rainier",
+ "CalloutList": [
+ { "Priority": "high", "LocCode": "P0-C5" },
+ {
+ "Priority": "medium_group_a",
+ "LocCode": "P0-T12",
+ "SymbolicFRUTrusted": "fan_cable"
+ },
+ {
+ "Priority": "medium_group_a",
+ "LocCode": "P0-T17",
+ "SymbolicFRUTrusted": "cable_continued"
+ },
+ { "Priority": "low", "LocCode": "P0" }
+ ]
+ },
+ {
+ "System": "ibm,everest",
+ "CalloutList": [
+ { "Priority": "high", "LocCode": "P0-C0" },
+ { "Priority": "medium", "LocCode": "P1" },
+ { "Priority": "low", "LocCode": "P0" }
+ ]
+ }
+ ],
- "Documentation": {
- "Description": "Fan GPIO sensors not present",
- "Message": "Fan GPIO sensors not present",
- "Notes": [
- "The device that reports fan presence is not functioning."
- ]
- }
+ "Documentation": {
+ "Description": "Fan GPIO sensors not present",
+ "Message": "Fan GPIO sensors not present",
+ "Notes": [
+ "The device that reports fan presence is not functioning."
+ ]
+ }
},
{
@@ -3838,7 +4045,10 @@
"Callouts": [
{
"CalloutList": [
- { "Priority": "high", "SymbolicFRU": "ambient_temp" }
+ {
+ "Priority": "high",
+ "SymbolicFRU": "ambient_temp"
+ }
]
}
]
@@ -3889,7 +4099,10 @@
"Callouts": [
{
"CalloutList": [
- { "Priority": "high", "SymbolicFRU": "ambient_temp_back" }
+ {
+ "Priority": "high",
+ "SymbolicFRU": "ambient_temp_back"
+ }
]
}
]
@@ -3927,7 +4140,10 @@
"Callouts": [
{
"CalloutList": [
- { "Priority": "high", "SymbolicFRU": "ambient_temp" }
+ {
+ "Priority": "high",
+ "SymbolicFRU": "ambient_temp"
+ }
]
}
]
@@ -3978,7 +4194,10 @@
"Callouts": [
{
"CalloutList": [
- { "Priority": "high", "SymbolicFRU": "ambient_temp_back" }
+ {
+ "Priority": "high",
+ "SymbolicFRU": "ambient_temp_back"
+ }
]
}
]
@@ -4016,7 +4235,10 @@
"Callouts": [
{
"CalloutList": [
- { "Priority": "high", "SymbolicFRU": "ambient_temp" }
+ {
+ "Priority": "high",
+ "SymbolicFRU": "ambient_temp"
+ }
]
}
]
@@ -4067,7 +4289,10 @@
"Callouts": [
{
"CalloutList": [
- { "Priority": "high", "SymbolicFRU": "ambient_temp_back" }
+ {
+ "Priority": "high",
+ "SymbolicFRU": "ambient_temp_back"
+ }
]
}
]
@@ -4101,8 +4326,8 @@
{
"CalloutList": [
{
- "Priority": "high",
- "SymbolicFRU": "ambient_temp"
+ "Priority": "high",
+ "SymbolicFRU": "ambient_temp"
}
]
}
@@ -4135,8 +4360,8 @@
{
"CalloutList": [
{
- "Priority": "high",
- "SymbolicFRU": "ambient_temp_back"
+ "Priority": "high",
+ "SymbolicFRU": "ambient_temp_back"
}
]
}
@@ -4163,8 +4388,8 @@
{
"CalloutList": [
{
- "Priority": "high",
- "SymbolicFRU": "ambient_temp"
+ "Priority": "high",
+ "SymbolicFRU": "ambient_temp"
}
]
}
@@ -4200,7 +4425,10 @@
"Callouts": [
{
"CalloutList": [
- { "Priority": "high", "SymbolicFRU": "altitude" }
+ {
+ "Priority": "high",
+ "SymbolicFRU": "altitude"
+ }
]
}
]
@@ -4372,10 +4600,8 @@
"SRC": {
"ReasonCode": "0x4000",
- "Words6To9":
- {
- "6":
- {
+ "Words6To9": {
+ "6": {
"Description": "Errno of the failure.",
"AdditionalDataPropSource": "CALLOUT_ERRNO"
}
@@ -4400,9 +4626,7 @@
"SRC": {
"ReasonCode": "0x4001",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Documentation": {
@@ -4424,9 +4648,7 @@
"SRC": {
"ReasonCode": "0x4002",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Documentation": {
@@ -4447,9 +4669,7 @@
"SRC": {
"ReasonCode": "0x4003",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
@@ -4479,9 +4699,7 @@
"SRC": {
"ReasonCode": "0x4004",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Documentation": {
@@ -4502,9 +4720,7 @@
"SRC": {
"ReasonCode": "0x4005",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
@@ -4533,16 +4749,12 @@
"SRC": {
"ReasonCode": "0x4006",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
{
- "CalloutList": [
- { "Priority": "high", "LocCode": "P0" }
- ]
+ "CalloutList": [{ "Priority": "high", "LocCode": "P0" }]
}
],
@@ -4564,9 +4776,7 @@
"SRC": {
"ReasonCode": "0x4007",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
@@ -4595,9 +4805,7 @@
"SRC": {
"ReasonCode": "0x4008",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
@@ -4627,9 +4835,7 @@
"SRC": {
"ReasonCode": "0x4009",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Documentation": {
@@ -4657,9 +4863,7 @@
"Documentation": {
"Description": "Button Handler Failure",
"Message": "Input Device path failure",
- "Notes": [
- "Button events will not be processed."
- ]
+ "Notes": ["Button events will not be processed."]
}
},
@@ -4693,20 +4897,21 @@
"Words6To9": {}
},
- "Callouts": [{
- "CalloutList": [{
- "Priority": "high",
- "Procedure": "bmc_code"
- }]
- }],
+ "Callouts": [
+ {
+ "CalloutList": [
+ {
+ "Priority": "high",
+ "Procedure": "bmc_code"
+ }
+ ]
+ }
+ ],
"Documentation": {
"Description": "Host Communication failure",
"Message": "Error in sending message to host",
- "Notes": [
- "Failure from PLDM sending message to",
- "Host"
- ]
+ "Notes": ["Failure from PLDM sending message to", "Host"]
}
},
@@ -4720,12 +4925,16 @@
"Words6To9": {}
},
- "Callouts": [{
- "CalloutList": [{
- "Priority": "high",
- "Procedure": "bmc_code"
- }]
- }],
+ "Callouts": [
+ {
+ "CalloutList": [
+ {
+ "Priority": "high",
+ "Procedure": "bmc_code"
+ }
+ ]
+ }
+ ],
"Documentation": {
"Description": "Dbus exception",
@@ -4764,16 +4973,12 @@
"Name": "org.open_power.Host.Boot.Error.WatchdogTimeout",
"Subsystem": "cec_sp_hostboot_iface",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0xC101",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
- "Documentation":
- {
+ "Documentation": {
"Description": "Host did not respond within the watchdog timeout interval",
"Message": "Host did not respond before the watchdog timeout interval expired",
"Notes": [
@@ -4787,12 +4992,9 @@
"Name": "xyz.openbmc_project.Software.Version.Error.Incompatible",
"Subsystem": "bmc_firmware",
"ComponentID": "0x3600",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x3601",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
@@ -4803,8 +5005,7 @@
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "A system component has a software version that is incompatible.",
"Message": "A system component has a software version that is incompatible."
}
@@ -4814,12 +5015,9 @@
"Name": "xyz.openbmc_project.Software.Version.Error.AlreadyExists",
"Subsystem": "bmc_firmware",
"ComponentID": "0x3600",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x3602",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
@@ -4830,8 +5028,7 @@
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "This image version already exists on the device.",
"Message": "This image version already exists on the device."
}
@@ -4841,12 +5038,9 @@
"Name": "xyz.openbmc_project.Software.Image.Error.UnTarFailure",
"Subsystem": "bmc_firmware",
"ComponentID": "0x3600",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x3603",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
@@ -4857,8 +5051,7 @@
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "An error occurred during untar.",
"Message": "An error occurred during untar."
}
@@ -4868,12 +5061,9 @@
"Name": "xyz.openbmc_project.Software.Image.Error.ManifestFileFailure",
"Subsystem": "bmc_firmware",
"ComponentID": "0x3600",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x3604",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
@@ -4884,8 +5074,7 @@
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "An error occurred when reading the software image Manifest file.",
"Message": "An error occurred when reading the software image Manifest file."
}
@@ -4895,12 +5084,9 @@
"Name": "xyz.openbmc_project.Software.Image.Error.InternalFailure",
"Subsystem": "bmc_firmware",
"ComponentID": "0x3600",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x3605",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
@@ -4911,8 +5097,7 @@
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "The operation failed internally during processing the image.",
"Message": "The operation failed internally during processing the image."
}
@@ -4922,12 +5107,9 @@
"Name": "xyz.openbmc_project.Software.Image.Error.ImageFailure",
"Subsystem": "bmc_firmware",
"ComponentID": "0x3600",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x3606",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
@@ -4938,8 +5120,7 @@
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "An error occurred processing the image.",
"Message": "An error occurred processing the image."
}
@@ -4949,12 +5130,9 @@
"Name": "xyz.openbmc_project.Software.Image.Error.BusyFailure",
"Subsystem": "bmc_firmware",
"ComponentID": "0x3600",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x3607",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
@@ -4965,8 +5143,7 @@
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "The device is busy during the update.",
"Message": "The device is busy during the update."
}
@@ -4976,12 +5153,9 @@
"Name": "xyz.openbmc_project.Software.Version.Error.ExpiredAccessKey",
"Subsystem": "bmc_firmware",
"ComponentID": "0x3600",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x3608",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
@@ -4992,8 +5166,7 @@
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "The Update Access Key has expired.",
"Message": "The Update Access Key has expired."
}
@@ -5003,12 +5176,9 @@
"Name": "xyz.openbmc_project.Software.Version.Error.InvalidSignature",
"Subsystem": "bmc_firmware",
"ComponentID": "0x3600",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x3609",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
@@ -5019,32 +5189,27 @@
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "The software image has an invalid signature.",
"Message": "The software image has an invalid signature"
}
},
{
- "Name" : "xyz.openbmc_project.Software.Version.Error.HostFile",
- "Subsystem" : "bmc_firmware",
- "ComponentID" : "0x3600",
+ "Name": "xyz.openbmc_project.Software.Version.Error.HostFile",
+ "Subsystem": "bmc_firmware",
+ "ComponentID": "0x3600",
- "SRC" :
- {
- "ReasonCode" : "0x360A",
- "Words6To9":
- {
- "6":
- {
- "Description" : "Size of the current running partition",
- "AdditionalDataPropSource" : "CURRENT_FILE_SIZE"
+ "SRC": {
+ "ReasonCode": "0x360A",
+ "Words6To9": {
+ "6": {
+ "Description": "Size of the current running partition",
+ "AdditionalDataPropSource": "CURRENT_FILE_SIZE"
},
- "7":
- {
- "Description" : "Size of the read only partition",
- "AdditionalDataPropSource" : "EXPECTED_FILE_SIZE"
+ "7": {
+ "Description": "Size of the read only partition",
+ "AdditionalDataPropSource": "EXPECTED_FILE_SIZE"
}
}
},
@@ -5055,11 +5220,10 @@
]
}
],
- "Documentation" :
- {
- "Description" : "Corrupted or changed preserved file",
- "Message" : "Partition was not preserved on reboot",
- "Notes" : [
+ "Documentation": {
+ "Description": "Corrupted or changed preserved file",
+ "Message": "Partition was not preserved on reboot",
+ "Notes": [
"This error may occur if one of the partitions marked",
"PRESERVED is either corrupted, or a change of size is ",
"desired for a particular partition."
@@ -5072,12 +5236,9 @@
"Subsystem": "bmc_firmware",
"ComponentID": "0x6000",
"Severity": "predictive",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x6001",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
{
@@ -5087,8 +5248,7 @@
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "Failed to get the requested dump object path.",
"Message": "Failed to get the requested dump object path from the system."
}
@@ -5098,12 +5258,9 @@
"Subsystem": "bmc_firmware",
"ComponentID": "0x6000",
"Severity": "unrecoverable",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x6002",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
{
@@ -5112,8 +5269,7 @@
]
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "Failed to make a new dump notify request to the dump manager application.",
"Message": "Failed to make a new dump notify request to the dump manager application."
}
@@ -5123,12 +5279,9 @@
"Subsystem": "bmc_firmware",
"ComponentID": "0x6000",
"Severity": "unrecoverable",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x6003",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
{
@@ -5137,8 +5290,7 @@
]
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "Failed to get the dump offload URI path from the dump entry.",
"Message": "Failed to get the dump offload URI path from the dump entry."
}
@@ -5148,12 +5300,9 @@
"Subsystem": "bmc_firmware",
"ComponentID": "0x6000",
"Severity": "non_error",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x6004",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
{
@@ -5162,8 +5311,7 @@
]
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "The hypervisor rejected the request to initiate a new resource dump.",
"Message": "The hypervisor rejected the request to initiate a new resource dump."
}
@@ -5173,12 +5321,9 @@
"Subsystem": "bmc_firmware",
"ComponentID": "0x6000",
"Severity": "unrecoverable",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x6005",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
{
@@ -5187,8 +5332,7 @@
]
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "Failed to reset the dump ID, due to this requested dump will not be deleted.",
"Message": "Failed to reset the dump ID, due to this requested dump will not be deleted."
}
@@ -5198,12 +5342,9 @@
"Subsystem": "bmc_firmware",
"ComponentID": "0x6000",
"Severity": "unrecoverable",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x6006",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
{
@@ -5212,8 +5353,7 @@
]
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "Failed to carry out the dump delete request from the hypervisor.",
"Message": "Failed to carry out the dump delete request from the hypervisor."
}
@@ -5223,12 +5363,9 @@
"Subsystem": "bmc_firmware",
"ComponentID": "0x6000",
"Severity": "unrecoverable",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x6007",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
{
@@ -5237,8 +5374,7 @@
]
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "Failed to set the dump offloaded completion flag in the dump entry.",
"Message": "Failed to set the dump offloaded completion flag in the dump entry."
}
@@ -5248,12 +5384,9 @@
"Subsystem": "bmc_firmware",
"ComponentID": "0x6000",
"Severity": "unrecoverable",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x6008",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
{
@@ -5262,8 +5395,7 @@
]
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "Failed to get the file path for the BMC dump and offload to the hypervisor.",
"Message": "Failed to get the file path for the BMC dump and offload to the hypervisor."
}
@@ -5273,12 +5405,9 @@
"Subsystem": "bmc_firmware",
"ComponentID": "0x6000",
"Severity": "unrecoverable",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x6009",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
{
@@ -5287,8 +5416,7 @@
]
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "Failed to get the file path for the BMC dump and offload to the hypervisor.",
"Message": "Failed to get the file path for the BMC dump and offload to the hypervisor."
}
@@ -5298,12 +5426,9 @@
"Subsystem": "bmc_firmware",
"ComponentID": "0x6000",
"Severity": "non_error",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x6010",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
{
@@ -5312,8 +5437,7 @@
]
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "Could not create a new resource dump due to hypervisor verification failed.",
"Message": "Could not create a new resource dump due to hypervisor verification failed."
}
@@ -5323,12 +5447,9 @@
"Subsystem": "bmc_firmware",
"ComponentID": "0x6000",
"Severity": "unrecoverable",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x6011",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
{
@@ -5337,8 +5458,7 @@
]
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "Failed to set the dump offload completion flag in the dump entry details.",
"Message": "Failed to set the dump offload completion flag in the dump entry details."
}
@@ -5348,12 +5468,9 @@
"Subsystem": "bmc_firmware",
"ComponentID": "0x6000",
"Severity": "unrecoverable",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x6012",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
{
@@ -5362,8 +5479,7 @@
]
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "Failed to notify a new dump available request.",
"Message": "Failed to notify a new dump available request."
}
@@ -5373,12 +5489,9 @@
"Subsystem": "bmc_firmware",
"ComponentID": "0x6000",
"Severity": "unrecoverable",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x6013",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
{
@@ -5387,8 +5500,7 @@
]
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "Failed to send the resource dump parameters for a new dump initiation.",
"Message": "Failed to send the resource dump parameters for a new dump initiation."
}
@@ -5398,12 +5510,9 @@
"Subsystem": "bmc_firmware",
"ComponentID": "0x6000",
"Severity": "unrecoverable",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x6014",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
{
@@ -5412,8 +5521,7 @@
]
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "Failed to send the certificate/license file to the host.",
"Message": "Failed to send the certificate/license file to the host."
}
@@ -5423,12 +5531,9 @@
"Subsystem": "bmc_firmware",
"ComponentID": "0x6000",
"Severity": "unrecoverable",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x6015",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
{
@@ -5437,8 +5542,7 @@
]
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "Failed to decode the response of certificate/license file sent to the host.",
"Message": "Failed to decode the response of certificate/license file sent to the host."
}
@@ -5448,12 +5552,9 @@
"Subsystem": "bmc_firmware",
"ComponentID": "0x6000",
"Severity": "unrecoverable",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x6016",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
{
@@ -5462,8 +5563,7 @@
]
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "Failed to send the new certificate/license file to the host.",
"Message": "Failed to send the new certificate/license file to the host."
}
@@ -5473,12 +5573,9 @@
"Subsystem": "bmc_firmware",
"ComponentID": "0x6000",
"Severity": "unrecoverable",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x6017",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
@@ -5488,8 +5585,7 @@
]
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "Failed to set state effecter states.",
"Message": "Failed to set state effecter states."
}
@@ -5499,12 +5595,9 @@
"Subsystem": "bmc_firmware",
"ComponentID": "0x6000",
"Severity": "unrecoverable",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x6018",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
{
@@ -5513,8 +5606,7 @@
]
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "Failed to parse PDR JSON file.",
"Message": "Failed to parse PDR JSON file."
}
@@ -5524,12 +5616,9 @@
"Subsystem": "bmc_firmware",
"ComponentID": "0x6000",
"Severity": "unrecoverable",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x6019",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
{
@@ -5538,8 +5627,7 @@
]
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "Failed to get state sensor PDR state.",
"Message": "Failed to get state sensor PDR state."
}
@@ -5549,12 +5637,9 @@
"Subsystem": "bmc_firmware",
"ComponentID": "0x6000",
"Severity": "unrecoverable",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x6020",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
{
@@ -5563,8 +5648,7 @@
]
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "Failed to encode state sensor request.",
"Message": "Failed to encode state sensor request."
}
@@ -5574,12 +5658,9 @@
"Subsystem": "bmc_firmware",
"ComponentID": "0x6000",
"Severity": "unrecoverable",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x6021",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
{
@@ -5588,8 +5669,7 @@
]
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "Failed to subscribe for concurrent maintenance of FRU.",
"Message": "Failed to subscribe for concurrent maintenance of FRU."
}
@@ -5599,12 +5679,9 @@
"Subsystem": "bmc_firmware",
"ComponentID": "0x6000",
"Severity": "non_error",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x6022",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
{
@@ -5613,8 +5690,7 @@
]
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "Host did not send a surveillance ping within stipulated timeout interval.",
"Message": "Host did not send a surveillance ping within stipulated timeout interval."
}
@@ -5624,12 +5700,9 @@
"Subsystem": "bmc_firmware",
"ComponentID": "0x6000",
"Severity": "unrecoverable",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x6023",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
{
@@ -5638,8 +5711,7 @@
]
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "Failed to reset the dump offload URI path from the dump entry.",
"Message": "Failed to reset the dump offload URI path from the dump entry."
}
@@ -5649,12 +5721,9 @@
"Subsystem": "bmc_firmware",
"ComponentID": "0x6000",
"Severity": "unrecoverable",
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x6024",
- "Words6To9":
- {
- }
+ "Words6To9": {}
},
"Callouts": [
{
@@ -5663,8 +5732,7 @@
]
}
],
- "Documentation":
- {
+ "Documentation": {
"Description": "Host failed to complete the power off gracefully within the timeout.",
"Message": "Host failed to complete the power off gracefully within the timeout."
}
diff --git a/extensions/openpower-pels/registry/schema/registry_example.json b/extensions/openpower-pels/registry/schema/registry_example.json
index fd2a1c0..bca8f1c 100644
--- a/extensions/openpower-pels/registry/schema/registry_example.json
+++ b/extensions/openpower-pels/registry/schema/registry_example.json
@@ -1,53 +1,41 @@
{
- "PELs":
- [
+ "PELs": [
{
"Name": "xyz.openbmc_project.Power.Fault",
"Subsystem": "power_supply",
"Severity": "unrecoverable",
"ActionFlags": ["service_action", "report"],
- "SRC":
- {
+ "SRC": {
"ReasonCode": "0x2030",
"SymptomIDFields": ["SRCWord3", "SRCWord6"],
- "Words6To9":
- {
- "6":
- {
+ "Words6To9": {
+ "6": {
"Description": "Failing unit number",
"AdditionalDataPropSource": "PS_NUM"
}
}
},
- "Documentation":
- {
+ "Documentation": {
"Description": "A PGOOD Fault",
"Message": "PS %1 had a PGOOD Fault",
- "MessageArgSources":
- [
- "SRCWord6"
- ],
+ "MessageArgSources": ["SRCWord6"],
"Notes": [
"In the UserData section there is a JSON",
"dump that provides debug information."
]
},
- "CalloutsUsingAD":
- {
+ "CalloutsUsingAD": {
"ADName": "PS_NUM",
- "CalloutsWithTheirADValues":
- [
+ "CalloutsWithTheirADValues": [
{
"ADValue": "0",
- "Callouts":
- [
+ "Callouts": [
{
"System": "system1",
- "CalloutList":
- [
+ "CalloutList": [
{
"Priority": "high",
"LocCode": "E1"
@@ -59,8 +47,7 @@
]
},
{
- "CalloutList":
- [
+ "CalloutList": [
{
"Priority": "high",
"Procedure": "bmc_code"
diff --git a/extensions/openpower-pels/registry/schema/schema.json b/extensions/openpower-pels/registry/schema/schema.json
index 31dba67..d105b3d 100644
--- a/extensions/openpower-pels/registry/schema/schema.json
+++ b/extensions/openpower-pels/registry/schema/schema.json
@@ -4,10 +4,8 @@
"description": "This schema describes JSON used for creating PELs from OpenBMC event logs.",
"type": "object",
- "properties":
- {
- "PELs":
- {
+ "properties": {
+ "PELs": {
"title": "This is an array of entries that specify PEL fields for event logs",
"$ref": "#/definitions/pels"
}
@@ -17,57 +15,57 @@
"minItems": 1,
"uniqueItems": true,
- "definitions":
- {
- "pels":
- {
+ "definitions": {
+ "pels": {
"description": "Each entry in this array is for converting an event log to a PEL",
"type": "array",
- "items":
- {
+ "items": {
"description": "The schema for a single event log registry entry",
"type": "object",
- "properties":
- {
- "Name": {"$ref": "#/definitions/errorName" },
+ "properties": {
+ "Name": { "$ref": "#/definitions/errorName" },
- "SRC": {"$ref": "#/definitions/src" },
+ "SRC": { "$ref": "#/definitions/src" },
- "Subsystem": {"$ref": "#/definitions/subsystem" },
+ "Subsystem": { "$ref": "#/definitions/subsystem" },
- "PossibleSubsystems": {"$ref": "#/definitions/possibleSubsystems" },
+ "PossibleSubsystems": {
+ "$ref": "#/definitions/possibleSubsystems"
+ },
- "Severity": {"$ref": "#/definitions/severity" },
+ "Severity": { "$ref": "#/definitions/severity" },
- "MfgSeverity": {"$ref": "#/definitions/mfgSeverity" },
+ "MfgSeverity": { "$ref": "#/definitions/mfgSeverity" },
- "EventScope": {"$ref": "#/definitions/eventScope" },
+ "EventScope": { "$ref": "#/definitions/eventScope" },
- "EventType": {"$ref": "#/definitions/eventType" },
+ "EventType": { "$ref": "#/definitions/eventType" },
- "ActionFlags": {"$ref": "#/definitions/actionFlags" },
+ "ActionFlags": { "$ref": "#/definitions/actionFlags" },
- "MfgActionFlags": {"$ref": "#/definitions/mfgActionFlags" },
+ "MfgActionFlags": {
+ "$ref": "#/definitions/mfgActionFlags"
+ },
- "Documentation": {"$ref": "#/definitions/documentation" },
+ "Documentation": { "$ref": "#/definitions/documentation" },
- "ComponentID": {"$ref": "#/definitions/componentID" },
+ "ComponentID": { "$ref": "#/definitions/componentID" },
- "CalloutsUsingAD": {"$ref": "#/definitions/calloutsUsingAD"},
+ "CalloutsUsingAD": {
+ "$ref": "#/definitions/calloutsUsingAD"
+ },
- "Callouts": {"$ref": "#/definitions/callouts"}
+ "Callouts": { "$ref": "#/definitions/callouts" }
},
"required": ["Name", "SRC", "Documentation"],
"additionalProperties": false,
- "not":
- {
+ "not": {
"required": ["CalloutsUsingAD", "Callouts"]
},
- "oneOf":
- [
+ "oneOf": [
{
"required": ["Subsystem"]
},
@@ -78,151 +76,186 @@
}
},
- "errorName":
- {
+ "errorName": {
"description": "The 'Message' property of an OpenBMC event log",
"type": "string"
},
- "componentID":
- {
+ "componentID": {
"description": "The component ID of the PEL creator, in the form 0xYY00. For BD SRCs, this is optional and if not present the component ID will be taken from the upper byte of the reason code.",
"type": "string",
"pattern": "^0x[0-9a-fA-F]{2}00$"
},
- "src":
- {
+ "src": {
"description": "Contains fields describing the primary SRC embedded in the PEL",
"type": "object",
- "properties":
- {
- "Type": {"$ref": "#/definitions/srcType" },
+ "properties": {
+ "Type": { "$ref": "#/definitions/srcType" },
- "ReasonCode": {"$ref": "#/definitions/reasonCode" },
+ "ReasonCode": { "$ref": "#/definitions/reasonCode" },
- "SymptomIDFields": {"$ref": "#/definitions/symptomID" },
+ "SymptomIDFields": { "$ref": "#/definitions/symptomID" },
- "Words6To9": {"$ref": "#/definitions/srcWords6To9" }
+ "Words6To9": { "$ref": "#/definitions/srcWords6To9" }
},
"required": ["ReasonCode", "Words6To9"],
"additionalProperties": false
},
- "documentation":
- {
+ "documentation": {
"description": "This contains event documentation that will be used by tools and parsers.",
"type": "object",
- "properties":
- {
- "Message": {"$ref": "#/definitions/docMessage" },
+ "properties": {
+ "Message": { "$ref": "#/definitions/docMessage" },
- "MessageArgSources": {"$ref": "#/definitions/docMessageArgSources" },
+ "MessageArgSources": {
+ "$ref": "#/definitions/docMessageArgSources"
+ },
- "Description": {"$ref": "#/definitions/docDescription" },
+ "Description": { "$ref": "#/definitions/docDescription" },
- "Notes": {"$ref": "#/definitions/docNotes" }
-
+ "Notes": { "$ref": "#/definitions/docNotes" }
},
"additionalProperties": false,
"required": ["Message", "Description"]
},
- "srcType":
- {
+ "srcType": {
"description": "The first byte of the SRC ASCII string. Optional and defaults to BD. The '11' SRC is only to be used for events related to power.",
"type": "string",
"enum": ["BD", "11"]
},
- "docNotes":
- {
+ "docNotes": {
"description": "Any notes/comments about the error. An array of strings for manual line wrapping. Optional.",
"type": "array",
- "items":
- {
+ "items": {
"description": "Notes",
"type": "string"
}
},
- "reasonCode":
- {
+ "reasonCode": {
"description": "String representation of the 2 byte reason code, like 0xABCD. The reason code is the 2nd half of the 8 character SRC ASCII String field, such as B1FFABCD.",
"type": "string",
"pattern": "^0x[0-9a-fA-F]{4}$",
- "examples": [
- "0x3355"
+ "examples": ["0x3355"]
+ },
+
+ "subsystem": {
+ "description": "PEL subsystem enumeration. See the PEL spec for more detailed definitions.",
+ "type": "string",
+ "enum": [
+ "processor",
+ "processor_fru",
+ "processor_chip",
+ "processor_unit",
+ "processor_bus",
+
+ "memory",
+ "memory_ctlr",
+ "memory_bus",
+ "memory_dimm",
+ "memory_fru",
+ "external_cache",
+
+ "io",
+ "io_hub",
+ "io_bridge",
+ "io_bus",
+ "io_processor",
+ "io_hub_other",
+ "phb",
+
+ "io_adapter",
+ "io_adapter_comm",
+ "io_device",
+ "io_device_dasd",
+ "io_external_general",
+ "io_external_workstation",
+ "io_storage_mezz",
+
+ "cec_hardware",
+ "cec_sp_a",
+ "cec_sp_b",
+ "cec_node_controller",
+ "cec_vpd",
+ "cec_i2c",
+ "cec_chip_iface",
+ "cec_clocks",
+ "cec_op_panel",
+ "cec_tod",
+ "cec_storage_device",
+ "cec_sp_hyp_iface",
+ "cec_service_network",
+ "cec_sp_hostboot_iface",
+
+ "power",
+ "power_supply",
+ "power_control_hw",
+ "power_fans",
+ "power_sequencer",
+
+ "others",
+ "other_hmc",
+ "other_test_tool",
+ "other_media",
+ "other_multiple_subsystems",
+ "other_na",
+ "other_info_src",
+
+ "surv_hyp_lost_sp",
+ "surv_sp_lost_hyp",
+ "surv_sp_lost_hmc",
+ "surv_hmc_lost_lpar",
+ "surv_hmc_lost_bpa",
+ "surv_hmc_lost_hmc",
+
+ "platform_firmware",
+ "bmc_firmware",
+ "hyp_firmware",
+ "partition_firmware",
+ "slic_firmware",
+ "spcn_firmware",
+ "bulk_power_firmware_side_a",
+ "hmc_code_firmware",
+ "bulk_power_firmware_side_b",
+ "virtual_sp",
+ "hostboot",
+ "occ",
+
+ "software",
+ "os_software",
+ "xpf_software",
+ "app_software",
+
+ "ext_env",
+ "input_power_source",
+ "ambient_temp",
+ "user_error",
+ "corrosion"
]
},
- "subsystem":
- {
- "description": "PEL subsystem enumeration. See the PEL spec for more detailed definitions.",
- "type": "string",
- "enum": ["processor", "processor_fru", "processor_chip",
- "processor_unit", "processor_bus",
-
- "memory", "memory_ctlr", "memory_bus", "memory_dimm",
- "memory_fru", "external_cache",
-
- "io", "io_hub", "io_bridge", "io_bus", "io_processor",
- "io_hub_other", "phb",
-
- "io_adapter", "io_adapter_comm", "io_device",
- "io_device_dasd", "io_external_general",
- "io_external_workstation", "io_storage_mezz",
-
- "cec_hardware", "cec_sp_a", "cec_sp_b",
- "cec_node_controller", "cec_vpd",
- "cec_i2c", "cec_chip_iface", "cec_clocks", "cec_op_panel",
- "cec_tod", "cec_storage_device", "cec_sp_hyp_iface",
- "cec_service_network", "cec_sp_hostboot_iface",
-
- "power", "power_supply", "power_control_hw", "power_fans",
- "power_sequencer",
-
- "others", "other_hmc", "other_test_tool", "other_media",
- "other_multiple_subsystems", "other_na", "other_info_src",
-
- "surv_hyp_lost_sp", "surv_sp_lost_hyp", "surv_sp_lost_hmc",
- "surv_hmc_lost_lpar", "surv_hmc_lost_bpa",
- "surv_hmc_lost_hmc",
-
- "platform_firmware", "bmc_firmware", "hyp_firmware",
- "partition_firmware", "slic_firmware", "spcn_firmware",
- "bulk_power_firmware_side_a", "hmc_code_firmware",
- "bulk_power_firmware_side_b", "virtual_sp", "hostboot",
- "occ",
-
- "software", "os_software", "xpf_software", "app_software",
-
- "ext_env", "input_power_source", "ambient_temp",
- "user_error", "corrosion"]
- },
-
- "possibleSubsystems":
- {
+ "possibleSubsystems": {
"description": "Required when the PEL creator uses PEL_SUBSYSTEM in the AdditionalData property to pass in the subsystem. Used by scripts that generate documentation to build all possible SRC ASCII strings for this error.",
"type": "array",
- "items":
- {
+ "items": {
"$ref": "#/definitions/subsystem"
},
"minItems": 1,
"uniqueItems": true
},
- "systemAndSeverity":
- {
+ "systemAndSeverity": {
"description": "A severity entry that has an optional system type qualifier. Used when the severity needs to be based on the system type.",
"type": "object",
- "properties":
- {
+ "properties": {
"System": { "$ref": "#/definitions/system" },
"SevValue": { "$ref": "#/definitions/severityTypes" }
},
@@ -230,18 +263,15 @@
"required": ["SevValue"]
},
- "severity":
- {
+ "severity": {
"description": "PEL severity field. Optional. If not provided, it will use the event log severity. It can either be an enum of the severity value, or an array of them that is based on system type, where an entry without a system type acts as the catch all.",
- "oneOf":
- [
+ "oneOf": [
{
"$ref": "#/definitions/severityTypes"
},
{
"type": "array",
- "items":
- {
+ "items": {
"$ref": "#/definitions/systemAndSeverity"
},
"minItems": 1,
@@ -249,8 +279,7 @@
}
],
- "examples":
- [
+ "examples": [
"unrecoverable",
[
@@ -263,146 +292,156 @@
}
]
]
-
},
- "severityTypes":
- {
+ "severityTypes": {
"description": "PEL severity enumeration. See the PEL spec for more detailed definitions.",
"type": "string",
- "enum": ["non_error",
+ "enum": [
+ "non_error",
- "recovered",
+ "recovered",
- "predictive", "predictive_degraded_perf",
- "predictive_reboot", "predictive_reboot_degraded",
- "predictive_redundancy_loss",
+ "predictive",
+ "predictive_degraded_perf",
+ "predictive_reboot",
+ "predictive_reboot_degraded",
+ "predictive_redundancy_loss",
- "unrecoverable", "unrecoverable_degraded_perf",
- "unrecoverable_redundancy_loss",
- "unrecoverable_redundancy_loss_perf",
- "unrecoverable_loss_of_function",
+ "unrecoverable",
+ "unrecoverable_degraded_perf",
+ "unrecoverable_redundancy_loss",
+ "unrecoverable_redundancy_loss_perf",
+ "unrecoverable_loss_of_function",
- "critical", "critical_system_term",
- "critical_imminent_failure",
- "critical_partition_term",
- "critical_partition_imminent_failure",
+ "critical",
+ "critical_system_term",
+ "critical_imminent_failure",
+ "critical_partition_term",
+ "critical_partition_imminent_failure",
- "diagnostic_error", "diagnostic_error_incorrect_results",
+ "diagnostic_error",
+ "diagnostic_error_incorrect_results",
- "symptom_recovered", "symptom_predictive",
- "symptom_unrecoverable", "symptom_critical",
- "symptom_diag_err"]
+ "symptom_recovered",
+ "symptom_predictive",
+ "symptom_unrecoverable",
+ "symptom_critical",
+ "symptom_diag_err"
+ ]
},
- "mfgSeverity":
- {
+ "mfgSeverity": {
"description": "The PEL severity to use in manufacturing reporting mode",
"$ref": "#/definitions/severity"
},
- "eventScope":
- {
+ "eventScope": {
"description": "The event scope PEL field. Optional and defaults to entire_platform",
"type": "string",
- "enum": ["entire_platform", "single_partition", "multiple_partitions",
- "possibly_multiple_platforms"]
+ "enum": [
+ "entire_platform",
+ "single_partition",
+ "multiple_partitions",
+ "possibly_multiple_platforms"
+ ]
},
- "eventType":
- {
+ "eventType": {
"description": "The event type PEL field. Optional and defaults to na",
"type": "string",
- "enum": ["na", "misc_information_only", "tracing_event",
- "dump_notification", "env_normal"]
+ "enum": [
+ "na",
+ "misc_information_only",
+ "tracing_event",
+ "dump_notification",
+ "env_normal"
+ ]
},
- "actionFlags":
- {
+ "actionFlags": {
"description": "The action flags Private Header PEL field",
"type": "array",
- "items":
- {
+ "items": {
"description": "List of action flags",
"type": "string",
- "enum": ["service_action", "hidden", "report", "dont_report",
- "call_home", "isolation_incomplete", "termination"]
+ "enum": [
+ "service_action",
+ "hidden",
+ "report",
+ "dont_report",
+ "call_home",
+ "isolation_incomplete",
+ "termination"
+ ]
}
},
- "mfgActionFlags":
- {
+ "mfgActionFlags": {
"description": "The PEL action flags to use in manufacturing reporting mode",
"$ref": "#/definitions/actionFlags"
},
- "docDescription":
- {
+ "docDescription": {
"description": "This is a higher level description of the error. It is required by the Redfish schema to generate a Redfish message entry, but is not used in Redfish or PEL output.",
"type": "string",
"minLength": 8
},
- "docMessage":
- {
+ "docMessage": {
"description": "The error message. This will show up in parsed PELs, and in the Redfish event logs. It can contain placeholders for numeric values using %1, %2, etc, that come from the SRC words 6-9 as defined by the MessageArgSources property.",
"type": "string",
"minLength": 8,
"examples": [
- {"Message": "The code update from level %1 to %2 failed" }
+ { "Message": "The code update from level %1 to %2 failed" }
]
},
- "docMessageArgSources":
- {
+ "docMessageArgSources": {
"description": "The SRC word 6-9 to use as the source of the numeric arguments that will be substituted into any placeholder in the Message field. Only required if there are arguments to substitute.",
"type": "array",
- "items":
- {
+ "items": {
"type": "string",
"enum": ["SRCWord6", "SRCWord7", "SRCWord8", "SRCWord9"]
},
"additionalItems": false
},
- "symptomID":
- {
+ "symptomID": {
"description": "Defines a custom Symptom ID, to be appended to the ASCII string word and separated by underscores. The maximum size of the Symptom ID field is 80 characters. The default is ASCIISTRING_SRCWord3 (e.g. B1103500_12345678).",
"type": "array",
- "items":
- {
+ "items": {
"type": "string",
- "enum": ["SRCWord3", "SRCWord4", "SRCWord5", "SRCWord6",
- "SRCWord7", "SRCWord8", "SRCWord9"]
+ "enum": [
+ "SRCWord3",
+ "SRCWord4",
+ "SRCWord5",
+ "SRCWord6",
+ "SRCWord7",
+ "SRCWord8",
+ "SRCWord9"
+ ]
},
"minItems": 1,
"maxItems": 8,
"uniqueItems": true,
- "examples": [
- ["SRCWord3", "SRCWord6"]
- ]
+ "examples": [["SRCWord3", "SRCWord6"]]
},
- "srcWords6To9":
- {
+ "srcWords6To9": {
"description": "This details what the user defined SRC hex words (6-9) mean, and which AdditionalData properties to get them from. These will be shown in the PEL parser output. Must be present, but can be empty.",
"type": "object",
- "patternProperties":
- {
- "^[6-9]$":
- {
+ "patternProperties": {
+ "^[6-9]$": {
"type": "object",
- "properties":
- {
- "Description":
- {
+ "properties": {
+ "Description": {
"description": "What the value in the field represents.",
"type": "string"
},
- "AdditionalDataPropSource":
- {
+ "AdditionalDataPropSource": {
"description": "Which AdditionalData property key to get the data from.",
"type": "string"
}
@@ -411,12 +450,9 @@
"additionalProperties": false
},
- "examples":
- {
- "SRCWords6To9":
- {
- "6":
- {
+ "examples": {
+ "SRCWords6To9": {
+ "6": {
"Description": "Failing PSU number",
"AdditionalDataPropSource": "PSU_NUM"
}
@@ -426,128 +462,147 @@
"additionalProperties": false
},
- "adName":
- {
+ "adName": {
"description": "The name of the AdditionalData entry to use to index into the callout tables.",
"type": "string"
},
- "adValue":
- {
+ "adValue": {
"description": "The value for the AdditionalData entry specified by ADName that indexes into the callout tables.",
"type": "string"
},
- "locationCode":
- {
+ "locationCode": {
"description": "A location code - the segment after the 'UTMS-' prefix. (e.g. P1-C2)",
"type": "string"
},
- "priority":
- {
+ "priority": {
"description": "The callout priority. See the PEL spec for priority definitions.",
"type": "string",
- "enum": ["high", "medium", "low", "medium_group_a",
- "medium_group_b", "medium_group_c"]
+ "enum": [
+ "high",
+ "medium",
+ "low",
+ "medium_group_a",
+ "medium_group_b",
+ "medium_group_c"
+ ]
},
- "symbolicFRU":
- {
+ "symbolicFRU": {
"description": "The symbolic FRU callout.",
"type": "string",
- "enum": ["service_docs", "pwrsply", "air_mover", "pgood_part", "usb_pgood", "ambient_temp", "ambient_temp_back", "ambient_perf_loss", "ac_module", "fan_cable", "cable_continued", "altitude", "pcie_hot_plug", "overtemp"]
+ "enum": [
+ "service_docs",
+ "pwrsply",
+ "air_mover",
+ "pgood_part",
+ "usb_pgood",
+ "ambient_temp",
+ "ambient_temp_back",
+ "ambient_perf_loss",
+ "ac_module",
+ "fan_cable",
+ "cable_continued",
+ "altitude",
+ "pcie_hot_plug",
+ "overtemp"
+ ]
},
- "symbolicFRUTrusted":
- {
+ "symbolicFRUTrusted": {
"description": "The symbolic FRU callout with a trusted location code. (Can light LEDs).",
"ref": "#/definitions/symbolicFRU"
},
- "procedure":
- {
+ "procedure": {
"description": "The maintenance procedure callout.",
"type": "string",
- "enum": ["bmc_code", "next_level_support", "sbe_code", "fsi_path", "power_overcurrent", "find_sue_root_cause"]
+ "enum": [
+ "bmc_code",
+ "next_level_support",
+ "sbe_code",
+ "fsi_path",
+ "power_overcurrent",
+ "find_sue_root_cause"
+ ]
},
- "useInventoryLocCode":
- {
+ "useInventoryLocCode": {
"description": "Used along with SymbolicFRUTrusted to specify that the location code to use with the symbolic FRU is to be taken from the passed in CALLOUT_INVENTORY_PATH callout rather than being specified with LocCode.",
"type": "boolean"
},
- "calloutList":
- {
+ "calloutList": {
"description": "The list of FRU callouts to add to a PEL. If just LocCode is specified, it is a normal hardware FRU callout. If Procedure is specified, it is a procedure callout. If SymbolicFRU or SymbolicFRUTrusted are specified, it is a Symbolic FRU callout. SymbolicFRUTrusted also requires LocCode.",
"type": "array",
- "items":
- {
+ "items": {
"type": "object",
- "properties":
- {
- "Priority": {"$ref": "#/definitions/priority" },
- "LocCode": {"$ref": "#/definitions/locationCode" },
- "SymbolicFRU": {"$ref": "#/definitions/symbolicFRU" },
- "SymbolicFRUTrusted": {"$ref": "#/definitions/symbolicFRUTrusted" },
- "Procedure": {"$ref": "#/definitions/procedure" },
- "UseInventoryLocCode": {"$ref": "#/definitions/useInventoryLocCode" }
+ "properties": {
+ "Priority": { "$ref": "#/definitions/priority" },
+ "LocCode": { "$ref": "#/definitions/locationCode" },
+ "SymbolicFRU": { "$ref": "#/definitions/symbolicFRU" },
+ "SymbolicFRUTrusted": {
+ "$ref": "#/definitions/symbolicFRUTrusted"
+ },
+ "Procedure": { "$ref": "#/definitions/procedure" },
+ "UseInventoryLocCode": {
+ "$ref": "#/definitions/useInventoryLocCode"
+ }
},
"additionalProperties": false,
"required": ["Priority"],
- "oneOf":
- [
+ "oneOf": [
{
- "allOf":
- [
+ "allOf": [
{ "required": ["LocCode"] },
- { "not": { "required": ["SymbolicFRU"] }},
- { "not": { "required": ["SymbolicFRUTrusted"] }},
- { "not": { "required": ["Procedure"] }},
- { "not": { "required": ["UseInventoryLocCode"] }}
+ { "not": { "required": ["SymbolicFRU"] } },
+ { "not": { "required": ["SymbolicFRUTrusted"] } },
+ { "not": { "required": ["Procedure"] } },
+ { "not": { "required": ["UseInventoryLocCode"] } }
]
},
{
-
- "allOf":
- [
+ "allOf": [
{ "required": ["SymbolicFRU"] },
- { "not": { "required": ["SymbolicFRUTrusted"] }},
- { "not": { "required": ["Procedure"] }},
- { "not": { "required": ["UseInventoryLocCode"] }}
+ { "not": { "required": ["SymbolicFRUTrusted"] } },
+ { "not": { "required": ["Procedure"] } },
+ { "not": { "required": ["UseInventoryLocCode"] } }
]
},
{
- "allOf":
- [
+ "allOf": [
{ "required": ["SymbolicFRUTrusted", "LocCode"] },
- { "not": { "required": ["SymbolicFRU"] }},
- { "not": { "required": ["Procedure"] }},
- { "not": { "required": ["UseInventoryLocCode"] }}
+ { "not": { "required": ["SymbolicFRU"] } },
+ { "not": { "required": ["Procedure"] } },
+ { "not": { "required": ["UseInventoryLocCode"] } }
]
},
{
- "allOf":
- [
- { "required": ["SymbolicFRUTrusted", "UseInventoryLocCode"] },
- { "not": { "required": ["SymbolicFRU"] }},
- { "not": { "required": ["Procedure"] }},
- { "not": { "required": ["LocCode"] }}
+ "allOf": [
+ {
+ "required": [
+ "SymbolicFRUTrusted",
+ "UseInventoryLocCode"
+ ]
+ },
+ { "not": { "required": ["SymbolicFRU"] } },
+ { "not": { "required": ["Procedure"] } },
+ { "not": { "required": ["LocCode"] } }
]
},
{
- "allOf":
- [
+ "allOf": [
{ "required": ["Procedure"] },
- { "not": { "required": ["SymbolicFRU"] }},
- { "not": { "required": ["SymbolicFRUTrusted"] }},
- { "not": { "required": ["LocCode"] }},
- { "not": { "required": ["UseInventoryLocCode"] }}
+ { "not": { "required": ["SymbolicFRU"] } },
+ { "not": { "required": ["SymbolicFRUTrusted"] } },
+ { "not": { "required": ["LocCode"] } },
+ { "not": { "required": ["UseInventoryLocCode"] } }
]
}
]
@@ -555,8 +610,7 @@
"minItems": 1,
"maxItems": 10,
- "examples":
- [
+ "examples": [
{
"Priority": "high",
"LocCode": "P1"
@@ -573,25 +627,21 @@
]
},
- "system":
- {
+ "system": {
"description": "The system type string, as specified by entity manger. It is used to index into different sections of the JSON.",
"type": "string",
"minLength": 1
},
- "callouts":
- {
+ "callouts": {
"description": "This contains callouts that can vary based on system type. Each entry contains an optional System property and a required CalloutList property. If the System property is left out it indicates that the CalloutList callouts are valid for every system type, unless there is another Callouts entry that has a matching System property, in which case that entry is valid.",
"type": "array",
- "items":
- {
+ "items": {
"type": "object",
- "properties":
- {
- "System": {"$ref": "#/definitions/system" },
- "CalloutList": {"$ref": "#/definitions/calloutList" }
+ "properties": {
+ "System": { "$ref": "#/definitions/system" },
+ "CalloutList": { "$ref": "#/definitions/calloutList" }
},
"required": ["CalloutList"],
"additionalProperties": false
@@ -599,56 +649,55 @@
"minItems": 1,
"maxItems": 10,
- "examples":
- [
+ "examples": [
[
{
"System": "system1",
- "CalloutList": [{"Priority": "high", "LocCode": "P1"}]
+ "CalloutList": [{ "Priority": "high", "LocCode": "P1" }]
},
{
- "CalloutList": [{"Priority": "high", "Procedure": "NEXTLVL"}]
+ "CalloutList": [
+ { "Priority": "high", "Procedure": "NEXTLVL" }
+ ]
}
]
]
},
- "calloutsWithTheirADValues":
- {
+ "calloutsWithTheirADValues": {
"description": "This contains callouts along with the AdditionalData value used to select an entry into the callout list. The AdditionalData entry was specified by ADName in the CalloutsUsingAD parent entry.",
"type": "array",
- "items":
- {
+ "items": {
"type": "object",
- "properties":
- {
- "ADValue": {"$ref": "#/definitions/adValue" },
- "Callouts": {"$ref": "#/definitions/callouts" }
+ "properties": {
+ "ADValue": { "$ref": "#/definitions/adValue" },
+ "Callouts": { "$ref": "#/definitions/callouts" }
},
"additionalProperties": false,
"required": ["ADValue", "Callouts"]
},
"minItems": 1,
- "examples":
- [
+ "examples": [
[
{
"ADValue": "0",
- "Callouts":
- [
+ "Callouts": [
{
- "CalloutList": [{"Priority": "high", "LocCode": "P1"}]
+ "CalloutList": [
+ { "Priority": "high", "LocCode": "P1" }
+ ]
}
]
},
{
"ADValue": "1",
- "Callouts":
- [
+ "Callouts": [
{
- "CalloutList": [{"Priority": "high", "LocCode": "P2"}]
+ "CalloutList": [
+ { "Priority": "high", "LocCode": "P2" }
+ ]
}
]
}
@@ -656,43 +705,43 @@
]
},
- "calloutsUsingAD":
- {
+ "calloutsUsingAD": {
"description": "This contains the callouts that can be specified based on a value in the AdditionalData property.",
"type": "object",
- "properties":
- {
- "ADName": {"$ref": "#/definitions/adName" },
- "CalloutsWithTheirADValues":
- {"$ref": "#/definitions/calloutsWithTheirADValues" },
- "CalloutsWhenNoADMatch":
- {"$ref": "#/definitions/calloutsWhenNoADMatch" }
+ "properties": {
+ "ADName": { "$ref": "#/definitions/adName" },
+ "CalloutsWithTheirADValues": {
+ "$ref": "#/definitions/calloutsWithTheirADValues"
+ },
+ "CalloutsWhenNoADMatch": {
+ "$ref": "#/definitions/calloutsWhenNoADMatch"
+ }
},
"additionalProperties": false,
"required": ["ADName", "CalloutsWithTheirADValues"],
- "examples":
- [
+ "examples": [
{
"ADName": "PROC_NUM",
- "CalloutsWithTheirADValues":
- [
+ "CalloutsWithTheirADValues": [
{
"ADValue": "0",
- "Callouts":
- [
+ "Callouts": [
{
- "CalloutList": [{"Priority": "high", "LocCode": "P1"}]
+ "CalloutList": [
+ { "Priority": "high", "LocCode": "P1" }
+ ]
}
]
},
{
"ADValue": "1",
- "Callouts":
- [
+ "Callouts": [
{
- "CalloutList": [{"Priority": "high", "LocCode": "P2"}]
+ "CalloutList": [
+ { "Priority": "high", "LocCode": "P2" }
+ ]
}
]
}
@@ -701,8 +750,7 @@
]
},
- "calloutsWhenNoADMatch":
- {
+ "calloutsWhenNoADMatch": {
"description": "This contains the callouts to use when a match in the 'CalloutsWithTheirADValues array isn't found.",
"$ref": "#/definitions/callouts"
}
diff --git a/tools/example/xyz/openbmc_project/Example/Bar.metadata.yaml b/tools/example/xyz/openbmc_project/Example/Bar.metadata.yaml
index c5c57ca..c8c94c4 100644
--- a/tools/example/xyz/openbmc_project/Example/Bar.metadata.yaml
+++ b/tools/example/xyz/openbmc_project/Example/Bar.metadata.yaml
@@ -1,7 +1,7 @@
- name: Bar
level: INFO
meta:
- - str: "BAR_DATA=%s"
- type: string
+ - str: "BAR_DATA=%s"
+ type: string
inherits:
- - example.xyz.openbmc_project.Example.Foo.Foo
+ - example.xyz.openbmc_project.Example.Foo.Foo
diff --git a/tools/example/xyz/openbmc_project/Example/Device.metadata.yaml b/tools/example/xyz/openbmc_project/Example/Device.metadata.yaml
index e5d6508..7ecb18e 100644
--- a/tools/example/xyz/openbmc_project/Example/Device.metadata.yaml
+++ b/tools/example/xyz/openbmc_project/Example/Device.metadata.yaml
@@ -1,7 +1,7 @@
- name: Callout
meta:
- - str: "CALLOUT_ERRNO_TEST=%d"
- type: int32
- - str: "CALLOUT_DEVICE_PATH_TEST=%s"
- type: string
- process: true
+ - str: "CALLOUT_ERRNO_TEST=%d"
+ type: int32
+ - str: "CALLOUT_DEVICE_PATH_TEST=%s"
+ type: string
+ process: true
diff --git a/tools/example/xyz/openbmc_project/Example/Elog.metadata.yaml b/tools/example/xyz/openbmc_project/Example/Elog.metadata.yaml
index cb1dc7a..b28772f 100644
--- a/tools/example/xyz/openbmc_project/Example/Elog.metadata.yaml
+++ b/tools/example/xyz/openbmc_project/Example/Elog.metadata.yaml
@@ -1,36 +1,36 @@
- name: TestErrorOne
level: INFO
meta:
- - str: "ERRNUM=0x%.4X"
- type: uint16
- - str: FILE_PATH=%s
- type: string
- - str: FILE_NAME=%s
- type: string
+ - str: "ERRNUM=0x%.4X"
+ type: uint16
+ - str: FILE_PATH=%s
+ type: string
+ - str: FILE_NAME=%s
+ type: string
inherits:
- - example.xyz.openbmc_project.Example.Elog.TestErrorTwo
+ - example.xyz.openbmc_project.Example.Elog.TestErrorTwo
- name: TestErrorTwo
level: ERR
meta:
- - str: DEV_ADDR=0x%.8X
- type: uint32
- - str: DEV_ID=%u
- type: uint32
- process: true
- - str: DEV_NAME=%s
- type: string
+ - str: DEV_ADDR=0x%.8X
+ type: uint32
+ - str: DEV_ID=%u
+ type: uint32
+ process: true
+ - str: DEV_NAME=%s
+ type: string
- name: AutoTestSimple
level: ERR
meta:
- - str: STRING=%s
- type: string
+ - str: STRING=%s
+ type: string
- name: TestCallout
level: ERR
meta:
- - str: DEV_ADDR=0x%.8X
- type: uint32
+ - str: DEV_ADDR=0x%.8X
+ type: uint32
inherits:
- - example.xyz.openbmc_project.Example.Device.Callout
+ - example.xyz.openbmc_project.Example.Device.Callout
diff --git a/tools/example/xyz/openbmc_project/Example/Foo.metadata.yaml b/tools/example/xyz/openbmc_project/Example/Foo.metadata.yaml
index 5fe2f13..df3a47e 100644
--- a/tools/example/xyz/openbmc_project/Example/Foo.metadata.yaml
+++ b/tools/example/xyz/openbmc_project/Example/Foo.metadata.yaml
@@ -1,7 +1,7 @@
- name: Foo
level: INFO
meta:
- - str: "FOO_DATA=%s"
- type: string
+ - str: "FOO_DATA=%s"
+ type: string
inherits:
- - example.xyz.openbmc_project.Example.Elog.TestErrorOne
+ - example.xyz.openbmc_project.Example.Elog.TestErrorOne
diff --git a/yaml/xyz/openbmc_project/Logging/Internal/Manager.interface.yaml b/yaml/xyz/openbmc_project/Logging/Internal/Manager.interface.yaml
index 6ab85c5..92b7faa 100644
--- a/yaml/xyz/openbmc_project/Logging/Internal/Manager.interface.yaml
+++ b/yaml/xyz/openbmc_project/Logging/Internal/Manager.interface.yaml
@@ -1,7 +1,7 @@
description: >
- Implement to provide event/error logging management features.
- This interface should be instantiated for the phosphor::logging namespace,
- and only one is required.
+ Implement to provide event/error logging management features. This interface
+ should be instantiated for the phosphor::logging namespace, and only one is
+ required.
methods:
- name: Commit
description: >
@@ -9,41 +9,41 @@
fields to flash. The "level" of the committed error log is same as the
level defined in error YAML definitions.
parameters:
- - name: transactionId
- type: uint64
- description: >
- The unique identifier of the journal entry(ies) to be committed.
- - name: errMsg
- type: string
- description: >
- The error exception message associated with the error
- event log to be committed.
+ - name: transactionId
+ type: uint64
+ description: >
+ The unique identifier of the journal entry(ies) to be committed.
+ - name: errMsg
+ type: string
+ description: >
+ The error exception message associated with the error event log
+ to be committed.
returns:
- - name: entryID
- type: uint32
- description: >
- The ID of the entry.
+ - name: entryID
+ type: uint32
+ description: >
+ The ID of the entry.
- name: CommitWithLvl
description: >
Write the requested error/event entry with its associated metadata
fields to flash. This interface allows the caller to override the
error level specified in the error YAML definition.
parameters:
- - name: transactionId
- type: uint64
- description: >
- The unique identifier of the journal entry(ies) to be committed.
- - name: errMsg
- type: string
- description: >
- The error exception message associated with the error
- event log to be committed.
- - name: errLvl
- type: uint32
- description: >
- The error level/severity indicator.
+ - name: transactionId
+ type: uint64
+ description: >
+ The unique identifier of the journal entry(ies) to be committed.
+ - name: errMsg
+ type: string
+ description: >
+ The error exception message associated with the error event log
+ to be committed.
+ - name: errLvl
+ type: uint32
+ description: >
+ The error level/severity indicator.
returns:
- - name: entryID
- type: uint32
- description: >
- The ID of the entry.
+ - name: entryID
+ type: uint32
+ description: >
+ The ID of the entry.