Message-Id: <20250407074614.1665575-1-raag.jadav@intel.com>
Date: Mon,  7 Apr 2025 13:16:14 +0530
From: Raag Jadav <raag.jadav@...el.com>
To: gregkh@...uxfoundation.org,
	david.m.ertman@...el.com,
	ira.weiny@...el.com,
	lee@...nel.org,
	andriy.shevchenko@...ux.intel.com
Cc: linux-kernel@...r.kernel.org,
	Raag Jadav <raag.jadav@...el.com>
Subject: [PATCH v2] mfd: core: Support auxiliary device

Extend MFD subsystem to support auxiliary child device. This is useful
for MFD usecases where parent device is on a discoverable bus and doesn't
fit into the platform device criteria. Purpose of this implementation is
to provide discoverable MFDs just enough infrastructure to register
independent child devices with their own memory and interrupt resources
without abusing the platform device.

Current support is limited to just PCI type MFDs, but this can be further
extended to support other types like USB in the future.

Signed-off-by: Raag Jadav <raag.jadav@...el.com>
---

v2: Introduce a shared struct mfd_aux_device
    Introduce MFD_AUX_TYPE flag for auxiliary device opt-in

PS: I'm leaning towards not doing any of the ioremap or regmap on MFD
side and think that we should enforce child devices to not overlap.

If there's a need to handle common register access by parent device,
then I think it warrants its own driver which adds auxiliary devices
along with a custom interface to communicate with them, and MFD on
AUX is not the right solution for it.

Open to feedback/suggestions if it's still worth pursuing here.

 drivers/mfd/mfd-core.c   | 135 +++++++++++++++++++++++++++++++++++----
 include/linux/mfd/aux.h  |  30 +++++++++
 include/linux/mfd/core.h |   3 +
 3 files changed, 157 insertions(+), 11 deletions(-)
 create mode 100644 include/linux/mfd/aux.h

diff --git a/drivers/mfd/mfd-core.c b/drivers/mfd/mfd-core.c
index 76bd316a50af..f38b5da6637e 100644
--- a/drivers/mfd/mfd-core.c
+++ b/drivers/mfd/mfd-core.c
@@ -10,8 +10,11 @@
 #include <linux/kernel.h>
 #include <linux/platform_device.h>
 #include <linux/acpi.h>
+#include <linux/auxiliary_bus.h>
+#include <linux/pci.h>
 #include <linux/list.h>
 #include <linux/property.h>
+#include <linux/mfd/aux.h>
 #include <linux/mfd/core.h>
 #include <linux/pm_runtime.h>
 #include <linux/slab.h>
@@ -29,8 +32,15 @@ struct mfd_of_node_entry {
 	struct device_node *np;
 };
 
