PEL: Use raw procedure names in PEL msg reg

Start using the raw maintenance procedure names in the PEL message
registry, such as BMC0001, instead of the enum values, such as
'bmc_firmware'. This wa

PEL: Use raw procedure names in PEL msg reg

Start using the raw maintenance procedure names in the PEL message
registry, such as BMC0001, instead of the enum values, such as
'bmc_firmware'. This way, the script that generates documentation can
list the procedure in the section for that PEL. This was requested by
the support team.

Note that there is still one user of the enums - the checkstop analysis
code uses them when it creates callouts by passing in them via JSON user
data files.

There are pointers added to the README and schema to find the available
procedures and their descriptions.

Tested:
- The unit tests still work which verify the callout contents when PEL
callouts are created via the message registry.
- Also manually verified PEL procedure callouts look correct when
created from the message registry.

Signed-off-by: Matt Spinler <spinler@us.ibm.com>
Change-Id: I3e8416956120d4dae1ff40592fd0df4f0285d072

show more ...

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.

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>

show more ...

PEL: Remove 'no_vpd_for_fru' maintenance procedure

This procedure was being used in a callout when the location code could
not be found on an inventory item. The code was changed to jus

PEL: Remove 'no_vpd_for_fru' maintenance procedure

This procedure was being used in a callout when the location code could
not be found on an inventory item. The code was changed to just not add
a callout in this case.

This was done for the following reasons:
1) There's no expected reason that the inventory would be missing a
location code for a valid inventory path.
2) There wasn't a way to give a hint to the end user about what the
callout should be in that case. Usually maintenance procedures should
have steps one can take to still do the appropriate replacement.
3) Because of 1), this case indicates a bad inventory path passed in by
the caller. Theoretically there is a way to have a 'bmc_code'
callout, but that wouldn't be appropriate to add in this log since
the intent of this one is for another problem.
3a) There is no way to create a new error log from inside a PEL section,
and I don't think this one case warrants coming up with a way to do
so.
4) The inventory path in question is still being added into a UserData
section so that development can debug it.

Signed-off-by: Matt Spinler <spinler@us.ibm.com>
Change-Id: I0757080f04942807cc34029d8667387db6b959fe

show more ...

PEL: Maintenance procedure callout definitions

A maintenance procedure is a short string that resides in the FRU
identity structure in the SRC section of a PEL that maps to a service

PEL: Maintenance procedure callout definitions

A maintenance procedure is a short string that resides in the FRU
identity structure in the SRC section of a PEL that maps to a service
procedure in the service documentation.

This commit adds the initial framework for dealing with these by adding
an enum type to specify them, and a pel_values.hpp function to get the
actual string value of the maintenance procedure based on its enum.

A single procedure is created in this commit, NoVPDforFRU, which will
be used in a future commit when the location code, part number, etc,
aren't available when trying to do a callout and so this procedure will
be used instead.

Signed-off-by: Matt Spinler <spinler@us.ibm.com>
Change-Id: I45f366e98794462c70d851f743e4f497c0af77b4

show more ...

PEL: Add JSON schema for callouts in registry

Add the JSON schema for the structures needed to describe callouts in
the message registry. The PEL code will then add these callouts to th

PEL: Add JSON schema for callouts in registry

Add the JSON schema for the structures needed to describe callouts in
the message registry. The PEL code will then add these callouts to that
PEL when it creates it.

The callouts to create for a PEL can vary based on system type, as well
as by an AdditionalData field if desired.

This is an optional field.

Signed-off-by: Matt Spinler <spinler@us.ibm.com>
Change-Id: Ib4e0edffc705e3147e5f7a40364f2adedaabb545

show more ...

PEL: Add message registry JSON schema

The message registry is JSON data that will aid in converting OpenBMC
event logs into IBM's Platform Event Log (PEL) format. PELs have more
fie

PEL: Add message registry JSON schema

The message registry is JSON data that will aid in converting OpenBMC
event logs into IBM's Platform Event Log (PEL) format. PELs have more
fields than event logs, many with specific IBM defined values, that need
to be able to be looked up for an OpenBMC event log so the PEL can be
filled in. In addition to aiding in creating PELs, it also contains
information to aid in parsing PELs.

This schema defines how that JSON will look, and this commit also
contains an example registry file.

A script will be added in the future to validate the registry JSON
against the schema during a bitbake build.

Until there is a need, the message registry will be contained in a
single JSON file. If there is a need, it can be split up along some
predetermined rules in the future.

Signed-off-by: Matt Spinler <spinler@us.ibm.com>
Change-Id: I98620b263bd1faff27e36da7a0c101a982b58057

show more ...