docs: add serial recovery throughput tuning guide#2640
Open
JayToltTech wants to merge 1 commit intomcu-tools:mainfrom
Open
docs: add serial recovery throughput tuning guide#2640JayToltTech wants to merge 1 commit intomcu-tools:mainfrom
JayToltTech wants to merge 1 commit intomcu-tools:mainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
Adds documentation to help users tune serial recovery upload throughput by aligning device-side receive buffers with host-side mcumgr MTU settings, including example timings for USB CDC-ACM on nRF52840.
Changes:
- Document Zephyr-related Kconfig options affecting SMP receive buffering.
- Provide a
mcumgrexample using a largermtuto increase throughput. - Add a small results table showing measured upload time improvements.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
JayToltTech
force-pushed
the
docs/serial-recovery-throughput
branch
from
67c31d0 to
97e115d
Compare
nordicjm
reviewed
Feb 23, 2026
docs/serial_recovery.md
Outdated
| How to enable and configure the serial recovery feature depends on the given mcuboot-port implementation. | ||
| Refer to the respective documentation and source code for more details. | ||
|
|
||
| ## Throughput tuning |
Collaborator
There was a problem hiding this comment.
This is a generic MCUboot doc page, the parts added here are zephyr specific, they cannot go on this page and would need to go on a separate page or under a separate heading - thoughts on which @de-nordic @d3zd3z ?
de-nordic
added
area: zephyr
JayToltTech
force-pushed
the
docs/serial-recovery-throughput
branch
from
97e115d to
9fbfd49
Compare
Contributor
Author
|
@nordicjm Per conversation on the last MCUBoot call, I have moved the doc edits into docs/readme-zephyr.md. |
JayToltTech
force-pushed
the
docs/serial-recovery-throughput
branch
from
9fbfd49 to
fb9611c
Compare
nordicjm
requested changes
Mar 10, 2026
JayToltTech
force-pushed
the
docs/serial-recovery-throughput
branch
from
fb9611c to
0c5bbd9
Compare
The serial recovery documentation did not mention the Kconfig options that control upload throughput (BOOT_SERIAL_MAX_RECEIVE_SIZE, BOOT_MAX_LINE_INPUT_LEN, BOOT_LINE_BUFS) or the host-side --mtu flag. With defaults, each SMP round-trip carries only ~228 bytes of image data, making large uploads unnecessarily slow. Document how to increase buffer sizes and pass a matching MTU for significantly faster uploads. Signed-off-by: Jay Beavers <jay@tolttechnologies.com>
JayToltTech
force-pushed
the
docs/serial-recovery-throughput
branch
from
0c5bbd9 to
4adbe71
Compare
This file contains hidden or 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
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.
Summary
CONFIG_BOOT_SERIAL_MAX_RECEIVE_SIZE,CONFIG_BOOT_MAX_LINE_INPUT_LEN,CONFIG_BOOT_LINE_BUFS)mcumgrconnstring