drivers: pwm: Clarify period parameter

Clarify what happens when the period parameter is zero or equal to the period. Signed-off-by: Alexander Wachter <[email protected]>
zephyrproject-rtos · May 19, 2020 · 31ae13e · 31ae13e
1 parent f6bbad8
commit 31ae13e
Showing 1 changed file with 5 additions and 0 deletions.
diff --git 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.