trxc.h

Go to the documentation of this file.

 
#pragma once
 
#include <stdint.h>
#include <stddef.h>
#include <stdbool.h>
 
#include <osmocom/core/utils.h>
 
#define OSMO_TRXC_CMD_LEN_MAX           32
#define OSMO_TRXC_MSG_BUF_SIZE          1500
#define OSMO_TRXC_PARAMS_LEN_MAX        (OSMO_TRXC_MSG_BUF_SIZE - OSMO_TRXC_CMD_LEN_MAX - 32)
 
enum osmo_trxc_msg_type {
        OSMO_TRXC_MT_CMD,       
        OSMO_TRXC_MT_RSP,       
        OSMO_TRXC_MT_IND,       
};
 
struct osmo_trxc_msg {
        enum osmo_trxc_msg_type type;
        char cmd[OSMO_TRXC_CMD_LEN_MAX];        
        int status;                             
        char params[OSMO_TRXC_PARAMS_LEN_MAX];  
};
 
int osmo_trxc_msg_parse(struct osmo_trxc_msg *msg, const char *buf, size_t len);
int osmo_trxc_msg_build(char *buf, size_t buf_size, const struct osmo_trxc_msg *msg);
int osmo_trxc_msg_params_scan(const struct osmo_trxc_msg *msg, const char *fmt, ...);
 
const char *osmo_trxc_msg_name(const struct osmo_trxc_msg *msg);
char *osmo_trxc_msg_name_buf(char *buf, size_t buf_size,
                             const struct osmo_trxc_msg *msg);
 
/* Well-known command verbs (the codec itself is verb-agnostic) */
#define OSMO_TRXC_CMD_POWERON           "POWERON"
#define OSMO_TRXC_CMD_POWEROFF          "POWEROFF"
#define OSMO_TRXC_CMD_RXTUNE            "RXTUNE"
#define OSMO_TRXC_CMD_TXTUNE            "TXTUNE"
#define OSMO_TRXC_CMD_SETSLOT           "SETSLOT"
#define OSMO_TRXC_CMD_SETTSC            "SETTSC"
#define OSMO_TRXC_CMD_SETBSIC           "SETBSIC"
#define OSMO_TRXC_CMD_SETPOWER          "SETPOWER"
#define OSMO_TRXC_CMD_ADJPOWER          "ADJPOWER"
#define OSMO_TRXC_CMD_NOMTXPOWER        "NOMTXPOWER"
#define OSMO_TRXC_CMD_SETRXGAIN         "SETRXGAIN"
#define OSMO_TRXC_CMD_SETMAXDLY         "SETMAXDLY"
#define OSMO_TRXC_CMD_SETMAXDLYNB       "SETMAXDLYNB"
#define OSMO_TRXC_CMD_SETFORMAT         "SETFORMAT"
#define OSMO_TRXC_CMD_HANDOVER          "HANDOVER"
#define OSMO_TRXC_CMD_NOHANDOVER        "NOHANDOVER"
#define OSMO_TRXC_CMD_RFMUTE            "RFMUTE"
#define OSMO_TRXC_CMD_NOISELEV          "NOISELEV"
#define OSMO_TRXC_CMD_SETFH             "SETFH"
#define OSMO_TRXC_CMD_ERR               "ERR" 
/* SETSLOT: "<tn> <chan_comb> [C<tsc>/S<tsc_set> ...]" */
 
enum osmo_trxc_chan_comb {
        OSMO_TRXC_CHAN_COMB_UNUSED              = 0, 
        OSMO_TRXC_CHAN_COMB_TCHF                = 1,
        OSMO_TRXC_CHAN_COMB_TCHH_IDLE           = 2, 
        OSMO_TRXC_CHAN_COMB_TCHH                = 3,
        OSMO_TRXC_CHAN_COMB_BCCH                = 4, 
        OSMO_TRXC_CHAN_COMB_BCCH_SDCCH4 = 5, 
        OSMO_TRXC_CHAN_COMB_CCCH                = 6, 
        OSMO_TRXC_CHAN_COMB_SDCCH8              = 7, 
        OSMO_TRXC_CHAN_COMB_TCHF_FACCH_SACCHM   = 8,
        OSMO_TRXC_CHAN_COMB_TCHF_SACCHM = 9,
        OSMO_TRXC_CHAN_COMB_TCHFD_SACCHMD       = 10,
        OSMO_TRXC_CHAN_COMB_PBCCH               = 11, 
        OSMO_TRXC_CHAN_COMB_PCCCH               = 12, 
        OSMO_TRXC_CHAN_COMB_PDTCH               = 13, 
};
 
extern const struct value_string osmo_trxc_chan_comb_names[];
static inline const char *osmo_trxc_chan_comb_name(enum osmo_trxc_chan_comb comb)
{
        return get_value_string(osmo_trxc_chan_comb_names, comb);
}
 
enum osmo_trxc_vamos_comb {
        OSMO_TRXC_VAMOS_COMB_VFF = 1,   
        OSMO_TRXC_VAMOS_COMB_VHH,       
        OSMO_TRXC_VAMOS_COMB_VFH,       
        OSMO_TRXC_VAMOS_COMB_HVHH,      
};
 
extern const struct value_string osmo_trxc_vamos_comb_names[];
static inline const char *osmo_trxc_vamos_comb_name(enum osmo_trxc_vamos_comb comb)
{
        return get_value_string(osmo_trxc_vamos_comb_names, comb);
}
 
#define OSMO_TRXC_SETSLOT_TSC_MAX       3 
struct osmo_trxc_setslot_tsc {
        uint8_t tsc;
        uint8_t tsc_set;
};
 
struct osmo_trxc_setslot {
        uint8_t tn;
        bool vamos;     
        union {
                enum osmo_trxc_chan_comb chan_comb;
                enum osmo_trxc_vamos_comb vamos_comb;
        };
        unsigned int num_tsc;   
        struct osmo_trxc_setslot_tsc tsc[OSMO_TRXC_SETSLOT_TSC_MAX];
};
 
int osmo_trxc_setslot_parse(struct osmo_trxc_setslot *ss, const struct osmo_trxc_msg *msg);
int osmo_trxc_setslot_build(char *buf, size_t buf_size, const struct osmo_trxc_setslot *ss);
 
/* Clock socket: "IND CLOCK <fn>" */
int osmo_trxc_clock_ind_parse(uint32_t *fn, const char *buf, size_t len);
int osmo_trxc_clock_ind_build(char *buf, size_t buf_size, uint32_t fn);