Skip to content

Commit 9cae0c4

Browse files
zophai-liufabiobaltieri
authored andcommitted
doc: develop: flash_debug: add realtek bee mpcli docs
Add setup and usage documentation for realtek bee mpcli. Signed-off-by: Zophai Liu <zophai_liu@realsil.com.cn>
1 parent 9ee71b4 commit 9cae0c4

1 file changed

Lines changed: 28 additions & 0 deletions

File tree

doc/develop/flash_debug/host-tools.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -658,6 +658,28 @@ using the ``--device`` option:
658658

659659
For more about the UF2 format and its tooling, see `USB Flashing Format (UF2)`_.
660660

661+
.. _runner_mpcli:
662+
663+
Realtek Bee Flash Programmer (MPCli) Host Tools
664+
***********************************************
665+
666+
Realtek provides `Realtek Flash Programmer (MPCli)`_ as an official programming tool for the Bee
667+
series, supporting Linux, macOS, and Windows operating systems. MPCli enables In‑System Programming
668+
(ISP) via a UART interface, eliminating the need for external programming hardware. On most
669+
official Bee‑series evaluation boards, a built‑in UART‑to‑USB converter is included for
670+
ready‑to‑use programming and logging.
671+
672+
After downloading the archive of MPCli, extract it and choose the version compatible with your
673+
operating system. Then, add the directory containing the ``mpcli`` executable to your system
674+
:ref:`PATH environment variable <env_vars>`.
675+
676+
Before starting, ensure your board is in download mode. Please refer to the board documentation
677+
at: `Realtek Supported Boards`_
678+
679+
.. code-block:: console
680+
681+
west flash [--runner mpcli] --port /dev/ttyX
682+
661683
.. _J-Link Software and Documentation Pack:
662684
https://www.segger.com/downloads/jlink/#J-LinkSoftwareAndDocumentationPack
663685

@@ -735,3 +757,9 @@ For more about the UF2 format and its tooling, see `USB Flashing Format (UF2)`_.
735757

736758
.. _USB Flashing Format (UF2):
737759
https://github.com/microsoft/uf2
760+
761+
.. _Realtek Flash Programmer (MPCli):
762+
https://docs.realmcu.com/tools/mpcli_tool/en/latest/mpcli/text_en/README.html
763+
764+
.. _Realtek Supported Boards:
765+
https://docs.zephyrproject.org/latest/boards/realtek/index.html

0 commit comments

Comments
 (0)