mip_parser.h

Go to the documentation of this file.

#pragma once
 
#include "mip_packet.h"
#include "mip_offsets.h"
 
#include "utils/byte_ring.h"
#include "mip_types.h"
 
#ifdef __cplusplus
namespace mip {
namespace C {
extern "C" {
#endif
 
 
 
 
 
typedef bool (*mip_packet_callback)(void* user, const mip_packet_view* packet, mip_timestamp timestamp);
 
 
typedef struct mip_parser
{
    mip_timestamp       _start_time;                           
    mip_timestamp       _timeout;                              
    uint8_t             _result_buffer[MIP_PACKET_LENGTH_MAX]; 
    uint16_t            _expected_length;                      
    byte_ring_state     _ring;                                 
    mip_packet_callback _callback;                             
    void*               _callback_object;                      
 
#ifdef MIP_ENABLE_DIAGNOSTICS
    uint32_t            _diag_bytes_read;                      
    uint32_t            _diag_bytes_skipped;                   
    uint32_t            _diag_packet_bytes;                    
    uint32_t            _diag_valid_packets;                   
    uint32_t            _diag_invalid_packets;                 
    uint32_t            _diag_timeouts;                        
#endif // MIP_ENABLE_DIAGNOSTICS
 
} mip_parser;
 
 
 
#define MIPPARSER_UNLIMITED_PACKETS   0   
#define MIPPARSER_DEFAULT_TIMEOUT_MS 100  
 
 
void mip_parser_init(mip_parser* parser, uint8_t* buffer, size_t buffer_size, mip_packet_callback callback, void* callback_object, mip_timestamp timeout);
bool mip_parser_parse_one_packet_from_ring(mip_parser* parser, mip_packet_view* packet_out, mip_timestamp timestamp);
size_t mip_parser_parse(mip_parser* parser, const uint8_t* input_buffer, size_t input_count, mip_timestamp timestamp, unsigned int max_packets);
 
void mip_parser_reset(mip_parser* parser);
 
size_t mip_parser_get_write_ptr(mip_parser* parser, uint8_t** ptr_out);
void mip_parser_process_written(mip_parser* parser, size_t count, mip_timestamp timestamp, unsigned int max_packets);
 
//
// Accessors
//
 
mip_timeout mip_parser_timeout(const mip_parser* parser);
void mip_parser_set_timeout(mip_parser* parser, mip_timeout timeout);
 
void mip_parser_set_callback(mip_parser* parser, mip_packet_callback callback, void* callback_object);
mip_packet_callback mip_parser_callback(const mip_parser* parser);
void* mip_parser_callback_object(const mip_parser* parser);
 
mip_timestamp mip_parser_last_packet_timestamp(const mip_parser* parser);
 
 
//
// Diagnostics
//
 
#ifdef MIP_ENABLE_DIAGNOSTICS
 
uint32_t mip_parser_diagnostic_bytes_read(const mip_parser* parser);
uint32_t mip_parser_diagnostic_bytes_skipped(const mip_parser* parser);
uint32_t mip_parser_diagnostic_packet_bytes(const mip_parser* parser);
 
uint32_t mip_parser_diagnostic_valid_packets(const mip_parser* parser);
uint32_t mip_parser_diagnostic_invalid_packets(const mip_parser* parser);
uint32_t mip_parser_diagnostic_timeouts(const mip_parser* parser);
 
#endif // MIP_ENABLE_DIAGNOSTICS
 
 
//
// Misc
//
 
mip_timeout mip_timeout_from_baudrate(uint32_t baudrate);
 
 
#ifdef __cplusplus
} // extern "C"
} // namespace C
} // namespace mip
#endif