Re: [PATCH v5 02/10] regulator: Move OF-specific regulator lookup code to of_regulator.c

Andy Shevchenko
2024-08-23T13:43:29Z

On Fri, Aug 23, 2024 at 02:49:59PM +0800, Chen-Yu Tsai wrote:
> On Thu, Aug 22, 2024 at 9:47 PM Andy Shevchenko
> <andriy.shevchenko@linux.intel.com> wrote:
> > On Thu, Aug 22, 2024 at 05:19:55PM +0800, Chen-Yu Tsai wrote:

...

> > > +/**
> > > + * of_get_child_regulator - get a child regulator device node
> > > + * based on supply name
> > > + * @parent: Parent device node
> > > + * @prop_name: Combination regulator supply name and "-supply"
> > > + *
> > > + * Traverse all child nodes.
> > > + * Extract the child regulator device node corresponding to the supply name.
> > > + * returns the device node corresponding to the regulator if found, else
> > > + * returns NULL.
> >
> > At the same time you may fix kernel-doc warnings (no "Return" section) in these
> > three (on your wish you may fix others in a separate change, but it's not
> > related to this series).
>
> As you said some other functions are missing it as well, so I'll do a
> patch separate from this series to fix them all.

But you need to fix them in this patch series. We do not add patches with known
issues, which are really easy to fix beforehand.

(And below seems you indirectly agrees on that)

> > > + */

...

> > > +/** of_regulator_dev_lookup - lookup a regulator device with device tree only
> >
> > Something went wrong with the indentation.
>
> Will fix, and also add a "Return" section.

Thank you!

> > > + * @dev: Device pointer for regulator supply lookup.
> > > + * @supply: Supply name or regulator ID.
> > > + *
> > > + * If successful, returns a struct regulator_dev that corresponds to the name
> > > + * @supply and with the embedded struct device refcount incremented by one.
> > > + * The refcount must be dropped by calling put_device().
> > > + * On failure one of the following ERR-PTR-encoded values is returned:
> > > + * -ENODEV if lookup fails permanently, -EPROBE_DEFER if lookup could succeed
> > > + * in the future.
> > > + */

--
With Best Regards,
Andy Shevchenko