NVMeSensorMain: Split out NVMeDevice

NVMeDevice was defined as a type to hold references to the MI and
subsystem instances across the lifetime of the device configuration
provided by EM.

setupMctpDevice() was a static function associated with these objects by
way of taking them as parameters. A small trick here was the conversion
of strong to weak pointers by way of the types specified for the formal
parameters. The conversion enables the desired lifetime management of
the associated DBus objects, tying them to the EM configuration (and not
the lifetime of `mctpd` DBus objects).

Really though, setupMctpDevice() could be better expressed as a method
on NVMeDevice: This way we can handle any smart-pointer type conversions
internal to the class' implementation, and applying this perspective
increases the testability of the code. A final benefit is that
by isolating the code we can refactor it to add features without
significantly impacting its readability. Ultimately the goal is to
insert a delay via a timer to mitigate stalling of the main thread due
to recovery-related event-cycles.

Here we purely do the code-motion that moves the implementation of
setupMctpEndpoint() out of NVMeSensorMain.cpp, along with defining a
method that wraps its invocation.

Change-Id: I498c43561dee61462e049b9ad43c987e1754ba0c
Signed-off-by: Andrew Jeffery <andrew@codeconstruct.com.au>
4 files changed
tree: dc1c409f2fbefd62ca71b82af53aa41aef775eee
  1. gen/
  2. include/
  3. proto/
  4. service_files/
  5. src/
  6. subprojects/
  7. tests/
  8. yaml/
  9. .clang-format
  10. .clang-tidy
  11. .clang-tidy-ignore
  12. .gitignore
  13. build.md
  14. gemini.md
  15. lesson.md
  16. LICENSE
  17. meson.build
  18. meson_options.txt
  19. OWNERS
  20. README.md
README.md

dbus-sensors

dbus-sensors is a collection of sensor applications that provide the xyz.openbmc_project.Sensor collection of interfaces. They read sensor values from hwmon, d-bus, or direct driver access to provide readings. Some advance non-sensor features such as fan presence, pwm control, and automatic cpu detection (x86) are also supported.

key features

  • runtime re-configurable from d-bus (entity-manager or the like)

  • isolated: each sensor type is isolated into its own daemon, so a bug in one sensor is unlikely to affect another, and single sensor modifications are possible

  • async single-threaded: uses sdbusplus/asio bindings

  • multiple data inputs: hwmon, d-bus, direct driver access

dbus interfaces

A typical dbus-sensors object support the following dbus interfaces:

Path        /xyz/openbmc_project/sensors/<type>/<sensor_name>

Interfaces  xyz.openbmc_project.Sensor.Value
            xyz.openbmc_project.Sensor.Threshold.Critical
            xyz.openbmc_project.Sensor.Threshold.Warning
            xyz.openbmc_project.State.Decorator.Availability
            xyz.openbmc_project.State.Decorator.OperationalStatus
            xyz.openbmc_project.Association.Definitions

Sensor interfaces collection are described here.

Consumer examples of these interfaces are Redfish, Phosphor-Pid-Control, IPMI SDR.

Reactor

dbus-sensor daemons are reactors that dynamically create and update sensors configuration when system configuration gets updated.

Using asio timers and async calls, dbus-sensor daemons read sensor values and check thresholds periodically. PropertiesChanged signals will be broadcasted for other services to consume when value or threshold status change. OperationStatus is set to false if the sensor is determined to be faulty.

A simple sensor example can be found here.

configuration

Sensor devices are described using Exposes records in configuration file. Name and Type fields are required. Different sensor types have different fields. Refer to entity manager schema for complete list.

sensor documentation