]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
pwm: Remove wrong implementation details from pwm_ops's documentation
authorUwe Kleine-König <ukleinek@baylibre.com>
Fri, 7 Jun 2024 10:42:31 +0000 (12:42 +0200)
committerUwe Kleine-König <ukleinek@kernel.org>
Wed, 10 Jul 2024 15:52:47 +0000 (17:52 +0200)
When .get_state() is called is an implementation detail that
implementors and users shouldn't care about and rely on. Additionally
it's wrong, because with PWM_DEBUG enabled it is called more often.

Just drop the wrong statement.

Signed-off-by: Uwe Kleine-König <u.kleine-koenig@baylibre.com>
Link: https://lore.kernel.org/r/611ba758d7e9fb2695e96b23cb7ceeefb6ba8513.1717756902.git.u.kleine-koenig@baylibre.com
Signed-off-by: Uwe Kleine-König <ukleinek@kernel.org>
include/linux/pwm.h

index 2e225f3b42828a03f05baf1fa65770271926ac91..75ad0d2fd9491ba873fbf6a6654c4aa62d5bdb06 100644 (file)
@@ -252,9 +252,7 @@ struct pwm_capture {
  * @free: optional hook for freeing a PWM
  * @capture: capture and report PWM signal
  * @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.
+ * @get_state: get the current PWM state.
  */
 struct pwm_ops {
        int (*request)(struct pwm_chip *chip, struct pwm_device *pwm);