]> git.baikalelectronics.ru Git - kernel.git/commit
clk: Improve documentation for devm_clk_get() and its optional variant
authorUwe Kleine-König <u.kleine-koenig@pengutronix.de>
Fri, 20 May 2022 07:57:34 +0000 (09:57 +0200)
committerStephen Boyd <sboyd@kernel.org>
Thu, 16 Jun 2022 02:22:29 +0000 (19:22 -0700)
commit7d5eb68a5f635389ddd6b7ddd147550871924cd7
tree05c8853374b9d4ace5dd00cfe0407bca260d8777
parentf040cca4b0da0180bf9de9141ef5c95f60f85182
clk: Improve documentation for devm_clk_get() and its optional variant

Make use of "Context:" and "Return:". Mention that the clk is not to be
expected to be prepared, previously only not being enabled was mentioned
which probably dates from the times when the concept of clk preparation
wasn't invented yet.

Also describe devm_clk_get_optional() fully instead of just referencing
devm_clk_get().

Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
Link: https://lore.kernel.org/r/20220520075737.758761-2-u.kleine-koenig@pengutronix.de
Reviewed-by: Russell King (Oracle) <rmk+kernel@armlinux.org.uk>
Signed-off-by: Stephen Boyd <sboyd@kernel.org>
include/linux/clk.h