-static const struct device_type mfd_dev_type = {
-	.name	= "mfd_device",
+enum mfd_dev {
+	MFD_AUX_DEV,
+	MFD_PLAT_DEV,
+	MFD_MAX_DEV
+};
+
+static const struct device_type mfd_dev_type[MFD_MAX_DEV] = {
+	[MFD_AUX_DEV]	= { .name = "mfd_auxiliary_device" },
+	[MFD_PLAT_DEV]	= { .name = "mfd_platform_device" },
 };
 
 #if IS_ENABLED(CONFIG_ACPI)
@@ -136,10 +146,87 @@ static int mfd_match_of_node_to_dev(struct platform_device *pdev,
 	return 0;
 }
 
-static int mfd_add_device(struct device *parent, int id,
-			  const struct mfd_cell *cell,
-			  struct resource *mem_base,
-			  int irq_base, struct irq_domain *domain)
+static void mfd_release_auxiliary_device(struct device *dev)
+{
+	struct auxiliary_device *auxdev = to_auxiliary_dev(dev);
+	struct mfd_aux_device *mfd_aux = auxiliary_dev_to_mfd_aux_dev(auxdev);
+
+	kfree(mfd_aux);
+}
+
+static int mfd_add_auxiliary_device(struct device *parent, int id, const struct mfd_cell *cell,
+				    struct resource *mem_base, int irq_base,
+				    struct irq_domain *domain)
+{
+	struct mfd_aux_device *mfd_aux;
+	struct auxiliary_device *auxdev;
+	int r, ret;
+
+	mfd_aux = kzalloc(sizeof(*mfd_aux), GFP_KERNEL);
+	if (!mfd_aux)
+		return -ENOMEM;
+
+	for (r = 0; r < cell->num_resources; r++) {
+		/* Find out base to use */
+		if ((cell->resources[r].flags & IORESOURCE_MEM) && mem_base) {
+			mfd_aux->mem.name = cell->resources[r].name;
+			mfd_aux->mem.flags = cell->resources[r].flags;
+
+			mfd_aux->mem.parent = mem_base;
+			mfd_aux->mem.start = mem_base->start + cell->resources[r].start;
+			mfd_aux->mem.end = mem_base->start + cell->resources[r].end;
+		} else if (cell->resources[r].flags & IORESOURCE_IRQ) {
+			mfd_aux->irq.name = cell->resources[r].name;
+			mfd_aux->irq.flags = cell->resources[r].flags;
+
+			if (domain) {
+				/* Unable to create mappings for IRQ ranges */
+				WARN_ON(cell->resources[r].start != cell->resources[r].end);
+				mfd_aux->irq.start = mfd_aux->irq.end = irq_create_mapping(
+						domain, cell->resources[r].start);
+			} else {
+				mfd_aux->irq.start = irq_base + cell->resources[r].start;
+				mfd_aux->irq.end = irq_base + cell->resources[r].end;
+			}
+		} else {
+			mfd_aux->ext.name = cell->resources[r].name;
+			mfd_aux->ext.flags = cell->resources[r].flags;
+			mfd_aux->ext.parent = cell->resources[r].parent;
+			mfd_aux->ext.start = cell->resources[r].start;
+			mfd_aux->ext.end = cell->resources[r].end;
+		}
+	}
+
+	auxdev = &mfd_aux->auxdev;
+	auxdev->name = cell->name;
+	/* Use parent id for discoverable devices */
+	auxdev->id = dev_is_pci(parent) ? pci_dev_id(to_pci_dev(parent)) : cell->id;
+
+	auxdev->dev.parent = parent;
+	auxdev->dev.type = &mfd_dev_type[MFD_AUX_DEV];
+	auxdev->dev.release = mfd_release_auxiliary_device;
+
+	ret = auxiliary_device_init(auxdev);
+	if (ret)
+		goto fail_aux_init;
+
+	ret = __auxiliary_device_add(auxdev, parent->driver->name);
+	if (ret)
+		goto fail_aux_add;
+
+	return 0;
+
+fail_aux_add:
+	/* auxdev will be freed with the put_device() and .release sequence */
+	auxiliary_device_uninit(auxdev);
+fail_aux_init:
+	kfree(mfd_aux);
+	return ret;
+}
+
+static int mfd_add_platform_device(struct device *parent, int id, const struct mfd_cell *cell,
+				   struct resource *mem_base, int irq_base,
+				   struct irq_domain *domain)
 {
 	struct resource *res;
 	struct platform_device *pdev;
@@ -168,7 +255,7 @@ static int mfd_add_device(struct device *parent, int id,
 		goto fail_device;
 
 	pdev->dev.parent = parent;
-	pdev->dev.type = &mfd_dev_type;
+	pdev->dev.type = &mfd_dev_type[MFD_PLAT_DEV];
 	pdev->dev.dma_mask = parent->dma_mask;
 	pdev->dev.dma_parms = parent->dma_parms;
 	pdev->dev.coherent_dma_mask = parent->coherent_dma_mask;
@@ -302,6 +389,16 @@ static int mfd_add_device(struct device *parent, int id,
 	return ret;
 }
 
+static int mfd_add_device(struct device *parent, int id, const struct mfd_cell *cells,
+			  struct resource *mem_base, int irq_base, struct irq_domain *domain)
+{
+	/* TODO: Convert the platform device abusers and remove this flag */
+	if (dev_is_pci(parent) && id == MFD_AUX_TYPE)
+		return mfd_add_auxiliary_device(parent, id, cells, mem_base, irq_base, domain);
+	else
+		return mfd_add_platform_device(parent, id, cells, mem_base, irq_base, domain);
+}
+
 /**
  * mfd_add_devices - register child devices
  *
@@ -340,16 +437,22 @@ int mfd_add_devices(struct device *parent, int id,
 }
 EXPORT_SYMBOL(mfd_add_devices);
 
-static int mfd_remove_devices_fn(struct device *dev, void *data)
+static int mfd_remove_auxiliary_device(struct device *dev)
+{
+	struct auxiliary_device *auxdev = to_auxiliary_dev(dev);
+
+	auxiliary_device_delete(auxdev);
+	auxiliary_device_uninit(auxdev);
+	return 0;
+}
+
+static int mfd_remove_platform_device(struct device *dev, void *data)
 {
 	struct platform_device *pdev;
 	const struct mfd_cell *cell;
 	struct mfd_of_node_entry *of_entry, *tmp;
 	int *level = data;
 
-	if (dev->type != &mfd_dev_type)
-		return 0;
-
 	pdev = to_platform_device(dev);
 	cell = mfd_get_cell(pdev);
 
@@ -372,6 +475,16 @@ static int mfd_remove_devices_fn(struct device *dev, void *data)
 	return 0;
 }
 
+static int mfd_remove_devices_fn(struct device *dev, void *data)
+{
+	if (dev->type == &mfd_dev_type[MFD_AUX_DEV])
+		return mfd_remove_auxiliary_device(dev);
+	else if (dev->type == &mfd_dev_type[MFD_PLAT_DEV])
+		return mfd_remove_platform_device(dev, data);
+
+	return 0;
+}
+
 void mfd_remove_devices_late(struct device *parent)
 {
 	int level = MFD_DEP_LEVEL_HIGH;
diff --git a/include/linux/mfd/aux.h b/include/linux/mfd/aux.h
new file mode 100644
index 000000000000..ebc385203184
--- /dev/null
+++ b/include/linux/mfd/aux.h
@@ -0,0 +1,30 @@
+/* SPDX-License-Identifier: GPL-2.0-only */
+/*
+ * MFD auxiliary device
+ *
+ * Copyright (c) 2025 Raag Jadav <raag.jadav@...el.com>
+ */
+
+#ifndef MFD_AUX_H
+#define MFD_AUX_H
+
+#include <linux/auxiliary_bus.h>
+#include <linux/ioport.h>
+#include <linux/types.h>
+
+#define auxiliary_dev_to_mfd_aux_dev(auxiliary_dev) \
+	container_of(auxiliary_dev, struct mfd_aux_device, auxdev)
+
+/*
+ * Common structure between MFD parent and auxiliary child device.
+ * To be used by leaf drivers to access child device resources.
+ */
+struct mfd_aux_device {
+	struct auxiliary_device auxdev;
+	struct resource	mem;
+	struct resource	irq;
+	/* Place holder for other types */
+	struct resource	ext;
+};
+
+#endif
diff --git a/include/linux/mfd/core.h b/include/linux/mfd/core.h
index faeea7abd688..ab516fc750e0 100644
--- a/include/linux/mfd/core.h
+++ b/include/linux/mfd/core.h
@@ -12,6 +12,9 @@
 
 #include <linux/platform_device.h>
 
+/* TODO: Convert the platform device abusers and remove this flag */
+#define MFD_AUX_TYPE	INT_MIN
+
 #define MFD_RES_SIZE(arr) (sizeof(arr) / sizeof(struct resource))
 
 #define MFD_CELL_ALL(_name, _res, _pdata, _pdsize, _id, _compat, _of_reg, _use_of_reg, _match) \
-- 
2.34.1

Powered by blists - more mailing lists