blob: c798f510d948f9e3f84233e2e43d00fc366592ec [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
Adriana Kobylak4175ffb2021-08-02 14:51:05 +000014// The file name Linux uses to capture the READ_VIN from pmbus.
15constexpr auto READ_VIN = "in1_input";
16
Brandon Wymanae35ac52022-05-23 22:33:40 +000017// The file name Linux uses to capture the MFR_POUT_MAX from pmbus.
18constexpr auto MFR_POUT_MAX = "max_power_out";
19// The max_power_out value expected to be read for 1400W IBM CFFPS type.
20constexpr auto IBM_CFFPS_1400W = 30725;
21
Adriana Kobylak4175ffb2021-08-02 14:51:05 +000022namespace in_input
23{
24// VIN thresholds in Volts
25constexpr auto VIN_VOLTAGE_MIN = 20;
26constexpr auto VIN_VOLTAGE_110_THRESHOLD = 160;
27
28// VIN actual values in Volts
29// VIN_VOLTAGE_0: VIN < VIN_VOLTAGE_MIN
30// VIN_VOLTAGE_110: VIN_VOLTAGE_MIN < VIN < VIN_VOLTAGE_110_THRESHOLD
31// VIN_VOLTAGE_220: VIN_VOLTAGE_110_THRESHOLD < VIN
32constexpr auto VIN_VOLTAGE_0 = 0;
33constexpr auto VIN_VOLTAGE_110 = 110;
34constexpr auto VIN_VOLTAGE_220 = 220;
35} // namespace in_input
36
Brandon Wyman10295542017-08-09 18:20:44 -050037// The file name Linux uses to capture the STATUS_WORD from pmbus.
Matt Spinlere7e432b2017-08-21 15:01:40 -050038constexpr auto STATUS_WORD = "status0";
Brandon Wyman10295542017-08-09 18:20:44 -050039
Brandon Wyman253dc9b2017-08-12 13:45:52 -050040// The file name Linux uses to capture the STATUS_INPUT from pmbus.
41constexpr auto STATUS_INPUT = "status0_input";
Matt Spinlere7e432b2017-08-21 15:01:40 -050042
Brandon Wyman764c7972017-08-22 17:05:36 -050043// Voltage out status.
44// Overvoltage fault or warning, Undervoltage fault or warning, maximum or
45// minimum warning, ....
Matt Spinlere7e432b2017-08-21 15:01:40 -050046// Uses Page substitution
47constexpr auto STATUS_VOUT = "statusP_vout";
48
Matt Spinlerde16d052017-12-13 13:22:14 -060049namespace status_vout
50{
51// Mask of bits that are only warnings
52constexpr auto WARNING_MASK = 0x6A;
Matt Spinlerf0f02b92018-10-25 16:12:43 -050053} // namespace status_vout
Matt Spinlerde16d052017-12-13 13:22:14 -060054
Brandon Wyman764c7972017-08-22 17:05:36 -050055// Current output status bits.
56constexpr auto STATUS_IOUT = "status0_iout";
57
58// Manufacturing specific status bits
59constexpr auto STATUS_MFR = "status0_mfr";
60
Brandon Wyman12661f12017-08-31 15:28:21 -050061// Reports on the status of any fans installed in position 1 and 2.
Brandon Wyman08cac062021-11-19 23:30:27 +000062constexpr auto STATUS_FANS_1_2 = "status0_fan12";
Brandon Wyman12661f12017-08-31 15:28:21 -050063
64// Reports on temperature faults or warnings. Overtemperature fault,
65// overtemperature warning, undertemperature warning, undertemperature fault.
66constexpr auto STATUS_TEMPERATURE = "status0_temp";
67
Brandon Wyman85c7bf42021-10-19 22:28:48 +000068// Reports on the communication, memory, logic fault(s).
69constexpr auto STATUS_CML = "status0_cml";
70
Matt Spinlere7e432b2017-08-21 15:01:40 -050071namespace status_word
72{
73constexpr auto VOUT_FAULT = 0x8000;
Brandon Wyman764c7972017-08-22 17:05:36 -050074
75// The IBM CFF power supply driver does map this bit to power1_alarm in the
76// hwmon space, but since the other bits that need to be checked do not have
77// a similar mapping, the code will just read STATUS_WORD and use bit masking
78// to see if the INPUT FAULT OR WARNING bit is on.
79constexpr auto INPUT_FAULT_WARN = 0x2000;
80
Brandon Wyman3f1242f2020-01-28 13:11:25 -060081// The bit mask representing the MFRSPECIFIC fault, bit 4 of STATUS_WORD high
82// byte. A manufacturer specific fault or warning has occurred.
83constexpr auto MFR_SPECIFIC_FAULT = 0x1000;
84
Brandon Wyman764c7972017-08-22 17:05:36 -050085// The bit mask representing the POWER_GOOD Negated bit of the STATUS_WORD.
86constexpr auto POWER_GOOD_NEGATED = 0x0800;
87
Brandon Wyman12661f12017-08-31 15:28:21 -050088// The bit mask representing the FAN FAULT or WARNING bit of the STATUS_WORD.
89// Bit 2 of the high byte of STATUS_WORD.
90constexpr auto FAN_FAULT = 0x0400;
91
Brandon Wyman764c7972017-08-22 17:05:36 -050092// The bit mask representing the UNITI_IS_OFF bit of the STATUS_WORD.
93constexpr auto UNIT_IS_OFF = 0x0040;
94
Brandon Wymanab05c072017-08-30 18:26:41 -050095// Bit 5 of the STATUS_BYTE, or lower byte of STATUS_WORD is used to indicate
96// an output overvoltage fault.
97constexpr auto VOUT_OV_FAULT = 0x0020;
98
Brandon Wymanb165c252017-08-25 18:59:54 -050099// The bit mask representing that an output overcurrent fault has occurred.
100constexpr auto IOUT_OC_FAULT = 0x0010;
101
Brandon Wyman764c7972017-08-22 17:05:36 -0500102// The IBM CFF power supply driver does map this bit to in1_alarm, however,
103// since a number of the other bits are not mapped that way for STATUS_WORD,
104// this code will just read the entire STATUS_WORD and use bit masking to find
105// out if that fault is on.
106constexpr auto VIN_UV_FAULT = 0x0008;
107
Brandon Wyman875b3632017-09-13 18:46:03 -0500108// The bit mask representing the TEMPERATURE FAULT or WARNING bit of the
109// STATUS_WORD. Bit 2 of the low byte (STATUS_BYTE).
110constexpr auto TEMPERATURE_FAULT_WARN = 0x0004;
111
Brandon Wyman85c7bf42021-10-19 22:28:48 +0000112// The bit mask representing the CML (Communication, Memory, and/or Logic) fault
113// bit of the STATUS_WORD. Bit 1 of the low byte (STATUS_BYTE).
114constexpr auto CML_FAULT = 0x0002;
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500115} // namespace status_word
Brandon Wyman875b3632017-09-13 18:46:03 -0500116
Lei YUe8c9cd62019-11-04 14:24:41 +0800117namespace status_vout
118{
119// The IBM CFF power supply driver maps MFR's OV_FAULT and VAUX_FAULT to this
120// bit.
121constexpr auto OV_FAULT = 0x80;
122
123// The IBM CFF power supply driver maps MFR's UV_FAULT to this bit.
124constexpr auto UV_FAULT = 0x10;
125} // namespace status_vout
126
Brandon Wyman875b3632017-09-13 18:46:03 -0500127namespace status_temperature
128{
129// Overtemperature Fault
130constexpr auto OT_FAULT = 0x80;
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500131} // namespace status_temperature
Matt Spinlere7e432b2017-08-21 15:01:40 -0500132
Brandon Wyman59a35792020-06-04 12:37:40 -0500133constexpr auto ON_OFF_CONFIG = "on_off_config";
134
135// From PMBus Specification Part II Revsion 1.2:
136// The ON_OFF_CONFIG command configures the combination of CONTROL pin input
137// and serial bus commands needed to turn the unit on and off. This includes how
138// the unit responds when power is applied.
139// Bits [7:5] - 000 - Reserved
140// Bit 4 - 1 - Unit does not power up until commanded by the CONTROL pin and
141// OPERATION command (as programmed in bits [3:0]).
142// Bit 3 - 0 - Unit ignores the on/off portion of the OPERATION command from
143// serial bus.
144// Bit 2 - 1 - Unit requires the CONTROL pin to be asserted to start the unit.
145// Bit 1 - 0 - Polarity of the CONTROL pin. Active low (Pull pin low to start
146// the unit).
147// Bit 0 - 1 - Turn off the output and stop transferring energy to the output as
148// fast as possible.
149constexpr auto ON_OFF_CONFIG_CONTROL_PIN_ONLY = 0x15;
150
Matt Spinler015e3ad2017-08-01 11:20:47 -0500151/**
Matt Spinler4dc46782018-01-04 14:29:16 -0600152 * Where the access should be done
Matt Spinler57868bc2017-08-03 10:07:41 -0500153 */
154enum class Type
155{
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500156 Base, // base device directory
157 Hwmon, // hwmon directory
158 Debug, // pmbus debug directory
159 DeviceDebug, // device debug directory
160 HwmonDeviceDebug // hwmon device debug directory
Matt Spinler57868bc2017-08-03 10:07:41 -0500161};
162
163/**
Brandon Wyman8d195772020-01-27 15:03:51 -0600164 * @class PMBusBase
165 *
166 * This is a base class for PMBus to assist with unit testing via mocking.
167 */
168class PMBusBase
169{
170 public:
171 virtual ~PMBusBase() = default;
Brandon Wyman3f1242f2020-01-28 13:11:25 -0600172
Brandon Wyman32453e92021-12-15 19:00:14 +0000173 virtual uint64_t read(const std::string& name, Type type,
174 bool errTrace = true) = 0;
Brandon Wyman1d7a7df2020-03-26 10:14:05 -0500175 virtual std::string readString(const std::string& name, Type type) = 0;
Brandon Wymanc3324422022-03-24 20:30:57 +0000176 virtual std::vector<uint8_t> readBinary(const std::string& name, Type type,
177 size_t length) = 0;
Brandon Wyman59a35792020-06-04 12:37:40 -0500178 virtual void writeBinary(const std::string& name, std::vector<uint8_t> data,
179 Type type) = 0;
Brandon Wyman9564e942020-11-10 14:01:42 -0600180 virtual void findHwmonDir() = 0;
Brandon Wyman4176d6b2020-10-07 17:41:06 -0500181 virtual const fs::path& path() const = 0;
Brandon Wyman6710ba22021-10-27 17:39:31 +0000182 virtual std::string insertPageNum(const std::string& templateName,
183 size_t page) = 0;
Shawn McCarneyfb0ccb82024-04-24 13:14:41 -0500184 virtual fs::path getPath(Type type) = 0;
Brandon Wyman8d195772020-01-27 15:03:51 -0600185};
186
187/**
188 * Wrapper function for PMBus
189 *
190 * @param[in] bus - I2C bus
191 * @param[in] address - I2C address (as a 2-byte string, e.g. 0069)
192 *
193 * @return PMBusBase pointer
194 */
195std::unique_ptr<PMBusBase> createPMBus(std::uint8_t bus,
196 const std::string& address);
197
198/**
Matt Spinler015e3ad2017-08-01 11:20:47 -0500199 * @class PMBus
200 *
201 * This class is an interface to communicating with PMBus devices
202 * by reading and writing sysfs files.
Matt Spinler57868bc2017-08-03 10:07:41 -0500203 *
204 * Based on the Type parameter, the accesses can either be done
205 * in the base device directory (the one passed into the constructor),
206 * or in the hwmon directory for the device.
Matt Spinler015e3ad2017-08-01 11:20:47 -0500207 */
Brandon Wyman8d195772020-01-27 15:03:51 -0600208class PMBus : public PMBusBase
Matt Spinler015e3ad2017-08-01 11:20:47 -0500209{
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500210 public:
211 PMBus() = delete;
Brandon Wyman8d195772020-01-27 15:03:51 -0600212 virtual ~PMBus() = default;
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500213 PMBus(const PMBus&) = default;
214 PMBus& operator=(const PMBus&) = default;
215 PMBus(PMBus&&) = default;
216 PMBus& operator=(PMBus&&) = default;
Matt Spinler015e3ad2017-08-01 11:20:47 -0500217
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500218 /**
219 * Constructor
220 *
221 * @param[in] path - path to the sysfs directory
222 */
223 PMBus(const std::string& path) : basePath(path)
224 {
225 findHwmonDir();
226 }
Matt Spinler015e3ad2017-08-01 11:20:47 -0500227
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500228 /**
229 * Constructor
230 *
231 * This version is required when DeviceDebug
232 * access will be used.
233 *
234 * @param[in] path - path to the sysfs directory
235 * @param[in] driverName - the device driver name
236 * @param[in] instance - chip instance number
237 */
238 PMBus(const std::string& path, const std::string& driverName,
239 size_t instance) :
Patrick Williamsf5402192024-08-16 15:20:53 -0400240 basePath(path), driverName(driverName), instance(instance)
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500241 {
242 findHwmonDir();
243 }
Matt Spinler015e3ad2017-08-01 11:20:47 -0500244
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500245 /**
Brandon Wyman8d195772020-01-27 15:03:51 -0600246 * Wrapper function for PMBus
247 *
248 * @param[in] bus - I2C bus
249 * @param[in] address - I2C address (as a 2-byte string, e.g. 0069)
250 *
251 * @return PMBusBase pointer
252 */
Patrick Williamsf5402192024-08-16 15:20:53 -0400253 static std::unique_ptr<PMBusBase>
254 createPMBus(std::uint8_t bus, const std::string& address);
Brandon Wyman8d195772020-01-27 15:03:51 -0600255
256 /**
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500257 * Reads a file in sysfs that represents a single bit,
258 * therefore doing a PMBus read.
259 *
260 * @param[in] name - path concatenated to
261 * basePath to read
262 * @param[in] type - Path type
263 *
264 * @return bool - false if result was 0, else true
265 */
266 bool readBit(const std::string& name, Type type);
Matt Spinler8f0d9532017-08-21 11:22:37 -0500267
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500268 /**
269 * Reads a file in sysfs that represents a single bit,
270 * where the page number passed in is substituted
271 * into the name in place of the 'P' character in it.
272 *
273 * @param[in] name - path concatenated to
274 * basePath to read
275 * @param[in] page - page number
276 * @param[in] type - Path type
277 *
278 * @return bool - false if result was 0, else true
279 */
280 bool readBitInPage(const std::string& name, size_t page, Type type);
281 /**
282 * Checks if the file for the given name and type exists.
283 *
284 * @param[in] name - path concatenated to basePath to read
285 * @param[in] type - Path type
286 *
287 * @return bool - True if file exists, false if it does not.
288 */
289 bool exists(const std::string& name, Type type);
Matt Spinler015e3ad2017-08-01 11:20:47 -0500290
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500291 /**
292 * Read byte(s) from file in sysfs.
293 *
294 * @param[in] name - path concatenated to basePath to read
295 * @param[in] type - Path type
Brandon Wyman32453e92021-12-15 19:00:14 +0000296 * @param[in] errTrace - true to enable tracing error (defaults to true)
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500297 *
298 * @return uint64_t - Up to 8 bytes of data read from file.
299 */
Brandon Wyman32453e92021-12-15 19:00:14 +0000300 uint64_t read(const std::string& name, Type type,
301 bool errTrace = true) override;
Brandon Wyman3b7b38b2017-09-25 16:43:45 -0500302
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500303 /**
304 * Read a string from file in sysfs.
305 *
306 * @param[in] name - path concatenated to basePath to read
307 * @param[in] type - Path type
308 *
309 * @return string - The data read from the file.
310 */
Brandon Wyman1d7a7df2020-03-26 10:14:05 -0500311 std::string readString(const std::string& name, Type type) override;
Matt Spinler015e3ad2017-08-01 11:20:47 -0500312
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500313 /**
314 * Read data from a binary file in sysfs.
315 *
316 * @param[in] name - path concatenated to basePath to read
317 * @param[in] type - Path type
318 * @param[in] length - length of data to read, in bytes
319 *
320 * @return vector<uint8_t> - The data read from the file.
321 */
322 std::vector<uint8_t> readBinary(const std::string& name, Type type,
323 size_t length);
Matt Spinlerfbae7b62018-01-04 14:33:13 -0600324
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500325 /**
326 * Writes an integer value to the file, therefore doing
327 * a PMBus write.
328 *
329 * @param[in] name - path concatenated to
330 * basePath to write
331 * @param[in] value - the value to write
332 * @param[in] type - Path type
333 */
334 void write(const std::string& name, int value, Type type);
Matt Spinlerfa23e332018-01-18 11:24:58 -0600335
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500336 /**
Brandon Wyman59a35792020-06-04 12:37:40 -0500337 * Writes binary data to a file in sysfs.
338 *
339 * @param[in] name - path concatenated to basePath to write
340 * @param[in] data - The data to write to the file
341 * @param[in] type - Path type
342 */
343 void writeBinary(const std::string& name, std::vector<uint8_t> data,
344 Type type) override;
345
346 /**
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500347 * Returns the sysfs base path of this device
348 */
Brandon Wyman4176d6b2020-10-07 17:41:06 -0500349 const fs::path& path() const override
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500350 {
351 return basePath;
352 }
Matt Spinler015e3ad2017-08-01 11:20:47 -0500353
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500354 /**
355 * Replaces the 'P' in the string passed in with
356 * the page number passed in.
357 *
358 * For example:
359 * insertPageNum("inP_enable", 42)
360 * returns "in42_enable"
361 *
362 * @param[in] templateName - the name string, with a 'P' in it
363 * @param[in] page - the page number to insert where the P was
364 *
365 * @return string - the new string with the page number in it
366 */
Brandon Wyman6710ba22021-10-27 17:39:31 +0000367 std::string insertPageNum(const std::string& templateName,
368 size_t page) override;
Matt Spinler015e3ad2017-08-01 11:20:47 -0500369
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500370 /**
371 * Finds the path relative to basePath to the hwmon directory
372 * for the device and stores it in hwmonRelPath.
373 */
Brandon Wyman9564e942020-11-10 14:01:42 -0600374 void findHwmonDir() override;
Matt Spinler015e3ad2017-08-01 11:20:47 -0500375
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500376 /**
377 * Returns the path to use for the passed in type.
378 *
379 * @param[in] type - Path type
380 *
381 * @return fs::path - the full path
382 */
Shawn McCarneyfb0ccb82024-04-24 13:14:41 -0500383 fs::path getPath(Type type) override;
Brandon Wymanff5f3392017-08-11 17:43:22 -0500384
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500385 private:
386 /**
387 * Returns the device name
388 *
389 * This is found in the 'name' file in basePath.
390 *
391 * @return string - the device name
392 */
393 std::string getDeviceName();
Matt Spinler57868bc2017-08-03 10:07:41 -0500394
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500395 /**
396 * The sysfs device path
397 */
398 fs::path basePath;
Matt Spinler015e3ad2017-08-01 11:20:47 -0500399
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500400 /**
401 * The directory name under the basePath hwmon directory
402 */
403 fs::path hwmonDir;
Matt Spinlerba053482018-01-04 14:26:05 -0600404
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500405 /**
406 * The device driver name. Used for finding the device
407 * debug directory. Not required if that directory
408 * isn't used.
409 */
410 std::string driverName;
Matt Spinler015e3ad2017-08-01 11:20:47 -0500411
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500412 /**
413 * The device instance number.
414 *
415 * Used in conjunction with the driver name for finding
416 * the debug directory. Not required if that directory
417 * isn't used.
418 */
419 size_t instance = 0;
Brandon Wymanff5f3392017-08-11 17:43:22 -0500420
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500421 /**
422 * The pmbus debug path with status files
423 */
424 const fs::path debugPath = "/sys/kernel/debug/";
Matt Spinler015e3ad2017-08-01 11:20:47 -0500425};
426
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500427} // namespace pmbus
Lei YUab093322019-10-09 16:43:22 +0800428} // namespace phosphor