boards/st/nucleo_h563zi/doc/index.rst
.. zephyr:board:: nucleo_h563zi
Overview
The Nucleo H563ZI board is designed as an affordable development platform for STMicroelectronics ARM® Cortex®-M33 core-based STM32H563ZIT6 microcontroller with TrustZone®. Here are some highlights of the Nucleo H563ZI board:
STM32H563ZI microcontroller featuring 2 Mbytes of Flash memory and 640Kbyte of SRAM in LQFP144 package
Board connectors:
Flexible board power supply:
On-board ST-LINK/V3EC debugger/programmer
Three users LEDs
Two push-buttons: USER and RESET
32.789 kHz crystal oscillator
More information about the board can be found at the NUCLEO_H563ZI website_.
Hardware
The STM32H563xx devices are high-performance microcontrollers from the STM32H5 Series based on the high-performance Arm® Cortex®-M33 32-bit RISC core. They operate at a frequency of up to 250 MHz.
Core: ARM® 32-bit Cortex®-M33 CPU with TrustZone® and FPU.
Performance benchmark:
Security
Clock management:
Power management
RTC with HW calendar, alarms and calibration
Up to 139 fast I/Os, most 5 V-tolerant, up to 10 I/Os with independent supply down to 1.08 V
Up to 16 timers and 2 watchdogs
Memories
Rich analog peripherals (independent supply)
34x communication interfaces
CORDIC for trigonometric functions acceleration
FMAC (filter mathematical accelerator)
CRC calculation unit
Development support: serial wire debug (SWD), JTAG, Embedded Trace Macrocell™
More information about STM32H563ZI can be found here:
STM32H563ZI on www.st.com_STM32H563 reference manual_.. zephyr:board-supported-hw::
Nucleo H563ZI Board has 9 GPIO controllers. These controllers are responsible for pin muxing, input/output, pull-up, etc.
For more details please refer to STM32H5 Nucleo-144 board User Manual_.
Nucleo H563ZI System Clock could be driven by internal or external oscillator, as well as main PLL clock. By default System clock is driven by PLL clock at 240MHz, driven by 8MHz external clock provided from the STLINK-V3EC.
Nucleo H563ZI board has up to 12 U(S)ARTs. The Zephyr console output is assigned to USART3. Default settings are 115200 8N1.
In order to test backup SRAM, you may want to disconnect VBAT from VDD_MCU.
You can do it by removing SB55 jumper on the back side of the board.
VBAT can be provided via the left ST Morpho connector's pin 33.
Programming and Debugging
.. zephyr:board-supported-runners::
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).
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 customized
STMicroelectronics OpenOCD Github and compile it following usual README guidelines.
Once it is done, you can set the OPENOCD and OPENOCD_DEFAULT_PATH variables in
:zephyr_file:boards/st/nucleo_h563zi/board.cmake to point the build
to the paths of the OpenOCD binary and its scripts, before
including the common openocd.board.cmake file:
.. code-block:: none
set(OPENOCD "<path_to_openocd_repo>/src/openocd" CACHE FILEPATH "" FORCE)
set(OPENOCD_DEFAULT_PATH <path_to_opneocd_repo>/tcl)
include(${ZEPHYR_BASE}/boards/common/openocd.board.cmake)
The board is configured to be flashed using west STM32CubeProgrammer_ runner,
so its :ref:installation <stm32cubeprog-flash-host-tools> 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 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
$ pyocd pack --update $ pyocd pack --install stm32h5
Connect the Nucleo H563ZI to your host computer using the USB port.
Then build and flash an application. Here is an example for the
:zephyr:code-sample:hello_world application.
Run a serial host program to connect with your Nucleo board:
.. code-block:: console
$ minicom -D /dev/ttyACM0
Then build and flash the application.
.. zephyr-app-commands:: :zephyr-app: samples/hello_world :board: nucleo_h563zi :goals: build flash
You should see the following message on the console:
.. code-block:: console
Hello World! nucleo_h563zi
You can debug an application in the usual way. Here is an example for the
:zephyr:code-sample:blinky application.
.. zephyr-app-commands:: :zephyr-app: samples/basic/blinky :board: nucleo_h563zi :goals: debug
.. _NUCLEO_H563ZI website: https://www.st.com/en/evaluation-tools/nucleo-h563zi
.. _STM32H5 Nucleo-144 board User Manual: https://www.st.com/resource/en/user_manual/um3115-stm32h5-nucleo144-board-mb1404-stmicroelectronics.pdf
.. _STM32H563ZI on www.st.com: https://www.st.com/en/microcontrollers/stm32h563zi.html
.. _STM32H563 reference manual: https://www.st.com/resource/en/reference_manual/rm0481-stm32h563h573-and-stm32h562-armbased-32bit-mcus-stmicroelectronics.pdf
.. _STM32CubeProgrammer: https://www.st.com/en/development-tools/stm32cubeprog.html
.. _OpenOCD official Github mirror: https://github.com/openocd-org/openocd/
.. _STMicroelectronics OpenOCD Github: https://github.com/STMicroelectronics/OpenOCD/tree/openocd-cubeide-r6