Skip to content

Commit 84aefaf

Browse files
rddunlapbebarino
authored andcommitted
clk: linux/clk-provider.h: fix kernel-doc warnings and typos
Fix spelling of "Structure". Fix multiple kernel-doc warnings: clk-provider.h:269: warning: Function parameter or member 'recalc_rate' not described in 'clk_ops' clk-provider.h:468: warning: Function parameter or member 'parent_data' not described in 'clk_hw_register_fixed_rate_with_accuracy_parent_data' clk-provider.h:468: warning: Excess function parameter 'parent_name' description in 'clk_hw_register_fixed_rate_with_accuracy_parent_data' clk-provider.h:482: warning: Function parameter or member 'parent_data' not described in 'clk_hw_register_fixed_rate_parent_accuracy' clk-provider.h:482: warning: Excess function parameter 'parent_name' description in 'clk_hw_register_fixed_rate_parent_accuracy' clk-provider.h:687: warning: Function parameter or member 'flags' not described in 'clk_divider' clk-provider.h:1164: warning: Function parameter or member 'flags' not described in 'clk_fractional_divider' clk-provider.h:1164: warning: Function parameter or member 'approximation' not described in 'clk_fractional_divider' clk-provider.h:1213: warning: Function parameter or member 'flags' not described in 'clk_multiplier' Fixes: 9fba738 ("clk: add duty cycle support") Fixes: b247649 ("clk: introduce the common clock framework") Fixes: 2d34f09 ("clk: fixed-rate: Add support for specifying parents via DT/pointers") Fixes: f5290d8 ("clk: asm9260: use parent index to link the reference clock") Fixes: 9d9f78e ("clk: basic clock hardware types") Fixes: e2d0e90 ("clk: new basic clk type for fractional divider") Fixes: f2e0a53 ("clk: Add a basic multiplier clock") Signed-off-by: Randy Dunlap <[email protected]> Cc: Michael Turquette <[email protected]> Cc: Stephen Boyd <[email protected]> Cc: [email protected] Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Stephen Boyd <[email protected]>
1 parent 0bb80ec commit 84aefaf

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

include/linux/clk-provider.h

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ void clk_hw_forward_rate_request(const struct clk_hw *core,
7474
unsigned long parent_rate);
7575

7676
/**
77-
* struct clk_duty - Struture encoding the duty cycle ratio of a clock
77+
* struct clk_duty - Structure encoding the duty cycle ratio of a clock
7878
*
7979
* @num: Numerator of the duty cycle ratio
8080
* @den: Denominator of the duty cycle ratio
@@ -129,7 +129,7 @@ struct clk_duty {
129129
* @restore_context: Restore the context of the clock after a restoration
130130
* of power.
131131
*
132-
* @recalc_rate Recalculate the rate of this clock, by querying hardware. The
132+
* @recalc_rate: Recalculate the rate of this clock, by querying hardware. The
133133
* parent rate is an input parameter. It is up to the caller to
134134
* ensure that the prepare_mutex is held across this call. If the
135135
* driver cannot figure out a rate for this clock, it must return
@@ -456,7 +456,7 @@ struct clk *clk_register_fixed_rate(struct device *dev, const char *name,
456456
* clock with the clock framework
457457
* @dev: device that is registering this clock
458458
* @name: name of this clock
459-
* @parent_name: name of clock's parent
459+
* @parent_data: name of clock's parent
460460
* @flags: framework-specific flags
461461
* @fixed_rate: non-adjustable clock rate
462462
* @fixed_accuracy: non-adjustable clock accuracy
@@ -471,7 +471,7 @@ struct clk *clk_register_fixed_rate(struct device *dev, const char *name,
471471
* the clock framework
472472
* @dev: device that is registering this clock
473473
* @name: name of this clock
474-
* @parent_name: name of clock's parent
474+
* @parent_data: name of clock's parent
475475
* @flags: framework-specific flags
476476
* @fixed_rate: non-adjustable clock rate
477477
*/
@@ -649,7 +649,7 @@ struct clk_div_table {
649649
* Clock with an adjustable divider affecting its output frequency. Implements
650650
* .recalc_rate, .set_rate and .round_rate
651651
*
652-
* Flags:
652+
* @flags:
653653
* CLK_DIVIDER_ONE_BASED - by default the divisor is the value read from the
654654
* register plus one. If CLK_DIVIDER_ONE_BASED is set then the divider is
655655
* the raw value read from the register, with the value of zero considered
@@ -1130,11 +1130,12 @@ struct clk_hw *clk_hw_register_fixed_factor_parent_hw(struct device *dev,
11301130
* @mwidth: width of the numerator bit field
11311131
* @nshift: shift to the denominator bit field
11321132
* @nwidth: width of the denominator bit field
1133+
* @approximation: clk driver's callback for calculating the divider clock
11331134
* @lock: register lock
11341135
*
11351136
* Clock with adjustable fractional divider affecting its output frequency.
11361137
*
1137-
* Flags:
1138+
* @flags:
11381139
* CLK_FRAC_DIVIDER_ZERO_BASED - by default the numerator and denominator
11391140
* is the value read from the register. If CLK_FRAC_DIVIDER_ZERO_BASED
11401141
* is set then the numerator and denominator are both the value read
@@ -1191,7 +1192,7 @@ void clk_hw_unregister_fractional_divider(struct clk_hw *hw);
11911192
* Clock with an adjustable multiplier affecting its output frequency.
11921193
* Implements .recalc_rate, .set_rate and .round_rate
11931194
*
1194-
* Flags:
1195+
* @flags:
11951196
* CLK_MULTIPLIER_ZERO_BYPASS - By default, the multiplier is the value read
11961197
* from the register, with 0 being a valid value effectively
11971198
* zeroing the output clock rate. If CLK_MULTIPLIER_ZERO_BYPASS is

0 commit comments

Comments
 (0)