openbmc/phosphor-host-ipmid/sensordatahandler.hpp

18 extern ipmi::sensor::SensorCacheMap sensorCacheMap;
28 namespace sensor
45  *  @param[in] cmdData - Input sensor data
59 /** @brief Populate sensor name from the D-Bus property associated with the
60  *         sensor. In the example entry from the yaml, the name of the D-bus
61  *         property "AttemptsLeft" is the sensor name.
78  *  @param[in] sensorInfo - Dbus info related to sensor.
80  *  @return On success return the sensor name for the sensor.
87 /** @brief Populate sensor name from the D-Bus object associated with the
88  *         sensor. If the object path is /system/chassis/motherboard/dimm0 then
89  *         the leaf dimm0 is considered as the sensor name.
91  *  @param[in] sensorInfo - Dbus info related to sensor.
93  *  @return On success return the sensor name for the sensor.
102 /** @brief Populate sensor name from the D-Bus object associated with the
103  *         sensor and the property.
106  *         joined to Fan0_Present as the sensor name.
108  *  @param[in] sensorInfo - Dbus info related to sensor.
110  *  @return On success return the sensor name for the sensor.
117 /** @brief Populate sensor name from the D-Bus object associated with the
118  *         sensor. If the object path is /system/chassis/motherboard/cpu0/core0
119  *         then the sensor name is cpu0_core0. The leaf and the parent is put
120  *         together to get the sensor name.
122  *  @param[in] sensorInfo - Dbus info related to sensor.
124  *  @return On success return the sensor name for the sensor.
129  *  @brief Helper function to map the dbus info to sensor's assertion status
130  *         for the get sensor reading command.
132  *  @param[in] sensorInfo - Dbus info related to sensor.
136  *  @return Response for get sensor reading command.
144  *  @brief Map the Dbus info to sensor's assertion status in the Get sensor
147  *  @param[in] sensorInfo - Dbus info related to sensor.
149  *  @return Response for get sensor reading command.
154  *  @brief Maps the Dbus info to the reading field in the Get sensor reading
157  *  @param[in] sensorInfo - Dbus info related to sensor.
159  *  @return Response for get sensor reading command.
165  *         serves as the sensor value.
167  *  @tparam T - type of the dbus property related to sensor.
168  *  @param[in] sensorInfo - Dbus info related to sensor.
170  *  @return Response for get sensor reading command.
202 /** @brief Map the Dbus info to the reading field in the Get sensor reading
205  *  @tparam T - type of the dbus property related to sensor.
206  *  @param[in] sensorInfo - Dbus info related to sensor.
208  *  @return Response for get sensor reading command.
273     // if sensorUnits1 [7:6] = 10b, sensor is signed
353  *  @brief Map the Dbus info to sensor's assertion status in the Get sensor
356  *  @param[in] id - The sensor id
357  *  @param[in] sensorInfo - Dbus info related to sensor.
360  *  @return Response for get sensor reading command.
366  *  @brief Maps the Dbus info to the reading field in the Get sensor reading
369  *  @param[in] id - The sensor id
370  *  @param[in] sensorInfo - Dbus info related to sensor.
373  *  @return Response for get sensor reading command.
380  *         serves as the sensor value.
382  *  @tparam T - type of the dbus property related to sensor.
383  *  @param[in] id - The sensor id
384  *  @param[in] sensorInfo - Dbus info related to sensor.
387  *  @return Response for get sensor reading command.
414 /** @brief Get sensor reading from the dbus message from match
416  *  @tparam T - type of the dbus property related to sensor.
417  *  @param[in] id - The sensor id
418  *  @param[in] sensorInfo - Dbus info related to sensor.
421  *  @return Response for get sensor reading command.
465     // if sensorUnits1 [7:6] = 10b, sensor is signed
510  *  @param[in] sensorPath - Path of the sensor
512  *  @param[in] sensorInterface - DBus interface of sensor
520 /** @brief Update d-bus based on assertion type sensor data
521  *  @param[in] cmdData - input sensor data
522  *  @param[in] sensorInfo - sensor d-bus info
528  *  @tparam T - type of d-bus property mapping this sensor
529  *  @param[in] cmdData - input sensor data
530  *  @param[in] sensorInfo - sensor d-bus info
554  *  @param[in] cmdData - input sensor data
555  *  @param[in] sensorInfo - sensor d-bus info
582 /** @brief Update d-bus based on eventdata type sensor data
583  *  @param[in] cmdData - input sensor data
584  *  @param[in] sensorInfo - sensor d-bus info
590 /** @brief Update d-bus based on eventdata1 type sensor data
591  *  @param[in] cmdData - input sensor data
592  *  @param[in] sensorInfo - sensor d-bus info
601 /** @brief Update d-bus based on eventdata2 type sensor data
602  *  @param[in] cmdData - input sensor data
603  *  @param[in] sensorInfo - sensor d-bus info
612 /** @brief Update d-bus based on eventdata3 type sensor data
613  *  @param[in] cmdData - input sensor data
614  *  @param[in] sensorInfo - sensor d-bus info
630  *  @param[in] sensorPath - Path of the sensor
632  *  @param[in] sensorInterface - DBus interface of sensor
640 /** @brief Update d-bus based on assertion type sensor data
641  *  @param[in] interfaceMap - sensor interface
642  *  @param[in] cmdData - input sensor data
643  *  @param[in] sensorInfo - sensor d-bus info
659  *  @brief Map the Dbus info to sensor's assertion status in the Get sensor
662  *  @param[in] sensorInfo - Dbus info related to sensor.
664  *  @return Response for get sensor reading command.
671  *  @brief Map the Dbus info to sensor's assertion status in the Get sensor
674  *  @param[in] id - The sensor id
675  *  @param[in] sensorInfo - Dbus info related to sensor.
678  *  @return Response for get sensor reading command.
688 } // namespace sensor