Skip to contentSkip to conversation

pwm: Fix kerneldoc for apply operation

PATCH In review Bjorn Andersson 2 participants 2 messages Oct 6, 2019 PWM

lore
Share & tools
lore
#0 lore raw

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")
---
 include/linux/pwm.h | 5 +----
 1 file changed, 1 insertion(+), 4 deletions(-)
include/linux/pwm.h +1 -4
index b2c9c460947d..8bc86f645d0d 100644
@@ -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
#1 lore raw

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")

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/  |