icc_protocol.h

Go to the documentation of this file.

 
#ifndef ICC_PROTOCOL_H
#define ICC_PROTOCOL_H
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include "icc_config.h"
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
typedef enum
{
    ICC_PROTO_OK   = 0,
    ICC_PROTO_BUSY = 1,
    ICC_PROTO_FULL = 2,
    ICC_ERR_STATE  = 3,
    ICC_ERR_PARAM  = 4,
} icc_proto_err_t;
 
typedef enum
{
    ICC_PROTO_STOPPED   = 0,
    ICC_PROTO_HANDSHAKE = 1,
    ICC_PROTO_RUNNING   = 2,
} icc_proto_state_t;
 
typedef enum
{
    ICC_EVT_HANDSHAKE_OK   = 0,
    ICC_EVT_HEARTBEAT_LOST = 1,
    ICC_EVT_HANDSHAKE_FAIL = 2,
} icc_proto_event_t;
 
typedef struct
{
    uint32_t tx;
    uint32_t tx_state_err;
    uint32_t tx_param_err;
    uint32_t tx_full_err;
    uint32_t retry_count;
    uint32_t retry_exhausted;
 
    uint32_t rx;
    uint32_t rx_len_err;
    uint32_t rx_crc_err;
 
    uint32_t tx_hd;
    uint32_t rx_hb_ack;
    uint32_t rx_hd;
    uint32_t handshake_ok;
    uint32_t handshake_fail;
    uint32_t heartbeat_lost;
} icc_proto_stats_t;
 
typedef void (*icc_proto_send_func_t)(const uint8_t* buf, uint16_t len, void* userData);
typedef void (*icc_proto_msg_cb_t)(uint16_t cmd, const uint8_t* data, uint16_t len, void* userData);
typedef void (*icc_proto_evt_cb_t)(icc_proto_event_t event, void* userData);
 
typedef struct
{
    uint8_t          seq;
    uint16_t         cmd;
    uint8_t          data[ICC_ACK_DATA_MAX];
    uint16_t         data_len;
    uint64_t         send_tick;
    uint8_t          retry;
    volatile uint8_t active;
} icc_ack_entry_t;
 
typedef struct
{
    int      rxState;
    uint16_t buf_pos;
    uint8_t  rx_ctrl;
    uint8_t  rx_seq;
    uint16_t rx_cmd;
    uint16_t rx_len;
    uint16_t rx_data_remain;
    uint8_t  buf[ICC_RX_FRAME_MAX];
} icc_parser_ctx_t;
 
typedef struct
{
    icc_parser_ctx_t  parser;
    icc_proto_state_t state;
    volatile uint8_t  seq_counter;
    ICC_PROTO_LOCK_T  sqp_mutex;
 
    uint64_t heartbeat_tick;
    uint64_t last_hb_send_tick;
 
    icc_ack_entry_t  ack_table[ICC_ACK_TABLE_DEPTH];
    ICC_PROTO_LOCK_T ack_mutex;
 
    icc_proto_stats_t stats;
 
    icc_proto_send_func_t send_func;
    icc_proto_msg_cb_t    on_message;
    icc_proto_evt_cb_t    on_event;
    void*                 user_data;
} icc_proto_mgr_t;

icc_proto_err_t icc_proto_init(icc_proto_mgr_t* mgr);

void icc_proto_deinit(icc_proto_mgr_t* mgr);

void icc_proto_start(icc_proto_mgr_t* mgr);

void icc_proto_stop(icc_proto_mgr_t* mgr);

icc_proto_err_t icc_proto_send(icc_proto_mgr_t* mgr, uint16_t cmd, uint8_t need_ack, const uint8_t* data, uint16_t len);

icc_proto_err_t icc_proto_send_space_enough(icc_proto_mgr_t* mgr, uint8_t need_ack, uint16_t len);

void icc_proto_feed(icc_proto_mgr_t* mgr, const uint8_t* buf, uint16_t len);

void icc_proto_tick(icc_proto_mgr_t* mgr);

void icc_proto_set_send_func(icc_proto_mgr_t* mgr, icc_proto_send_func_t func);

void icc_proto_on_message(icc_proto_mgr_t* mgr, icc_proto_msg_cb_t cb);

void icc_proto_on_event(icc_proto_mgr_t* mgr, icc_proto_evt_cb_t cb);

void icc_proto_set_user_data(icc_proto_mgr_t* mgr, void* user_data);

icc_proto_state_t icc_proto_get_state(icc_proto_mgr_t* mgr);

void icc_proto_get_stats(icc_proto_mgr_t* mgr, icc_proto_stats_t* stats);

void icc_proto_reset_stats(icc_proto_mgr_t* mgr);
#ifdef __cplusplus
}
#endif
 
#endif