pwm: Fix kerneldoc for apply operation
diff mbox series

Message ID 20191006044326.12043-1-bjorn.andersson@linaro.org
State Superseded
Headers show
Series
  • pwm: Fix kerneldoc for apply operation
Related show

Commit Message

Bjorn Andersson Oct. 6, 2019, 4:43 a.m. UTC
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 <bjorn.andersson@linaro.org>
---
 include/linux/pwm.h | 5 +----
 1 file changed, 1 insertion(+), 4 deletions(-)

Comments

Uwe Kleine-K├Ânig Oct. 6, 2019, 7:48 p.m. UTC | #1
Hello,

On Sat, Oct 05, 2019 at 09:43:26PM -0700, Bjorn Andersson wrote:
> 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 <bjorn.andersson@linaro.org>

This is a duplicate of https://patchwork.ozlabs.org/patch/1171851/.

Best regards
Uwe

Patch
diff mbox series

diff --git a/include/linux/pwm.h b/include/linux/pwm.h
index b2c9c460947d..8bc86f645d0d 100644
--- a/include/linux/pwm.h
+++ b/include/linux/pwm.h
@@ -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.