1.1.2 PIC32CXMTSH-DB Evaluation Kit: Building and Running the I2C EEPROM Bootloader applications

Downloading and building the application

To clone or download this application from Github,go to the main page of this repository and then click Clone button to clone this repo or download as zip file. This content can also be download using content manager by following these instructions

Path of the application within the repository is apps/i2c_eeprom_bootloader/

To build the application, refer to the following table and open the project using its IDE.

Setting up

  • To run the demo, the following additional hardware are required:

  • Install the EEPROM 3 Click on to the mikroBUS 1

  • Connect the Debug USB port on the board to the computer using a micro USB cable

Setting up the host script

  • Refer to UART Host Script Help for setting up the uart_host.py utility used to send the application binary from host PC

    • There will be no reset command sent from host after programming by default.

    • Reboot command has to be sent separately only after successful programming to trigger bootloader from programmer application

Running the Application

  1. Open the bootloader project bootloader/firmware/pic32cx_mtsh_db.X in the IDE

  2. Make sure that the app_programmer/firmware/pic32cx_mtsh_db.X is added as a loadable project to bootloader application

    • As the I2C EEPROM may not have any valid binary required by bootloader for the first time, Adding the app_programmer as loadable allows MPLAB X to create a unified hex file and program both these applications in their respective memory locations based on their linker script configurations
    mplab_loadable_pic32cx_mtsh_db

  3. Build and program the bootloader application using the IDE

  4. Once programming is done bootloader starts execution and directly jumps to application space to run the programmer application

    • LED_RED starts blinking every 500ms indicating that the programmer application is running

  5. Open the programmer application project app_programmer/firmware/pic32cx_mtsh_db.X in the IDE

  6. Update app_programmer/firmware/src/app.c to reduce the LED blink duration from 500ms to 100ms as below

    	APP_TIMER_DelayMs(100);

  7. Clean and Build the project to generate the binary (Do not program the binary)

  8. Run the uart_host.py from command prompt to program the updated programmer application binary in I2C EEPROM

     python <harmony3_path>/bootloader_apps_serial_memory/tools/uart_host.py -v -i <COM PORT> -d PIC32CX_MT -a  0x1002000 -f <harmony3_path>\bootloader_apps_serial_memory\apps\i2c_eeprom_bootloader\app_programmer\firmware\pic32cx_mtsh_db.X\dist\pic32cx_mtsh_db\production\pic32cx_mtsh_db.X.production.bin

  9. Following snapshot shows output of successfully programming the programmer application

    • LED_RED should still be blinking every 500ms
    uart_host_output_program

  10. To update the firmware, you can either:

    • Scroll Down button, then press RESET twice, OR
    • Run uart_host.py from the command prompt to send a Reboot command, then press RESET. This process updates the MetaData and triggers the Bootloader, which programs the updated binary from QSPI Flash to Internal Flash.
    uart_host_output_reboot

  11. Once Firmware Update is successful LED_RED should start blinking every 100ms indicating updated programmer application running

    • If there was any error you may need to power cycle the device to retry firmware upgrade

  12. Update app_programmer/firmware/src/app.c to revert LED blink duration to 500ms from 100ms as below

    APP_TIMER_DelayMs(500);

  13. Clean and Build the project to generate the binary (Do not program the binary)

  14. Repeat Step 8-9.

    • You should see LED_RED still blinking every 100ms

  15. Press the Switch SCROLL_DOWN and then Reset button to Update MetaData and trigger Bootloader to program the updated binary from I2C EEPROM to Internal Flash

  16. Once Firmware Update is successful LED_RED should start blinking every 500ms indicating updated programmer application running

    • If there was any error you may need to power cycle the device to retry firmware upgrade

Additional Steps (Optional)