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:   Liu Ying <victor.liu@nxp.com>
To:     linux-kernel@vger.kernel.org
Cc:     gregkh@linuxfoundation.org, geert+renesas@glider.be,
        saravanak@google.com, linux-imx@nxp.com, greg@kroah.com,
        arnd@arndb.de, sfr@canb.auug.org.au, linux-next@vger.kernel.org
Subject: [PATCH v5] drivers: bus: simple-pm-bus: Use clocks
Date:   Mon, 14 Nov 2022 22:39:16 +0800
Message-Id: <20221114143916.1162000-1-victor.liu@nxp.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?V1sPeltp9fxmwRiMP090FUJBT0MBLzRzU12H0TJfwgXU8OPuZ3QHhH71mPqO?=
 =?us-ascii?Q?csKKvuq5oXZtGqLLHuoegRmbHLrShkYXcryxFHMW9yF8XEmoRJk3H03KZpgG?=
 =?us-ascii?Q?dmjWTgBvC5nG5p2qYzfxt+7yRulgAAKDLI4NBXtbwx7E1GYU2DTBe2AvGGwe?=
 =?us-ascii?Q?voR3k3x0Z+/2tE5s/7j7dNVVmf2vXcW3Aqw/voXzgyom3WNEfQrsQw7T4Ug5?=
 =?us-ascii?Q?0JdgWgotL1+PgJ2rpVgd6QCcEAcAV44CbfPk0VHm+jmFm1QcEeotRhq8C0ZG?=
 =?us-ascii?Q?U19nvEGpYNRpXGsKFRtlayOFSHLGcI/8PRokNDk5fN2xrMoj+GLPkCYQYXT3?=
 =?us-ascii?Q?HmcEmdEahhgxF1wtpbIKkDjn3Vjh5CQa+AZEwZGc2OQRPir8frVpoguIwQbm?=
 =?us-ascii?Q?1sM/O3OTWE1f9YQRNF25H2PJ+BVNoAXNgW0aqrxyqGlxq/P2j3Kz8Cna9XA+?=
 =?us-ascii?Q?cAbShBwTRtyqCG9uWXx2+lA0+cAHMF2o1y0Vp1gNZHK3vqS9zKTJJo64QXRp?=
 =?us-ascii?Q?8Gz+fLZRwjOPmYZ73iz25Q/4+hacONLHvhEFeflrJygpyVEnM/wAt8869+7p?=
 =?us-ascii?Q?IrcJ6otckPQ6LtB307BzkjTZXS51n3+nwNrFixbhbABLBGbUeuUCHYTKnnBo?=
 =?us-ascii?Q?jf9Q1wfYA9NSZZ3vPwpyCTXAwSD+VNeaxmR7eZITyl9Q+vY3YubBuukYVZql?=
 =?us-ascii?Q?AZK0sQkBf04UfBxLpooXNct/I9BgUVMMWFMSkeadQ0XUgqx7cxpbPYA65M2d?=
 =?us-ascii?Q?gI5xggdPqfdcVcwY70urO/K9tKB41GZVwC3dfyktEd6nvH/mBiJcsHsbRi2Y?=
 =?us-ascii?Q?M8avoN+6TQuVJrSnEkyYJKYKQv2xyg5mCDATQ3hcYlq+pfMWhLlqT3Ft8akK?=
 =?us-ascii?Q?M9cQL738cRjWC5PWufEhRsdiESTAzohvDAYpO20vxI8tyDTUYttWypz2TXb0?=
 =?us-ascii?Q?JKX2qQgI8LwQswBStTOifuzibch8t+lHswo1zyKGGIkqsH040yu9tv1i3PzR?=
 =?us-ascii?Q?zw4ChhpMBr9Sr6OdKaFy/aV+Jcr+pOkZkB4Fs0j0qIkgLvdy4LLe/xjS/rE4?=
 =?us-ascii?Q?NwI1mndVWtmXrRe9fSAVLjnLIPVzj+JeXhM8Vuz0sWFpOR0oG5i/zm5lL+FY?=
 =?us-ascii?Q?w19MFFqywJ9pKl9ozoBXMPlqDgtNkjY9gDf5X0enF0bwDR5cVubHHQFN0xDj?=
 =?us-ascii?Q?SeK9zmPmX2SlPdi7WH8GI/gmGEdJADNgWUUW/i+bgx6HT1khF7vg+mxCyGX6?=
 =?us-ascii?Q?RDzJjrfUAQx/InRW8zz4mq6LONDLw+kgMgu0mukeW8LD+bXGHtb5ka6vWqi+?=
 =?us-ascii?Q?wld8xgyeBZvEBXErkxLuUmVJlrccE0L7HSuAeCyyIOvwf9ANBiXKD45jXl2W?=
 =?us-ascii?Q?kw06g0lkLj5Y+O1euFuyVRW4BnUv/yasBQYLnFufzaEtYYU8e7kcy8b2Bj8O?=
 =?us-ascii?Q?vHVtC09jK1bdz7pD60P1/44fBrh1Qmen45mYoP4KbZXMYGYAVjipNTmftW04?=
 =?us-ascii?Q?iE6bQ1Y2sHdEGBUWrOFUBs7zVrgBVeijDTsB6+CFPOomlOQHpK31whmWa5n1?=
 =?us-ascii?Q?teYmf3LMwkq7EfMIQT4zNrH190rWXNqOuRk10Pyn?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 5188f13a-fe52-4669-9f18-08dac64def21
