Re: [PATCH v2 6/6] pwm: update comment on struct pwm_ops::apply
From: Bjorn Andersson
Date: Mon Oct 07 2019 - 01:01:05 EST
On Fri, Oct 4, 2019 at 6:33 AM Rasmus Villemoes
<linux@xxxxxxxxxxxxxxxxxx> wrote:
>
> Commit 71523d1812ac (pwm: Ensure pwm_apply_state() doesn't modify the
> state argument) updated the kernel-doc for pwm_apply_state(), but not
> for the ->apply callback in the pwm_ops struct.
>
> Signed-off-by: Rasmus Villemoes <linux@xxxxxxxxxxxxxxxxxx>
Reviewed-by: Bjorn Andersson <bjorn.andersson@xxxxxxxxxx>
> ---
> include/linux/pwm.h | 5 +----
> 1 file changed, 1 insertion(+), 4 deletions(-)
>
> diff --git a/include/linux/pwm.h b/include/linux/pwm.h
> index b2c9c460947d..0ef808d925bb 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.
> --
> 2.20.1
>