phosphor-power-supply/docs/MultiChassis.md

1 # Multi-Chassis Support for phosphor-psu-monitor
5 Currently, **phosphor-psu-monitor** operates on a **single chassis**.
7 - It gets the PSUs device access information (such as PSU I2CBus and I2CAddress)
9 - The phosphor-psu-monitor uses a **fixed object path**, appended with the PSU
11 - Example of current PSU path:
18 ## Goal: Support Multi-Chassis PSUs
20 To support **multi-chassis**, the **phosphor-psu-monitor** requires the
23 - Define Chassis class
24 - Modify the **PSUManager** class to instantiate one **Chassis class** per
26 - Find all PSUs associated with each chassis.
27 - Update the PSUs status on DBus with appropriate path i.e.
37 - Chassis class constructor take parameters D-Bus connection object, chassis
39 - Vector of powerSupply instances
40 - Functions to get and add PSUs
41 - Function to get chassis status
45 - Add method to retrieve a list of chassis objects from the **inventory
47   for D-BUS events to track chassis PGOOD Status.
48 - Retrieve the PSU configurations from **entity manager**
49 - Find all PSUs associated with chassis from **inventory manager** (using
50   [`getSubTree`](https://github.com/openbmc/phosphor-power/blob/master/utility.hpp))
51   and add them to vector in the chassis object. **getSubTree** is a function
52   interacts with the D-Bus object mapper to retrieve all objects under a
57 - The PSUManager object loops over all **chassis** that are present and have
58   standby power. The **phosphor-psu-monitor** app monitors all PSUs associated
60   - Monitor Presence
61   - Create appropriate journal entries
62   - Create PELs for faults if the chassis is powered on
66 - Update/publish **PSU sensors, presence and VPD information** on D-Bus.
67 - Ensure properties **reflect multi-chassis** support.
69 Note: The phosphor-psu-monitor logic should remain the same when adding support
70 for multi chassis.
74 - TBD
78 - Ensure any **error** references the **correct PSU inventory path**, e.g.,
79   - `/xyz/openbmc_project/inventory/system/chassis0/powersupply0`
80   - `/xyz/openbmc_project/inventory/system/chassis1/powersupply3`
84 - Update journal messages to reflect **appropriate chassis**.
86 ---
90 **phosphor-psu-monitor** must be enhanced to dynamically:
92 - Discover chassis, and maintain state of each chassis and react accordingly.
93 - Monitor PSUs across all chassis
94 - Update DBus and error logs accordingly.