Skip to content

Commit 1303a1f

Browse files
rodrigopexstephanosio
authored andcommitted
doc: release notes: zbus
Add the new subsystem zbus information to Zephyr 3.3 release notes. Signed-off-by: Rodrigo Peixoto <[email protected]>
1 parent c9225e4 commit 1303a1f

File tree

1 file changed

+55
-0
lines changed

1 file changed

+55
-0
lines changed

doc/releases/release-notes-3.3.rst

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,11 @@ Changes in this release
124124
members for indicating standard/extended CAN ID, Remote Transmission Request
125125
(RTR), and added support for filtering of CAN-FD format frames.
126126

127+
* New :ref:`Zephyr message bus (Zbus) <zbus>` subsystem added; a message-oriented
128+
bus that enables one-to-one, one-to-many and many-to-many communication
129+
between threads.
130+
131+
127132
Removed APIs in this release
128133
============================
129134

@@ -1532,6 +1537,56 @@ Libraries / Subsystems
15321537
* Added the linear range API to map values in a linear range to a range index
15331538
:zephyr_file:`include/zephyr/sys/linear_range.h`.
15341539

1540+
1541+
* Zbus
1542+
1543+
* Added the :ref:`zbus` to Zephyr.
1544+
1545+
* Channel-centric multi-paradigm (message-passing and publish-subscribe) communication message bus.
1546+
* Virtual Distributed Event Dispatcher.
1547+
* Observers can be listeners (synchronous) and subscribers (asynchronous).
1548+
* One-to-one, one-to-many, and many-to-many communications.
1549+
* Persistent messages distributed by shared-memory approach.
1550+
* Delivery guarantee only for listeners.
1551+
* Uses mutex to control channels access.
1552+
* Added the following samples:
1553+
1554+
* :ref:`zbus-hello-world-sample`
1555+
* :ref:`zbus-work-queue-sample`
1556+
* :ref:`zbus-dyn-channel-sample`
1557+
* :ref:`zbus-uart-bridge-sample`
1558+
* :ref:`zbus-remote-mock-sample`
1559+
* :ref:`zbus-runtime-obs-registration-sample`
1560+
* :ref:`zbus-benchmark-sample`
1561+
1562+
* Added zbus channels APIs:
1563+
1564+
* :c:func:`zbus_chan_pub`
1565+
* :c:func:`zbus_chan_read`
1566+
* :c:func:`zbus_chan_notify`
1567+
* :c:func:`zbus_chan_claim`
1568+
* :c:func:`zbus_chan_finish`
1569+
* :c:func:`zbus_chan_name`
1570+
* :c:func:`zbus_chan_msg`
1571+
* :c:func:`zbus_chan_const_msg`
1572+
* :c:func:`zbus_chan_msg_size`
1573+
* :c:func:`zbus_chan_user_data`
1574+
* :c:func:`zbus_chan_add_obs`
1575+
* :c:func:`zbus_chan_rm_obs`
1576+
* :c:func:`zbus_runtime_obs_pool`
1577+
* :c:func:`zbus_obs_set_enable`
1578+
* :c:func:`zbus_obs_name`
1579+
* :c:func:`zbus_sub_wait`
1580+
* :c:func:`zbus_iterate_over_channels`
1581+
* :c:func:`zbus_iterate_over_observers`
1582+
1583+
* Added the related configuration options:
1584+
1585+
* :kconfig:option:`CONFIG_ZBUS_CHANNEL_NAME`
1586+
* :kconfig:option:`CONFIG_ZBUS_OBSERVER_NAME`
1587+
* :kconfig:option:`CONFIG_ZBUS_STRUCTS_ITERABLE_ACCESS`
1588+
* :kconfig:option:`CONFIG_ZBUS_RUNTIME_OBSERVERS_POOL_SIZE`
1589+
15351590
HALs
15361591
****
15371592

0 commit comments

Comments
 (0)