All of lore.kernel.org
 help / color / mirror / Atom feed
From: Stephen Boyd <sboyd@kernel.org>
To: Michael Turquette <mturquette@baylibre.com>,
	Stephen Boyd <sboyd@kernel.org>
Cc: linux-kernel@vger.kernel.org, linux-clk@vger.kernel.org
Subject: [PATCH 4/8] clk: Document __clk_mux_determine_rate()
Date: Tue,  2 Apr 2019 16:01:00 -0700	[thread overview]
Message-ID: <20190402230104.105845-5-sboyd@kernel.org> (raw)
In-Reply-To: <20190402230104.105845-1-sboyd@kernel.org>

It had some documentation, but not kerneldoc style so it wasn't getting
picked up. Add some docs so scripts can pick this function out.

Signed-off-by: Stephen Boyd <sboyd@kernel.org>
---
 drivers/clk/clk.c | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/drivers/clk/clk.c b/drivers/clk/clk.c
index 592e315f7cfd..c9860074899b 100644
--- a/drivers/clk/clk.c
+++ b/drivers/clk/clk.c
@@ -519,9 +519,15 @@ void clk_hw_set_rate_range(struct clk_hw *hw, unsigned long min_rate,
 EXPORT_SYMBOL_GPL(clk_hw_set_rate_range);
 
 /*
+ * __clk_mux_determine_rate - clk_ops::determine_rate implementation for a mux type clk
+ * @hw: mux type clk to determine rate on
+ * @req: rate request, also used to return preferred parent and frequencies
+ *
  * Helper for finding best parent to provide a given frequency. This can be used
  * directly as a determine_rate callback (e.g. for a mux), or from a more
  * complex clock that may combine a mux with other operations.
+ *
+ * Returns: 0 on success, -EERROR value on error
  */
 int __clk_mux_determine_rate(struct clk_hw *hw,
 			     struct clk_rate_request *req)
-- 
Sent by a computer through tubes


  parent reply	other threads:[~2019-04-02 23:01 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-04-02 23:00 [PATCH 0/8] Clk documentation updates Stephen Boyd
2019-04-02 23:00 ` [PATCH 1/8] clk: Collapse gpio clk kerneldoc Stephen Boyd
2019-04-02 23:00 ` [PATCH 2/8] clk: Document deprecated things Stephen Boyd
2019-04-02 23:00 ` [PATCH 3/8] clk: Document CLK_MUX_READ_ONLY mux flag Stephen Boyd
2019-04-02 23:01 ` Stephen Boyd [this message]
2019-04-02 23:01 ` [PATCH 5/8] clk: nxp: Drop 'flags' on fixed_rate clk macro Stephen Boyd
2019-04-02 23:01 ` [PATCH 6/8] clk: Remove 'flags' member of struct clk_fixed_rate Stephen Boyd
2019-04-02 23:01 ` [PATCH 7/8] clk: Document and simplify clk_core_get_rate_nolock() Stephen Boyd
2019-04-02 23:01 ` [PATCH 8/8] clk: Drop duplicate clk_register() documentation Stephen Boyd

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20190402230104.105845-5-sboyd@kernel.org \
    --to=sboyd@kernel.org \
    --cc=linux-clk@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mturquette@baylibre.com \
    --subject='Re: [PATCH 4/8] clk: Document __clk_mux_determine_rate()' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.