Received-SPF: pass (google.com: domain of linux-kernel+bounces-49925-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) client-ip=2604:1380:45d1:ec00::1;
From: "Shradha Todi" <shradha.t@samsung.com>
To: "'Manivannan Sadhasivam'" <manivannan.sadhasivam@linaro.org>,
	<m.szyprowski@samsung.com>, <sboyd@kernel.org>, <mturquette@baylibre.com>
Cc: <linux-clk@vger.kernel.org>, <linux-kernel@vger.kernel.org>,
	<linux-pci@vger.kernel.org>, <linux-arm-kernel@lists.infradead.org>,
	<linux-samsung-soc@vger.kernel.org>, <jingoohan1@gmail.com>,
	<lpieralisi@kernel.org>, <kw@linux.com>, <robh@kernel.org>,
	<bhelgaas@google.com>, <krzysztof.kozlowski@linaro.org>,
	<alim.akhtar@samsung.com>, <linux@armlinux.org.uk>,
	<pankaj.dubey@samsung.com>
In-Reply-To: <20240129065448.GC2971@thinkpad>
Subject: RE: [PATCH v4 1/2] clk: Provide managed helper to get and enable
 bulk clocks
Date: Fri, 2 Feb 2024 17:29:30 +0530
Message-ID: <08a901da55cf$4ee48000$ecad8000$@samsung.com>
Precedence: bulk
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable
Thread-Index: AQIcpPks/WB953w72Rl3v8cfkz9jJgG3GiapAsOufW4BkcYK8bBB75tA
Content-Language: en-in
Content-Type: text/plain; charset="utf-8"
CMS-TYPE: 105P
DLP-Filter: Pass
References: <20240124103838.32478-1-shradha.t@samsung.com>
	<CGME20240124103855epcas5p27400bd95df42f36b9547a4e28aa26f5d@epcas5p2.samsung.com>
	<20240124103838.32478-2-shradha.t@samsung.com>
	<20240129065448.GC2971@thinkpad>


