drivers: comparator: add fake comparator

Add fake comparator driver and bindings for use with testing.

Signed-off-by: Bjarki Arge Andreasen <[email protected]>

Author: bjarki-andreasen

drivers/comparator/CMakeLists.txt

@@ -6,6 +6,7 @@ zephyr_syscall_header(${ZEPHYR_BASE}/include/zephyr/drivers/comparator.h)
 zephyr_library()
 
 zephyr_library_sources_ifdef(CONFIG_USERSPACE comparator_handlers.c)
+zephyr_library_sources_ifdef(CONFIG_COMPARATOR_FAKE_COMP comparator_fake_comp.c)
 zephyr_library_sources_ifdef(CONFIG_COMPARATOR_MCUX_ACMP comparator_mcux_acmp.c)
 zephyr_library_sources_ifdef(CONFIG_COMPARATOR_NRF_COMP comparator_nrf_comp.c)
 zephyr_library_sources_ifdef(CONFIG_COMPARATOR_NRF_LPCOMP comparator_nrf_lpcomp.c)

drivers/comparator/Kconfig

@@ -18,6 +18,7 @@ config COMPARATOR_INIT_PRIORITY
 	help
 	  Comparator device driver initialization priority.
 
+rsource "Kconfig.fake_comp"
 rsource "Kconfig.mcux_acmp"
 rsource "Kconfig.nrf_comp"
 rsource "Kconfig.nrf_lpcomp"

drivers/comparator/Kconfig.fake_comp

@@ -0,0 +1,8 @@
+# Copyright (c) 2024 Nordic Semiconductor ASA
+# SPDX-License-Identifier: Apache-2.0
+
+config COMPARATOR_FAKE_COMP
+	bool "Fake comparator driver"
+	default y
+	depends on DT_HAS_ZEPHYR_FAKE_COMP_ENABLED
+	depends on ZTEST

drivers/comparator/comparator_fake_comp.c

@@ -0,0 +1,65 @@
+/*
+ * Copyright (c) 2024 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include <zephyr/drivers/comparator/fake_comp.h>
+
+#ifdef CONFIG_ZTEST
+#include <zephyr/ztest.h>
+#endif
+
+#define DT_DRV_COMPAT zephyr_fake_comp
+
+DEFINE_FAKE_VALUE_FUNC(int,
+		       comp_fake_comp_get_output,
+		       const struct device *);
+
+DEFINE_FAKE_VALUE_FUNC(int,
+		       comp_fake_comp_set_trigger,
+		       const struct device *,
+		       enum comparator_trigger);
+
+DEFINE_FAKE_VALUE_FUNC(int,
+		       comp_fake_comp_set_trigger_callback,
+		       const struct device *,
+		       comparator_callback_t,
+		       void *);
+
+DEFINE_FAKE_VALUE_FUNC(int,
+		       comp_fake_comp_trigger_is_pending,
+		       const struct device *);
+
+static const struct comparator_driver_api fake_comp_api = {
+	.get_output = comp_fake_comp_get_output,
+	.set_trigger = comp_fake_comp_set_trigger,
+	.set_trigger_callback = comp_fake_comp_set_trigger_callback,
+	.trigger_is_pending = comp_fake_comp_trigger_is_pending,
+};
+
+#ifdef CONFIG_ZTEST
+static void fake_comp_reset_rule_before(const struct ztest_unit_test *test, void *fixture)
+{
+	ARG_UNUSED(test);
+	ARG_UNUSED(fixture);
+
+	RESET_FAKE(comp_fake_comp_get_output);
+	RESET_FAKE(comp_fake_comp_set_trigger);
+	RESET_FAKE(comp_fake_comp_set_trigger_callback);
+	RESET_FAKE(comp_fake_comp_trigger_is_pending);
+}
+
+ZTEST_RULE(comp_fake_comp_reset_rule, fake_comp_reset_rule_before, NULL);
+#endif
+
+DEVICE_DT_INST_DEFINE(
+	0,
+	NULL,
+	NULL,
+	NULL,
+	NULL,
+	POST_KERNEL,
+	CONFIG_COMPARATOR_INIT_PRIORITY,
+	&fake_comp_api
+);

dts/bindings/comparator/zephyr,comp-fake.yaml

@@ -0,0 +1,8 @@
+# Copyright (c) 2024 Nordic Semiconductor ASA
+# SPDX-License-Identifier: Apache-2.0
+
+description: Fake comparator device used as stub or mock for testing
+
+compatible: "zephyr,fake-comp"
+
+include: base.yaml

include/zephyr/drivers/comparator/fake_comp.h

@@ -0,0 +1,40 @@
+/*
+ * Copyright (c) 2024 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef ZEPHYR_INCLUDE_DRIVERS_COMPARATOR_FAKE_H_
+#define ZEPHYR_INCLUDE_DRIVERS_COMPARATOR_FAKE_H_
+
+#include <zephyr/drivers/comparator.h>
+#include <zephyr/fff.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+DECLARE_FAKE_VALUE_FUNC(int,
+			comp_fake_comp_get_output,
+			const struct device *);
+
+DECLARE_FAKE_VALUE_FUNC(int,
+			comp_fake_comp_set_trigger,
+			const struct device *,
+			enum comparator_trigger);
+
+DECLARE_FAKE_VALUE_FUNC(int,
+			comp_fake_comp_set_trigger_callback,
+			const struct device *,
+			comparator_callback_t,
+			void *);
+
+DECLARE_FAKE_VALUE_FUNC(int,
+			comp_fake_comp_trigger_is_pending,
+			const struct device *);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* ZEPHYR_INCLUDE_DRIVERS_COMPARATOR_FAKE_H_ */