Readme.md

8-Bit MDFU Client Setup for SPI Communication

Go Back

Required Hardware

• Curiosity Nano Base for Click boards™
• MCP2210 Breakout Module
• Five female-to-female jumper wires

Hardware Configuration

8-Bit MDFU Client SPI Communication

• Communication Protocol: SPI
• Application Start Address (Set through Configuration Bits UI): 0x3000
• Device ID: 0x1E9708 (automatically added)
• I/O Pin Indicator: Enabled
• I/O Pin Entry: Enabled
• Memory Verification: CRC32

SPI

• Custom Name: SERCOM
• BOOT_CONFIG: Mode 0
• Interrupt Driven: Disabled

SPI0 PLIB

• Description: Refer to Abstract Driver for User Configurations

SPI Pins

• MSSP SCK: RA6
• MSSP SDI (MOSI): RA4
• MSSP SDO (MISO): RA5
• MSSP SS (Chip Select): RA7
  • Custom Name: CHIP_SELECT

8-Bit MDFU Client I/O

• BOOT INDICATE: RC6
• BOOT ENTRY: RC7

• BOOT INDICATE: Start High
• BOOT ENTRY: Weak Pullup

8-Bit MDFU Client Project Properties

Set the linker options to restrict the bootloader compilation to the BOOT partition. This step is different depending on the used compiler.

AVR-GCC:

• When using the AVR-GCC compiler, open the Project Properties window and apply the below settings where <Application Start Address> is the start address of the application.

 avr-ld>Additional options>-Wl,--defsym,__TEXT_REGION_LENGTH__=<Application Start Address>

XC8:

• When using the XC8 compiler, open the Project Properties window and apply the below settings where <Application Start Address> is the start address of the application.

  XC8 Linker>Additional options>Extra Linker Options>-Wl,--defsym,__TEXT_REGION_LENGTH__=<Application Start Address>

Replace the <Application Start Address> to the Application Start Address value as configured in the MDFU Client UI.

Application Setup

Refer to the Application Setup section in the main Readme file.

Operation

This example shows how to execute the CRC32 verification example and update the device Flash memory with the CRC32 application image to demonstrate a successful device firmware update (DFU) over the SPI communication protocol.

8-Bit MDFU Client Operation

1. Open the MDFU client project.

2. Set MDFU client project as Main Project.

3. Right click, then select Clean and Build.

4. Program the MDFU client project.

Bootloader Operation after initial programming

After initial programming, the LED must be on.

Application Operation

1. Open the Application Project that is configured for your selected verification scheme.

2. Set the application project as the Main Project.

3. Build the required application project.

• Navigate to the Building tab of the application Project Properties and enable the "Execute this line after build" checkbox

• Right click the project name, then select Clean and Build

4. Build the Application Image File using pyfwimagebuilder.

• To build the application image files, navigate to the Project tab and right click on Important Files>build_free_image.bat for Windows or Important Files>build_free_image.sh for Mac and Linux
• Select Run

Example Command:

Below is an example of the command used in the above step.

pyfwimagebuilder build -i "application_hex_file.hex" -c "mdfu_config_file.toml" -o output.img

Tip: The configuration TOML file is generated by the MDFU Client project.

5. Use the pymdfu host tool to transfer the application image file to the bootloader.

• To run the update with the examples, navigate to the Project tab and right click, Important Files>pymdfu_update.bat for Windows or Important Files>pymdfu_update.sh for Mac and Linux. Double click to open the file.
• Edit the chip select number to the proper GPIO you have set on your MCP2210 Breakout Module
• Then right click on the script and select Run

Example Command:

Below is an example of the command used in the above step.

pymdfu update --tool mcp2210 --image ./output.img --chip-select 7 --clk-speed 50000

Application Has Been Updated Successfully

Back to top