2023-05-11 14:27:16

by Marco Pagani

Subject: [RFC PATCH v5 3/4] fpga: add fake FPGA region

Add fake FPGA region platform driver with support functions. This module
is part of the KUnit tests for the FPGA subsystem.

Signed-off-by: Marco Pagani <[email protected]>
---
drivers/fpga/tests/fake-fpga-region.c | 245 ++++++++++++++++++++++++++
drivers/fpga/tests/fake-fpga-region.h | 40 +++++
2 files changed, 285 insertions(+)
create mode 100644 drivers/fpga/tests/fake-fpga-region.c
create mode 100644 drivers/fpga/tests/fake-fpga-region.h

diff --git a/drivers/fpga/tests/fake-fpga-region.c b/drivers/fpga/tests/fake-fpga-region.c
new file mode 100644
index 000000000000..020c3ad13812
--- /dev/null
+++ b/drivers/fpga/tests/fake-fpga-region.c
@@ -0,0 +1,245 @@
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * Driver for the fake FPGA region
+ *
+ * Copyright (C) 2023 Red Hat, Inc.
+ *
+ * Author: Marco Pagani <[email protected]>
+ */
+
+#include <linux/device.h>
+#include <linux/list.h>
+#include <linux/platform_device.h>
+#include <linux/fpga/fpga-mgr.h>
+#include <linux/fpga/fpga-region.h>
+#include <linux/fpga/fpga-bridge.h>
+#include <kunit/test.h>
+
+#include "fake-fpga-region.h"
+
+#define FAKE_FPGA_REGION_DEV_NAME "fake_fpga_region"
+
+struct fake_region_pdata {
+ struct kunit *test;
+ struct fpga_manager *mgr;
+};
+
+struct bridge_elem {
+ struct fpga_bridge *bridge;
+ struct list_head node;
+};
+
+struct fake_region_priv {
+ struct list_head bridge_list;
+ struct fake_region_pdata *pdata;
+};
+
+/**
+ * fake_fpga_region_register() - register a fake FPGA region.
+ * @mgr: associated FPGA manager.
+ * @parent: parent device.
+ * @test: KUnit test context object.
+ *
+ * Return: pointer to a new fake FPGA region on success, an ERR_PTR() encoded
+ * error code on failure.
+ */
+struct fake_fpga_region *
+fake_fpga_region_register(struct kunit *test, struct fpga_manager *mgr,
+ struct device *parent)
+{
+ struct fake_fpga_region *region_ctx;
+ struct fake_region_pdata pdata;
+ int ret;
+
+ region_ctx = kunit_kzalloc(test, sizeof(*region_ctx), GFP_KERNEL);
+ if (!region_ctx) {
+ ret = -ENOMEM;
+ goto err_mem;
+ }
+
+ region_ctx->pdev = platform_device_alloc(FAKE_FPGA_REGION_DEV_NAME,
+ PLATFORM_DEVID_AUTO);
+ if (!region_ctx->pdev) {
+ pr_err("Fake FPGA region device allocation failed\n");
+ ret = -ENOMEM;
+ goto err_mem;
+ }
+
+ pdata.mgr = mgr;
+ pdata.test = test;
+ platform_device_add_data(region_ctx->pdev, &pdata, sizeof(pdata));
+
+ region_ctx->pdev->dev.parent = parent;
+ ret = platform_device_add(region_ctx->pdev);
+ if (ret) {
+ pr_err("Fake FPGA region device add failed\n");
+ goto err_pdev;
+ }
+
+ region_ctx->region = platform_get_drvdata(region_ctx->pdev);
+
+ kunit_info(test, "Fake FPGA region %u: registered\n",
+ region_ctx->region->dev.id);
+
+ return region_ctx;
+
+err_pdev:
+ platform_device_put(region_ctx->pdev);
+err_mem:
+ return ERR_PTR(ret);
+}
+EXPORT_SYMBOL_GPL(fake_fpga_region_register);
+
+/**
+ * fake_fpga_region_unregister() - unregister a fake FPGA region.
+ * @region_ctx: fake FPGA region context data structure.
+ */
+void fake_fpga_region_unregister(struct fake_fpga_region *region_ctx)
+{
+ struct fake_region_priv *priv;
+ struct kunit *test;
+ u32 id;
+
+ if (!region_ctx)
+ return;
+
+ id = region_ctx->region->dev.id;
+ priv = region_ctx->region->priv;
+ test = priv->pdata->test;
+
+ platform_device_unregister(region_ctx->pdev);
+
+ kunit_info(test, "Fake FPGA region %u: unregistered\n", id);
+}
+EXPORT_SYMBOL_GPL(fake_fpga_region_unregister);
+
+/**
+ * fake_fpga_region_add_bridge() - add a bridge to a fake FPGA region.
+ * @region_ctx: fake FPGA region context data structure.
+ * @bridge: FPGA bridge.
+ *
+ * Return: 0 if registration succeeded, an error code otherwise.
+ */
+int fake_fpga_region_add_bridge(struct fake_fpga_region *region_ctx,
+ struct fpga_bridge *bridge)
+{
+ struct fake_region_priv *priv;
+ struct bridge_elem *elem;
+
+ priv = region_ctx->region->priv;
+
+ elem = devm_kzalloc(&region_ctx->pdev->dev, sizeof(*elem), GFP_KERNEL);
+ if (!elem)
+ return -ENOMEM;
+
+ /* Add bridge to the list of bridges in the private context */
+ elem->bridge = bridge;
+ list_add(&elem->node, &priv->bridge_list);
+
+ kunit_info(priv->pdata->test, "Bridge: %u added to fake FPGA region: %u\n",
+ bridge->dev.id, region_ctx->region->dev.id);
+
+ return 0;
+}
+EXPORT_SYMBOL_GPL(fake_fpga_region_add_bridge);
+
+int fake_fpga_region_program(struct fake_fpga_region *region_ctx)
+{
+ int ret;
+
+ ret = fpga_region_program_fpga(region_ctx->region);
+
+ /* fpga_region_program_fpga() already puts the bridges in case of errors */
+ if (!ret)
+ fpga_bridges_put(&region_ctx->region->bridge_list);
+
+ return ret;
+}
+EXPORT_SYMBOL_GPL(fake_fpga_region_program);
+
+static int fake_region_get_bridges(struct fpga_region *region)
+{
+ struct fake_region_priv *priv;
+ struct bridge_elem *elem;
+ int ret;
+
+ priv = region->priv;
+
+ /* Copy the list of bridges from the private context to the region */
+ list_for_each_entry(elem, &priv->bridge_list, node) {
+ ret = fpga_bridge_get_to_list(elem->bridge->dev.parent,
+ region->info,
+ &region->bridge_list);
+ if (ret)
+ break;
+ }
+
+ return ret;
+}
+
+static int fake_fpga_region_probe(struct platform_device *pdev)
+{
+ struct device *dev;
+ struct fpga_region *region;
+ struct fpga_manager *mgr;
+ struct fake_region_pdata *pdata;
+ struct fake_region_priv *priv;
+ struct fpga_region_info info;
+
+ dev = &pdev->dev;
+ pdata = dev_get_platdata(dev);
+
+ if (!pdata) {
+ dev_err(&pdev->dev, "Fake FPGA region probe: missing platform data\n");
+ return -EINVAL;
+ }
+
+ priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
+ if (!priv)
+ return -ENOMEM;
+
+ mgr = fpga_mgr_get(pdata->mgr->dev.parent);
+ if (IS_ERR(mgr))
+ return PTR_ERR(mgr);
+
+ priv->pdata = pdata;
+ INIT_LIST_HEAD(&priv->bridge_list);
+
+ memset(&info, 0, sizeof(info));
+ info.priv = priv;
+ info.mgr = mgr;
+ info.get_bridges = fake_region_get_bridges;
+
+ region = fpga_region_register_full(dev, &info);
+ if (IS_ERR(region)) {
+ fpga_mgr_put(mgr);
+ return PTR_ERR(region);
+ }
+
+ platform_set_drvdata(pdev, region);
+
+ return 0;
+}
+
+static int fake_fpga_region_remove(struct platform_device *pdev)
+{
+ struct fpga_region *region = platform_get_drvdata(pdev);
+ struct fpga_manager *mgr = region->mgr;
+
+ fpga_mgr_put(mgr);
+ fpga_region_unregister(region);
+
+ return 0;
+}
+
+static struct platform_driver fake_fpga_region_drv = {
+ .driver = {
+ .name = FAKE_FPGA_REGION_DEV_NAME
+ },
+ .probe = fake_fpga_region_probe,
+ .remove = fake_fpga_region_remove,
+};
+
+module_platform_driver(fake_fpga_region_drv);
+
+MODULE_LICENSE("GPL");
diff --git a/drivers/fpga/tests/fake-fpga-region.h b/drivers/fpga/tests/fake-fpga-region.h
new file mode 100644
index 000000000000..c72992cbb218
--- /dev/null
+++ b/drivers/fpga/tests/fake-fpga-region.h
@@ -0,0 +1,40 @@
+/* SPDX-License-Identifier: GPL-2.0 */
+/*
+ * Header file for the fake FPGA region
+ *
+ * Copyright (C) 2023 Red Hat, Inc.
+ *
+ * Author: Marco Pagani <[email protected]>
+ */
+
+#ifndef __FPGA_FAKE_RGN_H
+#define __FPGA_FAKE_RGN_H
+
+#include <linux/platform_device.h>
+#include <kunit/test.h>
+#include <linux/fpga/fpga-mgr.h>
+#include <linux/fpga/fpga-bridge.h>
+
+/**
+ * struct fake_fpga_region - fake FPGA region context data structure
+ *
+ * @region: FPGA region.
+ * @pdev: platform device of the FPGA region.
+ */
+struct fake_fpga_region {
+ struct fpga_region *region;
+ struct platform_device *pdev;
+};
+
+struct fake_fpga_region *
+fake_fpga_region_register(struct kunit *test, struct fpga_manager *mgr,
+ struct device *parent);
+
+int fake_fpga_region_add_bridge(struct fake_fpga_region *region_ctx,
+ struct fpga_bridge *bridge);
+
+int fake_fpga_region_program(struct fake_fpga_region *region_ctx);
+
+void fake_fpga_region_unregister(struct fake_fpga_region *region_ctx);
+
+#endif /* __FPGA_FAKE_RGN_H */
--
2.40.1

