Skip to content

Commit 523e5a6

Browse files
gmarullcarlescufi
authored andcommitted
doc: release-notes: inform anout PWM changes
- Inform about deprecated functions - Mention the pwm_dt_spec additions Signed-off-by: Gerard Marull-Paretas <[email protected]>
1 parent ae91933 commit 523e5a6

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

doc/releases/release-notes-3.1.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,15 @@ Deprecated in this release
4848
* Deprecated the `gpio_dev`, `gpio_pin` and `gpio_dt_flags` members from
4949
spi_cs_control struct in favor of `gpio_dt_spec` gpio.
5050

51+
* PWM
52+
53+
* The ``pin`` prefix has been removed from all PWM API calls. So for example,
54+
``pwm_pin_set_cycles`` is now ``pwm_set_cycles``. The old API calls are
55+
still provided but marked as deprecated.
56+
* The PWM period is now always set in nanoseconds, so the ``_nsec`` and
57+
``_usec`` set functions have been deprecated. Other units can be specified
58+
using, e.g. ``PWM_USEC()`` macros, which convert down to nanoseconds.
59+
5160
Stable API changes in this release
5261
==================================
5362

@@ -168,6 +177,11 @@ Drivers and Sensors
168177

169178
* PWM
170179

180+
* Added :c:struct:`pwm_dt_spec` and associated helpers, e.g.
181+
:c:macro:`PWM_DT_SPEC_GET` or :c:func:`pwm_set_dt`. This addition makes it
182+
easier to use the PWM API when the PWM channel, period and flags are taken
183+
from a Devicetree PWM cell.
184+
171185
* Sensor
172186

173187
* Serial

0 commit comments

Comments
 (0)