ra8_c6link.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
#include "ra8_c6link_transport.h"
#include "ra8_err.h"
#include "ra8_mdl_protocol.h"

typedef enum : uint16_t {
  k_ra8_c6link_frame_bytes = 1600U,
  k_ra8_c6link_header_bytes = 12U,
  k_ra8_c6link_max_payload = 1588U,
  k_ra8_c6link_mac_bytes = 6U,
  k_ra8_c6link_ssid_max = 32U,
  k_ra8_c6link_dma_align = 64U,
  k_ra8_c6link_arena_min = 2048U,
} ra8_c6link_geometry_t;

typedef enum : uint16_t {
  k_ra8_c6link_hs_wait_ms = 200U,
  k_ra8_c6link_hs_poll_ms = 1U,
  k_ra8_c6link_hs_giveup = 3U,
  k_ra8_c6link_gap_ms = 2U,
  k_ra8_c6link_rpc_transfers = 64U,
  k_ra8_c6link_announce_transfers = 8U,
} ra8_c6link_budget_t;

typedef struct ra8_c6link_mac {
  uint8_t octet[k_ra8_c6link_mac_bytes]; 
} ra8_c6link_mac_t;

typedef struct ra8_c6link_fw_version {
  uint32_t major;      
  uint32_t minor;      
  uint32_t patch;      
  uint32_t chip_id;    
  char     target[16]; 
  uint8_t  target_len; 
} ra8_c6link_fw_version_t;

typedef enum : uint8_t {
  k_ra8_c6link_event_boot = 0U,
  k_ra8_c6link_event_sta_connected = 1U,
  k_ra8_c6link_event_sta_disconnected = 2U,
  k_ra8_c6link_event_wifi = 3U,
} ra8_c6link_event_kind_t;

typedef struct ra8_c6link_event {
  ra8_c6link_event_kind_t kind;          
  uint8_t                 ssid_len;      
  uint8_t                 channel;       
  int8_t                  rssi;          
  uint16_t                reason;        
  int32_t                 wifi_event_id; 
  uint32_t                reset_reason;  
  ra8_c6link_mac_t        bssid;         
  char ssid[k_ra8_c6link_ssid_max + 1U];
} ra8_c6link_event_t;

typedef struct ra8_c6link_fault {
  uint32_t rpc_id; 
  int32_t  resp;   
} ra8_c6link_fault_t;

typedef struct ra8_c6link_stats {
  uint16_t transfers;    
  uint16_t data;         
  uint16_t idle;         
  uint16_t bad_checksum; 
  uint16_t malformed;    
  uint16_t rpc_in;       
  uint16_t events;       
  uint16_t eth_in;       
  uint16_t undecodable;  
  uint16_t unrouted;     
  uint16_t hs_timeouts;  
} ra8_c6link_stats_t;

typedef void (*ra8_c6link_event_cb_t)(void* ctx, const ra8_c6link_event_t* ev);

typedef void (*ra8_c6link_rx_cb_t)(void* ctx, const uint8_t* frame, uint16_t len);

typedef struct ra8_c6link_cfg {
  ra8_c6link_transport_t transport;   
  uint8_t*               arena;       
  uint32_t               arena_bytes; 
  ra8_c6link_event_cb_t  event_cb;    
  ra8_c6link_rx_cb_t     rx_cb;       
  void*                  cb_ctx;      
} ra8_c6link_cfg_t;

typedef ra8_err_t (*ra8_c6link_take_fn_t)(void* ctx, const void* msg);

typedef struct ra8_c6link_wait {
  uint32_t             uid;       
  uint32_t             resp_id;   
  ra8_c6link_take_fn_t take;      
  void*                take_ctx;  
  ra8_err_t            result;    
  bool                 armed;     
  bool                 satisfied; 
} ra8_c6link_wait_t;

typedef struct ra8_c6link {
  ra8_c6link_transport_t transport;   
  ra8_c6link_event_cb_t  event_cb;    
  ra8_c6link_rx_cb_t     rx_cb;       
  void*                  cb_ctx;      
  uint8_t*               arena;       
  uint32_t               arena_bytes; 
  uint32_t               arena_used;  
  uint32_t               arena_last;  
  uint32_t               next_uid;    
  ra8_c6link_wait_t      wait;        
  ra8_c6link_fault_t     fault;       
  ra8_c6link_stats_t*    stats;       
  /* tx_len/tx_if/open/boot_seen sit AFTER the two DMA-aligned frame buffers
     and mdl_request, not beside the other bookkeeping fields above: the
     bookkeeping ahead of `tx` already sums to an exact multiple of
     k_ra8_c6link_dma_align, so `tx` needs no compiler-inserted padding to
     reach its alignment boundary. Moving these four scalars back up
     reintroduces 64 bytes of padding (verified via sizeof/offsetof) and
     trips clang-analyzer-optin.performance.Padding. */
  alignas(k_ra8_c6link_dma_align) uint8_t tx[k_ra8_c6link_frame_bytes];
  alignas(k_ra8_c6link_dma_align) uint8_t rx[k_ra8_c6link_frame_bytes];
  uint8_t mdl_request[k_ra8_mdl_request_bytes_max];
  uint16_t tx_len;    
  uint8_t  tx_if;     
  bool     open;      
  bool     boot_seen; 
} ra8_c6link_t;

[[nodiscard]] ra8_err_t ra8_c6link_open(ra8_c6link_t* link, const ra8_c6link_cfg_t* cfg);

[[nodiscard]] ra8_err_t ra8_c6link_close(ra8_c6link_t* link);

[[nodiscard]] bool ra8_c6link_is_open(const ra8_c6link_t* link);

[[nodiscard]] ra8_err_t
ra8_c6link_poll(ra8_c6link_t* link, uint16_t max_transactions, ra8_c6link_stats_t* stats);

[[nodiscard]] ra8_err_t
ra8_c6link_await_ready(ra8_c6link_t* link, uint16_t max_transactions, ra8_c6link_fw_version_t* out);

[[nodiscard]] ra8_err_t ra8_c6link_fw_version(ra8_c6link_t* link, ra8_c6link_fw_version_t* out);

[[nodiscard]] ra8_err_t ra8_c6link_eth_send(ra8_c6link_t* link, const uint8_t* frame, uint16_t len);

[[nodiscard]] ra8_err_t ra8_c6link_last_fault(const ra8_c6link_t* link, ra8_c6link_fault_t* out);
 
#ifdef __cplusplus
}
#endif