{"id":8916,"date":"2025-01-27T20:16:57","date_gmt":"2025-01-28T04:16:57","guid":{"rendered":"https:\/\/visualgdb.com\/w\/?p=8916"},"modified":"2025-01-27T20:24:31","modified_gmt":"2025-01-28T04:24:31","slug":"debugging-bootloaders-on-the-stm32h7r-s-devices","status":"publish","type":"post","link":"https:\/\/visualgdb.com\/tutorials\/arm\/stm32\/stm32h7rs\/bootloader\/","title":{"rendered":"Debugging Bootloaders on the STM32H7R\/S devices"},"content":{"rendered":"

This tutorial shows how to create and debug a basic bootloader project on the NUCLEO-H7S3L8 board. We will show how to change the option bytes to resolve memory mapping problems, get debugging working, and will give a quick overview of the STM32H7R\/S project structure.<\/p>\n

The STM32H7R\/S devices come with a relatively small built-in FLASH memory and are designed to run most of the code from an external memory. The NUCLEO-H7S3L8 board contains a STM32H7S3 chip with 64KB of FLASH memory, that will contain the bootloader, and a much bigger 256MB OctoSPI FLASH module that will store the main program.<\/p>\n

Before you begin, install VisualGDB 6.0 or later and update the OpenOCD (ST fork) package to the latest version.<\/p>\n

    \n
  1. Start Visual Studio and locate the VisualGDB Embedded Project Wizard:\"\"<\/a><\/li>\n
  2. Enter the name and location for your project:\"\"<\/a><\/li>\n
  3. Proceed with creating a CMake-based application. MSBuild will also work just fine, however CMake allows joining the bootloader and the main application into the same logical project, sharing the common building and debugging settings between them:\"\"<\/a><\/li>\n
  4. Select your toolchain and the target device. In this tutorial we are targeting the STM32H7S3L8 device:\"\"<\/a><\/li>\n
  5. The regular “Blinking LED” sample does not demonstrate how to configure the FLASH memory, however most STM32CubeMX examples do include a bootloader for the corresponding board. In this tutorial we select the USB_Device\\CDC_Standalone\\Boot<\/strong> project, however any other bootloader for the same board should work as well: \"\"<\/a><\/li>\n
  6. On the Debug Method page select OpenOCD (ST Fork) <\/strong>and make sure that you are using the latest OpenOCD package (2025-01-22<\/strong> or later):\"\"<\/a>Warning<\/strong><\/span>: The previously released OpenOCD (STM32H7R\/S) package <\/strong>is no longer required and has been discontinued since ST merged the STM32H7R\/S support into their main OpenOCD repository. If you have it installed, please uninstall it via VisualGDB Package Manager <\/strong>and use OpenOCD (ST Fork)<\/strong> instead.<\/li>\n
  7. Click the “Test” button to verify that the connection to your device works:\"\"<\/a><\/li>\n
  8. Locate the call to BOOT_Application()<\/strong> from main()<\/strong>, press F12 to go into BOOT_Application, and set a breakpoint there after the MapMemory()<\/strong> call. If this is the first time you are using the board, it will fail with BOOT_ERROR_MAPPEDMODEFAIL<\/strong>: \"\"<\/a>This happens because the bootloader example relies on the high-speed mode of the external memory interface, that requires the XSPI2_HSLV<\/strong> option bit (see this thread<\/a>). You can change it via STM32CubeProgrammer, or by adding extra code to the bootloader (see below).<\/li>\n
  9. If you would like to use STM32CubeProgrammer, launch it and click “Connect” to connect to the device:\"\"<\/a><\/li>\n
  10. Then click the “Option Bytes” button (OB), expand User Configuration 1<\/strong> and set XSPI2_HSLV:<\/strong>
    \n    \"\"<\/a><\/li>\n
  11. You can also do by adding the following code to main()<\/strong> after HAL_Init()<\/strong>:\n
    FLASH_OBProgramInitTypeDef ob = { 0, };\r\nHAL_FLASHEx_OBGetConfig(&ob);\r\nif (!(ob.USERConfig1 & FLASH_OBW1SR_XSPI2_HSLV_Msk))\r\n{\r\n    HAL_FLASH_Unlock();\r\n    HAL_FLASH_OB_Unlock();\r\n    ob.OptionType = OPTIONBYTE_USER;\r\n    ob.USERType = OB_USER_XSPI2_HSLV;\r\n    ob.USERConfig1 |= FLASH_OBW1SR_XSPI2_HSLV_Msk;\r\n    if (HAL_FLASHEx_OBProgram(&ob) != HAL_OK)\r\n        asm(\"bkpt 255\");\r\n    HAL_NVIC_SystemReset();\r\n}<\/pre>\n
    WARNING:<\/strong><\/span> We advise removing the option byte programming code from main()<\/strong> after it has finished its work. Accidentally changing other option bytes could make the device unusable, or lead to other hard-to-troubleshoot errors.<\/li>\n
  12. Now that you have changed the option byte, you can run the bootloader again, and the MapMemory()<\/strong> call will succeed.
    \n    \"\"<\/a><\/li>\n
  13. Running beyond MapMemory() <\/strong>would require programming the main application into the external memory, that will be shown in a separate tutorial<\/a>. Before we do that, however, we will give an overview of the STM32H7R\/S memory manager. Locate the stm32_extmem.c<\/strong> file in Solution Explorer. Note how it’s a part of the ST’s SDK and is reused between multiple projects:\"\"<\/a><\/li>\n
  14. Note how it has conditional checks for EXTMEM_DRIVER_xxx<\/strong> macros. Click on the first one and press F12 to go to definition. This opens the stm32_extmem_conf.h<\/strong> file that is defined in each project separately: \"\"<\/a>If you would like to enable other memory types, you would need to change the definitions, and adjust the related code to match your board (using Find All References on either macro should give a quick overview of the related code).<\/li>\n
  15. You can also use the memory manager API to read\/write external memory (e.g. to create an OpenOCD FLASH plugin so that you won’t need to have STM32CubeProgrammer installed):\"\"<\/a><\/li>\n<\/ol>\n
    Now that you got the bootloader working, follow this tutorial<\/a> to create and debug a basic application in the external memory.<\/p>\n","protected":false},"excerpt":{"rendered":"
    This tutorial shows how to create and debug a basic bootloader project on the NUCLEO-H7S3L8 board. We will show how<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[89],"tags":[],"_links":{"self":[{"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/posts\/8916"}],"collection":[{"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/comments?post=8916"}],"version-history":[{"count":4,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/posts\/8916\/revisions"}],"predecessor-version":[{"id":8954,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/posts\/8916\/revisions\/8954"}],"wp:attachment":[{"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/media?parent=8916"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/categories?post=8916"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/tags?post=8916"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}