diff mbox

[V4,1/1] clk: bulk: add of_clk_bulk_get()

Message ID 1506415441-4435-1-git-send-email-aisheng.dong@nxp.com (mailing list archive)
State Changes Requested, archived
Headers show

Commit Message

Dong Aisheng Sept. 26, 2017, 8:44 a.m. UTC
'clock-names' property is optinal in DT, so of_clk_bulk_get() is introduced
here to handle this for DT users without 'clock-names' specified.

Cc: Stephen Boyd <sboyd@codeaurora.org>
Cc: Michael Turquette <mturquette@baylibre.com>
Cc: Russell King <linux@arm.linux.org.uk>
Reported-by: Shawn Guo <shawnguo@kernel.org>
Signed-off-by: Dong Aisheng <aisheng.dong@nxp.com>

---
Changes since v3:
 * fix build warning on the SH platform

Changes since v2:
 * of_clk_bulk_get should return -ENOENT;

Changes since v1:
 * using %pOF instead of full_name
---
 drivers/clk/clk-bulk.c | 31 +++++++++++++++++++++++++++++++
 include/linux/clk.h    |  8 ++++++++
 2 files changed, 39 insertions(+)

Comments

Stephen Boyd Sept. 29, 2017, 10:48 p.m. UTC | #1
On 09/26, Dong Aisheng wrote:
> 'clock-names' property is optinal in DT, so of_clk_bulk_get() is introduced

s/optinal/optional/

> here to handle this for DT users without 'clock-names' specified.
> 
> Cc: Stephen Boyd <sboyd@codeaurora.org>
> Cc: Michael Turquette <mturquette@baylibre.com>
> Cc: Russell King <linux@arm.linux.org.uk>
> Reported-by: Shawn Guo <shawnguo@kernel.org>
> Signed-off-by: Dong Aisheng <aisheng.dong@nxp.com>
> 
> ---
> Changes since v3:
>  * fix build warning on the SH platform
> 
> Changes since v2:
>  * of_clk_bulk_get should return -ENOENT;
> 
> Changes since v1:
>  * using %pOF instead of full_name
> ---
>  drivers/clk/clk-bulk.c | 31 +++++++++++++++++++++++++++++++
>  include/linux/clk.h    |  8 ++++++++
>  2 files changed, 39 insertions(+)
> 
> diff --git a/drivers/clk/clk-bulk.c b/drivers/clk/clk-bulk.c
> index c834f5a..896aa3b 100644
> --- a/drivers/clk/clk-bulk.c
> +++ b/drivers/clk/clk-bulk.c
> @@ -19,6 +19,37 @@
>  #include <linux/clk.h>
>  #include <linux/device.h>
>  #include <linux/export.h>
> +#include <linux/of.h>
> +
> +#if defined(CONFIG_OF) && defined(CONFIG_COMMON_CLK)
> +int __must_check of_clk_bulk_get(struct device_node *np, int num_clks,
> +				 struct clk_bulk_data *clks)
> +{
> +	int ret;
> +	int i;
> +
> +	for (i = 0; i < num_clks; i++)
> +		clks[i].clk = NULL;
> +
> +	for (i = 0; i < num_clks; i++) {
> +		clks[i].clk = of_clk_get(np, i);
> +		if (IS_ERR(clks[i].clk)) {
> +			ret = PTR_ERR(clks[i].clk);
> +			pr_err("%pOF: Failed to get clk index: %d ret: %d\n",
> +			       np, i, ret);
> +			clks[i].clk = NULL;
> +			goto err;
> +		}
> +	}
> +
> +	return 0;
> +
> +err:
> +	clk_bulk_put(i, clks);
> +
> +	return ret;
> +}

Export the symbol?

