Change PostCode property signature

- This commit would change the backend signature of the
  PostCode Raw Value property.

- IBM progress codes are typically around 72 bytes including a
  primary code (typically 8 bytes) & a secondary code that
  contains hex words that would provide additional details on the
  core problem during boot hangs.

- The intent behind this commit is to change the signature of the
  backend Post Code Raw Value Property as per the proposed PDI
  change.

- This commit has various dependencies across mutiple repos like
  phosphor-host-postd, phosphor-post-code-manager, all the dependent
  commit can be found in gerrit with topic name : progress codes

Tested By :
1. PATCHED a witherspoon system with the new PDI library with both
   changes(40927,40936).
2. PACTHED the new snoopd daemon, post code manager, bmcweb & pldm with
   the progress code support.
3. Trigger a progress code(ASCII Value : STANDBY) using the pldm tool as shown below:

./pldmtool raw --data 0x80 0x3F 0xC 0x0A 0x00 0x00 0x00 0x00 0x00 0x07
0x00 0x00 0x00 0x48 0x00 0x00 0x00 0x02 0x00 0x00 0x01 0x00 0x00 0x00
0x48 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00
0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00
0x00 0x00 0x00 0x00 0x00 0x53 0x54 0x41 0x4e 0x44 0x42 0x59 0x20 0x20
0x20 0x20 0x20 0x20 0x20 0x20 0x20 0x20 0x20 0x20 0x20 0x20 0x20 0x20
0x20 0x20 0x20 0x20 0x20 0x20 0x20 0x20 0x20

4. Now check the Raw Property :
busctl call xyz.openbmc_project.State.Boot.Raw /xyz/openbmc_project/state/boot/raw0
org.freedesktop.DBus.Properties Get ss xyz.openbmc_project.State.Boot.Raw Value
v (tay) 6004496007600167200 72 2 0 0 1 0 0 0 72 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0 0 0 0 0 83 84 65 78 68 66 89 32 32 32 32 32 32 32 32 32 32 32 32
32 32 32 32 32 32 32 32 32 32 32 32 32

5. Check the Redfish GET on Post Code Log Service Entry

{
  "@odata.id": "/redfish/v1/Systems/system/LogServices/PostCodes/Entries",
  "@odata.type": "#LogEntryCollection.LogEntryCollection",
  "Description": "Collection of POST Code Log Entries",
  "Members": [
    {
      "@odata.id": "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/B1-1",
      "@odata.type": "#LogEntry.v1_4_0.LogEntry",
      "Created": "2021-02-27T08:38:31+00:00",
      "EntryType": "Event",
      "Id": "B1-1",
      "Message": "Boot Count: 1: TS Offset: 0.0000; POST Code: 0x5354414e44425920",
      "MessageArgs": [
        "1",
        "0.0000",
        "0x5354414e44425920"
      ],
      "MessageId": "OpenBMC.0.1.BIOSPOSTCode",
      "Name": "POST Code Log Entry",
      "Severity": "OK"
    }
  ],
  "Members@odata.count": 1,
  "Members@odata.nextLink": "/redfish/v1/Systems/system/LogServices/PostCodes/Entries?$skip=1000",
  "Name": "BIOS POST Code Log Entries"
}

The post code Field shows 0x5354414e44425920 in Hex(In Ascii it would be
STANDBY)

Signed-off-by: Manojkiran Eda <manojkiran.eda@gmail.com>
Change-Id: I960a9a4f35ac8d7af03e9547d1f609b6adda0caa
1 file changed
tree: 73ac6d66b77bb742770d196d501bf52a6605121a
  1. .github/
  2. http/
  3. include/
  4. redfish-core/
  5. scripts/
  6. src/
  7. static/
  8. subprojects/
  9. .clang-format
  10. .clang-ignore
  11. .clang-tidy
  12. .dockerignore
  13. .gitignore
  14. .shellcheck
  15. bmcweb.service.in
  16. bmcweb.socket
  17. bmcweb_config.h.in
  18. build_x86.sh
  19. build_x86_docker.sh
  20. COMMON_ERRORS.md
  21. DEVELOPING.md
  22. Dockerfile
  23. Dockerfile.base
  24. LICENCE
  25. MAINTAINERS
  26. meson.build
  27. meson_options.txt
  28. OEM_SCHEMAS.md
  29. OWNERS
  30. pam-webserver
  31. README.md
  32. Redfish.md
README.md

OpenBMC webserver

This component attempts to be a "do everything" embedded webserver for openbmc.

Capabilities

At this time, the webserver implements a few interfaces:

  • Authentication middleware that supports cookie and token based authentication, as well as CSRF prevention backed by linux PAM authentication credentials.
  • An (incomplete) attempt at replicating phosphor-dbus-rest interfaces in C++. Right now, a few of the endpoint definitions work as expected, but there is still a lot of work to be done. The portions of the interface that are functional are designed to work correctly for phosphor-webui, but may not yet be complete.
  • Replication of the rest-dbus backend interfaces to allow bmc debug to logged in users.
  • An initial attempt at a read-only redfish interface. Currently the redfish interface targets ServiceRoot, SessionService, AccountService, Roles, and ManagersService. Some functionality here has been shimmed to make development possible. For example, there exists only a single user role.
  • SSL key generation at runtime. See the configuration section for details.
  • Static file hosting. Currently, static files are hosted from the fixed location at /usr/share/www. This is intended to allow loose coupling with yocto projects, and allow overriding static files at build time.
  • Dbus-monitor over websocket. A generic endpoint that allows UIs to open a websocket and register for notification of events to avoid polling in single page applications. (this interface may be modified in the future due to security concerns.

Configuration

BMCWeb is configured by setting -D flags that correspond to options in bmcweb/meson_options.txt and then compiling. For example, meson <builddir> -Dkvm=disabled ... followed by ninja in build directory. The option names become C++ preprocessor symbols that control which code is compiled into the program.

Compile bmcweb with default options:

meson builddir
ninja -C builddir

Compile bmcweb with yocto defaults:

meson builddir -Dbuildtype=minsize -Db_lto=true -Dtests=disabled
ninja -C buildir

If any of the dependencies are not found on the host system during configuration, meson automatically gets them via its wrap dependencies mentioned in bmcweb/subprojects.

Enable/Disable meson wrap feature

meson builddir -Dwrap_mode=nofallback
ninja -C builddir

Generate test coverage report:

meson builddir -Db_coverage=true -Dtests=enabled
ninja coverage -C builddir test

When BMCWeb starts running, it reads persistent configuration data (such as UUID and session data) from a local file. If this is not usable, it generates a new configuration.

When BMCWeb SSL support is enabled and a usable certificate is not found, it will generate a self-sign a certificate before launching the server. The keys are generated by the secp384r1 algorithm. The certificate

  • is issued by C=US, O=OpenBMC, CN=testhost,
  • is valid for 10 years,
  • has a random serial number, and
  • is signed using the SHA-256 algorithm.