tr_over_the_air_bootloading_client.h

Go to the documentation of this file.

#ifndef TR_OVER_THE_AIR_BOOTLOADING_CLIENT_H
#define TR_OVER_THE_AIR_BOOTLOADING_CLIENT_H
 
#include "tr_af.h"
 
#ifndef TR_OVER_THE_AIR_BOOTLOADING_CLIENT_QUERY_DELAY_MINUTES
#define TR_OVER_THE_AIR_BOOTLOADING_CLIENT_QUERY_DELAY_MINUTES 5
#endif
 
#define TR_OVER_THE_AIR_BOOTLOADING_CLIENT_QUERY_TIMER_INTERVAL (60L * ZB_TIME_ONE_SECOND * TR_OVER_THE_AIR_BOOTLOADING_CLIENT_QUERY_DELAY_MINUTES)
 
// define this to a 1 to include the hardware version in the query next image request
#ifndef TR_OVER_THE_AIR_BOOTLOADING_CLIENT_QUERY_INCLUDE_HW_VERSION
#define TR_OVER_THE_AIR_BOOTLOADING_CLIENT_QUERY_INCLUDE_HW_VERSION 0
#endif
 
#ifndef TR_OVER_THE_AIR_BOOTLOADING_CLIENT_MAX_DATA_SIZE
#define TR_OVER_THE_AIR_BOOTLOADING_CLIENT_MAX_DATA_SIZE 64
#endif
 
// define this to a 1 to include the IEEE address in image block requests
// this indicates a file that is intended for this specific device such as
// security credentials, configuration, or log data
#ifndef TR_OVER_THE_AIR_BOOTLOADING_CLIENT_IMAGE_BLOCK_REQUEST_INCLUDE_IEEE_ADDRESS
#define TR_OVER_THE_AIR_BOOTLOADING_CLIENT_IMAGE_BLOCK_REQUEST_INCLUDE_IEEE_ADDRESS 0
#endif
 
// max number of retries for an ota upgrade packet
#define TR_ZCL_OVER_THE_AIR_BOOTLOADING_MAX_ZCL_RETRIES 3
 
// maximum jitter value for query next image command
#define TR_ZCL_OVER_THE_AIR_BOOTLOADING_QUERY_JITTER_MAX_VALUE 100
 
// resend delay, used in case we don't get a response
#define TR_ZCL_OVER_THE_AIR_BOOTLOADING_RESEND_DELAY (ZB_TIME_ONE_SECOND * 15)
 
// default values for attributes
#define TR_ZCL_OVER_THE_AIR_BOOTLOADING_FILE_OFFSET_DEF_VALUE             0xFFFFFFFF
#define TR_ZCL_OVER_THE_AIR_BOOTLOADING_CURRENT_FILE_VERSION_DEF_VALUE    0xFFFFFFFF
#define TR_ZCL_OVER_THE_AIR_BOOTLOADING_DOWNLOADED_FILE_VERSION_DEF_VALUE 0xFFFFFFFF
#define TR_ZCL_OVER_THE_AIR_BOOTLOADING_MFG_ID_DEF_VALUE                  0xFFFF
#define TR_ZCL_OVER_THE_AIR_BOOTLOADING_IMAGE_TYPE_DEF_VALUE              0xFFFF
#define TR_ZCL_OVER_THE_AIR_BOOTLOADING_HW_VERSION_DEF_VALUE              0
 
#define TR_ZCL_OVER_THE_AIR_BOOTLOADING_UPGRADE_TIME_DEF_VALUE            0xFFFFFFFF
 
// wildcard values for command arguments
#define TR_ZCL_OVER_THE_AIR_BOOTLOADING_MFG_CODE_WILDCARD_VALUE     0xFFFF
#define TR_ZCL_OVER_THE_AIR_BOOTLOADING_IMAGE_TYPE_WILDCARD_VALUE   0xFFFF
#define TR_ZCL_OVER_THE_AIR_BOOTLOADING_FILE_VERSION_WILDCARD_VALUE 0xFFFFFFFF
 
// enum for image notify payload type
typedef enum
{
    TR_ZCL_OVER_THE_AIR_BOOTLOADING_IMAGE_NOTIFY_PAYLOAD_JITTER                = 0x00,
    TR_ZCL_OVER_THE_AIR_BOOTLOADING_IMAGE_NOTIFY_PAYLOAD_JITTER_CODE           = 0x01,
    TR_ZCL_OVER_THE_AIR_BOOTLOADING_IMAGE_NOTIFY_PAYLOAD_JITTER_CODE_IMAGE     = 0x02,
    TR_ZCL_OVER_THE_AIR_BOOTLOADING_IMAGE_NOTIFY_PAYLOAD_JITTER_CODE_IMAGE_VER = 0x03
} tr_over_the_air_bootloading_client_image_notify_payload_type_t;
 
// field control byte for the query next image request command
typedef union
{
    struct
    {
        zb_uint8_t hw_version_present : 1;
        zb_uint8_t unused : 7;
    };
 
    zb_uint8_t data;
} tr_over_the_air_bootloading_query_next_image_request_field_control_t;
 
