From 05a96526a5e02fc9282aee8a4794faca6aaeb028 Mon Sep 17 00:00:00 2001 From: Abderrahmane Jarmouni Date: Sat, 7 Sep 2024 17:14:02 +0200 Subject: [PATCH] boards: stm32: doc: update flashing section Update all STM32 official boards Doc Flashing section. Correct some typos and remove outdated information. Signed-off-by: Abderrahmane Jarmouni --- boards/st/b_g474e_dpow1/doc/index.rst | 8 ++- boards/st/b_l072z_lrwan1/doc/index.rst | 17 +++++-- boards/st/b_l4s5i_iot01a/doc/index.rst | 17 ++++++- boards/st/b_u585i_iot02a/doc/index.rst | 16 +++--- boards/st/disco_l475_iot1/doc/index.rst | 18 +++++-- boards/st/nucleo_c031c6/doc/index.rst | 8 ++- boards/st/nucleo_f030r8/doc/index.rst | 18 ++++++- boards/st/nucleo_f031k6/doc/index.rst | 17 ++++++- boards/st/nucleo_f042k6/doc/index.rst | 17 ++++++- boards/st/nucleo_f070rb/doc/index.rst | 17 ++++++- boards/st/nucleo_f091rc/doc/index.rst | 17 ++++++- boards/st/nucleo_f103rb/doc/index.rst | 17 ++++++- boards/st/nucleo_f207zg/doc/index.rst | 18 ++++++- boards/st/nucleo_f302r8/doc/index.rst | 18 ++++++- boards/st/nucleo_f303k8/doc/index.rst | 19 ++++++- boards/st/nucleo_f303re/doc/index.rst | 18 ++++++- boards/st/nucleo_f334r8/doc/index.rst | 18 ++++++- boards/st/nucleo_f401re/doc/index.rst | 17 ++++++- boards/st/nucleo_f410rb/doc/index.rst | 17 ++++++- boards/st/nucleo_f411re/doc/index.rst | 17 ++++++- boards/st/nucleo_f412zg/doc/index.rst | 18 ++++++- boards/st/nucleo_f413zh/doc/index.rst | 18 ++++++- boards/st/nucleo_f429zi/doc/index.rst | 18 ++++++- boards/st/nucleo_f446re/doc/index.rst | 17 ++++++- boards/st/nucleo_f446ze/doc/index.rst | 17 ++++++- boards/st/nucleo_f722ze/doc/index.rst | 28 ++++++---- boards/st/nucleo_f746zg/doc/index.rst | 16 +++--- boards/st/nucleo_f756zg/doc/index.rst | 16 +++++- boards/st/nucleo_f767zi/doc/index.rst | 16 +++++- boards/st/nucleo_g031k8/doc/index.rst | 17 ++++++- boards/st/nucleo_g070rb/doc/index.rst | 17 ++++++- boards/st/nucleo_g071rb/doc/index.rst | 17 ++++++- boards/st/nucleo_g0b1re/doc/index.rst | 24 ++++++--- boards/st/nucleo_g431rb/doc/index.rst | 29 ++++++----- boards/st/nucleo_g474re/doc/index.rst | 16 +++++- boards/st/nucleo_h503rb/doc/index.rst | 28 +++++----- boards/st/nucleo_h533re/doc/index.rst | 30 +++++------ boards/st/nucleo_h563zi/doc/index.rst | 27 +++++----- boards/st/nucleo_h723zg/doc/index.rst | 28 ++++++---- boards/st/nucleo_h743zi/doc/index.rst | 23 ++++++--- boards/st/nucleo_h745zi_q/doc/index.rst | 51 +++++++++++-------- boards/st/nucleo_h753zi/doc/index.rst | 22 +++++--- boards/st/nucleo_h755zi_q/doc/index.rst | 12 ++--- boards/st/nucleo_h7a3zi_q/doc/index.rst | 16 +++++- boards/st/nucleo_l011k4/doc/index.rst | 17 ++++++- boards/st/nucleo_l031k6/doc/index.rst | 17 ++++++- boards/st/nucleo_l053r8/doc/index.rst | 17 ++++++- boards/st/nucleo_l073rz/doc/index.rst | 17 ++++++- boards/st/nucleo_l152re/doc/index.rst | 16 +++++- boards/st/nucleo_l412rb_p/doc/index.rst | 18 +++++-- boards/st/nucleo_l432kc/doc/index.rst | 18 +++++-- boards/st/nucleo_l433rc_p/doc/index.rst | 18 +++++-- boards/st/nucleo_l452re/doc/index.rst | 18 +++++-- boards/st/nucleo_l476rg/doc/index.rst | 18 +++++-- boards/st/nucleo_l496zg/doc/index.rst | 18 +++++-- boards/st/nucleo_l4a6zg/doc/index.rst | 18 +++++-- boards/st/nucleo_l4r5zi/doc/index.rst | 14 +++-- .../st/nucleo_l552ze_q/doc/nucleol552ze_q.rst | 21 +++++--- boards/st/nucleo_u083rc/doc/index.rst | 16 +++--- boards/st/nucleo_u575zi_q/doc/index.rst | 17 ++++--- boards/st/nucleo_u5a5zj_q/doc/index.rst | 17 ++++--- boards/st/nucleo_wb55rg/doc/nucleo_wb55rg.rst | 22 ++++++-- .../st/nucleo_wba52cg/doc/nucleo_wba52cg.rst | 14 ++++- .../st/nucleo_wba55cg/doc/nucleo_wba55cg.rst | 14 ++++- boards/st/nucleo_wl55jc/doc/nucleo_wl55jc.rst | 18 +++++-- boards/st/stm32c0116_dk/doc/index.rst | 15 +++++- boards/st/stm32f072_eval/doc/index.rst | 17 ++++++- boards/st/stm32f072b_disco/doc/index.rst | 16 +++++- boards/st/stm32f0_disco/doc/index.rst | 17 ++++++- boards/st/stm32f3_disco/doc/index.rst | 20 ++++++-- boards/st/stm32f411e_disco/doc/index.rst | 18 +++++-- boards/st/stm32f412g_disco/doc/index.rst | 17 ++++++- boards/st/stm32f4_disco/doc/index.rst | 17 ++++++- boards/st/stm32f723e_disco/doc/index.rst | 17 ++++++- boards/st/stm32f746g_disco/doc/index.rst | 17 ++++++- boards/st/stm32f7508_dk/doc/index.rst | 17 ++++++- boards/st/stm32f769i_disco/doc/index.rst | 17 ++++++- boards/st/stm32g0316_disco/doc/index.rst | 18 +++++-- boards/st/stm32g071b_disco/doc/index.rst | 8 ++- boards/st/stm32g081b_eval/doc/index.rst | 8 ++- boards/st/stm32h573i_dk/doc/index.rst | 31 +++++------ boards/st/stm32h735g_disco/doc/index.rst | 18 +++++-- boards/st/stm32h745i_disco/doc/index.rst | 27 ++++++---- boards/st/stm32h747i_disco/doc/index.rst | 46 ++++++++++------- boards/st/stm32h7b3i_dk/doc/index.rst | 14 ++++- boards/st/stm32h7s78_dk/doc/index.rst | 8 +-- boards/st/stm32l1_disco/doc/index.rst | 18 +++++-- boards/st/stm32l476g_disco/doc/index.rst | 17 ++++++- boards/st/stm32l496g_disco/doc/index.rst | 18 +++++-- boards/st/stm32l4r9i_disco/doc/index.rst | 19 +++++-- boards/st/stm32l562e_dk/doc/index.rst | 20 +++++--- boards/st/stm32u083c_dk/doc/index.rst | 16 +++--- boards/st/stm32wb5mm_dk/doc/stm32wb5mm_dk.rst | 19 ++++++- boards/st/stm32wb5mmg/doc/stm32wb5mmg.rst | 13 +++++ 94 files changed, 1370 insertions(+), 366 deletions(-) diff --git a/boards/st/b_g474e_dpow1/doc/index.rst b/boards/st/b_g474e_dpow1/doc/index.rst index ce574d73c0c..39f7bf045aa 100644 --- a/boards/st/b_g474e_dpow1/doc/index.rst +++ b/boards/st/b_g474e_dpow1/doc/index.rst @@ -105,6 +105,8 @@ For more details please refer to `B-G474E-DPOW1 Discovery board User Manual`_. Programming and Debugging ************************* +The B-G474E-DPOW1 Discovery board includes an ST-LINK/V3E embedded debug tool interface. + Applications for the ``b_g474e_dpow1`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -112,7 +114,8 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -The B-G474E-DPOW1 Discovery board includes an ST-LINK/V3E embedded debug tool interface. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. .. code-block:: console @@ -158,3 +161,6 @@ References .. _G474RE on www.st.com: https://www.st.com/en/microcontrollers-microprocessors/stm32g474re.html + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/b_l072z_lrwan1/doc/index.rst b/boards/st/b_l072z_lrwan1/doc/index.rst index 5ea80847871..87a98d67910 100644 --- a/boards/st/b_l072z_lrwan1/doc/index.rst +++ b/boards/st/b_l072z_lrwan1/doc/index.rst @@ -191,6 +191,8 @@ the USB data lines to the MCU, short solder bridges SB15 and SB16. Programming and Debugging ************************* +B-L072Z-LRWAN1 Discovery board includes an ST-LINK/V2-1 embedded debug tool interface. + Applications for the ``b_l072z_lrwan1`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -198,10 +200,16 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -B-L072Z-LRWAN1 Discovery board includes an ST-LINK/V2-1 embedded debug -tool interface. This interface is supported by the openocd version included -in the Zephyr SDK since v0.9.2. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flashing an application to B-L072Z-LRWAN1 Discovery board --------------------------------------------------------- @@ -248,3 +256,6 @@ You can debug an application in the usual way. Here is an example for the .. _STM32L0x2 reference manual: https://www.st.com/resource/en/reference_manual/DM00108281.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/b_l4s5i_iot01a/doc/index.rst b/boards/st/b_l4s5i_iot01a/doc/index.rst index 17455c772dd..b66df638cd5 100644 --- a/boards/st/b_l4s5i_iot01a/doc/index.rst +++ b/boards/st/b_l4s5i_iot01a/doc/index.rst @@ -177,11 +177,21 @@ Default settings are 115200 8N1. Programming and Debugging ************************* +B_L4S5I_IOT01A Discovery kit includes an ST-LINK/V2-1 embedded debug tool interface. + Flashing ======== -B_L4S5I_IOT01A Discovery kit includes an ST-LINK/V2-1 embedded debug tool interface. -This interface is supported by the openocd version included in Zephyr SDK. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flashing an application to B_L4S5I_IOT01A Discovery kit ------------------------------------------------------- @@ -231,3 +241,6 @@ You can debug an application in the usual way. Here is an example for the .. _STM32L4S5 reference manual: https://www.st.com/resource/en/reference_manual/dm00310109.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/b_u585i_iot02a/doc/index.rst b/boards/st/b_u585i_iot02a/doc/index.rst index 0631b5b1ada..f057800aed3 100644 --- a/boards/st/b_u585i_iot02a/doc/index.rst +++ b/boards/st/b_u585i_iot02a/doc/index.rst @@ -297,12 +297,16 @@ This probe allows to flash the board using various tools. Flashing ======== -Board is configured to be flashed using west STM32CubeProgrammer runner. -Installation of `STM32CubeProgrammer`_ is then required to flash the board. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. -Alternatively, openocd (provided in Zephyr SDK), JLink and pyocd can also be -used to flash and debug the board if west is told to use it as runner, -using ``-r openocd``. +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Connect the B_U585I_IOT02A Discovery kit to your host computer using the USB port, then run a serial host program to connect with your Discovery @@ -329,7 +333,7 @@ You should see the following message on the console: Debugging ========= -Default flasher for this board is openocd. It could be used in the usual way. +Default flasher for this board is OpenOCD. It could be used in the usual way. Here is an example for the :zephyr:code-sample:`blinky` application. .. zephyr-app-commands:: diff --git a/boards/st/disco_l475_iot1/doc/index.rst b/boards/st/disco_l475_iot1/doc/index.rst index c67e3446a3b..a5ba3b59978 100644 --- a/boards/st/disco_l475_iot1/doc/index.rst +++ b/boards/st/disco_l475_iot1/doc/index.rst @@ -193,6 +193,8 @@ Default settings are 115200 8N1. Programming and Debugging ************************* +Disco L475 IoT board includes an ST-LINK/V2-1 embedded debug tool interface. + Applications for the ``disco_l475_iot1`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -200,9 +202,16 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -Disco L475 IoT board includes an ST-LINK/V2-1 embedded debug tool -interface. This interface is supported by the openocd version -included in the Zephyr SDK since v0.9.2. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flashing an application to Disco L475 IoT ----------------------------------------- @@ -252,3 +261,6 @@ You can debug an application in the usual way. Here is an example for the .. _STM32L475 reference manual: https://www.st.com/resource/en/reference_manual/dm00083560.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_c031c6/doc/index.rst b/boards/st/nucleo_c031c6/doc/index.rst index 8f44ab9d307..997b60e47e6 100644 --- a/boards/st/nucleo_c031c6/doc/index.rst +++ b/boards/st/nucleo_c031c6/doc/index.rst @@ -117,6 +117,8 @@ For more details please refer to `STM32 Nucleo-64 board User Manual`_. Programming and Debugging ************************* +Nucleo C031C6 board includes an ST-LINK/V2-1 embedded debug tool interface. + Applications for the ``nucleo_c031c6`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -124,7 +126,8 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -Nucleo C031C6 board includes an ST-LINK/V2-1 embedded debug tool interface. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. Flashing an application to Nucleo C031C6 ---------------------------------------- @@ -151,3 +154,6 @@ References .. _STM32 Nucleo-64 board User Manual: https://www.st.com/resource/en/user_manual/um2953-stm32c0-nucleo64-board-mb1717-stmicroelectronics.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_f030r8/doc/index.rst b/boards/st/nucleo_f030r8/doc/index.rst index a7479859d09..376faaa2d57 100644 --- a/boards/st/nucleo_f030r8/doc/index.rst +++ b/boards/st/nucleo_f030r8/doc/index.rst @@ -134,6 +134,8 @@ For more details please refer to `STM32 Nucleo-64 board User Manual`_. Programming and Debugging ************************* +Nucleo F030R8 board includes an ST-LINK/V2-1 embedded debug tool interface. + Applications for the ``nucleo_f030r8`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -143,8 +145,17 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -Nucleo F030R8 board includes an ST-LINK/V2-1 embedded debug tool interface. -This interface is supported by the openocd version included in the Zephyr SDK. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD, JLink, prob-rs can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink + $ west flash --runner prob-rs Flashing an application to Nucleo F030R8 ---------------------------------------- @@ -215,3 +226,6 @@ References .. _STM32 Nucleo-64 board User Manual: https://www.st.com/resource/en/user_manual/dm00105823.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_f031k6/doc/index.rst b/boards/st/nucleo_f031k6/doc/index.rst index 99ae997ce26..ba1a44d8bc4 100644 --- a/boards/st/nucleo_f031k6/doc/index.rst +++ b/boards/st/nucleo_f031k6/doc/index.rst @@ -103,6 +103,8 @@ For more details please refer to `STM32 Nucleo-32 board User Manual`_. Programming and Debugging ************************* +Nucleo F031K6 board includes an ST-LINK/V2-1 embedded debug tool interface. + Applications for the ``nucleo_f031k6`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -110,8 +112,16 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -Nucleo F031K6 board includes an ST-LINK/V2-1 embedded debug tool interface. -This interface is supported by the openocd version included in the Zephyr SDK. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flashing an application to Nucleo F030R8 ---------------------------------------- @@ -153,3 +163,6 @@ References .. _STM32 Nucleo-32 board User Manual: https://www.st.com/resource/en/user_manual/dm00231744-stm32-nucleo32-boards-mb1180-stmicroelectronics.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_f042k6/doc/index.rst b/boards/st/nucleo_f042k6/doc/index.rst index a1d90c8c4f3..7d0ec6e2a2b 100644 --- a/boards/st/nucleo_f042k6/doc/index.rst +++ b/boards/st/nucleo_f042k6/doc/index.rst @@ -103,6 +103,8 @@ For more details please refer to `STM32 Nucleo-32 board User Manual`_. Programming and Debugging ************************* +Nucleo F042K6 board includes an ST-LINK/V2-1 embedded debug tool interface. + Applications for the ``nucleo_f042k6`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -110,8 +112,16 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -Nucleo F042K6 board includes an ST-LINK/V2-1 embedded debug tool interface. -This interface is supported by the openocd version included in the Zephyr SDK. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flashing an application to Nucleo F042K6 ---------------------------------------- @@ -153,3 +163,6 @@ References .. _STM32 Nucleo-32 board User Manual: https://www.st.com/resource/en/user_manual/dm00231744-stm32-nucleo32-boards-mb1180-stmicroelectronics.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_f070rb/doc/index.rst b/boards/st/nucleo_f070rb/doc/index.rst index e8d9f40a77b..b017b218699 100644 --- a/boards/st/nucleo_f070rb/doc/index.rst +++ b/boards/st/nucleo_f070rb/doc/index.rst @@ -133,6 +133,8 @@ For more details please refer to `STM32 Nucleo-64 board User Manual`_. Programming and Debugging ************************* +Nucleo F070RB board includes an ST-LINK/V2-1 embedded debug tool interface. + Applications for the ``nucleo_f070rb`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -140,8 +142,16 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -Nucleo F070RB board includes an ST-LINK/V2-1 embedded debug tool interface. -This interface is supported by the openocd version included in the Zephyr SDK. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flashing an application to Nucleo F070RB ---------------------------------------- @@ -180,3 +190,6 @@ References .. _STM32 Nucleo-64 board User Manual: https://www.st.com/resource/en/user_manual/dm00105823.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_f091rc/doc/index.rst b/boards/st/nucleo_f091rc/doc/index.rst index a83b00bd82a..38cb5e6c38b 100644 --- a/boards/st/nucleo_f091rc/doc/index.rst +++ b/boards/st/nucleo_f091rc/doc/index.rst @@ -150,6 +150,8 @@ For more details please refer to `STM32 Nucleo-64 board User Manual`_. Programming and Debugging ************************* +Nucleo F091RC board includes an ST-LINK/V2-1 embedded debug tool interface. + Applications for the ``nucleo_f091rc`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -157,8 +159,16 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -Nucleo F091RC board includes an ST-LINK/V2-1 embedded debug tool interface. -This interface is supported by the openocd version included in the Zephyr SDK. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flashing an application to Nucleo F091RC ---------------------------------------- @@ -197,3 +207,6 @@ References .. _STM32 Nucleo-64 board User Manual: https://www.st.com/resource/en/user_manual/dm00105823.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_f103rb/doc/index.rst b/boards/st/nucleo_f103rb/doc/index.rst index e2313c5e932..8a9baaea537 100644 --- a/boards/st/nucleo_f103rb/doc/index.rst +++ b/boards/st/nucleo_f103rb/doc/index.rst @@ -136,6 +136,8 @@ For more details please refer to `STM32 Nucleo-64 board User Manual`_. Programming and Debugging ************************* +Nucleo F103RB board includes an ST-LINK/V2-1 embedded debug tool interface. + Applications for the ``nucleo_f103rb`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -143,8 +145,16 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -Nucleo F103RB board includes an ST-LINK/V2-1 embedded debug tool interface. -This interface is supported by the openocd version included in the Zephyr SDK. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flashing an application to Nucleo F103RB ---------------------------------------- @@ -186,3 +196,6 @@ References .. _STM32 Nucleo-64 board User Manual: https://www.st.com/resource/en/user_manual/dm00105823.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_f207zg/doc/index.rst b/boards/st/nucleo_f207zg/doc/index.rst index 032cf2ab859..17d51354dde 100644 --- a/boards/st/nucleo_f207zg/doc/index.rst +++ b/boards/st/nucleo_f207zg/doc/index.rst @@ -192,7 +192,20 @@ Programming and Debugging ************************* Nucleo F207ZG board includes an ST-LINK/V2-1 embedded debug tool interface. -This interface is supported by the openocd version included in Zephyr SDK. + +Flashing +======== + +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink .. _Nucleo F207ZG website: @@ -206,3 +219,6 @@ This interface is supported by the openocd version included in Zephyr SDK. .. _STM32F207 reference manual: https://www.st.com/resource/en/reference_manual/cd00225773.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_f302r8/doc/index.rst b/boards/st/nucleo_f302r8/doc/index.rst index 7e3ce412f04..8cb3f9e8a13 100644 --- a/boards/st/nucleo_f302r8/doc/index.rst +++ b/boards/st/nucleo_f302r8/doc/index.rst @@ -149,7 +149,20 @@ Programming and Debugging ************************* The Nucleo F302R8 board includes an ST-LINK/V2-1 embedded debug tool interface. -This interface is supported by the openocd version included in Zephyr SDK. + +Flashing +======== + +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink .. _Nucleo F302R8 website: @@ -166,3 +179,6 @@ This interface is supported by the openocd version included in Zephyr SDK. .. _STM32F302R8 datasheet: https://www.st.com/resource/en/datasheet/stm32f302r8.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_f303k8/doc/index.rst b/boards/st/nucleo_f303k8/doc/index.rst index 28d9e2754f6..e659d453a80 100644 --- a/boards/st/nucleo_f303k8/doc/index.rst +++ b/boards/st/nucleo_f303k8/doc/index.rst @@ -140,7 +140,21 @@ Programming and Debugging ************************* The Nucleo F303K8 board includes an ST-LINK/V2-1 embedded debug tool interface. -This interface is supported by the openocd version included in Zephyr SDK. + +Flashing +======== + +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD, JLink, or pyOCD can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink + $ west flash --runner pyocd .. _Nucleo F303K8 website: @@ -157,3 +171,6 @@ This interface is supported by the openocd version included in Zephyr SDK. .. _STM32F303K8 datasheet: https://www.st.com/resource/en/datasheet/stm32f303k8.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_f303re/doc/index.rst b/boards/st/nucleo_f303re/doc/index.rst index 743739f8af1..dc7d7e2d0a6 100644 --- a/boards/st/nucleo_f303re/doc/index.rst +++ b/boards/st/nucleo_f303re/doc/index.rst @@ -143,7 +143,20 @@ Programming and Debugging ************************* The Nucleo F303RE board includes an ST-LINK/V2-1 embedded debug tool interface. -This interface is supported by the openocd version included in Zephyr SDK. + +Flashing +======== + +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink .. _Nucleo F303RE website: @@ -160,3 +173,6 @@ This interface is supported by the openocd version included in Zephyr SDK. .. _STM32F303RE datasheet: https://www.st.com/resource/en/datasheet/stm32f303re.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_f334r8/doc/index.rst b/boards/st/nucleo_f334r8/doc/index.rst index 10e31269624..0115b2bda9c 100644 --- a/boards/st/nucleo_f334r8/doc/index.rst +++ b/boards/st/nucleo_f334r8/doc/index.rst @@ -128,6 +128,8 @@ For more details please refer to `STM32 Nucleo-64 board User Manual`_. Programming and Debugging ************************* +Nucleo F334R8 board includes an ST-LINK/V2-1 embedded debug tool interface. + Applications for the ``nucleo_f334r8`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -135,8 +137,17 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -Nucleo F334R8 board includes an ST-LINK/V2-1 embedded debug tool interface. -This interface is supported by the openocd version included in Zephyr SDK. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD, JLink, or pyOCD can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink + $ west flash --runner pyocd Flashing an application to Nucleo F334R8 ---------------------------------------- @@ -177,3 +188,6 @@ References .. _STM32 Nucleo-64 board User Manual: https://www.st.com/resource/en/user_manual/dm00105823.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_f401re/doc/index.rst b/boards/st/nucleo_f401re/doc/index.rst index 4b848eb1017..ceb25368d57 100644 --- a/boards/st/nucleo_f401re/doc/index.rst +++ b/boards/st/nucleo_f401re/doc/index.rst @@ -148,6 +148,8 @@ Nucleo F401RE board has up to 3 I2Cs. The default I2C mapping for Zephyr is: Programming and Debugging ************************* +Nucleo F401RE board includes an ST-LINK/V2-1 embedded debug tool interface. + Applications for the ``nucleo_f401re`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -155,8 +157,16 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -Nucleo F401RE board includes an ST-LINK/V2-1 embedded debug tool interface. -This interface is supported by the openocd version included in Zephyr SDK. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flashing an application to Nucleo F401RE ---------------------------------------- @@ -206,3 +216,6 @@ You can debug an application in the usual way. Here is an example for the .. _STM32F401 reference manual: https://www.st.com/resource/en/reference_manual/dm00096844.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_f410rb/doc/index.rst b/boards/st/nucleo_f410rb/doc/index.rst index 58579bce21c..f260608dafb 100644 --- a/boards/st/nucleo_f410rb/doc/index.rst +++ b/boards/st/nucleo_f410rb/doc/index.rst @@ -153,6 +153,8 @@ Default settings are 115200 8N1. Programming and Debugging ************************* +Nucleo F410RB board includes an ST-LINK/V2-1 embedded debug tool interface. + Applications for the ``nucleo_f410rb`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -160,8 +162,16 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -Nucleo F410RB board includes an ST-LINK/V2-1 embedded debug tool interface. -This interface is supported by the openocd version included in the Zephyr SDK. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flashing an application to Nucleo F410RB ---------------------------------------- @@ -210,3 +220,6 @@ You can debug an application in the usual way. Here is an example for the .. _STM32F410 reference manual: https://www.st.com/resource/en/reference_manual/dm00180366.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_f411re/doc/index.rst b/boards/st/nucleo_f411re/doc/index.rst index 77ca25184c6..fb6cf4ecba9 100644 --- a/boards/st/nucleo_f411re/doc/index.rst +++ b/boards/st/nucleo_f411re/doc/index.rst @@ -141,6 +141,8 @@ Default settings are 115200 8N1. Programming and Debugging ************************* +Nucleo F411RE board includes an ST-LINK/V2-1 embedded debug tool interface. + Applications for the ``nucleo_f411re`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -148,8 +150,16 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -Nucleo F411RE board includes an ST-LINK/V2-1 embedded debug tool interface. -This interface is supported by the openocd version included in Zephyr SDK. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flashing an application to Nucleo F411RE ---------------------------------------- @@ -198,3 +208,6 @@ You can debug an application in the usual way. Here is an example for the .. _STM32F411 reference manual: https://www.st.com/resource/en/reference_manual/dm00119316.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_f412zg/doc/index.rst b/boards/st/nucleo_f412zg/doc/index.rst index 40039aed089..f3f1cf0db75 100644 --- a/boards/st/nucleo_f412zg/doc/index.rst +++ b/boards/st/nucleo_f412zg/doc/index.rst @@ -156,7 +156,20 @@ Programming and Debugging ************************* Nucleo F412ZG board includes an ST-LINK/V2-1 embedded debug tool interface. -This interface is supported by the openocd version included in Zephyr SDK. + +Flashing +======== + +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink .. _Nucleo F412ZG website: @@ -170,3 +183,6 @@ This interface is supported by the openocd version included in Zephyr SDK. .. _STM32F412 reference manual: https://www.st.com/resource/en/reference_manual/dm00180369.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_f413zh/doc/index.rst b/boards/st/nucleo_f413zh/doc/index.rst index c6452fb4456..1240923df82 100644 --- a/boards/st/nucleo_f413zh/doc/index.rst +++ b/boards/st/nucleo_f413zh/doc/index.rst @@ -158,7 +158,20 @@ Programming and Debugging ************************* Nucleo F413ZH board includes an ST-LINK/V2-1 embedded debug tool interface. -This interface is supported by the openocd version included in Zephyr SDK. + +Flashing +======== + +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink .. _Nucleo F413ZH website: @@ -172,3 +185,6 @@ This interface is supported by the openocd version included in Zephyr SDK. .. _STM32F413/423 reference manual: https://www.st.com/resource/en/reference_manual/dm00305666.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_f429zi/doc/index.rst b/boards/st/nucleo_f429zi/doc/index.rst index c15e524238b..924c30de42b 100644 --- a/boards/st/nucleo_f429zi/doc/index.rst +++ b/boards/st/nucleo_f429zi/doc/index.rst @@ -181,7 +181,20 @@ Programming and Debugging ************************* The Nucleo F429ZI board includes an ST-LINK/V2-1 embedded debug tool interface. -This interface is supported by the openocd version included in Zephyr SDK. + +Flashing +======== + +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flash partitions for MCUBoot bootloader *************************************** @@ -217,3 +230,6 @@ A specific application can adjust each partition size based on its needs. .. _MCUBoot: https://github.com/JuulLabs-OSS/mcuboot/blob/master/README.md + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_f446re/doc/index.rst b/boards/st/nucleo_f446re/doc/index.rst index 28fe7699e60..49748acbde0 100644 --- a/boards/st/nucleo_f446re/doc/index.rst +++ b/boards/st/nucleo_f446re/doc/index.rst @@ -164,6 +164,8 @@ used with `RS485 CAN Shield`_. Programming and Debugging ************************* +Nucleo F446RE board includes an ST-LINK/V2-1 embedded debug tool interface. + Applications for the ``nucleo_f446re`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -171,8 +173,16 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -Nucleo F446RE board includes an ST-LINK/V2-1 embedded debug tool interface. -This interface is supported by the openocd version included in the Zephyr SDK. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flashing an application to Nucleo F446RE ---------------------------------------- @@ -224,3 +234,6 @@ You can debug an application in the usual way. Here is an example for the .. _RS485 CAN Shield: https://www.waveshare.com/wiki/RS485_CAN_Shield + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_f446ze/doc/index.rst b/boards/st/nucleo_f446ze/doc/index.rst index d99167db159..676da09ebb7 100644 --- a/boards/st/nucleo_f446ze/doc/index.rst +++ b/boards/st/nucleo_f446ze/doc/index.rst @@ -189,6 +189,8 @@ The TX/RX wires are connected with pins 25/27 of CN9 connector. Programming and Debugging ************************* +Nucleo F446ZE board includes an ST-LINK/V2-1 embedded debug tool interface. + Applications for the ``nucleo_f446ze`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -196,8 +198,16 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -Nucleo F446ZE board includes an ST-LINK/V2-1 embedded debug tool interface. -This interface is supported by the openocd version included in the Zephyr SDK. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flashing an application to Nucleo F446ZE ---------------------------------------- @@ -246,3 +256,6 @@ You can debug an application in the usual way. Here is an example for the .. _STM32F446 reference manual: https://www.st.com/resource/en/reference_manual/dm00135183.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_f722ze/doc/index.rst b/boards/st/nucleo_f722ze/doc/index.rst index 83b54130405..37d3237d260 100644 --- a/boards/st/nucleo_f722ze/doc/index.rst +++ b/boards/st/nucleo_f722ze/doc/index.rst @@ -182,14 +182,25 @@ Programming and Debugging ************************* The ``nucleo_f722ze`` can be flashed and debugged in the typical manner. -The Nucleo F722ZE board includes an ST-LINK V2-1 debugger, which can be used -with the OpenOCD version provided with the Zephyr SDK. Refer to -:ref:`build_an_application` and :ref:`application_run` for detailed +The Nucleo F722ZE board includes an ST-LINK V2-1 debugger. + +Refer to :ref:`build_an_application` and :ref:`application_run` for detailed instructions. Flashing ======== +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink + Build the :ref:`hello_world` application and flash it using the on-board ST-LINK interface: @@ -207,14 +218,6 @@ Debugging :maybe-skip-config: :goals: debug -J-Link OB Firmware ------------------- - -Like many other STM32 evaluation boards, the Nucleo F722ZE's on-board ST-LINK -debug interface may be flashed with `SEGGER J-Link OB firmware`_. This -firmware turns the ST-LINK into a J-Link probe. If the on-board debugger has -been re-flashed with J-Link OB firmware, simply append ``--runner jlink`` to -all flashing/debugging commands. References ********** @@ -243,3 +246,6 @@ More information about Nucleo F722ZE: .. _STM32 Nucleo-144 User Manual (UM1974): https://www.st.com/resource/en/user_manual/um1974-stm32-nucleo144-boards-mb1137-stmicroelectronics.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_f746zg/doc/index.rst b/boards/st/nucleo_f746zg/doc/index.rst index f0641545170..c4d4a0f9fc1 100644 --- a/boards/st/nucleo_f746zg/doc/index.rst +++ b/boards/st/nucleo_f746zg/doc/index.rst @@ -179,6 +179,8 @@ do it by removing ``SB156`` jumper on the back side of the board. Programming and Debugging ************************* +Nucleo F746ZG board includes an ST-LINK/V2-1 embedded debug tool interface. + Applications for the ``nucleo_f746zg`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -186,22 +188,20 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -Nucleo F746ZG board includes an ST-LINK/V2-1 embedded debug tool interface. - -Flashing an application to Nucleo F746ZG ----------------------------------------- - The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, -so its installation is required to be able to flash the board. +so its :ref:`installation ` is required. -Alternatively, openocd (provided in Zephyr SDK) or JLink can also be used to -flash the board using the ``--runner`` (or ``-r``) option: +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: .. code-block:: console $ west flash --runner openocd $ west flash --runner jlink +Flashing an application to Nucleo F746ZG +---------------------------------------- + Here is an example for the :ref:`hello_world` application. Run a serial host program to connect with your Nucleo board. diff --git a/boards/st/nucleo_f756zg/doc/index.rst b/boards/st/nucleo_f756zg/doc/index.rst index fd8b5f259c3..371464038d3 100644 --- a/boards/st/nucleo_f756zg/doc/index.rst +++ b/boards/st/nucleo_f756zg/doc/index.rst @@ -160,6 +160,8 @@ assigned to UART3. Default settings are 115200 8N1. Programming and Debugging ************************* +Nucleo F756ZG board includes an ST-LINK/V2-1 embedded debug tool interface. + Applications for the ``nucleo_f756zg`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -167,7 +169,16 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -Nucleo F756ZG board includes an ST-LINK/V2-1 embedded debug tool interface. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flashing an application to Nucleo F756ZG ---------------------------------------- @@ -216,3 +227,6 @@ You can debug an application in the usual way. Here is an example for the .. _STM32F756 reference manual: https://www.st.com/resource/en/reference_manual/dm00124865.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_f767zi/doc/index.rst b/boards/st/nucleo_f767zi/doc/index.rst index 5dec0099d90..87c08558518 100644 --- a/boards/st/nucleo_f767zi/doc/index.rst +++ b/boards/st/nucleo_f767zi/doc/index.rst @@ -180,6 +180,8 @@ assigned to UART3. Default settings are 115200 8N1. Programming and Debugging ************************* +Nucleo F767ZI board includes an ST-LINK/V2-1 embedded debug tool interface. + Applications for the ``nucleo_f767zi`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -187,7 +189,16 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -Nucleo F767ZI board includes an ST-LINK/V2-1 embedded debug tool interface. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flashing an application to Nucleo F767ZI ---------------------------------------- @@ -236,3 +247,6 @@ You can debug an application in the usual way. Here is an example for the .. _STM32F767 reference manual: https://www.st.com/resource/en/reference_manual/DM00224583.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_g031k8/doc/index.rst b/boards/st/nucleo_g031k8/doc/index.rst index e140ac74040..29ecc49cdff 100644 --- a/boards/st/nucleo_g031k8/doc/index.rst +++ b/boards/st/nucleo_g031k8/doc/index.rst @@ -110,6 +110,8 @@ For more details please refer to `STM32 Nucleo-32 board User Manual`_. Programming and Debugging ************************* +Nucleo G031K8 board includes an ST-LINK/V2-1 embedded debug tool interface. + Applications for the ``nucleo_g031k8`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -117,8 +119,16 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -Nucleo G031K8 board includes an ST-LINK/V2-1 embedded debug tool interface. -This interface is supported by the openocd version included in the Zephyr SDK. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flashing an application to Nucleo G031K8 ---------------------------------------- @@ -166,3 +176,6 @@ References .. _STM32 Nucleo-32 board User Manual: https://www.st.com/resource/en/user_manual/um2591-stm32g0-nucleo32-board-mb1455-stmicroelectronics.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_g070rb/doc/index.rst b/boards/st/nucleo_g070rb/doc/index.rst index b18525ee0eb..055b11b5c10 100644 --- a/boards/st/nucleo_g070rb/doc/index.rst +++ b/boards/st/nucleo_g070rb/doc/index.rst @@ -143,6 +143,8 @@ For more details please refer to `STM32 Nucleo-64 board User Manual`_. Programming and Debugging ************************* +Nucleo G070RB board includes an ST-LINK/V2-1 embedded debug tool interface. + Applications for the ``nucleo_g070rb`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -150,7 +152,17 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -Nucleo G070RB board includes an ST-LINK/V2-1 embedded debug tool interface. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD, JLink, or pyOCD can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink + $ west flash --runner pyocd Flashing an application to Nucleo G070RB ---------------------------------------- @@ -189,3 +201,6 @@ References .. _G070RB on www.st.com: https://www.st.com/en/microcontrollers/stm32g070rb.html + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_g071rb/doc/index.rst b/boards/st/nucleo_g071rb/doc/index.rst index 094666250f3..0dc30a94049 100644 --- a/boards/st/nucleo_g071rb/doc/index.rst +++ b/boards/st/nucleo_g071rb/doc/index.rst @@ -149,6 +149,8 @@ For more details please refer to `STM32 Nucleo-64 board User Manual`_. Programming and Debugging ************************* +Nucleo G071RB board includes an ST-LINK/V3 embedded debug tool interface. + Applications for the ``nucleo_g071rb`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -156,7 +158,17 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -Nucleo G071RB board includes an ST-LINK/V3 embedded debug tool interface. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD, JLink, or pyOCD can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink + $ west flash --runner pyocd Flashing an application to Nucleo G071RB ---------------------------------------- @@ -198,3 +210,6 @@ References .. _G071RB on www.st.com: https://www.st.com/en/microcontrollers/stm32g071rb.html + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_g0b1re/doc/index.rst b/boards/st/nucleo_g0b1re/doc/index.rst index b283d6d3d1f..d5f73d75cc8 100644 --- a/boards/st/nucleo_g0b1re/doc/index.rst +++ b/boards/st/nucleo_g0b1re/doc/index.rst @@ -147,6 +147,8 @@ For more details please refer to `STM32 Nucleo-64 board User Manual`_. Programming and Debugging ************************* +Nucleo G0B1RE board includes an ST-LINK/V2-1 embedded debug tool interface. + Applications for the ``nucleo_g0b1re`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -154,21 +156,28 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -Nucleo G0B1RE board includes an ST-LINK/V2-1 embedded debug tool interface. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD, JLink, or pyOCD can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink + $ west flash --runner pyocd -This interface is not yet supported by the openocd version included in the Zephyr SDK. -But JLink, STM32CubeProgrammer and Pyocd interfaces are supported. Pyocd support is currently limited: As the stm32g0b1 target causes issues, -the stm32g071 target is used. For STM32G0 support pyocd needs additional target +the stm32g071 target is used. For STM32G0 support pyOCD needs additional target information, which can be installed by adding "pack" support with the -following pyocd command: +following pyOCD commands: .. code-block:: console $ pyocd pack --update $ pyocd pack --install stm32g0 - Flashing an application to Nucleo G0B1RE ---------------------------------------- @@ -209,3 +218,6 @@ References .. _G0B1RE on www.st.com: https://www.st.com/en/microcontrollers/stm32g0b1re.html + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_g431rb/doc/index.rst b/boards/st/nucleo_g431rb/doc/index.rst index 08d660a0c7d..9d87f2f41d2 100644 --- a/boards/st/nucleo_g431rb/doc/index.rst +++ b/boards/st/nucleo_g431rb/doc/index.rst @@ -184,6 +184,8 @@ low power mode. Programming and Debugging ************************* +Nucleo G431RB board includes an ST-LINK/V3E embedded debug tool interface. + Applications for the ``nucleo_g431rb`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -191,28 +193,24 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -Nucleo G431RB board includes an ST-LINK/V3E embedded debug tool interface. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. -This interface is not yet supported by the openocd version included in the Zephyr SDK. +Alternatively, OpenOCD or pyOCD can also be used to flash the board using +the ``--runner`` (or ``-r``) option: -Instead, support can be enabled on pyocd by adding "pack" support with -the following pyocd command: +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner pyocd + +pyOCD can be used after adding "pack" support with the following commands: .. code-block:: console $ pyocd pack --update $ pyocd pack --install stm32g431rb -Note: -To manually enable the openocd interface, You can still update, compile and install -a 'local' openocd from the official openocd repo http://openocd.zylin.com . -Then run the following openocd command where the '/usr/local/bin/openocd'is your path -for the freshly installed openocd, given by "$ which openocd" : - -.. code-block:: console - - $ west flash --openocd /usr/local/bin/openocd - Flashing an application to Nucleo G431RB ---------------------------------------- @@ -261,3 +259,6 @@ You can debug an application in the usual way. Here is an example for the .. _STM32G4 reference manual: https://www.st.com/resource/en/reference_manual/dm00355726.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_g474re/doc/index.rst b/boards/st/nucleo_g474re/doc/index.rst index d826ce37188..e4dc198a9d4 100644 --- a/boards/st/nucleo_g474re/doc/index.rst +++ b/boards/st/nucleo_g474re/doc/index.rst @@ -198,6 +198,8 @@ low power mode. Programming and Debugging ************************* +Nucleo G474RE board includes an ST-LINK/V3E embedded debug tool interface. + Applications for the ``nucleo_g474re`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -205,7 +207,16 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -Nucleo G474RE board includes an ST-LINK/V3E embedded debug tool interface. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or pyOCD can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner pyocd Flashing an application to Nucleo G474RE ---------------------------------------- @@ -255,3 +266,6 @@ You can debug an application in the usual way. Here is an example for the .. _STM32G4 reference manual: https://www.st.com/resource/en/reference_manual/dm00355726.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_h503rb/doc/index.rst b/boards/st/nucleo_h503rb/doc/index.rst index 1238441cb12..e8ab73b8cb5 100644 --- a/boards/st/nucleo_h503rb/doc/index.rst +++ b/boards/st/nucleo_h503rb/doc/index.rst @@ -190,6 +190,9 @@ VBAT can be provided via the left ST Morpho connector's pin 33. Programming and Debugging ************************* +Nucleo-H503RB board includes an ST-LINK/V3EC embedded debug tool interface. +This probe allows to flash the board using various tools. + Applications for the ``nucleo_h503rb`` board can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -215,30 +218,27 @@ including the common openocd.board.cmake file: Flashing ======== -Nucleo-H503RB board includes an ST-LINK/V3EC embedded debug tool interface. -This probe allows to flash the board using various tools. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. -Board is configured to be flashed using west STM32CubeProgrammer runner. -Installation of `STM32CubeProgrammer`_ is then required to flash the board. +Alternatively, OpencOCD or pyOCD can also be used to flash the board using +the ``--runner`` (or ``-r``) option: -Alternatively, pyocd can also be used to flash and debug the board -if west is told to use it as runner, which can be done by -passing ``-r pyocd``. +.. code-block:: console -For pyocd additional target information needs to be installed. -This can be done by executing the following commands. + $ west flash --runner openocd + $ west flash --runner pyocd + +For pyOCD, additional target information needs to be installed +which can be done by executing the following commands: .. code-block:: console $ pyocd pack --update $ pyocd pack --install stm32h5 -Alternatively, the openocd interface will be supported by a next openocd version. -When available, OpenOCD could be used in the same way as other tools. - - Flashing an application to Nucleo-H503RB ------------------------------------------- +---------------------------------------- Connect the Nucleo-H503RB to your host computer using the USB port. Then build and flash an application. Here is an example for the diff --git a/boards/st/nucleo_h533re/doc/index.rst b/boards/st/nucleo_h533re/doc/index.rst index 9561cf3daed..eec0ad90721 100644 --- a/boards/st/nucleo_h533re/doc/index.rst +++ b/boards/st/nucleo_h533re/doc/index.rst @@ -240,6 +240,9 @@ VBAT can be provided via the left ST Morpho connector's pin 33. Programming and Debugging ************************* +Nucleo H533RE board includes an ST-LINK/V3EC embedded debug tool interface. +This probe allows to flash the board using various tools. + Applications for the ``nucleo_h533re`` board can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -265,31 +268,28 @@ including the common openocd.board.cmake file: Flashing ======== -Nucleo H533RE board includes an ST-LINK/V3EC embedded debug tool interface. -This probe allows to flash the board using various tools. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. -Board is configured to be flashed using west STM32CubeProgrammer runner. -Installation of `STM32CubeProgrammer`_ is then required to flash the board. +Alternatively, OpenOCD, JLink, or pyOCD can also be used to flash the board using +the ``--runner`` (or ``-r``) option: -Alternatively, pyocd or jlink via an external probe can also be used to flash -and debug the board if west is told to use it as runner, which can be done by -passing either or ``-r pyocd``, or ``-r jlink``. +.. code-block:: console -For pyocd additional target information needs to be installed. -This can be done by executing the following commands. + $ west flash --runner openocd + $ west flash --runner pyocd + $ west flash --runner jlink + +For pyOCD, additional target information needs to be installed +which can be done by executing the following commands: .. code-block:: console $ pyocd pack --update $ pyocd pack --install stm32h5 - -Alternatively, the openocd interface will be supported by a next openocd version. -When available, OpenOCD could be used in the same way as other tools. - - Flashing an application to Nucleo H533RE ------------------------------------------- +---------------------------------------- Connect the Nucleo H533RE to your host computer using the USB port. Then build and flash an application. Here is an example for the diff --git a/boards/st/nucleo_h563zi/doc/index.rst b/boards/st/nucleo_h563zi/doc/index.rst index d202d6aa397..f448483fb54 100644 --- a/boards/st/nucleo_h563zi/doc/index.rst +++ b/boards/st/nucleo_h563zi/doc/index.rst @@ -252,6 +252,9 @@ VBAT can be provided via the left ST Morpho connector's pin 33. Programming and Debugging ************************* +Nucleo H563ZI board includes an ST-LINK/V3EC embedded debug tool interface. +This probe allows to flash the board using various tools. + Applications for the ``nucleo_h563zi`` board can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -278,17 +281,19 @@ including the common openocd.board.cmake file: Flashing ======== -Nucleo H563ZI board includes an ST-LINK/V3EC embedded debug tool interface. -This probe allows to flash the board using various tools. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. -Board is configured to be flashed using west STM32CubeProgrammer runner. -Installation of `STM32CubeProgrammer`_ is then required to flash the board. +Alternatively, OpenOCD, JLink, or pyOCD can also be used to flash the board using +the ``--runner`` (or ``-r``) option: -Alternatively, pyocd or jlink via an external probe can also be used to flash -and debug the board if west is told to use it as runner, which can be done by -passing either or ``-r pyocd``, or ``-r jlink``. +.. code-block:: console -For pyocd additional target information needs to be installed. + $ west flash --runner openocd + $ west flash --runner pyocd + $ west flash --runner jlink + +For pyOCD, additional target information needs to be installed. This can be done by executing the following commands. .. code-block:: console @@ -297,12 +302,8 @@ This can be done by executing the following commands. $ pyocd pack --install stm32h5 -Alternatively, the openocd interface will be supported by a next openocd version. -When available, OpenOCD could be used in the same way as other tools. - - Flashing an application to Nucleo H563ZI ------------------------------------------- +---------------------------------------- Connect the Nucleo H563ZI to your host computer using the USB port. Then build and flash an application. Here is an example for the diff --git a/boards/st/nucleo_h723zg/doc/index.rst b/boards/st/nucleo_h723zg/doc/index.rst index f138eaacf3d..1e364d88263 100644 --- a/boards/st/nucleo_h723zg/doc/index.rst +++ b/boards/st/nucleo_h723zg/doc/index.rst @@ -171,23 +171,28 @@ connected to pins PD0 (RX) and PD1 (TX). Programming and Debugging ************************* -Currently the ``nucleo_h723zg`` board supports stm32cubeprogrammer (default), OpenOCD and J-Link debuggers. +Nucleo H723ZG board includes an ST-LINK/V3 embedded debug tool interface. .. note:: - Official OpenOCD support for this board was added on October '20. - Make sure your openocd version is older than that. - Following links may be helpful: `OpenOCD installing Debug Version`_ - and `OpenOCD installing with ST-LINK V3 support`_ - -.. note:: - - Check if your ST-LINK V3 has newest FW version. It can be done with `STM32CubeIDE`_ + Check if your ST-LINK V3 has newest FW version. It can be done with `STM32CubeProgrammer`_ Flashing ======== -Nucleo H723ZG board includes an ST-LINK/V3 embedded debug tool interface. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink + +Flashing an application to Nucleo H723ZG +---------------------------------------- First, connect the NUCLEO-H723ZG to your host computer using the USB port to prepare it for flashing. Then build and flash your application. @@ -258,3 +263,6 @@ You can debug an application in the usual way. Here is an example for the .. _STM32CubeIDE: https://www.st.com/en/development-tools/stm32cubeide.html + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_h743zi/doc/index.rst b/boards/st/nucleo_h743zi/doc/index.rst index a521bfbd3e8..403f356b862 100644 --- a/boards/st/nucleo_h743zi/doc/index.rst +++ b/boards/st/nucleo_h743zi/doc/index.rst @@ -184,20 +184,26 @@ Requires an external CAN or CANFD transceiver. Programming and Debugging ************************* +Nucleo H743ZI board includes an ST-LINK/V2-1 embedded debug tool interface. + Applications for the ``nucleo_h743zi`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). -.. note:: - - If using OpenOCD you will need a recent development version as the last - official release does not support H7 series yet. You can also choose the - ``stm32cubeprogrammer`` or ``pyocd``` runner. - Flashing ======== -Nucleo H743ZI board includes an ST-LINK/V2-1 embedded debug tool interface. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD, JLink or pyOCD can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink + $ west flash --runner pyocd Flashing an application to Nucleo H743ZI ---------------------------------------- @@ -246,3 +252,6 @@ You can debug an application in the usual way. Here is an example for the .. _STM32H743 reference manual: https://www.st.com/resource/en/reference_manual/dm00314099.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_h745zi_q/doc/index.rst b/boards/st/nucleo_h745zi_q/doc/index.rst index a77ac60e3f5..35e9dd2fbb1 100644 --- a/boards/st/nucleo_h745zi_q/doc/index.rst +++ b/boards/st/nucleo_h745zi_q/doc/index.rst @@ -173,29 +173,38 @@ two cores. This is done in 3 ways: Programming and Debugging ************************* +Nucleo H745ZI-Q board includes an ST-LINK/V3 embedded debug tool interface. + Applications for the ``nucleo_h745zi_q`` board should be built per core target, -using either ``nucleo_h745zi_q_m7`` or ```nucleo_h745zi_q_m4`` as the target -(see :ref:`build_an_application` and :ref:`application_run` for more details). +using either ``nucleo_h745zi_q/stm32h745xx/m7`` or ``nucleo_h745zi_q/stm32h745xx/m4`` +as the target (see :ref:`build_an_application` and :ref:`application_run` for more details). .. note:: - If using OpenOCD you will need a recent development version as the last - official release does not support H7 series and ST-LINK V3 yet. - Following links may be helpful: `OpenOCD installing Debug Version`_ - and `OpenOCD installing with ST-LINK V3 support`_ - -.. note:: - - Check if your ST-LINK V3 has newest FW version. It can be done with `STM32CubeIDE`_ + Check if the board's ST-LINK V3 has the newest FW version. It can be updated + using `STM32CubeProgrammer`_. Flashing ======== -Nucleo H745ZI-Q board includes an ST-LINK/V3 embedded debug tool interface. - Flashing operation will depend on the target to be flashed and the SoC option bytes configuration. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner +for both cores, so its :ref:`installation ` is required. +The target core is detected automatically. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink + +It is advised to use `STM32CubeProgrammer`_ to check and update option bytes +configuration. + By default: - CPU0 (Cortex-M7) boot address is set to 0x80000000 (OB: BOOT_CM7_ADD0) @@ -229,7 +238,7 @@ Build and flash the application: .. zephyr-app-commands:: :zephyr-app: samples/hello_world - :board: nucleo_h745zi_q_m7 + :board: nucleo_h745zi_q/stm32h745xx/m7 :goals: build flash You should see the following message on the console: @@ -249,7 +258,7 @@ Here is an example for the :zephyr:code-sample:`blinky` application on M4 core. .. zephyr-app-commands:: :zephyr-app: samples/basic/blinky - :board: nucleo_h745zi_q_m4 + :board: nucleo_h745zi_q/stm32h745xx/m4 :goals: build flash .. note:: @@ -260,18 +269,17 @@ Here is an example for the :zephyr:code-sample:`blinky` application on M4 core. Debugging ========= -You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +You can debug an application on Cortex M7 side in the usual way. Here is an example +for the :ref:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world - :board: nucleo_h745zi_q_m7 + :board: nucleo_h745zi_q/stm32h745xx/m7 :maybe-skip-config: :goals: debug -Debugging with west is currently not available on Cortex M4 side. -In order to debug a Zephyr application on Cortex M4 side, you can use -`STM32CubeIDE`_. +Debugging a Zephyr application on Cortex M4 side with west is currently not available. +As a workaround, you can use `STM32CubeIDE`_. .. _Nucleo H745ZI-Q website: https://www.st.com/en/evaluation-tools/nucleo-h745zi-q.html @@ -293,3 +301,6 @@ In order to debug a Zephyr application on Cortex M4 side, you can use .. _STM32CubeIDE: https://www.st.com/en/development-tools/stm32cubeide.html + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_h753zi/doc/index.rst b/boards/st/nucleo_h753zi/doc/index.rst index 536d90d6310..d03b6c1b5e7 100644 --- a/boards/st/nucleo_h753zi/doc/index.rst +++ b/boards/st/nucleo_h753zi/doc/index.rst @@ -169,20 +169,25 @@ Requires an external CAN or CANFD transceiver. Programming and Debugging ************************* +Nucleo H753ZI board includes an ST-LINK/V3 embedded debug tool interface. + Applications for the ``nucleo_h753zi`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). -.. note:: - - If using OpenOCD you will need a recent development version as the last - official release does not support H7 series yet. You can also choose the - ``stm32cubeprogrammer`` runner. - Flashing ======== -Nucleo H753ZI board includes an ST-LINK/V2-1 embedded debug tool interface. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flashing an application to Nucleo H753ZI ---------------------------------------- @@ -231,3 +236,6 @@ You can debug an application in the usual way. Here is an example for the .. _STM32H753 reference manual: https://www.st.com/resource/en/reference_manual/dm00314099.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_h755zi_q/doc/index.rst b/boards/st/nucleo_h755zi_q/doc/index.rst index 2b5aecf3368..d511cb1d7db 100644 --- a/boards/st/nucleo_h755zi_q/doc/index.rst +++ b/boards/st/nucleo_h755zi_q/doc/index.rst @@ -163,6 +163,8 @@ two cores. This is done in 3 ways: Programming and Debugging ************************* +Nucleo H755ZI-Q board includes an ST-LINK/V3 embedded debug tool interface. + Applications for the ``nucleo_h755zi_q`` board should be built per core target, using either ``nucleo_h755zi_q/stm32h755xx/m7`` or ``nucleo_h755zi_q/stm32h755xx/m4`` as the target (see :ref:`build_an_application` and :ref:`application_run` for more @@ -170,16 +172,14 @@ details). .. note:: - Check if the board's ST-LINK V3 has the newest firmware version. It can be - updated with `STM32CubeIDE`_ + Check if the board's ST-LINK/V3 has the newest firmware version. It can be + updated with `STM32CubeProgrammer`_ Flashing ======== -Nucleo H755ZI-Q board includes an ST-LINK/V3 embedded debug tool interface. - The board is configured to be flashed using west `STM32CubeProgrammer`_ runner -for both cores, so its installation is required to be able to flash the board. +for both cores, so its :ref:`installation ` is required. The target core is detected automatically. It is advised to use `STM32CubeProgrammer`_ to check and update option bytes @@ -196,7 +196,7 @@ board is powered (Option bytes BCM7 and BCM4 are checked). In that configuration, Kconfig boot option ``STM32H7_BOOT_CM4_CM7`` should be selected. Zephyr flash configuration has been set to meet these default settings. -Alternatively, openocd or JLink can also be used to flash the board using +Alternatively, OpenOCD or JLink can also be used to flash the board using the ``--runner`` (or ``-r``) option: .. code-block:: console diff --git a/boards/st/nucleo_h7a3zi_q/doc/index.rst b/boards/st/nucleo_h7a3zi_q/doc/index.rst index 484c7e82196..1683e04d87a 100644 --- a/boards/st/nucleo_h7a3zi_q/doc/index.rst +++ b/boards/st/nucleo_h7a3zi_q/doc/index.rst @@ -148,6 +148,8 @@ assigned to USART3. Default settings are 115200 8N1. Programming and Debugging ************************* +Nucleo H7A3ZI-Q board includes an ST-LINK/V3E embedded debug tool interface. + Applications for the ``nucleo_h7a3zi_q`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -155,7 +157,16 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -Nucleo H7A3ZI-Q board includes an ST-LINK/V3E embedded debug tool interface. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flashing an application to Nucleo H7A3ZI-Q ------------------------------------------ @@ -204,3 +215,6 @@ You can debug an application in the usual way. Here is an example for the .. _STM32H7A3ZI-Q reference manual: https://www.st.com/resource/en/reference_manual/rm0455-stm32h7a37b3-and-stm32h7b0-value-line-advanced-armbased-32bit-mcus-stmicroelectronics.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_l011k4/doc/index.rst b/boards/st/nucleo_l011k4/doc/index.rst index 7344ed734ad..7e13a9040a7 100644 --- a/boards/st/nucleo_l011k4/doc/index.rst +++ b/boards/st/nucleo_l011k4/doc/index.rst @@ -118,6 +118,8 @@ For more details please refer to `STM32 Nucleo-32 board User Manual`_. Programming and Debugging ************************* +Nucleo L011K4 board includes an ST-LINK/V2-1 embedded debug tool interface. + Applications for the ``nucleo_l011k4`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -125,8 +127,16 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -Nucleo L011K4 board includes an ST-LINK/V2-1 embedded debug tool interface. -This interface is supported by the openocd version included in the Zephyr SDK. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flashing an application to Nucleo L011K4 ---------------------------------------- @@ -165,3 +175,6 @@ References .. _STM32 Nucleo-32 board User Manual: https://www.st.com/resource/en/user_manual/dm00231744-stm32-nucleo32-boards-mb1180-stmicroelectronics.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_l031k6/doc/index.rst b/boards/st/nucleo_l031k6/doc/index.rst index 543d0cc01f8..2b1a3232128 100644 --- a/boards/st/nucleo_l031k6/doc/index.rst +++ b/boards/st/nucleo_l031k6/doc/index.rst @@ -111,6 +111,8 @@ For more details please refer to `STM32 Nucleo-32 board User Manual`_. Programming and Debugging ************************* +Nucleo L031K6 board includes an ST-LINK/V2-1 embedded debug tool interface. + Applications for the ``nucleo_l031k6`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -118,8 +120,16 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -Nucleo L031K6 board includes an ST-LINK/V2-1 embedded debug tool interface. -This interface is supported by the openocd version included in the Zephyr SDK. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flashing an application to Nucleo L031K6 ---------------------------------------- @@ -158,3 +168,6 @@ References .. _STM32 Nucleo-32 board User Manual: https://www.st.com/resource/en/user_manual/dm00231744-stm32-nucleo32-boards-mb1180-stmicroelectronics.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_l053r8/doc/index.rst b/boards/st/nucleo_l053r8/doc/index.rst index e8fdac96751..101d4c80d64 100644 --- a/boards/st/nucleo_l053r8/doc/index.rst +++ b/boards/st/nucleo_l053r8/doc/index.rst @@ -127,6 +127,8 @@ For more details please refer to `STM32 Nucleo-64 board User Manual`_. Programming and Debugging ************************* +Nucleo L053R8 board includes an ST-LINK/V2-1 embedded debug tool interface. + Applications for the ``nucleo_l053r8`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -134,8 +136,16 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -Nucleo L053R8 board includes an ST-LINK/V2-1 embedded debug tool interface. -This interface is supported by the openocd version included in the Zephyr SDK. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flashing an application to Nucleo L053R8 ---------------------------------------- @@ -174,3 +184,6 @@ References .. _STM32 Nucleo-64 board User Manual: https://www.st.com/resource/en/user_manual/dm00105823.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_l073rz/doc/index.rst b/boards/st/nucleo_l073rz/doc/index.rst index 991a3710d08..70c49d66b71 100644 --- a/boards/st/nucleo_l073rz/doc/index.rst +++ b/boards/st/nucleo_l073rz/doc/index.rst @@ -143,6 +143,8 @@ For more details please refer to `STM32 Nucleo-64 board User Manual`_. Programming and Debugging ************************* +Nucleo L073RZ board includes an ST-LINK/V2-1 embedded debug tool interface. + Applications for the ``nucleo_l073rz`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -150,8 +152,16 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -Nucleo L073RZ board includes an ST-LINK/V2-1 embedded debug tool interface. -This interface is supported by the openocd version included in the Zephyr SDK. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flashing an application to Nucleo L073RZ ---------------------------------------- @@ -190,3 +200,6 @@ References .. _STM32 Nucleo-64 board User Manual: https://www.st.com/resource/en/user_manual/dm00105823.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_l152re/doc/index.rst b/boards/st/nucleo_l152re/doc/index.rst index e0e92e5c168..29a7cab6ac6 100644 --- a/boards/st/nucleo_l152re/doc/index.rst +++ b/boards/st/nucleo_l152re/doc/index.rst @@ -137,6 +137,8 @@ For more details please refer to `STM32 Nucleo-64 board User Manual`_. Programming and Debugging ************************* +Nucleo L152RE board includes an ST-LINK/V2-1 embedded debug tool interface. + Applications for the ``nucleo_l152re`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -144,8 +146,15 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -Nucleo L152RE board includes an ST-LINK/V2-1 embedded debug tool interface. -This interface is supported by the openocd version included in the Zephyr SDK. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, openocd can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd Flashing an application to Nucleo L152RE ---------------------------------------- @@ -187,3 +196,6 @@ References .. _STM32 Nucleo-64 board User Manual: https://www.st.com/resource/en/user_manual/dm00105823.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_l412rb_p/doc/index.rst b/boards/st/nucleo_l412rb_p/doc/index.rst index b423f06c174..97d998d8454 100644 --- a/boards/st/nucleo_l412rb_p/doc/index.rst +++ b/boards/st/nucleo_l412rb_p/doc/index.rst @@ -208,6 +208,8 @@ Default settings are 115200 8N1. Programming and Debugging ************************* +Nucleo L412RB-P board includes an ST-LINK/V2-1 embedded debug tool interface. + Applications for the ``nucleo_l412rb_p`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -215,9 +217,16 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -Nucleo L412RB-P board includes an ST-LINK/V2-1 embedded debug tool -interface. This interface is supported by the openocd version -included in the Zephyr SDK since v0.9.2. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flashing an application to Nucleo L412RB-P ------------------------------------------ @@ -267,3 +276,6 @@ You can debug an application in the usual way. Here is an example for the .. _STM32L412 reference manual: https://www.st.com/resource/en/reference_manual/dm00151940-stm32l41xxx42xxx43xxx44xxx45xxx46xxx-advanced-armbased-32bit-mcus-stmicroelectronics.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_l432kc/doc/index.rst b/boards/st/nucleo_l432kc/doc/index.rst index ddbfaec6a80..b54031aaa62 100644 --- a/boards/st/nucleo_l432kc/doc/index.rst +++ b/boards/st/nucleo_l432kc/doc/index.rst @@ -168,6 +168,8 @@ Default settings are 115200 8N1. Programming and Debugging ************************* +Nucleo L432KC board includes an ST-LINK/V2-1 embedded debug tool interface. + Applications for the ``nucleo_l432kc`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -175,9 +177,16 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -Nucleo L432KC board includes an ST-LINK/V2-1 embedded debug tool -interface. This interface is supported by the openocd version -included in the Zephyr SDK since v0.9.2. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flashing an application to Nucleo L432KC ---------------------------------------- @@ -227,3 +236,6 @@ You can debug an application in the usual way. Here is an example for the .. _STM32L432 reference manual: https://www.st.com/resource/en/reference_manual/dm00151940.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_l433rc_p/doc/index.rst b/boards/st/nucleo_l433rc_p/doc/index.rst index 8981c68b236..9269652973b 100644 --- a/boards/st/nucleo_l433rc_p/doc/index.rst +++ b/boards/st/nucleo_l433rc_p/doc/index.rst @@ -173,6 +173,8 @@ to LPUART1. Default settings are 115200 8N1. Programming and Debugging ************************* +Nucleo L433RC-P board includes an ST-LINK/V2-1 embedded debug tool interface. + Applications for the ``nucleo_l433rc_p`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -180,9 +182,16 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -Nucleo L433RC-P board includes an ST-LINK/V2-1 embedded debug tool -interface. This interface is supported by the openocd version -included in the Zephyr SDK since v0.9.2. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flashing an application to Nucleo L433RC-P ------------------------------------------ @@ -232,3 +241,6 @@ You can debug an application in the usual way. Here is an example for the .. _STM32L432 reference manual: https://www.st.com/resource/en/reference_manual/dm00151940.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_l452re/doc/index.rst b/boards/st/nucleo_l452re/doc/index.rst index 57839f931c5..26ff761d06c 100644 --- a/boards/st/nucleo_l452re/doc/index.rst +++ b/boards/st/nucleo_l452re/doc/index.rst @@ -192,6 +192,8 @@ Default settings are 115200 8N1. Programming and Debugging ************************* +Nucleo L452RE board includes an ST-LINK/V2-1 embedded debug tool interface. + Applications for the ``nucleo_l452re`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -199,9 +201,16 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -Nucleo L452RE board includes an ST-LINK/V2-1 embedded debug tool -interface. This interface is supported by the openocd version -included in the Zephyr SDK since v0.9.2. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flashing an application to Nucleo L452RE ---------------------------------------- @@ -264,3 +273,6 @@ You can debug an application in the usual way. Here is an example for the .. _STM32L452 reference manual: https://www.st.com/resource/en/reference_manual/dm00151940.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_l476rg/doc/index.rst b/boards/st/nucleo_l476rg/doc/index.rst index a45b18b339e..2e1557e22ef 100644 --- a/boards/st/nucleo_l476rg/doc/index.rst +++ b/boards/st/nucleo_l476rg/doc/index.rst @@ -181,6 +181,8 @@ Default settings are 115200 8N1. Programming and Debugging ************************* +Nucleo L476RG board includes an ST-LINK/V2-1 embedded debug tool interface. + Applications for the ``nucleo_l476rg`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -188,9 +190,16 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -Nucleo L476RG board includes an ST-LINK/V2-1 embedded debug tool -interface. This interface is supported by the openocd version -included in the Zephyr SDK since v0.9.2. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flashing an application to Nucleo L476RG ---------------------------------------- @@ -241,3 +250,6 @@ You can debug an application in the usual way. Here is an example for the .. _STM32L476 reference manual: https://www.st.com/resource/en/reference_manual/DM00083560.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_l496zg/doc/index.rst b/boards/st/nucleo_l496zg/doc/index.rst index da208a4c8d9..d2f45406181 100644 --- a/boards/st/nucleo_l496zg/doc/index.rst +++ b/boards/st/nucleo_l496zg/doc/index.rst @@ -182,6 +182,8 @@ Default settings are 115200 8N1. Programming and Debugging ************************* +Nucleo L496ZG board includes an ST-LINK/V2-1 embedded debug tool interface. + Applications for the ``nucleo_l496zg`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -189,9 +191,16 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -Nucleo L496ZG board includes an ST-LINK/V2-1 embedded debug tool -interface. This interface is supported by the openocd version -included in the Zephyr SDK since v0.9.5. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flashing an application to Nucleo L496ZG ---------------------------------------- @@ -242,3 +251,6 @@ You can debug an application in the usual way. Here is an example for the .. _STM32L496 reference manual: https://www.st.com/resource/en/reference_manual/dm00083560.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_l4a6zg/doc/index.rst b/boards/st/nucleo_l4a6zg/doc/index.rst index 30cac697dde..428ece2b645 100644 --- a/boards/st/nucleo_l4a6zg/doc/index.rst +++ b/boards/st/nucleo_l4a6zg/doc/index.rst @@ -181,6 +181,8 @@ Default settings are 115200 8N1. Programming and Debugging ************************* +Nucleo L4A6ZG board includes an ST-LINK/V2-1 embedded debug tool interface. + Applications for the ``nucleo_l4a6zg`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -188,9 +190,16 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -Nucleo L4A6ZG board includes an ST-LINK/V2-1 embedded debug tool -interface. This interface is supported by the OpenOCD version -included in the Zephyr SDK since v0.9.5. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flashing an application to Nucleo L4A6ZG ---------------------------------------- @@ -241,3 +250,6 @@ You can debug an application in the usual way. Here is an example for the .. _STM32L4A6 reference manual: https://www.st.com/resource/en/reference_manual/dm00083560.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_l4r5zi/doc/index.rst b/boards/st/nucleo_l4r5zi/doc/index.rst index 5fd6156e1ba..7de08708650 100644 --- a/boards/st/nucleo_l4r5zi/doc/index.rst +++ b/boards/st/nucleo_l4r5zi/doc/index.rst @@ -223,17 +223,23 @@ Programming and Debugging The NUCLEO-L4R5ZI board includes a ST-LINK/V2 embedded debug tool interface. -The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, -so its installation is required to be able to flash the board. +Flashing +======== -Alternatively, openocd (provided in Zephyr SDK) or JLink can also be used to -flash the board using the ``--runner`` (or ``-r``) option: +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: .. code-block:: console $ west flash --runner openocd $ west flash --runner jlink +Flashing an application to Nucleo L4R4ZI +---------------------------------------- + Connect the Nucleo L4R5ZI to your host computer using the USB port. Then build and flash an application. diff --git a/boards/st/nucleo_l552ze_q/doc/nucleol552ze_q.rst b/boards/st/nucleo_l552ze_q/doc/nucleol552ze_q.rst index f084852c7ad..7339c0b10bd 100644 --- a/boards/st/nucleo_l552ze_q/doc/nucleol552ze_q.rst +++ b/boards/st/nucleo_l552ze_q/doc/nucleol552ze_q.rst @@ -282,6 +282,8 @@ UART2. Default settings are 115200 8N1. Programming and Debugging ************************* +Nucleo L552ZE Q board includes an ST-LINK/V2-1 embedded debug tool interface. + Applications for the ``nucleo_l552ze_q`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -289,18 +291,25 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -Nucleo L552ZE Q board includes an ST-LINK/V2-1 embedded debug tool -interface. Support can be enabled on pyocd by adding "pack" support with the -following pyocd command: +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or pyOCD can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner pyocd + +Support can be enabled for pyOCD by adding "pack" support with the +following pyOCD commands: .. code-block:: console $ pyocd pack --update $ pyocd pack --install stm32l552ze -Alternatively, this interface is supported by the openocd version -included in the Zephyr SDK since v0.13.1. - Flashing an application to Nucleo L552ZE Q ------------------------------------------ diff --git a/boards/st/nucleo_u083rc/doc/index.rst b/boards/st/nucleo_u083rc/doc/index.rst index 6786c30ffdd..5595cfaddcb 100644 --- a/boards/st/nucleo_u083rc/doc/index.rst +++ b/boards/st/nucleo_u083rc/doc/index.rst @@ -201,14 +201,18 @@ This probe allows to flash the board using various tools. Flashing ======== -Board is configured to be flashed using west STM32CubeProgrammer runner. -Installation of `STM32CubeProgrammer`_ is then required to flash the board. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. -Alternatively, pyocd or jlink via an external probe can also be used to flash -and debug the board if west is told to use it as runner, which can be done by -passing either or ``-r pyocd``, or ``-r jlink``. +Alternatively, JLink or pyOCD can also be used to flash the board using +the ``--runner`` (or ``-r``) option: -For pyocd additional target information needs to be installed. +.. code-block:: console + + $ west flash --runner jlink + $ west flash --runner pyocd + +For pyOCD, additional target information needs to be installed. This can be done by executing the following commands. .. code-block:: console diff --git a/boards/st/nucleo_u575zi_q/doc/index.rst b/boards/st/nucleo_u575zi_q/doc/index.rst index d69bbe3f28d..1852246f069 100644 --- a/boards/st/nucleo_u575zi_q/doc/index.rst +++ b/boards/st/nucleo_u575zi_q/doc/index.rst @@ -247,14 +247,19 @@ This probe allows to flash the board using various tools. Flashing ======== -Board is configured to be flashed using west STM32CubeProgrammer runner. -Installation of `STM32CubeProgrammer`_ is then required to flash the board. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. -Alternatively, openocd (provided in Zephyr SDK), JLink and pyocd can also be -used to flash and debug the board if west is told to use it as runner, -which can be done by passing either ``-r openocd``, ``-r jlink`` or ``-r pyocd``. +Alternatively, OpenOCD, JLink, or pyOCD can also be used to flash the board using +the ``--runner`` (or ``-r``) option: -For pyocd additional target information needs to be installed. +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink + $ west flash --runner pyocd + +For pyOCD, additional target information needs to be installed. This can be done by executing the following commands. .. code-block:: console diff --git a/boards/st/nucleo_u5a5zj_q/doc/index.rst b/boards/st/nucleo_u5a5zj_q/doc/index.rst index 9245300e816..47b36fce8ad 100644 --- a/boards/st/nucleo_u5a5zj_q/doc/index.rst +++ b/boards/st/nucleo_u5a5zj_q/doc/index.rst @@ -279,14 +279,19 @@ This probe allows to flash the board using various tools. Flashing ======== -Board is configured to be flashed using west STM32CubeProgrammer runner. -Installation of `STM32CubeProgrammer`_ is then required to flash the board. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. -Alternatively, openocd (provided in Zephyr SDK), JLink and pyocd can also be -used to flash and debug the board if west is told to use it as runner, -which can be done by passing either ``-r openocd``, ``-r jlink`` or ``-r pyocd``. +Alternatively, OpenOCD, JLink, or pyOCD can also be used to flash the board using +the ``--runner`` (or ``-r``) option: -For pyocd additional target information needs to be installed. +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink + $ west flash --runner pyocd + +For pyOCD, additional target information needs to be installed. This can be done by executing the following commands. .. code-block:: console diff --git a/boards/st/nucleo_wb55rg/doc/nucleo_wb55rg.rst b/boards/st/nucleo_wb55rg/doc/nucleo_wb55rg.rst index 6be25936050..3a97a2bfc90 100644 --- a/boards/st/nucleo_wb55rg/doc/nucleo_wb55rg.rst +++ b/boards/st/nucleo_wb55rg/doc/nucleo_wb55rg.rst @@ -241,18 +241,27 @@ Default settings are 115200 8N1. Programming and Debugging ************************* +Nucleo WB55RG board includes an ST-LINK/V2-1 embedded debug tool interface. + Applications for the ``nucleo_wb55rg`` board configuration can be built the usual way (see :ref:`build_an_application`). Flashing ======== -Nucleo WB55RG board includes an ST-LINK/V2-1 embedded debug tool -interface. This interface is supported by the openocd version included in the -Zephyr SDK since v0.11.0. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. -If you prefer, you can use pyocd, but it requires to enable "pack" support with -the following pyocd command: +Alternatively, OpenOCD or pyOCD can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner pyocd + +If you prefer, you can use pyOCD, but it requires to enable "pack" support with +the following pyOCD command: .. code-block:: console @@ -309,3 +318,6 @@ You can debug an application in the usual way. Here is an example for the .. _STM32WB5RG reference manual: https://www.st.com/resource/en/reference_manual/dm00318631.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_wba52cg/doc/nucleo_wba52cg.rst b/boards/st/nucleo_wba52cg/doc/nucleo_wba52cg.rst index 1b4362caeb2..7c3257aa6fa 100644 --- a/boards/st/nucleo_wba52cg/doc/nucleo_wba52cg.rst +++ b/boards/st/nucleo_wba52cg/doc/nucleo_wba52cg.rst @@ -228,8 +228,15 @@ It could be used for flash and debug using either OpenOCD or STM32Cube ecosystem Flashing ======== -STM32CubeProgrammer is configured as flashing tool by default. -If available, OpenOCD could be used. Same process applies with both tools. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd Flashing an application to Nucleo WBA52CG ----------------------------------------- @@ -287,3 +294,6 @@ For that: .. _OpenOCD official Github mirror: https://github.com/openocd-org/openocd/commit/870769b0ba9f4dae6ada9d8b1a40d75bd83aaa06 + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_wba55cg/doc/nucleo_wba55cg.rst b/boards/st/nucleo_wba55cg/doc/nucleo_wba55cg.rst index 7444c39bd42..c1ec0751854 100644 --- a/boards/st/nucleo_wba55cg/doc/nucleo_wba55cg.rst +++ b/boards/st/nucleo_wba55cg/doc/nucleo_wba55cg.rst @@ -241,8 +241,15 @@ It could be used for flash and debug using either OpenOCD or STM32Cube ecosystem Flashing ======== -STM32CubeProgrammer is configured as flashing tool by default. -If available, OpenOCD could be used. Same process applies with both tools. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, openocd can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd Flashing an application to Nucleo WBA55CG ----------------------------------------- @@ -291,3 +298,6 @@ For that: .. _OpenOCD official Github mirror: https://github.com/openocd-org/openocd/commit/870769b0ba9f4dae6ada9d8b1a40d75bd83aaa06 + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/nucleo_wl55jc/doc/nucleo_wl55jc.rst b/boards/st/nucleo_wl55jc/doc/nucleo_wl55jc.rst index 50f7c63d9e0..ca0276ebb00 100644 --- a/boards/st/nucleo_wl55jc/doc/nucleo_wl55jc.rst +++ b/boards/st/nucleo_wl55jc/doc/nucleo_wl55jc.rst @@ -258,16 +258,23 @@ Default settings are 115200 8N1. Programming and Debugging ************************* +Nucleo WL55JC board includes an STLINK-V3 embedded debug tool interface. + Applications for the ``nucleo_wl55jc`` board configuration can be built the usual way (see :ref:`build_an_application`). Flashing ======== -Nucleo WL55JC board includes an STLINK-V3 embedded debug tool -interface. This interface is supported by the openocd version included in the -Zephyr SDK since v0.11.0. -You can also choose the ``stm32cubeprogrammer`` runner. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd Flashing an application to Nucleo WL55JC @@ -328,3 +335,6 @@ You can debug an application in the usual way. Here is an example for the .. _STM32WL55JC reference manual: https://www.st.com/resource/en/reference_manual/dm00451556-stm32wl5x-advanced-armbased-32bit-mcus-with-subghz-radio-solution-stmicroelectronics.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/stm32c0116_dk/doc/index.rst b/boards/st/stm32c0116_dk/doc/index.rst index a59086c2930..98276b34946 100644 --- a/boards/st/stm32c0116_dk/doc/index.rst +++ b/boards/st/stm32c0116_dk/doc/index.rst @@ -106,6 +106,8 @@ The STM32C0116 Discovery board is configured as follows: Programming and Debugging ************************* +STM32C0116-DK Discovery kit includes an ST-LINK/V2 embedded debug tool interface. + Applications for the ``stm32c0116_dk`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -113,7 +115,15 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -STM32C0116-DK Discovery kit includes an ST-LINK/V2 embedded debug tool interface. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner jlink Flashing an application to STM32C0116-DK ------------------------------------------- @@ -152,3 +162,6 @@ You should see the following message on the console: .. _STM32C0x1 reference manual: https://www.st.com/resource/en/reference_manual/rm0490-stm32c0x1-advanced-armbased-64bit-mcus-stmicroelectronics.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/stm32f072_eval/doc/index.rst b/boards/st/stm32f072_eval/doc/index.rst index 998670d4cf2..b1bb7b0b5ac 100644 --- a/boards/st/stm32f072_eval/doc/index.rst +++ b/boards/st/stm32f072_eval/doc/index.rst @@ -142,6 +142,8 @@ Default settings are 115200 8N1. Programming and Debugging ************************* +STM32F072-EVAL Discovery kit includes an ST-LINK/V2 embedded debug tool interface. + Applications for the ``stm32f072_eval`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -149,8 +151,16 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -STM32F072-EVAL Discovery kit includes an ST-LINK/V2 embedded debug tool interface. -This interface is supported by the openocd version included in Zephyr SDK. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flashing an application to STM32F072-EVAL ------------------------------------------- @@ -182,3 +192,6 @@ You can debug an application in the usual way. Here is an example for the .. _STM32F072 reference manual: https://www.st.com/resource/en/reference_manual/dm00031936.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/stm32f072b_disco/doc/index.rst b/boards/st/stm32f072b_disco/doc/index.rst index d09a8fc47df..6ce491e3621 100644 --- a/boards/st/stm32f072b_disco/doc/index.rst +++ b/boards/st/stm32f072b_disco/doc/index.rst @@ -144,6 +144,8 @@ is assigned to UART 1. Default settings are 115200 8N1. Programming and Debugging ************************* +STM32F072B-DISCO board includes an ST-LINK/V2 embedded debug tool interface. + Applications for the ``stm32f072b_disco`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -151,9 +153,16 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -STM32F072B-DISCO board includes an ST-LINK/V2 embedded debug tool interface. -This interface is supported by the openocd version included in the Zephyr SDK. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flashing an application to STM32F072B-DISCO ------------------------------------------- @@ -216,3 +225,6 @@ References .. _SK Pang CAN breakout board: https://www.skpang.co.uk/products/can-bus-can-fd-breakout-board-5v-supply-and-5v-logic + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/stm32f0_disco/doc/index.rst b/boards/st/stm32f0_disco/doc/index.rst index 3947600d837..64e4605566b 100644 --- a/boards/st/stm32f0_disco/doc/index.rst +++ b/boards/st/stm32f0_disco/doc/index.rst @@ -94,6 +94,8 @@ For more details please refer to `STM32F0DISCOVERY board User Manual`_. Programming and Debugging ************************* +STM32F0DISCOVERY board includes an ST-LINK/V2-1 embedded debug tool interface. + Applications for the ``stm32f0_disco`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -101,8 +103,16 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -STM32F0DISCOVERY board includes an ST-LINK/V2-1 embedded debug tool interface. -This interface is supported by the openocd version included in the Zephyr SDK. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flashing an application to Nucleo F030R8 ---------------------------------------- @@ -141,3 +151,6 @@ References .. _STM32F0DISCOVERY board User Manual: https://www.st.com/resource/en/user_manual/dm00050135.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/stm32f3_disco/doc/index.rst b/boards/st/stm32f3_disco/doc/index.rst index d4a629a4895..4ad79931ba9 100644 --- a/boards/st/stm32f3_disco/doc/index.rst +++ b/boards/st/stm32f3_disco/doc/index.rst @@ -201,9 +201,6 @@ transceiver must be connected to ``PD0`` (``CAN1_RX``) and ``PD1`` Programming and Debugging ************************* -Flashing -======== - STM32F3DISCOVERY Discovery kit includes a ST-LINK/V2 or ST-LINK/V2-B embedded debug tool interface. @@ -211,6 +208,20 @@ Applications for the ``stm32f3_disco`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). +Flashing +======== + +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink + Flashing an application to STM32F3DISCOVERY ------------------------------------------- @@ -280,3 +291,6 @@ Again you have to use the adapted command for newer PCB revisions (E and newer): .. _STM32F303xC reference manual: https://www.st.com/resource/en/reference_manual/dm00043574.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/stm32f411e_disco/doc/index.rst b/boards/st/stm32f411e_disco/doc/index.rst index a2e6f02619b..acac229c810 100644 --- a/boards/st/stm32f411e_disco/doc/index.rst +++ b/boards/st/stm32f411e_disco/doc/index.rst @@ -124,6 +124,8 @@ assigned to UART2. Default settings are 115200 8N1. Programming and Debugging ************************* +STM32F411E-DISCO Discovery kit includes an ST-LINK/V2 embedded debug tool interface. + Applications for the ``stm32f411e_disco`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -131,9 +133,16 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -STM32F411E-DISCO Discovery kit includes an ST-LINK/V2 embedded debug tool -interface. This interface is supported by the openocd version included in -Zephyr SDK. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flashing an application to STM32F411E-DISCO ------------------------------------------- @@ -186,3 +195,6 @@ References .. _STM32F411x reference manual: https://www.st.com/resource/en/reference_manual/dm00119316.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/stm32f412g_disco/doc/index.rst b/boards/st/stm32f412g_disco/doc/index.rst index 0443d00b483..28a5499d878 100644 --- a/boards/st/stm32f412g_disco/doc/index.rst +++ b/boards/st/stm32f412g_disco/doc/index.rst @@ -140,6 +140,8 @@ Default settings are 115200 8N1. Programming and Debugging ************************* +STM32F412G-DISCO Discovery kit includes an ST-LINK/V2 embedded debug tool interface. + Applications for the ``stm32f412g_disco`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -147,8 +149,16 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -STM32F412G-DISCO Discovery kit includes an ST-LINK/V2 embedded debug tool interface. -This interface is supported by the openocd version included in Zephyr SDK. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flashing an application to STM32F412G-DISCO ------------------------------------------- @@ -199,3 +209,6 @@ You can debug an application in the usual way. Here is an example for the .. _STM32F412 reference manual: https://www.st.com/resource/en/reference_manual/dm00180369.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/stm32f4_disco/doc/index.rst b/boards/st/stm32f4_disco/doc/index.rst index 8839759a3ab..128b84f3168 100644 --- a/boards/st/stm32f4_disco/doc/index.rst +++ b/boards/st/stm32f4_disco/doc/index.rst @@ -155,6 +155,8 @@ enable console output you should use a serial cable and connect it to UART2 pins Programming and Debugging ************************* +STM32F4DISCOVERY Discovery kit includes an ST-LINK/V2 embedded debug tool interface. + Applications for the ``stm32f4_disco`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -162,8 +164,16 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -STM32F4DISCOVERY Discovery kit includes an ST-LINK/V2 embedded debug tool interface. -This interface is supported by the openocd version included in Zephyr SDK. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flashing an application to STM32F4DISCOVERY ------------------------------------------- @@ -211,3 +221,6 @@ You can debug an application in the usual way. Here is an example for the .. _SK Pang CAN breakout board: https://www.skpang.co.uk/products/can-bus-can-fd-breakout-board-5v-supply-and-3-3v-logic + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/stm32f723e_disco/doc/index.rst b/boards/st/stm32f723e_disco/doc/index.rst index 554c329db81..df201519219 100644 --- a/boards/st/stm32f723e_disco/doc/index.rst +++ b/boards/st/stm32f723e_disco/doc/index.rst @@ -132,6 +132,8 @@ settings are 115200 8N1. Programming and Debugging ************************* +STM32F723E Discovery kit includes an ST-LINK/V2 embedded debug tool interface. + Applications for the ``stm32f723e_disco`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -139,8 +141,16 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -STM32F723E Discovery kit includes an ST-LINK/V2 embedded debug tool interface. -This interface is supported by the openocd version included in the Zephyr SDK. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flashing an application to STM32F723E-DISCO ------------------------------------------- @@ -190,3 +200,6 @@ You can debug an application in the usual way. Here is an example for the .. _STM32F72xxx reference manual: https://www.st.com/resource/en/reference_manual/dm00305990.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/stm32f746g_disco/doc/index.rst b/boards/st/stm32f746g_disco/doc/index.rst index 03e71c20b90..7900c49436a 100644 --- a/boards/st/stm32f746g_disco/doc/index.rst +++ b/boards/st/stm32f746g_disco/doc/index.rst @@ -183,6 +183,8 @@ settings are 115200 8N1. Programming and Debugging ************************* +STM32F746G Discovery kit includes an ST-LINK/V2 embedded debug tool interface. + Applications for the ``stm32f746g_disco`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -190,8 +192,16 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -STM32F746G Discovery kit includes an ST-LINK/V2 embedded debug tool interface. -This interface is supported by the openocd version included in the Zephyr SDK. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flashing an application to STM32F746G ------------------------------------------- @@ -241,3 +251,6 @@ You can debug an application in the usual way. Here is an example for the .. _STM32F74xxx reference manual: https://www.st.com/resource/en/reference_manual/dm00124865.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/stm32f7508_dk/doc/index.rst b/boards/st/stm32f7508_dk/doc/index.rst index 0b3737a8761..0ebde3c4fdc 100644 --- a/boards/st/stm32f7508_dk/doc/index.rst +++ b/boards/st/stm32f7508_dk/doc/index.rst @@ -178,6 +178,8 @@ settings are 115200 8N1. Programming and Debugging ************************* +STM32F7508-DK Discovery kit includes an ST-LINK/V2 embedded debug tool interface. + Applications for the ``stm32f7508_dk`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -185,8 +187,16 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -STM32F7508-DK Discovery kit includes an ST-LINK/V2 embedded debug tool interface. -This interface is supported by the openocd version included in the Zephyr SDK. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flashing an application to STM32F7508-DK ------------------------------------------- @@ -236,3 +246,6 @@ You can debug an application in the usual way. Here is an example for the .. _STM32F74xxx reference manual: https://www.st.com/resource/en/reference_manual/dm00124865.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/stm32f769i_disco/doc/index.rst b/boards/st/stm32f769i_disco/doc/index.rst index 223c48a9dbe..60edc99273f 100644 --- a/boards/st/stm32f769i_disco/doc/index.rst +++ b/boards/st/stm32f769i_disco/doc/index.rst @@ -165,6 +165,8 @@ settings are 115200 8N1. Programming and Debugging ************************* +STM32F769I Discovery kit includes an ST-LINK/V2 embedded debug tool interface. + Applications for the ``stm32f769i_disco`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -172,8 +174,16 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -STM32F769I Discovery kit includes an ST-LINK/V2 embedded debug tool interface. -This interface is supported by the openocd version included in the Zephyr SDK. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flashing an application to STM32F769I ------------------------------------------- @@ -223,3 +233,6 @@ You can debug an application in the usual way. Here is an example for the .. _STM32F76xxx reference manual: https://www.st.com/resource/en/reference_manual/dm00224583.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/stm32g0316_disco/doc/index.rst b/boards/st/stm32g0316_disco/doc/index.rst index 516a1f9623e..40161376333 100644 --- a/boards/st/stm32g0316_disco/doc/index.rst +++ b/boards/st/stm32g0316_disco/doc/index.rst @@ -81,15 +81,24 @@ Default Zephyr Peripheral Mapping: Programming and Debugging ************************* +The STM32G0316-DISCO board includes an ST-LINK/V2-1 embedded debug tool interface. + Applications for the ``stm32g0316_disco`` board configuration can be built the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). Flashing ======== -The STM32G0316-DISCO board includes an ST-LINK/V2-1 embedded debug tool -interface. -This interface is supported by the openocd version included in the Zephyr SDK. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flashing an application to the STM32G0316-DISCO ----------------------------------------------- @@ -126,3 +135,6 @@ You can debug an application in the usual way. Here is an example for the .. _STM32G0316-DISCO website: https://www.st.com/en/evaluation-tools/stm32g0316-disco.html + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/stm32g071b_disco/doc/index.rst b/boards/st/stm32g071b_disco/doc/index.rst index eba207f2d2b..9b1b3c23041 100644 --- a/boards/st/stm32g071b_disco/doc/index.rst +++ b/boards/st/stm32g071b_disco/doc/index.rst @@ -115,6 +115,8 @@ For more details please refer to `STM32G0 Discovery board User Manual`_. Programming and Debugging ************************* +The STM32G071B Discovery board includes an ST-LINK/V2-1 embedded debug tool interface. + Applications for the ``stm32g071b_disco`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -122,7 +124,8 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -The STM32G071B Discovery board includes an ST-LINK/V2-1 embedded debug tool interface. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. .. code-block:: console @@ -168,3 +171,6 @@ References .. _G071RB on www.st.com: https://www.st.com/en/microcontrollers/stm32g071rb.html + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/stm32g081b_eval/doc/index.rst b/boards/st/stm32g081b_eval/doc/index.rst index c3e0e4c6b5b..1bae82739c6 100644 --- a/boards/st/stm32g081b_eval/doc/index.rst +++ b/boards/st/stm32g081b_eval/doc/index.rst @@ -153,6 +153,8 @@ For more details please refer to `STM32G0 Evaluation board User Manual`_. Programming and Debugging ************************* +The STM32G081B Evaluation board includes an ST-LINK/V2-1 embedded debug tool interface. + Applications for the ``stm32g081b_eval`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -160,7 +162,8 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -The STM32G081B Evaluation board includes an ST-LINK/V2-1 embedded debug tool interface. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. .. code-block:: console @@ -206,3 +209,6 @@ References .. _G081RB on www.st.com: https://www.st.com/en/microcontrollers/stm32g081rb.html + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/stm32h573i_dk/doc/index.rst b/boards/st/stm32h573i_dk/doc/index.rst index adde4178232..5fad2280266 100644 --- a/boards/st/stm32h573i_dk/doc/index.rst +++ b/boards/st/stm32h573i_dk/doc/index.rst @@ -245,6 +245,8 @@ assigned to USART1. Default settings are 115200 8N1. Programming and Debugging ************************* +STM32H573I-DK Discovery board includes an ST-LINK/V3E embedded debug tool interface. + Applications for the ``stm32h573i_dk`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -252,7 +254,7 @@ flashed in the usual way (see :ref:`build_an_application` and OpenOCD Support =============== -For now, openocd support for stm32h5 is not available on upstream OpenOCD. +For now, OpenOCD support for STM32H5 is not available on upstream OpenOCD. You can check `OpenOCD official Github mirror`_. In order to use it though, you should clone from the cutomized `STMicroelectronics OpenOCD Github`_ and compile it following usual README guidelines. @@ -271,27 +273,26 @@ including the common openocd.board.cmake file: Flashing ======== -STM32H573I-DK Discovery board includes an ST-LINK/V3E embedded debug tool -interface. Support is available on STM32CubeProgrammer V2.13.0. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. -Alternatively, pyocd or jlink via an external probe can also be used to flash -and debug the board if west is told to use it as runner, which can be done by -passing either or ``-r pyocd``, or ``-r jlink``. +Alternatively, OpenOCD or pyOCD can also be used to flash the board using +the ``--runner`` (or ``-r``) option: -For pyocd additional target information needs to be installed. -This can be done by executing the following commands. +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner pyocd + +For pyOCD, additional target information needs to be installed +by executing the following commands: .. code-block:: console $ pyocd pack --update $ pyocd pack --install stm32h5 - -Alternatively, the openocd interface will be supported by a next openocd version. -When available, OpenOCD could be used in the same way as other tools. - - Flashing an application to STM32H573I-DK Discovery -------------------------------------------------- @@ -321,8 +322,8 @@ You should see the following message on the console: Debugging ========= -Waiting for openocd support, debugging could be performed with pyocd which -requires to enable "pack" support with the following pyocd command: +Waiting for OpenOCD support, debugging could be performed with pyOCD which +requires to enable "pack" support with the following pyOCD command: .. code-block:: console diff --git a/boards/st/stm32h735g_disco/doc/index.rst b/boards/st/stm32h735g_disco/doc/index.rst index 2afd4dfca4f..ae14832ea21 100644 --- a/boards/st/stm32h735g_disco/doc/index.rst +++ b/boards/st/stm32h735g_disco/doc/index.rst @@ -114,17 +114,27 @@ COM port interface. Default communication settings are 115200 8N1. Programming and Debugging ************************* +STM32H735G-DISCO board includes an ST-LINK/V3 embedded debug tool interface. + See :ref:`build_an_application` for more information about application builds. Flashing ======== -Flashing operation will depend on the target to be flashed and the SoC -option bytes configuration. -It is advised to use `STM32CubeProgrammer`_ to check and update option bytes -configuration and flash the ``stm32h735g_disco`` target. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink + +It is advised to use `STM32CubeProgrammer`_ to check and update option bytes +configuration. Debugging ========= diff --git a/boards/st/stm32h745i_disco/doc/index.rst b/boards/st/stm32h745i_disco/doc/index.rst index 4a17b24f16f..2c5fc70dd34 100644 --- a/boards/st/stm32h745i_disco/doc/index.rst +++ b/boards/st/stm32h745i_disco/doc/index.rst @@ -150,6 +150,8 @@ two cores. This is done in 3 ways: Programming and Debugging ************************* +STM32H745I-DISCO board includes an ST-LINK/V3 embedded debug tool interface. + Applications for the ``stm32h745i_disco`` board should be built per core target, using either ``stm32h745i_disco/stm32h745xx/m7`` or ``stm32h745i_disco/stm32h745xx/m4`` as the target (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -161,10 +163,22 @@ using either ``stm32h745i_disco/stm32h745xx/m7`` or ``stm32h745i_disco/stm32h745 Flashing ======== -STM32H745I-DISCO board includes an ST-LINK/V3 embedded debug tool interface. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. +The target core is detected automatically. -Flashing operation will depend on the target and the SoC -option bytes configuration. +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink + +Flashing an application to STM32H745I-DISCO +------------------------------------------- + +Flashing operation will depend on the target and the SoC option bytes configuration. By default: @@ -176,13 +190,6 @@ board is powered (Option bytes BCM7 and BCM4 are checked). In that configuration, Kconfig boot option ``STM32H7_BOOT_CM4_CM7`` should be selected. Zephyr flash configuration has been set to meet these default settings. -Alternatively, west `STM32CubeProgrammer`_ runner can be used, after installing -it, to flash applications for both cores. The target core is detected automatically. - -.. code-block:: console - - $ west flash --runner stm32cubeprogrammer - Flashing an application to STM32H745XI M7 Core ---------------------------------------------- First, connect the STM32H745I-DISCO to your host computer using diff --git a/boards/st/stm32h747i_disco/doc/index.rst b/boards/st/stm32h747i_disco/doc/index.rst index a9635dd2e40..3af51370885 100644 --- a/boards/st/stm32h747i_disco/doc/index.rst +++ b/boards/st/stm32h747i_disco/doc/index.rst @@ -199,15 +199,21 @@ two cores. This is done in 3 ways: Programming and Debugging ************************* +STM32H747I-DISCO board includes an ST-LINK/V3 embedded debug tool interface. + Applications for the ``stm32h747i_disco`` board should be built per core target, -using either ``stm32h747i_disco/stm32h747xx/m7`` or ```stm32h747i_disco/stm32h747xx/m4`` as the target. +using either ``stm32h747i_disco/stm32h747xx/m7`` or ``stm32h747i_disco/stm32h747xx/m4`` +as the target. See :ref:`build_an_application` for more information about application builds. .. note:: - If using OpenOCD you will need a recent development version as the last - official release does not support H7 dualcore yet. - Also, with OpenOCD, sometimes, flashing is not working. It is necessary to + Check if the board's ST-LINK V3 has the newest FW version. It can be updated + using `STM32CubeProgrammer`_. + +.. note:: + + With OpenOCD, sometimes, flashing does not work. It is necessary to erase the flash (with STM32CubeProgrammer for example) to make it work again. Debugging with OpenOCD is currently working for this board only with Cortex M7, not Cortex M4. @@ -218,9 +224,21 @@ Flashing Flashing operation will depend on the target to be flashed and the SoC option bytes configuration. + +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner +for both cores, so its :ref:`installation ` is required. +The target core is detected automatically. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink + It is advised to use `STM32CubeProgrammer`_ to check and update option bytes -configuration and flash ``stm32h747i_disco/stm32h747xx/m7`` and -``stm32h747i_disco/stm32h747xx/m7`` targets. +configuration. By default: @@ -236,13 +254,6 @@ automatically. Zephyr flash configuration has been set to meet these default settings. -Alternatively, west `STM32CubeProgrammer`_ runner can be used, after installing -it, to flash applications for both cores. The target core is detected automatically. - -.. code-block:: console - - $ west flash --runner stm32cubeprogrammer - Flashing an application to STM32H747I M7 Core --------------------------------------------- @@ -285,17 +296,16 @@ Here is an example for the :zephyr:code-sample:`blinky` application on M4 core. Debugging ========= -You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +You can debug an application on Cortex M7 side in the usual way. Here is an example +for the :ref:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world :board: stm32h747i_disco/stm32h747xx/m7 :goals: debug -Debugging with west is currently not available on Cortex M4 side. -In order to debug a Zephyr application on Cortex M4 side, you can use -`STM32CubeIDE`_. +Debugging a Zephyr application on Cortex M4 side with west is currently not available. +As a workaround, you can use `STM32CubeIDE`_. .. _STM32H747I-DISCO website: https://www.st.com/en/evaluation-tools/stm32h747i-disco.html diff --git a/boards/st/stm32h7b3i_dk/doc/index.rst b/boards/st/stm32h7b3i_dk/doc/index.rst index dd1c6317e78..ff6f833fa8c 100644 --- a/boards/st/stm32h7b3i_dk/doc/index.rst +++ b/boards/st/stm32h7b3i_dk/doc/index.rst @@ -196,6 +196,8 @@ default communication settings are 115200 8N1. Programming and Debugging ************************* +STM32H7B3I Discovery kit includes an STLINK-V3E embedded debug tool interface. + Applications for the ``stm32h7b3i_dk`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -203,8 +205,16 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -STM32H7B3I Discovery kit includes an STLINK-V3E embedded debug tool interface. -This interface is supported by the openocd version included in the Zephyr SDK. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flashing may depend on the SoC option bytes configuration, which can be checked and updated using `STM32CubeProgrammer`_. diff --git a/boards/st/stm32h7s78_dk/doc/index.rst b/boards/st/stm32h7s78_dk/doc/index.rst index 8951ba16fdc..62c059cf0ec 100644 --- a/boards/st/stm32h7s78_dk/doc/index.rst +++ b/boards/st/stm32h7s78_dk/doc/index.rst @@ -240,6 +240,8 @@ assigned to USART4. Default settings are 115200 8N1. Programming and Debugging ************************* +STM32H7S78-DK Discovery board includes an ST-LINK/V3E embedded debug tool interface. + Applications for the ``stm32h7s78_dk`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -247,10 +249,8 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -STM32H7S78-DK Discovery board includes an ST-LINK/V3E embedded debug tool -interface. Support is available on STM32CubeProgrammer V2.13.0. - -Alternatively, this interface will be supported by a next openocd version. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. Flashing an application to STM32H7S78-DK Discovery -------------------------------------------------- diff --git a/boards/st/stm32l1_disco/doc/index.rst b/boards/st/stm32l1_disco/doc/index.rst index 30911141f93..20d6067b966 100644 --- a/boards/st/stm32l1_disco/doc/index.rst +++ b/boards/st/stm32l1_disco/doc/index.rst @@ -138,6 +138,8 @@ For more details please refer to `STM32L1DISCOVERY board User Manual`_. Programming and Debugging ************************* +STM32L1DISCOVERY and STM32L152CDISCOVERY boards include an ST-LINK/V2 embedded debug tool interface. + Applications for the ``stm32l1_disco`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -145,9 +147,16 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -STM32L1DISCOVERY and STM32L152CDISCOVERY boards include an ST-LINK/V2 embedded -debug tool interface. This interface is supported by the openocd version -included in the Zephyr SDK. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flashing an application ----------------------- @@ -189,3 +198,6 @@ References .. _STM32L152CDISCOVERY board User Manual: https://www.st.com/resource/en/user_manual/um1079-discovery-kit-with-stm32l152rc-mcu-stmicroelectronics.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/stm32l476g_disco/doc/index.rst b/boards/st/stm32l476g_disco/doc/index.rst index ef40802a709..91695acae20 100644 --- a/boards/st/stm32l476g_disco/doc/index.rst +++ b/boards/st/stm32l476g_disco/doc/index.rst @@ -162,11 +162,21 @@ Default settings are 115200 8N1. Programming and Debugging ************************* +STM32L476G Discovery board includes an ST-LINK/V2-1 embedded debug tool interface. + Flashing ======== -STM32L476G Discovery board includes an ST-LINK/V2-1 embedded debug tool interface. -This interface is supported by the openocd version included in Zephyr SDK. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flashing an application to STM32L476G Discovery ----------------------------------------------- @@ -216,3 +226,6 @@ You can debug an application in the usual way. Here is an example for the .. _STM32L476 reference manual: https://www.st.com/resource/en/reference_manual/DM00083560.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/stm32l496g_disco/doc/index.rst b/boards/st/stm32l496g_disco/doc/index.rst index 576c07bc2cc..22e575e4b11 100644 --- a/boards/st/stm32l496g_disco/doc/index.rst +++ b/boards/st/stm32l496g_disco/doc/index.rst @@ -198,12 +198,21 @@ Default settings are 115200 8N1. Programming and Debugging ************************* +STM32L496G Discovery board includes an ST-LINK/V2-1 embedded debug tool interface. + Flashing ======== -STM32L496G Discovery board includes an ST-LINK/V2-1 embedded debug -tool interface. This interface is supported by openocd version -v0.10.0, which has been available since Zephyr SDK v0.9.2. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Applications for the ``stm32l496g_disco`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` @@ -257,3 +266,6 @@ You can debug an application in the usual way. Here is an example for the .. _STM32L496 reference manual: https://www.st.com/resource/en/reference_manual/DM00083560.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/stm32l4r9i_disco/doc/index.rst b/boards/st/stm32l4r9i_disco/doc/index.rst index e2053313122..5d71a40633a 100644 --- a/boards/st/stm32l4r9i_disco/doc/index.rst +++ b/boards/st/stm32l4r9i_disco/doc/index.rst @@ -91,15 +91,25 @@ ST-LINK Virtual COM port interface. Default communication settings are 115200 8N Programming and Debugging ************************* -Flashing -======== - The STM32L4R9I Discovery board includes an ST-LINK/V2-1 debug tool. Applications for the ``stm32l4r9i_disco`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). +Flashing +======== + +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD or JLink can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner jlink Flashing an application to STM32L4R9I Discovery ----------------------------------------------- @@ -148,3 +158,6 @@ You can debug an application in the usual way. Here is an example for the .. _STM32L4R5xx/R7xx/R9xx datasheet: https://www.st.com/resource/en/datasheet/stm32l4r5vi.pdf + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/stm32l562e_dk/doc/index.rst b/boards/st/stm32l562e_dk/doc/index.rst index 370526ac14b..5982ec34f8f 100644 --- a/boards/st/stm32l562e_dk/doc/index.rst +++ b/boards/st/stm32l562e_dk/doc/index.rst @@ -284,6 +284,8 @@ assigned to USART1. Default settings are 115200 8N1. Programming and Debugging ************************* +STM32L562E-DK Discovery board includes an ST-LINK/V3E embedded debug tool interface. + Applications for the ``stm32l562e_dk`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). @@ -291,18 +293,24 @@ flashed in the usual way (see :ref:`build_an_application` and Flashing ======== -STM32L562E-DK Discovery board includes an ST-LINK/V3E embedded debug tool -interface. Support can be enabled on pyocd by adding "pack" support with the -following pyocd command: +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, OpenOCD can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + +Support can also be enabled for pyOCD by adding "pack" support with the +following pyOCD commands: .. code-block:: console $ pyocd pack --update $ pyocd pack --install stm32l562qe -Alternatively, this interface is supported by the openocd version -included in the Zephyr SDK since v0.13.1. - Flashing an application to STM32L562E-DK Discovery -------------------------------------------------- diff --git a/boards/st/stm32u083c_dk/doc/index.rst b/boards/st/stm32u083c_dk/doc/index.rst index 2b0c56742c2..cbc8d7d13ab 100644 --- a/boards/st/stm32u083c_dk/doc/index.rst +++ b/boards/st/stm32u083c_dk/doc/index.rst @@ -214,14 +214,18 @@ This probe allows to flash the board using various tools. Flashing ======== -Board is configured to be flashed using west STM32CubeProgrammer runner. -Installation of `STM32CubeProgrammer`_ is then required to flash the board. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. -Alternatively, pyocd or jlink via an external probe can also be used to flash -and debug the board if west is told to use it as runner, which can be done by -passing either or ``-r pyocd``, or ``-r jlink``. +Alternatively, JLink or pyOCD can also be used to flash the board using +the ``--runner`` (or ``-r``) option: -For pyocd additional target information needs to be installed. +.. code-block:: console + + $ west flash --runner pyocd + $ west flash --runner jlink + +For pyOCD, additional target information needs to be installed. This can be done by executing the following commands. .. code-block:: console diff --git a/boards/st/stm32wb5mm_dk/doc/stm32wb5mm_dk.rst b/boards/st/stm32wb5mm_dk/doc/stm32wb5mm_dk.rst index 84322f1bc71..254bd38fe6e 100644 --- a/boards/st/stm32wb5mm_dk/doc/stm32wb5mm_dk.rst +++ b/boards/st/stm32wb5mm_dk/doc/stm32wb5mm_dk.rst @@ -189,15 +189,24 @@ and the second to PC13. They have the aliases sw0 and sw1 respectively. Programming and Debugging ************************* +STM32WB5MM-DK has an on-board ST-Link to flash and debug the firmware on the module. + Applications for the ``stm32wb5mm_dk`` board configuration can be built the usual way (see :ref:`build_an_application`). Flashing ======== -STM32WB5MM-DK has an on-board ST-Link to flash and debug the firmware on the -module. +The board is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. +Alternatively, OpenOCD or pyOCD can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd + $ west flash --runner pyocd Flashing ``hello_world`` application to STM32WB5MM-DK ------------------------------------------------------ @@ -239,9 +248,15 @@ You can debug an application in the usual way. Here is an example for the .. _STM32WB5MM-DK on www.st.com: https://www.st.com/en/evaluation-tools/stm32wb5mm-dk.html + .. _STM32WB5MMG datasheet: https://www.st.com/resource/en/datasheet/stm32wb5mmg.pdf + .. _modules/hal/stm32/lib/stm32wb/hci/README: https://github.com/zephyrproject-rtos/hal_stm32/blob/main/lib/stm32wb/hci/README + .. _Hello_World: https://docs.zephyrproject.org/latest/samples/hello_world/README.html + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html diff --git a/boards/st/stm32wb5mmg/doc/stm32wb5mmg.rst b/boards/st/stm32wb5mmg/doc/stm32wb5mmg.rst index b9724248b79..4781fa0f7bc 100644 --- a/boards/st/stm32wb5mmg/doc/stm32wb5mmg.rst +++ b/boards/st/stm32wb5mmg/doc/stm32wb5mmg.rst @@ -238,6 +238,15 @@ The onboard ST-Link on the ``b_u585i_iot02a`` board can be used to flash the STM32WB5MMG module. To do this you should put SW4 on OFF and SW5 on ON mode. In this case the firmware will be uploaded on the STM32WB5MMG module. +The module is configured to be flashed using west `STM32CubeProgrammer`_ runner, +so its :ref:`installation ` is required. + +Alternatively, openocd can also be used to flash the board using +the ``--runner`` (or ``-r``) option: + +.. code-block:: console + + $ west flash --runner openocd Flashing `hci_uart` application to STM32WB5MMG ---------------------------------------------- @@ -300,5 +309,9 @@ You can debug an application in the usual way. Here is an example for the .. _STM32WB5MMG datasheet: https://www.st.com/resource/en/datasheet/stm32wb5mmg.pdf + .. _modules/hal/stm32/lib/stm32wb/hci/README: https://github.com/zephyrproject-rtos/hal_stm32/blob/main/lib/stm32wb/hci/README + +.. _STM32CubeProgrammer: + https://www.st.com/en/development-tools/stm32cubeprog.html