otap.h

Go to the documentation of this file.

/* Copyright 2017 Wirepas Ltd. All Rights Reserved.
 *
 * See file LICENSE.txt for full license details.
 *
 */
 
#ifndef APP_LIB_OTAP_H_
#define APP_LIB_OTAP_H_
 
#include <stdlib.h>
#include <stdint.h>
#include <stdbool.h>
 
#include "app/app.h"
 
#define APP_LIB_OTAP_NAME 0x000f2338 
 
 
#define APP_LIB_OTAP_VERSION 0x201
 
typedef enum
{
    APP_LIB_OTAP_TYPE_BLANK = 0,
    APP_LIB_OTAP_TYPE_PRESENT = 1,
    APP_LIB_OTAP_TYPE_PROCESS = 2,
} app_lib_otap_type_e;
 
typedef enum
{
    APP_LIB_OTAP_STATUS_OK = 0x00000000,
    APP_LIB_OTAP_STATUS_NEW = UINT32_MAX,
} app_lib_otap_status_e;
 
typedef enum
{
    APP_LIB_OTAP_WRITE_RES_OK = 0,
    APP_LIB_OTAP_WRITE_RES_COMPLETED_OK = 1,
    APP_LIB_OTAP_WRITE_RES_COMPLETED_ERROR = 2,
    APP_LIB_OTAP_WRITE_RES_NOT_ONGOING = 3,
    APP_LIB_OTAP_WRITE_RES_INVALID_START = 4,
    APP_LIB_OTAP_WRITE_RES_INVALID_NUM_BYTES = 5,
    APP_LIB_OTAP_WRITE_RES_INVALID_HEADER = 6,
    APP_LIB_OTAP_WRITE_RES_INVALID_NULL_BYTES = 7,
} app_lib_otap_write_res_e;
 
typedef enum
{
    APP_LIB_OTAP_ACTION_NO_OTAP = 0,
    APP_LIB_OTAP_ACTION_PROPAGATE_ONLY = 1,
    APP_LIB_OTAP_ACTION_PROPAGATE_AND_PROCESS = 2,
    APP_LIB_OTAP_ACTION_PROPAGATE_AND_PROCESS_WITH_DELAY = 3,
    APP_LIB_OTAP_ACTION_LEGACY = 4,
} app_lib_otap_action_e;
 
typedef uint8_t app_lib_otap_seq_t;
 
typedef size_t
    (*app_lib_otap_get_max_num_bytes_f)(void);
 
typedef size_t
    (*app_lib_otap_get_num_bytes_f)(void);
 
typedef size_t
    (*app_lib_otap_get_max_block_num_bytes_f)(void);
 
typedef app_lib_otap_seq_t
    (*app_lib_otap_get_seq_f)(void);
 
typedef uint16_t
    (*app_lib_otap_get_crc_f)(void);
 
typedef app_lib_otap_type_e
    (*app_lib_otap_get_type_f)(void);
 
typedef app_lib_otap_status_e
    (*app_lib_otap_get_status_f)(void);
 
typedef size_t
    (*app_lib_otap_get_processed_num_bytes_f)(void);
 
typedef app_lib_otap_seq_t
    (*app_lib_otap_get_processed_seq_f)(void);
 
typedef uint16_t
    (*app_lib_otap_get_processed_crc_f)(void);
 
typedef uint32_t
    (*app_lib_otap_get_processed_area_id_f)(void);
 
typedef bool
    (*app_lib_otap_is_valid_f)(void);
 
typedef bool
    (*app_lib_otap_is_processed_f)(void);
 
typedef bool
    (*app_lib_otap_is_set_to_be_processed_f)(void);
 
typedef app_res_e
    (*app_lib_otap_read_f)(uint32_t start,
                           size_t num_bytes,
                           void * bytes);
 
typedef app_res_e
    (*app_lib_otap_clear_f)(void);
 
typedef app_res_e
    (*app_lib_otap_begin_f)(size_t num_bytes,
                            app_lib_otap_seq_t seq);
 
typedef app_lib_otap_write_res_e
    (*app_lib_otap_write_f)(uint32_t start,
                            size_t num_bytes,
                            const void * bytes);
 
typedef app_res_e
    (*app_lib_otap_set_to_be_processed_f)(void);
 
typedef app_res_e (*app_lib_otap_set_target_scratchpad_and_action_f)(
                                            app_lib_otap_seq_t target_sequence,
                                            uint16_t target_crc,
                                            app_lib_otap_action_e action,
                                            uint8_t delay);
 
typedef app_res_e
    (*app_lib_otap_get_target_scratchpad_and_action_f)(
                                            app_lib_otap_seq_t * target_sequence,
                                            uint16_t * target_crc,
                                            app_lib_otap_action_e * action,
                                            uint8_t * delay);
 
typedef struct
{
    app_lib_otap_get_max_num_bytes_f                getMaxNumBytes;
    app_lib_otap_get_num_bytes_f                    getNumBytes;
    app_lib_otap_get_max_block_num_bytes_f          getMaxBlockNumBytes;
    app_lib_otap_get_seq_f                          getSeq;
    app_lib_otap_get_crc_f                          getCrc;
    app_lib_otap_get_type_f                         getType;
    app_lib_otap_get_status_f                       getStatus;
    app_lib_otap_get_processed_num_bytes_f          getProcessedNumBytes;
    app_lib_otap_get_processed_seq_f                getProcessedSeq;
    app_lib_otap_get_processed_crc_f                getProcessedCrc;
    app_lib_otap_get_processed_area_id_f            getProcessedAreaId;
    app_lib_otap_is_valid_f                         isValid;
    app_lib_otap_is_processed_f                     isProcessed;
    app_lib_otap_is_set_to_be_processed_f           isSetToBeProcessed;
    app_lib_otap_read_f                             read;
    app_lib_otap_clear_f                            clear;
    app_lib_otap_begin_f                            begin;
    app_lib_otap_write_f                            write;
    app_lib_otap_set_to_be_processed_f              setToBeProcessed;
    app_lib_otap_set_target_scratchpad_and_action_f setTargetScratchpadAndAction;
    app_lib_otap_get_target_scratchpad_and_action_f getTargetScratchpadAndAction;
} app_lib_otap_t;
 
#endif /* APP_LIB_OTAP_H_ */