From 523e5a6bd5d04852e5063ec6bfc9cb6792cd94fd Mon Sep 17 00:00:00 2001 From: Gerard Marull-Paretas Date: Wed, 27 Apr 2022 12:52:12 +0200 Subject: [PATCH] doc: release-notes: inform anout PWM changes - Inform about deprecated functions - Mention the pwm_dt_spec additions Signed-off-by: Gerard Marull-Paretas --- doc/releases/release-notes-3.1.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/doc/releases/release-notes-3.1.rst b/doc/releases/release-notes-3.1.rst index ea6d93659b..7c31f36eee 100644 --- a/doc/releases/release-notes-3.1.rst +++ b/doc/releases/release-notes-3.1.rst @@ -48,6 +48,15 @@ Deprecated in this release * Deprecated the `gpio_dev`, `gpio_pin` and `gpio_dt_flags` members from spi_cs_control struct in favor of `gpio_dt_spec` gpio. +* PWM + + * The ``pin`` prefix has been removed from all PWM API calls. So for example, + ``pwm_pin_set_cycles`` is now ``pwm_set_cycles``. The old API calls are + still provided but marked as deprecated. + * The PWM period is now always set in nanoseconds, so the ``_nsec`` and + ``_usec`` set functions have been deprecated. Other units can be specified + using, e.g. ``PWM_USEC()`` macros, which convert down to nanoseconds. + Stable API changes in this release ================================== @@ -168,6 +177,11 @@ Drivers and Sensors * PWM + * Added :c:struct:`pwm_dt_spec` and associated helpers, e.g. + :c:macro:`PWM_DT_SPEC_GET` or :c:func:`pwm_set_dt`. This addition makes it + easier to use the PWM API when the PWM channel, period and flags are taken + from a Devicetree PWM cell. + * Sensor * Serial