Re: [PATCH net-next 1/7] clk: Add devm_clk_bulk_get_enable()

[sashiko-bot@kernel.org]

Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [Low] The docstring for devm_clk_bulk_get_enable() incorrectly claims it returns an IS_ERR() condition.
--

--- Patch [1]: [PATCH net-next 1/7] clk: Add devm_clk_bulk_get_enable() ---
commit 0e92e9409720067c1f28a37f1eb2bb60ddaa0d56
Author: Suraj Gupta <suraj.gupta2@amd.com>

clk: Add devm_clk_bulk_get_enable()

This commit adds devm_clk_bulk_get_enable() to get, prepare, and enable a
mandatory set of clocks with device-managed cleanup. It introduces a
wrapper around the existing __devm_clk_bulk_get_enable() helper.

> diff --git a/include/linux/clk.h b/include/linux/clk.h
> index 998ba3f261dac..0289ac4c6e48e 100644
> --- a/include/linux/clk.h
> +++ b/include/linux/clk.h
> @@ -502,6 +502,22 @@ int __must_check devm_clk_bulk_get(struct device *dev, int num_clks,
>   */
>  int __must_check devm_clk_bulk_get_optional(struct device *dev, int num_clks,
>  					    struct clk_bulk_data *clks);
> +/**
> + * devm_clk_bulk_get_enable - Get and enable bulk clocks (managed)
> + * @dev: device for clock "consumer"
> + * @num_clks: the number of clk_bulk_data
> + * @clks: pointer to the clk_bulk_data table of consumer
> + *
> + * Behaves the same as devm_clk_bulk_get() but also prepares and enables the
> + * clocks in one operation with management. The clks will automatically be
> + * disabled, unprepared and freed when the device is unbound.
> + *
> + * Return: 0 if all clocks specified in clk_bulk_data table are obtained and
> + * enabled successfully. Otherwise returns valid IS_ERR() condition containing
> + * errno.
> + */

[Severity: Low]
Does this documentation incorrectly suggest using IS_ERR() on the return
value?

Since devm_clk_bulk_get_enable() returns a standard integer error code
rather than a pointer, consumers following this docstring and attempting
to use IS_ERR() on the result would encounter compiler warnings. Should
this instead state that it returns a negative error code on failure?

> +int __must_check devm_clk_bulk_get_enable(struct device *dev, int num_clks,
> +					  struct clk_bulk_data *clks);

-- 
Sashiko AI review · https://sashiko.dev/#/patchset/20260723123838.125145-1-suraj.gupta2@amd.com?part=1