[PATCH v3 5/9] drm/xe/kunit: Define helper functions to allocate mock device

[Michal Wajdeczko <michal.wajdeczko@intel.com>]

There will be more KUnit tests added that will require mock device.
Define generic helper functions to avoid code duplications.

Signed-off-by: Michal Wajdeczko <michal.wajdeczko@intel.com>
Cc: Lucas De Marchi <lucas.demarchi@intel.com>
---
 drivers/gpu/drm/xe/Makefile                 |  3 +
 drivers/gpu/drm/xe/tests/xe_kunit_helpers.c | 85 +++++++++++++++++++++
 drivers/gpu/drm/xe/tests/xe_kunit_helpers.h | 19 +++++
 3 files changed, 107 insertions(+)
 create mode 100644 drivers/gpu/drm/xe/tests/xe_kunit_helpers.c
 create mode 100644 drivers/gpu/drm/xe/tests/xe_kunit_helpers.h

diff --git a/drivers/gpu/drm/xe/Makefile b/drivers/gpu/drm/xe/Makefile
index 0c2e247dc188..14857923d217 100644
--- a/drivers/gpu/drm/xe/Makefile
+++ b/drivers/gpu/drm/xe/Makefile
@@ -145,6 +145,9 @@ xe-$(CONFIG_PCI_IOV) += \
 	xe_lmtt_2l.o \
 	xe_lmtt_ml.o
 
+xe-$(CONFIG_DRM_XE_KUNIT_TEST) += \
+	tests/xe_kunit_helpers.o
+
 # i915 Display compat #defines and #includes
 subdir-ccflags-$(CONFIG_DRM_XE_DISPLAY) += \
 	-I$(srctree)/$(src)/display/ext \
diff --git a/drivers/gpu/drm/xe/tests/xe_kunit_helpers.c b/drivers/gpu/drm/xe/tests/xe_kunit_helpers.c
new file mode 100644
index 000000000000..236f24d3ca17
--- /dev/null
+++ b/drivers/gpu/drm/xe/tests/xe_kunit_helpers.c
@@ -0,0 +1,85 @@
+// SPDX-License-Identifier: GPL-2.0 AND MIT
+/*
+ * Copyright © 2023 Intel Corporation
+ */
+
+#include <kunit/test.h>
+#include <kunit/static_stub.h>
+#include <kunit/visibility.h>
+
+#include <drm/drm_drv.h>
+#include <drm/drm_kunit_helpers.h>
+
+#include "tests/xe_kunit_helpers.h"
+#include "tests/xe_pci_test.h"
+#include "xe_device_types.h"
+
+/**
+ * __xe_kunit_helper_alloc_xe_device - Allocate a mock &xe_device for a KUnit test
+ * @test: the &kunit where this &xe_device will be used
+ * @data: the &xe_pci_fake_data with desired variant of the mock device (optional)
+ *
+ * This function creates a &xe_device based on parameters from @data.
+ * This allocation is managed. See drm_kunit_helper_alloc_device() and
+ * drm_kunit_helper_alloc_drm_device() for details.
+ *
+ * Return: A pointer to mock &xe_device described by &data
+ */
+struct xe_device *__xe_kunit_helper_alloc_xe_device(struct kunit *test,
+						    struct xe_pci_fake_data *data)
+{
+	struct xe_device *xe;
+	struct device *dev;
+	int err;
+
+	dev = drm_kunit_helper_alloc_device(test);
+	KUNIT_ASSERT_NOT_ERR_OR_NULL(test, dev);
+
+	xe = drm_kunit_helper_alloc_drm_device(test, dev,
+					       struct xe_device,
+					       drm, DRIVER_GEM);
+	KUNIT_ASSERT_NOT_ERR_OR_NULL(test, xe);
+
+	test->priv = data;
+	err = xe_pci_fake_device_init(xe);
+	test->priv = NULL;
+	KUNIT_ASSERT_EQ(test, 0, err);
+
+	xe->drm.dev = dev;
+	return xe;
+}
+EXPORT_SYMBOL_IF_KUNIT(__xe_kunit_helper_alloc_xe_device);
+
+/**
+ * xe_kunit_helper_alloc_xe_device - Allocate a mock &xe_device for KUnit test.
+ * @test: the &kunit where this &xe_device will be used
+ *
+ * See __xe_kunit_helper_alloc_xe_device() for details.
+ *
+ * Return: A pointer to default mock &xe_device.
+ */
+struct xe_device *xe_kunit_helper_alloc_xe_device(struct kunit *test)
+{
+	return __xe_kunit_helper_alloc_xe_device(test, NULL);
+}
+EXPORT_SYMBOL_IF_KUNIT(xe_kunit_helper_alloc_xe_device);
+
+/**
+ * xe_kunit_helper_xe_device_test_init - Allocate a mock &xe_device for KUnit test.
+ * @test: the &kunit where this fake &xe_device will be used
+ *
+ * This function allocates a default mock &xe_device and stores its pointer as
+ * &kunit.priv to allow test code to access it.
+ *
+ * This function can be directly used as custom implementation of &kunit_suite.init.
+ *
+ * See xe_kunit_helper_alloc_xe_device() for details.
+ *
+ * Return: Always 0.
+ */
+int xe_kunit_helper_xe_device_test_init(struct kunit *test)
+{
+	test->priv = xe_kunit_helper_alloc_xe_device(test);
+	return 0;
+}
+EXPORT_SYMBOL_IF_KUNIT(xe_kunit_helper_xe_device_test_init);
diff --git a/drivers/gpu/drm/xe/tests/xe_kunit_helpers.h b/drivers/gpu/drm/xe/tests/xe_kunit_helpers.h
new file mode 100644
index 000000000000..1bbd0a58c1b2
--- /dev/null
+++ b/drivers/gpu/drm/xe/tests/xe_kunit_helpers.h
@@ -0,0 +1,19 @@
+/* SPDX-License-Identifier: GPL-2.0 AND MIT */
+/*
+ * Copyright © 2023 Intel Corporation
+ */
+
+#ifndef _XE_KUNIT_HELPERS_H_
+#define _XE_KUNIT_HELPERS_H_
+
+struct kunit;
+struct xe_device;
+struct xe_pci_fake_data;
+
+struct xe_device *__xe_kunit_helper_alloc_xe_device(struct kunit *test,
+						    struct xe_pci_fake_data *data);
+struct xe_device *xe_kunit_helper_alloc_xe_device(struct kunit *test);
+
+int xe_kunit_helper_xe_device_test_init(struct kunit *test);
+
+#endif
-- 
2.25.1