split lchan specific defines and code to its own file

It is really difficult right now to find out where all the different
stuff relative to operation and lifecycle of an lchan is. Let's move
everything to its own file to have all the related defines and logic
together.

Change-Id: Idd855d126c43ac6576c5f3ba7e0b8014127a65e1

16 files changed, 156 insertions, 112 deletions

diff --git a/src/osmo-bsc/Makefile.am b/src/osmo-bsc/Makefile.am
index f07558038..c242e36e8 100644
--- a/src/osmo-bsc/Makefile.am
+++ b/src/osmo-bsc/Makefile.am
@@ -70,6 +70,7 @@ libbsc_la_SOURCES = \
 	handover_logic.c \
 	handover_vty.c \
 	lb.c \
+	lchan.c \
 	lchan_fsm.c \
 	lchan_rtp_fsm.c \
 	lchan_select.c \
diff --git a/src/osmo-bsc/abis_rsl.c b/src/osmo-bsc/abis_rsl.c
index c650c366d..8ec94a91d 100644
--- a/src/osmo-bsc/abis_rsl.c
+++ b/src/osmo-bsc/abis_rsl.c
@@ -57,6 +57,7 @@
 #include <osmocom/bsc/bts.h>
 #include <osmocom/bsc/power_control.h>
 #include <osmocom/bsc/chan_counts.h>
+#include <osmocom/bsc/lchan.h>
 
 static void send_lchan_signal(int sig_no, struct gsm_lchan *lchan,
 			      struct gsm_meas_rep *resp)
diff --git a/src/osmo-bsc/assignment_fsm.c b/src/osmo-bsc/assignment_fsm.c
index 1918252a3..7ca17c6a1 100644
--- a/src/osmo-bsc/assignment_fsm.c
+++ b/src/osmo-bsc/assignment_fsm.c
@@ -37,7 +37,7 @@
 #include <osmocom/bsc/abis_rsl.h>
 #include <osmocom/bsc/bts.h>
 #include <osmocom/bsc/bsc_stats.h>
-
+#include <osmocom/bsc/lchan.h>
 #include <osmocom/bsc/assignment_fsm.h>
 
 static struct osmo_fsm assignment_fsm;
diff --git a/src/osmo-bsc/bsc_subscr_conn_fsm.c b/src/osmo-bsc/bsc_subscr_conn_fsm.c
index 7c0c7c3a4..21988ce7a 100644
--- a/src/osmo-bsc/bsc_subscr_conn_fsm.c
+++ b/src/osmo-bsc/bsc_subscr_conn_fsm.c
@@ -32,6 +32,7 @@
 #include <osmocom/bsc/handover_fsm.h>
 #include <osmocom/bsc/lchan_fsm.h>
 #include <osmocom/bsc/lchan_rtp_fsm.h>
+#include <osmocom/bsc/lchan.h>
 #include <osmocom/bsc/bsc_subscriber.h>
 #include <osmocom/bsc/osmo_bsc_sigtran.h>
 #include <osmocom/bsc/osmo_bsc_lcls.h>
diff --git a/src/osmo-bsc/bsc_vty.c b/src/osmo-bsc/bsc_vty.c
index 8f0618a5f..61a1559bf 100644
--- a/src/osmo-bsc/bsc_vty.c
+++ b/src/osmo-bsc/bsc_vty.c
@@ -65,6 +65,7 @@
 #include <osmocom/bsc/assignment_fsm.h>
 #include <osmocom/bsc/bssmap_reset.h>
 #include <osmocom/bsc/bsc_msc_data.h>
+#include <osmocom/bsc/lchan.h>
 
 #include <inttypes.h>
 
diff --git a/src/osmo-bsc/bts_trx.c b/src/osmo-bsc/bts_trx.c
index 71d9fbf35..220234700 100644
--- a/src/osmo-bsc/bts_trx.c
+++ b/src/osmo-bsc/bts_trx.c
@@ -31,6 +31,7 @@
 #include <osmocom/bsc/pcu_if.h>
 #include <osmocom/bsc/debug.h>
 #include <osmocom/bsc/nm_common_fsm.h>
