tests: drivers: hwspinlock: Add dt_spec test

Adds a hwspinlock driver test to exercise the dt spec macros and detect
the context initializer build warning that was fixed in commit
8b208b0. Previously the build warning
wasn't reproducible in-tree.

Signed-off-by: Maureen Helm <maureen.helm@analog.com>

Author: MaureenHelm

drivers/hwspinlock/CMakeLists.txt

@@ -3,3 +3,4 @@
 zephyr_library()
 
 zephyr_library_sources_ifdef(CONFIG_SQN_HWSPINLOCK sqn_hwspinlock.c)
+zephyr_library_sources_ifdef(CONFIG_HWSPINLOCK_TEST hwspinlock_test.c)

drivers/hwspinlock/Kconfig

@@ -21,5 +21,6 @@ config HWSPINLOCK_INIT_PRIORITY
 	  HW spinlock driver device initialization priority.
 
 source "drivers/hwspinlock/Kconfig.sqn"
+source "drivers/hwspinlock/Kconfig.test"
 
 endif

drivers/hwspinlock/Kconfig.test

@@ -0,0 +1,6 @@
+# Copyright (c) 2025 Analog Devices, Inc.
+# SPDX-License-Identifier: Apache-2.0
+#
+config HWSPINLOCK_TEST
+	def_bool DT_HAS_VND_HWSPINLOCK_ENABLED
+	depends on DT_HAS_VND_HWSPINLOCK_ENABLED

drivers/hwspinlock/hwspinlock_test.c

@@ -0,0 +1,36 @@
+/*
+ * Copyright (c) 2025 Analog Devices, Inc.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include <zephyr/kernel.h>
+#include <zephyr/drivers/hwspinlock.h>
+
+#define DT_DRV_COMPAT vnd_hwspinlock
+
+static void vnd_hwspinlock_lock(const struct device *dev, uint32_t id)
+{
+}
+
+static void vnd_hwspinlock_unlock(const struct device *dev, uint32_t id)
+{
+}
+
+static uint32_t vnd_hwspinlock_get_max_id(const struct device *dev)
+{
+	return 0;
+}
+
+static DEVICE_API(hwspinlock, vnd_hwspinlock_api) = {
+	.lock = vnd_hwspinlock_lock,
+	.unlock = vnd_hwspinlock_unlock,
+	.get_max_id = vnd_hwspinlock_get_max_id,
+};
+
+#define VND_HWSPINLOCK_INIT(idx)					\
+	DEVICE_DT_INST_DEFINE(idx, NULL, NULL, NULL, NULL, POST_KERNEL,	\
+			      CONFIG_HWSPINLOCK_INIT_PRIORITY,		\
+			      &vnd_hwspinlock_api)
+
+DT_INST_FOREACH_STATUS_OKAY(VND_HWSPINLOCK_INIT);

dts/bindings/test/vnd,hwspinlock-device.yaml

@@ -0,0 +1,12 @@
+# Copyright (c) 2025 Analog Devices, Inc.
+# SPDX-License-Identifier: Apache-2.0
+
+description: Test hardware spinlock device node
+
+compatible: "vnd,hwspinlock-device"
+
+include: base.yaml
+
+properties:
+  hwlocks:
+    required: true

dts/bindings/test/vnd,hwspinlock.yaml

@@ -0,0 +1,11 @@
+# Copyright (c) 2025 Analog Devices, Inc.
+# SPDX-License-Identifier: Apache-2.0
+
+description: Test hardware spinlock node
+
+compatible: "vnd,hwspinlock"
+
+include: [base.yaml, hwspinlock-controller.yaml]
+
+hwlock-cells:
+  - id

tests/drivers/hwspinlock/dt_spec/CMakeLists.txt

@@ -0,0 +1,10 @@
+# Copyright (c) 2025 Analog Devices, Inc.
+# SPDX-License-Identifier: Apache-2.0
+
+cmake_minimum_required(VERSION 3.20.0)
+
+find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})
+project(spi_dt_spec)
+
+FILE(GLOB app_sources src/*.c)
+target_sources(app PRIVATE ${app_sources})

tests/drivers/hwspinlock/dt_spec/app.overlay

@@ -0,0 +1,23 @@
+/*
+ * Copyright (c) 2025 Analog Devices, Inc.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ */
+
+/ {
+	test {
+		test_hwspinlock: hwspinlock {
+			compatible = "vnd,hwspinlock";
+			#hwlock-cells = <1>;
+			status = "okay";
+		};
+
+		test_hwspinlock_dev: hwspinlock-dev {
+			compatible = "vnd,hwspinlock-device";
+			hwlocks = <&test_hwspinlock 1>, <&test_hwspinlock 2>;
+			hwlock-names = "rd", "wr";
+			status = "okay";
+		};
+	};
+};

tests/drivers/hwspinlock/dt_spec/prj.conf

@@ -0,0 +1,5 @@
+# Copyright (c) 2025 Analog Devices, Inc.
+# SPDX-License-Identifier: Apache-2.0
+
+CONFIG_ZTEST=y
+CONFIG_HWSPINLOCK=y

tests/drivers/hwspinlock/dt_spec/src/main.c

@@ -0,0 +1,45 @@
+/*
+ * Copyright (c) 2025 Analog Devices, Inc.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include <zephyr/ztest.h>
+#include <zephyr/devicetree.h>
+#include <zephyr/device.h>
+#include <zephyr/drivers/hwspinlock.h>
+
+#define TEST_HWSPINLOCK \
+	DT_NODELABEL(test_hwspinlock)
+
+#define TEST_HWSPINLOCK_DEV \
+	DT_NODELABEL(test_hwspinlock_dev)
+
+#define HWSPINLOCK_BY_IDX(node_id, prop, idx) \
+	HWSPINLOCK_DT_SPEC_GET_BY_IDX(node_id, idx)
+
+static const struct hwspinlock_dt_spec spec[] = {
+	DT_FOREACH_PROP_ELEM_SEP(TEST_HWSPINLOCK_DEV, hwlocks, HWSPINLOCK_BY_IDX, (,))
+};
+
+static const struct hwspinlock_dt_spec rd =
+	HWSPINLOCK_DT_SPEC_GET_BY_NAME(TEST_HWSPINLOCK_DEV, rd);
+
+static const struct hwspinlock_dt_spec wr =
+	HWSPINLOCK_DT_SPEC_GET_BY_NAME(TEST_HWSPINLOCK_DEV, wr);
+
+ZTEST(hwspinlock_dt_spec, test_dt_spec)
+{
+	for (int i = 0; i < ARRAY_SIZE(spec); i++) {
+		zassert_equal(spec[i].dev, DEVICE_DT_GET(TEST_HWSPINLOCK));
+		zassert_equal(spec[i].id, i + 1);
+	}
+
+	zassert_equal(rd.dev, DEVICE_DT_GET(TEST_HWSPINLOCK));
+	zassert_equal(rd.id, 1);
+
+	zassert_equal(wr.dev, DEVICE_DT_GET(TEST_HWSPINLOCK));
+	zassert_equal(wr.id, 2);
+}
+
+ZTEST_SUITE(hwspinlock_dt_spec, NULL, NULL, NULL, NULL, NULL);