ra8_c6link_internal.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stddef.h>
#include <stdint.h>
 
#include "ra8_attributes.h"
#include "ra8_c6link.h"
#include "ra8_err.h"
 
/* Vendored esp-hosted: the packed payload header, the interface enumeration,
   the transport constants and the generated protobuf codec. Nothing else from
   the vendor tree is reachable from this library. */
#include "esp_hosted_header.h"
#include "esp_hosted_interface.h"
#include "esp_hosted_rpc.pb-c.h"
#include "esp_hosted_transport.h"
#include "protobuf-c/protobuf-c.h"

typedef enum : uint8_t {
  k_ra8_c6link_frame_data = 0U,
  k_ra8_c6link_frame_idle = 1U,
  k_ra8_c6link_frame_malformed = 2U,
  k_ra8_c6link_frame_bad_checksum = 3U,
} ra8_c6link_frame_class_t;

typedef struct ra8_c6link_rx_view {
  uint16_t offset;  
  uint16_t len;     
  uint8_t  if_type; 
  uint8_t  if_num;  
} ra8_c6link_rx_view_t;
 
/* ==========================================================================
 * ra8_c6link_arena.c -- the fixed decode arena behind the protobuf codec
 * ==========================================================================
 */

RA8_PRIV void* priv_c6link_arena_alloc(void* ctx, size_t size);

RA8_PRIV void priv_c6link_arena_free(void* ctx, void* pointer);

RA8_PRIV void priv_c6link_arena_reset(ra8_c6link_t* link);

RA8_PRIV void priv_c6link_arena_bind(ProtobufCAllocator* out, ra8_c6link_t* link);
 
/* ==========================================================================
 * ra8_c6link_frame.c -- the twelve-byte payload header
 * ==========================================================================
 */

RA8_PRIV void priv_c6link_frame_filler(uint8_t* tx);

RA8_PRIV void priv_c6link_frame_seal(uint8_t* tx, uint8_t if_type, uint8_t if_num, uint16_t len);

[[nodiscard]] RA8_PRIV ra8_c6link_frame_class_t
priv_c6link_frame_classify(uint8_t* rx, ra8_c6link_rx_view_t* view);

typedef enum : uint8_t {
  k_ra8_c6link_caps_type      = 0U, 
  k_ra8_c6link_caps_len       = 1U, 
  k_ra8_c6link_caps_hdr       = 2U, 
  k_ra8_c6link_caps_tags      = 5U, 
  k_ra8_c6link_caps_value_len = 1U, 
  k_ra8_c6link_caps_stride    = 3U, 
  k_ra8_c6link_caps_bytes     = 17U,
  k_ra8_c6link_caps_host = 0U,
  k_ra8_c6link_caps_chip = 0x0DU,
  k_ra8_c6link_caps_raw_tp = 0U,
  k_ra8_c6link_caps_throttle_high = 80U,
  k_ra8_c6link_caps_throttle_low = 60U,
} ra8_c6link_caps_t;

[[nodiscard]] RA8_PRIV uint8_t priv_c6link_caps(uint8_t* out, uint8_t cap);
 
/* ==========================================================================
 * ra8_c6link_tlv.c -- the serial endpoint's two-tag envelope
 * ==========================================================================
 */

typedef enum : uint16_t {
  k_ra8_c6link_tlv_t_epname = 0x01U, 
  k_ra8_c6link_tlv_t_data   = 0x02U, 
  k_ra8_c6link_tlv_type     = 0U,    
  k_ra8_c6link_tlv_len_lo   = 1U,    
  k_ra8_c6link_tlv_len_hi   = 2U,    
  k_ra8_c6link_tlv_value    = 3U,    
  k_ra8_c6link_tlv_ep_len   = (uint16_t)(sizeof(RPC_EP_NAME_RSP) - 1U),
  k_ra8_c6link_tlv_overhead =
    (uint16_t)((uint16_t)k_ra8_c6link_tlv_value + (uint16_t)(sizeof(RPC_EP_NAME_RSP) - 1U) +
               (uint16_t)k_ra8_c6link_tlv_value),
  k_ra8_c6link_tlv_shift = 8U,    
  k_ra8_c6link_tlv_mask  = 0xFFU, 
} ra8_c6link_tlv_t;

[[nodiscard]] RA8_PRIV ra8_err_t priv_c6link_tlv_open(uint8_t*  out,
                                                      uint16_t  cap,
                                                      uint16_t  proto_len,
                                                      uint16_t* body_at);

[[nodiscard]] RA8_PRIV const uint8_t*
priv_c6link_tlv_body(const uint8_t* payload, uint16_t len, uint16_t* proto_len);
 
/* ==========================================================================
 * ra8_c6link_rpc.c -- request, response, correlation
 * ==========================================================================
 */

typedef struct ra8_c6link_take_ctx {
  ra8_c6link_t* link;   
  void*         out;    
  uint32_t      rpc_id; 
} ra8_c6link_take_ctx_t;

[[nodiscard]] RA8_PRIV ra8_err_t priv_c6link_take_resp(void* ctx, const void* msg_v);

[[nodiscard]] RA8_PRIV ra8_err_t priv_c6link_bare_req(ra8_c6link_t* link, uint32_t req_id);

[[nodiscard]] RA8_PRIV ra8_err_t priv_c6link_rpc_call(ra8_c6link_t*        link,
                                                      Rpc*                 req,
                                                      uint32_t             resp_id,
                                                      ra8_c6link_take_fn_t take,
                                                      void*                take_ctx);

[[nodiscard]] RA8_PRIV bool
priv_c6link_rpc_consume(ra8_c6link_t* link, const uint8_t* payload, uint16_t len);

[[nodiscard]] RA8_PRIV ra8_err_t priv_c6link_resp(ra8_c6link_t* link,
                                                  uint32_t      rpc_id,
                                                  int32_t       resp);
 
/* ==========================================================================
 * ra8_c6link_pump.c -- the transaction loop
 * ==========================================================================
 */

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

[[nodiscard]] RA8_PRIV bool priv_c6link_dispatch(ra8_c6link_t*               link,
                                                 const ra8_c6link_rx_view_t* view);

RA8_PRIV void priv_c6link_emit(ra8_c6link_t* link, const ra8_c6link_event_t* ev);

RA8_PRIV uint8_t priv_c6link_copy_str(char* dst, uint8_t cap, const ProtobufCBinaryData* src);

[[nodiscard]] RA8_PRIV bool priv_c6link_copy_mac(ra8_c6link_mac_t*          dst,
                                                 const ProtobufCBinaryData* src);
 
#ifdef __cplusplus
}
#endif