Skip to content

Commit d781945

Browse files
henrikbrixandersenmbolivar-nordic
authored andcommitted
doc: releases: 3.1: add CAN related release notes
Add CAN related release notes for Zephyr v3.1.0. Signed-off-by: Henrik Brix Andersen <[email protected]>
1 parent 39f3d2d commit d781945

File tree

1 file changed

+67
-0
lines changed

1 file changed

+67
-0
lines changed

doc/releases/release-notes-3.1.rst

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,41 @@ Changes in this release
3636
with SD cards. See :ref:`the disk access api <disk_access_api>` for an
3737
example of the new devicetree binding format required.
3838

39+
* CAN
40+
41+
* Added ``const struct device`` parameter to the following CAN callback function signatures:
42+
43+
* ``can_tx_callback_t``
44+
* ``can_rx_callback_t``
45+
* ``can_state_change_callback_t``
46+
47+
* Allow calling the following CAN API functions from userspace:
48+
49+
* :c:func:`can_set_mode()`
50+
* :c:func:`can_calc_timing()`
51+
* :c:func:`can_calc_timing_data()`
52+
* :c:func:`can_set_bitrate()`
53+
* :c:func:`can_get_max_filters()`
54+
55+
* Changed :c:func:`can_set_bitrate()` to use a sample point of 75.0% for bitrates over 800 kbit/s,
56+
80.0% for bitrates over 500 kbit/s, and 87.5% for all other bitrates.
57+
58+
* Split CAN classic and CAN-FD APIs:
59+
60+
* :c:func:`can_set_timing()` split into :c:func:`can_set_timing()` and
61+
:c:func:`can_set_timing_data()`.
62+
* :c:func:`can_set_bitrate()` split into :c:func:`can_set_bitrate()` and
63+
:c:func:`can_set_bitrate_data()`.
64+
65+
* Converted the ``enum can_mode`` into a ``can_mode_t`` bitfield and renamed the CAN mode
66+
definitions:
67+
68+
* ``CAN_NORMAL_MODE`` renamed to :c:macro:`CAN_MODE_NORMAL`.
69+
* ``CAN_SILENT_MODE`` renamed to :c:macro:`CAN_MODE_LISTENONLY`.
70+
* ``CAN_LOOPBACK_MODE`` renamed to :c:macro:`CAN_MODE_LOOPBACK`.
71+
* The previous ``CAN_SILENT_LOOPBACK_MODE`` can be set using the bitmask ``(CAN_MODE_LISTENONLY |
72+
CAN_MODE_LOOPBACK)``.
73+
3974
Removed APIs in this release
4075
============================
4176

@@ -49,6 +84,19 @@ Removed APIs in this release
4984
* ``CONFIG_GPIO_STM32_SWJ_NOJTAG``
5085
* ``CONFIG_GPIO_STM32_SWJ_DISABLE``
5186

87+
* Removed experimental 6LoCAN protocol support.
88+
89+
* Removed the following deprecated CAN APIs:
90+
91+
* Custom CAN error codes
92+
* ``can_configure()``
93+
* ``can_attach_workq()``
94+
* ``can_attach_isr()``
95+
* ``can_attach_msgq()``
96+
* ``can_detach()``
97+
* ``can_register_state_change_isr()``
98+
* ``can_write()``
99+
52100
Deprecated in this release
53101
==========================
54102

@@ -105,6 +153,16 @@ New APIs in this release
105153
* Added a :ref:`MIPI-DSI api <mipi_dsi_api>`. This is an experimental API,
106154
some of the features/APIs will be implemented later.
107155

156+
* CAN
157+
158+
* Added support for getting the minimum/maximum supported CAN timing parameters:
159+
160+
* :c:func:`can_get_timing_min()`
161+
* :c:func:`can_get_timing_max()`
162+
* :c:func:`can_get_timing_data_min()`
163+
* :c:func:`can_get_timing_data_max()`
164+
165+
* Added support for enabling/disabling CAN-FD mode at runtime using :c:macro:`CAN_MODE_FD`.
108166

109167
Kernel
110168
******
@@ -168,6 +226,15 @@ Drivers and Sensors
168226

169227
* CAN
170228

229+
* Switched from transmitting CAN frames in FIFO/chronological order to transmitting according to
230+
CAN-ID priority (NXP FlexCAN, ST STM32 bxCAN, Bosch M_CAN, Microchip MCP2515).
231+
* Added support for ST STM32U5 to the ST STM32 FDCAN driver.
232+
* Renamed the base Bosch M_CAN devicetree binding compatible from ``bosch,m-can-base`` to
233+
:dtcompatible:`bosch,m_can-base`.
234+
* Added CAN controller statistics support (NXP FlexCAN, Renesas R-Car, ST STM32 bxCAN).
235+
* Added CAN transceiver support.
236+
* Added generic SocketCAN network interface and removed driver-specific implementations.
237+
171238
* Counter
172239

173240
* DAC

0 commit comments

Comments
 (0)