u-boot.git/include/clk.h, branch v2023.01

Merge tag 'clk-2023.01' of https://source.denx.de/u-boot/custodians/u-boot-clk

2022-10-20T12:58:25+00:00

Clock patches for 2023.01

This contains various fixes (some long overdue) for the next release.

clk: change return type of clk_get_parent_rate from long long to ulong

2022-10-19T16:06:41+00:00

All functions getting and setting clock rate use ulong for rate, only
clk_get_parent_rate is an exception. Change the return value to match
other clock rate funcrions.

Most users directly assign the rate to unsigned long anyway, and the few
users that use u64 (not s64) multiply the rate so they may need the
extra bits for the result in their use case.

Fixes: 4aa78300a0 ("dm: clk: Define clk_get_parent_rate() for clk operations")
Signed-off-by: Michal Suchanek 
Reviewed-by: Simon Glass 
Reviewed-by: Sean Anderson 
Link: https://lore.kernel.org/r/20220928103757.11870-1-msuchanek@suse.de

dm: clk: add missing stub when CONFIG_CLK is deactivated

2022-10-09T08:42:20+00:00

Add missing stub for functions [devm_]clk_...() when CONFIG_CLK is
deactivated.

Signed-off-by: Dario Binacchi 
Reviewed-by: Sean Anderson

clk: Make clk_free return void

2022-03-30T17:02:55+00:00

Most callers of this function do not check the return value, and it is
unclear what action they should take if it fails. If a function is freeing
multiple clocks, it should not stop just because the first one failed.
Since the callbacks can no longer fail, just convert the return type to
void.

Signed-off-by: Sean Anderson 
Link: https://lore.kernel.org/r/20220115222504.617013-8-seanga2@gmail.com

clk: Add clk_get_by_name_optional

2022-02-25T06:41:04+00:00

This adds a helper function for clk_get_by_name in cases where the clock is
optional. Hopefully this helps point driver writers in the right direction.
Also convert some existing users.

Signed-off-by: Sean Anderson 
Reviewed-by: Neil Armstrong 
Reviewed-by: Simon Glass 
Link: https://lore.kernel.org/r/20220115205247.566210-2-seanga2@gmail.com

clk: Add client API to HTML docs

2022-02-25T06:41:04+00:00

This converts the existing client (aka clk.h) documentation to kernel doc
format, and adds it to the HTML docs. I have tried to preserve existing
comments as much as possible, refraining from semantic changes.

Signed-off-by: Sean Anderson 
Tested-by: Heinrich Schuchardt 
Reviewed-by: Simon Glass 
Link: https://lore.kernel.org/r/20211222171114.3091780-4-seanga2@gmail.com
[rebased onto u-boot/master and resolved conflicts]
Signed-off-by: Sean Anderson

clk: Inline clk_get_*_optional

2022-02-25T04:58:13+00:00

The optional varients of clk_get_* functions are just simple wrappers.
Reduce code size a bit by inlining them. On platforms where it is not used
(most of them), it will not be compiled in any more. On platforms where
they are used, the inlined branch should not cause any significant growth.

Signed-off-by: Sean Anderson 
Reviewed-by: Simon Glass 
Link: https://lore.kernel.org/r/20211222171114.3091780-3-seanga2@gmail.com

clk: Rename clk_get_optional_nodev

2022-02-25T04:58:13+00:00

This normalizes the name of this accessor function to put "_optional" last.

Signed-off-by: Sean Anderson 
Reviewed-by: Simon Glass 
Link: https://lore.kernel.org/r/20211222171114.3091780-2-seanga2@gmail.com

doc: replace @return by Return:

2022-01-19T17:11:34+00:00

Sphinx expects Return: and not @return to indicate a return value.

find . -name '*.c' -exec \
sed -i 's/^\(\s\)\*\(\s*\)@return\(\s\)/\1*\2Return:\3/' {} \;

find . -name '*.h' -exec \
sed -i 's/^\(\s\)\*\(\s*\)@return\(\s\)/\1*\2Return:\3/' {} \;

Signed-off-by: Heinrich Schuchardt

clk: fix clk_get_rate() documentation

2021-12-15T17:16:15+00:00

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