2023-05-13 08:18:40

by Xu Yilun

Subject: Re: [RFC PATCH v5 3/4] fpga: add fake FPGA region

On 2023-05-11 at 16:19:21 +0200, Marco Pagani wrote:
> Add fake FPGA region platform driver with support functions. This module
> is part of the KUnit tests for the FPGA subsystem.
>
> Signed-off-by: Marco Pagani <[email protected]>
> ---
> drivers/fpga/tests/fake-fpga-region.c | 245 ++++++++++++++++++++++++++
> drivers/fpga/tests/fake-fpga-region.h | 40 +++++
> 2 files changed, 285 insertions(+)
> create mode 100644 drivers/fpga/tests/fake-fpga-region.c
> create mode 100644 drivers/fpga/tests/fake-fpga-region.h
>
> diff --git a/drivers/fpga/tests/fake-fpga-region.c b/drivers/fpga/tests/fake-fpga-region.c
> new file mode 100644
> index 000000000000..020c3ad13812
> --- /dev/null
> +++ b/drivers/fpga/tests/fake-fpga-region.c
> @@ -0,0 +1,245 @@
> +// SPDX-License-Identifier: GPL-2.0
> +/*
> + * Driver for the fake FPGA region
> + *
> + * Copyright (C) 2023 Red Hat, Inc.
> + *
> + * Author: Marco Pagani <[email protected]>
> + */
> +
> +#include <linux/device.h>
> +#include <linux/list.h>
> +#include <linux/platform_device.h>
> +#include <linux/fpga/fpga-mgr.h>
> +#include <linux/fpga/fpga-region.h>
> +#include <linux/fpga/fpga-bridge.h>
> +#include <kunit/test.h>
> +
> +#include "fake-fpga-region.h"
> +
> +#define FAKE_FPGA_REGION_DEV_NAME "fake_fpga_region"
> +
> +struct fake_region_pdata {
> + struct kunit *test;
> + struct fpga_manager *mgr;
> +};
> +
> +struct bridge_elem {
> + struct fpga_bridge *bridge;
> + struct list_head node;
> +};
> +
> +struct fake_region_priv {
> + struct list_head bridge_list;
> + struct fake_region_pdata *pdata;
> +};
> +
> +/**
> + * fake_fpga_region_register() - register a fake FPGA region.
> + * @mgr: associated FPGA manager.
> + * @parent: parent device.
> + * @test: KUnit test context object.
> + *
> + * Return: pointer to a new fake FPGA region on success, an ERR_PTR() encoded
> + * error code on failure.
> + */
> +struct fake_fpga_region *
> +fake_fpga_region_register(struct kunit *test, struct fpga_manager *mgr,
> + struct device *parent)
> +{
> + struct fake_fpga_region *region_ctx;
> + struct fake_region_pdata pdata;
> + int ret;
> +
> + region_ctx = kunit_kzalloc(test, sizeof(*region_ctx), GFP_KERNEL);
> + if (!region_ctx) {
> + ret = -ENOMEM;
> + goto err_mem;
> + }
> +
> + region_ctx->pdev = platform_device_alloc(FAKE_FPGA_REGION_DEV_NAME,
> + PLATFORM_DEVID_AUTO);
> + if (!region_ctx->pdev) {
> + pr_err("Fake FPGA region device allocation failed\n");
> + ret = -ENOMEM;
> + goto err_mem;
> + }
> +
> + pdata.mgr = mgr;
> + pdata.test = test;
> + platform_device_add_data(region_ctx->pdev, &pdata, sizeof(pdata));
> +
> + region_ctx->pdev->dev.parent = parent;
> + ret = platform_device_add(region_ctx->pdev);
> + if (ret) {
> + pr_err("Fake FPGA region device add failed\n");
> + goto err_pdev;
> + }
> +
> + region_ctx->region = platform_get_drvdata(region_ctx->pdev);
> +
> + kunit_info(test, "Fake FPGA region %u: registered\n",
> + region_ctx->region->dev.id);
> +
> + return region_ctx;
> +
> +err_pdev:
> + platform_device_put(region_ctx->pdev);
> +err_mem:
> + return ERR_PTR(ret);
> +}
> +EXPORT_SYMBOL_GPL(fake_fpga_region_register);

