MCU Bootloader Reference Manual

Table of Contents

• Introduction
  • Introduction
  • Terminology
  • Block Diagram
  • Features Supported
  • Components supported
• Functional description
  • Introduction
  • Memory map
  • MCU Bootloader Configuration Area (BCA)
  • Start-up process
  • Clock configuration
  • Bootloader entry point
  • Application integrity check
    • MCU bootloader flow with integrity checker
      • Bootloader initialization
      • Staying in or leaving bootloader
• MCU bootloader protocol
  • Introduction
  • Command with no data phase
  • Command with incoming data phase
  • Command with outgoing data phase
• Bootloader packet types
  • Introduction
  • Ping packet
  • Ping Response packet
  • Framing packet
  • CRC16 algorithm
  • Command packet
  • Response packet
• MCU bootloader command API
  • Introduction
  • GetProperty command
  • SetProperty command
  • FlashEraseAll command
  • FlashEraseRegion command
  • FlashEraseAllUnsecure command
  • ReadMemory command
  • WriteMemory command
  • FillMemory command
  • FlashSecurityDisable command
  • Execute command
  • Call command
  • Reset command
  • FlashProgramOnce command
  • FlashReadOnce command
  • FlashReadResource command
  • Configure Memory command
  • ReceiveSBFile command
  • ReliableUpdate command
• Supported peripherals
  • Introduction
  • I2C peripheral
    • Performance numbers for I2C
  • SPI Peripheral
    • Performance Numbers for SPI
  • UART peripheral
    • Performance Numbers for UART
  • USB HID Peripheral
    • Device descriptor
    • Endpoints
    • HID reports
  • USB peripheral
  • FlexCAN Peripheral
  • QuadSPI Peripheral
    • QSPI configuration block
    • Look-up-table
    • Configure QuadSPI module
    • Access external SPI flash devices using QuadSPI module
    • Boot directly from QuadSPI
    • Example QCB
• Peripheral interfaces
  • Introduction - Peripheral interfaces
  • Abstract control interface
  • Abstract byte interface
  • Abstract packet interface
  • Framing packetizer
  • USB HID packetizer
  • USB HID packetizer
  • Command/data processor
• Memory interface
  • Abstract interface
  • Flash driver interface
  • Low-level flash driver
• MCU bootloader porting
  • Introduction
  • Choosing a starting point
  • Preliminary porting tasks
    • Download MCUXpresso SDK
    • Copy the closest match
    • Provide device startup file (vector table)
    • Clean up the IAR project
    • Bootloader peripherals
  • Primary porting tasks
    • Bootloader peripherals
      • Supported peripherals
      • Peripheral initialization
      • Clock initialization
    • Bootloader configuration
    • Bootloader memory map configuration
• Creating a custom flash-resident bootloader
  • Introduction
  • Where to start
  • Flash-resident bootloader source tree
  • Modifying source files
  • Example
  • Modifying a peripheral configuration macro
  • How to generate MMCAU functions in binary image
• Bootloader Reliable Update
  • Introduction
  • Functional description
    • Bootloader workflow with reliable update
    • Reliable update implementation types
    • Reliable update flow
      • Software implementation
      • Hardware implementation
  • Configuration macros
  • Get property
• Appendix A: Status and error codes
• Appendix B: GetProperty and SetProperty commands
• Note about the source code in the document