From be1898495977f1aa0db1f63c4158be7ec0d8218e Mon Sep 17 00:00:00 2001 From: Harald Welte Date: Fri, 22 Aug 2014 23:26:26 +0200 Subject: ctrl: Add sysmobts control interface This sysmobts specific control interface allows for clock calibration from an external program by means of the "trx.0.clock-info" and "trx.0.clock-correction" values. --- src/osmo-bts-sysmo/Makefile.am | 2 +- src/osmo-bts-sysmo/main.c | 1 + src/osmo-bts-sysmo/sysmobts_ctrl.c | 253 +++++++++++++++++++++++++++++++++++++ 3 files changed, 255 insertions(+), 1 deletion(-) create mode 100644 src/osmo-bts-sysmo/sysmobts_ctrl.c diff --git a/src/osmo-bts-sysmo/Makefile.am b/src/osmo-bts-sysmo/Makefile.am index 720bcff7..bb101bde 100644 --- a/src/osmo-bts-sysmo/Makefile.am +++ b/src/osmo-bts-sysmo/Makefile.am @@ -9,7 +9,7 @@ EXTRA_DIST = misc/sysmobts_mgr.h misc/sysmobts_misc.h misc/sysmobts_par.h \ bin_PROGRAMS = sysmobts sysmobts-remote l1fwd-proxy sysmobts-mgr sysmobts-util COMMON_SOURCES = main.c femtobts.c l1_if.c oml.c sysmobts_vty.c tch.c hw_misc.c calib_file.c \ - eeprom.c calib_fixup.c utils.c misc/sysmobts_par.c oml_router.c + eeprom.c calib_fixup.c utils.c misc/sysmobts_par.c oml_router.c sysmobts_ctrl.c sysmobts_SOURCES = $(COMMON_SOURCES) l1_transp_hw.c sysmobts_LDADD = $(top_builddir)/src/common/libbts.a $(COMMON_LDADD) diff --git a/src/osmo-bts-sysmo/main.c b/src/osmo-bts-sysmo/main.c index 730b0c35..51619ee9 100644 --- a/src/osmo-bts-sysmo/main.c +++ b/src/osmo-bts-sysmo/main.c @@ -353,6 +353,7 @@ int main(int argc, char **argv) write_pid_file("osmo-bts"); bts_controlif_setup(bts); + sysmobts_ctrlif_inst_cmds(); rc = telnet_init(tall_bts_ctx, NULL, OSMO_VTY_PORT_BTS); if (rc < 0) { diff --git a/src/osmo-bts-sysmo/sysmobts_ctrl.c b/src/osmo-bts-sysmo/sysmobts_ctrl.c new file mode 100644 index 00000000..97b89221 --- /dev/null +++ b/src/osmo-bts-sysmo/sysmobts_ctrl.c @@ -0,0 +1,253 @@ +/* Control Interface for sysmoBTS */ + +/* (C) 2014 by Harald Welte + * + * All Rights Reserved + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation; either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + +#include +#include +#include +#include + +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include + +#include "femtobts.h" +#include "l1_if.h" + + +/* for control interface */ + +CTRL_CMD_DEFINE(clock_info, "clock-info"); +static int ctrl_clkinfo_cb(struct gsm_bts_trx *trx, struct msgb *resp, + void *data) +{ + SuperFemto_Prim_t *sysp = msgb_sysprim(resp); + struct ctrl_cmd_def *cd = data; + struct ctrl_cmd *cmd = cd->cmd; + + LOGP(DL1C, LOGL_NOTICE, + "RfClockInfo iClkCor=%d/clkSrc=%s Err=%d/ErrRes=%d/clkSrc=%s\n", + sysp->u.rfClockInfoCnf.rfTrx.iClkCor, + get_value_string(femtobts_clksrc_names, + sysp->u.rfClockInfoCnf.rfTrx.clkSrc), + sysp->u.rfClockInfoCnf.rfTrxClkCal.iClkErr, + sysp->u.rfClockInfoCnf.rfTrxClkCal.iClkErrRes, + get_value_string(femtobts_clksrc_names, + sysp->u.rfClockInfoCnf.rfTrxClkCal.clkSrc)); + + if (ctrl_cmd_def_is_zombie(cd)) { + talloc_free(resp); + return 0; + } + + cmd->reply = talloc_asprintf(cmd, "%d,%s,%d,%d,%s", + sysp->u.rfClockInfoCnf.rfTrx.iClkCor, + get_value_string(femtobts_clksrc_names, + sysp->u.rfClockInfoCnf.rfTrx.clkSrc), + sysp->u.rfClockInfoCnf.rfTrxClkCal.iClkErr, + sysp->u.rfClockInfoCnf.rfTrxClkCal.iClkErrRes, + get_value_string(femtobts_clksrc_names, + sysp->u.rfClockInfoCnf.rfTrxClkCal.clkSrc)); + + ctrl_cmd_def_send(cd); + + talloc_free(resp); + + return 0; +} +static int get_clock_info(struct ctrl_cmd *cmd, void *data) +{ + struct gsm_bts_trx *trx = cmd->node; + struct femtol1_hdl *fl1h = trx_femtol1_hdl(trx); + struct msgb *msg = sysp_msgb_alloc(); + SuperFemto_Prim_t *sysp = msgb_sysprim(msg); + struct ctrl_cmd_def *cd; + + /* geneate a deferred control command */ + cd = ctrl_cmd_def_make(fl1h, cmd, NULL, 10); + + sysp->id = SuperFemto_PrimId_RfClockInfoReq; + sysp->u.rfClockInfoReq.u8RstClkCal = 0; + + return l1if_req_compl(fl1h, msg, ctrl_clkinfo_cb, cd); +} +static int ctrl_set_clkinfo_cb(struct gsm_bts_trx *trx, struct msgb *resp, + void *data) +{ + struct ctrl_cmd_def *cd = data; + struct ctrl_cmd *cmd = cd->cmd; + + if (ctrl_cmd_def_is_zombie(cd)) { + talloc_free(resp); + return 0; + } + + cmd->reply = "success"; + + ctrl_cmd_def_send(cd); + + talloc_free(resp); + + return 0; +} +static int set_clock_info(struct ctrl_cmd *cmd, void *data) +{ + struct gsm_bts_trx *trx = cmd->node; + struct femtol1_hdl *fl1h = trx_femtol1_hdl(trx); + struct msgb *msg = sysp_msgb_alloc(); + SuperFemto_Prim_t *sysp = msgb_sysprim(msg); + struct ctrl_cmd_def *cd; + + /* geneate a deferred control command */ + cd = ctrl_cmd_def_make(fl1h, cmd, NULL, 10); + + sysp->id = SuperFemto_PrimId_RfClockInfoReq; + sysp->u.rfClockInfoReq.u8RstClkCal = 1; + + l1if_req_compl(fl1h, msg, ctrl_set_clkinfo_cb, cd); + + return CTRL_CMD_HANDLED; +} + +static int verify_clock_info(struct ctrl_cmd *cmd, const char *value, void *data) +{ + return 0; +} + + +CTRL_CMD_DEFINE(clock_corr, "clock-correction"); +static int ctrl_get_clkcorr_cb(struct gsm_bts_trx *trx, struct msgb *resp, + void *data) +{ + SuperFemto_Prim_t *sysp = msgb_sysprim(resp); + struct ctrl_cmd_def *cd = data; + struct ctrl_cmd *cmd = cd->cmd; + + if (ctrl_cmd_def_is_zombie(cd)) { + talloc_free(resp); + return 0; + } + + cmd->reply = talloc_asprintf(cmd, "%d", + sysp->u.rfClockInfoCnf.rfTrx.iClkCor); + + ctrl_cmd_def_send(cd); + + talloc_free(resp); + + return 0; +} +static int get_clock_corr(struct ctrl_cmd *cmd, void *data) +{ + struct gsm_bts_trx *trx = cmd->node; + struct femtol1_hdl *fl1h = trx_femtol1_hdl(trx); + struct msgb *msg = sysp_msgb_alloc(); + SuperFemto_Prim_t *sysp = msgb_sysprim(msg); + struct ctrl_cmd_def *cd; + + /* we could theoretically simply respond with a cached value, but I + * prefer to to ask the actual L1 about the currently used value to + * avoid any mistakes */ + + /* geneate a deferred control command */ + cd = ctrl_cmd_def_make(fl1h, cmd, NULL, 10); + + sysp->id = SuperFemto_PrimId_RfClockInfoReq; + sysp->u.rfClockInfoReq.u8RstClkCal = 0; + + l1if_req_compl(fl1h, msg, ctrl_get_clkcorr_cb, cd); + + return CTRL_CMD_HANDLED; +} +static int ctrl_set_clkcorr_cb(struct gsm_bts_trx *trx, struct msgb *resp, + void *data) +{ + SuperFemto_Prim_t *sysp = msgb_sysprim(resp); + struct ctrl_cmd_def *cd = data; + struct ctrl_cmd *cmd = cd->cmd; + + if (ctrl_cmd_def_is_zombie(cd)) { + talloc_free(resp); + return 0; + } + + if (sysp->u.rfClockSetupCnf.status != GsmL1_Status_Success) { + cmd->type = CTRL_CMD_ERROR; + cmd->reply = "Error setting new correction value."; + } else + cmd->reply = "success"; + + ctrl_cmd_def_send(cd); + + talloc_free(resp); + + return 0; +} +static int set_clock_corr(struct ctrl_cmd *cmd, void *data) +{ + struct gsm_bts_trx *trx = cmd->node; + struct femtol1_hdl *fl1h = trx_femtol1_hdl(trx); + struct msgb *msg = sysp_msgb_alloc(); + SuperFemto_Prim_t *sysp = msgb_sysprim(msg); + struct ctrl_cmd_def *cd; + + fl1h->clk_cal = atoi(cmd->value); + + /* geneate a deferred control command */ + cd = ctrl_cmd_def_make(fl1h, cmd, NULL, 10); + + sysp->id = SuperFemto_PrimId_RfClockSetupReq; + sysp->u.rfClockSetupReq.rfTrx.iClkCor = fl1h->clk_cal; + sysp->u.rfClockSetupReq.rfTrx.clkSrc = fl1h->clk_src; + sysp->u.rfClockSetupReq.rfTrxClkCal.clkSrc = SuperFemto_ClkSrcId_GpsPps; + + l1if_req_compl(fl1h, msg, ctrl_set_clkcorr_cb, cd); + + return CTRL_CMD_HANDLED; +} + +static int verify_clock_corr(struct ctrl_cmd *cmd, const char *value, void *data) +{ + /* FIXME: check the range */ + return 0; +} + +int sysmobts_ctrlif_inst_cmds(void) +{ + int rc = 0; + + rc |= ctrl_cmd_install(CTRL_NODE_TRX, &cmd_clock_info); + rc |= ctrl_cmd_install(CTRL_NODE_TRX, &cmd_clock_corr); + + return rc; +} -- cgit v1.2.3