c6_probe.h

Go to the documentation of this file.

#pragma once
 
#include <stdint.h>
 
#include "c6_proto.h"
#include "ra8_err.h"
#include "ra8_spi.h"
 
/* =============================================================================
 * 1. Tunables and budgets
 * =============================================================================
 */

typedef enum : uint32_t {
  k_c6_probe_uart_baud    = 115200U,  
  k_c6_probe_sck_hz       = 1000000U, 
  k_c6_probe_boot_wait_ms = 1500U,    
  k_c6_probe_settle_ms    = 20U,      
  k_c6_probe_gap_ms       = 100U,     
  k_c6_probe_cs_hold_ms   = 2U,       
  k_c6_probe_idle_ms      = 500U,     
} c6_probe_tunable_t;

typedef enum : uint8_t {
  k_c6_probe_xfer_per_mode  = 4U,   
  k_c6_probe_mode_count     = 4U,   
  k_c6_probe_hs_poll_max    = 100U, 
  k_c6_probe_hs_poll_ms     = 5U,   
  k_c6_probe_dump_bytes     = 32U,  
  k_c6_probe_str_max        = 96U,  
  k_c6_probe_pull_samples   = 8U,   
  k_c6_probe_pull_settle_ms = 5U,   
  k_c6_probe_min_votes      = 2U,   
} c6_probe_budget_t;

typedef enum : uint8_t {
  k_c6_fmt_dec_radix  = 10U,   
  k_c6_fmt_dec_digits = 10U,   
  k_c6_fmt_hex_max    = 8U,    
  k_c6_fmt_hex_bits   = 4U,    
  k_c6_fmt_hex_mask   = 0x0FU, 
  k_c6_fmt_hex_alpha  = 10U,   
  k_c6_fmt_hex_byte   = 2U,    
  k_c6_fmt_hex_word   = 4U,    
} c6_probe_fmt_t;
 
/* =============================================================================
 * 2. Side-band pins
 * =============================================================================
 */

typedef enum : uint8_t {
  k_c6_sb_irq    = 0U, 
  k_c6_sb_reset  = 1U, 
  k_c6_sb_gpio_a = 2U, 
  k_c6_sb_gpio_b = 3U, 
  k_c6_sb_count  = 4U, 
} c6_sideband_idx_t;

typedef struct {
  uint8_t level[k_c6_sb_count]; 
} c6_sideband_sample_t;

typedef enum : uint8_t {
  k_c6_wire_p800  = 0U, 
  k_c6_wire_p801  = 1U, 
  k_c6_wire_p802  = 2U, 
  k_c6_wire_p803  = 3U, 
  k_c6_wire_p804  = 4U, 
  k_c6_wire_count = 5U, 
} c6_wire_idx_t;

typedef enum : uint8_t {
  k_c6_wire_floating  = 0U, 
  k_c6_wire_low_side  = 1U, 
  k_c6_wire_high_side = 2U, 
  k_c6_wire_odd       = 3U, 
} c6_wire_kind_t;

typedef struct {
  uint32_t attempts;                 
  uint32_t idle_frames;              
  uint32_t data_frames;              
  uint32_t bad_csum_frames;          
  uint32_t hs_vote[k_c6_sb_count];   
  uint32_t dr_vote[k_c6_sb_count];   
  uint8_t  ever_high[k_c6_sb_count]; 
  uint8_t  ever_low[k_c6_sb_count];  
  uint8_t  pull_low[k_c6_sb_count];  
  uint8_t  pull_samples;             
} c6_probe_stats_t;
 
/* =============================================================================
 * 3. Module entry points
 * =============================================================================
 */

void c6_probe_puts(const char* text);

void c6_probe_put_u32(uint32_t value);

void c6_probe_put_hex(uint32_t value, uint8_t digits);

[[nodiscard]] ra8_err_t c6_probe_sideband_init(void);

void c6_probe_sample_sideband(c6_sideband_sample_t* out);

void c6_probe_print_sideband(const char* label, const c6_sideband_sample_t* s);

void c6_probe_vote(const c6_sideband_sample_t* pre,
                   const c6_sideband_sample_t* mid,
                   const c6_sideband_sample_t* post,
                   c6_probe_stats_t*           st);

uint8_t c6_probe_best(const uint32_t* votes, uint8_t ignore, uint32_t min_votes);

[[nodiscard]] ra8_err_t c6_probe_pull_contest(c6_probe_stats_t* st);

uint8_t c6_probe_sunk_pin(const c6_probe_stats_t* st, uint8_t ignore);

void c6_probe_resolve_map(const c6_probe_stats_t* st, uint8_t* hs_idx, uint8_t* dr_idx);

const char* c6_probe_sideband_name(uint8_t idx);

c6_wire_kind_t c6_probe_wire_kind(uint8_t after_high, uint8_t after_low);

void c6_probe_wire_test(void);

uint8_t c6_probe_cs_hunt(c6_probe_stats_t* st);

[[nodiscard]] ra8_err_t c6_probe_spi_pins_init(void);

bool c6_probe_sweep_mode(ra8_spi_mode_t    mode,
                         uint32_t          pclka_hz,
                         c6_probe_stats_t* st,
                         uint8_t*          hs_idx);