[v6,02/10] clk: Add kerneldoc to managed of-provider interfaces

Commit Message

Vaittinen, Matti Dec. 4, 2018, 11:33 a.m. UTC

Document the devm_of_clk_del_provider and the
devm_of_clk_add_hw_provider functions.

Signed-off-by: Matti Vaittinen <[e-mail]>
---
 drivers/clk/clk.c | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

Comments

Stephen Boyd Dec. 4, 2018, 7:39 p.m. UTC | #1

Quoting Matti Vaittinen (2018-12-04 03:33:48)
> Document the devm_of_clk_del_provider and the
> devm_of_clk_add_hw_provider functions.
> 
> Signed-off-by: Matti Vaittinen <[e-mail]>
> ---

Applied to clk-next

Patch

diff --git a/drivers/clk/clk.c b/drivers/clk/clk.c
index af011974d4ec..78c90913f987 100644
--- a/drivers/clk/clk.c
+++ b/drivers/clk/clk.c
@@ -3893,6 +3893,17 @@  static void devm_of_clk_release_provider(struct device *dev, void *res)
 	of_clk_del_provider(*(struct device_node **)res);
 }
 
+/**
+ * devm_of_clk_add_hw_provider() - Managed clk provider node registration
+ * @dev: Device acting as the clock provider. Used for DT node and lifetime.
+ * @get: callback for decoding clk_hw
+ * @data: context pointer for @get callback.
+ *
+ * Returns 0 on success or an errno on failure.
+ *
+ * Registers clock provider for given device's node. Provider is automatically
+ * released at device exit.
+ */
 int devm_of_clk_add_hw_provider(struct device *dev,
 			struct clk_hw *(*get)(struct of_phandle_args *clkspec,
 					      void *data),
@@ -3950,6 +3961,10 @@  static int devm_clk_provider_match(struct device *dev, void *res, void *data)
 	return *np == data;
 }
 
+/**
+ * devm_of_clk_del_provider() - Remove clock provider registered using devm
+ * @dev: Device to whose lifetime the clock provider was bound
+ */
 void devm_of_clk_del_provider(struct device *dev)
 {
 	int ret;