trxc_client.h

Go to the documentation of this file.

 
#pragma once
 
#include <stdint.h>
#include <stddef.h>
 
#include <osmocom/trx/trxc.h>
 
struct osmo_trxc_client;
 
typedef int osmo_trxc_client_rsp_cb(struct osmo_trxc_client *client,
                                    const struct osmo_trxc_msg *rsp,
                                    void *cb_data);
 
typedef int osmo_trxc_client_tx_msg_cb(struct osmo_trxc_client *client,
                                       const struct osmo_trxc_msg *msg);
 
typedef void osmo_trxc_client_fatal_error_cb(struct osmo_trxc_client *client,
                                             const struct osmo_trxc_msg *rsp);
 
struct osmo_trxc_client *osmo_trxc_client_alloc(void *ctx);
void osmo_trxc_client_free(struct osmo_trxc_client *client);
void osmo_trxc_client_set_priv(struct osmo_trxc_client *client, void *priv);
void *osmo_trxc_client_get_priv(const struct osmo_trxc_client *client);
int osmo_trxc_client_set_name(struct osmo_trxc_client *client, const char *fmt, ...);
void osmo_trxc_client_set_log_cat(struct osmo_trxc_client *client, int log_cat);
int osmo_trxc_client_set_retrans(struct osmo_trxc_client *client, unsigned int sec);
void osmo_trxc_client_set_max_retrans(struct osmo_trxc_client *client, unsigned int n);
void osmo_trxc_client_set_tx_msg_cb(struct osmo_trxc_client *client,
                                    osmo_trxc_client_tx_msg_cb *cb);
void osmo_trxc_client_set_fatal_error_cb(struct osmo_trxc_client *client,
                                         osmo_trxc_client_fatal_error_cb *cb);
 
#define OSMO_TRXC_F_CRITICAL            (1 << 0)
#define OSMO_TRXC_F_MATCH_PARAMS        (1 << 1)
 
int osmo_trxc_client_send_cmd(struct osmo_trxc_client *client, uint32_t flags,
                              osmo_trxc_client_rsp_cb *cb, void *cb_data,
                              const char *cmd, const char *fmt, ...);
void osmo_trxc_client_flush(struct osmo_trxc_client *client);
 
int osmo_trxc_client_rx_msg(struct osmo_trxc_client *client,
                            const struct osmo_trxc_msg *rsp);
int osmo_trxc_client_rx(struct osmo_trxc_client *client, const char *buf, size_t len);
 
typedef void osmo_trxc_setformat_cb(struct osmo_trxc_client *client,
                                    uint8_t ver_use, void *cb_data);
int osmo_trxc_client_negotiate_format(struct osmo_trxc_client *client,
                                      uint8_t ver_max,
                                      osmo_trxc_setformat_cb *cb, void *cb_data);
 
/* Convenience wrappers for the common command set (thin, optional) */
static inline int osmo_trxc_client_poweron(struct osmo_trxc_client *client,
                                           osmo_trxc_client_rsp_cb *cb, void *cb_data)
{
        return osmo_trxc_client_send_cmd(client, OSMO_TRXC_F_CRITICAL, cb, cb_data,
                                         OSMO_TRXC_CMD_POWERON, NULL);
}
static inline int osmo_trxc_client_poweroff(struct osmo_trxc_client *client,
                                            osmo_trxc_client_rsp_cb *cb, void *cb_data)
{
        return osmo_trxc_client_send_cmd(client, OSMO_TRXC_F_CRITICAL, cb, cb_data,
                                         OSMO_TRXC_CMD_POWEROFF, NULL);
}
static inline int osmo_trxc_client_rxtune(struct osmo_trxc_client *client,
                                          unsigned int freq_khz,
                                          osmo_trxc_client_rsp_cb *cb, void *cb_data)
{
        return osmo_trxc_client_send_cmd(client, OSMO_TRXC_F_CRITICAL, cb, cb_data,
                                         OSMO_TRXC_CMD_RXTUNE, "%u", freq_khz);
}
static inline int osmo_trxc_client_txtune(struct osmo_trxc_client *client,
                                          unsigned int freq_khz,
                                          osmo_trxc_client_rsp_cb *cb, void *cb_data)
{
        return osmo_trxc_client_send_cmd(client, OSMO_TRXC_F_CRITICAL, cb, cb_data,
                                         OSMO_TRXC_CMD_TXTUNE, "%u", freq_khz);
}