clk: Document __clk_mux_determine_rate()
authorStephen Boyd <sboyd@kernel.org>
Tue, 11 Dec 2018 21:24:50 +0000 (13:24 -0800)
committerStephen Boyd <sboyd@kernel.org>
Thu, 24 Jan 2019 22:21:14 +0000 (14:21 -0800)
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

index 592e315..c986007 100644 (file)
@@ -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)