openbmc/phosphor-power/pmbus.hpp

139 // Bits [7:5] - 000 - Reserved
140 // Bit 4 - 1 - Unit does not power up until commanded by the CONTROL pin and
142 // Bit 3 - 0 - Unit ignores the on/off portion of the OPERATION command from
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
147 // Bit 0 - 1 - Turn off the output and stop transferring energy to the output as
166  * This is a base class for PMBus to assist with unit testing via mocking.
190  * @param[in] bus - I2C bus
191  * @param[in] address - I2C address (as a 2-byte string, e.g. 0069)
221      * @param[in] path - path to the sysfs directory
234      * @param[in] path - path to the sysfs directory
235      * @param[in] driverName - the device driver name
236      * @param[in] instance - chip instance number
248      * @param[in] bus - I2C bus
249      * @param[in] address - I2C address (as a 2-byte string, e.g. 0069)
260      * @param[in] name - path concatenated to
262      * @param[in] type - Path type
264      * @return bool - false if result was 0, else true
273      * @param[in] name - path concatenated to
275      * @param[in] page - page number
276      * @param[in] type - Path type
278      * @return bool - false if result was 0, else true
284      * @param[in] name   - path concatenated to basePath to read
285      * @param[in] type   - Path type
287      * @return bool - True if file exists, false if it does not.
294      * @param[in] name   - path concatenated to basePath to read
295      * @param[in] type   - Path type
296      * @param[in] errTrace - true to enable tracing error (defaults to true)
298      * @return uint64_t - Up to 8 bytes of data read from file.
306      * @param[in] name   - path concatenated to basePath to read
307      * @param[in] type   - Path type
309      * @return string - The data read from the file.
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
320      * @return vector<uint8_t> - The data read from the file.
327      * a PMBus write.
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
334     void write(const std::string& name, int value, Type type);
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
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
365      * @return string - the new string with the page number in it
379      * @param[in] type - Path type
381      * @return fs::path - the full path
391      * @return string - the device name