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:     linux-arm-kernel@lists.infradead.org, linux-gpio@vger.kernel.org,
        netdev@vger.kernel.org, linux-kernel@vger.kernel.org,
        devicetree@vger.kernel.org
Cc:     Terry Bowman <terry.bowman@amd.com>,
        Vladimir Oltean <vladimir.oltean@nxp.com>,
        Wolfram Sang <wsa@kernel.org>,
        Andy Shevchenko <andy.shevchenko@gmail.com>,
        UNGLinuxDriver@microchip.com,
        Steen Hegelund <Steen.Hegelund@microchip.com>,
        Lars Povlsen <lars.povlsen@microchip.com>,
        Linus Walleij <linus.walleij@linaro.org>,
        Paolo Abeni <pabeni@redhat.com>,
        Jakub Kicinski <kuba@kernel.org>,
        Eric Dumazet <edumazet@google.com>,
        "David S. Miller" <davem@davemloft.net>,
        Russell King <linux@armlinux.org.uk>,
        Heiner Kallweit <hkallweit1@gmail.com>,
        Andrew Lunn <andrew@lunn.ch>,
        Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
        Rob Herring <robh+dt@kernel.org>,
        Lee Jones <lee.jones@linaro.org>, katie.morris@in-advantage.com
Subject: [PATCH v15 mfd 1/9] mfd: ocelot: add helper to get regmap from a resource
Date:   Tue,  2 Aug 2022 22:47:20 -0700
Message-Id: <20220803054728.1541104-2-colin.foster@in-advantage.com>
In-Reply-To: <20220803054728.1541104-1-colin.foster@in-advantage.com>
References: <20220803054728.1541104-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?uxlS4Zcy0ZFe48H4Bv/c13Pa55HTP7CQtXhM1FMOuikz2mx4eFEnhJU3OF2N?=
 =?us-ascii?Q?Q6wmQfWo0JQx8UXZ+SnOgeGtHetkD3gsnhyhfvXn3Wf0r75nVuFqpT8+mDVr?=
 =?us-ascii?Q?H9OWv4NemVuh6eZwrqDDCks3w+9VR0Eme5IF8Z7upQp13p0wFFAS2f65GLdU?=
 =?us-ascii?Q?UmqzAJcABwR2a7DZ+WcAfnqvxNINc1KQtwPSDD6zE5mtmbRxZ6H3s+Kqcivf?=
 =?us-ascii?Q?vBWS4rKXJcFxBrbhsxmte48uJQ6FtfovJjkZukW/zygt6quWnW+MYzkOG7Yl?=
 =?us-ascii?Q?+4UMNsBRmCCaRoUTiXOoh1pmTVAyGAOHEerdD8mUo9fYEfqnVOlIGc+vRSsC?=
 =?us-ascii?Q?Wv29Bb23NO6kzYhUj7kaaPzknwG0INO/SxZ4Rk6jXYSP8oQrOVOB2cqx5uNM?=
 =?us-ascii?Q?3Q/+YW91UamiP1VzQNpAkE94JdyGP5NuzyWxgNiJTBqSzYjxW+Hh2eRcHntR?=
 =?us-ascii?Q?Pta/+d5TCR5Uw/qGHus2FqmYJq7Eoel8povlC6mNDKEcfOcwdaiyHPZVUPG3?=
 =?us-ascii?Q?6ZaG/WCcH/iFJWiD4XnVO5HDX2tg3OeFIByxAhvMYM7pscypt7Nl3eb6a2IF?=
 =?us-ascii?Q?16J7v3fgaw8quNsH/Hvmjly50ZILuwBpJBgrrYpaCqxY7jMyQP5onYypwDrb?=
 =?us-ascii?Q?n2twMx3vfb3bnD04tNsrve7PhlsbcA5qtcV/Bfs8LX6HjnT+7ZHGjBP5kvYb?=
 =?us-ascii?Q?Bg84ua96If7nqbkZ2eOHjw7D9xD8CTlmPFub3GbKRdaOOFAiHj7Bs++ff79s?=
 =?us-ascii?Q?FD77nK8eV54oakadh85SyV2GTgAWnZ+19dfwY87no/DFzj6wN9HTl3rwQZ2J?=
 =?us-ascii?Q?uFIY254UEYxz/XtC3qYig5lN2AlTmJnfKclidJSVWL6Vp6zbiTgrP+GPjPKY?=
 =?us-ascii?Q?EgdmIM+PvNuqUqScZgvtCticb3daKm/zOJHRX8F768iFAJSli1pbsYTLDvSG?=
 =?us-ascii?Q?PUYA4cr5MrZ+YaLSbq/yFjVgLcZPtISTCGonSEnx2chniPvyVemOMWwtYPmp?=
 =?us-ascii?Q?dOwf+JuHjC2uxt8QApM7CdgAmjLgI/GJ1Idv2daqhUf97OHWy/sZGgro6B2j?=
 =?us-ascii?Q?GtcxEooiVTvB/UF3vU4pYfMRep6WmiBNRmFeKrWb//InlhBrg/8yBI+9m1SD?=
 =?us-ascii?Q?iyOgq4Ko3vaWgIzy1qv96OoZ9VLOUTOYmFFRs8R7ls/wuwxJmU6VdW+bZDG0?=
 =?us-ascii?Q?P5szlDi7BJ3DF1Xcvx8uaei3YzTI+uEM4ceb0j1e5IZmII+tsnPynAdi4u89?=
 =?us-ascii?Q?OikFKFsXhkVJtWQKiY+Bx2Kn12OfcDEa8L4uWof8EiHARWsFhQAJaOJocWQP?=
 =?us-ascii?Q?Hl3PvhhQ+UcJPZzSYeOtvZd6YP5CJ6AGjH/gbiPLabnvqNnCbBiIqDuYI6Tz?=
 =?us-ascii?Q?xj/+Vgj0FgPcDVFzbFGqNTxphZ62JLfk6q5BMYsRMEBwfrMsEJUFUZmnWfvd?=
 =?us-ascii?Q?MVuIxvu6nqrSJg2eZBqtfGCCzX7wx/29h0gHfiWXdg3GzLXjP3cqOnl824jr?=
 =?us-ascii?Q?AEQ63k4M1s05cqK5RPYfMQLSgg42Mi2GsyxuaHpXidPDWVqBszHt4BW0L/q1?=
 =?us-ascii?Q?vxrajkQOItfTXHL5m9iIjLbwCXadb871Hx1lBnrrq8VoG9gU3cXwaPLhDvrv?=
 =?us-ascii?Q?nA=3D=3D?=
