diff options
| author | Maxime Ripard <maxime@cerno.tech> | 2022-08-16 13:25:10 +0200 |
|---|---|---|
| committer | Stephen Boyd <sboyd@kernel.org> | 2022-09-15 09:30:34 -0700 |
| commit | bde8870cd8c3a3913ddbc19f8422a21828e14d99 (patch) | |
| tree | 0f05db773dab6a4d60746cb3aaf6ac36f3ceb7e5 /drivers/clk/clk.c | |
| parent | f24a0b1c22c2e90abb4ee1f7a3b0f0d8fc2ede5f (diff) | |
| download | linux-bde8870cd8c3a3913ddbc19f8422a21828e14d99.tar.gz | |
clk: Clarify clk_get_rate() expectations
As shown by a number of clock users already, clk_get_rate() can be
called whether or not the clock is enabled.
Similarly, a number of clock drivers will return a rate of 0 whenever
the rate cannot be figured out.
Since it was a bit ambiguous before, let's make it clear in the
clk_get_rate() documentation.
Signed-off-by: Maxime Ripard <maxime@cerno.tech>
Link: https://lore.kernel.org/r/20220816112530.1837489-6-maxime@cerno.tech
Tested-by: Linux Kernel Functional Testing <lkft@linaro.org>
Tested-by: Naresh Kamboju <naresh.kamboju@linaro.org>
Signed-off-by: Stephen Boyd <sboyd@kernel.org>
Diffstat (limited to 'drivers/clk/clk.c')
| -rw-r--r-- | drivers/clk/clk.c | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/drivers/clk/clk.c b/drivers/clk/clk.c index 9d63163244d4..caa2eb640441 100644 --- a/drivers/clk/clk.c +++ b/drivers/clk/clk.c @@ -1672,8 +1672,9 @@ static unsigned long clk_core_get_rate_recalc(struct clk_core *core) * @clk: the clk whose rate is being returned * * Simply returns the cached rate of the clk, unless CLK_GET_RATE_NOCACHE flag - * is set, which means a recalc_rate will be issued. - * If clk is NULL then returns 0. + * is set, which means a recalc_rate will be issued. Can be called regardless of + * the clock enabledness. If clk is NULL, or if an error occurred, then returns + * 0. */ unsigned long clk_get_rate(struct clk *clk) { |