diff options
author | Geert Uytterhoeven <geert+renesas@glider.be> | 2014-04-22 15:11:42 +0200 |
---|---|---|
committer | Mike Turquette <mturquette@linaro.org> | 2014-05-13 02:08:33 +0200 |
commit | 54e73016dd217be915ed83353d296f2a133d1ad5 (patch) | |
tree | c8b83281415528d75a32842d1062780cc216d3ee /Documentation/clk.txt | |
parent | clk: Fixup spacing in comments (diff) | |
download | linux-54e73016dd217be915ed83353d296f2a133d1ad5.tar.xz linux-54e73016dd217be915ed83353d296f2a133d1ad5.zip |
clk: Improve clk_ops documentation
General:
- Add parameter names to .round_rate() and .set_rate().
Documentation/clk.txt:
- Add missing parameter for .set_rate(),
- Add missing .debug_init().
include/linux/clk-provider.h:
- Add parent rate documentation for .round_rate(),
- Reorder documentation to match implementation order,
- Add missing documentation for .init().
Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
Signed-off-by: Mike Turquette <mturquette@linaro.org>
Diffstat (limited to 'Documentation/clk.txt')
-rw-r--r-- | Documentation/clk.txt | 16 |
1 files changed, 11 insertions, 5 deletions
diff --git a/Documentation/clk.txt b/Documentation/clk.txt index c9c399af7c08..1fee72f4d331 100644 --- a/Documentation/clk.txt +++ b/Documentation/clk.txt @@ -68,21 +68,27 @@ the operations defined in clk.h: int (*is_enabled)(struct clk_hw *hw); unsigned long (*recalc_rate)(struct clk_hw *hw, unsigned long parent_rate); - long (*round_rate)(struct clk_hw *hw, unsigned long, - unsigned long *); + long (*round_rate)(struct clk_hw *hw, + unsigned long rate, + unsigned long *parent_rate); long (*determine_rate)(struct clk_hw *hw, unsigned long rate, unsigned long *best_parent_rate, struct clk **best_parent_clk); int (*set_parent)(struct clk_hw *hw, u8 index); u8 (*get_parent)(struct clk_hw *hw); - int (*set_rate)(struct clk_hw *hw, unsigned long); + int (*set_rate)(struct clk_hw *hw, + unsigned long rate, + unsigned long parent_rate); int (*set_rate_and_parent)(struct clk_hw *hw, unsigned long rate, - unsigned long parent_rate, u8 index); + unsigned long parent_rate, + u8 index); unsigned long (*recalc_accuracy)(struct clk_hw *hw, - unsigned long parent_accuracy); + unsigned long parent_accuracy); void (*init)(struct clk_hw *hw); + int (*debug_init)(struct clk_hw *hw, + struct dentry *dentry); }; Part 3 - hardware clk implementations |