X-MS-Exchange-CrossTenant-AuthSource: AM7PR04MB7046.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 14 Nov 2022 14:38:47.8122
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 686ea1d3-bc2b-4c6f-a92c-d99c5c301635
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: 84fPkkdOq3ns/d9gZxnmgQmur3o1HJXTKtY2PI5/z9wC61Z9boR5VX+aMIjmlSgtzgSDz40mZxU4Cnq3r3uaNg==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: AS1PR04MB9288
X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,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

Simple Power-Managed bus controller may need functional clock(s)
to be enabled before child devices connected to the bus can be
accessed.  Get the clock(s) as a bulk and enable/disable the
clock(s) when the bus is being power managed.

One example is that Freescale i.MX8qxp pixel link MSI bus controller
needs MSI clock and AHB clock to be enabled before accessing child
devices.

Signed-off-by: Liu Ying <victor.liu@nxp.com>
---
v4->v5:
* Fix build warnings when CONFIG_PM=n by using RUNTIME_PM_OPS,
  NOIRQ_SYSTEM_SLEEP_PM_OPS and pm_ptr macros.
* Drop Geert's R-b tag due to the fix.

v3->v4:
* Drop unnecessary 'bus == NULL' check from simple_pm_bus_runtime_{suspend,resume}.
  (Geert)
* Add Geert's R-b tag.

v1->v3:
* No change.

 drivers/bus/simple-pm-bus.c | 46 +++++++++++++++++++++++++++++++++++++
 1 file changed, 46 insertions(+)

diff --git a/drivers/bus/simple-pm-bus.c b/drivers/bus/simple-pm-bus.c
index 6b8d6257ed8a..7afe1947e1c0 100644
--- a/drivers/bus/simple-pm-bus.c
+++ b/drivers/bus/simple-pm-bus.c
@@ -8,17 +8,24 @@
  * for more details.
  */
 
+#include <linux/clk.h>
 #include <linux/module.h>
 #include <linux/of_platform.h>
 #include <linux/platform_device.h>
 #include <linux/pm_runtime.h>
 
+struct simple_pm_bus {
+	struct clk_bulk_data *clks;
+	int num_clks;
+};
+
 static int simple_pm_bus_probe(struct platform_device *pdev)
 {
 	const struct device *dev = &pdev->dev;
 	const struct of_dev_auxdata *lookup = dev_get_platdata(dev);
 	struct device_node *np = dev->of_node;
 	const struct of_device_id *match;
+	struct simple_pm_bus *bus;
 
 	/*
 	 * Allow user to use driver_override to bind this driver to a
@@ -44,6 +51,16 @@ static int simple_pm_bus_probe(struct platform_device *pdev)
 			return -ENODEV;
 	}
 
+	bus = devm_kzalloc(&pdev->dev, sizeof(*bus), GFP_KERNEL);
+	if (!bus)
+		return -ENOMEM;
+
+	bus->num_clks = devm_clk_bulk_get_all(&pdev->dev, &bus->clks);
+	if (bus->num_clks < 0)
+		return dev_err_probe(&pdev->dev, bus->num_clks, "failed to get clocks\n");
+
+	dev_set_drvdata(&pdev->dev, bus);
+
 	dev_dbg(&pdev->dev, "%s\n", __func__);
 
 	pm_runtime_enable(&pdev->dev);
@@ -67,6 +84,34 @@ static int simple_pm_bus_remove(struct platform_device *pdev)
 	return 0;
 }
 
+static int simple_pm_bus_runtime_suspend(struct device *dev)
+{
+	struct simple_pm_bus *bus = dev_get_drvdata(dev);
+
+	clk_bulk_disable_unprepare(bus->num_clks, bus->clks);
+
+	return 0;
+}
+
+static int simple_pm_bus_runtime_resume(struct device *dev)
+{
+	struct simple_pm_bus *bus = dev_get_drvdata(dev);
+	int ret;
+
+	ret = clk_bulk_prepare_enable(bus->num_clks, bus->clks);
+	if (ret) {
+		dev_err(dev, "failed to enable clocks: %d\n", ret);
+		return ret;
+	}
+
+	return 0;
+}
+
+static const struct dev_pm_ops simple_pm_bus_pm_ops = {
+	RUNTIME_PM_OPS(simple_pm_bus_runtime_suspend, simple_pm_bus_runtime_resume, NULL)
+	NOIRQ_SYSTEM_SLEEP_PM_OPS(pm_runtime_force_suspend, pm_runtime_force_resume)
+};
+
 #define ONLY_BUS	((void *) 1) /* Match if the device is only a bus. */
 
 static const struct of_device_id simple_pm_bus_of_match[] = {
@@ -85,6 +130,7 @@ static struct platform_driver simple_pm_bus_driver = {
 	.driver = {
 		.name = "simple-pm-bus",
 		.of_match_table = simple_pm_bus_of_match,
+		.pm = pm_ptr(&simple_pm_bus_pm_ops),
 	},
 };
 
-- 
2.37.1