Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   Colin Foster <colin.foster@in-advantage.com>
To:     devicetree@vger.kernel.org, linux-kernel@vger.kernel.org,
        netdev@vger.kernel.org, linux-arm-kernel@lists.infradead.org,
        linux-gpio@vger.kernel.org
Cc:     Vladimir Oltean <vladimir.oltean@nxp.com>,
        Lee Jones <lee.jones@linaro.org>,
        Rob Herring <robh+dt@kernel.org>,
        Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
        Andrew Lunn <andrew@lunn.ch>,
        Heiner Kallweit <hkallweit1@gmail.com>,
        Russell King <linux@armlinux.org.uk>,
        "David S. Miller" <davem@davemloft.net>,
        Eric Dumazet <edumazet@google.com>,
        Jakub Kicinski <kuba@kernel.org>,
        Paolo Abeni <pabeni@redhat.com>,
        Lars Povlsen <lars.povlsen@microchip.com>,
        Steen Hegelund <Steen.Hegelund@microchip.com>,
        UNGLinuxDriver@microchip.com,
        Linus Walleij <linus.walleij@linaro.org>,
        Wolfram Sang <wsa@kernel.org>,
        Terry Bowman <terry.bowman@amd.com>,
        Andy Shevchenko <andy.shevchenko@gmail.com>,
        katie.morris@in-advantage.com
Subject: [PATCH v13 net-next 1/9] mfd: ocelot: add helper to get regmap from a resource
Date:   Tue,  5 Jul 2022 13:47:35 -0700
Message-Id: <20220705204743.3224692-2-colin.foster@in-advantage.com>
In-Reply-To: <20220705204743.3224692-1-colin.foster@in-advantage.com>
References: <20220705204743.3224692-1-colin.foster@in-advantage.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?Hdgu1CvzX5EI/QCqSAA/HDZsJcZZ7r9NTsPSKKzEHpKsdfr9g5chGOmwTYPN?=
 =?us-ascii?Q?xRMHP9H1pkEcVlw/63Cq0M047gFGOO4A9HBd1t0KBxkUVW81U2rSBZOA8/ol?=
 =?us-ascii?Q?zPiIZPLTJZ5ysjGfTA1vQpJEuECT6hwDMjGpWoT1c1Dh+Bq8kZC5+xmjLVR/?=
 =?us-ascii?Q?wLf6gjfGuvJp+8keiEus9qslgipQClviYgGMwfLpFVwNww2r8GCYCx4RQmPj?=
 =?us-ascii?Q?cz5X/FX/qXhLe7Mlji7bll3ikAYRK3579/3kn9ELoNJnQxQKnNiZ020khDcG?=
 =?us-ascii?Q?ZlPjTvzWxfszaRmCM24bRZsYNnYnOzm7gPBpQ03tFgXMsJokquD1cMfAR0V2?=
 =?us-ascii?Q?wWDdRQPksTRQhU5Re3O9MMwz6RFn3nohmoGj3j8nJOo2QxPBhMovLzy2qAkP?=
 =?us-ascii?Q?Zfxtx0U67tIjJN1G+Gv1KnZ8MDElQ2sqs46WSeuCq4pTuoXWWCmj6NmayfNx?=
 =?us-ascii?Q?eaazA8NjyvQ8ElRf8REeJVYb4rOyCdIEPfxrOehvEzad8/heIlNziTYSI4QI?=
 =?us-ascii?Q?NTnzyRYvjQV8uvcWnl7X7m+UuxZNEwh1dSYfPsF+wkPD+Tg/EAJdtKBS5pPI?=
 =?us-ascii?Q?J4e/4WJva4/a71xrVlJyCPDOx5ZnM8GXrSgTUMvhRGPcJcQU6TtVmOZb+5C4?=
 =?us-ascii?Q?7c7yls/oNEoqG1yK98ugr+MFf/HWA7Lv7qWZGnN6dNuJ/NO7/eJFZs8/KiO/?=
 =?us-ascii?Q?+yRFGCKEgmL9FzwDaHA1S6Cq7t5zp4soJef8VGBD6P6Iam+t65AtjVih1/5O?=
 =?us-ascii?Q?gHL2xilhxtYp167PYCEGSZ2UF8h7c/DTMPYc8aVlMUpcKZpLv+BJpgpZQ1rx?=
 =?us-ascii?Q?kbD38B5G6yEKXMuVFrsyKnDG26pwKg6SwPandgQ1cEnkdP9vXCIcMRjZ+Z6N?=
 =?us-ascii?Q?YSelShpOdJtYMU1H35kaYqeeExOcg3qVCJnBedDvuN8VFjgS+lG/XtbdYsAb?=
 =?us-ascii?Q?jGIgTxZJbToMqsldIJr1TbeGK8zA2wIuwSitNQ3g45g63ZZs8IGhXNMnAPPD?=
 =?us-ascii?Q?HyFpfN4XJlgF4mS9eD4xds9EcISVCSdtE/yujVgokuYtNNlf0sAyqMXEqn5J?=
 =?us-ascii?Q?S1u9J/h7Y9lPENwY5vLsFYDKJ4HuX0YXVAOyZw2kTUipa+mhldmODoiMvBdR?=
 =?us-ascii?Q?kOqv7wdxFbZ2MrVfF6kqQdWoTGy80I9DOrnFOb8jEr4xjPSvErFOMzP/GUaI?=
 =?us-ascii?Q?xqrBRasoIl9MlZqZth1EWUDWBZ15CmcxM+BAc6nwBqOvnrmaywD6P9lYsF2H?=
 =?us-ascii?Q?E8jnm8DmHOfp4R0sdOZHDzed9C1I5Vp1ti8FULtm5HYMF5C+A/sC57uQi7FU?=
 =?us-ascii?Q?AbS1fyF2jcs/tRxxTFrjvyeoo0cNfe/DZHs1oKmdmKjm604g14k7q5FncziK?=
 =?us-ascii?Q?i+UNPzIQP2pQMhzqgheuMRP2onHxM4H3iaJHmkW9Jw63hGakeMTZ5DyE9bEo?=
 =?us-ascii?Q?XIFICAOXinaXIyJcnMnnFBT4u4gtdcm1LkWKNGtTiQq9KlyTbTwkEXhVLZLv?=
 =?us-ascii?Q?Lhd/z+3FH7+xFqZbrd1376UxqMNQPFLa0FNZYQq8hAjMHGQdS+oTjASa/f9y?=
 =?us-ascii?Q?sRfbrtqLy3+gXEgjT1zU9QlcaysDCt9nAVwIJE4fZdxqvfznaiQq1eprWOxO?=
 =?us-ascii?Q?YQ=3D=3D?=
