[sw, dif_clkmgr] Add smoke test for clock manager DIF
Also replace 'sanity' with 'smoke' in the checklist as has already
been done for the other DIFs.
Signed-off-by: Michael Munday <mike.munday@lowrisc.org>
diff --git a/sw/device/lib/dif/dif_clkmgr.md b/sw/device/lib/dif/dif_clkmgr.md
index 7cbc294..850bde3 100644
--- a/sw/device/lib/dif/dif_clkmgr.md
+++ b/sw/device/lib/dif/dif_clkmgr.md
@@ -12,12 +12,12 @@
Implementation | [DIF_EXISTS][] | Done |
Implementation | [DIF_USED_IN_TREE][] | Not Started |
Tests | [DIF_TEST_UNIT][] | Done |
-Tests | [DIF_TEST_SANITY][] | Not Started |
+Tests | [DIF_TEST_SMOKE][] | Done |
[DIF_EXISTS]: {{< relref "/doc/project/checklist.md#dif_exists" >}}
[DIF_USED_IN_TREE]: {{< relref "/doc/project/checklist.md#dif_used_in_tree" >}}
[DIF_TEST_UNIT]: {{< relref "/doc/project/checklist.md#dif_test_unit" >}}
-[DIF_TEST_SANITY]: {{< relref "/doc/project/checklist.md#dif_test_sanity" >}}
+[DIF_TEST_SMOKE]: {{< relref "/doc/project/checklist.md#dif_test_smoke" >}}
Type | Item | Resolution | Note/Collaterals
diff --git a/sw/device/tests/dif/dif_clkmgr_smoketest.c b/sw/device/tests/dif/dif_clkmgr_smoketest.c
new file mode 100644
index 0000000..1a053d7
--- /dev/null
+++ b/sw/device/tests/dif/dif_clkmgr_smoketest.c
@@ -0,0 +1,105 @@
+// Copyright lowRISC contributors.
+// Licensed under the Apache License, Version 2.0, see LICENSE for details.
+// SPDX-License-Identifier: Apache-2.0
+
+#include "sw/device/lib/base/memory.h"
+#include "sw/device/lib/dif/dif_clkmgr.h"
+#include "sw/device/lib/testing/check.h"
+#include "sw/device/lib/testing/test_main.h"
+
+#include "hw/top_earlgrey/sw/autogen/top_earlgrey.h" // Generated.
+
+const test_config_t kTestConfig;
+
+/**
+ * Test that all 'gateable' clocks, directly controlled by software,
+ * can be enabled and disabled.
+ */
+static void test_gateable_clocks(const dif_clkmgr_t *clkmgr) {
+ const dif_clkmgr_gateable_clock_t clocks[] = {
+ kTopEarlgreyGateableClocksIoDiv4Peri,
+ kTopEarlgreyGateableClocksUsbPeri,
+ };
+
+ for (int i = 0; i < ARRAYSIZE(clocks); ++i) {
+ dif_clkmgr_gateable_clock_t clock = clocks[i];
+
+ // Get the initial state of the clock. The clock might be enabled or
+ // disabled depending on reset behavior - either is fine for the purposes of
+ // this test.
+ bool enabled;
+ CHECK(dif_clkmgr_gateable_clock_get_enabled(clkmgr, clock, &enabled) ==
+ kDifClkmgrOk);
+
+ // Toggle the enable twice so that it ends up in its original state.
+ for (int j = 0; j < 2; ++j) {
+ bool expected = !enabled;
+ CHECK(dif_clkmgr_gateable_clock_set_enabled(
+ clkmgr, clock,
+ expected ? kDifClkmgrToggleEnabled
+ : kDifClkmgrToggleDisabled) == kDifClkmgrOk);
+ CHECK(dif_clkmgr_gateable_clock_get_enabled(clkmgr, clock, &enabled) ==
+ kDifClkmgrOk);
+ CHECK(enabled == expected);
+ }
+ }
+}
+
+/**
+ * Test that all 'hintable' clocks, indirectly controlled by software,
+ * can have their hint toggled and status checked.
+ */
+void test_hintable_clocks(const dif_clkmgr_t *clkmgr) {
+ const dif_clkmgr_hintable_clock_t clocks[] = {
+ kTopEarlgreyHintableClocksMainAes,
+ kTopEarlgreyHintableClocksMainHmac,
+ kTopEarlgreyHintableClocksMainKmac,
+ kTopEarlgreyHintableClocksMainOtbn,
+ };
+
+ for (int i = 0; i < ARRAYSIZE(clocks); ++i) {
+ dif_clkmgr_hintable_clock_t clock = clocks[i];
+
+ // Get the initial state of the hint for the clock The clock hint might be
+ // enabled or disabled depending on reset behavior - either is fine for the
+ // purposes of this test.
+ bool enabled;
+ CHECK(dif_clkmgr_hintable_clock_get_hint(clkmgr, clock, &enabled) ==
+ kDifClkmgrOk);
+
+ // Toggle the hint twice so that it ends up in its original state.
+ for (int j = 0; j < 2; ++j) {
+ bool expected = !enabled;
+ CHECK(dif_clkmgr_hintable_clock_set_hint(
+ clkmgr, clock,
+ expected ? kDifClkmgrToggleEnabled
+ : kDifClkmgrToggleDisabled) == kDifClkmgrOk);
+ CHECK(dif_clkmgr_hintable_clock_get_hint(clkmgr, clock, &enabled) ==
+ kDifClkmgrOk);
+ CHECK(enabled == expected);
+
+ // If the clock hint is enabled then the clock should always be enabled.
+ if (enabled) {
+ bool status = false;
+ CHECK(dif_clkmgr_hintable_clock_get_enabled(clkmgr, clock, &status) ==
+ kDifClkmgrOk);
+ CHECK(status, "clock %u hint is enabled but status is disabled", clock);
+ }
+ }
+ }
+}
+
+bool test_main() {
+ const dif_clkmgr_params_t params = {
+ .base_addr = mmio_region_from_addr(TOP_EARLGREY_CLKMGR_BASE_ADDR),
+ .last_gateable_clock = kTopEarlgreyGateableClocksLast,
+ .last_hintable_clock = kTopEarlgreyHintableClocksLast,
+ };
+
+ dif_clkmgr_t clkmgr;
+ CHECK(dif_clkmgr_init(params, &clkmgr) == kDifClkmgrOk);
+ test_gateable_clocks(&clkmgr);
+ test_hintable_clocks(&clkmgr);
+
+ return true;
+}
diff --git a/sw/device/tests/dif/meson.build b/sw/device/tests/dif/meson.build
index 18da744..9d78607 100644
--- a/sw/device/tests/dif/meson.build
+++ b/sw/device/tests/dif/meson.build
@@ -390,3 +390,20 @@
'library': dif_aes_smoketest_lib,
}
}
+
+dif_clkmgr_smoketest_lib = declare_dependency(
+ link_with: static_library(
+ 'dif_clkmgr_smoketest_lib',
+ sources: ['dif_clkmgr_smoketest.c'],
+ dependencies: [
+ sw_lib_dif_clkmgr,
+ sw_lib_mmio,
+ sw_lib_runtime_log,
+ ],
+ ),
+)
+sw_tests += {
+ 'dif_clkmgr_smoketest': {
+ 'library': dif_clkmgr_smoketest_lib,
+ }
+}
diff --git a/test/systemtest/config.py b/test/systemtest/config.py
index 065a8a4..8b03a84 100644
--- a/test/systemtest/config.py
+++ b/test/systemtest/config.py
@@ -60,6 +60,9 @@
"name": "dif_uart_smoketest",
},
{
+ "name": "dif_clkmgr_smoketest",
+ },
+ {
"name": "flash_ctrl_test",
},
{
