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>
Subject: [PATCH v10 net-next 1/7] mfd: ocelot: add helper to get regmap from a resource
Date:   Fri, 10 Jun 2022 13:23:24 -0700
Message-Id: <20220610202330.799510-2-colin.foster@in-advantage.com>
In-Reply-To: <20220610202330.799510-1-colin.foster@in-advantage.com>
References: <20220610202330.799510-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?XzekJcFAMJdjonIO5mbRqOTFxvCoEh1uA0AUy7GDIVzNIpCIBXjzejjl28k4?=
 =?us-ascii?Q?PjDUZHJpipaPffGQlP3OsNzl0G5wPBP4+V581YcgmYroJN2myl2Z9rgqw4EY?=
 =?us-ascii?Q?RUuS02iwXFajxyNtPYlBowq0S9+eTRrkLjNtDsoFsYXABiQ114RAhv1BIMrl?=
 =?us-ascii?Q?15uhkkJS37EDVtXZ9u2QQtM/joW4Wcdd+hqWFhcVcugpa9k37525TphmsvJB?=
 =?us-ascii?Q?S0L4rH+hP5nKl0euBlGRBM9JJOQRfn17WhNFz9zYFDR5HZuUCoAA7eRTHj29?=
 =?us-ascii?Q?5PyP9D2a7fr6MiQucOvPyTVWZ0DP6/Qs6Lp7qLVntPQpqBff1Dm9W2mVK2cD?=
 =?us-ascii?Q?pygJ4/+dBb77In68pUWfEoLhAem79wt1OPS9dUe/Dm49WPzTfUZOhWXpAWwB?=
 =?us-ascii?Q?8fa0nGZXB3KZnJ6kuOdoaPHHmuyySN6OhBheFGNdobostaStW0JxyVcQcoMr?=
 =?us-ascii?Q?nmpCurGmbtu56Gm1WTegodB7SEIVXp9rOBIDu6UBtIhLy58FGxNnci8nK0zS?=
 =?us-ascii?Q?pXaGb9zcESb4tWQIL/BGy+AzTZIgXF3TYaSf/z/4Oli3vt6hvdow+Spiiz5P?=
 =?us-ascii?Q?elhu1OqM7wyc4QRTy+6OKh4IXvm5CIJO5euJlDcAaoCUHB+TgzSUNCQmexYE?=
 =?us-ascii?Q?mSIbK+Uj4/N695zgVOOXpUSmoycFsfEkPHcHVywwit1nc5dThXpMyW7T0chT?=
 =?us-ascii?Q?GUlP5cchdXk2vSO3mu3YbUbDIyit0+yRruCZfGWcOBcL4ZtzPt/G/J8bsRF1?=
 =?us-ascii?Q?flSdnKWIjhswYM3qr+6v/kVzMAOKV3afQ5uo0oVMIUynzTWWtUArjB1Oba9n?=
 =?us-ascii?Q?af2l8apODzX1VHyjvrZIi5G7kyvjsRwdqiZp7knORU3hITA6Fxijekt9a54G?=
 =?us-ascii?Q?0cTlmuZ/JTWC/09fWgoYmj12o9l4/bf3qDabc72Y49NdG5YdVcc/S39AEbPb?=
 =?us-ascii?Q?QnMeTJSicDfocEcyvtB0t0f5a30fiK79MnqnUysvufL4RH7uFv9nQ6iKcZHO?=
 =?us-ascii?Q?2v7zkFt87a5xzPsx/Pm0Fpnag0kw14jlTyz+Uh/2IWXEJ5bwYQFA7b8nmUTh?=
 =?us-ascii?Q?+n6RIawa+6t2LPifhZ0g2+BF7pIVqojBOUiEm2Bm97F7AfcAcFtpgigioQGo?=
 =?us-ascii?Q?cw0Thn2zPyS1R4j3/mBfjOwp8w0IWHI1vgJ9eCFg6/rnzQToWhfU6zMO2PpD?=
 =?us-ascii?Q?ygnxweg7UrhcHbwKHMaKxtK8RjtPQ8X5IDbog67xwJ2Fax3HLbR/LC4JnUlh?=
 =?us-ascii?Q?mMWSYPIKxIECaC2O03VqwMe/ampj7Nnvgo9li3INXTKKSDOlxcLCX3/Bu20e?=
 =?us-ascii?Q?lt3xLUppessszYImK7jmiXb3FXH28uOtEXgjJKVfuyOrKeNwVnrPtLIV8+Fb?=
 =?us-ascii?Q?Z49to5P1ZcDPfm5Rz+j6EMQhDCRueog3d7TgxAXqM9/4oCug5NUqjxwNMxD9?=
 =?us-ascii?Q?zmjvxuWz/us2qVuaDUGynVaddyKeCKi8DCbIYbUkkW/Uj2jlWx0zlt7Re9PD?=
 =?us-ascii?Q?flz+AFj8bxLwH3ox1zu41Hm16TAX6lep02JS7CP+3ncUAD/ubE0sETm3BAar?=
 =?us-ascii?Q?ypImmY1HfNVj/jX8wyx801RxebtlMBHPV9i2xOBNC3Q/fE/YF8UCB6wPl/UG?=
 =?us-ascii?Q?IARl9D8F+1TUacBlgGhIsb9+vQS8Rg6fwDvRFZPz6Vsd/AHVcgthNXITkNNl?=
 =?us-ascii?Q?0snzWc8jBtGjNwRcveSYuN3RtX0B5BuY8oWzAaRpWApi1myFmAsgzA//v54f?=
 =?us-ascii?Q?BVZ6/7+avsfxv3jnITlCqSkCwR3iTs2tcwUwZYo6bcGguXnBYf/Q?=
X-OriginatorOrg: in-advantage.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 409485c7-5b1b-40f5-d8c0-08da4b1f1e91
X-MS-Exchange-CrossTenant-AuthSource: MWHPR1001MB2351.namprd10.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 10 Jun 2022 20:23:45.8259
 (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: JZAfrfHAfR9freUzlaa651DctPLaYAOlFb/Bo8Vh1v2h5xs7V22eKJfLWrGns2r4hthJQFOrAomqKDtNJN2peLJkKq1i3YXqAd6oFt/3cjk=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: MWHPR10MB1629
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 | 22 ++++++++++++++++++++++
 2 files changed, 27 insertions(+)
 create mode 100644 include/linux/mfd/ocelot.h

diff --git a/MAINTAINERS b/MAINTAINERS
index 033a01b07f8f..91b4151c5ad1 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -14352,6 +14352,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..40e775f1143f
--- /dev/null
+++ b/include/linux/mfd/ocelot.h
@@ -0,0 +1,22 @@
+/* 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>
+
+static inline void
+ocelot_platform_init_regmap_from_resource(struct platform_device *pdev,
+					  unsigned int index,
+					  struct regmap **map,
+					  struct resource **res,
+					  const struct regmap_config *config);
+{
+	u32 __iomem *regs =
+		devm_platform_get_and_ioremap_resource(pdev, index, res);
+
+	if (!IS_ERR(regs))
+		*map = devm_regmap_init_mmio(&pdev->dev, regs, config);
+	else
+		*map = ERR_PTR(ENODEV);
+}
-- 
2.25.1