In this exercise, we will learn how to do DFU over UART . We will first enable Serial Recovery and then add DFU in the application. Both these can be active at the same time. After all, the bootloader does not know anything about the application.
UART0 on our development kits are routed to the debugger chip and exposed to the connected PC as a VCOM port. Therefore, we do not have to connect anything extra to the DK to test DFU over UART.
Exercise prerequisites
To send the firmware updates over UART, we will use the command line tool mcumgr-cli. You can install this using:
Copy
go install github.com/apache/mynewt-mcumgr-cli/mcumgr@latest
You might have to install Go to install mcumgr-cli. See https://go.dev/doc/install for how to install Go.
Note
You will need to add mcumgr to path . For Linux , export PATH="$PATH:$HOME/go/bin" For Windows, you can add it using the Edit System system environment variables
Now we can run mcumgr from the CLI:
Prepare the DK
The DK debugger (Interface MCU)has a virtual mass storage disk. This may interfere with UART DFU transfer since the Interface MCU is also used for UART<> USB conversion, so it is recommended to disable it using the J-link Commander(Windows), or JLinkExe(Linux) :
The Development Kit must then be power-cycled for the settings to take effect. Replace SEGGER_ID with the SEGGER ID of your DK. The SEGGER ID is for the on-board debugger on the DK. Each DK has its unique SEGGER ID. The SEGGER ID is displayed in the Connected Devices View in nRF Connect for VS Code, as shown in the screenshot below. It’s also printed on the kit label.
Note that this setting remains valid even if you program another firmware onto the device.
Exercise steps
For this exercise, The base code is simply a copy of the Blinky sample. The goal here is to show you how to add MCUboot to an existing nRF Connect SDK application.
Open the code base of the exercise by navigating to Create a new application in the nRF Connect for VS Code extension, select Copy a sample, and search for Lesson 8 – Exercise 1.
2.1 Create a child_image directory to configure child images.
2.2 Create a file to configure MCUboot in the child image folder and add the following comments inside mcuboot.conf
Copy
# STEP 2.3 - Enable logging for MCUboot# STEP 3.1 - Enable Serial Recovery over UART# STEP 3.2 - Disable UART, since Serial Recovery uses it# STEP 3.3 - Configure boolader to use only one slot. # STEP 5.1 - Go back to two slots, as we need two for DFU from the app# STEP 3.4 - Turn on a LED so we can see when Serial Recovery mode is active
Kconfig
The folder structure should now look like this:
2.3 Next, we will enable logging for MCUboot. For this, we both need to enable logs and set the log level:
Copy
CONFIG_LOG=yCONFIG_MCUBOOT_LOG_LEVEL_INF=y
Kconfig
After this, we can build and run the sample to see it run with MCUboot. Observe logs from nRF Serial Terminal:
We can also see the partitioning of the device, with the nRF Connect for VS Code Memory Report
Now, we have MCUboot running before the application. However, we can not yet update the application.
3. Add DFU over UART to MCUboot
Next, we will add DFU over UART to MCUboot, also known as Serial Recovery. MCUboot configuration options can be found here, and MCUboot Kconfig options specific for Serial Recovery are found here .
3.1 To enable Serial Recovery, we must set CONFIG_MCUBOOT_SERIAL and to enable transport over UART, we must set BOOT_SERIAL_UART. Since these are both for the MCUboot child image, we must set them in mcuboot.conf.
Copy
CONFIG_MCUBOOT_SERIAL=yCONFIG_BOOT_SERIAL_UART=y
Kconfig
3.2 Since we now use UART for Serial Recovery, we must disable UART from the console from MCUboot, so this does not try to use the UART at the same time.
Copy
CONFIG_UART_CONSOLE=n
Kconfig
3.3 By default, MCUboot splits the non-volatile memory into two slots. Since we use Serial Recovery, we can use only one slot instead to get more available non-volatile memory. We can do this by setting CONFIG_SINGLE_APPLICATION_SLOT.
Copy
CONFIG_SINGLE_APPLICATION_SLOT=y
Kconfig
3.4. To indicate that MCUboot is in Serial Recovery mode, it is nice to have an indicator LED. We can enable this by setting CONFIG_MCUBOOT_INDICATION_LED.
Copy
CONFIG_MCUBOOT_INDICATION_LED=y
Kconfig
3.5 we will set which button and LED will be used before testing. This is set using a Devicetree overlay. For this, we will create the file child_image/mcuboot.overlay. Now, the folder structure will then look like this:
Add the following comment to mcuboot.overlay:
Copy
/* Step 3.5 - Configure button and LED for Serial Recovery */
Note that the alias button1 represents the physical Button 2 on the DK. led1 alias represents the physical LED2 on the DK. Alieases and node identifiers in devicetree start from 0, while on the physical board, they start from 1.
4. Build and flash the application to your board.
Now we can test Serial Recovery. When you start the kit normally, you see LED1 blink as normal.
4.1 Now, hold button 2 while resetting the Development Kit. Instead of starting normally, the kit will now enter Serial Recovery mode. You can see this from LED2, which should be on.
4.2 While in serial recovery mode, we can use mcumgr-cli to communicate with the DK. First, we will add a configuration to mcumgr-cli:
Note that the port number will vary from machine to machine and DK to DK. Use the Connected Devices view in nRF Connect for VS Code to know the port of your DK.
testDK in the command above can be named whatever we want. A list of supported mcumgr-cli commands can be found here.
4.3 With this configuration, we can test listing current images on the DK:
If you see an error like Error: Access is denied. it means there is an application on your machine that is using that same port. Close all applications that use that port to eliminate this error message.
4.4 Before we try to upload a new firmware image to the DK, we should change something in the application, so we can verify that the new firmware image has been flashed. This can, for example be to change the delay in the blinky code. For example, change SLEEP_TIME_MS from 1000 to 100, then rebuild the code.
4.5 Now we can upload the new image firmware to the DK, using:
4.6 After the successful upload, reset the DK to see the new image in effect:
Copy
mcumgr -c testDK reset
DFU over UART from the application
5. Add DFU over UART to the application.
Next up, we will add DFU over UART to the application. This method uses the mcumgr library.
5.1 First, we must go back to dual slots, as DFU from the application must have two slots:
Copy
CONFIG_SINGLE_APPLICATION_SLOT=n
Kconfig
5.2 Then we add mcumgr configurations and dependencies to prj.conf. We can take inspiration from the SMP Server sample to find which configurations we need. For this exercise, we can use the following:
Copy
# Step 5.2 - Enable mcumgr DFU in application# Enable MCUMGR CONFIG_MCUMGR=y# Enable MCUMGR management for both OS and ImagesCONFIG_MCUMGR_GRP_OS=yCONFIG_MCUMGR_GRP_IMG=y# Configure MCUMGR transport to UARTCONFIG_MCUMGR_TRANSPORT_UART=y# Dependencies# Configure dependencies for CONFIG_MCUMGR CONFIG_NET_BUF=yCONFIG_ZCBOR=yCONFIG_CRC=y# Configure dependencies for CONFIG_MCUMGR_GRP_IMG CONFIG_FLASH=yCONFIG_IMG_MANAGER=y# Configure dependencies for CONFIG_IMG_MANAGER CONFIG_STREAM_FLASH=yCONFIG_FLASH_MAP=y# Configure dependencies for CONFIG_MCUMGR_TRANSPORT_UART CONFIG_BASE64=y
Kconfig
5.3 With this, we can do DFU over UART without entering bootloader mode. Build, flash and start the DK normally (do not hold any buttons). During operations, we can use the mcumgr-cli to list images, as before:
Copy
mcumgr -c testDK image list
Then we change the application code again, build the code and upload the new firmware image:
5.4 Since we now use a dual slot configuration, the uploaded application does not automatically run. We can reset the DK now without any change. To make the application swap into primary slot, we must tag it with either “test” or “confirm”. Let’s do “test” first. First, we need to get the hash of the image:
And if we reset the board, again, we can in the same way see that the image swaps back to the old firmware. This is because we passed test not confirm to mcumgr
Note
To restore the default DK debugger (Interface MCU) behavior with a virtual mass storage disk enabled, use the following J-Link command: MSDEnable. This command can be executed via J-Link Commander (on Windows) or JLinkExe (on Linux).
nRF5340 update
The application core of the nRF5340 can be updated, as explained above.
When doing DFU from the application, no extra configurations are needed to update the network core. Another DFU package file must be used for the network core. Instead of app_update.bin, use net_core_app_update.bin.
In this Privacy Policy you will find information on Nordic Semiconductor ASA (“Nordic Semiconductor”) processes your personal data when you use the Nordic Developer Academy.
References to “we” and “us” in this document refers to Nordic Semiconductor.
2. Our processing of personal data when you use the Nordic Developer Academy
2.1 Nordic Developer Academy
Nordic Semiconductor processes personal data in order to provide you with the features and functionality of the Nordic Developer Academy. Creating a user account is optional, but required if you want to track you progress and view your completed courses and obtained certificates. If you choose to create a user account, we will process the following categories of personal data:
Email
Name
Password (encrypted)
Course progression (e.g. which course you have completely or partly completed)
Certificate information, which consists of name of completed course and the validity of the certificate
Course results
During your use of the Nordic Developer Academy, you may also be asked if you want to provide feedback. If you choose to respond to any such surveys, we will also process the personal data in your responses in that survey.
The legal basis for this processing is GDPR article 6 (1) b. The processing is necessary for Nordic Semiconductor to provide the Nordic Developer Academy under the Terms of Service.
2.2 Analytics
If you consent to analytics, Nordic Semiconductor will use Google Analytics to obtain statistics about how the Nordic Developer Academy is used. This includes collecting information on for example what pages are viewed, the duration of the visit, the way in which the pages are maneuvered, what links are clicked, technical information about your equipment. The information is used to learn how Nordic Developer Academy is used and how the user experience can be further developed.
2.2 Newsletter
You can consent to receive newsletters from Nordic from within the Nordic Developer Academy. How your personal data is processed when you sign up for our newsletters is described in the Nordic Semiconductor Privacy Policy.
3. Retention period
We will store your personal data for as long you use the Nordic Developer Academy. If our systems register that you have not used your account for 36 months, your account will be deleted.
4. Additional information
Additional information on how we process personal data can be found in the Nordic Semiconductor Privacy Policy and Cookie Policy.
Nordic Developer Academy Terms of Service
1. Introduction
These terms and conditions (“Terms of Use”) apply to the use of the Nordic Developer Academy, provided by Nordic Semiconductor ASA, org. nr. 966 011 726, a public limited liability company registered in Norway (“Nordic Semiconductor”).
Nordic Developer Academy allows the user to take technical courses related to Nordic Semiconductor products, software and services, and obtain a certificate certifying completion of these courses. By completing the registration process for the Nordic Developer Academy, you are agreeing to be bound by these Terms of Use.
These Terms of Use are applicable as long as you have a user account giving you access to Nordic Developer Academy.
2. Access to and use of Nordic Developer Academy
Upon acceptance of these Terms of Use you are granted a non-exclusive right of access to, and use of Nordic Developer Academy, as it is provided to you at any time. Nordic Semiconductor provides Nordic Developer Academy to you free of charge, subject to the provisions of these Terms of Use and the Nordic Developer Academy Privacy Policy.
To access select features of Nordic Developer Academy, you need to create a user account. You are solely responsible for the security associated with your user account, including always keeping your login details safe.
You will able to receive an electronic certificate from Nordic Developer Academy upon completion of courses. By issuing you such a certificate, Nordic Semiconductor certifies that you have completed the applicable course, but does not provide any further warrants or endorsements for any particular skills or professional qualifications.
Nordic Semiconductor will continuously develop Nordic Developer Academy with new features and functionality, but reserves the right to remove or alter any existing functions without notice.
3. Acceptable use
You undertake that you will use Nordic Developer Academy in accordance with applicable law and regulations, and in accordance with these Terms of Use. You must not modify, adapt, or hack Nordic Developer Academy or modify another website so as to falsely imply that it is associated with Nordic Developer Academy, Nordic Semiconductor, or any other Nordic Semiconductor product, software or service.
You agree not to reproduce, duplicate, copy, sell, resell or in any other way exploit any portion of Nordic Developer Academy, use of Nordic Developer Academy, or access to Nordic Developer Academy without the express written permission by Nordic Semiconductor. You must not upload, post, host, or transmit unsolicited email, SMS, or \”spam\” messages.
You are responsible for ensuring that the information you post and the content you share does not;
contain false, misleading or otherwise erroneous information
infringe someone else’s copyrights or other intellectual property rights
contain sensitive personal data or
contain information that might be received as offensive or insulting.
Such information may be removed without prior notice.
Nordic Semiconductor reserves the right to at any time determine whether a use of Nordic Developer Academy is in violation of its requirements for acceptable use.
Violation of the at any time applicable requirements for acceptable use may result in termination of your account. We will take reasonable steps to notify you and state the reason for termination in such cases.
4. Routines for planned maintenance
Certain types of maintenance may imply a stop or reduction in availability of Nordic Developer Academy. Nordic Semiconductor does not warrant any level of service availability but will provide its best effort to limit the impact of any planned maintenance on the availability of Nordic Developer Academy.
5. Intellectual property rights
Nordic Semiconductor retains all rights to all elements of Nordic Developer Academy. This includes, but is not limited to, the concept, design, trademarks, know-how, trade secrets, copyrights and all other intellectual property rights.
Nordic Semiconductor receives all rights to all content uploaded or created in Nordic Developer Academy. You do not receive any license or usage rights to Nordic Developer Academy beyond what is explicitly stated in this Agreement.
6. Liability and damages
Nothing within these Terms of Use is intended to limit your statutory data privacy rights as a data subject, as described in the Nordic Developer Academy Privacy Policy. You acknowledge that errors might occur from time to time and waive any right to claim for compensation as a result of errors in Nordic Developer Academy. When an error occurs, you shall notify Nordic Semiconductor of the error and provide a description of the error situation.
You agree to indemnify Nordic Semiconductor for any loss, including indirect loss, arising out of or in connection with your use of Nordic Developer Academy or violations of these Terms of Use. Nordic Semiconductor shall not be held liable for, and does not warrant that (i) Nordic Developer Academy will meet your specific requirements, (ii) Nordic Developer Academy will be uninterrupted, timely, secure, or error-free, (iii) the results that may be obtained from the use of Nordic Developer Academy will be accurate or reliable, (iv) the quality of any products, services, information, or other material purchased or obtained by you through Nordic Developer Academy will meet your expectations, or that (v) any errors in Nordic Developer Academy will be corrected.
You accept that this is a service provided to you without any payment and hence you accept that Nordic Semiconductor will not be held responsible, or liable, for any breaches of these Terms of Use or any loss connected to your use of Nordic Developer Academy. Unless otherwise follows from mandatory law, Nordic Semiconductor will not accept any such responsibility or liability.
7. Change of terms
Nordic Semiconductor may update and change the Terms of Use from time to time. Nordic Semiconductor will seek to notify you about significant changes before such changes come into force and give you a possibility to evaluate the effects of proposed changes. Continued use of Nordic Developer Academy after any such changes shall constitute your acceptance of such changes. You can review the current version of the Terms of Use at any time at https://academy.nordicsemi.com/terms-of-service/
8. Transfer of rights
Nordic Semiconductor is entitled to transfer its rights and obligation pursuant to these Terms of Use to a third party as part of a merger or acquisition process, or as a result of other organizational changes.
9. Third Party Services
To the extent Nordic Developer Academy facilitates access to services provided by a third party, you agree to comply with the terms governing such third party services. Nordic Semiconductor shall not be held liable for any errors, omissions, inaccuracies, etc. related to such third party services.
10. Dispute resolution
The Terms of Use and any other legally binding agreement between yourself and Nordic Semiconductor shall be subject to Norwegian law and Norwegian courts’ exclusive jurisdiction.
