openbmc/phosphor-fan-presence/json_config.hpp

6  * You may obtain a copy of the License at
8  *     http://www.apache.org/licenses/LICENSE-2.0
21 #include <phosphor-logging/log.hpp>
36 constexpr auto confOverridePath = "/etc/phosphor-fan-presence";
37 constexpr auto confBasePath = "/usr/share/phosphor-fan-presence";
40     "xyz.openbmc_project.Inventory.Decorator.Compatible";
44  * @class NoConfigFound - A no JSON configuration found exception
63      * exception can be thrown to denote that at that time finding/loading the
68      * @param[in] details - Additional details
82      * @brief Get the object paths with the compatible interface
84      * Retrieve all the object paths implementing the compatible interface for
110      * Attempts to set the list of compatible values from the compatible
112      * the compatible interface is not found, it subscribes to the
113      * interfacesAdded signal for that interface on the compatible service
116      * @param[in] func - Fan app function to call to load its config file(s)
135             // Compatible interface does not exist on any dbus object yet  in JsonConfig()
144                     // Retrieve json config compatible relative path  in JsonConfig()
146                     // than one dbus object implementing the compatible  in JsonConfig()
155                     // Compatible property unavailable on this dbus object  in JsonConfig()
156                     // path's compatible interface, ignore  in JsonConfig()
165                 // The Decorator.Compatible interface is not unique to one  in JsonConfig()
173             // compatible interface, otherwise this is intended to catch the  in JsonConfig()
176             // waiting for the compatible interfacesAdded signal  in JsonConfig()
183                 // Wait for compatible interfacesAdded signal  in JsonConfig()
189      * @brief InterfacesAdded callback function for the compatible interface.
191      * @param[in] msg - The D-Bus message contents
193      * If the compatible interface is found, it uses the compatible property on
194      * the interface to set the list of compatible values to be used when
195      * attempting to get a configuration file. Once the list of compatible
202             // Do not process the interfaceAdded signal if one compatible name  in compatIntfAdded()
218         const auto& props = intfProps.at(confCompatIntf);  in compatIntfAdded()
219         // Only one dbus object with the compatible interface is used at a time  in compatIntfAdded()
221             std::get<std::vector<std::string>>(props.at(confCompatProp));  in compatIntfAdded()
239      * @param[in] appName - The phosphor-fan-presence application name
240      * @param[in] fileName - Application's configuration file's name
241      * @param[in] isOptional - Config file is optional, default to 'false'
264         // Look for a config file at each entry relative to the base  in getConfFile()
290      * @param[in] confFile - File system path of the configuration file to load
340      * @brief Return the compatible values property
342      * @return const std::vector<std::string>& - The values
355      *        for the Inventory.Decorator.Compatible interface to show up.
360      * @brief List of compatible values from the compatible interface
362      * Only supports a single instance of the compatible interface on a dbus
363      * object. If more than one dbus object exists with the compatible
364      * interface, the last one found will be the list of compatible values used.
369      * @brief The compatible value that is currently used to load configuration
372      * as a sub-folder to append to the configuration location and really