clk: Clean up optional helpers, and add API docs to HTML
Subsystems (3)
v3 cover clk: Clean up optional helpers, and add API docs to HTML
This cleans up the various optional helpers for clocks, and adds a new one. While we're at it, also convert the existing API docs to our HTML documentation.
The rest of this series has been applied, but the former patch 5 had an error, so I did not apply it. I have fixed it in this revision.
Changes in v3:
- Fix clk_get_by_name_optional recursing
Changes in v2:
- Rebased onto u-boot/master
Sean Anderson (1):
clk: Add clk_get_by_name_optional
drivers/clk/clk_zynq.c | 5 +++-- drivers/rng/meson-rng.c | 4 ++-- include/clk.h | 24 ++++++++++++++++++++++++ 3 files changed, 29 insertions(+), 4 deletions(-)
Signature · 1 line
2.34.1
PATCH v3 1/1 clk: Add clk_get_by_name_optional
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.
---
Changes in v3:
- Fix clk_get_by_name_optional recursing
drivers/clk/clk_zynq.c | 5 +++-- drivers/rng/meson-rng.c | 4 ++-- include/clk.h | 24 ++++++++++++++++++++++++ 3 files changed, 29 insertions(+), 4 deletions(-)
drivers/clk/clk_zynq.c +3 -2
@@ -472,8 +472,9 @@ static int zynq_clk_probe(struct udevice *dev)for (i =0 ; i <2 ; i++) {sprintf (name,"gem%d_emio_clk" , i); - ret =clk_get_by_name (dev, name, &priv->gem_emio_clk[i]); -if (ret <0 && ret != -ENODATA ) { + ret =clk_get_by_name_optional (dev, name, + &priv->gem_emio_clk[i]); +if (ret) {dev_err (dev,"failed to get %s clock\n" , name);return ret; }
drivers/rng/meson-rng.c +2 -2
@@ -91,8 +91,8 @@ static int meson_rng_of_to_plat(struct udevice *dev)return -ENODEV ;/* Get optional "core" clock */ - err =clk_get_by_name (dev,"core" , &pdata->clk); -if (err && err != -ENODATA ) + err =clk_get_by_name_optional (dev,"core" , &pdata->clk); +if (err)return err;return 0 ;
include/clk.h +24 -0
@@ -292,6 +292,30 @@ static inline int clk_release_all(struct clk *clk, int count) }#endif +/** +* clk_get_by_name_optional() - Get/request a optional clock by name. +* @dev: The client device. +* @name: The name of the clock to request, within the client's list of +* clocks. +* @clk: A pointer to a clock struct to initialize. +* +* Behaves the same as clk_get_by_name(), except when there is no clock +* provider. In the latter case, return 0. +* +* Return: 0 if OK, or a negative error code. +*/ +static inline int clk_get_by_name_optional (struct udevice *dev, +const char *name,struct clk *clk) +{ +int ret; + + ret =clk_get_by_name (dev, name, clk); +if (ret == -ENODATA ) +return 0 ; + +return ret; +} +/** * clk_get_by_name_nodev_optional - Get/request an optinonal clock by name * without a device.
Signature · 1 line
2.34.1
Sean Anderson
AppliedQuoted 10 lines · Sean Anderson
This cleans up the various optional helpers for clocks, and adds a new one. While we're at it, also convert the existing API docs to our HTML documentation.
The rest of this series has been applied, but the former patch 5 had an error, so I did not apply it. I have fixed it in this revision.
Changes in v3:
- Fixclk_get_by_name_optionalrecursing[...]
Applied, thanks!
[1/1] clk: Add clk_get_by_name_optional
commit: e96e2132f977aab738994c11162b14695029be6e
Best regards,
Signature · 1 line
Sean Anderson <[email protected]>