update_fw.h

Go to the documentation of this file.

/*
 * update_fw.h
 *
 *  Created on: 19 мар. 2023 г.
 *      Author: PC
 */
 
#ifndef INC_UPDATE_FW_H_
#define INC_UPDATE_FW_H_
 
#include "UBI_SDK.h"
 
#include "TransportLevel/main_receiver.h"
#include "stdint.h"
#include "string.h"
#include "stdbool.h"
#include "Data/data_table.h"
#include "Data/device_info_structs.h"
#include "Data/base_parameter.h"
#include "Devices/enum_discription.h"
#include "Drivers/base_memory_driver.h"
#include "TransportLevel/a_protocol_struct.h"
#include "Data/base_device_info.h"
#include "Data/data_table_structs.h"
#include "Data/data_verification.h"
#include "TransportLevel/p2p_protocol.h"
 
#ifdef UBI_SDK_TARGET_ESP32
#include "Drivers/esp32/partition_flash_driver.h"
#endif
 
#define IN_MAIN_APP_STATUS              0x01
#define IN_BOOTLOADER_STATUS            0x02
 
#define BAD_CRC_FIRMWARE                0x1E
#define GOOD_CRC_FIRMWARE               0x2E
 
#define BAD_COMPARE                     0x00
#define GOOD_COMPARE                    0x01
 
#define SIZE_BUFF_FOR_BOOT              1024
 
#define SIZE_FW_INFO_STRUCT             10
 
#define BEGIN_CALCULATE_CRC             0x01
#define END_CALCULATE_CRC               0x00
 
typedef struct
  {
    char BoardName[32];
    uint8_t BoardVersion;
    uint8_t BoardSubVersion;
    uint8_t BoardRev;
    uint8_t BoardSubRev;
    uint16_t BoardBuild;
    uint8_t BoardType;
    uint8_t BoardCode;
 
    uint8_t BoardAdditionalInfoType;
    uint32_t BoardAdditionalInfo;
 
    char FWName[32];
    uint8_t FWMajorVersion;
    uint8_t FWMinorVersion;
    uint8_t FWQuickFixVersion;
    uint8_t FWSinceLastTag;
 
    char FWLabel[16];
    uint8_t FWType;
    uint8_t FWCode;
 
    uint32_t FWStartAddress;
    uint32_t FWSize;
    uint32_t FWCRC;
 
    uint8_t SDKMajorVersion;
    uint8_t SDKMinorVersion;
    uint8_t SDKQuickFixVersion;
    uint8_t SDKSinceLastTag;
 
    uint8_t FWAdditionalInfoType;
    uint32_t FWAdditionalInfo;
 
  }__attribute__((__packed__)) FW_info_struct;
 
  typedef struct
  {
   uint16_t chanck_size;
   uint32_t bytes_interval;
   uint16_t timeout_ms;
   uint16_t flash_clear_delay_ms;
  }__attribute__((packed)) FW_up_load_atribute;
 
typedef enum {
       GET_RUN_PROGRAM_TYPE = 1,        //where are we
       JUMP_TO_BOOTLOADER,                //jump to boot
       CHECK_NEW_FW,                    //compare with data in flash about device
       PRELOAD_INFO,                    //preload before start firmware
       LOAD_NEW_FW,                      //download our firmware
       GET_BOOTLOADER_STATUS,          //witch mode now
       CALCULATE_CRC,
       COMPLITE_CRC,
       GET_BOOTLOADER_INFO,
       CHECK_NEW_BOOTLOADER,
       LOAD_NEW_BOOTLOADER,
       GET_UP_LOAD_ATRIBUTE,
 
       START_SYSTEM_UPDATE,
       FINISH_SYSTEM_UPDATE
 }update_fw_state_enum;
 
//=================================================
typedef enum
{
    BOOTLOADER_IDLE=1,                   //state wait
    PROCESSING_CLER,
    DONE_CLEAR,
    BOOTLOADER_PRELOAD_STATE,
    BOOTLOADER_CONTINUE_WRITE_FW,
    BOOTLOADER_CHECK_INFO_FW,
    PROCESSING_CULCULATE_CRC,
    DONE_CALCULATE_CRC
}state_process_bootloader;
//=================================================
 
 typedef enum {
        BOOTLOADER = 1,
        MAIN_PROGRAM,
  }update_fw_program_type_enum;
 
void Update_FW_Receive(base_device_information_struct* deviceInfo, ubi4_bus_protocol_obj_struct* protocol_str, protocol_receive_struct receive_str);
void JumpToProgramCommand(uint32_t address_to_jump);
void Init_Need_Struct_For_FW(base_BootloaderInfo_struct* base_boot,base_FWInfo_struct* base_fw,base_BoardInfo_struct* base_board);
uint8_t Compare_Data(void);
 
#ifdef UBI_SDK_FAMILY_STM32
    void Calculate_CRC();
    uint8_t Get_Enable_CRC(void);
    void Set_Enable_CRC(uint8_t value);
 
#elif defined(UBI_SDK_TARGET_ESP32)
    uint32_t calculate_crc_func(partition_flash_driver_struct*  memory_driver, base_FWInfo_struct *l_FW_struct, uint32_t calculate_part_delay);
    void StartESP_App();
    void StartESP_Bootloader();
    void SetESP_Bootloader();
    void Test_Clear();
    void Test_Get_CRC();
#endif
 
#endif /* INC_UPDATE_FW_H_ */