pwm: Fix kerneldoc for apply operation
PATCH 1/1 pwm: Fix kerneldoc for apply operation
As the @state passed to apply() is now const the comment in the kerneldoc about drivers being expected to adjust the parameters is no longer valid. Update it to reflect the API change.
Fixes 71523d1812ac ("pwm: Ensure pwm_apply_state() doesn't modify the state argument")
Signed-off-by Bjorn Andersson <[email protected]>
--- include/linux/pwm.h | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-)
include/linux/pwm.h +1 -4
@@ -243,10 +243,7 @@ pwm_set_relative_duty_cycle(struct pwm_state *state, unsigned int duty_cycle,* @request: optional hook for requesting a PWM * @free: optional hook for freeing a PWM * @capture: capture and report PWM signal -* @apply: atomically apply a new PWM config. The state argument -* should be adjusted with the real hardware config (if the -* approximate the period or duty_cycle value, state should -* reflect it) +* @apply: atomically apply a new PWM config. * @get_state: get the current PWM state. This function is only * called once per PWM device when the PWM chip is * registered.
Signature · 1 line
2.18.0
Hello,
Quoted 6 lines · Bjorn Andersson
As the @state passed to
apply()is now const the comment in the kerneldoc about drivers being expected to adjust the parameters is no longer valid. Update it to reflect the API change.Fixes 71523d1812ac ("pwm: Ensure pwm_apply_state() doesn't modify the state argument")Signed-off-by Bjorn Andersson <[email protected]>
This is a duplicate of https://patchwork.ozlabs.org/patch/1171851/.
Best regards
Uwe
Signature · 2 lines
Pengutronix e.K. | Uwe Kleine-König | Industrial Linux Solutions | http://www.pengutronix.de/ |