[silicon_creator,pwrmgr] Create a mock

This pwrmgr library is used in the watchdog unittest so it is useful to
create a mock to abstract from the details of how the pwrmgr works.

Signed-off-by: Amaury Pouly <[email protected]>

Author: pamaury

sw/device/silicon_creator/lib/drivers/BUILD

@@ -879,18 +879,33 @@ cc_test(
     ],
 )
 
-cc_library(
+dual_cc_library(
     name = "pwrmgr",
-    srcs = ["pwrmgr.c"],
-    hdrs = ["pwrmgr.h"],
-    deps = [
-        ":ibex",
-        "//hw/top:dt",
-        "//hw/top:pwrmgr_c_regs",
-        "//sw/device/lib/base:abs_mmio",
-        "//sw/device/silicon_creator/lib:error",
-        "//sw/device/silicon_creator/lib/base:sec_mmio",
-    ],
+    srcs = dual_inputs(
+        device = ["pwrmgr.c"],
+        host = ["mock_pwrmgr.cc"],
+    ),
+    hdrs = dual_inputs(
+        host = ["mock_pwrmgr.h"],
+        shared = ["pwrmgr.h"],
+    ),
+    deps = dual_inputs(
+        device = [
+            ":ibex",
+            "//hw/top:pwrmgr_c_regs",
+            "//sw/device/lib/base:abs_mmio",
+            "//sw/device/silicon_creator/lib/base:sec_mmio",
+        ],
+        host = [
+            "//sw/device/lib/base:global_mock",
+            "//sw/device/silicon_creator/testing:rom_test",
+            "@googletest//:gtest",
+        ],
+        shared = [
+            "//hw/top:dt",
+            "//sw/device/silicon_creator/lib:error",
+        ],
+    ),
 )
 
 cc_library(

sw/device/silicon_creator/lib/drivers/mock_pwrmgr.cc

@@ -0,0 +1,31 @@
+// Copyright lowRISC contributors (OpenTitan project).
+// Licensed under the Apache License, Version 2.0, see LICENSE for details.
+// SPDX-License-Identifier: Apache-2.0
+
+#include "sw/device/silicon_creator/lib/drivers/mock_pwrmgr.h"
+
+namespace rom_test {
+extern "C" {
+void pwrmgr_enable_watchdog_reset_request(void) {
+  MockPwrmgr::Instance().EnableWatchdogResetRequest();
+}
+
+/**
+ * Synchronize across clock domain.
+ *
+ * Synchronizes across clock domains by setting the CDC_SYNC register and
+ * waiting for it to clear.
+ *
+ * @param n Number of synchronizations to perform.
+ */
+void pwrmgr_cdc_sync(uint32_t n) { MockPwrmgr::Instance().CdcSync(n); }
+
+/**
+ * Enable all resets.
+ */
+void pwrmgr_all_resets_enable(void) {
+  MockPwrmgr::Instance().AllResetsEnable();
+}
+
+}  // extern "C"
+}  // namespace rom_test

sw/device/silicon_creator/lib/drivers/mock_pwrmgr.h

@@ -0,0 +1,30 @@
+// Copyright lowRISC contributors (OpenTitan project).
+// Licensed under the Apache License, Version 2.0, see LICENSE for details.
+// SPDX-License-Identifier: Apache-2.0
+
+#ifndef OPENTITAN_SW_DEVICE_SILICON_CREATOR_LIB_DRIVERS_MOCK_PWRMGR_H_
+#define OPENTITAN_SW_DEVICE_SILICON_CREATOR_LIB_DRIVERS_MOCK_PWRMGR_H_
+
+#include "sw/device/lib/base/global_mock.h"
+#include "sw/device/silicon_creator/lib/drivers/pwrmgr.h"
+
+namespace rom_test {
+namespace internal {
+
+/**
+ * Mock class for pwrmgr.c.
+ */
+class MockPwrmgr : public global_mock::GlobalMock<MockPwrmgr> {
+ public:
+  MOCK_METHOD(void, EnableWatchdogResetRequest, ());
+  MOCK_METHOD(void, CdcSync, (uint32_t));
+  MOCK_METHOD(void, AllResetsEnable, ());
+};
+
+}  // namespace internal
+
+using MockPwrmgr = testing::StrictMock<internal::MockPwrmgr>;
+
+}  // namespace rom_test
+
+#endif  // OPENTITAN_SW_DEVICE_SILICON_CREATOR_LIB_DRIVERS_MOCK_PWRMGR_H_

sw/device/silicon_creator/lib/drivers/watchdog_unittest.cc

@@ -11,6 +11,7 @@
 #include "sw/device/silicon_creator/lib/base/mock_sec_mmio.h"
 #include "sw/device/silicon_creator/lib/drivers/lifecycle.h"
 #include "sw/device/silicon_creator/lib/drivers/mock_otp.h"
+#include "sw/device/silicon_creator/lib/drivers/mock_pwrmgr.h"
 #include "sw/device/silicon_creator/testing/rom_test.h"
 
 #include "hw/top/aon_timer_regs.h"
@@ -24,13 +25,7 @@ using ::testing::Return;
 
 class WatchdogTest : public rom_test::RomTest {
  protected:
-  void ExpectCdcSync() {
-    // The pwrmgr_cdc_sync function reads to check that the sync bit is clear,
-    // writes to the sync bit and then reads back waiting for it to clear.
-    EXPECT_ABS_READ32(pwrmgr_ + PWRMGR_CFG_CDC_SYNC_REG_OFFSET, 0);
-    EXPECT_ABS_WRITE32(pwrmgr_ + PWRMGR_CFG_CDC_SYNC_REG_OFFSET, 1);
-    EXPECT_ABS_READ32(pwrmgr_ + PWRMGR_CFG_CDC_SYNC_REG_OFFSET, 0);
-  }
+  void ExpectCdcSync() { EXPECT_CALL(pwrmgr_, CdcSync(1)).WillOnce(Return()); }
   /**
    * Sets up expectations for `watchdog_init()`.
    *
@@ -44,11 +39,7 @@ class WatchdogTest : public rom_test::RomTest {
             OTP_CTRL_PARAM_OWNER_SW_CFG_ROM_WATCHDOG_BITE_THRESHOLD_CYCLES_OFFSET))
         .WillOnce(Return(kBiteThreshold));
 
-    EXPECT_SEC_WRITE32(pwrmgr_ + PWRMGR_RESET_EN_REG_OFFSET,
-                       {
-                           {PWRMGR_RESET_EN_EN_1_BIT, true},
-                       });
-    ExpectCdcSync();
+    EXPECT_CALL(pwrmgr_, EnableWatchdogResetRequest).WillOnce(Return());
     EXPECT_SEC_WRITE32(wdog_ + AON_TIMER_WDOG_CTRL_REG_OFFSET,
                        0 << AON_TIMER_WDOG_CTRL_ENABLE_BIT);
     EXPECT_ABS_WRITE32(wdog_ + AON_TIMER_WDOG_COUNT_REG_OFFSET, 0);
@@ -61,11 +52,11 @@ class WatchdogTest : public rom_test::RomTest {
     ExpectCdcSync();
   }
 
-  uint32_t pwrmgr_ = TOP_EARLGREY_PWRMGR_AON_BASE_ADDR;
   uint32_t wdog_ = TOP_EARLGREY_AON_TIMER_AON_BASE_ADDR;
   rom_test::MockAbsMmio abs_;
   rom_test::MockSecMmio sec_;
   rom_test::MockOtp otp_;
+  rom_test::MockPwrmgr pwrmgr_;
 };
 
 TEST_F(WatchdogTest, InitializeNoOtp) {