#include "arq.h"
#include "arq_fsm.h"
#include "arq_protocol.h"
#include "arq_timing.h"
#include "arq_modem.h"
#include "arq_channels.h"
#include "fsm.h"
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <stdio.h>
#include <string.h>
#include <pthread.h>
#include <stdlib.h>
#include <time.h>
#include <errno.h>
#include <limits.h>
#include <stdatomic.h>
#include "../common/hermes_log.h"
#include "../common/defines_modem.h"
#include "../common/ring_buffer_posix.h"
#include "../data_interfaces/tcp_interfaces.h"
#include "../modem/framer.h"
#include "../modem/freedv/freedv_api.h"

Include dependency graph for arq.c:

Macros
#define	LOG_COMP "arq"

#define	APP_TX_BUF_SIZE (64 * 1024)

#define	ARQ_EV_QUEUE_CAP 64

Functions
void	tnc_send_pending (void)

void	tnc_send_cancelpending (void)

void	tnc_send_connected (void)

void	tnc_send_cqframe (const char *source_call, int bw_hz)

void	tnc_send_disconnected (void)

void	tnc_send_buffer (uint32_t bytes)

void	init_model (void)

static void	evq_push (const arq_event_t *ev)

static bool	evq_pop_locked (arq_event_t *ev)

static void	ptt_event_inject (int mode, bool ptt_on)

static void	cb_send_tx_frame (int packet_type, int mode, size_t frame_size, const uint8_t *frame)

static void	cb_notify_connected (const char *remote_call)

static void	cb_notify_pending (const char *remote_call)

static void	cb_notify_cancelpending (void)

static void	cb_notify_disconnected (bool to_no_client)

static void	cb_deliver_rx_data (const uint8_t *data, size_t len)

static int	cb_tx_backlog (void)

static int	cb_tx_read (uint8_t *buf, size_t len)

static void	cb_send_buffer_status (int backlog_bytes)

static int	normalize_bandwidth_hz (int bw_hz)

static int	active_session_bandwidth_hz (void)

int	arq_effective_bandwidth_hz (void)
	Get the effective ARQ bandwidth cap in Hz used for mode gating.

int	arq_reported_bandwidth_hz (void)
	Get the configured ARQ bandwidth token to report to VARA clients.

bool	arq_bandwidth_allows_mode (int mode)
	Check whether the current ARQ bandwidth cap allows a modem mode.

static void	handle_cmd (const arq_cmd_msg_t *msg)

static void *	arq_cmd_bridge_worker (void *arg)

static void *	arq_payload_bridge_worker (void *arg)

static void *	arq_event_loop_worker (void *arg)

bool	arq_handle_incoming_connect_frame (uint8_t *data, size_t frame_size)
	Handle incoming compressed CALL/ACCEPT frame.

bool	arq_handle_incoming_cq_frame (uint8_t *data, size_t frame_size)
	Handle incoming compact CQ frame and emit host-side CQFRAME notification.

void	arq_notify_cq_tx_started (void)
	Emit VARA-style async status for an outgoing CQFRAME transmission.

void	arq_notify_cq_tx_complete (void)

void	arq_handle_incoming_frame (uint8_t *data, size_t frame_size, float rx_snr)
	Handle incoming regular ARQ control/data frame.

int	arq_init (size_t frame_size, int mode)
	Initialize ARQ subsystem.

void	arq_shutdown (void)
	Shut down ARQ workers and release ARQ resources.

void	arq_tick_1hz (void)
	Execute 1 Hz ARQ maintenance tick.

void	arq_post_event (int event)
	Post an FSM event to ARQ.

bool	arq_is_link_connected (void)
	Check whether ARQ link is connected.

int	arq_queue_data (const uint8_t *data, size_t len)
	Queue outbound payload bytes for ARQ transmission.

int	arq_get_tx_backlog_bytes (void)
	Get pending outbound payload backlog.

int	arq_get_speed_level (void)
	Get current ARQ speed level (gear).

int	arq_get_payload_mode (void)
	Get active ARQ payload mode.

int	arq_get_control_mode (void)
	Get active ARQ control mode.

int	arq_get_preferred_rx_mode (void)
	Get ARQ-preferred receive mode for modem.

int	arq_get_preferred_tx_mode (void)
	Get ARQ-preferred transmit mode for modem.

void	arq_set_active_modem_mode (int mode, size_t frame_size)
	Inform ARQ of modem mode/frame size actually active in modem.

void	arq_update_link_metrics (int sync, float snr, int rx_status, bool frame_decoded)
	Feed decoder/link metrics into ARQ adaptation.

bool	arq_try_dequeue_action (arq_action_t *action)
	Try to dequeue next modem action without blocking.

bool	arq_wait_dequeue_action (arq_action_t *action, int timeout_ms)
	Wait for next modem action.

bool	arq_get_runtime_snapshot (arq_runtime_snapshot_t *snapshot)
	Copy ARQ runtime snapshot.

int	arq_submit_tcp_cmd (const arq_cmd_msg_t *cmd)
	Submit parsed control command from TCP bridge to ARQ.

int	arq_submit_tcp_payload (const uint8_t *data, size_t len)
	Submit payload bytes from TCP bridge to ARQ.

void	clear_connection_data (void)
	Clear legacy ARQ connection state and buffers.

void	arq_set_retry_slots (int slots)
	Set runtime retry slot counts.

void	reset_arq_info (arq_info *conn)
	Reset external arq_info structure.

void	call_remote (void)
	Trigger outgoing call attempt using current ARQ addresses.

void	callee_accept_connection (void)
	Trigger callee-side accept flow in compatibility path.

Variables
arq_info	arq_conn

fsm_handle	arq_fsm

cbuf_handle_t	data_tx_buffer_arq

cbuf_handle_t	data_tx_buffer_arq_control

cbuf_handle_t	data_rx_buffer_arq

static arq_session_t	g_sess

static arq_timing_ctx_t	g_timing

static uint8_t	g_app_tx_storage [APP_TX_BUF_SIZE]

static cbuf_handle_t	g_app_tx_buf

static pthread_mutex_t	g_app_tx_mtx = PTHREAD_MUTEX_INITIALIZER

static arq_event_t	g_evq [ARQ_EV_QUEUE_CAP]

static size_t	g_evq_head

static size_t	g_evq_tail

static size_t	g_evq_count

static pthread_mutex_t	g_evq_lock = PTHREAD_MUTEX_INITIALIZER

static pthread_cond_t	g_evq_cond = PTHREAD_COND_INITIALIZER

static arq_channel_bus_t	g_bus

static pthread_t	g_loop_tid

static pthread_t	g_cmd_tid

static pthread_t	g_payload_tid

static volatile bool	g_running

static volatile bool	g_initialized

Macro Definition Documentation

◆ APP_TX_BUF_SIZE

#define APP_TX_BUF_SIZE (64 * 1024)

◆ ARQ_EV_QUEUE_CAP

#define ARQ_EV_QUEUE_CAP 64

◆ LOG_COMP

#define LOG_COMP "arq"

Function Documentation

◆ active_session_bandwidth_hz()

static int active_session_bandwidth_hz ( void )

static

◆ arq_bandwidth_allows_mode()

bool arq_bandwidth_allows_mode ( int mode )

Check whether the current ARQ bandwidth cap allows a modem mode.

Parameters

mode	FreeDV mode value.

Returns: true if the mode is allowed under the active BW setting.

◆ arq_cmd_bridge_worker()

static void * arq_cmd_bridge_worker ( void * arg )

static

◆ arq_effective_bandwidth_hz()

int arq_effective_bandwidth_hz ( void )

Get the effective ARQ bandwidth cap in Hz used for mode gating.

Returns: 500 for narrow-band mode, otherwise 2300.

◆ arq_event_loop_worker()

static void * arq_event_loop_worker ( void * arg )

static

◆ arq_get_control_mode()

int arq_get_control_mode ( void )

Get active ARQ control mode.

Returns: FreeDV control mode value.

◆ arq_get_payload_mode()

int arq_get_payload_mode ( void )

Get active ARQ payload mode.

Returns: FreeDV payload mode value.

◆ arq_get_preferred_rx_mode()

int arq_get_preferred_rx_mode ( void )

Get ARQ-preferred receive mode for modem.

Returns: FreeDV mode value.

◆ arq_get_preferred_tx_mode()

int arq_get_preferred_tx_mode ( void )

Get ARQ-preferred transmit mode for modem.

Returns: FreeDV mode value.

◆ arq_get_runtime_snapshot()

bool arq_get_runtime_snapshot ( arq_runtime_snapshot_t * snapshot )

Copy ARQ runtime snapshot.

Parameters

snapshot Output snapshot pointer.

Returns: true when snapshot contains initialized state.

◆ arq_get_speed_level()

int arq_get_speed_level ( void )

Get current ARQ speed level (gear).

Returns: Speed level index.

◆ arq_get_tx_backlog_bytes()

int arq_get_tx_backlog_bytes ( void )

Get pending outbound payload backlog.

Returns: Backlog size in bytes.

◆ arq_handle_incoming_connect_frame()

bool arq_handle_incoming_connect_frame	(	uint8_t *	data,
		size_t	frame_size
	)

Handle incoming compressed CALL/ACCEPT frame.

Parameters

data	Frame bytes.
frame_size	Frame length in bytes.

Returns: true if frame was handled by ARQ connect path.

◆ arq_handle_incoming_cq_frame()

bool arq_handle_incoming_cq_frame	(	uint8_t *	data,
		size_t	frame_size
	)

Handle incoming compact CQ frame and emit host-side CQFRAME notification.

Parameters

data	Incoming frame bytes.
frame_size	Frame length in bytes.

Returns: true if frame was handled by CQ path.

◆ arq_handle_incoming_frame()

void arq_handle_incoming_frame	(	uint8_t *	data,
		size_t	frame_size,
		float	rx_snr
	)

Handle incoming regular ARQ control/data frame.

Parameters

data	Frame bytes.
frame_size	Frame length in bytes.
rx_snr	Local receive SNR at decode time (dB); 0.0 = unknown.

◆ arq_init()

int arq_init	(	size_t	frame_size,
		int	mode
	)

Initialize ARQ subsystem.

Parameters

frame_size	Active modem frame size in bytes.
mode	Initial modem mode.

Returns: 0 on success, non-zero on failure.

◆ arq_is_link_connected()

bool arq_is_link_connected ( void )

Check whether ARQ link is connected.

Returns: true when connected; otherwise false.

◆ arq_notify_cq_tx_complete()

void arq_notify_cq_tx_complete ( void )

◆ arq_notify_cq_tx_started()

void arq_notify_cq_tx_started ( void )

Emit VARA-style async status for an outgoing CQFRAME transmission.

VARA clients such as varim treat CQFRAME as a pending operation and expect PENDING/CANCELPENDING around the actual send lifecycle.

◆ arq_payload_bridge_worker()

static void * arq_payload_bridge_worker ( void * arg )

static

◆ arq_post_event()

void arq_post_event ( int event )

Post an FSM event to ARQ.

Parameters

event Event identifier from fsm.h.

◆ arq_queue_data()

int arq_queue_data	(	const uint8_t *	data,
		size_t	len
	)

Queue outbound payload bytes for ARQ transmission.

Parameters

data	Pointer to payload bytes.
len	Number of bytes to queue.

Returns: Number of bytes queued, or negative on error.

◆ arq_reported_bandwidth_hz()

int arq_reported_bandwidth_hz ( void )

Get the configured ARQ bandwidth token to report to VARA clients.

Returns: 500, 2300, or 2750 when configured; otherwise 2300.

◆ arq_set_active_modem_mode()

void arq_set_active_modem_mode	(	int	mode,
		size_t	frame_size
	)

Inform ARQ of modem mode/frame size actually active in modem.

Parameters

mode	Active FreeDV mode.
frame_size	Active frame size in bytes.

◆ arq_set_retry_slots()

void arq_set_retry_slots ( int slots )

Set runtime retry slot counts.

Updates CALL, ACCEPT, and DATA retry counters used by the ARQ FSM. DISCONNECT retries are left at the compiled default. Pass 0 to restore all counters to compiled defaults.

Parameters

slots Number of retry slots, or 0 to restore defaults.

◆ arq_shutdown()

void arq_shutdown ( void )

Shut down ARQ workers and release ARQ resources.

◆ arq_submit_tcp_cmd()

int arq_submit_tcp_cmd ( const arq_cmd_msg_t * cmd )

Submit parsed control command from TCP bridge to ARQ.

Parameters

cmd	Command message.

Returns: 0 on success, negative on queue/error.

◆ arq_submit_tcp_payload()

int arq_submit_tcp_payload	(	const uint8_t *	data,
		size_t	len
	)

Submit payload bytes from TCP bridge to ARQ.

Parameters

data	Payload bytes.
len	Payload length in bytes.

Returns: 0 on success, negative on queue/error.

◆ arq_tick_1hz()

void arq_tick_1hz ( void )

Execute 1 Hz ARQ maintenance tick.

◆ arq_try_dequeue_action()

bool arq_try_dequeue_action ( arq_action_t * action )

Try to dequeue next modem action without blocking.

Parameters

action Output action item.

Returns: true if an action was dequeued.

◆ arq_update_link_metrics()

void arq_update_link_metrics	(	int	sync,
		float	snr,
		int	rx_status,
		bool	frame_decoded
	)

Feed decoder/link metrics into ARQ adaptation.

Parameters

sync	Decoder sync flag.
snr	Estimated SNR.
rx_status	Decoder RX status flags.
frame_decoded	True when a frame decoded this cycle.

◆ arq_wait_dequeue_action()

bool arq_wait_dequeue_action	(	arq_action_t *	action,
		int	timeout_ms
	)

Wait for next modem action.

Parameters

action	Output action item.
timeout_ms	Wait timeout in milliseconds.

Returns: true if an action was dequeued.

◆ call_remote()

void call_remote ( void )

Trigger outgoing call attempt using current ARQ addresses.

◆ callee_accept_connection()

void callee_accept_connection ( void )

Trigger callee-side accept flow in compatibility path.

◆ cb_deliver_rx_data()

static void cb_deliver_rx_data	(	const uint8_t *	data,
		size_t	len
	)

static

◆ cb_notify_cancelpending()

static void cb_notify_cancelpending ( void )

static

◆ cb_notify_connected()

static void cb_notify_connected ( const char * remote_call )

static

◆ cb_notify_disconnected()

static void cb_notify_disconnected ( bool to_no_client )

static

◆ cb_notify_pending()

static void cb_notify_pending ( const char * remote_call )

static

◆ cb_send_buffer_status()

static void cb_send_buffer_status ( int backlog_bytes )

static

◆ cb_send_tx_frame()

static void cb_send_tx_frame	(	int	packet_type,
		int	mode,
		size_t	frame_size,
		const uint8_t *	frame
	)

static

◆ cb_tx_backlog()

static int cb_tx_backlog ( void )

static

◆ cb_tx_read()

static int cb_tx_read	(	uint8_t *	buf,
		size_t	len
	)

static

◆ clear_connection_data()

void clear_connection_data ( void )

Clear legacy ARQ connection state and buffers.

◆ evq_pop_locked()

static bool evq_pop_locked ( arq_event_t * ev )

static

◆ evq_push()

static void evq_push ( const arq_event_t * ev )

static

◆ handle_cmd()

static void handle_cmd ( const arq_cmd_msg_t * msg )

static

◆ init_model()

void init_model ( void )

extern

◆ normalize_bandwidth_hz()

static int normalize_bandwidth_hz ( int bw_hz )

static

◆ ptt_event_inject()

static void ptt_event_inject	(	int	mode,
		bool	ptt_on
	)

static

◆ reset_arq_info()

void reset_arq_info ( arq_info * arq_conn )

Reset external arq_info structure.

Parameters

arq_conn Pointer to structure to reset.

◆ tnc_send_buffer()

void tnc_send_buffer ( uint32_t bytes )

extern

◆ tnc_send_cancelpending()

void tnc_send_cancelpending ( void )

extern

◆ tnc_send_connected()

void tnc_send_connected ( void )

extern

◆ tnc_send_cqframe()

void tnc_send_cqframe	(	const char *	source_call,
		int	bw_hz
	)

extern

◆ tnc_send_disconnected()

void tnc_send_disconnected ( void )

extern

◆ tnc_send_pending()

void tnc_send_pending ( void )

extern

Variable Documentation

◆ arq_conn

arq_info arq_conn

◆ arq_fsm

fsm_handle arq_fsm

◆ data_rx_buffer_arq

cbuf_handle_t data_rx_buffer_arq

extern

◆ data_tx_buffer_arq

cbuf_handle_t data_tx_buffer_arq

