This training topic describes how to download, configure, and build at91bootstrap to load an MPLAB® Harmony 3 Software Framework application binary image (harmony.bin) from NOR Flash (QSPI) Memory to DDR2 SDRAM on the SAM9X60-EK Evaluation Kit using the MPLAB X Integrated Development Environment (IDE).
Once at91bootstrap has been built, the resulting binary image (boot.bin) can be written to NOR Flash (QSPI) memory using the SAM-BA® In-System Programmer (ISP).
at91bootstrap is a second-stage bootloader for Microchip Technology, Arm®-based microprocessors (MPU). For more information see the "at91bootstrap: A Second Stage Bootloader for Microchip Microprocessors" page.
The following are prerequisites for this training:
- SAM9X60-EK - booting from QSPI Flash memory
- MPLAB X IDE installed on the host computer
- MPLAB XC32 Compiler installed on the host computer
This training topic was developed with MPLAB X IDE v6.05 and XC32 v4.21.
Before You Begin
Before you begin configuring at91bootstrap, you will need some information from the production build of the MPLAB Harmony 3 application. In this example, we use harmony.bin as our application image from the "SAM9X60-EK – Getting Started with MPLAB Harmony 3 Development: CSP Application: rtt_periodic_timeout" training page.
- NOR Flash Memory offset value to read harmony.bin
- The harmony.bin image size
- The DDR2 SDRAM address to load harmony.bin
These values will be used to configure at91bootstrap in the steps below.
NOR Flash Memory
The SAM9X60-EK has a 64 Mbit Serial Quad I/O™ (SQI™) Flash memory (U8) (Microchip Technology SST26VF064B) that can be used for booting the system.
The at91bootstrap (boot.bin) binary will be written to location 0x0 to 0x0003FFFF. The harmony.bin binary will be written to location 0x00040000 to 0x000FFFFF.
Create a Project Directory.
For the purpose of this training topic, we’ll name our project directory at91bootstrap.
Download or clone at91bootstrap version 4.
Download or clone from the Linux4sam GitHub repository.
This training topic was developed with at91bootstrap version 4.0.5.
Open Project at91bootstrap
From MPLAB X IDE, select File > Open Project… An Open Project dialog is displayed.
Click on the Open Project button.
The at91bootstrap project will be displayed in the Projects pane (upper left) and in the at91bootstrap – Dashboard pane (bottom left).
You may receive a Configuration Loading Error. This is due to an older version of the Device Family Pack (DFP) at the time of creating the at91bootstrap project. You will update the DFP to the latest version in the next steps.
Configure at91bootstrap Project Properties
Open at91bootstrap Project Properties.
Open the at91bootstrap Project Properties using one of the following methods:
- In the Projects pane, highlight at91bootstrap and click on the wrench icon in the at91bootstrap - Dashboard.
- In the Projects pane, right-click on at91bootstrap and select Properties from the menu.
The Projects Properties – at91bootstrap dialog box opens.
If you received a Configuration Loading Error in the previous step, you may see a [Resolve] link next to a version of the DFP. Highlight the latest DFP and click on the Apply button. This will update the configuration to the latest DFP.
The DFP contains device-specific support software. The 32-bit MCU and MPU DFPs are maintained by Microchip Technology and are available on GitHub.
Configure the XC32 Compiler
In the Categories pane, select Makefile.
Enter the following text in the Build command and Debug build command boxes:
"make CROSS_COMPILE="C:/Program Files/Microchip/xc32/v4.21/bin/bin/pic32c-""
Enter the following text in the Clean command box:
"make mplabclean CROSS_COMPILE="C:/Program Files/Microchip/xc32/v4.21/bin/bin/pic32c-""
Type the version number of the XC32 compiler on your host computer. In this step, we are using version 4.21.
The installation location of the XC compiler versions can be found by selecting from the MPLAB X IDE toolbar: Tools > Options. An Options dialog box will open. Select Embedded from the toolbar and select the Build Tools tab.
When cutting and pasting, beware of hidden formatting characters.
Click on the Apply button.
Configure at91bootstrap to load harmony.bin from NOR Flash (QSPI) Memory.
In the Categories pane, select Kconfig and click on the Load button.
Find the at91boostrap project directory and select configs directory and then select sam9x60ekdf_qspi_linux_image_dt_defconfig and click on the Open button.
Make the following changes:
In this step, you are taking an existing default configuration and altering it to load the MPLAB Harmony 3 Software Framework application (harmony.bin) from NOR Flash (QSPI) memory. This makes configuration a little bit easier than starting from scratch.
Expand Demo Application Image Storage Setup.
Observe Flash Offset for Demo-App.
This is the NOR Flash (QSPI) memory offset value to the application binary (here called Demo-App). This value is planned by the developer as part of the memory map of the NOR Flash (QSPI) memory.
Observe the value: 0x200000. This value is set in the default configuration.
Take note of this value as you will use it when writing the application binary (harmony.bin) to NOR Flash (QSPI) memory using the SAM-BA host applet qspiflash (see the "What’s Next?" section below).
Observe Demo-App Image Size.
This is the image size of the application binary image (here called Demo-App) to be copied from NOR Flash (QSPI) to SDRAM memory by at91bootstrap.
Observe the value: 0x00400000. This value is set in the default configuration.
It is important that the Demo-App Image Size is greater than the application binary size. In this example, harmony.bin is approximately 3 KB. Much smaller than the value set in the default configuration.
Click on the Apply and OK buttons.
This completes the configuration of the at91bootstrap project properties.
Build the at91bootstrap project using one of the following methods:
- In the Projects pane, right-click on at91bootstrap and select Build from the menu.
- Click on the Build icon (hammer) in the tool ribbon.
Note the location of boot.bin:
The boot.bin file is the binary image of at91bootstrap. The boot.bin image can now be written to NOR Flash (QSPI) memory using the SAM-BA host applet qspiflash. Instructions on how to do this are listed in the "What’s Next?" section below.
The at91bootstrap has been configured and built to load an MPLAB Harmony 3 Software Framework application from NOR Flash (QSPI) memory on the SAM9X60-EK.