diff options
author | Pau Espin Pedrol <pespin@sysmocom.de> | 2020-09-30 13:42:04 +0200 |
---|---|---|
committer | laforge <laforge@osmocom.org> | 2020-10-15 05:55:36 +0000 |
commit | 95486f248a37e66d6ae0baa1fd33e44317cce3ba (patch) | |
tree | 6761332de416b43b71cb1e05599646ea5bebfa78 /src/osmo-bsc | |
parent | 6adeb607d0a932fcbc07b1daada432e77490e7ce (diff) |
Introduce NM BaseBand Transceiver FSM
Change-Id: Ib4d35316c52eb4c71ea0d352a1e06fd5e600fe08
Diffstat (limited to 'src/osmo-bsc')
-rw-r--r-- | src/osmo-bsc/Makefile.am | 1 | ||||
-rw-r--r-- | src/osmo-bsc/bts_ipaccess_nanobts.c | 36 | ||||
-rw-r--r-- | src/osmo-bsc/bts_trx.c | 16 | ||||
-rw-r--r-- | src/osmo-bsc/nm_bb_transc_fsm.c | 337 |
4 files changed, 380 insertions, 10 deletions
diff --git a/src/osmo-bsc/Makefile.am b/src/osmo-bsc/Makefile.am index 4584b2c1d..e6c98d138 100644 --- a/src/osmo-bsc/Makefile.am +++ b/src/osmo-bsc/Makefile.am @@ -77,6 +77,7 @@ osmo_bsc_SOURCES = \ neighbor_ident_vty.c \ net_init.c \ nm_common_fsm.c \ + nm_bb_transc_fsm.c \ nm_bts_sm_fsm.c \ nm_bts_fsm.c \ gsm_08_08.c \ diff --git a/src/osmo-bsc/bts_ipaccess_nanobts.c b/src/osmo-bsc/bts_ipaccess_nanobts.c index bb05236f3..a93183a96 100644 --- a/src/osmo-bsc/bts_ipaccess_nanobts.c +++ b/src/osmo-bsc/bts_ipaccess_nanobts.c @@ -131,6 +131,7 @@ static int nm_statechg_event(int evt, struct nm_statechg_signal_data *nsd) struct gsm_bts_sm *bts_sm; struct gsm_bts *bts; struct gsm_bts_trx *trx; + struct gsm_bts_bb_trx *bb_transc; struct gsm_bts_trx_ts *ts; struct gsm_bts_gprs_nsvc *nsvc; @@ -143,7 +144,9 @@ static int nm_statechg_event(int evt, struct nm_statechg_signal_data *nsd) /* S_NM_STATECHG_ADM is called after we call chg_adm_state() and would create * endless loop */ - if (obj_class != NM_OC_BTS && evt != S_NM_STATECHG_OPER) + if (obj_class != NM_OC_BTS && + obj_class != NM_OC_BASEB_TRANSC && + evt != S_NM_STATECHG_OPER) return 0; switch (obj_class) { @@ -155,6 +158,10 @@ static int nm_statechg_event(int evt, struct nm_statechg_signal_data *nsd) bts = obj; osmo_fsm_inst_dispatch(bts->mo.fi, NM_EV_STATE_CHG_REP, nsd); break; + case NM_OC_BASEB_TRANSC: + bb_transc = obj; + osmo_fsm_inst_dispatch(bb_transc->mo.fi, NM_EV_STATE_CHG_REP, nsd); + break; case NM_OC_CHANNEL: ts = obj; trx = ts->trx; @@ -262,14 +269,7 @@ static int sw_activ_rep(struct msgb *mb) case NM_OC_BASEB_TRANSC: if (!(trx = gsm_bts_trx_num(bts, foh->obj_inst.trx_nr))) return -EINVAL; - abis_nm_chg_adm_state(trx->bts, foh->obj_class, - trx->bts->bts_nr, trx->nr, 0xff, - NM_STATE_UNLOCKED); - abis_nm_opstart(trx->bts, foh->obj_class, - trx->bts->bts_nr, trx->nr, 0xff); - /* TRX software is active, tell it to initiate RSL Link */ - abis_nm_ipaccess_rsl_connect(trx, trx->bts->ip_access.rsl_ip, - 3003, trx->rsl_tei); + osmo_fsm_inst_dispatch(trx->bb_transc.mo.fi, NM_EV_SW_ACT_REP, NULL); break; case NM_OC_RADIO_CARRIER: { if (!(trx = gsm_bts_trx_num(bts, foh->obj_inst.trx_nr))) @@ -316,6 +316,8 @@ static void nm_rx_opstart_ack(struct msgb *oml_msg) struct abis_om_fom_hdr *foh = msgb_l3(oml_msg); struct e1inp_sign_link *sign_link = oml_msg->dst; struct gsm_bts *bts = sign_link->trx->bts; + struct gsm_bts_trx *trx; + switch (foh->obj_class) { case NM_OC_SITE_MANAGER: osmo_fsm_inst_dispatch(bts->site_mgr.mo.fi, NM_EV_OPSTART_ACK, NULL); @@ -323,6 +325,11 @@ static void nm_rx_opstart_ack(struct msgb *oml_msg) case NM_OC_BTS: osmo_fsm_inst_dispatch(bts->mo.fi, NM_EV_OPSTART_ACK, NULL); break; + case NM_OC_BASEB_TRANSC: + if (!(trx = gsm_bts_trx_num(bts, foh->obj_inst.trx_nr))) + return; + osmo_fsm_inst_dispatch(trx->bb_transc.mo.fi, NM_EV_OPSTART_ACK, NULL); + break; case NM_OC_CHANNEL: nm_rx_opstart_ack_chan(oml_msg); break; @@ -336,6 +343,8 @@ static void nm_rx_opstart_nack(struct msgb *oml_msg) struct abis_om_fom_hdr *foh = msgb_l3(oml_msg); struct e1inp_sign_link *sign_link = oml_msg->dst; struct gsm_bts *bts = sign_link->trx->bts; + struct gsm_bts_trx *trx; + switch (foh->obj_class) { case NM_OC_SITE_MANAGER: osmo_fsm_inst_dispatch(bts->site_mgr.mo.fi, NM_EV_OPSTART_NACK, NULL); @@ -343,6 +352,11 @@ static void nm_rx_opstart_nack(struct msgb *oml_msg) case NM_OC_BTS: osmo_fsm_inst_dispatch(bts->mo.fi, NM_EV_OPSTART_ACK, NULL); break; + case NM_OC_BASEB_TRANSC: + if (!(trx = gsm_bts_trx_num(bts, foh->obj_inst.trx_nr))) + return; + osmo_fsm_inst_dispatch(trx->bb_transc.mo.fi, NM_EV_OPSTART_NACK, NULL); + break; default: break; } @@ -480,8 +494,10 @@ void ipaccess_drop_oml(struct gsm_bts *bts, const char *reason) osmo_stat_item_dec(bts->bts_statg->items[BTS_STAT_OML_CONNECTED], 1); /* we have issues reconnecting RSL, drop everything. */ - llist_for_each_entry(trx, &bts->trx_list, list) + llist_for_each_entry(trx, &bts->trx_list, list) { ipaccess_drop_rsl(trx, "OML link drop"); + osmo_fsm_inst_dispatch(trx->bb_transc.mo.fi, NM_EV_OML_DOWN, NULL); + } osmo_fsm_inst_dispatch(bts->site_mgr.mo.fi, NM_EV_OML_DOWN, NULL); osmo_fsm_inst_dispatch(bts->mo.fi, NM_EV_OML_DOWN, NULL); diff --git a/src/osmo-bsc/bts_trx.c b/src/osmo-bsc/bts_trx.c index 65ff7526e..c01444a0c 100644 --- a/src/osmo-bsc/bts_trx.c +++ b/src/osmo-bsc/bts_trx.c @@ -30,6 +30,16 @@ #include <osmocom/bsc/system_information.h> #include <osmocom/bsc/pcu_if.h> #include <osmocom/bsc/debug.h> +#include <osmocom/bsc/nm_common_fsm.h> + +static int gsm_bts_trx_talloc_destructor(struct gsm_bts_trx *trx) +{ + if (trx->bb_transc.mo.fi) { + osmo_fsm_inst_free(trx->bb_transc.mo.fi); + trx->bb_transc.mo.fi = NULL; + } + return 0; +} struct gsm_bts_trx *gsm_bts_trx_alloc(struct gsm_bts *bts) { @@ -39,11 +49,17 @@ struct gsm_bts_trx *gsm_bts_trx_alloc(struct gsm_bts *bts) if (!trx) return NULL; + talloc_set_destructor(trx, gsm_bts_trx_talloc_destructor); + trx->bts = bts; trx->nr = bts->num_trx++; gsm_mo_init(&trx->mo, bts, NM_OC_RADIO_CARRIER, bts->nr, trx->nr, 0xff); + + trx->bb_transc.mo.fi = osmo_fsm_inst_alloc(&nm_bb_transc_fsm, trx, &trx->bb_transc, + LOGL_INFO, NULL); + osmo_fsm_inst_update_id_f(trx->bb_transc.mo.fi, "bts%d-trx%d", bts->nr, trx->nr); gsm_mo_init(&trx->bb_transc.mo, bts, NM_OC_BASEB_TRANSC, bts->nr, trx->nr, 0xff); diff --git a/src/osmo-bsc/nm_bb_transc_fsm.c b/src/osmo-bsc/nm_bb_transc_fsm.c new file mode 100644 index 000000000..d4875c18a --- /dev/null +++ b/src/osmo-bsc/nm_bb_transc_fsm.c @@ -0,0 +1,337 @@ +/* NM BaseBand Transceiver FSM */ + +/* (C) 2020 by sysmocom - s.m.f.c. GmbH <info@sysmocom.de> + * Author: Pau Espin Pedrol <pespin@sysmocom.de> + * + * 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 <http://www.gnu.org/licenses/>. + * + */ + +#include <errno.h> +#include <unistd.h> +#include <inttypes.h> + +#include <osmocom/core/fsm.h> +#include <osmocom/core/tdef.h> +#include <osmocom/gsm/protocol/gsm_12_21.h> + +#include <osmocom/bsc/bts.h> +#include <osmocom/bsc/signal.h> +#include <osmocom/bsc/abis_nm.h> +#include <osmocom/bsc/bts_ipaccess_nanobts_omlattr.h> +#include <osmocom/bsc/nm_common_fsm.h> +#include <osmocom/bsc/debug.h> + +#define X(s) (1 << (s)) + +#define nm_bb_transc_fsm_state_chg(fi, NEXT_STATE) \ + osmo_fsm_inst_state_chg(fi, NEXT_STATE, 0, 0) + +////////////////////////// +// FSM STATE ACTIONS +////////////////////////// + +static void st_op_disabled_notinstalled_on_enter(struct osmo_fsm_inst *fi, uint32_t prev_state) +{ + struct gsm_bts_bb_trx *bb_transc = (struct gsm_bts_bb_trx *)fi->priv; + + bb_transc->mo.adm_unlock_sent = false; + bb_transc->mo.opstart_sent = false; +} + +static void st_op_disabled_notinstalled(struct osmo_fsm_inst *fi, uint32_t event, void *data) +{ + struct nm_statechg_signal_data *nsd; + struct gsm_nm_state *new_state; + + switch (event) { + case NM_EV_SW_ACT_REP: + break; + case NM_EV_STATE_CHG_REP: + nsd = (struct nm_statechg_signal_data *)data; + new_state = nsd->new_state; + if (new_state->operational == NM_OPSTATE_ENABLED) { + /*should not happen... */ + nm_bb_transc_fsm_state_chg(fi, NM_BB_TRANSC_ST_OP_ENABLED); + return; + } + switch (new_state->availability) { /* operational = DISABLED */ + case NM_AVSTATE_DEPENDENCY: + nm_bb_transc_fsm_state_chg(fi, NM_BB_TRANSC_ST_OP_DISABLED_DEPENDENCY); + return; + case NM_AVSTATE_OFF_LINE: + case NM_AVSTATE_OK: + nm_bb_transc_fsm_state_chg(fi, NM_BB_TRANSC_ST_OP_DISABLED_OFFLINE); + return; + default: + return; + } + default: + OSMO_ASSERT(0); + } +} + +static void configure_loop(struct gsm_bts_bb_trx *bb_transc, struct gsm_nm_state *state, bool allow_opstart) +{ + struct gsm_bts_trx *trx = gsm_bts_bb_trx_get_trx(bb_transc); + if (state->administrative != NM_STATE_UNLOCKED && !bb_transc->mo.adm_unlock_sent) { + bb_transc->mo.adm_unlock_sent = true; + /* Note: nanoBTS sometimes fails NACKing the BaseBand + Transceiver Unlock command while in Dependency, specially + during first attempt after boot. When NACK is received, the + OML link is dropped and the whole procedure is restarted. */ + abis_nm_chg_adm_state(trx->bts, NM_OC_BASEB_TRANSC, + trx->bts->bts_nr, trx->nr, 0xff, + NM_STATE_UNLOCKED); + } + + if (allow_opstart && state->administrative == NM_STATE_UNLOCKED && + !bb_transc->mo.opstart_sent) { + bb_transc->mo.opstart_sent = true; + abis_nm_opstart(trx->bts, NM_OC_BASEB_TRANSC, trx->bts->bts_nr, trx->nr, 0xff); + /* TRX software is active, tell it to initiate RSL Link */ + abis_nm_ipaccess_rsl_connect(trx, trx->bts->ip_access.rsl_ip, + 3003, trx->rsl_tei); + } +} + +static void st_op_disabled_dependency_on_enter(struct osmo_fsm_inst *fi, uint32_t prev_state) +{ + struct gsm_bts_bb_trx *bb_transc = (struct gsm_bts_bb_trx *)fi->priv; + struct gsm_bts_trx *trx = gsm_bts_bb_trx_get_trx(bb_transc); + + /* nanoBTS is broken, doesn't follow TS 12.21. Opstart MUST be sent + during Dependency, so we simply move to OFFLINE state here to avoid + duplicating code */ + if (trx->bts->type == GSM_BTS_TYPE_NANOBTS) { + nm_bb_transc_fsm_state_chg(fi, NM_BB_TRANSC_ST_OP_DISABLED_OFFLINE); + return; + } + configure_loop(bb_transc, &bb_transc->mo.nm_state, false); +} + +static void st_op_disabled_dependency(struct osmo_fsm_inst *fi, uint32_t event, void *data) +{ + struct gsm_bts_bb_trx *bb_transc = (struct gsm_bts_bb_trx *)fi->priv; + struct nm_statechg_signal_data *nsd; + struct gsm_nm_state *new_state; + + switch (event) { + case NM_EV_STATE_CHG_REP: + nsd = (struct nm_statechg_signal_data *)data; + new_state = nsd->new_state; + if (new_state->operational == NM_OPSTATE_ENABLED) { + /* should not happen... */ + nm_bb_transc_fsm_state_chg(fi, NM_BB_TRANSC_ST_OP_ENABLED); + return; + } + switch (new_state->availability) { /* operational = DISABLED */ + case NM_AVSTATE_NOT_INSTALLED: + case NM_AVSTATE_POWER_OFF: + nm_bb_transc_fsm_state_chg(fi, NM_BB_TRANSC_ST_OP_DISABLED_NOTINSTALLED); + return; + case NM_AVSTATE_OFF_LINE: + case NM_AVSTATE_OK: + nm_bb_transc_fsm_state_chg(fi, NM_BB_TRANSC_ST_OP_DISABLED_OFFLINE); + return; + case NM_AVSTATE_DEPENDENCY: + configure_loop(bb_transc, new_state, false); + return; + default: + return; + } + default: + OSMO_ASSERT(0); + } +} + +static void st_op_disabled_offline_on_enter(struct osmo_fsm_inst *fi, uint32_t prev_state) +{ + struct gsm_bts_bb_trx *bb_transc = (struct gsm_bts_bb_trx *)fi->priv; + + /* Warning: In here we may be acessing an state older than new_state + from prev (syncrhonous) FSM state */ + configure_loop(bb_transc, &bb_transc->mo.nm_state, true); +} + +static void st_op_disabled_offline(struct osmo_fsm_inst *fi, uint32_t event, void *data) +{ + struct gsm_bts_bb_trx *bb_transc = (struct gsm_bts_bb_trx *)fi->priv; + struct gsm_bts_trx *trx = gsm_bts_bb_trx_get_trx(bb_transc); + struct nm_statechg_signal_data *nsd; + struct gsm_nm_state *new_state; + + switch (event) { + case NM_EV_STATE_CHG_REP: + nsd = (struct nm_statechg_signal_data *)data; + new_state = nsd->new_state; + if (new_state->operational == NM_OPSTATE_ENABLED) { + nm_bb_transc_fsm_state_chg(fi, NM_BB_TRANSC_ST_OP_ENABLED); + return; + } + switch (new_state->availability) { /* operational = DISABLED */ + case NM_AVSTATE_NOT_INSTALLED: + case NM_AVSTATE_POWER_OFF: + nm_bb_transc_fsm_state_chg(fi, NM_BB_TRANSC_ST_OP_DISABLED_NOTINSTALLED); + return; + case NM_AVSTATE_DEPENDENCY: + /* There's no point in moving back to Dependency in nanoBTS, since it's broken + and it acts actually as if it was in Offline state */ + if (trx->bts->type != GSM_BTS_TYPE_NANOBTS) { + nm_bb_transc_fsm_state_chg(fi, NM_BB_TRANSC_ST_OP_DISABLED_DEPENDENCY); + } else { + /* Moreover, in nanoBTS we need to check here for tx + Opstart since we may have gone Unlocked state + in this event, which means Opstart may be txed here. */ + configure_loop(bb_transc, new_state, true); + } + return; + case NM_AVSTATE_OFF_LINE: + case NM_AVSTATE_OK: + configure_loop(bb_transc, new_state, true); + return; + default: + return; + } + default: + OSMO_ASSERT(0); + } +} + +static void st_op_enabled_on_enter(struct osmo_fsm_inst *fi, uint32_t prev_state) +{ + struct gsm_bts_bb_trx *bb_transc = (struct gsm_bts_bb_trx *)fi->priv; + + /* Reset state, we don't need it in this state and it will need to be + reused as soon as we move back to Disabled */ + bb_transc->mo.opstart_sent = false; + bb_transc->mo.adm_unlock_sent = false; +} + +static void st_op_enabled(struct osmo_fsm_inst *fi, uint32_t event, void *data) +{ + struct nm_statechg_signal_data *nsd; + struct gsm_nm_state *new_state; + + switch (event) { + case NM_EV_STATE_CHG_REP: + nsd = (struct nm_statechg_signal_data *)data; + new_state = nsd->new_state; + if (new_state->operational == NM_OPSTATE_ENABLED) + return; + switch (new_state->availability) { /* operational = DISABLED */ + case NM_AVSTATE_NOT_INSTALLED: + case NM_AVSTATE_POWER_OFF: + nm_bb_transc_fsm_state_chg(fi, NM_BB_TRANSC_ST_OP_DISABLED_NOTINSTALLED); + return; + case NM_AVSTATE_DEPENDENCY: + nm_bb_transc_fsm_state_chg(fi, NM_BB_TRANSC_ST_OP_DISABLED_DEPENDENCY); + return; + case NM_AVSTATE_OFF_LINE: + case NM_AVSTATE_OK: + nm_bb_transc_fsm_state_chg(fi, NM_BB_TRANSC_ST_OP_DISABLED_OFFLINE); + return; + default: + return; + } + default: + OSMO_ASSERT(0); + } +} + +static void st_op_allstate(struct osmo_fsm_inst *fi, uint32_t event, void *data) +{ + struct gsm_bts_bb_trx *bb_transc = (struct gsm_bts_bb_trx *)fi->priv; + + switch (event) { + case NM_EV_OPSTART_ACK: + case NM_EV_OPSTART_NACK: + /* TODO: if on state OFFLINE and rx NACK, try again? */ + bb_transc->mo.opstart_sent = false; + break; + case NM_EV_OML_DOWN: + nm_bb_transc_fsm_state_chg(fi, NM_BB_TRANSC_ST_OP_DISABLED_NOTINSTALLED); + break; + default: + OSMO_ASSERT(0); + } +} + +static struct osmo_fsm_state nm_bb_transc_fsm_states[] = { + [NM_BB_TRANSC_ST_OP_DISABLED_NOTINSTALLED] = { + .in_event_mask = + X(NM_EV_SW_ACT_REP) | + X(NM_EV_STATE_CHG_REP), + .out_state_mask = + X(NM_BB_TRANSC_ST_OP_DISABLED_DEPENDENCY) | + X(NM_BB_TRANSC_ST_OP_DISABLED_OFFLINE) | + X(NM_BB_TRANSC_ST_OP_ENABLED), + .name = "DISABLED_NOTINSTALLED", + .onenter = st_op_disabled_notinstalled_on_enter, + .action = st_op_disabled_notinstalled, + }, + [NM_BB_TRANSC_ST_OP_DISABLED_DEPENDENCY] = { + .in_event_mask = + X(NM_EV_STATE_CHG_REP), + .out_state_mask = + X(NM_BB_TRANSC_ST_OP_DISABLED_NOTINSTALLED) | + X(NM_BB_TRANSC_ST_OP_DISABLED_OFFLINE) | + X(NM_BB_TRANSC_ST_OP_ENABLED), + .name = "DISABLED_DEPENDENCY", + .onenter = st_op_disabled_dependency_on_enter, + .action = st_op_disabled_dependency, + }, + [NM_BB_TRANSC_ST_OP_DISABLED_OFFLINE] = { + .in_event_mask = + X(NM_EV_STATE_CHG_REP), + .out_state_mask = + X(NM_BB_TRANSC_ST_OP_DISABLED_NOTINSTALLED) | + X(NM_BB_TRANSC_ST_OP_DISABLED_DEPENDENCY) | + X(NM_BB_TRANSC_ST_OP_ENABLED), + .name = "DISABLED_OFFLINE", + .onenter = st_op_disabled_offline_on_enter, + .action = st_op_disabled_offline, + }, + [NM_BB_TRANSC_ST_OP_ENABLED] = { + .in_event_mask = + X(NM_EV_STATE_CHG_REP), + .out_state_mask = + X(NM_BB_TRANSC_ST_OP_DISABLED_NOTINSTALLED) | + X(NM_BB_TRANSC_ST_OP_DISABLED_DEPENDENCY) | + X(NM_BB_TRANSC_ST_OP_DISABLED_OFFLINE), + .name = "ENABLED", + .onenter = st_op_enabled_on_enter, + .action = st_op_enabled, + }, +}; + +struct osmo_fsm nm_bb_transc_fsm = { + .name = "NM_BB_TRANSC_OP", + .states = nm_bb_transc_fsm_states, + .num_states = ARRAY_SIZE(nm_bb_transc_fsm_states), + .allstate_event_mask = + X(NM_EV_OPSTART_ACK) | + X(NM_EV_OPSTART_NACK) | + X(NM_EV_OML_DOWN), + .allstate_action = st_op_allstate, + .event_names = nm_fsm_event_names, + .log_subsys = DNM, +}; + +static __attribute__((constructor)) void nm_bb_transc_fsm_init(void) +{ + OSMO_ASSERT(osmo_fsm_register(&nm_bb_transc_fsm) == 0); +} |