From 31ae13eeb16f726e56fbcfc0820675811b2f3362 Mon Sep 17 00:00:00 2001 From: Alexander Wachter Date: Mon, 27 Apr 2020 11:11:43 +0200 Subject: [PATCH] drivers: pwm: Clarify period parameter Clarify what happens when the period parameter is zero or equal to the period. Signed-off-by: Alexander Wachter --- include/drivers/pwm.h | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/include/drivers/pwm.h b/include/drivers/pwm.h index 4b7c7ec4556c60..a3261260441bf6 100644 --- a/include/drivers/pwm.h +++ b/include/drivers/pwm.h @@ -59,6 +59,11 @@ __subsystem struct pwm_driver_api { /** * @brief Set the period and pulse width for a single PWM output. + * + * Passing 0 to the @param pulse will cause the pin to be driven to a constant + * inactive level. + * Passing a @param pulse equal @param period will cause the pin to be driven + * to a constant active level. * * @param dev Pointer to the device structure for the driver instance. * @param pwm PWM pin.