Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 9fe9b7ab authored by Stephen Boyd's avatar Stephen Boyd
Browse files

clk: Document deprecated things 



We don't want driver authors to use the struct clk based registration
and provider APIs. Instead, they should use the clk_hw based APIs. Add
some notes in the kerneldoc to this effect.

Signed-off-by: default avatarStephen Boyd <sboyd@kernel.org>
parent 38581ddc

drivers/clk/clk.c

+10 −5
Original line number Diff line number Diff line
@@ -3240,8 +3240,10 @@ void __clk_free_clk(struct clk *clk) 
 * @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

 * clk_register is the *deprecated* interface for populating the clock tree with

 * new clock nodes. Use clk_hw_register() instead.

 *

 * Returns: a pointer to the newly allocated struct clk which

 * cannot be dereferenced by driver code but may be used in conjunction 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.
@@ -3486,9 +3488,10 @@ static void devm_clk_hw_release(struct device *dev, void *res) 
 * @dev: device that is registering this clock

 * @hw: link to hardware-specific clock data

 *

 * Managed clk_register(). Clocks returned from this function are

 * automatically clk_unregister()ed on driver detach. See clk_register() for

 * more information.

 * Managed clk_register(). This function is *deprecated*, use devm_clk_hw_register() instead.

 *

 * Clocks returned from this function are automatically clk_unregister()ed on

 * driver detach. See clk_register() for more information.

 */

struct clk *devm_clk_register(struct device *dev, struct clk_hw *hw)

{
@@ -3820,6 +3823,8 @@ EXPORT_SYMBOL_GPL(of_clk_hw_onecell_get); 
 * @np: Device node pointer associated with clock provider

 * @clk_src_get: callback for decoding clock

 * @data: context pointer for @clk_src_get callback.

 *

 * This function is *deprecated*. Use of_clk_add_hw_provider() instead.

 */

int of_clk_add_provider(struct device_node *np,

			struct clk *(*clk_src_get)(struct of_phandle_args *clkspec,

include/linux/clk-provider.h

+1 −1
Original line number Diff line number Diff line
@@ -24,7 +24,7 @@ 
#define CLK_SET_RATE_PARENT	BIT(2) /* propagate rate change up one level */

#define CLK_IGNORE_UNUSED	BIT(3) /* do not gate even if unused */

				/* unused */

#define CLK_IS_BASIC		BIT(5) /* Basic clk, can't do a to_clk_foo() */

#define CLK_IS_BASIC		BIT(5) /* deprecated, don't use */

#define CLK_GET_RATE_NOCACHE	BIT(6) /* do not use the cached clk rate */

#define CLK_SET_RATE_NO_REPARENT BIT(7) /* don't re-parent on rate change */

#define CLK_GET_ACCURACY_NOCACHE BIT(8) /* do not use the cached clk accuracy */