From: Geert Uytterhoeven <geert+renesas@glider.be>
Date: Wed, 3 Jan 2018 11:06:14 +0000 (+0100)
Subject: clk: Improve flags doc for of_clk_detect_critical()
X-Git-Url: http://git.maquefel.me/?a=commitdiff_plain;h=f7ae75036762618ecc2cc7ae6fb4f6a74af92afb;p=linux.git

clk: Improve flags doc for of_clk_detect_critical()

The "flags" parameter passed to of_clk_detect_critical() cannot be a
pointer to a real clk_core.flags field, as clk_core is private to the
clock framework internals.

Change the comment to refer to top-level framework flags instead.

Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
Signed-off-by: Stephen Boyd <sboyd@codeaurora.org>
---

diff --git a/drivers/clk/clk.c b/drivers/clk/clk.c
index efbc802da3b30..fe2d43e342162 100644
--- a/drivers/clk/clk.c
+++ b/drivers/clk/clk.c
@@ -3912,7 +3912,7 @@ static int parent_ready(struct device_node *np)
  * of_clk_detect_critical() - set CLK_IS_CRITICAL flag from Device Tree
  * @np: Device node pointer associated with clock provider
  * @index: clock index
- * @flags: pointer to clk_core->flags
+ * @flags: pointer to top-level framework flags
  *
  * Detects if the clock-critical property exists and, if so, sets the
  * corresponding CLK_IS_CRITICAL flag.