packet_utils.h

Go to the documentation of this file.

#ifndef __PACKET_UTILS_H__
#define __PACKET_UTILS_H__
 
#include "pal_log.h"
#include <stdint.h>
#include <stdio.h>
#include <stdbool.h>
#include <stdatomic.h>
#include "esp_random.h"
#include "rom/crc.h"
 
#define PACKET_BYTES (111)
#define PAYLOAD_BYTES (48)
#define PKT_NO_LOCATION (-1)
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum : uint8_t {
    DOMAIN_TM = 0x00,  
    DOMAIN_TC = 0x01,  
    DOMAIN_TEST = 0x02 
} domain_t;
 
typedef enum : uint8_t {
    TM_SDATA = 0x00,
    TM_BDATA = 0x01,
    TM_EVENT = 0x02
} tm_category_t;
 
typedef enum : uint8_t {
    TM_SDATA_SENSORS = 0x00,
    TM_SDATA_STATUS = 0x01
} tm_sdata_type_t;
 
typedef enum : uint8_t {
    TM_BDATA_IMAGE = 0x00,
    TM_BDATA_VIDEO = 0x01
} tm_bdata_type_t;
 
typedef enum : uint8_t {
    TM_EVENT_LOG = 0x00,
    TM_EVENT_ERROR = 0x01,
    TM_EVENT_CRASH = 0x02
} tm_event_type_t;
 
typedef enum : uint8_t {
    TC_CTRL = 0x00,
    TC_REQ = 0x01
} tc_category_t;
 
typedef enum : uint8_t {
    TC_REQ_SENSORS = 0x00,
    TC_REQ_STATUS = 0x01,
    TC_REQ_IMAGE = 0x02,
    TC_REQ_VIDEO = 0x03,
    TC_REQ_LOG = 0x04,
    TC_REQ_ERROR = 0x05,
    TC_REQ_CRASH = 0x06
} tc_req_type_t;
 
typedef enum : uint8_t {
    TC_CTRL_REBOOT = 0x00
} tc_ctrl_type_t;
 
typedef enum : uint8_t {
    TEST_WIMG = 0x00, 
    TEST_FRM = 0x01, 
    TEST_MSG = 0x02 
} test_category_t;
 
typedef struct packet packet_t;
typedef struct pkt_enc_pool pkt_enc_pool_t;
typedef struct pkt_dec_pool pkt_dec_pool_t;
 
typedef union {
    tm_category_t tm;
    tc_category_t tc;
    test_category_t test;
    uint8_t u8;
} category_t;
 
typedef union {
    tm_sdata_type_t sdata;
    tm_bdata_type_t bdata;
    tm_event_type_t event;
    tc_req_type_t req;
    tc_ctrl_type_t ctrl;
    uint8_t u8;
} type_t;
 
typedef struct {
    domain_t domain;
    category_t category;
    type_t type;
    uint16_t index;
    uint16_t total;
} header_t;
 
typedef enum {
    PKT_OK = 0,
    PKT_FAIL,
    PKT_ERR_INVALID_ARG,
    PKT_ERR_SYNC,
    PKT_ERR_CRC
} pkt_err_t;
 
packet_t* pkt_create(void);
void pkt_destroy(packet_t* restrict pkt);
 
pkt_enc_pool_t* enc_pool_create(void);
void enc_pool_destroy(pkt_enc_pool_t* restrict pool);
 
pkt_dec_pool_t* dec_pool_create(void);
void dec_pool_destroy(pkt_dec_pool_t* restrict pool);
 
pkt_err_t pkt_encode(
    packet_t* restrict pkt,
    pkt_enc_pool_t* restrict pool
);
 
pkt_err_t pkt_decode(
    const packet_t* restrict pkt,
    pkt_dec_pool_t* restrict pool,
    int8_t* restrict relative_loc
);
 
pkt_err_t dec_pool_get_pkt_from_relative_loc(
    const pkt_dec_pool_t* restrict pool,
    int8_t relative_loc,
    packet_t* restrict pkt
);
 
pkt_err_t pkt_get_id(
    const packet_t* restrict pkt,
    uint16_t* id
);
 
pkt_err_t header_sensor_config(header_t* restrict header);
pkt_err_t header_old_sensor_config(header_t* restrict header, uint16_t old_id);
 
pkt_err_t pkt_get_header(
    const packet_t* restrict pkt,
    header_t* header
);
 
pkt_err_t pkt_set_header(
    packet_t* restrict pkt,
    const header_t* restrict header
);
 
pkt_err_t pkt_get_payload(
    const packet_t* restrict pkt,
    uint8_t* payload,
    size_t len
);
 
pkt_err_t pkt_set_payload(
    packet_t* restrict pkt,
    const uint8_t* restrict payload,
    size_t len
);
 
bool pkt_is_chunked(const packet_t* restrict pkt);
 
pkt_err_t pkt_log(const packet_t* restrict pkt);
 
pkt_err_t pkt_test_random_set_sync8(packet_t* restrict pkt, bool* failed);
 
pkt_err_t pkt_test_random_set_crc16(packet_t* restrict pkt);
 
#ifdef __cplusplus
}
#endif
 
#endif // __PACKET_UTILS_H__