1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
|
#pragma once
#include <chrono>
#include <sdbusplus/bus.hpp>
#include <sdbusplus/server.hpp>
#include "timer.hpp"
namespace phosphor
{
namespace fan
{
namespace monitor
{
class Fan;
/**
* @class TachSensor
*
* This class represents the sensor that reads a tach value.
* It may also support a Target, which is the property used to
* set a speed. Since it doesn't necessarily have a Target, it
* won't for sure know if it is running too slow, so it leaves
* that determination to other code.
*
* This class has a parent Fan object that knows about all
* sensors for that fan.
*/
class TachSensor
{
public:
TachSensor() = delete;
TachSensor(const TachSensor&) = delete;
TachSensor(TachSensor&&) = default;
TachSensor& operator=(const TachSensor&) = delete;
TachSensor& operator=(TachSensor&&) = default;
~TachSensor() = default;
/**
* @brief Constructor
*
* @param[in] bus - the dbus object
* @param[in] fan - the parent fan object
* @param[in] id - the id of the sensor
* @param[in] hasTarget - if the sensor supports
* setting the speed
* @param[in] timeout - Normal timeout value to use
* @param[in] events - sd_event pointer
*/
TachSensor(sdbusplus::bus::bus& bus,
Fan& fan,
const std::string& id,
bool hasTarget,
size_t timeout,
std::shared_ptr<sd_event>& events);
/**
* @brief Returns the target speed value
*/
inline uint64_t getTarget() const
{
return _tachTarget;
}
/**
* @brief Returns the input speed value
*/
inline int64_t getInput() const
{
return _tachInput;
}
/**
* @brief Returns true if sensor has a target
*/
inline bool hasTarget() const
{
return _hasTarget;
}
/**
* Returns true if the hardware behind this
* sensor is considered working OK/functional.
*/
inline bool functional() const
{
return _functional;
}
/**
* Sets functional status
*/
inline void setFunctional(bool functional)
{
_functional = functional;
}
/**
* Returns the timer object for this sensor
*/
inline phosphor::fan::util::Timer& getTimer()
{
return _timer;
}
/**
* @brief Returns the timeout value to use for the sensor
*/
std::chrono::microseconds getTimeout();
private:
/**
* @brief Returns the service name for reading the sensor
*/
std::string getService();
/**
* @brief Returns the match string to use for matching
* on a properties changed signal.
*/
std::string getMatchString(const std::string& interface);
/**
* @brief Callback function for a tach input properties
* changed signal
*
* @param[in] msg - the dbus message
* @param[in] data - user data
* @param[in] err - dbus error
*/
static int handleTachChangeSignal(sd_bus_message* msg,
void* data,
sd_bus_error* err);
/**
* @brief Callback function for a Target properties
* changed signal
*
* @param[in] msg - the dbus message
* @param[in] data - user data
* @param[in] err - dbus error
*/
static int handleTargetChangeSignal(sd_bus_message* msg,
void* data,
sd_bus_error* err);
/**
* @brief Reads the Target property and stores in _tachTarget.
* Also calls Fan::tachChanged().
*
* @param[in] msg - the dbus message
* @param[in] err - dbus error
*/
void handleTargetChange(sdbusplus::message::message& msg,
sd_bus_error* err);
/**
* @brief Reads the Value property and stores in _tachInput.
* Also calls Fan::tachChanged().
*
* @param[in] msg - the dbus message
* @param[in] err - dbus error
*/
void handleTachChange(sdbusplus::message::message& msg,
sd_bus_error* err);
/**
* @brief the dbus object
*/
sdbusplus::bus::bus& _bus;
/**
* @brief Reference to the parent Fan object
*/
Fan& _fan;
/**
* @brief The name of the sensor, including the full path
*
* For example /xyz/openbmc_project/sensors/fan_tach/fan0
*/
const std::string _name;
/**
* @brief If functional (not too slow). The parent
* fan object sets this.
*/
bool _functional = true;
/**
* @brief If the sensor has a Target property (can set speed)
*/
const bool _hasTarget;
/**
* @brief The input speed, from the Value dbus property
*/
int64_t _tachInput = 0;
/**
* @brief The current target speed, from the Target dbus property
* (if applicable)
*/
uint64_t _tachTarget = 0;
/**
* @brief The timeout value to use
*/
const size_t _timeout;
/**
* The timer object
*/
phosphor::fan::util::Timer _timer;
/**
* @brief The match object for the Value properties changed signal
*/
std::unique_ptr<sdbusplus::server::match::match> tachSignal;
/**
* @brief The match object for the Target properties changed signal
*/
std::unique_ptr<sdbusplus::server::match::match> targetSignal;
};
}
}
}
|
