blob: 89c311890c32d7a2b59a453410810c1f169ae8fd [file] [log] [blame]
Matt Spinler015e3ad2017-08-01 11:20:47 -05001#pragma once
2
Brandon Wyman9c7897c2019-03-28 17:42:34 -05003#include <filesystem>
Matt Spinler015e3ad2017-08-01 11:20:47 -05004#include <string>
5#include <vector>
6
Lei YUab093322019-10-09 16:43:22 +08007namespace phosphor
Matt Spinler015e3ad2017-08-01 11:20:47 -05008{
9namespace pmbus
10{
11
Brandon Wyman9c7897c2019-03-28 17:42:34 -050012namespace fs = std::filesystem;
Brandon Wymanff5f3392017-08-11 17:43:22 -050013
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
Matt Spinlerde16d052017-12-13 13:22:14 -060026namespace status_vout
27{
28// Mask of bits that are only warnings
29constexpr auto WARNING_MASK = 0x6A;
Matt Spinlerf0f02b92018-10-25 16:12:43 -050030} // namespace status_vout
Matt Spinlerde16d052017-12-13 13:22:14 -060031
Brandon Wyman764c7972017-08-22 17:05:36 -050032// Current output status bits.
33constexpr auto STATUS_IOUT = "status0_iout";
34
35// Manufacturing specific status bits
36constexpr auto STATUS_MFR = "status0_mfr";
37
Brandon Wyman12661f12017-08-31 15:28:21 -050038// Reports on the status of any fans installed in position 1 and 2.
39constexpr auto STATUS_FANS_1_2 = "status0_fans12";
40
41// Reports on temperature faults or warnings. Overtemperature fault,
42// overtemperature warning, undertemperature warning, undertemperature fault.
43constexpr auto STATUS_TEMPERATURE = "status0_temp";
44
Matt Spinlere7e432b2017-08-21 15:01:40 -050045namespace status_word
46{
47constexpr auto VOUT_FAULT = 0x8000;
Brandon Wyman764c7972017-08-22 17:05:36 -050048
49// The IBM CFF power supply driver does map this bit to power1_alarm in the
50// hwmon space, but since the other bits that need to be checked do not have
51// a similar mapping, the code will just read STATUS_WORD and use bit masking
52// to see if the INPUT FAULT OR WARNING bit is on.
53constexpr auto INPUT_FAULT_WARN = 0x2000;
54
55// The bit mask representing the POWER_GOOD Negated bit of the STATUS_WORD.
56constexpr auto POWER_GOOD_NEGATED = 0x0800;
57
Brandon Wyman12661f12017-08-31 15:28:21 -050058// The bit mask representing the FAN FAULT or WARNING bit of the STATUS_WORD.
59// Bit 2 of the high byte of STATUS_WORD.
60constexpr auto FAN_FAULT = 0x0400;
61
Brandon Wyman764c7972017-08-22 17:05:36 -050062// The bit mask representing the UNITI_IS_OFF bit of the STATUS_WORD.
63constexpr auto UNIT_IS_OFF = 0x0040;
64
Brandon Wymanab05c072017-08-30 18:26:41 -050065// Bit 5 of the STATUS_BYTE, or lower byte of STATUS_WORD is used to indicate
66// an output overvoltage fault.
67constexpr auto VOUT_OV_FAULT = 0x0020;
68
Brandon Wymanb165c252017-08-25 18:59:54 -050069// The bit mask representing that an output overcurrent fault has occurred.
70constexpr auto IOUT_OC_FAULT = 0x0010;
71
Brandon Wyman764c7972017-08-22 17:05:36 -050072// The IBM CFF power supply driver does map this bit to in1_alarm, however,
73// since a number of the other bits are not mapped that way for STATUS_WORD,
74// this code will just read the entire STATUS_WORD and use bit masking to find
75// out if that fault is on.
76constexpr auto VIN_UV_FAULT = 0x0008;
77
Brandon Wyman875b3632017-09-13 18:46:03 -050078// The bit mask representing the TEMPERATURE FAULT or WARNING bit of the
79// STATUS_WORD. Bit 2 of the low byte (STATUS_BYTE).
80constexpr auto TEMPERATURE_FAULT_WARN = 0x0004;
81
Matt Spinlerf0f02b92018-10-25 16:12:43 -050082} // namespace status_word
Brandon Wyman875b3632017-09-13 18:46:03 -050083
Lei YUe8c9cd62019-11-04 14:24:41 +080084namespace status_vout
85{
86// The IBM CFF power supply driver maps MFR's OV_FAULT and VAUX_FAULT to this
87// bit.
88constexpr auto OV_FAULT = 0x80;
89
90// The IBM CFF power supply driver maps MFR's UV_FAULT to this bit.
91constexpr auto UV_FAULT = 0x10;
92} // namespace status_vout
93
Brandon Wyman875b3632017-09-13 18:46:03 -050094namespace status_temperature
95{
96// Overtemperature Fault
97constexpr auto OT_FAULT = 0x80;
Matt Spinlerf0f02b92018-10-25 16:12:43 -050098} // namespace status_temperature
Matt Spinlere7e432b2017-08-21 15:01:40 -050099
Matt Spinler015e3ad2017-08-01 11:20:47 -0500100/**
Matt Spinler4dc46782018-01-04 14:29:16 -0600101 * Where the access should be done
Matt Spinler57868bc2017-08-03 10:07:41 -0500102 */
103enum class Type
104{
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500105 Base, // base device directory
106 Hwmon, // hwmon directory
107 Debug, // pmbus debug directory
108 DeviceDebug, // device debug directory
109 HwmonDeviceDebug // hwmon device debug directory
Matt Spinler57868bc2017-08-03 10:07:41 -0500110};
111
112/**
Brandon Wyman8d195772020-01-27 15:03:51 -0600113 * @class PMBusBase
114 *
115 * This is a base class for PMBus to assist with unit testing via mocking.
116 */
117class PMBusBase
118{
119 public:
120 virtual ~PMBusBase() = default;
121};
122
123/**
124 * Wrapper function for PMBus
125 *
126 * @param[in] bus - I2C bus
127 * @param[in] address - I2C address (as a 2-byte string, e.g. 0069)
128 *
129 * @return PMBusBase pointer
130 */
131std::unique_ptr<PMBusBase> createPMBus(std::uint8_t bus,
132 const std::string& address);
133
134/**
Matt Spinler015e3ad2017-08-01 11:20:47 -0500135 * @class PMBus
136 *
137 * This class is an interface to communicating with PMBus devices
138 * by reading and writing sysfs files.
Matt Spinler57868bc2017-08-03 10:07:41 -0500139 *
140 * Based on the Type parameter, the accesses can either be done
141 * in the base device directory (the one passed into the constructor),
142 * or in the hwmon directory for the device.
Matt Spinler015e3ad2017-08-01 11:20:47 -0500143 */
Brandon Wyman8d195772020-01-27 15:03:51 -0600144class PMBus : public PMBusBase
Matt Spinler015e3ad2017-08-01 11:20:47 -0500145{
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500146 public:
147 PMBus() = delete;
Brandon Wyman8d195772020-01-27 15:03:51 -0600148 virtual ~PMBus() = default;
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500149 PMBus(const PMBus&) = default;
150 PMBus& operator=(const PMBus&) = default;
151 PMBus(PMBus&&) = default;
152 PMBus& operator=(PMBus&&) = default;
Matt Spinler015e3ad2017-08-01 11:20:47 -0500153
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500154 /**
155 * Constructor
156 *
157 * @param[in] path - path to the sysfs directory
158 */
159 PMBus(const std::string& path) : basePath(path)
160 {
161 findHwmonDir();
162 }
Matt Spinler015e3ad2017-08-01 11:20:47 -0500163
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500164 /**
165 * Constructor
166 *
167 * This version is required when DeviceDebug
168 * access will be used.
169 *
170 * @param[in] path - path to the sysfs directory
171 * @param[in] driverName - the device driver name
172 * @param[in] instance - chip instance number
173 */
174 PMBus(const std::string& path, const std::string& driverName,
175 size_t instance) :
176 basePath(path),
177 driverName(driverName), instance(instance)
178 {
179 findHwmonDir();
180 }
Matt Spinler015e3ad2017-08-01 11:20:47 -0500181
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500182 /**
Brandon Wyman8d195772020-01-27 15:03:51 -0600183 * Wrapper function for PMBus
184 *
185 * @param[in] bus - I2C bus
186 * @param[in] address - I2C address (as a 2-byte string, e.g. 0069)
187 *
188 * @return PMBusBase pointer
189 */
190 static std::unique_ptr<PMBusBase> createPMBus(std::uint8_t bus,
191 const std::string& address);
192
193 /**
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500194 * Reads a file in sysfs that represents a single bit,
195 * therefore doing a PMBus read.
196 *
197 * @param[in] name - path concatenated to
198 * basePath to read
199 * @param[in] type - Path type
200 *
201 * @return bool - false if result was 0, else true
202 */
203 bool readBit(const std::string& name, Type type);
Matt Spinler8f0d9532017-08-21 11:22:37 -0500204
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500205 /**
206 * Reads a file in sysfs that represents a single bit,
207 * where the page number passed in is substituted
208 * into the name in place of the 'P' character in it.
209 *
210 * @param[in] name - path concatenated to
211 * basePath to read
212 * @param[in] page - page number
213 * @param[in] type - Path type
214 *
215 * @return bool - false if result was 0, else true
216 */
217 bool readBitInPage(const std::string& name, size_t page, Type type);
218 /**
219 * Checks if the file for the given name and type exists.
220 *
221 * @param[in] name - path concatenated to basePath to read
222 * @param[in] type - Path type
223 *
224 * @return bool - True if file exists, false if it does not.
225 */
226 bool exists(const std::string& name, Type type);
Matt Spinler015e3ad2017-08-01 11:20:47 -0500227
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500228 /**
229 * Read byte(s) from file in sysfs.
230 *
231 * @param[in] name - path concatenated to basePath to read
232 * @param[in] type - Path type
233 *
234 * @return uint64_t - Up to 8 bytes of data read from file.
235 */
236 uint64_t read(const std::string& name, Type type);
Brandon Wyman3b7b38b2017-09-25 16:43:45 -0500237
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500238 /**
239 * Read a string from file in sysfs.
240 *
241 * @param[in] name - path concatenated to basePath to read
242 * @param[in] type - Path type
243 *
244 * @return string - The data read from the file.
245 */
246 std::string readString(const std::string& name, Type type);
Matt Spinler015e3ad2017-08-01 11:20:47 -0500247
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500248 /**
249 * Read data from a binary file in sysfs.
250 *
251 * @param[in] name - path concatenated to basePath to read
252 * @param[in] type - Path type
253 * @param[in] length - length of data to read, in bytes
254 *
255 * @return vector<uint8_t> - The data read from the file.
256 */
257 std::vector<uint8_t> readBinary(const std::string& name, Type type,
258 size_t length);
Matt Spinlerfbae7b62018-01-04 14:33:13 -0600259
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500260 /**
261 * Writes an integer value to the file, therefore doing
262 * a PMBus write.
263 *
264 * @param[in] name - path concatenated to
265 * basePath to write
266 * @param[in] value - the value to write
267 * @param[in] type - Path type
268 */
269 void write(const std::string& name, int value, Type type);
Matt Spinlerfa23e332018-01-18 11:24:58 -0600270
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500271 /**
272 * Returns the sysfs base path of this device
273 */
274 inline const auto& path() const
275 {
276 return basePath;
277 }
Matt Spinler015e3ad2017-08-01 11:20:47 -0500278
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500279 /**
280 * Replaces the 'P' in the string passed in with
281 * the page number passed in.
282 *
283 * For example:
284 * insertPageNum("inP_enable", 42)
285 * returns "in42_enable"
286 *
287 * @param[in] templateName - the name string, with a 'P' in it
288 * @param[in] page - the page number to insert where the P was
289 *
290 * @return string - the new string with the page number in it
291 */
292 static std::string insertPageNum(const std::string& templateName,
293 size_t page);
Matt Spinler015e3ad2017-08-01 11:20:47 -0500294
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500295 /**
296 * Finds the path relative to basePath to the hwmon directory
297 * for the device and stores it in hwmonRelPath.
298 */
299 void findHwmonDir();
Matt Spinler015e3ad2017-08-01 11:20:47 -0500300
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500301 /**
302 * Returns the path to use for the passed in type.
303 *
304 * @param[in] type - Path type
305 *
306 * @return fs::path - the full path
307 */
308 fs::path getPath(Type type);
Brandon Wymanff5f3392017-08-11 17:43:22 -0500309
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500310 private:
311 /**
312 * Returns the device name
313 *
314 * This is found in the 'name' file in basePath.
315 *
316 * @return string - the device name
317 */
318 std::string getDeviceName();
Matt Spinler57868bc2017-08-03 10:07:41 -0500319
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500320 /**
321 * The sysfs device path
322 */
323 fs::path basePath;
Matt Spinler015e3ad2017-08-01 11:20:47 -0500324
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500325 /**
326 * The directory name under the basePath hwmon directory
327 */
328 fs::path hwmonDir;
Matt Spinlerba053482018-01-04 14:26:05 -0600329
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500330 /**
331 * The device driver name. Used for finding the device
332 * debug directory. Not required if that directory
333 * isn't used.
334 */
335 std::string driverName;
Matt Spinler015e3ad2017-08-01 11:20:47 -0500336
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500337 /**
338 * The device instance number.
339 *
340 * Used in conjunction with the driver name for finding
341 * the debug directory. Not required if that directory
342 * isn't used.
343 */
344 size_t instance = 0;
Brandon Wymanff5f3392017-08-11 17:43:22 -0500345
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500346 /**
347 * The pmbus debug path with status files
348 */
349 const fs::path debugPath = "/sys/kernel/debug/";
Matt Spinler015e3ad2017-08-01 11:20:47 -0500350};
351
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500352} // namespace pmbus
Lei YUab093322019-10-09 16:43:22 +0800353} // namespace phosphor