mip_packet.h

Go to the documentation of this file.

#pragma once
 
#include "mip_types.h"
 
#ifdef __cplusplus
 
namespace microstrain {
namespace C {
struct microstrain_serializer;
}
}
 
namespace mip {
namespace C {
extern "C" {
#else
struct microstrain_serializer;
#endif
 
 
 
 
 
typedef struct mip_packet_view
{
    uint8_t*       _buffer;         
    uint_least16_t _buffer_length;  
} mip_packet_view;
 
typedef enum mip_packet_index
{
    MIP_PACKET_INDEX_SYNC_1   = 0,
    MIP_PACKET_INDEX_SYNC_2   = 1,
    MIP_PACKET_INDEX_DESC_SET = 2,
    MIP_PACKET_INDEX_LENGTH   = 3,
    MIP_PACKET_INDEX_PAYLOAD  = 4
} mip_packet_index;
 
typedef enum mip_packet_index_length
{
    MIP_PACKET_HEADER_LENGTH      = 4,
    MIP_PACKET_CHECKSUM_LENGTH    = 2,
    MIP_PACKET_PAYLOAD_LENGTH_MIN = 0,
    MIP_PACKET_PAYLOAD_LENGTH_MAX = 255,
    MIP_PACKET_LENGTH_MIN         = MIP_PACKET_HEADER_LENGTH + MIP_PACKET_CHECKSUM_LENGTH + MIP_PACKET_PAYLOAD_LENGTH_MIN,
    MIP_PACKET_LENGTH_MAX         = MIP_PACKET_HEADER_LENGTH + MIP_PACKET_CHECKSUM_LENGTH + MIP_PACKET_PAYLOAD_LENGTH_MAX
} mip_packet_index_length;
 
typedef enum mip_packet_sync_byte
{
    MIP_SYNC_1 = 0x75,
    MIP_SYNC_2 = 0x65
} mip_packet_sync_byte;
 
 
void mip_packet_create(mip_packet_view* packet, uint8_t* buffer, size_t buffer_size, uint8_t descriptor_set);
 
bool mip_packet_add_field(mip_packet_view* packet, uint8_t field_descriptor, const uint8_t* payload, uint8_t payload_length);
int  mip_packet_create_field(mip_packet_view* packet, uint8_t field_descriptor, uint8_t payload_length, uint8_t** payload_ptr_out);
int  mip_packet_update_last_field_length(mip_packet_view* packet, uint8_t* payload_ptr, uint8_t new_payload_length);
int  mip_packet_cancel_last_field(mip_packet_view* packet, uint8_t* payload_ptr);
 
void mip_packet_finalize(mip_packet_view* packet);
 
void mip_packet_reset(mip_packet_view* packet, uint8_t descriptor_set);
 
 
void mip_packet_from_buffer(mip_packet_view* packet, const uint8_t* buffer, size_t length);
 
uint8_t         mip_packet_descriptor_set(const mip_packet_view* packet);
uint_least16_t  mip_packet_total_length(const mip_packet_view* packet);
uint8_t         mip_packet_payload_length(const mip_packet_view* packet);
const uint8_t*  mip_packet_buffer(const mip_packet_view* packet);
uint8_t*        mip_packet_buffer_w(mip_packet_view* packet);
const uint8_t*  mip_packet_data(const mip_packet_view* packet);
const uint8_t*  mip_packet_payload(const mip_packet_view* packet);
uint8_t*        mip_packet_payload_w(mip_packet_view* packet);
uint16_t        mip_packet_checksum_value(const mip_packet_view* packet);
uint16_t        mip_packet_compute_checksum(const mip_packet_view* packet);
 
 
bool            mip_packet_is_sane(const mip_packet_view* packet);
bool            mip_packet_is_valid(const mip_packet_view* packet);
bool            mip_packet_is_empty(const mip_packet_view* packet);
 
uint_least16_t  mip_packet_buffer_length(const mip_packet_view* packet);
int             mip_packet_remaining_space(const mip_packet_view* packet);
 
bool            mip_packet_is_data(const mip_packet_view* packet);
 
 
 
#ifdef __cplusplus
} // extern "C"
} // namespace C
} // namespace mip
#endif