xref: /openbmc/phosphor-dbus-interfaces/yaml/xyz/openbmc_project/Inventory/Item/README.md (revision fc5546ea66377480bcddc5208eefc291ca5b0e99)
1# Representing Inventory Items on DBus
2
3## Overview
4
5Inventory refers to physical objects. Some of the objects can be physically
6accessed, such as a board, a chassis and a drive. Some objects are embedded in
7other objects, such as a BMC embedded in a board, or a core in a CPU. The DBus
8interfaces in this directory describe the DBus representation of those physical
9objects. A graph consisting of Inventory objects as vertexes and Association
10as edges can be constructed that represents the relationship between different
11parts (such as chassis, drive, sensors, etc) of the system.
12
13# Inventory Association
14
15DBus objects with xyz.opebmc_project.Inventory.Item.${ItemType} interface might
16be associated with other inventory objects. Such association can be translated
17to Redfish schemas and then indicate the system topology.
18
19Document ObjectMapper association forward and reverse names as follows:
20* cpu and PCIe slots: [associated_pcie_slots, upstream_processor]
21* cpu and core: [containing, contained_by]
22* Sensor.Value and Bmc: [monitoring, monitored_by]
23