Same as fake_fpga_mgr, move it to fpga-test? Same as below exported
functions.

> +
> +/**
> + * fake_fpga_region_unregister() - unregister a fake FPGA region.
> + * @region_ctx: fake FPGA region context data structure.
> + */
> +void fake_fpga_region_unregister(struct fake_fpga_region *region_ctx)
> +{
> + struct fake_region_priv *priv;
> + struct kunit *test;
> + u32 id;
> +
> + if (!region_ctx)
> + return;
> +
> + id = region_ctx->region->dev.id;
> + priv = region_ctx->region->priv;
> + test = priv->pdata->test;
> +
> + platform_device_unregister(region_ctx->pdev);
> +
> + kunit_info(test, "Fake FPGA region %u: unregistered\n", id);
> +}
> +EXPORT_SYMBOL_GPL(fake_fpga_region_unregister);
> +
> +/**
> + * fake_fpga_region_add_bridge() - add a bridge to a fake FPGA region.
> + * @region_ctx: fake FPGA region context data structure.
> + * @bridge: FPGA bridge.
> + *
> + * Return: 0 if registration succeeded, an error code otherwise.
> + */
> +int fake_fpga_region_add_bridge(struct fake_fpga_region *region_ctx,
> + struct fpga_bridge *bridge)
> +{
> + struct fake_region_priv *priv;
> + struct bridge_elem *elem;
> +
> + priv = region_ctx->region->priv;
> +
> + elem = devm_kzalloc(&region_ctx->pdev->dev, sizeof(*elem), GFP_KERNEL);
> + if (!elem)
> + return -ENOMEM;
> +
> + /* Add bridge to the list of bridges in the private context */
> + elem->bridge = bridge;
> + list_add(&elem->node, &priv->bridge_list);
> +
> + kunit_info(priv->pdata->test, "Bridge: %u added to fake FPGA region: %u\n",
> + bridge->dev.id, region_ctx->region->dev.id);
> +
> + return 0;
> +}
> +EXPORT_SYMBOL_GPL(fake_fpga_region_add_bridge);

