Skip to content

Commit 8de5781

Browse files
henrikbrixandersennashif
authored andcommitted
doc: releases: 3.0: add CAN related release notes
Add CAN related release notes for Zephyr v3.0.0. Signed-off-by: Henrik Brix Andersen <[email protected]>
1 parent 2abc8cf commit 8de5781

File tree

1 file changed

+44
-2
lines changed

1 file changed

+44
-2
lines changed

doc/releases/release-notes-3.0.rst

Lines changed: 44 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,13 @@ Removed APIs in this release
8585
* Removed ``flash_write_protection_set()`` along with the flash write protection
8686
implementation handler.
8787

88+
* Removed ``CAN_BUS_UNKNOWN`` and changed the signature of
89+
:c:func:`can_get_state` to return an error code instead.
90+
91+
* Removed ``DT_CHOSEN_ZEPHYR_CANBUS_LABEL`` in favor of utilizing
92+
:c:macro:`DEVICE_DT_GET`.
93+
94+
8895
Deprecated in this release
8996
==========================
9097

@@ -96,6 +103,26 @@ Deprecated in this release
96103
:c:macro:`SYS_INIT`.
97104
* :c:func:`device_usable_check` is deprecated in favor of utilizing
98105
:c:func:`device_is_ready`.
106+
* Custom CAN return codes (:c:macro:`CAN_TX_OK`, :c:macro:`CAN_TX_ERR`,
107+
:c:macro:`CAN_TX_ARB_LOST`, :c:macro:`CAN_TX_BUS_OFF`,
108+
:c:macro:`CAN_TX_UNKNOWN`, :c:macro:`CAN_TX_EINVAL`,
109+
:c:macro:`CAN_NO_FREE_FILTER`, and :c:macro:`CAN_TIMEOUT`) are deprecated in
110+
favor of utilizing standard errno error codes.
111+
* :c:func:`can_configure` is deprecated in favor of utilizing
112+
:c:func:`can_set_bitrate` and :c:func:`can_set_mode`.
113+
* :c:func:`can_attach_workq` is deprecated in favor of utilizing
114+
:c:func:`can_add_rx_filter_msgq` and :c:func:`k_work_poll_submit`.
115+
* :c:func:`can_attach_isr` is is deprecated and replaced by
116+
:c:func:`can_add_rx_filter`.
117+
* :c:macro:`CAN_DEFINE_MSGQ` is deprecated and replaced by
118+
:c:macro:`CAN_MSGQ_DEFINE`.
119+
* :c:func:`can_attach_msgq` is deprecated and replaced by
120+
:c:func:`can_add_rx_filter_msgq`.
121+
* :c:func:`can_detach` is deprecated and replaced by
122+
:c:func:`can_remove_rx_filter`.
123+
* :c:func:`can_register_state_change_isr` is deprecated and replaced by
124+
:c:func:`can_set_state_change_callback`.
125+
* :c:func:`can_write` is deprecated in favor of utilizing :c:func:`can_send`.
99126

100127
Stable API changes in this release
101128
==================================
@@ -135,6 +162,11 @@ New APIs in this release
135162
* :c:macro:`DT_INST_ENUM_IDX_OR`
136163
* :c:macro:`DT_INST_PARENT`
137164

165+
* CAN
166+
167+
* Added :c:func:`can_get_max_filters` for retrieving the maximum number of RX
168+
filters support by a CAN controller device.
169+
138170
Kernel
139171
******
140172

@@ -250,8 +282,18 @@ Drivers and Sensors
250282

251283
* CAN
252284

253-
* Add Atmel SAM Bosch m_can CAN-FD Driver
254-
* Added LPCXpresso support for MCAN
285+
* Renamed ``zephyr,can-primary`` chosen property to ``zephyr,canbus``.
286+
* Added :c:macro:`CAN_ERROR_WARNING` CAN controller state.
287+
* Added Atmel SAM Bosch M_CAN CAN-FD driver.
288+
* Added NXP LPCXpresso Bosch M_CAN CAN-FD driver.
289+
* Added ST STM32H7 Bosch M_CAN CAN-FD driver.
290+
* Rework transmission error handling the NXP FlexCAN driver to automatically
291+
retry transmission in case or arbitration lost or missing acknowledge and
292+
to fail early in :c:func:`can_send` if in :c:macro:`CAN_BUS_OFF` state.
293+
* Added support for disabling automatic retransmissions ("one-shot" mode") to
294+
the ST STM32 bxCAN driver.
295+
* Converted the emulated CAN loopback driver to be configured through
296+
devicetree instead of Kconfig.
255297

256298
* Clock Control
257299

0 commit comments

Comments
 (0)