Skip to content

Commit 6755999

Browse files
de-nordiccarlescufi
authored andcommitted
doc: releases: Note on deprecation of zephyr_ prefix in SMP API
The commit adds note on deprecation of zephyr_ prefix in SMP API used by SMP transports, that allow MCUMgr receive and process SMP frames. Signed-off-by: Dominik Ermel <[email protected]>
1 parent 7089f94 commit 6755999

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

doc/releases/release-notes-3.3.rst

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,49 @@ Removed APIs in this release
3030
Deprecated in this release
3131
==========================
3232

33+
* MCUmgr subsystem, specifically the SMP transport API, is dropping `zephyr_`
34+
prefix, deprecating prefixed functions and callback type definitions with the
35+
prefix and replacing them with with prefix-less variants.
36+
The :c:struct:`zephyr_smp_transport` type, representing transport object,
37+
is now replaced with :c:struct:`smp_transport`, and the later one is used,
38+
instead of the former one, by all prefix-less functions.
39+
40+
Deprecated functions and their replacements:
41+
42+
.. table::
43+
:align: center
44+
45+
+-------------------------------------+---------------------------------------+
46+
| Deprecated | Drop in replacement |
47+
+=====================================+=======================================+
48+
| :c:func:`zephyr_smp_transport_init` | :c:func:`smp_transport_init` |
49+
+-------------------------------------+---------------------------------------+
50+
| :c:func:`zephyr_smp_rx_req` | :c:func:`smp_rx_req` |
51+
+-------------------------------------+---------------------------------------+
52+
| :c:func:`zephyr_smp_alloc_rsp` | :c:func:`smp_alloc_rsp` |
53+
+-------------------------------------+---------------------------------------+
54+
| :c:func:`zephyr_smp_free_buf` | :c:func:`smp_free_buf` |
55+
+-------------------------------------+---------------------------------------+
56+
57+
Deprecated callback types and their replacements:
58+
59+
.. table::
60+
:align: center
61+
62+
+---------------------------------------------+---------------------------------------+
63+
| Deprecated | Drop in replacement |
64+
+=============================================+=======================================+
65+
| :c:func:`zephyr_smp_transport_out_fn` | :c:func:`smp_transport_out_fn` |
66+
+---------------------------------------------+---------------------------------------+
67+
| :c:func:`zephyr_smp_transport_get_mtu_fn` | :c:func:`smp_transport_get_mtu_fn` |
68+
+---------------------------------------------+---------------------------------------+
69+
| :c:func:`zephyr_smp_transport_ud_copy_fn` | :c:func:`smp_transport_ud_copy_fn` |
70+
+---------------------------------------------+---------------------------------------+
71+
| :c:func:`zephyr_smp_transport_ud_free_fn` | :c:func:`smp_transport_ud_free_fn` |
72+
+---------------------------------------------+---------------------------------------+
73+
74+
NOTE: Only functions are marked as ``__deprecated``, type definitions are not.
75+
3376
Stable API changes in this release
3477
==================================
3578

0 commit comments

Comments
 (0)