Skip to content

Commit a6efb35

Browse files
Uwe Kleine-Königthierryreding
authored andcommitted
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/[email protected]/ 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: 1a7a6e8 ("pwm: Clarify which state pwm_get_state() returns") Signed-off-by: Uwe Kleine-König <[email protected]> Signed-off-by: Thierry Reding <[email protected]>
1 parent 8035e6c commit a6efb35

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

Documentation/driver-api/pwm.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -55,11 +55,11 @@ several parameter at once. For example, if you see pwm_config() and
5555
pwm_{enable,disable}() calls in the same function, this probably means you
5656
should switch to pwm_apply_state().
5757

58-
The PWM user API also allows one to query the last applied PWM state with
59-
pwm_get_last_applied_state(). Note this is different to what the driver has
60-
actually implemented if the request cannot be implemented exactly with the
61-
hardware in use. There is currently no way for consumers to get the actually
62-
implemented settings.
58+
The PWM user API also allows one to query the PWM state that was passed to the
59+
last invocation of pwm_apply_state() using pwm_get_state(). Note this is
60+
different to what the driver has actually implemented if the request cannot be
61+
satisfied exactly with the hardware in use. There is currently no way for
62+
consumers to get the actually implemented settings.
6363

6464
In addition to the PWM state, the PWM API also exposes PWM arguments, which
6565
are the reference PWM config one should use on this PWM.

0 commit comments

Comments
 (0)