Commit a6efb350 authored by Uwe Kleine-König's avatar Uwe Kleine-König Committed by Thierry Reding

pwm: Reword docs about pwm_apply_state()

The main issue is that the current documentation talks about the
non-existent function pwm_get_last_applied_state. (This was right in the
context of
https://lore.kernel.org/linux-pwm/20210406073036.26857-1-u.kleine-koenig@pengutronix.de/
but was then missed to adapt when this patch was reduced to a
documentation update.)

While at is also clarify "last applied PWM state" to "PWM state that was
passed to the last invocation of pwm_apply_state()" to better
distinguish to the last actually implemented state and reword to drop a
word repetition.

Fixes: 1a7a6e80 ("pwm: Clarify which state pwm_get_state() returns")
Signed-off-by: default avatarUwe Kleine-König <u.kleine-koenig@pengutronix.de>
Signed-off-by: default avatarThierry Reding <thierry.reding@gmail.com>
parent 8035e6c6
...@@ -55,11 +55,11 @@ several parameter at once. For example, if you see pwm_config() and ...@@ -55,11 +55,11 @@ several parameter at once. For example, if you see pwm_config() and
pwm_{enable,disable}() calls in the same function, this probably means you pwm_{enable,disable}() calls in the same function, this probably means you
should switch to pwm_apply_state(). should switch to pwm_apply_state().
The PWM user API also allows one to query the last applied PWM state with The PWM user API also allows one to query the PWM state that was passed to the
pwm_get_last_applied_state(). Note this is different to what the driver has last invocation of pwm_apply_state() using pwm_get_state(). Note this is
actually implemented if the request cannot be implemented exactly with the different to what the driver has actually implemented if the request cannot be
hardware in use. There is currently no way for consumers to get the actually satisfied exactly with the hardware in use. There is currently no way for
implemented settings. consumers to get the actually implemented settings.
In addition to the PWM state, the PWM API also exposes PWM arguments, which In addition to the PWM state, the PWM API also exposes PWM arguments, which
are the reference PWM config one should use on this PWM. are the reference PWM config one should use on this PWM.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment