arq_modem.h

Go to the documentation of this file.

/* HERMES Modem — ARQ Modem interface: action queue and PTT callbacks
 *
 * Copyright (C) 2025 Rhizomatica
 * Author: Rafael Diniz <rafael@riseup.net>
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 */
 
#ifndef ARQ_MODEM_H_
#define ARQ_MODEM_H_
 
#include <stdbool.h>
#include <stddef.h>
 
#include "arq.h"      /* arq_action_t, arq_action_type_t */
#include "arq_fsm.h"  /* arq_session_t                   */
 
/* ======================================================================
 * Action queue (replaces arq_action_queue in old arq.c)
 *
 * The FSM enqueues TX actions; the modem worker dequeues them.
 * Thread-safe: enqueue from event-loop thread, dequeue from modem thread.
 * ====================================================================== */
 
int  arq_modem_queue_init(size_t capacity);
 
void arq_modem_queue_shutdown(void);
 
int  arq_modem_enqueue(const arq_action_t *action);
 
bool arq_modem_dequeue(arq_action_t *action, int timeout_ms);
 
/* ======================================================================
 * PTT notifications (modem → ARQ)
 *
 * Called from the modem TX worker when PTT changes state.
 * These generate ARQ_EV_TX_STARTED / ARQ_EV_TX_COMPLETE events and
 * trigger the timing recorder.
 * ====================================================================== */
 
void arq_modem_set_event_fn(void (*fn)(int mode, bool ptt_on));
 
void arq_modem_set_channel_busy_fn(bool (*fn)(void));
 
bool arq_modem_channel_busy(void);
 
void arq_modem_set_crc_seed_fn(void (*fn)(uint16_t seed));
void arq_modem_crc_seed(uint16_t seed);
 
void arq_modem_ptt_on(int mode, size_t frame_size);
 
void arq_modem_ptt_off(void);
 
/* ======================================================================
 * Mode selection helpers
 *
 * Used by the modem worker to query preferred RX/TX modes.
 * Delegated to arq_modem.c so mode-selection logic is co-located with
 * the rest of the modem interface.
 * ====================================================================== */
 
int arq_modem_preferred_rx_mode(const arq_session_t *sess);
 
int arq_modem_preferred_tx_mode(const arq_session_t *sess);
 
#endif /* ARQ_MODEM_H_ */