pwm: Document that the pinstate of a disabled PWM isn't reliable
authorUwe Kleine-König <u.kleine-koenig@pengutronix.de>
Tue, 17 May 2022 15:05:55 +0000 (17:05 +0200)
committerThierry Reding <thierry.reding@gmail.com>
Fri, 20 May 2022 14:36:07 +0000 (16:36 +0200)
commit80a22fde803af6f390be49ee5ced6ee75595ba05
treef3e43e450f04d9876b4eea558aa547f334096c8c
parenta1bbf823e5e9178ec2f70dd52345fd1a57efe145
pwm: Document that the pinstate of a disabled PWM isn't reliable

Some (most?) drivers emit the inactive state when the PWM is disabled.
However there are exceptions, so document that a consumer better doesn't
depend on this behaviour.

Some known exceptions:

  - imx27 emits 0 independent of the configured polarity
  - mxs just drives the output to the last emitted state.
  - iqs620a makes the output tristated on disable, so an external
    pull-down would be required.

Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
Acked-by: Alexander Stein <alexander.stein@ew.tq-group.com>
Signed-off-by: Thierry Reding <thierry.reding@gmail.com>
Documentation/driver-api/pwm.rst