I remember in previous version we are going to provide the bridges in
platform data.

> +
> +int fake_fpga_region_program(struct fake_fpga_region *region_ctx)
> +{
> + int ret;
> +
> + ret = fpga_region_program_fpga(region_ctx->region);
> +
> + /* fpga_region_program_fpga() already puts the bridges in case of errors */
> + if (!ret)
> + fpga_bridges_put(&region_ctx->region->bridge_list);
> +
> + return ret;
> +}
> +EXPORT_SYMBOL_GPL(fake_fpga_region_program);

Move it to fpga-test if possible. Maintain all the region/mgr/bridge_ctx
in fpga_test.

Thanks,
Yilun

> +
> +static int fake_region_get_bridges(struct fpga_region *region)
> +{
> + struct fake_region_priv *priv;
> + struct bridge_elem *elem;
> + int ret;
> +
> + priv = region->priv;
> +
> + /* Copy the list of bridges from the private context to the region */
> + list_for_each_entry(elem, &priv->bridge_list, node) {
> + ret = fpga_bridge_get_to_list(elem->bridge->dev.parent,
> + region->info,
> + &region->bridge_list);
> + if (ret)
> + break;
> + }
> +
> + return ret;
> +}
> +
> +static int fake_fpga_region_probe(struct platform_device *pdev)
> +{
> + struct device *dev;
> + struct fpga_region *region;
> + struct fpga_manager *mgr;
> + struct fake_region_pdata *pdata;
> + struct fake_region_priv *priv;
> + struct fpga_region_info info;
> +
> + dev = &pdev->dev;
> + pdata = dev_get_platdata(dev);
> +
> + if (!pdata) {
> + dev_err(&pdev->dev, "Fake FPGA region probe: missing platform data\n");
> + return -EINVAL;
> + }
> +
> + priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
> + if (!priv)
> + return -ENOMEM;
> +
> + mgr = fpga_mgr_get(pdata->mgr->dev.parent);
> + if (IS_ERR(mgr))
> + return PTR_ERR(mgr);
> +
> + priv->pdata = pdata;
> + INIT_LIST_HEAD(&priv->bridge_list);
> +
> + memset(&info, 0, sizeof(info));
> + info.priv = priv;
> + info.mgr = mgr;
> + info.get_bridges = fake_region_get_bridges;
> +
> + region = fpga_region_register_full(dev, &info);
> + if (IS_ERR(region)) {
> + fpga_mgr_put(mgr);
> + return PTR_ERR(region);
> + }
> +
> + platform_set_drvdata(pdev, region);
> +
> + return 0;
> +}
> +
> +static int fake_fpga_region_remove(struct platform_device *pdev)
> +{
> + struct fpga_region *region = platform_get_drvdata(pdev);
> + struct fpga_manager *mgr = region->mgr;
> +
> + fpga_mgr_put(mgr);
> + fpga_region_unregister(region);
> +
> + return 0;
> +}
> +
> +static struct platform_driver fake_fpga_region_drv = {
> + .driver = {
> + .name = FAKE_FPGA_REGION_DEV_NAME
> + },
> + .probe = fake_fpga_region_probe,
> + .remove = fake_fpga_region_remove,
> +};
> +
> +module_platform_driver(fake_fpga_region_drv);
> +
> +MODULE_LICENSE("GPL");
> diff --git a/drivers/fpga/tests/fake-fpga-region.h b/drivers/fpga/tests/fake-fpga-region.h
> new file mode 100644
> index 000000000000..c72992cbb218
> --- /dev/null
> +++ b/drivers/fpga/tests/fake-fpga-region.h
> @@ -0,0 +1,40 @@
> +/* SPDX-License-Identifier: GPL-2.0 */
> +/*
> + * Header file for the fake FPGA region
> + *
> + * Copyright (C) 2023 Red Hat, Inc.
> + *
> + * Author: Marco Pagani <[email protected]>
> + */
> +
> +#ifndef __FPGA_FAKE_RGN_H
> +#define __FPGA_FAKE_RGN_H
> +
> +#include <linux/platform_device.h>
> +#include <kunit/test.h>
> +#include <linux/fpga/fpga-mgr.h>
> +#include <linux/fpga/fpga-bridge.h>
> +
> +/**
> + * struct fake_fpga_region - fake FPGA region context data structure
> + *
> + * @region: FPGA region.
> + * @pdev: platform device of the FPGA region.
> + */
> +struct fake_fpga_region {
> + struct fpga_region *region;
> + struct platform_device *pdev;
> +};
> +
> +struct fake_fpga_region *
> +fake_fpga_region_register(struct kunit *test, struct fpga_manager *mgr,
> + struct device *parent);
> +
> +int fake_fpga_region_add_bridge(struct fake_fpga_region *region_ctx,
> + struct fpga_bridge *bridge);
> +
> +int fake_fpga_region_program(struct fake_fpga_region *region_ctx);
> +
> +void fake_fpga_region_unregister(struct fake_fpga_region *region_ctx);
> +
> +#endif /* __FPGA_FAKE_RGN_H */
> --
> 2.40.1
>