]> asedeno.scripts.mit.edu Git - linux.git/commitdiff
clk: Drop duplicate clk_register() documentation
authorStephen Boyd <sboyd@kernel.org>
Tue, 2 Apr 2019 22:54:10 +0000 (15:54 -0700)
committerStephen Boyd <sboyd@kernel.org>
Tue, 2 Apr 2019 22:54:10 +0000 (15:54 -0700)
clk_register() isn't the main way to register a clk anymore. Developers
should use clk_hw_register() instead. Furthermore, this whole chunk of
documentation duplicates what's in the C file, so let's just use that.

Signed-off-by: Stephen Boyd <sboyd@kernel.org>
include/linux/clk-provider.h

index a1705a0f08c7176ac4404083552ba970fedb0df3..677df7865ac888afeb9989d91d311ff1a9fd700e 100644 (file)
@@ -751,17 +751,6 @@ struct clk_hw *clk_hw_register_gpio_mux(struct device *dev, const char *name,
                unsigned long flags);
 void clk_hw_unregister_gpio_mux(struct clk_hw *hw);
 
-/**
- * clk_register - allocate a new clock, register it and return an opaque cookie
- * @dev: device that is registering this clock
- * @hw: link to hardware-specific clock data
- *
- * clk_register is the primary interface for populating the clock tree with new
- * clock nodes.  It returns a pointer to the newly allocated struct clk which
- * cannot be dereferenced by driver code but may be used in conjuction with the
- * rest of the clock API.  In the event of an error clk_register will return an
- * error code; drivers must test for an error code after calling clk_register.
- */
 struct clk *clk_register(struct device *dev, struct clk_hw *hw);
 struct clk *devm_clk_register(struct device *dev, struct clk_hw *hw);