MyOTAFirmwareUpdate.h

Go to the documentation of this file.

/*
 * The MySensors Arduino library handles the wireless radio link and protocol
 * between your home built sensors/actuators and HA controller of choice.
 * The sensors forms a self healing radio network with optional repeaters. Each
 * repeater and gateway builds a routing tables in EEPROM which keeps track of the
 * network topology allowing messages to be routed to nodes.
 *
 * Created by Henrik Ekblad <[email protected]>
 * Copyright (C) 2013-2022 Sensnology AB
 * Full contributor list: https://github.com/mysensors/MySensors/graphs/contributors
 *
 * Documentation: http://www.mysensors.org
 * Support Forum: http://forum.mysensors.org
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * version 2 as published by the Free Software Foundation.
 */
 
#ifndef MyOTAFirmwareUpdate_h
#define MyOTAFirmwareUpdate_h
 
#include "MySensorsCore.h"
#ifdef MCUBOOT_PRESENT
#include "generated_dts_board.h"
#define FIRMWARE_PROTOCOL_31
#endif
 
#define LOCAL static 
 
#if MAX_PAYLOAD_SIZE >= 22
#define FIRMWARE_BLOCK_SIZE     (16u)               
#else
#define FIRMWARE_BLOCK_SIZE     (8u)                
#ifndef FIRMWARE_PROTOCOL_31
#define FIRMWARE_PROTOCOL_31
#endif
#endif
#ifndef MY_OTA_RETRY
#define MY_OTA_RETRY            (5u)                
#endif
#ifndef MY_OTA_RETRY_DELAY
#define MY_OTA_RETRY_DELAY      (500u)              
#endif
#ifndef MCUBOOT_PRESENT
#define FIRMWARE_START_OFFSET   (10u)               
#else
#define FIRMWARE_START_OFFSET   (FLASH_AREA_IMAGE_1_OFFSET_0)   
#endif
 
#define MY_OTA_BOOTLOADER_MAJOR_VERSION (3u)        
#ifdef FIRMWARE_PROTOCOL_31
#define MY_OTA_BOOTLOADER_MINOR_VERSION (1u)        
#else
#define MY_OTA_BOOTLOADER_MINOR_VERSION (0u)        
#endif
#define MY_OTA_BOOTLOADER_VERSION (MY_OTA_BOOTLOADER_MINOR_VERSION * 256 + MY_OTA_BOOTLOADER_MAJOR_VERSION) 
 
#if defined(MY_DEBUG_VERBOSE_OTA_UPDATE)
#define OTA_DEBUG(x,...) DEBUG_OUTPUT(x, ##__VA_ARGS__) 
//#define OTA_EXTRA_FLASH_DEBUG 
#else
#define OTA_DEBUG(x,...)    
#endif
 
#if defined(DOXYGEN) && !defined(FIRMWARE_PROTOCOL_31)
 
#define FIRMWARE_PROTOCOL_31
#endif
 
typedef struct {
    uint16_t type;                              
    uint16_t version;                           
    uint16_t blocks;                            
    uint16_t crc;                               
} __attribute__((packed)) nodeFirmwareConfig_t;
 
typedef struct {
    uint16_t type;                              
    uint16_t version;                           
    uint16_t blocks;                            
    uint16_t crc;                               
    uint16_t BLVersion;                         
#ifdef FIRMWARE_PROTOCOL_31
    uint8_t  blockSize;                         
    uint8_t  img_commited;                          
    uint16_t img_revision;                          
    uint32_t img_build_num;                         
#endif
} __attribute__((packed)) requestFirmwareConfig_t;
 
typedef struct {
    uint16_t type;                              
    uint16_t version;                           
    uint16_t block;                             
} __attribute__((packed)) requestFirmwareBlock_t;
 
typedef struct {
    uint16_t type;                              
    uint16_t version;                           
    uint16_t block;                             
    uint8_t data[FIRMWARE_BLOCK_SIZE];          
} __attribute__((packed)) replyFirmwareBlock_t;
 
typedef struct {
    uint16_t type;                              
    uint16_t version;                           
    uint16_t block;                             
    uint16_t number_of_blocks;                      
    uint8_t data;                               
} __attribute__((packed)) replyFirmwareBlockRLE_t;
 
LOCAL void readFirmwareSettings(void);
LOCAL void firmwareOTAUpdateRequest(void);
LOCAL bool firmwareOTAUpdateProcess(void);
LOCAL bool transportIsValidFirmware(void);
LOCAL void presentBootloaderInformation(void);
 
#endif