Commit d1d53909 authored by Sam Protsenko's avatar Sam Protsenko Committed by Krzysztof Kozlowski

clk: samsung: Fix kernel-doc comments

Fix some issues found in kernel-doc comments in Samsung CCF framework.
It makes scripts/kernel-doc happy, which can be checked with:

    $ find drivers/clk/samsung/ -name '*.[ch]' -exec \
      scripts/kernel-doc -v -none {} \;
Signed-off-by: default avatarSam Protsenko <semen.protsenko@linaro.org>
Fixes: ddeac8d9 ("clk: samsung: add infrastructure to register cpu clocks")
Fixes: 721c42a3 ("clk: samsung: add common clock framework helper functions for Samsung platforms")
Fixes: 3ff6e0d8 ("clk: samsung: Add support to register rate_table for samsung plls")
Reviewed-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Tested-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Link: https://lore.kernel.org/r/20231109190925.2066-1-semen.protsenko@linaro.orgSigned-off-by: default avatarKrzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
parent b85ea95d
...@@ -11,7 +11,7 @@ ...@@ -11,7 +11,7 @@
#include "clk.h" #include "clk.h"
/** /**
* struct exynos_cpuclk_data: config data to setup cpu clocks. * struct exynos_cpuclk_cfg_data: config data to setup cpu clocks.
* @prate: frequency of the primary parent clock (in KHz). * @prate: frequency of the primary parent clock (in KHz).
* @div0: value to be programmed in the div_cpu0 register. * @div0: value to be programmed in the div_cpu0 register.
* @div1: value to be programmed in the div_cpu1 register. * @div1: value to be programmed in the div_cpu1 register.
......
...@@ -55,7 +55,7 @@ struct samsung_clock_alias { ...@@ -55,7 +55,7 @@ struct samsung_clock_alias {
* @name: name of this fixed-rate clock. * @name: name of this fixed-rate clock.
* @parent_name: optional parent clock name. * @parent_name: optional parent clock name.
* @flags: optional fixed-rate clock flags. * @flags: optional fixed-rate clock flags.
* @fixed-rate: fixed clock rate of this clock. * @fixed_rate: fixed clock rate of this clock.
*/ */
struct samsung_fixed_rate_clock { struct samsung_fixed_rate_clock {
unsigned int id; unsigned int id;
...@@ -74,7 +74,7 @@ struct samsung_fixed_rate_clock { ...@@ -74,7 +74,7 @@ struct samsung_fixed_rate_clock {
.fixed_rate = frate, \ .fixed_rate = frate, \
} }
/* /**
* struct samsung_fixed_factor_clock: information about fixed-factor clock * struct samsung_fixed_factor_clock: information about fixed-factor clock
* @id: platform specific id of the clock. * @id: platform specific id of the clock.
* @name: name of this fixed-factor clock. * @name: name of this fixed-factor clock.
...@@ -146,14 +146,16 @@ struct samsung_mux_clock { ...@@ -146,14 +146,16 @@ struct samsung_mux_clock {
__MUX(_id, cname, pnames, o, s, w, f, mf) __MUX(_id, cname, pnames, o, s, w, f, mf)
/** /**
* @id: platform specific id of the clock.
* struct samsung_div_clock: information about div clock * struct samsung_div_clock: information about div clock
* @id: platform specific id of the clock.
* @name: name of this div clock. * @name: name of this div clock.
* @parent_name: name of the parent clock. * @parent_name: name of the parent clock.
* @flags: optional flags for basic clock. * @flags: optional flags for basic clock.
* @offset: offset of the register for configuring the div. * @offset: offset of the register for configuring the div.
* @shift: starting bit location of the div control bit-field in @reg. * @shift: starting bit location of the div control bit-field in @reg.
* @width: width of the bitfield.
* @div_flags: flags for div-type clock. * @div_flags: flags for div-type clock.
* @table: array of divider/value pairs ending with a div set to 0.
*/ */
struct samsung_div_clock { struct samsung_div_clock {
unsigned int id; unsigned int id;
...@@ -244,6 +246,7 @@ struct samsung_clk_reg_dump { ...@@ -244,6 +246,7 @@ struct samsung_clk_reg_dump {
* @con_offset: offset of the register for configuring the PLL. * @con_offset: offset of the register for configuring the PLL.
* @lock_offset: offset of the register for locking the PLL. * @lock_offset: offset of the register for locking the PLL.
* @type: Type of PLL to be registered. * @type: Type of PLL to be registered.
* @rate_table: array of PLL settings for possible PLL rates.
*/ */
struct samsung_pll_clock { struct samsung_pll_clock {
unsigned int id; unsigned int id;
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment