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
|
#pragma once
#include <chrono>
#include <string>
namespace hwmonio
{
static constexpr auto retries = 10;
static constexpr auto delay = std::chrono::milliseconds{100};
/** @class HwmonIOInterface
* @brief Abstract base class defining a HwmonIOInterface.
*
* This is initially to provide easier testing through injection,
* however, could in theory support non-sysfs handling of hwmon IO.
*/
class HwmonIOInterface
{
public:
virtual ~HwmonIOInterface() = default;
virtual int64_t read(const std::string& type, const std::string& id,
const std::string& sensor, size_t retries,
std::chrono::milliseconds delay) const = 0;
virtual void write(uint32_t val, const std::string& type,
const std::string& id, const std::string& sensor,
size_t retries,
std::chrono::milliseconds delay) const = 0;
virtual std::string path() const = 0;
};
/** @class HwmonIO
* @brief Convenience wrappers for HWMON sysfs attribute IO.
*
* Unburden the rest of the application from having to check
* ENOENT after every hwmon attribute io operation. Hwmon
* device drivers can be unbound at any time; the program
* cannot always be terminated externally before we try to
* do an io.
*/
class HwmonIO : public HwmonIOInterface
{
public:
HwmonIO() = delete;
HwmonIO(const HwmonIO&) = default;
HwmonIO(HwmonIO&&) = default;
HwmonIO& operator=(const HwmonIO&) = default;
HwmonIO& operator=(HwmonIO&&) = default;
~HwmonIO() = default;
/** @brief Constructor
*
* @param[in] path - hwmon instance root - eg:
* /sys/class/hwmon/hwmon<N>
*/
explicit HwmonIO(const std::string& path);
/** @brief Perform formatted hwmon sysfs read.
*
* Propagates any exceptions other than ENOENT.
* ENOENT will result in a call to exit(0) in case
* the underlying hwmon driver is unbound and
* the program is inadvertently left running.
*
* For possibly transient errors will retry up to
* the specified number of times.
*
* @param[in] type - The hwmon type (ex. temp).
* @param[in] id - The hwmon id (ex. 1).
* @param[in] sensor - The hwmon sensor (ex. input).
* @param[in] retries - The number of times to retry.
* @param[in] delay - The time to sleep between retry attempts.
*
* @return val - The read value.
*/
int64_t read(const std::string& type, const std::string& id,
const std::string& sensor, size_t retries,
std::chrono::milliseconds delay) const override;
/** @brief Perform formatted hwmon sysfs write.
*
* Propagates any exceptions other than ENOENT.
* ENOENT will result in a call to exit(0) in case
* the underlying hwmon driver is unbound and
* the program is inadvertently left running.
*
* For possibly transient errors will retry up to
* the specified number of times.
*
* @param[in] val - The value to be written.
* @param[in] type - The hwmon type (ex. fan).
* @param[in] id - The hwmon id (ex. 1).
* @param[in] retries - The number of times to retry.
* @param[in] delay - The time to sleep between retry attempts.
*/
void write(uint32_t val, const std::string& type, const std::string& id,
const std::string& sensor, size_t retries,
std::chrono::milliseconds delay) const override;
/** @brief Hwmon instance path access.
*
* @return path - The hwmon instance path.
*/
std::string path() const override;
private:
std::string _p;
};
} // namespace hwmonio
// vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4
|