extern

◆ data_tx_buffer_arq_control

cbuf_handle_t data_tx_buffer_arq_control

extern

◆ g_app_tx_buf

cbuf_handle_t g_app_tx_buf

static

◆ g_app_tx_mtx

pthread_mutex_t g_app_tx_mtx = PTHREAD_MUTEX_INITIALIZER

static

◆ g_app_tx_storage

uint8_t g_app_tx_storage[APP_TX_BUF_SIZE]

static

◆ g_bus

arq_channel_bus_t g_bus

static

◆ g_cmd_tid

pthread_t g_cmd_tid

static

◆ g_evq

arq_event_t g_evq[ARQ_EV_QUEUE_CAP]

static

◆ g_evq_cond

pthread_cond_t g_evq_cond = PTHREAD_COND_INITIALIZER

static

◆ g_evq_count

size_t g_evq_count

static

◆ g_evq_head

size_t g_evq_head

static

◆ g_evq_lock

pthread_mutex_t g_evq_lock = PTHREAD_MUTEX_INITIALIZER

static

◆ g_evq_tail

size_t g_evq_tail

static

◆ g_initialized

volatile bool g_initialized

static

◆ g_loop_tid

pthread_t g_loop_tid

static

◆ g_payload_tid

pthread_t g_payload_tid

static

◆ g_running

volatile bool g_running

static

◆ g_sess

arq_session_t g_sess

static

◆ g_timing

arq_timing_ctx_t g_timing

static

Macros

Functions

Variables

Macro Definition Documentation

◆ APP_TX_BUF_SIZE

◆ ARQ_EV_QUEUE_CAP

◆ LOG_COMP

Function Documentation

◆ active_session_bandwidth_hz()

◆ arq_bandwidth_allows_mode()

◆ arq_cmd_bridge_worker()

◆ arq_effective_bandwidth_hz()

◆ arq_event_loop_worker()

◆ arq_get_control_mode()

◆ arq_get_payload_mode()

◆ arq_get_preferred_rx_mode()

◆ arq_get_preferred_tx_mode()

◆ arq_get_runtime_snapshot()

◆ arq_get_speed_level()

◆ arq_get_tx_backlog_bytes()

◆ arq_handle_incoming_connect_frame()

◆ arq_handle_incoming_cq_frame()

◆ arq_handle_incoming_frame()

◆ arq_init()

◆ arq_is_link_connected()

◆ arq_notify_cq_tx_complete()

◆ arq_notify_cq_tx_started()

◆ arq_payload_bridge_worker()

◆ arq_post_event()

◆ arq_queue_data()

◆ arq_reported_bandwidth_hz()

◆ arq_set_active_modem_mode()

◆ arq_set_retry_slots()

◆ arq_shutdown()

◆ arq_submit_tcp_cmd()

◆ arq_submit_tcp_payload()

◆ arq_tick_1hz()

◆ arq_try_dequeue_action()

◆ arq_update_link_metrics()

◆ arq_wait_dequeue_action()

◆ call_remote()

◆ callee_accept_connection()

◆ cb_deliver_rx_data()

◆ cb_notify_cancelpending()

◆ cb_notify_connected()

◆ cb_notify_disconnected()

◆ cb_notify_pending()

◆ cb_send_buffer_status()

◆ cb_send_tx_frame()

◆ cb_tx_backlog()

◆ cb_tx_read()

◆ clear_connection_data()

◆ evq_pop_locked()

◆ evq_push()

◆ handle_cmd()

◆ init_model()

◆ normalize_bandwidth_hz()

◆ ptt_event_inject()

◆ reset_arq_info()

◆ tnc_send_buffer()

◆ tnc_send_cancelpending()

◆ tnc_send_connected()

◆ tnc_send_cqframe()

◆ tnc_send_disconnected()

◆ tnc_send_pending()

Variable Documentation

◆ arq_conn

◆ arq_fsm

◆ data_rx_buffer_arq

◆ data_tx_buffer_arq

◆ data_tx_buffer_arq_control

◆ g_app_tx_buf

◆ g_app_tx_mtx

◆ g_app_tx_storage

◆ g_bus

◆ g_cmd_tid

◆ g_evq

◆ g_evq_cond

◆ g_evq_count

◆ g_evq_head