diff options
Diffstat (limited to 'os/hal/templates')
| -rw-r--r-- | os/hal/templates/pwm_lld.c | 11 |
1 files changed, 5 insertions, 6 deletions
diff --git a/os/hal/templates/pwm_lld.c b/os/hal/templates/pwm_lld.c index 2cd92422f..67683d120 100644 --- a/os/hal/templates/pwm_lld.c +++ b/os/hal/templates/pwm_lld.c @@ -92,16 +92,15 @@ void pwm_lld_stop(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 The function has effect at the next cycle start.
+ * @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
*
- * @api
+ * @notapi
*/
void pwm_lld_change_period(PWMDriver *pwmp, pwmcnt_t period) {
|