> +#endif
>  
>  void clk_bulk_put(int num_clks, struct clk_bulk_data *clks)
>  {
> diff --git a/include/linux/clk.h b/include/linux/clk.h
> index 12c96d9..073cb3b 100644
> --- a/include/linux/clk.h
> +++ b/include/linux/clk.h
> @@ -680,10 +680,18 @@ static inline void clk_bulk_disable_unprepare(int num_clks,
>  }
>  
>  #if defined(CONFIG_OF) && defined(CONFIG_COMMON_CLK)
> +int __must_check of_clk_bulk_get(struct device_node *np, int num_clks,
> +				 struct clk_bulk_data *clks);
>  struct clk *of_clk_get(struct device_node *np, int index);
>  struct clk *of_clk_get_by_name(struct device_node *np, const char *name);
>  struct clk *of_clk_get_from_provider(struct of_phandle_args *clkspec);
>  #else
> +static inline int of_clk_bulk_get(struct device_node *np, int num_clks,

Do we need __must_check here too? We should do the same for the
other bulk get APIs. Seems we missed that part last time.

I'll fix all these things up when applying.
Dong Aisheng Dec. 20, 2017, 1:53 p.m. UTC | #2
On Fri, Sep 29, 2017 at 03:48:21PM -0700, Stephen Boyd wrote:
> On 09/26, Dong Aisheng wrote:
> > 'clock-names' property is optinal in DT, so of_clk_bulk_get() is introduced
> 
> s/optinal/optional/
> 

Got it.

> > here to handle this for DT users without 'clock-names' specified.
> > 
> > Cc: Stephen Boyd <sboyd@codeaurora.org>
> > Cc: Michael Turquette <mturquette@baylibre.com>
> > Cc: Russell King <linux@arm.linux.org.uk>
> > Reported-by: Shawn Guo <shawnguo@kernel.org>
> > Signed-off-by: Dong Aisheng <aisheng.dong@nxp.com>
> > 
> > ---
> > Changes since v3:
> >  * fix build warning on the SH platform
> > 
> > Changes since v2:
> >  * of_clk_bulk_get should return -ENOENT;
> > 
> > Changes since v1:
> >  * using %pOF instead of full_name
> > ---
> >  drivers/clk/clk-bulk.c | 31 +++++++++++++++++++++++++++++++
> >  include/linux/clk.h    |  8 ++++++++
> >  2 files changed, 39 insertions(+)
> > 
> > diff --git a/drivers/clk/clk-bulk.c b/drivers/clk/clk-bulk.c
> > index c834f5a..896aa3b 100644
> > --- a/drivers/clk/clk-bulk.c
> > +++ b/drivers/clk/clk-bulk.c
> > @@ -19,6 +19,37 @@
> >  #include <linux/clk.h>
> >  #include <linux/device.h>
> >  #include <linux/export.h>
> > +#include <linux/of.h>
> > +
> > +#if defined(CONFIG_OF) && defined(CONFIG_COMMON_CLK)
> > +int __must_check of_clk_bulk_get(struct device_node *np, int num_clks,
> > +				 struct clk_bulk_data *clks)
> > +{
> > +	int ret;
> > +	int i;
> > +
> > +	for (i = 0; i < num_clks; i++)
> > +		clks[i].clk = NULL;
> > +
> > +	for (i = 0; i < num_clks; i++) {
> > +		clks[i].clk = of_clk_get(np, i);
> > +		if (IS_ERR(clks[i].clk)) {
> > +			ret = PTR_ERR(clks[i].clk);
> > +			pr_err("%pOF: Failed to get clk index: %d ret: %d\n",
> > +			       np, i, ret);
> > +			clks[i].clk = NULL;
> > +			goto err;
> > +		}
> > +	}
> > +
> > +	return 0;
> > +
> > +err:
> > +	clk_bulk_put(i, clks);
> > +
> > +	return ret;
> > +}
> 
> Export the symbol?
> 

Got it.

> > +#endif
> >  
> >  void clk_bulk_put(int num_clks, struct clk_bulk_data *clks)
> >  {
> > diff --git a/include/linux/clk.h b/include/linux/clk.h
> > index 12c96d9..073cb3b 100644
> > --- a/include/linux/clk.h
> > +++ b/include/linux/clk.h
> > @@ -680,10 +680,18 @@ static inline void clk_bulk_disable_unprepare(int num_clks,
> >  }
> >  
> >  #if defined(CONFIG_OF) && defined(CONFIG_COMMON_CLK)
> > +int __must_check of_clk_bulk_get(struct device_node *np, int num_clks,
> > +				 struct clk_bulk_data *clks);
> >  struct clk *of_clk_get(struct device_node *np, int index);
> >  struct clk *of_clk_get_by_name(struct device_node *np, const char *name);
> >  struct clk *of_clk_get_from_provider(struct of_phandle_args *clkspec);
> >  #else
> > +static inline int of_clk_bulk_get(struct device_node *np, int num_clks,
> 
> Do we need __must_check here too?

Yes, you're absolutely right.

of_clk_bulk_get is special as it returns error, so should add __must_check.

> We should do the same for the
> other bulk get APIs. Seems we missed that part last time.
> 

Currently for !CONFIG_HAVE_CLK case, all APIs return 0.
!CONFIG_HAVE_CLK
clk_bulk_get		return 0
devm_clk_bulk_get	return 0
clk_bulk_enable		return 0
clk_bulk_prepare	return 0

Do you think we still need add __must_check for them?

And for CONFIG_HAVE_CLK case, all __must_check already added.

int __must_check clk_bulk_get
int __must_check devm_clk_bulk_get
int __must_check clk_bulk_enable
int __must_check clk_bulk_prepare

And no need for void function.
void clk_bulk_put
void clk_bulk_unprepare
void clk_bulk_disable

> I'll fix all these things up when applying.
> 

I did not see this in latest tree.
Suppose i should resend it with above things fixed, right?

Regards
Dong Aisheng
--
To unsubscribe from this list: send the line "unsubscribe linux-clk" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Stephen Boyd Dec. 21, 2017, 11:20 p.m. UTC | #3
On 12/20, Dong Aisheng wrote:
> On Fri, Sep 29, 2017 at 03:48:21PM -0700, Stephen Boyd wrote:
> > On 09/26, Dong Aisheng wrote:
> > > here to handle this for DT users without 'clock-names' specified.
> 
> > > +#endif
> > >  
> > >  void clk_bulk_put(int num_clks, struct clk_bulk_data *clks)
> > >  {
> > > diff --git a/include/linux/clk.h b/include/linux/clk.h
> > > index 12c96d9..073cb3b 100644
> > > --- a/include/linux/clk.h
> > > +++ b/include/linux/clk.h
> > > @@ -680,10 +680,18 @@ static inline void clk_bulk_disable_unprepare(int num_clks,
> > >  }
> > >  
> > >  #if defined(CONFIG_OF) && defined(CONFIG_COMMON_CLK)
> > > +int __must_check of_clk_bulk_get(struct device_node *np, int num_clks,
> > > +				 struct clk_bulk_data *clks);
> > >  struct clk *of_clk_get(struct device_node *np, int index);
> > >  struct clk *of_clk_get_by_name(struct device_node *np, const char *name);
> > >  struct clk *of_clk_get_from_provider(struct of_phandle_args *clkspec);
> > >  #else
> > > +static inline int of_clk_bulk_get(struct device_node *np, int num_clks,
> > 
> > Do we need __must_check here too?
> 
> Yes, you're absolutely right.
> 
> of_clk_bulk_get is special as it returns error, so should add __must_check.
> 
> > We should do the same for the
> > other bulk get APIs. Seems we missed that part last time.
> > 
> 
> Currently for !CONFIG_HAVE_CLK case, all APIs return 0.
> !CONFIG_HAVE_CLK
> clk_bulk_get		return 0
> devm_clk_bulk_get	return 0
> clk_bulk_enable		return 0
> clk_bulk_prepare	return 0
> 
> Do you think we still need add __must_check for them?

Yes, we need it even when !CONFIG_HAVE_CLK because it allows us
to catch missing checking return values in the non-clk compile
configurations too. More test coverage.

> 
> And for CONFIG_HAVE_CLK case, all __must_check already added.
> 
> int __must_check clk_bulk_get
> int __must_check devm_clk_bulk_get
> int __must_check clk_bulk_enable
> int __must_check clk_bulk_prepare
> 
> And no need for void function.
> void clk_bulk_put
> void clk_bulk_unprepare
> void clk_bulk_disable
> 
> > I'll fix all these things up when applying.
> > 
> 
> I did not see this in latest tree.
> Suppose i should resend it with above things fixed, right?
> 

I dropped it because it seems like maybe we don't need
of_clk_bulk_get(), but more like clk_get_all() or something like
that to acquire all clks for a device. It seems like it isn't DT
specific, and so we should just provide the "all" API instead of
some DT specific one that needs to know how many clks to get. I
think I sent a similar reply on some other thread and added you
to it.
Dong Aisheng Dec. 22, 2017, 2:51 a.m. UTC | #4
On Thu, Dec 21, 2017 at 03:20:32PM -0800, Stephen Boyd wrote:
> On 12/20, Dong Aisheng wrote:
> > On Fri, Sep 29, 2017 at 03:48:21PM -0700, Stephen Boyd wrote:
> > > On 09/26, Dong Aisheng wrote:
> > > > here to handle this for DT users without 'clock-names' specified.
> > 
> > > > +#endif
> > > >  
> > > >  void clk_bulk_put(int num_clks, struct clk_bulk_data *clks)
> > > >  {
> > > > diff --git a/include/linux/clk.h b/include/linux/clk.h
> > > > index 12c96d9..073cb3b 100644
> > > > --- a/include/linux/clk.h
> > > > +++ b/include/linux/clk.h
> > > > @@ -680,10 +680,18 @@ static inline void clk_bulk_disable_unprepare(int num_clks,
> > > >  }
> > > >  
> > > >  #if defined(CONFIG_OF) && defined(CONFIG_COMMON_CLK)
> > > > +int __must_check of_clk_bulk_get(struct device_node *np, int num_clks,
> > > > +				 struct clk_bulk_data *clks);
> > > >  struct clk *of_clk_get(struct device_node *np, int index);
> > > >  struct clk *of_clk_get_by_name(struct device_node *np, const char *name);
> > > >  struct clk *of_clk_get_from_provider(struct of_phandle_args *clkspec);
> > > >  #else
> > > > +static inline int of_clk_bulk_get(struct device_node *np, int num_clks,
> > > 
> > > Do we need __must_check here too?
> > 
> > Yes, you're absolutely right.
> > 
> > of_clk_bulk_get is special as it returns error, so should add __must_check.
> > 
> > > We should do the same for the
> > > other bulk get APIs. Seems we missed that part last time.
> > > 
> > 
> > Currently for !CONFIG_HAVE_CLK case, all APIs return 0.
> > !CONFIG_HAVE_CLK
> > clk_bulk_get		return 0
> > devm_clk_bulk_get	return 0
> > clk_bulk_enable		return 0
> > clk_bulk_prepare	return 0
> > 
> > Do you think we still need add __must_check for them?
> 
> Yes, we need it even when !CONFIG_HAVE_CLK because it allows us
> to catch missing checking return values in the non-clk compile
> configurations too. More test coverage.
> 

Ok, understand.
May cook a patch to fix them.

> > 
> > And for CONFIG_HAVE_CLK case, all __must_check already added.
> > 
> > int __must_check clk_bulk_get
> > int __must_check devm_clk_bulk_get
> > int __must_check clk_bulk_enable
> > int __must_check clk_bulk_prepare
> > 
> > And no need for void function.
> > void clk_bulk_put
> > void clk_bulk_unprepare
> > void clk_bulk_disable
> > 
> > > I'll fix all these things up when applying.
> > > 
> > 
> > I did not see this in latest tree.
> > Suppose i should resend it with above things fixed, right?
> > 
> 
> I dropped it because it seems like maybe we don't need
> of_clk_bulk_get(), but more like clk_get_all() or something like
> that to acquire all clks for a device. It seems like it isn't DT
> specific, and so we should just provide the "all" API instead of
> some DT specific one that needs to know how many clks to get. I
> think I sent a similar reply on some other thread and added you
> to it.
> 

I probably missed it before.
Will check later.

Thanks for reminder.

Regards
Dong Aisheng
--
To unsubscribe from this list: send the line "unsubscribe linux-clk" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
diff mbox

Patch

diff --git a/drivers/clk/clk-bulk.c b/drivers/clk/clk-bulk.c
index c834f5a..896aa3b 100644
--- a/drivers/clk/clk-bulk.c
+++ b/drivers/clk/clk-bulk.c
@@ -19,6 +19,37 @@ 
 #include <linux/clk.h>
 #include <linux/device.h>
 #include <linux/export.h>
+#include <linux/of.h>
+
+#if defined(CONFIG_OF) && defined(CONFIG_COMMON_CLK)
+int __must_check of_clk_bulk_get(struct device_node *np, int num_clks,
+				 struct clk_bulk_data *clks)
+{
+	int ret;
+	int i;
+
+	for (i = 0; i < num_clks; i++)
+		clks[i].clk = NULL;
+
+	for (i = 0; i < num_clks; i++) {
+		clks[i].clk = of_clk_get(np, i);
+		if (IS_ERR(clks[i].clk)) {
+			ret = PTR_ERR(clks[i].clk);
+			pr_err("%pOF: Failed to get clk index: %d ret: %d\n",
+			       np, i, ret);
+			clks[i].clk = NULL;
+			goto err;
+		}
+	}
+
+	return 0;
+
+err:
+	clk_bulk_put(i, clks);
+
+	return ret;
+}
+#endif
 
 void clk_bulk_put(int num_clks, struct clk_bulk_data *clks)
 {
diff --git a/include/linux/clk.h b/include/linux/clk.h
index 12c96d9..073cb3b 100644
--- a/include/linux/clk.h
+++ b/include/linux/clk.h
@@ -680,10 +680,18 @@  static inline void clk_bulk_disable_unprepare(int num_clks,
 }
 
 #if defined(CONFIG_OF) && defined(CONFIG_COMMON_CLK)
+int __must_check of_clk_bulk_get(struct device_node *np, int num_clks,
+				 struct clk_bulk_data *clks);
 struct clk *of_clk_get(struct device_node *np, int index);
 struct clk *of_clk_get_by_name(struct device_node *np, const char *name);
 struct clk *of_clk_get_from_provider(struct of_phandle_args *clkspec);
 #else
+static inline int of_clk_bulk_get(struct device_node *np, int num_clks,
+			   struct clk_bulk_data *clks)
+{
+	return -ENOENT;
+}
+
 static inline struct clk *of_clk_get(struct device_node *np, int index)
 {
 	return ERR_PTR(-ENOENT);