pwm: Clarify which state pwm_get_state() returns
authorUwe Kleine-König <u.kleine-koenig@pengutronix.de>
Tue, 6 Apr 2021 07:30:36 +0000 (09:30 +0200)
committerThierry Reding <thierry.reding@gmail.com>
Fri, 9 Apr 2021 12:17:03 +0000 (14:17 +0200)
commit1a7a6e8072ea0e4582de2da63a9088841fde798e
treec06c96d6547f620a8733a1134b1c01ab5207bcaf
parent9666cec380d60808eb86d3be4caf84faeebe3081
pwm: Clarify which state pwm_get_state() returns

Given that lowlevel drivers usually cannot implement exactly what a
consumer requests with pwm_apply_state() there is some rounding
involved.

pwm_get_state() returns the setting that was requested most recently by
the consumer (opposed to what was actually implemented in hardware in
reply to the last request). Clarify this in the function kerneldoc.

Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
Signed-off-by: Thierry Reding <thierry.reding@gmail.com>
Documentation/driver-api/pwm.rst
include/linux/pwm.h