devm_cci_regmap_init_i2c() returns a struct regmap pointer (or an
ERR_PTR() from devm_regmap_init_i2c()), but its kernel-doc says "%0 on
success", which was never true. Describe the pointer.

Fixes: 613cbb91e9ce ("media: Add MIPI CCI register access helper functions")
Assisted-by: LLM
Signed-off-by: Karl Mehltretter <kmehltretter@gmail.com>
---
 include/media/v4l2-cci.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/media/v4l2-cci.h b/include/media/v4l2-cci.h
index 4e96e90ee6369f14b43e012cd7044d14bcc5a7f0..a603d419ecaa2cc3771da41ddf5f27270318dbf5 100644
--- a/include/media/v4l2-cci.h
+++ b/include/media/v4l2-cci.h
@@ -132,7 +132,7 @@ int cci_multi_reg_write(struct regmap *map, const struct cci_reg_sequence *regs,
  *
  * Note the memory for the created regmap is devm() managed, tied to the client.
  *
- * Return: %0 on success or a negative error code on failure.
+ * Return: the regmap on success or an ERR_PTR() on failure.
  */
 struct regmap *devm_cci_regmap_init_i2c(struct i2c_client *client,
 					int reg_addr_bits);
-- 
2.39.5 (Apple Git-154)

On Sat, Sep 12, 2026 at 10:27 AM Karl Mehltretter
<kmehltretter@gmail.com> wrote:
>
> devm_cci_regmap_init_i2c() returns a struct regmap pointer (or an
> ERR_PTR() from devm_regmap_init_i2c()), but its kernel-doc says "%0 on
> success", which was never true. Describe the pointer.

...

>   * Note the memory for the created regmap is devm() managed, tied to the client.
>   *
> - * Return: %0 on success or a negative error code on failure.
> + * Return: the regmap on success or an ERR_PTR() on failure.
>   */

What about

 * Return: An error pointer on failure or a valid pointer
 * to a struct regmap. The regmap will be automatically freed by the
 * device management code.
 */

?

The part of the proposed text is taken from other v4l2 header files.

--
With Best Regards,
Andy Shevchenko