// field control byte for the image block request command
typedef union
{
    struct
    {
        zb_uint8_t ieee_address_present : 1;
        zb_uint8_t minimum_block_period_present : 1;
        zb_uint8_t unused : 6;
    };
 
    zb_uint8_t data;
} tr_over_the_air_bootloading_image_block_request_field_control_t;
 
// definition of the values for the image upgrade status attribute
typedef enum
{
    TR_ZCL_OVER_THE_AIR_BOOTLOADING_CLIENT_STATUS_NORMAL                        = 0x00,
    TR_ZCL_OVER_THE_AIR_BOOTLOADING_CLIENT_STATUS_DOWNLOADING                   = 0x01,
    TR_ZCL_OVER_THE_AIR_BOOTLOADING_CLIENT_STATUS_DOWNLOADED                    = 0x02,
    TR_ZCL_OVER_THE_AIR_BOOTLOADING_CLIENT_STATUS_WAITING_UPGRADE               = 0x03,
    TR_ZCL_OVER_THE_AIR_BOOTLOADING_CLIENT_STATUS_COUNT_DOWN                    = 0x04,
    TR_ZCL_OVER_THE_AIR_BOOTLOADING_CLIENT_STATUS_WAIT_FOR_MORE                 = 0x05,
    TR_ZCL_OVER_THE_AIR_BOOTLOADING_CLIENT_STATUS_WAIT_TO_UPGRADE_VIA_EXT_EVENT = 0x06,
    TR_ZCL_OVER_THE_AIR_BOOTLOADING_CLIENT_STATUS_UNKNOWN                       = 0xFF
} tr_over_the_air_bootloading_client_status_t;
 
// command structure for Over the Air Bootloading image block response with status wait for data
typedef ZB_PACKED_PRE struct
{
    zb_uint8_t  status;
    zb_uint32_t current_time;
    zb_uint32_t request_time;
    zb_uint16_t minimum_block_period;
} ZB_PACKED_STRUCT tr_over_the_air_bootloading_image_block_response_wait_for_data_cmd_t;
 
// Structure for saving OTA server information
typedef struct
{
    zb_uint32_t image_size;
    zb_uint32_t fw_version;
    zb_uint16_t short_addr;
    zb_uint8_t  endpoint;
} tr_over_the_air_bootloading_server_info_t;
 
// Structure for saving OTA client information
typedef struct
{
    zb_uint32_t fw_version;
    zb_uint32_t download_file_size;
    zb_uint32_t offset_at_last_attr_save;
    zb_uint16_t image_type;
    zb_uint16_t mfg_id;
    zb_uint16_t hw_version;
    zb_uint16_t saved_min_block_period;
    zb_uint8_t  endpoint;
    zb_uint8_t  block_req_retries;
    zb_uint8_t  end_req_retries;
    zb_uint8_t  end_req_status;
} tr_over_the_air_bootloading_client_info_t;
 
typedef ZB_PACKED_PRE struct
{
    zb_uint32_t file_id;
    zb_uint16_t header_version;
    zb_uint16_t header_length;
    zb_uint16_t fc;
    zb_uint16_t manufacturer_code;
    zb_uint16_t image_type;
    zb_uint32_t file_version;
    zb_uint16_t stack_version;
    zb_char_t   header_string[32];
    zb_uint32_t total_image_size;
} ZB_PACKED_STRUCT tr_zcl_over_the_air_bootloading_file_header_t;
 
typedef ZB_PACKED_PRE struct
{
    zb_uint16_t tag_id;
    zb_uint32_t length;
    zb_uint8_t  value[1];
} ZB_PACKED_STRUCT tr_zcl_over_the_air_bootloading_sub_element_t;
 
#define TR_ZCL_OVER_THE_AIR_BOOTLOADING_TAG_HEADER_LENGTH (sizeof(tr_zcl_over_the_air_bootloading_sub_element_t) - 1)
 
typedef enum
{
    TR_ZCL_OTA_UPGRADE_FILE_TAG_UPGRADE_IMAGE        = 0x0000,
    TR_ZCL_OTA_UPGRADE_FILE_TAG_ECDSA                = 0x0001,
    TR_ZCL_OTA_UPGRADE_FILE_TAG_ECDSA_CERT           = 0x0002,
    TR_ZCL_OTA_UPGRADE_FILE_TAG_IMAGE_INTEGRITY_CODE = 0x0003,
    TR_ZCL_OTA_UPGRADE_FILE_TAG_PICTURE_DATA         = 0x0004,
    TR_ZCL_OTA_UPGRADE_FILE_TAG_ECDSA_V_2            = 0x0005,
    TR_ZCL_OTA_UPGRADE_FILE_TAG_ECDSA_CERT_V_2       = 0x0006,
    TR_ZCL_OTA_UPGRADE_FILE_TAG_MANUF_MIN            = 0xf000,
    TR_ZCL_OTA_UPGRADE_FILE_TAG_MANUF_MAX            = 0xffff
} tr_zcl_ota_upgrade_sub_element_tag;