X-OriginatorOrg: in-advantage.com
X-MS-Exchange-CrossTenant-Network-Message-Id: eb9dd48d-3723-4a9f-23ae-08da5ec7ac03
X-MS-Exchange-CrossTenant-AuthSource: MWHPR1001MB2351.namprd10.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 05 Jul 2022 20:48:10.5767
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 48e842ca-fbd8-4633-a79d-0c955a7d3aae
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: zBkaiGC75ZID4f3w5AlfK4F0u4vA3nfY/vs6U+64UE9A4ASmH2+OfQ8+W9NFwsRs5w6l3atyv5eoGXUgTge05r6qWMEBjVnYbwQAUQBfDn0=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: BL0PR10MB2898
X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,RCVD_IN_DNSWL_NONE,RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,SPF_PASS,
        T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

Several ocelot-related modules are designed for MMIO / regmaps. As such,
they often use a combination of devm_platform_get_and_ioremap_resource and
devm_regmap_init_mmio.

Operating in an MFD might be different, in that it could be memory mapped,
or it could be SPI, I2C... In these cases a fallback to use IORESOURCE_REG
instead of IORESOURCE_MEM becomes necessary.

When this happens, there's redundant logic that needs to be implemented in
every driver. In order to avoid this redundancy, utilize a single function
that, if the MFD scenario is enabled, will perform this fallback logic.

Signed-off-by: Colin Foster <colin.foster@in-advantage.com>
---
 MAINTAINERS                |  5 ++++
 include/linux/mfd/ocelot.h | 55 ++++++++++++++++++++++++++++++++++++++
 2 files changed, 60 insertions(+)
 create mode 100644 include/linux/mfd/ocelot.h

diff --git a/MAINTAINERS b/MAINTAINERS
index 28108e4fdb8f..f781caceeb38 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -14467,6 +14467,11 @@ F:	net/dsa/tag_ocelot.c
 F:	net/dsa/tag_ocelot_8021q.c
 F:	tools/testing/selftests/drivers/net/ocelot/*
 
+OCELOT EXTERNAL SWITCH CONTROL
+M:	Colin Foster <colin.foster@in-advantage.com>
+S:	Supported
+F:	include/linux/mfd/ocelot.h
+
 OCXL (Open Coherent Accelerator Processor Interface OpenCAPI) DRIVER
 M:	Frederic Barrat <fbarrat@linux.ibm.com>
 M:	Andrew Donnellan <ajd@linux.ibm.com>
diff --git a/include/linux/mfd/ocelot.h b/include/linux/mfd/ocelot.h
new file mode 100644
index 000000000000..353b7c2ee445
--- /dev/null
+++ b/include/linux/mfd/ocelot.h
@@ -0,0 +1,55 @@
+/* SPDX-License-Identifier: GPL-2.0 OR MIT */
+/* Copyright 2022 Innovative Advantage Inc. */
+
+#include <linux/err.h>
+#include <linux/platform_device.h>
+#include <linux/regmap.h>
+#include <linux/types.h>
+
+struct resource;
+
+static inline struct regmap *
+ocelot_regmap_from_resource_optional(struct platform_device *pdev,
+				     unsigned int index,
+				     const struct regmap_config *config)
+{
+	struct device *dev = &pdev->dev;
+	struct resource *res;
+	u32 __iomem *regs;
+
+	/*
+	 * Don't use get_and_ioremap_resource here, since that will invoke
+	 * prints of "invalid resource" which simply add confusion
+	 */
+	res = platform_get_resource(pdev, IORESOURCE_MEM, index);
+	if (res) {
+		regs = devm_ioremap_resource(dev, res);
+		if (IS_ERR(regs))
+			return ERR_CAST(regs);
+		return devm_regmap_init_mmio(dev, regs, config);
+	}
+
+	/*
+	 * Fall back to using REG and getting the resource from the parent
+	 * device, which is possible in an MFD configuration
+	 */
+	if (dev->parent) {
+		res = platform_get_resource(pdev, IORESOURCE_REG, index);
+		if (!res)
+			return NULL;
+
+		return dev_get_regmap(dev->parent, res->name);
+	}
+
+	return NULL;
+}
+
+static inline struct regmap *
+ocelot_regmap_from_resource(struct platform_device *pdev, unsigned int index,
+			    const struct regmap_config *config)
+{
+	struct regmap *map;
+
+	map = ocelot_regmap_from_resource_optional(pdev, index, config);
+	return map ?: ERR_PTR(-ENOENT);
+}
-- 
2.25.1