blob: 8ae85836ac2df93acd6293552cd0330cabf13ed5 [file] [log] [blame]
Matt Spinlerabf8da32017-04-27 14:08:45 -05001/**
2 * Copyright © 2017 IBM Corporation
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
Matthew Barth4d982852017-11-17 09:37:13 -060016#include <experimental/filesystem>
Matt Spinlerabf8da32017-04-27 14:08:45 -050017#include <phosphor-logging/log.hpp>
18#include "fan.hpp"
Brad Bishop2a58e2c2017-07-30 13:49:09 -040019#include "sdbusplus.hpp"
Matt Spinlerabf8da32017-04-27 14:08:45 -050020#include "tach_sensor.hpp"
Matthew Barth4d982852017-11-17 09:37:13 -060021#include "utility.hpp"
Matt Spinlerabf8da32017-04-27 14:08:45 -050022
23namespace phosphor
24{
25namespace fan
26{
27namespace monitor
28{
29
Matt Spinlerebaae612017-04-27 14:21:48 -050030constexpr auto FAN_SENSOR_CONTROL_INTF = "xyz.openbmc_project.Control.FanSpeed";
31constexpr auto FAN_SENSOR_VALUE_INTF = "xyz.openbmc_project.Sensor.Value";
32constexpr auto FAN_TARGET_PROPERTY = "Target";
33constexpr auto FAN_VALUE_PROPERTY = "Value";
34
Matthew Barth4d982852017-11-17 09:37:13 -060035using namespace std::experimental::filesystem;
Matt Spinlerebaae612017-04-27 14:21:48 -050036
37/**
38 * @brief Helper function to read a property
39 *
40 * @param[in] interface - the interface the property is on
41 * @param[in] propertName - the name of the property
42 * @param[in] path - the dbus path
Matt Spinlerebaae612017-04-27 14:21:48 -050043 * @param[in] bus - the dbus object
44 * @param[out] value - filled in with the property value
45 */
46template<typename T>
47static void readProperty(const std::string& interface,
48 const std::string& propertyName,
49 const std::string& path,
Matt Spinlerebaae612017-04-27 14:21:48 -050050 sdbusplus::bus::bus& bus,
51 T& value)
52{
Matt Spinlerebaae612017-04-27 14:21:48 -050053 try
54 {
Brad Bishop2a58e2c2017-07-30 13:49:09 -040055 value = util::SDBusPlus::getProperty<T>(bus,
56 path,
57 interface,
58 propertyName);
Matt Spinlerebaae612017-04-27 14:21:48 -050059 }
60 catch (std::exception& e)
61 {
62 phosphor::logging::log<phosphor::logging::level::ERR>(e.what());
63 }
64}
Matt Spinlerabf8da32017-04-27 14:08:45 -050065
66
67TachSensor::TachSensor(sdbusplus::bus::bus& bus,
68 Fan& fan,
69 const std::string& id,
70 bool hasTarget,
Matt Spinlera9406a72017-04-27 14:29:24 -050071 size_t timeout,
Matt Spinlere824f982017-05-11 10:07:55 -050072 phosphor::fan::event::EventPtr& events) :
Matt Spinlerabf8da32017-04-27 14:08:45 -050073 _bus(bus),
74 _fan(fan),
75 _name(FAN_SENSOR_PATH + id),
Matthew Barth4d982852017-11-17 09:37:13 -060076 _invName(path(fan.getName()) / id),
Matt Spinlerabf8da32017-04-27 14:08:45 -050077 _hasTarget(hasTarget),
Matt Spinlera9406a72017-04-27 14:29:24 -050078 _timeout(timeout),
79 _timer(events, [this, &fan](){ fan.timerExpired(*this); })
Matt Spinlerabf8da32017-04-27 14:08:45 -050080{
Matthew Barthd199dcd2017-11-20 10:36:41 -060081 // Start from a known state of functional
82 _functional = true;
83 updateInventory(_functional);
Brad Bishopedaeb312017-07-30 19:38:20 -040084
Matthew Barthd199dcd2017-11-20 10:36:41 -060085 // Load in starting Target and Input values
Brad Bishopedaeb312017-07-30 19:38:20 -040086 try
87 {
88 // Use getProperty directly to allow a missing sensor object
89 // to abort construction.
90 _tachInput = util::SDBusPlus::getProperty<decltype(_tachInput)>(
91 _bus,
92 _name,
93 FAN_SENSOR_VALUE_INTF,
94 FAN_VALUE_PROPERTY);
95 }
96 catch (std::exception& e)
97 {
98 throw InvalidSensorError();
99 }
Matt Spinlerebaae612017-04-27 14:21:48 -0500100
101 if (_hasTarget)
102 {
103 readProperty(FAN_SENSOR_CONTROL_INTF,
104 FAN_TARGET_PROPERTY,
105 _name,
Matt Spinlerebaae612017-04-27 14:21:48 -0500106 _bus,
107 _tachTarget);
108 }
109
110 auto match = getMatchString(FAN_SENSOR_VALUE_INTF);
111
112 tachSignal = std::make_unique<sdbusplus::server::match::match>(
113 _bus,
114 match.c_str(),
Brad Bishop771659f2017-07-30 19:52:21 -0400115 [this](auto& msg){ this->handleTachChange(msg); });
Matt Spinlerebaae612017-04-27 14:21:48 -0500116
117 if (_hasTarget)
118 {
119 match = getMatchString(FAN_SENSOR_CONTROL_INTF);
120
121 targetSignal = std::make_unique<sdbusplus::server::match::match>(
122 _bus,
123 match.c_str(),
Brad Bishop771659f2017-07-30 19:52:21 -0400124 [this](auto& msg){ this->handleTargetChange(msg); });
Matt Spinlerebaae612017-04-27 14:21:48 -0500125 }
126
127}
128
129
Matt Spinlerebaae612017-04-27 14:21:48 -0500130std::string TachSensor::getMatchString(const std::string& interface)
131{
Brad Bishop78b58452017-07-30 19:44:49 -0400132 return sdbusplus::bus::match::rules::propertiesChanged(
133 _name, interface);
Matt Spinlerebaae612017-04-27 14:21:48 -0500134}
135
Matthew Barthd199dcd2017-11-20 10:36:41 -0600136void TachSensor::setFunctional(bool functional)
137{
138 _functional = functional;
139 updateInventory(_functional);
140}
Matt Spinlerebaae612017-04-27 14:21:48 -0500141
Matt Spinlerebaae612017-04-27 14:21:48 -0500142/**
143 * @brief Reads a property from the input message and stores it in value.
144 * T is the value type.
145 *
146 * Note: This can only be called once per message.
147 *
148 * @param[in] msg - the dbus message that contains the data
149 * @param[in] interface - the interface the property is on
150 * @param[in] propertName - the name of the property
151 * @param[out] value - the value to store the property value in
152 */
153template<typename T>
154static void readPropertyFromMessage(sdbusplus::message::message& msg,
155 const std::string& interface,
156 const std::string& propertyName,
157 T& value)
158{
159 std::string sensor;
160 std::map<std::string, sdbusplus::message::variant<T>> data;
161 msg.read(sensor, data);
162
163 if (sensor.compare(interface) == 0)
164 {
165 auto propertyMap = data.find(propertyName);
166 if (propertyMap != data.end())
167 {
168 value = sdbusplus::message::variant_ns::get<T>(
169 propertyMap->second);
170 }
171 }
172}
173
174
Brad Bishop771659f2017-07-30 19:52:21 -0400175void TachSensor::handleTargetChange(sdbusplus::message::message& msg)
Matt Spinlerebaae612017-04-27 14:21:48 -0500176{
177 readPropertyFromMessage(msg,
178 FAN_SENSOR_CONTROL_INTF,
179 FAN_TARGET_PROPERTY,
180 _tachTarget);
181
182 //Check all tach sensors on the fan against the target
183 _fan.tachChanged();
184}
185
186
Brad Bishop771659f2017-07-30 19:52:21 -0400187void TachSensor::handleTachChange(sdbusplus::message::message& msg)
Matt Spinlerebaae612017-04-27 14:21:48 -0500188{
189 readPropertyFromMessage(msg,
190 FAN_SENSOR_VALUE_INTF,
191 FAN_VALUE_PROPERTY,
192 _tachInput);
193
194 //Check just this sensor against the target
195 _fan.tachChanged(*this);
Matt Spinlerabf8da32017-04-27 14:08:45 -0500196}
197
198
Matt Spinlera9406a72017-04-27 14:29:24 -0500199std::chrono::microseconds TachSensor::getTimeout()
200{
201 using namespace std::chrono;
202
203 return duration_cast<microseconds>(seconds(_timeout));
204}
205
Matthew Barth4d982852017-11-17 09:37:13 -0600206void TachSensor::updateInventory(bool functional)
207{
208 auto objectMap = util::getObjMap<bool>(
209 _invName,
210 util::OPERATIONAL_STATUS_INTF,
211 util::FUNCTIONAL_PROPERTY,
212 functional);
213 auto response = util::SDBusPlus::lookupAndCallMethod(
214 _bus,
215 util::INVENTORY_PATH,
216 util::INVENTORY_INTF,
217 "Notify",
218 objectMap);
219 if (response.is_method_error())
220 {
221 log<level::ERR>("Error in notify update of tach sensor inventory");
222 }
223}
Matt Spinlera9406a72017-04-27 14:29:24 -0500224
Matt Spinlerabf8da32017-04-27 14:08:45 -0500225}
226}
227}