Zigbee Over-The-Air Firmware Upgrade

• Z-Stack OTA Upgrade
  • 1. Introduction
    • 1.1 How to Read this Document
    • 1.2 Definitions, Abbreviations, Acronyms
    • 1.3 References
  • 2. OTA Overview
    • 2.1 OTA Theory of Operation
    • 2.2 OTA Image Converter Applications
    • 2.3 OtaServer PC Tool
      • 2.3.1 OTA Upgrade Image File Format
      • 2.3.2 OTA Image Converter Command Line Arguments
        • 2.3.2.1 Image Manufacturer Identifier
        • 2.3.2.2 Image Type Identifier
        • 2.3.2.3 Image Version
    • 2.4 Z-Stack Implementation of the OTA Upgrade Cluster for Client Device
      • 2.4.1 ZCL functionality
        • 2.4.1.1 zcl_ota.c and zcl_ota.h
        • 2.4.1.2 ota_client_app.c and ota_client_app.h
      • 2.4.2 BIM functionality
        • 2.4.2.1 crc32.c and crc32.h
        • 2.4.2.2 flash_interface_ext_rtos_NVS.C
        • 2.4.2.3 oad_image_header_app.c, oad_image_header_app.h and oad_image_header.h
        • 2.4.2.4 oad_switch_agama.c and oad_switch_agama.h
    • 2.5 Z-Stack Implementation of the OTA Upgrade Cluster for Server Device
      • 2.5.1 ZCL functionality
        • 2.5.1.1 ota_srv_app.c and ota_srv_app.h
        • 2.5.1.2 ota_common.c and ota_common.h
      • 2.5.2 Serial interface
        • 2.5.2.1 znp_app.c and znp_app.h
        • 2.5.2.2 NPI
      • 2.5.3 OTA Upgrade API
        • 2.5.3.1 OTA Callback Events
        • 2.5.3.2 zclOTA_RequestNextUpdate
        • 2.5.3.3 zclOTA_SendImageNotify
        • 2.5.3.4 zclOTA_PermitOta
      • 2.5.4 OTA Client Memory Partition
  • 3. Boot Image Manager (BIM)
  • 4. OAD Image Header
  • 5. Using the Sample OTA Applications
    • 5.1 Required Materials
    • 5.2 Building and Downloading Target Applications
      • 5.2.1 OTA BIM
      • 5.2.2 OTA Client Applications
        • 5.2.2.1 Generate OTA binaries
      • 5.2.3 OTA Server
        • 5.2.3.1 OTA Server Compilation Flags
    • 5.3 Performing an Image Update
      • 5.3.1 OtaServer Operation (desktop application)
  • 6. Adding Client Functionality to an Application
    • 6.1 Add OTA initialization and event process code
    • 6.2 Adding OTA Client Source Code
    • 6.3 Replace OTA linker and oad configuration file
      • 6.3.1 Replace OTA linker and oad configuration file in CCS
      • 6.3.2 Replace OTA linker and oad configuration file in IAR
    • 6.4 Add OTA Includes Directories
      • 6.4.1 Add OTA Includes Directories in CCS
      • 6.4.2 Add OTA Includes Directories in IAR
    • 6.5 Adding Configuration Compile Time Flags
      • 6.5.1 Adding Configuration Compile Time Flags in CCS
      • 6.5.2 Adding Configuration Compile Time Flags in IAR
    • 6.6 Adding Post-Build Actions
      • 6.6.1 Adding Post-Build Actions in CCS
      • 6.6.2 Adding Post-Build Actions in IAR
  • 7. OTA Client Application Binary Usage
    • 7.1 Flashing OTA client sequence
• TI Over-the-Air Download (OAD)
  • Introduction
    • OAD Topology Overview
  • Boot Image Manager (BIM)
    • Overview & Software Architecture
    • Boot procedure
      • Device trim
      • Halt In Boot (HIB)
    • Locating and Preparing a user application
      • BIM for Off-Chip OAD
  • OAD Image Header
    • OAD Image Header Overview
    • OAD Core Image Header
      • OAD Image Identification Value
      • CRC
      • BIM Version
      • Image Header Version
      • Wireless Technology
      • Image Information
      • Image Validation
      • Image Length
      • Program Entry Address
      • Software version
      • Image End Address
      • Header Length
    • OAD Image Header segments
      • Segment Header
        • Segment Type
        • Wireless Technology
        • Reserved
        • Payload Length
      • Boundary Information Segment
        • Stack Entry Address
        • Stack Boundary Address (ICALL_STACK0_ADDR)
        • Lower RAM Boundary (RAM_START_ADDR)
        • Upper RAM Boundary (RAM_END_ADDR)
      • Contiguous Image Information Segment
        • Image Start Address
  • OAD External Flash Image Header
    • Additional Fields in External Flash Image Header
  • Flash Layout for Off-Chip OAD
    • Constraints and Requirements for Off-chip OAD
    • Internal Flash Memory Layout
    • External Flash Memory Layout
  • OAD Image Tool
    • Running the tool
    • Running the Tool from Source
    • Required Arguments/Getting help