xref: /openbmc/phosphor-bmc-code-mgmt/i2c-vr/xdpe1x2xx/xdpe1x2xx.hpp (revision fd34144b13fe506b8dcabf54e868e109a9605f0e)
1 #pragma once
2 
3 #include "common/include/i2c/i2c.hpp"
4 #include "i2c-vr/vr.hpp"
5 
6 #include <sdbusplus/async.hpp>
7 
8 #include <cstdint>
9 
10 namespace phosphor::software::VR
11 {
12 
13 class XDPE1X2XX : public VoltageRegulator
14 {
15   public:
16     XDPE1X2XX(sdbusplus::async::context& ctx, uint16_t bus, uint16_t address);
17 
18     sdbusplus::async::task<bool> verifyImage(const uint8_t* image,
19                                              size_t imageSize) final;
20 
21     sdbusplus::async::task<bool> updateFirmware(bool force) final;
22     sdbusplus::async::task<bool> reset() final;
23 
24     sdbusplus::async::task<bool> getCRC(uint32_t* checksum) final;
25     bool forcedUpdateAllowed() final;
26 
27   private:
28     static const int MaxSectCnt = 16;
29     static const int MaxSectDataCnt = 200;
30 
31     struct deviceInfo
32     {
33         uint8_t deviceId;
34         uint8_t deviceRev;
35         uint8_t remainingWrites;
36         uint32_t scratchPadAddress;
37         uint32_t actualCRC;
38         uint32_t configSize;
39     };
40 
41     struct configSect
42     {
43         uint8_t type;
44         uint16_t dataCnt;
45         uint32_t data[MaxSectDataCnt];
46     };
47 
48     struct xdpe1x2xxConfig
49     {
50         uint8_t addr;
51         uint16_t totalCnt;
52         uint32_t sumExp;
53         uint8_t sectCnt;
54         struct configSect section[MaxSectCnt];
55     };
56 
57     sdbusplus::async::task<bool> getDeviceId(uint8_t* deviceId);
58     sdbusplus::async::task<bool> mfrFWcmd(uint8_t cmd, uint16_t processTime,
59                                           uint8_t* data, uint8_t* resp);
60     sdbusplus::async::task<bool> getRemainingWrites(uint8_t* remain);
61     sdbusplus::async::task<bool> program(bool force);
62     sdbusplus::async::task<bool> getScratchPadAddress();
63 
64     bool parseImage(const uint8_t* image, size_t imageSize);
65     bool checkImage();
66 
67     static uint32_t calcCRC32(const uint32_t* data, int len);
68     static int getConfigSize(uint8_t deviceId, uint8_t revision);
69     static int lineSplit(char** dst, char* src, char* delim);
70 
71     phosphor::i2c::I2C i2cInterface;
72 
73     struct deviceInfo info;
74     struct xdpe1x2xxConfig configuration;
75 };
76 
77 } // namespace phosphor::software::VR
78