mgmt/mcumgr: Drop zephyr_ prefix from functions #49528
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
de-nordic
requested review from
carlescufi,
nvlsianpu,
nashif,
galak and
MaureenHelm
as code owners
galak
previously requested changes
Aug 25, 2022
There was a problem hiding this comment.
This is technically a breaking API change, so should go through the API change process: https://docs.zephyrproject.org/latest/develop/api/api_lifecycle.html
OK, can follow that path, although nothing I have changed is available in public documentation, nor here https://docs.zephyrproject.org/latest/develop/api/overview.html. |
de-nordic
force-pushed
the
mcumgr-drop-zephyr_
branch
2 times, most recently
from
3b15abd
to
1ac71db
Compare
|
Please update release notes for deprecation. |
|
Please rebase to fix CI failure |
de-nordic
force-pushed
the
mcumgr-drop-zephyr_
branch
from
1ac71db
to
d48c408
Compare
de-nordic
force-pushed
the
mcumgr-drop-zephyr_
branch
from
d48c408
to
e872b3a
Compare
nordicjm
reviewed
Aug 31, 2022
subsys/mgmt/mcumgr/smp.c
Outdated
Comment on lines
155
to
168
| mtu = zst->zst_get_mtu(rsp); | ||
| mtu = smpt->get_mtu(rsp); | ||
| if (mtu == 0U) { | ||
| /* The transport cannot support a transmission right now. */ | ||
| return MGMT_ERR_EUNKNOWN; | ||
| } | ||
|
|
There was a problem hiding this comment.
This code can go once the other PRs are merged
nordicjm
previously approved these changes
Aug 31, 2022
de-nordic
force-pushed
the
mcumgr-drop-zephyr_
branch
from
e872b3a
to
aea68c0
Compare
15 tasks
nordicjm
reviewed
Sep 6, 2022
include/zephyr/mgmt/mcumgr/smp.h
Outdated
| * @param nb The net_buf to transmit. | ||
| * | ||
| * @return 0 on success, MGMT_ERR_[...] code on failure. | ||
| */ | ||
| typedef int zephyr_smp_transport_out_fn(struct zephyr_smp_transport *zst, | ||
| typedef int smp_transport_out_fn(struct smp_transport *smpt, | ||
| struct net_buf *nb); |
subsys/mgmt/mcumgr/smp_uart.c
Outdated
| @@ -91,7 +91,7 @@ static int smp_uart_init(const struct device *dev) | |||
| { | |||
| ARG_UNUSED(dev); | |||
|
|
|||
| zephyr_smp_transport_init(&smp_uart_transport, smp_uart_tx_pkt, | |||
| smp_transport_init(&smp_uart_transport, smp_uart_tx_pkt, | |||
| smp_uart_get_mtu, NULL, NULL); | |||
|
We agreed with @de-nordic to follow the stable API change procedure |
de-nordic
force-pushed
the
mcumgr-drop-zephyr_
branch
from
37517b7
to
49edb1c
Compare
nvlsianpu
previously approved these changes
Oct 4, 2022
nordicjm
previously approved these changes
Oct 6, 2022
fabiobaltieri
previously approved these changes
Oct 6, 2022
carlescufi
previously approved these changes
Oct 6, 2022
|
@de-nordic please rebase |
The MCUMgr library is now part of Zephyr, so there is no point to prefix SMP functions with Zephyr. Signed-off-by: Dominik Ermel <dominik.ermel@nordicsemi.no>
Cosmetic change: the zst was short for zephyr_smp_transport, now it is just smp_transport so smpt makes more sense. Signed-off-by: Dominik Ermel <dominik.ermel@nordicsemi.no>
The mcumgr transport API drops zephyr_ prefixes. Signed-off-by: Dominik Ermel <dominik.ermel@nordicsemi.no>
With dropping the zephyr_ prefix, the member prefix zst_ makes no sense. Signed-off-by: Dominik Ermel <dominik.ermel@nordicsemi.no>
The zephyr_ prefixed functions have been marked __deprecated. Signed-off-by: Dominik Ermel <dominik.ermel@nordicsemi.no>
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 <dominik.ermel@nordicsemi.no>
de-nordic
dismissed stale reviews from carlescufi, fabiobaltieri, nordicjm, and nvlsianpu
via
886ca71
de-nordic
force-pushed
the
mcumgr-drop-zephyr_
branch
from
49edb1c
to
886ca71
Compare
nvlsianpu
approved these changes
Oct 6, 2022
fabiobaltieri
approved these changes
Oct 7, 2022
nordicjm
approved these changes
Oct 10, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The MCUMgr library is now part of Zephyr, so there is no point
to prefix SMP functions with Zephyr.
Signed-off-by: Dominik Ermel dominik.ermel@nordicsemi.no
Closes: #49962
DNM until dependency #50904 is merged.