blob: fc9a1cb9b24f114c820df5cbefc894a257427089 [file] [log] [blame]
Matt Spinler015e3ad2017-08-01 11:20:47 -05001#pragma once
2
3#include <experimental/filesystem>
4#include <string>
5#include <vector>
6
7namespace witherspoon
8{
9namespace pmbus
10{
11
Brandon Wymanff5f3392017-08-11 17:43:22 -050012namespace fs = std::experimental::filesystem;
13
Brandon Wyman10295542017-08-09 18:20:44 -050014// The file name Linux uses to capture the STATUS_WORD from pmbus.
Matt Spinlere7e432b2017-08-21 15:01:40 -050015constexpr auto STATUS_WORD = "status0";
Brandon Wyman10295542017-08-09 18:20:44 -050016
Brandon Wyman253dc9b2017-08-12 13:45:52 -050017// The file name Linux uses to capture the STATUS_INPUT from pmbus.
18constexpr auto STATUS_INPUT = "status0_input";
Matt Spinlere7e432b2017-08-21 15:01:40 -050019
Brandon Wyman764c7972017-08-22 17:05:36 -050020// Voltage out status.
21// Overvoltage fault or warning, Undervoltage fault or warning, maximum or
22// minimum warning, ....
Matt Spinlere7e432b2017-08-21 15:01:40 -050023// Uses Page substitution
24constexpr auto STATUS_VOUT = "statusP_vout";
25
Brandon Wyman764c7972017-08-22 17:05:36 -050026// Current output status bits.
27constexpr auto STATUS_IOUT = "status0_iout";
28
29// Manufacturing specific status bits
30constexpr auto STATUS_MFR = "status0_mfr";
31
Brandon Wyman12661f12017-08-31 15:28:21 -050032// Reports on the status of any fans installed in position 1 and 2.
33constexpr auto STATUS_FANS_1_2 = "status0_fans12";
34
35// Reports on temperature faults or warnings. Overtemperature fault,
36// overtemperature warning, undertemperature warning, undertemperature fault.
37constexpr auto STATUS_TEMPERATURE = "status0_temp";
38
Matt Spinlere7e432b2017-08-21 15:01:40 -050039namespace status_word
40{
41constexpr auto VOUT_FAULT = 0x8000;
Brandon Wyman764c7972017-08-22 17:05:36 -050042
43// The IBM CFF power supply driver does map this bit to power1_alarm in the
44// hwmon space, but since the other bits that need to be checked do not have
45// a similar mapping, the code will just read STATUS_WORD and use bit masking
46// to see if the INPUT FAULT OR WARNING bit is on.
47constexpr auto INPUT_FAULT_WARN = 0x2000;
48
49// The bit mask representing the POWER_GOOD Negated bit of the STATUS_WORD.
50constexpr auto POWER_GOOD_NEGATED = 0x0800;
51
Brandon Wyman12661f12017-08-31 15:28:21 -050052// The bit mask representing the FAN FAULT or WARNING bit of the STATUS_WORD.
53// Bit 2 of the high byte of STATUS_WORD.
54constexpr auto FAN_FAULT = 0x0400;
55
Brandon Wyman764c7972017-08-22 17:05:36 -050056// The bit mask representing the UNITI_IS_OFF bit of the STATUS_WORD.
57constexpr auto UNIT_IS_OFF = 0x0040;
58
Brandon Wymanab05c072017-08-30 18:26:41 -050059// Bit 5 of the STATUS_BYTE, or lower byte of STATUS_WORD is used to indicate
60// an output overvoltage fault.
61constexpr auto VOUT_OV_FAULT = 0x0020;
62
Brandon Wymanb165c252017-08-25 18:59:54 -050063// The bit mask representing that an output overcurrent fault has occurred.
64constexpr auto IOUT_OC_FAULT = 0x0010;
65
Brandon Wyman764c7972017-08-22 17:05:36 -050066// The IBM CFF power supply driver does map this bit to in1_alarm, however,
67// since a number of the other bits are not mapped that way for STATUS_WORD,
68// this code will just read the entire STATUS_WORD and use bit masking to find
69// out if that fault is on.
70constexpr auto VIN_UV_FAULT = 0x0008;
71
Brandon Wyman875b3632017-09-13 18:46:03 -050072// The bit mask representing the TEMPERATURE FAULT or WARNING bit of the
73// STATUS_WORD. Bit 2 of the low byte (STATUS_BYTE).
74constexpr auto TEMPERATURE_FAULT_WARN = 0x0004;
75
76}
77
78namespace status_temperature
79{
80// Overtemperature Fault
81constexpr auto OT_FAULT = 0x80;
Matt Spinlere7e432b2017-08-21 15:01:40 -050082}
83
Matt Spinler015e3ad2017-08-01 11:20:47 -050084/**
Matt Spinler57868bc2017-08-03 10:07:41 -050085 * If the access should be done in the base
Matt Spinler8f0d9532017-08-21 11:22:37 -050086 * device directory, the hwmon directory, the
87 * pmbus debug directory, or the device debug
88 * directory.
Matt Spinler57868bc2017-08-03 10:07:41 -050089 */
90enum class Type
91{
92 Base,
Brandon Wymanff5f3392017-08-11 17:43:22 -050093 Hwmon,
Matt Spinler8f0d9532017-08-21 11:22:37 -050094 Debug,
95 DeviceDebug
Matt Spinler57868bc2017-08-03 10:07:41 -050096};
97
98/**
Matt Spinler015e3ad2017-08-01 11:20:47 -050099 * @class PMBus
100 *
101 * This class is an interface to communicating with PMBus devices
102 * by reading and writing sysfs files.
Matt Spinler57868bc2017-08-03 10:07:41 -0500103 *
104 * Based on the Type parameter, the accesses can either be done
105 * in the base device directory (the one passed into the constructor),
106 * or in the hwmon directory for the device.
Matt Spinler015e3ad2017-08-01 11:20:47 -0500107 */
108class PMBus
109{
110 public:
111
112 PMBus() = delete;
113 ~PMBus() = default;
114 PMBus(const PMBus&) = default;
115 PMBus& operator=(const PMBus&) = default;
116 PMBus(PMBus&&) = default;
117 PMBus& operator=(PMBus&&) = default;
118
119 /**
120 * Constructor
121 *
122 * @param[in] path - path to the sysfs directory
123 */
124 PMBus(const std::string& path) :
125 basePath(path)
126 {
Brandon Wymanff5f3392017-08-11 17:43:22 -0500127 findHwmonDir();
Matt Spinler015e3ad2017-08-01 11:20:47 -0500128 }
129
130 /**
Matt Spinler8f0d9532017-08-21 11:22:37 -0500131 * Constructor
132 *
133 * This version is required when DeviceDebug
134 * access will be used.
135 *
136 * @param[in] path - path to the sysfs directory
137 * @param[in] driverName - the device driver name
138 * @param[in] instance - chip instance number
139 */
140 PMBus(const std::string& path,
141 const std::string& driverName,
142 size_t instance) :
143 basePath(path),
144 driverName(driverName),
145 instance(instance)
146 {
147 findHwmonDir();
148 }
149
150 /**
Matt Spinler015e3ad2017-08-01 11:20:47 -0500151 * Reads a file in sysfs that represents a single bit,
152 * therefore doing a PMBus read.
153 *
154 * @param[in] name - path concatenated to
155 * basePath to read
Matt Spinler8f0d9532017-08-21 11:22:37 -0500156 * @param[in] type - Path type
Matt Spinler015e3ad2017-08-01 11:20:47 -0500157 *
158 * @return bool - false if result was 0, else true
159 */
Matt Spinler57868bc2017-08-03 10:07:41 -0500160 bool readBit(const std::string& name, Type type);
Matt Spinler015e3ad2017-08-01 11:20:47 -0500161
162 /**
163 * Reads a file in sysfs that represents a single bit,
164 * where the page number passed in is substituted
165 * into the name in place of the 'P' character in it.
166 *
167 * @param[in] name - path concatenated to
168 * basePath to read
169 * @param[in] page - page number
Matt Spinler8f0d9532017-08-21 11:22:37 -0500170 * @param[in] type - Path type
Matt Spinler015e3ad2017-08-01 11:20:47 -0500171 *
172 * @return bool - false if result was 0, else true
173 */
174 bool readBitInPage(const std::string& name,
Matt Spinler57868bc2017-08-03 10:07:41 -0500175 size_t page,
176 Type type);
Brandon Wymanf855e822017-08-08 18:04:47 -0500177 /**
178 * Read byte(s) from file in sysfs.
179 *
180 * @param[in] name - path concatenated to basePath to read
Matt Spinler8f0d9532017-08-21 11:22:37 -0500181 * @param[in] type - Path type
Brandon Wymanf855e822017-08-08 18:04:47 -0500182 *
183 * @return uint64_t - Up to 8 bytes of data read from file.
184 */
185 uint64_t read(const std::string& name, Type type);
Matt Spinler015e3ad2017-08-01 11:20:47 -0500186
187 /**
188 * Writes an integer value to the file, therefore doing
189 * a PMBus write.
190 *
191 * @param[in] name - path concatenated to
192 * basePath to write
193 * @param[in] value - the value to write
Matt Spinler8f0d9532017-08-21 11:22:37 -0500194 * @param[in] type - Path type
Matt Spinler015e3ad2017-08-01 11:20:47 -0500195 */
Matt Spinler57868bc2017-08-03 10:07:41 -0500196 void write(const std::string& name, int value, Type type);
Matt Spinler015e3ad2017-08-01 11:20:47 -0500197
198 /**
199 * Returns the sysfs base path of this device
200 */
201 inline const auto& path() const
202 {
203 return basePath;
204 }
205
206 /**
207 * Replaces the 'P' in the string passed in with
208 * the page number passed in.
209 *
210 * For example:
211 * insertPageNum("inP_enable", 42)
212 * returns "in42_enable"
213 *
214 * @param[in] templateName - the name string, with a 'P' in it
215 * @param[in] page - the page number to insert where the P was
216 *
217 * @return string - the new string with the page number in it
218 */
219 static std::string insertPageNum(const std::string& templateName,
220 size_t page);
221
Matt Spinler57868bc2017-08-03 10:07:41 -0500222 /**
223 * Finds the path relative to basePath to the hwmon directory
224 * for the device and stores it in hwmonRelPath.
225 */
Brandon Wyman764c7972017-08-22 17:05:36 -0500226 void findHwmonDir();
Brandon Wymanff5f3392017-08-11 17:43:22 -0500227
228 /**
229 * Returns the path to use for the passed in type.
230 *
Matt Spinler8f0d9532017-08-21 11:22:37 -0500231 * @param[in] type - Path type
Brandon Wymanff5f3392017-08-11 17:43:22 -0500232 *
Matt Spinler8f0d9532017-08-21 11:22:37 -0500233 * @return fs::path - the full path
Brandon Wymanff5f3392017-08-11 17:43:22 -0500234 */
Brandon Wyman764c7972017-08-22 17:05:36 -0500235 fs::path getPath(Type type);
Matt Spinler57868bc2017-08-03 10:07:41 -0500236
Matt Spinler015e3ad2017-08-01 11:20:47 -0500237 private:
238
239 /**
240 * The sysfs device path
241 */
Brandon Wymanff5f3392017-08-11 17:43:22 -0500242 fs::path basePath;
Matt Spinler015e3ad2017-08-01 11:20:47 -0500243
Matt Spinler57868bc2017-08-03 10:07:41 -0500244 /**
Brandon Wymanff5f3392017-08-11 17:43:22 -0500245 * The directory name under the basePath hwmon directory
Matt Spinler57868bc2017-08-03 10:07:41 -0500246 */
Brandon Wymanff5f3392017-08-11 17:43:22 -0500247 fs::path hwmonDir;
248
249 /**
Matt Spinler8f0d9532017-08-21 11:22:37 -0500250 * The device driver name. Used for finding the device
251 * debug directory. Not required if that directory
252 * isn't used.
253 */
254 std::string driverName;
255
256 /**
257 * The device instance number.
258 *
259 * Used in conjuction with the driver name for finding
260 * the debug directory. Not required if that directory
261 * isn't used.
262 */
263 size_t instance = 0;
264
265 /**
Brandon Wymanff5f3392017-08-11 17:43:22 -0500266 * The pmbus debug path with status files
267 */
Matt Spinler8f0d9532017-08-21 11:22:37 -0500268 const fs::path debugPath = "/sys/kernel/debug/";
Matt Spinler57868bc2017-08-03 10:07:41 -0500269
Matt Spinler015e3ad2017-08-01 11:20:47 -0500270};
271
272}
273}