* [PATCH v4 1/2] clk: divider: Add KUnit tests for clk_divider_bestdiv() ULONG_MAX handling
2026-04-27 11:28 [PATCH v4 0/2] Fix clk_divider_bestdiv() to get max clk rate supported and add KUnit test suites Prabhakar
@ 2026-04-27 11:28 ` Prabhakar
2026-04-27 15:23 ` Brian Masney
2026-04-27 11:28 ` [PATCH v4 2/2] clk: divider: Fix clk_divider_bestdiv() returning min rate for large rate requests Prabhakar
1 sibling, 1 reply; 5+ messages in thread
From: Prabhakar @ 2026-04-27 11:28 UTC (permalink / raw)
To: Michael Turquette, Stephen Boyd, Brian Masney, Geert Uytterhoeven
Cc: linux-kernel, linux-clk, linux-renesas-soc, Prabhakar, Biju Das,
Fabrizio Castro, Lad Prabhakar
From: Lad Prabhakar <prabhakar.mahadev-lad.rj@bp.renesas.com>
Add KUnit tests to verify the behaviour of clk_divider_bestdiv() when
clk_round_rate() is called with ULONG_MAX, which is the canonical way
to probe the maximum rate a clock can produce.
Two test cases are introduced:
- clk_divider_bestdiv_ulong_max_returns_max_rate: registers a 1 GHz
fixed-rate parent driving a table-based divider whose smallest entry
is div=2 (entries: 2, 4, 8). Calls clk_hw_round_rate(div_hw, ULONG_MAX)
and checks the result.
- clk_divider_bestdiv_mux_ulong_max_returns_max_rate: places a two-input
mux (4 GHz and 2 GHz fixed-rate parents, CLK_SET_RATE_PARENT) ahead of
the same table-based divider to verify correct parent selection under
ULONG_MAX.
Both tests use an explicit clk_div_table with a minimum divider of 2 so
that the pre-loop maxdiv clamping in clk_divider_bestdiv():
maxdiv = min(ULONG_MAX / rate, maxdiv);
clamps maxdiv to 1, causing _next_div() to return 2 on the first
iteration and skip the loop body entirely. This makes bestdiv fall back
to the maximum divider, returning the minimum rate rather than the
maximum.
The expected values intentionally reflect the buggy output:
- test 1: PARENT_RATE_1GHZ / 8 (minimum rate, not maximum)
- test 2: 0 (invalid, loop never populated bestdiv)
These will be corrected to PARENT_RATE_1GHZ / 2 and PARENT_RATE_4GHZ / 2
respectively once the fix to clk_divider_bestdiv() is applied.
Signed-off-by: Lad Prabhakar <prabhakar.mahadev-lad.rj@bp.renesas.com>
---
v3->v4:
- Dropped unregister_fixed_rate/unregister_divider/unregister_mux wrapper
- Added entry in .kunitconfig file
- Fixed reverse christmas tree order in
clk_divider_bestdiv_ulong_max_returns_max_rate
- Updated MODULE_DESCRIPTION() to be more specific
v2->v3:
- Added false positive expected values
- Updated the commit message
- Added dependency on !S390 in Kconfig
---
drivers/clk/.kunitconfig | 1 +
drivers/clk/Kconfig | 8 ++
drivers/clk/Makefile | 1 +
drivers/clk/clk-divider_test.c | 152 +++++++++++++++++++++++++++++++++
4 files changed, 162 insertions(+)
create mode 100644 drivers/clk/clk-divider_test.c
diff --git a/drivers/clk/.kunitconfig b/drivers/clk/.kunitconfig
index 8a0ea41934a2..ea05b9a28c80 100644
--- a/drivers/clk/.kunitconfig
+++ b/drivers/clk/.kunitconfig
@@ -4,6 +4,7 @@ CONFIG_OF=y
CONFIG_OF_OVERLAY=y
CONFIG_COMMON_CLK=y
CONFIG_CLK_KUNIT_TEST=y
+CONFIG_CLK_DIVIDER_KUNIT_TEST=y
CONFIG_CLK_FIXED_RATE_KUNIT_TEST=y
CONFIG_CLK_GATE_KUNIT_TEST=y
CONFIG_CLK_FD_KUNIT_TEST=y
diff --git a/drivers/clk/Kconfig b/drivers/clk/Kconfig
index b2efbe9f6acb..fdeb87ff8fd9 100644
--- a/drivers/clk/Kconfig
+++ b/drivers/clk/Kconfig
@@ -573,4 +573,12 @@ config CLK_FD_KUNIT_TEST
help
Kunit test for the clk-fractional-divider type.
+config CLK_DIVIDER_KUNIT_TEST
+ tristate "KUnit tests for clk divider bestdiv" if !KUNIT_ALL_TESTS
+ depends on KUNIT
+ depends on !S390
+ default KUNIT_ALL_TESTS
+ help
+ Kunit test for the clk-divider type.
+
endif
diff --git a/drivers/clk/Makefile b/drivers/clk/Makefile
index a3e2862ebd7e..dc653b458f56 100644
--- a/drivers/clk/Makefile
+++ b/drivers/clk/Makefile
@@ -21,6 +21,7 @@ clk-test-y := clk_test.o \
kunit_clk_hw_get_dev_of_node.dtbo.o \
kunit_clk_parent_data_test.dtbo.o
obj-$(CONFIG_COMMON_CLK) += clk-divider.o
+obj-$(CONFIG_CLK_DIVIDER_KUNIT_TEST) += clk-divider_test.o
obj-$(CONFIG_COMMON_CLK) += clk-fixed-factor.o
obj-$(CONFIG_COMMON_CLK) += clk-fixed-rate.o
obj-$(CONFIG_CLK_FIXED_RATE_KUNIT_TEST) += clk-fixed-rate-test.o
diff --git a/drivers/clk/clk-divider_test.c b/drivers/clk/clk-divider_test.c
new file mode 100644
index 000000000000..b1bc802f38e4
--- /dev/null
+++ b/drivers/clk/clk-divider_test.c
@@ -0,0 +1,152 @@
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * KUnit tests for clk_divider_bestdiv()
+ */
+#include <kunit/test.h>
+#include <linux/clk.h>
+#include <linux/clk-provider.h>
+#include <linux/limits.h>
+#include <linux/units.h>
+
+#define PARENT_RATE_1GHZ GIGA
+#define PARENT_RATE_2GHZ (2 * GIGA)
+#define PARENT_RATE_4GHZ (4 * GIGA)
+
+static const struct clk_div_table bestdiv_table[] = {
+ { .val = 0, .div = 2 },
+ { .val = 1, .div = 4 },
+ { .val = 2, .div = 8 },
+ { /* sentinel */ }
+};
+
+/*
+ * Test that clk_round_rate(clk, ULONG_MAX) returns the maximum achievable
+ * rate for a divider clock.
+ */
+static void clk_divider_bestdiv_ulong_max_returns_max_rate(struct kunit *test)
+{
+ struct clk_hw *parent_hw, *div_hw;
+ unsigned long rate;
+ u32 *fake_reg;
+
+ fake_reg = kunit_kzalloc(test, sizeof(*fake_reg), GFP_KERNEL);
+ KUNIT_ASSERT_NOT_ERR_OR_NULL(test, fake_reg);
+
+ parent_hw = clk_hw_register_fixed_rate(NULL, "bestdiv-parent",
+ NULL, 0, PARENT_RATE_1GHZ);
+ KUNIT_ASSERT_NOT_ERR_OR_NULL(test, parent_hw);
+ KUNIT_ASSERT_EQ(test, 0,
+ kunit_add_action_or_reset(test,
+ (kunit_action_t *)clk_hw_unregister_fixed_rate,
+ parent_hw));
+
+ div_hw = clk_hw_register_divider_table(NULL, "bestdiv-div",
+ "bestdiv-parent",
+ CLK_SET_RATE_PARENT,
+ (void __iomem __force *)fake_reg,
+ 0, 2, 0, bestdiv_table, NULL);
+ KUNIT_ASSERT_NOT_ERR_OR_NULL(test, div_hw);
+ KUNIT_ASSERT_EQ(test, 0,
+ kunit_add_action_or_reset(test,
+ (kunit_action_t *)clk_hw_unregister_divider,
+ div_hw));
+
+ /*
+ * ULONG_MAX is the canonical way to probe the maximum rate a clock
+ * can produce.
+ */
+ rate = clk_hw_round_rate(div_hw, ULONG_MAX);
+ KUNIT_EXPECT_EQ(test, rate, PARENT_RATE_1GHZ / 8);
+}
+
+/*
+ * Test that clk_round_rate(clk, ULONG_MAX) returns the correct maximum rate
+ * when a mux clock sits between a divider and its parent candidates.
+ *
+ * Topology:
+ *
+ * [fixed 4 GHz] --\
+ * +--> [mux CLK_SET_RATE_PARENT] --> [div {2,4,8} CLK_SET_RATE_PARENT]
+ * [fixed 2 GHz] --/
+ *
+ */
+static void clk_divider_bestdiv_mux_ulong_max_returns_max_rate(struct kunit *test)
+{
+ static const char * const mux_parents[] = {
+ "bestdiv-mux-parent-a",
+ "bestdiv-mux-parent-b",
+ };
+ struct clk_hw *parent_a_hw, *parent_b_hw, *mux_hw, *div_hw;
+ u32 *fake_reg_mux, *fake_reg_div;
+ unsigned long rate;
+
+ fake_reg_mux = kunit_kzalloc(test, sizeof(*fake_reg_mux), GFP_KERNEL);
+ KUNIT_ASSERT_NOT_ERR_OR_NULL(test, fake_reg_mux);
+
+ fake_reg_div = kunit_kzalloc(test, sizeof(*fake_reg_div), GFP_KERNEL);
+ KUNIT_ASSERT_NOT_ERR_OR_NULL(test, fake_reg_div);
+
+ /* Higher-rate parent: the mux should select this for ULONG_MAX. */
+ parent_a_hw = clk_hw_register_fixed_rate(NULL, "bestdiv-mux-parent-a",
+ NULL, 0, PARENT_RATE_4GHZ);
+ KUNIT_ASSERT_NOT_ERR_OR_NULL(test, parent_a_hw);
+ KUNIT_ASSERT_EQ(test, 0,
+ kunit_add_action_or_reset(test,
+ (kunit_action_t *)clk_hw_unregister_fixed_rate,
+ parent_a_hw));
+
+ /* Lower-rate parent: should not be selected. */
+ parent_b_hw = clk_hw_register_fixed_rate(NULL, "bestdiv-mux-parent-b",
+ NULL, 0, PARENT_RATE_2GHZ);
+ KUNIT_ASSERT_NOT_ERR_OR_NULL(test, parent_b_hw);
+ KUNIT_ASSERT_EQ(test, 0,
+ kunit_add_action_or_reset(test,
+ (kunit_action_t *)clk_hw_unregister_fixed_rate,
+ parent_b_hw));
+
+ /*
+ * 1-bit mux register selects between the two parents.
+ * CLK_SET_RATE_PARENT allows the divider's rate request to
+ * propagate into clk_mux_determine_rate().
+ */
+ mux_hw = clk_hw_register_mux(NULL, "bestdiv-mux",
+ mux_parents, ARRAY_SIZE(mux_parents),
+ CLK_SET_RATE_PARENT,
+ (void __iomem __force *)fake_reg_mux,
+ 0, 1, 0, NULL);
+ KUNIT_ASSERT_NOT_ERR_OR_NULL(test, mux_hw);
+ KUNIT_ASSERT_EQ(test, 0,
+ kunit_add_action_or_reset(test,
+ (kunit_action_t *)clk_hw_unregister_mux,
+ mux_hw));
+
+ div_hw = clk_hw_register_divider_table(NULL, "bestdiv-mux-div",
+ "bestdiv-mux",
+ CLK_SET_RATE_PARENT,
+ (void __iomem __force *)fake_reg_div,
+ 0, 2, 0, bestdiv_table, NULL);
+ KUNIT_ASSERT_NOT_ERR_OR_NULL(test, div_hw);
+ KUNIT_ASSERT_EQ(test, 0,
+ kunit_add_action_or_reset(test,
+ (kunit_action_t *)clk_hw_unregister_divider,
+ div_hw));
+
+ rate = clk_hw_round_rate(div_hw, ULONG_MAX);
+ KUNIT_EXPECT_EQ(test, rate, 0);
+}
+
+static struct kunit_case clk_divider_bestdiv_test_cases[] = {
+ KUNIT_CASE(clk_divider_bestdiv_ulong_max_returns_max_rate),
+ KUNIT_CASE(clk_divider_bestdiv_mux_ulong_max_returns_max_rate),
+ {}
+};
+
+static struct kunit_suite clk_divider_bestdiv_test_suite = {
+ .name = "clk_divider_bestdiv",
+ .test_cases = clk_divider_bestdiv_test_cases,
+};
+
+kunit_test_suite(clk_divider_bestdiv_test_suite);
+
+MODULE_DESCRIPTION("KUnit tests for clk divider");
+MODULE_LICENSE("GPL");
--
2.54.0
^ permalink raw reply related [flat|nested] 5+ messages in thread* [PATCH v4 2/2] clk: divider: Fix clk_divider_bestdiv() returning min rate for large rate requests
2026-04-27 11:28 [PATCH v4 0/2] Fix clk_divider_bestdiv() to get max clk rate supported and add KUnit test suites Prabhakar
2026-04-27 11:28 ` [PATCH v4 1/2] clk: divider: Add KUnit tests for clk_divider_bestdiv() ULONG_MAX handling Prabhakar
@ 2026-04-27 11:28 ` Prabhakar
1 sibling, 0 replies; 5+ messages in thread
From: Prabhakar @ 2026-04-27 11:28 UTC (permalink / raw)
To: Michael Turquette, Stephen Boyd, Brian Masney, Geert Uytterhoeven
Cc: linux-kernel, linux-clk, linux-renesas-soc, Prabhakar, Biju Das,
Fabrizio Castro, Lad Prabhakar
From: Lad Prabhakar <prabhakar.mahadev-lad.rj@bp.renesas.com>
clk_divider_bestdiv() clamps maxdiv using:
maxdiv = min(ULONG_MAX / rate, maxdiv);
to avoid overflow in rate * i. However, requests like
clk_round_rate(clk, ULONG_MAX), which are used to determine the maximum
supported rate of a clock, result in maxdiv being clamped to 1. If no
valid divider of 1 exists in the table the loop is never entered and
bestdiv falls back to the maximum divider with the minimum parent rate,
causing clk_round_rate(clk, ULONG_MAX) to incorrectly return the minimum
supported rate instead of the maximum.
Fix this by removing the pre-loop maxdiv clamping and replacing the
unprotected rate * i multiplication with check_mul_overflow(). Guard
the exact-match short-circuit with !overflow to prevent a clamped
target_parent_rate of ULONG_MAX from falsely matching parent_rate_saved
and causing premature loop exit. Break out of the loop after evaluating
the first overflowing divider since clk_hw_round_rate(parent, ULONG_MAX)
returns a constant for all subsequent iterations, meaning no better
candidate can be found, and continuing would cause exponential recursive
calls in chained divider clocks.
Update the KUnit test expected values to reflect the corrected behaviour:
- clk_divider_bestdiv_ulong_max_returns_max_rate: PARENT_RATE_1GHZ / 8
(minimum rate, pre-fix) -> PARENT_RATE_1GHZ / 2 (maximum rate)
- clk_divider_bestdiv_mux_ulong_max_returns_max_rate: 0 (invalid,
pre-fix) -> PARENT_RATE_4GHZ / 2 (maximum rate with mux selecting
the 4 GHz parent and applying the smallest table divider of 2)
Signed-off-by: Lad Prabhakar <prabhakar.mahadev-lad.rj@bp.renesas.com>
Reviewed-by: Brian Masney <bmasney@redhat.com>
---
v3->v4:
- No change
v2->v3:
- Added Rb tag
- Added the expected value for the tests
- updated the commit message
---
drivers/clk/clk-divider.c | 25 +++++++++++++++++--------
drivers/clk/clk-divider_test.c | 4 ++--
2 files changed, 19 insertions(+), 10 deletions(-)
diff --git a/drivers/clk/clk-divider.c b/drivers/clk/clk-divider.c
index c3804bbc06f9..36bfaf7200e2 100644
--- a/drivers/clk/clk-divider.c
+++ b/drivers/clk/clk-divider.c
@@ -15,6 +15,7 @@
#include <linux/err.h>
#include <linux/string.h>
#include <linux/log2.h>
+#include <linux/overflow.h>
/*
* DOC: basic adjustable divider clock that cannot gate
@@ -301,6 +302,7 @@ static int clk_divider_bestdiv(struct clk_hw *hw, struct clk_hw *parent,
int i, bestdiv = 0;
unsigned long parent_rate, best = 0, now, maxdiv;
unsigned long parent_rate_saved = *best_parent_rate;
+ unsigned long target_parent_rate;
if (!rate)
rate = 1;
@@ -315,15 +317,11 @@ static int clk_divider_bestdiv(struct clk_hw *hw, struct clk_hw *parent,
return bestdiv;
}
- /*
- * The maximum divider we can use without overflowing
- * unsigned long in rate * i below
- */
- maxdiv = min(ULONG_MAX / rate, maxdiv);
-
for (i = _next_div(table, 0, flags); i <= maxdiv;
i = _next_div(table, i, flags)) {
- if (rate * i == parent_rate_saved) {
+ bool overflow = check_mul_overflow(rate, (unsigned long)i, &target_parent_rate);
+
+ if (!overflow && target_parent_rate == parent_rate_saved) {
/*
* It's the most ideal case if the requested rate can be
* divided from parent clock without needing to change
@@ -332,13 +330,24 @@ static int clk_divider_bestdiv(struct clk_hw *hw, struct clk_hw *parent,
*best_parent_rate = parent_rate_saved;
return i;
}
- parent_rate = clk_hw_round_rate(parent, rate * i);
+ /*
+ * Clamp target_parent_rate to ULONG_MAX on overflow. The true
+ * required parent rate exceeds what can be represented, so ask
+ * the parent for the highest rate it can produce. There is no
+ * point continuing the loop past this since larger dividers
+ * only move further from the requested rate.
+ */
+ if (overflow)
+ target_parent_rate = ULONG_MAX;
+ parent_rate = clk_hw_round_rate(parent, target_parent_rate);
now = DIV_ROUND_UP_ULL((u64)parent_rate, i);
if (_is_best_div(rate, now, best, flags)) {
bestdiv = i;
best = now;
*best_parent_rate = parent_rate;
}
+ if (overflow)
+ break;
}
if (!bestdiv) {
diff --git a/drivers/clk/clk-divider_test.c b/drivers/clk/clk-divider_test.c
index b1bc802f38e4..093399c06467 100644
--- a/drivers/clk/clk-divider_test.c
+++ b/drivers/clk/clk-divider_test.c
@@ -56,7 +56,7 @@ static void clk_divider_bestdiv_ulong_max_returns_max_rate(struct kunit *test)
* can produce.
*/
rate = clk_hw_round_rate(div_hw, ULONG_MAX);
- KUNIT_EXPECT_EQ(test, rate, PARENT_RATE_1GHZ / 8);
+ KUNIT_EXPECT_EQ(test, rate, PARENT_RATE_1GHZ / 2);
}
/*
@@ -132,7 +132,7 @@ static void clk_divider_bestdiv_mux_ulong_max_returns_max_rate(struct kunit *tes
div_hw));
rate = clk_hw_round_rate(div_hw, ULONG_MAX);
- KUNIT_EXPECT_EQ(test, rate, 0);
+ KUNIT_EXPECT_EQ(test, rate, PARENT_RATE_4GHZ / 2);
}
static struct kunit_case clk_divider_bestdiv_test_cases[] = {
--
2.54.0
^ permalink raw reply related [flat|nested] 5+ messages in thread