hf_co_driver.h

Go to the documentation of this file.

 
#ifndef HF_CO_DRIVER_H
#define HF_CO_DRIVER_H
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ── Build configuration (override with -D) ─────────────────────────────── */
 
#ifndef HF_CO_CAN_MAX_LEN
#if defined(HF_CO_CAN_FD) && HF_CO_CAN_FD
#define HF_CO_CAN_MAX_LEN 64U
#else
#define HF_CO_CAN_MAX_LEN 8U
#endif
#endif
 
#ifndef HF_CO_MAX_PORTS
#define HF_CO_MAX_PORTS 4U
#endif
 
#ifndef HF_CO_RX_RING_LEN
#define HF_CO_RX_RING_LEN 64U
#endif
 
#ifndef HF_CO_MAX_DRIVERS
#define HF_CO_MAX_DRIVERS 2U
#endif
 
#ifndef HF_CO_BUSOFF_RETRY_CALLS
#define HF_CO_BUSOFF_RETRY_CALLS 100U
#endif
 
#if (HF_CO_RX_RING_LEN & (HF_CO_RX_RING_LEN - 1U)) != 0U
#error "HF_CO_RX_RING_LEN must be a power of two"
#endif
#if HF_CO_MAX_PORTS > 8U
#error "HF_CO_MAX_PORTS is limited to 8 (one pending bit per port in a uint8_t)"
#endif
 
/* ── Frame ──────────────────────────────────────────────────────────────── */
 
#define HF_CO_FRAME_MAX_LEN 64U
 
#define HF_CO_FRAME_EXT 0x01U 
#define HF_CO_FRAME_RTR 0x02U 
#define HF_CO_FRAME_FDF 0x04U 
#define HF_CO_FRAME_BRS 0x08U 
#define HF_CO_FRAME_ESI 0x10U 
typedef struct hf_co_frame {
  uint32_t id;                        
  uint8_t len;                        
  uint8_t flags;                      
  uint8_t data[HF_CO_FRAME_MAX_LEN];  
  uint32_t ts_us;                     
} hf_co_frame_t;
 
/* ── Port ───────────────────────────────────────────────────────────────── */
 
typedef enum hf_co_tx_result {
  HF_CO_TX_OK = 0,          
  HF_CO_TX_QUEUE_FULL = 1,  
  HF_CO_TX_BUS_OFF = 2,     
  HF_CO_TX_NOT_ALLOWED = 3, 
} hf_co_tx_result_t;
 
typedef enum hf_co_bus_state {
  HF_CO_BUS_STOPPED = 0,
  HF_CO_BUS_ERROR_ACTIVE = 1,
  HF_CO_BUS_ERROR_WARNING = 2,
  HF_CO_BUS_ERROR_PASSIVE = 3,
  HF_CO_BUS_OFF = 4,
} hf_co_bus_state_t;
 
typedef struct hf_co_port_status {
  uint8_t state;           
  uint16_t tec;            
  uint16_t rec;            
  uint32_t rx_overruns;    
  uint32_t tx_queue_full;  
  uint32_t bus_off_count;  
} hf_co_port_status_t;
 
typedef struct hf_co_port_ops {
  hf_co_tx_result_t (*send)(void* ctx, const hf_co_frame_t* frame);
  bool (*status)(void* ctx, hf_co_port_status_t* out);
  bool (*recover)(void* ctx);
} hf_co_port_ops_t;
 
#define HF_CO_PORT_ERROR_SOURCE 0x01U
 
typedef struct hf_co_port_stats {
  uint32_t rx_frames;         
  uint32_t rx_ring_overruns;  
  uint32_t rx_rejected;       
  uint32_t rx_dispatched;     
  uint32_t rx_unhandled;      
  uint32_t rx_denied;         
  uint32_t tx_frames;         
  uint32_t tx_queue_full;     
  uint32_t tx_retried;        
  uint32_t tx_dropped;        
  uint32_t tx_denied;         
  uint32_t recover_requests;  
} hf_co_port_stats_t;
 
/* ── Policy and wake hooks ──────────────────────────────────────────────── */
 
typedef bool (*hf_co_rx_policy_fn)(void* ctx, uint8_t port, uint16_t rx_index, const void* consumer,
                                   const hf_co_frame_t* frame);
typedef bool (*hf_co_tx_policy_fn)(void* ctx, uint8_t port, uint16_t tx_index, const hf_co_frame_t* frame);
typedef void (*hf_co_wake_fn)(void* ctx);
 
/* ── Driver instance ────────────────────────────────────────────────────── */
 
typedef struct hf_co_driver hf_co_driver_t;
 
hf_co_driver_t* hf_co_driver_acquire(void);
void hf_co_driver_release(hf_co_driver_t* drv);
 
bool hf_co_driver_attach_port(hf_co_driver_t* drv, uint8_t index, const hf_co_port_ops_t* ops, void* ctx,
                              uint8_t max_len, uint8_t flags);
void hf_co_driver_detach_port(hf_co_driver_t* drv, uint8_t index);
 
void hf_co_driver_set_policy(hf_co_driver_t* drv, hf_co_rx_policy_fn rx, hf_co_tx_policy_fn tx, void* ctx);
void hf_co_driver_set_wake(hf_co_driver_t* drv, hf_co_wake_fn wake, void* ctx);
 
bool hf_co_driver_rx_push(hf_co_driver_t* drv, uint8_t port, const hf_co_frame_t* frame);
 
bool hf_co_driver_rx_offer(hf_co_driver_t* drv, uint8_t port, const hf_co_frame_t* frame);
 
void hf_co_driver_tx_done(hf_co_driver_t* drv, uint8_t port);
 
uint32_t hf_co_driver_rx_drain(hf_co_driver_t* drv, uint32_t max);
 
uint32_t hf_co_driver_rx_pending(const hf_co_driver_t* drv);
uint32_t hf_co_driver_tx_pending(const hf_co_driver_t* drv);
 
void hf_co_driver_get_stats(const hf_co_driver_t* drv, uint8_t port, hf_co_port_stats_t* out);
 
#ifdef __cplusplus
}
#endif
 
#endif /* HF_CO_DRIVER_H */