README and Platform Events whitepaper

This commit introduces general README to the repository.
It gives basic information about intel-ipmi-oem role and surroundings,
with references to proper documents and repositories.

It also introduces detailed document intended for end-users about
Platform Event parsing.
Intel platforms are source of high-impact health events and this
usually introduces confusion and false-positives among OEM BMC
implementations. Document specifies abstract algorithm for parsing these
events and references existing implementation in repository as solution.
It's intended to be used by external OEMs as guide for porting the
feature to other BMC implementations.

Change-Id: Ibe6c1e148feba425a7a026d1b7a1dadb028cf09b
Signed-off-by: Adrian Ambrożewicz <adrian.ambrozewicz@linux.intel.com>
2 files changed
tree: e481d33555deef70d3fc84bcd182f62c40fcc61b
  1. docs/
  2. include/
  3. non-yocto/
  4. src/
  5. tests/
  6. .clang-format
  7. .gitignore
  8. cmake-format.json
  9. CMakeLists.txt
  10. CMakeLists.txt.in
  11. generate-whitelist.py
  12. ipmi-whitelist.conf
  13. LICENSE
  14. MAINTAINERS
  15. README.md
README.md

Intel IPMI OEM support library

This component is intended to provide Intel-specific IPMI[3] command handlers for OpenBMC. These handlers are intended to integrate BMC with servers based on Intel architecture.

Overview

intel-ipmi-oem serves as an extension[1] to OpenBMC IPMI daemon[2]. It is compiled as a shared library and intended to both:

  • override existing implementation of standard IPMI commands to comply with Intel-specific solutions,
  • provide implementation for non-standard OEM extensions.

Capabilities

Related features provided by the library are grouped in separate source files. Main extensions to vanilla OpenBMC IPMI stack are the following:

  • Acquiring SMBIOS data over IPMI
  • Commands for better integration with Intel hardware
  • Firmware update extensions
  • Extended parsing of IPMI Platform Events[4]

References

  1. OpenBMC IPMI Architecture
  2. Phosphor IPMI Host
  3. IPMI Specification v2.0
  4. Intel Platform Events parsing