From: Vyacheslav Yurkov via B4 Relay <devnull+V.Yurkov.EXT.bruker.com@kernel.org>
To: Michael Turquette <mturquette@baylibre.com>,
Stephen Boyd <sboyd@kernel.org>, Rob Herring <robh@kernel.org>,
Krzysztof Kozlowski <krzk+dt@kernel.org>,
Conor Dooley <conor+dt@kernel.org>,
Brian Masney <bmasney@redhat.com>,
Brian Masney <bmasney+clk@redhat.com>,
Jerome Brunet <jbrunet+clk@baylibre.com>,
Jyri Sarha <jsarha@ti.com>
Cc: linux-kernel@vger.kernel.org, linux-clk@vger.kernel.org,
devicetree@vger.kernel.org,
Vyacheslav Yurkov <uvv.mail@gmail.com>,
Vyacheslav Yurkov <V.Yurkov.EXT@bruker.com>
Subject: [PATCH v10 2/2] clk: gpio: Add driver for GPIO-signalled clocks
Date: Sat, 21 Nov 2026 13:16:09 +0000 [thread overview]
Message-ID: <20261121-feature-clock-guard-v10-2-5d449739bb8c@bruker.com> (raw)
In-Reply-To: <20261121-feature-clock-guard-v10-0-5d449739bb8c@bruker.com>
From: Vyacheslav Yurkov <V.Yurkov.EXT@bruker.com>
Some clocks are not under CPU control: they are generated and enabled
by external hardware, which only reports through a GPIO whether the
clock is running. There is currently no way to describe such a clock,
so consumers either initialize too early or rely on ad-hoc delays.
Add a "gpio-enabled-clock" provider for this case. Its prepare
callback polls the GPIO until it is asserted or a timeout expires, so
a consumer's clk_prepare_enable() succeeds only once the clock is
actually running, and fails otherwise. is_prepared reports the
current state of the GPIO.
Signed-off-by: Vyacheslav Yurkov <V.Yurkov.EXT@bruker.com>
---
Our use case: peripheral clocks generated by FPGA PLLs, with the
PLL-lock signals routed to GPIOs of the SoC.
---
drivers/clk/clk-gpio.c | 107 +++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 107 insertions(+)
diff --git a/drivers/clk/clk-gpio.c b/drivers/clk/clk-gpio.c
index df0856a39c8d..33f251b209a0 100644
--- a/drivers/clk/clk-gpio.c
+++ b/drivers/clk/clk-gpio.c
@@ -15,6 +15,7 @@
#include <linux/gpio/consumer.h>
#include <linux/err.h>
#include <linux/device.h>
+#include <linux/iopoll.h>
#include <linux/of.h>
#include <linux/platform_device.h>
#include <linux/regulator/consumer.h>
@@ -241,6 +242,112 @@ static struct platform_driver gpio_clk_driver = {
};
builtin_platform_driver(gpio_clk_driver);
+/**
+ * struct clk_gpio_enabled - gpio enabled clock
+ *
+ * @hw: handle between common and hardware-specific interfaces
+ * @gpiod: gpio descriptor
+ * @timeout_us: timeout that is used to get a GPIO value
+ *
+ * Clock whose status is determined by a GPIO signal.
+ *
+ * Implements .prepare and .is_prepared
+ */
+struct clk_gpio_enabled {
+ struct clk_hw hw;
+ struct gpio_desc *gpiod;
+ u32 timeout_us;
+};
+
+#define to_clk_gpio_enabled(_hw) container_of(_hw, struct clk_gpio_enabled, hw)
+#define GPIO_ENABLED_TIMEOUT_MIN 10
+#define GPIO_ENABLED_TIMEOUT_MAX 1000
+#define GPIO_ENABLED_TIMEOUT_DEFAULT 10
+
+static int clk_gpio_enabled_is_prepared(struct clk_hw *hw)
+{
+ struct clk_gpio_enabled *clk = to_clk_gpio_enabled(hw);
+
+ return gpiod_get_value_cansleep(clk->gpiod) > 0;
+}
+
+/* The clock cannot be turned on, only waited for. */
+static int clk_gpio_enabled_prepare(struct clk_hw *hw)
+{
+ struct clk_gpio_enabled *clk = to_clk_gpio_enabled(hw);
+ int value, ret;
+
+ ret = readx_poll_timeout(gpiod_get_value_cansleep, clk->gpiod, value,
+ value != 0, 10, clk->timeout_us);
+ if (ret)
+ return ret;
+
+ return value < 0 ? value : 0;
+}
+
+static const struct clk_ops clk_gpio_enabled_ops = {
+ .prepare = clk_gpio_enabled_prepare,
+ .is_prepared = clk_gpio_enabled_is_prepared,
+};
+
+static int gpio_enabled_clk_driver_probe(struct platform_device *pdev)
+{
+ struct device *dev = &pdev->dev;
+ struct clk_gpio_enabled *clk;
+ const char *clk_name;
+ const struct clk_parent_data gpio_parent_data[] = {
+ { .index = 0 },
+ };
+ u32 timeout_us = GPIO_ENABLED_TIMEOUT_DEFAULT;
+ int ret;
+
+ clk = devm_kzalloc(dev, sizeof(*clk), GFP_KERNEL);
+ if (!clk)
+ return -ENOMEM;
+
+ clk->gpiod = devm_gpiod_get(dev, "enabled", GPIOD_IN);
+ if (IS_ERR(clk->gpiod))
+ return dev_err_probe(dev, PTR_ERR(clk->gpiod),
+ "Can't get enabled GPIO property\n");
+
+ ret = device_property_read_string(dev, "clock-output-names", &clk_name);
+ if (ret)
+ return dev_err_probe(dev, ret, "missing clock-output-names\n");
+
+ device_property_read_u32(dev, "poll-timeout-us", &timeout_us);
+ if (timeout_us < GPIO_ENABLED_TIMEOUT_MIN ||
+ timeout_us > GPIO_ENABLED_TIMEOUT_MAX)
+ return dev_err_probe(dev, -EINVAL,
+ "poll-timeout-us is out of range [%u, %u]\n",
+ GPIO_ENABLED_TIMEOUT_MIN,
+ GPIO_ENABLED_TIMEOUT_MAX);
+ clk->timeout_us = timeout_us;
+
+ clk->hw.init = CLK_HW_INIT_PARENTS_DATA(clk_name, gpio_parent_data,
+ clk_gpio_enabled_ops, CLK_SET_RATE_PARENT);
+
+ ret = devm_clk_hw_register(dev, &clk->hw);
+ if (ret)
+ return dev_err_probe(dev, ret,
+ "Failed to register clock\n");
+
+ return devm_of_clk_add_hw_provider(dev, of_clk_hw_simple_get, &clk->hw);
+}
+
+static const struct of_device_id gpio_enabled_clk_match_table[] = {
+ { .compatible = "gpio-enabled-clock" },
+ { }
+};
+
+static struct platform_driver gpio_enabled_clk_driver = {
+ .probe = gpio_enabled_clk_driver_probe,
+ .driver = {
+ .name = "gpio-enabled-clk",
+ .of_match_table = gpio_enabled_clk_match_table,
+ },
+};
+builtin_platform_driver(gpio_enabled_clk_driver);
+
/**
* DOC: gated fixed clock, controlled with a gpio output and a regulator
* Traits of this clock:
--
2.34.1
prev parent reply other threads:[~2026-11-21 13:16 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-11-21 13:16 [PATCH v10 0/2] A proposal to add a gpio-enabled clock driver Vyacheslav Yurkov via B4 Relay
2026-11-21 13:16 ` [PATCH v10 1/2] dt-bindings: clock: Add gpio-enabled-clock Vyacheslav Yurkov via B4 Relay
2026-11-21 13:16 ` Vyacheslav Yurkov via B4 Relay [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20261121-feature-clock-guard-v10-2-5d449739bb8c@bruker.com \
--to=devnull+v.yurkov.ext.bruker.com@kernel.org \
--cc=V.Yurkov.EXT@bruker.com \
--cc=bmasney+clk@redhat.com \
--cc=bmasney@redhat.com \
--cc=conor+dt@kernel.org \
--cc=devicetree@vger.kernel.org \
--cc=jbrunet+clk@baylibre.com \
--cc=jsarha@ti.com \
--cc=krzk+dt@kernel.org \
--cc=linux-clk@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mturquette@baylibre.com \
--cc=robh@kernel.org \
--cc=sboyd@kernel.org \
--cc=uvv.mail@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®