> -----Original Message-----
> From: Manivannan Sadhasivam <manivannan.sadhasivam=40linaro.org>
> Sent: 29 January 2024 12:25
> To: Shradha Todi <shradha.t=40samsung.com>
> Cc: linux-clk=40vger.kernel.org; linux-kernel=40vger.kernel.org; linux-
> pci=40vger.kernel.org; linux-arm-kernel=40lists.infradead.org; linux-sams=
ung-
> soc=40vger.kernel.org; mturquette=40baylibre.com; sboyd=40kernel.org;
> jingoohan1=40gmail.com; lpieralisi=40kernel.org; kw=40linux.com; robh=40k=
ernel.org;
> bhelgaas=40google.com; krzysztof.kozlowski=40linaro.org;
> alim.akhtar=40samsung.com; linux=40armlinux.org.uk;
> m.szyprowski=40samsung.com; pankaj.dubey=40samsung.com
> Subject: Re: =5BPATCH v4 1/2=5D clk: Provide managed helper to get and en=
able bulk
> clocks
>=20
> On Wed, Jan 24, 2024 at 04:08:37PM +0530, Shradha Todi wrote:
> > Provide a managed devm_clk_bulk* wrapper to get and enable all bulk
> > clocks in order to simplify drivers that keeps all clocks enabled for
> > the time of driver operation.
> >
> > Suggested-by: Marek Szyprowski <m.szyprowski=40samsung.com>
> > Signed-off-by: Shradha Todi <shradha.t=40samsung.com>
> > ---
> >  drivers/clk/clk-devres.c =7C 40
> ++++++++++++++++++++++++++++++++++++++++
> >  include/linux/clk.h      =7C 24 ++++++++++++++++++++++++
> >  2 files changed, 64 insertions(+)
> >
> > diff --git a/drivers/clk/clk-devres.c b/drivers/clk/clk-devres.c index
> > 4fb4fd4b06bd..cbbd2cc339c3 100644
> > --- a/drivers/clk/clk-devres.c
> > +++ b/drivers/clk/clk-devres.c
> > =40=40 -182,6 +182,46 =40=40 int __must_check devm_clk_bulk_get_all(str=
uct
> > device *dev,  =7D  EXPORT_SYMBOL_GPL(devm_clk_bulk_get_all);
> >
> > +static void devm_clk_bulk_release_all_enable(struct device *dev, void
> > +*res) =7B
> > +	struct clk_bulk_devres *devres =3D res;
> > +
> > +	clk_bulk_disable_unprepare(devres->num_clks, devres->clks);
> > +	clk_bulk_put_all(devres->num_clks, devres->clks); =7D
> > +
> > +int __must_check devm_clk_bulk_get_all_enable(struct device *dev,
> > +					      struct clk_bulk_data **clks) =7B
> > +	struct clk_bulk_devres *devres;
> > +	int ret;
> > +
> > +	devres =3D devres_alloc(devm_clk_bulk_release_all_enable,
> > +			      sizeof(*devres), GFP_KERNEL);
> > +	if (=21devres)
> > +		return -ENOMEM;
> > +
> > +	ret =3D clk_bulk_get_all(dev, &devres->clks);
> > +	if (ret > 0) =7B
> > +		*clks =3D devres->clks;
> > +		devres->num_clks =3D ret;
> > +	=7D else =7B
> > +		devres_free(devres);
> > +		return ret;
> > +	=7D
>=20
> How about:
>=20
> 	ret =3D clk_bulk_get_all(dev, &devres->clks);
> 	if (ret <=3D 0) =7B
> 		devres_free(devres);
> 		return ret;
> 	=7D
>=20
> 	*clks =3D devres->clks;
> 	devres->num_clks =3D ret;
>=20
> Even though this patch follows the pattern used by the rest of the APIs i=
n the
> driver, IMO above makes it more readable.
>=20

Since I have usually seen that maintainers suggest to maintain the coding s=
tyle of the file, I followed the same.
If you have a stronger reason to change this, please let me know
Marek, Michael, Stephen please let us know what do you think about this?

> > +
> > +	ret =3D clk_bulk_prepare_enable(devres->num_clks, *clks);
> > +	if (=21ret) =7B
> > +		devres_add(dev, devres);
> > +	=7D else =7B
> > +		clk_bulk_put_all(devres->num_clks, devres->clks);
> > +		devres_free(devres);
> > +	=7D
> > +
>=20
> Same as above:
>=20
> 	ret =3D clk_bulk_prepare_enable(devres->num_clks, *clks);
> 	if (ret) =7B
> 		clk_bulk_put_all(devres->num_clks, devres->clks);
> 		devres_free(devres);
> 		return ret;
> 	=7D
>=20
> 	devres_add(dev, devres);
>=20
> > +	return ret;
>=20
> 	return 0;
>=20

Same as above

> > +=7D
> > +EXPORT_SYMBOL_GPL(devm_clk_bulk_get_all_enable);
> > +
> >  static int devm_clk_match(struct device *dev, void *res, void *data)
> > =7B
> >  	struct clk **c =3D res;
> > diff --git a/include/linux/clk.h b/include/linux/clk.h index
> > 1ef013324237..a005e709b7bd 100644
> > --- a/include/linux/clk.h
> > +++ b/include/linux/clk.h
> > =40=40 -438,6 +438,23 =40=40 int __must_check
> > devm_clk_bulk_get_optional(struct device *dev, int num_clks,  int
> __must_check devm_clk_bulk_get_all(struct device *dev,
> >  				       struct clk_bulk_data **clks);
> >
> > +/**
> > + * devm_clk_bulk_get_all_enable - managed get multiple clk consumers a=
nd
> > + *				  enable all clks
>=20
> =22Get and enable all clocks of the consumer (managed)=22
>=20

Will take this up in the next patchset

> > + * =40dev: device for clock =22consumer=22
> > + * =40clks: pointer to the clk_bulk_data table of consumer
> > + *
> > + * Returns success (0) or negative errno.
> > + *
> > + * This helper function allows drivers to get several clk
>=20
> =22This helper function allows drivers to get all clocks of the consumer =
and enables
> them...=22
>=20
> - Mani
>=20

Will take this up. Thanks for your review Mani=21

> > + * consumers and enable all of them in one operation with management.
> > + * The clks will automatically be disabled and freed when the device
> > + * is unbound.
> > + */
> > +
> > +int __must_check devm_clk_bulk_get_all_enable(struct device *dev,
> > +					      struct clk_bulk_data **clks);
> > +
> >  /**
> >   * devm_clk_get - lookup and obtain a managed reference to a clock pro=
ducer.
> >   * =40dev: device for clock =22consumer=22
> > =40=40 -960,6 +977,13 =40=40 static inline int __must_check
> devm_clk_bulk_get_all(struct device *dev,
> >  	return 0;
> >  =7D
> >
> > +static inline int __must_check devm_clk_bulk_get_all_enable(struct dev=
ice
> *dev,
> > +						struct clk_bulk_data **clks)
> > +=7B
> > +
> > +	return 0;
> > +=7D
> > +
> >  static inline struct clk *devm_get_clk_from_child(struct device *dev,
> >  				struct device_node *np, const char *con_id)  =7B
> > --
> > 2.17.1
> >
>=20
> --
> =E0=AE=AE=E0=AE=A3=E0=AE=BF=E0=AE=B5=E0=AE=A3=E0=AF=8D=E0=AE=A3=E0=AE=A9=
=E0=AF=8D=20=E0=AE=9A=E0=AE=A4=E0=AE=BE=E0=AE=9A=E0=AE=BF=E0=AE=B5=E0=AE=AE=
=E0=AF=8D=0D=0A=0D=0A