clk: fix clk_get_rate() documentation
authorGiulio Benetti <giulio.benetti@benettiengineering.com>
Sun, 14 Feb 2021 02:17:18 +0000 (03:17 +0100)
committerSean Anderson <seanga2@gmail.com>
Wed, 15 Dec 2021 17:16:15 +0000 (12:16 -0500)
commit9e578f6340ba3f4324cd823872afe6eda39857d2
tree33eb1b5ad07ec50f8c3a86f663ab344244100759
parentade37460a944aed36ae6ee634c4d4a9a22690461
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 <giulio.benetti@benettiengineering.com>
Reviewed-by: Sean Anderson <seanga2@gmail.com>
include/clk.h