diff options
Diffstat (limited to 'os/hal/include')
| -rw-r--r-- | os/hal/include/pwm.h | 8 |
1 files changed, 3 insertions, 5 deletions
diff --git a/os/hal/include/pwm.h b/os/hal/include/pwm.h index 72430f1aa..2ffd3599c 100644 --- a/os/hal/include/pwm.h +++ b/os/hal/include/pwm.h @@ -150,11 +150,9 @@ typedef void (*pwmcallback_t)(PWMDriver *pwmp); * been activated using @p pwmStart().
* @pre The PWM unit must have been activated using @p pwmStart().
* @post The PWM unit period is changed to the new value.
- * @post Any active channel is disabled by this function and must be
- * activated explicitly using @p pwmEnableChannel().
- * @note Depending on the hardware implementation this function has
- * effect starting on the next cycle (recommended implementation)
- * or immediately (fallback implementation).
+ * @note If a period is specified that is shorter than the pulse width
+ * programmed in one of the channels then the behavior is not
+ * guaranteed.
*
* @param[in] pwmp pointer to a @p PWMDriver object
* @param[in] period new cycle time in ticks
|