ep.h

Go to the documentation of this file.

 
#pragma once
 
#include <stdint.h>
#include <stdbool.h>
 
#include <osmocom/trx/trxc.h>
#include <osmocom/trx/trxd.h>
 
struct osmo_trx_ep;
 
enum osmo_trx_ep_mode {
        OSMO_TRX_EP_MODE_L1,
        OSMO_TRX_EP_MODE_TRX,
};
 
/* Decoded RX handlers: to avoid indirect calls on the hot path, these are
 * plain function prototypes the API user implements (link-time binding,
 * like bts_model_*() in osmo-bts), not function pointers.  The library
 * provides weak default stubs (logging an error), so an application only
 * needs to implement the handlers for the directions it consumes. */
 
extern void osmo_trx_ep_rx_clck_ind(struct osmo_trx_ep *ep, uint32_t fn);
 
extern void osmo_trx_ep_rx_ctrl_msg(struct osmo_trx_ep *ep, unsigned int chan,
                                    const struct osmo_trxc_msg *msg);
 
extern void osmo_trx_ep_rx_burst_ind(struct osmo_trx_ep *ep, unsigned int chan,
                                     const struct osmo_trxd_burst_ind *bi);
 
extern void osmo_trx_ep_rx_burst_req(struct osmo_trx_ep *ep, unsigned int chan,
                                     const struct osmo_trxd_burst_req *br);
 
struct osmo_trx_ep *osmo_trx_ep_alloc(void *ctx, unsigned int num_chans);
int osmo_trx_ep_open(struct osmo_trx_ep *ep);
void osmo_trx_ep_close(struct osmo_trx_ep *ep);
void osmo_trx_ep_free(struct osmo_trx_ep *ep);
bool osmo_trx_ep_is_open(const struct osmo_trx_ep *ep);
bool osmo_trx_ep_is_closing(const struct osmo_trx_ep *ep);
 
typedef void (*osmo_trx_ep_closed_cb_t)(struct osmo_trx_ep *ep);
void osmo_trx_ep_set_closed_cb(struct osmo_trx_ep *ep, osmo_trx_ep_closed_cb_t closed_cb);
 
void osmo_trx_ep_set_priv(struct osmo_trx_ep *ep, void *priv);
void *osmo_trx_ep_get_priv(const struct osmo_trx_ep *ep);
int osmo_trx_ep_set_name(struct osmo_trx_ep *ep, const char *fmt, ...);
const char *osmo_trx_ep_get_name(const struct osmo_trx_ep *ep);
void osmo_trx_ep_set_log_cat(struct osmo_trx_ep *ep, int log_cat);
int osmo_trx_ep_set_num_chans(struct osmo_trx_ep *ep, unsigned int num_chans);
unsigned int osmo_trx_ep_get_num_chans(const struct osmo_trx_ep *ep);
 
int osmo_trx_ep_set_mode(struct osmo_trx_ep *ep, enum osmo_trx_ep_mode mode);
enum osmo_trx_ep_mode osmo_trx_ep_get_mode(const struct osmo_trx_ep *ep);
 
int osmo_trx_ep_set_laddr(struct osmo_trx_ep *ep, const char *addr);
const char *osmo_trx_ep_get_laddr(const struct osmo_trx_ep *ep);
int osmo_trx_ep_set_raddr(struct osmo_trx_ep *ep, const char *addr);
const char *osmo_trx_ep_get_raddr(const struct osmo_trx_ep *ep);
 
int osmo_trx_ep_set_base_port(struct osmo_trx_ep *ep, uint16_t base_port);
uint16_t osmo_trx_ep_get_base_port(const struct osmo_trx_ep *ep);
 
int osmo_trx_ep_set_clock_socket(struct osmo_trx_ep *ep, bool enable);
bool osmo_trx_ep_get_clock_socket(const struct osmo_trx_ep *ep);
 
int osmo_trx_ep_set_ctrl_promisc(struct osmo_trx_ep *ep, bool enable);
bool osmo_trx_ep_get_ctrl_promisc(const struct osmo_trx_ep *ep);
 
void osmo_trx_ep_set_pdu_batch(struct osmo_trx_ep *ep, bool enable);
bool osmo_trx_ep_get_pdu_batch(const struct osmo_trx_ep *ep);
 
int osmo_trx_ep_set_pdu_ver(struct osmo_trx_ep *ep, unsigned int chan, uint8_t ver);
int osmo_trx_ep_get_pdu_ver(const struct osmo_trx_ep *ep, unsigned int chan);
 
/* TX paths (encode + transmit) */
int osmo_trx_ep_send_clck_ind(struct osmo_trx_ep *ep, uint32_t fn);
int osmo_trx_ep_send_ctrl_msg(struct osmo_trx_ep *ep, unsigned int chan,
                              const struct osmo_trxc_msg *msg);
int osmo_trx_ep_send_burst_ind(struct osmo_trx_ep *ep, unsigned int chan,
                               const struct osmo_trxd_burst_ind *bi);
int osmo_trx_ep_send_burst_req(struct osmo_trx_ep *ep, unsigned int chan,
                               const struct osmo_trxd_burst_req *br);
int osmo_trx_ep_send_burst_fin(struct osmo_trx_ep *ep, unsigned int chan);