#if defined(TR_OVER_THE_AIR_BOOTLOADING_CLIENT_PLUGIN_PRINT_ENABLE) && (TR_OVER_THE_AIR_BOOTLOADING_CLIENT_PLUGIN_PRINT_ENABLE == 1)
#define tr_over_the_air_bootloading_client_printf(...)  tr_zcl_printf(__VA_ARGS__)
#define tr_over_the_air_bootloading_client_println(...) tr_zcl_println(__VA_ARGS__)
#else
#define tr_over_the_air_bootloading_client_printf(...)
#define tr_over_the_air_bootloading_client_println(...)
#endif


void tr_over_the_air_bootloading_client_init_cb(zb_uint8_t endpoint);

zb_bool_t tr_over_the_air_bootloading_client_command_received_cb(zb_zcl_parsed_hdr_t *cmd_info);

void tr_over_the_air_bootloading_client_write_attr_cb(zb_uint8_t  endpoint,
                                                      zb_uint16_t attr_id,
                                                      zb_uint8_t  *new_value,
                                                      zb_uint16_t manuf_code);

zb_bool_t tr_over_the_air_bootloading_client_image_notify_cb(zb_zcl_parsed_hdr_t *cmd_info,
                                                             zb_uint8_t          endpoint,
                                                             zb_uint8_t          payload_type,
                                                             zb_uint8_t          query_jitter,
                                                             zb_uint16_t         manufacturer_id,
                                                             zb_uint16_t         image_type,
                                                             zb_uint32_t         new_file_version);

zb_bool_t tr_over_the_air_bootloading_client_query_next_image_response_cb(zb_zcl_parsed_hdr_t *cmd_info,
                                                                          zb_uint8_t          endpoint,
                                                                          zb_uint8_t          status,
                                                                          zb_uint16_t         manufacturer_id,
                                                                          zb_uint16_t         image_type,
                                                                          zb_uint32_t         file_version,
                                                                          zb_uint32_t         image_size);

zb_bool_t tr_over_the_air_bootloading_client_image_block_response_cb(zb_zcl_parsed_hdr_t                                    *cmd_info,
                                                                     zb_uint8_t                                             endpoint,
                                                                     zb_uint8_t                                             status,
                                                                     zb_uint16_t                                            manufacturer_id,
                                                                     zb_uint16_t                                            image_type,
                                                                     zb_uint32_t                                            file_version,
                                                                     zb_uint32_t                                            file_offset,
                                                                     zb_uint8_t                                             data_size,
                                                                     /* TYPE WARNING: array array defaults to */ zb_uint8_t *image_data);

zb_bool_t tr_over_the_air_bootloading_client_upgrade_end_response_cb(zb_zcl_parsed_hdr_t *cmd_info,
                                                                     zb_uint8_t          endpoint,
                                                                     zb_uint16_t         manufacturer_id,
                                                                     zb_uint16_t         image_type,
                                                                     zb_uint32_t         file_version,
                                                                     zb_uint32_t         current_time,
                                                                     zb_uint32_t         upgrade_time);

zb_bool_t tr_over_the_air_bootloading_client_query_specific_file_response_cb(zb_zcl_parsed_hdr_t *cmd_info,
                                                                             zb_uint8_t          endpoint,
                                                                             zb_uint8_t          status,
                                                                             zb_uint16_t         manufacturer_id,
                                                                             zb_uint16_t         image_type,
                                                                             zb_uint32_t         file_version,
                                                                             zb_uint32_t         image_size);

void tr_over_the_air_bootloading_client_version_cb(zb_uint8_t  endpoint,
                                                   zb_uint32_t *fw_version,
                                                   zb_uint16_t *mfg_id,
                                                   zb_uint16_t *image_type,
                                                   zb_uint16_t *hw_version);

void tr_over_the_air_bootloading_client_upgrade_start_cb(zb_uint32_t image_version,
                                                         zb_uint32_t image_size,
                                                         zb_uint32_t starting_offset);

void tr_over_the_air_bootloading_client_mfg_tag_found_cb(tr_zcl_over_the_air_bootloading_sub_element_t *tag_header);

zb_bool_t tr_over_the_air_bootloading_client_check_for_zigbee_upgrade_cb(zb_uint32_t downloaded_fw_version);

void tr_over_the_air_bootloading_client_server_not_found_cb(void);



tr_over_the_air_bootloading_server_info_t *tr_over_the_air_bootloading_client_get_server_info(void);

tr_over_the_air_bootloading_client_info_t *tr_over_the_air_bootloading_client_get_client_info(void);

tr_zcl_over_the_air_bootloading_sub_element_t *tr_over_the_air_bootloading_client_find_tag_header(zb_uint16_t tag_id);

tr_zcl_over_the_air_bootloading_file_header_t *tr_over_the_air_bootloading_client_get_ota_header(void);

void tr_over_the_air_bootloading_client_stop(void);

void tr_over_the_air_bootloading_client_start(void);


void tr_over_the_air_bootloading_client_connection_state_cb(tr_conn_state_e conn_state);
void tr_over_the_air_bootloading_client_init(void);
 
#endif // TR_OVER_THE_AIR_BOOTLOADING_CLIENT_H