1*b5451447SShawn McCarney /**
2*b5451447SShawn McCarney * Copyright © 2024 IBM Corporation
3*b5451447SShawn McCarney *
4*b5451447SShawn McCarney * Licensed under the Apache License, Version 2.0 (the "License");
5*b5451447SShawn McCarney * you may not use this file except in compliance with the License.
6*b5451447SShawn McCarney * You may obtain a copy of the License at
7*b5451447SShawn McCarney *
8*b5451447SShawn McCarney * http://www.apache.org/licenses/LICENSE-2.0
9*b5451447SShawn McCarney *
10*b5451447SShawn McCarney * Unless required by applicable law or agreed to in writing, software
11*b5451447SShawn McCarney * distributed under the License is distributed on an "AS IS" BASIS,
12*b5451447SShawn McCarney * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*b5451447SShawn McCarney * See the License for the specific language governing permissions and
14*b5451447SShawn McCarney * limitations under the License.
15*b5451447SShawn McCarney */
16*b5451447SShawn McCarney
17*b5451447SShawn McCarney #include "mock_pmbus.hpp"
18*b5451447SShawn McCarney #include "mock_services.hpp"
19*b5451447SShawn McCarney #include "pmbus.hpp"
20*b5451447SShawn McCarney #include "rail.hpp"
21*b5451447SShawn McCarney #include "services.hpp"
22*b5451447SShawn McCarney #include "ucd90160_device.hpp"
23*b5451447SShawn McCarney
24*b5451447SShawn McCarney #include <cstdint>
25*b5451447SShawn McCarney #include <map>
26*b5451447SShawn McCarney #include <memory>
27*b5451447SShawn McCarney #include <optional>
28*b5451447SShawn McCarney #include <string>
29*b5451447SShawn McCarney #include <utility>
30*b5451447SShawn McCarney #include <vector>
31*b5451447SShawn McCarney
32*b5451447SShawn McCarney #include <gmock/gmock.h>
33*b5451447SShawn McCarney #include <gtest/gtest.h>
34*b5451447SShawn McCarney
35*b5451447SShawn McCarney using namespace phosphor::power::sequencer;
36*b5451447SShawn McCarney using namespace phosphor::pmbus;
37*b5451447SShawn McCarney
38*b5451447SShawn McCarney using ::testing::Return;
39*b5451447SShawn McCarney
40*b5451447SShawn McCarney /**
41*b5451447SShawn McCarney * Creates a Rail object that checks for a pgood fault using a GPIO.
42*b5451447SShawn McCarney *
43*b5451447SShawn McCarney * @param name Unique name for the rail
44*b5451447SShawn McCarney * @param gpio GPIO line to read to determine the pgood status of the rail
45*b5451447SShawn McCarney * @return Rail object
46*b5451447SShawn McCarney */
createRail(const std::string & name,unsigned int gpioLine)47*b5451447SShawn McCarney static std::unique_ptr<Rail> createRail(const std::string& name,
48*b5451447SShawn McCarney unsigned int gpioLine)
49*b5451447SShawn McCarney {
50*b5451447SShawn McCarney std::optional<std::string> presence{};
51*b5451447SShawn McCarney std::optional<uint8_t> page{};
52*b5451447SShawn McCarney bool isPowerSupplyRail{false};
53*b5451447SShawn McCarney bool checkStatusVout{false};
54*b5451447SShawn McCarney bool compareVoltageToLimit{false};
55*b5451447SShawn McCarney bool activeLow{false};
56*b5451447SShawn McCarney std::optional<GPIO> gpio{GPIO{gpioLine, activeLow}};
57*b5451447SShawn McCarney return std::make_unique<Rail>(name, presence, page, isPowerSupplyRail,
58*b5451447SShawn McCarney checkStatusVout, compareVoltageToLimit, gpio);
59*b5451447SShawn McCarney }
60*b5451447SShawn McCarney
TEST(UCD90160DeviceTests,Constructor)61*b5451447SShawn McCarney TEST(UCD90160DeviceTests, Constructor)
62*b5451447SShawn McCarney {
63*b5451447SShawn McCarney MockServices services;
64*b5451447SShawn McCarney
65*b5451447SShawn McCarney std::vector<std::unique_ptr<Rail>> rails;
66*b5451447SShawn McCarney rails.emplace_back(createRail("VDD", 5));
67*b5451447SShawn McCarney rails.emplace_back(createRail("VIO", 7));
68*b5451447SShawn McCarney uint8_t bus{3};
69*b5451447SShawn McCarney uint16_t address{0x72};
70*b5451447SShawn McCarney UCD90160Device device{std::move(rails), services, bus, address};
71*b5451447SShawn McCarney
72*b5451447SShawn McCarney EXPECT_EQ(device.getName(), "UCD90160");
73*b5451447SShawn McCarney EXPECT_EQ(device.getRails().size(), 2);
74*b5451447SShawn McCarney EXPECT_EQ(device.getRails()[0]->getName(), "VDD");
75*b5451447SShawn McCarney EXPECT_EQ(device.getRails()[1]->getName(), "VIO");
76*b5451447SShawn McCarney EXPECT_EQ(device.getBus(), bus);
77*b5451447SShawn McCarney EXPECT_EQ(device.getAddress(), address);
78*b5451447SShawn McCarney EXPECT_EQ(device.getDriverName(), "ucd9000");
79*b5451447SShawn McCarney EXPECT_EQ(device.getInstance(), 0);
80*b5451447SShawn McCarney EXPECT_NE(&(device.getPMBusInterface()), nullptr);
81*b5451447SShawn McCarney }
82*b5451447SShawn McCarney
TEST(UCD90160DeviceTests,StoreGPIOValues)83*b5451447SShawn McCarney TEST(UCD90160DeviceTests, StoreGPIOValues)
84*b5451447SShawn McCarney {
85*b5451447SShawn McCarney // This is a protected method and cannot be called directly from a gtest.
86*b5451447SShawn McCarney // Call findPgoodFault() which calls storeGPIOValues().
87*b5451447SShawn McCarney
88*b5451447SShawn McCarney // Test where works
89*b5451447SShawn McCarney {
90*b5451447SShawn McCarney std::vector<int> gpioValues{
91*b5451447SShawn McCarney 1, 0, 0, 1, // group 1 in journal
92*b5451447SShawn McCarney 1, 1, 0, 0, // group 2 in journal
93*b5451447SShawn McCarney 1, 0, 1, 1, // group 3 in journal
94*b5451447SShawn McCarney 0, 0, 1, 1, // group 4 in journal
95*b5451447SShawn McCarney 1, 0, 0, 0, // group 5 in journal
96*b5451447SShawn McCarney 1, 0, 0, 1, // group 6 in journal
97*b5451447SShawn McCarney 1, 1 // group 7 in journal
98*b5451447SShawn McCarney };
99*b5451447SShawn McCarney
100*b5451447SShawn McCarney MockServices services;
101*b5451447SShawn McCarney EXPECT_CALL(services, getGPIOValues("ucd90160"))
102*b5451447SShawn McCarney .Times(1)
103*b5451447SShawn McCarney .WillOnce(Return(gpioValues));
104*b5451447SShawn McCarney EXPECT_CALL(services, logInfoMsg("Device UCD90160 GPIO values:"))
105*b5451447SShawn McCarney .Times(1);
106*b5451447SShawn McCarney EXPECT_CALL(
107*b5451447SShawn McCarney services,
108*b5451447SShawn McCarney logInfoMsg("[FPWM1_GPIO5, FPWM2_GPIO6, FPWM3_GPIO7, FPWM4_GPIO8]: "
109*b5451447SShawn McCarney "[1, 0, 0, 1]"))
110*b5451447SShawn McCarney .Times(1);
111*b5451447SShawn McCarney EXPECT_CALL(
112*b5451447SShawn McCarney services,
113*b5451447SShawn McCarney logInfoMsg(
114*b5451447SShawn McCarney "[FPWM5_GPIO9, FPWM6_GPIO10, FPWM7_GPIO11, FPWM8_GPIO12]: "
115*b5451447SShawn McCarney "[1, 1, 0, 0]"))
116*b5451447SShawn McCarney .Times(1);
117*b5451447SShawn McCarney EXPECT_CALL(services,
118*b5451447SShawn McCarney logInfoMsg("[GPI1_PWM1, GPI2_PWM2, GPI3_PWM3, GPI4_PWM4]: "
119*b5451447SShawn McCarney "[1, 0, 1, 1]"))
120*b5451447SShawn McCarney .Times(1);
121*b5451447SShawn McCarney EXPECT_CALL(services,
122*b5451447SShawn McCarney logInfoMsg("[GPIO14, GPIO15, TDO_GPIO20, TCK_GPIO19]: "
123*b5451447SShawn McCarney "[0, 0, 1, 1]"))
124*b5451447SShawn McCarney .Times(1);
125*b5451447SShawn McCarney EXPECT_CALL(services,
126*b5451447SShawn McCarney logInfoMsg("[TMS_GPIO22, TDI_GPIO21, GPIO1, GPIO2]: "
127*b5451447SShawn McCarney "[1, 0, 0, 0]"))
128*b5451447SShawn McCarney .Times(1);
129*b5451447SShawn McCarney EXPECT_CALL(services, logInfoMsg("[GPIO3, GPIO4, GPIO13, GPIO16]: "
130*b5451447SShawn McCarney "[1, 0, 0, 1]"))
131*b5451447SShawn McCarney .Times(1);
132*b5451447SShawn McCarney EXPECT_CALL(services, logInfoMsg("[GPIO17, GPIO18]: "
133*b5451447SShawn McCarney "[1, 1]"))
134*b5451447SShawn McCarney .Times(1);
135*b5451447SShawn McCarney EXPECT_CALL(services,
136*b5451447SShawn McCarney logInfoMsg("Device UCD90160 MFR_STATUS: 0x123456789abc"))
137*b5451447SShawn McCarney .Times(1);
138*b5451447SShawn McCarney EXPECT_CALL(
139*b5451447SShawn McCarney services,
140*b5451447SShawn McCarney logErrorMsg(
141*b5451447SShawn McCarney "Pgood fault found in rail monitored by device UCD90160"))
142*b5451447SShawn McCarney .Times(1);
143*b5451447SShawn McCarney EXPECT_CALL(services, logErrorMsg("Pgood fault detected in rail VDD"))
144*b5451447SShawn McCarney .Times(1);
145*b5451447SShawn McCarney EXPECT_CALL(
146*b5451447SShawn McCarney services,
147*b5451447SShawn McCarney logErrorMsg(
148*b5451447SShawn McCarney "Rail VDD pgood GPIO line offset 2 has inactive value 0"))
149*b5451447SShawn McCarney .Times(1);
150*b5451447SShawn McCarney
151*b5451447SShawn McCarney std::vector<std::unique_ptr<Rail>> rails;
152*b5451447SShawn McCarney rails.emplace_back(createRail("VDD", 2));
153*b5451447SShawn McCarney uint8_t bus{3};
154*b5451447SShawn McCarney uint16_t address{0x72};
155*b5451447SShawn McCarney UCD90160Device device{std::move(rails), services, bus, address};
156*b5451447SShawn McCarney
157*b5451447SShawn McCarney MockPMBus& pmbus = static_cast<MockPMBus&>(device.getPMBusInterface());
158*b5451447SShawn McCarney EXPECT_CALL(pmbus, getPath(Type::Hwmon))
159*b5451447SShawn McCarney .Times(1)
160*b5451447SShawn McCarney .WillOnce(Return("/tmp"));
161*b5451447SShawn McCarney EXPECT_CALL(pmbus, read("mfr_status", Type::HwmonDeviceDebug, true))
162*b5451447SShawn McCarney .Times(1)
163*b5451447SShawn McCarney .WillOnce(Return(0x123456789abcull));
164*b5451447SShawn McCarney
165*b5451447SShawn McCarney // Call findPgoodFault() which calls storeGPIOValues()
166*b5451447SShawn McCarney std::string powerSupplyError{};
167*b5451447SShawn McCarney std::map<std::string, std::string> additionalData{};
168*b5451447SShawn McCarney std::string error = device.findPgoodFault(services, powerSupplyError,
169*b5451447SShawn McCarney additionalData);
170*b5451447SShawn McCarney EXPECT_EQ(error,
171*b5451447SShawn McCarney "xyz.openbmc_project.Power.Error.PowerSequencerVoltageFault");
172*b5451447SShawn McCarney EXPECT_EQ(additionalData.size(), 31);
173*b5451447SShawn McCarney EXPECT_EQ(additionalData["MFR_STATUS"], "0x123456789abc");
174*b5451447SShawn McCarney EXPECT_EQ(additionalData["DEVICE_NAME"], "UCD90160");
175*b5451447SShawn McCarney EXPECT_EQ(additionalData["FPWM1_GPIO5"], "1");
176*b5451447SShawn McCarney EXPECT_EQ(additionalData["FPWM2_GPIO6"], "0");
177*b5451447SShawn McCarney EXPECT_EQ(additionalData["FPWM3_GPIO7"], "0");
178*b5451447SShawn McCarney EXPECT_EQ(additionalData["FPWM4_GPIO8"], "1");
179*b5451447SShawn McCarney EXPECT_EQ(additionalData["FPWM5_GPIO9"], "1");
180*b5451447SShawn McCarney EXPECT_EQ(additionalData["FPWM6_GPIO10"], "1");
181*b5451447SShawn McCarney EXPECT_EQ(additionalData["FPWM7_GPIO11"], "0");
182*b5451447SShawn McCarney EXPECT_EQ(additionalData["FPWM8_GPIO12"], "0");
183*b5451447SShawn McCarney EXPECT_EQ(additionalData["GPI1_PWM1"], "1");
184*b5451447SShawn McCarney EXPECT_EQ(additionalData["GPI2_PWM2"], "0");
185*b5451447SShawn McCarney EXPECT_EQ(additionalData["GPI3_PWM3"], "1");
186*b5451447SShawn McCarney EXPECT_EQ(additionalData["GPI4_PWM4"], "1");
187*b5451447SShawn McCarney EXPECT_EQ(additionalData["GPIO14"], "0");
188*b5451447SShawn McCarney EXPECT_EQ(additionalData["GPIO15"], "0");
189*b5451447SShawn McCarney EXPECT_EQ(additionalData["TDO_GPIO20"], "1");
190*b5451447SShawn McCarney EXPECT_EQ(additionalData["TCK_GPIO19"], "1");
191*b5451447SShawn McCarney EXPECT_EQ(additionalData["TMS_GPIO22"], "1");
192*b5451447SShawn McCarney EXPECT_EQ(additionalData["TDI_GPIO21"], "0");
193*b5451447SShawn McCarney EXPECT_EQ(additionalData["GPIO1"], "0");
194*b5451447SShawn McCarney EXPECT_EQ(additionalData["GPIO2"], "0");
195*b5451447SShawn McCarney EXPECT_EQ(additionalData["GPIO3"], "1");
196*b5451447SShawn McCarney EXPECT_EQ(additionalData["GPIO4"], "0");
197*b5451447SShawn McCarney EXPECT_EQ(additionalData["GPIO13"], "0");
198*b5451447SShawn McCarney EXPECT_EQ(additionalData["GPIO16"], "1");
199*b5451447SShawn McCarney EXPECT_EQ(additionalData["GPIO17"], "1");
200*b5451447SShawn McCarney EXPECT_EQ(additionalData["GPIO18"], "1");
201*b5451447SShawn McCarney EXPECT_EQ(additionalData["RAIL_NAME"], "VDD");
202*b5451447SShawn McCarney EXPECT_EQ(additionalData["GPIO_LINE"], "2");
203*b5451447SShawn McCarney EXPECT_EQ(additionalData["GPIO_VALUE"], "0");
204*b5451447SShawn McCarney }
205*b5451447SShawn McCarney
206*b5451447SShawn McCarney // Test where there are the wrong number of GPIOs (27 instead of 26)
207*b5451447SShawn McCarney {
208*b5451447SShawn McCarney std::vector<int> gpioValues{
209*b5451447SShawn McCarney 1, 0, 0, 1, // group 1 in journal
210*b5451447SShawn McCarney 1, 1, 0, 0, // group 2 in journal
211*b5451447SShawn McCarney 1, 0, 1, 1, // group 3 in journal
212*b5451447SShawn McCarney 0, 0, 1, 1, // group 4 in journal
213*b5451447SShawn McCarney 1, 0, 0, 0, // group 5 in journal
214*b5451447SShawn McCarney 1, 0, 0, 1, // group 6 in journal
215*b5451447SShawn McCarney 1, 1, 0 // group 7 in journal + extra value
216*b5451447SShawn McCarney };
217*b5451447SShawn McCarney
218*b5451447SShawn McCarney MockServices services;
219*b5451447SShawn McCarney EXPECT_CALL(services, getGPIOValues("ucd90160"))
220*b5451447SShawn McCarney .Times(1)
221*b5451447SShawn McCarney .WillOnce(Return(gpioValues));
222*b5451447SShawn McCarney EXPECT_CALL(services, logInfoMsg("Device UCD90160 GPIO values: ["
223*b5451447SShawn McCarney "1, 0, 0, 1, "
224*b5451447SShawn McCarney "1, 1, 0, 0, "
225*b5451447SShawn McCarney "1, 0, 1, 1, "
226*b5451447SShawn McCarney "0, 0, 1, 1, "
227*b5451447SShawn McCarney "1, 0, 0, 0, "
228*b5451447SShawn McCarney "1, 0, 0, 1, "
229*b5451447SShawn McCarney "1, 1, 0]"))
230*b5451447SShawn McCarney .Times(1);
231*b5451447SShawn McCarney EXPECT_CALL(services,
232*b5451447SShawn McCarney logInfoMsg("Device UCD90160 MFR_STATUS: 0x123456789abc"))
233*b5451447SShawn McCarney .Times(1);
234*b5451447SShawn McCarney EXPECT_CALL(
235*b5451447SShawn McCarney services,
236*b5451447SShawn McCarney logErrorMsg(
237*b5451447SShawn McCarney "Pgood fault found in rail monitored by device UCD90160"))
238*b5451447SShawn McCarney .Times(1);
239*b5451447SShawn McCarney EXPECT_CALL(services, logErrorMsg("Pgood fault detected in rail VDD"))
240*b5451447SShawn McCarney .Times(1);
241*b5451447SShawn McCarney EXPECT_CALL(
242*b5451447SShawn McCarney services,
243*b5451447SShawn McCarney logErrorMsg(
244*b5451447SShawn McCarney "Rail VDD pgood GPIO line offset 2 has inactive value 0"))
245*b5451447SShawn McCarney .Times(1);
246*b5451447SShawn McCarney
247*b5451447SShawn McCarney std::vector<std::unique_ptr<Rail>> rails;
248*b5451447SShawn McCarney rails.emplace_back(createRail("VDD", 2));
249*b5451447SShawn McCarney uint8_t bus{3};
250*b5451447SShawn McCarney uint16_t address{0x72};
251*b5451447SShawn McCarney UCD90160Device device{std::move(rails), services, bus, address};
252*b5451447SShawn McCarney
253*b5451447SShawn McCarney MockPMBus& pmbus = static_cast<MockPMBus&>(device.getPMBusInterface());
254*b5451447SShawn McCarney EXPECT_CALL(pmbus, getPath(Type::Hwmon))
255*b5451447SShawn McCarney .Times(1)
256*b5451447SShawn McCarney .WillOnce(Return("/tmp"));
257*b5451447SShawn McCarney EXPECT_CALL(pmbus, read("mfr_status", Type::HwmonDeviceDebug, true))
258*b5451447SShawn McCarney .Times(1)
259*b5451447SShawn McCarney .WillOnce(Return(0x123456789abcull));
260*b5451447SShawn McCarney
261*b5451447SShawn McCarney // Call findPgoodFault() which calls storeGPIOValues()
262*b5451447SShawn McCarney std::string powerSupplyError{};
263*b5451447SShawn McCarney std::map<std::string, std::string> additionalData{};
264*b5451447SShawn McCarney std::string error = device.findPgoodFault(services, powerSupplyError,
265*b5451447SShawn McCarney additionalData);
266*b5451447SShawn McCarney EXPECT_EQ(error,
267*b5451447SShawn McCarney "xyz.openbmc_project.Power.Error.PowerSequencerVoltageFault");
268*b5451447SShawn McCarney EXPECT_EQ(additionalData.size(), 6);
269*b5451447SShawn McCarney EXPECT_EQ(additionalData["MFR_STATUS"], "0x123456789abc");
270*b5451447SShawn McCarney EXPECT_EQ(additionalData["DEVICE_NAME"], "UCD90160");
271*b5451447SShawn McCarney EXPECT_EQ(additionalData["GPIO_VALUES"], "[1, 0, 0, 1, "
272*b5451447SShawn McCarney "1, 1, 0, 0, "
273*b5451447SShawn McCarney "1, 0, 1, 1, "
274*b5451447SShawn McCarney "0, 0, 1, 1, "
275*b5451447SShawn McCarney "1, 0, 0, 0, "
276*b5451447SShawn McCarney "1, 0, 0, 1, "
277*b5451447SShawn McCarney "1, 1, 0]");
278*b5451447SShawn McCarney EXPECT_EQ(additionalData["RAIL_NAME"], "VDD");
279*b5451447SShawn McCarney EXPECT_EQ(additionalData["GPIO_LINE"], "2");
280*b5451447SShawn McCarney EXPECT_EQ(additionalData["GPIO_VALUE"], "0");
281*b5451447SShawn McCarney }
282*b5451447SShawn McCarney }
283