c6_fwver.h

Go to the documentation of this file.

 
#pragma once
 
#include <stddef.h>
#include <stdint.h>
 
#include "esp_hosted_header.h"
#include "port_esp_hosted_host_spi.h"
#include "ra8_err.h"

typedef enum : uint32_t {
  k_c6_fwver_uart_baud    = 115200U,  
  k_c6_fwver_sck_hz       = 5000000U, 
  k_c6_fwver_edge_poll_ms = 2U,       
  k_c6_fwver_boot_wait_ms = 200U,     
  k_c6_fwver_heartbeat_ms = 5000U,    
  k_c6_fwver_dma_align    = 64U,      
  k_c6_fwver_worker_stack = 8192U,    
  k_c6_fwver_worker_prio  = 8U,       
  k_c6_fwver_rpc_uid      = 1U,       
} c6_fwver_cfg_t;

typedef enum : uint16_t {
  k_c6_fwver_str_max    = 256U,  
  k_c6_fwver_dec_radix  = 10U,   
  k_c6_fwver_dec_digits = 10U,   
  k_c6_fwver_hex_digits = 8U,    
  k_c6_fwver_hex_bits   = 4U,    
  k_c6_fwver_hex_mask   = 0x0FU, 
  k_c6_fwver_hex_alpha  = 10U,   
  k_c6_fwver_hex_byte   = 2U,    
  k_c6_fwver_hex_word   = 4U,    
  k_c6_fwver_text_max   = 32U,   
} c6_fwver_fmt_t;

typedef enum : uint16_t {
  k_c6_fwver_frame_bytes = (uint16_t)MAX_TRANSPORT_BUFFER_SIZE,
  k_c6_fwver_max_transfers = 64U,
  k_c6_fwver_hs_wait_ms = 200U,
  k_c6_fwver_hs_giveup = 3U,
  k_c6_fwver_hs_poll_ms = 1U,
  k_c6_fwver_gap_ms = 2U,
  k_c6_fwver_tx_max = 512U,
} c6_fwver_link_t;

typedef union c6_fwver_frame {
  uint8_t bytes[k_c6_fwver_frame_bytes];
  struct esp_payload_header header;
} c6_fwver_frame_t;

typedef struct c6_fwver_pump_stats {
  uint16_t transfers;    
  uint16_t frames;       
  uint16_t idle;         
  uint16_t bad_checksum; 
  uint16_t malformed;    
  uint16_t hs_timeouts;  
  uint16_t ifnum_defect; 
  bool     bus_error;    
  bool     sink_stopped; 
} c6_fwver_pump_stats_t;

typedef bool (*c6_fwver_sink_t)(uint8_t        if_type,
                                uint8_t        if_num,
                                const uint8_t* payload,
                                uint16_t       len);

void c6_fwver_puts(const char* text);

void c6_fwver_put_u32(uint32_t value);

void c6_fwver_put_i32(int32_t value);

void c6_fwver_put_hex(uint32_t value, uint8_t digits);

void c6_fwver_put_text(const uint8_t* text, size_t len);

void c6_fwver_print_banner(uint32_t cpuclk_hz, uint32_t pclka_hz);

void c6_fwver_print_pump(const char* label, const c6_fwver_pump_stats_t* stats);

[[nodiscard]] ra8_err_t c6_fwver_link_pump(uint8_t                if_type,
                                           uint8_t                if_num,
                                           const uint8_t*         payload,
                                           uint16_t               payload_len,
                                           uint16_t               max_transfers,
                                           c6_fwver_sink_t        sink,
                                           c6_fwver_pump_stats_t* stats);

[[nodiscard]] ra8_err_t c6_fwver_priv_host_caps(uint8_t* out, uint16_t cap, uint16_t* out_len);

bool c6_fwver_priv_consume(uint8_t if_type, uint8_t if_num, const uint8_t* payload, uint16_t len);

[[nodiscard]] uint32_t c6_fwver_priv_init_version(void);

[[nodiscard]] ra8_err_t c6_fwver_rpc_request(uint8_t* out, uint16_t cap, uint16_t* out_len);

bool c6_fwver_rpc_consume(uint8_t if_type, uint8_t if_num, const uint8_t* payload, uint16_t len);

bool c6_fwver_rpc_report(void);

bool c6_fwver_dispatch(uint8_t if_type, uint8_t if_num, const uint8_t* payload, uint16_t len);