diff mbox series

[4/8] clk: Document __clk_mux_determine_rate()

Message ID 20190402230104.105845-5-sboyd@kernel.org (mailing list archive)
State New, archived
Headers show
Series Clk documentation updates | expand

Commit Message

Stephen Boyd April 2, 2019, 11:01 p.m. UTC
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 mbox series


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,
+ * __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)