c6_proto.h

Go to the documentation of this file.

#pragma once
 
#include <stdint.h>
 
/* =============================================================================
 * 1. Transport dimensions, header layout and interface identifiers
 * =============================================================================
 */

typedef enum : uint16_t {
  k_c6_proto_buf_size    = 1600U, 
  k_c6_proto_hdr_size    = 12U,   
  k_c6_proto_payload_max = 1588U, 
} c6_proto_dim_t;

typedef enum : uint8_t {
  k_c6_hdr_off_iface    = 0U,  
  k_c6_hdr_off_flags    = 1U,  
  k_c6_hdr_off_len_lo   = 2U,  
  k_c6_hdr_off_len_hi   = 3U,  
  k_c6_hdr_off_off_lo   = 4U,  
  k_c6_hdr_off_off_hi   = 5U,  
  k_c6_hdr_off_csum_lo  = 6U,  
  k_c6_hdr_off_csum_hi  = 7U,  
  k_c6_hdr_off_seq_lo   = 8U,  
  k_c6_hdr_off_seq_hi   = 9U,  
  k_c6_hdr_off_throttle = 10U, 
  k_c6_hdr_off_pkttype  = 11U, 
} c6_hdr_offset_t;

typedef enum : uint8_t {
  k_c6_if_invalid = 0U, 
  k_c6_if_sta     = 1U, 
  k_c6_if_ap      = 2U, 
  k_c6_if_serial  = 3U, 
  k_c6_if_hci     = 4U, 
  k_c6_if_priv    = 5U, 
  k_c6_if_test    = 6U, 
  k_c6_if_eth     = 7U, 
  k_c6_if_max     = 8U, 
} c6_if_type_t;

typedef enum : uint8_t {
  k_c6_priv_pkt_event  = 0x33U, 
  k_c6_priv_event_init = 0x22U, 
  k_c6_dummy_if_num    = 0x0FU, 
} c6_proto_priv_t;

typedef enum : uint8_t {
  k_c6_shift_nibble  = 4U,    
  k_c6_mask_nibble   = 0x0FU, 
  k_c6_shift_byte    = 8U,    
  k_c6_mask_throttle = 0x03U, 
} c6_bitop_t;
 
/* =============================================================================
 * 2. Frame decode, checksum and classification
 * =============================================================================
 */

typedef enum : uint8_t {
  k_c6_frame_garbage  = 0U, 
  k_c6_frame_idle     = 1U, 
  k_c6_frame_data     = 2U, 
  k_c6_frame_bad_csum = 3U, 
} c6_frame_kind_t;

typedef struct {
  uint8_t  if_type;  
  uint8_t  if_num;   
  uint8_t  flags;    
  uint16_t len;      
  uint16_t offset;   
  uint16_t checksum; 
  uint16_t seq_num;  
  uint8_t  throttle; 
  uint8_t  pkt_type; 
  uint16_t computed; 
} c6_hdr_t;

void c6_probe_decode_header(const uint8_t* buf, c6_hdr_t* out);

uint16_t c6_probe_checksum(const uint8_t* buf, uint16_t count);

c6_frame_kind_t c6_probe_classify(const c6_hdr_t* h);

void c6_probe_print_header(const c6_hdr_t* h);

void c6_probe_dump_payload(const uint8_t* buf, uint16_t len);