hwmonio.hpp (505523772e7b1ba789d6522397f9932629b96e83) hwmonio.hpp (043d32306e00484afc446a44789b61869ea14f84)
1#pragma once
2
3#include <chrono>
4#include <string>
5
1#pragma once
2
3#include <chrono>
4#include <string>
5
6namespace hwmonio {
6namespace hwmonio
7{
7
8static constexpr auto retries = 10;
9static constexpr auto delay = std::chrono::milliseconds{100};
10
11/** @class HwmonIOInterface
12 * @brief Abstract base class defining a HwmonIOInterface.
13 *
14 * This is initially to provide easier testing through injection,
15 * however, could in theory support non-sysfs handling of hwmon IO.
16 */
17class HwmonIOInterface
18{
8
9static constexpr auto retries = 10;
10static constexpr auto delay = std::chrono::milliseconds{100};
11
12/** @class HwmonIOInterface
13 * @brief Abstract base class defining a HwmonIOInterface.
14 *
15 * This is initially to provide easier testing through injection,
16 * however, could in theory support non-sysfs handling of hwmon IO.
17 */
18class HwmonIOInterface
19{
19 public:
20 virtual ~HwmonIOInterface() = default;
20 public:
21 virtual ~HwmonIOInterface() = default;
21
22
22 virtual int64_t read(
23 const std::string& type,
24 const std::string& id,
25 const std::string& sensor,
26 size_t retries,
27 std::chrono::milliseconds delay) const = 0;
23 virtual int64_t read(const std::string& type, const std::string& id,
24 const std::string& sensor, size_t retries,
25 std::chrono::milliseconds delay) const = 0;
28
26
29 virtual void write(
30 uint32_t val,
31 const std::string& type,
32 const std::string& id,
33 const std::string& sensor,
34 size_t retries,
35 std::chrono::milliseconds delay) const = 0;
27 virtual void write(uint32_t val, const std::string& type,
28 const std::string& id, const std::string& sensor,
29 size_t retries,
30 std::chrono::milliseconds delay) const = 0;
36
31
37 virtual std::string path() const = 0;
32 virtual std::string path() const = 0;
38};
39
40/** @class HwmonIO
41 * @brief Convenience wrappers for HWMON sysfs attribute IO.
42 *
43 * Unburden the rest of the application from having to check
44 * ENOENT after every hwmon attribute io operation. Hwmon
45 * device drivers can be unbound at any time; the program
46 * cannot always be terminated externally before we try to
47 * do an io.
48 */
49class HwmonIO : public HwmonIOInterface
50{
33};
34
35/** @class HwmonIO
36 * @brief Convenience wrappers for HWMON sysfs attribute IO.
37 *
38 * Unburden the rest of the application from having to check
39 * ENOENT after every hwmon attribute io operation. Hwmon
40 * device drivers can be unbound at any time; the program
41 * cannot always be terminated externally before we try to
42 * do an io.
43 */
44class HwmonIO : public HwmonIOInterface
45{
51 public:
52 HwmonIO() = delete;
53 HwmonIO(const HwmonIO&) = default;
54 HwmonIO(HwmonIO&&) = default;
55 HwmonIO& operator=(const HwmonIO&) = default;
56 HwmonIO& operator=(HwmonIO&&) = default;
57 ~HwmonIO() = default;
46 public:
47 HwmonIO() = delete;
48 HwmonIO(const HwmonIO&) = default;
49 HwmonIO(HwmonIO&&) = default;
50 HwmonIO& operator=(const HwmonIO&) = default;
51 HwmonIO& operator=(HwmonIO&&) = default;
52 ~HwmonIO() = default;
58
53
59 /** @brief Constructor
60 *
61 * @param[in] path - hwmon instance root - eg:
62 * /sys/class/hwmon/hwmon<N>
63 */
64 explicit HwmonIO(const std::string& path);
54 /** @brief Constructor
55 *
56 * @param[in] path - hwmon instance root - eg:
57 * /sys/class/hwmon/hwmon<N>
58 */
59 explicit HwmonIO(const std::string& path);
65
60
66 /** @brief Perform formatted hwmon sysfs read.
67 *
68 * Propagates any exceptions other than ENOENT.
69 * ENOENT will result in a call to exit(0) in case
70 * the underlying hwmon driver is unbound and
71 * the program is inadvertently left running.
72 *
73 * For possibly transient errors will retry up to
74 * the specified number of times.
75 *
76 * @param[in] type - The hwmon type (ex. temp).
77 * @param[in] id - The hwmon id (ex. 1).
78 * @param[in] sensor - The hwmon sensor (ex. input).
79 * @param[in] retries - The number of times to retry.
80 * @param[in] delay - The time to sleep between retry attempts.
81 *
82 * @return val - The read value.
83 */
84 int64_t read(
85 const std::string& type,
86 const std::string& id,
87 const std::string& sensor,
88 size_t retries,
89 std::chrono::milliseconds delay) const override;
61 /** @brief Perform formatted hwmon sysfs read.
62 *
63 * Propagates any exceptions other than ENOENT.
64 * ENOENT will result in a call to exit(0) in case
65 * the underlying hwmon driver is unbound and
66 * the program is inadvertently left running.
67 *
68 * For possibly transient errors will retry up to
69 * the specified number of times.
70 *
71 * @param[in] type - The hwmon type (ex. temp).
72 * @param[in] id - The hwmon id (ex. 1).
73 * @param[in] sensor - The hwmon sensor (ex. input).
74 * @param[in] retries - The number of times to retry.
75 * @param[in] delay - The time to sleep between retry attempts.
76 *
77 * @return val - The read value.
78 */
79 int64_t read(const std::string& type, const std::string& id,
80 const std::string& sensor, size_t retries,
81 std::chrono::milliseconds delay) const override;
90
82
91 /** @brief Perform formatted hwmon sysfs write.
92 *
93 * Propagates any exceptions other than ENOENT.
94 * ENOENT will result in a call to exit(0) in case
95 * the underlying hwmon driver is unbound and
96 * the program is inadvertently left running.
97 *
98 * For possibly transient errors will retry up to
99 * the specified number of times.
100 *
101 * @param[in] val - The value to be written.
102 * @param[in] type - The hwmon type (ex. fan).
103 * @param[in] id - The hwmon id (ex. 1).
104 * @param[in] retries - The number of times to retry.
105 * @param[in] delay - The time to sleep between retry attempts.
106 */
107 void write(
108 uint32_t val,
109 const std::string& type,
110 const std::string& id,
111 const std::string& sensor,
112 size_t retries,
113 std::chrono::milliseconds delay) const override;
83 /** @brief Perform formatted hwmon sysfs write.
84 *
85 * Propagates any exceptions other than ENOENT.
86 * ENOENT will result in a call to exit(0) in case
87 * the underlying hwmon driver is unbound and
88 * the program is inadvertently left running.
89 *
90 * For possibly transient errors will retry up to
91 * the specified number of times.
92 *
93 * @param[in] val - The value to be written.
94 * @param[in] type - The hwmon type (ex. fan).
95 * @param[in] id - The hwmon id (ex. 1).
96 * @param[in] retries - The number of times to retry.
97 * @param[in] delay - The time to sleep between retry attempts.
98 */
99 void write(uint32_t val, const std::string& type, const std::string& id,
100 const std::string& sensor, size_t retries,
101 std::chrono::milliseconds delay) const override;
114
102
103 /** @brief Hwmon instance path access.
104 *
105 * @return path - The hwmon instance path.
106 */
107 std::string path() const override;
115
108
116 /** @brief Hwmon instance path access.
117 *
118 * @return path - The hwmon instance path.
119 */
120 std::string path() const override;
121
122 private:
123 std::string p;
109 private:
110 std::string p;
124};
125} // namespace hwmonio
126
127// vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4
111};
112} // namespace hwmonio
113
114// vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4