From 9e578f6340ba3f4324cd823872afe6eda39857d2 Mon Sep 17 00:00:00 2001 From: Giulio Benetti Date: Sun, 14 Feb 2021 03:17:18 +0100 Subject: [PATCH] clk: fix clk_get_rate() documentation Improve clk_get_rate() @return documentation that otherwise is a bit ambiguous. At the moment I expect to return 0 as error since the return type is 'ulong', instead the function really returns negative value in case the corresponding function pointer is null and returns 0 if the clock is invalid. Signed-off-by: Giulio Benetti Reviewed-by: Sean Anderson --- include/clk.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/include/clk.h b/include/clk.h index a928879b12..df5255e510 100644 --- a/include/clk.h +++ b/include/clk.h @@ -389,7 +389,8 @@ int clk_free(struct clk *clk); * * @clk: A clock struct that was previously successfully requested by * clk_request/get_by_*(). - * @return clock rate in Hz, or -ve error code. + * @return clock rate in Hz on success, 0 for invalid clock, or -ve error code + * for other errors. */ ulong clk_get_rate(struct clk *clk); -- 2.34.1