X-OriginatorOrg: in-advantage.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 00ab748f-59bc-49bc-633b-08da7513b00a
X-MS-Exchange-CrossTenant-AuthSource: MWHPR1001MB2351.namprd10.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 03 Aug 2022 05:47:44.6989
 (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: bm/ti1ZaFhphUdZBQ30Cdh+xL2Trp9NtLxgFRNcT6bE8nC9AHYuZXC0cYvyUlwB86YI2FByGhpW+s+MrLUOkyIiCLlLpCTgj7scbPZ0eFPA=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: MW4PR10MB6438
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
        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>
Reviewed-by: Vladimir Oltean <vladimir.oltean@nxp.com>
---

v15
    * Add missed errno.h and ioport.h includes
    * Add () to function references in both the commit log and comments

v14
    * Add header guard
    * Change regs type from u32* to void*
    * Add Reviewed-by tag

---
 MAINTAINERS                |  5 +++
 include/linux/mfd/ocelot.h | 62 ++++++++++++++++++++++++++++++++++++++
 2 files changed, 67 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..dd72073d2d4f
--- /dev/null
+++ b/include/linux/mfd/ocelot.h
@@ -0,0 +1,62 @@
+/* SPDX-License-Identifier: GPL-2.0 OR MIT */
+/* Copyright 2022 Innovative Advantage Inc. */
+
+#ifndef _LINUX_MFD_OCELOT_H
+#define _LINUX_MFD_OCELOT_H
+
+#include <linux/err.h>
+#include <linux/errno.h>
+#include <linux/ioport.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;
+	void __iomem *regs;
+
+	/*
+	 * Don't use _get_and_ioremap_resource() here, since that will invoke
+	 * prints of "invalid resource" which will 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);
+}
+
+#endif
-- 
2.25.1