+#include <osmocom/bsc/lchan.h>
 
 static int gsm_bts_trx_talloc_destructor(struct gsm_bts_trx *trx)
 {
diff --git a/src/osmo-bsc/bts_trx_vty.c b/src/osmo-bsc/bts_trx_vty.c
index d8c633a05..b5275ac00 100644
--- a/src/osmo-bsc/bts_trx_vty.c
+++ b/src/osmo-bsc/bts_trx_vty.c
@@ -39,6 +39,7 @@
 #include <osmocom/bsc/system_information.h>
 #include <osmocom/bsc/debug.h>
 #include <osmocom/bsc/timeslot_fsm.h>
+#include <osmocom/bsc/lchan.h>
 #include <osmocom/bsc/lchan_fsm.h>
 #include <osmocom/bsc/lchan_select.h>
 #include <osmocom/bsc/bts.h>
diff --git a/src/osmo-bsc/gsm_04_08_rr.c b/src/osmo-bsc/gsm_04_08_rr.c
index 13b00da74..3321a0ed6 100644
--- a/src/osmo-bsc/gsm_04_08_rr.c
+++ b/src/osmo-bsc/gsm_04_08_rr.c
@@ -46,7 +46,7 @@
 #include <osmocom/bsc/bsc_msc_data.h>
 #include <osmocom/bsc/system_information.h>
 #include <osmocom/bsc/bts.h>
-
+#include <osmocom/bsc/lchan.h>
 
 int gsm48_sendmsg(struct msgb *msg)
 {
diff --git a/src/osmo-bsc/gsm_data.c b/src/osmo-bsc/gsm_data.c
index 174ff2aae..1562ea8b6 100644
--- a/src/osmo-bsc/gsm_data.c
+++ b/src/osmo-bsc/gsm_data.c
@@ -325,32 +325,6 @@ char *gsm_ts_and_pchan_name(const struct gsm_bts_trx_ts *ts)
 	return ts2str;
 }
 
-void lchan_update_name(struct gsm_lchan *lchan)
-{
-	struct gsm_bts_trx_ts *ts = lchan->ts;
-	if (lchan->name)
-		talloc_free(lchan->name);
-	lchan->name = talloc_asprintf(ts->trx, "(bts=%d,trx=%d,ts=%d,ss=%s%d)",
-				      ts->trx->bts->nr, ts->trx->nr, ts->nr,
-				      lchan->vamos.is_secondary ? "shadow" : "",
-				      lchan->nr - (lchan->vamos.is_secondary ? ts->max_primary_lchans : 0));
-}
-
-/* If the lchan is currently active, return the duration since activation in milliseconds.
- * Otherwise return 0. */
-uint64_t gsm_lchan_active_duration_ms(const struct gsm_lchan *lchan)
-{
-	struct timespec now, elapsed;
-
-	if (lchan->active_start.tv_sec == 0 && lchan->active_start.tv_nsec == 0)
-		return 0;
-
-	osmo_clock_gettime(CLOCK_MONOTONIC, &now);
-	timespecsub(&now, &lchan->active_start, &elapsed);
-
-	return elapsed.tv_sec * 1000 + elapsed.tv_nsec / 1000000;
-}
-
 /* obtain the MO structure for a given object instance */
 static inline struct gsm_abis_mo *
 gsm_objclass2mo(struct gsm_bts *bts, uint8_t obj_class,
@@ -668,36 +642,6 @@ bool ts_is_tch(struct gsm_bts_trx_ts *ts)
 	return pchan_is_tch(ts->pchan_is);
 }
 
-/* For a VAMOS secondary shadow lchan, return its primary lchan. If the lchan is not a secondary lchan, return NULL. */
-struct gsm_lchan *gsm_lchan_vamos_to_primary(const struct gsm_lchan *lchan_vamos)
-{
-	struct gsm_lchan *lchan_primary;
-	if (!lchan_vamos || !lchan_vamos->vamos.is_secondary)
-		return NULL;
-	/* OsmoBSC currently does not support mixed TCH/F + TCH/H VAMOS multiplexes. Hence the primary <-> secondary
-	 * relation is a simple index shift in the lchan array. If mixed multiplexes were allowed, a TCH/F primary might
-	 * have two TCH/H VAMOS secondary lchans, etc. Fortunately, we don't need to care about that. */
-	lchan_primary = (struct gsm_lchan*)lchan_vamos - lchan_vamos->ts->max_primary_lchans;
-	if (!lchan_primary->fi)
-		return NULL;
-	return lchan_primary;
-}
-
-/* For a primary lchan, return its VAMOS secondary shadow lchan. If the lchan is not a primary lchan, return NULL. */
-struct gsm_lchan *gsm_lchan_primary_to_vamos(const struct gsm_lchan *lchan_primary)
-{
-	struct gsm_lchan *lchan_vamos;
-	if (!lchan_primary || lchan_primary->vamos.is_secondary)
-		return NULL;
-	/* OsmoBSC currently does not support mixed TCH/F + TCH/H VAMOS multiplexes. Hence the primary <-> secondary
-	 * relation is a simple index shift in the lchan array. If mixed multiplexes were allowed, a TCH/F primary might
-	 * have two TCH/H VAMOS secondary lchans, etc. Fortunately, we don't need to care about that. */
-	lchan_vamos = (struct gsm_lchan*)lchan_primary + lchan_primary->ts->max_primary_lchans;
-	if (!lchan_vamos->fi)
-		return NULL;
-	return lchan_vamos;
-}
-
 struct gsm_bts *conn_get_bts(struct gsm_subscriber_connection *conn) {
 	if (!conn || !conn->lchan)
 		return NULL;
@@ -990,59 +934,6 @@ void conn_update_ms_power_class(struct gsm_subscriber_connection *conn, uint8_t
 		lchan_update_ms_power_ctrl_level(conn->lchan, bts->ms_max_power);
 }
 
-void lchan_update_ms_power_ctrl_level(struct gsm_lchan *lchan, int ms_power_dbm)
-{
-	struct gsm_bts *bts = lchan->ts->trx->bts;
-	struct gsm_subscriber_connection *conn = lchan->conn;
-	int max_pwr_dbm_pwclass, new_pwr;
-	bool send_pwr_ctrl_msg = false;
-
-	LOG_LCHAN(lchan, LOGL_DEBUG,
-		  "MS Power level update requested: %d dBm\n", ms_power_dbm);
-
-	if (!conn)
-		goto ms_power_default;
-
-	if (conn->ms_power_class == 0)
-		goto ms_power_default;
-
-	if ((max_pwr_dbm_pwclass = (int)ms_class_gmsk_dbm(bts->band, conn->ms_power_class)) < 0) {
-		LOG_LCHAN(lchan, LOGL_INFO,
-			 "Failed getting max ms power for power class %" PRIu8
-			 " on band %s, providing default max ms power\n",
-			 conn->ms_power_class, gsm_band_name(bts->band));
-		goto ms_power_default;
-	}
-
-	/* Current configured max pwr is above maximum one allowed on
-	   current band + ms power class, so use that one. */
-	if (ms_power_dbm > max_pwr_dbm_pwclass)
-		ms_power_dbm = max_pwr_dbm_pwclass;
-
-ms_power_default:
-	if ((new_pwr = ms_pwr_ctl_lvl(bts->band, ms_power_dbm)) < 0) {
-		LOG_LCHAN(lchan, LOGL_INFO,
-			 "Failed getting max ms power level %d on band %s,"
-			 " providing default max ms power\n",
-			 ms_power_dbm, gsm_band_name(bts->band));
-		return;
-	}
-
-	LOG_LCHAN(lchan, LOGL_DEBUG,
-		  "MS Power level update (power class %" PRIu8 "): %" PRIu8 " -> %d\n",
-		  conn ? conn->ms_power_class : 0, lchan->ms_power, new_pwr);
-
-	/* If chan was already activated and max ms_power changes (due to power
-	   classmark received), send an MS Power Control message */
-	if (lchan->activate.activ_ack && new_pwr != lchan->ms_power)
-		send_pwr_ctrl_msg = true;
-
-	lchan->ms_power = new_pwr;
-
-	if (send_pwr_ctrl_msg)
-		rsl_chan_ms_power_ctrl(lchan);
-}
-
 const struct value_string lchan_activate_mode_names[] = {
 	OSMO_VALUE_STRING(ACTIVATE_FOR_NONE),
 	OSMO_VALUE_STRING(ACTIVATE_FOR_MS_CHANNEL_REQUEST),
diff --git a/src/osmo-bsc/handover_fsm.c b/src/osmo-bsc/handover_fsm.c
index 5ba8c1772..92e8c6e5a 100644
--- a/src/osmo-bsc/handover_fsm.c
+++ b/src/osmo-bsc/handover_fsm.c
@@ -46,6 +46,7 @@
 #include <osmocom/bsc/bts.h>
 #include <osmocom/bsc/lcs_loc_req.h>
 #include <osmocom/bsc/bsc_stats.h>
+#include <osmocom/bsc/lchan.h>
 
 #define LOG_FMT_BTS "bts %u lac-ci %u-%u arfcn-bsic %d-%d"
 #define LOG_ARGS_BTS(bts) \
diff --git a/src/osmo-bsc/lchan.c b/src/osmo-bsc/lchan.c
new file mode 100644
index 000000000..84fc97a84
--- /dev/null
+++ b/src/osmo-bsc/lchan.c
@@ -0,0 +1,141 @@
+/* (C) 2022 by sysmocom - s.m.f.c. GmbH <info@sysmocom.de>
+ * (C) 2008-2018 by Harald Welte <laforge@gnumonks.org>
+ *
+ * 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 Affero 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 <stdint.h>
+#include <stdbool.h>
+#include <inttypes.h>
+
+#include <osmocom/gsm/gsm_utils.h>
+
+#include <osmocom/bsc/lchan.h>
+#include <osmocom/bsc/lchan_fsm.h>
+#include <osmocom/bsc/gsm_data.h>
+#include <osmocom/bsc/bts.h>
+#include <osmocom/bsc/bts_trx.h>
+#include <osmocom/bsc/abis_rsl.h>
+
+void lchan_update_name(struct gsm_lchan *lchan)
+{
+	struct gsm_bts_trx_ts *ts = lchan->ts;
+	if (lchan->name)
+		talloc_free(lchan->name);
+	lchan->name = talloc_asprintf(ts->trx, "(bts=%d,trx=%d,ts=%d,ss=%s%d)",
+				      ts->trx->bts->nr, ts->trx->nr, ts->nr,
+				      lchan->vamos.is_secondary ? "shadow" : "",
+				      lchan->nr - (lchan->vamos.is_secondary ? ts->max_primary_lchans : 0));
+}
+
+/* If the lchan is currently active, return the duration since activation in milliseconds.
+ * Otherwise return 0. */
+uint64_t gsm_lchan_active_duration_ms(const struct gsm_lchan *lchan)
+{
+	struct timespec now, elapsed;
+
+	if (lchan->active_start.tv_sec == 0 && lchan->active_start.tv_nsec == 0)
+		return 0;
+
+	osmo_clock_gettime(CLOCK_MONOTONIC, &now);
+	timespecsub(&now, &lchan->active_start, &elapsed);
+
+	return elapsed.tv_sec * 1000 + elapsed.tv_nsec / 1000000;
+}
+
+/* For a VAMOS secondary shadow lchan, return its primary lchan. If the lchan is not a secondary lchan, return NULL. */
+struct gsm_lchan *gsm_lchan_vamos_to_primary(const struct gsm_lchan *lchan_vamos)
+{
+	struct gsm_lchan *lchan_primary;
+	if (!lchan_vamos || !lchan_vamos->vamos.is_secondary)
+		return NULL;
+	/* OsmoBSC currently does not support mixed TCH/F + TCH/H VAMOS multiplexes. Hence the primary <-> secondary
+	 * relation is a simple index shift in the lchan array. If mixed multiplexes were allowed, a TCH/F primary might
+	 * have two TCH/H VAMOS secondary lchans, etc. Fortunately, we don't need to care about that. */
+	lchan_primary = (struct gsm_lchan *)lchan_vamos - lchan_vamos->ts->max_primary_lchans;
+	if (!lchan_primary->fi)
+		return NULL;
+	return lchan_primary;
+}
+
+/* For a primary lchan, return its VAMOS secondary shadow lchan. If the lchan is not a primary lchan, return NULL. */
+struct gsm_lchan *gsm_lchan_primary_to_vamos(const struct gsm_lchan *lchan_primary)
+{
+	struct gsm_lchan *lchan_vamos;
+	if (!lchan_primary || lchan_primary->vamos.is_secondary)
+		return NULL;
+	/* OsmoBSC currently does not support mixed TCH/F + TCH/H VAMOS multiplexes. Hence the primary <-> secondary
+	 * relation is a simple index shift in the lchan array. If mixed multiplexes were allowed, a TCH/F primary might
+	 * have two TCH/H VAMOS secondary lchans, etc. Fortunately, we don't need to care about that. */
+	lchan_vamos = (struct gsm_lchan *)lchan_primary + lchan_primary->ts->max_primary_lchans;
+	if (!lchan_vamos->fi)
+		return NULL;
+	return lchan_vamos;
+}
+
+void lchan_update_ms_power_ctrl_level(struct gsm_lchan *lchan, int ms_power_dbm)
+{
+	struct gsm_bts *bts = lchan->ts->trx->bts;
+	struct gsm_subscriber_connection *conn = lchan->conn;
+	int max_pwr_dbm_pwclass, new_pwr;
+	bool send_pwr_ctrl_msg = false;
+
+	LOG_LCHAN(lchan, LOGL_DEBUG,
+		  "MS Power level update requested: %d dBm\n", ms_power_dbm);
+
+	if (!conn)
+		goto ms_power_default;
+
+	if (conn->ms_power_class == 0)
+		goto ms_power_default;
+
+	if ((max_pwr_dbm_pwclass = (int)ms_class_gmsk_dbm(bts->band, conn->ms_power_class)) < 0) {
+		LOG_LCHAN(lchan, LOGL_INFO,
+			 "Failed getting max ms power for power class %" PRIu8
+			 " on band %s, providing default max ms power\n",
+			 conn->ms_power_class, gsm_band_name(bts->band));
+		goto ms_power_default;
+	}
+
+	/* Current configured max pwr is above maximum one allowed on
+	   current band + ms power class, so use that one. */
+	if (ms_power_dbm > max_pwr_dbm_pwclass)
+		ms_power_dbm = max_pwr_dbm_pwclass;
+
+ms_power_default:
+	if ((new_pwr = ms_pwr_ctl_lvl(bts->band, ms_power_dbm)) < 0) {
+		LOG_LCHAN(lchan, LOGL_INFO,
+			 "Failed getting max ms power level %d on band %s,"
+			 " providing default max ms power\n",
+			 ms_power_dbm, gsm_band_name(bts->band));
+		return;
+	}
+
+	LOG_LCHAN(lchan, LOGL_DEBUG,
+		  "MS Power level update (power class %" PRIu8 "): %" PRIu8 " -> %d\n",
+		  conn ? conn->ms_power_class : 0, lchan->ms_power, new_pwr);
+
+	/* If chan was already activated and max ms_power changes (due to power
+	   classmark received), send an MS Power Control message */
+	if (lchan->activate.activ_ack && new_pwr != lchan->ms_power)
+		send_pwr_ctrl_msg = true;
+
+	lchan->ms_power = new_pwr;
+
+	if (send_pwr_ctrl_msg)
+		rsl_chan_ms_power_ctrl(lchan);
+}
diff --git a/src/osmo-bsc/lchan_fsm.c b/src/osmo-bsc/lchan_fsm.c
index be3be7bc0..21e145bdd 100644
--- a/src/osmo-bsc/lchan_fsm.c
+++ b/src/osmo-bsc/lchan_fsm.c
@@ -41,6 +41,7 @@
 #include <osmocom/bsc/codec_pref.h>
 #include <osmocom/bsc/bts.h>
 #include <osmocom/bsc/bsc_stats.h>
+#include <osmocom/bsc/lchan.h>
 
 static struct osmo_fsm lchan_fsm;
 
diff --git a/src/osmo-bsc/lchan_rtp_fsm.c b/src/osmo-bsc/lchan_rtp_fsm.c
index 14d8e079e..f5da93065 100644
--- a/src/osmo-bsc/lchan_rtp_fsm.c
+++ b/src/osmo-bsc/lchan_rtp_fsm.c
@@ -31,6 +31,7 @@
 #include <osmocom/bsc/abis_rsl.h>
 #include <osmocom/bsc/bsc_msc_data.h>
 #include <osmocom/bsc/bts.h>
+#include <osmocom/bsc/lchan.h>
 
 static struct osmo_fsm lchan_rtp_fsm;
 
diff --git a/src/osmo-bsc/meas_feed.c b/src/osmo-bsc/meas_feed.c
index 881f40919..afd96e18b 100644
--- a/src/osmo-bsc/meas_feed.c
+++ b/src/osmo-bsc/meas_feed.c
@@ -20,6 +20,7 @@
 #include <osmocom/bsc/vty.h>
 #include <osmocom/bsc/debug.h>
 #include <osmocom/bsc/bts.h>
+#include <osmocom/bsc/lchan.h>
 
 struct meas_feed_state {
 	struct osmo_wqueue wqueue;
diff --git a/src/osmo-bsc/osmo_bsc_lcls.c b/src/osmo-bsc/osmo_bsc_lcls.c
index 542bbf5e3..eab0be4d1 100644
--- a/src/osmo-bsc/osmo_bsc_lcls.c
+++ b/src/osmo-bsc/osmo_bsc_lcls.c
@@ -30,6 +30,7 @@
 #include <osmocom/bsc/gsm_data.h>
 #include <osmocom/bsc/osmo_bsc_lcls.h>
 #include <osmocom/bsc/lchan_rtp_fsm.h>
+#include <osmocom/bsc/lchan.h>
 #include <osmocom/mgcp_client/mgcp_client_endpoint_fsm.h>
 
 struct value_string lcls_event_names[] = {
@@ -561,7 +562,7 @@ static void lcls_req_lcls_not_supp_fn(struct osmo_fsm_inst *fi, uint32_t event,
 	case LCLS_EV_UPDATE_CFG_CSC:
 		if (lcls_handle_cfg_update(conn, data) != 0)
 			return;
-		//FIXME osmo_fsm_inst_state_chg(fi, 
+		//FIXME osmo_fsm_inst_state_chg(fi,
 		return;
 	case LCLS_EV_APPLY_CFG_CSC:
 		if (lcls_perform_correlation(conn) != 0) {
diff --git a/src/osmo-bsc/timeslot_fsm.c b/src/osmo-bsc/timeslot_fsm.c
index 3a25fc987..72db0faf7 100644
--- a/src/osmo-bsc/timeslot_fsm.c
+++ b/src/osmo-bsc/timeslot_fsm.c
@@ -29,6 +29,7 @@
 #include <osmocom/bsc/abis_rsl.h>
 #include <osmocom/bsc/pcu_if.h>
 #include <osmocom/bsc/bts.h>
+#include <osmocom/bsc/lchan.h>
 
 static struct osmo_fsm ts_fsm;