clk: update clk API documentation to clarify clk_round_rate()
authorRussell King <rmk+kernel@arm.linux.org.uk>
Sat, 14 Mar 2015 15:12:35 +0000 (15:12 +0000)
committerRussell King <rmk+kernel@arm.linux.org.uk>
Wed, 6 May 2015 10:58:10 +0000 (11:58 +0100)
commitd2d14a77886485310ec66e575f00ea5232ac7a14
tree1bde5a546fc78058703552c28cdefd0061130d01
parentd5622a9c13752be46e6fcde9d31391ce0bb0598b
clk: update clk API documentation to clarify clk_round_rate()

The idea is that rate = clk_round_rate(clk, r) is equivalent to:

clk_set_rate(clk, r);
rate = clk_get_rate(clk);

except that clk_round_rate() does not change the hardware in any way.

Signed-off-by: Russell King <rmk+kernel@arm.linux.org.uk>
include/linux/clk.h