blob: 8f52c7d788bdf4b5fc984d9b7e4a22c69899d919 [file] [log] [blame]
Christopher Meis7e446a42024-10-22 09:36:41 +02001#pragma once
2
3#include <sdbusplus/async.hpp>
4
5#include <cstdint>
6#include <memory>
7#include <string>
8
9namespace phosphor::software::VR
10{
11
12enum class VRType
13{
14 XDPE1X2XX,
Christopher Meisf00ce802025-04-08 08:07:31 +020015 ISL69269,
Kevin Tungdcf4b602025-07-04 13:14:49 +080016 MP2X6XX,
Kevin Tung3f2f3e62025-08-15 15:41:07 +080017 MP297X,
FreddieJheng782d6ee2025-08-19 18:53:15 +080018 MP5998,
cchoux86a2fd02025-08-20 16:22:12 +080019 RAA22XGen2,
Christopher Meis7e446a42024-10-22 09:36:41 +020020};
21
22class VoltageRegulator
23{
24 public:
25 explicit VoltageRegulator(sdbusplus::async::context& ctx) : ctx(ctx) {}
26 virtual ~VoltageRegulator() = default;
27
28 VoltageRegulator(VoltageRegulator& vr) = delete;
29 VoltageRegulator& operator=(VoltageRegulator other) = delete;
30 VoltageRegulator(VoltageRegulator&& other) = delete;
31 VoltageRegulator& operator=(VoltageRegulator&& other) = delete;
32
33 // @brief Parses the firmware image into the configuration structure
34 // and verifies its correctness.
35 // @return sdbusplus::async::task<bool> true indicates success.
36 virtual sdbusplus::async::task<bool> verifyImage(const uint8_t* image,
37 size_t imageSize) = 0;
38
39 // @brief Applies update to the voltage regulator
40 // @return sdbusplus::async::task<bool> true indicates success.
41 virtual sdbusplus::async::task<bool> updateFirmware(bool force) = 0;
42
Christopher Meis7e446a42024-10-22 09:36:41 +020043 // @brief Requests the CRC value of the voltage regulator over I2C.
44 // @param pointer to write the result to.
45 // @returns < 0 on error
46 virtual sdbusplus::async::task<bool> getCRC(uint32_t* checksum) = 0;
47
48 // @brief This function returns true if the voltage regulator supports
49 // force of updates.
50 virtual bool forcedUpdateAllowed() = 0;
51
52 protected:
53 sdbusplus::async::context& ctx;
54};
55
56std::unique_ptr<VoltageRegulator> create(sdbusplus::async::context& ctx,
57 enum VRType vrType, uint16_t bus,
58 uint16_t address);
59
60bool stringToEnum(std::string& vrStr, VRType& vrType);
61
62} // namespace phosphor::software::VR